@objectstack/objectql 7.2.0 → 7.3.0

package/dist/index.d.mts

@@ -138,6 +138,21 @@ declare class SchemaRegistry {
     private namespaceRegistry;
     /** Type → Name/ID → MetadataItem */
     private metadata;
+    /**
+     * Package ids that must be installed in a DISABLED state. Seeded once at
+     * boot (from persisted state) BEFORE any package registration so that every
+     * registration path — boot artifact, marketplace rehydrate, local import —
+     * honors persisted disable state uniformly without a fragile post-boot
+     * re-application hook. See {@link setInitialDisabledPackageIds} and
+     * {@link installPackage}.
+     */
+    private initialDisabledPackageIds;
+    /**
+     * Seed the set of package ids that should be installed disabled. Call this
+     * before package registration begins; later `installPackage` calls for these
+     * ids land in the `disabled` state. Replaces any previously seeded set.
+     */
+    setInitialDisabledPackageIds(ids: Iterable<string>): void;
     /**
      * Register a namespace for a package.
      * Multiple packages can share the same namespace (e.g. 'sys').
@@ -226,6 +241,11 @@ declare class SchemaRegistry {
      * Universal List Method
      */
     listItems<T>(type: string, packageId?: string): T[];
+    /**
+     * Whether a package has been explicitly disabled. Unknown packages and
+     * items with no owning package are treated as enabled.
+     */
+    isPackageDisabled(packageId?: string): boolean;
     /**
      * Get all registered metadata types (Kinds)
      */
@@ -536,6 +556,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
          */
         stats: Record<string, {
             count: number;
+            locked: number;
             packages: string[];
         }>;
     }>;
@@ -564,6 +585,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
         packageVersion?: string | undefined;
         packageId?: string | undefined;
         provenance?: "package" | "env-forced" | "org" | undefined;
+        lockDocsUrl?: string | undefined;
         lockSource?: "artifact" | "package" | "env-forced" | undefined;
         lockReason?: string | undefined;
         type: string;
@@ -609,6 +631,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
         lock: MetadataLock;
         lockReason?: string;
         lockSource?: 'artifact' | 'package' | 'env-forced' | 'overlay';
+        lockDocsUrl?: string;
         provenance?: MetadataProvenance;
         packageId?: string;
         packageVersion?: string;
@@ -865,7 +888,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
      */
     private static readonly OVERLAY_ALLOWED_TYPES;
     /**
-     * Phase 3a-env-writable: parse `OBJECTSTACK_METADATA_WRITABLE` once.
+     * Phase 3a-env-writable: parse `OS_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
@@ -974,6 +997,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
         actor?: string;
         force?: boolean;
         mode?: 'draft' | 'publish';
+        packageId?: string | null;
     }): Promise<{
         success: boolean;
         version: string;
@@ -1346,7 +1370,7 @@ declare class SysMetadataRepository implements MetadataRepository {
      * at `(type, name)`. In that case we accept types with
      * `allowRuntimeCreate: true`, even when `allowOrgOverride` is false.
      *
-     * The env-var escape hatch (`OBJECTSTACK_METADATA_WRITABLE`) still
+     * The env-var escape hatch (`OS_METADATA_WRITABLE`) still
      * applies to BOTH intents, so operators can opt into artifact
      * overrides at runtime for emergency fixes.
      */

package/dist/index.d.ts

@@ -138,6 +138,21 @@ declare class SchemaRegistry {
     private namespaceRegistry;
     /** Type → Name/ID → MetadataItem */
     private metadata;
+    /**
+     * Package ids that must be installed in a DISABLED state. Seeded once at
+     * boot (from persisted state) BEFORE any package registration so that every
+     * registration path — boot artifact, marketplace rehydrate, local import —
+     * honors persisted disable state uniformly without a fragile post-boot
+     * re-application hook. See {@link setInitialDisabledPackageIds} and
+     * {@link installPackage}.
+     */
+    private initialDisabledPackageIds;
+    /**
+     * Seed the set of package ids that should be installed disabled. Call this
+     * before package registration begins; later `installPackage` calls for these
+     * ids land in the `disabled` state. Replaces any previously seeded set.
+     */
+    setInitialDisabledPackageIds(ids: Iterable<string>): void;
     /**
      * Register a namespace for a package.
      * Multiple packages can share the same namespace (e.g. 'sys').
@@ -226,6 +241,11 @@ declare class SchemaRegistry {
      * Universal List Method
      */
     listItems<T>(type: string, packageId?: string): T[];
+    /**
+     * Whether a package has been explicitly disabled. Unknown packages and
+     * items with no owning package are treated as enabled.
+     */
+    isPackageDisabled(packageId?: string): boolean;
     /**
      * Get all registered metadata types (Kinds)
      */
@@ -536,6 +556,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
          */
         stats: Record<string, {
             count: number;
+            locked: number;
             packages: string[];
         }>;
     }>;
@@ -564,6 +585,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
         packageVersion?: string | undefined;
         packageId?: string | undefined;
         provenance?: "package" | "env-forced" | "org" | undefined;
+        lockDocsUrl?: string | undefined;
         lockSource?: "artifact" | "package" | "env-forced" | undefined;
         lockReason?: string | undefined;
         type: string;
@@ -609,6 +631,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
         lock: MetadataLock;
         lockReason?: string;
         lockSource?: 'artifact' | 'package' | 'env-forced' | 'overlay';
+        lockDocsUrl?: string;
         provenance?: MetadataProvenance;
         packageId?: string;
         packageVersion?: string;
@@ -865,7 +888,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
      */
     private static readonly OVERLAY_ALLOWED_TYPES;
     /**
-     * Phase 3a-env-writable: parse `OBJECTSTACK_METADATA_WRITABLE` once.
+     * Phase 3a-env-writable: parse `OS_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
@@ -974,6 +997,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
         actor?: string;
         force?: boolean;
         mode?: 'draft' | 'publish';
+        packageId?: string | null;
     }): Promise<{
         success: boolean;
         version: string;
@@ -1346,7 +1370,7 @@ declare class SysMetadataRepository implements MetadataRepository {
      * at `(type, name)`. In that case we accept types with
      * `allowRuntimeCreate: true`, even when `allowOrgOverride` is false.
      *
-     * The env-var escape hatch (`OBJECTSTACK_METADATA_WRITABLE`) still
+     * The env-var escape hatch (`OS_METADATA_WRITABLE`) still
      * applies to BOTH intents, so operators can opt into artifact
      * overrides at runtime for emergency fixes.
      */