agent-cms 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,213 @@
+import { Context, Effect, Option } from "effect";
+
+//#region src/search/vectorize.d.ts
+/**
+ * Minimal structural type for Workers AI binding.
+ * Compatible with Cloudflare's `Ai` type from `wrangler types` — no cast needed.
+ */
+interface AiBinding {
+  run(model: string, input: {
+    text: string[];
+  }): Promise<unknown>;
+}
+/**
+ * Minimal structural type for Vectorize binding.
+ * Compatible with Cloudflare's `VectorizeIndex` type from `wrangler types` — no cast needed.
+ */
+interface VectorizeBinding {
+  upsert(vectors: Array<{
+    id: string;
+    values: number[];
+    metadata?: Record<string, string>;
+  }>): Promise<unknown>;
+  deleteByIds(ids: string[]): Promise<unknown>;
+  query(vector: number[], options: {
+    topK: number;
+    returnMetadata?: "all" | "none";
+  }): Promise<unknown>;
+}
+//#endregion
+//#region src/hooks.d.ts
+interface CmsHooks {
+  readonly onRecordCreate?: (event: {
+    modelApiKey: string;
+    recordId: string;
+  }) => void | Promise<void>;
+  readonly onRecordUpdate?: (event: {
+    modelApiKey: string;
+    recordId: string;
+  }) => void | Promise<void>;
+  readonly onRecordDelete?: (event: {
+    modelApiKey: string;
+    recordId: string;
+  }) => void | Promise<void>;
+  readonly onPublish?: (event: {
+    modelApiKey: string;
+    recordId: string;
+  }) => void | Promise<void>;
+  readonly onUnpublish?: (event: {
+    modelApiKey: string;
+    recordId: string;
+  }) => void | Promise<void>;
+}
+//#endregion
+//#region src/admin-client.d.ts
+interface CmsAdminClientConfig {
+  readonly endpoint: string;
+  readonly writeKey: string;
+  readonly fetch?: typeof globalThis.fetch;
+}
+interface CreateEditorTokenRequest {
+  readonly name: string;
+  readonly expiresIn?: number;
+}
+interface CreateEditorTokenResponse {
+  readonly id: string;
+  readonly token: string;
+  readonly tokenPrefix: string;
+  readonly name: string;
+  readonly createdAt: string;
+  readonly expiresAt: string | null;
+}
+interface EditorTokenListItem {
+  readonly id: string;
+  readonly name: string;
+  readonly token_prefix: string;
+  readonly created_at: string;
+  readonly last_used_at: string | null;
+  readonly expires_at: string | null;
+}
+declare function createCmsAdminClient(config: CmsAdminClientConfig): {
+  createEditorToken(input: CreateEditorTokenRequest): Promise<CreateEditorTokenResponse>;
+  listEditorTokens(): Promise<EditorTokenListItem[]>;
+  revokeEditorToken(id: string): Promise<{
+    ok: true;
+  }>;
+};
+//#endregion
+//#region src/editor-mcp-proxy.d.ts
+interface EditorMcpPrincipal {
+  readonly id: string;
+  readonly name: string;
+}
+interface EditorMcpProxyConfig {
+  readonly appBaseUrl: string;
+  readonly cmsBaseUrl: string;
+  readonly cmsWriteKey: string;
+  readonly oauthSecret: string;
+  readonly getEditor: (request: Request) => Promise<EditorMcpPrincipal | null>;
+  readonly getLoginUrl: (request: Request) => string | URL;
+  readonly mountPath?: string;
+  readonly oauthTokenTtlSeconds?: number;
+  readonly cmsTokenTtlSeconds?: number;
+  readonly resourceName?: string;
+  readonly fetch?: typeof globalThis.fetch;
+}
+interface EditorMcpProxyPaths {
+  readonly mountPath: string;
+  readonly issuer: string;
+  readonly mcpPath: string;
+  readonly authorizationPath: string;
+  readonly tokenPath: string;
+  readonly registrationPath: string;
+  readonly oauthAuthorizationServerMetadataPath: string;
+  readonly protectedResourceMetadataPath: string;
+}
+interface EditorMcpProxy {
+  readonly paths: EditorMcpProxyPaths;
+  fetch(request: Request): Promise<Response>;
+}
+declare function createEditorMcpProxy(config: EditorMcpProxyConfig): EditorMcpProxy;
+//#endregion
+//#region src/index.d.ts
+/** Explicit runtime bindings/config passed to agent-cms */
+interface CmsBindings {
+  db: D1Database;
+  assets?: R2Bucket;
+  environment?: "production" | "development";
+  /** Public URL base for assets (e.g. "https://my-cms.workers.dev") */
+  assetBaseUrl?: string;
+  /** Write API key — required for REST writes, MCP, publish/unpublish.
+   *  Like DatoCMS CMA token. Use any string for local dev (e.g. "dev"). */
+  writeKey?: string;
+  /** Workers AI binding for embedding generation (optional — enables vector search) */
+  ai?: AiBinding;
+  /** Vectorize index binding (optional — enables semantic search) */
+  vectorize?: VectorizeBinding;
+  /** R2 API token access key ID — enables presigned upload URLs */
+  r2AccessKeyId?: string;
+  /** R2 API token secret access key — enables presigned upload URLs */
+  r2SecretAccessKey?: string;
+  /** R2 bucket name — needed for presigned upload URLs */
+  r2BucketName?: string;
+  /** Cloudflare account ID — needed for the R2 S3-compatible endpoint */
+  cfAccountId?: string;
+}
+interface CmsHandlerConfig {
+  bindings: CmsBindings;
+  /** Lifecycle hooks fired on content events */
+  hooks?: CmsHooks;
+}
+/**
+ * Create the agent-cms fetch handler.
+ *
+ * Usage in your Worker's src/index.ts:
+ * ```typescript
+ * import { createCMSHandler } from "agent-cms";
+ *
+ * export default {
+ *   fetch: (request, env) => getHandler(env).fetch(request),
+ *   scheduled: (_controller, env) => getHandler(env).runScheduledTransitions(),
+ * };
+ *
+ * let cachedHandler: ReturnType<typeof createCMSHandler> | null = null;
+ *
+ * function getHandler(env: Env) {
+ *   if (!cachedHandler) {
+ *     cachedHandler = createCMSHandler({
+ *       bindings: {
+ *         db: env.DB,
+ *         assets: env.ASSETS,
+ *         environment: env.ENVIRONMENT,
+ *         assetBaseUrl: env.ASSET_BASE_URL,
+ *         writeKey: env.CMS_WRITE_KEY,
+ *         ai: env.AI,
+ *         vectorize: env.VECTORIZE,
+ *       },
+ *     });
+ *   }
+ *   return cachedHandler;
+ * }
+ * ```
+ */
+declare function createCMSHandler(config: CmsHandlerConfig): {
+  fetch: (request: Request) => Promise<Response>;
+  /**
+   * Execute a GraphQL query directly, without HTTP serialization.
+   * For in-process queries when CMS and site share a Worker.
+   * Skips CORS, auth, and request logging — caller is trusted.
+   */
+  execute: (query: string, variables?: Record<string, unknown>, context?: {
+    includeDrafts?: boolean;
+    excludeInvalid?: boolean;
+  }) => Promise<{
+    data: unknown;
+    errors?: ReadonlyArray<{
+      message: string;
+    }>;
+  }>; /** Run due scheduled publish/unpublish transitions. Safe to call from a cron trigger. */
+  runScheduledTransitions: (now?: Date) => Promise<{
+    now: string;
+    published: {
+      modelApiKey: string;
+      recordId: string;
+    }[];
+    unpublished: {
+      modelApiKey: string;
+      recordId: string;
+    }[];
+  }>;
+};
+//#endregion
+export { type CmsAdminClientConfig, CmsBindings, CmsHandlerConfig, type CmsHooks, type CreateEditorTokenRequest, type CreateEditorTokenResponse, type EditorMcpPrincipal, type EditorMcpProxy, type EditorMcpProxyConfig, type EditorMcpProxyPaths, type EditorTokenListItem, createCMSHandler, createCmsAdminClient, createEditorMcpProxy };
+//# sourceMappingURL=index.d.mts.map