@happyvertical/smrt-preferences 0.0.0-stage → 0.55.10

package/dist/manifest.json

@@ -0,0 +1,533 @@
+{
+  "version": "1.0.0",
+  "timestamp": 0,
+  "packageName": "@happyvertical/smrt-preferences",
+  "packageVersion": "0.55.10",
+  "objects": {
+    "@happyvertical/smrt-preferences:UiPreferenceRecordCollection": {
+      "name": "uipreferencerecordcollection",
+      "className": "UiPreferenceRecordCollection",
+      "qualifiedName": "@happyvertical/smrt-preferences:UiPreferenceRecordCollection",
+      "collection": "uipreferencerecords",
+      "description": "Reads of UiPreferenceRecord. Not decorated: the model has no generated surface, so a decorated collection would only add a second manifest schema for the same table.",
+      "filePath": "/home/runner/work/smrt/smrt/packages/preferences/src/collections/UiPreferenceRecordCollection.ts",
+      "packageName": "@happyvertical/smrt-preferences",
+      "fields": {},
+      "methods": {
+        "findTier": {
+          "name": "findTier",
+          "async": true,
+          "parameters": [
+            {
+              "name": "tenantId",
+              "type": "string",
+              "optional": false
+            },
+            {
+              "name": "kind",
+              "type": "string",
+              "optional": false
+            },
+            {
+              "name": "surfaceId",
+              "type": "string",
+              "optional": false
+            },
+            {
+              "name": "scope",
+              "type": "PreferenceScope",
+              "optional": false
+            },
+            {
+              "name": "userId",
+              "type": "string",
+              "optional": true
+            }
+          ],
+          "returnType": "Promise<UiPreferenceRecord | null>",
+          "isStatic": false,
+          "isPublic": true
+        }
+      },
+      "decoratorConfig": {
+        "tableName": "_smrt_ui_preferences",
+        "cli": false
+      },
+      "extends": "SmrtCollection",
+      "extendsTypeArg": "UiPreferenceRecord",
+      "exportName": "UiPreferenceRecordCollection",
+      "collectionExportName": "UiPreferenceRecordCollectionCollection",
+      "schema": {
+        "tableName": "_smrt_ui_preferences",
+        "ddl": "CREATE TABLE IF NOT EXISTS \"_smrt_ui_preferences\" (\n  \"id\" UUID PRIMARY KEY NOT NULL,\n  \"slug\" TEXT NOT NULL,\n  \"context\" TEXT NOT NULL DEFAULT '',\n  \"created_at\" TIMESTAMP NOT NULL DEFAULT current_timestamp,\n  \"updated_at\" TIMESTAMP NOT NULL DEFAULT current_timestamp,\n  \"tenant_id\" UUID NOT NULL,\n  \"kind\" TEXT NOT NULL DEFAULT '',\n  \"surface_id\" TEXT NOT NULL DEFAULT '',\n  \"scope_type\" TEXT NOT NULL DEFAULT 'tenant',\n  \"user_id\" UUID,\n  \"scope_key\" TEXT NOT NULL,\n  \"payload_json\" TEXT NOT NULL,\n  \"format_version\" INTEGER,\n  \"updated_by\" UUID\n);",
+        "columns": {
+          "id": {
+            "type": "UUID",
+            "primaryKey": true,
+            "referenceKind": "id",
+            "notNull": true
+          },
+          "slug": {
+            "type": "TEXT",
+            "notNull": true
+          },
+          "context": {
+            "type": "TEXT",
+            "notNull": true,
+            "default": ""
+          },
+          "created_at": {
+            "type": "TIMESTAMP",
+            "notNull": true,
+            "default": "current_timestamp"
+          },
+          "updated_at": {
+            "type": "TIMESTAMP",
+            "notNull": true,
+            "default": "current_timestamp"
+          },
+          "tenant_id": {
+            "type": "UUID",
+            "referenceKind": "tenantId",
+            "notNull": true,
+            "unique": false
+          },
+          "kind": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false,
+            "default": ""
+          },
+          "surface_id": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false,
+            "default": ""
+          },
+          "scope_type": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false,
+            "default": "tenant"
+          },
+          "user_id": {
+            "type": "UUID",
+            "referenceKind": "crossPackageRef",
+            "notNull": false,
+            "unique": false
+          },
+          "scope_key": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false
+          },
+          "payload_json": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false
+          },
+          "format_version": {
+            "type": "INTEGER",
+            "notNull": false,
+            "unique": false
+          },
+          "updated_by": {
+            "type": "UUID",
+            "referenceKind": "crossPackageRef",
+            "notNull": false,
+            "unique": false
+          }
+        },
+        "indexes": [
+          {
+            "name": "_smrt_ui_preferences_tenant_id_kind_idx",
+            "columns": [
+              "tenant_id",
+              "kind",
+              "surface_id",
+              "scope_type",
+              "scope_key"
+            ],
+            "unique": true
+          },
+          {
+            "name": "_smrt_ui_preferences_slug_context_idx",
+            "columns": [
+              "slug",
+              "context"
+            ]
+          },
+          {
+            "name": "_smrt_ui_preferences_tenant_id_created_at_idx",
+            "columns": [
+              "tenant_id",
+              "created_at"
+            ]
+          },
+          {
+            "name": "_smrt_ui_preferences_user_id_idx",
+            "columns": [
+              "user_id"
+            ]
+          },
+          {
+            "name": "_smrt_ui_preferences_updated_by_idx",
+            "columns": [
+              "updated_by"
+            ]
+          }
+        ],
+        "version": "3f9df5fd"
+      },
+      "importPath": "@happyvertical/smrt-preferences"
+    },
+    "@happyvertical/smrt-preferences:UiPreferenceRecord": {
+      "name": "uipreferencerecord",
+      "className": "UiPreferenceRecord",
+      "qualifiedName": "@happyvertical/smrt-preferences:UiPreferenceRecord",
+      "collection": "uipreferencerecords",
+      "description": "One stored user-interface preference (#3727): the canonical payload of a registered preference kind (overview, shell-layout, ...) for one surface at one tier of one tenant.",
+      "filePath": "/home/runner/work/smrt/smrt/packages/preferences/src/models/UiPreferenceRecord.ts",
+      "packageName": "@happyvertical/smrt-preferences",
+      "fields": {
+        "tenantId": {
+          "type": "text",
+          "required": true,
+          "_meta": {
+            "sqlType": "UUID",
+            "__tenancy": {
+              "isTenantIdField": true,
+              "autoFilter": true,
+              "required": true,
+              "autoPopulate": true,
+              "nullable": false,
+              "mode": "required",
+              "field": "tenantId",
+              "allowSuperAdminBypass": false
+            }
+          }
+        },
+        "kind": {
+          "type": "text",
+          "required": true,
+          "default": "",
+          "_meta": {
+            "required": true
+          }
+        },
+        "surfaceId": {
+          "type": "text",
+          "required": true,
+          "default": "",
+          "_meta": {
+            "required": true
+          }
+        },
+        "scopeType": {
+          "type": "text",
+          "required": true,
+          "default": "tenant",
+          "_meta": {
+            "required": true
+          }
+        },
+        "userId": {
+          "type": "crossPackageRef",
+          "required": false,
+          "related": "@happyvertical/smrt-users:User",
+          "_meta": {
+            "nullable": true
+          }
+        },
+        "scopeKey": {
+          "type": "text",
+          "required": true,
+          "_meta": {
+            "required": true
+          }
+        },
+        "payloadJson": {
+          "type": "text",
+          "required": true,
+          "_meta": {
+            "required": true
+          }
+        },
+        "formatVersion": {
+          "type": "integer",
+          "required": false,
+          "_meta": {}
+        },
+        "updatedBy": {
+          "type": "crossPackageRef",
+          "required": false,
+          "related": "@happyvertical/smrt-users:User",
+          "_meta": {
+            "nullable": true
+          }
+        }
+      },
+      "methods": {
+        "loadFromId": {
+          "name": "loadFromId",
+          "async": true,
+          "parameters": [],
+          "returnType": "Promise<void>",
+          "isStatic": false,
+          "isPublic": true
+        },
+        "loadFromSlug": {
+          "name": "loadFromSlug",
+          "async": true,
+          "parameters": [],
+          "returnType": "Promise<void>",
+          "isStatic": false,
+          "isPublic": true
+        },
+        "getPayload": {
+          "name": "getPayload",
+          "async": false,
+          "parameters": [],
+          "returnType": "unknown",
+          "isStatic": false,
+          "isPublic": true
+        },
+        "setPayload": {
+          "name": "setPayload",
+          "async": false,
+          "parameters": [
+            {
+              "name": "value",
+              "type": "unknown",
+              "optional": false
+            }
+          ],
+          "returnType": "void",
+          "isStatic": false,
+          "isPublic": true
+        },
+        "save": {
+          "name": "save",
+          "async": true,
+          "parameters": [
+            {
+              "name": "options",
+              "type": "SaveOptions",
+              "optional": true
+            }
+          ],
+          "returnType": "Promise<this>",
+          "isStatic": false,
+          "isPublic": true
+        },
+        "delete": {
+          "name": "delete",
+          "async": true,
+          "parameters": [
+            {
+              "name": "options",
+              "type": "DeleteOptions",
+              "optional": true
+            }
+          ],
+          "returnType": "Promise<void>",
+          "isStatic": false,
+          "isPublic": true
+        }
+      },
+      "decoratorConfig": {
+        "tableName": "_smrt_ui_preferences",
+        "conflictColumns": [
+          "tenant_id",
+          "kind",
+          "surface_id",
+          "scope_type",
+          "scope_key"
+        ],
+        "api": {
+          "include": []
+        },
+        "cli": false,
+        "mcp": {
+          "include": []
+        },
+        "tenantScoped": {
+          "mode": "required"
+        }
+      },
+      "extends": "SmrtObject",
+      "exportName": "UiPreferenceRecord",
+      "collectionExportName": "UiPreferenceRecordCollection",
+      "validationRules": [
+        {
+          "field": "kind",
+          "rule": "required",
+          "fieldType": "text"
+        },
+        {
+          "field": "surfaceId",
+          "rule": "required",
+          "fieldType": "text"
+        },
+        {
+          "field": "scopeType",
+          "rule": "required",
+          "fieldType": "text"
+        },
+        {
+          "field": "scopeKey",
+          "rule": "required",
+          "fieldType": "text"
+        },
+        {
+          "field": "payloadJson",
+          "rule": "required",
+          "fieldType": "text"
+        }
+      ],
+      "schema": {
+        "tableName": "_smrt_ui_preferences",
+        "ddl": "CREATE TABLE IF NOT EXISTS \"_smrt_ui_preferences\" (\n  \"id\" UUID PRIMARY KEY NOT NULL,\n  \"slug\" TEXT NOT NULL,\n  \"context\" TEXT NOT NULL DEFAULT '',\n  \"created_at\" TIMESTAMP NOT NULL DEFAULT current_timestamp,\n  \"updated_at\" TIMESTAMP NOT NULL DEFAULT current_timestamp,\n  \"tenant_id\" UUID NOT NULL,\n  \"kind\" TEXT NOT NULL DEFAULT '',\n  \"surface_id\" TEXT NOT NULL DEFAULT '',\n  \"scope_type\" TEXT NOT NULL DEFAULT 'tenant',\n  \"user_id\" UUID,\n  \"scope_key\" TEXT NOT NULL,\n  \"payload_json\" TEXT NOT NULL,\n  \"format_version\" INTEGER,\n  \"updated_by\" UUID\n);",
+        "columns": {
+          "id": {
+            "type": "UUID",
+            "primaryKey": true,
+            "referenceKind": "id",
+            "notNull": true
+          },
+          "slug": {
+            "type": "TEXT",
+            "notNull": true
+          },
+          "context": {
+            "type": "TEXT",
+            "notNull": true,
+            "default": ""
+          },
+          "created_at": {
+            "type": "TIMESTAMP",
+            "notNull": true,
+            "default": "current_timestamp"
+          },
+          "updated_at": {
+            "type": "TIMESTAMP",
+            "notNull": true,
+            "default": "current_timestamp"
+          },
+          "tenant_id": {
+            "type": "UUID",
+            "referenceKind": "tenantId",
+            "notNull": true,
+            "unique": false
+          },
+          "kind": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false,
+            "default": ""
+          },
+          "surface_id": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false,
+            "default": ""
+          },
+          "scope_type": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false,
+            "default": "tenant"
+          },
+          "user_id": {
+            "type": "UUID",
+            "referenceKind": "crossPackageRef",
+            "notNull": false,
+            "unique": false
+          },
+          "scope_key": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false
+          },
+          "payload_json": {
+            "type": "TEXT",
+            "notNull": true,
+            "unique": false
+          },
+          "format_version": {
+            "type": "INTEGER",
+            "notNull": false,
+            "unique": false
+          },
+          "updated_by": {
+            "type": "UUID",
+            "referenceKind": "crossPackageRef",
+            "notNull": false,
+            "unique": false
+          }
+        },
+        "indexes": [
+          {
+            "name": "_smrt_ui_preferences_tenant_id_kind_idx",
+            "columns": [
+              "tenant_id",
+              "kind",
+              "surface_id",
+              "scope_type",
+              "scope_key"
+            ],
+            "unique": true
+          },
+          {
+            "name": "_smrt_ui_preferences_slug_context_idx",
+            "columns": [
+              "slug",
+              "context"
+            ]
+          },
+          {
+            "name": "_smrt_ui_preferences_tenant_id_created_at_idx",
+            "columns": [
+              "tenant_id",
+              "created_at"
+            ]
+          },
+          {
+            "name": "_smrt_ui_preferences_user_id_idx",
+            "columns": [
+              "user_id"
+            ]
+          },
+          {
+            "name": "_smrt_ui_preferences_updated_by_idx",
+            "columns": [
+              "updated_by"
+            ]
+          }
+        ],
+        "version": "3f9df5fd"
+      },
+      "importPath": "@happyvertical/smrt-preferences"
+    }
+  },
+  "moduleType": "smrt",
+  "smrtDependencies": [
+    "@happyvertical/smrt-core",
+    "@happyvertical/smrt-tenancy",
+    "@happyvertical/smrt-users"
+  ],
+  "browser": {
+    "status": "server-only",
+    "issues": [
+      "#3617",
+      "#3624",
+      "#3626"
+    ],
+    "via": [
+      "@happyvertical/smrt-profiles",
+      "@happyvertical/smrt-tenancy",
+      "@happyvertical/smrt-users"
+    ]
+  },
+  "stampsConstructors": true
+}

package/dist/models/UiPreferenceRecord.d.ts

@@ -0,0 +1,100 @@
+import { SmrtObject } from '@happyvertical/smrt-core';
+import { type PreferenceScope } from '../kinds.js';
+type ConstructorOptions = ConstructorParameters<typeof SmrtObject>[0];
+type SaveOptions = NonNullable<Parameters<SmrtObject['save']>[0]>;
+type DeleteOptions = NonNullable<Parameters<SmrtObject['delete']>[0]>;
+/** `scopeKey` of a tenant-default row (user rows use the user id). */
+export declare const TENANT_SCOPE_KEY = "__tenant__";
+/**
+ * One stored user-interface preference (#3727): the canonical payload of a
+ * registered preference kind (`overview`, `shell-layout`, ...) for one surface
+ * at one tier of one tenant.
+ *
+ * - `scopeType: 'tenant'` is the tenant default (`userId` null), written with
+ *   the kind's tenant permission.
+ * - `scopeType: 'user'` is one person's preference on top of the tenant
+ *   default, inside that tenant. Only that user may write it, with the kind's
+ *   user permission.
+ *
+ * Every row carries its tenant, so the table is `@TenantScoped` (required):
+ * the tenancy interceptor filters reads and refuses foreign rows, and the
+ * save/delete guards below re-check identity, tier ownership and the kind's
+ * permission. The kind's validator (run by the store) owns the payload's
+ * content; this model owns identity, scope shape and authorization, and
+ * refuses any kind that is not registered.
+ *
+ * No generated surface: a payload is only meaningful after its kind's
+ * validation, which a generated route would skip.
+ */
+export declare class UiPreferenceRecord extends SmrtObject {
+    /** Owning tenant (native UUID on PostgreSQL/DuckDB). */
+    tenantId: string;
+    /** The registered preference kind (`overview`, `shell-layout`, ...). */
+    kind: string;
+    /** The surface within the kind (an overview id, a shell key). */
+    surfaceId: string;
+    /** `tenant` (the tenant default) or `user` (one person's preference). */
+    scopeType: PreferenceScope;
+    /** The owning user of a user-scope row; NULL on the tenant default. */
+    userId: string | null;
+    /**
+     * `userId ?? '__tenant__'`, set on save. Keeps the `conflictColumns`
+     * unique index total while `userId` is nullable (NULLs are distinct in a
+     * unique index). Kept in lockstep with
+     * `scopeType` / `userId` on every write, so the owner read predicate
+     * (`read-guard.ts`) can filter on it in one condition.
+     */
+    scopeKey: string;
+    /** The kind's canonical payload as JSON text. */
+    payloadJson: string;
+    /** The kind's format version the payload was written at. */
+    formatVersion: number;
+    /** Who last wrote the row; stamped from the ambient principal. */
+    updatedBy: string | null;
+    constructor(options?: ConstructorOptions);
+    /**
+     * Single-row hydration (`new UiPreferenceRecord({ id }).initialize()`)
+     * reads the table directly, outside the collection interceptors, so the
+     * owner check runs here: another user's row is wiped and refused.
+     */
+    loadFromId(): Promise<void>;
+    loadFromSlug(): Promise<void>;
+    private assertReadable;
+    /** The stored payload, parsed. `undefined` when the text is not JSON. */
+    getPayload(): unknown;
+    /** Store a payload; the caller passes the kind's canonical value. */
+    setPayload(value: unknown): void;
+    /** The optimistic-concurrency token a client echoes back on save. */
+    get revision(): string | null;
+    save(options?: SaveOptions): Promise<this>;
+    /**
+     * Runs for ordinary saves and bulk creates alike, so a collection-level
+     * bulk insert is refused too (`save()` checks first so callers see it).
+     */
+    protected validateBeforeSave(): Promise<void>;
+    delete(options?: DeleteOptions): Promise<void>;
+    /**
+     * Only the store, after the kind's validator accepted exactly this
+     * payload, may write a row (see `write-capability.ts`).
+     */
+    private assertStoreWrite;
+    private syncScopeKey;
+    private validateShape;
+    /**
+     * Fail-closed tier guard. The tenant must be the principal's (the
+     * interceptor checks this too; a super-admin bypass does not filter reads,
+     * so it is re-checked here), a user row must belong to the principal (a
+     * principal with no user id may not touch the user tier), the kind must be
+     * registered, and its permission for the tier must be held.
+     */
+    private authorize;
+    /**
+     * A persisted row keeps its identity: the stored tenant, kind, surface and
+     * tier must be the ones in memory, so {@link authorize} always judges the
+     * row as stored. Matched by predicate rather than by reading the columns
+     * back, because DuckDB returns raw UUID columns as lossy HUGEINTs.
+     */
+    private assertPersistedIdentityUnchanged;
+}
+export {};
+//# sourceMappingURL=UiPreferenceRecord.d.ts.map

package/dist/models/UiPreferenceRecord.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UiPreferenceRecord.d.ts","sourceRoot":"","sources":["../../src/models/UiPreferenceRecord.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,UAAU,EAEX,MAAM,0BAA0B,CAAC;AAOlC,OAAO,EAIL,KAAK,eAAe,EAErB,MAAM,aAAa,CAAC;AAsBrB,KAAK,kBAAkB,GAAG,qBAAqB,CAAC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AACtE,KAAK,WAAW,GAAG,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAClE,KAAK,aAAa,GAAG,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEtE,sEAAsE;AACtE,eAAO,MAAM,gBAAgB,eAAe,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAca,kBAAmB,SAAQ,UAAU;IAChD,wDAAwD;IAExD,QAAQ,EAAE,MAAM,CAAM;IAEtB,wEAAwE;IAExE,IAAI,EAAE,MAAM,CAAM;IAElB,iEAAiE;IAEjE,SAAS,EAAE,MAAM,CAAM;IAEvB,yEAAyE;IAEzE,SAAS,EAAE,eAAe,CAAY;IAEtC,uEAAuE;IAEvE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAQ;IAE7B;;;;;;OAMG;IAEH,QAAQ,EAAE,MAAM,CAAM;IAEtB,iDAAiD;IAEjD,WAAW,EAAE,MAAM,CAAM;IAEzB,4DAA4D;IAE5D,aAAa,EAAE,MAAM,CAAK;IAE1B,kEAAkE;IAElE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAQ;gBAEpB,OAAO,GAAE,kBAAuB;IAK5C;;;;OAIG;IACY,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAK3B,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAK5C,OAAO,CAAC,cAAc;IAQtB,yEAAyE;IACzE,UAAU,IAAI,OAAO;IAQrB,qEAAqE;IACrE,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAIhC,qEAAqE;IACrE,IAAI,QAAQ,IAAI,MAAM,GAAG,IAAI,CAK5B;IAEc,IAAI,CAAC,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB7D;;;OAGG;cACsB,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAK7C,MAAM,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAcjE;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAQxB,OAAO,CAAC,YAAY;IAQpB,OAAO,CAAC,aAAa;IAwBrB;;;;;;OAMG;YACW,SAAS;IA4BvB;;;;;OAKG;YACW,gCAAgC;CAkB/C"}