@objectstack/objectql 6.7.1 → 6.8.0

package/dist/index.d.ts

@@ -356,6 +356,132 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
     }>;
     getMetaTypes(): Promise<{
         types: string[];
+        entries: {
+            type: string;
+            schemaId: string;
+            allowOrgOverride: boolean;
+            overrideSource: "env" | "registry";
+            schema: Record<string, unknown>;
+            form: {
+                type: "split" | "modal" | "drawer" | "simple" | "tabbed" | "wizard";
+                data?: {
+                    provider: "object";
+                    object: string;
+                } | {
+                    provider: "api";
+                    read?: {
+                        url: string;
+                        method: "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
+                        headers?: Record<string, string> | undefined;
+                        params?: Record<string, unknown> | undefined;
+                        body?: unknown;
+                    } | undefined;
+                    write?: {
+                        url: string;
+                        method: "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
+                        headers?: Record<string, string> | undefined;
+                        params?: Record<string, unknown> | undefined;
+                        body?: unknown;
+                    } | undefined;
+                } | {
+                    provider: "value";
+                    items: unknown[];
+                } | {
+                    provider: "schema";
+                    schemaId: string;
+                    schema?: Record<string, unknown> | undefined;
+                } | undefined;
+                sections?: {
+                    collapsible: boolean;
+                    collapsed: boolean;
+                    columns: 1 | 2 | 3 | 4;
+                    fields: any[];
+                    label?: string | undefined;
+                    description?: string | undefined;
+                    visibleOn?: {
+                        dialect: "cel" | "js" | "cron" | "template";
+                        source?: string | undefined;
+                        ast?: unknown;
+                        meta?: {
+                            rationale?: string | undefined;
+                            generatedBy?: string | undefined;
+                        } | undefined;
+                    } | {
+                        dialect: "cel" | "js" | "cron" | "template";
+                        source?: string | undefined;
+                        ast?: unknown;
+                        meta?: {
+                            rationale?: string | undefined;
+                            generatedBy?: string | undefined;
+                        } | undefined;
+                    } | undefined;
+                }[] | undefined;
+                groups?: {
+                    collapsible: boolean;
+                    collapsed: boolean;
+                    columns: 1 | 2 | 3 | 4;
+                    fields: any[];
+                    label?: string | undefined;
+                    description?: string | undefined;
+                    visibleOn?: {
+                        dialect: "cel" | "js" | "cron" | "template";
+                        source?: string | undefined;
+                        ast?: unknown;
+                        meta?: {
+                            rationale?: string | undefined;
+                            generatedBy?: string | undefined;
+                        } | undefined;
+                    } | {
+                        dialect: "cel" | "js" | "cron" | "template";
+                        source?: string | undefined;
+                        ast?: unknown;
+                        meta?: {
+                            rationale?: string | undefined;
+                            generatedBy?: string | undefined;
+                        } | undefined;
+                    } | undefined;
+                }[] | undefined;
+                defaultSort?: {
+                    field: string;
+                    order: "asc" | "desc";
+                }[] | undefined;
+                sharing?: {
+                    enabled: boolean;
+                    allowAnonymous: boolean;
+                    publicLink?: string | undefined;
+                    password?: string | undefined;
+                    allowedDomains?: string[] | undefined;
+                    expiresAt?: string | undefined;
+                } | undefined;
+                submitBehavior?: {
+                    kind: "thank-you";
+                    title?: string | undefined;
+                    message?: string | undefined;
+                } | {
+                    kind: "redirect";
+                    url: string;
+                    delayMs?: number | undefined;
+                } | {
+                    kind: "continue";
+                } | {
+                    kind: "next-record";
+                } | undefined;
+                aria?: {
+                    ariaLabel?: string | undefined;
+                    ariaDescribedBy?: string | undefined;
+                    role?: string | undefined;
+                } | undefined;
+            };
+            label: string;
+            filePatterns: string[];
+            supportsOverlay: boolean;
+            allowRuntimeCreate: boolean;
+            supportsVersioning: boolean;
+            executionPinned: boolean;
+            loadOrder: number;
+            domain: "system" | "data" | "ui" | "automation" | "ai" | "security";
+            description?: string | undefined;
+        }[];
     }>;
     getMetaItems(request: {
         type: string;
@@ -375,6 +501,33 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
         name: string;
         item: unknown;
     }>;
+    /**
+     * Phase 3a-layered-get: return the 3 layers of a metadata item
+     * separately — `code` (artifact-loaded baseline), `overlay` (per-org
+     * customisation row, if any), and `effective` (what `getMetaItem`
+     * would return, i.e. overlay-wins merge).
+     *
+     * Drives the "Code default vs Overlay vs Effective" diff tab in the
+     * generic Metadata Resource Edit page. Admins can see exactly what
+     * was customised and reset selectively.
+     *
+     * `code` is null if no artifact baseline exists; `overlay` is null if
+     * no sys_metadata row exists for the requested scope; `effective` is
+     * never null when either layer exists.
+     */
+    getMetaItemLayered(request: {
+        type: string;
+        name: string;
+        packageId?: string;
+        organizationId?: string;
+    }): Promise<{
+        type: string;
+        name: string;
+        code: unknown | null;
+        overlay: unknown | null;
+        overlayScope: 'org' | 'env' | null;
+        effective: unknown | null;
+    }>;
     getUiView(request: {
         object: string;
         type: 'list' | 'form';
@@ -407,7 +560,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
                     label: string | undefined;
                     required: boolean;
                     readonly: boolean;
-                    type: "number" | "boolean" | "tags" | "date" | "file" | "code" | "datetime" | "signature" | "progress" | "url" | "text" | "textarea" | "email" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "time" | "toggle" | "select" | "multiselect" | "radio" | "checkboxes" | "lookup" | "master_detail" | "tree" | "image" | "avatar" | "video" | "audio" | "formula" | "summary" | "autonumber" | "location" | "address" | "json" | "color" | "rating" | "slider" | "qrcode" | "vector";
+                    type: "number" | "boolean" | "tags" | "date" | "file" | "code" | "datetime" | "signature" | "progress" | "url" | "text" | "textarea" | "email" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "time" | "toggle" | "select" | "multiselect" | "radio" | "checkboxes" | "lookup" | "master_detail" | "tree" | "image" | "avatar" | "video" | "audio" | "formula" | "summary" | "autonumber" | "composite" | "repeater" | "location" | "address" | "json" | "color" | "rating" | "slider" | "qrcode" | "vector";
                     colSpan: number;
                 }[];
             }[];
@@ -589,6 +742,21 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
      * checklist.
      */
     private static readonly OVERLAY_ALLOWED_TYPES;
+    /**
+     * Phase 3a-env-writable: parse `OBJECTSTACK_METADATA_WRITABLE` once.
+     * Comma-separated singular type names. When the env var is set, the
+     * listed types get treated as `allowOrgOverride: true` regardless of
+     * their static registry entry. This is the runtime escape hatch admins
+     * use to enable Studio-side editing of types whose protocol-level flag
+     * is still false (object, field, permission, …).
+     *
+     * Memoised at first call. Tests can override by clearing the cache via
+     * {@link ObjectStackProtocolImplementation.resetEnvWritableCache}.
+     */
+    private static _envWritableTypes;
+    private static envWritableTypes;
+    /** Test hook — clear the memoised env-writable cache. */
+    static resetEnvWritableCache(): void;
     /** Normalize plural→singular before consulting the allow-list. */
     private static isOverlayAllowed;
     /**
@@ -609,6 +777,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
         organizationId?: string;
         parentVersion?: string | null;
         actor?: string;
+        force?: boolean;
     }): Promise<{
         success: boolean;
         version: string;
@@ -670,6 +839,30 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
         loaded: number;
         errors: number;
     }>;
+    /**
+     * Scan all loaded metadata for references pointing at the given
+     * `{type, name}` target. Returns one row per referring artifact with
+     * the path that produced the hit, so the admin UI can render an
+     * "Used by" panel before destructive actions (rename / delete /
+     * type-narrowing).
+     *
+     * Coverage is driven by the hand-curated {@link REFERENCE_PATHS}
+     * registry. Types not present in the registry simply return no hits
+     * — the engine never throws.
+     */
+    findReferencesToMeta(request: {
+        type: string;
+        name: string;
+        organizationId?: string;
+    }): Promise<{
+        references: Array<{
+            type: string;
+            name: string;
+            label?: string;
+            path: string;
+            kind: string;
+        }>;
+    }>;
     listFeed(request: any): Promise<any>;
     createFeedItem(request: any): Promise<any>;
     updateFeedItem(request: any): Promise<any>;