@weborigami/async-tree 0.5.2-test.1 → 0.5.3

package/index.ts

@@ -20,6 +20,7 @@ export type HasString = {
  * an HTTP response via response.write, or readily converted to such a form.
  */
 export type Packed = (ArrayBuffer | Buffer | ReadableStream | string | String | TypedArray) & {
+  parent?: AsyncTree|null;
   unpack?(): Promise<any>;
 };
 
@@ -70,4 +71,9 @@ export type Unpackable<T> = {
   unpack(): Promise<T>
 };
 
+/**
+ * A function that converts a value from a persistent form into a live value.
+ */
+export type UnpackFunction = (input: Packed, options?: any) => any;
+
 export type ValueKeyFn = (value: any, key: any, innerTree: AsyncTree) => any;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@weborigami/async-tree",
-  "version": "0.5.2-test.1",
+  "version": "0.5.3",
   "description": "Asynchronous tree drivers based on standard JavaScript classes",
   "type": "module",
   "main": "./main.js",
   "browser": "./browser.js",
   "types": "./index.ts",
   "dependencies": {
-    "@weborigami/types": "0.5.2-test.1"
+    "@weborigami/types": "0.5.3"
   },
   "devDependencies": {
     "@types/node": "24.3.0",

package/src/Tree.js

@@ -291,6 +291,11 @@ export async function mapReduce(treelike, valueFn, reduceFn) {
 /**
  * Returns slash-separated paths for all values in the tree.
  *
+ * The `base` argument is prepended to all paths.
+ *
+ * If `assumeSlashes` is true, then keys are assumed to have trailing slashes to
+ * indicate subtrees. The default value of this option is false.
+ *
  * @param {Treelike} treelike
  * @param {{ assumeSlashes?: boolean, base?: string }} options
  */

package/src/utilities.d.ts

@@ -4,6 +4,7 @@ import { Packed, PlainObject, StringLike } from "../index.ts";
 export function assertIsTreelike(object: any, operation: string, position?: number): void;
 export function box(value: any): any;
 export function castArrayLike(keys: any[], values: any[]): any;
+export function getParent(object: any, options?: any): AsyncTree|null;
 export function getRealmObjectPrototype(object: any): any;
 export const hiddenFileNames: string[];
 export function isPacked(obj: any): obj is Packed;

package/src/utilities.js

@@ -87,6 +87,36 @@ export function castArrayLike(keys, values) {
     : Object.fromEntries(keys.map((key, i) => [key, values[i]]));
 }
 
+/**
+ * Return a suitable parent for the packed file.
+ *
+ * This is intended to be called by unpack functions.
+ *
+ * @param {any} packed
+ * @param {any} [options]
+ * @returns {AsyncTree|null}
+ */
+export function getParent(packed, options = {}) {
+  // Prefer parent set on options
+  if (options?.parent) {
+    return options.parent;
+  }
+
+  // If the packed object has a `parent` property, use that. Exception: Node
+  // Buffer objects have a `parent` property that we ignore.
+  if (packed.parent && !(packed instanceof Buffer)) {
+    return packed.parent;
+  }
+
+  // If the packed object has a parent symbol, use that.
+  if (packed[symbols.parent]) {
+    return packed[symbols.parent];
+  }
+
+  // Otherwise, return null.
+  return null;
+}
+
 /**
  * Return the Object prototype at the root of the object's prototype chain.
  *