@milaboratories/pl-tree 1.9.7 → 1.9.9
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 +7 -13
- package/dist/accessors.cjs +3 -4
- package/dist/accessors.cjs.map +1 -1
- package/dist/accessors.d.ts.map +1 -0
- package/dist/accessors.js +1 -2
- package/dist/accessors.js.map +1 -1
- package/dist/dump.cjs +1 -2
- package/dist/dump.cjs.map +1 -1
- package/dist/dump.d.ts.map +1 -0
- package/dist/dump.js +1 -1
- package/dist/index.cjs +9 -10
- package/dist/index.js +1 -2
- package/dist/snapshot.cjs +3 -4
- package/dist/snapshot.cjs.map +1 -1
- package/dist/snapshot.d.ts.map +1 -0
- package/dist/snapshot.js +1 -2
- package/dist/snapshot.js.map +1 -1
- package/dist/state.cjs +3 -4
- package/dist/state.cjs.map +1 -1
- package/dist/state.d.ts.map +1 -0
- package/dist/state.js +1 -2
- package/dist/state.js.map +1 -1
- package/dist/sync.cjs +2 -3
- package/dist/sync.cjs.map +1 -1
- package/dist/sync.d.ts.map +1 -0
- package/dist/sync.js +1 -2
- package/dist/sync.js.map +1 -1
- package/dist/synchronized_tree.cjs +5 -6
- package/dist/synchronized_tree.cjs.map +1 -1
- package/dist/synchronized_tree.d.ts.map +1 -0
- package/dist/synchronized_tree.js +1 -2
- package/dist/synchronized_tree.js.map +1 -1
- package/dist/traversal_ops.d.ts.map +1 -0
- package/dist/value_and_error.cjs +1 -2
- package/dist/value_and_error.cjs.map +1 -1
- package/dist/value_and_error.d.ts.map +1 -0
- package/dist/value_and_error.js +1 -1
- package/dist/value_and_error.js.map +1 -1
- package/dist/value_or_error.d.ts.map +1 -0
- package/package.json +10 -10
|
@@ -6,16 +6,12 @@ var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
|
6
6
|
var __getProtoOf = Object.getPrototypeOf;
|
|
7
7
|
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
8
8
|
var __copyProps = (to, from, except, desc) => {
|
|
9
|
-
if (from && typeof from === "object" || typeof from === "function") {
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
|
|
16
|
-
});
|
|
17
|
-
}
|
|
18
|
-
}
|
|
9
|
+
if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
|
|
10
|
+
key = keys[i];
|
|
11
|
+
if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
|
|
12
|
+
get: ((k) => from[k]).bind(null, key),
|
|
13
|
+
enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
|
|
14
|
+
});
|
|
19
15
|
}
|
|
20
16
|
return to;
|
|
21
17
|
};
|
|
@@ -23,7 +19,5 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
|
|
|
23
19
|
value: mod,
|
|
24
20
|
enumerable: true
|
|
25
21
|
}) : target, mod));
|
|
26
|
-
|
|
27
22
|
//#endregion
|
|
28
|
-
|
|
29
|
-
exports.__toESM = __toESM;
|
|
23
|
+
exports.__toESM = __toESM;
|
package/dist/accessors.cjs
CHANGED
|
@@ -1,9 +1,8 @@
|
|
|
1
|
-
|
|
2
|
-
const require_value_and_error = require(
|
|
1
|
+
require("./_virtual/_rolldown/runtime.cjs");
|
|
2
|
+
const require_value_and_error = require("./value_and_error.cjs");
|
|
3
3
|
let _milaboratories_pl_client = require("@milaboratories/pl-client");
|
|
4
4
|
let _milaboratories_pl_errors = require("@milaboratories/pl-errors");
|
|
5
5
|
let _milaboratories_ts_helpers = require("@milaboratories/ts-helpers");
|
|
6
|
-
|
|
7
6
|
//#region src/accessors.ts
|
|
8
7
|
/** Error encountered during traversal in field or resource. */
|
|
9
8
|
var PlError = class extends Error {
|
|
@@ -247,7 +246,6 @@ var PlTreeNodeAccessor = class {
|
|
|
247
246
|
return new PlTreeEntry(this.accessorData, this.resource.id);
|
|
248
247
|
}
|
|
249
248
|
};
|
|
250
|
-
|
|
251
249
|
//#endregion
|
|
252
250
|
exports.PlError = PlError;
|
|
253
251
|
exports.PlTreeEntry = PlTreeEntry;
|
|
@@ -257,4 +255,5 @@ exports.isPlTreeEntry = isPlTreeEntry;
|
|
|
257
255
|
exports.isPlTreeEntryAccessor = isPlTreeEntryAccessor;
|
|
258
256
|
exports.isPlTreeNodeAccessor = isPlTreeNodeAccessor;
|
|
259
257
|
exports.treeEntryToResourceInfo = treeEntryToResourceInfo;
|
|
258
|
+
|
|
260
259
|
//# sourceMappingURL=accessors.cjs.map
|
package/dist/accessors.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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"}
|
|
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,0BAA2C;CAE3C,YACE,cACA,KACA;AAFiB,OAAA,eAAA;AACD,OAAA,MAAA;;CAGlB,eAAsB,KAAoB,OAAwC;AAChF,SAAO,IAAI,oBAAoB,KAAK,cAAc,KAAK,aAAa,cAAc,EAAE,KAAK,KAAK;GAC5F;GACA;GACD,CAAC;;CAGJ,SAAwB;AACtB,SAAO,KAAK,UAAU;;CAGxB,WAA0B;AACxB,SAAO,WAAA,GAAA,0BAAA,oBAA6B,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,KAAA,EACV,QAAA,GAAA,0BAAA,eAAA,GAAA,2BAAA,UAA4B,IAAI,iBAAiB,CAAC,EAAE,IAAI,IAAI,IAAI,aAAa;;AAGjF,KACE,IAAI,uBAAuB,KAAA,MAC1B,MAAM,QAAQ,IAAI,mBAAmB,GAClC,IAAI,mBAAmB,WAAW,QAAA,GAAA,0BAAA,oBAA0B,IAAI,IAAI,aAAa,CAAC,KAAK,KACvF,EAAA,GAAA,0BAAA,oBAAoB,IAAI,oBAAoB,IAAI,aAAa,EAEjE,OAAM,IAAI,MAER,wBAAA,GAAA,0BAAA,sBAA4C,IAAI,aAAa,CAAC,gBAAgB,IAAI,qBACnF;AAEH,QAAO;;AAGT,IAAa,sBAAb,MAAiC;CAC/B,0BAA2C;CAE3C,YACE,cACA,MACA,KACA,cACA;AAJiB,OAAA,eAAA;AACA,OAAA,OAAA;AACA,OAAA,MAAA;AACA,OAAA,eAAA;;CAGnB,KAAK,MAA4B,EAAE,EAAsB;AACvD,OAAK,aAAa,OAAO;AAIzB,MAAI,KAAK,aAAa,UAAU,KAAA,EAC9B,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,0BAA2C;CAE3C,YACE,cACA,MACA,UACA,cACA;AAJiB,OAAA,eAAA;AACA,OAAA,OAAA;AACA,OAAA,WAAA;AACA,OAAA,eAAA;;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,oBAA4B,KAAiB,KAA+C;AAC1F,SAAO,oBAAoB,KAAK,cAAc,KAAK,MAAM,KAAK,cAAc,KAAK,IAAI;;CAWvF,SAAgB,GAAG,OAAwE;AACzF,SAAO,KAAK,mBAAmB,EAAE,EAAE,GAAG,MAAM;;CAa9C,gBACE,GAAG,OACkD;AACrD,SAAO,KAAK,0BAA0B,EAAE,EAAE,GAAG,MAAM;;CAGrD,mBACE,eACA,GAAG,OAC6B;EAChC,MAAM,SAAS,KAAK,0BAA0B,eAAe,GAAG,MAAM;AACtE,MAAI,WAAW,KAAA,EAAW,QAAO,KAAA;AAEjC,MAAI,CAAC,OAAO,GAAI,OAAM,OAAO;AAC7B,SAAO,OAAO;;CAGhB,0BACE,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,KAAA,EAAW,QAAO,KAAA;AAE/B,OAAI,KAAK,6BAA6B,KAAK,UAAU,KAAA,KAAa,KAAK,UAAU,KAAA,EAC/E,QAAO,KAAA;AAET,QAAK,CAAC,KAAK,eAAe,KAAK,UAAU,KAAA,MAAc,KAAK,UAAU,KAAA,EACpE,QAAO;IACL,IAAI;IAGJ,QAAA,GAAA,0BAAA,eAAA,GAAA,2BAAA,UACW,KAAK,MAAM,iBAAiB,CAAC,EACtC,QAAQ,IACR,QAAQ,cACR,KAAK,MACN;IACF;AAEH,OAAI,KAAK,UAAU,KAAA,GAAW;AAC5B,QAAI,KAAK,mBACP,QAAO;KACL,IAAI;KACJ,uBAAO,IAAI,MACT,gCAAgC,KAAK,MAAM,OAAA,GAAA,0BAAA,oBAAyB,QAAQ,GAAG,GAChF;KACF;AAEH,SAAK,iBAAiB,uBAAuB,KAAK,MAAM;AACxD;;AAGF,aAAU,KAAK;;AAEjB,SAAO;GAAE,IAAI;GAAM,OAAO;GAAS;;CAGrC,oBAAqC,WAAmB;AACtD,OAAK,aAAa,IAAI,aAAa,OAAO;;CAS5C,SAAgB,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,KAAA,EAAW,QAAO,KAAA;AAE7B,SAAOA,wBAAAA,iBAAiB,KAAK,QAAQ,KAAK,oBAAoB,KAAK,EAAE,aAAa,MAAM,CAAC,CAAC;;CAG5F,kBAAkC;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,mBAAmC;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,oBAAoC;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,aAAoB;AAClB,OAAK,aAAa,OAAO;AACzB,SAAO,KAAK,SAAS,WAAW,KAAK,aAAa,IAAI,QAAQ;;CAGhE,WAAkD;AAChD,OAAK,aAAa,OAAO;EACzB,MAAM,MAAM,KAAK,SAAS,SAAS,KAAK,aAAa,IAAI,QAAQ;AACjE,MAAI,QAAQ,KAAA,EAEV,QAAO,KAAA;AACT,SAAO,KAAK,oBAAoB,KAAK,EAAE,CAAC;;CAG1C,UAAyC;AACvC,SAAO,KAAK,SAAS;;CAGvB,kBAA6C;AAC3C,SAAO,KAAK,SAAS,iBAAiB;;CAGxC,gBAAmD;AACjD,SAAO,KAAK,SAAS,eAAkB;;CAGzC,kBAAmC;AACjC,OAAK,aAAa,OAAO;AACzB,OAAK,iBAAiB;AACtB,SAAO,KAAK,SAAS,gBAAgB,KAAK,aAAa,IAAI,QAAQ;;CAGrE,mBAAoC;AAClC,OAAK,aAAa,OAAO;AACzB,OAAK,kBAAkB;AACvB,SAAO,KAAK,SAAS,iBAAiB,KAAK,aAAa,IAAI,QAAQ;;CAGtE,oBAAqC;AACnC,OAAK,aAAa,OAAO;AACzB,SAAO,KAAK,SAAS,kBAAkB,KAAK,aAAa,IAAI,QAAQ;;CAGvE,YAAmB,KAAa,qBAA8B,OAA+B;AAC3F,OAAK,aAAa,OAAO;EACzB,MAAM,SAAS,KAAK,SAAS,YAAY,KAAK,aAAa,IAAI,SAAS,IAAI;AAC5E,MAAI,WAAW,KAAA,KAAa,mBAC1B,MAAK,aAAa,IAAI,aAAa,qBAAqB,IAAI;AAC9D,SAAO;;;CAIT,kBAAyB,KAAiC;AACxD,SAAO,KAAK,oBAAoB,IAAI;;CAGtC,oBAA2B,KAAa,qBAA8B,OAA2B;AAC/F,OAAK,aAAa,OAAO;EACzB,MAAM,SAAS,KAAK,SAAS,kBAAkB,KAAK,aAAa,IAAI,SAAS,IAAI;AAClF,MAAI,WAAW,KAAA,KAAa,mBAC1B,MAAK,aAAa,IAAI,aAAa,qBAAqB,IAAI;AAC9D,SAAO;;CAGT,kBACE,KACA,qBAA8B,OACf;EACf,MAAM,SAAS,KAAK,SAAS,kBAAqB,KAAK,aAAa,IAAI,SAAS,IAAI;AACrF,MAAI,WAAW,KAAA,GAAW;AACxB,OAAI,mBAAoB,MAAK,aAAa,IAAI,aAAa,qBAAqB,IAAI;AACpF;;AAEF,SAAO;;;;;;CAOT,kBAA8C;AAC5C,SAAO,IAAI,oBAAoB,KAAK,cAAc,KAAK,MAAM,KAAK,IAAI,KAAK,aAAa;;;CAI1F,UAA8B;AAC5B,SAAO,IAAI,YAAY,KAAK,cAAc,KAAK,SAAS,GAAG"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"accessors.d.ts","names":[],"sources":["../src/accessors.ts"],"mappings":";;;;;;;;;cA2Ba,OAAA,SAAgB,KAAA;cACf,OAAA;AAAA;AAAA,KAKF,gBAAA;EAAA,SACD,YAAA,QAAoB,WAAA;EAAA,SACpB,KAAA,GAAQ,eAAA;AAAA;AAAA,KAGP,wBAAA;EAAA,SACD,KAAA,EAAO,UAAA;EAAA,SACP,GAAA,EAAK,aAAA;AAAA;AAAA,iBAGA,aAAA,CAAc,GAAA,YAAe,GAAA,IAAO,WAAA;AAAA,iBAQpC,qBAAA,CAAsB,GAAA,YAAe,GAAA,IAAO,mBAAA;AAAA,iBAQ5C,oBAAA,CAAqB,GAAA,YAAe,GAAA,IAAO,kBAAA;;cAS9C,WAAA,YAAuB,gBAAA,CAAiB,mBAAA;EAAA,iBAIhC,YAAA;EAAA,SACD,GAAA,EAAK,UAAA;EAAA,iBAJN,uBAAA;cAGE,YAAA,EAAc,gBAAA,EACf,GAAA,EAAK,UAAA;EAGhB,cAAA,CAAe,GAAA,EAAK,aAAA,EAAe,KAAA,EAAO,UAAA,GAAa,mBAAA;EAOvD,MAAA,CAAA;EAIA,QAAA,CAAA;AAAA;AAAA,cAuCI,mBAAA;EAAA,iBAIQ,YAAA;EAAA,iBACA,IAAA;EAAA,iBACA,GAAA;EAAA,iBACA,YAAA;EAAA,iBANF,uBAAA;cAGE,YAAA,EAAc,gBAAA,EACd,IAAA,EAAM,WAAA,EACN,GAAA,EAAK,UAAA,EACL,YAAA,EAAc,wBAAA;EAGjC,IAAA,CAAK,GAAA,GAAK,oBAAA,GAA4B,kBAAA;AAAA;;;;KAe5B,YAAA;EAAA,SACD,EAAA,EAAI,UAAA;EAAA,SACJ,IAAA,EAAM,YAAA;AAAA;;;;;iBAOD,uBAAA,CAAwB,GAAA,EAAK,WAAA,GAAc,YAAA,EAAc,GAAA,EAAK,aAAA,GAAa,YAAA;;;;AArG3F;;;cAiHa,kBAAA;EAAA,iBAIQ,YAAA;EAAA,iBACA,IAAA;EAAA,iBACA,QAAA;EAAA,iBACA,YAAA;EAAA,iBANF,uBAAA;cAGE,YAAA,EAAc,gBAAA,EACd,IAAA,EAAM,WAAA,EACN,QAAA,EAAU,cAAA,EACV,YAAA,EAAc,wBAAA;EAAA,IAGtB,EAAA,CAAA,GAAM,UAAA;EAAA,IAKN,UAAA,CAAA,GAAc,kBAAA;EAAA,IAKd,YAAA,CAAA,GAAgB,YAAA;EAAA,IAKhB,YAAA,CAAA,GAAgB,YAAA;EAAA,QAInB,mBAAA;EAID,QAAA,CAAA,GACF,KAAA,GACD,IAAA,CAAK,kBAAA;IACH,kBAAA;EAAA,KAGH,kBAAA;EACI,QAAA,CAAA,GAAY,KAAA,GAAQ,kBAAA,eAAiC,kBAAA;EAKrD,eAAA,CAAA,GACF,KAAA,GACD,IAAA,CAAK,kBAAA;IACH,kBAAA;EAAA,KAGH,YAAA,CAAa,kBAAA,EAAoB,KAAA;EAC7B,eAAA,CAAA,GACF,KAAA,GAAQ,kBAAA,eACV,YAAA,CAAa,kBAAA,EAAoB,KAAA;EAO7B,kBAAA,CACL,aAAA,EAAe,sBAAA,KACZ,KAAA,GAAQ,kBAAA,eACV,kBAAA;EAQI,yBAAA,CACL,aAAA,EAAe,sBAAA,KACZ,KAAA,GAAQ,kBAAA,eACV,YAAA,CAAa,kBAAA,EAAoB,KAAA;EAAA,iBAmDnB,gBAAA;EAIV,QAAA,CACL,KAAA,GACK,IAAA,CAAK,YAAA;IAA0C,oBAAA;EAAA,MAC/C,IAAA,CAAK,YAAA;IAAwC,kBAAA;EAAA,KACjD,aAAA,CAAc,kBAAA;EACV,QAAA,CAAS,KAAA,EAAO,YAAA,YAAwB,aAAA,CAAc,kBAAA;EAYtD,eAAA,CAAA;EAOA,gBAAA,CAAA;EAOA,iBAAA,CAAA;EAOA,UAAA,CAAA;EAKA,QAAA,CAAA,GAAY,kBAAA;EASZ,OAAA,CAAA,GAAW,UAAA;EAIX,eAAA,CAAA;EAIA,aAAA,aAAA,CAAA,GAA8B,CAAA;EAI9B,eAAA,CAAA;EAMA,gBAAA,CAAA;EAMA,iBAAA,CAAA;EAKA,WAAA,CAAY,GAAA,UAAa,kBAAA,aAAsC,UAAA;EA3P9C;EAoQjB,iBAAA,CAAkB,GAAA;EAIlB,mBAAA,CAAoB,GAAA,UAAa,kBAAA;EAQjC,iBAAA,aAAA,CACL,GAAA,UACA,kBAAA,aACC,CAAA;EA/QqD;;;;EA4RjD,eAAA,CAAA,GAAmB,mBAAA;EA/RP;EAoSZ,OAAA,CAAA,GAAW,WAAA;AAAA"}
|
package/dist/accessors.js
CHANGED
|
@@ -2,7 +2,6 @@ import { mapValueAndError } from "./value_and_error.js";
|
|
|
2
2
|
import { resourceIdToString, resourceTypeToString, resourceTypesEqual } from "@milaboratories/pl-client";
|
|
3
3
|
import { parsePlError } from "@milaboratories/pl-errors";
|
|
4
4
|
import { notEmpty } from "@milaboratories/ts-helpers";
|
|
5
|
-
|
|
6
5
|
//#region src/accessors.ts
|
|
7
6
|
/** Error encountered during traversal in field or resource. */
|
|
8
7
|
var PlError = class extends Error {
|
|
@@ -246,7 +245,7 @@ var PlTreeNodeAccessor = class {
|
|
|
246
245
|
return new PlTreeEntry(this.accessorData, this.resource.id);
|
|
247
246
|
}
|
|
248
247
|
};
|
|
249
|
-
|
|
250
248
|
//#endregion
|
|
251
249
|
export { PlError, PlTreeEntry, PlTreeEntryAccessor, PlTreeNodeAccessor, isPlTreeEntry, isPlTreeEntryAccessor, isPlTreeNodeAccessor, treeEntryToResourceInfo };
|
|
250
|
+
|
|
252
251
|
//# sourceMappingURL=accessors.js.map
|
package/dist/accessors.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"accessors.js","names":[],"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,UAAU,mBAAmB,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,OAAM,aAAa,SAAS,IAAI,iBAAiB,CAAC,EAAE,IAAI,IAAI,IAAI,aAAa;;AAGjF,KACE,IAAI,uBAAuB,WAC1B,MAAM,QAAQ,IAAI,mBAAmB,GAClC,IAAI,mBAAmB,WAAW,OAAO,mBAAmB,IAAI,IAAI,aAAa,CAAC,KAAK,KACvF,CAAC,mBAAmB,IAAI,oBAAoB,IAAI,aAAa,EAEjE,OAAM,IAAI,MAER,uBAAuB,qBAAqB,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,OAAO,aACL,SAAS,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,MAAM,mBAAmB,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,SAAO,iBAAiB,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"}
|
|
1
|
+
{"version":3,"file":"accessors.js","names":[],"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,0BAA2C;CAE3C,YACE,cACA,KACA;AAFiB,OAAA,eAAA;AACD,OAAA,MAAA;;CAGlB,eAAsB,KAAoB,OAAwC;AAChF,SAAO,IAAI,oBAAoB,KAAK,cAAc,KAAK,aAAa,cAAc,EAAE,KAAK,KAAK;GAC5F;GACA;GACD,CAAC;;CAGJ,SAAwB;AACtB,SAAO,KAAK,UAAU;;CAGxB,WAA0B;AACxB,SAAO,UAAU,mBAAmB,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,KAAA,EACV,OAAM,aAAa,SAAS,IAAI,iBAAiB,CAAC,EAAE,IAAI,IAAI,IAAI,aAAa;;AAGjF,KACE,IAAI,uBAAuB,KAAA,MAC1B,MAAM,QAAQ,IAAI,mBAAmB,GAClC,IAAI,mBAAmB,WAAW,OAAO,mBAAmB,IAAI,IAAI,aAAa,CAAC,KAAK,KACvF,CAAC,mBAAmB,IAAI,oBAAoB,IAAI,aAAa,EAEjE,OAAM,IAAI,MAER,uBAAuB,qBAAqB,IAAI,aAAa,CAAC,gBAAgB,IAAI,qBACnF;AAEH,QAAO;;AAGT,IAAa,sBAAb,MAAiC;CAC/B,0BAA2C;CAE3C,YACE,cACA,MACA,KACA,cACA;AAJiB,OAAA,eAAA;AACA,OAAA,OAAA;AACA,OAAA,MAAA;AACA,OAAA,eAAA;;CAGnB,KAAK,MAA4B,EAAE,EAAsB;AACvD,OAAK,aAAa,OAAO;AAIzB,MAAI,KAAK,aAAa,UAAU,KAAA,EAC9B,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,0BAA2C;CAE3C,YACE,cACA,MACA,UACA,cACA;AAJiB,OAAA,eAAA;AACA,OAAA,OAAA;AACA,OAAA,WAAA;AACA,OAAA,eAAA;;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,oBAA4B,KAAiB,KAA+C;AAC1F,SAAO,oBAAoB,KAAK,cAAc,KAAK,MAAM,KAAK,cAAc,KAAK,IAAI;;CAWvF,SAAgB,GAAG,OAAwE;AACzF,SAAO,KAAK,mBAAmB,EAAE,EAAE,GAAG,MAAM;;CAa9C,gBACE,GAAG,OACkD;AACrD,SAAO,KAAK,0BAA0B,EAAE,EAAE,GAAG,MAAM;;CAGrD,mBACE,eACA,GAAG,OAC6B;EAChC,MAAM,SAAS,KAAK,0BAA0B,eAAe,GAAG,MAAM;AACtE,MAAI,WAAW,KAAA,EAAW,QAAO,KAAA;AAEjC,MAAI,CAAC,OAAO,GAAI,OAAM,OAAO;AAC7B,SAAO,OAAO;;CAGhB,0BACE,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,KAAA,EAAW,QAAO,KAAA;AAE/B,OAAI,KAAK,6BAA6B,KAAK,UAAU,KAAA,KAAa,KAAK,UAAU,KAAA,EAC/E,QAAO,KAAA;AAET,QAAK,CAAC,KAAK,eAAe,KAAK,UAAU,KAAA,MAAc,KAAK,UAAU,KAAA,EACpE,QAAO;IACL,IAAI;IAGJ,OAAO,aACL,SAAS,KAAK,MAAM,iBAAiB,CAAC,EACtC,QAAQ,IACR,QAAQ,cACR,KAAK,MACN;IACF;AAEH,OAAI,KAAK,UAAU,KAAA,GAAW;AAC5B,QAAI,KAAK,mBACP,QAAO;KACL,IAAI;KACJ,uBAAO,IAAI,MACT,gCAAgC,KAAK,MAAM,MAAM,mBAAmB,QAAQ,GAAG,GAChF;KACF;AAEH,SAAK,iBAAiB,uBAAuB,KAAK,MAAM;AACxD;;AAGF,aAAU,KAAK;;AAEjB,SAAO;GAAE,IAAI;GAAM,OAAO;GAAS;;CAGrC,oBAAqC,WAAmB;AACtD,OAAK,aAAa,IAAI,aAAa,OAAO;;CAS5C,SAAgB,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,KAAA,EAAW,QAAO,KAAA;AAE7B,SAAO,iBAAiB,KAAK,QAAQ,KAAK,oBAAoB,KAAK,EAAE,aAAa,MAAM,CAAC,CAAC;;CAG5F,kBAAkC;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,mBAAmC;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,oBAAoC;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,aAAoB;AAClB,OAAK,aAAa,OAAO;AACzB,SAAO,KAAK,SAAS,WAAW,KAAK,aAAa,IAAI,QAAQ;;CAGhE,WAAkD;AAChD,OAAK,aAAa,OAAO;EACzB,MAAM,MAAM,KAAK,SAAS,SAAS,KAAK,aAAa,IAAI,QAAQ;AACjE,MAAI,QAAQ,KAAA,EAEV,QAAO,KAAA;AACT,SAAO,KAAK,oBAAoB,KAAK,EAAE,CAAC;;CAG1C,UAAyC;AACvC,SAAO,KAAK,SAAS;;CAGvB,kBAA6C;AAC3C,SAAO,KAAK,SAAS,iBAAiB;;CAGxC,gBAAmD;AACjD,SAAO,KAAK,SAAS,eAAkB;;CAGzC,kBAAmC;AACjC,OAAK,aAAa,OAAO;AACzB,OAAK,iBAAiB;AACtB,SAAO,KAAK,SAAS,gBAAgB,KAAK,aAAa,IAAI,QAAQ;;CAGrE,mBAAoC;AAClC,OAAK,aAAa,OAAO;AACzB,OAAK,kBAAkB;AACvB,SAAO,KAAK,SAAS,iBAAiB,KAAK,aAAa,IAAI,QAAQ;;CAGtE,oBAAqC;AACnC,OAAK,aAAa,OAAO;AACzB,SAAO,KAAK,SAAS,kBAAkB,KAAK,aAAa,IAAI,QAAQ;;CAGvE,YAAmB,KAAa,qBAA8B,OAA+B;AAC3F,OAAK,aAAa,OAAO;EACzB,MAAM,SAAS,KAAK,SAAS,YAAY,KAAK,aAAa,IAAI,SAAS,IAAI;AAC5E,MAAI,WAAW,KAAA,KAAa,mBAC1B,MAAK,aAAa,IAAI,aAAa,qBAAqB,IAAI;AAC9D,SAAO;;;CAIT,kBAAyB,KAAiC;AACxD,SAAO,KAAK,oBAAoB,IAAI;;CAGtC,oBAA2B,KAAa,qBAA8B,OAA2B;AAC/F,OAAK,aAAa,OAAO;EACzB,MAAM,SAAS,KAAK,SAAS,kBAAkB,KAAK,aAAa,IAAI,SAAS,IAAI;AAClF,MAAI,WAAW,KAAA,KAAa,mBAC1B,MAAK,aAAa,IAAI,aAAa,qBAAqB,IAAI;AAC9D,SAAO;;CAGT,kBACE,KACA,qBAA8B,OACf;EACf,MAAM,SAAS,KAAK,SAAS,kBAAqB,KAAK,aAAa,IAAI,SAAS,IAAI;AACrF,MAAI,WAAW,KAAA,GAAW;AACxB,OAAI,mBAAoB,MAAK,aAAa,IAAI,aAAa,qBAAqB,IAAI;AACpF;;AAEF,SAAO;;;;;;CAOT,kBAA8C;AAC5C,SAAO,IAAI,oBAAoB,KAAK,cAAc,KAAK,MAAM,KAAK,IAAI,KAAK,aAAa;;;CAI1F,UAA8B;AAC5B,SAAO,IAAI,YAAY,KAAK,cAAc,KAAK,SAAS,GAAG"}
|
package/dist/dump.cjs
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
|
|
2
1
|
//#region src/dump.ts
|
|
3
2
|
/**
|
|
4
3
|
* Analyzes a collection of resources and generates statistics grouped by resource type.
|
|
@@ -79,7 +78,7 @@ function treeDumpStats(dumpStats) {
|
|
|
79
78
|
}
|
|
80
79
|
return stats;
|
|
81
80
|
}
|
|
82
|
-
|
|
83
81
|
//#endregion
|
|
84
82
|
exports.treeDumpStats = treeDumpStats;
|
|
83
|
+
|
|
85
84
|
//# sourceMappingURL=dump.cjs.map
|
package/dist/dump.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dump.cjs","names":[],"sources":["../src/dump.ts"],"sourcesContent":["import type { ExtendedResourceData } from \"./state\";\n\nexport type ResourceStats = {\n /** Number of resources of this type */\n count: number;\n /** Total number of bytes in the field names of all resources of this type */\n fieldNameBytes: number;\n /** Total number of fields in all resources of this type */\n fieldsCount: number;\n /** Total number of bytes in the data of all resources of this type */\n dataBytes: number;\n /** Total number of key-value records in all resources of this type */\n kvCount: number;\n /** Total number of bytes in the key-value records of all resources of this type */\n kvBytes: number;\n};\n\n/**\n * A map of resource type statistics, keyed by the resource type name and version.\n *\n * @type {Record<string, ResourceStats>}\n */\nexport type TreeDumpStats = {\n total: ResourceStats;\n byResourceType: Record<`${string}/${string}`, ResourceStats>;\n};\n\n/**\n * Analyzes a collection of resources and generates statistics grouped by resource type.\n *\n * This function processes an array of ExtendedResourceData and calculates various metrics\n * for each unique resource type, including:\n * - Count of resources\n * - Total bytes in field names\n * - Total number of fields\n * - Total bytes in resource data\n * - Total number of key-value records\n * - Total bytes in key-value records\n *\n * The statistics are organized by resource type using a key in the format \"typeName/version\".\n *\n * @param dumpStats - Array of ExtendedResourceData objects to analyze\n * @returns A DumpStats object containing statistics for each resource type\n * @example\n * ```typescript\n * const resources = [...]; // Array of ExtendedResourceData\n * const stats = treeDumpStats(resources);\n * // stats = {\n * // \"MyResource/1\": {\n * // count: 5,\n * // fieldNameBytes: 150,\n * // fieldsCount: 10,\n * // dataBytes: 1024,\n * // kvCount: 3,\n * // kvBytes: 256\n * // },\n * // ...\n * // }\n * ```\n */\nexport function treeDumpStats(dumpStats: ExtendedResourceData[]): TreeDumpStats {\n const stats: TreeDumpStats = {\n total: {\n count: 0,\n fieldNameBytes: 0,\n fieldsCount: 0,\n dataBytes: 0,\n kvCount: 0,\n kvBytes: 0,\n },\n byResourceType: {},\n };\n\n for (const resource of dumpStats) {\n const typeKey = `${resource.type.name}/${resource.type.version}` as const;\n if (!stats.byResourceType[typeKey]) {\n stats.byResourceType[typeKey] = {\n count: 0,\n fieldNameBytes: 0,\n fieldsCount: 0,\n dataBytes: 0,\n kvCount: 0,\n kvBytes: 0,\n };\n }\n\n const typeStats = stats.byResourceType[typeKey];\n typeStats.count++;\n stats.total.count++;\n\n for (const field of resource.fields) {\n typeStats.fieldNameBytes += field.name.length;\n typeStats.fieldsCount++;\n stats.total.fieldNameBytes += field.name.length;\n stats.total.fieldsCount++;\n }\n\n if (resource.data) {\n const dataLength = resource.data?.length ?? 0;\n typeStats.dataBytes += dataLength;\n stats.total.dataBytes += dataLength;\n }\n\n typeStats.kvCount += resource.kv.length;\n stats.total.kvCount += resource.kv.length;\n\n for (const kv of resource.kv) {\n const kvLength = kv.key.length + kv.value.length;\n typeStats.kvBytes += kvLength;\n stats.total.kvBytes += kvLength;\n }\n }\n\n return stats;\n}\n"],"mappings":"
|
|
1
|
+
{"version":3,"file":"dump.cjs","names":[],"sources":["../src/dump.ts"],"sourcesContent":["import type { ExtendedResourceData } from \"./state\";\n\nexport type ResourceStats = {\n /** Number of resources of this type */\n count: number;\n /** Total number of bytes in the field names of all resources of this type */\n fieldNameBytes: number;\n /** Total number of fields in all resources of this type */\n fieldsCount: number;\n /** Total number of bytes in the data of all resources of this type */\n dataBytes: number;\n /** Total number of key-value records in all resources of this type */\n kvCount: number;\n /** Total number of bytes in the key-value records of all resources of this type */\n kvBytes: number;\n};\n\n/**\n * A map of resource type statistics, keyed by the resource type name and version.\n *\n * @type {Record<string, ResourceStats>}\n */\nexport type TreeDumpStats = {\n total: ResourceStats;\n byResourceType: Record<`${string}/${string}`, ResourceStats>;\n};\n\n/**\n * Analyzes a collection of resources and generates statistics grouped by resource type.\n *\n * This function processes an array of ExtendedResourceData and calculates various metrics\n * for each unique resource type, including:\n * - Count of resources\n * - Total bytes in field names\n * - Total number of fields\n * - Total bytes in resource data\n * - Total number of key-value records\n * - Total bytes in key-value records\n *\n * The statistics are organized by resource type using a key in the format \"typeName/version\".\n *\n * @param dumpStats - Array of ExtendedResourceData objects to analyze\n * @returns A DumpStats object containing statistics for each resource type\n * @example\n * ```typescript\n * const resources = [...]; // Array of ExtendedResourceData\n * const stats = treeDumpStats(resources);\n * // stats = {\n * // \"MyResource/1\": {\n * // count: 5,\n * // fieldNameBytes: 150,\n * // fieldsCount: 10,\n * // dataBytes: 1024,\n * // kvCount: 3,\n * // kvBytes: 256\n * // },\n * // ...\n * // }\n * ```\n */\nexport function treeDumpStats(dumpStats: ExtendedResourceData[]): TreeDumpStats {\n const stats: TreeDumpStats = {\n total: {\n count: 0,\n fieldNameBytes: 0,\n fieldsCount: 0,\n dataBytes: 0,\n kvCount: 0,\n kvBytes: 0,\n },\n byResourceType: {},\n };\n\n for (const resource of dumpStats) {\n const typeKey = `${resource.type.name}/${resource.type.version}` as const;\n if (!stats.byResourceType[typeKey]) {\n stats.byResourceType[typeKey] = {\n count: 0,\n fieldNameBytes: 0,\n fieldsCount: 0,\n dataBytes: 0,\n kvCount: 0,\n kvBytes: 0,\n };\n }\n\n const typeStats = stats.byResourceType[typeKey];\n typeStats.count++;\n stats.total.count++;\n\n for (const field of resource.fields) {\n typeStats.fieldNameBytes += field.name.length;\n typeStats.fieldsCount++;\n stats.total.fieldNameBytes += field.name.length;\n stats.total.fieldsCount++;\n }\n\n if (resource.data) {\n const dataLength = resource.data?.length ?? 0;\n typeStats.dataBytes += dataLength;\n stats.total.dataBytes += dataLength;\n }\n\n typeStats.kvCount += resource.kv.length;\n stats.total.kvCount += resource.kv.length;\n\n for (const kv of resource.kv) {\n const kvLength = kv.key.length + kv.value.length;\n typeStats.kvBytes += kvLength;\n stats.total.kvBytes += kvLength;\n }\n }\n\n return stats;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4DA,SAAgB,cAAc,WAAkD;CAC9E,MAAM,QAAuB;EAC3B,OAAO;GACL,OAAO;GACP,gBAAgB;GAChB,aAAa;GACb,WAAW;GACX,SAAS;GACT,SAAS;GACV;EACD,gBAAgB,EAAE;EACnB;AAED,MAAK,MAAM,YAAY,WAAW;EAChC,MAAM,UAAU,GAAG,SAAS,KAAK,KAAK,GAAG,SAAS,KAAK;AACvD,MAAI,CAAC,MAAM,eAAe,SACxB,OAAM,eAAe,WAAW;GAC9B,OAAO;GACP,gBAAgB;GAChB,aAAa;GACb,WAAW;GACX,SAAS;GACT,SAAS;GACV;EAGH,MAAM,YAAY,MAAM,eAAe;AACvC,YAAU;AACV,QAAM,MAAM;AAEZ,OAAK,MAAM,SAAS,SAAS,QAAQ;AACnC,aAAU,kBAAkB,MAAM,KAAK;AACvC,aAAU;AACV,SAAM,MAAM,kBAAkB,MAAM,KAAK;AACzC,SAAM,MAAM;;AAGd,MAAI,SAAS,MAAM;GACjB,MAAM,aAAa,SAAS,MAAM,UAAU;AAC5C,aAAU,aAAa;AACvB,SAAM,MAAM,aAAa;;AAG3B,YAAU,WAAW,SAAS,GAAG;AACjC,QAAM,MAAM,WAAW,SAAS,GAAG;AAEnC,OAAK,MAAM,MAAM,SAAS,IAAI;GAC5B,MAAM,WAAW,GAAG,IAAI,SAAS,GAAG,MAAM;AAC1C,aAAU,WAAW;AACrB,SAAM,MAAM,WAAW;;;AAI3B,QAAO"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dump.d.ts","names":[],"sources":["../src/dump.ts"],"mappings":";;;KAEY,aAAA;yCAEV,KAAA,UAFuB;EAIvB,cAAA,UAJuB;EAMvB,WAAA,UAFA;EAIA,SAAA;EAEA,OAAA,UAEA;EAAA,OAAA;AAAA;AAQF;;;;;AAAA,KAAY,aAAA;EACV,KAAA,EAAO,aAAA;EACP,cAAA,EAAgB,MAAA,wBAA8B,aAAA;AAAA;;;;;;;AAoChD;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAgB,aAAA,CAAc,SAAA,EAAW,oBAAA,KAAyB,aAAA"}
|
package/dist/dump.js
CHANGED
package/dist/index.cjs
CHANGED
|
@@ -1,12 +1,11 @@
|
|
|
1
|
-
Object.defineProperty(exports, Symbol.toStringTag, { value:
|
|
2
|
-
const require_value_and_error = require(
|
|
3
|
-
const require_accessors = require(
|
|
4
|
-
const require_state = require(
|
|
5
|
-
const require_sync = require(
|
|
6
|
-
const require_snapshot = require(
|
|
7
|
-
const require_synchronized_tree = require(
|
|
8
|
-
const require_dump = require(
|
|
9
|
-
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
|
+
const require_value_and_error = require("./value_and_error.cjs");
|
|
3
|
+
const require_accessors = require("./accessors.cjs");
|
|
4
|
+
const require_state = require("./state.cjs");
|
|
5
|
+
const require_sync = require("./sync.cjs");
|
|
6
|
+
const require_snapshot = require("./snapshot.cjs");
|
|
7
|
+
const require_synchronized_tree = require("./synchronized_tree.cjs");
|
|
8
|
+
const require_dump = require("./dump.cjs");
|
|
10
9
|
exports.PlError = require_accessors.PlError;
|
|
11
10
|
exports.PlTreeEntry = require_accessors.PlTreeEntry;
|
|
12
11
|
exports.PlTreeEntryAccessor = require_accessors.PlTreeEntryAccessor;
|
|
@@ -29,4 +28,4 @@ exports.rsSchema = require_snapshot.rsSchema;
|
|
|
29
28
|
exports.treeDumpStats = require_dump.treeDumpStats;
|
|
30
29
|
exports.treeEntryToResourceInfo = require_accessors.treeEntryToResourceInfo;
|
|
31
30
|
exports.treeEntryToResourceWithData = require_snapshot.treeEntryToResourceWithData;
|
|
32
|
-
exports.treeEntryToResourceWithMetadata = require_snapshot.treeEntryToResourceWithMetadata;
|
|
31
|
+
exports.treeEntryToResourceWithMetadata = require_snapshot.treeEntryToResourceWithMetadata;
|
package/dist/index.js
CHANGED
|
@@ -5,5 +5,4 @@ import { constructTreeLoadingRequest, formatTreeLoadingStat, initialTreeLoadingS
|
|
|
5
5
|
import { makeResourceSnapshot, rsSchema, treeEntryToResourceWithData, treeEntryToResourceWithMetadata } from "./snapshot.js";
|
|
6
6
|
import { SynchronizedTreeState } from "./synchronized_tree.js";
|
|
7
7
|
import { treeDumpStats } from "./dump.js";
|
|
8
|
-
|
|
9
|
-
export { PlError, PlTreeEntry, PlTreeEntryAccessor, PlTreeNodeAccessor, PlTreeResource, PlTreeState, SynchronizedTreeState, TreeStateUpdateError, constructTreeLoadingRequest, formatTreeLoadingStat, initialTreeLoadingStat, isPlTreeEntry, isPlTreeEntryAccessor, isPlTreeNodeAccessor, loadTreeState, makeResourceSnapshot, mapValueAndError, mapValueAndErrorIfDefined, rsSchema, treeDumpStats, treeEntryToResourceInfo, treeEntryToResourceWithData, treeEntryToResourceWithMetadata };
|
|
8
|
+
export { PlError, PlTreeEntry, PlTreeEntryAccessor, PlTreeNodeAccessor, PlTreeResource, PlTreeState, SynchronizedTreeState, TreeStateUpdateError, constructTreeLoadingRequest, formatTreeLoadingStat, initialTreeLoadingStat, isPlTreeEntry, isPlTreeEntryAccessor, isPlTreeNodeAccessor, loadTreeState, makeResourceSnapshot, mapValueAndError, mapValueAndErrorIfDefined, rsSchema, treeDumpStats, treeEntryToResourceInfo, treeEntryToResourceWithData, treeEntryToResourceWithMetadata };
|
package/dist/snapshot.cjs
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
|
|
2
|
-
const require_accessors = require(
|
|
1
|
+
require("./_virtual/_rolldown/runtime.cjs");
|
|
2
|
+
const require_accessors = require("./accessors.cjs");
|
|
3
3
|
let _milaboratories_ts_helpers = require("@milaboratories/ts-helpers");
|
|
4
|
-
|
|
5
4
|
//#region src/snapshot.ts
|
|
6
5
|
/** Creates ResourceSnapshotSchema. It converts an optional schema type to schema type. */
|
|
7
6
|
function rsSchema(schema) {
|
|
@@ -58,10 +57,10 @@ function treeEntryToResourceWithMetadata(res, mdKeys, ctx) {
|
|
|
58
57
|
metadata: Object.fromEntries(mdEntries)
|
|
59
58
|
};
|
|
60
59
|
}
|
|
61
|
-
|
|
62
60
|
//#endregion
|
|
63
61
|
exports.makeResourceSnapshot = makeResourceSnapshot;
|
|
64
62
|
exports.rsSchema = rsSchema;
|
|
65
63
|
exports.treeEntryToResourceWithData = treeEntryToResourceWithData;
|
|
66
64
|
exports.treeEntryToResourceWithMetadata = treeEntryToResourceWithMetadata;
|
|
65
|
+
|
|
67
66
|
//# sourceMappingURL=snapshot.cjs.map
|
package/dist/snapshot.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"snapshot.cjs","names":["PlTreeEntry","PlTreeEntryAccessor"],"sources":["../src/snapshot.ts"],"sourcesContent":["import type { ResourceId, ResourceType } from \"@milaboratories/pl-client\";\nimport type { Optional, Writable } from \"utility-types\";\nimport type { ZodType, z } from \"zod\";\nimport type { PlTreeNodeAccessor } from \"./accessors\";\nimport { PlTreeEntry, PlTreeEntryAccessor } from \"./accessors\";\nimport type { ComputableCtx } from \"@milaboratories/computable\";\nimport { notEmpty } from \"@milaboratories/ts-helpers\";\n\n/**\n * A DTO that can be generated from a tree node to make a snapshot of specific parts of it's state.\n * Such snapshots can then be used in core that requires this information without the need of\n * retrieving state from the tree.\n */\nexport type ResourceSnapshot<\n Data = undefined,\n Fields extends Record<string, ResourceId | undefined> | undefined = undefined,\n KV extends Record<string, unknown> | undefined = undefined,\n> = {\n readonly id: ResourceId;\n readonly type: ResourceType;\n readonly data: Data;\n readonly fields: Fields;\n readonly kv: KV;\n};\n\n/** The most generic type of ResourceSnapshot. */\ntype ResourceSnapshotGeneric = ResourceSnapshot<\n unknown,\n Record<string, ResourceId | undefined> | undefined,\n Record<string, unknown> | undefined\n>;\n\n/** Request that we'll pass to getResourceSnapshot function. We infer the type of ResourceSnapshot from this. */\nexport type ResourceSnapshotSchema<\n Data extends ZodType | \"raw\" | undefined = undefined,\n Fields extends Record<string, boolean> | undefined = undefined,\n KV extends Record<string, ZodType | \"raw\"> | undefined = undefined,\n> = {\n readonly data: Data;\n readonly fields: Fields;\n readonly kv: KV;\n};\n\n/** Creates ResourceSnapshotSchema. It converts an optional schema type to schema type. */\nexport function rsSchema<\n const Data extends ZodType | \"raw\" | undefined = undefined,\n const Fields extends Record<string, boolean> | undefined = undefined,\n const KV extends Record<string, ZodType | \"raw\"> | undefined = undefined,\n>(\n schema: Optional<ResourceSnapshotSchema<Data, Fields, KV>>,\n): ResourceSnapshotSchema<Data, Fields, KV> {\n return schema as any;\n}\n\n/** The most generic type of ResourceSnapshotSchema. */\ntype ResourceSnapshotSchemaGeneric = ResourceSnapshotSchema<\n ZodType | \"raw\" | undefined,\n Record<string, boolean> | undefined,\n Record<string, ZodType | \"raw\"> | undefined\n>;\n\n/**\n * If Data is 'raw' in schema, we'll get bytes,\n * if it's Zod, we'll parse it via zod.\n * Or else we just got undefined in the field.\n */\ntype InferDataType<Data extends ZodType | \"raw\" | undefined> = Data extends \"raw\"\n ? Uint8Array\n : Data extends ZodType\n ? z.infer<Data>\n : undefined;\n\n/**\n * If Fields is a record of field names to booleans,\n * then if the value of the field is true, we'll require this field and throw a Error if it wasn't found.\n * If it's false and doesn't exist, we'll return undefined.\n * If Fields type is undefined, we won't set fields at all.\n */\ntype InferFieldsType<Fields extends Record<string, boolean> | undefined> = Fields extends undefined\n ? undefined\n : {\n [FieldName in keyof Fields]: Fields[FieldName] extends true\n ? ResourceId\n : ResourceId | undefined;\n };\n\n/**\n * If KV is undefined, won't set it.\n * If one of values is Zod, we'll get KV and converts it to Zod schema.\n * If the value is 'raw', just returns bytes.\n */\ntype InferKVType<KV extends Record<string, ZodType | \"raw\"> | undefined> = KV extends undefined\n ? undefined\n : {\n [FieldName in keyof KV]: KV[FieldName] extends ZodType ? z.infer<KV[FieldName]> : Uint8Array;\n };\n\n/** Infer ResourceSnapshot from ResourceShapshotSchema, S can be any ResourceSnapshotSchema. */\nexport type InferSnapshot<S extends ResourceSnapshotSchemaGeneric> = ResourceSnapshot<\n InferDataType<S[\"data\"]>,\n InferFieldsType<S[\"fields\"]>,\n InferKVType<S[\"kv\"]>\n>;\n\n/** Gets a ResourceSnapshot from PlTreeEntry. */\nexport function makeResourceSnapshot<Schema extends ResourceSnapshotSchemaGeneric>(\n res: PlTreeEntry,\n schema: Schema,\n ctx: ComputableCtx,\n): InferSnapshot<Schema>;\nexport function makeResourceSnapshot<Schema extends ResourceSnapshotSchemaGeneric>(\n res: PlTreeEntryAccessor | PlTreeNodeAccessor,\n schema: Schema,\n): InferSnapshot<Schema>;\nexport function makeResourceSnapshot<Schema extends ResourceSnapshotSchemaGeneric>(\n res: PlTreeEntry | PlTreeEntryAccessor | PlTreeNodeAccessor,\n schema: Schema,\n ctx?: ComputableCtx,\n): InferSnapshot<Schema> {\n const node =\n res instanceof PlTreeEntry\n ? notEmpty(ctx).accessor(res).node()\n : res instanceof PlTreeEntryAccessor\n ? res.node()\n : res;\n const info = node.resourceInfo;\n const result: Optional<Writable<ResourceSnapshotGeneric>, \"data\" | \"fields\" | \"kv\"> = { ...info };\n\n if (schema.data !== undefined) {\n if (schema.data === \"raw\") result.data = node.getData();\n else result.data = schema.data.parse(node.getDataAsJson());\n }\n\n if (schema.fields !== undefined) {\n const fields: Record<string, ResourceId | undefined> = {};\n // even if field is not defined, corresponding object field\n // with \"undefined\" value will still be added\n for (const [fieldName, required] of Object.entries(schema.fields))\n fields[fieldName] = node.traverse({\n field: fieldName,\n errorIfFieldNotSet: required,\n stableIfNotFound: !required,\n })?.id;\n result.fields = fields;\n }\n\n if (schema.kv !== undefined) {\n const kv: Record<string, unknown> = {};\n for (const [fieldName, type] of Object.entries(schema.kv)) {\n const value = node.getKeyValue(fieldName);\n\n if (value === undefined) {\n throw new Error(`Key not found ${fieldName}`);\n } else if (type === \"raw\") {\n kv[fieldName] = value;\n } else {\n kv[fieldName] = type.parse(JSON.parse(Buffer.from(value).toString(\"utf-8\")));\n }\n }\n result.kv = kv;\n }\n\n return result as any;\n}\n\n/** @deprecated */\nexport type ResourceWithData = {\n readonly id: ResourceId;\n readonly type: ResourceType;\n readonly fields: Map<string, ResourceId | undefined>;\n readonly data?: Uint8Array;\n};\n\n/** @deprecated */\nexport function treeEntryToResourceWithData(\n res: PlTreeEntry | ResourceWithData,\n fields: string[],\n ctx: ComputableCtx,\n): ResourceWithData {\n if (res instanceof PlTreeEntry) {\n const node = ctx.accessor(res).node();\n const info = node.resourceInfo;\n\n const fValues: [string, ResourceId | undefined][] = fields.map((name) => [\n name,\n node.getField(name)?.value?.id,\n ]);\n\n return {\n ...info,\n fields: new Map(fValues),\n data: node.getData() ?? new Uint8Array(),\n };\n }\n\n return res;\n}\n\n/** @deprecated */\nexport type ResourceWithMetadata = {\n readonly id: ResourceId;\n readonly type: ResourceType;\n readonly metadata: Record<string, any>;\n};\n\n/** @deprecated */\nexport function treeEntryToResourceWithMetadata(\n res: PlTreeEntry | ResourceWithMetadata,\n mdKeys: string[],\n ctx: ComputableCtx,\n): ResourceWithMetadata {\n if (!(res instanceof PlTreeEntry)) return res;\n\n const node = ctx.accessor(res).node();\n const info = node.resourceInfo;\n const mdEntries: [string, any][] = mdKeys.map((k) => [k, node.getKeyValue(k)]);\n\n return {\n ...info,\n metadata: Object.fromEntries(mdEntries),\n };\n}\n"],"mappings":"
|
|
1
|
+
{"version":3,"file":"snapshot.cjs","names":["PlTreeEntry","PlTreeEntryAccessor"],"sources":["../src/snapshot.ts"],"sourcesContent":["import type { ResourceId, ResourceType } from \"@milaboratories/pl-client\";\nimport type { Optional, Writable } from \"utility-types\";\nimport type { ZodType, z } from \"zod\";\nimport type { PlTreeNodeAccessor } from \"./accessors\";\nimport { PlTreeEntry, PlTreeEntryAccessor } from \"./accessors\";\nimport type { ComputableCtx } from \"@milaboratories/computable\";\nimport { notEmpty } from \"@milaboratories/ts-helpers\";\n\n/**\n * A DTO that can be generated from a tree node to make a snapshot of specific parts of it's state.\n * Such snapshots can then be used in core that requires this information without the need of\n * retrieving state from the tree.\n */\nexport type ResourceSnapshot<\n Data = undefined,\n Fields extends Record<string, ResourceId | undefined> | undefined = undefined,\n KV extends Record<string, unknown> | undefined = undefined,\n> = {\n readonly id: ResourceId;\n readonly type: ResourceType;\n readonly data: Data;\n readonly fields: Fields;\n readonly kv: KV;\n};\n\n/** The most generic type of ResourceSnapshot. */\ntype ResourceSnapshotGeneric = ResourceSnapshot<\n unknown,\n Record<string, ResourceId | undefined> | undefined,\n Record<string, unknown> | undefined\n>;\n\n/** Request that we'll pass to getResourceSnapshot function. We infer the type of ResourceSnapshot from this. */\nexport type ResourceSnapshotSchema<\n Data extends ZodType | \"raw\" | undefined = undefined,\n Fields extends Record<string, boolean> | undefined = undefined,\n KV extends Record<string, ZodType | \"raw\"> | undefined = undefined,\n> = {\n readonly data: Data;\n readonly fields: Fields;\n readonly kv: KV;\n};\n\n/** Creates ResourceSnapshotSchema. It converts an optional schema type to schema type. */\nexport function rsSchema<\n const Data extends ZodType | \"raw\" | undefined = undefined,\n const Fields extends Record<string, boolean> | undefined = undefined,\n const KV extends Record<string, ZodType | \"raw\"> | undefined = undefined,\n>(\n schema: Optional<ResourceSnapshotSchema<Data, Fields, KV>>,\n): ResourceSnapshotSchema<Data, Fields, KV> {\n return schema as any;\n}\n\n/** The most generic type of ResourceSnapshotSchema. */\ntype ResourceSnapshotSchemaGeneric = ResourceSnapshotSchema<\n ZodType | \"raw\" | undefined,\n Record<string, boolean> | undefined,\n Record<string, ZodType | \"raw\"> | undefined\n>;\n\n/**\n * If Data is 'raw' in schema, we'll get bytes,\n * if it's Zod, we'll parse it via zod.\n * Or else we just got undefined in the field.\n */\ntype InferDataType<Data extends ZodType | \"raw\" | undefined> = Data extends \"raw\"\n ? Uint8Array\n : Data extends ZodType\n ? z.infer<Data>\n : undefined;\n\n/**\n * If Fields is a record of field names to booleans,\n * then if the value of the field is true, we'll require this field and throw a Error if it wasn't found.\n * If it's false and doesn't exist, we'll return undefined.\n * If Fields type is undefined, we won't set fields at all.\n */\ntype InferFieldsType<Fields extends Record<string, boolean> | undefined> = Fields extends undefined\n ? undefined\n : {\n [FieldName in keyof Fields]: Fields[FieldName] extends true\n ? ResourceId\n : ResourceId | undefined;\n };\n\n/**\n * If KV is undefined, won't set it.\n * If one of values is Zod, we'll get KV and converts it to Zod schema.\n * If the value is 'raw', just returns bytes.\n */\ntype InferKVType<KV extends Record<string, ZodType | \"raw\"> | undefined> = KV extends undefined\n ? undefined\n : {\n [FieldName in keyof KV]: KV[FieldName] extends ZodType ? z.infer<KV[FieldName]> : Uint8Array;\n };\n\n/** Infer ResourceSnapshot from ResourceShapshotSchema, S can be any ResourceSnapshotSchema. */\nexport type InferSnapshot<S extends ResourceSnapshotSchemaGeneric> = ResourceSnapshot<\n InferDataType<S[\"data\"]>,\n InferFieldsType<S[\"fields\"]>,\n InferKVType<S[\"kv\"]>\n>;\n\n/** Gets a ResourceSnapshot from PlTreeEntry. */\nexport function makeResourceSnapshot<Schema extends ResourceSnapshotSchemaGeneric>(\n res: PlTreeEntry,\n schema: Schema,\n ctx: ComputableCtx,\n): InferSnapshot<Schema>;\nexport function makeResourceSnapshot<Schema extends ResourceSnapshotSchemaGeneric>(\n res: PlTreeEntryAccessor | PlTreeNodeAccessor,\n schema: Schema,\n): InferSnapshot<Schema>;\nexport function makeResourceSnapshot<Schema extends ResourceSnapshotSchemaGeneric>(\n res: PlTreeEntry | PlTreeEntryAccessor | PlTreeNodeAccessor,\n schema: Schema,\n ctx?: ComputableCtx,\n): InferSnapshot<Schema> {\n const node =\n res instanceof PlTreeEntry\n ? notEmpty(ctx).accessor(res).node()\n : res instanceof PlTreeEntryAccessor\n ? res.node()\n : res;\n const info = node.resourceInfo;\n const result: Optional<Writable<ResourceSnapshotGeneric>, \"data\" | \"fields\" | \"kv\"> = { ...info };\n\n if (schema.data !== undefined) {\n if (schema.data === \"raw\") result.data = node.getData();\n else result.data = schema.data.parse(node.getDataAsJson());\n }\n\n if (schema.fields !== undefined) {\n const fields: Record<string, ResourceId | undefined> = {};\n // even if field is not defined, corresponding object field\n // with \"undefined\" value will still be added\n for (const [fieldName, required] of Object.entries(schema.fields))\n fields[fieldName] = node.traverse({\n field: fieldName,\n errorIfFieldNotSet: required,\n stableIfNotFound: !required,\n })?.id;\n result.fields = fields;\n }\n\n if (schema.kv !== undefined) {\n const kv: Record<string, unknown> = {};\n for (const [fieldName, type] of Object.entries(schema.kv)) {\n const value = node.getKeyValue(fieldName);\n\n if (value === undefined) {\n throw new Error(`Key not found ${fieldName}`);\n } else if (type === \"raw\") {\n kv[fieldName] = value;\n } else {\n kv[fieldName] = type.parse(JSON.parse(Buffer.from(value).toString(\"utf-8\")));\n }\n }\n result.kv = kv;\n }\n\n return result as any;\n}\n\n/** @deprecated */\nexport type ResourceWithData = {\n readonly id: ResourceId;\n readonly type: ResourceType;\n readonly fields: Map<string, ResourceId | undefined>;\n readonly data?: Uint8Array;\n};\n\n/** @deprecated */\nexport function treeEntryToResourceWithData(\n res: PlTreeEntry | ResourceWithData,\n fields: string[],\n ctx: ComputableCtx,\n): ResourceWithData {\n if (res instanceof PlTreeEntry) {\n const node = ctx.accessor(res).node();\n const info = node.resourceInfo;\n\n const fValues: [string, ResourceId | undefined][] = fields.map((name) => [\n name,\n node.getField(name)?.value?.id,\n ]);\n\n return {\n ...info,\n fields: new Map(fValues),\n data: node.getData() ?? new Uint8Array(),\n };\n }\n\n return res;\n}\n\n/** @deprecated */\nexport type ResourceWithMetadata = {\n readonly id: ResourceId;\n readonly type: ResourceType;\n readonly metadata: Record<string, any>;\n};\n\n/** @deprecated */\nexport function treeEntryToResourceWithMetadata(\n res: PlTreeEntry | ResourceWithMetadata,\n mdKeys: string[],\n ctx: ComputableCtx,\n): ResourceWithMetadata {\n if (!(res instanceof PlTreeEntry)) return res;\n\n const node = ctx.accessor(res).node();\n const info = node.resourceInfo;\n const mdEntries: [string, any][] = mdKeys.map((k) => [k, node.getKeyValue(k)]);\n\n return {\n ...info,\n metadata: Object.fromEntries(mdEntries),\n };\n}\n"],"mappings":";;;;;AA4CA,SAAgB,SAKd,QAC0C;AAC1C,QAAO;;AA+DT,SAAgB,qBACd,KACA,QACA,KACuB;CACvB,MAAM,OACJ,eAAeA,kBAAAA,eAAAA,GAAAA,2BAAAA,UACF,IAAI,CAAC,SAAS,IAAI,CAAC,MAAM,GAClC,eAAeC,kBAAAA,sBACb,IAAI,MAAM,GACV;CAER,MAAM,SAAgF,EAAE,GAD3E,KAAK,cAC+E;AAEjG,KAAI,OAAO,SAAS,KAAA,EAClB,KAAI,OAAO,SAAS,MAAO,QAAO,OAAO,KAAK,SAAS;KAClD,QAAO,OAAO,OAAO,KAAK,MAAM,KAAK,eAAe,CAAC;AAG5D,KAAI,OAAO,WAAW,KAAA,GAAW;EAC/B,MAAM,SAAiD,EAAE;AAGzD,OAAK,MAAM,CAAC,WAAW,aAAa,OAAO,QAAQ,OAAO,OAAO,CAC/D,QAAO,aAAa,KAAK,SAAS;GAChC,OAAO;GACP,oBAAoB;GACpB,kBAAkB,CAAC;GACpB,CAAC,EAAE;AACN,SAAO,SAAS;;AAGlB,KAAI,OAAO,OAAO,KAAA,GAAW;EAC3B,MAAM,KAA8B,EAAE;AACtC,OAAK,MAAM,CAAC,WAAW,SAAS,OAAO,QAAQ,OAAO,GAAG,EAAE;GACzD,MAAM,QAAQ,KAAK,YAAY,UAAU;AAEzC,OAAI,UAAU,KAAA,EACZ,OAAM,IAAI,MAAM,iBAAiB,YAAY;YACpC,SAAS,MAClB,IAAG,aAAa;OAEhB,IAAG,aAAa,KAAK,MAAM,KAAK,MAAM,OAAO,KAAK,MAAM,CAAC,SAAS,QAAQ,CAAC,CAAC;;AAGhF,SAAO,KAAK;;AAGd,QAAO;;;AAYT,SAAgB,4BACd,KACA,QACA,KACkB;AAClB,KAAI,eAAeD,kBAAAA,aAAa;EAC9B,MAAM,OAAO,IAAI,SAAS,IAAI,CAAC,MAAM;EACrC,MAAM,OAAO,KAAK;EAElB,MAAM,UAA8C,OAAO,KAAK,SAAS,CACvE,MACA,KAAK,SAAS,KAAK,EAAE,OAAO,GAC7B,CAAC;AAEF,SAAO;GACL,GAAG;GACH,QAAQ,IAAI,IAAI,QAAQ;GACxB,MAAM,KAAK,SAAS,IAAI,IAAI,YAAY;GACzC;;AAGH,QAAO;;;AAWT,SAAgB,gCACd,KACA,QACA,KACsB;AACtB,KAAI,EAAE,eAAeA,kBAAAA,aAAc,QAAO;CAE1C,MAAM,OAAO,IAAI,SAAS,IAAI,CAAC,MAAM;CACrC,MAAM,OAAO,KAAK;CAClB,MAAM,YAA6B,OAAO,KAAK,MAAM,CAAC,GAAG,KAAK,YAAY,EAAE,CAAC,CAAC;AAE9E,QAAO;EACL,GAAG;EACH,UAAU,OAAO,YAAY,UAAU;EACxC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"snapshot.d.ts","names":[],"sources":["../src/snapshot.ts"],"mappings":";;;;;;;;AAaA;;;;KAAY,gBAAA,kCAEK,MAAA,SAAe,UAAA,kDACnB,MAAA;EAAA,SAEF,EAAA,EAAI,UAAA;EAAA,SACJ,IAAA,EAAM,YAAA;EAAA,SACN,IAAA,EAAM,IAAA;EAAA,SACN,MAAA,EAAQ,MAAA;EAAA,SACR,EAAA,EAAI,EAAA;AAAA;;KAWH,sBAAA,cACG,OAAA,iDACE,MAAA,sDACJ,MAAA,SAAe,OAAA;EAAA,SAEjB,IAAA,EAAM,IAAA;EAAA,SACN,MAAA,EAAQ,MAAA;EAAA,SACR,EAAA,EAAI,EAAA;AAAA;;iBAIC,QAAA,oBACK,OAAA,uDACE,MAAA,4DACJ,MAAA,SAAe,OAAA,kCAAA,CAEhC,MAAA,EAAQ,QAAA,CAAS,sBAAA,CAAuB,IAAA,EAAM,MAAA,EAAQ,EAAA,KACrD,sBAAA,CAAuB,IAAA,EAAM,MAAA,EAAQ,EAAA;;KAKnC,6BAAA,GAAgC,sBAAA,CACnC,OAAA,sBACA,MAAA,+BACA,MAAA,SAAe,OAAA;;;;;;KAQZ,aAAA,cAA2B,OAAA,wBAA+B,IAAA,iBAC3D,UAAA,GACA,IAAA,SAAa,OAAA,GACX,CAAA,CAAE,KAAA,CAAM,IAAA;;;;;AApCd;;KA6CK,eAAA,gBAA+B,MAAA,iCAAuC,MAAA,uDAGjD,MAAA,GAAS,MAAA,CAAO,SAAA,iBAChC,UAAA,GACA,UAAA;;;;;;KAQL,WAAA,YAAuB,MAAA,SAAe,OAAA,yBAAgC,EAAA,uDAGjD,EAAA,GAAK,EAAA,CAAG,SAAA,UAAmB,OAAA,GAAU,CAAA,CAAE,KAAA,CAAM,EAAA,CAAG,SAAA,KAAc,UAAA;;KAI5E,aAAA,WAAwB,6BAAA,IAAiC,gBAAA,CACnE,aAAA,CAAc,CAAA,WACd,eAAA,CAAgB,CAAA,aAChB,WAAA,CAAY,CAAA;;iBAIE,oBAAA,gBAAoC,6BAAA,CAAA,CAClD,GAAA,EAAK,WAAA,EACL,MAAA,EAAQ,MAAA,EACR,GAAA,EAAK,aAAA,GACJ,aAAA,CAAc,MAAA;AAAA,iBACD,oBAAA,gBAAoC,6BAAA,CAAA,CAClD,GAAA,EAAK,mBAAA,GAAsB,kBAAA,EAC3B,MAAA,EAAQ,MAAA,GACP,aAAA,CAAc,MAAA;;KAqDL,gBAAA;EAAA,SACD,EAAA,EAAI,UAAA;EAAA,SACJ,IAAA,EAAM,YAAA;EAAA,SACN,MAAA,EAAQ,GAAA,SAAY,UAAA;EAAA,SACpB,IAAA,GAAO,UAAA;AAAA;;iBAIF,2BAAA,CACd,GAAA,EAAK,WAAA,GAAc,gBAAA,EACnB,MAAA,YACA,GAAA,EAAK,aAAA,GACJ,gBAAA;AAtIH;AAAA,KA2JY,oBAAA;EAAA,SACD,EAAA,EAAI,UAAA;EAAA,SACJ,IAAA,EAAM,YAAA;EAAA,SACN,QAAA,EAAU,MAAA;AAAA;;iBAIL,+BAAA,CACd,GAAA,EAAK,WAAA,GAAc,oBAAA,EACnB,MAAA,YACA,GAAA,EAAK,aAAA,GACJ,oBAAA"}
|
package/dist/snapshot.js
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { PlTreeEntry, PlTreeEntryAccessor } from "./accessors.js";
|
|
2
2
|
import { notEmpty } from "@milaboratories/ts-helpers";
|
|
3
|
-
|
|
4
3
|
//#region src/snapshot.ts
|
|
5
4
|
/** Creates ResourceSnapshotSchema. It converts an optional schema type to schema type. */
|
|
6
5
|
function rsSchema(schema) {
|
|
@@ -57,7 +56,7 @@ function treeEntryToResourceWithMetadata(res, mdKeys, ctx) {
|
|
|
57
56
|
metadata: Object.fromEntries(mdEntries)
|
|
58
57
|
};
|
|
59
58
|
}
|
|
60
|
-
|
|
61
59
|
//#endregion
|
|
62
60
|
export { makeResourceSnapshot, rsSchema, treeEntryToResourceWithData, treeEntryToResourceWithMetadata };
|
|
61
|
+
|
|
63
62
|
//# sourceMappingURL=snapshot.js.map
|
package/dist/snapshot.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"snapshot.js","names":[],"sources":["../src/snapshot.ts"],"sourcesContent":["import type { ResourceId, ResourceType } from \"@milaboratories/pl-client\";\nimport type { Optional, Writable } from \"utility-types\";\nimport type { ZodType, z } from \"zod\";\nimport type { PlTreeNodeAccessor } from \"./accessors\";\nimport { PlTreeEntry, PlTreeEntryAccessor } from \"./accessors\";\nimport type { ComputableCtx } from \"@milaboratories/computable\";\nimport { notEmpty } from \"@milaboratories/ts-helpers\";\n\n/**\n * A DTO that can be generated from a tree node to make a snapshot of specific parts of it's state.\n * Such snapshots can then be used in core that requires this information without the need of\n * retrieving state from the tree.\n */\nexport type ResourceSnapshot<\n Data = undefined,\n Fields extends Record<string, ResourceId | undefined> | undefined = undefined,\n KV extends Record<string, unknown> | undefined = undefined,\n> = {\n readonly id: ResourceId;\n readonly type: ResourceType;\n readonly data: Data;\n readonly fields: Fields;\n readonly kv: KV;\n};\n\n/** The most generic type of ResourceSnapshot. */\ntype ResourceSnapshotGeneric = ResourceSnapshot<\n unknown,\n Record<string, ResourceId | undefined> | undefined,\n Record<string, unknown> | undefined\n>;\n\n/** Request that we'll pass to getResourceSnapshot function. We infer the type of ResourceSnapshot from this. */\nexport type ResourceSnapshotSchema<\n Data extends ZodType | \"raw\" | undefined = undefined,\n Fields extends Record<string, boolean> | undefined = undefined,\n KV extends Record<string, ZodType | \"raw\"> | undefined = undefined,\n> = {\n readonly data: Data;\n readonly fields: Fields;\n readonly kv: KV;\n};\n\n/** Creates ResourceSnapshotSchema. It converts an optional schema type to schema type. */\nexport function rsSchema<\n const Data extends ZodType | \"raw\" | undefined = undefined,\n const Fields extends Record<string, boolean> | undefined = undefined,\n const KV extends Record<string, ZodType | \"raw\"> | undefined = undefined,\n>(\n schema: Optional<ResourceSnapshotSchema<Data, Fields, KV>>,\n): ResourceSnapshotSchema<Data, Fields, KV> {\n return schema as any;\n}\n\n/** The most generic type of ResourceSnapshotSchema. */\ntype ResourceSnapshotSchemaGeneric = ResourceSnapshotSchema<\n ZodType | \"raw\" | undefined,\n Record<string, boolean> | undefined,\n Record<string, ZodType | \"raw\"> | undefined\n>;\n\n/**\n * If Data is 'raw' in schema, we'll get bytes,\n * if it's Zod, we'll parse it via zod.\n * Or else we just got undefined in the field.\n */\ntype InferDataType<Data extends ZodType | \"raw\" | undefined> = Data extends \"raw\"\n ? Uint8Array\n : Data extends ZodType\n ? z.infer<Data>\n : undefined;\n\n/**\n * If Fields is a record of field names to booleans,\n * then if the value of the field is true, we'll require this field and throw a Error if it wasn't found.\n * If it's false and doesn't exist, we'll return undefined.\n * If Fields type is undefined, we won't set fields at all.\n */\ntype InferFieldsType<Fields extends Record<string, boolean> | undefined> = Fields extends undefined\n ? undefined\n : {\n [FieldName in keyof Fields]: Fields[FieldName] extends true\n ? ResourceId\n : ResourceId | undefined;\n };\n\n/**\n * If KV is undefined, won't set it.\n * If one of values is Zod, we'll get KV and converts it to Zod schema.\n * If the value is 'raw', just returns bytes.\n */\ntype InferKVType<KV extends Record<string, ZodType | \"raw\"> | undefined> = KV extends undefined\n ? undefined\n : {\n [FieldName in keyof KV]: KV[FieldName] extends ZodType ? z.infer<KV[FieldName]> : Uint8Array;\n };\n\n/** Infer ResourceSnapshot from ResourceShapshotSchema, S can be any ResourceSnapshotSchema. */\nexport type InferSnapshot<S extends ResourceSnapshotSchemaGeneric> = ResourceSnapshot<\n InferDataType<S[\"data\"]>,\n InferFieldsType<S[\"fields\"]>,\n InferKVType<S[\"kv\"]>\n>;\n\n/** Gets a ResourceSnapshot from PlTreeEntry. */\nexport function makeResourceSnapshot<Schema extends ResourceSnapshotSchemaGeneric>(\n res: PlTreeEntry,\n schema: Schema,\n ctx: ComputableCtx,\n): InferSnapshot<Schema>;\nexport function makeResourceSnapshot<Schema extends ResourceSnapshotSchemaGeneric>(\n res: PlTreeEntryAccessor | PlTreeNodeAccessor,\n schema: Schema,\n): InferSnapshot<Schema>;\nexport function makeResourceSnapshot<Schema extends ResourceSnapshotSchemaGeneric>(\n res: PlTreeEntry | PlTreeEntryAccessor | PlTreeNodeAccessor,\n schema: Schema,\n ctx?: ComputableCtx,\n): InferSnapshot<Schema> {\n const node =\n res instanceof PlTreeEntry\n ? notEmpty(ctx).accessor(res).node()\n : res instanceof PlTreeEntryAccessor\n ? res.node()\n : res;\n const info = node.resourceInfo;\n const result: Optional<Writable<ResourceSnapshotGeneric>, \"data\" | \"fields\" | \"kv\"> = { ...info };\n\n if (schema.data !== undefined) {\n if (schema.data === \"raw\") result.data = node.getData();\n else result.data = schema.data.parse(node.getDataAsJson());\n }\n\n if (schema.fields !== undefined) {\n const fields: Record<string, ResourceId | undefined> = {};\n // even if field is not defined, corresponding object field\n // with \"undefined\" value will still be added\n for (const [fieldName, required] of Object.entries(schema.fields))\n fields[fieldName] = node.traverse({\n field: fieldName,\n errorIfFieldNotSet: required,\n stableIfNotFound: !required,\n })?.id;\n result.fields = fields;\n }\n\n if (schema.kv !== undefined) {\n const kv: Record<string, unknown> = {};\n for (const [fieldName, type] of Object.entries(schema.kv)) {\n const value = node.getKeyValue(fieldName);\n\n if (value === undefined) {\n throw new Error(`Key not found ${fieldName}`);\n } else if (type === \"raw\") {\n kv[fieldName] = value;\n } else {\n kv[fieldName] = type.parse(JSON.parse(Buffer.from(value).toString(\"utf-8\")));\n }\n }\n result.kv = kv;\n }\n\n return result as any;\n}\n\n/** @deprecated */\nexport type ResourceWithData = {\n readonly id: ResourceId;\n readonly type: ResourceType;\n readonly fields: Map<string, ResourceId | undefined>;\n readonly data?: Uint8Array;\n};\n\n/** @deprecated */\nexport function treeEntryToResourceWithData(\n res: PlTreeEntry | ResourceWithData,\n fields: string[],\n ctx: ComputableCtx,\n): ResourceWithData {\n if (res instanceof PlTreeEntry) {\n const node = ctx.accessor(res).node();\n const info = node.resourceInfo;\n\n const fValues: [string, ResourceId | undefined][] = fields.map((name) => [\n name,\n node.getField(name)?.value?.id,\n ]);\n\n return {\n ...info,\n fields: new Map(fValues),\n data: node.getData() ?? new Uint8Array(),\n };\n }\n\n return res;\n}\n\n/** @deprecated */\nexport type ResourceWithMetadata = {\n readonly id: ResourceId;\n readonly type: ResourceType;\n readonly metadata: Record<string, any>;\n};\n\n/** @deprecated */\nexport function treeEntryToResourceWithMetadata(\n res: PlTreeEntry | ResourceWithMetadata,\n mdKeys: string[],\n ctx: ComputableCtx,\n): ResourceWithMetadata {\n if (!(res instanceof PlTreeEntry)) return res;\n\n const node = ctx.accessor(res).node();\n const info = node.resourceInfo;\n const mdEntries: [string, any][] = mdKeys.map((k) => [k, node.getKeyValue(k)]);\n\n return {\n ...info,\n metadata: Object.fromEntries(mdEntries),\n };\n}\n"],"mappings":"
|
|
1
|
+
{"version":3,"file":"snapshot.js","names":[],"sources":["../src/snapshot.ts"],"sourcesContent":["import type { ResourceId, ResourceType } from \"@milaboratories/pl-client\";\nimport type { Optional, Writable } from \"utility-types\";\nimport type { ZodType, z } from \"zod\";\nimport type { PlTreeNodeAccessor } from \"./accessors\";\nimport { PlTreeEntry, PlTreeEntryAccessor } from \"./accessors\";\nimport type { ComputableCtx } from \"@milaboratories/computable\";\nimport { notEmpty } from \"@milaboratories/ts-helpers\";\n\n/**\n * A DTO that can be generated from a tree node to make a snapshot of specific parts of it's state.\n * Such snapshots can then be used in core that requires this information without the need of\n * retrieving state from the tree.\n */\nexport type ResourceSnapshot<\n Data = undefined,\n Fields extends Record<string, ResourceId | undefined> | undefined = undefined,\n KV extends Record<string, unknown> | undefined = undefined,\n> = {\n readonly id: ResourceId;\n readonly type: ResourceType;\n readonly data: Data;\n readonly fields: Fields;\n readonly kv: KV;\n};\n\n/** The most generic type of ResourceSnapshot. */\ntype ResourceSnapshotGeneric = ResourceSnapshot<\n unknown,\n Record<string, ResourceId | undefined> | undefined,\n Record<string, unknown> | undefined\n>;\n\n/** Request that we'll pass to getResourceSnapshot function. We infer the type of ResourceSnapshot from this. */\nexport type ResourceSnapshotSchema<\n Data extends ZodType | \"raw\" | undefined = undefined,\n Fields extends Record<string, boolean> | undefined = undefined,\n KV extends Record<string, ZodType | \"raw\"> | undefined = undefined,\n> = {\n readonly data: Data;\n readonly fields: Fields;\n readonly kv: KV;\n};\n\n/** Creates ResourceSnapshotSchema. It converts an optional schema type to schema type. */\nexport function rsSchema<\n const Data extends ZodType | \"raw\" | undefined = undefined,\n const Fields extends Record<string, boolean> | undefined = undefined,\n const KV extends Record<string, ZodType | \"raw\"> | undefined = undefined,\n>(\n schema: Optional<ResourceSnapshotSchema<Data, Fields, KV>>,\n): ResourceSnapshotSchema<Data, Fields, KV> {\n return schema as any;\n}\n\n/** The most generic type of ResourceSnapshotSchema. */\ntype ResourceSnapshotSchemaGeneric = ResourceSnapshotSchema<\n ZodType | \"raw\" | undefined,\n Record<string, boolean> | undefined,\n Record<string, ZodType | \"raw\"> | undefined\n>;\n\n/**\n * If Data is 'raw' in schema, we'll get bytes,\n * if it's Zod, we'll parse it via zod.\n * Or else we just got undefined in the field.\n */\ntype InferDataType<Data extends ZodType | \"raw\" | undefined> = Data extends \"raw\"\n ? Uint8Array\n : Data extends ZodType\n ? z.infer<Data>\n : undefined;\n\n/**\n * If Fields is a record of field names to booleans,\n * then if the value of the field is true, we'll require this field and throw a Error if it wasn't found.\n * If it's false and doesn't exist, we'll return undefined.\n * If Fields type is undefined, we won't set fields at all.\n */\ntype InferFieldsType<Fields extends Record<string, boolean> | undefined> = Fields extends undefined\n ? undefined\n : {\n [FieldName in keyof Fields]: Fields[FieldName] extends true\n ? ResourceId\n : ResourceId | undefined;\n };\n\n/**\n * If KV is undefined, won't set it.\n * If one of values is Zod, we'll get KV and converts it to Zod schema.\n * If the value is 'raw', just returns bytes.\n */\ntype InferKVType<KV extends Record<string, ZodType | \"raw\"> | undefined> = KV extends undefined\n ? undefined\n : {\n [FieldName in keyof KV]: KV[FieldName] extends ZodType ? z.infer<KV[FieldName]> : Uint8Array;\n };\n\n/** Infer ResourceSnapshot from ResourceShapshotSchema, S can be any ResourceSnapshotSchema. */\nexport type InferSnapshot<S extends ResourceSnapshotSchemaGeneric> = ResourceSnapshot<\n InferDataType<S[\"data\"]>,\n InferFieldsType<S[\"fields\"]>,\n InferKVType<S[\"kv\"]>\n>;\n\n/** Gets a ResourceSnapshot from PlTreeEntry. */\nexport function makeResourceSnapshot<Schema extends ResourceSnapshotSchemaGeneric>(\n res: PlTreeEntry,\n schema: Schema,\n ctx: ComputableCtx,\n): InferSnapshot<Schema>;\nexport function makeResourceSnapshot<Schema extends ResourceSnapshotSchemaGeneric>(\n res: PlTreeEntryAccessor | PlTreeNodeAccessor,\n schema: Schema,\n): InferSnapshot<Schema>;\nexport function makeResourceSnapshot<Schema extends ResourceSnapshotSchemaGeneric>(\n res: PlTreeEntry | PlTreeEntryAccessor | PlTreeNodeAccessor,\n schema: Schema,\n ctx?: ComputableCtx,\n): InferSnapshot<Schema> {\n const node =\n res instanceof PlTreeEntry\n ? notEmpty(ctx).accessor(res).node()\n : res instanceof PlTreeEntryAccessor\n ? res.node()\n : res;\n const info = node.resourceInfo;\n const result: Optional<Writable<ResourceSnapshotGeneric>, \"data\" | \"fields\" | \"kv\"> = { ...info };\n\n if (schema.data !== undefined) {\n if (schema.data === \"raw\") result.data = node.getData();\n else result.data = schema.data.parse(node.getDataAsJson());\n }\n\n if (schema.fields !== undefined) {\n const fields: Record<string, ResourceId | undefined> = {};\n // even if field is not defined, corresponding object field\n // with \"undefined\" value will still be added\n for (const [fieldName, required] of Object.entries(schema.fields))\n fields[fieldName] = node.traverse({\n field: fieldName,\n errorIfFieldNotSet: required,\n stableIfNotFound: !required,\n })?.id;\n result.fields = fields;\n }\n\n if (schema.kv !== undefined) {\n const kv: Record<string, unknown> = {};\n for (const [fieldName, type] of Object.entries(schema.kv)) {\n const value = node.getKeyValue(fieldName);\n\n if (value === undefined) {\n throw new Error(`Key not found ${fieldName}`);\n } else if (type === \"raw\") {\n kv[fieldName] = value;\n } else {\n kv[fieldName] = type.parse(JSON.parse(Buffer.from(value).toString(\"utf-8\")));\n }\n }\n result.kv = kv;\n }\n\n return result as any;\n}\n\n/** @deprecated */\nexport type ResourceWithData = {\n readonly id: ResourceId;\n readonly type: ResourceType;\n readonly fields: Map<string, ResourceId | undefined>;\n readonly data?: Uint8Array;\n};\n\n/** @deprecated */\nexport function treeEntryToResourceWithData(\n res: PlTreeEntry | ResourceWithData,\n fields: string[],\n ctx: ComputableCtx,\n): ResourceWithData {\n if (res instanceof PlTreeEntry) {\n const node = ctx.accessor(res).node();\n const info = node.resourceInfo;\n\n const fValues: [string, ResourceId | undefined][] = fields.map((name) => [\n name,\n node.getField(name)?.value?.id,\n ]);\n\n return {\n ...info,\n fields: new Map(fValues),\n data: node.getData() ?? new Uint8Array(),\n };\n }\n\n return res;\n}\n\n/** @deprecated */\nexport type ResourceWithMetadata = {\n readonly id: ResourceId;\n readonly type: ResourceType;\n readonly metadata: Record<string, any>;\n};\n\n/** @deprecated */\nexport function treeEntryToResourceWithMetadata(\n res: PlTreeEntry | ResourceWithMetadata,\n mdKeys: string[],\n ctx: ComputableCtx,\n): ResourceWithMetadata {\n if (!(res instanceof PlTreeEntry)) return res;\n\n const node = ctx.accessor(res).node();\n const info = node.resourceInfo;\n const mdEntries: [string, any][] = mdKeys.map((k) => [k, node.getKeyValue(k)]);\n\n return {\n ...info,\n metadata: Object.fromEntries(mdEntries),\n };\n}\n"],"mappings":";;;;AA4CA,SAAgB,SAKd,QAC0C;AAC1C,QAAO;;AA+DT,SAAgB,qBACd,KACA,QACA,KACuB;CACvB,MAAM,OACJ,eAAe,cACX,SAAS,IAAI,CAAC,SAAS,IAAI,CAAC,MAAM,GAClC,eAAe,sBACb,IAAI,MAAM,GACV;CAER,MAAM,SAAgF,EAAE,GAD3E,KAAK,cAC+E;AAEjG,KAAI,OAAO,SAAS,KAAA,EAClB,KAAI,OAAO,SAAS,MAAO,QAAO,OAAO,KAAK,SAAS;KAClD,QAAO,OAAO,OAAO,KAAK,MAAM,KAAK,eAAe,CAAC;AAG5D,KAAI,OAAO,WAAW,KAAA,GAAW;EAC/B,MAAM,SAAiD,EAAE;AAGzD,OAAK,MAAM,CAAC,WAAW,aAAa,OAAO,QAAQ,OAAO,OAAO,CAC/D,QAAO,aAAa,KAAK,SAAS;GAChC,OAAO;GACP,oBAAoB;GACpB,kBAAkB,CAAC;GACpB,CAAC,EAAE;AACN,SAAO,SAAS;;AAGlB,KAAI,OAAO,OAAO,KAAA,GAAW;EAC3B,MAAM,KAA8B,EAAE;AACtC,OAAK,MAAM,CAAC,WAAW,SAAS,OAAO,QAAQ,OAAO,GAAG,EAAE;GACzD,MAAM,QAAQ,KAAK,YAAY,UAAU;AAEzC,OAAI,UAAU,KAAA,EACZ,OAAM,IAAI,MAAM,iBAAiB,YAAY;YACpC,SAAS,MAClB,IAAG,aAAa;OAEhB,IAAG,aAAa,KAAK,MAAM,KAAK,MAAM,OAAO,KAAK,MAAM,CAAC,SAAS,QAAQ,CAAC,CAAC;;AAGhF,SAAO,KAAK;;AAGd,QAAO;;;AAYT,SAAgB,4BACd,KACA,QACA,KACkB;AAClB,KAAI,eAAe,aAAa;EAC9B,MAAM,OAAO,IAAI,SAAS,IAAI,CAAC,MAAM;EACrC,MAAM,OAAO,KAAK;EAElB,MAAM,UAA8C,OAAO,KAAK,SAAS,CACvE,MACA,KAAK,SAAS,KAAK,EAAE,OAAO,GAC7B,CAAC;AAEF,SAAO;GACL,GAAG;GACH,QAAQ,IAAI,IAAI,QAAQ;GACxB,MAAM,KAAK,SAAS,IAAI,IAAI,YAAY;GACzC;;AAGH,QAAO;;;AAWT,SAAgB,gCACd,KACA,QACA,KACsB;AACtB,KAAI,EAAE,eAAe,aAAc,QAAO;CAE1C,MAAM,OAAO,IAAI,SAAS,IAAI,CAAC,MAAM;CACrC,MAAM,OAAO,KAAK;CAClB,MAAM,YAA6B,OAAO,KAAK,MAAM,CAAC,GAAG,KAAK,YAAY,EAAE,CAAC,CAAC;AAE9E,QAAO;EACL,GAAG;EACH,UAAU,OAAO,YAAY,UAAU;EACxC"}
|
package/dist/state.cjs
CHANGED
|
@@ -1,9 +1,8 @@
|
|
|
1
|
-
|
|
2
|
-
const require_accessors = require(
|
|
1
|
+
require("./_virtual/_rolldown/runtime.cjs");
|
|
2
|
+
const require_accessors = require("./accessors.cjs");
|
|
3
3
|
let _milaboratories_pl_client = require("@milaboratories/pl-client");
|
|
4
4
|
let _milaboratories_computable = require("@milaboratories/computable");
|
|
5
5
|
let _milaboratories_ts_helpers = require("@milaboratories/ts-helpers");
|
|
6
|
-
|
|
7
6
|
//#region src/state.ts
|
|
8
7
|
var TreeStateUpdateError = class extends Error {
|
|
9
8
|
constructor(message) {
|
|
@@ -486,9 +485,9 @@ var PlTreeState = class {
|
|
|
486
485
|
return Array.from(this.resources.values()).map((res) => res.extendedState);
|
|
487
486
|
}
|
|
488
487
|
};
|
|
489
|
-
|
|
490
488
|
//#endregion
|
|
491
489
|
exports.PlTreeResource = PlTreeResource;
|
|
492
490
|
exports.PlTreeState = PlTreeState;
|
|
493
491
|
exports.TreeStateUpdateError = TreeStateUpdateError;
|
|
492
|
+
|
|
494
493
|
//# sourceMappingURL=state.cjs.map
|