@xyo-network/archivist-abstract 3.8.0 → 3.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/neutral/index.d.ts +70 -2
  2. package/package.json +11 -11
  3. package/dist/neutral/AbstractArchivist.d.ts +0 -67
  4. package/dist/neutral/AbstractArchivist.d.ts.map +0 -1
  5. package/dist/neutral/index.d.ts.map +0 -1
package/dist/neutral/index.d.ts CHANGED
@@ -1,2 +1,70 @@
1
- export * from './AbstractArchivist.ts';
2
- //# sourceMappingURL=index.d.ts.map
1
+ import * as _xylabs_object from '@xylabs/object';
2
+ import { Hash } from '@xylabs/hex';
3
+ import { PromisableArray, Promisable } from '@xylabs/promise';
4
+ import { AccountInstance } from '@xyo-network/account-model';
5
+ import { ArchivistInstance, ArchivistParams, ArchivistModuleEventData, AttachableArchivistInstance, ArchivistNextOptions } from '@xyo-network/archivist-model';
6
+ import { BoundWitness, QueryBoundWitness } from '@xyo-network/boundwitness-model';
7
+ import { QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper';
8
+ import { AbstractModuleInstance } from '@xyo-network/module-abstract';
9
+ import { ModuleQueryResult, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module-model';
10
+ import { Payload, Schema, WithStorageMeta } from '@xyo-network/payload-model';
11
+
12
+ interface ActionConfig {
13
+ emitEvents?: boolean;
14
+ }
15
+ interface InsertConfig extends ActionConfig {
16
+ writeToParents?: boolean;
17
+ }
18
+ interface ArchivistParentInstances {
19
+ commit?: Record<string, ArchivistInstance>;
20
+ read?: Record<string, ArchivistInstance>;
21
+ write?: Record<string, ArchivistInstance>;
22
+ }
23
+ declare abstract class AbstractArchivist<TParams extends ArchivistParams = ArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData> extends AbstractModuleInstance<TParams, TEventData> implements AttachableArchivistInstance<TParams, TEventData, Payload> {
24
+ static readonly configSchemas: Schema[];
25
+ static readonly defaultConfigSchema: Schema;
26
+ static readonly uniqueName: string;
27
+ protected static defaultNextLimitSetting: number;
28
+ private _parentArchivists?;
29
+ static get defaultNextLimit(): number;
30
+ get queries(): string[];
31
+ get requireAllParents(): boolean;
32
+ protected get storeParentReads(): boolean;
33
+ all(): PromisableArray<WithStorageMeta<Payload>>;
34
+ allQuery(account: AccountInstance): Promise<ModuleQueryResult>;
35
+ clear(): Promisable<void>;
36
+ clearQuery(account: AccountInstance): Promise<ModuleQueryResult>;
37
+ commit(): Promisable<BoundWitness[]>;
38
+ commitQuery(account: AccountInstance): Promise<ModuleQueryResult>;
39
+ delete(hashes: Hash[]): Promise<Hash[]>;
40
+ deleteQuery(hashes: Hash[], account?: AccountInstance): Promise<ModuleQueryResult>;
41
+ get(hashes: Hash[]): Promise<WithStorageMeta<Payload>[]>;
42
+ getQuery(hashes: Hash[], account?: AccountInstance): Promise<ModuleQueryResult>;
43
+ insert(payloads: Payload[]): Promise<WithStorageMeta<Payload>[]>;
44
+ insertQuery(payloads: Payload[], account?: AccountInstance): Promise<ModuleQueryResult>;
45
+ next(options?: ArchivistNextOptions): Promise<WithStorageMeta<Payload>[]>;
46
+ nextQuery(options?: ArchivistNextOptions, account?: AccountInstance): Promise<ModuleQueryResult>;
47
+ protected allHandler(): PromisableArray<WithStorageMeta<Payload>>;
48
+ protected clearHandler(): Promisable<void>;
49
+ protected commitHandler(): Promisable<BoundWitness[]>;
50
+ protected deleteHandler(_hashes: Hash[]): PromisableArray<Hash>;
51
+ protected deleteWithConfig(hashes: Hash[], config?: ActionConfig): Promise<Hash[]>;
52
+ protected getFromParent(hashes: Hash[], archivist: ArchivistInstance): Promise<[WithStorageMeta<Payload>[], Hash[]]>;
53
+ protected getFromParents(hashes: Hash[]): Promise<[WithStorageMeta<Payload>[], Hash[]]>;
54
+ protected getHandler(_hashes: Hash[]): Promisable<WithStorageMeta<Payload>[]>;
55
+ protected getWithConfig(hashes: Hash[], _config?: InsertConfig): Promise<WithStorageMeta<Payload>[]>;
56
+ protected insertHandler(_payloads: WithStorageMeta<Payload>[]): Promisable<WithStorageMeta<Payload>[]>;
57
+ protected insertQueryHandler<T extends QueryBoundWitnessWrapper = QueryBoundWitnessWrapper>(query: T, payloads?: Payload[]): Promise<WithStorageMeta<_xylabs_object.DeepRestrictToStringKeys<{
58
+ schema: Schema;
59
+ }>>[]>;
60
+ protected insertWithConfig(payloads: Payload[], config?: InsertConfig): Promise<WithStorageMeta<Payload>[]>;
61
+ protected nextHandler(_options?: ArchivistNextOptions): Promisable<WithStorageMeta<Payload>[]>;
62
+ protected nextWithConfig(options?: ArchivistNextOptions, _config?: InsertConfig): Promise<WithStorageMeta<Payload>[]>;
63
+ protected parentArchivists(): Promise<ArchivistParentInstances>;
64
+ protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads: Payload[], queryConfig?: TConfig): Promise<ModuleQueryHandlerResult>;
65
+ protected writeToParent(parent: ArchivistInstance, payloads: Payload[]): Promise<Payload[]>;
66
+ protected writeToParents(payloads: Payload[]): Promise<Payload[]>;
67
+ private resolveArchivists;
68
+ }
69
+
70
+ export { AbstractArchivist, type ActionConfig, type ArchivistParentInstances, type InsertConfig };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/archivist-abstract",
3
- "version": "3.8.0",
3
+ "version": "3.8.2",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -35,18 +35,18 @@
35
35
  "@xylabs/object": "^4.5.1",
36
36
  "@xylabs/promise": "^4.5.1",
37
37
  "@xylabs/set": "^4.5.1",
38
- "@xyo-network/account-model": "^3.8.0",
39
- "@xyo-network/archivist-model": "^3.8.0",
40
- "@xyo-network/boundwitness-model": "^3.8.0",
41
- "@xyo-network/boundwitness-wrapper": "^3.8.0",
42
- "@xyo-network/module-abstract": "^3.8.0",
43
- "@xyo-network/module-model": "^3.8.0",
44
- "@xyo-network/payload-builder": "^3.8.0",
45
- "@xyo-network/payload-model": "^3.8.0"
38
+ "@xyo-network/account-model": "^3.8.2",
39
+ "@xyo-network/archivist-model": "^3.8.2",
40
+ "@xyo-network/boundwitness-model": "^3.8.2",
41
+ "@xyo-network/boundwitness-wrapper": "^3.8.2",
42
+ "@xyo-network/module-abstract": "^3.8.2",
43
+ "@xyo-network/module-model": "^3.8.2",
44
+ "@xyo-network/payload-builder": "^3.8.2",
45
+ "@xyo-network/payload-model": "^3.8.2"
46
46
  },
47
47
  "devDependencies": {
48
- "@xylabs/ts-scripts-yarn3": "^4.2.6",
49
- "@xylabs/tsconfig": "^4.2.6",
48
+ "@xylabs/ts-scripts-yarn3": "^5.0.22",
49
+ "@xylabs/tsconfig": "^5.0.22",
50
50
  "typescript": "^5.7.3"
51
51
  },
52
52
  "publishConfig": {
package/dist/neutral/AbstractArchivist.d.ts DELETED
@@ -1,67 +0,0 @@
1
- import { type Hash } from '@xylabs/hex';
2
- import type { Promisable, PromisableArray } from '@xylabs/promise';
3
- import type { AccountInstance } from '@xyo-network/account-model';
4
- import type { ArchivistInstance, ArchivistModuleEventData, ArchivistNextOptions, ArchivistParams, AttachableArchivistInstance } from '@xyo-network/archivist-model';
5
- import type { BoundWitness, QueryBoundWitness } from '@xyo-network/boundwitness-model';
6
- import { QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper';
7
- import { AbstractModuleInstance } from '@xyo-network/module-abstract';
8
- import type { ModuleConfig, ModuleQueryHandlerResult, ModuleQueryResult } from '@xyo-network/module-model';
9
- import type { Payload, Schema, WithStorageMeta } from '@xyo-network/payload-model';
10
- export interface ActionConfig {
11
- emitEvents?: boolean;
12
- }
13
- export interface InsertConfig extends ActionConfig {
14
- writeToParents?: boolean;
15
- }
16
- export interface ArchivistParentInstances {
17
- commit?: Record<string, ArchivistInstance>;
18
- read?: Record<string, ArchivistInstance>;
19
- write?: Record<string, ArchivistInstance>;
20
- }
21
- export declare abstract class AbstractArchivist<TParams extends ArchivistParams = ArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData> extends AbstractModuleInstance<TParams, TEventData> implements AttachableArchivistInstance<TParams, TEventData, Payload> {
22
- static readonly configSchemas: Schema[];
23
- static readonly defaultConfigSchema: Schema;
24
- static readonly uniqueName: string;
25
- protected static defaultNextLimitSetting: number;
26
- private _parentArchivists?;
27
- static get defaultNextLimit(): number;
28
- get queries(): string[];
29
- get requireAllParents(): boolean;
30
- protected get storeParentReads(): boolean;
31
- all(): PromisableArray<WithStorageMeta<Payload>>;
32
- allQuery(account: AccountInstance): Promise<ModuleQueryResult>;
33
- clear(): Promisable<void>;
34
- clearQuery(account: AccountInstance): Promise<ModuleQueryResult>;
35
- commit(): Promisable<BoundWitness[]>;
36
- commitQuery(account: AccountInstance): Promise<ModuleQueryResult>;
37
- delete(hashes: Hash[]): Promise<Hash[]>;
38
- deleteQuery(hashes: Hash[], account?: AccountInstance): Promise<ModuleQueryResult>;
39
- get(hashes: Hash[]): Promise<WithStorageMeta<Payload>[]>;
40
- getQuery(hashes: Hash[], account?: AccountInstance): Promise<ModuleQueryResult>;
41
- insert(payloads: Payload[]): Promise<WithStorageMeta<Payload>[]>;
42
- insertQuery(payloads: Payload[], account?: AccountInstance): Promise<ModuleQueryResult>;
43
- next(options?: ArchivistNextOptions): Promise<WithStorageMeta<Payload>[]>;
44
- nextQuery(options?: ArchivistNextOptions, account?: AccountInstance): Promise<ModuleQueryResult>;
45
- protected allHandler(): PromisableArray<WithStorageMeta<Payload>>;
46
- protected clearHandler(): Promisable<void>;
47
- protected commitHandler(): Promisable<BoundWitness[]>;
48
- protected deleteHandler(_hashes: Hash[]): PromisableArray<Hash>;
49
- protected deleteWithConfig(hashes: Hash[], config?: ActionConfig): Promise<Hash[]>;
50
- protected getFromParent(hashes: Hash[], archivist: ArchivistInstance): Promise<[WithStorageMeta<Payload>[], Hash[]]>;
51
- protected getFromParents(hashes: Hash[]): Promise<[WithStorageMeta<Payload>[], Hash[]]>;
52
- protected getHandler(_hashes: Hash[]): Promisable<WithStorageMeta<Payload>[]>;
53
- protected getWithConfig(hashes: Hash[], _config?: InsertConfig): Promise<WithStorageMeta<Payload>[]>;
54
- protected insertHandler(_payloads: WithStorageMeta<Payload>[]): Promisable<WithStorageMeta<Payload>[]>;
55
- protected insertQueryHandler<T extends QueryBoundWitnessWrapper = QueryBoundWitnessWrapper>(query: T, payloads?: Payload[]): Promise<WithStorageMeta<import("@xylabs/object").DeepRestrictToStringKeys<{
56
- schema: Schema;
57
- }>>[]>;
58
- protected insertWithConfig(payloads: Payload[], config?: InsertConfig): Promise<WithStorageMeta<Payload>[]>;
59
- protected nextHandler(_options?: ArchivistNextOptions): Promisable<WithStorageMeta<Payload>[]>;
60
- protected nextWithConfig(options?: ArchivistNextOptions, _config?: InsertConfig): Promise<WithStorageMeta<Payload>[]>;
61
- protected parentArchivists(): Promise<ArchivistParentInstances>;
62
- protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads: Payload[], queryConfig?: TConfig): Promise<ModuleQueryHandlerResult>;
63
- protected writeToParent(parent: ArchivistInstance, payloads: Payload[]): Promise<Payload[]>;
64
- protected writeToParents(payloads: Payload[]): Promise<Payload[]>;
65
- private resolveArchivists;
66
- }
67
- //# sourceMappingURL=AbstractArchivist.d.ts.map
package/dist/neutral/AbstractArchivist.d.ts.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"AbstractArchivist.d.ts","sourceRoot":"","sources":["../../src/AbstractArchivist.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,aAAa,CAAA;AAEvC,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAElE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AACjE,OAAO,KAAK,EAOV,iBAAiB,EACjB,wBAAwB,EACxB,oBAAoB,EAEpB,eAAe,EAEf,2BAA2B,EAC5B,MAAM,8BAA8B,CAAA;AAarC,OAAO,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACtF,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAA;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,KAAK,EACV,YAAY,EAAoB,wBAAwB,EAAE,iBAAiB,EAC5E,MAAM,2BAA2B,CAAA;AAGlC,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EAAE,eAAe,EACjC,MAAM,4BAA4B,CAAA;AAInC,MAAM,WAAW,YAAY;IAC3B,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;CAC1C;AAED,8BAAsB,iBAAiB,CACrC,OAAO,SAAS,eAAe,GAAG,eAAe,EACjD,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,CAEtE,SAAQ,sBAAsB,CAAC,OAAO,EAAE,UAAU,CAClD,YAAW,2BAA2B,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC;IACpE,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAkD;IAClG,gBAAyB,mBAAmB,EAAE,MAAM,CAAwB;IAC5E,gBAAyB,UAAU,SAAgE;IAGnG,SAAS,CAAC,MAAM,CAAC,uBAAuB,SAAM;IAE9C,OAAO,CAAC,iBAAiB,CAAC,CAA0B;IAGpD,MAAM,KAAK,gBAAgB,WAE1B;IAED,IAAa,OAAO,IAAI,MAAM,EAAE,CAE/B;IAED,IAAI,iBAAiB,YAEpB;IAED,SAAS,KAAK,gBAAgB,YAE7B;IAED,GAAG,IAAI,eAAe,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAQ1C,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAKpE,KAAK,IAAI,UAAU,CAAC,IAAI,CAAC;IAQnB,UAAU,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAKtE,MAAM,IAAI,UAAU,CAAC,YAAY,EAAE,CAAC;IAQ9B,WAAW,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAKjE,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAQvC,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAKlF,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;IAQxD,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAK/E,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;IAQhE,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAKvF,IAAI,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;IASzE,SAAS,CAAC,OAAO,CAAC,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAKtG,SAAS,CAAC,UAAU,IAAI,eAAe,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAIjE,SAAS,CAAC,YAAY,IAAI,UAAU,CAAC,IAAI,CAAC;IAI1C,SAAS,CAAC,aAAa,IAAI,UAAU,CAAC,YAAY,EAAE,CAAC;IAIrD,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,eAAe,CAAC,IAAI,CAAC;cAI/C,gBAAgB,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;cAYxE,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,iBAAiB,GAAG,OAAO,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;cAiB1G,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IAgB7F,SAAS,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAI7D,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;IAkD1G,SAAS,CAAC,aAAa,CAAC,SAAS,EAAE,eAAe,CAAC,OAAO,CAAC,EAAE,GAAG,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAItF,kBAAkB,CAAC,CAAC,SAAS,wBAAwB,GAAG,wBAAwB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE;;;cAahH,gBAAgB,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;IAuBjH,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,oBAAoB,GAAG,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAI9E,cAAc,CAAC,OAAO,CAAC,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAK3G,gBAAgB;cASP,YAAY,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,EAAE,OAAO,SAAS,YAAY,GAAG,YAAY,EAChI,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,OAAO,EAAE,EACnB,WAAW,CAAC,EAAE,OAAO,GACpB,OAAO,CAAC,wBAAwB,CAAC;cAuDpB,aAAa,CAAC,MAAM,EAAE,iBAAiB,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAIjF,cAAc,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;YAWzD,iBAAiB;CAoBhC"}
package/dist/neutral/index.d.ts.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA"}