nesoi 3.0.8 → 3.0.9

package/lib/elements/blocks/machine/machine.schema.js

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.$MachineJobScope = exports.$Machine = exports.$MachineState = exports.$MachineTransition = void 0;
 const block_schema_1 = require("../block.schema");
 // Transition
+/**
+ * @category Schemas
+ * @subcategory Block
+ */
 class $MachineTransition extends block_schema_1.$Block {
     constructor(module, name, alias, authn, msg, from, to, condition, jobs = []) {
         super(module, name, alias, authn, [msg], {});
@@ -20,6 +24,10 @@ class $MachineTransition extends block_schema_1.$Block {
 }
 exports.$MachineTransition = $MachineTransition;
 // State
+/**
+ * @category Schemas
+ * @subcategory Block
+ */
 class $MachineState extends block_schema_1.$Block {
     constructor(module, name, alias, authn, initial, final, inputEnter, inputLeave, jobs) {
         super(module, name, alias, authn, [...inputEnter, ...inputLeave], {});
@@ -36,7 +44,10 @@ class $MachineState extends block_schema_1.$Block {
     }
 }
 exports.$MachineState = $MachineState;
-// Machine
+/**
+ * @category Schemas
+ * @subcategory Block
+ */
 class $Machine extends block_schema_1.$Block {
     constructor(module, name, alias, authn, input, buckets, stateField, states, transitions, stateAliasField, logger) {
         super(module, name, alias, authn, input, {});
@@ -55,6 +66,10 @@ class $Machine extends block_schema_1.$Block {
     }
 }
 exports.$Machine = $Machine;
+/**
+ * @category Schemas
+ * @subcategory Block
+ */
 class $MachineJobScope {
     constructor(module, machine) {
         this.module = module;

package/lib/elements/blocks/machine/machine_state.builder.d.ts

@@ -6,6 +6,10 @@ import { BlockBuilder } from '../block.builder';
 import { $Job } from '../job/job.schema';
 import { AnyMachineBuilder } from './machine.builder';
 import { MachineJobDef } from '../job/internal/machine_job.builder';
+/**
+ * @category Builders
+ * @subcategory Block
+ */
 export declare class MachineStateBuilder<S extends $Space, M extends $Module, $M extends $Machine, $ extends $MachineState = $MachineState> extends BlockBuilder<S, M, 'machine'> {
     private machine;
     private _initial;

package/lib/elements/blocks/machine/machine_state.builder.js

@@ -7,6 +7,10 @@ const dependency_1 = require("../../../engine/dependency");
 const block_builder_1 = require("../block.builder");
 const name_helpers_1 = require("../../../compiler/helpers/name_helpers");
 const machine_job_builder_1 = require("../job/internal/machine_job.builder");
+/**
+ * @category Builders
+ * @subcategory Block
+ */
 class MachineStateBuilder extends block_builder_1.BlockBuilder {
     constructor(machine, module, name, _initial = false) {
         super(module, 'machine', name);

package/lib/elements/blocks/machine/machine_transition.builder.d.ts

@@ -11,6 +11,10 @@ import { MachineJobDef } from '../job/internal/machine_job.builder';
 type JobWithMatchingInput<M extends $Module, Input extends $Message> = {
     [J in keyof M['jobs']]: Input extends M['jobs'][J]['#input'] ? J : never;
 }[keyof M['jobs']];
+/**
+ * @category Builders
+ * @subcategory Block
+ */
 export declare class MachineTransitionBuilder<S extends $Space, M extends $Module, $M extends $Machine, $ extends $MachineTransition = $MachineTransition> extends BlockBuilder<S, M, 'machine'> {
     private machine;
     private _from;

package/lib/elements/blocks/machine/machine_transition.builder.js

@@ -5,6 +5,10 @@ const machine_schema_1 = require("./machine.schema");
 const dependency_1 = require("../../../engine/dependency");
 const block_builder_1 = require("../block.builder");
 const machine_job_builder_1 = require("../job/internal/machine_job.builder");
+/**
+ * @category Builders
+ * @subcategory Block
+ */
 class MachineTransitionBuilder extends block_builder_1.BlockBuilder {
     constructor(machine, module, _from, _msg, index = 0) {
         super(module, 'machine', `${_from}~${_msg.refName}`);

package/lib/elements/blocks/queue/adapters/bucket.queue_adapter.d.ts

@@ -2,6 +2,10 @@ import { $Module } from "../../../../schema";
 import { QueueAdapter } from './queue_adapter';
 import { AnyMessage } from "../../../entities/message/message";
 import { AnyTrxNode } from "../../../../engine/transaction/trx_node";
+/**
+ * @category Adapters
+ * @subcategory Block
+ */
 export declare class BucketQueueAdapter<M extends $Module> extends QueueAdapter {
     protected bucket: keyof M['buckets'];
     constructor(bucket: keyof M['buckets']);

package/lib/elements/blocks/queue/adapters/bucket.queue_adapter.js

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BucketQueueAdapter = void 0;
 const queue_adapter_1 = require("./queue_adapter");
+/**
+ * @category Adapters
+ * @subcategory Block
+ */
 class BucketQueueAdapter extends queue_adapter_1.QueueAdapter {
     constructor(bucket) {
         super();

package/lib/elements/blocks/queue/adapters/queue_adapter.d.ts

@@ -1,5 +1,9 @@
 import { AnyTrxNode } from "../../../../engine/transaction/trx_node";
 import { AnyMessage } from "../../../entities/message/message";
+/**
+ * @category Adapters
+ * @subcategory Block
+ */
 export declare abstract class QueueAdapter {
     abstract push(trx: AnyTrxNode, message: AnyMessage): Promise<void>;
     abstract pop(trx: AnyTrxNode): Promise<AnyMessage | undefined>;

package/lib/elements/blocks/queue/adapters/queue_adapter.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.QueueAdapter = void 0;
+/**
+ * @category Adapters
+ * @subcategory Block
+ */
 class QueueAdapter {
 }
 exports.QueueAdapter = QueueAdapter;

package/lib/elements/blocks/queue/queue.builder.d.ts

@@ -6,6 +6,10 @@ import { Overlay } from "../../../engine/util/type";
 import { MultiMessageTemplateDef } from "../../entities/message/template/message_template.builder";
 import { $MessageInfer } from "../../entities/message/message.infer";
 import { ModuleTree } from "../../../engine/tree";
+/**
+ * @category Builders
+ * @subcategory Block
+ */
 export declare class QueueBuilder<Space extends $Space, M extends $Module, $ extends $Queue> extends BlockBuilder<Space, M, 'queue'> {
     $b: "queue";
     constructor(module: string, name: string);

package/lib/elements/blocks/queue/queue.builder.js

@@ -4,6 +4,10 @@ exports.QueueBuilder = void 0;
 const queue_schema_1 = require("./queue.schema");
 const block_builder_1 = require("../block.builder");
 const message_builder_1 = require("../../entities/message/message.builder");
+/**
+ * @category Builders
+ * @subcategory Block
+ */
 class QueueBuilder extends block_builder_1.BlockBuilder {
     constructor(module, name) {
         super(module, 'queue', name);

package/lib/elements/blocks/queue/queue.schema.d.ts

@@ -1,5 +1,9 @@
 import { $Dependency } from "../../../engine/dependency";
 import { $Block } from '../block.schema';
+/**
+ * @category Schemas
+ * @subcategory Block
+ */
 export declare class $Queue extends $Block {
     module: string;
     name: string;

package/lib/elements/blocks/queue/queue.schema.js

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.$Queue = void 0;
 const block_schema_1 = require("../block.schema");
+/**
+ * @category Schemas
+ * @subcategory Block
+ */
 class $Queue extends block_schema_1.$Block {
     constructor(module, name, alias, authn, msgs) {
         super(module, name, alias, authn, msgs, {});

package/lib/elements/blocks/resource/resource.builder.d.ts

@@ -11,6 +11,10 @@ import { $Bucket } from "../../entities/bucket/bucket.schema";
 import { CreateObj, PatchResourceObj } from "../../entities/bucket/bucket.types";
 import { Overlay } from "../../../engine/util/type";
 import { $MessageInferFromData } from "../../entities/message/message.infer";
+/**
+ * @category Builders
+ * @subcategory Block
+ */
 export declare class ResourceBuilder<Space extends $Space, Module extends $Module, Resource extends $Resource> extends BlockBuilder<Space, Module, 'resource'> {
     $b: "resource";
     private _jobs;

package/lib/elements/blocks/resource/resource.builder.js

@@ -12,6 +12,10 @@ const name_helpers_1 = require("../../../compiler/helpers/name_helpers");
 const job_builder_1 = require("../job/job.builder");
 const resource_1 = require("./resource");
 const resource_job_1 = require("../job/internal/resource_job");
+/**
+ * @category Builders
+ * @subcategory Block
+ */
 class ResourceBuilder extends block_builder_1.BlockBuilder {
     constructor(module, name) {
         super(module, 'resource', name);

package/lib/elements/blocks/resource/resource.d.ts

@@ -8,6 +8,10 @@ import { AnyTrxNode, TrxNode } from "../../../engine/transaction/trx_node";
 import { $Dependency } from "../../../engine/dependency";
 import { ResourceAssertions } from '../job/internal/resource_job.builder';
 import { $Job } from '../job/job.schema';
+/**
+ * @category Elements
+ * @subcategory Block
+ */
 export declare class Resource<S extends $Space, M extends $Module, $ extends $Resource> extends Block<S, M, $> {
     module: Module<S, M>;
     schema: $;

package/lib/elements/blocks/resource/resource.js

@@ -4,6 +4,10 @@ exports.Resource = void 0;
 const block_1 = require("../block");
 const trx_node_1 = require("../../../engine/transaction/trx_node");
 const error_1 = require("../../../engine/data/error");
+/**
+ * @category Elements
+ * @subcategory Block
+ */
 class Resource extends block_1.Block {
     constructor(module, schema) {
         super('resource', module, schema);

package/lib/elements/blocks/resource/resource.schema.d.ts

@@ -2,6 +2,10 @@ import { $Block } from "../block.schema";
 import { $Bucket } from "../../entities/bucket/bucket.schema";
 import { $Message } from "../../entities/message/message.schema";
 import { $Dependency } from "../../../engine/dependency";
+/**
+ * @category Schemas
+ * @subcategory Block
+ */
 export declare class $Resource extends $Block {
     module: string;
     name: string;

package/lib/elements/blocks/resource/resource.schema.js

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.$Resource = void 0;
 const block_schema_1 = require("../block.schema");
 const dependency_1 = require("../../../engine/dependency");
+/**
+ * @category Schemas
+ * @subcategory Block
+ */
 class $Resource extends block_schema_1.$Block {
     constructor(module, name, alias, authn, bucket, jobs) {
         const input = [];

package/lib/elements/edge/controller/adapters/cli.controller_adapter.d.ts

@@ -2,6 +2,10 @@ import { ControllerAdapter } from './controller_adapter';
 import { ControllerEndpoint } from '../controller';
 import { $ControllerDomain, $ControllerEndpoint, $ControllerGroup } from '../controller.schema';
 export type ControllerEndpointPath = ($ControllerDomain | $ControllerGroup | $ControllerEndpoint)[];
+/**
+ * @category Adapters
+ * @subcategory Edge
+ */
 export declare class CLIControllerAdapter extends ControllerAdapter {
     endpoints: Record<string, ControllerEndpoint<$ControllerEndpoint>>;
     protected makeEndpoint(path: string, schema: $ControllerEndpoint): void;

package/lib/elements/edge/controller/adapters/cli.controller_adapter.js

@@ -4,6 +4,10 @@ exports.CLIControllerAdapter = void 0;
 const controller_adapter_1 = require("./controller_adapter");
 const controller_1 = require("../controller");
 const log_1 = require("../../../../engine/util/log");
+/**
+ * @category Adapters
+ * @subcategory Edge
+ */
 class CLIControllerAdapter extends controller_adapter_1.ControllerAdapter {
     constructor() {
         super(...arguments);

package/lib/elements/edge/controller/adapters/controller_adapter.d.ts

@@ -3,6 +3,10 @@ import { $Controller, $ControllerDomain, $ControllerEndpoint, $ControllerGroup }
 import { AnyDaemon } from "../../../../engine/daemon";
 import { AuthnRequest } from "../../../../engine/auth/authn";
 export type ControllerEndpointPath = ($ControllerDomain | $ControllerGroup | $ControllerEndpoint)[];
+/**
+ * @category Adapters
+ * @subcategory Edge
+ */
 export declare abstract class ControllerAdapter {
     protected schema: $Controller;
     protected daemon?: AnyDaemon;

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

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ControllerAdapter = void 0;
 const log_1 = require("../../../../engine/util/log");
+/**
+ * @category Adapters
+ * @subcategory Edge
+ */
 class ControllerAdapter {
     constructor(schema) {
         this.schema = schema;

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

@@ -11,6 +11,10 @@ type ResourcesSupportingMsg<M extends $Module, Msg extends $Message> = {
 type MachinesSupportingMsg<M extends $Module, Msg extends $Message> = {
     [J in keyof M['machines']]: Msg extends M['machines'][J]['#input'] ? J : never;
 }[keyof M['machines']];
+/**
+ * @category Builders
+ * @subcategory Edge
+ */
 export declare class ControllerEndpointBuilder<S extends $Space, M extends $Module, Msg extends $Message = never> {
     private module;
     private name;
@@ -30,6 +34,10 @@ export declare class ControllerEndpointBuilder<S extends $Space, M extends $Modu
     toMachine(machine: MachinesSupportingMsg<M, Msg>): this;
     static build(builder: ControllerEndpointBuilder<any, any>): $ControllerEndpoint;
 }
+/**
+ * @category Builders
+ * @subcategory Edge
+ */
 export declare class ControllerGroupBuilder<S extends $Space, M extends $Module> {
     private module;
     protected name: string;
@@ -46,11 +54,19 @@ export declare class ControllerGroupBuilder<S extends $Space, M extends $Module>
     static buildGroups(builders: Record<string, ControllerGroupBuilder<any, any>>): Record<string, $ControllerGroup>;
     static buildEndpoints(builders: Record<string, ControllerEndpointBuilder<any, any>>): Record<string, $ControllerEndpoint>;
 }
+/**
+ * @category Builders
+ * @subcategory Edge
+ */
 export declare class ControllerDomainBuilder<S extends $Space, M extends $Module> extends ControllerGroupBuilder<S, M> {
     private _version;
     version(version: string): this;
     static build(builder: ControllerDomainBuilder<any, any>): $ControllerDomain;
 }
+/**
+ * @category Builders
+ * @subcategory Edge
+ */
 export declare class ControllerBuilder<S extends $Space, M extends $Module> {
     private module;
     private name;

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

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ControllerBuilder = exports.ControllerDomainBuilder = exports.ControllerGroupBuilder = exports.ControllerEndpointBuilder = void 0;
 const controller_schema_1 = require("./controller.schema");
 const dependency_1 = require("../../../engine/dependency");
+/**
+ * @category Builders
+ * @subcategory Edge
+ */
 class ControllerEndpointBuilder {
     constructor(module, name, _authn = []) {
         this.module = module;
@@ -50,6 +54,10 @@ class ControllerEndpointBuilder {
     }
 }
 exports.ControllerEndpointBuilder = ControllerEndpointBuilder;
+/**
+ * @category Builders
+ * @subcategory Edge
+ */
 class ControllerGroupBuilder {
     constructor(module, name, _authn = []) {
         this.module = module;
@@ -104,6 +112,10 @@ class ControllerGroupBuilder {
     }
 }
 exports.ControllerGroupBuilder = ControllerGroupBuilder;
+/**
+ * @category Builders
+ * @subcategory Edge
+ */
 class ControllerDomainBuilder extends ControllerGroupBuilder {
     constructor() {
         super(...arguments);
@@ -119,6 +131,10 @@ class ControllerDomainBuilder extends ControllerGroupBuilder {
     }
 }
 exports.ControllerDomainBuilder = ControllerDomainBuilder;
+/**
+ * @category Builders
+ * @subcategory Edge
+ */
 class ControllerBuilder {
     constructor(module, name) {
         this.module = module;

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

@@ -5,6 +5,10 @@ import { ControllerAdapter } from './adapters/controller_adapter';
 import { ControllerConfig } from './controller.config';
 import { AnyDaemon } from "../../../engine/daemon";
 import { AuthnRequest } from "../../../engine/auth/authn";
+/**
+ * @category Elements
+ * @subcategory Edge
+ */
 export declare class ControllerEndpoint<$ extends $ControllerEndpoint> {
     schema: $;
     adapter: ControllerAdapter;

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;

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;
@@ -90,19 +94,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 +114,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 +143,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();