@shapio/cms 0.2.1 → 0.3.1

package/dist/{public-CKU0Gkfq.d.ts → public-B7fFHMNr.d.ts}

@@ -1,5 +1,224 @@
 import { FastifyBaseLogger, FastifyInstance, FastifyPluginAsync, preHandlerAsyncHookHandler } from "fastify";
 import { ColumnType, Kysely, Transaction } from "kysely";
+import { Static, Type } from "typebox";
+//#region ../../packages/schema/dist/index.d.ts
+//#endregion
+//#region src/types/dataTypes.d.ts
+/** Every stored data type. A field's data type is separate from the editor that renders it (brief §2.5). */
+declare const DATA_TYPES: readonly ["string", "text", "richtext", "number", "integer", "decimal", "biginteger", "boolean", "date", "datetime", "time", "enum", "json", "slug", "email", "url", "uid", "media", "relation", "component", "dynamiczone"];
+type DataType = (typeof DATA_TYPES)[number];
+//#endregion
+//#region src/types/json.d.ts
+type JsonPrimitive$1 = string | number | boolean | null;
+type JsonValue$1 = JsonPrimitive$1 | JsonValue$1[] | {
+  [key: string]: JsonValue$1;
+};
+declare const SETTINGS_SCHEMAS: {
+  string: Type.TObject<{
+    pattern: Type.TOptional<Type.TString>;
+    minLength: Type.TOptional<Type.TInteger>;
+    maxLength: Type.TOptional<Type.TInteger>;
+  }>;
+  text: Type.TObject<{
+    minLength: Type.TOptional<Type.TInteger>;
+    maxLength: Type.TOptional<Type.TInteger>;
+  }>;
+  richtext: Type.TObject<{
+    formatVersion: Type.TOptional<Type.TInteger>;
+    maxLength: Type.TOptional<Type.TInteger>;
+  }>;
+  number: Type.TObject<{
+    min: Type.TOptional<Type.TNumber>;
+    max: Type.TOptional<Type.TNumber>;
+  }>;
+  integer: Type.TObject<{
+    min: Type.TOptional<Type.TInteger>;
+    max: Type.TOptional<Type.TInteger>;
+  }>;
+  decimal: Type.TObject<{
+    precision: Type.TOptional<Type.TInteger>;
+    scale: Type.TOptional<Type.TInteger>;
+    min: Type.TOptional<Type.TString>;
+    max: Type.TOptional<Type.TString>;
+  }>;
+  biginteger: Type.TObject<{
+    min: Type.TOptional<Type.TString>;
+    max: Type.TOptional<Type.TString>;
+  }>;
+  boolean: Type.TObject<{}>;
+  date: Type.TObject<{
+    min: Type.TOptional<Type.TString>;
+    max: Type.TOptional<Type.TString>;
+  }>;
+  datetime: Type.TObject<{
+    min: Type.TOptional<Type.TString>;
+    max: Type.TOptional<Type.TString>;
+  }>;
+  time: Type.TObject<{
+    min: Type.TOptional<Type.TString>;
+    max: Type.TOptional<Type.TString>;
+  }>;
+  enum: Type.TObject<{
+    values: Type.TArray<Type.TObject<{
+      value: Type.TString;
+      label: Type.TString;
+    }>>;
+    multiple: Type.TOptional<Type.TBoolean>;
+  }>;
+  json: Type.TObject<{}>;
+  slug: Type.TObject<{
+    sourceFieldId: Type.TOptional<Type.TString>;
+    minLength: Type.TOptional<Type.TInteger>;
+    maxLength: Type.TOptional<Type.TInteger>;
+  }>;
+  email: Type.TObject<{}>;
+  url: Type.TObject<{
+    protocols: Type.TOptional<Type.TArray<Type.TEnum<["http", "https", "mailto", "tel"]>>>;
+  }>;
+  uid: Type.TObject<{
+    minLength: Type.TOptional<Type.TInteger>;
+    maxLength: Type.TOptional<Type.TInteger>;
+  }>;
+  media: Type.TObject<{
+    min: Type.TOptional<Type.TInteger>;
+    max: Type.TOptional<Type.TInteger>;
+    multiple: Type.TOptional<Type.TBoolean>;
+    allowedKinds: Type.TOptional<Type.TArray<Type.TEnum<["image", "video", "audio", "document", "other"]>>>;
+  }>;
+  relation: Type.TObject<{
+    min: Type.TOptional<Type.TInteger>;
+    max: Type.TOptional<Type.TInteger>;
+    target: Type.TString;
+    cardinality: Type.TEnum<["one", "many"]>;
+  }>;
+  component: Type.TObject<{
+    min: Type.TOptional<Type.TInteger>;
+    max: Type.TOptional<Type.TInteger>;
+    component: Type.TString;
+    repeatable: Type.TOptional<Type.TBoolean>;
+  }>;
+  dynamiczone: Type.TObject<{
+    min: Type.TOptional<Type.TInteger>;
+    max: Type.TOptional<Type.TInteger>;
+    components: Type.TArray<Type.TString>;
+  }>;
+};
+type SettingsSchemas = typeof SETTINGS_SCHEMAS;
+/** Settings as authored (defaults may be missing). */
+type DataTypeSettingsInput = { [T in DataType]: Static<SettingsSchemas[T]>; };
+/** Settings after normalization: the defaulted keys are always present. */
+type DataTypeSettings = Omit<DataTypeSettingsInput, 'richtext' | 'enum' | 'media' | 'component'> & {
+  richtext: DataTypeSettingsInput['richtext'] & {
+    formatVersion: number;
+  };
+  enum: DataTypeSettingsInput['enum'] & {
+    multiple: boolean;
+  };
+  media: DataTypeSettingsInput['media'] & {
+    multiple: boolean;
+  };
+  component: DataTypeSettingsInput['component'] & {
+    repeatable: boolean;
+  };
+};
+//#endregion
+//#region src/types/definitions.d.ts
+declare const MODEL_KINDS: readonly ["collection", "singleton"];
+type ModelKind = (typeof MODEL_KINDS)[number];
+declare const SORT_DIRECTIONS: readonly ["asc", "desc"];
+type SortDirection = (typeof SORT_DIRECTIONS)[number];
+type EditorChoice = {
+  id: string;
+  options: Record<string, JsonValue$1>;
+};
+type FieldBase = {
+  id: string;
+  apiKey: string;
+  label: string;
+  description?: string;
+  required: boolean;
+  localized: boolean;
+  public: boolean;
+  unique: boolean;
+  filterable: boolean;
+  sortable: boolean;
+  deprecated: boolean;
+  defaultValue?: JsonValue$1;
+  editor: EditorChoice;
+};
+/** A normalized field. Narrow on `type` to get typed `settings`. */
+type FieldDefinition<T extends DataType = DataType> = { [K in T]: FieldBase & {
+  type: K;
+  settings: DataTypeSettings[K];
+}; }[T];
+type FieldGroup = {
+  id: string;
+  label: string;
+  fieldIds: string[];
+};
+type ModelDisplay = {
+  titleFieldId?: string;
+  listFieldIds?: string[];
+  defaultSort?: {
+    fieldId: string;
+    direction: SortDirection;
+  };
+  groups?: FieldGroup[];
+  canvasFieldIds?: string[];
+  coverFieldId?: string;
+  stripFieldIds?: string[];
+};
+type ComponentDisplay = {
+  titleFieldId?: string;
+  groups?: FieldGroup[];
+};
+type ModelDefinition = {
+  id: string;
+  kind: ModelKind;
+  apiKey: string;
+  /**
+   * Present on collections (filled by normalizing), absent on singletons. Read it through `routeKeyOf`,
+   * which also covers a stored definition that predates plural API IDs.
+   */
+  pluralApiKey?: string;
+  label: string;
+  description?: string;
+  localized: boolean;
+  draftAndPublish: boolean;
+  fields: FieldDefinition[];
+  display: ModelDisplay;
+};
+type ComponentDefinition = {
+  id: string;
+  kind: 'component';
+  apiKey: string;
+  label: string;
+  description?: string;
+  category?: string;
+  icon?: string;
+  fields: FieldDefinition[];
+  display: ComponentDisplay;
+};
+//#endregion
+//#region src/diff/types.d.ts
+declare const CHANGE_KINDS: readonly ["definition.added", "definition.removed", "definition.apiKey", "definition.pluralApiKey", "definition.metadata", "model.kind", "model.localized", "model.draftAndPublish", "field.added", "field.removed", "field.order", "field.apiKey", "field.metadata", "field.editor", "field.type", "field.required", "field.localized", "field.public", "field.deprecated", "field.unique", "field.filterable", "field.sortable", "field.settings"];
+type ChangeKind = (typeof CHANGE_KINDS)[number];
+/**
+ * One difference between two versions of a definition. `property` names the changed property for
+ * `*.metadata` (`label`, `description`, ...) and `field.settings` (the settings key); `from`/`to` hold the
+ * old and new values (absent when the side does not exist).
+ */
+type SchemaChange = {
+  kind: ChangeKind;
+  definitionId: string;
+  fieldId?: string;
+  property?: string;
+  from?: JsonValue$1;
+  to?: JsonValue$1;
+};
+declare const THEME_TOKENS: readonly ["background", "foreground", "card", "card-foreground", "popover", "popover-foreground", "primary", "primary-foreground", "primary-hover", "secondary", "secondary-foreground", "muted", "muted-foreground", "accent", "accent-foreground", "destructive", "destructive-foreground", "destructive-muted", "success", "success-muted", "warning", "warning-muted", "info", "info-muted", "border", "input", "ring", "link", "overlay", "sidebar", "sidebar-foreground", "sidebar-primary", "sidebar-primary-foreground", "sidebar-accent", "sidebar-accent-foreground", "sidebar-border", "sidebar-ring", "brand-logo", "brand-logo-foreground", "brand-letters", "brand-panel-from", "brand-panel-to", "brand-panel-foreground", "brand-panel-mark"];
+type ThemeToken = (typeof THEME_TOKENS)[number];
+//#endregion
 //#region src/db/contentData.d.ts
 /**
  * User content values: JSONB keyed by stable field IDs. The shape is only known at runtime from the active
@@ -510,6 +729,7 @@ interface Models {
   deleted_at: Timestamp | null;
   id: string;
   kind: string;
+  site_id: string | null;
   updated_at: Generated<Timestamp>;
 }
 interface OutboxEvents {
@@ -628,6 +848,7 @@ interface SchemaDrafts {
   definition_id: string;
   id: Generated<string>;
   kind: string;
+  shared: Generated<boolean>;
   updated_at: Generated<Timestamp>;
   updated_by_id: string | null;
   updated_by_type: string;
@@ -797,6 +1018,9 @@ interface DB {
   webhooks: Webhooks;
 }
 //#endregion
+//#region src/db/index.d.ts
+type Database = Kysely<DB>;
+//#endregion
 //#region src/permissions/types.d.ts
 /**
  * Principals and policies (ADR 0005). One evaluator serves admin users, app users, tokens and anonymous
@@ -896,9 +1120,21 @@ type PolicyRequest = {
   action: ContentAction;
   modelId: string;
 };
+/**
+ * Where a permission lookup reads its durable version checks (and any reload): the open transaction when
+ * the caller is inside one, so the lookup never waits for a second pooled connection while it holds one
+ * (an exhausted pool would then wait forever). Omitted: the pool.
+ */
+type PermissionExecutor = Database;
 type PermissionEvaluator = {
-  evaluate: (principal: Principal, request: PolicyRequest) => Promise<Policy>;
-  canPerform: (principal: Principal, action: GlobalAction) => Promise<boolean>;
+  evaluate: (principal: Principal, request: PolicyRequest, executor?: PermissionExecutor) => Promise<Policy>;
+  canPerform: (principal: Principal, action: GlobalAction, executor?: PermissionExecutor) => Promise<boolean>;
+  /**
+   * `canPerform` for the request's site: an action in `SITE_GRANTABLE_ACTIONS` also counts the roles that
+   * apply on `siteId` when the principal acts on that site (an admin narrowed to it, a site token of it, a
+   * network token). Any other action is `canPerform`.
+   */
+  canPerformOnSite: (principal: Principal, action: GlobalAction, siteId: string, executor?: PermissionExecutor) => Promise<boolean>;
 };
 //#endregion
 //#region src/plugins/auditDeclaration.d.ts
@@ -1002,7 +1238,7 @@ type ContentReadService = {
   }>;
   /** Number of (non-deleted) entries of a model. */
   count: (modelKey: string) => Promise<number>;
-  /** The active content models (collections and singletons). */
+  /** The active content models (collections and singletons) of this site: shared ones and its own. */
   models: () => Promise<HookModel[]>;
 };
 type MediaUsage = {
@@ -1147,6 +1383,22 @@ type JobHandlerContext = {
 };
 /** Throw to retry with backoff; the return value (JSON) is stored as the job result. */
 type ExtensionJobHandler = (context: JobHandlerContext) => Promise<unknown>;
+/**
+ * A colour theme for the admin: token values for a light variant, a dark variant, or both. Every UI token is
+ * required in a variant; the `brand-*` tokens may be left out (Shapio's are used). Values are `#rrggbb`
+ * (contrast is checked by `shapio extensions check`), `#rgb`, `#rrggbbaa`, or `rgb()`, `hsl()`, `oklch()`,
+ * `oklab()` with plain arguments.
+ */
+type ThemeTokens = Partial<Record<ThemeToken, string>>;
+type ThemeDefinition = {
+  /** Lower-case letters, digits and dashes; not a built-in theme's key. Saved in each browser's setting. */
+  key: string;
+  /** Shown in the theme menu (not translated). */
+  name: string;
+  description?: string;
+  light?: ThemeTokens;
+  dark?: ThemeTokens;
+};
 type ShapioConfig = {
   /** Lifecycle hooks by model API ID (or stable model UUID); `*` runs for every model. */
   hooks?: Record<string, ModelHooks>;
@@ -1157,6 +1409,8 @@ type ShapioConfig = {
   editors?: string[];
   /** Job handlers by name; registered as `ext.<name>`. */
   jobs?: Record<string, ExtensionJobHandler>;
+  /** Admin colour themes, listed after the built-in ones in the theme menu. */
+  themes?: ThemeDefinition[];
 };
 /** Identity helper for completion and type checking in `shapio.config.ts`. */
 declare const defineConfig: (config: ShapioConfig) => ShapioConfig;
@@ -1173,5 +1427,5 @@ declare class HookError extends Error {
 }
 declare const isHookError: (error: unknown) => error is HookError;
 //#endregion
-export { ServiceFactoryContext as A, HookEvent as C, MediaUsage as D, MediaReferenceService as E, PermissionEvaluator as F, Principal as I, DB as L, ShapioServices as M, defineConfig as N, ModelHooks as O, isHookError as P, OutboxEvents as R, HookError as S, JobHandlerContext as T, ExtensionRoute as _, BeforeHookContext as a, ExtensionSite as b, ContentReadOptions as c, EXTENSION_CONTRACT_VERSION as d, EnqueueOptions as f, ExtensionJobService as g, ExtensionJobHandler as h, BeforeHook as i, ShapioConfig as j, ServiceFactory as k, ContentReadService as l, ExtensionHostConfig as m, AfterHookContext as n, BeforeHookEvent as o, EntryData as p, AfterHookEvent as r, ContentReadEntry as s, AfterHook as t, CustomServices as u, ExtensionRouteOptions as v, HookModel as w, HookEntry as x, ExtensionServices as y, ContentData as z };
-//# sourceMappingURL=public-CKU0Gkfq.d.ts.map
+export { ServiceFactoryContext as A, Database as B, HookEvent as C, MediaUsage as D, MediaReferenceService as E, defineConfig as F, DataType as G, OutboxEvents as H, isHookError as I, SchemaChange as J, JsonValue$1 as K, PermissionEvaluator as L, ShapioServices as M, ThemeDefinition as N, ModelHooks as O, ThemeTokens as P, PermissionExecutor as R, HookError as S, JobHandlerContext as T, ContentData as U, DB as V, ComponentDefinition as W, ExtensionRoute as _, BeforeHookContext as a, ExtensionSite as b, ContentReadOptions as c, EXTENSION_CONTRACT_VERSION as d, EnqueueOptions as f, ExtensionJobService as g, ExtensionJobHandler as h, BeforeHook as i, ShapioConfig as j, ServiceFactory as k, ContentReadService as l, ExtensionHostConfig as m, AfterHookContext as n, BeforeHookEvent as o, EntryData as p, ModelDefinition as q, AfterHookEvent as r, ContentReadEntry as s, AfterHook as t, CustomServices as u, ExtensionRouteOptions as v, HookModel as w, HookEntry as x, ExtensionServices as y, Principal as z };
+//# sourceMappingURL=public-B7fFHMNr.d.ts.map