nesoi 3.0.8 → 3.0.10

package/lib/elements/edge/controller/controller.js

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Controller = exports.ControllerEndpoint = void 0;
 const cli_controller_adapter_1 = require("./adapters/cli.controller_adapter");
 const trx_node_1 = require("../../../engine/transaction/trx_node");
+/**
+ * @category Elements
+ * @subcategory Edge
+ */
 class ControllerEndpoint {
     constructor(schema, adapter, path) {
         this.schema = schema;
@@ -30,11 +34,11 @@ class ControllerEndpoint {
 }
 exports.ControllerEndpoint = ControllerEndpoint;
 class Controller {
-    constructor(module, schema, config, providers = {}) {
+    constructor(module, schema, config, services = {}) {
         this.schema = schema;
         this.config = config;
-        this.providers = providers;
-        this.adapter = config?.adapter?.(schema, providers) || new cli_controller_adapter_1.CLIControllerAdapter(schema);
+        this.services = services;
+        this.adapter = config?.adapter?.(module.schema, schema, services) || new cli_controller_adapter_1.CLIControllerAdapter(module.schema, schema);
     }
     bind(daemon) {
         this.adapter.bind(daemon);

package/lib/elements/edge/controller/controller.schema.d.ts

@@ -1,6 +1,10 @@
 import { $Message } from "../../entities/message/message.schema";
 import { AnyUsers } from "../../../engine/auth/authn";
 import { $Dependency } from "../../../engine/dependency";
+/**
+ * @category Schemas
+ * @subcategory Edge
+ */
 export declare class $ControllerEndpoint {
     name: string;
     alias: string;
@@ -11,6 +15,10 @@ export declare class $ControllerEndpoint {
     $t: string;
     constructor(name: string, alias: string, authn: string[], tags: string[], msg: $Dependency, target: $Dependency);
 }
+/**
+ * @category Schemas
+ * @subcategory Edge
+ */
 export declare class $ControllerGroup {
     name: string;
     alias: string;
@@ -20,6 +28,10 @@ export declare class $ControllerGroup {
     $t: string;
     constructor(name: string, alias: string, authn: string[], groups?: Record<string, $ControllerGroup>, endpoints?: Record<string, $ControllerEndpoint>);
 }
+/**
+ * @category Schemas
+ * @subcategory Edge
+ */
 export declare class $ControllerDomain extends $ControllerGroup {
     name: string;
     alias: string;
@@ -30,6 +42,10 @@ export declare class $ControllerDomain extends $ControllerGroup {
     $t: string;
     constructor(name: string, alias: string, authn: string[], version: string, groups?: Record<string, $ControllerGroup>, endpoints?: Record<string, $ControllerEndpoint>);
 }
+/**
+ * @category Schemas
+ * @subcategory Edge
+ */
 export declare class $Controller {
     module: string;
     name: string;

package/lib/elements/edge/controller/controller.schema.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.$Controller = exports.$ControllerDomain = exports.$ControllerGroup = exports.$ControllerEndpoint = void 0;
+/**
+ * @category Schemas
+ * @subcategory Edge
+ */
 class $ControllerEndpoint {
     constructor(name, alias, authn, tags, msg, target) {
         this.name = name;
@@ -13,6 +17,10 @@ class $ControllerEndpoint {
     }
 }
 exports.$ControllerEndpoint = $ControllerEndpoint;
+/**
+ * @category Schemas
+ * @subcategory Edge
+ */
 class $ControllerGroup {
     constructor(name, alias, authn, groups = {}, endpoints = {}) {
         this.name = name;
@@ -24,6 +32,10 @@ class $ControllerGroup {
     }
 }
 exports.$ControllerGroup = $ControllerGroup;
+/**
+ * @category Schemas
+ * @subcategory Edge
+ */
 class $ControllerDomain extends $ControllerGroup {
     constructor(name, alias, authn, version, groups = {}, endpoints = {}) {
         super(name, alias, authn, groups, endpoints);
@@ -37,6 +49,10 @@ class $ControllerDomain extends $ControllerGroup {
     }
 }
 exports.$ControllerDomain = $ControllerDomain;
+/**
+ * @category Schemas
+ * @subcategory Edge
+ */
 class $Controller {
     constructor(module, name, alias, authn, input, domains = {}) {
         this.module = module;

package/lib/elements/{blocks → edge}/externals/externals.builder.d.ts

@@ -8,6 +8,10 @@ type MergeAllBuckets<Space extends $Space, Module extends keyof Space['modules']
     };
 }[keyof Modules]>;
 type ExternalBucketRefName<Space extends $Space, M extends keyof Space['modules'], AllBuckets = MergeAllBuckets<Space, M>> = Exclude<keyof AllBuckets, `${M & string}::${string}` | `${string}::${string}::${string}`>;
+/**
+ * @category Builders
+ * @subcategory Edge
+ */
 export declare class ExternalsBuilder<Space extends $Space, ModuleName extends keyof Space['modules']> {
     private module;
     $b: "externals";

package/lib/elements/{blocks → edge}/externals/externals.builder.js

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExternalsBuilder = void 0;
 const externals_schema_1 = require("./externals.schema");
 const dependency_1 = require("../../../engine/dependency");
+/**
+ * @category Builders
+ * @subcategory Edge
+ */
 class ExternalsBuilder {
     constructor(module) {
         this.module = module;

package/lib/elements/{blocks → edge}/externals/externals.schema.d.ts

@@ -1,4 +1,8 @@
 import { $Dependency } from "../../../engine/dependency";
+/**
+ * @category Schemas
+ * @subcategory Edge
+ */
 export declare class $Externals {
     name: string;
     buckets: Record<string, $Dependency>;

package/lib/elements/{blocks → edge}/externals/externals.schema.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.$Externals = void 0;
+/**
+ * @category Schemas
+ * @subcategory Edge
+ */
 class $Externals {
     constructor(name, buckets = {}, jobs = {}, machines = {}) {
         this.name = name;

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

@@ -12,6 +12,10 @@ export type BucketAdapterConfig = {
         updated_by: string;
     };
 };
+/**
+ * @category Adapters
+ * @subcategory Entity
+ * */
 export declare abstract class BucketAdapter<Obj extends NesoiObj> {
     protected schema: $Bucket;
     nql: NQLRunner;
@@ -24,7 +28,8 @@ export declare abstract class BucketAdapter<Obj extends NesoiObj> {
      */
     protected abstract deleteEverything(trx: AnyTrxNode): Promise<void>;
     /**
-     * Return one entity by ID
+     * Return one entity by ID.
+     * - This method MUST NOT throw an exception if not found. The exception is thrown by Nesoi.
      */
     abstract get(trx: AnyTrxNode, id: Obj['id']): Promise<undefined | Obj>;
     /**
@@ -90,19 +95,19 @@ export declare abstract class BucketAdapter<Obj extends NesoiObj> {
      * - If it does, check if it changed since lastObjUpdateEpoch
      *      - If yes, return the updated object
      *      - If not, return null
-     * @returns
-     *  - null: Object hasn't changed
-     *  - Obj: Object has changed
-     *  - 'deleted': Object was deleted
+     * @returns One of the below:
+     *  - `null`: Object hasn't changed
+     *  - `Obj`: Object has changed
+     *  - `deleted`: Object was deleted
      */
     abstract syncOne(trx: AnyTrxNode, id: Obj['id'], lastObjUpdateEpoch: number): Promise<null | 'deleted' | BucketCacheSync<Obj>>;
     /**
      * Given an id, if the object was not deleted and has changed on source,
      * sync the object and all objects of this bucket updated before it.
-     * @returns
-     *  - null: Object hasn't changed
-     *  - Obj[]: Object or past objects changed
-     *  - 'deleted': Object was deleted
+     * @returns One of the below:
+     *  - `null`: Object hasn't changed
+     *  - `Obj[]`: Object or past objects changed
+     *  - `deleted`: Object was deleted
      */
     abstract syncOneAndPast(trx: AnyTrxNode, id: Obj['id'], lastUpdateEpoch: number): Promise<null | 'deleted' | BucketCacheSync<Obj>[]>;
     /**
@@ -110,9 +115,9 @@ export declare abstract class BucketAdapter<Obj extends NesoiObj> {
      * - Hash the ids, check if it matches the incoming hash
      *   - If yes, read all data that changed since last time
      *   - If not, read all data and return a hard resync (previous data will be wiped)
-     @returns
-     *  - null: Cache hasn't changed
-     *  - { data: Obj[], hash: string, hard: true }: Cache has changed
+     @returns One of the below:
+     *  - `null`: Cache hasn't changed
+     *  - `{ data: Obj[], hash: string, hard: true }`: Cache has changed
      */
     abstract syncAll(trx: AnyTrxNode, lastHash?: string, lastUpdateEpoch?: number): Promise<null | {
         sync: BucketCacheSync<Obj>[];
@@ -139,6 +144,7 @@ export declare abstract class BucketAdapter<Obj extends NesoiObj> {
     }[] : Obj[]>>;
     /**
      * Return the epoch of the last update of an object
+     * @param {Obj} obj An object of this bucket
      */
     getUpdateEpoch(obj: Obj): number;
 }

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

@@ -4,6 +4,10 @@ exports.BucketAdapter = void 0;
 const trx_node_1 = require("../../../../engine/transaction/trx_node");
 const error_1 = require("../../../../engine/data/error");
 const nql_compiler_1 = require("../query/nql_compiler");
+/**
+ * @category Adapters
+ * @subcategory Entity
+ * */
 class BucketAdapter {
     constructor(schema, nql, config) {
         this.schema = schema;
@@ -38,6 +42,7 @@ class BucketAdapter {
     }
     /**
      * Return the epoch of the last update of an object
+     * @param {Obj} obj An object of this bucket
      */
     getUpdateEpoch(obj) {
         const objUpdate = obj[this.config.meta.updated_at];

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

@@ -3,6 +3,10 @@ import { ObjWithOptionalId } from "../../../../engine/data/obj";
 import { AnyTrxNode } from "../../../../engine/transaction/trx_node";
 import { $Bucket } from "../../..";
 import { BucketCacheSync } from '../cache/bucket_cache';
+/**
+ * @category Adapters
+ * @subcategory Entity
+ * */
 export declare class MemoryBucketAdapter<B extends $Bucket, Obj extends B['#data']> extends BucketAdapter<Obj> {
     schema: B;
     data: NoInfer<Record<Obj['id'], Obj>>;

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

@@ -4,6 +4,10 @@ exports.MemoryBucketAdapter = void 0;
 const bucket_adapter_1 = require("./bucket_adapter");
 const crypto_1 = require("crypto");
 const memory_nql_1 = require("./memory.nql");
+/**
+ * @category Adapters
+ * @subcategory Entity
+ * */
 class MemoryBucketAdapter extends bucket_adapter_1.BucketAdapter {
     constructor(schema, data = {}, config) {
         const nql = new memory_nql_1.MemoryNQLRunner();

package/lib/elements/entities/bucket/adapters/memory.nql.d.ts

@@ -3,6 +3,9 @@ import { AnyTrxNode } from "../../../../engine/transaction/trx_node";
 import { NQL_Pagination, NQL_Part } from '../query/nql.schema';
 import { AnyMemoryBucketAdapter } from './memory.bucket_adapter';
 type Obj = Record<string, any>;
+/**
+ * @category NQL
+ * */
 export declare class MemoryNQLRunner extends NQLRunner {
     protected adapter?: AnyMemoryBucketAdapter;
     constructor();
@@ -16,7 +19,7 @@ export declare class MemoryNQLRunner extends NQLRunner {
     /**
      * Goes through each rule keeping a scoped white and black list to avoid
      * testing objects unnecessarily. Returns a dict of results by id.
-     * @returns
+     * @returns A dict of results by id
      */
     private filter;
 }

package/lib/elements/entities/bucket/adapters/memory.nql.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MemoryNQLRunner = void 0;
 const nql_engine_1 = require("../query/nql_engine");
 const tree_1 = require("../../../../engine/data/tree");
+/**
+ * @category NQL
+ * */
 class MemoryNQLRunner extends nql_engine_1.NQLRunner {
     constructor() {
         super();
@@ -55,7 +58,7 @@ class MemoryNQLRunner extends nql_engine_1.NQLRunner {
     /**
      * Goes through each rule keeping a scoped white and black list to avoid
      * testing objects unnecessarily. Returns a dict of results by id.
-     * @returns
+     * @returns A dict of results by id
      */
     filter(part, objs, params) {
         const _union = (union, objs, params) => {

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

@@ -14,6 +14,10 @@ import { BucketFieldpathInfer, BucketModelInfer } from './model/bucket_model.inf
 import { Overlay } from "../../../engine/util/type";
 import { $Constants } from '../constants/constants.schema';
 import { NesoiObj } from "../../../engine/data/obj";
+/**
+ * @category Builders
+ * @subcategory Entity
+ * */
 export declare class BucketBuilder<Space extends $Space, Module extends $Module, Bucket extends $Bucket = Omit<$Bucket, 'views'> & {
     views: {};
 }> {

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

@@ -11,6 +11,10 @@ const bucket_graph_link_builder_1 = require("./graph/bucket_graph_link.builder")
 const dependency_1 = require("../../../engine/dependency");
 const constants_schema_1 = require("../constants/constants.schema");
 const error_1 = require("../../../engine/data/error");
+/**
+ * @category Builders
+ * @subcategory Entity
+ * */
 class BucketBuilder {
     constructor(module, name) {
         this.module = module;

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

@@ -2,11 +2,11 @@ import { $Module } from "../..";
 import { BucketAdapter } from './adapters/bucket_adapter';
 import { $Bucket } from './bucket.schema';
 import { DriveAdapter } from '../drive/drive_adapter';
-export type BucketConfig<M extends $Module, B extends $Bucket, Providers extends Record<string, any>> = {
+export type BucketConfig<M extends $Module, B extends $Bucket, Services extends Record<string, any>> = {
     /** Adapter used by this bucket to communicate with a data source */
-    adapter?: (schema: B, providers: Providers) => BucketAdapter<B['#data']>;
+    adapter?: (schema: B, services: Services) => BucketAdapter<B['#data']>;
     /** Drive Adapter used by this bucket to write/read files */
-    drive?: (schema: B, providers: Providers) => DriveAdapter;
+    drive?: (schema: B, services: Services) => 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

@@ -10,23 +10,31 @@ 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';
+import { IService } from "../../../engine/apps/service";
 /**
  * **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.
+ *
+ * @category Elements
+ * @subcategory Entity
  */
 export declare const $id: string | number;
+/**
+ * @category Elements
+ * @subcategory Entity
+ * */
 export declare class Bucket<M extends $Module, $ extends $Bucket> {
     schema: $;
     private config?;
-    providers: Record<string, any>;
+    services: Record<string, IService>;
     adapter: BucketAdapter<$['#data']>;
     private cache?;
     graph: BucketGraph<M, $>;
     private views;
     drive?: DriveAdapter;
-    constructor(schema: $, config?: BucketConfig<any, any, any> | undefined, providers?: Record<string, any>);
+    constructor(schema: $, config?: BucketConfig<any, any, any> | undefined, services?: Record<string, IService>);
     getQueryMeta(): {
         bucket: $;
         scope: string;
@@ -189,9 +197,9 @@ export declare class Bucket<M extends $Module, $ extends $Bucket> {
     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
+     * - Call `drive.upload` to send the files to the drive 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>;
+    protected uploadFilesToDrive(obj: Record<string, any>): Promise<void>;
 }
 export type AnyBucket = Bucket<$Module, $Bucket>;

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

@@ -17,15 +17,22 @@ const bucket_model_schema_1 = require("./model/bucket_model.schema");
  *
  * 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.
+ *
+ * @category Elements
+ * @subcategory Entity
  */
 exports.$id = Symbol('FUTURE ID OF CREATE');
+/**
+ * @category Elements
+ * @subcategory Entity
+ * */
 class Bucket {
-    constructor(schema, config, providers = {}) {
+    constructor(schema, config, services = {}) {
         this.schema = schema;
         this.config = config;
-        this.providers = providers;
+        this.services = services;
         // Config
-        this.adapter = this.config?.adapter?.(schema, providers) || new memory_bucket_adapter_1.MemoryBucketAdapter(schema, {});
+        this.adapter = this.config?.adapter?.(schema, services) || new memory_bucket_adapter_1.MemoryBucketAdapter(schema, {});
         // Graph
         this.graph = new bucket_graph_1.BucketGraph(this);
         // Views
@@ -40,7 +47,7 @@ class Bucket {
         }
         // Drive
         if (this.config?.drive) {
-            this.drive = this.config.drive(schema, providers);
+            this.drive = this.config.drive(schema, services);
         }
     }
     // Getters
@@ -279,7 +286,7 @@ class Bucket {
         }
         // Drive
         if (this.schema.model.hasFileField) {
-            await this.copyFilesToDrive(obj);
+            await this.uploadFilesToDrive(obj);
         }
         // Create
         const input = Object.assign({}, this.schema.model.defaults, obj);
@@ -405,7 +412,7 @@ class Bucket {
         }
         // Drive
         if (this.schema.model.hasFileField) {
-            await this.copyFilesToDrive(obj);
+            await this.uploadFilesToDrive(obj);
         }
         // Patch/Replace
         const mode = options?.mode || 'patch';
@@ -451,7 +458,7 @@ class Bucket {
         }
         // Drive
         if (this.schema.model.hasFileField) {
-            await this.copyFilesToDrive(obj);
+            await this.uploadFilesToDrive(obj);
         }
         // Put
         const _obj = await this.adapter.put(trx, obj);
@@ -711,10 +718,10 @@ class Bucket {
     // Drive (Files)
     /**
      * Copy all files from the object to the bucket's Drive
-     * - Call `drive.copy` to send the files preserving the local copy
+     * - Call `drive.upload` to send the files to the drive preserving the local copy
      * - Replace the file on the object with a new one representing the remote
      */
-    async copyFilesToDrive(obj) {
+    async uploadFilesToDrive(obj) {
         if (!this.drive) {
             throw error_1.NesoiError.Bucket.Drive.NoAdapter({ bucket: this.schema.alias });
         }
@@ -724,13 +731,13 @@ class Bucket {
                 const files = tree_1.Tree.get(obj, field.path);
                 const remoteFiles = [];
                 for (const file of files) {
-                    remoteFiles.push(await this.drive.copy(file, this.drive.dirpath));
+                    remoteFiles.push(await this.drive.upload(file));
                 }
                 tree_1.Tree.set(obj, field.path, () => remoteFiles);
             }
             else {
                 const file = tree_1.Tree.get(obj, field.path);
-                const remoteFile = await this.drive.copy(file, this.drive.dirpath);
+                const remoteFile = await this.drive.upload(file);
                 tree_1.Tree.set(obj, field.path, () => remoteFile);
             }
         }

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

@@ -8,6 +8,10 @@ import { NQL_Query } from './query/nql.schema';
 export type $BucketTenancy<M extends $Module, B extends $Bucket> = {
     [K in keyof M['#authn']]?: (user: M['#authn'][K]) => NQL_Query<M, B>;
 };
+/**
+ * @category Schemas
+ * @subcategory Entity
+ * */
 export declare class $Bucket {
     module: string;
     name: string;

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

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.$Bucket = void 0;
+/**
+ * @category Schemas
+ * @subcategory Entity
+ * */
 class $Bucket {
     constructor(module, name, alias, model, graph, views, tenancy, extended) {
         this.module = module;

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

@@ -9,6 +9,10 @@ export type BucketCacheSync<T> = {
     obj: T;
     updateEpoch: number;
 };
+/**
+ * @category Elements
+ * @subcategory Entity
+ * */
 export declare class BucketCacheEntry<Obj extends NesoiObj> {
     id: Obj['id'];
     obj: Obj;
@@ -16,6 +20,10 @@ export declare class BucketCacheEntry<Obj extends NesoiObj> {
     syncEpoch: number;
     constructor(id: Obj['id'], obj: Obj, updateEpoch: number, syncEpoch: number);
 }
+/**
+ * @category Elements
+ * @subcategory Entity
+ * */
 export declare class BucketCache<Obj extends NesoiObj> {
     private bucketName;
     private outerAdapter;

package/lib/elements/entities/bucket/cache/bucket_cache.js

@@ -4,6 +4,10 @@ exports.BucketCache = exports.BucketCacheEntry = void 0;
 const log_1 = require("../../../../engine/util/log");
 const memory_bucket_adapter_1 = require("../adapters/memory.bucket_adapter");
 const datetime_1 = require("../../../../engine/data/datetime");
+/**
+ * @category Elements
+ * @subcategory Entity
+ * */
 class BucketCacheEntry {
     constructor(id, obj, updateEpoch, syncEpoch) {
         this.id = id;
@@ -13,6 +17,10 @@ class BucketCacheEntry {
     }
 }
 exports.BucketCacheEntry = BucketCacheEntry;
+/**
+ * @category Elements
+ * @subcategory Entity
+ * */
 class BucketCache {
     constructor(bucketName, outerAdapter, config) {
         this.bucketName = bucketName;

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

@@ -3,6 +3,10 @@ import { $BucketGraph } from './bucket_graph.schema';
 import { BucketGraphLinkBuilders, BucketGraphLinkFactory } from './bucket_graph_link.builder';
 import { BucketBuilderNode } from '../bucket.builder';
 import { $Bucket } from '../bucket.schema';
+/**
+ * @category Builders
+ * @subcategory Entity
+ * */
 export declare class BucketGraphBuilder<Module extends $Module> {
     private _links;
     links(builders: BucketGraphLinkBuilders): this;

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

@@ -6,6 +6,10 @@ const bucket_graph_link_builder_1 = require("./bucket_graph_link.builder");
 /*
     Builder
 */
+/**
+ * @category Builders
+ * @subcategory Entity
+ * */
 class BucketGraphBuilder {
     constructor() {
         this._links = {};

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

@@ -2,6 +2,10 @@ import { AnyTrxNode } from "../../../../engine/transaction/trx_node";
 import { $Module, ViewName, ViewObj } from "../../../../schema";
 import { Bucket } from '../bucket';
 import { $Bucket } from '../bucket.schema';
+/**
+ * @category Elements
+ * @subcategory Entity
+ * */
 export declare class BucketGraph<M extends $Module, $ extends $Bucket> {
     private bucket;
     private bucketName;

package/lib/elements/entities/bucket/graph/bucket_graph.js

@@ -4,6 +4,10 @@ exports.BucketGraph = void 0;
 const trx_node_1 = require("../../../../engine/transaction/trx_node");
 const log_1 = require("../../../../engine/util/log");
 const error_1 = require("../../../../engine/data/error");
+/**
+ * @category Elements
+ * @subcategory Entity
+ * */
 class BucketGraph {
     constructor(bucket) {
         this.bucket = bucket;

package/lib/elements/entities/bucket/graph/bucket_graph.schema.d.ts

@@ -1,6 +1,10 @@
 import { $Dependency } from "../../../../engine/dependency";
 import { $Bucket } from '../bucket.schema';
 import { NQL_AnyQuery } from '../query/nql.schema';
+/**
+ * @category Schemas
+ * @subcategory Entity
+ * */
 export declare class $BucketGraphLink {
     name: string;
     alias: string;
@@ -18,6 +22,10 @@ export declare class $BucketGraphLink {
 export type $BucketGraphLinks = {
     [x: string]: $BucketGraphLink;
 };
+/**
+ * @category Schemas
+ * @subcategory Entity
+ * */
 export declare class $BucketGraph {
     links: $BucketGraphLinks;
     $t: string;

package/lib/elements/entities/bucket/graph/bucket_graph.schema.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.$BucketGraph = exports.$BucketGraphLink = void 0;
+/**
+ * @category Schemas
+ * @subcategory Entity
+ * */
 class $BucketGraphLink {
     constructor(name, alias, bucket, rel, many, optional, keyOwner, query) {
         this.name = name;
@@ -15,6 +19,10 @@ class $BucketGraphLink {
     }
 }
 exports.$BucketGraphLink = $BucketGraphLink;
+/**
+ * @category Schemas
+ * @subcategory Entity
+ * */
 class $BucketGraph {
     constructor(links = {}) {
         this.links = links;