@xyo-network/abstract-witness 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.
- package/dist/neutral/index.d.ts +89 -2
- package/dist/neutral/index.mjs +1 -1
- package/dist/neutral/index.mjs.map +1 -1
- package/package.json +13 -13
- package/src/AbstractWitness.ts +1 -1
- package/dist/neutral/AbstractWitness.d.ts +0 -86
- package/dist/neutral/AbstractWitness.d.ts.map +0 -1
- package/dist/neutral/index.d.ts.map +0 -1
package/dist/neutral/index.d.ts
CHANGED
|
@@ -1,2 +1,89 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
import * as _xyo_network_archivist_model from '@xyo-network/archivist-model';
|
|
2
|
+
import { ArchivistInstance } from '@xyo-network/archivist-model';
|
|
3
|
+
import * as _xylabs_logger from '@xylabs/logger';
|
|
4
|
+
import * as _xyo_network_module_model from '@xyo-network/module-model';
|
|
5
|
+
import { ModuleQueryResult, ModuleConfig, ModuleQueryHandlerResult } from '@xyo-network/module-model';
|
|
6
|
+
import * as _xylabs_object from '@xylabs/object';
|
|
7
|
+
import { Promisable } from '@xylabs/promise';
|
|
8
|
+
import { AccountInstance } from '@xyo-network/account-model';
|
|
9
|
+
import { QueryBoundWitness } from '@xyo-network/boundwitness-model';
|
|
10
|
+
import { AbstractModuleInstance } from '@xyo-network/module-abstract';
|
|
11
|
+
import { Payload, Schema, WithoutPrivateStorageMeta } from '@xyo-network/payload-model';
|
|
12
|
+
import { WitnessParams, WitnessModuleEventData, WitnessInstance, CustomWitnessInstance } from '@xyo-network/witness-model';
|
|
13
|
+
|
|
14
|
+
declare abstract class AbstractWitness<TParams extends WitnessParams = WitnessParams, TIn extends Payload = Payload, TOut extends Payload = Payload, TEventData extends WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut> = WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut>> extends AbstractModuleInstance<TParams, TEventData> implements CustomWitnessInstance<TParams, TIn, TOut, TEventData> {
|
|
15
|
+
static readonly configSchemas: Schema[];
|
|
16
|
+
static readonly defaultConfigSchema: Schema;
|
|
17
|
+
static readonly uniqueName: string;
|
|
18
|
+
private _archivistInstance;
|
|
19
|
+
get queries(): string[];
|
|
20
|
+
getArchivistInstance(): Promise<ArchivistInstance<_xylabs_object.BaseParamsFields & {
|
|
21
|
+
account?: AccountInstance | "random";
|
|
22
|
+
addToResolvers?: boolean;
|
|
23
|
+
additionalSigners?: AccountInstance[];
|
|
24
|
+
allowNameResolution?: boolean;
|
|
25
|
+
config: _xylabs_object.DeepRestrictToStringKeys<{
|
|
26
|
+
schema: Schema;
|
|
27
|
+
readonly archiving?: {
|
|
28
|
+
readonly archivists?: string[] | undefined;
|
|
29
|
+
readonly queries?: string[] | undefined;
|
|
30
|
+
} | undefined;
|
|
31
|
+
readonly allowedQueries?: string[] | undefined;
|
|
32
|
+
readonly archivist?: _xyo_network_module_model.ModuleIdentifier | undefined;
|
|
33
|
+
readonly consoleLogger?: _xylabs_logger.LogLevel | undefined;
|
|
34
|
+
readonly labels?: {
|
|
35
|
+
[x: string]: string | undefined;
|
|
36
|
+
} | undefined;
|
|
37
|
+
readonly name?: _xyo_network_module_model.ModuleName | undefined;
|
|
38
|
+
readonly paging?: {
|
|
39
|
+
[x: string]: {
|
|
40
|
+
size?: number | undefined;
|
|
41
|
+
};
|
|
42
|
+
} | undefined;
|
|
43
|
+
readonly retry?: {
|
|
44
|
+
backoff?: number | undefined;
|
|
45
|
+
interval?: number | undefined;
|
|
46
|
+
retries?: number | undefined;
|
|
47
|
+
} | undefined;
|
|
48
|
+
readonly security?: {
|
|
49
|
+
readonly allowAnonymous?: boolean | undefined;
|
|
50
|
+
readonly allowed?: {
|
|
51
|
+
[x: string]: (Lowercase<string> | Lowercase<string>[])[];
|
|
52
|
+
} | undefined;
|
|
53
|
+
readonly disallowed?: {
|
|
54
|
+
[x: string]: Lowercase<string>[];
|
|
55
|
+
} | undefined;
|
|
56
|
+
} | undefined;
|
|
57
|
+
readonly sign?: boolean | undefined;
|
|
58
|
+
readonly storeQueries?: boolean | undefined;
|
|
59
|
+
readonly timestamp?: boolean | undefined;
|
|
60
|
+
parents?: {
|
|
61
|
+
commit?: string[] | undefined;
|
|
62
|
+
read?: string[] | undefined;
|
|
63
|
+
write?: string[] | undefined;
|
|
64
|
+
} | undefined;
|
|
65
|
+
requireAllParents?: boolean | undefined;
|
|
66
|
+
storage?: {
|
|
67
|
+
indexes?: {
|
|
68
|
+
key: {
|
|
69
|
+
[x: string]: _xyo_network_archivist_model.IndexDirection;
|
|
70
|
+
};
|
|
71
|
+
multiEntry?: boolean | undefined;
|
|
72
|
+
name?: string | undefined;
|
|
73
|
+
unique?: boolean | undefined;
|
|
74
|
+
}[] | undefined;
|
|
75
|
+
} | undefined;
|
|
76
|
+
storeParentReads?: boolean | undefined;
|
|
77
|
+
}>;
|
|
78
|
+
ephemeralQueryAccountEnabled?: boolean;
|
|
79
|
+
moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
|
|
80
|
+
}, _xyo_network_archivist_model.ArchivistModuleEventData, _xylabs_object.DeepRestrictToStringKeys<{
|
|
81
|
+
schema: Schema;
|
|
82
|
+
}>> | undefined>;
|
|
83
|
+
observe(inPayloads?: TIn[]): Promise<WithoutPrivateStorageMeta<TOut>[]>;
|
|
84
|
+
observeQuery(payloads?: TIn[], account?: AccountInstance): Promise<ModuleQueryResult<TOut>>;
|
|
85
|
+
protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryHandlerResult>;
|
|
86
|
+
protected abstract observeHandler(payloads?: TIn[]): Promisable<TOut[]>;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
export { AbstractWitness };
|
package/dist/neutral/index.mjs
CHANGED
|
@@ -47,7 +47,7 @@ var AbstractWitness = class _AbstractWitness extends AbstractModuleInstance {
|
|
|
47
47
|
}
|
|
48
48
|
/** @function queryHandler Calls observe for an observe query. Override to support additional queries. */
|
|
49
49
|
async queryHandler(query, payloads, queryConfig) {
|
|
50
|
-
const wrapper =
|
|
50
|
+
const wrapper = QueryBoundWitnessWrapper.parseQuery(query, payloads);
|
|
51
51
|
const queryPayload = await wrapper.getQuery();
|
|
52
52
|
assertEx(await this.queryable(query, payloads, queryConfig));
|
|
53
53
|
const resultPayloads = [];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/AbstractWitness.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { globallyUnique } from '@xylabs/object'\nimport type { Promisable } from '@xylabs/promise'\nimport type { AccountInstance } from '@xyo-network/account-model'\nimport type { ArchivistInstance } from '@xyo-network/archivist-model'\nimport type { QueryBoundWitness } from '@xyo-network/boundwitness-model'\nimport { QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper'\nimport { AbstractModuleInstance } from '@xyo-network/module-abstract'\nimport type {\n ModuleConfig, ModuleQueryHandlerResult, ModuleQueryResult,\n} from '@xyo-network/module-model'\nimport { creatableModule } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type {\n Payload, Schema, WithoutPrivateStorageMeta,\n} from '@xyo-network/payload-model'\nimport type {\n CustomWitnessInstance,\n WitnessInstance,\n WitnessModuleEventData,\n WitnessObserveQuery,\n WitnessParams,\n WitnessQueries,\n} from '@xyo-network/witness-model'\nimport {\n WitnessConfigSchema,\n WitnessObserveQuerySchema,\n} from '@xyo-network/witness-model'\n\ncreatableModule()\nexport abstract class AbstractWitness<\n TParams extends WitnessParams = WitnessParams,\n TIn extends Payload = Payload,\n TOut extends Payload = Payload,\n TEventData extends WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut> = WitnessModuleEventData<\n WitnessInstance<TParams, TIn, TOut>,\n TIn,\n TOut\n >,\n>\n extends AbstractModuleInstance<TParams, TEventData>\n implements CustomWitnessInstance<TParams, TIn, TOut, TEventData> {\n static override readonly configSchemas: Schema[] = [...super.configSchemas, WitnessConfigSchema]\n static override readonly defaultConfigSchema: Schema = WitnessConfigSchema\n static override readonly uniqueName = globallyUnique('AbstractWitness', AbstractWitness, 'xyo')\n\n private _archivistInstance: ArchivistInstance | undefined\n\n override get queries(): string[] {\n return [WitnessObserveQuerySchema, ...super.queries]\n }\n\n async getArchivistInstance() {\n const archivistAddress = this.archivist\n this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : undefined)\n return this._archivistInstance\n }\n\n /** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */\n async observe(inPayloads?: TIn[]): Promise<WithoutPrivateStorageMeta<TOut>[]> {\n this._noOverride('observe')\n await this.started('throw')\n await this.emit('observeStart', { inPayloads, mod: this } as TEventData['observeStart'])\n const outPayloads = assertEx(await this.observeHandler(inPayloads), () => 'Trying to witness nothing')\n // assertEx(outPayloads.length > 0, 'Trying to witness empty list')\n for (const payload of outPayloads ?? []) assertEx(payload.schema, () => 'observe: Missing Schema')\n\n const archivist = await this.getArchivistInstance()\n if (archivist) {\n await archivist.insert(outPayloads)\n }\n\n await this.emit('observeEnd', {\n inPayloads, mod: this, outPayloads,\n } as TEventData['observeEnd'])\n\n return PayloadBuilder.omitPrivateStorageMeta(outPayloads)\n }\n\n async observeQuery(payloads?: TIn[], account?: AccountInstance): Promise<ModuleQueryResult<TOut>> {\n const queryPayload: WitnessObserveQuery = { schema: WitnessObserveQuerySchema }\n return await this.sendQueryRaw(queryPayload, payloads, account)\n }\n\n /** @function queryHandler Calls observe for an observe query. Override to support additional queries. */\n protected override async queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(\n query: T,\n payloads?: Payload[],\n queryConfig?: TConfig,\n ): Promise<ModuleQueryHandlerResult> {\n const wrapper =
|
|
1
|
+
{"version":3,"sources":["../../src/AbstractWitness.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { globallyUnique } from '@xylabs/object'\nimport type { Promisable } from '@xylabs/promise'\nimport type { AccountInstance } from '@xyo-network/account-model'\nimport type { ArchivistInstance } from '@xyo-network/archivist-model'\nimport type { QueryBoundWitness } from '@xyo-network/boundwitness-model'\nimport { QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper'\nimport { AbstractModuleInstance } from '@xyo-network/module-abstract'\nimport type {\n ModuleConfig, ModuleQueryHandlerResult, ModuleQueryResult,\n} from '@xyo-network/module-model'\nimport { creatableModule } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type {\n Payload, Schema, WithoutPrivateStorageMeta,\n} from '@xyo-network/payload-model'\nimport type {\n CustomWitnessInstance,\n WitnessInstance,\n WitnessModuleEventData,\n WitnessObserveQuery,\n WitnessParams,\n WitnessQueries,\n} from '@xyo-network/witness-model'\nimport {\n WitnessConfigSchema,\n WitnessObserveQuerySchema,\n} from '@xyo-network/witness-model'\n\ncreatableModule()\nexport abstract class AbstractWitness<\n TParams extends WitnessParams = WitnessParams,\n TIn extends Payload = Payload,\n TOut extends Payload = Payload,\n TEventData extends WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut> = WitnessModuleEventData<\n WitnessInstance<TParams, TIn, TOut>,\n TIn,\n TOut\n >,\n>\n extends AbstractModuleInstance<TParams, TEventData>\n implements CustomWitnessInstance<TParams, TIn, TOut, TEventData> {\n static override readonly configSchemas: Schema[] = [...super.configSchemas, WitnessConfigSchema]\n static override readonly defaultConfigSchema: Schema = WitnessConfigSchema\n static override readonly uniqueName = globallyUnique('AbstractWitness', AbstractWitness, 'xyo')\n\n private _archivistInstance: ArchivistInstance | undefined\n\n override get queries(): string[] {\n return [WitnessObserveQuerySchema, ...super.queries]\n }\n\n async getArchivistInstance() {\n const archivistAddress = this.archivist\n this._archivistInstance = this._archivistInstance ?? (archivistAddress ? await this.resolve(archivistAddress) : undefined)\n return this._archivistInstance\n }\n\n /** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */\n async observe(inPayloads?: TIn[]): Promise<WithoutPrivateStorageMeta<TOut>[]> {\n this._noOverride('observe')\n await this.started('throw')\n await this.emit('observeStart', { inPayloads, mod: this } as TEventData['observeStart'])\n const outPayloads = assertEx(await this.observeHandler(inPayloads), () => 'Trying to witness nothing')\n // assertEx(outPayloads.length > 0, 'Trying to witness empty list')\n for (const payload of outPayloads ?? []) assertEx(payload.schema, () => 'observe: Missing Schema')\n\n const archivist = await this.getArchivistInstance()\n if (archivist) {\n await archivist.insert(outPayloads)\n }\n\n await this.emit('observeEnd', {\n inPayloads, mod: this, outPayloads,\n } as TEventData['observeEnd'])\n\n return PayloadBuilder.omitPrivateStorageMeta(outPayloads)\n }\n\n async observeQuery(payloads?: TIn[], account?: AccountInstance): Promise<ModuleQueryResult<TOut>> {\n const queryPayload: WitnessObserveQuery = { schema: WitnessObserveQuerySchema }\n return await this.sendQueryRaw(queryPayload, payloads, account)\n }\n\n /** @function queryHandler Calls observe for an observe query. Override to support additional queries. */\n protected override async queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(\n query: T,\n payloads?: Payload[],\n queryConfig?: TConfig,\n ): Promise<ModuleQueryHandlerResult> {\n const wrapper = QueryBoundWitnessWrapper.parseQuery<WitnessQueries>(query, payloads)\n const queryPayload = await wrapper.getQuery()\n assertEx(await this.queryable(query, payloads, queryConfig))\n const resultPayloads: Payload[] = []\n // Remove the query payload from the arguments passed to us so we don't observe it\n const filteredObservation = (await PayloadBuilder.filterExclude(payloads, query.query)) as TIn[]\n switch (queryPayload.schema) {\n case WitnessObserveQuerySchema: {\n const observePayloads = await this.observe(filteredObservation)\n resultPayloads.push(...observePayloads)\n break\n }\n default: {\n return super.queryHandler(query, payloads)\n }\n }\n return PayloadBuilder.omitPrivateStorageMeta(resultPayloads)\n }\n\n /** @function observeHandler Implement or override to add custom functionality to a witness */\n protected abstract observeHandler(payloads?: TIn[]): Promisable<TOut[]>\n}\n"],"mappings":";AAAA,SAAS,gBAAgB;AACzB,SAAS,sBAAsB;AAK/B,SAAS,gCAAgC;AACzC,SAAS,8BAA8B;AAIvC,SAAS,uBAAuB;AAChC,SAAS,sBAAsB;AAY/B;AAAA,EACE;AAAA,EACA;AAAA,OACK;AAEP,gBAAgB;AACT,IAAe,kBAAf,MAAe,yBAUZ,uBACyD;AAAA,EACjE,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,mBAAmB;AAAA,EAC/F,OAAyB,sBAA8B;AAAA,EACvD,OAAyB,aAAa,eAAe,mBAAmB,kBAAiB,KAAK;AAAA,EAEtF;AAAA,EAER,IAAa,UAAoB;AAC/B,WAAO,CAAC,2BAA2B,GAAG,MAAM,OAAO;AAAA,EACrD;AAAA,EAEA,MAAM,uBAAuB;AAC3B,UAAM,mBAAmB,KAAK;AAC9B,SAAK,qBAAqB,KAAK,uBAAuB,mBAAmB,MAAM,KAAK,QAAQ,gBAAgB,IAAI;AAChH,WAAO,KAAK;AAAA,EACd;AAAA;AAAA,EAGA,MAAM,QAAQ,YAAgE;AAC5E,SAAK,YAAY,SAAS;AAC1B,UAAM,KAAK,QAAQ,OAAO;AAC1B,UAAM,KAAK,KAAK,gBAAgB,EAAE,YAAY,KAAK,KAAK,CAA+B;AACvF,UAAM,cAAc,SAAS,MAAM,KAAK,eAAe,UAAU,GAAG,MAAM,2BAA2B;AAErG,eAAW,WAAW,eAAe,CAAC,EAAG,UAAS,QAAQ,QAAQ,MAAM,yBAAyB;AAEjG,UAAM,YAAY,MAAM,KAAK,qBAAqB;AAClD,QAAI,WAAW;AACb,YAAM,UAAU,OAAO,WAAW;AAAA,IACpC;AAEA,UAAM,KAAK,KAAK,cAAc;AAAA,MAC5B;AAAA,MAAY,KAAK;AAAA,MAAM;AAAA,IACzB,CAA6B;AAE7B,WAAO,eAAe,uBAAuB,WAAW;AAAA,EAC1D;AAAA,EAEA,MAAM,aAAa,UAAkB,SAA6D;AAChG,UAAM,eAAoC,EAAE,QAAQ,0BAA0B;AAC9E,WAAO,MAAM,KAAK,aAAa,cAAc,UAAU,OAAO;AAAA,EAChE;AAAA;AAAA,EAGA,MAAyB,aACvB,OACA,UACA,aACmC;AACnC,UAAM,UAAU,yBAAyB,WAA2B,OAAO,QAAQ;AACnF,UAAM,eAAe,MAAM,QAAQ,SAAS;AAC5C,aAAS,MAAM,KAAK,UAAU,OAAO,UAAU,WAAW,CAAC;AAC3D,UAAM,iBAA4B,CAAC;AAEnC,UAAM,sBAAuB,MAAM,eAAe,cAAc,UAAU,MAAM,KAAK;AACrF,YAAQ,aAAa,QAAQ;AAAA,MAC3B,KAAK,2BAA2B;AAC9B,cAAM,kBAAkB,MAAM,KAAK,QAAQ,mBAAmB;AAC9D,uBAAe,KAAK,GAAG,eAAe;AACtC;AAAA,MACF;AAAA,MACA,SAAS;AACP,eAAO,MAAM,aAAa,OAAO,QAAQ;AAAA,MAC3C;AAAA,IACF;AACA,WAAO,eAAe,uBAAuB,cAAc;AAAA,EAC7D;AAIF;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xyo-network/abstract-witness",
|
|
3
|
-
"version": "3.8.
|
|
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": {
|
|
@@ -32,22 +32,22 @@
|
|
|
32
32
|
"@xylabs/assert": "^4.5.1",
|
|
33
33
|
"@xylabs/object": "^4.5.1",
|
|
34
34
|
"@xylabs/promise": "^4.5.1",
|
|
35
|
-
"@xyo-network/account-model": "^3.8.
|
|
36
|
-
"@xyo-network/archivist-model": "^3.8.
|
|
37
|
-
"@xyo-network/boundwitness-model": "^3.8.
|
|
38
|
-
"@xyo-network/boundwitness-wrapper": "^3.8.
|
|
39
|
-
"@xyo-network/module-abstract": "^3.8.
|
|
40
|
-
"@xyo-network/module-model": "^3.8.
|
|
41
|
-
"@xyo-network/payload-builder": "^3.8.
|
|
42
|
-
"@xyo-network/payload-model": "^3.8.
|
|
43
|
-
"@xyo-network/witness-model": "^3.8.
|
|
35
|
+
"@xyo-network/account-model": "^3.8.2",
|
|
36
|
+
"@xyo-network/archivist-model": "^3.8.2",
|
|
37
|
+
"@xyo-network/boundwitness-model": "^3.8.2",
|
|
38
|
+
"@xyo-network/boundwitness-wrapper": "^3.8.2",
|
|
39
|
+
"@xyo-network/module-abstract": "^3.8.2",
|
|
40
|
+
"@xyo-network/module-model": "^3.8.2",
|
|
41
|
+
"@xyo-network/payload-builder": "^3.8.2",
|
|
42
|
+
"@xyo-network/payload-model": "^3.8.2",
|
|
43
|
+
"@xyo-network/witness-model": "^3.8.2"
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
|
-
"@xylabs/ts-scripts-yarn3": "^
|
|
47
|
-
"@xylabs/tsconfig": "^
|
|
46
|
+
"@xylabs/ts-scripts-yarn3": "^5.0.22",
|
|
47
|
+
"@xylabs/tsconfig": "^5.0.22",
|
|
48
48
|
"@xylabs/vitest-extended": "^4.5.1",
|
|
49
49
|
"typescript": "^5.7.3",
|
|
50
|
-
"vitest": "^3.0.
|
|
50
|
+
"vitest": "^3.0.5"
|
|
51
51
|
},
|
|
52
52
|
"publishConfig": {
|
|
53
53
|
"access": "public"
|
package/src/AbstractWitness.ts
CHANGED
|
@@ -88,7 +88,7 @@ export abstract class AbstractWitness<
|
|
|
88
88
|
payloads?: Payload[],
|
|
89
89
|
queryConfig?: TConfig,
|
|
90
90
|
): Promise<ModuleQueryHandlerResult> {
|
|
91
|
-
const wrapper =
|
|
91
|
+
const wrapper = QueryBoundWitnessWrapper.parseQuery<WitnessQueries>(query, payloads)
|
|
92
92
|
const queryPayload = await wrapper.getQuery()
|
|
93
93
|
assertEx(await this.queryable(query, payloads, queryConfig))
|
|
94
94
|
const resultPayloads: Payload[] = []
|
|
@@ -1,86 +0,0 @@
|
|
|
1
|
-
import type { Promisable } from '@xylabs/promise';
|
|
2
|
-
import type { AccountInstance } from '@xyo-network/account-model';
|
|
3
|
-
import type { ArchivistInstance } from '@xyo-network/archivist-model';
|
|
4
|
-
import type { QueryBoundWitness } from '@xyo-network/boundwitness-model';
|
|
5
|
-
import { AbstractModuleInstance } from '@xyo-network/module-abstract';
|
|
6
|
-
import type { ModuleConfig, ModuleQueryHandlerResult, ModuleQueryResult } from '@xyo-network/module-model';
|
|
7
|
-
import type { Payload, Schema, WithoutPrivateStorageMeta } from '@xyo-network/payload-model';
|
|
8
|
-
import type { CustomWitnessInstance, WitnessInstance, WitnessModuleEventData, WitnessParams } from '@xyo-network/witness-model';
|
|
9
|
-
export declare abstract class AbstractWitness<TParams extends WitnessParams = WitnessParams, TIn extends Payload = Payload, TOut extends Payload = Payload, TEventData extends WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut> = WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut>> extends AbstractModuleInstance<TParams, TEventData> implements CustomWitnessInstance<TParams, TIn, TOut, TEventData> {
|
|
10
|
-
static readonly configSchemas: Schema[];
|
|
11
|
-
static readonly defaultConfigSchema: Schema;
|
|
12
|
-
static readonly uniqueName: string;
|
|
13
|
-
private _archivistInstance;
|
|
14
|
-
get queries(): string[];
|
|
15
|
-
getArchivistInstance(): Promise<ArchivistInstance<import("@xylabs/object").BaseParamsFields & {
|
|
16
|
-
account?: AccountInstance | "random";
|
|
17
|
-
addToResolvers?: boolean;
|
|
18
|
-
additionalSigners?: AccountInstance[];
|
|
19
|
-
allowNameResolution?: boolean;
|
|
20
|
-
config: import("@xylabs/object").DeepRestrictToStringKeys<{
|
|
21
|
-
schema: Schema;
|
|
22
|
-
readonly archiving?: {
|
|
23
|
-
readonly archivists?: string[] | undefined;
|
|
24
|
-
readonly queries?: string[] | undefined;
|
|
25
|
-
} | undefined;
|
|
26
|
-
readonly allowedQueries?: string[] | undefined;
|
|
27
|
-
readonly archivist?: import("@xyo-network/module-model").ModuleIdentifier | undefined;
|
|
28
|
-
readonly consoleLogger?: import("@xylabs/logger").LogLevel | undefined;
|
|
29
|
-
readonly labels?: {
|
|
30
|
-
[x: string]: string | undefined;
|
|
31
|
-
} | undefined;
|
|
32
|
-
readonly name?: import("@xyo-network/module-model").ModuleName | undefined;
|
|
33
|
-
readonly paging?: {
|
|
34
|
-
[x: string]: {
|
|
35
|
-
size?: number | undefined;
|
|
36
|
-
};
|
|
37
|
-
} | undefined;
|
|
38
|
-
readonly retry?: {
|
|
39
|
-
backoff?: number | undefined;
|
|
40
|
-
interval?: number | undefined;
|
|
41
|
-
retries?: number | undefined;
|
|
42
|
-
} | undefined;
|
|
43
|
-
readonly security?: {
|
|
44
|
-
readonly allowAnonymous?: boolean | undefined;
|
|
45
|
-
readonly allowed?: {
|
|
46
|
-
[x: string]: (Lowercase<string> | Lowercase<string>[])[];
|
|
47
|
-
} | undefined;
|
|
48
|
-
readonly disallowed?: {
|
|
49
|
-
[x: string]: Lowercase<string>[];
|
|
50
|
-
} | undefined;
|
|
51
|
-
} | undefined;
|
|
52
|
-
readonly sign?: boolean | undefined;
|
|
53
|
-
readonly storeQueries?: boolean | undefined;
|
|
54
|
-
readonly timestamp?: boolean | undefined;
|
|
55
|
-
parents?: {
|
|
56
|
-
commit?: string[] | undefined;
|
|
57
|
-
read?: string[] | undefined;
|
|
58
|
-
write?: string[] | undefined;
|
|
59
|
-
} | undefined;
|
|
60
|
-
requireAllParents?: boolean | undefined;
|
|
61
|
-
storage?: {
|
|
62
|
-
indexes?: {
|
|
63
|
-
key: {
|
|
64
|
-
[x: string]: import("@xyo-network/archivist-model").IndexDirection;
|
|
65
|
-
};
|
|
66
|
-
multiEntry?: boolean | undefined;
|
|
67
|
-
name?: string | undefined;
|
|
68
|
-
unique?: boolean | undefined;
|
|
69
|
-
}[] | undefined;
|
|
70
|
-
} | undefined;
|
|
71
|
-
storeParentReads?: boolean | undefined;
|
|
72
|
-
}>;
|
|
73
|
-
ephemeralQueryAccountEnabled?: boolean;
|
|
74
|
-
moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[];
|
|
75
|
-
}, import("@xyo-network/archivist-model").ArchivistModuleEventData, import("@xylabs/object").DeepRestrictToStringKeys<{
|
|
76
|
-
schema: Schema;
|
|
77
|
-
}>> | undefined>;
|
|
78
|
-
/** @function observe The main entry point for a witness. Do not override this function. Implement/override observeHandler for custom functionality */
|
|
79
|
-
observe(inPayloads?: TIn[]): Promise<WithoutPrivateStorageMeta<TOut>[]>;
|
|
80
|
-
observeQuery(payloads?: TIn[], account?: AccountInstance): Promise<ModuleQueryResult<TOut>>;
|
|
81
|
-
/** @function queryHandler Calls observe for an observe query. Override to support additional queries. */
|
|
82
|
-
protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryHandlerResult>;
|
|
83
|
-
/** @function observeHandler Implement or override to add custom functionality to a witness */
|
|
84
|
-
protected abstract observeHandler(payloads?: TIn[]): Promisable<TOut[]>;
|
|
85
|
-
}
|
|
86
|
-
//# sourceMappingURL=AbstractWitness.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"AbstractWitness.d.ts","sourceRoot":"","sources":["../../src/AbstractWitness.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AACjE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AAExE,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,KAAK,EACV,YAAY,EAAE,wBAAwB,EAAE,iBAAiB,EAC1D,MAAM,2BAA2B,CAAA;AAGlC,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EAAE,yBAAyB,EAC3C,MAAM,4BAA4B,CAAA;AACnC,OAAO,KAAK,EACV,qBAAqB,EACrB,eAAe,EACf,sBAAsB,EAEtB,aAAa,EAEd,MAAM,4BAA4B,CAAA;AAOnC,8BAAsB,eAAe,CACnC,OAAO,SAAS,aAAa,GAAG,aAAa,EAC7C,GAAG,SAAS,OAAO,GAAG,OAAO,EAC7B,IAAI,SAAS,OAAO,GAAG,OAAO,EAC9B,UAAU,SAAS,sBAAsB,CAAC,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,sBAAsB,CAChH,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EACnC,GAAG,EACH,IAAI,CACL,CAED,SAAQ,sBAAsB,CAAC,OAAO,EAAE,UAAU,CAClD,YAAW,qBAAqB,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC;IAChE,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAgD;IAChG,gBAAyB,mBAAmB,EAAE,MAAM,CAAsB;IAC1E,gBAAyB,UAAU,SAA4D;IAE/F,OAAO,CAAC,kBAAkB,CAA+B;IAEzD,IAAa,OAAO,IAAI,MAAM,EAAE,CAE/B;IAEK,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAM1B,wJAAwJ;IAClJ,OAAO,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,yBAAyB,CAAC,IAAI,CAAC,EAAE,CAAC;IAoBvE,YAAY,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAKjG,0GAA0G;cACjF,YAAY,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,EAAE,OAAO,SAAS,YAAY,GAAG,YAAY,EAChI,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,OAAO,EAAE,EACpB,WAAW,CAAC,EAAE,OAAO,GACpB,OAAO,CAAC,wBAAwB,CAAC;IAoBpC,8FAA8F;IAC9F,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;CACxE"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA"}
|