@milaboratories/pl-tree 1.8.47 → 1.8.49
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/_virtual/_rolldown/runtime.cjs +29 -0
- package/dist/accessors.cjs +236 -273
- package/dist/accessors.cjs.map +1 -1
- package/dist/accessors.d.ts +93 -93
- package/dist/accessors.js +235 -271
- package/dist/accessors.js.map +1 -1
- package/dist/dump.cjs +79 -80
- package/dist/dump.cjs.map +1 -1
- package/dist/dump.d.ts +16 -18
- package/dist/dump.js +79 -79
- package/dist/dump.js.map +1 -1
- package/dist/index.cjs +31 -35
- package/dist/index.d.ts +10 -10
- package/dist/index.js +9 -8
- package/dist/snapshot.cjs +50 -71
- package/dist/snapshot.cjs.map +1 -1
- package/dist/snapshot.d.ts +36 -38
- package/dist/snapshot.js +49 -69
- package/dist/snapshot.js.map +1 -1
- package/dist/state.cjs +487 -624
- package/dist/state.cjs.map +1 -1
- package/dist/state.d.ts +117 -116
- package/dist/state.js +486 -622
- package/dist/state.js.map +1 -1
- package/dist/sync.cjs +113 -133
- package/dist/sync.cjs.map +1 -1
- package/dist/sync.d.ts +37 -33
- package/dist/sync.js +111 -131
- package/dist/sync.js.map +1 -1
- package/dist/synchronized_tree.cjs +167 -232
- package/dist/synchronized_tree.cjs.map +1 -1
- package/dist/synchronized_tree.d.ts +66 -68
- package/dist/synchronized_tree.js +165 -211
- package/dist/synchronized_tree.js.map +1 -1
- package/dist/traversal_ops.d.ts +42 -42
- package/dist/value_and_error.cjs +9 -12
- package/dist/value_and_error.cjs.map +1 -1
- package/dist/value_and_error.d.ts +8 -5
- package/dist/value_and_error.js +9 -11
- package/dist/value_and_error.js.map +1 -1
- package/dist/value_or_error.d.ts +8 -5
- package/package.json +9 -9
- package/src/synchronized_tree.ts +10 -5
- package/dist/accessors.d.ts.map +0 -1
- package/dist/dump.d.ts.map +0 -1
- package/dist/index.cjs.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/snapshot.d.ts.map +0 -1
- package/dist/state.d.ts.map +0 -1
- package/dist/sync.d.ts.map +0 -1
- package/dist/synchronized_tree.d.ts.map +0 -1
- package/dist/test_utils.d.ts +0 -25
- package/dist/test_utils.d.ts.map +0 -1
- package/dist/traversal_ops.d.ts.map +0 -1
- package/dist/value_and_error.d.ts.map +0 -1
- package/dist/value_or_error.d.ts.map +0 -1
package/dist/accessors.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"accessors.cjs","sources":["../src/accessors.ts"],"sourcesContent":["import type { PlTreeResource, PlTreeState } from \"./state\";\nimport type {\n AccessorProvider,\n ComputableCtx,\n ComputableHooks,\n UsageGuard,\n} from \"@milaboratories/computable\";\nimport type { ResourceId, ResourceType, OptionalResourceId } from \"@milaboratories/pl-client\";\nimport {\n resourceIdToString,\n resourceTypesEqual,\n resourceTypeToString,\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n NullResourceId,\n} from \"@milaboratories/pl-client\";\nimport type { ValueAndError } from \"./value_and_error\";\nimport { mapValueAndError } from \"./value_and_error\";\nimport type {\n CommonFieldTraverseOps,\n FieldTraversalStep,\n GetFieldStep,\n ResourceTraversalOps,\n} from \"./traversal_ops\";\nimport type { ValueOrError } from \"./value_or_error\";\nimport { parsePlError } from \"@milaboratories/pl-errors\";\nimport { notEmpty } from \"@milaboratories/ts-helpers\";\n/** Error encountered during traversal in field or resource. */\nexport class PlError extends Error {\n constructor(message: string) {\n super(message);\n }\n}\n\nexport type TreeAccessorData = {\n readonly treeProvider: () => PlTreeState;\n readonly hooks?: ComputableHooks;\n};\n\nexport type TreeAccessorInstanceData = {\n readonly guard: UsageGuard;\n readonly ctx: ComputableCtx;\n};\n\nexport function isPlTreeEntry(obj: unknown): obj is PlTreeEntry {\n return (\n typeof obj === \"object\" &&\n obj !== null &&\n (obj as any)[\"__pl_tree_type_marker__\"] === \"PlTreeEntry\"\n );\n}\n\nexport function isPlTreeEntryAccessor(obj: unknown): obj is PlTreeEntryAccessor {\n return (\n typeof obj === \"object\" &&\n obj !== null &&\n (obj as any)[\"__pl_tree_type_marker__\"] === \"PlTreeEntryAccessor\"\n );\n}\n\nexport function isPlTreeNodeAccessor(obj: unknown): obj is PlTreeNodeAccessor {\n return (\n typeof obj === \"object\" &&\n obj !== null &&\n (obj as any)[\"__pl_tree_type_marker__\"] === \"PlTreeNodeAccessor\"\n );\n}\n\n/** Main entry point for using PlTree in reactive setting */\nexport class PlTreeEntry implements AccessorProvider<PlTreeEntryAccessor> {\n private readonly __pl_tree_type_marker__ = \"PlTreeEntry\";\n\n constructor(\n private readonly accessorData: TreeAccessorData,\n public readonly rid: ResourceId,\n ) {}\n\n public createAccessor(ctx: ComputableCtx, guard: UsageGuard): PlTreeEntryAccessor {\n return new PlTreeEntryAccessor(this.accessorData, this.accessorData.treeProvider(), this.rid, {\n ctx,\n guard,\n });\n }\n\n public toJSON(): string {\n return this.toString();\n }\n\n public toString(): string {\n return `[ENTRY:${resourceIdToString(this.rid)}]`;\n }\n}\n\nfunction getResourceFromTree(\n accessorData: TreeAccessorData,\n tree: PlTreeState,\n instanceData: TreeAccessorInstanceData,\n rid: ResourceId,\n ops: ResourceTraversalOps,\n): PlTreeNodeAccessor {\n const acc = new PlTreeNodeAccessor(\n accessorData,\n tree,\n tree.get(instanceData.ctx.watcher, rid),\n instanceData,\n );\n\n if (!ops.ignoreError) {\n const err = acc.getError();\n if (err !== undefined)\n throw parsePlError(notEmpty(err.getDataAsString()), acc.id, acc.resourceType);\n }\n\n if (\n ops.assertResourceType !== undefined &&\n (Array.isArray(ops.assertResourceType)\n ? ops.assertResourceType.findIndex((rt) => resourceTypesEqual(rt, acc.resourceType)) === -1\n : !resourceTypesEqual(ops.assertResourceType, acc.resourceType))\n )\n throw new Error(\n // eslint-disable-next-line @typescript-eslint/no-base-to-string\n `wrong resource type ${resourceTypeToString(acc.resourceType)} but expected ${ops.assertResourceType}`,\n );\n\n return acc;\n}\n\nexport class PlTreeEntryAccessor {\n private readonly __pl_tree_type_marker__ = \"PlTreeEntryAccessor\";\n\n constructor(\n private readonly accessorData: TreeAccessorData,\n private readonly tree: PlTreeState,\n private readonly rid: ResourceId,\n private readonly instanceData: TreeAccessorInstanceData,\n ) {}\n\n node(ops: ResourceTraversalOps = {}): PlTreeNodeAccessor {\n this.instanceData.guard();\n\n // this is the only entry point to acquire a PlTreeNodeAccessor,\n // so this is the only point where we should attach the hooks\n if (this.accessorData.hooks !== undefined)\n this.instanceData.ctx.attacheHooks(this.accessorData.hooks);\n\n return getResourceFromTree(this.accessorData, this.tree, this.instanceData, this.rid, ops);\n }\n}\n\n/**\n * Helper type to simplify implementation of APIs requiring type information.\n * */\nexport type ResourceInfo = {\n readonly id: ResourceId;\n readonly type: ResourceType;\n};\n\n/**\n * Can be called only when a ctx is provided, because pl tree entry is a computable entity.\n * @deprecated\n * */\nexport function treeEntryToResourceInfo(res: PlTreeEntry | ResourceInfo, ctx: ComputableCtx) {\n if (res instanceof PlTreeEntry) return ctx.accessor(res).node().resourceInfo;\n\n return res;\n}\n\n/**\n * API contracts:\n * - API never return {@link NullResourceId}, absence of link is always modeled as `undefined`\n *\n * Important: never store instances of this class, always get fresh instance from {@link PlTreeState} accessor.\n * */\nexport class PlTreeNodeAccessor {\n private readonly __pl_tree_type_marker__ = \"PlTreeNodeAccessor\";\n\n constructor(\n private readonly accessorData: TreeAccessorData,\n private readonly tree: PlTreeState,\n private readonly resource: PlTreeResource,\n private readonly instanceData: TreeAccessorInstanceData,\n ) {}\n\n public get id(): ResourceId {\n this.instanceData.guard();\n return this.resource.id;\n }\n\n public get originalId(): OptionalResourceId {\n this.instanceData.guard();\n return this.resource.originalResourceId;\n }\n\n public get resourceType(): ResourceType {\n this.instanceData.guard();\n return this.resource.type;\n }\n\n public get resourceInfo(): ResourceInfo {\n return { id: this.id, type: this.resourceType };\n }\n\n private getResourceFromTree(rid: ResourceId, ops: ResourceTraversalOps): PlTreeNodeAccessor {\n return getResourceFromTree(this.accessorData, this.tree, this.instanceData, rid, ops);\n }\n\n public traverse(\n ...steps: [\n Omit<FieldTraversalStep, \"errorIfFieldNotSet\"> & {\n errorIfFieldNotSet: true;\n },\n ]\n ): PlTreeNodeAccessor;\n public traverse(...steps: (FieldTraversalStep | string)[]): PlTreeNodeAccessor | undefined;\n public traverse(...steps: (FieldTraversalStep | string)[]): PlTreeNodeAccessor | undefined {\n return this.traverseWithCommon({}, ...steps);\n }\n\n public traverseOrError(\n ...steps: [\n Omit<FieldTraversalStep, \"errorIfFieldNotSet\"> & {\n errorIfFieldNotSet: true;\n },\n ]\n ): ValueOrError<PlTreeNodeAccessor, Error>;\n public traverseOrError(\n ...steps: (FieldTraversalStep | string)[]\n ): ValueOrError<PlTreeNodeAccessor, Error> | undefined;\n public traverseOrError(\n ...steps: (FieldTraversalStep | string)[]\n ): ValueOrError<PlTreeNodeAccessor, Error> | undefined {\n return this.traverseOrErrorWithCommon({}, ...steps);\n }\n\n public traverseWithCommon(\n commonOptions: CommonFieldTraverseOps,\n ...steps: (FieldTraversalStep | string)[]\n ): PlTreeNodeAccessor | undefined {\n const result = this.traverseOrErrorWithCommon(commonOptions, ...steps);\n if (result === undefined) return undefined;\n\n if (!result.ok) throw result.error;\n return result.value;\n }\n\n public traverseOrErrorWithCommon(\n commonOptions: CommonFieldTraverseOps,\n ...steps: (FieldTraversalStep | string)[]\n ): ValueOrError<PlTreeNodeAccessor, Error> | undefined {\n // eslint-disable-next-line @typescript-eslint/no-this-alias\n let current: PlTreeNodeAccessor = this;\n\n for (const _step of steps) {\n const step: FieldTraversalStep =\n typeof _step === \"string\"\n ? {\n ...commonOptions,\n field: _step,\n }\n : { ...commonOptions, ..._step };\n\n const next = current.getField(_step);\n\n if (next === undefined) return undefined;\n\n if (step.pureFieldErrorToUndefined && next.value === undefined && next.error !== undefined)\n return undefined;\n\n if ((!step.ignoreError || next.value === undefined) && next.error !== undefined)\n return {\n ok: false,\n\n // FIXME: in next tickets we'll allow Errors to be thrown.\n error: parsePlError(\n notEmpty(next.error.getDataAsString()),\n current.id,\n current.resourceType,\n step.field,\n ),\n };\n\n if (next.value === undefined) {\n if (step.errorIfFieldNotSet)\n return {\n ok: false,\n error: new Error(\n `field have no assigned value ${step.field} of ${resourceIdToString(current.id)}`,\n ),\n };\n // existing but unpopulated field is unstable because it must be resolved at some point\n this.onUnstableLambda(\"unpopulated_field:\" + step.field);\n return undefined;\n }\n\n current = next.value;\n }\n return { ok: true, value: current };\n }\n\n private readonly onUnstableLambda = (marker: string) => {\n this.instanceData.ctx.markUnstable(marker);\n };\n\n public getField(\n _step:\n | (Omit<GetFieldStep, \"errorIfFieldNotFound\"> & { errorIfFieldNotFound: true })\n | (Omit<GetFieldStep, \"errorIfFieldNotSet\"> & { errorIfFieldNotSet: true }),\n ): ValueAndError<PlTreeNodeAccessor>;\n public getField(_step: GetFieldStep | string): ValueAndError<PlTreeNodeAccessor> | undefined;\n public getField(_step: GetFieldStep | string): ValueAndError<PlTreeNodeAccessor> | undefined {\n this.instanceData.guard();\n const step: GetFieldStep = typeof _step === \"string\" ? { field: _step } : _step;\n\n const ve = this.resource.getField(this.instanceData.ctx.watcher, step, this.onUnstableLambda);\n\n if (ve === undefined) return undefined;\n\n return mapValueAndError(ve, (rid) => this.getResourceFromTree(rid, { ignoreError: true }));\n }\n\n public getInputsLocked(): boolean {\n this.instanceData.guard();\n const result = this.resource.getInputsLocked(this.instanceData.ctx.watcher);\n if (!result) this.instanceData.ctx.markUnstable(\"inputs_unlocked:\" + this.resourceType.name);\n return result;\n }\n\n public getOutputsLocked(): boolean {\n this.instanceData.guard();\n const result = this.resource.getOutputsLocked(this.instanceData.ctx.watcher);\n if (!result) this.instanceData.ctx.markUnstable(\"outputs_unlocked:\" + this.resourceType.name);\n return result;\n }\n\n public getIsReadyOrError(): boolean {\n this.instanceData.guard();\n const result = this.resource.getIsReadyOrError(this.instanceData.ctx.watcher);\n if (!result) this.instanceData.ctx.markUnstable(\"not_ready:\" + this.resourceType.name);\n return result;\n }\n\n public getIsFinal() {\n this.instanceData.guard();\n return this.resource.getIsFinal(this.instanceData.ctx.watcher);\n }\n\n public getError(): PlTreeNodeAccessor | undefined {\n this.instanceData.guard();\n const rid = this.resource.getError(this.instanceData.ctx.watcher);\n if (rid === undefined)\n // absence of error always considered as stable\n return undefined;\n return this.getResourceFromTree(rid, {});\n }\n\n public getData(): Uint8Array | undefined {\n return this.resource.data;\n }\n\n public getDataAsString(): string | undefined {\n return this.resource.getDataAsString();\n }\n\n public getDataAsJson<T = unknown>(): T | undefined {\n return this.resource.getDataAsJson<T>();\n }\n\n public listInputFields(): string[] {\n this.instanceData.guard();\n this.getInputsLocked(); // will set unstable if not locked\n return this.resource.listInputFields(this.instanceData.ctx.watcher);\n }\n\n public listOutputFields(): string[] {\n this.instanceData.guard();\n this.getOutputsLocked(); // will set unstable if not locked\n return this.resource.listOutputFields(this.instanceData.ctx.watcher);\n }\n\n public listDynamicFields(): string[] {\n this.instanceData.guard();\n return this.resource.listDynamicFields(this.instanceData.ctx.watcher);\n }\n\n public getKeyValue(key: string, unstableIfNotFound: boolean = false): Uint8Array | undefined {\n this.instanceData.guard();\n const result = this.resource.getKeyValue(this.instanceData.ctx.watcher, key);\n if (result === undefined && unstableIfNotFound)\n this.instanceData.ctx.markUnstable(\"key_not_found_b:\" + key);\n return result;\n }\n\n /** @deprecated */\n public getKeyValueString(key: string): string | undefined {\n return this.getKeyValueAsString(key);\n }\n\n public getKeyValueAsString(key: string, unstableIfNotFound: boolean = false): string | undefined {\n this.instanceData.guard();\n const result = this.resource.getKeyValueString(this.instanceData.ctx.watcher, key);\n if (result === undefined && unstableIfNotFound)\n this.instanceData.ctx.markUnstable(\"key_not_found_s:\" + key);\n return result;\n }\n\n public getKeyValueAsJson<T = unknown>(\n key: string,\n unstableIfNotFound: boolean = false,\n ): T | undefined {\n const result = this.resource.getKeyValueAsJson<T>(this.instanceData.ctx.watcher, key);\n if (result === undefined) {\n if (unstableIfNotFound) this.instanceData.ctx.markUnstable(\"key_not_found_j:\" + key);\n return undefined;\n }\n return result;\n }\n\n /**\n * Can be used to pass a higher level accessor that will wrap the resource and throw its\n * errors on node resolution.\n * */\n public toEntryAccessor(): PlTreeEntryAccessor {\n return new PlTreeEntryAccessor(this.accessorData, this.tree, this.id, this.instanceData);\n }\n\n /** Can be passed to nested computable. */\n public persist(): PlTreeEntry {\n return new PlTreeEntry(this.accessorData, this.resource.id);\n }\n}\n"],"names":["resourceIdToString","parsePlError","notEmpty","resourceTypesEqual","resourceTypeToString","mapValueAndError"],"mappings":";;;;;;;AA0BA;AACM,MAAO,OAAQ,SAAQ,KAAK,CAAA;AAChC,IAAA,WAAA,CAAY,OAAe,EAAA;QACzB,KAAK,CAAC,OAAO,CAAC;IAChB;AACD;AAYK,SAAU,aAAa,CAAC,GAAY,EAAA;AACxC,IAAA,QACE,OAAO,GAAG,KAAK,QAAQ;AACvB,QAAA,GAAG,KAAK,IAAI;AACX,QAAA,GAAW,CAAC,yBAAyB,CAAC,KAAK,aAAa;AAE7D;AAEM,SAAU,qBAAqB,CAAC,GAAY,EAAA;AAChD,IAAA,QACE,OAAO,GAAG,KAAK,QAAQ;AACvB,QAAA,GAAG,KAAK,IAAI;AACX,QAAA,GAAW,CAAC,yBAAyB,CAAC,KAAK,qBAAqB;AAErE;AAEM,SAAU,oBAAoB,CAAC,GAAY,EAAA;AAC/C,IAAA,QACE,OAAO,GAAG,KAAK,QAAQ;AACvB,QAAA,GAAG,KAAK,IAAI;AACX,QAAA,GAAW,CAAC,yBAAyB,CAAC,KAAK,oBAAoB;AAEpE;AAEA;MACa,WAAW,CAAA;AAIH,IAAA,YAAA;AACD,IAAA,GAAA;IAJD,uBAAuB,GAAG,aAAa;IAExD,WAAA,CACmB,YAA8B,EAC/B,GAAe,EAAA;QADd,IAAA,CAAA,YAAY,GAAZ,YAAY;QACb,IAAA,CAAA,GAAG,GAAH,GAAG;IAClB;IAEI,cAAc,CAAC,GAAkB,EAAE,KAAiB,EAAA;AACzD,QAAA,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;YAC5F,GAAG;YACH,KAAK;AACN,SAAA,CAAC;IACJ;IAEO,MAAM,GAAA;AACX,QAAA,OAAO,IAAI,CAAC,QAAQ,EAAE;IACxB;IAEO,QAAQ,GAAA;QACb,OAAO,CAAA,OAAA,EAAUA,2BAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG;IAClD;AACD;AAED,SAAS,mBAAmB,CAC1B,YAA8B,EAC9B,IAAiB,EACjB,YAAsC,EACtC,GAAe,EACf,GAAyB,EAAA;IAEzB,MAAM,GAAG,GAAG,IAAI,kBAAkB,CAChC,YAAY,EACZ,IAAI,EACJ,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,EACvC,YAAY,CACb;AAED,IAAA,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE;AACpB,QAAA,MAAM,GAAG,GAAG,GAAG,CAAC,QAAQ,EAAE;QAC1B,IAAI,GAAG,KAAK,SAAS;AACnB,YAAA,MAAMC,qBAAY,CAACC,kBAAQ,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,YAAY,CAAC;IACjF;AAEA,IAAA,IACE,GAAG,CAAC,kBAAkB,KAAK,SAAS;AACpC,SAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB;cACjC,GAAG,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,EAAE,KAAKC,2BAAkB,CAAC,EAAE,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,KAAK;AACzF,cAAE,CAACA,2BAAkB,CAAC,GAAG,CAAC,kBAAkB,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;AAElE,QAAA,MAAM,IAAI,KAAK;;AAEb,QAAA,CAAA,oBAAA,EAAuBC,6BAAoB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA,cAAA,EAAiB,GAAG,CAAC,kBAAkB,CAAA,CAAE,CACvG;AAEH,IAAA,OAAO,GAAG;AACZ;MAEa,mBAAmB,CAAA;AAIX,IAAA,YAAA;AACA,IAAA,IAAA;AACA,IAAA,GAAA;AACA,IAAA,YAAA;IANF,uBAAuB,GAAG,qBAAqB;AAEhE,IAAA,WAAA,CACmB,YAA8B,EAC9B,IAAiB,EACjB,GAAe,EACf,YAAsC,EAAA;QAHtC,IAAA,CAAA,YAAY,GAAZ,YAAY;QACZ,IAAA,CAAA,IAAI,GAAJ,IAAI;QACJ,IAAA,CAAA,GAAG,GAAH,GAAG;QACH,IAAA,CAAA,YAAY,GAAZ,YAAY;IAC5B;IAEH,IAAI,CAAC,MAA4B,EAAE,EAAA;AACjC,QAAA,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;;;AAIzB,QAAA,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,KAAK,SAAS;AACvC,YAAA,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;QAE7D,OAAO,mBAAmB,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC;IAC5F;AACD;AAUD;;;AAGK;AACC,SAAU,uBAAuB,CAAC,GAA+B,EAAE,GAAkB,EAAA;IACzF,IAAI,GAAG,YAAY,WAAW;QAAE,OAAO,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,YAAY;AAE5E,IAAA,OAAO,GAAG;AACZ;AAEA;;;;;AAKK;MACQ,kBAAkB,CAAA;AAIV,IAAA,YAAA;AACA,IAAA,IAAA;AACA,IAAA,QAAA;AACA,IAAA,YAAA;IANF,uBAAuB,GAAG,oBAAoB;AAE/D,IAAA,WAAA,CACmB,YAA8B,EAC9B,IAAiB,EACjB,QAAwB,EACxB,YAAsC,EAAA;QAHtC,IAAA,CAAA,YAAY,GAAZ,YAAY;QACZ,IAAA,CAAA,IAAI,GAAJ,IAAI;QACJ,IAAA,CAAA,QAAQ,GAAR,QAAQ;QACR,IAAA,CAAA,YAAY,GAAZ,YAAY;IAC5B;AAEH,IAAA,IAAW,EAAE,GAAA;AACX,QAAA,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;AACzB,QAAA,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE;IACzB;AAEA,IAAA,IAAW,UAAU,GAAA;AACnB,QAAA,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;AACzB,QAAA,OAAO,IAAI,CAAC,QAAQ,CAAC,kBAAkB;IACzC;AAEA,IAAA,IAAW,YAAY,GAAA;AACrB,QAAA,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;AACzB,QAAA,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI;IAC3B;AAEA,IAAA,IAAW,YAAY,GAAA;AACrB,QAAA,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE;IACjD;IAEQ,mBAAmB,CAAC,GAAe,EAAE,GAAyB,EAAA;AACpE,QAAA,OAAO,mBAAmB,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE,GAAG,CAAC;IACvF;IAUO,QAAQ,CAAC,GAAG,KAAsC,EAAA;QACvD,OAAO,IAAI,CAAC,kBAAkB,CAAC,EAAE,EAAE,GAAG,KAAK,CAAC;IAC9C;IAYO,eAAe,CACpB,GAAG,KAAsC,EAAA;QAEzC,OAAO,IAAI,CAAC,yBAAyB,CAAC,EAAE,EAAE,GAAG,KAAK,CAAC;IACrD;AAEO,IAAA,kBAAkB,CACvB,aAAqC,EACrC,GAAG,KAAsC,EAAA;QAEzC,MAAM,MAAM,GAAG,IAAI,CAAC,yBAAyB,CAAC,aAAa,EAAE,GAAG,KAAK,CAAC;QACtE,IAAI,MAAM,KAAK,SAAS;AAAE,YAAA,OAAO,SAAS;QAE1C,IAAI,CAAC,MAAM,CAAC,EAAE;YAAE,MAAM,MAAM,CAAC,KAAK;QAClC,OAAO,MAAM,CAAC,KAAK;IACrB;AAEO,IAAA,yBAAyB,CAC9B,aAAqC,EACrC,GAAG,KAAsC,EAAA;;QAGzC,IAAI,OAAO,GAAuB,IAAI;AAEtC,QAAA,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE;AACzB,YAAA,MAAM,IAAI,GACR,OAAO,KAAK,KAAK;AACf,kBAAE;AACE,oBAAA,GAAG,aAAa;AAChB,oBAAA,KAAK,EAAE,KAAK;AACb;kBACD,EAAE,GAAG,aAAa,EAAE,GAAG,KAAK,EAAE;YAEpC,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;YAEpC,IAAI,IAAI,KAAK,SAAS;AAAE,gBAAA,OAAO,SAAS;AAExC,YAAA,IAAI,IAAI,CAAC,yBAAyB,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS;AACxF,gBAAA,OAAO,SAAS;AAElB,YAAA,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,KAAK,IAAI,CAAC,KAAK,KAAK,SAAS;gBAC7E,OAAO;AACL,oBAAA,EAAE,EAAE,KAAK;;oBAGT,KAAK,EAAEH,qBAAY,CACjBC,kBAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC,EACtC,OAAO,CAAC,EAAE,EACV,OAAO,CAAC,YAAY,EACpB,IAAI,CAAC,KAAK,CACX;iBACF;AAEH,YAAA,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE;gBAC5B,IAAI,IAAI,CAAC,kBAAkB;oBACzB,OAAO;AACL,wBAAA,EAAE,EAAE,KAAK;AACT,wBAAA,KAAK,EAAE,IAAI,KAAK,CACd,CAAA,6BAAA,EAAgC,IAAI,CAAC,KAAK,CAAA,IAAA,EAAOF,2BAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAClF;qBACF;;gBAEH,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,GAAG,IAAI,CAAC,KAAK,CAAC;AACxD,gBAAA,OAAO,SAAS;YAClB;AAEA,YAAA,OAAO,GAAG,IAAI,CAAC,KAAK;QACtB;QACA,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE;IACrC;AAEiB,IAAA,gBAAgB,GAAG,CAAC,MAAc,KAAI;QACrD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC;AAC5C,IAAA,CAAC;AAQM,IAAA,QAAQ,CAAC,KAA4B,EAAA;AAC1C,QAAA,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;AACzB,QAAA,MAAM,IAAI,GAAiB,OAAO,KAAK,KAAK,QAAQ,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,KAAK;QAE/E,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,gBAAgB,CAAC;QAE7F,IAAI,EAAE,KAAK,SAAS;AAAE,YAAA,OAAO,SAAS;QAEtC,OAAOK,gCAAgB,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5F;IAEO,eAAe,GAAA;AACpB,QAAA,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;AACzB,QAAA,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC;AAC3E,QAAA,IAAI,CAAC,MAAM;AAAE,YAAA,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;AAC5F,QAAA,OAAO,MAAM;IACf;IAEO,gBAAgB,GAAA;AACrB,QAAA,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;AACzB,QAAA,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC;AAC5E,QAAA,IAAI,CAAC,MAAM;AAAE,YAAA,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,mBAAmB,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;AAC7F,QAAA,OAAO,MAAM;IACf;IAEO,iBAAiB,GAAA;AACtB,QAAA,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;AACzB,QAAA,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC;AAC7E,QAAA,IAAI,CAAC,MAAM;AAAE,YAAA,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;AACtF,QAAA,OAAO,MAAM;IACf;IAEO,UAAU,GAAA;AACf,QAAA,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;AACzB,QAAA,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC;IAChE;IAEO,QAAQ,GAAA;AACb,QAAA,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;AACzB,QAAA,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC;QACjE,IAAI,GAAG,KAAK,SAAS;;AAEnB,YAAA,OAAO,SAAS;QAClB,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,EAAE,CAAC;IAC1C;IAEO,OAAO,GAAA;AACZ,QAAA,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI;IAC3B;IAEO,eAAe,GAAA;AACpB,QAAA,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE;IACxC;IAEO,aAAa,GAAA;AAClB,QAAA,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAK;IACzC;IAEO,eAAe,GAAA;AACpB,QAAA,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;AACzB,QAAA,IAAI,CAAC,eAAe,EAAE,CAAC;AACvB,QAAA,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC;IACrE;IAEO,gBAAgB,GAAA;AACrB,QAAA,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;AACzB,QAAA,IAAI,CAAC,gBAAgB,EAAE,CAAC;AACxB,QAAA,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC;IACtE;IAEO,iBAAiB,GAAA;AACtB,QAAA,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;AACzB,QAAA,OAAO,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC;IACvE;AAEO,IAAA,WAAW,CAAC,GAAW,EAAE,kBAAA,GAA8B,KAAK,EAAA;AACjE,QAAA,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;AACzB,QAAA,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC;AAC5E,QAAA,IAAI,MAAM,KAAK,SAAS,IAAI,kBAAkB;YAC5C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,kBAAkB,GAAG,GAAG,CAAC;AAC9D,QAAA,OAAO,MAAM;IACf;;AAGO,IAAA,iBAAiB,CAAC,GAAW,EAAA;AAClC,QAAA,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC;IACtC;AAEO,IAAA,mBAAmB,CAAC,GAAW,EAAE,kBAAA,GAA8B,KAAK,EAAA;AACzE,QAAA,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;AACzB,QAAA,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC;AAClF,QAAA,IAAI,MAAM,KAAK,SAAS,IAAI,kBAAkB;YAC5C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,kBAAkB,GAAG,GAAG,CAAC;AAC9D,QAAA,OAAO,MAAM;IACf;AAEO,IAAA,iBAAiB,CACtB,GAAW,EACX,kBAAA,GAA8B,KAAK,EAAA;AAEnC,QAAA,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAI,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC;AACrF,QAAA,IAAI,MAAM,KAAK,SAAS,EAAE;AACxB,YAAA,IAAI,kBAAkB;gBAAE,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,kBAAkB,GAAG,GAAG,CAAC;AACpF,YAAA,OAAO,SAAS;QAClB;AACA,QAAA,OAAO,MAAM;IACf;AAEA;;;AAGK;IACE,eAAe,GAAA;AACpB,QAAA,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,YAAY,CAAC;IAC1F;;IAGO,OAAO,GAAA;AACZ,QAAA,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC7D;AACD;;;;;;;;;;;"}
|
|
1
|
+
{"version":3,"file":"accessors.cjs","names":["mapValueAndError"],"sources":["../src/accessors.ts"],"sourcesContent":["import type { PlTreeResource, PlTreeState } from \"./state\";\nimport type {\n AccessorProvider,\n ComputableCtx,\n ComputableHooks,\n UsageGuard,\n} from \"@milaboratories/computable\";\nimport type { ResourceId, ResourceType, OptionalResourceId } from \"@milaboratories/pl-client\";\nimport {\n resourceIdToString,\n resourceTypesEqual,\n resourceTypeToString,\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n NullResourceId,\n} from \"@milaboratories/pl-client\";\nimport type { ValueAndError } from \"./value_and_error\";\nimport { mapValueAndError } from \"./value_and_error\";\nimport type {\n CommonFieldTraverseOps,\n FieldTraversalStep,\n GetFieldStep,\n ResourceTraversalOps,\n} from \"./traversal_ops\";\nimport type { ValueOrError } from \"./value_or_error\";\nimport { parsePlError } from \"@milaboratories/pl-errors\";\nimport { notEmpty } from \"@milaboratories/ts-helpers\";\n/** Error encountered during traversal in field or resource. */\nexport class PlError extends Error {\n constructor(message: string) {\n super(message);\n }\n}\n\nexport type TreeAccessorData = {\n readonly treeProvider: () => PlTreeState;\n readonly hooks?: ComputableHooks;\n};\n\nexport type TreeAccessorInstanceData = {\n readonly guard: UsageGuard;\n readonly ctx: ComputableCtx;\n};\n\nexport function isPlTreeEntry(obj: unknown): obj is PlTreeEntry {\n return (\n typeof obj === \"object\" &&\n obj !== null &&\n (obj as any)[\"__pl_tree_type_marker__\"] === \"PlTreeEntry\"\n );\n}\n\nexport function isPlTreeEntryAccessor(obj: unknown): obj is PlTreeEntryAccessor {\n return (\n typeof obj === \"object\" &&\n obj !== null &&\n (obj as any)[\"__pl_tree_type_marker__\"] === \"PlTreeEntryAccessor\"\n );\n}\n\nexport function isPlTreeNodeAccessor(obj: unknown): obj is PlTreeNodeAccessor {\n return (\n typeof obj === \"object\" &&\n obj !== null &&\n (obj as any)[\"__pl_tree_type_marker__\"] === \"PlTreeNodeAccessor\"\n );\n}\n\n/** Main entry point for using PlTree in reactive setting */\nexport class PlTreeEntry implements AccessorProvider<PlTreeEntryAccessor> {\n private readonly __pl_tree_type_marker__ = \"PlTreeEntry\";\n\n constructor(\n private readonly accessorData: TreeAccessorData,\n public readonly rid: ResourceId,\n ) {}\n\n public createAccessor(ctx: ComputableCtx, guard: UsageGuard): PlTreeEntryAccessor {\n return new PlTreeEntryAccessor(this.accessorData, this.accessorData.treeProvider(), this.rid, {\n ctx,\n guard,\n });\n }\n\n public toJSON(): string {\n return this.toString();\n }\n\n public toString(): string {\n return `[ENTRY:${resourceIdToString(this.rid)}]`;\n }\n}\n\nfunction getResourceFromTree(\n accessorData: TreeAccessorData,\n tree: PlTreeState,\n instanceData: TreeAccessorInstanceData,\n rid: ResourceId,\n ops: ResourceTraversalOps,\n): PlTreeNodeAccessor {\n const acc = new PlTreeNodeAccessor(\n accessorData,\n tree,\n tree.get(instanceData.ctx.watcher, rid),\n instanceData,\n );\n\n if (!ops.ignoreError) {\n const err = acc.getError();\n if (err !== undefined)\n throw parsePlError(notEmpty(err.getDataAsString()), acc.id, acc.resourceType);\n }\n\n if (\n ops.assertResourceType !== undefined &&\n (Array.isArray(ops.assertResourceType)\n ? ops.assertResourceType.findIndex((rt) => resourceTypesEqual(rt, acc.resourceType)) === -1\n : !resourceTypesEqual(ops.assertResourceType, acc.resourceType))\n )\n throw new Error(\n // eslint-disable-next-line @typescript-eslint/no-base-to-string\n `wrong resource type ${resourceTypeToString(acc.resourceType)} but expected ${ops.assertResourceType}`,\n );\n\n return acc;\n}\n\nexport class PlTreeEntryAccessor {\n private readonly __pl_tree_type_marker__ = \"PlTreeEntryAccessor\";\n\n constructor(\n private readonly accessorData: TreeAccessorData,\n private readonly tree: PlTreeState,\n private readonly rid: ResourceId,\n private readonly instanceData: TreeAccessorInstanceData,\n ) {}\n\n node(ops: ResourceTraversalOps = {}): PlTreeNodeAccessor {\n this.instanceData.guard();\n\n // this is the only entry point to acquire a PlTreeNodeAccessor,\n // so this is the only point where we should attach the hooks\n if (this.accessorData.hooks !== undefined)\n this.instanceData.ctx.attacheHooks(this.accessorData.hooks);\n\n return getResourceFromTree(this.accessorData, this.tree, this.instanceData, this.rid, ops);\n }\n}\n\n/**\n * Helper type to simplify implementation of APIs requiring type information.\n * */\nexport type ResourceInfo = {\n readonly id: ResourceId;\n readonly type: ResourceType;\n};\n\n/**\n * Can be called only when a ctx is provided, because pl tree entry is a computable entity.\n * @deprecated\n * */\nexport function treeEntryToResourceInfo(res: PlTreeEntry | ResourceInfo, ctx: ComputableCtx) {\n if (res instanceof PlTreeEntry) return ctx.accessor(res).node().resourceInfo;\n\n return res;\n}\n\n/**\n * API contracts:\n * - API never return {@link NullResourceId}, absence of link is always modeled as `undefined`\n *\n * Important: never store instances of this class, always get fresh instance from {@link PlTreeState} accessor.\n * */\nexport class PlTreeNodeAccessor {\n private readonly __pl_tree_type_marker__ = \"PlTreeNodeAccessor\";\n\n constructor(\n private readonly accessorData: TreeAccessorData,\n private readonly tree: PlTreeState,\n private readonly resource: PlTreeResource,\n private readonly instanceData: TreeAccessorInstanceData,\n ) {}\n\n public get id(): ResourceId {\n this.instanceData.guard();\n return this.resource.id;\n }\n\n public get originalId(): OptionalResourceId {\n this.instanceData.guard();\n return this.resource.originalResourceId;\n }\n\n public get resourceType(): ResourceType {\n this.instanceData.guard();\n return this.resource.type;\n }\n\n public get resourceInfo(): ResourceInfo {\n return { id: this.id, type: this.resourceType };\n }\n\n private getResourceFromTree(rid: ResourceId, ops: ResourceTraversalOps): PlTreeNodeAccessor {\n return getResourceFromTree(this.accessorData, this.tree, this.instanceData, rid, ops);\n }\n\n public traverse(\n ...steps: [\n Omit<FieldTraversalStep, \"errorIfFieldNotSet\"> & {\n errorIfFieldNotSet: true;\n },\n ]\n ): PlTreeNodeAccessor;\n public traverse(...steps: (FieldTraversalStep | string)[]): PlTreeNodeAccessor | undefined;\n public traverse(...steps: (FieldTraversalStep | string)[]): PlTreeNodeAccessor | undefined {\n return this.traverseWithCommon({}, ...steps);\n }\n\n public traverseOrError(\n ...steps: [\n Omit<FieldTraversalStep, \"errorIfFieldNotSet\"> & {\n errorIfFieldNotSet: true;\n },\n ]\n ): ValueOrError<PlTreeNodeAccessor, Error>;\n public traverseOrError(\n ...steps: (FieldTraversalStep | string)[]\n ): ValueOrError<PlTreeNodeAccessor, Error> | undefined;\n public traverseOrError(\n ...steps: (FieldTraversalStep | string)[]\n ): ValueOrError<PlTreeNodeAccessor, Error> | undefined {\n return this.traverseOrErrorWithCommon({}, ...steps);\n }\n\n public traverseWithCommon(\n commonOptions: CommonFieldTraverseOps,\n ...steps: (FieldTraversalStep | string)[]\n ): PlTreeNodeAccessor | undefined {\n const result = this.traverseOrErrorWithCommon(commonOptions, ...steps);\n if (result === undefined) return undefined;\n\n if (!result.ok) throw result.error;\n return result.value;\n }\n\n public traverseOrErrorWithCommon(\n commonOptions: CommonFieldTraverseOps,\n ...steps: (FieldTraversalStep | string)[]\n ): ValueOrError<PlTreeNodeAccessor, Error> | undefined {\n // eslint-disable-next-line @typescript-eslint/no-this-alias\n let current: PlTreeNodeAccessor = this;\n\n for (const _step of steps) {\n const step: FieldTraversalStep =\n typeof _step === \"string\"\n ? {\n ...commonOptions,\n field: _step,\n }\n : { ...commonOptions, ..._step };\n\n const next = current.getField(_step);\n\n if (next === undefined) return undefined;\n\n if (step.pureFieldErrorToUndefined && next.value === undefined && next.error !== undefined)\n return undefined;\n\n if ((!step.ignoreError || next.value === undefined) && next.error !== undefined)\n return {\n ok: false,\n\n // FIXME: in next tickets we'll allow Errors to be thrown.\n error: parsePlError(\n notEmpty(next.error.getDataAsString()),\n current.id,\n current.resourceType,\n step.field,\n ),\n };\n\n if (next.value === undefined) {\n if (step.errorIfFieldNotSet)\n return {\n ok: false,\n error: new Error(\n `field have no assigned value ${step.field} of ${resourceIdToString(current.id)}`,\n ),\n };\n // existing but unpopulated field is unstable because it must be resolved at some point\n this.onUnstableLambda(\"unpopulated_field:\" + step.field);\n return undefined;\n }\n\n current = next.value;\n }\n return { ok: true, value: current };\n }\n\n private readonly onUnstableLambda = (marker: string) => {\n this.instanceData.ctx.markUnstable(marker);\n };\n\n public getField(\n _step:\n | (Omit<GetFieldStep, \"errorIfFieldNotFound\"> & { errorIfFieldNotFound: true })\n | (Omit<GetFieldStep, \"errorIfFieldNotSet\"> & { errorIfFieldNotSet: true }),\n ): ValueAndError<PlTreeNodeAccessor>;\n public getField(_step: GetFieldStep | string): ValueAndError<PlTreeNodeAccessor> | undefined;\n public getField(_step: GetFieldStep | string): ValueAndError<PlTreeNodeAccessor> | undefined {\n this.instanceData.guard();\n const step: GetFieldStep = typeof _step === \"string\" ? { field: _step } : _step;\n\n const ve = this.resource.getField(this.instanceData.ctx.watcher, step, this.onUnstableLambda);\n\n if (ve === undefined) return undefined;\n\n return mapValueAndError(ve, (rid) => this.getResourceFromTree(rid, { ignoreError: true }));\n }\n\n public getInputsLocked(): boolean {\n this.instanceData.guard();\n const result = this.resource.getInputsLocked(this.instanceData.ctx.watcher);\n if (!result) this.instanceData.ctx.markUnstable(\"inputs_unlocked:\" + this.resourceType.name);\n return result;\n }\n\n public getOutputsLocked(): boolean {\n this.instanceData.guard();\n const result = this.resource.getOutputsLocked(this.instanceData.ctx.watcher);\n if (!result) this.instanceData.ctx.markUnstable(\"outputs_unlocked:\" + this.resourceType.name);\n return result;\n }\n\n public getIsReadyOrError(): boolean {\n this.instanceData.guard();\n const result = this.resource.getIsReadyOrError(this.instanceData.ctx.watcher);\n if (!result) this.instanceData.ctx.markUnstable(\"not_ready:\" + this.resourceType.name);\n return result;\n }\n\n public getIsFinal() {\n this.instanceData.guard();\n return this.resource.getIsFinal(this.instanceData.ctx.watcher);\n }\n\n public getError(): PlTreeNodeAccessor | undefined {\n this.instanceData.guard();\n const rid = this.resource.getError(this.instanceData.ctx.watcher);\n if (rid === undefined)\n // absence of error always considered as stable\n return undefined;\n return this.getResourceFromTree(rid, {});\n }\n\n public getData(): Uint8Array | undefined {\n return this.resource.data;\n }\n\n public getDataAsString(): string | undefined {\n return this.resource.getDataAsString();\n }\n\n public getDataAsJson<T = unknown>(): T | undefined {\n return this.resource.getDataAsJson<T>();\n }\n\n public listInputFields(): string[] {\n this.instanceData.guard();\n this.getInputsLocked(); // will set unstable if not locked\n return this.resource.listInputFields(this.instanceData.ctx.watcher);\n }\n\n public listOutputFields(): string[] {\n this.instanceData.guard();\n this.getOutputsLocked(); // will set unstable if not locked\n return this.resource.listOutputFields(this.instanceData.ctx.watcher);\n }\n\n public listDynamicFields(): string[] {\n this.instanceData.guard();\n return this.resource.listDynamicFields(this.instanceData.ctx.watcher);\n }\n\n public getKeyValue(key: string, unstableIfNotFound: boolean = false): Uint8Array | undefined {\n this.instanceData.guard();\n const result = this.resource.getKeyValue(this.instanceData.ctx.watcher, key);\n if (result === undefined && unstableIfNotFound)\n this.instanceData.ctx.markUnstable(\"key_not_found_b:\" + key);\n return result;\n }\n\n /** @deprecated */\n public getKeyValueString(key: string): string | undefined {\n return this.getKeyValueAsString(key);\n }\n\n public getKeyValueAsString(key: string, unstableIfNotFound: boolean = false): string | undefined {\n this.instanceData.guard();\n const result = this.resource.getKeyValueString(this.instanceData.ctx.watcher, key);\n if (result === undefined && unstableIfNotFound)\n this.instanceData.ctx.markUnstable(\"key_not_found_s:\" + key);\n return result;\n }\n\n public getKeyValueAsJson<T = unknown>(\n key: string,\n unstableIfNotFound: boolean = false,\n ): T | undefined {\n const result = this.resource.getKeyValueAsJson<T>(this.instanceData.ctx.watcher, key);\n if (result === undefined) {\n if (unstableIfNotFound) this.instanceData.ctx.markUnstable(\"key_not_found_j:\" + key);\n return undefined;\n }\n return result;\n }\n\n /**\n * Can be used to pass a higher level accessor that will wrap the resource and throw its\n * errors on node resolution.\n * */\n public toEntryAccessor(): PlTreeEntryAccessor {\n return new PlTreeEntryAccessor(this.accessorData, this.tree, this.id, this.instanceData);\n }\n\n /** Can be passed to nested computable. */\n public persist(): PlTreeEntry {\n return new PlTreeEntry(this.accessorData, this.resource.id);\n }\n}\n"],"mappings":";;;;;;;;AA2BA,IAAa,UAAb,cAA6B,MAAM;CACjC,YAAY,SAAiB;AAC3B,QAAM,QAAQ;;;AAclB,SAAgB,cAAc,KAAkC;AAC9D,QACE,OAAO,QAAQ,YACf,QAAQ,QACP,IAAY,+BAA+B;;AAIhD,SAAgB,sBAAsB,KAA0C;AAC9E,QACE,OAAO,QAAQ,YACf,QAAQ,QACP,IAAY,+BAA+B;;AAIhD,SAAgB,qBAAqB,KAAyC;AAC5E,QACE,OAAO,QAAQ,YACf,QAAQ,QACP,IAAY,+BAA+B;;;AAKhD,IAAa,cAAb,MAA0E;CACxE,AAAiB,0BAA0B;CAE3C,YACE,AAAiB,cACjB,AAAgB,KAChB;EAFiB;EACD;;CAGlB,AAAO,eAAe,KAAoB,OAAwC;AAChF,SAAO,IAAI,oBAAoB,KAAK,cAAc,KAAK,aAAa,cAAc,EAAE,KAAK,KAAK;GAC5F;GACA;GACD,CAAC;;CAGJ,AAAO,SAAiB;AACtB,SAAO,KAAK,UAAU;;CAGxB,AAAO,WAAmB;AACxB,SAAO,4DAA6B,KAAK,IAAI,CAAC;;;AAIlD,SAAS,oBACP,cACA,MACA,cACA,KACA,KACoB;CACpB,MAAM,MAAM,IAAI,mBACd,cACA,MACA,KAAK,IAAI,aAAa,IAAI,SAAS,IAAI,EACvC,aACD;AAED,KAAI,CAAC,IAAI,aAAa;EACpB,MAAM,MAAM,IAAI,UAAU;AAC1B,MAAI,QAAQ,OACV,4FAA4B,IAAI,iBAAiB,CAAC,EAAE,IAAI,IAAI,IAAI,aAAa;;AAGjF,KACE,IAAI,uBAAuB,WAC1B,MAAM,QAAQ,IAAI,mBAAmB,GAClC,IAAI,mBAAmB,WAAW,yDAA0B,IAAI,IAAI,aAAa,CAAC,KAAK,KACvF,mDAAoB,IAAI,oBAAoB,IAAI,aAAa,EAEjE,OAAM,IAAI,MAER,2EAA4C,IAAI,aAAa,CAAC,gBAAgB,IAAI,qBACnF;AAEH,QAAO;;AAGT,IAAa,sBAAb,MAAiC;CAC/B,AAAiB,0BAA0B;CAE3C,YACE,AAAiB,cACjB,AAAiB,MACjB,AAAiB,KACjB,AAAiB,cACjB;EAJiB;EACA;EACA;EACA;;CAGnB,KAAK,MAA4B,EAAE,EAAsB;AACvD,OAAK,aAAa,OAAO;AAIzB,MAAI,KAAK,aAAa,UAAU,OAC9B,MAAK,aAAa,IAAI,aAAa,KAAK,aAAa,MAAM;AAE7D,SAAO,oBAAoB,KAAK,cAAc,KAAK,MAAM,KAAK,cAAc,KAAK,KAAK,IAAI;;;;;;;AAgB9F,SAAgB,wBAAwB,KAAiC,KAAoB;AAC3F,KAAI,eAAe,YAAa,QAAO,IAAI,SAAS,IAAI,CAAC,MAAM,CAAC;AAEhE,QAAO;;;;;;;;AAST,IAAa,qBAAb,MAAgC;CAC9B,AAAiB,0BAA0B;CAE3C,YACE,AAAiB,cACjB,AAAiB,MACjB,AAAiB,UACjB,AAAiB,cACjB;EAJiB;EACA;EACA;EACA;;CAGnB,IAAW,KAAiB;AAC1B,OAAK,aAAa,OAAO;AACzB,SAAO,KAAK,SAAS;;CAGvB,IAAW,aAAiC;AAC1C,OAAK,aAAa,OAAO;AACzB,SAAO,KAAK,SAAS;;CAGvB,IAAW,eAA6B;AACtC,OAAK,aAAa,OAAO;AACzB,SAAO,KAAK,SAAS;;CAGvB,IAAW,eAA6B;AACtC,SAAO;GAAE,IAAI,KAAK;GAAI,MAAM,KAAK;GAAc;;CAGjD,AAAQ,oBAAoB,KAAiB,KAA+C;AAC1F,SAAO,oBAAoB,KAAK,cAAc,KAAK,MAAM,KAAK,cAAc,KAAK,IAAI;;CAWvF,AAAO,SAAS,GAAG,OAAwE;AACzF,SAAO,KAAK,mBAAmB,EAAE,EAAE,GAAG,MAAM;;CAa9C,AAAO,gBACL,GAAG,OACkD;AACrD,SAAO,KAAK,0BAA0B,EAAE,EAAE,GAAG,MAAM;;CAGrD,AAAO,mBACL,eACA,GAAG,OAC6B;EAChC,MAAM,SAAS,KAAK,0BAA0B,eAAe,GAAG,MAAM;AACtE,MAAI,WAAW,OAAW,QAAO;AAEjC,MAAI,CAAC,OAAO,GAAI,OAAM,OAAO;AAC7B,SAAO,OAAO;;CAGhB,AAAO,0BACL,eACA,GAAG,OACkD;EAErD,IAAI,UAA8B;AAElC,OAAK,MAAM,SAAS,OAAO;GACzB,MAAM,OACJ,OAAO,UAAU,WACb;IACE,GAAG;IACH,OAAO;IACR,GACD;IAAE,GAAG;IAAe,GAAG;IAAO;GAEpC,MAAM,OAAO,QAAQ,SAAS,MAAM;AAEpC,OAAI,SAAS,OAAW,QAAO;AAE/B,OAAI,KAAK,6BAA6B,KAAK,UAAU,UAAa,KAAK,UAAU,OAC/E,QAAO;AAET,QAAK,CAAC,KAAK,eAAe,KAAK,UAAU,WAAc,KAAK,UAAU,OACpE,QAAO;IACL,IAAI;IAGJ,4FACW,KAAK,MAAM,iBAAiB,CAAC,EACtC,QAAQ,IACR,QAAQ,cACR,KAAK,MACN;IACF;AAEH,OAAI,KAAK,UAAU,QAAW;AAC5B,QAAI,KAAK,mBACP,QAAO;KACL,IAAI;KACJ,uBAAO,IAAI,MACT,gCAAgC,KAAK,MAAM,wDAAyB,QAAQ,GAAG,GAChF;KACF;AAEH,SAAK,iBAAiB,uBAAuB,KAAK,MAAM;AACxD;;AAGF,aAAU,KAAK;;AAEjB,SAAO;GAAE,IAAI;GAAM,OAAO;GAAS;;CAGrC,AAAiB,oBAAoB,WAAmB;AACtD,OAAK,aAAa,IAAI,aAAa,OAAO;;CAS5C,AAAO,SAAS,OAA6E;AAC3F,OAAK,aAAa,OAAO;EACzB,MAAM,OAAqB,OAAO,UAAU,WAAW,EAAE,OAAO,OAAO,GAAG;EAE1E,MAAM,KAAK,KAAK,SAAS,SAAS,KAAK,aAAa,IAAI,SAAS,MAAM,KAAK,iBAAiB;AAE7F,MAAI,OAAO,OAAW,QAAO;AAE7B,SAAOA,yCAAiB,KAAK,QAAQ,KAAK,oBAAoB,KAAK,EAAE,aAAa,MAAM,CAAC,CAAC;;CAG5F,AAAO,kBAA2B;AAChC,OAAK,aAAa,OAAO;EACzB,MAAM,SAAS,KAAK,SAAS,gBAAgB,KAAK,aAAa,IAAI,QAAQ;AAC3E,MAAI,CAAC,OAAQ,MAAK,aAAa,IAAI,aAAa,qBAAqB,KAAK,aAAa,KAAK;AAC5F,SAAO;;CAGT,AAAO,mBAA4B;AACjC,OAAK,aAAa,OAAO;EACzB,MAAM,SAAS,KAAK,SAAS,iBAAiB,KAAK,aAAa,IAAI,QAAQ;AAC5E,MAAI,CAAC,OAAQ,MAAK,aAAa,IAAI,aAAa,sBAAsB,KAAK,aAAa,KAAK;AAC7F,SAAO;;CAGT,AAAO,oBAA6B;AAClC,OAAK,aAAa,OAAO;EACzB,MAAM,SAAS,KAAK,SAAS,kBAAkB,KAAK,aAAa,IAAI,QAAQ;AAC7E,MAAI,CAAC,OAAQ,MAAK,aAAa,IAAI,aAAa,eAAe,KAAK,aAAa,KAAK;AACtF,SAAO;;CAGT,AAAO,aAAa;AAClB,OAAK,aAAa,OAAO;AACzB,SAAO,KAAK,SAAS,WAAW,KAAK,aAAa,IAAI,QAAQ;;CAGhE,AAAO,WAA2C;AAChD,OAAK,aAAa,OAAO;EACzB,MAAM,MAAM,KAAK,SAAS,SAAS,KAAK,aAAa,IAAI,QAAQ;AACjE,MAAI,QAAQ,OAEV,QAAO;AACT,SAAO,KAAK,oBAAoB,KAAK,EAAE,CAAC;;CAG1C,AAAO,UAAkC;AACvC,SAAO,KAAK,SAAS;;CAGvB,AAAO,kBAAsC;AAC3C,SAAO,KAAK,SAAS,iBAAiB;;CAGxC,AAAO,gBAA4C;AACjD,SAAO,KAAK,SAAS,eAAkB;;CAGzC,AAAO,kBAA4B;AACjC,OAAK,aAAa,OAAO;AACzB,OAAK,iBAAiB;AACtB,SAAO,KAAK,SAAS,gBAAgB,KAAK,aAAa,IAAI,QAAQ;;CAGrE,AAAO,mBAA6B;AAClC,OAAK,aAAa,OAAO;AACzB,OAAK,kBAAkB;AACvB,SAAO,KAAK,SAAS,iBAAiB,KAAK,aAAa,IAAI,QAAQ;;CAGtE,AAAO,oBAA8B;AACnC,OAAK,aAAa,OAAO;AACzB,SAAO,KAAK,SAAS,kBAAkB,KAAK,aAAa,IAAI,QAAQ;;CAGvE,AAAO,YAAY,KAAa,qBAA8B,OAA+B;AAC3F,OAAK,aAAa,OAAO;EACzB,MAAM,SAAS,KAAK,SAAS,YAAY,KAAK,aAAa,IAAI,SAAS,IAAI;AAC5E,MAAI,WAAW,UAAa,mBAC1B,MAAK,aAAa,IAAI,aAAa,qBAAqB,IAAI;AAC9D,SAAO;;;CAIT,AAAO,kBAAkB,KAAiC;AACxD,SAAO,KAAK,oBAAoB,IAAI;;CAGtC,AAAO,oBAAoB,KAAa,qBAA8B,OAA2B;AAC/F,OAAK,aAAa,OAAO;EACzB,MAAM,SAAS,KAAK,SAAS,kBAAkB,KAAK,aAAa,IAAI,SAAS,IAAI;AAClF,MAAI,WAAW,UAAa,mBAC1B,MAAK,aAAa,IAAI,aAAa,qBAAqB,IAAI;AAC9D,SAAO;;CAGT,AAAO,kBACL,KACA,qBAA8B,OACf;EACf,MAAM,SAAS,KAAK,SAAS,kBAAqB,KAAK,aAAa,IAAI,SAAS,IAAI;AACrF,MAAI,WAAW,QAAW;AACxB,OAAI,mBAAoB,MAAK,aAAa,IAAI,aAAa,qBAAqB,IAAI;AACpF;;AAEF,SAAO;;;;;;CAOT,AAAO,kBAAuC;AAC5C,SAAO,IAAI,oBAAoB,KAAK,cAAc,KAAK,MAAM,KAAK,IAAI,KAAK,aAAa;;;CAI1F,AAAO,UAAuB;AAC5B,SAAO,IAAI,YAAY,KAAK,cAAc,KAAK,SAAS,GAAG"}
|
package/dist/accessors.d.ts
CHANGED
|
@@ -1,116 +1,116 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
3
|
-
import
|
|
4
|
-
import
|
|
5
|
-
import
|
|
6
|
-
import
|
|
1
|
+
import { CommonFieldTraverseOps, FieldTraversalStep, GetFieldStep, ResourceTraversalOps } from "./traversal_ops.js";
|
|
2
|
+
import { ValueAndError } from "./value_and_error.js";
|
|
3
|
+
import { ValueOrError } from "./value_or_error.js";
|
|
4
|
+
import { PlTreeResource, PlTreeState } from "./state.js";
|
|
5
|
+
import { OptionalResourceId, ResourceId, ResourceType } from "@milaboratories/pl-client";
|
|
6
|
+
import { AccessorProvider, ComputableCtx, ComputableHooks, UsageGuard } from "@milaboratories/computable";
|
|
7
|
+
|
|
8
|
+
//#region src/accessors.d.ts
|
|
7
9
|
/** Error encountered during traversal in field or resource. */
|
|
8
|
-
|
|
9
|
-
|
|
10
|
+
declare class PlError extends Error {
|
|
11
|
+
constructor(message: string);
|
|
10
12
|
}
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
13
|
+
type TreeAccessorData = {
|
|
14
|
+
readonly treeProvider: () => PlTreeState;
|
|
15
|
+
readonly hooks?: ComputableHooks;
|
|
14
16
|
};
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
17
|
+
type TreeAccessorInstanceData = {
|
|
18
|
+
readonly guard: UsageGuard;
|
|
19
|
+
readonly ctx: ComputableCtx;
|
|
18
20
|
};
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
21
|
+
declare function isPlTreeEntry(obj: unknown): obj is PlTreeEntry;
|
|
22
|
+
declare function isPlTreeEntryAccessor(obj: unknown): obj is PlTreeEntryAccessor;
|
|
23
|
+
declare function isPlTreeNodeAccessor(obj: unknown): obj is PlTreeNodeAccessor;
|
|
22
24
|
/** Main entry point for using PlTree in reactive setting */
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
25
|
+
declare class PlTreeEntry implements AccessorProvider<PlTreeEntryAccessor> {
|
|
26
|
+
private readonly accessorData;
|
|
27
|
+
readonly rid: ResourceId;
|
|
28
|
+
private readonly __pl_tree_type_marker__;
|
|
29
|
+
constructor(accessorData: TreeAccessorData, rid: ResourceId);
|
|
30
|
+
createAccessor(ctx: ComputableCtx, guard: UsageGuard): PlTreeEntryAccessor;
|
|
31
|
+
toJSON(): string;
|
|
32
|
+
toString(): string;
|
|
31
33
|
}
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
34
|
+
declare class PlTreeEntryAccessor {
|
|
35
|
+
private readonly accessorData;
|
|
36
|
+
private readonly tree;
|
|
37
|
+
private readonly rid;
|
|
38
|
+
private readonly instanceData;
|
|
39
|
+
private readonly __pl_tree_type_marker__;
|
|
40
|
+
constructor(accessorData: TreeAccessorData, tree: PlTreeState, rid: ResourceId, instanceData: TreeAccessorInstanceData);
|
|
41
|
+
node(ops?: ResourceTraversalOps): PlTreeNodeAccessor;
|
|
40
42
|
}
|
|
41
43
|
/**
|
|
42
44
|
* Helper type to simplify implementation of APIs requiring type information.
|
|
43
45
|
* */
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
46
|
+
type ResourceInfo = {
|
|
47
|
+
readonly id: ResourceId;
|
|
48
|
+
readonly type: ResourceType;
|
|
47
49
|
};
|
|
48
50
|
/**
|
|
49
51
|
* Can be called only when a ctx is provided, because pl tree entry is a computable entity.
|
|
50
52
|
* @deprecated
|
|
51
53
|
* */
|
|
52
|
-
|
|
54
|
+
declare function treeEntryToResourceInfo(res: PlTreeEntry | ResourceInfo, ctx: ComputableCtx): ResourceInfo;
|
|
53
55
|
/**
|
|
54
56
|
* API contracts:
|
|
55
57
|
* - API never return {@link NullResourceId}, absence of link is always modeled as `undefined`
|
|
56
58
|
*
|
|
57
59
|
* Important: never store instances of this class, always get fresh instance from {@link PlTreeState} accessor.
|
|
58
60
|
* */
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
* */
|
|
112
|
-
toEntryAccessor(): PlTreeEntryAccessor;
|
|
113
|
-
/** Can be passed to nested computable. */
|
|
114
|
-
persist(): PlTreeEntry;
|
|
61
|
+
declare class PlTreeNodeAccessor {
|
|
62
|
+
private readonly accessorData;
|
|
63
|
+
private readonly tree;
|
|
64
|
+
private readonly resource;
|
|
65
|
+
private readonly instanceData;
|
|
66
|
+
private readonly __pl_tree_type_marker__;
|
|
67
|
+
constructor(accessorData: TreeAccessorData, tree: PlTreeState, resource: PlTreeResource, instanceData: TreeAccessorInstanceData);
|
|
68
|
+
get id(): ResourceId;
|
|
69
|
+
get originalId(): OptionalResourceId;
|
|
70
|
+
get resourceType(): ResourceType;
|
|
71
|
+
get resourceInfo(): ResourceInfo;
|
|
72
|
+
private getResourceFromTree;
|
|
73
|
+
traverse(...steps: [Omit<FieldTraversalStep, "errorIfFieldNotSet"> & {
|
|
74
|
+
errorIfFieldNotSet: true;
|
|
75
|
+
}]): PlTreeNodeAccessor;
|
|
76
|
+
traverse(...steps: (FieldTraversalStep | string)[]): PlTreeNodeAccessor | undefined;
|
|
77
|
+
traverseOrError(...steps: [Omit<FieldTraversalStep, "errorIfFieldNotSet"> & {
|
|
78
|
+
errorIfFieldNotSet: true;
|
|
79
|
+
}]): ValueOrError<PlTreeNodeAccessor, Error>;
|
|
80
|
+
traverseOrError(...steps: (FieldTraversalStep | string)[]): ValueOrError<PlTreeNodeAccessor, Error> | undefined;
|
|
81
|
+
traverseWithCommon(commonOptions: CommonFieldTraverseOps, ...steps: (FieldTraversalStep | string)[]): PlTreeNodeAccessor | undefined;
|
|
82
|
+
traverseOrErrorWithCommon(commonOptions: CommonFieldTraverseOps, ...steps: (FieldTraversalStep | string)[]): ValueOrError<PlTreeNodeAccessor, Error> | undefined;
|
|
83
|
+
private readonly onUnstableLambda;
|
|
84
|
+
getField(_step: (Omit<GetFieldStep, "errorIfFieldNotFound"> & {
|
|
85
|
+
errorIfFieldNotFound: true;
|
|
86
|
+
}) | (Omit<GetFieldStep, "errorIfFieldNotSet"> & {
|
|
87
|
+
errorIfFieldNotSet: true;
|
|
88
|
+
})): ValueAndError<PlTreeNodeAccessor>;
|
|
89
|
+
getField(_step: GetFieldStep | string): ValueAndError<PlTreeNodeAccessor> | undefined;
|
|
90
|
+
getInputsLocked(): boolean;
|
|
91
|
+
getOutputsLocked(): boolean;
|
|
92
|
+
getIsReadyOrError(): boolean;
|
|
93
|
+
getIsFinal(): boolean;
|
|
94
|
+
getError(): PlTreeNodeAccessor | undefined;
|
|
95
|
+
getData(): Uint8Array | undefined;
|
|
96
|
+
getDataAsString(): string | undefined;
|
|
97
|
+
getDataAsJson<T = unknown>(): T | undefined;
|
|
98
|
+
listInputFields(): string[];
|
|
99
|
+
listOutputFields(): string[];
|
|
100
|
+
listDynamicFields(): string[];
|
|
101
|
+
getKeyValue(key: string, unstableIfNotFound?: boolean): Uint8Array | undefined;
|
|
102
|
+
/** @deprecated */
|
|
103
|
+
getKeyValueString(key: string): string | undefined;
|
|
104
|
+
getKeyValueAsString(key: string, unstableIfNotFound?: boolean): string | undefined;
|
|
105
|
+
getKeyValueAsJson<T = unknown>(key: string, unstableIfNotFound?: boolean): T | undefined;
|
|
106
|
+
/**
|
|
107
|
+
* Can be used to pass a higher level accessor that will wrap the resource and throw its
|
|
108
|
+
* errors on node resolution.
|
|
109
|
+
* */
|
|
110
|
+
toEntryAccessor(): PlTreeEntryAccessor;
|
|
111
|
+
/** Can be passed to nested computable. */
|
|
112
|
+
persist(): PlTreeEntry;
|
|
115
113
|
}
|
|
114
|
+
//#endregion
|
|
115
|
+
export { PlError, PlTreeEntry, PlTreeEntryAccessor, PlTreeNodeAccessor, ResourceInfo, TreeAccessorData, TreeAccessorInstanceData, isPlTreeEntry, isPlTreeEntryAccessor, isPlTreeNodeAccessor, treeEntryToResourceInfo };
|
|
116
116
|
//# sourceMappingURL=accessors.d.ts.map
|