nesoi 3.0.0 → 3.0.3

package/lib/elements/entities/bucket/adapters/slow_memory.bucket_adapter.d.ts

@@ -1,20 +0,0 @@
-import { BucketAdapterConfig } from './bucket_adapter';
-import { MemoryBucketAdapter } from './memory.bucket_adapter';
-import { $Bucket } from '../bucket.schema';
-import { NesoiObj } from "../../../../engine/data/obj";
-import { AnyTrxNode } from "../../../../engine/transaction/trx_node";
-import { NQL_AnyQuery, NQL_Pagination } from '../query/nql.schema';
-export declare class SlowMemoryBucketAdapter<Obj extends NesoiObj> extends MemoryBucketAdapter<Obj> {
-    schema: $Bucket;
-    protected timeout: number;
-    constructor(schema: $Bucket, timeout: number, data?: Record<Obj['id'], Obj>, config?: BucketAdapterConfig);
-    private wrap;
-    index(trx: AnyTrxNode): Promise<Obj[]>;
-    get(trx: AnyTrxNode, id: Obj['id']): Promise<Awaited<Record<Obj["id"], Obj>[Obj["id"]]>>;
-    query<MetadataOnly extends boolean>(trx: AnyTrxNode, query: NQL_AnyQuery, pagination?: NQL_Pagination, config?: {
-        metadataOnly: MetadataOnly;
-    }): Promise<MetadataOnly extends true ? {
-        id: Obj['id'];
-        [x: string]: any;
-    }[] : Obj[]>;
-}

package/lib/elements/entities/bucket/adapters/slow_memory.bucket_adapter.js

@@ -1,31 +1,47 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SlowMemoryBucketAdapter = void 0;
-const memory_bucket_adapter_1 = require("./memory.bucket_adapter");
-class SlowMemoryBucketAdapter extends memory_bucket_adapter_1.MemoryBucketAdapter {
-    constructor(schema, timeout, data = {}, config) {
-        super(schema, data, config);
-        this.schema = schema;
-        this.timeout = timeout;
-    }
-    wrap(scale, fn) {
-        return new Promise((resolve, reject) => {
-            setTimeout(() => {
-                fn()
-                    .then(resolve)
-                    .catch(reject);
-            }, this.timeout * scale);
-        });
-    }
-    /* Read operations */
-    index(trx) {
-        return this.wrap(5, () => super.index(trx));
-    }
-    get(trx, id) {
-        return this.wrap(1, () => super.get(trx, id));
-    }
-    async query(trx, query, pagination, config) {
-        return this.wrap(3, () => super.query(trx, query, pagination, config));
-    }
-}
-exports.SlowMemoryBucketAdapter = SlowMemoryBucketAdapter;
+// import { BucketAdapterConfig } from './bucket_adapter';
+// import { MemoryBucketAdapter } from './memory.bucket_adapter';
+// import { $Bucket } from '../bucket.schema';
+// import { AnyTrxNode } from '~/engine/transaction/trx_node';
+// import { NQL_AnyQuery, NQL_Pagination } from '../query/nql.schema';
+// export class SlowMemoryBucketAdapter<
+// B extends $Bucket,
+// Obj extends B['#data']
+// > extends MemoryBucketAdapter<B, Obj> {
+//     constructor(
+//         public schema: $Bucket,
+//         protected timeout: number,
+//         data: Record<Obj['id'], Obj> = {} as any,
+//         config?: BucketAdapterConfig
+//     ) {
+//         super(schema, data, config);
+//     }
+//     private wrap<T extends Promise<any>>(scale: number, fn: () => T): T {
+//         return new Promise((resolve, reject) => {
+//             setTimeout(() => {
+//                 fn()
+//                     .then(resolve)
+//                     .catch(reject);
+//             }, this.timeout*scale);
+//         }) as any;
+//     }
+//     /* Read operations */
+//     index(trx: AnyTrxNode) {
+//         return this.wrap(5, () => super.index(trx));
+//     }
+//     get(trx: AnyTrxNode, id: Obj['id']) {
+//         return this.wrap(1, () => super.get(trx, id));
+//     }
+//     async query<
+//         MetadataOnly extends boolean
+//     >(
+//         trx: AnyTrxNode,
+//         query: NQL_AnyQuery,
+//         pagination?: NQL_Pagination,
+//         config?: {
+//             metadataOnly: MetadataOnly
+//         }
+//     ): Promise<MetadataOnly extends true ? { id: Obj['id'], [x: string]: any }[] : Obj[]> {
+//         return this.wrap(3, () => super.query(trx, query, pagination, config));
+//     }
+// }

package/lib/elements/entities/bucket/bucket.builder.d.ts

@@ -2,7 +2,7 @@ import { $Module, $Space, BucketName } from "../../../schema";
 import { BucketGraphDef } from './graph/bucket_graph.builder';
 import { $BucketView, $BucketViews } from './view/bucket_view.schema';
 import { BucketViewDef } from './view/bucket_view.builder';
-import { $Bucket } from './bucket.schema';
+import { $Bucket, $BucketTenancy } from './bucket.schema';
 import { BucketModelDef } from './model/bucket_model.builder';
 import { $BucketModelFields } from './model/bucket_model.schema';
 import { $BucketViewDataInfer, $BucketViewFieldsInfer } from './bucket.infer';
@@ -20,11 +20,12 @@ export declare class BucketBuilder<Space extends $Space, Module extends $Module,
     private module;
     private name;
     $b: "bucket";
+    private _extend?;
     private _alias?;
     private _model;
     private _graph;
     private _views;
-    private _extend?;
+    private _tenancy?;
     constructor(module: string, name: string);
     as(alias: string): this;
     extend<N extends Exclude<BucketName<Module>, Bucket['name']>>(name: N): BucketBuilder<Space, Module, Module["buckets"][N]>;
@@ -37,6 +38,11 @@ export declare class BucketBuilder<Space extends $Space, Module extends $Module,
         '#data': Obj & NesoiObj;
         '#fieldpath': Fieldpath;
     }>>;
+    /**
+     * Optional query to be appended to every read of this bucket, based on the user
+     * This allows implementing complex multi-tenancy rules through NQL
+     */
+    tenancy<T extends $BucketTenancy<Module, Bucket>>($: T): void;
     graph<Def extends BucketGraphDef<Module, Bucket>>($: Def): BucketBuilder<Space, Module, Overlay<Bucket, {
         graph: Overlay<Bucket["graph"], {
             links: $BucketGraphLinksInfer<ReturnType<Def>>;

package/lib/elements/entities/bucket/bucket.builder.js

@@ -34,6 +34,13 @@ class BucketBuilder {
         this._model = bucket_model_builder_1.BucketModelBuilder.build(builder);
         return this;
     }
+    /**
+     * Optional query to be appended to every read of this bucket, based on the user
+     * This allows implementing complex multi-tenancy rules through NQL
+     */
+    tenancy($) {
+        this._tenancy = $;
+    }
     graph($) {
         const linkFactory = new bucket_graph_link_builder_1.BucketGraphLinkFactory(this.module);
         const links = $(linkFactory);
@@ -67,15 +74,14 @@ class BucketBuilder {
         }
         const graph = BucketBuilder.buildGraph(node, tree, extend);
         const views = BucketBuilder.buildViews(node.builder, graph, tree, extend);
-        BucketBuilder.checkComposition(node, graph);
-        node.schema = new bucket_schema_1.$Bucket(node.builder.module, node.builder.name, node.builder._alias || $ext?.alias || node.builder.name, node.builder._model, graph, views, extend);
+        node.schema = new bucket_schema_1.$Bucket(node.builder.module, node.builder.name, node.builder._alias || $ext?.alias || node.builder.name, node.builder._model, graph, views, node.builder._tenancy, extend);
         return node.schema;
     }
     static mergeModelEnums(fields, constants) {
         Object.values(fields).forEach(field => {
-            if (field.type === 'enum' && typeof field._enum?.options === 'string') {
-                field._enum = {
-                    options: constants_schema_1.$ConstantEnum.keys(constants.enums[field._enum.options])
+            if (field.type === 'enum' && typeof field.meta?.enum?.options === 'string') {
+                field.meta.enum = {
+                    options: constants_schema_1.$ConstantEnum.keys(constants.enums[field.meta.enum.options])
                 };
             }
             if (field.children) {
@@ -91,16 +97,6 @@ class BucketBuilder {
         }
         const graphBuilder = new bucket_graph_builder_1.BucketGraphBuilder().links(node.builder._graph);
         const graph = bucket_graph_builder_1.BucketGraphBuilder.build(node, graphBuilder);
-        Object.values(graph.links).forEach(link => {
-            if (link.keyOwner === 'other') {
-                link.selfKey || (link.selfKey = 'id');
-                link.otherKey || (link.otherKey = node.builder.name + '_id');
-            }
-            else if (link.keyOwner === 'self') {
-                link.selfKey || (link.selfKey = link.bucket.name + '_id');
-                link.otherKey || (link.otherKey = 'id');
-            }
-        });
         graph.links = Object.assign(graph.links, links);
         return graph;
     }
@@ -119,10 +115,8 @@ class BucketBuilder {
     }
     static checkComposition(node, graph) {
         Object.values(graph.links).forEach(link => {
-            if (link.rel === 'composition') {
-                if (link.pivotBucket) {
-                    throw error_1.NesoiError.Builder.Bucket.CompositionWithPivotNotAllowed();
-                }
+            if (link.rel === 'composition' && link.keyOwner === 'pivot') {
+                throw error_1.NesoiError.Builder.Bucket.CompositionThroughPivotNotAllowed({ bucket: this.name, link: link.name });
             }
         });
     }

package/lib/elements/entities/bucket/bucket.config.d.ts

@@ -1,8 +1,12 @@
+import { $Module } from "../..";
 import { BucketAdapter } from './adapters/bucket_adapter';
 import { $Bucket } from './bucket.schema';
-export type BucketConfig<B extends $Bucket, Providers extends Record<string, any>> = {
+import { DriveAdapter } from '../drive/drive_adapter';
+export type BucketConfig<M extends $Module, B extends $Bucket, Providers extends Record<string, any>> = {
     /** Adapter used by this bucket to communicate with a data source */
     adapter?: (schema: B, providers: Providers) => BucketAdapter<B['#data']>;
+    /** Drive Adapter used by this bucket to write/read files */
+    drive?: (schema: B, providers: Providers) => DriveAdapter;
     /** Settings for the app cache of this bucket */
     cache?: {
         /** Inner adapter used by the cache to manage cache entry data */

package/lib/elements/entities/bucket/bucket.d.ts

@@ -1,36 +1,197 @@
 import { AnyTrxNode } from "../../../engine/transaction/trx_node";
-import { NesoiObj, NewOrOldObj } from "../../../engine/data/obj";
+import { NesoiObj } from "../../../engine/data/obj";
 import { $Module, ViewName, ViewObj } from "../../../schema";
 import { $Bucket } from './bucket.schema';
-import { AnyBucketAdapter, BucketAdapter } from './adapters/bucket_adapter';
+import { BucketAdapter } from './adapters/bucket_adapter';
 import { BucketConfig } from './bucket.config';
 import { BucketGraph } from './graph/bucket_graph';
-import { NQL_AnyQuery, NQL_Order, NQL_Pagination } from './query/nql.schema';
+import { NQL_AnyQuery, NQL_Pagination } from './query/nql.schema';
+import { CreateObj, PatchObj, PutObj } from './bucket.types';
+import { NQL_Result } from './query/nql_engine';
+import { $BucketModelFields } from './model/bucket_model.schema';
+import { DriveAdapter } from '../drive/drive_adapter';
+/**
+ * **This should only be used inside a `#composition` of a bucket `create`** to refer to the parent id, which doesn't exist yet.
+ *
+ * This property has no useful value outside the engine. If you try to `console.log` it, you'll find a Symbol.
+ * It's replaced by the bucket after creating the parent, before creating the composition.
+ */
+export declare const $id: string | number;
 export declare class Bucket<M extends $Module, $ extends $Bucket> {
     schema: $;
     private config?;
     providers: Record<string, any>;
-    private adapter;
+    adapter: BucketAdapter<$['#data']>;
     private cache?;
     graph: BucketGraph<M, $>;
     private views;
-    constructor(schema: $, config?: BucketConfig<$, any> | undefined, providers?: Record<string, any>);
-    readOne<Obj = $['#data']>(trx: AnyTrxNode, id: (Obj & NesoiObj)['id']): Promise<Obj | undefined>;
-    readAll<Obj = $['#data']>(trx: AnyTrxNode, pagination?: NQL_Pagination, order?: NQL_Order<$['#fieldpath']>): Promise<Obj[]>;
-    viewOne<V extends ViewName<$>, Obj extends ViewObj<$, V>>(trx: AnyTrxNode, id: (Obj & NesoiObj)['id'], view: V): Promise<Obj | undefined>;
-    viewAll<V extends ViewName<$>, Obj extends ViewObj<$, V>>(trx: AnyTrxNode, view: V, pagination?: NQL_Pagination, order?: NQL_Order<$['#fieldpath']>): Promise<Obj[]>;
-    buildOne<V extends ViewName<$>, Obj extends ViewObj<$, V>>(trx: AnyTrxNode, obj: $['#data'], view: V): Promise<Obj>;
-    buildAll<V extends ViewName<$>, Obj extends ViewObj<$, V>>(trx: AnyTrxNode, objs: $['#data'][], view: V): Promise<Obj[]>;
-    put<Obj = $['#data']>(trx: AnyTrxNode, obj: NewOrOldObj<Obj & NesoiObj>): Promise<Obj>;
-    delete(trx: AnyTrxNode, id: $['#data']['id']): Promise<void>;
-    deleteMany(trx: AnyTrxNode, ids: $['#data']['id'][]): Promise<void>;
-    query<V extends ViewName<$>, Obj extends ViewObj<$, V>>(trx: AnyTrxNode, query: NQL_AnyQuery, pagination?: NQL_Pagination, view?: V): Promise<Obj[]>;
-    static getQueryMeta(bucket: AnyBucket): {
-        bucket: $Bucket;
+    drive?: DriveAdapter;
+    constructor(schema: $, config?: BucketConfig<any, any, any> | undefined, providers?: Record<string, any>);
+    getQueryMeta(): {
+        bucket: $;
         scope: string;
         avgTime: number;
     };
-    static getQueryRunner(bucket: AnyBucket): AnyBucketAdapter["nql"];
-    static getAdapter(bucket: AnyBucket): BucketAdapter<NesoiObj>;
+    /**
+     * Read one raw entity by `id`
+     *
+     * - Options:
+     *   - `silent`: If not found, return `undefined` instead of throwing an exception
+     *   - `no_tenancy`: Don't apply tenancy rules.
+     */
+    readOne<Obj = $['#data']>(trx: AnyTrxNode, id: (Obj & NesoiObj)['id'], options?: {
+        silent?: boolean;
+        no_tenancy?: boolean;
+    }): Promise<Obj | undefined>;
+    /**
+     * Read all raw entities
+     *
+     * - Options:
+     *   - `no_tenancy`: Don't apply tenancy rules.
+     */
+    readAll<Obj = $['#data']>(trx: AnyTrxNode, options?: {
+        no_tenancy?: boolean;
+    }): Promise<Obj[]>;
+    /**
+     * Read an entity's view by `id`
+     *
+     * - Options:
+     *   - `silent`: If not found, return `undefined` instead of throwing an exception
+     *   - `no_tenancy`: Don't apply tenancy rules.
+     */
+    viewOne<V extends ViewName<$>, Obj extends ViewObj<$, V>>(trx: AnyTrxNode, id: (Obj & NesoiObj)['id'], view: V, options?: {
+        silent?: boolean;
+        no_tenancy?: boolean;
+    }): Promise<Obj | undefined>;
+    /**
+     * Read a view of all entities
+     *
+     * - Options:
+     *   - `no_tenancy`: Don't apply tenancy rules.
+     */
+    viewAll<V extends ViewName<$>, Obj extends ViewObj<$, V>>(trx: AnyTrxNode, view: V, options?: {
+        no_tenancy: boolean;
+    }): Promise<Obj[]>;
+    /**
+     * Read raw entity of a graph link
+     *
+     * - Options:
+     *   - `silent`: If not found, return `undefined` instead of throwing an exception
+     *   - `no_tenancy`: Don't apply tenancy rules.
+     */
+    readLink<LinkName extends keyof $['graph']['links'], Link extends $['graph']['links'][LinkName], LinkBucket extends Link['#bucket'], V extends ViewName<LinkBucket>, Obj extends ViewObj<LinkBucket, V>>(trx: AnyTrxNode, id: $['#data']['id'], link: LinkName, options?: {
+        silent?: boolean;
+        no_tenancy?: boolean;
+    }): Promise<Link['#many'] extends true ? Obj[] : (Obj | undefined)>;
+    /**
+     * Read the view of an entity of a graph link
+     *
+     * - Options:
+     *   - `silent`: If not found, return `undefined` instead of throwing an exception
+     *   - `no_tenancy`: Don't apply tenancy rules.
+     */
+    viewLink<LinkName extends keyof $['graph']['links'], Link extends $['graph']['links'][LinkName], LinkBucket extends Link['#bucket'], V extends ViewName<LinkBucket>, Obj extends ViewObj<LinkBucket, V>>(trx: AnyTrxNode, id: $['#data']['id'], link: LinkName, view: V, options?: {
+        silent?: boolean;
+        no_tenancy?: boolean;
+    }): Promise<Obj | Obj[] | undefined>;
+    /**
+     * Return true if the graph link refers to at least one object
+     *
+     * - Options:
+     *   - `no_tenancy`: Don't apply tenancy rules.
+     */
+    hasLink<LinkName extends keyof $['graph']['links']>(trx: AnyTrxNode, id: $['#data']['id'], link: LinkName, options?: {
+        no_tenancy?: boolean;
+    }): Promise<boolean | undefined>;
+    /**
+     * Build one object with a view
+     */
+    buildOne<V extends ViewName<$>, Obj extends ViewObj<$, V>>(trx: AnyTrxNode, obj: $['#data'], view: V): Promise<Obj>;
+    /**
+     * Build a list ob objects with a view
+     */
+    buildMany<V extends ViewName<$>, Obj extends ViewObj<$, V>>(trx: AnyTrxNode, objs: $['#data'][], view: V): Promise<Obj[]>;
+    /**
+     * Create an entity
+     */
+    create(trx: AnyTrxNode, obj: CreateObj<$>): Promise<$['#data'] | undefined>;
+    /**
+     * Replace the `$id` symbol on an object with the proper ID value.
+     * This is used on composition, to access the ID of the parent.
+     */
+    private replaceFutureId;
+    /**
+     * Update an entity
+     *
+     * - Options:
+     *   - `mode`: Type of update to perform (default: `patch`)
+     *     - `patch`: Only modifies properties that changed
+     *     - `replace`: Replace the whole object
+     *   - `no_tenancy`: Don't apply tenancy rules (default: `false`)
+     *   - `unsafe`:
+     *     - Don't attempt to read the object before updating. This option is faster, but can throw exceptions directly from the adapter (default: `false`)
+     *     - **WARNING** Unsafe currently avoids the tenancy check
+     */
+    update(trx: AnyTrxNode, obj: PatchObj<$>, options?: {
+        mode?: 'patch' | 'replace';
+        no_tenancy?: boolean;
+        unsafe?: boolean;
+    }): Promise<$['#data'] | undefined>;
+    /**
+     * Create or Replace an entity
+     *
+     * **WARNING** Tenancy not checked
+     */
+    put(trx: AnyTrxNode, obj: PutObj<$>): Promise<$['#data']>;
+    /**
+     * Delete an entity
+     *
+     * - Options:
+     *   - `no_tenancy`: Don't apply tenancy rules (default: `false`)
+     *   - `unsafe`
+     *     - Don't attempt to read the object before updating. This option is faster, but can throw exceptions directly from the adapter (default: `false`)
+     *     - **WARNING** Unsafe currently avoids the tenancy check
+     */
+    delete(trx: AnyTrxNode, id: $['#data']['id'], options?: {
+        no_tenancy?: boolean;
+        unsafe?: boolean;
+    }): Promise<void>;
+    /**
+     * Delete many entities
+     *
+     * - Options:
+     *   - `no_tenancy`: Don't apply tenancy rules (default: `false`)
+     *   - `unsafe`
+     *     - Don't attempt to read the object before updating. This option is faster, but can throw exceptions directly from the adapter (default: `false`)
+     *     - **WARNING** Unsafe currently avoids the tenancy check
+     */
+    deleteMany(trx: AnyTrxNode, ids: $['#data']['id'][], options?: {
+        no_tenancy?: boolean;
+        unsafe?: boolean;
+    }): Promise<void>;
+    /**
+     * Query entities using NQL
+     *
+     * - Options:
+     *   - `no_tenancy`: Don't apply tenancy rules (default: `false`)
+     *   - `params`: NQL parameters
+     */
+    query<V extends ViewName<$>, Obj extends ViewObj<$, V>>(trx: AnyTrxNode, query: NQL_AnyQuery, pagination?: NQL_Pagination, view?: V, options?: {
+        no_tenancy?: boolean;
+        params?: Record<string, any>;
+    }): Promise<NQL_Result<Obj>>;
+    /**
+     * Add `created_by`, `created_at`, `updated_by` and `updated_at` fields to object
+     */
+    protected addMeta(trx: AnyTrxNode, obj: Record<string, any>, operation: 'create' | 'update'): void;
+    getTenancyQuery(trx: AnyTrxNode): import("./query/nql.schema").NQL_Query<any, any> | undefined;
+    protected encrypt(trx: AnyTrxNode, obj: Record<string, any>, fields?: $BucketModelFields): void;
+    protected decrypt(trx: AnyTrxNode, obj: Record<string, any>, fields?: $BucketModelFields): void;
+    /**
+     * Copy all files from the object to the bucket's Drive
+     * - Call `drive.copy` to send the files preserving the local copy
+     * - Replace the file on the object with a new one representing the remote
+     */
+    protected copyFilesToDrive(obj: Record<string, any>): Promise<void>;
 }
 export type AnyBucket = Bucket<$Module, $Bucket>;