@objectstack/objectql 0.6.0 → 0.7.1

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @objectstack/objectql
 
+## 0.7.1
+
+### Patch Changes
+
+- Patch release for maintenance and stability improvements
+- Updated dependencies
+  - @objectstack/spec@0.7.1
+  - @objectstack/types@0.7.1
+  - @objectstack/core@0.7.1
+
+## 0.6.1
+
+### Patch Changes
+
+- Patch release for maintenance and stability improvements
+- Updated dependencies
+  - @objectstack/spec@0.6.1
+  - @objectstack/types@0.6.1
+  - @objectstack/core@0.6.1
+
 ## 0.6.0
 
 ### Minor Changes

package/README.md

@@ -69,7 +69,8 @@ When building full applications, use the `ObjectKernel` to manage plugins and co
 
 ```typescript
 import { ObjectKernel } from '@objectstack/core';
-import { ObjectQLPlugin, DriverPlugin } from '@objectstack/runtime';
+import { DriverPlugin } from '@objectstack/runtime';
+import { ObjectQLPlugin } from '@objectstack/objectql';
 import { InMemoryDriver } from '@objectstack/driver-memory';
 
 const kernel = new ObjectKernel();

package/dist/engine.d.ts

@@ -0,0 +1,286 @@
+import { HookContext } from '@objectstack/spec/data';
+import { DataEngineQueryOptions, DataEngineInsertOptions, DataEngineUpdateOptions, DataEngineDeleteOptions, DataEngineAggregateOptions, DataEngineCountOptions } from '@objectstack/spec/data';
+import { DriverInterface, IDataEngine, Logger } from '@objectstack/core';
+export type HookHandler = (context: HookContext) => Promise<void> | void;
+/**
+ * Host Context provided to plugins (Internal ObjectQL Plugin System)
+ */
+export interface ObjectQLHostContext {
+    ql: ObjectQL;
+    logger: Logger;
+    [key: string]: any;
+}
+/**
+ * ObjectQL Engine
+ *
+ * Implements the IDataEngine interface for data persistence.
+ */
+export declare class ObjectQL implements IDataEngine {
+    private drivers;
+    private defaultDriver;
+    private logger;
+    private hooks;
+    private hostContext;
+    constructor(hostContext?: Record<string, any>);
+    /**
+     * 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;
+            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;
+            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: "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>;
+}
+//# sourceMappingURL=engine.d.ts.map

package/dist/engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../src/engine.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,EACvB,0BAA0B,EAC1B,sBAAsB,EACvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,EAAgB,MAAM,mBAAmB,CAAC;AAGvF,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,QAAQ,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IAEf,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;;GAIG;AACH,qBAAa,QAAS,YAAW,WAAW;IAC1C,OAAO,CAAC,OAAO,CAAsC;IACrD,OAAO,CAAC,aAAa,CAAuB;IAC5C,OAAO,CAAC,MAAM,CAAS;IAGvB,OAAO,CAAC,KAAK,CAKX;IAGF,OAAO,CAAC,WAAW,CAA2B;gBAElC,WAAW,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM;IAOjD;;OAEG;IACG,GAAG,CAAC,YAAY,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,GAAG;IAiC9C;;;;OAIG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW;IAQnC,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW;IAe7D;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,GAAG;IAiCzB;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,eAAe,EAAE,SAAS,GAAE,OAAe;IAkBlE;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM;;;;;;;;;;;;;;mBAoTqxtC,CAAC;;;qBAA2E,CAAC;uBAAyC,CAAC;;sBAAkE,CAAC;wBAA0C,CAAC;eAAkB,CAAC;eAAiC,CAAC;oBAAsC,CAAC;4BAA8C,CAAC;;;;;yBAAmQ,CAAC;kCAAoD,CAAC;;;;;;;;;;;mBAAwZ,CAAC;iBAAmC,CAAC;qBAAuC,CAAC;gBAAkC,CAAC;uBAAyC,CAAC;kBAAoC,CAAC;qBAAuC,CAAC;qBAAuC,CAAC;iBAAmC,CAAC;qBAAuC,CAAC;4BAA8C,CAAC;mCAAuD,CAAC;6BAAgD,CAAC;;;;;iBAA8J,CAAC;uBAAyC,CAAC;qBAAwC,CAAC;qBAAuC,CAAC;sBAAyC,CAAC;0BAA6C,CAAC;yBAA4C,CAAC;uBAAgE,CAAC;sBAAgE,CAAC;wBAA2C,CAAC;gBAAoC,CAAC;qBAAuC,CAAC;iBAAoC,CAAC;yBAA2D,CAAC;6BAAyG,CAAC;wBAAyD,CAAC;yBAA4C,CAAC;0BAA6C,CAAC;;;;;wBAAkK,CAAC;;;;;yBAAyM,CAAC;;gCAA8F,CAAC;;;;;;;;;;;;;uBAA8c,CAAC;uBAAyC,CAAC;4BAA8C,CAAC;4BAAgD,CAAC;gCAAoD,CAAC;gCAAoD,CAAC;iCAAqD,CAAC;+BAA8F,CAAC;6BAA+C,CAAC;6BAA+C,CAAC;+BAAiD,CAAC;;;;4BAAyJ,CAAC;4BAA8C,CAAC;6BAA+C,CAAC;6BAA+C,CAAC;+BAAiD,CAAC;kCAAoD,CAAC;;;;;;;2BAAmO,CAAC;;uBAAgE,CAAC;;;;;uBAAuO,CAAC;qBAAuC,CAAC;2BAA+C,CAAC;;wBAAmE,CAAC;kBAAsC,CAAC;;;;;uBAAyI,CAAC;;;wBAA2F,CAAC;;;;;;;;;;;;;yBAA4S,CAAC;mBAAuC,CAAC;;;;;;;;;;;;mBAA2Y,CAAC;gBAAkC,CAAC;;;;;;;;;;;;;;;;;yBAA+e,CAAC;;;;;;oBAA0K,CAAC;;;;;;;;;;;;;;;;;;;;sBAAqjB,CAAC;;;IAhThj8C;;OAEG;IACH,OAAO,CAAC,SAAS;IA6BjB;;OAEG;IACG,IAAI;IAkBJ,OAAO;IAkBb,OAAO,CAAC,UAAU;IAqCZ,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IA2BpE,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,GAAG,CAAC;IAWzE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,GAAG,EAAE,EAAE,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,GAAG,CAAC;IAqC1F,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,GAAG,CAAC;IA+ClF,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,GAAG,CAAC;IAyCvE,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,MAAM,CAAC;IAWtE,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,0BAA0B,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAS5E,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;CAYzE"}