@shapio/cms 0.2.1 → 0.3.0

package/dist/config.d.ts

@@ -1,2 +1,2 @@
-import { A as ServiceFactoryContext, C as HookEvent, D as MediaUsage, E as MediaReferenceService, M as ShapioServices, N as defineConfig, O as ModelHooks, P as isHookError, S as HookError, T as JobHandlerContext, _ as ExtensionRoute, a as BeforeHookContext, b as ExtensionSite, c as ContentReadOptions, d as EXTENSION_CONTRACT_VERSION, f as EnqueueOptions, g as ExtensionJobService, h as ExtensionJobHandler, i as BeforeHook, j as ShapioConfig, k as ServiceFactory, l as ContentReadService, m as ExtensionHostConfig, n as AfterHookContext, o as BeforeHookEvent, p as EntryData, r as AfterHookEvent, s as ContentReadEntry, t as AfterHook, u as CustomServices, v as ExtensionRouteOptions, w as HookModel, x as HookEntry, y as ExtensionServices } from "./public-CKU0Gkfq.js";
+import { A as ServiceFactoryContext, C as HookEvent, D as MediaUsage, E as MediaReferenceService, M as ShapioServices, N as defineConfig, O as ModelHooks, P as isHookError, S as HookError, T as JobHandlerContext, _ as ExtensionRoute, a as BeforeHookContext, b as ExtensionSite, c as ContentReadOptions, d as EXTENSION_CONTRACT_VERSION, f as EnqueueOptions, g as ExtensionJobService, h as ExtensionJobHandler, i as BeforeHook, j as ShapioConfig, k as ServiceFactory, l as ContentReadService, m as ExtensionHostConfig, n as AfterHookContext, o as BeforeHookEvent, p as EntryData, r as AfterHookEvent, s as ContentReadEntry, t as AfterHook, u as CustomServices, v as ExtensionRouteOptions, w as HookModel, x as HookEntry, y as ExtensionServices } from "./public-CGO8RBn3.js";
 export { AfterHook, AfterHookContext, AfterHookEvent, BeforeHook, BeforeHookContext, BeforeHookEvent, ContentReadEntry, ContentReadOptions, ContentReadService, CustomServices, EXTENSION_CONTRACT_VERSION, EnqueueOptions, EntryData, ExtensionHostConfig, ExtensionJobHandler, ExtensionJobService, ExtensionRoute, ExtensionRouteOptions, ExtensionServices, ExtensionSite, HookEntry, HookError, HookEvent, HookModel, JobHandlerContext, MediaReferenceService, MediaUsage, ModelHooks, ServiceFactory, ServiceFactoryContext, ShapioConfig, ShapioServices, defineConfig, isHookError };

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","names":[],"sources":["../src/extensions/public.ts"],"sourcesContent":["import type { FastifyBaseLogger, FastifyPluginAsync, preHandlerAsyncHookHandler } from 'fastify';\nimport type { Kysely, Transaction } from 'kysely';\nimport type { DB } from '../db/types.js';\nimport type { PermissionEvaluator, Principal } from '../permissions/types.js';\nimport type { RouteAuditConfig } from '../plugins/auditDeclaration.js';\n\n// What Shapio adds to Fastify, repeated here so custom route code is typed without the server's internals.\ndeclare module 'fastify' {\n  interface FastifyRequest {\n    /** Who is calling. Anonymous unless a session cookie or API token resolved. Never null after onRequest. */\n    principal: Principal;\n    /**\n     * The request's site on a site route (custom routes are site routes): the credential's site, else the\n     * `Shapio-Site` header or `?site=`, else the primary site. Undefined on a route declaring\n     * `config.site = 'network'`.\n     */\n    site: { id: string; key: string } | undefined;\n  }\n  interface FastifyContextConfig {\n    /** Required on every mutating route: the audit action recorded on success, or `{ exempt: '<why>' }`. */\n    audit?: RouteAuditConfig;\n    /** `'network'` for a custom route that is about the whole instance rather than one site. */\n    site?: 'site' | 'network';\n  }\n}\n\n/**\n * The project extension contract (ADR 0009), imported by project authors from `@shapio/cms/config`:\n *\n * ```ts\n * import { defineConfig } from '@shapio/cms/config';\n * export const config = defineConfig({ hooks: { article: { beforePublish: (ctx) => { ... } } } });\n * ```\n *\n * Extensions are code: changing them needs a restart of Shapio (never a rebuild). Content models are never\n * configured here; they change live in the admin. This file has no runtime imports from the server, so a\n * config that imports it stays cheap to load.\n *\n * Stability: everything exported here follows semver with `EXTENSION_CONTRACT_VERSION`; Shapio's database\n * tables (reachable through `trx`) are internal and may change in any release.\n */\nexport const EXTENSION_CONTRACT_VERSION = 1;\n\nexport type BeforeHookEvent = 'beforeCreate' | 'beforeUpdate' | 'beforePublish' | 'beforeDelete';\nexport type AfterHookEvent = 'afterCreate' | 'afterUpdate' | 'afterPublish' | 'afterDelete';\nexport type HookEvent = BeforeHookEvent | AfterHookEvent;\n\n/** A site of a multi-site instance: its stable ID and its key (sites share the schema, not content). */\nexport type ExtensionSite = { id: string; key: string };\n\n/** Entry data keyed by field API key (the admin API's shape; media and relations are IDs). */\nexport type EntryData = Readonly<Record<string, unknown>>;\n\nexport type HookModel = {\n  /** Stable model ID (never changes). */\n  id: string;\n  apiKey: string;\n  label: string;\n  kind: 'collection' | 'singleton';\n  localized: boolean;\n  draftAndPublish: boolean;\n};\n\nexport type HookEntry = {\n  id: string;\n  locale: string | null;\n  /** Which head the change is about: the draft (create/update), the live version (publish), or a delete. */\n  state: 'draft' | 'published' | 'deleted';\n};\n\nexport type ContentReadOptions = {\n  locale?: string;\n  /** Read as this principal (its permissions apply). Default: Shapio itself (everything). */\n  principal?: Principal;\n};\n\nexport type ContentReadEntry = {\n  id: string;\n  locale: string;\n  status: string;\n  data: Record<string, unknown>;\n};\n\n/** Read-only access to content (drafts, as the admin API shows them). Reads committed data. */\nexport type ContentReadService = {\n  get: (modelKey: string, id: string, options?: ContentReadOptions) => Promise<ContentReadEntry>;\n  /** `query` is a delivery-style querystring, e.g. `filters[title][$contains]=a&pageSize=10`. */\n  list: (\n    modelKey: string,\n    query?: string,\n    options?: Omit<ContentReadOptions, 'locale'>,\n  ) => Promise<{ items: ContentReadEntry[]; total: number }>;\n  /** Number of (non-deleted) entries of a model. */\n  count: (modelKey: string) => Promise<number>;\n  /** The active content models (collections and singletons). */\n  models: () => Promise<HookModel[]>;\n};\n\nexport type MediaUsage = {\n  entryId: string;\n  modelId: string;\n  fieldId: string;\n  locale: string;\n  state: string;\n};\n\nexport type MediaReferenceService = {\n  /** Where an asset is used (up to 100 references, plus the total). */\n  usages: (assetId: string) => Promise<{ items: MediaUsage[]; total: number }>;\n};\n\nexport type EnqueueOptions = {\n  runAt?: Date;\n  /** Enqueueing the same key twice creates one job. */\n  idempotencyKey?: string;\n  maxAttempts?: number;\n};\n\nexport type ExtensionJobService = {\n  /** Enqueues one of the project's own jobs (`jobs` in the config), by its name without the `ext.` prefix. */\n  enqueue: (\n    name: string,\n    payload?: Record<string, unknown>,\n    options?: EnqueueOptions,\n  ) => Promise<{ id: string; created: boolean }>;\n};\n\n/**\n * What Shapio offers extensions. Deliberately small; everything else goes through `trx` or HTTP.\n *\n * Content and media are per site. The services handed to a hook read the hook's site; the services given to\n * routes, jobs and service factories read the primary site. Use `forSite` for another one (in a custom\n * route: `services.forSite(request.site)`).\n */\nexport type ShapioServices = {\n  /** The site `content` and `media` read. */\n  site: ExtensionSite;\n  /** The same services reading another site. */\n  forSite: (site: ExtensionSite) => ShapioServices;\n  content: ContentReadService;\n  media: MediaReferenceService;\n  jobs: ExtensionJobService;\n  logger: FastifyBaseLogger;\n};\n\n/**\n * Your own services, by name. Augment it for typed access everywhere services appear:\n *\n * ```ts\n * declare module '@shapio/cms/config' {\n *   interface CustomServices { stats: StatsService }\n * }\n * ```\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type -- augmented by projects\nexport interface CustomServices {}\n\nexport type ExtensionServices = ShapioServices & CustomServices;\n\ntype HookContextBase = {\n  /** The site the entry belongs to; `services` read this site. */\n  site: ExtensionSite;\n  model: HookModel;\n  entry: HookEntry;\n  locale: string | null;\n  /** The document after the change (absent for deletes). */\n  data: EntryData | undefined;\n  /** The document before the change: the previous draft (update) or the live version (publish). */\n  before: EntryData | undefined;\n  /** Who made the change (an admin, an API token, an app user, or Shapio itself for scheduled work). */\n  principal: Principal;\n  services: ExtensionServices;\n  logger: FastifyBaseLogger;\n  /** Aborted when Shapio shuts down. */\n  signal: AbortSignal;\n};\n\n/**\n * `before*` hooks run INSIDE the write's transaction, before it commits. Throw `HookError` (or call\n * `reject`) to abort the write with 422 `HOOK_REJECTED`; nothing of the write is kept. Other errors abort it\n * too, as a 500. Database work through `trx` commits or rolls back with the write.\n */\nexport type BeforeHookContext = HookContextBase & {\n  event: BeforeHookEvent;\n  trx: Transaction<DB>;\n  reject: (message: string, details?: Record<string, unknown>) => never;\n};\n\n/**\n * `after*` hooks run AFTER the write committed, as a job (retried with backoff on error, never rolling the\n * write back). Database work through `trx` is exactly once: it commits together with the record that the\n * hook ran. Other side effects (HTTP calls) are at least once: make them idempotent with `idempotencyKey`.\n */\nexport type AfterHookContext = HookContextBase & {\n  event: AfterHookEvent;\n  trx: Transaction<DB>;\n  /** The outbox event the hook runs for. */\n  eventId: string;\n  /** `<eventId>:<hook name>`: stable across retries. */\n  idempotencyKey: string;\n  attempt: number;\n};\n\nexport type BeforeHook = (context: BeforeHookContext) => Promise<void> | void;\nexport type AfterHook = (context: AfterHookContext) => Promise<void> | void;\n\nexport type ModelHooks = { [E in BeforeHookEvent]?: BeforeHook } & { [E in AfterHookEvent]?: AfterHook };\n\nexport type ServiceFactoryContext = {\n  /** Kysely on Shapio's database. Shapio's own tables are internal and may change between releases. */\n  db: Kysely<DB>;\n  config: ExtensionHostConfig;\n  logger: FastifyBaseLogger;\n  /** Shapio's services plus the custom services declared before this one. */\n  services: ExtensionServices;\n};\n\nexport type ExtensionHostConfig = {\n  nodeEnv: 'development' | 'production' | 'test';\n  /** PUBLIC_URL origin, without a trailing slash. */\n  publicUrl: string;\n  basePath: string;\n  /** The directory holding shapio.config and extensions/. */\n  projectDir: string;\n};\n\nexport type ServiceFactory = (context: ServiceFactoryContext) => unknown;\n\n/** Options every custom route plugin receives (also available as `app.ext`). */\nexport type ExtensionRouteOptions = {\n  services: ExtensionServices;\n  /** Shapio's permission evaluator: `permissions.evaluate(request.principal, { action, modelId })`. */\n  permissions: PermissionEvaluator;\n  logger: FastifyBaseLogger;\n  /** preHandler: 401/403 unless the caller is an admin user or an admin API token. */\n  requireAdmin: preHandlerAsyncHookHandler;\n};\n\nexport type ExtensionRoute = {\n  /** Mounted at `/api/ext/<prefix>` (under BASE_PATH). Lower-case letters, digits and dashes. */\n  prefix: string;\n  plugin: FastifyPluginAsync<ExtensionRouteOptions>;\n};\n\nexport type JobHandlerContext = {\n  jobId: string;\n  payload: Record<string, unknown>;\n  attempt: number;\n  maxAttempts: number;\n  idempotencyKey: string | null;\n  services: ExtensionServices;\n  logger: FastifyBaseLogger;\n  signal: AbortSignal;\n};\n\n/** Throw to retry with backoff; the return value (JSON) is stored as the job result. */\nexport type ExtensionJobHandler = (context: JobHandlerContext) => Promise<unknown>;\n\nexport type ShapioConfig = {\n  /** Lifecycle hooks by model API ID (or stable model UUID); `*` runs for every model. */\n  hooks?: Record<string, ModelHooks>;\n  routes?: ExtensionRoute[];\n  /** Constructed once at startup, in order, and shared by hooks, routes and jobs. */\n  services?: Record<string, ServiceFactory>;\n  /** Custom field editor modules: file names inside `extensions/editors/` (built ES modules). */\n  editors?: string[];\n  /** Job handlers by name; registered as `ext.<name>`. */\n  jobs?: Record<string, ExtensionJobHandler>;\n};\n\n/** Identity helper for completion and type checking in `shapio.config.ts`. */\nexport const defineConfig = (config: ShapioConfig): ShapioConfig => config;\n\nconst HOOK_ERROR_BRAND = Symbol.for('shapio.HookError');\n\n/**\n * Thrown by a `before*` hook to reject a write: the API answers 422 with code `HOOK_REJECTED`, this message\n * and the details. Recognised by a brand, not `instanceof`, so a copy of this class loaded from another\n * path (a project's own `node_modules`) works the same.\n */\nexport class HookError extends Error {\n  readonly details: Record<string, unknown> | undefined;\n  readonly [HOOK_ERROR_BRAND] = true;\n\n  constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = 'HookError';\n    this.details = details;\n  }\n}\n\nexport const isHookError = (error: unknown): error is HookError =>\n  typeof error === 'object' &&\n  error !== null &&\n  (error as Record<symbol, unknown>)[HOOK_ERROR_BRAND] === true;\n"],"mappings":";;;;;;;;;;;;;;;;AAyCA,MAAa,6BAA6B;;AAsO1C,MAAa,gBAAgB,WAAuC;AAEpE,MAAM,mBAAmB,OAAO,IAAI,kBAAkB;;;;;;AAOtD,IAAa,YAAb,cAA+B,MAAM;CACnC;CACA,CAAU,oBAAoB;CAE9B,YAAY,SAAiB,SAAmC;EAC9D,MAAM,OAAO;EACb,KAAK,OAAO;EACZ,KAAK,UAAU;CACjB;AACF;AAEA,MAAa,eAAe,UAC1B,OAAO,UAAU,YACjB,UAAU,QACT,MAAkC,sBAAsB"}
+{"version":3,"file":"config.js","names":[],"sources":["../src/extensions/public.ts"],"sourcesContent":["import type { FastifyBaseLogger, FastifyPluginAsync, preHandlerAsyncHookHandler } from 'fastify';\nimport type { Kysely, Transaction } from 'kysely';\nimport type { DB } from '../db/types.js';\nimport type { PermissionEvaluator, Principal } from '../permissions/types.js';\nimport type { RouteAuditConfig } from '../plugins/auditDeclaration.js';\n\n// What Shapio adds to Fastify, repeated here so custom route code is typed without the server's internals.\ndeclare module 'fastify' {\n  interface FastifyRequest {\n    /** Who is calling. Anonymous unless a session cookie or API token resolved. Never null after onRequest. */\n    principal: Principal;\n    /**\n     * The request's site on a site route (custom routes are site routes): the credential's site, else the\n     * `Shapio-Site` header or `?site=`, else the primary site. Undefined on a route declaring\n     * `config.site = 'network'`.\n     */\n    site: { id: string; key: string } | undefined;\n  }\n  interface FastifyContextConfig {\n    /** Required on every mutating route: the audit action recorded on success, or `{ exempt: '<why>' }`. */\n    audit?: RouteAuditConfig;\n    /** `'network'` for a custom route that is about the whole instance rather than one site. */\n    site?: 'site' | 'network';\n  }\n}\n\n/**\n * The project extension contract (ADR 0009), imported by project authors from `@shapio/cms/config`:\n *\n * ```ts\n * import { defineConfig } from '@shapio/cms/config';\n * export const config = defineConfig({ hooks: { article: { beforePublish: (ctx) => { ... } } } });\n * ```\n *\n * Extensions are code: changing them needs a restart of Shapio (never a rebuild). Content models are never\n * configured here; they change live in the admin. This file has no runtime imports from the server, so a\n * config that imports it stays cheap to load.\n *\n * Stability: everything exported here follows semver with `EXTENSION_CONTRACT_VERSION`; Shapio's database\n * tables (reachable through `trx`) are internal and may change in any release.\n */\nexport const EXTENSION_CONTRACT_VERSION = 1;\n\nexport type BeforeHookEvent = 'beforeCreate' | 'beforeUpdate' | 'beforePublish' | 'beforeDelete';\nexport type AfterHookEvent = 'afterCreate' | 'afterUpdate' | 'afterPublish' | 'afterDelete';\nexport type HookEvent = BeforeHookEvent | AfterHookEvent;\n\n/** A site of a multi-site instance: its stable ID and its key (sites share the schema, not content). */\nexport type ExtensionSite = { id: string; key: string };\n\n/** Entry data keyed by field API key (the admin API's shape; media and relations are IDs). */\nexport type EntryData = Readonly<Record<string, unknown>>;\n\nexport type HookModel = {\n  /** Stable model ID (never changes). */\n  id: string;\n  apiKey: string;\n  label: string;\n  kind: 'collection' | 'singleton';\n  localized: boolean;\n  draftAndPublish: boolean;\n};\n\nexport type HookEntry = {\n  id: string;\n  locale: string | null;\n  /** Which head the change is about: the draft (create/update), the live version (publish), or a delete. */\n  state: 'draft' | 'published' | 'deleted';\n};\n\nexport type ContentReadOptions = {\n  locale?: string;\n  /** Read as this principal (its permissions apply). Default: Shapio itself (everything). */\n  principal?: Principal;\n};\n\nexport type ContentReadEntry = {\n  id: string;\n  locale: string;\n  status: string;\n  data: Record<string, unknown>;\n};\n\n/** Read-only access to content (drafts, as the admin API shows them). Reads committed data. */\nexport type ContentReadService = {\n  get: (modelKey: string, id: string, options?: ContentReadOptions) => Promise<ContentReadEntry>;\n  /** `query` is a delivery-style querystring, e.g. `filters[title][$contains]=a&pageSize=10`. */\n  list: (\n    modelKey: string,\n    query?: string,\n    options?: Omit<ContentReadOptions, 'locale'>,\n  ) => Promise<{ items: ContentReadEntry[]; total: number }>;\n  /** Number of (non-deleted) entries of a model. */\n  count: (modelKey: string) => Promise<number>;\n  /** The active content models (collections and singletons) of this site: shared ones and its own. */\n  models: () => Promise<HookModel[]>;\n};\n\nexport type MediaUsage = {\n  entryId: string;\n  modelId: string;\n  fieldId: string;\n  locale: string;\n  state: string;\n};\n\nexport type MediaReferenceService = {\n  /** Where an asset is used (up to 100 references, plus the total). */\n  usages: (assetId: string) => Promise<{ items: MediaUsage[]; total: number }>;\n};\n\nexport type EnqueueOptions = {\n  runAt?: Date;\n  /** Enqueueing the same key twice creates one job. */\n  idempotencyKey?: string;\n  maxAttempts?: number;\n};\n\nexport type ExtensionJobService = {\n  /** Enqueues one of the project's own jobs (`jobs` in the config), by its name without the `ext.` prefix. */\n  enqueue: (\n    name: string,\n    payload?: Record<string, unknown>,\n    options?: EnqueueOptions,\n  ) => Promise<{ id: string; created: boolean }>;\n};\n\n/**\n * What Shapio offers extensions. Deliberately small; everything else goes through `trx` or HTTP.\n *\n * Content and media are per site. The services handed to a hook read the hook's site; the services given to\n * routes, jobs and service factories read the primary site. Use `forSite` for another one (in a custom\n * route: `services.forSite(request.site)`).\n */\nexport type ShapioServices = {\n  /** The site `content` and `media` read. */\n  site: ExtensionSite;\n  /** The same services reading another site. */\n  forSite: (site: ExtensionSite) => ShapioServices;\n  content: ContentReadService;\n  media: MediaReferenceService;\n  jobs: ExtensionJobService;\n  logger: FastifyBaseLogger;\n};\n\n/**\n * Your own services, by name. Augment it for typed access everywhere services appear:\n *\n * ```ts\n * declare module '@shapio/cms/config' {\n *   interface CustomServices { stats: StatsService }\n * }\n * ```\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type -- augmented by projects\nexport interface CustomServices {}\n\nexport type ExtensionServices = ShapioServices & CustomServices;\n\ntype HookContextBase = {\n  /** The site the entry belongs to; `services` read this site. */\n  site: ExtensionSite;\n  model: HookModel;\n  entry: HookEntry;\n  locale: string | null;\n  /** The document after the change (absent for deletes). */\n  data: EntryData | undefined;\n  /** The document before the change: the previous draft (update) or the live version (publish). */\n  before: EntryData | undefined;\n  /** Who made the change (an admin, an API token, an app user, or Shapio itself for scheduled work). */\n  principal: Principal;\n  services: ExtensionServices;\n  logger: FastifyBaseLogger;\n  /** Aborted when Shapio shuts down. */\n  signal: AbortSignal;\n};\n\n/**\n * `before*` hooks run INSIDE the write's transaction, before it commits. Throw `HookError` (or call\n * `reject`) to abort the write with 422 `HOOK_REJECTED`; nothing of the write is kept. Other errors abort it\n * too, as a 500. Database work through `trx` commits or rolls back with the write.\n */\nexport type BeforeHookContext = HookContextBase & {\n  event: BeforeHookEvent;\n  trx: Transaction<DB>;\n  reject: (message: string, details?: Record<string, unknown>) => never;\n};\n\n/**\n * `after*` hooks run AFTER the write committed, as a job (retried with backoff on error, never rolling the\n * write back). Database work through `trx` is exactly once: it commits together with the record that the\n * hook ran. Other side effects (HTTP calls) are at least once: make them idempotent with `idempotencyKey`.\n */\nexport type AfterHookContext = HookContextBase & {\n  event: AfterHookEvent;\n  trx: Transaction<DB>;\n  /** The outbox event the hook runs for. */\n  eventId: string;\n  /** `<eventId>:<hook name>`: stable across retries. */\n  idempotencyKey: string;\n  attempt: number;\n};\n\nexport type BeforeHook = (context: BeforeHookContext) => Promise<void> | void;\nexport type AfterHook = (context: AfterHookContext) => Promise<void> | void;\n\nexport type ModelHooks = { [E in BeforeHookEvent]?: BeforeHook } & { [E in AfterHookEvent]?: AfterHook };\n\nexport type ServiceFactoryContext = {\n  /** Kysely on Shapio's database. Shapio's own tables are internal and may change between releases. */\n  db: Kysely<DB>;\n  config: ExtensionHostConfig;\n  logger: FastifyBaseLogger;\n  /** Shapio's services plus the custom services declared before this one. */\n  services: ExtensionServices;\n};\n\nexport type ExtensionHostConfig = {\n  nodeEnv: 'development' | 'production' | 'test';\n  /** PUBLIC_URL origin, without a trailing slash. */\n  publicUrl: string;\n  basePath: string;\n  /** The directory holding shapio.config and extensions/. */\n  projectDir: string;\n};\n\nexport type ServiceFactory = (context: ServiceFactoryContext) => unknown;\n\n/** Options every custom route plugin receives (also available as `app.ext`). */\nexport type ExtensionRouteOptions = {\n  services: ExtensionServices;\n  /** Shapio's permission evaluator: `permissions.evaluate(request.principal, { action, modelId })`. */\n  permissions: PermissionEvaluator;\n  logger: FastifyBaseLogger;\n  /** preHandler: 401/403 unless the caller is an admin user or an admin API token. */\n  requireAdmin: preHandlerAsyncHookHandler;\n};\n\nexport type ExtensionRoute = {\n  /** Mounted at `/api/ext/<prefix>` (under BASE_PATH). Lower-case letters, digits and dashes. */\n  prefix: string;\n  plugin: FastifyPluginAsync<ExtensionRouteOptions>;\n};\n\nexport type JobHandlerContext = {\n  jobId: string;\n  payload: Record<string, unknown>;\n  attempt: number;\n  maxAttempts: number;\n  idempotencyKey: string | null;\n  services: ExtensionServices;\n  logger: FastifyBaseLogger;\n  signal: AbortSignal;\n};\n\n/** Throw to retry with backoff; the return value (JSON) is stored as the job result. */\nexport type ExtensionJobHandler = (context: JobHandlerContext) => Promise<unknown>;\n\nexport type ShapioConfig = {\n  /** Lifecycle hooks by model API ID (or stable model UUID); `*` runs for every model. */\n  hooks?: Record<string, ModelHooks>;\n  routes?: ExtensionRoute[];\n  /** Constructed once at startup, in order, and shared by hooks, routes and jobs. */\n  services?: Record<string, ServiceFactory>;\n  /** Custom field editor modules: file names inside `extensions/editors/` (built ES modules). */\n  editors?: string[];\n  /** Job handlers by name; registered as `ext.<name>`. */\n  jobs?: Record<string, ExtensionJobHandler>;\n};\n\n/** Identity helper for completion and type checking in `shapio.config.ts`. */\nexport const defineConfig = (config: ShapioConfig): ShapioConfig => config;\n\nconst HOOK_ERROR_BRAND = Symbol.for('shapio.HookError');\n\n/**\n * Thrown by a `before*` hook to reject a write: the API answers 422 with code `HOOK_REJECTED`, this message\n * and the details. Recognised by a brand, not `instanceof`, so a copy of this class loaded from another\n * path (a project's own `node_modules`) works the same.\n */\nexport class HookError extends Error {\n  readonly details: Record<string, unknown> | undefined;\n  readonly [HOOK_ERROR_BRAND] = true;\n\n  constructor(message: string, details?: Record<string, unknown>) {\n    super(message);\n    this.name = 'HookError';\n    this.details = details;\n  }\n}\n\nexport const isHookError = (error: unknown): error is HookError =>\n  typeof error === 'object' &&\n  error !== null &&\n  (error as Record<symbol, unknown>)[HOOK_ERROR_BRAND] === true;\n"],"mappings":";;;;;;;;;;;;;;;;AAyCA,MAAa,6BAA6B;;AAsO1C,MAAa,gBAAgB,WAAuC;AAEpE,MAAM,mBAAmB,OAAO,IAAI,kBAAkB;;;;;;AAOtD,IAAa,YAAb,cAA+B,MAAM;CACnC;CACA,CAAU,oBAAoB;CAE9B,YAAY,SAAiB,SAAmC;EAC9D,MAAM,OAAO;EACb,KAAK,OAAO;EACZ,KAAK,UAAU;CACjB;AACF;AAEA,MAAa,eAAe,UAC1B,OAAO,UAAU,YACjB,UAAU,QACT,MAAkC,sBAAsB"}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { A as ServiceFactoryContext, C as HookEvent, D as MediaUsage, E as MediaReferenceService, F as PermissionEvaluator, I as Principal, L as DB, M as ShapioServices, N as defineConfig, O as ModelHooks, P as isHookError, R as OutboxEvents, S as HookError, T as JobHandlerContext, _ as ExtensionRoute, a as BeforeHookContext, b as ExtensionSite, c as ContentReadOptions, d as EXTENSION_CONTRACT_VERSION, f as EnqueueOptions, g as ExtensionJobService, h as ExtensionJobHandler, i as BeforeHook, j as ShapioConfig, k as ServiceFactory, l as ContentReadService, m as ExtensionHostConfig, n as AfterHookContext, o as BeforeHookEvent, p as EntryData, r as AfterHookEvent, s as ContentReadEntry, t as AfterHook, u as CustomServices, v as ExtensionRouteOptions, w as HookModel, x as HookEntry, y as ExtensionServices, z as ContentData } from "./public-CKU0Gkfq.js";
+import { A as ServiceFactoryContext, C as HookEvent, D as MediaUsage, E as MediaReferenceService, F as PermissionEvaluator, I as Principal, L as DB, M as ShapioServices, N as defineConfig, O as ModelHooks, P as isHookError, R as OutboxEvents, S as HookError, T as JobHandlerContext, _ as ExtensionRoute, a as BeforeHookContext, b as ExtensionSite, c as ContentReadOptions, d as EXTENSION_CONTRACT_VERSION, f as EnqueueOptions, g as ExtensionJobService, h as ExtensionJobHandler, i as BeforeHook, j as ShapioConfig, k as ServiceFactory, l as ContentReadService, m as ExtensionHostConfig, n as AfterHookContext, o as BeforeHookEvent, p as EntryData, r as AfterHookEvent, s as ContentReadEntry, t as AfterHook, u as CustomServices, v as ExtensionRouteOptions, w as HookModel, x as HookEntry, y as ExtensionServices, z as ContentData } from "./public-CGO8RBn3.js";
 import { FastifyBaseLogger, FastifyInstance } from "fastify";
 import { Kysely, Selectable, Transaction } from "kysely";
 import { Static, Type } from "typebox";
@@ -780,6 +780,11 @@ type ModelField = {
 type FieldVisibilityLookup = {
   getModelFields: (modelId: string) => Promise<readonly ModelField[] | undefined>;
   hasModel: (modelId: string) => Promise<boolean>;
+  /**
+   * The site a definition belongs to: null when it is shared (or unknown). Schema management of a site's
+   * definition is granted by roles held on that site (plan site-schema, rule 4).
+   */
+  getModelSite: (modelId: string) => Promise<string | null>;
 };
 //#endregion
 //#region src/publishing/outbound/ssrf.d.ts

package/dist/index.js

@@ -1,3 +1,3 @@
-import { a as loadConfig, n as startServer, s as buildApp, t as startDedicatedWorker, u as SHAPIO_VERSION } from "./worker-C-MSYr4l.js";
+import { a as loadConfig, n as startServer, s as buildApp, t as startDedicatedWorker, u as SHAPIO_VERSION } from "./worker-BLXy8aRW.js";
 import { EXTENSION_CONTRACT_VERSION, HookError, defineConfig, isHookError } from "./config.js";
 export { EXTENSION_CONTRACT_VERSION, HookError, SHAPIO_VERSION, buildApp, defineConfig, isHookError, loadConfig, startDedicatedWorker, startServer };

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

@@ -510,6 +510,7 @@ interface Models {
   deleted_at: Timestamp | null;
   id: string;
   kind: string;
+  site_id: string | null;
   updated_at: Generated<Timestamp>;
 }
 interface OutboxEvents {
@@ -628,6 +629,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;
@@ -899,6 +901,12 @@ type PolicyRequest = {
 type PermissionEvaluator = {
   evaluate: (principal: Principal, request: PolicyRequest) => Promise<Policy>;
   canPerform: (principal: Principal, action: GlobalAction) => 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) => Promise<boolean>;
 };
 //#endregion
 //#region src/plugins/auditDeclaration.d.ts
@@ -1002,7 +1010,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 = {
@@ -1174,4 +1182,4 @@ 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
+//# sourceMappingURL=public-CGO8RBn3.d.ts.map