@marinoscar/platform-contract 0.0.0-stage → 0.1.0-next.4

package/dist/esm/settings/schemas.js

@@ -0,0 +1,434 @@
+// =============================================================================
+// The settings slice's wire shapes (issue #733, PP-8.1)
+// =============================================================================
+//
+// The core fields of a user's settings document (`theme`, `profile`), the two
+// UI-preference user namespaces the platform owns (`dataTables`,
+// `navigation`) and the organization-settings route bodies, as zod schemas
+// plus their inferred types. Shared by `@marinoscar/platform-api/settings`
+// (which composes them into its request DTOs, so the OpenAPI document is
+// generated from them) and the web app (which takes the types).
+//
+// MOVED VERBATIM from the reference app (`apps/api/src/common/schemas/
+// settings.schema.ts` and `user-settings-namespaces.schema.ts`): field order,
+// bounds and enum orders are part of the published OpenAPI document. Change
+// them only as a deliberate API change.
+//
+// NO `.default()` ANYWHERE. Absent means "use the built-in default", computed
+// at read time by the consumer; a default here would freeze a user at today's
+// value the first time they saved an unrelated preference.
+// =============================================================================
+import { z } from 'zod';
+import { DATA_TABLE_DENSITIES, DATA_TABLE_ENTRY_MAX_BYTES, DATA_TABLE_EXTRA_MAX_BYTES, DATA_TABLE_EXTRA_MAX_DEPTH, DATA_TABLE_EXTRA_MAX_KEYS, DATA_TABLE_ID_PATTERN, DATA_TABLE_MAX_ID_LENGTH, DATA_TABLE_MAX_PAGE_SIZE, DATA_TABLE_MAX_SAVED_VIEWS, DATA_TABLE_MAX_VISIBLE_COLUMNS, DATA_TABLE_SORT_DIRECTIONS, DATA_TABLE_VIEW_NAME_MAX_LENGTH, ORG_SETTINGS_FIELD_KINDS, ORG_SETTINGS_MERGE_MODES, PROFILE_DISPLAY_NAME_MAX, PROFILE_IMAGE_SOURCES, THEME_OPTION_LABEL_MAX, THEME_PREFERENCE_ID_PATTERN, THEME_PREFERENCES, } from './constants.js';
+// =============================================================================
+// Core fields: theme and profile
+// =============================================================================
+/**
+ * `theme` as stored and as a PUT carries it.
+ *
+ * @stability stable
+ */
+export const themePreferenceSchema = z.enum(THEME_PREFERENCES);
+/**
+ * A theme preference id of any registered theme: the pattern
+ * {@link THEME_PREFERENCE_ID_PATTERN}, not the closed list. The API accepts in
+ * `theme` only the built-in ids and the ones an app registered, so this schema
+ * types a registered id on the wire without validating membership.
+ *
+ * @extensionPoint schema
+ * @stability experimental
+ */
+export const themePreferenceIdSchema = z.string().regex(THEME_PREFERENCE_ID_PATTERN);
+/**
+ * One theme an app registered, as `themeOptions` lists it in the user
+ * settings response.
+ *
+ * @extensionPoint schema
+ * @stability experimental
+ */
+export const themeOptionSchema = z.object({
+    /** The id stored in `theme`. */
+    id: themePreferenceIdSchema,
+    /** The label the theme control shows. */
+    label: z.string().min(1).max(THEME_OPTION_LABEL_MAX),
+});
+/**
+ * `profile.imageSource`.
+ *
+ * @stability stable
+ */
+export const profileImageSourceSchema = z.enum(PROFILE_IMAGE_SOURCES);
+/**
+ * `profile` as stored. `imageObjectId` is nullable (no avatar uploaded, or it
+ * was removed) and optional only so a PUT body may omit it: the service then
+ * keeps the stored id. Whether the id names an avatar the caller owns is
+ * checked by the API, not here (it needs the database).
+ *
+ * @stability stable
+ */
+export const userProfileSettingsSchema = z.object({
+    /** The name the user chose to be shown under. */
+    displayName: z.string().max(PROFILE_DISPLAY_NAME_MAX).optional(),
+    /** Which picture represents the user. */
+    imageSource: profileImageSourceSchema,
+    /** The uploaded avatar's object id; `null` when none. */
+    imageObjectId: z.string().uuid().nullable().optional(),
+});
+/**
+ * `profile` in a PATCH body: every field optional; `imageObjectId: null`
+ * clears the reference, absent leaves it alone.
+ *
+ * @stability stable
+ */
+export const userProfileSettingsPatchSchema = z.object({
+    /** The new display name. */
+    displayName: z.string().max(PROFILE_DISPLAY_NAME_MAX).optional(),
+    /** The new picture source. */
+    imageSource: profileImageSourceSchema.optional(),
+    /** The new avatar object id; `null` clears it. */
+    imageObjectId: z.string().uuid().nullable().optional(),
+});
+// =============================================================================
+// The `dataTables` user namespace
+// =============================================================================
+/**
+ * Row density of one table.
+ *
+ * @stability stable
+ */
+export const dataTableDensitySchema = z.enum(DATA_TABLE_DENSITIES);
+/**
+ * Sort direction of one table.
+ *
+ * @stability stable
+ */
+export const dataTableSortDirectionSchema = z.enum(DATA_TABLE_SORT_DIRECTIONS);
+/**
+ * Persisted sort state of one table.
+ *
+ * @stability stable
+ */
+export const dataTableSortSchema = z
+    .object({
+    /** The column sorted by. */
+    field: z.string().min(1).max(DATA_TABLE_MAX_ID_LENGTH),
+    /** The direction. */
+    direction: dataTableSortDirectionSchema,
+})
+    .strict();
+/** The JSON size of `value` in bytes, or `Infinity` when it is not JSON. */
+function jsonBytes(value) {
+    try {
+        const text = JSON.stringify(value);
+        return text === undefined ? Infinity : new TextEncoder().encode(text).length;
+    }
+    catch {
+        return Infinity;
+    }
+}
+/** Whether `value` is plain JSON within the depth bound and free of keys that could poison a later merge. */
+function isSafeJson(value, depth = 0) {
+    if (depth > DATA_TABLE_EXTRA_MAX_DEPTH)
+        return false;
+    if (value === null || typeof value === 'string' || typeof value === 'boolean')
+        return true;
+    if (typeof value === 'number')
+        return Number.isFinite(value);
+    if (Array.isArray(value))
+        return value.every((item) => isSafeJson(item, depth + 1));
+    if (typeof value === 'object') {
+        return Object.keys(value).every((key) => key !== '__proto__' && key !== 'constructor' && key !== 'prototype' && isSafeJson(value[key], depth + 1));
+    }
+    return false;
+}
+/**
+ * An app's own stored layout fields: a record of bounded plain JSON (at most
+ * `DATA_TABLE_EXTRA_MAX_KEYS` keys, `DATA_TABLE_EXTRA_MAX_BYTES` bytes and
+ * `DATA_TABLE_EXTRA_MAX_DEPTH` levels; no `__proto__`, `constructor` or
+ * `prototype` key at any depth). The platform never reads it.
+ *
+ * @stability experimental
+ */
+export const dataTableExtraSchema = z
+    .record(z.string().min(1).max(DATA_TABLE_MAX_ID_LENGTH), z.unknown())
+    .refine((extra) => Object.keys(extra).length <= DATA_TABLE_EXTRA_MAX_KEYS, {
+    message: `extra carries at most ${DATA_TABLE_EXTRA_MAX_KEYS} keys`,
+})
+    .refine((extra) => isSafeJson(extra), {
+    message: `extra must be plain JSON, at most ${DATA_TABLE_EXTRA_MAX_DEPTH} levels deep`,
+})
+    .refine((extra) => jsonBytes(extra) <= DATA_TABLE_EXTRA_MAX_BYTES, {
+    message: `extra is larger than ${DATA_TABLE_EXTRA_MAX_BYTES} bytes`,
+});
+/** The fields a table's layout and a saved view's layout share. */
+const dataTableLayoutShape = {
+    /** The column ids shown, in order. */
+    visibleColumns: z
+        .array(z.string().min(1).max(DATA_TABLE_MAX_ID_LENGTH))
+        .max(DATA_TABLE_MAX_VISIBLE_COLUMNS)
+        .optional(),
+    /** The row density. */
+    density: dataTableDensitySchema.optional(),
+    /** The sort state. */
+    sort: dataTableSortSchema.optional(),
+    /** The page size. */
+    pageSize: z.number().int().min(1).max(DATA_TABLE_MAX_PAGE_SIZE).optional(),
+    /** An app's own bounded JSON (saved filters, a chart toggle). */
+    extra: dataTableExtraSchema.optional(),
+};
+/**
+ * The layout a saved view captures: the same fields as the table's own entry,
+ * `extra` included, without nested views.
+ *
+ * @stability experimental
+ */
+export const dataTableViewLayoutSchema = z.object(dataTableLayoutShape).strict();
+/**
+ * One saved view of a table: a named layout.
+ *
+ * @stability experimental
+ */
+export const dataTableSavedViewSchema = z
+    .object({
+    /** A slug unique within the table's views. */
+    id: z.string().min(1).max(DATA_TABLE_MAX_ID_LENGTH).regex(DATA_TABLE_ID_PATTERN),
+    /** What the user called it. */
+    name: z.string().trim().min(1).max(DATA_TABLE_VIEW_NAME_MAX_LENGTH),
+    /** The layout it restores. */
+    layout: dataTableViewLayoutSchema,
+})
+    .strict();
+/**
+ * Persisted preferences of one data table. Every key optional, none
+ * defaulted. `extra` (an app's bounded JSON, at most 8 KiB) and `savedViews`
+ * (at most 20, ids unique) are the app-facing additions; the whole entry stays
+ * within `DATA_TABLE_ENTRY_MAX_BYTES`.
+ *
+ * @stability stable
+ */
+export const dataTableEntrySchema = z
+    .object({
+    ...dataTableLayoutShape,
+    /** Named layouts the user saved. */
+    savedViews: z
+        .array(dataTableSavedViewSchema)
+        .max(DATA_TABLE_MAX_SAVED_VIEWS)
+        .refine((views) => new Set(views.map((view) => view.id)).size === views.length, { message: 'saved view ids must be unique' })
+        .optional(),
+})
+    .strict()
+    .refine((entry) => jsonBytes(entry) <= DATA_TABLE_ENTRY_MAX_BYTES, {
+    message: `a table's stored preferences are larger than ${DATA_TABLE_ENTRY_MAX_BYTES} bytes`,
+});
+/**
+ * A table identifier: the key of the `dataTables` record.
+ *
+ * @stability stable
+ */
+export const dataTableIdSchema = z.string().min(1).max(DATA_TABLE_MAX_ID_LENGTH).regex(DATA_TABLE_ID_PATTERN);
+/**
+ * The stored `dataTables` namespace: table id to preferences. The entry
+ * count cap (`DATA_TABLE_MAX_TABLES`) is enforced by the API after the merge.
+ *
+ * @stability stable
+ */
+export const dataTablesSchema = z.record(dataTableIdSchema, dataTableEntrySchema);
+/**
+ * The PATCH form of `dataTables`: `null` deletes one table's entry; a
+ * non-null entry REPLACES the stored one wholesale.
+ *
+ * @stability stable
+ */
+export const dataTablesPatchSchema = z.record(dataTableIdSchema, dataTableEntrySchema.nullable());
+// =============================================================================
+// The `navigation` user namespace
+// =============================================================================
+/**
+ * The stored `navigation` namespace. `railCollapsed` absent means "use the
+ * built-in default".
+ *
+ * @stability stable
+ */
+export const navigationSchema = z
+    .object({
+    /** Whether the navigation rail is collapsed. */
+    railCollapsed: z.boolean().optional(),
+})
+    .strict();
+/**
+ * The PATCH form of `navigation`: a field may be `null`, meaning "delete it
+ * and fall back to the built-in default".
+ *
+ * @stability stable
+ */
+export const navigationPatchSchema = z
+    .object({
+    /** Whether the rail is collapsed; `null` deletes the preference. */
+    railCollapsed: z.boolean().nullable().optional(),
+})
+    .strict();
+// =============================================================================
+// Organization settings (`GET` / `PATCH /api/org-settings`)
+// =============================================================================
+/**
+ * One field of an org-overridable namespace, described for a generated form.
+ *
+ * @stability experimental
+ */
+export const orgSettingsFieldSchema = z.object({
+    /** The field's key inside the namespace. */
+    name: z.string(),
+    /** The control the page renders; `other` links to the slice's own page. */
+    kind: z.enum(ORG_SETTINGS_FIELD_KINDS),
+    /** The allowed values of an `enum` field. */
+    options: z.array(z.string()).optional(),
+    /** The lower bound of a `number` field, when the schema declares one. */
+    min: z.number().optional(),
+    /** The upper bound of a `number` field, when the schema declares one. */
+    max: z.number().optional(),
+    /** Whether a `number` field must be an integer. */
+    integer: z.boolean().optional(),
+    /** The longest `string` value, when the schema declares one. */
+    maxLength: z.number().int().optional(),
+});
+/**
+ * One org-overridable namespace the caller may read.
+ *
+ * @stability experimental
+ */
+export const orgSettingsNamespaceSchema = z.object({
+    /** The namespace key (`ai`, `notifications`, ...). */
+    key: z.string(),
+    /** One sentence on what it configures. */
+    description: z.string(),
+    /** How the org value combines with the system value. */
+    merge: z.enum(ORG_SETTINGS_MERGE_MODES),
+    /** Whether the caller may PATCH it (holds its write permission). */
+    writable: z.boolean(),
+    /** The fields an organization may set, in declaration order. */
+    fields: z.array(orgSettingsFieldSchema),
+});
+/**
+ * The `GET` / `PATCH /api/org-settings` response (inside the `{ data }`
+ * envelope): the caller's active organization's stored overrides (`value`),
+ * the resolved system-then-org value of every org-overridable namespace
+ * (`effective`), the row version for `If-Match` (`0` while no row exists)
+ * and the namespace descriptors. A namespace the caller may not read is
+ * absent from all three maps.
+ *
+ * @stability experimental
+ */
+export const orgSettingsResponseSchema = z.object({
+    /** The organization (the caller's active one). */
+    orgId: z.string().uuid(),
+    /** Its stored overrides: namespace key to the fields it sets. */
+    value: z.record(z.string(), z.record(z.string(), z.unknown())),
+    /** The effective value of each org-overridable namespace (system, then org). */
+    effective: z.record(z.string(), z.unknown()),
+    /** The row version for `If-Match`; `0` while the organization has no row. */
+    version: z.number().int(),
+    /** The descriptor of every org-overridable namespace the caller may read. */
+    namespaces: z.array(orgSettingsNamespaceSchema),
+    /** When the row last changed, or `null`. */
+    updatedAt: z.iso.datetime().nullable(),
+});
+/**
+ * The `PATCH /api/org-settings` body: namespace key to a partial of that
+ * namespace's org fields, or `null` to clear the organization's override of
+ * the namespace. Inside a namespace a field set to `null` is removed (the
+ * system value applies again). Each branch is validated by the API against
+ * the namespace's own org schema; an unknown or non-overridable namespace is
+ * a 400.
+ *
+ * @stability experimental
+ */
+export const patchOrgSettingsSchema = z.record(z.string().regex(/^[a-z][A-Za-z0-9]*$/), z.record(z.string(), z.unknown()).nullable());
+// =============================================================================
+// Pluggable kinds: the descriptor a generated configuration form renders
+// (PP-14.5, issue #923)
+// =============================================================================
+const configFieldBase = {
+    /** The field's key inside the implementation's settings (or the secret's name). */
+    name: z.string(),
+    /** The human label the form shows. */
+    label: z.string(),
+    /** One sentence of help, shown under the control. */
+    help: z.string().optional(),
+};
+/**
+ * One configuration field of a pluggable implementation, described for a
+ * generated form. Discriminated by `kind`. The five non-secret kinds are the
+ * organization settings kinds ({@link orgSettingsFieldSchema}) plus `label`
+ * and `help`; `secret` is write-only: it carries whether a value is stored
+ * (`hasValue`) and whether one is required, never the value.
+ *
+ * @extensionPoint schema
+ * @stability experimental
+ */
+export const configFieldSchema = z.discriminatedUnion('kind', [
+    z.object({
+        ...configFieldBase,
+        /** A switch. */
+        kind: z.literal('boolean'),
+    }),
+    z.object({
+        ...configFieldBase,
+        /** A select. */
+        kind: z.literal('enum'),
+        /** The allowed values. */
+        options: z.array(z.string()),
+    }),
+    z.object({
+        ...configFieldBase,
+        /** A number input. */
+        kind: z.literal('number'),
+        /** The lower bound, when the schema declares one. */
+        min: z.number().optional(),
+        /** The upper bound, when the schema declares one. */
+        max: z.number().optional(),
+        /** Whether the value must be an integer. */
+        integer: z.boolean().optional(),
+    }),
+    z.object({
+        ...configFieldBase,
+        /** A text input. */
+        kind: z.literal('string'),
+        /** The longest value, when the schema declares one. */
+        maxLength: z.number().int().optional(),
+    }),
+    z.object({
+        ...configFieldBase,
+        /** A field the form cannot edit generically; it shows a note instead of a control. */
+        kind: z.literal('other'),
+    }),
+    z.object({
+        ...configFieldBase,
+        /** A write-only secret input. */
+        kind: z.literal('secret'),
+        /** Whether a value is stored. The value itself never leaves the server. */
+        hasValue: z.boolean(),
+        /** Whether the implementation cannot work without one. */
+        required: z.boolean(),
+    }),
+]);
+/**
+ * One implementation of a pluggable kind, described for a generated form: its
+ * identity and its fields (the non-secret settings in declaration order, then
+ * one `secret` field per declared secret).
+ *
+ * @extensionPoint schema
+ * @stability experimental
+ */
+export const pluggableDescriptorSchema = z.object({
+    /** The kind it implements (`ai-provider`, `storage-driver`, ...). */
+    kind: z.string(),
+    /** The implementation id; permanent once stored. */
+    id: z.string(),
+    /** The human label. */
+    label: z.string(),
+    /** One sentence on what it is. */
+    description: z.string().optional(),
+    /** Its configuration fields. */
+    fields: z.array(configFieldSchema),
+});
+//# sourceMappingURL=schemas.js.map

package/dist/esm/settings/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/settings/schemas.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,wDAAwD;AACxD,gFAAgF;AAChF,EAAE;AACF,8EAA8E;AAC9E,iEAAiE;AACjE,2EAA2E;AAC3E,2EAA2E;AAC3E,yEAAyE;AACzE,gEAAgE;AAChE,EAAE;AACF,uEAAuE;AACvE,8EAA8E;AAC9E,4EAA4E;AAC5E,wCAAwC;AACxC,EAAE;AACF,8EAA8E;AAC9E,8EAA8E;AAC9E,2DAA2D;AAC3D,gFAAgF;AAEhF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,oBAAoB,EACpB,0BAA0B,EAC1B,0BAA0B,EAC1B,0BAA0B,EAC1B,yBAAyB,EACzB,qBAAqB,EACrB,wBAAwB,EACxB,wBAAwB,EACxB,0BAA0B,EAC1B,8BAA8B,EAC9B,0BAA0B,EAC1B,+BAA+B,EAC/B,wBAAwB,EACxB,wBAAwB,EACxB,wBAAwB,EACxB,qBAAqB,EACrB,sBAAsB,EACtB,2BAA2B,EAC3B,iBAAiB,GAClB,MAAM,gBAAgB,CAAC;AA2CxB,gFAAgF;AAChF,iCAAiC;AACjC,gFAAgF;AAEhF;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAmC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;AAE/F;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;AAErF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,gCAAgC;IAChC,EAAE,EAAE,uBAAuB;IAC3B,yCAAyC;IACzC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,sBAAsB,CAAC;CACrD,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAsC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;AAEzG;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,iDAAiD;IACjD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC,QAAQ,EAAE;IAChE,yCAAyC;IACzC,WAAW,EAAE,wBAAwB;IACrC,yDAAyD;IACzD,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CACvD,CAAC,CAAC;AASH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,4BAA4B;IAC5B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC,QAAQ,EAAE;IAChE,8BAA8B;IAC9B,WAAW,EAAE,wBAAwB,CAAC,QAAQ,EAAE;IAChD,kDAAkD;IAClD,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CACvD,CAAC,CAAC;AASH,gFAAgF;AAChF,kCAAkC;AAClC,gFAAgF;AAEhF;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAoC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;AAEpG;;;;GAIG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAA0C,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;AAEtH;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC;KACjC,MAAM,CAAC;IACN,4BAA4B;IAC5B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,wBAAwB,CAAC;IACtD,qBAAqB;IACrB,SAAS,EAAE,4BAA4B;CACxC,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,4EAA4E;AAC5E,SAAS,SAAS,CAAC,KAAc;IAC/B,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACnC,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;IAC/E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,QAAQ,CAAC;IAClB,CAAC;AACH,CAAC;AAED,6GAA6G;AAC7G,SAAS,UAAU,CAAC,KAAc,EAAE,KAAK,GAAG,CAAC;IAC3C,IAAI,KAAK,GAAG,0BAA0B;QAAE,OAAO,KAAK,CAAC;IACrD,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAC3F,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC7D,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;IACpF,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,MAAM,CAAC,IAAI,CAAC,KAAe,CAAC,CAAC,KAAK,CACvC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,aAAa,IAAI,GAAG,KAAK,WAAW,IAAI,UAAU,CAAE,KAAiC,CAAC,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CAC/I,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,wBAAwB,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;KACpE,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,IAAI,yBAAyB,EAAE;IACzE,OAAO,EAAE,yBAAyB,yBAAyB,OAAO;CACnE,CAAC;KACD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;IACpC,OAAO,EAAE,qCAAqC,0BAA0B,cAAc;CACvF,CAAC;KACD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,0BAA0B,EAAE;IACjE,OAAO,EAAE,wBAAwB,0BAA0B,QAAQ;CACpE,CAAC,CAAC;AAEL,mEAAmE;AACnE,MAAM,oBAAoB,GAAG;IAC3B,sCAAsC;IACtC,cAAc,EAAE,CAAC;SACd,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;SACtD,GAAG,CAAC,8BAA8B,CAAC;SACnC,QAAQ,EAAE;IACb,uBAAuB;IACvB,OAAO,EAAE,sBAAsB,CAAC,QAAQ,EAAE;IAC1C,sBAAsB;IACtB,IAAI,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IACpC,qBAAqB;IACrB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC,QAAQ,EAAE;IAC1E,iEAAiE;IACjE,KAAK,EAAE,oBAAoB,CAAC,QAAQ,EAAE;CACvC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,MAAM,EAAE,CAAC;AAEjF;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACtC,MAAM,CAAC;IACN,8CAA8C;IAC9C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC;IAChF,+BAA+B;IAC/B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,+BAA+B,CAAC;IACnE,8BAA8B;IAC9B,MAAM,EAAE,yBAAyB;CAClC,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,GAAG,oBAAoB;IACvB,oCAAoC;IACpC,UAAU,EAAE,CAAC;SACV,KAAK,CAAC,wBAAwB,CAAC;SAC/B,GAAG,CAAC,0BAA0B,CAAC;SAC/B,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,+BAA+B,EAAE,CAAC;SAC5H,QAAQ,EAAE;CACd,CAAC;KACD,MAAM,EAAE;KACR,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,0BAA0B,EAAE;IACjE,OAAO,EAAE,gDAAgD,0BAA0B,QAAQ;CAC5F,CAAC,CAAC;AAEL;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;AAE9G;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,CAAC;AAElF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,QAAQ,EAAE,CAAC,CAAC;AAmDlG,gFAAgF;AAChF,kCAAkC;AAClC,gFAAgF;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,MAAM,CAAC;IACN,gDAAgD;IAChD,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACtC,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC;KACnC,MAAM,CAAC;IACN,oEAAoE;IACpE,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CACjD,CAAC;KACD,MAAM,EAAE,CAAC;AAeZ,gFAAgF;AAChF,4DAA4D;AAC5D,gFAAgF;AAEhF;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,4CAA4C;IAC5C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,2EAA2E;IAC3E,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAwC;IAC7E,6CAA6C;IAC7C,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,yEAAyE;IACzE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,yEAAyE;IACzE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,mDAAmD;IACnD,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,gEAAgE;IAChE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAC;AASH;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,sDAAsD;IACtD,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,0CAA0C;IAC1C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,wDAAwD;IACxD,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAwC;IAC9E,oEAAoE;IACpE,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,gEAAgE;IAChE,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC;CACxC,CAAC,CAAC;AASH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,kDAAkD;IAClD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IACxB,iEAAiE;IACjE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IAC9D,gFAAgF;IAChF,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;IAC5C,6EAA6E;IAC7E,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACzB,6EAA6E;IAC7E,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,0BAA0B,CAAC;IAC/C,4CAA4C;IAC5C,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAC;AASH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAC5C,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,qBAAqB,CAAC,EACvC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAC7C,CAAC;AASF,gFAAgF;AAChF,yEAAyE;AACzE,wBAAwB;AACxB,gFAAgF;AAEhF,MAAM,eAAe,GAAG;IACtB,mFAAmF;IACnF,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,sCAAsC;IACtC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,qDAAqD;IACrD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IAC5D,CAAC,CAAC,MAAM,CAAC;QACP,GAAG,eAAe;QAClB,gBAAgB;QAChB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;KAC3B,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,GAAG,eAAe;QAClB,gBAAgB;QAChB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QACvB,0BAA0B;QAC1B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;KAC7B,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,GAAG,eAAe;QAClB,sBAAsB;QACtB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;QACzB,qDAAqD;QACrD,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC1B,qDAAqD;QACrD,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC1B,4CAA4C;QAC5C,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;KAChC,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,GAAG,eAAe;QAClB,oBAAoB;QACpB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;QACzB,uDAAuD;QACvD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;KACvC,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,GAAG,eAAe;QAClB,sFAAsF;QACtF,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;KACzB,CAAC;IACF,CAAC,CAAC,MAAM,CAAC;QACP,GAAG,eAAe;QAClB,iCAAiC;QACjC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;QACzB,2EAA2E;QAC3E,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;QACrB,0DAA0D;QAC1D,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;KACtB,CAAC;CACH,CAAC,CAAC;AASH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,qEAAqE;IACrE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,oDAAoD;IACpD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,uBAAuB;IACvB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,kCAAkC;IAClC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,gCAAgC;IAChC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC;CACnC,CAAC,CAAC"}

package/dist/esm/settings/types.d.ts

@@ -0,0 +1,79 @@
+import type { ProfileImageSource, ThemePreference } from './constants.js';
+/**
+ * A theme preference id: one of the built-in {@link ThemePreference} values or
+ * the id of a theme an app registered with `registerThemePreference`. The
+ * `(string & {})` keeps editor completion for the built-in ids.
+ *
+ * @stability experimental
+ */
+export type ThemePreferenceId = ThemePreference | (string & {});
+/**
+ * One theme an app registered on top of the built-in light, dark and system
+ * choices, as `GET /api/user-settings` lists it in `themeOptions`.
+ *
+ * @stability experimental
+ */
+export interface ThemeOption {
+    /** The id stored in `theme`; matches `THEME_PREFERENCE_ID_PATTERN`. */
+    id: string;
+    /** The label the theme control shows. */
+    label: string;
+}
+/**
+ * The core fields of `GET /api/system-settings`: the session policy (derived
+ * configuration, never stored), the audit fields and the row version for
+ * `If-Match`. Every registered system namespace is a further property; an
+ * app types them by extending this interface.
+ *
+ * @stability experimental
+ */
+export interface SystemSettingsResponseBase {
+    /** The session policy the token signer uses (read only). */
+    security: {
+        /** The access token's lifetime, in minutes. */
+        jwtAccessTtlMinutes: number;
+        /** The refresh token's lifetime, in days. */
+        refreshTtlDays: number;
+    };
+    /** When the row last changed (ISO 8601). */
+    updatedAt: string;
+    /** Who last changed it, or `null`. */
+    updatedBy: {
+        /** The user's id. */
+        id: string;
+        /** The user's email. */
+        email: string;
+    } | null;
+    /** The row version; send it back as `If-Match`. */
+    version: number;
+}
+/**
+ * The core fields of `GET /api/user-settings`. Every optional user namespace
+ * the user has stored something for is a further property (absent means
+ * "apply the built-in defaults").
+ *
+ * @stability experimental
+ */
+export interface UserSettingsResponseBase {
+    /** The theme preference. */
+    theme: ThemePreference;
+    /** The profile preferences; `imageObjectId` is `null` when nothing is uploaded. */
+    profile: {
+        /** The display name, when one was chosen. */
+        displayName?: string | null;
+        /** Which picture represents the user. */
+        imageSource: ProfileImageSource;
+        /** The uploaded avatar's object id, or `null`. */
+        imageObjectId: string | null;
+    };
+    /**
+     * The themes an app registered on top of light, dark and system; absent
+     * (never an empty list) when it registered none.
+     */
+    themeOptions?: ThemeOption[];
+    /** When the row last changed (ISO 8601). */
+    updatedAt: string;
+    /** The row version; send it back as `If-Match`. */
+    version: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/settings/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/settings/types.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAE1E;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG,eAAe,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAEhE;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,uEAAuE;IACvE,EAAE,EAAE,MAAM,CAAC;IACX,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,0BAA0B;IACzC,4DAA4D;IAC5D,QAAQ,EAAE;QACR,+CAA+C;QAC/C,mBAAmB,EAAE,MAAM,CAAC;QAC5B,6CAA6C;QAC7C,cAAc,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,4CAA4C;IAC5C,SAAS,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,SAAS,EAAE;QACT,qBAAqB;QACrB,EAAE,EAAE,MAAM,CAAC;QACX,wBAAwB;QACxB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,IAAI,CAAC;IACT,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,wBAAwB;IACvC,4BAA4B;IAC5B,KAAK,EAAE,eAAe,CAAC;IACvB,mFAAmF;IACnF,OAAO,EAAE;QACP,6CAA6C;QAC7C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC5B,yCAAyC;QACzC,WAAW,EAAE,kBAAkB,CAAC;QAChC,kDAAkD;QAClD,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B,CAAC;IACF;;;OAGG;IACH,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,4CAA4C;IAC5C,SAAS,EAAE,MAAM,CAAC;IAClB,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/dist/esm/settings/types.js

@@ -0,0 +1,5 @@
+// The settings slice's response envelopes as plain types (issue #733). Zod-free:
+// the web hooks take these as the default type of their documents, and an app
+// that registers its own namespaces passes a wider type of its own.
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/settings/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/settings/types.ts"],"names":[],"mappings":"AAAA,iFAAiF;AACjF,8EAA8E;AAC9E,oEAAoE"}