@kvasar/openclaw-storyblok-plugin 0.1.0 → 0.1.1

package/index.ts

@@ -0,0 +1,277 @@
+/**
+ * index.ts — OpenClaw Storyblok Plugin
+ *
+ * Tools for interacting with Storyblok Management API and Delivery API.
+ * Authentication:
+ * - managementToken required for write operations
+ * - previewToken optional for read operations
+ */
+
+import { Type } from "@sinclair/typebox";
+import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
+
+import { StoryblokClient } from "./src/client.js";
+import { validateConfig, redactTokens } from "./src/config.js";
+
+interface StoryblokPluginConfig {
+  baseUrl?: string;
+  spaceId?: string;
+  managementToken?: string;
+  previewToken?: string;
+}
+
+function ok(data: unknown) {
+  return {
+    content: [
+      {
+        type: "text",
+        text: JSON.stringify(data, null, 2),
+      },
+    ],
+    metadata: { storyblok: true },
+  };
+}
+
+function fail(error: unknown) {
+  return {
+    content: [
+      {
+        type: "text",
+        text: `❌ Storyblok: ${String(error)}`,
+      },
+    ],
+    isError: true,
+  };
+}
+
+function safeError(error: unknown, cfg: StoryblokPluginConfig) {
+  return fail(
+    redactTokens(String((error as any)?.message ?? error), cfg)
+  );
+}
+
+export default definePluginEntry({
+  id: "openclaw-storyblok",
+  name: "Storyblok Integration",
+  description:
+    "Interact with Storyblok CMS: manage stories, components, and space information.",
+
+  register(api) {
+    const rawCfg = (
+      (api as { pluginConfig?: unknown; config?: unknown }).pluginConfig ??
+      (api as { pluginConfig?: unknown; config?: unknown }).config ??
+      {}
+    ) as StoryblokPluginConfig;
+
+    const cfg: StoryblokPluginConfig = {
+      baseUrl: rawCfg.baseUrl ?? "https://api.storyblok.com",
+      spaceId: rawCfg.spaceId,
+      managementToken: rawCfg.managementToken,
+      previewToken: rawCfg.previewToken,
+    };
+
+    try {
+      validateConfig(cfg);
+    } catch (error) {
+      console.warn(
+        "[openclaw-storyblok] Config validation warning:",
+        error
+      );
+    }
+
+    const client = new StoryblokClient(cfg);
+
+    api.registerTool({
+      name: "storyblok_get_space",
+      description: "Retrieve Storyblok space details.",
+      parameters: Type.Object({}),
+      async execute() {
+        try {
+          return ok(await client.getSpace());
+        } catch (error) {
+          return safeError(error, cfg);
+        }
+      },
+    });
+
+    api.registerTool({
+      name: "storyblok_get_story",
+      description:
+        "Retrieve a story by ID, UUID, or slug.",
+      parameters: Type.Object({
+        identifier: Type.String({
+          description: "Story ID, UUID, or slug",
+        }),
+        version: Type.Optional(
+          Type.String({
+            description: "'draft' or 'published'",
+          })
+        ),
+        language: Type.Optional(Type.String()),
+        svg_render: Type.Optional(Type.Boolean()),
+      }),
+      async execute(
+        _id: string,
+        params: {
+          identifier: string;
+          version?: string;
+          language?: string;
+          svg_render?: boolean;
+        }
+      ) {
+        try {
+          return ok(
+            await client.getStory(params.identifier, {
+              version: params.version,
+              language: params.language,
+              svg_render: params.svg_render,
+            })
+          );
+        } catch (error) {
+          return safeError(error, cfg);
+        }
+      },
+    });
+
+    api.registerTool({
+      name: "storyblok_list_stories",
+      description: "List stories with optional filters.",
+      parameters: Type.Object({
+        folder_id: Type.Optional(Type.Number()),
+        parent_id: Type.Optional(Type.Number()),
+        status: Type.Optional(Type.String()),
+        tag: Type.Optional(Type.String()),
+        per_page: Type.Optional(Type.Number()),
+        page: Type.Optional(Type.Number()),
+        sort_by: Type.Optional(Type.String()),
+        direction: Type.Optional(Type.String()),
+      }),
+      async execute(_id: string, params: Record<string, any>) {
+        try {
+          return ok(await client.listStories(params));
+        } catch (error) {
+          return safeError(error, cfg);
+        }
+      },
+    });
+
+    api.registerTool({
+      name: "storyblok_create_story",
+      description: "Create a new story.",
+      parameters: Type.Object({
+        title: Type.String(),
+        slug: Type.Optional(Type.String()),
+        folder_id: Type.Optional(Type.Number()),
+        parent_id: Type.Optional(Type.Number()),
+        content: Type.Optional(
+          Type.Record(Type.String(), Type.Any())
+        ),
+        tags: Type.Optional(Type.Array(Type.String())),
+        is_folder: Type.Optional(Type.Boolean()),
+        language: Type.Optional(Type.String()),
+      }),
+      async execute(_id: string, params: Record<string, any>) {
+        try {
+          return ok(await client.createStory(params));
+        } catch (error) {
+          return safeError(error, cfg);
+        }
+      },
+    });
+
+    api.registerTool({
+      name: "storyblok_update_story",
+      description: "Update an existing story.",
+      parameters: Type.Object({
+        story_id: Type.String(),
+        title: Type.Optional(Type.String()),
+        slug: Type.Optional(Type.String()),
+        content: Type.Optional(
+          Type.Record(Type.String(), Type.Any())
+        ),
+        parent_id: Type.Optional(Type.Number()),
+        tags: Type.Optional(Type.Array(Type.String())),
+        language: Type.Optional(Type.String()),
+        version: Type.Optional(Type.String()),
+      }),
+      async execute(_id: string, params: Record<string, any>) {
+        try {
+          return ok(
+            await client.updateStory(
+              params.story_id,
+              params
+            )
+          );
+        } catch (error) {
+          return safeError(error, cfg);
+        }
+      },
+    });
+
+    api.registerTool({
+      name: "storyblok_publish_story",
+      description: "Publish a story.",
+      parameters: Type.Object({
+        story_id: Type.String(),
+        version: Type.Optional(Type.String()),
+        language: Type.Optional(Type.String()),
+        publish_notes: Type.Optional(Type.String()),
+      }),
+      async execute(_id: string, params: Record<string, any>) {
+        try {
+          return ok(
+            await client.publishStory(params.story_id, {
+              version: params.version,
+              language: params.language,
+              publish_notes: params.publish_notes,
+            })
+          );
+        } catch (error) {
+          return safeError(error, cfg);
+        }
+      },
+    });
+
+    api.registerTool({
+      name: "storyblok_unpublish_story",
+      description: "Unpublish a story.",
+      parameters: Type.Object({
+        story_id: Type.String(),
+        language: Type.Optional(Type.String()),
+      }),
+      async execute(_id: string, params: Record<string, any>) {
+        try {
+          return ok(
+            await client.unpublishStory(
+              params.story_id,
+              params.language
+            )
+          );
+        } catch (error) {
+          return safeError(error, cfg);
+        }
+      },
+    });
+
+    api.registerTool({
+      name: "storyblok_get_components",
+      description: "Get component schemas.",
+      parameters: Type.Object({
+        version: Type.Optional(Type.String()),
+        language: Type.Optional(Type.String()),
+      }),
+      async execute(_id: string, params: Record<string, any>) {
+        try {
+          return ok(
+            await client.getComponents(
+              params.version,
+              params.language
+            )
+          );
+        } catch (error) {
+          return safeError(error, cfg);
+        }
+      },
+    });
+  },
+});

package/openclaw.plugin.json

@@ -2,7 +2,7 @@
   "id": "openclaw-storyblok",
   "kind": "tool",
   "name": "Storyblok Integration",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Provides tools to interact with Storyblok CMS via Management API and Delivery API. Supports stories, components, and space management.",
   "configSchema": {
     "type": "object",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kvasar/openclaw-storyblok-plugin",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "OpenClaw plugin — interact with Storyblok CMS via Management API and Delivery API",
   "type": "module",
   "main": "./index.ts",
@@ -8,6 +8,7 @@
     "index.ts",
     "src/",
     "openclaw.plugin.json",
+    "skills/",
     "tsconfig.json",
     "README.md"
   ],
@@ -19,7 +20,9 @@
     "check": "tsc --noEmit && vitest run"
   },
   "openclaw": {
-    "extensions": ["./index.ts"],
+    "extensions": [
+      "./index.ts"
+    ],
     "tools": [
       "storyblok_get_space",
       "storyblok_get_story",
@@ -39,6 +42,11 @@
     "@types/node": "^22.0.0",
     "vitest": "^1.6.0"
   },
-  "keywords": ["openclaw", "plugin", "storyblok", "cms"],
+  "keywords": [
+    "openclaw",
+    "plugin",
+    "storyblok",
+    "cms"
+  ],
   "license": "MIT"
-}
+}

package/src/index.ts

@@ -1,228 +0,0 @@
-/**
- * index.ts — OpenClaw Storyblok Plugin
- *
- * Tools for interacting with Storyblok Management API and Delivery API.
- * Authentication: Management token required for writes; preview token optional for reads.
- */
-
-import { Type } from "@sinclair/typebox";
-import { StoryblokClient } from "./client.js";
-import { validateConfig, redactTokens } from "./config.js";
-
-const definePluginEntry = <T>(def: T): T => def;
-
-// Shared response helpers
-function ok(data: any) {
-  return { content: [{ type: "text", text: JSON.stringify(data, null, 2) }], metadata: { storyblok: true } };
-}
-
-function fail(error: string) {
-  return { content: [{ type: "text", text: `❌ Storyblok: ${error}` }], isError: true };
-}
-
-export default definePluginEntry({
-  id: "openclaw-storyblok",
-  name: "Storyblok Integration",
-  description: "Interact with Storyblok CMS: manage stories, components, and space information.",
-  register(api: { config?: unknown; registerTool: (def: any, opts?: { optional?: boolean }) => void }) {
-    const rawCfg = (api.config ?? {}) as Record<string, any>;
-    validateConfig(rawCfg);
-    const cfg = {
-      baseUrl: rawCfg.baseUrl ?? "https://api.storyblok.com",
-      spaceId: rawCfg.spaceId,
-      managementToken: rawCfg.managementToken,
-      previewToken: rawCfg.previewToken,
-    };
-    const client = new StoryblokClient(cfg);
-
-    // ── storyblok_get_space ─────────────────────────────────────────────────────
-    api.registerTool({
-      name: "storyblok_get_space",
-      description: "Retrieve Storyblok space details.",
-      parameters: Type.Object({}),
-      async execute(_id: string, _params: {}) {
-        try {
-          const result = await client.getSpace();
-          return ok(result);
-        } catch (e: any) {
-          return fail(redactTokens(e.message, cfg));
-        }
-      },
-    });
-
-    // ── storyblok_get_story ─────────────────────────────────────────────────────
-    api.registerTool({
-      name: "storyblok_get_story",
-      description: "Retrieve a story by ID, UUID, or slug. Use preview token for published version, management token for draft.",
-      parameters: Type.Object({
-        identifier: Type.String({ description: "Story ID, UUID, or slug" }),
-        version: Type.Optional(Type.String({ description: "Version to fetch: 'draft' (default) or 'published'" })),
-        language: Type.Optional(Type.String({ description: "Language code (e.g., 'en') for multilingual spaces" })),
-        svg_render: Type.Optional(Type.Boolean({ description: "If true, returns SVG render of the story (experimental)" })),
-      }),
-      async execute(_id: string, params: { identifier: string; version?: string; language?: string; svg_render?: boolean }) {
-        try {
-          const result = await client.getStory(params.identifier, { version: params.version, language: params.language, svg_render: params.svg_render });
-          return ok(result);
-        } catch (e: any) {
-          return fail(redactTokens(e.message, cfg));
-        }
-      },
-    });
-
-    // ── storyblok_list_stories ───────────────────────────────────────────────────
-    api.registerTool({
-      name: "storyblok_list_stories",
-      description: "List stories with optional filters (folder, status, tags, etc.).",
-      parameters: Type.Object({
-        folder_id: Type.Optional(Type.Number({ description: "Filter by folder ID" })),
-        parent_id: Type.Optional(Type.Number({ description: "Filter by parent story ID" })),
-        status: Type.Optional(Type.String({ description: "Filter by status: 'draft', 'published'" })),
-        tag: Type.Optional(Type.String({ description: "Filter by tag" })),
-        per_page: Type.Optional(Type.Number({ description: "Number of results per page (max 100)", minimum: 1, maximum: 100 })),
-        page: Type.Optional(Type.Number({ description: "Page number (starting from 1)", minimum: 1 })),
-        sort_by: Type.Optional(Type.String({ description: "Sort field (e.g., 'created_at', 'published_at')" })),
-        direction: Type.Optional(Type.String({ description: "Sort direction: 'asc' or 'desc'" })),
-      }),
-      async execute(_id: string, params: {
-        folder_id?: number;
-        parent_id?: number;
-        status?: string;
-        tag?: string;
-        per_page?: number;
-        page?: number;
-        sort_by?: string;
-        direction?: string;
-      }) {
-        try {
-          const result = await client.listStories(params);
-          return ok(result);
-        } catch (e: any) {
-          return fail(redactTokens(e.message, cfg));
-        }
-      },
-    });
-
-    // ── storyblok_create_story ───────────────────────────────────────────────────
-    api.registerTool({
-      name: "storyblok_create_story",
-      description: "Create a new story (optionally in a folder). By default creates a draft.",
-      parameters: Type.Object({
-        title: Type.String({ description: "Story title" }),
-        slug: Type.Optional(Type.String({ description: "URL slug (autogenerated if omitted)" })),
-        folder_id: Type.Optional(Type.Number({ description: "Folder ID to place the story in" })),
-        parent_id: Type.Optional(Type.Number({ description: "Parent story ID for nested stories" })),
-        content: Type.Optional(Type.Record(Type.String(), Type.Any())),
-        tags: Type.Optional(Type.Array(Type.String())),
-        is_folder: Type.Optional(Type.Boolean({ description: "If true, creates a folder instead of a story" })),
-        language: Type.Optional(Type.String({ description: "Language code for multilingual spaces" })),
-      }),
-      async execute(_id: string, params: {
-        title: string;
-        slug?: string;
-        folder_id?: number;
-        parent_id?: number;
-        content?: Record<string, any>;
-        tags?: string[];
-        is_folder?: boolean;
-        language?: string;
-      }) {
-        try {
-          const result = await client.createStory(params);
-          return ok(result);
-        } catch (e: any) {
-          return fail(redactTokens(e.message, cfg));
-        }
-      },
-    });
-
-    // ── storyblok_update_story ───────────────────────────────────────────────────
-    api.registerTool({
-      name: "storyblok_update_story",
-      description: "Update a story (draft or published). Use with caution on published stories.",
-      parameters: Type.Object({
-        story_id: Type.String({ description: "Story ID or UUID" }),
-        title: Type.Optional(Type.String({ description: "New title" })),
-        slug: Type.Optional(Type.String({ description: "New slug" })),
-        content: Type.Optional(Type.Record(Type.String(), Type.Any())),
-        parent_id: Type.Optional(Type.Number({ description: "New parent ID" })),
-        tags: Type.Optional(Type.Array(Type.String())),
-        language: Type.Optional(Type.String({ description: "Language code" })),
-        version: Type.Optional(Type.String({ description: "Which version to update: 'draft' (default) or 'published'" })),
-      }),
-      async execute(_id: string, params: {
-        story_id: string;
-        title?: string;
-        slug?: string;
-        content?: Record<string, any>;
-        parent_id?: number;
-        tags?: string[];
-        language?: string;
-        version?: string;
-      }) {
-        try {
-          const result = await client.updateStory(params.story_id, params);
-          return ok(result);
-        } catch (e: any) {
-          return fail(redactTokens(e.message, cfg));
-        }
-      },
-    });
-
-    // ── storyblok_publish_story ──────────────────────────────────────────────────
-    api.registerTool({
-      name: "storyblok_publish_story",
-      description: "Publish a story (from draft). Optionally set a version note.",
-      parameters: Type.Object({
-        story_id: Type.String({ description: "Story ID or UUID" }),
-        version: Type.Optional(Type.String({ description: "Version to publish: usually 'draft' to publish the latest draft" })),
-        language: Type.Optional(Type.String({ description: "Language code" })),
-        publish_notes: Type.Optional(Type.String({ description: "Version note / changelog" })),
-      }),
-      async execute(_id: string, params: { story_id: string; version?: string; language?: string; publish_notes?: string }) {
-        try {
-          const result = await client.publishStory(params.story_id, { version: params.version, language: params.language, publish_notes: params.publish_notes });
-          return ok(result);
-        } catch (e: any) {
-          return fail(redactTokens(e.message, cfg));
-        }
-      },
-    });
-
-    // ── storyblok_unpublish_story ───────────────────────────────────────────────
-    api.registerTool({
-      name: "storyblok_unpublish_story",
-      description: "Unpublish a story (makes it draft-only).",
-      parameters: Type.Object({
-        story_id: Type.String({ description: "Story ID or UUID" }),
-        language: Type.Optional(Type.String({ description: "Language code" })),
-      }),
-      async execute(_id: string, params: { story_id: string; language?: string }) {
-        try {
-          const result = await client.unpublishStory(params.story_id, params.language);
-          return ok(result);
-        } catch (e: any) {
-          return fail(redactTokens(e.message, cfg));
-        }
-      },
-    });
-
-    // ── storyblok_get_components ─────────────────────────────────────────────────
-    api.registerTool({
-      name: "storyblok_get_components",
-      description: "Retrieve the list of component schemas (blok types) defined in the space.",
-      parameters: Type.Object({
-        version: Type.Optional(Type.String({ description: "Version: 'draft' (default) or 'published'" })),
-        language: Type.Optional(Type.String({ description: "Language code for localized component definitions" })),
-      }),
-      async execute(_id: string, params: { version?: string; language?: string }) {
-        try {
-          const result = await client.getComponents(params.version, params.language);
-          return ok(result);
-        } catch (e:any) {
-          return fail(redactTokens(e.message, cfg));
-        }
-      },
-    });
-  },
-});