@objectstack/objectql 1.0.4 → 1.0.6

package/.turbo/turbo-build.log

@@ -0,0 +1,22 @@
+
+> @objectstack/objectql@1.0.6 build /home/runner/work/spec/spec/packages/objectql
+> tsup --config ../../tsup.config.ts
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.1
+CLI Using tsup config: /home/runner/work/spec/spec/tsup.config.ts
+CLI Target: es2020
+CLI Cleaning output folder
+ESM Build start
+CJS Build start
+ESM dist/index.mjs     23.51 KB
+ESM dist/index.mjs.map 49.71 KB
+ESM ⚡️ Build success in 76ms
+CJS dist/index.js     24.72 KB
+CJS dist/index.js.map 50.17 KB
+CJS ⚡️ Build success in 84ms
+DTS Build start
+DTS ⚡️ Build success in 10005ms
+DTS dist/index.d.mts 37.73 KB
+DTS dist/index.d.ts  37.73 KB

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @objectstack/objectql
 
+## 1.0.6
+
+### Patch Changes
+
+- Updated dependencies [a7f7b9d]
+  - @objectstack/spec@1.0.6
+  - @objectstack/core@1.0.6
+  - @objectstack/types@1.0.6
+
+## 1.0.5
+
+### Patch Changes
+
+- b1d24bd: refactor: migrate build system from tsc to tsup for faster builds
+  - Replaced `tsc` with `tsup` (using esbuild) across all packages
+  - Added shared `tsup.config.ts` in workspace root
+  - Added `tsup` as workspace dev dependency
+  - significantly improved build performance
+- Updated dependencies [b1d24bd]
+  - @objectstack/core@1.0.5
+  - @objectstack/types@1.0.5
+  - @objectstack/spec@1.0.5
+
 ## 1.0.4
 
 ### Patch Changes

package/dist/{registry.d.ts → index.d.mts}

@@ -1,10 +1,13 @@
-import { ServiceObject } from '@objectstack/spec/data';
+import { ServiceObject, HookContext, DataEngineQueryOptions, DataEngineInsertOptions, DataEngineUpdateOptions, DataEngineDeleteOptions, DataEngineCountOptions, DataEngineAggregateOptions } from '@objectstack/spec/data';
 import { ObjectStackManifest } from '@objectstack/spec/kernel';
+import { ObjectStackProtocol, MetadataCacheRequest, MetadataCacheResponse, BatchUpdateRequest, BatchUpdateResponse, UpdateManyDataRequest, DeleteManyDataRequest } from '@objectstack/spec/api';
+import { IDataEngine, DriverInterface, Logger, Plugin, PluginContext } from '@objectstack/core';
+
 /**
  * Global Schema Registry
  * Unified storage for all metadata types (Objects, Apps, Flows, Layouts, etc.)
  */
-export declare class SchemaRegistry {
+declare class SchemaRegistry {
     private static metadata;
     /**
      * Universal Register Method
@@ -566,4 +569,431 @@ export declare class SchemaRegistry {
         globs: string[];
     }[];
 }
-//# sourceMappingURL=registry.d.ts.map
+
+declare class ObjectStackProtocolImplementation implements ObjectStackProtocol {
+    private engine;
+    constructor(engine: IDataEngine);
+    getDiscovery(_request: {}): Promise<{
+        version: string;
+        apiName: string;
+        capabilities: {
+            graphql: boolean;
+            search: boolean;
+            websockets: boolean;
+            files: boolean;
+            analytics: boolean;
+            hub: boolean;
+        };
+        endpoints: {
+            data: string;
+            metadata: string;
+            auth: string;
+        };
+    }>;
+    getMetaTypes(_request: {}): Promise<{
+        types: string[];
+    }>;
+    getMetaItems(request: {
+        type: string;
+    }): Promise<{
+        type: string;
+        items: unknown[];
+    }>;
+    getMetaItem(request: {
+        type: string;
+        name: string;
+    }): Promise<{
+        type: string;
+        name: string;
+        item: unknown;
+    }>;
+    getUiView(request: {
+        object: string;
+        type: 'list' | 'form';
+    }): Promise<any>;
+    findData(request: {
+        object: string;
+        query?: any;
+    }): Promise<{
+        object: string;
+        value: any[];
+        records: any[];
+        total: number;
+        hasMore: boolean;
+    }>;
+    getData(request: {
+        object: string;
+        id: string;
+    }): Promise<{
+        object: string;
+        id: string;
+        record: any;
+    }>;
+    createData(request: {
+        object: string;
+        data: any;
+    }): Promise<{
+        object: string;
+        id: any;
+        record: any;
+    }>;
+    updateData(request: {
+        object: string;
+        id: string;
+        data: any;
+    }): Promise<{
+        object: string;
+        id: string;
+        record: any;
+    }>;
+    deleteData(request: {
+        object: string;
+        id: string;
+    }): Promise<{
+        object: string;
+        id: string;
+        success: boolean;
+    }>;
+    getMetaItemCached(request: {
+        type: string;
+        name: string;
+        cacheRequest?: MetadataCacheRequest;
+    }): Promise<MetadataCacheResponse>;
+    batchData(_request: {
+        object: string;
+        request: BatchUpdateRequest;
+    }): Promise<BatchUpdateResponse>;
+    createManyData(request: {
+        object: string;
+        records: any[];
+    }): Promise<any>;
+    updateManyData(_request: UpdateManyDataRequest): Promise<any>;
+    analyticsQuery(_request: any): Promise<any>;
+    getAnalyticsMeta(_request: any): Promise<any>;
+    triggerAutomation(_request: any): Promise<any>;
+    listSpaces(_request: any): Promise<any>;
+    createSpace(_request: any): Promise<any>;
+    installPlugin(_request: any): Promise<any>;
+    deleteManyData(request: DeleteManyDataRequest): Promise<any>;
+    saveMetaItem(request: {
+        type: string;
+        name: string;
+        item?: any;
+    }): Promise<{
+        success: boolean;
+        message: string;
+    }>;
+}
+
+type HookHandler = (context: HookContext) => Promise<void> | void;
+/**
+ * Host Context provided to plugins (Internal ObjectQL Plugin System)
+ */
+interface ObjectQLHostContext {
+    ql: ObjectQL;
+    logger: Logger;
+    [key: string]: any;
+}
+/**
+ * ObjectQL Engine
+ *
+ * Implements the IDataEngine interface for data persistence.
+ * Acts as the reference implementation for:
+ * - CoreServiceName.data (CRUD)
+ * - CoreServiceName.metadata (Schema Registry)
+ */
+declare class ObjectQL implements IDataEngine {
+    private drivers;
+    private defaultDriver;
+    private logger;
+    private hooks;
+    private hostContext;
+    constructor(hostContext?: Record<string, any>);
+    /**
+     * Service Status Report
+     * Used by Kernel to verify health and capabilities.
+     */
+    getStatus(): {
+        name: "data";
+        status: string;
+        version: string;
+        features: string[];
+    };
+    /**
+     * Expose the SchemaRegistry for plugins to register metadata
+     */
+    get registry(): typeof SchemaRegistry;
+    /**
+     * Load and Register a Plugin
+     */
+    use(manifestPart: any, runtimePart?: any): Promise<void>;
+    /**
+     * Register a hook
+     * @param event The event name (e.g. 'beforeFind', 'afterInsert')
+     * @param handler The handler function
+     */
+    registerHook(event: string, handler: HookHandler): void;
+    triggerHooks(event: string, context: HookContext): Promise<void>;
+    /**
+     * Register contribution (Manifest)
+     */
+    registerApp(manifest: any): void;
+    /**
+     * Register a new storage driver
+     */
+    registerDriver(driver: DriverInterface, isDefault?: boolean): void;
+    /**
+     * Helper to get object definition
+     */
+    getSchema(objectName: string): {
+        fields: Record<string, {
+            type: "number" | "boolean" | "code" | "date" | "lookup" | "text" | "textarea" | "email" | "url" | "phone" | "password" | "markdown" | "html" | "richtext" | "currency" | "percent" | "datetime" | "time" | "toggle" | "select" | "multiselect" | "radio" | "checkboxes" | "master_detail" | "tree" | "image" | "file" | "avatar" | "video" | "audio" | "formula" | "summary" | "autonumber" | "location" | "address" | "json" | "color" | "rating" | "slider" | "signature" | "qrcode" | "progress" | "tags" | "vector";
+            required: boolean;
+            searchable: boolean;
+            multiple: boolean;
+            unique: boolean;
+            deleteBehavior: "set_null" | "cascade" | "restrict";
+            auditTrail: boolean;
+            hidden: boolean;
+            readonly: boolean;
+            encryption: boolean;
+            index: boolean;
+            externalId: boolean;
+            options?: {
+                value: string;
+                label: string;
+                color?: string | undefined;
+                default?: boolean | undefined;
+            }[] | undefined;
+            expression?: string | undefined;
+            defaultValue?: any;
+            min?: number | undefined;
+            max?: number | undefined;
+            step?: number | undefined;
+            language?: string | 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: "table" | "field" | "database" | "record";
+                deterministicEncryption: boolean;
+                searchableEncryption: boolean;
+            } | undefined;
+            formula?: string | undefined;
+            label?: string | undefined;
+            precision?: number | undefined;
+            name?: string | undefined;
+            description?: string | undefined;
+            format?: string | undefined;
+            maxLength?: number | undefined;
+            minLength?: number | undefined;
+            scale?: number | undefined;
+            reference?: string | undefined;
+            referenceFilters?: string[] | undefined;
+            writeRequiresMasterRead?: boolean | undefined;
+            summaryOperations?: {
+                object: string;
+                function: "count" | "sum" | "avg" | "min" | "max";
+                field: 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;
+            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: "dynamic" | "fixed";
+                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?: {
+                    autoRotate: boolean;
+                    generateThumbnails: boolean;
+                    preserveMetadata: 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;
+            maskingRule?: {
+                field: string;
+                strategy: "partial" | "hash" | "redact" | "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;
+        }>;
+        name: string;
+        active: boolean;
+        isSystem: boolean;
+        abstract: boolean;
+        datasource: string;
+        search?: {
+            fields: string[];
+            displayFields?: string[] | undefined;
+            filters?: string[] | undefined;
+        } | undefined;
+        tags?: string[] | undefined;
+        label?: string | undefined;
+        description?: string | undefined;
+        pluralLabel?: string | undefined;
+        icon?: string | undefined;
+        tableName?: string | undefined;
+        indexes?: {
+            type: "hash" | "btree" | "gin" | "gist" | "fulltext";
+            fields: string[];
+            unique: boolean;
+            partial?: string | undefined;
+            name?: 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: ("insert" | "update" | "delete")[];
+            destination: string;
+        } | undefined;
+        validations?: any[] | undefined;
+        titleFormat?: string | undefined;
+        compactLayout?: string[] | undefined;
+        enable?: {
+            searchable: boolean;
+            trackHistory: boolean;
+            apiEnabled: boolean;
+            files: boolean;
+            feeds: boolean;
+            activities: boolean;
+            trash: boolean;
+            mru: boolean;
+            clone: boolean;
+            apiMethods?: ("search" | "update" | "delete" | "get" | "list" | "create" | "upsert" | "bulk" | "aggregate" | "history" | "restore" | "purge" | "import" | "export")[] | undefined;
+        } | undefined;
+    } | undefined;
+    /**
+     * Helper to get the target driver
+     */
+    private getDriver;
+    /**
+     * Initialize the engine and all registered drivers
+     */
+    init(): Promise<void>;
+    destroy(): Promise<void>;
+    private toQueryAST;
+    find(object: string, query?: DataEngineQueryOptions): Promise<any[]>;
+    findOne(objectName: string, query?: DataEngineQueryOptions): Promise<any>;
+    insert(object: string, data: any | any[], options?: DataEngineInsertOptions): Promise<any>;
+    update(object: string, data: any, options?: DataEngineUpdateOptions): Promise<any>;
+    delete(object: string, options?: DataEngineDeleteOptions): Promise<any>;
+    count(object: string, query?: DataEngineCountOptions): Promise<number>;
+    aggregate(object: string, query: DataEngineAggregateOptions): Promise<any[]>;
+    execute(command: any, options?: Record<string, any>): Promise<any>;
+}
+
+declare class ObjectQLPlugin implements Plugin {
+    name: string;
+    type: "objectql";
+    version: string;
+    private ql;
+    private hostContext?;
+    constructor(ql?: ObjectQL, hostContext?: Record<string, any>);
+    init: (ctx: PluginContext) => Promise<void>;
+    start: (ctx: PluginContext) => Promise<void>;
+}
+
+export { type HookHandler, ObjectQL, type ObjectQLHostContext, ObjectQLPlugin, ObjectStackProtocolImplementation, SchemaRegistry };