@kvasar/openclaw-storyblok-plugin 0.1.13 → 0.1.14

package/index.ts

@@ -0,0 +1,247 @@
+/**
+ * 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, type StoryblokConfig } from "./src/client.js";
+import { redactTokens } from "./src/config.js";
+
+interface StoryblokPluginConfig {
+  baseUrl?: string;
+  spaceId?: string;
+  managementToken?: string;
+  previewToken?: string;
+}
+
+interface OpenClawPluginApi {
+  pluginConfig?: unknown;
+  config?: unknown;
+  registerTool(tool: {
+    name: string;
+    description: string;
+    parameters: unknown;
+    execute: (_id?: string, params?: any) => Promise<unknown> | unknown;
+  }): void;
+}
+
+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,
+  };
+}
+
+export default definePluginEntry({
+  id: "openclaw-storyblok",
+  name: "Storyblok Integration",
+  description:
+    "Interact with Storyblok CMS: manage stories, components, and space information.",
+
+  register(api: OpenClawPluginApi) {
+    function resolveClient() {
+      const rawCfg = (api.pluginConfig ?? api.config ?? {}) as StoryblokPluginConfig;
+
+      const cfg: StoryblokPluginConfig = {
+        baseUrl: rawCfg.baseUrl ?? "https://api.storyblok.com",
+        spaceId: rawCfg.spaceId,
+        managementToken: rawCfg.managementToken,
+        previewToken: rawCfg.previewToken,
+      };
+
+      const clientCfg: StoryblokConfig = {
+        baseUrl: cfg.baseUrl!,
+        spaceId: cfg.spaceId ?? "",
+        managementToken: cfg.managementToken ?? "",
+        previewToken: cfg.previewToken,
+      };
+
+      return {
+        client: new StoryblokClient(clientCfg),
+        cfg,
+      };
+    }
+
+    async function executeSafely<T>(
+      handler: (client: StoryblokClient, params?: T) => Promise<unknown>,
+      params?: T
+    ) {
+      const { client, cfg } = resolveClient();
+
+      try {
+        return ok(await handler(client, params));
+      } catch (error) {
+        return fail(
+          redactTokens(String((error as any)?.message ?? error), cfg)
+        );
+      }
+    }
+
+    api.registerTool({
+      name: "storyblok_get_space",
+      description: "Retrieve Storyblok space details.",
+      parameters: Type.Object({}),
+      execute() {
+        return executeSafely((client) => client.getSpace());
+      },
+    });
+
+    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()),
+      }),
+      execute(_id, params) {
+        return executeSafely((client, p: any) =>
+          client.getStory(p.identifier, {
+            version: p.version,
+            language: p.language,
+            svg_render: p.svg_render,
+          }),
+          params
+        );
+      },
+    });
+
+    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()),
+      }),
+      execute(_id, params) {
+        return executeSafely((client, p) => client.listStories(p), params);
+      },
+    });
+
+    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()),
+      }),
+      execute(_id, params) {
+        return executeSafely((client, p) => client.createStory(p), params);
+      },
+    });
+
+    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()),
+      }),
+      execute(_id, params) {
+        return executeSafely((client, p: any) => {
+          const { story_id, ...update } = p;
+          return client.updateStory(story_id, update);
+        }, params);
+      },
+    });
+
+    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()),
+      }),
+      execute(_id, params) {
+        return executeSafely((client, p: any) =>
+          client.publishStory(p.story_id, {
+            version: p.version,
+            language: p.language,
+            publish_notes: p.publish_notes,
+          }),
+          params
+        );
+      },
+    });
+
+    api.registerTool({
+      name: "storyblok_unpublish_story",
+      description: "Unpublish a story.",
+      parameters: Type.Object({
+        story_id: Type.String(),
+        language: Type.Optional(Type.String()),
+      }),
+      execute(_id, params) {
+        return executeSafely((client, p: any) =>
+          client.unpublishStory(p.story_id, p.language),
+          params
+        );
+      },
+    });
+
+    api.registerTool({
+      name: "storyblok_get_components",
+      description: "Get component schemas.",
+      parameters: Type.Object({
+        version: Type.Optional(Type.String()),
+        language: Type.Optional(Type.String()),
+      }),
+      execute(_id, params) {
+        return executeSafely((client, p: any) =>
+          client.getComponents(p.version, p.language),
+          params
+        );
+      },
+    });
+  },
+});

package/openclaw.plugin.json

@@ -1,7 +1,7 @@
 {
   "id": "openclaw-storyblok",
   "name": "Storyblok Integration",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "description": "Provides tools to interact with Storyblok CMS via Management API and Delivery API. Supports stories, components, and space management.",
     "activation": {
     "onStartup": false

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@kvasar/openclaw-storyblok-plugin",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "description": "OpenClaw plugin — interact with Storyblok CMS via Management API and Delivery API",
   "type": "module",
-  "main": "./dist/index.js",
+  "main": "./index.ts",
   "files": [
-    "dist/",
+    "index.ts",
+    "src/",
     "openclaw.plugin.json",
     "skills/",
     "tsconfig.json",

package/src/__tests__/README.md

@@ -0,0 +1,115 @@
+# Storyblok Plugin (thin client) — OpenClaw
+
+Thin‑client OpenClaw plugin that calls an external REST service to generate Storyblok pages via AI.
+
+## Quick Start
+
+### 1. Clone the plugin repository
+
+```bash
+git clone git@bitbucket.org:scaledagilequa/openclaw-storyblok-plugin.git
+cd openclaw-storyblok-plugin
+```
+
+### 2. Install dependencies
+
+```bash
+npm install
+```
+
+### 3. Build the plugin
+
+```bash
+npm run build
+```
+
+### 4. Configure OpenClaw
+
+Add the plugin to your OpenClaw configuration (`~/.openclaw/config.yaml` or equivalent):
+
+```yaml
+plugins:
+  - id: storyblok
+    config:
+      serviceUrl: "http://localhost:8000"   # base URL of your Storyblok AI service
+      apiKey: "optional-key"                # optional API key for the service
+```
+
+### 5. Restart OpenClaw
+
+Restart OpenClaw (or reload plugins) to activate the new plugin.
+
+## Plugin Configuration
+
+| Key | Type | Required | Default | Description |
+|-----|------|----------|---------|-------------|
+| `serviceUrl` | string | Yes | `http://localhost:8000` | Base URL of the Storyblok AI service (must be reachable from OpenClaw). |
+| `apiKey` | string | No | – | Optional API key if the service requires authentication. |
+
+## Tool
+
+### `storyblok_generate_page`
+
+Generates a Storyblok page by sending a prompt to the external AI service.
+
+**Parameters:**
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `prompt` | string | Description of the page you want to generate. |
+
+**Example usage (in OpenClaw chat):**
+
+```
+@assistant storyblok_generate_page prompt="Landing page for an AI consulting company"
+```
+
+**Response:**
+
+Returns the JSON response from the external service (typically containing the created story details).
+
+## Development
+
+### Prerequisites
+
+- Node.js 18+
+- npm or yarn
+
+### Building
+
+```bash
+npm run build
+```
+
+### Testing
+
+```bash
+npm test
+```
+
+### Type Checking
+
+```bash
+npm run typecheck
+```
+
+## Architecture
+
+```
+openclaw-storyblok-plugin/
+├── src/
+│   └── index.ts           # Plugin entry point (registers the tool)
+├── openclaw.plugin.json   # Plugin manifest
+├── package.json           # Dependencies and scripts
+└── tsconfig.json         # TypeScript configuration
+```
+
+The plugin uses `node-fetch` to call the external REST service. It is designed to be a thin client—all business logic resides in the separate Storyblok AI service.
+
+## Related Projects
+
+- **Storyblok AI Service**: Python FastAPI service that does the actual LLM generation and Storyblok integration. Available at `git@bitbucket.org:scaledagilequa/openclaw-storyblok.git`.
+
+## License
+
+MIT

package/src/__tests__/openclaw.plugin.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "https://openclaw.ai/schema/openclaw.plugin.v1.json",
+  "id": "storyblok",
+  "name": "Storyblok",
+  "description": "Thin‑client plugin for Storyblok AI page generation (calls external REST service)",
+  "version": "0.1.0",
+  "config": {
+    "serviceUrl": {
+      "type": "string",
+      "description": "Base URL of the Storyblok AI service (e.g., http://localhost:8000)",
+      "required": true,
+      "default": "http://localhost:8000"
+    },
+    "apiKey": {
+      "type": "string",
+      "description": "Optional API key for the service (if required)",
+      "secret": true,
+      "required": false
+    }
+  },
+  "tools": [
+    {
+      "name": "storyblok_generate_page",
+      "description": "Generate a Storyblok page via AI using the external service",
+      "parameters": {
+        "prompt": { "type": "string", "description": "Description of the page you want to generate" }
+      }
+    }
+  ]
+}