@happyvertical/smrt-fields 0.40.59 → 0.40.61

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../src/types.ts"],"sourcesContent":["import type {\n  SmrtClassOptions,\n  SmrtObjectOptions,\n} from '@happyvertical/smrt-core';\n\n/**\n * Scope tier a {@link FieldPolicy} row belongs to.\n *\n * Resolution precedence is code seed → `app` → `tenant` (hierarchy walk,\n * root → leaf) → `user`. Unlike smrt-features (which ships only\n * `global`/`tenant`), the user tier is implemented end to end here — both\n * defaults and visibility resolve through it.\n */\nexport type FieldPolicyScopeType = 'app' | 'tenant' | 'user';\n\n/**\n * Visibility tier for a field in generated/consuming form UIs.\n *\n * - `basic`: shown before the advanced disclosure\n * - `advanced`: shown behind the advanced disclosure\n * - `hidden`: not rendered (requires the field to be optional or have a\n *   resolved default — the required-field invariant)\n */\nexport type FieldPolicyVisibility = 'basic' | 'advanced' | 'hidden';\n\n/**\n * `scopeKey` value for app-scope rows. `scopeKey` exists ONLY so the\n * `conflictColumns` unique index stays total while `tenantId`/`userId` are\n * nullable (nullable columns would allow duplicate NULL rows) — the same\n * trick as `PromptOverride.context`.\n */\nexport const APP_FIELD_POLICY_SCOPE_KEY = '__app__';\n\nexport const FIELD_POLICY_SCOPE_TYPES: readonly FieldPolicyScopeType[] = [\n  'app',\n  'tenant',\n  'user',\n];\n\nexport const FIELD_POLICY_VISIBILITIES: readonly FieldPolicyVisibility[] = [\n  'basic',\n  'advanced',\n  'hidden',\n];\n\nexport interface FieldPolicyOptions extends SmrtObjectOptions {\n  objectRef?: string;\n  fieldName?: string;\n  scopeType?: FieldPolicyScopeType;\n  tenantId?: string | null;\n  userId?: string | null;\n  /**\n   * ENCODED channel: an already-JSON-encoded default, exactly as the column\n   * stores it (`'\"Net 30\"'`, `'42'`, `'null'`), or `null` to inherit.\n   *\n   * This is the wire contract: the generated write routes hand the request\n   * body straight to the constructor, and the #2049/#2050 gear posts\n   * `JSON.stringify(draft.defaultValue)`. It must therefore keep meaning\n   * \"already encoded\" — auto-serializing here would double-encode every gear\n   * write.\n   *\n   * Use {@link FieldPolicyOptions.defaultValueRaw} for a plain value. The two\n   * are mutually exclusive: `'\"TBD\"'` and `'TBD'` are indistinguishable once\n   * a single option carries both meanings, so the channel must be explicit\n   * rather than sniffed.\n   */\n  defaultValue?: string | null;\n  /**\n   * PLAIN channel: any value, always serialized — strings included. The\n   * constructor-option twin of {@link FieldPolicy.setDefaultValue}, so\n   * `{ defaultValueRaw: 'Net 30' }` stores `'\"Net 30\"'` rather than the\n   * unparseable literal `Net 30`.\n   */\n  defaultValueRaw?: unknown;\n  visibility?: FieldPolicyVisibility | null;\n  help?: string | null;\n  label?: string | null;\n  displayOrder?: number | null;\n  locked?: boolean | null;\n  updatedBy?: string | null;\n}\n\n/**\n * The sparse contribution of one layer (code seed or one stored row).\n *\n * `default` is boxed so an explicit JSON `null` default (meaning \"default to\n * null\") stays distinguishable from \"this layer contributes no default\".\n */\nexport interface FieldPolicyDelta {\n  default?: { value: unknown };\n  visibility?: FieldPolicyVisibility;\n  help?: string;\n  label?: string;\n  order?: number;\n  locked?: boolean;\n}\n\n/** One layer's contribution to a field's resolved policy (explain variant). */\nexport interface FieldPolicyLayerContribution {\n  layer: 'code' | 'app' | 'tenant' | 'user';\n  /** Chain node id for `tenant` layers (root → leaf order). */\n  tenantId?: string;\n  /** User id for the `user` layer. */\n  userId?: string;\n  delta: FieldPolicyDelta;\n}\n\n/** Fully merged policy for a single field. */\nexport interface ResolvedFieldPolicy {\n  fieldName: string;\n  /** True when any layer resolved a default (including an explicit null). */\n  hasDefault: boolean;\n  /** Parsed default value; `undefined` when {@link hasDefault} is false. */\n  defaultValue: unknown;\n  visibility: FieldPolicyVisibility;\n  help: string | null;\n  label: string | null;\n  order: number | null;\n  /** Grouping key — code-seed only (`ui.group`), not overridable by rows. */\n  group: string | null;\n  locked: boolean;\n  /** Mirror of the manifest required flag (nullable fields are optional). */\n  required: boolean;\n  /**\n   * True when the resolver forced `basic` visibility because the field is\n   * required and no usable default resolved (the resolver-side safety net for\n   * the required-field invariant).\n   */\n  visibilityForced?: boolean;\n}\n\n/** Merged policy for every field of one object. */\nexport interface ResolvedObjectFieldPolicy {\n  objectRef: string;\n  fields: Record<string, ResolvedFieldPolicy>;\n}\n\n/**\n * Explain variant: merged result plus the ordered per-layer contributions for\n * each field, so admin/gear UIs (#2049/#2050) never re-derive precedence.\n * Layers are listed in application order (code, app, tenant chain root → leaf,\n * user) and contain ONLY contributions that survive into the merged result:\n * tenant ancestors discarded by a permission-inheritance break and user rows\n * suppressed by an effective org lock are omitted, so sequentially replaying\n * the listed deltas reproduces the merged policy.\n */\nexport interface ExplainedObjectFieldPolicy extends ResolvedObjectFieldPolicy {\n  layers: Record<string, FieldPolicyLayerContribution[]>;\n}\n\n/** Minimal tenant node consumed by the hierarchy walk (mirrors smrt-features). */\nexport interface FieldPolicyTenantNode {\n  id: string;\n  inheritPermissions: boolean;\n  cascadePermissions: boolean;\n}\n\n/** Provider returning the root → leaf tenant chain (mirrors smrt-features). */\nexport interface FieldPolicyTenantHierarchyProvider {\n  getChain(tenantId: string): Promise<FieldPolicyTenantNode[]>;\n}\n\n/**\n * Loader-function DI seam (NOT a container registration): the resolver calls\n * it lazily and treats `null` as \"no hierarchy available\" (flat-tenant\n * fallback). The default loader dynamic-imports `@happyvertical/smrt-users`\n * and returns `null` when it is not installed.\n */\nexport type FieldPolicyTenantHierarchyLoader = (\n  options: SmrtClassOptions,\n) => Promise<FieldPolicyTenantHierarchyProvider | null>;\n\nexport interface ResolveFieldPolicyOptions {\n  tenantId?: string | null;\n  userId?: string | null;\n  /**\n   * Database holding `_smrt_field_policies`. Without it, only the code seed\n   * resolves (stored layers are skipped) — the smrt-prompts precedent.\n   */\n  db?: SmrtClassOptions['db'];\n  tenantHierarchyLoader?: FieldPolicyTenantHierarchyLoader;\n}\n\n/**\n * Minimal structural shape of the tenant surface loaded from\n * `@happyvertical/smrt-users` by the default hierarchy loader. Only the\n * permission-cascade fields consumed by the chain walk are modeled.\n */\nexport interface FieldPolicyUsersTenantRecord {\n  id: string;\n  inheritPermissions?: boolean;\n  cascadePermissions?: boolean;\n}\n\nexport interface FieldPolicyUsersModule {\n  TenantCollection: {\n    create(options: SmrtClassOptions): Promise<{\n      get(criteria: {\n        id: string;\n      }): Promise<FieldPolicyUsersTenantRecord | null>;\n      getAncestorsFromRoot(\n        tenantId: string,\n      ): Promise<FieldPolicyUsersTenantRecord[]>;\n    }>;\n  };\n}\n\n/** Result shape of the batch resolve action (`FieldPolicyCollection.resolveBatch`). */\nexport interface FieldPolicyBatchResult {\n  policies: Record<string, ResolvedObjectFieldPolicy>;\n}\n\nexport type { SmrtClassOptions };\n"],"mappings":";AA+BO,IAAM,6BAA6B;AAEnC,IAAM,2BAA4D;CACvE;CACA;CACA;AACF;AAEO,IAAM,4BAA8D;CACzE;CACA;CACA;AACF"}
+{"version":3,"file":"types.js","names":[],"sources":["../src/types.ts"],"sourcesContent":["import type {\n  SmrtClassOptions,\n  SmrtObjectOptions,\n} from '@happyvertical/smrt-core';\n\n/**\n * Scope tier a {@link FieldPolicy} row belongs to.\n *\n * Resolution precedence is code seed → `app` → `tenant` (hierarchy walk,\n * root → leaf) → `user`. Unlike smrt-features (which ships only\n * `global`/`tenant`), the user tier is implemented end to end here — both\n * defaults and visibility resolve through it.\n */\nexport type FieldPolicyScopeType = 'app' | 'tenant' | 'user';\n\n/**\n * Visibility tier for a field in generated/consuming form UIs.\n *\n * - `basic`: shown before the advanced disclosure\n * - `advanced`: shown behind the advanced disclosure\n * - `hidden`: not rendered (requires the field to be optional or have a\n *   resolved default — the required-field invariant)\n */\nexport type FieldPolicyVisibility = 'basic' | 'advanced' | 'hidden';\n\n/**\n * `scopeKey` value for app-scope rows. `scopeKey` exists ONLY so the\n * `conflictColumns` unique index stays total while `tenantId`/`userId` are\n * nullable (nullable columns would allow duplicate NULL rows) — the same\n * trick as `PromptOverride.context`.\n */\nexport const APP_FIELD_POLICY_SCOPE_KEY = '__app__';\n\nexport const FIELD_POLICY_SCOPE_TYPES: readonly FieldPolicyScopeType[] = [\n  'app',\n  'tenant',\n  'user',\n];\n\nexport const FIELD_POLICY_VISIBILITIES: readonly FieldPolicyVisibility[] = [\n  'basic',\n  'advanced',\n  'hidden',\n];\n\nexport interface FieldPolicyOptions extends SmrtObjectOptions {\n  objectRef?: string;\n  fieldName?: string;\n  scopeType?: FieldPolicyScopeType;\n  tenantId?: string | null;\n  userId?: string | null;\n  /**\n   * ENCODED channel: an already-JSON-encoded default, exactly as the column\n   * stores it (`'\"Net 30\"'`, `'42'`, `'null'`), or `null` to inherit.\n   *\n   * This is the wire contract: the generated write routes hand the request\n   * body straight to the constructor, and the #2049/#2050 gear posts\n   * `JSON.stringify(draft.defaultValue)`. It must therefore keep meaning\n   * \"already encoded\" — auto-serializing here would double-encode every gear\n   * write.\n   *\n   * Use {@link FieldPolicyOptions.defaultValueRaw} for a plain value. The two\n   * are mutually exclusive: `'\"TBD\"'` and `'TBD'` are indistinguishable once\n   * a single option carries both meanings, so the channel must be explicit\n   * rather than sniffed.\n   */\n  defaultValue?: string | null;\n  /**\n   * PLAIN channel: any value, always serialized — strings included. The\n   * constructor-option twin of {@link FieldPolicy.setDefaultValue}, so\n   * `{ defaultValueRaw: 'Net 30' }` stores `'\"Net 30\"'` rather than the\n   * unparseable literal `Net 30`.\n   */\n  defaultValueRaw?: unknown;\n  visibility?: FieldPolicyVisibility | null;\n  help?: string | null;\n  label?: string | null;\n  displayOrder?: number | null;\n  locked?: boolean | null;\n  updatedBy?: string | null;\n}\n\n/**\n * The sparse contribution of one layer (code seed or one stored row).\n *\n * `default` is boxed so an explicit JSON `null` default (meaning \"default to\n * null\") stays distinguishable from \"this layer contributes no default\".\n */\nexport interface FieldPolicyDelta {\n  default?: { value: unknown };\n  visibility?: FieldPolicyVisibility;\n  help?: string;\n  label?: string;\n  order?: number;\n  locked?: boolean;\n}\n\n/** One layer's contribution to a field's resolved policy (explain variant). */\nexport interface FieldPolicyLayerContribution {\n  layer: 'code' | 'app' | 'tenant' | 'user';\n  /** Chain node id for `tenant` layers (root → leaf order). */\n  tenantId?: string;\n  /** User id for the `user` layer. */\n  userId?: string;\n  delta: FieldPolicyDelta;\n}\n\n/** Fully merged policy for a single field. */\nexport interface ResolvedFieldPolicy {\n  fieldName: string;\n  /** True when any layer resolved a default (including an explicit null). */\n  hasDefault: boolean;\n  /** Parsed default value; `undefined` when {@link hasDefault} is false. */\n  defaultValue: unknown;\n  visibility: FieldPolicyVisibility;\n  help: string | null;\n  label: string | null;\n  order: number | null;\n  /** Grouping key — code-seed only (`ui.group`), not overridable by rows. */\n  group: string | null;\n  locked: boolean;\n  /** Mirror of the manifest required flag (nullable fields are optional). */\n  required: boolean;\n  /**\n   * True when the resolver forced `basic` visibility because the field is\n   * required and no usable default resolved (the resolver-side safety net for\n   * the required-field invariant).\n   */\n  visibilityForced?: boolean;\n}\n\n/** Merged policy for every field of one object. */\nexport interface ResolvedObjectFieldPolicy {\n  objectRef: string;\n  fields: Record<string, ResolvedFieldPolicy>;\n}\n\n/**\n * Explain variant: merged result plus the ordered per-layer contributions for\n * each field, so admin/gear UIs (#2049/#2050) never re-derive precedence.\n * Layers are listed in application order (code, app, tenant chain root → leaf,\n * user) and contain ONLY contributions that survive into the merged result:\n * tenant ancestors discarded by a permission-inheritance break and user rows\n * suppressed by an effective org lock are omitted, so sequentially replaying\n * the listed deltas reproduces the merged policy.\n */\nexport interface ExplainedObjectFieldPolicy extends ResolvedObjectFieldPolicy {\n  layers: Record<string, FieldPolicyLayerContribution[]>;\n}\n\n/** Minimal tenant node consumed by the hierarchy walk (mirrors smrt-features). */\nexport interface FieldPolicyTenantNode {\n  id: string;\n  inheritPermissions: boolean;\n  cascadePermissions: boolean;\n}\n\n/** Provider returning the root → leaf tenant chain (mirrors smrt-features). */\nexport interface FieldPolicyTenantHierarchyProvider {\n  getChain(tenantId: string): Promise<FieldPolicyTenantNode[]>;\n}\n\n/**\n * Loader-function DI seam (NOT a container registration): the resolver calls\n * it lazily and treats `null` as \"no hierarchy available\" (flat-tenant\n * fallback). The default loader dynamic-imports `@happyvertical/smrt-users`\n * and returns `null` when it is not installed.\n */\nexport type FieldPolicyTenantHierarchyLoader = (\n  options: SmrtClassOptions,\n) => Promise<FieldPolicyTenantHierarchyProvider | null>;\n\nexport interface ResolveFieldPolicyOptions {\n  tenantId?: string | null;\n  userId?: string | null;\n  /**\n   * Database holding `_smrt_field_policies`. Without it, only the code seed\n   * resolves (stored layers are skipped) — the smrt-prompts precedent.\n   */\n  db?: SmrtClassOptions['db'];\n  tenantHierarchyLoader?: FieldPolicyTenantHierarchyLoader;\n  /**\n   * Internal write-validation seam: omit persisted rows while evaluating a\n   * proposed replacement. Excluded resolutions bypass the shared cache so a\n   * projected result can never poison ordinary reads.\n   */\n  excludePolicyIds?: ReadonlySet<string>;\n}\n\n/**\n * Minimal structural shape of the tenant surface loaded from\n * `@happyvertical/smrt-users` by the default hierarchy loader. Only the\n * permission-cascade fields consumed by the chain walk are modeled.\n */\nexport interface FieldPolicyUsersTenantRecord {\n  id: string;\n  inheritPermissions?: boolean;\n  cascadePermissions?: boolean;\n}\n\nexport interface FieldPolicyUsersModule {\n  TenantCollection: {\n    create(options: SmrtClassOptions): Promise<{\n      get(criteria: {\n        id: string;\n      }): Promise<FieldPolicyUsersTenantRecord | null>;\n      getAncestorsFromRoot(\n        tenantId: string,\n      ): Promise<FieldPolicyUsersTenantRecord[]>;\n    }>;\n  };\n}\n\n/** Result shape of the batch resolve action (`FieldPolicyCollection.resolveBatch`). */\nexport interface FieldPolicyBatchResult {\n  policies: Record<string, ResolvedObjectFieldPolicy>;\n}\n\n/** A policy row safe to expose through the context-scoped gear action. */\nexport interface FieldPolicyEditorRow {\n  defaultValue: string | null;\n  displayOrder: number | null;\n  fieldName: string;\n  help: string | null;\n  id: string;\n  label: string | null;\n  locked: boolean | null;\n  scopeType: FieldPolicyScopeType;\n  tenantId: string | null;\n  updatedBy: string | null;\n  userId: string | null;\n  visibility: FieldPolicyVisibility | null;\n}\n\n/** Context-derived authorization state for the field-policy gear. */\nexport interface FieldPolicyEditorCapabilities {\n  manage: boolean;\n  personalize: boolean;\n}\n\n/**\n * Gear bootstrap response. `policy` is always filtered by the public-field\n * rail; raw rows and explanation layers appear only for scopes the caller is\n * authorized to mutate. Row ids are present for reset/delete operations.\n */\nexport interface FieldPolicyEditorState {\n  capabilities: FieldPolicyEditorCapabilities;\n  /**\n   * For the caller's personal layer only, whether removing that layer's\n   * default still leaves a usable default at code/app/tenant precedence.\n   * This intentionally exposes no lower-layer rows or default values.\n   */\n  personalLowerDefaultUsable: Record<string, boolean>;\n  policy: ExplainedObjectFieldPolicy;\n  rows: {\n    app: FieldPolicyEditorRow[];\n    tenant: FieldPolicyEditorRow[];\n    user: FieldPolicyEditorRow[];\n  };\n}\n\n/** A stored organization row with the immutable audit metadata needed by #2050. */\nexport interface FieldPolicyAuditRow extends FieldPolicyEditorRow {\n  objectRef: string;\n  createdAt: string | null;\n  updatedAt: string | null;\n}\n\n/** Why a persisted policy row is no longer usable by the live registry. */\nexport type FieldPolicyDriftReason =\n  | 'unknown-object'\n  | 'unknown-field'\n  | 'excluded-field';\n\n/** Drift is deliberately identity-only: stale values are never serialized. */\nexport interface FieldPolicyDriftRow {\n  id: string;\n  objectRef: string;\n  fieldName: string;\n  scopeType: FieldPolicyScopeType;\n  tenantId: string | null;\n  userId: string | null;\n  updatedBy: string | null;\n  createdAt: string | null;\n  updatedAt: string | null;\n  reason: FieldPolicyDriftReason;\n  prunable: boolean;\n}\n\n/**\n * Tenant-admin catalog read surface. Foreign user rows are represented only\n * by counts; their values and identifiers never leave the collection.\n */\nexport interface FieldPolicyAuditSnapshot {\n  orgRows: FieldPolicyAuditRow[];\n  appRows: FieldPolicyAuditRow[];\n  inheritedOrgKeys: Record<string, string[]>;\n  userOverrideCounts: Record<string, Record<string, number>>;\n  driftRows: FieldPolicyDriftRow[];\n  policies: Record<string, ExplainedObjectFieldPolicy>;\n  caller: {\n    tenantId: string | null;\n    userId: string | null;\n    canManageOrg: boolean;\n    canPersonalize: boolean;\n  };\n}\n\n/** Explicit 403 result used by generated custom-action transports. */\nexport interface FieldPolicyEditorStateDenied {\n  code: 'permission_denied';\n  message: string;\n  ok: false;\n  status: 403;\n}\n\nexport type FieldPolicyEditorStateResult =\n  | FieldPolicyEditorState\n  | FieldPolicyEditorStateDenied;\n\nexport type { SmrtClassOptions };\n"],"mappings":";AA+BO,IAAM,6BAA6B;AAEnC,IAAM,2BAA4D;CACvE;CACA;CACA;AACF;AAEO,IAAM,4BAA8D;CACzE;CACA;CACA;AACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@happyvertical/smrt-fields",
-  "version": "0.40.59",
+  "version": "0.40.61",
   "description": "Layered field policy store and resolver (defaults, visibility tiers, help text) for SMRT objects",
   "type": "module",
   "main": "./dist/index.js",
@@ -15,22 +15,46 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     },
+    "./svelte": {
+      "types": "./dist/svelte/index.d.ts",
+      "svelte": "./dist/svelte/index.js",
+      "import": "./dist/svelte/index.js"
+    },
     "./manifest": "./dist/manifest.json",
-    "./manifest.json": "./dist/manifest.json"
+    "./manifest.json": "./dist/manifest.json",
+    "./playground": {
+      "types": "./dist/playground.d.ts",
+      "import": "./dist/playground.js"
+    }
+  },
+  "peerDependencies": {
+    "svelte": "^5.56.4"
+  },
+  "peerDependenciesMeta": {
+    "svelte": {
+      "optional": true
+    }
   },
   "dependencies": {
     "@happyvertical/sql": "^0.85.5",
-    "@happyvertical/smrt-core": "0.40.59",
-    "@happyvertical/smrt-tenancy": "0.40.59"
+    "@happyvertical/smrt-core": "0.40.61",
+    "@happyvertical/smrt-tenancy": "0.40.61",
+    "@happyvertical/smrt-ui": "0.40.61",
+    "@happyvertical/smrt-users": "0.40.61"
   },
   "devDependencies": {
+    "@sveltejs/package": "^2.5.8",
+    "@sveltejs/vite-plugin-svelte": "^7.1.2",
+    "@testing-library/svelte": "^5.4.2",
     "@types/node": "24.13.2",
+    "svelte": "^5.56.4",
+    "svelte-check": "^4.7.1",
     "typescript": "5.9.3",
     "vite": "8.1.4",
     "vitest": "4.1.10",
-    "@happyvertical/smrt-cli": "0.40.59",
-    "@happyvertical/smrt-users": "0.40.59",
-    "@happyvertical/smrt-vitest": "0.40.59"
+    "@happyvertical/smrt-cli": "0.40.61",
+    "@happyvertical/smrt-users": "0.40.61",
+    "@happyvertical/smrt-vitest": "0.40.61"
   },
   "keywords": [
     "smrt",
@@ -51,8 +75,9 @@
     "directory": "packages/fields"
   },
   "scripts": {
-    "build": "vite build --mode library",
+    "build": "vite build --mode library && svelte-package -i src/svelte -o dist/svelte --tsconfig tsconfig.svelte.json",
     "build:watch": "vite build --mode library --watch",
+    "check": "svelte-check --tsconfig ./tsconfig.svelte.json",
     "clean": "rm -rf dist",
     "dev": "vite dev",
     "test": "vitest run",