@capacms/sdk 1.0.0-next.0

package/dist/webhooks.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WEBHOOKS_NEED_ACCESS_TOKEN = void 0;
+exports.createWebhooks = createWebhooks;
+const http_1 = require("./http");
+// ------------------------------------------------------------ the resource --
+exports.WEBHOOKS_NEED_ACCESS_TOKEN = "@capacms/sdk: webhooks need accessToken; API keys cannot manage endpoints.";
+const BASE = "/v2/webhooks";
+function endpointPath(id, suffix = "") {
+    return `${BASE}/endpoints/${encodeURIComponent(id)}${suffix}`;
+}
+function deliveryPath(id, suffix = "") {
+    return `${BASE}/deliveries/${encodeURIComponent(id)}${suffix}`;
+}
+function createWebhooks(resolved) {
+    /**
+     * Checked before every call rather than once in `createClient`, because a
+     * client built for reading content is legitimately built without a token and
+     * should not throw until somebody actually reaches for webhooks.
+     */
+    function requireToken() {
+        if (!resolved.accessToken)
+            throw new Error(exports.WEBHOOKS_NEED_ACCESS_TOKEN);
+    }
+    async function read(path, query = {}) {
+        requireToken();
+        const { body } = await (0, http_1.getJson)(resolved, path, query, "session");
+        return body;
+    }
+    async function write(method, path, body) {
+        requireToken();
+        return (0, http_1.writeJson)(resolved, method, path, body, "session");
+    }
+    /**
+     * A 404 is an ANSWER on `get`, not a failure: "no endpoint with that id in
+     * this tenant" is exactly what `null` means, and it is the same rule
+     * `scheduledActions.get` follows. Every other status still throws.
+     */
+    async function readOrNull(path) {
+        try {
+            return await read(path);
+        }
+        catch (err) {
+            if (err?.status === 404)
+                return null;
+            throw err;
+        }
+    }
+    return {
+        async events() {
+            const body = await read(`${BASE}/events`);
+            return body.events ?? [];
+        },
+        endpoints: {
+            async list() {
+                const body = await read(`${BASE}/endpoints`);
+                return body.endpoints ?? [];
+            },
+            async create(input) {
+                // Refused here rather than by the API, because both are 400s the caller
+                // can avoid and the message says which one they hit.
+                if (!input?.name)
+                    throw new Error("@capacms/sdk: webhooks.endpoints.create needs a name.");
+                if (!input?.url)
+                    throw new Error("@capacms/sdk: webhooks.endpoints.create needs a url.");
+                if (!input?.events?.length) {
+                    throw new Error("@capacms/sdk: webhooks.endpoints.create needs at least one event. " +
+                        "Read webhooks.events() for the catalogue, or subscribe to a wildcard like \"instance.*\".");
+                }
+                return write("POST", `${BASE}/endpoints`, input);
+            },
+            async get(id) {
+                return readOrNull(endpointPath(id));
+            },
+            async update(id, patch) {
+                return write("PATCH", endpointPath(id), patch ?? {});
+            },
+            async delete(id) {
+                const body = await write("DELETE", endpointPath(id));
+                return body?.deleted === true;
+            },
+            async pause(id) {
+                return write("POST", endpointPath(id, "/pause"), {});
+            },
+            async resume(id, options = {}) {
+                return write("POST", endpointPath(id, "/resume"), 
+                // Both keys are sent only when asked for. `backfill: false` and an
+                // absent `backfill` mean the same thing to the route, and sending
+                // `since: undefined` would serialise to nothing anyway.
+                {
+                    ...(options.backfill ? { backfill: true } : {}),
+                    ...(options.since ? { since: options.since } : {}),
+                });
+            },
+            async revealSecret(id) {
+                return write("POST", endpointPath(id, "/secret/reveal"), {});
+            },
+            async rotateSecret(id) {
+                return write("POST", endpointPath(id, "/secret/rotate"), {});
+            },
+            async test(id) {
+                return write("POST", endpointPath(id, "/test"), {});
+            },
+            async deliveries(id, options = {}) {
+                const body = await read(endpointPath(id, "/deliveries"), {
+                    status: options.status?.length ? options.status.join(",") : undefined,
+                    eventType: options.eventType,
+                    page: options.page,
+                    limit: options.limit,
+                });
+                return {
+                    deliveries: body.deliveries ?? [],
+                    pagination: body.pagination ?? { total: 0, page: 1, limit: 0, totalPages: 0, hasMore: false },
+                };
+            },
+            async redeliverFailed(id, options = {}) {
+                const body = await write("POST", endpointPath(id, "/redeliver-failed"), options.since ? { since: options.since } : {});
+                return { created: body?.created ?? 0 };
+            },
+        },
+        deliveries: {
+            async get(id) {
+                return readOrNull(deliveryPath(id));
+            },
+            async redeliver(id) {
+                return write("POST", deliveryPath(id, "/redeliver"), {});
+            },
+        },
+    };
+}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@capacms/sdk",
+  "version": "1.0.0-next.0",
+  "license": "UNLICENSED",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ZVN-DEV/capa-cms-future.git",
+    "directory": "packages/sdk"
+  },
+  "homepage": "https://github.com/ZVN-DEV/capa-cms-future/tree/main/packages/sdk#readme",
+  "bugs": {
+    "url": "https://github.com/ZVN-DEV/capa-cms-future/issues"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "bin",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "tag": "next"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./next": {
+      "types": "./dist/next/index.d.ts",
+      "default": "./dist/next/index.js"
+    },
+    "./nextjs": {
+      "types": "./dist/nextjs/index.d.ts",
+      "default": "./dist/nextjs/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "next": [
+        "dist/next/index.d.ts"
+      ],
+      "nextjs": [
+        "dist/nextjs/index.d.ts"
+      ],
+      "*": [
+        "dist/index.d.ts"
+      ]
+    }
+  },
+  "bin": {
+    "capa-codegen": "bin/capa-codegen.js"
+  },
+  "devDependencies": {
+    "typescript": "^5.5.0",
+    "@capa/shared": "0.1.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "tsc -p tsconfig.json && node --test test/codegen.test.js test/client.test.js test/next-client.test.js test/nextjs.test.js test/webhooks.test.js && tsc -p test/types/tsconfig.consumer.json --noEmit"
+  }
+}