Merge pull request #176 from schabibi1/feature/remove-axios

feat: bump major version

BREAKING CHANGE: remove axios

.github/workflows/release.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v2
         with:
-          node-version: "16.13.2"
+          node-version: "18.0.0"
           cache: "npm"
       - name: Install dependencies
         run: npm ci

README.md

@@ -40,6 +40,13 @@ npm install gatsby-source-storyblok
 // yarn add gatsby-source-storyblok
 ```
 
+#### Compatibility
+
+| Version to install                                                                                                              | Support                                              |
+| ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
+| Latest `gatsby-source-storyblok`                                                                                                    | Modern browsers + Node 16+. [isomorphic-fetch](https://github.com/matthew-andrews/isomorphic-fetch) is implemented.                           |
+| [Version 4](https://github.com/storyblok/gatsby-source-storyblok/tree/v4.2.1) `gatsby-source-storyblok@4`                               | Node 14 and lower Node with no Fetch API support
+
 ### 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=gatsby-source-storyblok) of your Storyblok space. You can also add the `apiPlugin` in case that you want to use the Storyblok API Client: For Spaces created under US region, you should pass the region like { apiOptions: { region: 'us' } }. If your space is under EU, no further configuration is required.

lib/__tests__/sync.test.js

@@ -1,3 +1,4 @@
+require("isomorphic-fetch")
 const StoryblokClient = require('storyblok-js-client')
 const Sync = require('../src/sync')
 

lib/gatsby-node.js

@@ -1,13 +1,16 @@
-const StoryblokClient = require('storyblok-js-client');
-const { storyblokInit } = require('@storyblok/react');
+require("isomorphic-fetch")
+const { storyblokInit, apiPlugin, useStoryblokApi } = require('@storyblok/react');
 const Sync = require('./src/sync');
 const getStoryParams = require('./src/getStoryParams');
 const stringify = require('json-stringify-safe');
 const { createRemoteFileNode } = require(`gatsby-source-filesystem`);
 
 exports.sourceNodes = async function ({ actions }, options) {
   const { createNode, setPluginStatus } = actions;
-  const client = new StoryblokClient(options);
+  const { plugins, ...apiOptions } = options
+  storyblokInit({ use: [apiPlugin], apiOptions })
+
+  const client = useStoryblokApi()
 
   Sync.init({
     createNode,

lib/index.ts

@@ -9,7 +9,6 @@ export {
   useStoryblokApi,
   getStoryblokApi,
   renderRichText,
-  RichTextSchema
 } from "@storyblok/react";
 
 import type {

lib/package.json

@@ -23,10 +23,10 @@
     "prepublishOnly": "npm run build && cp ../README.md ./"
   },
   "dependencies": {
-    "@storyblok/react": "^1.3.0",
+    "@storyblok/react": "^2.0.4",
     "gatsby-source-filesystem": "^4.0.0",
-    "json-stringify-safe": "^5.0.1",
-    "storyblok-js-client": "^4.5.2"
+    "isomorphic-fetch": "^3.0.0",
+    "json-stringify-safe": "^5.0.1"
   },
   "devDependencies": {
     "@babel/core": "^7.18.0",
@@ -92,4 +92,4 @@
     "gatsby-plugin",
     "gatsby-source-storyblok"
   ]
-}
+}

lib/types.ts

@@ -1,33 +1,36 @@
-import type { StoryData, StoryblokComponentType } from "@storyblok/react";
+import type { ISbStoryData, StoryblokComponentType } from "@storyblok/react";
 
-export interface SbGatsbyStory extends StoryData<StoryblokComponentType<string> & { [index: string]: any; }> {
+export interface SbGatsbyStory extends ISbStoryData<StoryblokComponentType<string> & { [index: string]: any; }> {
   internalId: number
 }
 
 export type {
-  AlternateObject,
-  Richtext,
-  RichtextInstance,
+  ISbConfig,
+  ISbCache,
+  ISbResult,
+  ISbResponse,
+  ISbError,
+  ISbNode,
+  ISbSchema,
+  ThrottleFn,
+  AsyncFn,
+  ArrayFn,
+  ISbContentMangmntAPI,
+  ISbManagmentApiResult,
+  ISbStories,
+  ISbStory,
+  ISbDimensions,
+  ISbStoryData,
+  ISbAlternateObject,
+  ISbStoriesParams,
+  ISbStoryParams,
+  ISbRichtext,
   SbBlokData,
   SbBlokKeyDataTypes,
   SbRichTextOptions,
   SbSDKOptions,
-  Stories,
-  StoriesParams,
-  Story,
-  StoryData,
-  StoryParams,
   StoryblokBridgeConfigV2,
   StoryblokBridgeV2,
-  StoryblokCache,
-  StoryblokCacheProvider,
   StoryblokClient,
   StoryblokComponentType,
-  StoryblokConfig,
-  StoryblokManagmentApiResult,
-  StoryblokResult,
-  apiPlugin,
-  useStoryblokBridge,
-  SbReactComponentsMap,
-  SbReactSDKOptions
 } from "@storyblok/react";

lib/vite.config.ts

@@ -13,11 +13,11 @@ export default defineConfig(() => {
           format === "es" ? `${libName}.mjs` : `${libName}.js`,
       },
       rollupOptions: {
-        external: ["react", "axios"],
+        external: ["react"],
         output: {
           globals: { react: "React" },
         },
       },
     },
   };
-});
+});

package.json

@@ -62,4 +62,4 @@
     "semi": true,
     "singleQuote": false
   }
-}
+}