deep6 1.1.3 → 1.2.0

package/src/traverse/deref.d.ts

@@ -0,0 +1,59 @@
+// Type definitions for deep6 deref
+// Generated from src/traverse/deref.js
+
+import type {Env} from '../env.js';
+import type {WalkContext} from './walk.js';
+
+/**
+ * Options for dereferencing
+ */
+export interface DerefOptions {
+  /** Handle circular references (default: false) */
+  circular?: boolean;
+  /** Include symbol properties (default: false) */
+  symbols?: boolean;
+  /** Include non-enumerable properties (default: false) */
+  allProps?: boolean;
+  /** Custom context object */
+  context?: Record<string, unknown>;
+  /** Custom object processor */
+  processObject?: (object: unknown, context: WalkContext) => void;
+  /** Custom non-object value processor */
+  processOther?: (value: unknown, context: WalkContext) => void;
+  /** Custom circular reference processor */
+  processCircular?: (value: unknown, context: WalkContext) => void;
+  /** Custom type handler registry (flat array of [Constructor, handler] pairs) */
+  registry?: unknown[];
+  /** Custom filter functions */
+  filters?: Array<(val: unknown, context: WalkContext) => boolean>;
+}
+
+/**
+ * Flat array of type-specific deref pairs: [Constructor, handler, ...]
+ *
+ * Use `registry.push(Type, handler)` to register a custom handler.
+ */
+export declare const registry: unknown[];
+
+/**
+ * Filter functions for custom deref processing
+ */
+export declare const filters: Array<(val: unknown, context: WalkContext) => boolean>;
+
+/**
+ * Replaces variables with bound values in-place
+ *
+ * Unlike assemble(), modifies the existing structure directly
+ * rather than creating a new one.
+ *
+ * @param source - Value to dereference (modified in-place)
+ * @param env - Env with bindings, or options object
+ * @param options - Deref options (when env is provided separately)
+ * @returns The same source value with variables replaced
+ */
+export declare const deref: ((source: unknown, env?: Env | DerefOptions | null, options?: DerefOptions) => unknown) & {
+  registry: unknown[];
+  filters: Array<(val: unknown, context: WalkContext) => boolean>;
+};
+
+export default deref;

package/src/traverse/deref.js

@@ -22,7 +22,7 @@ function postProcessMap(context) {
   const stackOut = context.stackOut,
     s = this.s;
   let j = stackOut.length - 1;
-  for (const key of s) {
+  for (const key of s.keys()) {
     s.set(key, stackOut[j--]);
   }
   replaceObject(j, s, stackOut);
@@ -54,6 +54,7 @@ const registry = [
 
 const addType = (Type, process) => registry.push(Type, process || processOther);
 
+typeof URL == 'function' && addType(URL);
 typeof Int8Array == 'function' && addType(Int8Array);
 typeof Uint8Array == 'function' && addType(Uint8Array);
 typeof Uint8ClampedArray == 'function' && addType(Uint8ClampedArray);
@@ -100,5 +101,5 @@ const deref = (source, env, options) => {
 deref.registry = registry;
 deref.filters = filters;
 
-export {registry, filters};
+export {registry, filters, deref};
 export default deref;

package/src/traverse/preprocess.d.ts

@@ -0,0 +1,65 @@
+// Type definitions for deep6 preprocess
+// Generated from src/traverse/preprocess.js
+
+import type {WalkContext} from './walk.js';
+
+/**
+ * Options for pattern preprocessing
+ */
+export interface PreprocessOptions {
+  /** Wrap plain objects with open() (default: false) */
+  openObjects?: boolean;
+  /** Wrap arrays with open() (default: false) */
+  openArrays?: boolean;
+  /** Wrap Maps with open() (default: false) */
+  openMaps?: boolean;
+  /** Wrap Sets with open() (default: false) */
+  openSets?: boolean;
+  /** Handle circular references */
+  circular?: boolean;
+  /** Include symbol properties */
+  symbols?: boolean;
+  /** Include non-enumerable properties */
+  allProps?: boolean;
+  /** Custom context object */
+  context?: Record<string, unknown>;
+  /** Custom object processor */
+  processObject?: (object: unknown, context: WalkContext) => void;
+  /** Custom non-object value processor */
+  processOther?: (value: unknown, context: WalkContext) => void;
+  /** Custom circular reference processor */
+  processCircular?: (value: unknown, context: WalkContext) => void;
+  /** Custom type handler registry (flat array of [Constructor, handler] pairs) */
+  registry?: unknown[];
+  /** Custom filter functions */
+  filters?: Array<(val: unknown, context: WalkContext) => boolean>;
+}
+
+/**
+ * Flat array of type-specific preprocessor pairs: [Constructor, handler, ...]
+ *
+ * Use `registry.push(Type, handler)` to register a custom preprocessor.
+ */
+export declare const registry: unknown[];
+
+/**
+ * Filter functions for custom preprocessing
+ */
+export declare const filters: Array<(val: unknown, context: WalkContext) => boolean>;
+
+/**
+ * Preprocesses a pattern for unification
+ *
+ * Wraps objects, arrays, Maps, and Sets with open/soft markers
+ * based on options. Used internally by match().
+ *
+ * @param source - Pattern to preprocess
+ * @param options - Preprocessing options
+ * @returns Preprocessed pattern ready for unification
+ */
+export declare const preprocess: ((source: unknown, options?: PreprocessOptions) => unknown) & {
+  registry: unknown[];
+  filters: Array<(val: unknown, context: WalkContext) => boolean>;
+};
+
+export default preprocess;

package/src/traverse/preprocess.js

@@ -63,6 +63,7 @@ const registry = [
 
 const addType = (Type, process) => registry.push(Type, process || processOther);
 
+typeof URL == 'function' && addType(URL);
 typeof Int8Array == 'function' && addType(Int8Array);
 typeof Uint8Array == 'function' && addType(Uint8Array);
 typeof Uint8ClampedArray == 'function' && addType(Uint8ClampedArray);
@@ -108,5 +109,5 @@ const preprocess = (source, options) => {
 preprocess.registry = registry;
 preprocess.filters = filters;
 
-export {registry, filters};
+export {registry, filters, preprocess};
 export default preprocess;

package/src/traverse/walk.d.ts

@@ -0,0 +1,219 @@
+// Type definitions for deep6 walk
+// Generated from src/traverse/walk.js
+
+/**
+ * Context object available during walk traversal
+ */
+export interface WalkContext {
+  /** Stack of values to process */
+  stack: unknown[];
+  /** Output stack for processed values */
+  stackOut: unknown[];
+  /** Map tracking circular references (present when circular: true) */
+  seen: Map<unknown, {value?: unknown; actions?: Array<[unknown, unknown]>}> | null;
+  /** Include symbol properties */
+  symbols?: boolean;
+  /** Include non-enumerable properties */
+  allProps?: boolean;
+  /** Optional environment for variable handling */
+  env?: unknown;
+  /** Wrapper for Maps (set by preprocess) */
+  wrapMap?: (map: Map<unknown, unknown>) => unknown;
+  /** Wrapper for Arrays (set by preprocess) */
+  wrapArray?: (array: unknown[]) => unknown;
+  /** Wrapper for Objects (set by preprocess) */
+  wrapObject?: (object: unknown) => unknown;
+  /** Wrapper for Sets (set by preprocess) */
+  wrapSet?: (set: Set<unknown>) => unknown;
+  /** Additional context properties */
+  [key: string]: unknown;
+}
+
+/**
+ * Options for walk traversal
+ */
+export interface WalkOptions {
+  /** Custom object processor */
+  processObject?: (object: unknown, context: WalkContext) => void;
+  /** Custom non-object value processor */
+  processOther?: (value: unknown, context: WalkContext) => void;
+  /** Custom circular reference processor */
+  processCircular?: (value: unknown, context: WalkContext) => void;
+  /**
+   * Flat array of type handler pairs: [Constructor, handler, Constructor, handler, ...]
+   *
+   * Each pair maps a constructor to a processing function.
+   */
+  registry?: unknown[];
+  /** Array of filter functions — return true to indicate value was handled */
+  filters?: Array<(val: unknown, context: WalkContext) => boolean>;
+  /** Enable circular reference detection */
+  circular?: boolean;
+  /** Include symbol properties */
+  symbols?: boolean;
+  /** Include non-enumerable properties */
+  allProps?: boolean;
+  /** Custom context object (properties are merged into WalkContext) */
+  context?: Record<string, unknown>;
+}
+
+/**
+ * Marker for values that were already seen (circular references)
+ */
+export declare class Circular {
+  /** The already-seen value */
+  value: unknown;
+  constructor(value: unknown);
+}
+
+/**
+ * Deferred processing command pushed onto the walk stack
+ */
+export declare class Command {
+  /** Function to execute during post-processing */
+  f: (context: WalkContext) => void;
+  /** Source object being processed */
+  s: unknown;
+  constructor(f: (context: WalkContext) => void, s: unknown);
+}
+
+/**
+ * Non-recursive stack-based object tree walker
+ *
+ * Traverses values using an explicit stack with support for
+ * circular references, type registries, and filters.
+ *
+ * @param o - Value to traverse
+ * @param options - Walk options and processors
+ */
+export declare const walk: ((o: unknown, options?: WalkOptions) => void) & {
+  Command: typeof Command;
+};
+
+/**
+ * Default type handler registry (flat array of [Constructor, handler] pairs)
+ */
+export declare const registry: unknown[];
+
+/**
+ * Default filter functions
+ */
+export declare const filters: Array<(val: unknown, context: WalkContext) => boolean>;
+
+// Utility processors
+
+/** Pushes value to stackOut unchanged */
+export declare const processOther: (value: unknown, context: WalkContext) => void;
+
+/** Pushes a Circular marker to stackOut */
+export declare const processCircular: (value: unknown, context: WalkContext) => void;
+
+/**
+ * Creates a Map processor with optional post-processing
+ * @param postProcess - Post-processor for normal flow
+ * @param postProcessSeen - Post-processor when circular refs are tracked
+ * @returns Map processing function
+ */
+export declare const processMap: (
+  postProcess?: (context: WalkContext) => void,
+  postProcessSeen?: (context: WalkContext) => void
+) => (object: Map<unknown, unknown>, context: WalkContext) => void;
+
+/**
+ * Post-processes a Map with circular reference resolution
+ * @param source - Original Map
+ * @param context - Walk context
+ */
+export declare const postMapCircular: (source: Map<unknown, unknown>, context: WalkContext) => void;
+
+/**
+ * Builds a new Map from processed values on stackOut
+ * @param keys - Keys for the new Map
+ * @param stackOut - Output stack with values
+ * @param wrap - Optional wrapper function
+ */
+export declare const buildNewMap: (keys: Iterable<unknown>, stackOut: unknown[], wrap?: (map: Map<unknown, unknown>) => unknown) => void;
+
+/**
+ * Replaces stackOut entries from upTo to end with a single object
+ * @param upTo - Index offset from end
+ * @param object - Object to push
+ * @param stackOut - Output stack
+ */
+export declare const replaceObject: (upTo: number, object: unknown, stackOut: unknown[]) => void;
+
+/**
+ * Creates an Object processor with optional post-processing
+ * @param postProcess - Post-processor for normal flow
+ * @param postProcessSeen - Post-processor when circular refs are tracked
+ * @returns Object processing function
+ */
+export declare const processObject: (
+  postProcess?: (context: WalkContext) => void,
+  postProcessSeen?: (context: WalkContext) => void
+) => (object: unknown, context: WalkContext) => void;
+
+/**
+ * Post-processes an Object with circular reference resolution
+ * @param source - Original object
+ * @param descriptors - Property descriptors
+ * @param keys - Property keys
+ * @param context - Walk context
+ */
+export declare const postObjectCircular: (
+  source: unknown,
+  descriptors: Record<string | symbol, PropertyDescriptor>,
+  keys: Array<string | symbol>,
+  context: WalkContext
+) => void;
+
+/**
+ * Extracts property descriptors and keys from an object
+ * @param object - Object to analyze
+ * @param context - Walk context (uses symbols and allProps flags)
+ * @returns Descriptors and keys
+ */
+export declare const getObjectData: (
+  object: unknown,
+  context: WalkContext
+) => {descriptors: Record<string | symbol, PropertyDescriptor>; keys: Array<string | symbol>};
+
+/**
+ * Builds a new object from processed values on stackOut
+ * @param source - Original object (used for prototype and array detection)
+ * @param descriptors - Property descriptors
+ * @param keys - Property keys
+ * @param stackOut - Output stack with values
+ * @param wrap - Optional wrapper function
+ */
+export declare const buildNewObject: (
+  source: unknown,
+  descriptors: Record<string | symbol, PropertyDescriptor>,
+  keys: Array<string | symbol>,
+  stackOut: unknown[],
+  wrap?: (object: unknown) => unknown
+) => void;
+
+/**
+ * Resolves a Variable to its bound value and pushes to the stack
+ * @param val - Variable instance
+ * @param context - Walk context (uses context.env)
+ */
+export declare const processVariable: (val: unknown, context: WalkContext) => void;
+
+/**
+ * Executes a Command's function
+ * @param val - Command instance
+ * @param context - Walk context
+ */
+export declare const processCommand: (val: unknown, context: WalkContext) => void;
+
+/**
+ * Resolves circular reference actions for a seen object
+ * @param seen - Map of seen objects
+ * @param source - Source object
+ * @param value - Resolved value
+ */
+export declare const setObject: (seen: Map<unknown, {value?: unknown; actions?: Array<[unknown, unknown]>}>, source: unknown, value: unknown) => void;
+
+export default walk;

package/src/traverse/walk.js

@@ -34,7 +34,10 @@ const processCircular = (value, context) => context.stackOut.push(new Circular(v
 
 const processMap = (postProcess, postProcessSeen) => (object, context) => {
   const stack = context.stack;
-  postProcess && stack.push(new Command(postProcessSeen ? (context.seen ? postProcessSeen : postProcess) : postProcess, object));
+  if (postProcess) {
+    const processor = context.seen && postProcessSeen ? postProcessSeen : postProcess;
+    stack.push(new Command(processor, object));
+  }
   for (const value of object.values()) {
     stack.push(value);
   }
@@ -170,8 +173,9 @@ class Command {
 
 const processCommand = (val, context) => val.f(context);
 
-const defaultRegistry = [Command, processCommand, Array, processObject(), Date, nop, RegExp, nop, Map, processMap(), Set, nop, Promise, nop],
-  defaultFilters = [];
+const defaultRegistry = [Command, processCommand, Array, processObject(), Date, nop, RegExp, nop, Map, processMap(), Set, nop, Promise, nop];
+typeof URL == 'function' && defaultRegistry.push(URL, nop);
+const defaultFilters = [];
 
 // add more types
 
@@ -257,6 +261,7 @@ export {
   getObjectData,
   buildNewObject,
   processVariable,
-  processCommand
+  processCommand,
+  walk
 };
 export default walk;

package/src/unifiers/matchCondition.d.ts

@@ -0,0 +1,45 @@
+// Type definitions for deep6 matchCondition unifier
+// Generated from src/unifiers/matchCondition.js
+
+import type {Unifier, Env} from '../env.js';
+
+/**
+ * Predicate-based matching unifier
+ *
+ * Delegates matching to a user-supplied function that receives
+ * the full unification context (value, stacks, environment).
+ */
+export declare class MatchCondition extends Unifier {
+  /** Predicate function */
+  f: (val: unknown, ls: unknown[], rs: unknown[], env: Env) => boolean;
+
+  /**
+   * @param f - Predicate that returns true if the value matches
+   */
+  constructor(f: (val: unknown, ls: unknown[], rs: unknown[], env: Env) => boolean);
+
+  /**
+   * Delegates to the predicate function
+   * @param val - Value to test
+   * @param ls - Left argument stack
+   * @param rs - Right argument stack
+   * @param env - Unification environment
+   * @returns Result of the predicate
+   */
+  unify(val: unknown, ls: unknown[], rs: unknown[], env: Env): boolean;
+}
+
+/**
+ * Creates a predicate matcher
+ *
+ * @param f - Predicate function `(val, ls, rs, env) => boolean`
+ * @returns A new MatchCondition instance
+ *
+ * @example
+ * ```ts
+ * const isPositive = matchCondition(val => typeof val === 'number' && val > 0);
+ * match({n: 5}, {n: isPositive}); // true
+ * ```
+ */
+export declare const matchCondition: (f: (val: unknown, ls: unknown[], rs: unknown[], env: Env) => boolean) => MatchCondition;
+export default matchCondition;

package/src/unifiers/matchCondition.js

@@ -13,4 +13,5 @@ class MatchCondition extends Unifier {
 
 const matchCondition = f => new MatchCondition(f);
 
+export {matchCondition};
 export default matchCondition;

package/src/unifiers/matchInstanceOf.d.ts

@@ -0,0 +1,37 @@
+// Type definitions for deep6 matchInstanceOf unifier
+// Generated from src/unifiers/matchInstanceOf.js
+
+import type {Unifier} from '../env.js';
+
+/**
+ * Instanceof-based matching unifier
+ *
+ * Matches values by their prototype chain. Rejects falsy values and unbound Variables.
+ */
+export declare class MatchInstanceOf extends Unifier {
+  /** Array of constructors to match against */
+  types: (new (...args: any[]) => unknown)[];
+
+  /**
+   * @param types - Constructor or array of constructors
+   */
+  constructor(types: (new (...args: any[]) => unknown) | (new (...args: any[]) => unknown)[]);
+
+  /**
+   * Tests if the value is an instance of one of the configured constructors
+   * @param val - Value to check
+   * @param ls - Left argument stack (unused)
+   * @param rs - Right argument stack (unused)
+   * @returns True if val is an instance of any configured type
+   */
+  unify(val: unknown, ls: unknown[], rs: unknown[]): boolean;
+}
+
+/**
+ * Creates an instanceof matcher
+ *
+ * @param types - Constructor(s) to match against
+ * @returns A new MatchInstanceOf instance
+ */
+export declare const matchInstanceOf: (types: (new (...args: any[]) => unknown) | (new (...args: any[]) => unknown)[]) => MatchInstanceOf;
+export default matchInstanceOf;

package/src/unifiers/matchInstanceOf.js

@@ -13,4 +13,5 @@ class MatchInstanceOf extends Unifier {
 
 const matchInstanceOf = types => new MatchInstanceOf(types);
 
+export {matchInstanceOf};
 export default matchInstanceOf;

package/src/unifiers/matchString.d.ts

@@ -0,0 +1,56 @@
+// Type definitions for deep6 matchString unifier
+// Generated from src/unifiers/matchString.js
+
+import type {Unifier} from '../env.js';
+
+/**
+ * RegExp-based string matching unifier
+ *
+ * Matches values against a regular expression. Optionally captures
+ * the match array and match properties (index, input) for variable binding.
+ */
+export declare class MatchString extends Unifier {
+  /** Regular expression to match against */
+  regexp: RegExp;
+  /** Pattern to unify with the match result array (optional) */
+  matches?: unknown;
+  /** Pattern to unify with match properties {index, input} (optional) */
+  props?: unknown;
+
+  /**
+   * @param regexp - Regular expression to match
+   * @param matches - Pattern to unify with match array (optional)
+   * @param props - Pattern to unify with {index, input} (optional)
+   */
+  constructor(regexp: RegExp, matches?: unknown, props?: unknown);
+
+  /**
+   * Tests a value against the regex and pushes capture bindings
+   * @param val - Value to match (coerced to string)
+   * @param ls - Left argument stack
+   * @param rs - Right argument stack
+   * @returns Truthy if the regex matches
+   */
+  unify(val: unknown, ls: unknown[], rs: unknown[]): boolean;
+}
+
+/**
+ * Creates a regex string matcher
+ *
+ * @param regexp - Regular expression to match against
+ * @param matches - Pattern to unify with the full match array (optional)
+ * @param props - Pattern to unify with {index, input} (optional)
+ * @returns A new MatchString instance
+ *
+ * @example
+ * ```ts
+ * // Simple matching
+ * matchString(/^hello/i);
+ *
+ * // With captures bound to a variable array
+ * const names = [any, variable('first'), variable('last')];
+ * matchString(/^(\w+)\s+(\w+)$/, names);
+ * ```
+ */
+export declare const matchString: (regexp: RegExp, matches?: unknown, props?: unknown) => MatchString;
+export default matchString;

package/src/unifiers/matchString.js

@@ -30,4 +30,5 @@ class MatchString extends Unifier {
 
 const matchString = (regexp, matches, props) => new MatchString(regexp, matches, props);
 
+export {matchString};
 export default matchString;

package/src/unifiers/matchTypeOf.d.ts

@@ -0,0 +1,37 @@
+// Type definitions for deep6 matchTypeOf unifier
+// Generated from src/unifiers/matchTypeOf.js
+
+import type {Unifier} from '../env.js';
+
+/**
+ * Type-based matching unifier
+ *
+ * Matches values by their `typeof` result. Rejects unbound Variables.
+ */
+export declare class MatchTypeOf extends Unifier {
+  /** Array of type names to match against */
+  types: string[];
+
+  /**
+   * @param types - Type name or array of type names
+   */
+  constructor(types: string | string[]);
+
+  /**
+   * Tests if the value's typeof matches one of the configured types
+   * @param val - Value to check
+   * @param ls - Left argument stack (unused)
+   * @param rs - Right argument stack (unused)
+   * @returns True if typeof val matches
+   */
+  unify(val: unknown, ls: unknown[], rs: unknown[]): boolean;
+}
+
+/**
+ * Creates a typeof matcher
+ *
+ * @param types - Type name(s) to match against (e.g. 'string', ['number', 'bigint'])
+ * @returns A new MatchTypeOf instance
+ */
+export declare const matchTypeOf: (types: string | string[]) => MatchTypeOf;
+export default matchTypeOf;

package/src/unifiers/matchTypeOf.js

@@ -13,4 +13,5 @@ class MatchTypeOf extends Unifier {
 
 const matchTypeOf = types => new MatchTypeOf(types);
 
+export {matchTypeOf};
 export default matchTypeOf;

package/src/unifiers/ref.d.ts

@@ -0,0 +1,52 @@
+// Type definitions for deep6 ref unifier
+// Generated from src/unifiers/ref.js
+
+import type {Variable, Env} from '../env.js';
+
+/**
+ * Reference unifier for cross-pattern variable binding
+ *
+ * Binds both a variable and a value to the same input during unification.
+ * Pushes `(this.value, val)` and `(this.variable, val)` onto the stacks.
+ */
+export declare class Ref extends Variable {
+  /** The variable being referenced */
+  variable: Variable;
+  /** The value pattern to unify against */
+  value: unknown;
+
+  /**
+   * @param variable - Variable name (string) or Variable instance
+   * @param value - Value pattern to bind alongside the variable
+   */
+  constructor(variable: string | Variable, value: unknown);
+
+  /**
+   * Pushes value and variable bindings onto the stacks
+   * @param val - Input value
+   * @param ls - Left argument stack
+   * @param rs - Right argument stack
+   * @param env - Unification environment
+   * @returns Always true
+   */
+  unify(val: unknown, ls: unknown[], rs: unknown[], env: Env): boolean;
+}
+
+/**
+ * Creates a reference unifier
+ *
+ * @param variable - Variable name or Variable instance
+ * @param value - Value pattern to bind alongside the variable
+ * @returns A new Ref instance
+ *
+ * @example
+ * ```ts
+ * const r = ref('x', variable('y'));
+ * // During unification, both 'x' and 'y' get bound to the matched value
+ * ```
+ */
+export declare const ref: ((variable: string | Variable, value: unknown) => Ref) & {
+  Ref: typeof Ref;
+};
+
+export default ref;

package/src/unifiers/ref.js

@@ -18,4 +18,5 @@ class Ref extends Variable {
 const ref = (variable, value) => new Ref(variable, value);
 ref.Ref = Ref;
 
+export {ref};
 export default ref;