@objectstack/platform-objects 4.2.0 → 5.1.0

package/dist/integration/index.d.mts

@@ -609,6 +609,12 @@ declare const SysWebhook: Omit<{
     recordTypes?: string[] | undefined;
     sharingModel?: "read" | "full" | "private" | "read_write" | undefined;
     keyPrefix?: string | undefined;
+    detail?: {
+        [x: string]: unknown;
+        renderViaSchema?: boolean | undefined;
+        hideReferenceRail?: boolean | undefined;
+        hideRelatedTab?: boolean | undefined;
+    } | undefined;
     actions?: {
         name: string;
         label: string;

package/dist/integration/index.d.ts

@@ -609,6 +609,12 @@ declare const SysWebhook: Omit<{
     recordTypes?: string[] | undefined;
     sharingModel?: "read" | "full" | "private" | "read_write" | undefined;
     keyPrefix?: string | undefined;
+    detail?: {
+        [x: string]: unknown;
+        renderViaSchema?: boolean | undefined;
+        hideReferenceRail?: boolean | undefined;
+        hideRelatedTab?: boolean | undefined;
+    } | undefined;
     actions?: {
         name: string;
         label: string;

package/dist/metadata/index.d.mts

@@ -598,6 +598,12 @@ declare const SysMetadataObject: Omit<{
     recordTypes?: string[] | undefined;
     sharingModel?: "read" | "full" | "private" | "read_write" | undefined;
     keyPrefix?: string | undefined;
+    detail?: {
+        [x: string]: unknown;
+        renderViaSchema?: boolean | undefined;
+        hideReferenceRail?: boolean | undefined;
+        hideRelatedTab?: boolean | undefined;
+    } | undefined;
     actions?: {
         name: string;
         label: string;
@@ -3506,7 +3512,7 @@ declare const SysMetadataObject: Omit<{
             readonly index?: boolean | undefined;
             readonly type: "number";
         };
-        /** Content checksum for change detection */
+        /** Content checksum for change detection (e.g. `sha256:<64 hex>` = 71 chars) */
         readonly checksum: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
@@ -4763,18 +4769,42 @@ declare const SysMetadataObject: Omit<{
 }, "fields">;
 
 /**
- * sys_metadata_history — Metadata Version History Object
+ * sys_metadata_history — Metadata Version History / Event Log
  *
- * Stores historical snapshots of metadata changes for version tracking,
- * audit trail, and rollback capabilities.
+ * Append-only durable log of every overlay change made through
+ * `SysMetadataRepository.put` / `delete` (ADR-0008 §10 M1). Each row is a
+ * single event in the per-organisation event log; rows are NEVER
+ * mutated after insertion. The legacy `DatabaseLoader` writes the same
+ * shape from its own put/restore code paths.
  *
- * This is a system object (isSystem: true) — protected from deletion and
- * automatically provisioned when metadata history is enabled.
+ * ─────────────────────────────────────────────────────────────────────
+ *  Key design points (ADR-0008 §0 amendment + M1):
+ *
+ *  • Keyed by `(organization_id, type, name)` only — `project_id` was
+ *    removed in the branch/project-removal amendment. The original
+ *    `metadata_id` column (a downgraded plain-text version of the old
+ *    `sys_metadata.id` FK) was removed in the M1 follow-up — joins go
+ *    through `(organization_id, type, name, version)` exclusively.
+ *
+ *  • `event_seq` is the per-org monotonic event-log cursor. Producers
+ *    compute `MAX(event_seq) + 1 WHERE organization_id = X` inside the
+ *    same transaction as the parent `sys_metadata` write.
+ *
+ *  • `version` is the per-(org,type,name) lineage counter. Producers
+ *    compute `MAX(version) + 1 WHERE organization_id = X AND type = T
+ *    AND name = N` so delete + recreate continues incrementing instead
+ *    of restarting at 1.
  *
- * Each record represents a single version snapshot of a metadata item,
- * created whenever the metadata is modified, published, or reverted.
+ *  • `metadata` / `checksum` are nullable — DELETE rows have no body or
+ *    hash. Readers must tolerate null on both columns.
  *
- * @see MetadataHistoryRecordSchema in metadata-persistence.zod.ts
+ *  • `source` records the producer ('sys-metadata-repo', 'fs',
+ *    'studio', …) and feeds MetadataEvent.source on history() reads.
+ *
+ *  Indexes are purpose-built for the two dominant read patterns:
+ *    1. per-item history view  → `(organization_id, type, name, version)`
+ *    2. org-wide event replay   → `(organization_id, event_seq)`
+ * ─────────────────────────────────────────────────────────────────────
  */
 declare const SysMetadataHistoryObject: Omit<{
     name: string;
@@ -5360,6 +5390,12 @@ declare const SysMetadataHistoryObject: Omit<{
     recordTypes?: string[] | undefined;
     sharingModel?: "read" | "full" | "private" | "read_write" | undefined;
     keyPrefix?: string | undefined;
+    detail?: {
+        [x: string]: unknown;
+        renderViaSchema?: boolean | undefined;
+        hideReferenceRail?: boolean | undefined;
+        hideRelatedTab?: boolean | undefined;
+    } | undefined;
     actions?: {
         name: string;
         label: string;
@@ -5442,7 +5478,7 @@ declare const SysMetadataHistoryObject: Omit<{
     readonly icon: "history";
     readonly isSystem: true;
     readonly managedBy: "system";
-    readonly description: "Version history and audit trail for metadata changes";
+    readonly description: "Durable event log of metadata overlay changes (per-org, append-only)";
     readonly fields: {
         /** Primary Key (UUID) */
         readonly id: {
@@ -5620,8 +5656,8 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly index?: boolean | undefined;
             readonly type: "text";
         };
-        /** Foreign key to sys_metadata.id */
-        readonly metadata_id: {
+        /** Per-org monotonic event sequence (durable cursor for replay). */
+        readonly event_seq: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
             readonly options?: {
@@ -5667,7 +5703,7 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly maxLength?: number | undefined;
             readonly minLength?: number | undefined;
             readonly scale?: number | undefined;
-            reference: string;
+            readonly reference?: string | undefined;
             readonly referenceFilters?: string[] | undefined;
             readonly writeRequiresMasterRead?: boolean | undefined;
             readonly deleteBehavior?: "set_null" | "cascade" | "restrict" | undefined;
@@ -5794,7 +5830,7 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly caseSensitive?: boolean | undefined;
             readonly autonumberFormat?: string | undefined;
             readonly index?: boolean | undefined;
-            readonly type: "lookup";
+            readonly type: "number";
         };
         /** Machine name (denormalized for easier querying) */
         readonly name: {
@@ -6148,7 +6184,7 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly index?: boolean | undefined;
             readonly type: "text";
         };
-        /** Version number at this snapshot */
+        /** Per-(org,type,name) lineage counter at this snapshot. */
         readonly version: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
@@ -6500,7 +6536,10 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly index?: boolean | undefined;
             readonly type: "select";
         };
-        /** Historical metadata snapshot (JSON payload) */
+        /**
+         * Historical metadata snapshot (JSON payload).
+         * Null for `operation_type = 'delete'` — the row carries no body.
+         */
         readonly metadata: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
@@ -6676,7 +6715,7 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly index?: boolean | undefined;
             readonly type: "textarea";
         };
-        /** SHA-256 checksum of metadata content */
+        /** SHA-256 checksum of metadata content (null for deletes). */
         readonly checksum: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
@@ -6852,7 +6891,7 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly index?: boolean | undefined;
             readonly type: "text";
         };
-        /** Checksum of the previous version */
+        /** Checksum of the previous version (null for the first event). */
         readonly previous_checksum: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
@@ -7028,7 +7067,7 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly index?: boolean | undefined;
             readonly type: "text";
         };
-        /** Human-readable description of changes */
+        /** Human-readable description of changes (= MetadataEvent.message). */
         readonly change_note: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
@@ -7204,8 +7243,12 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly index?: boolean | undefined;
             readonly type: "textarea";
         };
-        /** Organization ID for multi-tenant isolation */
-        readonly organization_id: {
+        /**
+         * Producer of the event ('sys-metadata-repo', 'fs', 'studio',
+         * 'api', …). Defaults to 'sys-metadata-repo' on the canonical
+         * write path; preserved on history() reads as MetadataEvent.source.
+         */
+        readonly source: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
             readonly options?: {
@@ -7251,7 +7294,7 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly maxLength?: number | undefined;
             readonly minLength?: number | undefined;
             readonly scale?: number | undefined;
-            reference: string;
+            readonly reference?: string | undefined;
             readonly referenceFilters?: string[] | undefined;
             readonly writeRequiresMasterRead?: boolean | undefined;
             readonly deleteBehavior?: "set_null" | "cascade" | "restrict" | undefined;
@@ -7378,10 +7421,10 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly caseSensitive?: boolean | undefined;
             readonly autonumberFormat?: string | undefined;
             readonly index?: boolean | undefined;
-            readonly type: "lookup";
+            readonly type: "text";
         };
-        /** Environment ID — null = platform-global, set = env-scoped */
-        readonly project_id: {
+        /** Organization ID for multi-tenant isolation */
+        readonly organization_id: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
             readonly options?: {
@@ -7427,7 +7470,7 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly maxLength?: number | undefined;
             readonly minLength?: number | undefined;
             readonly scale?: number | undefined;
-            readonly reference?: string | undefined;
+            reference: string;
             readonly referenceFilters?: string[] | undefined;
             readonly writeRequiresMasterRead?: boolean | undefined;
             readonly deleteBehavior?: "set_null" | "cascade" | "restrict" | undefined;
@@ -7554,9 +7597,9 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly caseSensitive?: boolean | undefined;
             readonly autonumberFormat?: string | undefined;
             readonly index?: boolean | undefined;
-            readonly type: "text";
+            readonly type: "lookup";
         };
-        /** User who made this change */
+        /** User who made this change (= MetadataEvent.actor). */
         readonly recorded_by: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
@@ -7910,20 +7953,21 @@ declare const SysMetadataHistoryObject: Omit<{
         };
     };
     readonly indexes: [{
-        readonly fields: ["metadata_id", "version"];
+        readonly fields: ["organization_id", "event_seq"];
+        readonly unique: true;
+    }, {
+        readonly fields: ["organization_id", "type", "name", "version"];
         readonly unique: true;
     }, {
-        readonly fields: ["metadata_id", "recorded_at"];
+        readonly fields: ["organization_id", "type", "name", "recorded_at"];
+    }, {
+        readonly fields: ["organization_id", "type", "name", "checksum"];
     }, {
         readonly fields: ["type", "name"];
     }, {
         readonly fields: ["recorded_at"];
     }, {
         readonly fields: ["operation_type"];
-    }, {
-        readonly fields: ["organization_id"];
-    }, {
-        readonly fields: ["project_id"];
     }];
     readonly enable: {
         readonly trackHistory: false;

package/dist/metadata/index.d.ts

@@ -598,6 +598,12 @@ declare const SysMetadataObject: Omit<{
     recordTypes?: string[] | undefined;
     sharingModel?: "read" | "full" | "private" | "read_write" | undefined;
     keyPrefix?: string | undefined;
+    detail?: {
+        [x: string]: unknown;
+        renderViaSchema?: boolean | undefined;
+        hideReferenceRail?: boolean | undefined;
+        hideRelatedTab?: boolean | undefined;
+    } | undefined;
     actions?: {
         name: string;
         label: string;
@@ -3506,7 +3512,7 @@ declare const SysMetadataObject: Omit<{
             readonly index?: boolean | undefined;
             readonly type: "number";
         };
-        /** Content checksum for change detection */
+        /** Content checksum for change detection (e.g. `sha256:<64 hex>` = 71 chars) */
         readonly checksum: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
@@ -4763,18 +4769,42 @@ declare const SysMetadataObject: Omit<{
 }, "fields">;
 
 /**
- * sys_metadata_history — Metadata Version History Object
+ * sys_metadata_history — Metadata Version History / Event Log
  *
- * Stores historical snapshots of metadata changes for version tracking,
- * audit trail, and rollback capabilities.
+ * Append-only durable log of every overlay change made through
+ * `SysMetadataRepository.put` / `delete` (ADR-0008 §10 M1). Each row is a
+ * single event in the per-organisation event log; rows are NEVER
+ * mutated after insertion. The legacy `DatabaseLoader` writes the same
+ * shape from its own put/restore code paths.
  *
- * This is a system object (isSystem: true) — protected from deletion and
- * automatically provisioned when metadata history is enabled.
+ * ─────────────────────────────────────────────────────────────────────
+ *  Key design points (ADR-0008 §0 amendment + M1):
+ *
+ *  • Keyed by `(organization_id, type, name)` only — `project_id` was
+ *    removed in the branch/project-removal amendment. The original
+ *    `metadata_id` column (a downgraded plain-text version of the old
+ *    `sys_metadata.id` FK) was removed in the M1 follow-up — joins go
+ *    through `(organization_id, type, name, version)` exclusively.
+ *
+ *  • `event_seq` is the per-org monotonic event-log cursor. Producers
+ *    compute `MAX(event_seq) + 1 WHERE organization_id = X` inside the
+ *    same transaction as the parent `sys_metadata` write.
+ *
+ *  • `version` is the per-(org,type,name) lineage counter. Producers
+ *    compute `MAX(version) + 1 WHERE organization_id = X AND type = T
+ *    AND name = N` so delete + recreate continues incrementing instead
+ *    of restarting at 1.
  *
- * Each record represents a single version snapshot of a metadata item,
- * created whenever the metadata is modified, published, or reverted.
+ *  • `metadata` / `checksum` are nullable — DELETE rows have no body or
+ *    hash. Readers must tolerate null on both columns.
  *
- * @see MetadataHistoryRecordSchema in metadata-persistence.zod.ts
+ *  • `source` records the producer ('sys-metadata-repo', 'fs',
+ *    'studio', …) and feeds MetadataEvent.source on history() reads.
+ *
+ *  Indexes are purpose-built for the two dominant read patterns:
+ *    1. per-item history view  → `(organization_id, type, name, version)`
+ *    2. org-wide event replay   → `(organization_id, event_seq)`
+ * ─────────────────────────────────────────────────────────────────────
  */
 declare const SysMetadataHistoryObject: Omit<{
     name: string;
@@ -5360,6 +5390,12 @@ declare const SysMetadataHistoryObject: Omit<{
     recordTypes?: string[] | undefined;
     sharingModel?: "read" | "full" | "private" | "read_write" | undefined;
     keyPrefix?: string | undefined;
+    detail?: {
+        [x: string]: unknown;
+        renderViaSchema?: boolean | undefined;
+        hideReferenceRail?: boolean | undefined;
+        hideRelatedTab?: boolean | undefined;
+    } | undefined;
     actions?: {
         name: string;
         label: string;
@@ -5442,7 +5478,7 @@ declare const SysMetadataHistoryObject: Omit<{
     readonly icon: "history";
     readonly isSystem: true;
     readonly managedBy: "system";
-    readonly description: "Version history and audit trail for metadata changes";
+    readonly description: "Durable event log of metadata overlay changes (per-org, append-only)";
     readonly fields: {
         /** Primary Key (UUID) */
         readonly id: {
@@ -5620,8 +5656,8 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly index?: boolean | undefined;
             readonly type: "text";
         };
-        /** Foreign key to sys_metadata.id */
-        readonly metadata_id: {
+        /** Per-org monotonic event sequence (durable cursor for replay). */
+        readonly event_seq: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
             readonly options?: {
@@ -5667,7 +5703,7 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly maxLength?: number | undefined;
             readonly minLength?: number | undefined;
             readonly scale?: number | undefined;
-            reference: string;
+            readonly reference?: string | undefined;
             readonly referenceFilters?: string[] | undefined;
             readonly writeRequiresMasterRead?: boolean | undefined;
             readonly deleteBehavior?: "set_null" | "cascade" | "restrict" | undefined;
@@ -5794,7 +5830,7 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly caseSensitive?: boolean | undefined;
             readonly autonumberFormat?: string | undefined;
             readonly index?: boolean | undefined;
-            readonly type: "lookup";
+            readonly type: "number";
         };
         /** Machine name (denormalized for easier querying) */
         readonly name: {
@@ -6148,7 +6184,7 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly index?: boolean | undefined;
             readonly type: "text";
         };
-        /** Version number at this snapshot */
+        /** Per-(org,type,name) lineage counter at this snapshot. */
         readonly version: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
@@ -6500,7 +6536,10 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly index?: boolean | undefined;
             readonly type: "select";
         };
-        /** Historical metadata snapshot (JSON payload) */
+        /**
+         * Historical metadata snapshot (JSON payload).
+         * Null for `operation_type = 'delete'` — the row carries no body.
+         */
         readonly metadata: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
@@ -6676,7 +6715,7 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly index?: boolean | undefined;
             readonly type: "textarea";
         };
-        /** SHA-256 checksum of metadata content */
+        /** SHA-256 checksum of metadata content (null for deletes). */
         readonly checksum: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
@@ -6852,7 +6891,7 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly index?: boolean | undefined;
             readonly type: "text";
         };
-        /** Checksum of the previous version */
+        /** Checksum of the previous version (null for the first event). */
         readonly previous_checksum: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
@@ -7028,7 +7067,7 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly index?: boolean | undefined;
             readonly type: "text";
         };
-        /** Human-readable description of changes */
+        /** Human-readable description of changes (= MetadataEvent.message). */
         readonly change_note: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
@@ -7204,8 +7243,12 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly index?: boolean | undefined;
             readonly type: "textarea";
         };
-        /** Organization ID for multi-tenant isolation */
-        readonly organization_id: {
+        /**
+         * Producer of the event ('sys-metadata-repo', 'fs', 'studio',
+         * 'api', …). Defaults to 'sys-metadata-repo' on the canonical
+         * write path; preserved on history() reads as MetadataEvent.source.
+         */
+        readonly source: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
             readonly options?: {
@@ -7251,7 +7294,7 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly maxLength?: number | undefined;
             readonly minLength?: number | undefined;
             readonly scale?: number | undefined;
-            reference: string;
+            readonly reference?: string | undefined;
             readonly referenceFilters?: string[] | undefined;
             readonly writeRequiresMasterRead?: boolean | undefined;
             readonly deleteBehavior?: "set_null" | "cascade" | "restrict" | undefined;
@@ -7378,10 +7421,10 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly caseSensitive?: boolean | undefined;
             readonly autonumberFormat?: string | undefined;
             readonly index?: boolean | undefined;
-            readonly type: "lookup";
+            readonly type: "text";
         };
-        /** Environment ID — null = platform-global, set = env-scoped */
-        readonly project_id: {
+        /** Organization ID for multi-tenant isolation */
+        readonly organization_id: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
             readonly options?: {
@@ -7427,7 +7470,7 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly maxLength?: number | undefined;
             readonly minLength?: number | undefined;
             readonly scale?: number | undefined;
-            readonly reference?: string | undefined;
+            reference: string;
             readonly referenceFilters?: string[] | undefined;
             readonly writeRequiresMasterRead?: boolean | undefined;
             readonly deleteBehavior?: "set_null" | "cascade" | "restrict" | undefined;
@@ -7554,9 +7597,9 @@ declare const SysMetadataHistoryObject: Omit<{
             readonly caseSensitive?: boolean | undefined;
             readonly autonumberFormat?: string | undefined;
             readonly index?: boolean | undefined;
-            readonly type: "text";
+            readonly type: "lookup";
         };
-        /** User who made this change */
+        /** User who made this change (= MetadataEvent.actor). */
         readonly recorded_by: {
             readonly readonly?: boolean | undefined;
             readonly format?: string | undefined;
@@ -7910,20 +7953,21 @@ declare const SysMetadataHistoryObject: Omit<{
         };
     };
     readonly indexes: [{
-        readonly fields: ["metadata_id", "version"];
+        readonly fields: ["organization_id", "event_seq"];
+        readonly unique: true;
+    }, {
+        readonly fields: ["organization_id", "type", "name", "version"];
         readonly unique: true;
     }, {
-        readonly fields: ["metadata_id", "recorded_at"];
+        readonly fields: ["organization_id", "type", "name", "recorded_at"];
+    }, {
+        readonly fields: ["organization_id", "type", "name", "checksum"];
     }, {
         readonly fields: ["type", "name"];
     }, {
         readonly fields: ["recorded_at"];
     }, {
         readonly fields: ["operation_type"];
-    }, {
-        readonly fields: ["organization_id"];
-    }, {
-        readonly fields: ["project_id"];
     }];
     readonly enable: {
         readonly trackHistory: false;