@storyblok/js 1.8.5 → 2.0.0

package/dist/types/index.d.ts

@@ -1,10 +1,10 @@
-import { SbSDKOptions, StoryblokBridgeConfigV2, StoryData, SbInitResult, Richtext, StoryblokComponentType, SbRichTextOptions, RichtextInstance } from "./types";
-export { default as RichTextSchema } from "storyblok-js-client/source/schema";
-export declare const useStoryblokBridge: <T extends StoryblokComponentType<string> = any>(id: Number, cb: (newStory: StoryData<T>) => void, options?: StoryblokBridgeConfigV2) => void;
+import { SbSDKOptions, StoryblokBridgeConfigV2, ISbStoryData, SbInitResult, ISbRichtext, StoryblokComponentType, SbRichTextOptions } from "./types";
+import { RichtextResolver } from "storyblok-js-client";
+export declare const useStoryblokBridge: <T extends StoryblokComponentType<string> = any>(id: Number, cb: (newStory: ISbStoryData<T>) => void, options?: StoryblokBridgeConfigV2) => void;
 export { useStoryblokBridge as registerStoryblokBridge };
 export { default as apiPlugin } from "./modules/api";
 export { default as storyblokEditable } from "./modules/editable";
 export declare const storyblokInit: (pluginOptions?: SbSDKOptions) => SbInitResult;
-export declare const renderRichText: (data: Richtext, options?: SbRichTextOptions, resolverInstance?: RichtextInstance) => string;
+export declare const renderRichText: (data: ISbRichtext, options?: SbRichTextOptions, resolverInstance?: RichtextResolver) => string;
 export declare const loadStoryblokBridge: () => Promise<unknown>;
 export * from "./types";

package/dist/types/types.d.ts

@@ -1,4 +1,4 @@
-import StoryblokJSClient, { StoryblokConfig, StoryblokComponent } from "storyblok-js-client";
+import StoryblokJSClient, { ISbConfig, ISbComponentType, ISbStoryData } from "storyblok-js-client";
 export declare type StoryblokClient = StoryblokJSClient;
 declare global {
     interface Window {
@@ -13,20 +13,29 @@ export interface SbInitResult {
 }
 export declare type SbPluginFactory = (options: SbSDKOptions) => any;
 export declare type SbBlokKeyDataTypes = string | number | object | boolean | undefined;
-export interface SbBlokData extends StoryblokComponent<string> {
+export interface SbBlokData extends ISbComponentType<string> {
     [index: string]: SbBlokKeyDataTypes;
 }
 export interface SbRichTextOptions {
-    schema?: StoryblokConfig["richTextSchema"];
-    resolver?: StoryblokConfig["componentResolver"];
+    schema?: ISbConfig["richTextSchema"];
+    resolver?: ISbConfig["componentResolver"];
 }
 export interface SbSDKOptions {
     bridge?: boolean;
     accessToken?: string;
     use?: any[];
-    apiOptions?: StoryblokConfig;
+    apiOptions?: ISbConfig;
     richText?: SbRichTextOptions;
 }
+export interface ISbEventPayload<S extends ISbComponentType<string> = any> {
+    action: "customEvent" | "published" | "input" | "change" | "unpublished" | "enterEditmode";
+    event?: string;
+    story?: ISbStoryData<S>;
+    slug?: string;
+    slugChanged?: boolean;
+    storyId?: number;
+    reload?: boolean;
+}
 export interface StoryblokBridgeConfigV2 {
     resolveRelations?: string[];
     customParent?: string;
@@ -37,6 +46,17 @@ export interface StoryblokBridgeV2 {
     pingEditor: (event: any) => void;
     isInEditor: () => boolean;
     enterEditmode: () => void;
-    on: (event: "customEvent" | "published" | "input" | "change" | "unpublished" | "enterEditmode" | string[], callback: (payload?: StoryblokEventPayload) => void) => void;
+    on: (event: "customEvent" | "published" | "input" | "change" | "unpublished" | "enterEditmode" | string[], callback: (payload?: ISbEventPayload) => void) => void;
 }
-export type { StoryblokConfig, StoryblokCache, StoryblokCacheProvider, StoryblokResult, StoryblokManagmentApiResult, StoryblokComponent as StoryblokComponentType, StoryData, AlternateObject, Stories, Story, StoriesParams, StoryParams, Richtext, RichtextInstance, } from "storyblok-js-client";
+export type { ISbConfig, // previously StoryblokConfig
+ISbCache, // previously StoryblokCache
+ISbResult, // previously StoryblokResult
+ISbResponse, ISbError, ISbNode, ISbSchema, ThrottleFn, AsyncFn, ArrayFn, ISbContentMangmntAPI, ISbManagmentApiResult, // previously StoryblokManagmentApiResult
+ISbStories, // previously Stories
+ISbStory, // previously Story
+ISbDimensions, ISbComponentType as StoryblokComponentType, ISbStoryData, // previously StoryData
+ISbAlternateObject, // previously AlternateObject
+ISbStoriesParams, // previously StoriesParams
+ISbStoryParams, // previously StoryParams
+ISbRichtext, // previously Richtext
+RichtextResolver, } from "storyblok-js-client";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storyblok/js",
-  "version": "1.8.5",
+  "version": "2.0.0",
   "description": "SDK to integrate Storyblok into your project using JavaScript.",
   "main": "./dist/storyblok-js.js",
   "module": "./dist/storyblok-js.mjs",
@@ -18,7 +18,7 @@
     "dev": "vite build --watch",
     "build": "vite build && tsc --project tsconfig.json",
     "test": "npm run test:unit && npm run test:e2e",
-    "test:unit": "jest __tests__",
+    "test:unit": "vitest run",
     "test:e2e": "start-server-and-test cy:playground http-get://localhost:3000/ cy:run",
     "test:e2e-watch": "start-server-and-test cy:playground http-get://localhost:3000/ cy:open",
     "cy:playground": "npm run demo --prefix ../playground",
@@ -27,20 +27,17 @@
     "prepublishOnly": "npm run build && cp ../README.md ./"
   },
   "dependencies": {
-    "storyblok-js-client": "^4.5.7"
+    "storyblok-js-client": "^5.1.1"
   },
   "devDependencies": {
-    "@babel/core": "^7.19.0",
-    "@babel/preset-env": "^7.19.0",
     "@tsconfig/recommended": "^1.0.1",
-    "babel-jest": "^28.1.0",
     "cypress": "^9.6.1",
     "eslint-plugin-cypress": "^2.12.1",
     "eslint-plugin-jest": "^26.9.0",
-    "jest": "^28.1.3",
-    "jest-console": "^0.1.0",
+    "isomorphic-fetch": "^3.0.0",
     "start-server-and-test": "^1.14.0",
-    "vite": "^2.9.15"
+    "vite": "^2.9.15",
+    "vitest": "^0.25.3"
   },
   "babel": {
     "presets": [