@milaboratories/pl-tree 1.3.6 → 1.3.8

package/dist/accessors.d.ts

@@ -0,0 +1,117 @@
+import { PlTreeResource, PlTreeState } from './state';
+import { AccessorProvider, ComputableCtx, ComputableHooks, UsageGuard } from '@milaboratories/computable';
+import { ResourceId, ResourceType, OptionalResourceId } from '@milaboratories/pl-client';
+import { ValueAndError } from './value_and_error';
+import { CommonFieldTraverseOps, FieldTraversalStep, GetFieldStep, ResourceTraversalOps } from './traversal_ops';
+import { ValueOrError } from './value_or_error';
+/** Error encountered during traversal in field or resource. */
+export declare class PlError extends Error {
+    constructor(message: string);
+}
+export type TreeAccessorData = {
+    readonly treeProvider: () => PlTreeState;
+    readonly hooks?: ComputableHooks;
+};
+export type TreeAccessorInstanceData = {
+    readonly guard: UsageGuard;
+    readonly ctx: ComputableCtx;
+};
+export declare function isPlTreeEntry(obj: unknown): obj is PlTreeEntry;
+export declare function isPlTreeEntryAccessor(obj: unknown): obj is PlTreeEntryAccessor;
+export declare function isPlTreeNodeAccessor(obj: unknown): obj is PlTreeNodeAccessor;
+/** Main entry point for using PlTree in reactive setting */
+export declare class PlTreeEntry implements AccessorProvider<PlTreeEntryAccessor> {
+    private readonly accessorData;
+    readonly rid: ResourceId;
+    private readonly __pl_tree_type_marker__;
+    constructor(accessorData: TreeAccessorData, rid: ResourceId);
+    createAccessor(ctx: ComputableCtx, guard: UsageGuard): PlTreeEntryAccessor;
+    toJSON(): string;
+    toString(): string;
+}
+export declare class PlTreeEntryAccessor {
+    private readonly accessorData;
+    private readonly tree;
+    private readonly rid;
+    private readonly instanceData;
+    private readonly __pl_tree_type_marker__;
+    constructor(accessorData: TreeAccessorData, tree: PlTreeState, rid: ResourceId, instanceData: TreeAccessorInstanceData);
+    node(ops?: ResourceTraversalOps): PlTreeNodeAccessor;
+}
+/**
+ * Helper type to simplify implementation of APIs requiring type information.
+ * @deprecated
+ * */
+export type ResourceInfo = {
+    readonly id: ResourceId;
+    readonly type: ResourceType;
+};
+/**
+ * Can be called only when a ctx is provided, because pl tree entry is a computable entity.
+ * @deprecated
+ * */
+export declare function treeEntryToResourceInfo(res: PlTreeEntry | ResourceInfo, ctx: ComputableCtx): ResourceInfo;
+/**
+ * API contracts:
+ *   - API never return {@link NullResourceId}, absence of link is always modeled as `undefined`
+ *
+ * Important: never store instances of this class, always get fresh instance from {@link PlTreeState} accessor.
+ * */
+export declare class PlTreeNodeAccessor {
+    private readonly accessorData;
+    private readonly tree;
+    private readonly resource;
+    private readonly instanceData;
+    private readonly __pl_tree_type_marker__;
+    constructor(accessorData: TreeAccessorData, tree: PlTreeState, resource: PlTreeResource, instanceData: TreeAccessorInstanceData);
+    get id(): ResourceId;
+    get originalId(): OptionalResourceId;
+    get resourceType(): ResourceType;
+    get resourceInfo(): ResourceInfo;
+    private getResourceFromTree;
+    traverse(...steps: [
+        Omit<FieldTraversalStep, 'errorIfFieldNotSet'> & {
+            errorIfFieldNotSet: true;
+        }
+    ]): PlTreeNodeAccessor;
+    traverse(...steps: (FieldTraversalStep | string)[]): PlTreeNodeAccessor | undefined;
+    traverseOrError(...steps: [
+        Omit<FieldTraversalStep, 'errorIfFieldNotSet'> & {
+            errorIfFieldNotSet: true;
+        }
+    ]): ValueOrError<PlTreeNodeAccessor, string>;
+    traverseOrError(...steps: (FieldTraversalStep | string)[]): ValueOrError<PlTreeNodeAccessor, string> | undefined;
+    traverseWithCommon(commonOptions: CommonFieldTraverseOps, ...steps: (FieldTraversalStep | string)[]): PlTreeNodeAccessor | undefined;
+    traverseOrErrorWithCommon(commonOptions: CommonFieldTraverseOps, ...steps: (FieldTraversalStep | string)[]): ValueOrError<PlTreeNodeAccessor, string> | undefined;
+    private readonly onUnstableLambda;
+    getField(_step: (Omit<GetFieldStep, 'errorIfFieldNotFound'> & {
+        errorIfFieldNotFound: true;
+    }) | (Omit<GetFieldStep, 'errorIfFieldNotSet'> & {
+        errorIfFieldNotSet: true;
+    })): ValueAndError<PlTreeNodeAccessor>;
+    getField(_step: GetFieldStep | string): ValueAndError<PlTreeNodeAccessor> | undefined;
+    getInputsLocked(): boolean;
+    getOutputsLocked(): boolean;
+    getIsReadyOrError(): boolean;
+    getIsFinal(): boolean;
+    getError(): PlTreeNodeAccessor | undefined;
+    getData(): Uint8Array | undefined;
+    getDataAsString(): string | undefined;
+    getDataAsJson<T = unknown>(): T | undefined;
+    listInputFields(): string[];
+    listOutputFields(): string[];
+    listDynamicFields(): string[];
+    getKeyValue(key: string, unstableIfNotFound?: boolean): Uint8Array | undefined;
+    /** @deprecated */
+    getKeyValueString(key: string): string | undefined;
+    getKeyValueAsString(key: string, unstableIfNotFound?: boolean): string | undefined;
+    getKeyValueAsJson<T = unknown>(key: string, unstableIfNotFound?: boolean): T | undefined;
+    /**
+     * Can be used to passe a higher level accessor that will wrap the resource and throw its
+     * errors on node resolution.
+     * */
+    toEntryAccessor(): PlTreeEntryAccessor;
+    /** Can be passed to nested computable. */
+    persist(): PlTreeEntry;
+}
+//# sourceMappingURL=accessors.d.ts.map

package/dist/accessors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessors.d.ts","sourceRoot":"","sources":["../src/accessors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtD,OAAO,EACL,gBAAgB,EAChB,aAAa,EACb,eAAe,EACf,UAAU,EACX,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,UAAU,EAEV,YAAY,EAIZ,kBAAkB,EACnB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAoB,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,YAAY,EACZ,oBAAoB,EACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAKhD,+DAA+D;AAC/D,qBAAa,OAAQ,SAAQ,KAAK;gBACpB,OAAO,EAAE,MAAM;CAG5B;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM,WAAW,CAAC;IACzC,QAAQ,CAAC,KAAK,CAAC,EAAE,eAAe,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC;CAC7B,CAAC;AAEF,wBAAgB,aAAa,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,WAAW,CAM9D;AAED,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,mBAAmB,CAM9E;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,kBAAkB,CAM5E;AAED,4DAA4D;AAC5D,qBAAa,WAAY,YAAW,gBAAgB,CAAC,mBAAmB,CAAC;IAIrE,OAAO,CAAC,QAAQ,CAAC,YAAY;aACb,GAAG,EAAE,UAAU;IAJjC,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAiB;gBAGtC,YAAY,EAAE,gBAAgB,EAC/B,GAAG,EAAE,UAAU;IAG1B,cAAc,CAAC,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,UAAU,GAAG,mBAAmB;IAO1E,MAAM,IAAI,MAAM;IAIhB,QAAQ,IAAI,MAAM;CAG1B;AAqCD,qBAAa,mBAAmB;IAI5B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAN/B,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAyB;gBAG9C,YAAY,EAAE,gBAAgB,EAC9B,IAAI,EAAE,WAAW,EACjB,GAAG,EAAE,UAAU,EACf,YAAY,EAAE,wBAAwB;IAGzD,IAAI,CAAC,GAAG,GAAE,oBAAyB,GAAG,kBAAkB;CAUzD;AAED;;;KAGK;AACL,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;CAC7B,CAAC;AAEF;;;KAGK;AACL,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,WAAW,GAAG,YAAY,EAAE,GAAG,EAAE,aAAa,gBAI1F;AAED;;;;;KAKK;AACL,qBAAa,kBAAkB;IAI3B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAN/B,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAwB;gBAG7C,YAAY,EAAE,gBAAgB,EAC9B,IAAI,EAAE,WAAW,EACjB,QAAQ,EAAE,cAAc,EACxB,YAAY,EAAE,wBAAwB;IAGzD,IAAW,EAAE,IAAI,UAAU,CAG1B;IAED,IAAW,UAAU,IAAI,kBAAkB,CAG1C;IAED,IAAW,YAAY,IAAI,YAAY,CAGtC;IAED,IAAW,YAAY,IAAI,YAAY,CAEtC;IAED,OAAO,CAAC,mBAAmB;IAIpB,QAAQ,CACb,GAAG,KAAK,EAAE;QACR,IAAI,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,GAAG;YAC/C,kBAAkB,EAAE,IAAI,CAAC;SAC1B;KACF,GACA,kBAAkB;IACd,QAAQ,CAAC,GAAG,KAAK,EAAE,CAAC,kBAAkB,GAAG,MAAM,CAAC,EAAE,GAAG,kBAAkB,GAAG,SAAS;IAKnF,eAAe,CACpB,GAAG,KAAK,EAAE;QACR,IAAI,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,GAAG;YAC/C,kBAAkB,EAAE,IAAI,CAAC;SAC1B;KACF,GACA,YAAY,CAAC,kBAAkB,EAAE,MAAM,CAAC;IACpC,eAAe,CACpB,GAAG,KAAK,EAAE,CAAC,kBAAkB,GAAG,MAAM,CAAC,EAAE,GACxC,YAAY,CAAC,kBAAkB,EAAE,MAAM,CAAC,GAAG,SAAS;IAOhD,kBAAkB,CACvB,aAAa,EAAE,sBAAsB,EACrC,GAAG,KAAK,EAAE,CAAC,kBAAkB,GAAG,MAAM,CAAC,EAAE,GACxC,kBAAkB,GAAG,SAAS;IAO1B,yBAAyB,CAC9B,aAAa,EAAE,sBAAsB,EACrC,GAAG,KAAK,EAAE,CAAC,kBAAkB,GAAG,MAAM,CAAC,EAAE,GACxC,YAAY,CAAC,kBAAkB,EAAE,MAAM,CAAC,GAAG,SAAS;IAyCvD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAE/B;IAEK,QAAQ,CACb,KAAK,EACD,CAAC,IAAI,CAAC,YAAY,EAAE,sBAAsB,CAAC,GAAG;QAAE,oBAAoB,EAAE,IAAI,CAAA;KAAE,CAAC,GAC7E,CAAC,IAAI,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG;QAAE,kBAAkB,EAAE,IAAI,CAAA;KAAE,CAAC,GAC5E,aAAa,CAAC,kBAAkB,CAAC;IAC7B,QAAQ,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM,GAAG,aAAa,CAAC,kBAAkB,CAAC,GAAG,SAAS;IAYrF,eAAe,IAAI,OAAO;IAO1B,gBAAgB,IAAI,OAAO;IAO3B,iBAAiB,IAAI,OAAO;IAO5B,UAAU;IAKV,QAAQ,IAAI,kBAAkB,GAAG,SAAS;IAS1C,OAAO,IAAI,UAAU,GAAG,SAAS;IAIjC,eAAe,IAAI,MAAM,GAAG,SAAS;IAIrC,aAAa,CAAC,CAAC,GAAG,OAAO,KAAK,CAAC,GAAG,SAAS;IAI3C,eAAe,IAAI,MAAM,EAAE;IAM3B,gBAAgB,IAAI,MAAM,EAAE;IAM5B,iBAAiB,IAAI,MAAM,EAAE;IAK7B,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,kBAAkB,GAAE,OAAe,GAAG,UAAU,GAAG,SAAS;IAQ5F,kBAAkB;IACX,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAIlD,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,kBAAkB,GAAE,OAAe,GAAG,MAAM,GAAG,SAAS;IAQzF,iBAAiB,CAAC,CAAC,GAAG,OAAO,EAClC,GAAG,EAAE,MAAM,EACX,kBAAkB,GAAE,OAAe,GAClC,CAAC,GAAG,SAAS;IAShB;;;SAGK;IACE,eAAe,IAAI,mBAAmB;IAI7C,0CAA0C;IACnC,OAAO,IAAI,WAAW;CAG9B"}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export * from './traversal_ops';
+export * from './state';
+export * from './sync';
+export * from './accessors';
+export * from './snapshot';
+export * from './synchronized_tree';
+export * from './value_and_error';
+export * from './value_or_error';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC"}