@objectstack/objectql 3.0.0 → 3.0.1

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @objectstack/objectql@3.0.0 build /home/runner/work/spec/spec/packages/objectql
+> @objectstack/objectql@3.0.1 build /home/runner/work/spec/spec/packages/objectql
 > tsup --config ../../tsup.config.ts
 
 CLI Building entry: src/index.ts
@@ -10,13 +10,13 @@
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-ESM dist/index.mjs     75.55 KB
-ESM dist/index.mjs.map 152.89 KB
-ESM ⚡️ Build success in 120ms
-CJS dist/index.js     77.09 KB
-CJS dist/index.js.map 153.77 KB
-CJS ⚡️ Build success in 127ms
+ESM dist/index.mjs     79.69 KB
+ESM dist/index.mjs.map 160.22 KB
+ESM ⚡️ Build success in 128ms
+CJS dist/index.js     81.23 KB
+CJS dist/index.js.map 161.10 KB
+CJS ⚡️ Build success in 131ms
 DTS Build start
-DTS ⚡️ Build success in 13686ms
-DTS dist/index.d.mts 75.15 KB
-DTS dist/index.d.ts  75.15 KB
+DTS ⚡️ Build success in 13628ms
+DTS dist/index.d.mts 66.76 KB
+DTS dist/index.d.ts  66.76 KB

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @objectstack/objectql
 
+## 3.0.1
+
+### Patch Changes
+
+- Updated dependencies [389725a]
+  - @objectstack/spec@3.0.1
+  - @objectstack/core@3.0.1
+  - @objectstack/types@3.0.1
+
 ## 3.0.0
 
 ### Major Changes

package/dist/index.d.mts

@@ -204,7 +204,7 @@ declare class SchemaRegistry {
         abstract: boolean;
         datasource: string;
         fields: Record<string, {
-            type: "number" | "boolean" | "tags" | "date" | "lookup" | "file" | "json" | "code" | "text" | "textarea" | "email" | "url" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "datetime" | "time" | "toggle" | "select" | "multiselect" | "radio" | "checkboxes" | "master_detail" | "tree" | "image" | "avatar" | "video" | "audio" | "formula" | "summary" | "autonumber" | "location" | "address" | "color" | "rating" | "slider" | "signature" | "qrcode" | "progress" | "vector";
+            type: "number" | "boolean" | "tags" | "date" | "lookup" | "file" | "json" | "text" | "textarea" | "email" | "url" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "datetime" | "time" | "toggle" | "select" | "multiselect" | "radio" | "checkboxes" | "master_detail" | "tree" | "image" | "avatar" | "video" | "audio" | "formula" | "summary" | "autonumber" | "location" | "address" | "code" | "color" | "rating" | "slider" | "signature" | "qrcode" | "progress" | "vector";
             required: boolean;
             searchable: boolean;
             multiple: boolean;
@@ -262,7 +262,7 @@ declare class SchemaRegistry {
             allowScanning?: boolean | undefined;
             currencyConfig?: {
                 precision: number;
-                currencyMode: "fixed" | "dynamic";
+                currencyMode: "dynamic" | "fixed";
                 defaultCurrency: string;
             } | undefined;
             vectorConfig?: {
@@ -270,7 +270,7 @@ declare class SchemaRegistry {
                 distanceMetric: "cosine" | "euclidean" | "dotProduct" | "manhattan";
                 normalized: boolean;
                 indexed: boolean;
-                indexType?: "flat" | "hnsw" | "ivfflat" | undefined;
+                indexType?: "hnsw" | "ivfflat" | "flat" | undefined;
             } | undefined;
             fileAttachmentConfig?: {
                 virusScan: boolean;
@@ -332,7 +332,7 @@ declare class SchemaRegistry {
             } | undefined;
             maskingRule?: {
                 field: string;
-                strategy: "hash" | "redact" | "partial" | "tokenize" | "randomize" | "nullify" | "substitute";
+                strategy: "redact" | "partial" | "hash" | "tokenize" | "randomize" | "nullify" | "substitute";
                 preserveFormat: boolean;
                 preserveLength: boolean;
                 pattern?: string | undefined;
@@ -1240,7 +1240,7 @@ declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
                     label: string | undefined;
                     required: boolean;
                     readonly: boolean;
-                    type: "number" | "boolean" | "tags" | "date" | "lookup" | "file" | "json" | "code" | "text" | "textarea" | "email" | "url" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "datetime" | "time" | "toggle" | "select" | "multiselect" | "radio" | "checkboxes" | "master_detail" | "tree" | "image" | "avatar" | "video" | "audio" | "formula" | "summary" | "autonumber" | "location" | "address" | "color" | "rating" | "slider" | "signature" | "qrcode" | "progress" | "vector";
+                    type: "number" | "boolean" | "tags" | "date" | "lookup" | "file" | "json" | "text" | "textarea" | "email" | "url" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "datetime" | "time" | "toggle" | "select" | "multiselect" | "radio" | "checkboxes" | "master_detail" | "tree" | "image" | "avatar" | "video" | "audio" | "formula" | "summary" | "autonumber" | "location" | "address" | "code" | "color" | "rating" | "slider" | "signature" | "qrcode" | "progress" | "vector";
                     colSpan: number;
                 }[];
             }[];
@@ -1327,6 +1327,7 @@ interface HookEntry {
     handler: HookHandler;
     object?: string | string[];
     priority: number;
+    packageId?: string;
 }
 /**
  * Operation Context for Middleware Chain
@@ -1396,6 +1397,7 @@ declare class ObjectQL implements IDataEngine {
     registerHook(event: string, handler: HookHandler, options?: {
         object?: string | string[];
         priority?: number;
+        packageId?: string;
     }): void;
     triggerHooks(event: string, context: HookContext): Promise<void>;
     /**
@@ -1463,270 +1465,7 @@ declare class ObjectQL implements IDataEngine {
     /**
      * Helper to get object definition
      */
-    getSchema(objectName: string): {
-        name: string;
-        active: boolean;
-        isSystem: boolean;
-        abstract: boolean;
-        datasource: string;
-        fields: Record<string, {
-            type: "number" | "boolean" | "tags" | "date" | "lookup" | "file" | "json" | "code" | "text" | "textarea" | "email" | "url" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "datetime" | "time" | "toggle" | "select" | "multiselect" | "radio" | "checkboxes" | "master_detail" | "tree" | "image" | "avatar" | "video" | "audio" | "formula" | "summary" | "autonumber" | "location" | "address" | "color" | "rating" | "slider" | "signature" | "qrcode" | "progress" | "vector";
-            required: boolean;
-            searchable: boolean;
-            multiple: boolean;
-            unique: boolean;
-            deleteBehavior: "set_null" | "cascade" | "restrict";
-            auditTrail: boolean;
-            hidden: boolean;
-            readonly: boolean;
-            sortable: boolean;
-            index: boolean;
-            externalId: boolean;
-            name?: string | undefined;
-            label?: string | undefined;
-            description?: string | undefined;
-            format?: string | undefined;
-            defaultValue?: unknown;
-            maxLength?: number | undefined;
-            minLength?: number | undefined;
-            precision?: number | undefined;
-            scale?: number | undefined;
-            min?: number | undefined;
-            max?: number | undefined;
-            options?: {
-                label: string;
-                value: string;
-                color?: string | undefined;
-                default?: boolean | undefined;
-            }[] | undefined;
-            reference?: string | undefined;
-            referenceFilters?: string[] | undefined;
-            writeRequiresMasterRead?: boolean | undefined;
-            expression?: string | undefined;
-            summaryOperations?: {
-                object: string;
-                field: string;
-                function: "min" | "max" | "count" | "sum" | "avg";
-            } | undefined;
-            language?: string | undefined;
-            theme?: string | undefined;
-            lineNumbers?: boolean | undefined;
-            maxRating?: number | undefined;
-            allowHalf?: boolean | undefined;
-            displayMap?: boolean | undefined;
-            allowGeocoding?: boolean | undefined;
-            addressFormat?: "us" | "uk" | "international" | undefined;
-            colorFormat?: "hex" | "rgb" | "rgba" | "hsl" | undefined;
-            allowAlpha?: boolean | undefined;
-            presetColors?: string[] | undefined;
-            step?: number | undefined;
-            showValue?: boolean | undefined;
-            marks?: Record<string, string> | undefined;
-            barcodeFormat?: "qr" | "ean13" | "ean8" | "code128" | "code39" | "upca" | "upce" | undefined;
-            qrErrorCorrection?: "L" | "M" | "Q" | "H" | undefined;
-            displayValue?: boolean | undefined;
-            allowScanning?: boolean | undefined;
-            currencyConfig?: {
-                precision: number;
-                currencyMode: "fixed" | "dynamic";
-                defaultCurrency: string;
-            } | undefined;
-            vectorConfig?: {
-                dimensions: number;
-                distanceMetric: "cosine" | "euclidean" | "dotProduct" | "manhattan";
-                normalized: boolean;
-                indexed: boolean;
-                indexType?: "flat" | "hnsw" | "ivfflat" | undefined;
-            } | undefined;
-            fileAttachmentConfig?: {
-                virusScan: boolean;
-                virusScanOnUpload: boolean;
-                quarantineOnThreat: boolean;
-                allowMultiple: boolean;
-                allowReplace: boolean;
-                allowDelete: boolean;
-                requireUpload: boolean;
-                extractMetadata: boolean;
-                extractText: boolean;
-                versioningEnabled: boolean;
-                publicRead: boolean;
-                presignedUrlExpiry: number;
-                minSize?: number | undefined;
-                maxSize?: number | undefined;
-                allowedTypes?: string[] | undefined;
-                blockedTypes?: string[] | undefined;
-                allowedMimeTypes?: string[] | undefined;
-                blockedMimeTypes?: string[] | undefined;
-                virusScanProvider?: "custom" | "clamav" | "virustotal" | "metadefender" | undefined;
-                storageProvider?: string | undefined;
-                storageBucket?: string | undefined;
-                storagePrefix?: string | undefined;
-                imageValidation?: {
-                    generateThumbnails: boolean;
-                    preserveMetadata: boolean;
-                    autoRotate: boolean;
-                    minWidth?: number | undefined;
-                    maxWidth?: number | undefined;
-                    minHeight?: number | undefined;
-                    maxHeight?: number | undefined;
-                    aspectRatio?: string | undefined;
-                    thumbnailSizes?: {
-                        name: string;
-                        width: number;
-                        height: number;
-                        crop: boolean;
-                    }[] | undefined;
-                } | undefined;
-                maxVersions?: number | undefined;
-            } | undefined;
-            encryptionConfig?: {
-                enabled: boolean;
-                algorithm: "aes-256-gcm" | "aes-256-cbc" | "chacha20-poly1305";
-                keyManagement: {
-                    provider: "local" | "aws-kms" | "azure-key-vault" | "gcp-kms" | "hashicorp-vault";
-                    keyId?: string | undefined;
-                    rotationPolicy?: {
-                        enabled: boolean;
-                        frequencyDays: number;
-                        retainOldVersions: number;
-                        autoRotate: boolean;
-                    } | undefined;
-                };
-                scope: "field" | "table" | "record" | "database";
-                deterministicEncryption: boolean;
-                searchableEncryption: boolean;
-            } | undefined;
-            maskingRule?: {
-                field: string;
-                strategy: "hash" | "redact" | "partial" | "tokenize" | "randomize" | "nullify" | "substitute";
-                preserveFormat: boolean;
-                preserveLength: boolean;
-                pattern?: string | undefined;
-                roles?: string[] | undefined;
-                exemptRoles?: string[] | undefined;
-            } | undefined;
-            dependencies?: string[] | undefined;
-            cached?: {
-                enabled: boolean;
-                ttl: number;
-                invalidateOn: string[];
-            } | undefined;
-            dataQuality?: {
-                uniqueness: boolean;
-                completeness: number;
-                accuracy?: {
-                    source: string;
-                    threshold: number;
-                } | undefined;
-            } | undefined;
-            group?: string | undefined;
-            conditionalRequired?: string | undefined;
-            inlineHelpText?: string | undefined;
-            trackFeedHistory?: boolean | undefined;
-            caseSensitive?: boolean | undefined;
-            autonumberFormat?: string | undefined;
-        }>;
-        label?: string | undefined;
-        pluralLabel?: string | undefined;
-        description?: string | undefined;
-        icon?: string | undefined;
-        tags?: string[] | undefined;
-        tableName?: string | undefined;
-        indexes?: {
-            fields: string[];
-            type: "hash" | "btree" | "gin" | "gist" | "fulltext";
-            unique: boolean;
-            name?: string | undefined;
-            partial?: string | undefined;
-        }[] | undefined;
-        tenancy?: {
-            enabled: boolean;
-            strategy: "shared" | "isolated" | "hybrid";
-            tenantField: string;
-            crossTenantAccess: boolean;
-        } | undefined;
-        softDelete?: {
-            enabled: boolean;
-            field: string;
-            cascadeDelete: boolean;
-        } | undefined;
-        versioning?: {
-            enabled: boolean;
-            strategy: "snapshot" | "delta" | "event-sourcing";
-            versionField: string;
-            retentionDays?: number | undefined;
-        } | undefined;
-        partitioning?: {
-            enabled: boolean;
-            strategy: "hash" | "range" | "list";
-            key: string;
-            interval?: string | undefined;
-        } | undefined;
-        cdc?: {
-            enabled: boolean;
-            events: ("update" | "delete" | "insert")[];
-            destination: string;
-        } | undefined;
-        validations?: _objectstack_spec_data.BaseValidationRuleShape[] | undefined;
-        stateMachines?: Record<string, {
-            id: string;
-            initial: string;
-            states: Record<string, StateNodeConfig>;
-            description?: string | undefined;
-            contextSchema?: Record<string, unknown> | undefined;
-            on?: Record<string, string | {
-                target?: string | undefined;
-                cond?: string | {
-                    type: string;
-                    params?: Record<string, unknown> | undefined;
-                } | undefined;
-                actions?: (string | {
-                    type: string;
-                    params?: Record<string, unknown> | undefined;
-                })[] | undefined;
-                description?: string | undefined;
-            } | {
-                target?: string | undefined;
-                cond?: string | {
-                    type: string;
-                    params?: Record<string, unknown> | undefined;
-                } | undefined;
-                actions?: (string | {
-                    type: string;
-                    params?: Record<string, unknown> | undefined;
-                })[] | undefined;
-                description?: string | undefined;
-            }[]> | undefined;
-        }> | undefined;
-        displayNameField?: string | undefined;
-        recordName?: {
-            type: "text" | "autonumber";
-            displayFormat?: string | undefined;
-            startNumber?: number | undefined;
-        } | undefined;
-        titleFormat?: string | undefined;
-        compactLayout?: string[] | undefined;
-        search?: {
-            fields: string[];
-            displayFields?: string[] | undefined;
-            filters?: string[] | undefined;
-        } | undefined;
-        enable?: {
-            trackHistory: boolean;
-            searchable: boolean;
-            apiEnabled: boolean;
-            files: boolean;
-            feeds: boolean;
-            activities: boolean;
-            trash: boolean;
-            mru: boolean;
-            clone: boolean;
-            apiMethods?: ("search" | "list" | "update" | "delete" | "upsert" | "history" | "get" | "create" | "bulk" | "aggregate" | "restore" | "purge" | "import" | "export")[] | undefined;
-        } | undefined;
-        recordTypes?: string[] | undefined;
-        sharingModel?: "full" | "private" | "read" | "read_write" | undefined;
-        keyPrefix?: string | undefined;
-    } | undefined;
+    getSchema(objectName: string): ServiceObject | undefined;
     /**
      * Resolve an object name to its Fully Qualified Name (FQN).
      *
@@ -1756,6 +1495,58 @@ declare class ObjectQL implements IDataEngine {
     count(object: string, query?: DataEngineCountOptions): Promise<number>;
     aggregate(object: string, query: DataEngineAggregateOptions): Promise<any[]>;
     execute(command: any, options?: Record<string, any>): Promise<any>;
+    /**
+     * Register a single object definition.
+     *
+     * Proxies to SchemaRegistry.registerObject() with sensible defaults.
+     * Fields without a `name` property are auto-assigned from their key.
+     */
+    registerObject(schema: ServiceObject, packageId?: string, namespace?: string): string;
+    /**
+     * Unregister a single object by name.
+     */
+    unregisterObject(name: string, packageId?: string): void;
+    /**
+     * Get an object definition by name.
+     * Alias for getSchema() — matches @objectql/core API.
+     */
+    getObject(name: string): ServiceObject | undefined;
+    /**
+     * Get all registered object configs as a name→config map.
+     * Matches @objectql/core getConfigs() API.
+     */
+    getConfigs(): Record<string, ServiceObject>;
+    /**
+     * Get a registered driver by datasource name.
+     *
+     * Unlike the private getDriver() (which resolves by object name),
+     * this method directly looks up a driver by its registered name.
+     */
+    getDriverByName(name: string): DriverInterface | undefined;
+    /**
+     * Get a registered driver by datasource name.
+     * Alias matching @objectql/core datasource() API.
+     *
+     * @throws Error if the datasource is not found
+     */
+    datasource(name: string): DriverInterface;
+    /**
+     * Register a hook handler.
+     * Convenience alias for registerHook() matching @objectql/core on() API.
+     *
+     * Usage:
+     *   ql.on('beforeInsert', 'user', async (ctx) => { ... });
+     */
+    on(event: string, objectName: string, handler: (ctx: HookContext) => Promise<void> | void, packageId?: string): void;
+    /**
+     * Remove all hooks, actions, and objects contributed by a package.
+     */
+    removePackage(packageId: string): void;
+    /**
+     * Gracefully shut down the engine, disconnecting all drivers.
+     * Alias for destroy() — matches @objectql/core close() API.
+     */
+    close(): Promise<void>;
     /**
      * Create a scoped execution context bound to this engine.
      *
@@ -1765,6 +1556,27 @@ declare class ObjectQL implements IDataEngine {
      *   await users.find({ filter: { status: 'active' } });
      */
     createContext(ctx: Partial<ExecutionContext>): ScopedContext;
+    /**
+     * Static factory: create a fully configured ObjectQL instance.
+     *
+     * Matches @objectql/core's `new ObjectQL(config)` pattern but also
+     * registers drivers and objects, then calls init().
+     *
+     * Usage:
+     *   const ql = await ObjectQL.create({
+     *     datasources: { default: myDriver },
+     *     objects: { user: { name: 'user', fields: { ... } } }
+     *   });
+     */
+    static create(config: {
+        datasources?: Record<string, DriverInterface>;
+        objects?: Record<string, ServiceObject>;
+        hooks?: Array<{
+            event: string;
+            object: string;
+            handler: (ctx: HookContext) => Promise<void> | void;
+        }>;
+    }): Promise<ObjectQL>;
 }
 /**
  * Repository scoped to a single object, bound to an execution context.