@storyblok/js 3.1.9 → 3.2.1

package/dist/types/index.d.ts

@@ -1,13 +1,64 @@
-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 declare const storyblokInit: (pluginOptions?: SbSDKOptions) => SbInitResult;
-export declare const isRichTextEmpty: (data?: ISbRichtext) => boolean;
-export declare const renderRichText: (data?: ISbRichtext, options?: SbRichTextOptions, resolverInstance?: RichtextResolver) => string;
-export declare const loadStoryblokBridge: () => Promise<unknown>;
-export { useStoryblokBridge as registerStoryblokBridge };
-export { default as apiPlugin } from "./modules/api";
-export { default as storyblokEditable } from "./modules/editable";
-export { RichtextResolver as RichTextResolver, RichtextSchema as RichTextSchema, } from "storyblok-js-client";
-export * from "./types";
-export { BlockTypes, MarkTypes, richTextResolver, TextTypes, type StoryblokRichTextOptions, type StoryblokRichTextDocumentNode, type StoryblokRichTextNodeTypes, type StoryblokRichTextNode, type StoryblokRichTextResolvers, type StoryblokRichTextNodeResolver, type StoryblokRichTextImageOptimizationOptions, } from "@storyblok/richtext";
+import { ISbComponentType, ISbConfig, ISbStoryData, default as StoryblokJSClient } from 'storyblok-js-client';
+export type StoryblokClient = StoryblokJSClient;
+declare global {
+    interface Window {
+        storyblokRegisterEvent: (cb: () => void) => void;
+        StoryblokBridge: {
+            new (options?: StoryblokBridgeConfigV2): StoryblokBridgeV2;
+        };
+    }
+}
+export interface SbInitResult {
+    storyblokApi?: StoryblokClient;
+}
+export type SbPluginFactory = (options: SbSDKOptions) => any;
+export type SbBlokKeyDataTypes = string | number | object | boolean | undefined;
+export interface SbBlokData extends ISbComponentType<string> {
+    [index: string]: SbBlokKeyDataTypes;
+}
+export interface SbRichTextOptions {
+    schema?: ISbConfig['richTextSchema'];
+    resolver?: ISbConfig['componentResolver'];
+}
+export interface SbSDKOptions {
+    bridge?: boolean;
+    accessToken?: string;
+    use?: any[];
+    apiOptions?: ISbConfig;
+    richText?: SbRichTextOptions;
+    bridgeUrl?: string;
+}
+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 | string[];
+    customParent?: string;
+    preventClicks?: boolean;
+    language?: string;
+    resolveLinks?: 'url' | 'story' | '0' | '1' | 'link';
+}
+export interface StoryblokBridgeV2 {
+    pingEditor: (event: any) => void;
+    isInEditor: () => boolean;
+    enterEditmode: () => void;
+    on: (event: 'customEvent' | 'published' | 'input' | 'change' | 'unpublished' | 'enterEditmode' | string[], callback: (payload?: ISbEventPayload) => void) => void;
+}
+export type { ArrayFn, AsyncFn, ISbAlternateObject, // previously AlternateObject
+ISbCache, // previously StoryblokCache
+ISbComponentType as StoryblokComponentType, ISbConfig, // previously StoryblokConfig
+ISbContentMangmntAPI, ISbDimensions, ISbError, ISbManagmentApiResult, // previously StoryblokManagmentApiResult
+ISbNode, ISbResponse, ISbResult, // previously StoryblokResult
+ISbRichtext, // previously Richtext
+ISbSchema, ISbStories, // previously Stories
+ISbStoriesParams, // previously StoriesParams
+ISbStory, // previously Story
+ISbStoryData, // previously StoryData
+ISbStoryParams, // previously StoryParams
+ISbThrottle, ISbThrottledRequest, } from 'storyblok-js-client';

package/package.json

@@ -1,90 +1,82 @@
 {
   "name": "@storyblok/js",
-  "version": "3.1.9",
+  "type": "module",
+  "version": "3.2.1",
+  "private": false,
+  "packageManager": "pnpm@9.15.1",
   "description": "SDK to integrate Storyblok into your project using JavaScript.",
-  "main": "./dist/storyblok-js.js",
-  "module": "./dist/storyblok-js.mjs",
-  "types": "./dist/types/index.d.ts",
-  "files": [
-    "dist"
-  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/storyblok/storyblok-js"
+  },
+  "bugs": {
+    "url": "https://github.com/storyblok/storyblok-js/issues"
+  },
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/index.d.ts",
       "import": "./dist/storyblok-js.mjs",
       "require": "./dist/storyblok-js.js"
     }
   },
+  "main": "./dist/storyblok-js.js",
+  "module": "./dist/storyblok-js.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "scripts": {
-    "dev": "vite build --watch",
-    "build": "vite build && tsc --project tsconfig.json",
-    "test": "npm run test:unit && npm run test:e2e",
-    "test:unit": "vitest run",
+    "dev": "vite",
+    "build": "vite build",
+    "test": "pnpm run test:unit:ci && pnpm run test:e2e",
+    "test:unit": "vitest",
+    "test:unit:ci": "vitest run",
+    "test:unit:ui": "vitest --ui",
     "test:e2e": "start-server-and-test cy:playground http://localhost:5173/ cy:run",
     "test:e2e-watch": "start-server-and-test cy:playground http://localhost:5173/ cy:open",
-    "cy:playground": "npm run demo --prefix ../playground",
+    "cy:playground": "pnpm --filter='./playground/vanilla' dev",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
     "cy:run": "cypress run",
-    "cy:open": "cypress open",
-    "prepublishOnly": "npm run build && cp ../README.md ./"
+    "cy:open": "cypress open"
   },
   "dependencies": {
-    "@storyblok/richtext": "^3.0.0",
-    "storyblok-js-client": "^6.10.3"
+    "@storyblok/richtext": "3.0.2",
+    "storyblok-js-client": "6.10.6"
   },
   "devDependencies": {
+    "@commitlint/cli": "^19.6.1",
+    "@commitlint/config-conventional": "^19.6.0",
+    "@storyblok/eslint-config": "^0.3.0",
     "@tsconfig/recommended": "^1.0.8",
-    "cypress": "^13.16.0",
-    "eslint-plugin-cypress": "^2.15.2",
-    "eslint-plugin-jest": "^28.9.0",
-    "isomorphic-fetch": "^3.0.0",
-    "start-server-and-test": "^2.0.8",
-    "vite": "^5.4.11",
-    "vitest": "^2.1.5"
+    "@types/node": "^22.10.2",
+    "cypress": "^13.17.0",
+    "eslint": "^9.17.0",
+    "eslint-plugin-cypress": "^4.1.0",
+    "kolorist": "^1.8.0",
+    "pathe": "^1.1.2",
+    "simple-git-hooks": "^2.11.1",
+    "start-server-and-test": "^2.0.9",
+    "typescript": "^5.7.2",
+    "vite": "^6.0.5",
+    "vite-plugin-banner": "^0.8.0",
+    "vite-plugin-dts": "^4.4.0",
+    "vite-plugin-qrcode": "^0.2.3",
+    "vitest": "^2.1.8"
   },
-  "babel": {
-    "presets": [
-      [
-        "@babel/preset-env",
-        {
-          "targets": {
-            "node": "current"
-          }
-        }
-      ]
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
     ]
   },
-  "jest": {
-    "moduleFileExtensions": [
-      "js",
-      "json"
-    ],
-    "transform": {
-      "^.+\\.js$": "babel-jest"
-    }
-  },
   "release": {
     "branches": [
-      "main",
-      {
-        "name": "next",
-        "prerelease": true
-      },
-      {
-        "name": "beta",
-        "prerelease": true
-      }
+      "main"
     ]
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/storyblok/storyblok-js"
-  },
-  "author": "Storyblok",
-  "bugs": {
-    "url": "https://github.com/storyblok/storyblok-js/issues"
-  },
-  "homepage": "https://github.com/storyblok/storyblok-js",
-  "publishConfig": {
-    "access": "public"
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint",
+    "pre-push": "pnpm commitlint --last --verbose"
   }
 }

package/dist/types/modules/editable.d.ts

@@ -1,9 +0,0 @@
-import { SbBlokData } from "../types";
-declare const _default: (blok: SbBlokData) => {
-    "data-blok-c"?: undefined;
-    "data-blok-uid"?: undefined;
-} | {
-    "data-blok-c": string;
-    "data-blok-uid": string;
-};
-export default _default;

package/dist/types/types.d.ts

@@ -1,63 +0,0 @@
-import StoryblokJSClient, { ISbConfig, ISbComponentType, ISbStoryData } from "storyblok-js-client";
-export type StoryblokClient = StoryblokJSClient;
-declare global {
-    interface Window {
-        storyblokRegisterEvent: (cb: Function) => void;
-        StoryblokBridge: {
-            new (options?: StoryblokBridgeConfigV2): StoryblokBridgeV2;
-        };
-    }
-}
-export interface SbInitResult {
-    storyblokApi?: StoryblokClient;
-}
-export type SbPluginFactory = (options: SbSDKOptions) => any;
-export type SbBlokKeyDataTypes = string | number | object | boolean | undefined;
-export interface SbBlokData extends ISbComponentType<string> {
-    [index: string]: SbBlokKeyDataTypes;
-}
-export interface SbRichTextOptions {
-    schema?: ISbConfig["richTextSchema"];
-    resolver?: ISbConfig["componentResolver"];
-}
-export interface SbSDKOptions {
-    bridge?: boolean;
-    accessToken?: string;
-    use?: any[];
-    apiOptions?: ISbConfig;
-    richText?: SbRichTextOptions;
-    bridgeUrl?: string;
-}
-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 | string[];
-    customParent?: string;
-    preventClicks?: boolean;
-    language?: string;
-    resolveLinks?: "url" | "story" | "0" | "1" | "link";
-}
-export interface StoryblokBridgeV2 {
-    pingEditor: (event: any) => void;
-    isInEditor: () => boolean;
-    enterEditmode: () => void;
-    on: (event: "customEvent" | "published" | "input" | "change" | "unpublished" | "enterEditmode" | string[], callback: (payload?: ISbEventPayload) => void) => void;
-}
-export type { ISbConfig, // previously StoryblokConfig
-ISbCache, // previously StoryblokCache
-ISbResult, // previously StoryblokResult
-ISbResponse, ISbError, ISbNode, ISbSchema, ISbThrottle, ISbThrottledRequest, 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, } from "storyblok-js-client";