first commit

.github/workflows/release.yml

@@ -0,0 +1,33 @@
+name: Release CI
+
+on:
+  push:
+    branches: [master, next]
+  pull_request:
+    branches: [master, next]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: "lts/*"
+          cache: "npm"
+      - name: Install dependencies
+        run: npm ci
+      - name: Build lib
+        run: npm run build
+      - name: Jest run
+        run: npm run test:unit
+      - name: Cypress run
+        run: npm run test:e2e
+    #  - name: Release
+    #    working-directory: lib
+    #    env:
+    #      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    #      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+    #    run: npx semantic-release

.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+node_modules
+dist
+dist-v2
+lib/cypress/videos

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1,6 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit "$1"
+# npx --no-install commitlint --edit
+

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

.npmignore

@@ -0,0 +1,4 @@
+.*
+*.md
+*.json
+example

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Storyblok
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,201 @@
+<div align="center">
+	<a href="https://www.storyblok.com?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js" align="center">
+		<img src="https://a.storyblok.com/f/88751/1776x360/a7d027d26d/sb-vue.png"  alt="Storyblok Logo">
+	</a>
+	<h1 align="center">@storyblok/js</h1>
+    The JavaScript plugin you need to interact with <a href="http://www.storyblok.com?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js" target="_blank">Storyblok API</a> and enable the <a href="https://www.storyblok.com/docs/guide/essentials/visual-editor?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js" target="_blank">Real-time Visual Editing Experience</a>.
+
+  <br />
+</div>
+
+<p align="center">
+  <a href="https://npmjs.com/package/@storyblok/js">
+    <img src="https://img.shields.io/npm/v/@storyblok/js/latest.svg?style=flat-square" alt="Storyblok JS" />
+  </a>
+  <a href="https://npmjs.com/package/@storyblok/js" rel="nofollow">
+    <img src="https://img.shields.io/npm/dt/@storyblok/js.svg?style=flat-square" alt="npm">
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://discord.gg/jKrbAMz">
+   <img src="https://img.shields.io/discord/700316478792138842?label=Join%20Our%20Discord%20Community&style=appveyor&logo=discord&color=09b3af">
+   </a>
+  <a href="https://twitter.com/intent/follow?screen_name=storyblok">
+    <img src="https://img.shields.io/badge/Follow-%40storyblok-09b3af?style=appveyor&logo=twitter" alt="Follow @Storyblok" />
+  </a>
+  <a href="https://app.storyblok.com/#!/signup?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js">
+    <img src="https://img.shields.io/badge/Try%20Storyblok-Free-09b3af?style=appveyor&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAB4AAAAeCAYAAAA7MK6iAAAABGdBTUEAALGPC/xhBQAAADhlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAAHqADAAQAAAABAAAAHgAAAADpiRU/AAACRElEQVRIDWNgGGmAEd3D3Js3LPrP8D8WXZwSPiMjw6qvPoHhyGYwIXNAbGpbCjbzP0MYuj0YFqMroBV/wCxmIeSju64eDNzMBJUxvP/9i2Hnq5cM1devMnz984eQsQwETeRhYWHgIcJiXqC6VHlFBjUeXgav40cIWkz1oLYXFmGwFBImaDFBHyObcOzdW4aSq5eRhRiE2dgYlpuYoYSKJi8vw3GgWnyAJIs/AuPu4scPGObd/fqVQZ+PHy7+6udPOBsXgySLDfn5GRYYmaKYJcXBgWLpsx8/GPa8foWiBhuHJIsl2DkYQqWksZkDFgP5PObcKYYff//iVAOTIDlx/QPqRMb/YSYBaWlOToZIaVkGZmAZSQiQ5OPtwHwacuo4iplMQEu6tXUZMhSUGDiYmBjylFQYvv/7x9B04xqKOnQOyT5GN+Df//8M59ASXKyMHLoyDD5JPtbj42OYrm+EYgg70JfuYuIoYmLs7AwMjIzA+uY/zjAnyWJpDk6GOFnCvrn86SOwmsNtKciVFAc1ileBHFDC67lzG10Yg0+SjzF0ownsf/OaofvOLYaDQJoQIGix94ljv1gIZI8Pv38zPvj2lQWYf3HGKbpDCFp85v07NnRN1OBTPY6JdRSGxcCw2k6sZuLVMZ5AV4s1TozPnGGFKbz+/PE7IJsHmC//MDMyhXBw8e6FyRFLv3Z0/IKuFqvFyIqAzd1PwBzJw8jAGPfVx38JshwlbIygxmYY43/GQmpais0ODDHuzevLMARHBcgIAQAbOJHZW0/EyQAAAABJRU5ErkJggg==" alt="Follow @Storyblok" />
+  </a>
+</p>
+
+## 🚀 Usage
+
+> If you are first-time user of the Storyblok, read the [Getting Started](https://www.storyblok.com/docs/guide/getting-started?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js) guide to get a project ready in less than 5 minutes.
+
+### Installation
+
+Install `@storyblok/js`:
+
+```bash
+npm install --save-dev @storyblok/js
+// yarn add -D @storyblok/js
+```
+
+#### From a CDN
+
+Install the file from the CDN:
+
+```html
+<script src="https://unpkg.com/@storyblok/js"></script>
+```
+
+### Initialization
+
+Register the plugin on your application and add the [access token](https://www.storyblok.com/docs/api/content-delivery#topics/authentication?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js) of your Storyblok space. You can also add the `apiPlugin` in case that you want to use the Storyblok API Client:
+
+```js
+import { storyblokInit, apiPlugin } from "@storyblok/js";
+
+const { storyblokApi } = storyblokInit({
+  accessToken: "YOUR_ACCESS_TOKEN",
+  bridge: true / false,
+  use: [apiPlugin],
+});
+```
+
+That's it! All the features are enabled for you: the _Api Client_ for interacting with [Storyblok CDN API](https://www.storyblok.com/docs/api/content-delivery#topics/introduction?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js), and _Storyblok Bridge_ for [real-time visual editing experience](https://www.storyblok.com/docs/guide/essentials/visual-editor?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js).
+
+> You can enable/disable some of these features if you don't need them, so you save some KB. Please read the "Features and API" section
+
+### Getting Started
+
+`@storyblok/js` does three actions when you initialize it:
+
+- Provides a `storyblokApi` object in your app, which is an instance of [storyblok-js-client](https://github.com/storyblok/storyblok-js-client).
+- Loads [Storyblok Bridge](https://www.storyblok.com/docs/Guides/storyblok-latest-js?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js) for real-time visual updates.
+- Provides a `storyblokEditable` function to link editable components to the Storyblok Visual Editor.
+
+#### 1. Fetching Content
+
+Inject `storyblokApi`:
+
+```js
+import { storyblokInit, apiPlugin } from "@storyblok/js";
+
+const { storyblokApi } = storyblokInit({
+  accessToken: "YOUR_ACCESS_TOKEN",
+  use: [apiPlugin],
+});
+
+const { data } = await storyblokApi.get("cdn/stories", { version: "draft" });
+</script>
+```
+
+> Note: if you don't use `apiPlugin`, you can use your prefered method or function to fetch your data.
+
+#### 2. Listen to Storyblok Visual Editor events
+
+Use `useStoryBridge` to get the new story every time is triggered a `change` event from the Visual Editor. You need to pass the story id as first param, and a callback function as second param to update the new story:
+
+```js
+import { storyblokInit, apiPlugin, useStoryblokBridge } from "@storyblok/js";
+
+const { storyblokApi } = storyblokInit({
+  accessToken: "YOUR_ACCESS_TOKEN",
+  use: [apiPlugin],
+});
+
+const { data } = await storyblokApi.get("cdn/stories", { version: "draft" });
+
+const story = data ? data.story : null;
+
+useStoryblokBridge(story.id, (story) => (state.story = story));
+```
+
+You can pass [Bridge options](https://www.storyblok.com/docs/Guides/storyblok-latest-js?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js) as a third parameter as well:
+
+```js
+useStoryblokBridge(story.id, (story) => (state.story = story), {
+  resolveRelations: ["Article.author"],
+});
+```
+
+#### 3. Link your components to Storyblok Visual Editor
+
+For every component you've defined in your Storyblok space, call the `storyblokEditable` function with the blok content:
+
+```js
+import { storyblokEditable } from "@storyblok/js";
+
+storyblokEditable(blok);
+```
+
+Where `blok` is the actual blok data coming from [Storblok's Content Delivery API](https://www.storyblok.com/docs/api/content-delivery?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js).
+
+### Features and API
+
+You can **choose the features to use** when you initialize the plugin. In that way, you can improve Web Performance by optimizing your page load and save some bytes.
+
+#### Storyblok API
+
+You can use an `apiOptions` object. This is passed down to the (storyblok-js-client config object](https://github.com/storyblok/storyblok-js-client#class-storyblok):
+
+```js
+const { storyblokApi } = storyblokInit({
+  accessToken: "YOUR_ACCESS_TOKEN",
+  apiOptions: {
+    // storyblok-js-client config object
+    cache: { type: "memory" },
+  },
+  use: [apiPlugin],
+});
+```
+
+If you prefer to use your own fetch method, just remove the `apiPlugin` and `storyblok-js-client` won't be added to your application.
+
+```js
+storyblokInit({});
+```
+
+#### Storyblok Bridge
+
+You can conditionally load it by using the `bridge` option. Very useful if you want to disable it in production:
+
+```js
+const { storyblokApi } = storyblokInit({
+  bridge: process.env.NODE_ENV !== "production",
+});
+```
+
+If you don't use `useStoryblokBridge`, you have still access to the raw `window.StoryblokBridge`:
+
+```js
+const sbBridge = new window.StoryblokBridge(options);
+
+sbBridge.on(["input", "published", "change"], (event) => {
+  // ...
+});
+```
+
+## 🔗 Related Links
+
+- **[Storyblok Technology Hub](https://www.storyblok.com/technologies?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js)**: Storyblok integrates with every framework so that you are free to choose the best fit for your project. We prepared the technology hub so that you can find selected beginner tutorials, videos, boilerplates, and even cheatsheets all in one place.
+- **[Getting Started](https://www.storyblok.com/docs/guide/getting-started?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js)**: Get a project ready in less than 5 minutes.
+- **[Storyblok CLI](https://github.com/storyblok/storyblok)**: A simple CLI for scaffolding Storyblok projects and fieldtypes.
+
+## ℹ️ More Resources
+
+### Support
+
+- Bugs or Feature Requests? [Submit an issue](/../../issues/new).
+- Do you have questions about Storyblok or you need help? [Join our Discord Community](https://discord.gg/jKrbAMz).
+
+### Contributing
+
+Please see our [contributing guidelines](https://github.com/storyblok/.github/blob/master/contributing.md) and our [code of conduct](https://www.storyblok.com/trust-center#code-of-conduct?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok-js).
+This project use [semantic-release](https://semantic-release.gitbook.io/semantic-release/) for generate new versions by using commit messages and we use the Angular Convention to naming the commits. Check [this question](https://semantic-release.gitbook.io/semantic-release/support/faq#how-can-i-change-the-type-of-commits-that-trigger-a-release) about it in semantic-release FAQ.
+
+### License
+
+This repository is published under the [MIT](./LICENSE) license.

lib/__tests__/.eslintrc

@@ -0,0 +1,5 @@
+{
+  "env": {
+    "jest": true
+  }
+}

lib/__tests__/index.test.js

@@ -0,0 +1,59 @@
+import { getLog } from "jest-console";
+import { storyblokInit, apiPlugin, storyblokEditable } from "@storyblok/js";
+
+describe("@storyblok/js", () => {
+  describe("Api", () => {
+    it("Is not loaded by default", () => {
+      const result = storyblokInit({
+        accessToken: "wANpEQEsMYGOwLxwXQ76Ggtt",
+      });
+
+      expect(result).toEqual({});
+    });
+
+    it("Is loaded correctly when using the apiPlugin", async () => {
+      const { storyblokApi } = storyblokInit({
+        accessToken: "wANpEQEsMYGOwLxwXQ76Ggtt",
+        use: [apiPlugin],
+      });
+
+      const result = await storyblokApi.getAll("cdn/stories");
+
+      expect(result.length).toBeGreaterThan(0);
+    });
+
+    it("Logs an error if no access token is provided", () => {
+      const { storyblokApi } = storyblokInit({
+        accessToken: null,
+        apiOptions: { accessToken: null },
+        use: [apiPlugin],
+      });
+
+      expect(getLog().logs).toEqual([
+        [
+          "error",
+          "You need to provide an access token to interact with Storyblok API. Read https://www.storyblok.com/docs/api/content-delivery#topics/authentication",
+        ],
+      ]);
+    });
+  });
+
+  describe("Editable", () => {
+    it("Gets data-blok-c and data-blok-uid", async () => {
+      const { storyblokApi } = storyblokInit({
+        accessToken: "wANpEQEsMYGOwLxwXQ76Ggtt",
+        use: [apiPlugin],
+      });
+
+      const { data } = await storyblokApi.get("cdn/stories/demo");
+
+      let blok = data.story.content;
+      blok._editable = `<!--#storyblok#{"id":${data.story.id},"uid":"${data.story.uid}"}-->`;
+
+      const editableResult = storyblokEditable(blok);
+
+      expect(editableResult["data-blok-c"]).toBeDefined();
+      expect(editableResult["data-blok-uid"]).toBeDefined();
+    });
+  });
+});

lib/cypress.json

@@ -0,0 +1,5 @@
+{
+  "integration": {
+    "testFiles": "**/*.spec.js"
+  }
+}

lib/cypress/.eslintrc

@@ -0,0 +1,3 @@
+{
+  "extends": ["plugin:cypress/recommended"]
+}

lib/cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "[email protected]",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

lib/cypress/integration/index.spec.js

@@ -0,0 +1,15 @@
+describe("@storyblok/js", () => {
+  describe("Bridge", () => {
+    it("Is loaded by default", () => {
+      cy.visit("http://localhost:3000/");
+      cy.get(".with-bridge").click();
+      cy.get("#storyblok-javascript-bridge").should("exist");
+    });
+
+    it("Is not loaded if options.bridge: false and errors in console", () => {
+      cy.visit("http://localhost:3000/");
+      cy.get(".without-bridge").click();
+      cy.get("#storyblok-javascript-bridge").should("not.exist");
+    });
+  });
+});