@milaboratories/pl-tree 1.8.33 → 1.8.35

package/dist/dump.js.map

@@ -1 +1 @@
-{"version":3,"file":"dump.js","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"],"names":[],"mappings":"AA2BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCG;AACG,SAAU,aAAa,CAAC,SAAiC,EAAA;AAC7D,IAAA,MAAM,KAAK,GAAkB;AAC3B,QAAA,KAAK,EAAE;AACL,YAAA,KAAK,EAAE,CAAC;AACR,YAAA,cAAc,EAAE,CAAC;AACjB,YAAA,WAAW,EAAE,CAAC;AACd,YAAA,SAAS,EAAE,CAAC;AACZ,YAAA,OAAO,EAAE,CAAC;AACV,YAAA,OAAO,EAAE,CAAC;AACX,SAAA;AACD,QAAA,cAAc,EAAE,EAAE;KACnB;AAED,IAAA,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;AAChC,QAAA,MAAM,OAAO,GAAG,CAAA,EAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAA,CAAA,EAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAW;QACzE,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE;AAClC,YAAA,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG;AAC9B,gBAAA,KAAK,EAAE,CAAC;AACR,gBAAA,cAAc,EAAE,CAAC;AACjB,gBAAA,WAAW,EAAE,CAAC;AACd,gBAAA,SAAS,EAAE,CAAC;AACZ,gBAAA,OAAO,EAAE,CAAC;AACV,gBAAA,OAAO,EAAE,CAAC;aACX;QACH;QAEA,MAAM,SAAS,GAAG,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC;QAC/C,SAAS,CAAC,KAAK,EAAE;AACjB,QAAA,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE;AAEnB,QAAA,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE;YACnC,SAAS,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM;YAC7C,SAAS,CAAC,WAAW,EAAE;YACvB,KAAK,CAAC,KAAK,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM;AAC/C,YAAA,KAAK,CAAC,KAAK,CAAC,WAAW,EAAE;QAC3B;AAEA,QAAA,IAAI,QAAQ,CAAC,IAAI,EAAE;YACjB,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC;AAC7C,YAAA,SAAS,CAAC,SAAS,IAAI,UAAU;AACjC,YAAA,KAAK,CAAC,KAAK,CAAC,SAAS,IAAI,UAAU;QACrC;QAEA,SAAS,CAAC,OAAO,IAAI,QAAQ,CAAC,EAAE,CAAC,MAAM;QACvC,KAAK,CAAC,KAAK,CAAC,OAAO,IAAI,QAAQ,CAAC,EAAE,CAAC,MAAM;AAEzC,QAAA,KAAK,MAAM,EAAE,IAAI,QAAQ,CAAC,EAAE,EAAE;AAC5B,YAAA,MAAM,QAAQ,GAAG,EAAE,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM;AAChD,YAAA,SAAS,CAAC,OAAO,IAAI,QAAQ;AAC7B,YAAA,KAAK,CAAC,KAAK,CAAC,OAAO,IAAI,QAAQ;QACjC;IACF;AAEA,IAAA,OAAO,KAAK;AACd;;;;"}
+{"version":3,"file":"dump.js","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"],"names":[],"mappings":"AA2BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCG;AACG,SAAU,aAAa,CAAC,SAAiC,EAAA;AAC7D,IAAA,MAAM,KAAK,GAAkB;AAC3B,QAAA,KAAK,EAAE;AACL,YAAA,KAAK,EAAE,CAAC;AACR,YAAA,cAAc,EAAE,CAAC;AACjB,YAAA,WAAW,EAAE,CAAC;AACd,YAAA,SAAS,EAAE,CAAC;AACZ,YAAA,OAAO,EAAE,CAAC;AACV,YAAA,OAAO,EAAE,CAAC;AACX,SAAA;AACD,QAAA,cAAc,EAAE,EAAE;KACnB;AAED,IAAA,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;AAChC,QAAA,MAAM,OAAO,GAAG,CAAA,EAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAA,CAAA,EAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAW;QACzE,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE;AAClC,YAAA,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG;AAC9B,gBAAA,KAAK,EAAE,CAAC;AACR,gBAAA,cAAc,EAAE,CAAC;AACjB,gBAAA,WAAW,EAAE,CAAC;AACd,gBAAA,SAAS,EAAE,CAAC;AACZ,gBAAA,OAAO,EAAE,CAAC;AACV,gBAAA,OAAO,EAAE,CAAC;aACX;QACH;QAEA,MAAM,SAAS,GAAG,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC;QAC/C,SAAS,CAAC,KAAK,EAAE;AACjB,QAAA,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE;AAEnB,QAAA,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE;YACnC,SAAS,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM;YAC7C,SAAS,CAAC,WAAW,EAAE;YACvB,KAAK,CAAC,KAAK,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM;AAC/C,YAAA,KAAK,CAAC,KAAK,CAAC,WAAW,EAAE;QAC3B;AAEA,QAAA,IAAI,QAAQ,CAAC,IAAI,EAAE;YACjB,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC;AAC7C,YAAA,SAAS,CAAC,SAAS,IAAI,UAAU;AACjC,YAAA,KAAK,CAAC,KAAK,CAAC,SAAS,IAAI,UAAU;QACrC;QAEA,SAAS,CAAC,OAAO,IAAI,QAAQ,CAAC,EAAE,CAAC,MAAM;QACvC,KAAK,CAAC,KAAK,CAAC,OAAO,IAAI,QAAQ,CAAC,EAAE,CAAC,MAAM;AAEzC,QAAA,KAAK,MAAM,EAAE,IAAI,QAAQ,CAAC,EAAE,EAAE;AAC5B,YAAA,MAAM,QAAQ,GAAG,EAAE,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM;AAChD,YAAA,SAAS,CAAC,OAAO,IAAI,QAAQ;AAC7B,YAAA,KAAK,CAAC,KAAK,CAAC,OAAO,IAAI,QAAQ;QACjC;IACF;AAEA,IAAA,OAAO,KAAK;AACd;;;;"}

package/dist/index.d.ts

@@ -1,10 +1,10 @@
-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';
-export * from './dump';
+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";
+export * from "./dump";
 //# sourceMappingURL=index.d.ts.map

package/dist/snapshot.cjs

@@ -16,7 +16,7 @@ function makeResourceSnapshot(res, schema, ctx) {
     const info = node.resourceInfo;
     const result = { ...info };
     if (schema.data !== undefined) {
-        if (schema.data === 'raw')
+        if (schema.data === "raw")
             result.data = node.getData();
         else
             result.data = schema.data.parse(node.getDataAsJson());
@@ -40,11 +40,11 @@ function makeResourceSnapshot(res, schema, ctx) {
             if (value === undefined) {
                 throw new Error(`Key not found ${fieldName}`);
             }
-            else if (type === 'raw') {
+            else if (type === "raw") {
                 kv[fieldName] = value;
             }
             else {
-                kv[fieldName] = type.parse(JSON.parse(Buffer.from(value).toString('utf-8')));
+                kv[fieldName] = type.parse(JSON.parse(Buffer.from(value).toString("utf-8")));
             }
         }
         result.kv = kv;

package/dist/snapshot.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"snapshot.cjs","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"],"names":["PlTreeEntry","notEmpty","PlTreeEntryAccessor"],"mappings":";;;;;AA2CA;AACM,SAAU,QAAQ,CAKtB,MAA0D,EAAA;AAE1D,IAAA,OAAO,MAAa;AACtB;SA8DgB,oBAAoB,CAClC,GAA2D,EAC3D,MAAc,EACd,GAAmB,EAAA;AAEnB,IAAA,MAAM,IAAI,GACN,GAAG,YAAYA;AACf,UAAEC,kBAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI;UAChC,GAAG,YAAYC;AACf,cAAE,GAAG,CAAC,IAAI;cACR,GAAG;AACX,IAAA,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY;AAC9B,IAAA,MAAM,MAAM,GAA0E,EAAE,GAAG,IAAI,EAAE;AAEjG,IAAA,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE;AAC7B,QAAA,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK;AAAE,YAAA,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE;;AAClD,YAAA,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;IAC5D;AAEA,IAAA,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE;QAC/B,MAAM,MAAM,GAA2C,EAAE;;;AAGzD,QAAA,KAAK,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;AAC/D,YAAA,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;AAChC,gBAAA,KAAK,EAAE,SAAS;AAChB,gBAAA,kBAAkB,EAAE,QAAQ;gBAC5B,gBAAgB,EAAE,CAAC,QAAQ;aAC5B,CAAC,EAAE,EAAE;AACR,QAAA,MAAM,CAAC,MAAM,GAAG,MAAM;IACxB;AAEA,IAAA,IAAI,MAAM,CAAC,EAAE,KAAK,SAAS,EAAE;QAC3B,MAAM,EAAE,GAA4B,EAAE;AACtC,QAAA,KAAK,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;YACzD,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;AAEzC,YAAA,IAAI,KAAK,KAAK,SAAS,EAAE;AACvB,gBAAA,MAAM,IAAI,KAAK,CAAC,iBAAiB,SAAS,CAAA,CAAE,CAAC;YAC/C;AAAO,iBAAA,IAAI,IAAI,KAAK,KAAK,EAAE;AACzB,gBAAA,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK;YACvB;iBAAO;gBACL,EAAE,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YAC9E;QACF;AACA,QAAA,MAAM,CAAC,EAAE,GAAG,EAAE;IAChB;AAEA,IAAA,OAAO,MAAa;AACtB;AAUA;SACgB,2BAA2B,CACzC,GAAmC,EACnC,MAAgB,EAChB,GAAkB,EAAA;AAElB,IAAA,IAAI,GAAG,YAAYF,qBAAW,EAAE;QAC9B,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE;AACrC,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY;QAE9B,MAAM,OAAO,GAAuC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK;YACvE,IAAI;YACJ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE;AAC/B,SAAA,CAAC;QAEF,OAAO;AACL,YAAA,GAAG,IAAI;AACP,YAAA,MAAM,EAAE,IAAI,GAAG,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,IAAI,UAAU,EAAE;SACzC;IACH;AAEA,IAAA,OAAO,GAAG;AACZ;AASA;SACgB,+BAA+B,CAC7C,GAAuC,EACvC,MAAgB,EAChB,GAAkB,EAAA;AAElB,IAAA,IAAI,EAAE,GAAG,YAAYA,qBAAW,CAAC;AAAE,QAAA,OAAO,GAAG;IAE7C,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE;AACrC,IAAA,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY;IAC9B,MAAM,SAAS,GAAoB,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAE9E,OAAO;AACL,QAAA,GAAG,IAAI;AACP,QAAA,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC;KACxC;AACH;;;;;;;"}
+{"version":3,"file":"snapshot.cjs","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"],"names":["PlTreeEntry","notEmpty","PlTreeEntryAccessor"],"mappings":";;;;;AA2CA;AACM,SAAU,QAAQ,CAKtB,MAA0D,EAAA;AAE1D,IAAA,OAAO,MAAa;AACtB;SA8DgB,oBAAoB,CAClC,GAA2D,EAC3D,MAAc,EACd,GAAmB,EAAA;AAEnB,IAAA,MAAM,IAAI,GACR,GAAG,YAAYA;AACb,UAAEC,kBAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI;UAChC,GAAG,YAAYC;AACf,cAAE,GAAG,CAAC,IAAI;cACR,GAAG;AACX,IAAA,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY;AAC9B,IAAA,MAAM,MAAM,GAA0E,EAAE,GAAG,IAAI,EAAE;AAEjG,IAAA,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE;AAC7B,QAAA,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK;AAAE,YAAA,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE;;AAClD,YAAA,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;IAC5D;AAEA,IAAA,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE;QAC/B,MAAM,MAAM,GAA2C,EAAE;;;AAGzD,QAAA,KAAK,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;AAC/D,YAAA,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;AAChC,gBAAA,KAAK,EAAE,SAAS;AAChB,gBAAA,kBAAkB,EAAE,QAAQ;gBAC5B,gBAAgB,EAAE,CAAC,QAAQ;aAC5B,CAAC,EAAE,EAAE;AACR,QAAA,MAAM,CAAC,MAAM,GAAG,MAAM;IACxB;AAEA,IAAA,IAAI,MAAM,CAAC,EAAE,KAAK,SAAS,EAAE;QAC3B,MAAM,EAAE,GAA4B,EAAE;AACtC,QAAA,KAAK,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;YACzD,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;AAEzC,YAAA,IAAI,KAAK,KAAK,SAAS,EAAE;AACvB,gBAAA,MAAM,IAAI,KAAK,CAAC,iBAAiB,SAAS,CAAA,CAAE,CAAC;YAC/C;AAAO,iBAAA,IAAI,IAAI,KAAK,KAAK,EAAE;AACzB,gBAAA,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK;YACvB;iBAAO;gBACL,EAAE,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YAC9E;QACF;AACA,QAAA,MAAM,CAAC,EAAE,GAAG,EAAE;IAChB;AAEA,IAAA,OAAO,MAAa;AACtB;AAUA;SACgB,2BAA2B,CACzC,GAAmC,EACnC,MAAgB,EAChB,GAAkB,EAAA;AAElB,IAAA,IAAI,GAAG,YAAYF,qBAAW,EAAE;QAC9B,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE;AACrC,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY;QAE9B,MAAM,OAAO,GAAuC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK;YACvE,IAAI;YACJ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE;AAC/B,SAAA,CAAC;QAEF,OAAO;AACL,YAAA,GAAG,IAAI;AACP,YAAA,MAAM,EAAE,IAAI,GAAG,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,IAAI,UAAU,EAAE;SACzC;IACH;AAEA,IAAA,OAAO,GAAG;AACZ;AASA;SACgB,+BAA+B,CAC7C,GAAuC,EACvC,MAAgB,EAChB,GAAkB,EAAA;AAElB,IAAA,IAAI,EAAE,GAAG,YAAYA,qBAAW,CAAC;AAAE,QAAA,OAAO,GAAG;IAE7C,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE;AACrC,IAAA,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY;IAC9B,MAAM,SAAS,GAAoB,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAE9E,OAAO;AACL,QAAA,GAAG,IAAI;AACP,QAAA,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC;KACxC;AACH;;;;;;;"}

package/dist/snapshot.d.ts

@@ -1,9 +1,9 @@
-import type { ResourceId, ResourceType } from '@milaboratories/pl-client';
-import type { Optional } from 'utility-types';
-import type { ZodType, z } from 'zod';
-import type { PlTreeNodeAccessor } from './accessors';
-import { PlTreeEntry, PlTreeEntryAccessor } from './accessors';
-import type { ComputableCtx } from '@milaboratories/computable';
+import type { ResourceId, ResourceType } from "@milaboratories/pl-client";
+import type { Optional } from "utility-types";
+import type { ZodType, z } from "zod";
+import type { PlTreeNodeAccessor } from "./accessors";
+import { PlTreeEntry, PlTreeEntryAccessor } from "./accessors";
+import type { ComputableCtx } from "@milaboratories/computable";
 /**
  * A DTO that can be generated from a tree node to make a snapshot of specific parts of it's state.
  * Such snapshots can then be used in core that requires this information without the need of
@@ -17,21 +17,21 @@ export type ResourceSnapshot<Data = undefined, Fields extends Record<string, Res
     readonly kv: KV;
 };
 /** Request that we'll pass to getResourceSnapshot function. We infer the type of ResourceSnapshot from this. */
-export type ResourceSnapshotSchema<Data extends ZodType | 'raw' | undefined = undefined, Fields extends Record<string, boolean> | undefined = undefined, KV extends Record<string, ZodType | 'raw'> | undefined = undefined> = {
+export type ResourceSnapshotSchema<Data extends ZodType | "raw" | undefined = undefined, Fields extends Record<string, boolean> | undefined = undefined, KV extends Record<string, ZodType | "raw"> | undefined = undefined> = {
     readonly data: Data;
     readonly fields: Fields;
     readonly kv: KV;
 };
 /** Creates ResourceSnapshotSchema. It converts an optional schema type to schema type. */
-export declare function rsSchema<const Data extends ZodType | 'raw' | undefined = undefined, const Fields extends Record<string, boolean> | undefined = undefined, const KV extends Record<string, ZodType | 'raw'> | undefined = undefined>(schema: Optional<ResourceSnapshotSchema<Data, Fields, KV>>): ResourceSnapshotSchema<Data, Fields, KV>;
+export declare function rsSchema<const Data extends ZodType | "raw" | undefined = undefined, const Fields extends Record<string, boolean> | undefined = undefined, const KV extends Record<string, ZodType | "raw"> | undefined = undefined>(schema: Optional<ResourceSnapshotSchema<Data, Fields, KV>>): ResourceSnapshotSchema<Data, Fields, KV>;
 /** The most generic type of ResourceSnapshotSchema. */
-type ResourceSnapshotSchemaGeneric = ResourceSnapshotSchema<ZodType | 'raw' | undefined, Record<string, boolean> | undefined, Record<string, ZodType | 'raw'> | undefined>;
+type ResourceSnapshotSchemaGeneric = ResourceSnapshotSchema<ZodType | "raw" | undefined, Record<string, boolean> | undefined, Record<string, ZodType | "raw"> | undefined>;
 /**
  * If Data is 'raw' in schema, we'll get bytes,
  * if it's Zod, we'll parse it via zod.
  * Or else we just got undefined in the field.
  */
-type InferDataType<Data extends ZodType | 'raw' | undefined> = Data extends 'raw' ? Uint8Array : Data extends ZodType ? z.infer<Data> : undefined;
+type InferDataType<Data extends ZodType | "raw" | undefined> = Data extends "raw" ? Uint8Array : Data extends ZodType ? z.infer<Data> : undefined;
 /**
  * If Fields is a record of field names to booleans,
  * then if the value of the field is true, we'll require this field and throw a Error if it wasn't found.
@@ -46,11 +46,11 @@ type InferFieldsType<Fields extends Record<string, boolean> | undefined> = Field
  * If one of values is Zod, we'll get KV and converts it to Zod schema.
  * If the value is 'raw', just returns bytes.
  */
-type InferKVType<KV extends Record<string, ZodType | 'raw'> | undefined> = KV extends undefined ? undefined : {
+type InferKVType<KV extends Record<string, ZodType | "raw"> | undefined> = KV extends undefined ? undefined : {
     [FieldName in keyof KV]: KV[FieldName] extends ZodType ? z.infer<KV[FieldName]> : Uint8Array;
 };
 /** Infer ResourceSnapshot from ResourceShapshotSchema, S can be any ResourceSnapshotSchema. */
-export type InferSnapshot<S extends ResourceSnapshotSchemaGeneric> = ResourceSnapshot<InferDataType<S['data']>, InferFieldsType<S['fields']>, InferKVType<S['kv']>>;
+export type InferSnapshot<S extends ResourceSnapshotSchemaGeneric> = ResourceSnapshot<InferDataType<S["data"]>, InferFieldsType<S["fields"]>, InferKVType<S["kv"]>>;
 /** Gets a ResourceSnapshot from PlTreeEntry. */
 export declare function makeResourceSnapshot<Schema extends ResourceSnapshotSchemaGeneric>(res: PlTreeEntry, schema: Schema, ctx: ComputableCtx): InferSnapshot<Schema>;
 export declare function makeResourceSnapshot<Schema extends ResourceSnapshotSchemaGeneric>(res: PlTreeEntryAccessor | PlTreeNodeAccessor, schema: Schema): InferSnapshot<Schema>;

package/dist/snapshot.js

@@ -14,7 +14,7 @@ function makeResourceSnapshot(res, schema, ctx) {
     const info = node.resourceInfo;
     const result = { ...info };
     if (schema.data !== undefined) {
-        if (schema.data === 'raw')
+        if (schema.data === "raw")
             result.data = node.getData();
         else
             result.data = schema.data.parse(node.getDataAsJson());
@@ -38,11 +38,11 @@ function makeResourceSnapshot(res, schema, ctx) {
             if (value === undefined) {
                 throw new Error(`Key not found ${fieldName}`);
             }
-            else if (type === 'raw') {
+            else if (type === "raw") {
                 kv[fieldName] = value;
             }
             else {
-                kv[fieldName] = type.parse(JSON.parse(Buffer.from(value).toString('utf-8')));
+                kv[fieldName] = type.parse(JSON.parse(Buffer.from(value).toString("utf-8")));
             }
         }
         result.kv = kv;

package/dist/snapshot.js.map

@@ -1 +1 @@
-{"version":3,"file":"snapshot.js","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"],"names":[],"mappings":";;;AA2CA;AACM,SAAU,QAAQ,CAKtB,MAA0D,EAAA;AAE1D,IAAA,OAAO,MAAa;AACtB;SA8DgB,oBAAoB,CAClC,GAA2D,EAC3D,MAAc,EACd,GAAmB,EAAA;AAEnB,IAAA,MAAM,IAAI,GACN,GAAG,YAAY;AACf,UAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI;UAChC,GAAG,YAAY;AACf,cAAE,GAAG,CAAC,IAAI;cACR,GAAG;AACX,IAAA,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY;AAC9B,IAAA,MAAM,MAAM,GAA0E,EAAE,GAAG,IAAI,EAAE;AAEjG,IAAA,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE;AAC7B,QAAA,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK;AAAE,YAAA,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE;;AAClD,YAAA,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;IAC5D;AAEA,IAAA,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE;QAC/B,MAAM,MAAM,GAA2C,EAAE;;;AAGzD,QAAA,KAAK,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;AAC/D,YAAA,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;AAChC,gBAAA,KAAK,EAAE,SAAS;AAChB,gBAAA,kBAAkB,EAAE,QAAQ;gBAC5B,gBAAgB,EAAE,CAAC,QAAQ;aAC5B,CAAC,EAAE,EAAE;AACR,QAAA,MAAM,CAAC,MAAM,GAAG,MAAM;IACxB;AAEA,IAAA,IAAI,MAAM,CAAC,EAAE,KAAK,SAAS,EAAE;QAC3B,MAAM,EAAE,GAA4B,EAAE;AACtC,QAAA,KAAK,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;YACzD,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;AAEzC,YAAA,IAAI,KAAK,KAAK,SAAS,EAAE;AACvB,gBAAA,MAAM,IAAI,KAAK,CAAC,iBAAiB,SAAS,CAAA,CAAE,CAAC;YAC/C;AAAO,iBAAA,IAAI,IAAI,KAAK,KAAK,EAAE;AACzB,gBAAA,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK;YACvB;iBAAO;gBACL,EAAE,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YAC9E;QACF;AACA,QAAA,MAAM,CAAC,EAAE,GAAG,EAAE;IAChB;AAEA,IAAA,OAAO,MAAa;AACtB;AAUA;SACgB,2BAA2B,CACzC,GAAmC,EACnC,MAAgB,EAChB,GAAkB,EAAA;AAElB,IAAA,IAAI,GAAG,YAAY,WAAW,EAAE;QAC9B,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE;AACrC,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY;QAE9B,MAAM,OAAO,GAAuC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK;YACvE,IAAI;YACJ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE;AAC/B,SAAA,CAAC;QAEF,OAAO;AACL,YAAA,GAAG,IAAI;AACP,YAAA,MAAM,EAAE,IAAI,GAAG,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,IAAI,UAAU,EAAE;SACzC;IACH;AAEA,IAAA,OAAO,GAAG;AACZ;AASA;SACgB,+BAA+B,CAC7C,GAAuC,EACvC,MAAgB,EAChB,GAAkB,EAAA;AAElB,IAAA,IAAI,EAAE,GAAG,YAAY,WAAW,CAAC;AAAE,QAAA,OAAO,GAAG;IAE7C,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE;AACrC,IAAA,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY;IAC9B,MAAM,SAAS,GAAoB,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAE9E,OAAO;AACL,QAAA,GAAG,IAAI;AACP,QAAA,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC;KACxC;AACH;;;;"}
+{"version":3,"file":"snapshot.js","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"],"names":[],"mappings":";;;AA2CA;AACM,SAAU,QAAQ,CAKtB,MAA0D,EAAA;AAE1D,IAAA,OAAO,MAAa;AACtB;SA8DgB,oBAAoB,CAClC,GAA2D,EAC3D,MAAc,EACd,GAAmB,EAAA;AAEnB,IAAA,MAAM,IAAI,GACR,GAAG,YAAY;AACb,UAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI;UAChC,GAAG,YAAY;AACf,cAAE,GAAG,CAAC,IAAI;cACR,GAAG;AACX,IAAA,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY;AAC9B,IAAA,MAAM,MAAM,GAA0E,EAAE,GAAG,IAAI,EAAE;AAEjG,IAAA,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE;AAC7B,QAAA,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK;AAAE,YAAA,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE;;AAClD,YAAA,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;IAC5D;AAEA,IAAA,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE;QAC/B,MAAM,MAAM,GAA2C,EAAE;;;AAGzD,QAAA,KAAK,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;AAC/D,YAAA,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;AAChC,gBAAA,KAAK,EAAE,SAAS;AAChB,gBAAA,kBAAkB,EAAE,QAAQ;gBAC5B,gBAAgB,EAAE,CAAC,QAAQ;aAC5B,CAAC,EAAE,EAAE;AACR,QAAA,MAAM,CAAC,MAAM,GAAG,MAAM;IACxB;AAEA,IAAA,IAAI,MAAM,CAAC,EAAE,KAAK,SAAS,EAAE;QAC3B,MAAM,EAAE,GAA4B,EAAE;AACtC,QAAA,KAAK,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;YACzD,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;AAEzC,YAAA,IAAI,KAAK,KAAK,SAAS,EAAE;AACvB,gBAAA,MAAM,IAAI,KAAK,CAAC,iBAAiB,SAAS,CAAA,CAAE,CAAC;YAC/C;AAAO,iBAAA,IAAI,IAAI,KAAK,KAAK,EAAE;AACzB,gBAAA,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK;YACvB;iBAAO;gBACL,EAAE,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YAC9E;QACF;AACA,QAAA,MAAM,CAAC,EAAE,GAAG,EAAE;IAChB;AAEA,IAAA,OAAO,MAAa;AACtB;AAUA;SACgB,2BAA2B,CACzC,GAAmC,EACnC,MAAgB,EAChB,GAAkB,EAAA;AAElB,IAAA,IAAI,GAAG,YAAY,WAAW,EAAE;QAC9B,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE;AACrC,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY;QAE9B,MAAM,OAAO,GAAuC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK;YACvE,IAAI;YACJ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE;AAC/B,SAAA,CAAC;QAEF,OAAO;AACL,YAAA,GAAG,IAAI;AACP,YAAA,MAAM,EAAE,IAAI,GAAG,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,IAAI,UAAU,EAAE;SACzC;IACH;AAEA,IAAA,OAAO,GAAG;AACZ;AASA;SACgB,+BAA+B,CAC7C,GAAuC,EACvC,MAAgB,EAChB,GAAkB,EAAA;AAElB,IAAA,IAAI,EAAE,GAAG,YAAY,WAAW,CAAC;AAAE,QAAA,OAAO,GAAG;IAE7C,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE;AACrC,IAAA,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY;IAC9B,MAAM,SAAS,GAAoB,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAE9E,OAAO;AACL,QAAA,GAAG,IAAI;AACP,QAAA,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC;KACxC;AACH;;;;"}

package/dist/state.cjs

@@ -109,14 +109,14 @@ class PlTreeResource {
         return [...this.fieldsMap.values()];
     }
     getField(watcher, _step, onUnstable = () => { }) {
-        const step = typeof _step === 'string' ? { field: _step } : _step;
+        const step = typeof _step === "string" ? { field: _step } : _step;
         const field = this.fieldsMap.get(step.field);
         if (field === undefined) {
             if (step.errorIfFieldNotFound || step.errorIfFieldNotSet)
                 throw new Error(`Field "${step.field}" not found in resource ${plClient.resourceIdToString(this.id)}`);
             if (!this.inputsLocked)
                 this.inputAndServiceFieldListChanged?.attachWatcher(watcher);
-            else if (step.assertFieldType === 'Service' || step.assertFieldType === 'Input') {
+            else if (step.assertFieldType === "Service" || step.assertFieldType === "Input") {
                 if (step.allowPermanentAbsence)
                     // stable absence of field
                     return undefined;
@@ -125,7 +125,7 @@ class PlTreeResource {
             }
             if (!this.outputsLocked)
                 this.outputFieldListChanged?.attachWatcher(watcher);
-            else if (step.assertFieldType === 'Output') {
+            else if (step.assertFieldType === "Output") {
                 if (step.allowPermanentAbsence)
                     // stable absence of field
                     return undefined;
@@ -134,7 +134,7 @@ class PlTreeResource {
             }
             this.dynamicFieldListChanged?.attachWatcher(watcher);
             if (!this._finalState && !step.stableIfNotFound)
-                onUnstable('field_not_found:' + step.field);
+                onUnstable("field_not_found:" + step.field);
             return undefined;
         }
         else {
@@ -149,7 +149,7 @@ class PlTreeResource {
                 // this method returns value and error of the field, thus those values are considered to be accessed;
                 // any existing but not resolved field here is considered to be unstable, in the sense it is
                 // considered to acquire some resolved value eventually
-                onUnstable('field_not_resolved:' + step.field);
+                onUnstable("field_not_resolved:" + step.field);
             field.change.attachWatcher(watcher);
             return ret;
         }
@@ -167,9 +167,9 @@ class PlTreeResource {
         return this.outputsLocked;
     }
     get isReadyOrError() {
-        return (this.error !== plClient.NullResourceId
-            || this.resourceReady
-            || this.originalResourceId !== plClient.NullResourceId);
+        return (this.error !== plClient.NullResourceId ||
+            this.resourceReady ||
+            this.originalResourceId !== plClient.NullResourceId);
     }
     getIsFinal(watcher) {
         this.finalChanged?.attachWatcher(watcher);
@@ -194,7 +194,7 @@ class PlTreeResource {
     listInputFields(watcher) {
         const ret = [];
         this.fieldsMap.forEach((field, name) => {
-            if (field.type === 'Input' || field.type === 'Service')
+            if (field.type === "Input" || field.type === "Service")
                 ret.push(name);
         });
         if (!this.inputsLocked)
@@ -204,7 +204,7 @@ class PlTreeResource {
     listOutputFields(watcher) {
         const ret = [];
         this.fieldsMap.forEach((field, name) => {
-            if (field.type === 'Output')
+            if (field.type === "Output")
                 ret.push(name);
         });
         if (!this.outputsLocked)
@@ -214,7 +214,7 @@ class PlTreeResource {
     listDynamicFields(watcher) {
         const ret = [];
         this.fieldsMap.forEach((field, name) => {
-            if (field.type !== 'Input' && field.type !== 'Output')
+            if (field.type !== "Input" && field.type !== "Output")
                 ret.push(name);
         });
         this.dynamicFieldListChanged?.attachWatcher(watcher);
@@ -280,7 +280,7 @@ class PlTreeResource {
         if (this._finalState)
             return;
         this._finalState = true;
-        tsHelpers.notEmpty(this.finalChanged).markChanged('marked final');
+        tsHelpers.notEmpty(this.finalChanged).markChanged("marked final");
         this.finalChanged = undefined;
         this.resourceStateChange = undefined;
         this.dynamicFieldListChanged = undefined;
@@ -292,16 +292,16 @@ class PlTreeResource {
     }
     /** Used for invalidation */
     markAllChanged() {
-        this.fieldsMap.forEach((field) => field.change.markChanged('marked all changed'));
-        this.finalChanged?.markChanged('marked all changed');
-        this.resourceStateChange?.markChanged('marked all changed');
-        this.lockedChange?.markChanged('marked all changed');
-        this.inputAndServiceFieldListChanged?.markChanged('marked all changed');
-        this.outputFieldListChanged?.markChanged('marked all changed');
-        this.dynamicFieldListChanged?.markChanged('marked all changed');
+        this.fieldsMap.forEach((field) => field.change.markChanged("marked all changed"));
+        this.finalChanged?.markChanged("marked all changed");
+        this.resourceStateChange?.markChanged("marked all changed");
+        this.lockedChange?.markChanged("marked all changed");
+        this.inputAndServiceFieldListChanged?.markChanged("marked all changed");
+        this.outputFieldListChanged?.markChanged("marked all changed");
+        this.dynamicFieldListChanged?.markChanged("marked all changed");
         // this.kvChangedGlobal?.markChanged('marked all changed');
-        this.kvChangedPerKey?.markAllChanged('marked all changed');
-        this.resourceRemoved.markChanged('marked all changed');
+        this.kvChangedPerKey?.markAllChanged("marked all changed");
+        this.resourceRemoved.markChanged("marked all changed");
     }
 }
 class PlTreeState {
@@ -325,7 +325,7 @@ class PlTreeState {
     }
     checkValid() {
         if (!this._isValid)
-            throw new Error(this.invalidationMessage ?? 'tree is in invalid state');
+            throw new Error(this.invalidationMessage ?? "tree is in invalid state");
     }
     get(watcher, rid) {
         this.checkValid();
@@ -357,14 +357,14 @@ class PlTreeState {
             if (resource !== undefined) {
                 // updating existing resource
                 if (resource.finalState)
-                    unexpectedTransitionError('resource state can\t be updated after it is marked as final');
+                    unexpectedTransitionError("resource state can\t be updated after it is marked as final");
                 let changed = false;
                 // updating resource version, even if it was not changed
                 resource.version += 1;
                 // duplicate / original
                 if (resource.originalResourceId !== rd.originalResourceId) {
                     if (resource.originalResourceId !== plClient.NullResourceId)
-                        unexpectedTransitionError('originalResourceId can\'t change after it is set');
+                        unexpectedTransitionError("originalResourceId can't change after it is set");
                     resource.originalResourceId = rd.originalResourceId;
                     // duplicate status of the resource counts as ready for the external observer
                     tsHelpers.notEmpty(resource.resourceStateChange).markChanged(`originalResourceId changed for ${plClient.resourceIdToString(resource.id)}`);
@@ -373,7 +373,7 @@ class PlTreeState {
                 // error
                 if (resource.error !== rd.error) {
                     if (plClient.isNotNullResourceId(resource.error))
-                        unexpectedTransitionError('resource can\'t change attached error after it is set');
+                        unexpectedTransitionError("resource can't change attached error after it is set");
                     resource.error = rd.error;
                     incrementRefs.push(resource.error);
                     tsHelpers.notEmpty(resource.resourceStateChange).markChanged(`error changed for ${plClient.resourceIdToString(resource.id)}`);
@@ -389,12 +389,12 @@ class PlTreeState {
                             incrementRefs.push(fd.value);
                         if (plClient.isNotNullResourceId(fd.error))
                             incrementRefs.push(fd.error);
-                        if (fd.type === 'Input' || fd.type === 'Service') {
+                        if (fd.type === "Input" || fd.type === "Service") {
                             if (resource.inputsLocked)
                                 unexpectedTransitionError(`adding ${fd.type} (${fd.name}) field while inputs locked`);
                             tsHelpers.notEmpty(resource.inputAndServiceFieldListChanged).markChanged(`new ${fd.type} field ${fd.name} added to ${plClient.resourceIdToString(resource.id)}`);
                         }
-                        else if (fd.type === 'Output') {
+                        else if (fd.type === "Output") {
                             if (resource.outputsLocked)
                                 unexpectedTransitionError(`adding ${fd.type} (${fd.name}) field while outputs locked`);
                             tsHelpers.notEmpty(resource.outputFieldListChanged).markChanged(`new ${fd.type} field ${fd.name} added to ${plClient.resourceIdToString(resource.id)}`);
@@ -409,15 +409,15 @@ class PlTreeState {
                         // change of old field
                         // in principle this transition is possible, see assertions below
                         if (field.type !== fd.type) {
-                            if (field.type !== 'Dynamic')
+                            if (field.type !== "Dynamic")
                                 unexpectedTransitionError(`field changed type ${field.type} -> ${fd.type}`);
                             tsHelpers.notEmpty(resource.dynamicFieldListChanged).markChanged(`field ${fd.name} changed type from Dynamic to ${fd.type} in ${plClient.resourceIdToString(resource.id)}`);
-                            if (field.type === 'Input' || field.type === 'Service') {
+                            if (field.type === "Input" || field.type === "Service") {
                                 if (resource.inputsLocked)
                                     unexpectedTransitionError(`adding input field "${fd.name}", while corresponding list is locked`);
                                 tsHelpers.notEmpty(resource.inputAndServiceFieldListChanged).markChanged(`field ${fd.name} changed to type ${fd.type} in ${plClient.resourceIdToString(resource.id)}`);
                             }
-                            if (field.type === 'Output') {
+                            if (field.type === "Output") {
                                 if (resource.outputsLocked)
                                     unexpectedTransitionError(`adding output field "${fd.name}", while corresponding list is locked`);
                                 tsHelpers.notEmpty(resource.outputFieldListChanged).markChanged(`field ${fd.name} changed to type ${fd.type} in ${plClient.resourceIdToString(resource.id)}`);
@@ -464,7 +464,7 @@ class PlTreeState {
                 // detecting removed fields
                 resource.fieldsMap.forEach((field, fieldName, fields) => {
                     if (field.resourceVersion !== resource.version) {
-                        if (field.type === 'Input' || field.type === 'Service' || field.type === 'Output')
+                        if (field.type === "Input" || field.type === "Service" || field.type === "Output")
                             unexpectedTransitionError(`removal of ${field.type} field ${fieldName}`);
                         field.change.markChanged(`dynamic field ${fieldName} removed from ${plClient.resourceIdToString(resource.id)}`);
                         fields.delete(fieldName);
@@ -478,7 +478,7 @@ class PlTreeState {
                 // inputsLocked
                 if (resource.inputsLocked !== rd.inputsLocked) {
                     if (resource.inputsLocked)
-                        unexpectedTransitionError('inputs unlocking is not permitted');
+                        unexpectedTransitionError("inputs unlocking is not permitted");
                     resource.inputsLocked = rd.inputsLocked;
                     tsHelpers.notEmpty(resource.lockedChange).markChanged(`inputs locked for ${plClient.resourceIdToString(resource.id)}`);
                     changed = true;
@@ -486,7 +486,7 @@ class PlTreeState {
                 // outputsLocked
                 if (resource.outputsLocked !== rd.outputsLocked) {
                     if (resource.outputsLocked)
-                        unexpectedTransitionError('outputs unlocking is not permitted');
+                        unexpectedTransitionError("outputs unlocking is not permitted");
                     resource.outputsLocked = rd.outputsLocked;
                     tsHelpers.notEmpty(resource.lockedChange).markChanged(`outputs locked for ${plClient.resourceIdToString(resource.id)}`);
                     changed = true;