@stetcms/client 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,571 @@
+import { ContentModel, DEFAULT_ORIGIN, entryTypeName, fetchContentModel, renderContentModule } from "./codegen.js";
+import { ContractRouterClient, InferContractRouterInputs, InferContractRouterOutputs } from "@orpc/contract";
+import { z } from "zod";
+import { isDefinedError, safe } from "@orpc/client";
+
+//#region ../../internal/api/src/contract.d.ts
+declare const organizationSchema: z.ZodObject<{
+  id: z.ZodString;
+  name: z.ZodString;
+  slug: z.ZodString;
+  logo: z.ZodNullable<z.ZodString>;
+  createdAt: z.ZodISODateTime;
+}, z.core.$strip>;
+type Organization = z.infer<typeof organizationSchema>;
+declare const contentTypeSchema: z.ZodObject<{
+  slug: z.ZodString;
+  name: z.ZodString;
+  kind: z.ZodEnum<{
+    map: "map";
+    collection: "collection";
+  }>;
+  fields: z.ZodArray<z.ZodObject<{
+    key: z.ZodString;
+    name: z.ZodString;
+    type: z.ZodEnum<{
+      number: "number";
+      date: "date";
+      text: "text";
+      rich_text: "rich_text";
+      checkbox: "checkbox";
+      select: "select";
+      multi_select: "multi_select";
+      link: "link";
+      person: "person";
+      asset: "asset";
+      reference: "reference";
+      multi_reference: "multi_reference";
+    }>;
+    options: z.ZodArray<z.ZodObject<{
+      name: z.ZodString;
+      color: z.ZodString;
+    }, z.core.$strip>>;
+    collection: z.ZodOptional<z.ZodString>;
+    deprecated: z.ZodOptional<z.ZodObject<{
+      at: z.ZodISODateTime;
+      by: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+type ContentType = z.infer<typeof contentTypeSchema>;
+declare const contentEntrySchema: z.ZodObject<{
+  id: z.ZodString;
+  slug: z.ZodString;
+  title: z.ZodString;
+  fields: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+  createdAt: z.ZodISODateTime;
+  updatedAt: z.ZodISODateTime;
+}, z.core.$strip>;
+type ContentEntry = z.infer<typeof contentEntrySchema>;
+declare const contract: {
+  health: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodObject<{
+    status: z.ZodLiteral<"ok">;
+  }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
+    readonly RATE_LIMITED: {
+      readonly status: 429;
+      readonly message: "Too many requests. Try again shortly.";
+    };
+  }>, Record<never, never>>;
+  analytics: {
+    ingest: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+      context: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+      metadata: z.ZodDefault<z.ZodObject<{
+        visitor: z.ZodOptional<z.ZodString>;
+        country: z.ZodOptional<z.ZodString>;
+        region: z.ZodOptional<z.ZodString>;
+        city: z.ZodOptional<z.ZodString>;
+        browser: z.ZodOptional<z.ZodString>;
+        os: z.ZodOptional<z.ZodString>;
+        device: z.ZodOptional<z.ZodEnum<{
+          desktop: "desktop";
+          mobile: "mobile";
+          tablet: "tablet";
+        }>>;
+      }, z.core.$strip>>;
+      events: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        props: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        timestamp: z.ZodNumber;
+        url: z.ZodOptional<z.ZodString>;
+        referrer: z.ZodOptional<z.ZodString>;
+      }, z.core.$strip>>;
+    }, z.core.$strip>, z.ZodObject<{
+      accepted: z.ZodNumber;
+    }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
+      readonly RATE_LIMITED: {
+        readonly status: 429;
+        readonly message: "Too many requests. Try again shortly.";
+      };
+      readonly UNAUTHORIZED: {
+        readonly message: "Authentication required. Pass an organization API key in the `x-api-key` header.";
+      };
+    }>, Record<never, never>>;
+    sync: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+      events: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        props: z.ZodArray<z.ZodString>;
+      }, z.core.$strip>>;
+    }, z.core.$strip>, z.ZodObject<{
+      synced: z.ZodNumber;
+    }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
+      readonly RATE_LIMITED: {
+        readonly status: 429;
+        readonly message: "Too many requests. Try again shortly.";
+      };
+      readonly UNAUTHORIZED: {
+        readonly message: "Authentication required. Pass an organization API key in the `x-api-key` header.";
+      };
+    }>, Record<never, never>>;
+  };
+  content: {
+    model: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodObject<{
+      types: z.ZodArray<z.ZodObject<{
+        slug: z.ZodString;
+        name: z.ZodString;
+        kind: z.ZodEnum<{
+          map: "map";
+          collection: "collection";
+        }>;
+        fields: z.ZodArray<z.ZodObject<{
+          key: z.ZodString;
+          name: z.ZodString;
+          type: z.ZodEnum<{
+            number: "number";
+            date: "date";
+            text: "text";
+            rich_text: "rich_text";
+            checkbox: "checkbox";
+            select: "select";
+            multi_select: "multi_select";
+            link: "link";
+            person: "person";
+            asset: "asset";
+            reference: "reference";
+            multi_reference: "multi_reference";
+          }>;
+          options: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            color: z.ZodString;
+          }, z.core.$strip>>;
+          collection: z.ZodOptional<z.ZodString>;
+          deprecated: z.ZodOptional<z.ZodObject<{
+            at: z.ZodISODateTime;
+            by: z.ZodOptional<z.ZodString>;
+          }, z.core.$strip>>;
+        }, z.core.$strip>>;
+      }, z.core.$strip>>;
+    }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
+      readonly RATE_LIMITED: {
+        readonly status: 429;
+        readonly message: "Too many requests. Try again shortly.";
+      };
+      readonly UNAUTHORIZED: {
+        readonly message: "Authentication required. Pass an organization API key in the `x-api-key` header.";
+      };
+      readonly QUOTA_EXCEEDED: {
+        readonly status: 429;
+        readonly message: "The organization's API request limit for this period has been reached.";
+      };
+    }>, Record<never, never>>;
+    list: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+      type: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+      type: z.ZodObject<{
+        slug: z.ZodString;
+        name: z.ZodString;
+        kind: z.ZodEnum<{
+          map: "map";
+          collection: "collection";
+        }>;
+        fields: z.ZodArray<z.ZodObject<{
+          key: z.ZodString;
+          name: z.ZodString;
+          type: z.ZodEnum<{
+            number: "number";
+            date: "date";
+            text: "text";
+            rich_text: "rich_text";
+            checkbox: "checkbox";
+            select: "select";
+            multi_select: "multi_select";
+            link: "link";
+            person: "person";
+            asset: "asset";
+            reference: "reference";
+            multi_reference: "multi_reference";
+          }>;
+          options: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            color: z.ZodString;
+          }, z.core.$strip>>;
+          collection: z.ZodOptional<z.ZodString>;
+          deprecated: z.ZodOptional<z.ZodObject<{
+            at: z.ZodISODateTime;
+            by: z.ZodOptional<z.ZodString>;
+          }, z.core.$strip>>;
+        }, z.core.$strip>>;
+      }, z.core.$strip>;
+      entries: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        slug: z.ZodString;
+        title: z.ZodString;
+        fields: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+      }, z.core.$strip>>;
+    }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
+      NOT_FOUND: {
+        readonly message: "No content type with that slug in this organization.";
+      };
+      RATE_LIMITED: {
+        readonly status: 429;
+        readonly message: "Too many requests. Try again shortly.";
+      };
+      UNAUTHORIZED: {
+        readonly message: "Authentication required. Pass an organization API key in the `x-api-key` header.";
+      };
+      QUOTA_EXCEEDED: {
+        readonly status: 429;
+        readonly message: "The organization's API request limit for this period has been reached.";
+      };
+    }>, Record<never, never>>;
+    get: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+      type: z.ZodString;
+      slug: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+      id: z.ZodString;
+      slug: z.ZodString;
+      title: z.ZodString;
+      fields: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+      createdAt: z.ZodISODateTime;
+      updatedAt: z.ZodISODateTime;
+    }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
+      NOT_FOUND: {
+        message: string;
+      };
+      RATE_LIMITED: {
+        readonly status: 429;
+        readonly message: "Too many requests. Try again shortly.";
+      };
+      UNAUTHORIZED: {
+        readonly message: "Authentication required. Pass an organization API key in the `x-api-key` header.";
+      };
+      QUOTA_EXCEEDED: {
+        readonly status: 429;
+        readonly message: "The organization's API request limit for this period has been reached.";
+      };
+    }>, Record<never, never>>;
+  };
+  org: {
+    current: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodObject<{
+      id: z.ZodString;
+      name: z.ZodString;
+      slug: z.ZodString;
+      logo: z.ZodNullable<z.ZodString>;
+      createdAt: z.ZodISODateTime;
+    }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
+      readonly RATE_LIMITED: {
+        readonly status: 429;
+        readonly message: "Too many requests. Try again shortly.";
+      };
+      readonly UNAUTHORIZED: {
+        readonly message: "Authentication required. Pass an organization API key in the `x-api-key` header.";
+      };
+      readonly QUOTA_EXCEEDED: {
+        readonly status: 429;
+        readonly message: "The organization's API request limit for this period has been reached.";
+      };
+    }>, Record<never, never>>;
+    billing: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodObject<{
+      plan: z.ZodEnum<{
+        free: "free";
+        paid: "paid";
+      }>;
+      status: z.ZodNullable<z.ZodString>;
+      seats: z.ZodNullable<z.ZodNumber>;
+      periodEnd: z.ZodNullable<z.ZodISODateTime>;
+      cancelAtPeriodEnd: z.ZodBoolean;
+      usage: z.ZodArray<z.ZodObject<{
+        feature: z.ZodEnum<{
+          members: "members";
+          apiRequests: "apiRequests";
+          storage: "storage";
+        }>;
+        used: z.ZodNumber;
+        cap: z.ZodNullable<z.ZodNumber>;
+        window: z.ZodNullable<z.ZodEnum<{
+          month: "month";
+        }>>;
+      }, z.core.$strip>>;
+    }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
+      readonly RATE_LIMITED: {
+        readonly status: 429;
+        readonly message: "Too many requests. Try again shortly.";
+      };
+      readonly UNAUTHORIZED: {
+        readonly message: "Authentication required. Pass an organization API key in the `x-api-key` header.";
+      };
+      readonly QUOTA_EXCEEDED: {
+        readonly status: 429;
+        readonly message: "The organization's API request limit for this period has been reached.";
+      };
+    }>, Record<never, never>>;
+    note: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodObject<{
+      text: z.ZodNullable<z.ZodString>;
+      words: z.ZodNumber;
+      savedAt: z.ZodNullable<z.ZodISODateTime>;
+    }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
+      readonly RATE_LIMITED: {
+        readonly status: 429;
+        readonly message: "Too many requests. Try again shortly.";
+      };
+      readonly UNAUTHORIZED: {
+        readonly message: "Authentication required. Pass an organization API key in the `x-api-key` header.";
+      };
+      readonly QUOTA_EXCEEDED: {
+        readonly status: 429;
+        readonly message: "The organization's API request limit for this period has been reached.";
+      };
+    }>, Record<never, never>>;
+  };
+  webhooks: {
+    list: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodArray<z.ZodObject<{
+      id: z.ZodString;
+      url: z.ZodString;
+      events: z.ZodArray<z.ZodEnum<{
+        "content.changed": "content.changed";
+        "member.joined": "member.joined";
+        "invitation.created": "invitation.created";
+        "subscription.started": "subscription.started";
+        "subscription.canceled": "subscription.canceled";
+        ping: "ping";
+      }>>;
+      enabled: z.ZodBoolean;
+      createdAt: z.ZodISODateTime;
+    }, z.core.$strip>>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
+      readonly RATE_LIMITED: {
+        readonly status: 429;
+        readonly message: "Too many requests. Try again shortly.";
+      };
+      readonly UNAUTHORIZED: {
+        readonly message: "Authentication required. Pass an organization API key in the `x-api-key` header.";
+      };
+      readonly QUOTA_EXCEEDED: {
+        readonly status: 429;
+        readonly message: "The organization's API request limit for this period has been reached.";
+      };
+    }>, Record<never, never>>;
+    create: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+      url: z.ZodURL;
+      events: z.ZodArray<z.ZodEnum<{
+        "content.changed": "content.changed";
+        "member.joined": "member.joined";
+        "invitation.created": "invitation.created";
+        "subscription.started": "subscription.started";
+        "subscription.canceled": "subscription.canceled";
+        ping: "ping";
+      }>>;
+    }, z.core.$strip>, z.ZodObject<{
+      id: z.ZodString;
+      url: z.ZodString;
+      events: z.ZodArray<z.ZodEnum<{
+        "content.changed": "content.changed";
+        "member.joined": "member.joined";
+        "invitation.created": "invitation.created";
+        "subscription.started": "subscription.started";
+        "subscription.canceled": "subscription.canceled";
+        ping: "ping";
+      }>>;
+      enabled: z.ZodBoolean;
+      createdAt: z.ZodISODateTime;
+      secret: z.ZodString;
+    }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
+      BAD_REQUEST: {
+        message: string;
+      };
+      RATE_LIMITED: {
+        readonly status: 429;
+        readonly message: "Too many requests. Try again shortly.";
+      };
+      UNAUTHORIZED: {
+        readonly message: "Authentication required. Pass an organization API key in the `x-api-key` header.";
+      };
+      QUOTA_EXCEEDED: {
+        readonly status: 429;
+        readonly message: "The organization's API request limit for this period has been reached.";
+      };
+    }>, Record<never, never>>;
+    delete: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+      id: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+      id: z.ZodString;
+    }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
+      NOT_FOUND: {
+        readonly message: "No webhook endpoint with that id in this organization.";
+      };
+      RATE_LIMITED: {
+        readonly status: 429;
+        readonly message: "Too many requests. Try again shortly.";
+      };
+      UNAUTHORIZED: {
+        readonly message: "Authentication required. Pass an organization API key in the `x-api-key` header.";
+      };
+      QUOTA_EXCEEDED: {
+        readonly status: 429;
+        readonly message: "The organization's API request limit for this period has been reached.";
+      };
+    }>, Record<never, never>>;
+    rotateSecret: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+      id: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+      id: z.ZodString;
+      url: z.ZodString;
+      events: z.ZodArray<z.ZodEnum<{
+        "content.changed": "content.changed";
+        "member.joined": "member.joined";
+        "invitation.created": "invitation.created";
+        "subscription.started": "subscription.started";
+        "subscription.canceled": "subscription.canceled";
+        ping: "ping";
+      }>>;
+      enabled: z.ZodBoolean;
+      createdAt: z.ZodISODateTime;
+      secret: z.ZodString;
+    }, z.core.$strip>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
+      NOT_FOUND: {
+        readonly message: "No webhook endpoint with that id in this organization.";
+      };
+      RATE_LIMITED: {
+        readonly status: 429;
+        readonly message: "Too many requests. Try again shortly.";
+      };
+      UNAUTHORIZED: {
+        readonly message: "Authentication required. Pass an organization API key in the `x-api-key` header.";
+      };
+      QUOTA_EXCEEDED: {
+        readonly status: 429;
+        readonly message: "The organization's API request limit for this period has been reached.";
+      };
+    }>, Record<never, never>>;
+    deliveries: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+      id: z.ZodString;
+    }, z.core.$strip>, z.ZodArray<z.ZodObject<{
+      id: z.ZodString;
+      eventId: z.ZodString;
+      eventType: z.ZodString;
+      status: z.ZodEnum<{
+        success: "success";
+        failed: "failed";
+      }>;
+      responseStatus: z.ZodNullable<z.ZodNumber>;
+      attempts: z.ZodNumber;
+      createdAt: z.ZodISODateTime;
+    }, z.core.$strip>>, import("@orpc/contract").MergedErrorMap<Record<never, never>, {
+      NOT_FOUND: {
+        readonly message: "No webhook endpoint with that id in this organization.";
+      };
+      RATE_LIMITED: {
+        readonly status: 429;
+        readonly message: "Too many requests. Try again shortly.";
+      };
+      UNAUTHORIZED: {
+        readonly message: "Authentication required. Pass an organization API key in the `x-api-key` header.";
+      };
+      QUOTA_EXCEEDED: {
+        readonly status: 429;
+        readonly message: "The organization's API request limit for this period has been reached.";
+      };
+    }>, Record<never, never>>;
+  };
+};
+//#endregion
+//#region src/content.d.ts
+/** Fields every entry carries, whatever its collection's shape. */
+type ContentEntryBase = {
+  id: string;
+  slug: string;
+  title: string; /** ISO 8601. */
+  createdAt: string;
+  updatedAt: string;
+};
+/**
+ * What a reference field holds: enough to render a link without a second
+ * request, and the slug to fetch the whole entry with the target
+ * collection's `get()`. Which collection that is stands in the generated
+ * field's doc comment.
+ */
+type ContentReference = {
+  id: string;
+  slug: string;
+  title: string;
+};
+/**
+ * What an asset field holds. `url` is a fully-qualified, public URL: the API
+ * returns it relative to itself and the client resolves it against the origin
+ * it was configured with, so it can go straight into an `img` tag or a
+ * download link on your own site, which is a different origin.
+ */
+type ContentAsset = {
+  id: string;
+  url: string; /** The original filename. */
+  name: string;
+  contentType: string; /** Bytes. */
+  size: number;
+};
+/**
+ * The shape `@stetcms/vite` generates from the organization's content model:
+ * one key per collection or map, carrying its kind and full entry type.
+ */
+type ContentModelShape = Record<string, {
+  kind: 'collection' | 'map';
+  entry: ContentEntryBase;
+}>;
+type CollectionClient<E extends ContentEntryBase> = {
+  /** Every entry, oldest first. */list(): Promise<E[]>; /** One entry, addressed by its slug. */
+  get(slug: string): Promise<E>;
+};
+type MapClient<E extends ContentEntryBase> = {
+  /** The map's single entry. */get(): Promise<E>;
+};
+type ContentClient<M extends ContentModelShape> = { [K in keyof M]: M[K] extends {
+  kind: 'map';
+} ? MapClient<M[K]['entry']> : CollectionClient<M[K]['entry']> };
+type ContentClientOptions = {
+  origin?: string;
+  /**
+   * Organization API key, sent as `x-api-key`. Content is served to servers:
+   * keep the key out of browser bundles and call from your own backend.
+   */
+  apiKey?: string;
+  fetch?: typeof globalThis.fetch;
+};
+/**
+ * Joins an asset path to the Stet origin. Anything already absolute is left
+ * alone, so a future API that returns whole URLs needs no change here.
+ */
+declare function assetUrl(url: string, origin: string): string;
+/**
+ * The same join applied inside a body's markdown, so an image an editor
+ * dropped into a body renders on your site as readily as an asset field does.
+ */
+declare function resolveAssetPaths(text: string, origin: string): string;
+/**
+ * The model-shaped client `stet.gen.ts` instantiates: `stet.posts.list()`,
+ * `stet.posts.get('hello-world')`, `stet.landing.get()`. The type parameter
+ * narrows which keys exist and what their entries look like; the runtime is
+ * one Proxy over the content API.
+ */
+declare function createContentClient<M extends ContentModelShape>(options?: ContentClientOptions): ContentClient<M>;
+//#endregion
+//#region src/index.d.ts
+type ApiInputs = InferContractRouterInputs<typeof contract>;
+type ApiOutputs = InferContractRouterOutputs<typeof contract>;
+type StetClient = ContractRouterClient<typeof contract>;
+type StetClientOptions = {
+  origin?: string;
+  apiKey?: string;
+  fetch?: typeof globalThis.fetch;
+};
+declare function createStetClient(options?: StetClientOptions): StetClient;
+//#endregion
+export { ApiInputs, ApiOutputs, type CollectionClient, type ContentAsset, type ContentClient, type ContentClientOptions, type ContentEntry, type ContentEntryBase, type ContentModel, type ContentModelShape, type ContentReference, type ContentType, DEFAULT_ORIGIN, type MapClient, type Organization, StetClient, StetClientOptions, assetUrl, createContentClient, createStetClient, entryTypeName, fetchContentModel, isDefinedError, renderContentModule, resolveAssetPaths, safe };