@xyo-network/diviner-abstract 3.0.2 → 3.0.4
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.mjs.map +1 -1
- package/package.json +17 -17
- package/src/AbstractDiviner.ts +12 -10
- package/xy.config.ts +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/AbstractDiviner.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { globallyUnique } from '@xylabs/object'\nimport { Promisable } from '@xylabs/promise'\nimport {
|
|
1
|
+
{"version":3,"sources":["../../src/AbstractDiviner.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { globallyUnique } from '@xylabs/object'\nimport type { Promisable } from '@xylabs/promise'\nimport type { RetryConfig, RetryConfigWithComplete } from '@xylabs/retry'\nimport { retry } from '@xylabs/retry'\nimport type { AccountInstance } from '@xyo-network/account-model'\nimport type { QueryBoundWitness } from '@xyo-network/boundwitness-model'\nimport { QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper'\nimport type {\n AttachableDivinerInstance,\n DivinerDivineQuery,\n DivinerInstance,\n DivinerModuleEventData,\n DivinerParams,\n DivinerQueries } from '@xyo-network/diviner-model'\nimport {\n DivinerConfigSchema,\n DivinerDivineQuerySchema,\n} from '@xyo-network/diviner-model'\nimport { AbstractModuleInstance } from '@xyo-network/module-abstract'\nimport type { ModuleConfig, ModuleQueryHandlerResult, ModuleQueryResult } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type { Payload, Schema, WithMeta, WithSources } from '@xyo-network/payload-model'\n\nexport abstract class AbstractDiviner<\n TParams extends DivinerParams = DivinerParams,\n TIn extends Payload = Payload,\n TOut extends Payload = Payload,\n TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<\n DivinerInstance<TParams, TIn, TOut>,\n TIn,\n TOut\n >,\n>\n extends AbstractModuleInstance<TParams, TEventData>\n implements AttachableDivinerInstance<TParams, TIn, TOut, TEventData> {\n static override readonly configSchemas: Schema[] = [...super.configSchemas, DivinerConfigSchema]\n static override readonly defaultConfigSchema: Schema = DivinerConfigSchema\n static targetSchema: string\n static override readonly uniqueName = globallyUnique('AbstractDiviner', AbstractDiviner, 'xyo')\n\n override get queries(): string[] {\n return [DivinerDivineQuerySchema, ...super.queries]\n }\n\n /** @function divine The main entry point for a diviner. Do not override this function. Implement/override divineHandler for custom functionality */\n divine(payloads: TIn[] = [], retryConfigIn?: RetryConfigWithComplete): Promise<WithSources<WithMeta<TOut>>[]> {\n this._noOverride('divine')\n return this.busy(async () => {\n const retryConfig = retryConfigIn ?? this.config.retry\n await this.started('throw')\n await this.emit('divineStart', { inPayloads: payloads, mod: this })\n const resultPayloads: TOut[]\n = (retryConfig ? await retry(() => this.divineHandler(payloads), retryConfig) : await this.divineHandler(payloads)) ?? []\n await this.emit('divineEnd', { errors: [], inPayloads: payloads, mod: this, outPayloads: resultPayloads })\n return await Promise.all(resultPayloads.map(payload => PayloadBuilder.build(payload)))\n })\n }\n\n async divineQuery(payloads?: TIn[], account?: AccountInstance, _retry?: RetryConfig): Promise<ModuleQueryResult<TOut>> {\n const queryPayload: DivinerDivineQuery = { schema: DivinerDivineQuerySchema }\n return await this.sendQueryRaw(queryPayload, payloads, account)\n }\n\n /** @function queryHandler Calls divine for a divine 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 = await QueryBoundWitnessWrapper.parseQuery<DivinerQueries>(query, payloads)\n // remove the query payload\n const cleanPayloads = await PayloadBuilder.filterExclude(payloads, query.query)\n const queryPayload = await wrapper.getQuery()\n assertEx(await this.queryable(query, payloads, queryConfig))\n const resultPayloads: Payload[] = []\n switch (queryPayload.schema) {\n case DivinerDivineQuerySchema: {\n resultPayloads.push(...(await this.divine(cleanPayloads as TIn[])))\n break\n }\n default: {\n return super.queryHandler(query, payloads)\n }\n }\n return resultPayloads\n }\n\n /** @function divineHandler Implement or override to add custom functionality to a diviner */\n protected abstract divineHandler(payloads?: TIn[]): Promisable<WithSources<TOut>[]>\n}\n"],"mappings":";;;;AAAA,SAASA,gBAAgB;AACzB,SAASC,sBAAsB;AAG/B,SAASC,aAAa;AAGtB,SAASC,gCAAgC;AAQzC,SACEC,qBACAC,gCACK;AACP,SAASC,8BAA8B;AAEvC,SAASC,sBAAsB;AAGxB,IAAeC,kBAAf,MAAeA,yBAUZC,uBAAAA;EAlCV,OAkCUA;;;EAER,OAAyBC,gBAA0B;OAAI,MAAMA;IAAeC;;EAC5E,OAAyBC,sBAA8BD;EACvD,OAAOE;EACP,OAAyBC,aAAaC,eAAe,mBAAmBP,kBAAiB,KAAA;EAEzF,IAAaQ,UAAoB;AAC/B,WAAO;MAACC;SAA6B,MAAMD;;EAC7C;;EAGAE,OAAOC,WAAkB,CAAA,GAAIC,eAAiF;AAC5G,SAAKC,YAAY,QAAA;AACjB,WAAO,KAAKC,KAAK,YAAA;AACf,YAAMC,cAAcH,iBAAiB,KAAKI,OAAOC;AACjD,YAAM,KAAKC,QAAQ,OAAA;AACnB,YAAM,KAAKC,KAAK,eAAe;QAAEC,YAAYT;QAAUU,KAAK;MAAK,CAAA;AACjE,YAAMC,kBACDP,cAAc,MAAME,MAAM,MAAM,KAAKM,cAAcZ,QAAAA,GAAWI,WAAAA,IAAe,MAAM,KAAKQ,cAAcZ,QAAAA,MAAc,CAAA;AACzH,YAAM,KAAKQ,KAAK,aAAa;QAAEK,QAAQ,CAAA;QAAIJ,YAAYT;QAAUU,KAAK;QAAMI,aAAaH;MAAe,CAAA;AACxG,aAAO,MAAMI,QAAQC,IAAIL,eAAeM,IAAIC,CAAAA,YAAWC,eAAeC,MAAMF,OAAAA,CAAAA,CAAAA;IAC9E,CAAA;EACF;EAEA,MAAMG,YAAYrB,UAAkBsB,SAA2BC,QAAwD;AACrH,UAAMC,eAAmC;MAAEC,QAAQ3B;IAAyB;AAC5E,WAAO,MAAM,KAAK4B,aAAaF,cAAcxB,UAAUsB,OAAAA;EACzD;;EAGA,MAAyBK,aACvBC,OACA5B,UACA6B,aACmC;AACnC,UAAMC,UAAU,MAAMC,yBAAyBC,WAA2BJ,OAAO5B,QAAAA;AAEjF,UAAMiC,gBAAgB,MAAMd,eAAee,cAAclC,UAAU4B,MAAMA,KAAK;AAC9E,UAAMJ,eAAe,MAAMM,QAAQK,SAAQ;AAC3CC,aAAS,MAAM,KAAKC,UAAUT,OAAO5B,UAAU6B,WAAAA,CAAAA;AAC/C,UAAMlB,iBAA4B,CAAA;AAClC,YAAQa,aAAaC,QAAM;MACzB,KAAK3B,0BAA0B;AAC7Ba,uBAAe2B,KAAI,GAAK,MAAM,KAAKvC,OAAOkC,aAAAA,CAAAA;AAC1C;MACF;MACA,SAAS;AACP,eAAO,MAAMN,aAAaC,OAAO5B,QAAAA;MACnC;IACF;AACA,WAAOW;EACT;AAIF;","names":["assertEx","globallyUnique","retry","QueryBoundWitnessWrapper","DivinerConfigSchema","DivinerDivineQuerySchema","AbstractModuleInstance","PayloadBuilder","AbstractDiviner","AbstractModuleInstance","configSchemas","DivinerConfigSchema","defaultConfigSchema","targetSchema","uniqueName","globallyUnique","queries","DivinerDivineQuerySchema","divine","payloads","retryConfigIn","_noOverride","busy","retryConfig","config","retry","started","emit","inPayloads","mod","resultPayloads","divineHandler","errors","outPayloads","Promise","all","map","payload","PayloadBuilder","build","divineQuery","account","_retry","queryPayload","schema","sendQueryRaw","queryHandler","query","queryConfig","wrapper","QueryBoundWitnessWrapper","parseQuery","cleanPayloads","filterExclude","getQuery","assertEx","queryable","push"]}
|
package/package.json
CHANGED
|
@@ -7,25 +7,25 @@
|
|
|
7
7
|
},
|
|
8
8
|
"bugs": {
|
|
9
9
|
"email": "support@xyo.network",
|
|
10
|
-
"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
|
|
10
|
+
"url": "git+https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
|
|
11
11
|
},
|
|
12
12
|
"dependencies": {
|
|
13
|
-
"@xylabs/assert": "^4.0.
|
|
14
|
-
"@xylabs/object": "^4.0.
|
|
15
|
-
"@xylabs/promise": "^4.0.
|
|
16
|
-
"@xylabs/retry": "^4.0.
|
|
17
|
-
"@xyo-network/account-model": "^3.0.
|
|
18
|
-
"@xyo-network/boundwitness-model": "^3.0.
|
|
19
|
-
"@xyo-network/boundwitness-wrapper": "^3.0.
|
|
20
|
-
"@xyo-network/diviner-model": "^3.0.
|
|
21
|
-
"@xyo-network/module-abstract": "^3.0.
|
|
22
|
-
"@xyo-network/module-model": "^3.0.
|
|
23
|
-
"@xyo-network/payload-builder": "^3.0.
|
|
24
|
-
"@xyo-network/payload-model": "^3.0.
|
|
13
|
+
"@xylabs/assert": "^4.0.2",
|
|
14
|
+
"@xylabs/object": "^4.0.2",
|
|
15
|
+
"@xylabs/promise": "^4.0.2",
|
|
16
|
+
"@xylabs/retry": "^4.0.2",
|
|
17
|
+
"@xyo-network/account-model": "^3.0.4",
|
|
18
|
+
"@xyo-network/boundwitness-model": "^3.0.4",
|
|
19
|
+
"@xyo-network/boundwitness-wrapper": "^3.0.4",
|
|
20
|
+
"@xyo-network/diviner-model": "^3.0.4",
|
|
21
|
+
"@xyo-network/module-abstract": "^3.0.4",
|
|
22
|
+
"@xyo-network/module-model": "^3.0.4",
|
|
23
|
+
"@xyo-network/payload-builder": "^3.0.4",
|
|
24
|
+
"@xyo-network/payload-model": "^3.0.4"
|
|
25
25
|
},
|
|
26
26
|
"devDependencies": {
|
|
27
|
-
"@xylabs/ts-scripts-yarn3": "^4.0.0-rc.
|
|
28
|
-
"@xylabs/tsconfig": "^4.0.0-rc.
|
|
27
|
+
"@xylabs/ts-scripts-yarn3": "^4.0.0-rc.20",
|
|
28
|
+
"@xylabs/tsconfig": "^4.0.0-rc.20",
|
|
29
29
|
"typescript": "^5.5.4"
|
|
30
30
|
},
|
|
31
31
|
"description": "Primary SDK for using XYO Protocol 2.0",
|
|
@@ -45,9 +45,9 @@
|
|
|
45
45
|
},
|
|
46
46
|
"repository": {
|
|
47
47
|
"type": "git",
|
|
48
|
-
"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
|
|
48
|
+
"url": "git+https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
|
|
49
49
|
},
|
|
50
50
|
"sideEffects": false,
|
|
51
|
-
"version": "3.0.
|
|
51
|
+
"version": "3.0.4",
|
|
52
52
|
"type": "module"
|
|
53
53
|
}
|
package/src/AbstractDiviner.ts
CHANGED
|
@@ -1,24 +1,26 @@
|
|
|
1
1
|
import { assertEx } from '@xylabs/assert'
|
|
2
2
|
import { globallyUnique } from '@xylabs/object'
|
|
3
|
-
import { Promisable } from '@xylabs/promise'
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
3
|
+
import type { Promisable } from '@xylabs/promise'
|
|
4
|
+
import type { RetryConfig, RetryConfigWithComplete } from '@xylabs/retry'
|
|
5
|
+
import { retry } from '@xylabs/retry'
|
|
6
|
+
import type { AccountInstance } from '@xyo-network/account-model'
|
|
7
|
+
import type { QueryBoundWitness } from '@xyo-network/boundwitness-model'
|
|
7
8
|
import { QueryBoundWitnessWrapper } from '@xyo-network/boundwitness-wrapper'
|
|
8
|
-
import {
|
|
9
|
+
import type {
|
|
9
10
|
AttachableDivinerInstance,
|
|
10
|
-
DivinerConfigSchema,
|
|
11
11
|
DivinerDivineQuery,
|
|
12
|
-
DivinerDivineQuerySchema,
|
|
13
12
|
DivinerInstance,
|
|
14
13
|
DivinerModuleEventData,
|
|
15
14
|
DivinerParams,
|
|
16
|
-
DivinerQueries
|
|
15
|
+
DivinerQueries } from '@xyo-network/diviner-model'
|
|
16
|
+
import {
|
|
17
|
+
DivinerConfigSchema,
|
|
18
|
+
DivinerDivineQuerySchema,
|
|
17
19
|
} from '@xyo-network/diviner-model'
|
|
18
20
|
import { AbstractModuleInstance } from '@xyo-network/module-abstract'
|
|
19
|
-
import { ModuleConfig, ModuleQueryHandlerResult, ModuleQueryResult } from '@xyo-network/module-model'
|
|
21
|
+
import type { ModuleConfig, ModuleQueryHandlerResult, ModuleQueryResult } from '@xyo-network/module-model'
|
|
20
22
|
import { PayloadBuilder } from '@xyo-network/payload-builder'
|
|
21
|
-
import { Payload, Schema, WithMeta, WithSources } from '@xyo-network/payload-model'
|
|
23
|
+
import type { Payload, Schema, WithMeta, WithSources } from '@xyo-network/payload-model'
|
|
22
24
|
|
|
23
25
|
export abstract class AbstractDiviner<
|
|
24
26
|
TParams extends DivinerParams = DivinerParams,
|
package/xy.config.ts
CHANGED