@speclynx/apidom-datamodel 4.0.3 → 4.0.5

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.0.5](https://github.com/speclynx/apidom/compare/v4.0.4...v4.0.5) (2026-03-13)
+
+**Note:** Version bump only for package @speclynx/apidom-datamodel
+
+## [4.0.4](https://github.com/speclynx/apidom/compare/v4.0.3...v4.0.4) (2026-03-12)
+
+### Bug Fixes
+
+- **release:** override minimatch 10.2.3 to fix glob pattern regression in lerna publish ([#157](https://github.com/speclynx/apidom/issues/157)) ([c2d65a0](https://github.com/speclynx/apidom/commit/c2d65a06a2187e8563a9dc9db74ba27255450e0b)), closes [lerna/lerna#4305](https://github.com/lerna/lerna/issues/4305) [isaacs/minimatch#284](https://github.com/isaacs/minimatch/issues/284)
+
 ## [4.0.3](https://github.com/speclynx/apidom/compare/v4.0.2...v4.0.3) (2026-03-11)
 
 ### Bug Fixes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speclynx/apidom-datamodel",
-  "version": "4.0.3",
+  "version": "4.0.5",
   "description": "Data model primitives for ApiDOM.",
   "keywords": [
     "apidom",
@@ -55,11 +55,12 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.28.4",
-    "@speclynx/apidom-error": "4.0.3",
+    "@speclynx/apidom-error": "4.0.5",
     "ramda": "~0.32.0"
   },
   "files": [
-    "src/",
+    "src/**/*.mjs",
+    "src/**/*.cjs",
     "dist/",
     "types/apidom-datamodel.d.ts",
     "LICENSES",
@@ -67,5 +68,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "6ccfa09c02232516215e7de3ead276641957e626"
+  "gitHead": "5a85d2a832eeefb07d03760faa391b457447e966"
 }

package/src/KeyValuePair.ts

@@ -1,31 +0,0 @@
-import type Element from './primitives/Element.ts';
-
-/**
- * Represents a key-value pair used in MemberElement content.
- * This is used internally to store object member data.
- *
- * @typeParam K - Key element type
- * @typeParam V - Value element type
- * @public
- */
-class KeyValuePair<K extends Element = Element, V extends Element = Element> {
-  public key: K | undefined;
-  public value: V | undefined;
-
-  constructor(key?: K, value?: V) {
-    this.key = key;
-    this.value = value;
-  }
-
-  /**
-   * Converts to a plain JavaScript object representation.
-   */
-  toValue(): { key: unknown; value: unknown } {
-    return {
-      key: this.key?.toValue(),
-      value: this.value?.toValue(),
-    };
-  }
-}
-
-export default KeyValuePair;

package/src/Metadata.ts

@@ -1,100 +0,0 @@
-import { clone } from 'ramda';
-
-import type Element from './primitives/Element.ts';
-
-/**
- * Lightweight meta container for Element metadata.
- *
- * Data is stored as own properties on the instance; methods live on the prototype.
- * `Object.keys()`, `Object.entries()`, etc. only see data properties.
- *
- * @public
- */
-class Metadata {
-  // Set via prototype assignment in registration.ts to avoid circular dependency
-  declare Element: typeof Element;
-  declare cloneDeepElement: (element: Element) => Element;
-
-  get(name: string): unknown {
-    return (this as Record<string, unknown>)[name];
-  }
-
-  set(name: string, value: unknown): void {
-    (this as Record<string, unknown>)[name] = value;
-  }
-
-  hasKey(name: string): boolean {
-    return Object.hasOwn(this, name);
-  }
-
-  keys(): string[] {
-    return Object.keys(this);
-  }
-
-  remove(name: string): void {
-    delete (this as Record<string, unknown>)[name];
-  }
-
-  get isEmpty(): boolean {
-    return Object.keys(this).length === 0;
-  }
-
-  get isFrozen(): boolean {
-    return Object.isFrozen(this);
-  }
-
-  freeze(): void {
-    for (const value of Object.values(this)) {
-      if (value instanceof this.Element) {
-        value.freeze();
-      } else if (Array.isArray(value) || (value !== null && typeof value === 'object')) {
-        Object.freeze(value);
-      }
-    }
-    Object.freeze(this);
-  }
-
-  /**
-   * Creates a shallow clone. Same references, new container.
-   */
-  cloneShallow(): Metadata {
-    const clone = new Metadata();
-    Object.assign(clone, this);
-    return clone;
-  }
-
-  /**
-   * Merges another Metadata into a new instance.
-   * Arrays are concatenated, all other values are overwritten by source.
-   */
-  merge(source: Metadata): Metadata {
-    const result = this.cloneShallow();
-    for (const [key, value] of Object.entries(source)) {
-      const existing = result.get(key);
-      if (Array.isArray(existing) && Array.isArray(value)) {
-        result.set(key, [...existing, ...value]);
-      } else {
-        result.set(key, value);
-      }
-    }
-    return result;
-  }
-
-  /**
-   * Creates a deep clone. Elements are deep cloned,
-   * all other values are deep cloned via ramda clone.
-   */
-  cloneDeep(): Metadata {
-    const copy = new Metadata();
-    for (const [key, value] of Object.entries(this)) {
-      if (value instanceof this.Element) {
-        copy.set(key, this.cloneDeepElement(value));
-      } else {
-        copy.set(key, clone(value));
-      }
-    }
-    return copy;
-  }
-}
-
-export default Metadata;

package/src/Namespace.ts

@@ -1,260 +0,0 @@
-import JSONSerialiser from './serialisers/JSONSerialiser.ts';
-import * as elements from './registration.ts';
-import type Element from './primitives/Element.ts';
-import type ElementConstructor from './primitives/Element.ts';
-import type KeyValuePairConstructor from './KeyValuePair.ts';
-
-const isNull = (value: unknown): value is null => value === null;
-const isString = (value: unknown): value is string => typeof value === 'string';
-const isNumber = (value: unknown): value is number => typeof value === 'number';
-const isBoolean = (value: unknown): value is boolean => typeof value === 'boolean';
-const isObject = (value: unknown): value is Record<string, unknown> =>
-  value !== null && typeof value === 'object';
-
-/**
- * Constructor type for Element classes.
- * @public
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type ElementClass = new (...args: any[]) => Element;
-
-/**
- * Function to test if a value should be converted to a specific element type.
- * @public
- */
-type DetectionTest = (value: unknown) => boolean;
-
-/**
- * Tuple of detection test and element class.
- * @public
- */
-type DetectionEntry = [DetectionTest, ElementClass];
-
-/**
- * Options for Namespace constructor.
- * @public
- */
-interface NamespaceOptions {
-  noDefault?: boolean;
-}
-
-/**
- * Plugin interface for extending Namespace.
- * @public
- */
-interface NamespacePlugin {
-  namespace?: (options: { base: Namespace }) => void;
-  load?: (options: { base: Namespace }) => void;
-}
-
-/**
- * Map of registered element classes.
- * @public
- */
-interface ElementsMap {
-  Element: ElementClass;
-  [key: string]: ElementClass;
-}
-
-/**
- * A refract element implementation with an extensible namespace, able to
- * load other namespaces into it.
- *
- * The namespace allows you to register your own classes to be instantiated
- * when a particular refract element is encountered, and allows you to specify
- * which elements get instantiated for existing JavaScript objects.
- *
- * @public
- */
-class Namespace {
-  public elementMap: Record<string, ElementClass> = {};
-  public elementDetection: DetectionEntry[] = [];
-  public Element: typeof ElementConstructor;
-  public KeyValuePair: typeof KeyValuePairConstructor;
-
-  protected _elements?: ElementsMap;
-  protected _attributeElementKeys: string[] = [];
-  protected _attributeElementArrayKeys: string[] = [];
-
-  constructor(options?: NamespaceOptions) {
-    this.Element = elements.Element;
-    this.KeyValuePair = elements.KeyValuePair;
-
-    if (!options || !options.noDefault) {
-      this.useDefault();
-    }
-  }
-
-  /**
-   * Use a namespace plugin or load a generic plugin.
-   */
-  use(plugin: NamespacePlugin): this {
-    if (plugin.namespace) {
-      plugin.namespace({ base: this });
-    }
-    if (plugin.load) {
-      plugin.load({ base: this });
-    }
-    return this;
-  }
-
-  /**
-   * Use the default namespace. This preloads all the default elements
-   * into this registry instance.
-   */
-  useDefault(): this {
-    // Set up classes for default elements
-    this.register('null', elements.NullElement)
-      .register('string', elements.StringElement)
-      .register('number', elements.NumberElement)
-      .register('boolean', elements.BooleanElement)
-      .register('array', elements.ArrayElement)
-      .register('object', elements.ObjectElement)
-      .register('member', elements.MemberElement)
-      .register('ref', elements.RefElement)
-      .register('link', elements.LinkElement)
-      .register('sourceMap', elements.SourceMapElement);
-
-    // Add instance detection functions to convert existing objects into
-    // the corresponding refract elements.
-    this.detect(isNull, elements.NullElement, false)
-      .detect(isString, elements.StringElement, false)
-      .detect(isNumber, elements.NumberElement, false)
-      .detect(isBoolean, elements.BooleanElement, false)
-      .detect(Array.isArray, elements.ArrayElement, false)
-      .detect(isObject, elements.ObjectElement, false);
-
-    return this;
-  }
-
-  /**
-   * Register a new element class for an element.
-   */
-  register(name: string, ElementClass: ElementClass): this {
-    this._elements = undefined;
-    this.elementMap[name] = ElementClass;
-    return this;
-  }
-
-  /**
-   * Unregister a previously registered class for an element.
-   */
-  unregister(name: string): this {
-    this._elements = undefined;
-    delete this.elementMap[name];
-    return this;
-  }
-
-  /**
-   * Add a new detection function to determine which element
-   * class to use when converting existing JS instances into
-   * refract elements.
-   */
-  detect(test: DetectionTest, ElementClass: ElementClass, givenPrepend?: boolean): this {
-    const prepend = givenPrepend === undefined ? true : givenPrepend;
-
-    if (prepend) {
-      this.elementDetection.unshift([test, ElementClass]);
-    } else {
-      this.elementDetection.push([test, ElementClass]);
-    }
-
-    return this;
-  }
-
-  /**
-   * Convert an existing JavaScript object into refract element instances.
-   * If the item passed in is already refracted, then it is returned unmodified.
-   */
-  toElement(value: unknown): Element | undefined {
-    if (value instanceof this.Element) {
-      return value as Element;
-    }
-
-    let element: Element | undefined;
-
-    for (const [test, ElementClass] of this.elementDetection) {
-      if (test(value)) {
-        element = new ElementClass(value);
-        break;
-      }
-    }
-
-    return element;
-  }
-
-  /**
-   * Get an element class given an element name.
-   */
-  getElementClass(element: string): ElementClass {
-    const ElementClass = this.elementMap[element];
-
-    if (ElementClass === undefined) {
-      // Fall back to the base element. We may not know what
-      // to do with the `content`, but downstream software
-      // may know.
-      return this.Element as unknown as ElementClass;
-    }
-
-    return ElementClass;
-  }
-
-  /**
-   * Convert a refract document into refract element instances.
-   */
-  fromRefract(doc: Record<string, unknown>): Element {
-    return this.serialiser.deserialise(
-      doc as unknown as Parameters<JSONSerialiser['deserialise']>[0],
-    );
-  }
-
-  /**
-   * Convert an element to a Refracted JSON object.
-   */
-  toRefract(element: Element): ReturnType<JSONSerialiser['serialise']> {
-    return this.serialiser.serialise(element);
-  }
-
-  /**
-   * Get an object that contains all registered element classes, where
-   * the key is the PascalCased element name and the value is the class.
-   */
-  get elements(): ElementsMap {
-    if (this._elements === undefined) {
-      this._elements = {
-        Element: this.Element,
-      };
-
-      Object.keys(this.elementMap).forEach((name) => {
-        // Currently, all registered element types use a camelCaseName.
-        // Converting to PascalCase is as simple as upper-casing the first letter.
-        const pascal = name[0].toUpperCase() + name.substring(1);
-        this._elements![pascal] = this.elementMap[name];
-      });
-    }
-
-    return this._elements;
-  }
-
-  /**
-   * Convenience method for getting a JSON Serialiser configured with the
-   * current namespace.
-   */
-  get serialiser(): JSONSerialiser {
-    return new JSONSerialiser(this);
-  }
-}
-
-// Set up the circular reference for JSONSerialiser
-JSONSerialiser.prototype.Namespace = Namespace;
-
-export default Namespace;
-
-export type {
-  ElementClass,
-  DetectionTest,
-  DetectionEntry,
-  NamespaceOptions,
-  NamespacePlugin,
-  ElementsMap,
-};

package/src/ObjectSlice.ts

@@ -1,228 +0,0 @@
-import type Element from './primitives/Element.ts';
-import type MemberElement from './primitives/MemberElement.ts';
-
-/**
- * Callback type for ObjectSlice iteration methods.
- * Receives (value, key, member) - the standard pattern for object-like iteration.
- * @public
- */
-export type ObjectSliceCallback<U> = (value: Element, key: Element, member: MemberElement) => U;
-
-/**
- * Callback type for ObjectSlice forEach that also receives the index.
- * @public
- */
-export type ObjectSliceForEachCallback = (
-  value: Element,
-  key: Element,
-  member: MemberElement,
-  index: number,
-) => void;
-
-/**
- * ObjectSlice is a collection wrapper for MemberElement arrays.
- * It provides functional methods with (value, key, member) callback signatures,
- * which is the standard pattern for iterating over object-like structures.
- *
- * Unlike ArraySlice, ObjectSlice uses composition rather than inheritance
- * because its callback signatures are fundamentally different.
- *
- * @public
- */
-class ObjectSlice {
-  public readonly elements: MemberElement[];
-
-  constructor(elements?: MemberElement[]) {
-    this.elements = elements ?? [];
-  }
-
-  /**
-   * Converts all member elements to their JavaScript values.
-   * Returns an array of \{ key, value \} objects.
-   */
-  toValue(): Array<{ key: unknown; value: unknown }> {
-    return this.elements.map((member) => ({
-      key: member.key?.toValue(),
-      value: member.value?.toValue(),
-    }));
-  }
-
-  /**
-   * Maps over the member elements, calling callback with (value, key, member).
-   * @param callback - Function to execute for each member
-   * @param thisArg - Value to use as this when executing callback
-   */
-  map<U>(callback: ObjectSliceCallback<U>, thisArg?: unknown): U[] {
-    return this.elements.map((member) => {
-      const value = member.value;
-      const key = member.key;
-
-      if (value === undefined || key === undefined) {
-        throw new Error('MemberElement must have both key and value');
-      }
-
-      return thisArg !== undefined
-        ? callback.call(thisArg, value, key, member)
-        : callback(value, key, member);
-    });
-  }
-
-  /**
-   * Filters member elements using the provided callback.
-   * @param callback - Function that receives (value, key, member) and returns boolean
-   * @param thisArg - Value to use as this when executing callback
-   */
-  filter(callback: ObjectSliceCallback<boolean>, thisArg?: unknown): ObjectSlice {
-    const filtered = this.elements.filter((member) => {
-      const value = member.value;
-      const key = member.key;
-
-      if (value === undefined || key === undefined) {
-        return false; // Skip malformed members
-      }
-
-      return thisArg !== undefined
-        ? callback.call(thisArg, value, key, member)
-        : callback(value, key, member);
-    });
-
-    return new ObjectSlice(filtered);
-  }
-
-  /**
-   * Rejects member elements that match the provided callback.
-   * @param callback - Function that receives (value, key, member) and returns boolean
-   * @param thisArg - Value to use as this when executing callback
-   */
-  reject(callback: ObjectSliceCallback<boolean>, thisArg?: unknown): ObjectSlice {
-    const results: MemberElement[] = [];
-    for (const member of this.elements) {
-      const value = member.value;
-      const key = member.key;
-
-      if (value === undefined || key === undefined) {
-        continue;
-      }
-
-      if (!callback.call(thisArg, value, key, member)) {
-        results.push(member);
-      }
-    }
-    return new ObjectSlice(results);
-  }
-
-  /**
-   * Executes a provided function once for each member element.
-   * @param callback - Function that receives (value, key, member, index)
-   * @param thisArg - Value to use as this when executing callback
-   */
-  forEach(callback: ObjectSliceForEachCallback, thisArg?: unknown): void {
-    this.elements.forEach((member, index) => {
-      const value = member.value;
-      const key = member.key;
-
-      if (value === undefined || key === undefined) {
-        return; // Skip malformed members
-      }
-
-      if (thisArg !== undefined) {
-        callback.call(thisArg, value, key, member, index);
-      } else {
-        callback(value, key, member, index);
-      }
-    });
-  }
-
-  /**
-   * Returns the first member element that satisfies the callback.
-   * @param callback - Function that receives (value, key, member) and returns boolean
-   * @param thisArg - Value to use as this when executing callback
-   */
-  find(callback: ObjectSliceCallback<boolean>, thisArg?: unknown): MemberElement | undefined {
-    return this.elements.find((member) => {
-      const value = member.value;
-      const key = member.key;
-
-      if (value === undefined || key === undefined) {
-        return false;
-      }
-
-      return thisArg !== undefined
-        ? callback.call(thisArg, value, key, member)
-        : callback(value, key, member);
-    });
-  }
-
-  /**
-   * Returns an array of all keys' values.
-   */
-  keys(): unknown[] {
-    return this.elements
-      .map((member) => member.key?.toValue())
-      .filter((key): key is unknown => key !== undefined);
-  }
-
-  /**
-   * Returns an array of all values' values.
-   */
-  values(): unknown[] {
-    return this.elements
-      .map((member) => member.value?.toValue())
-      .filter((value): value is unknown => value !== undefined);
-  }
-
-  /**
-   * Returns the number of elements in the slice.
-   */
-  get length(): number {
-    return this.elements.length;
-  }
-
-  /**
-   * Returns whether the slice is empty.
-   */
-  get isEmpty(): boolean {
-    return this.length === 0;
-  }
-
-  /**
-   * Returns the first element in the slice or undefined if empty.
-   */
-  get first(): MemberElement | undefined {
-    return this.elements[0];
-  }
-
-  /**
-   * Gets the element at the specified index.
-   * @param index - The index of the element to get
-   */
-  get(index: number): MemberElement | undefined {
-    return this.elements[index];
-  }
-
-  /**
-   * Adds the given member element to the end of the slice.
-   * @param member - The member element to add
-   */
-  push(member: MemberElement): this {
-    this.elements.push(member);
-    return this;
-  }
-
-  /**
-   * Determines whether the slice includes a member with the given key value.
-   * @param keyValue - The key value to search for
-   */
-  includesKey(keyValue: unknown): boolean {
-    return this.elements.some((member) => member.key?.equals(keyValue));
-  }
-
-  /**
-   * Iterator support - allows for...of loops.
-   */
-  [Symbol.iterator](): IterableIterator<MemberElement> {
-    return this.elements[Symbol.iterator]();
-  }
-}
-
-export default ObjectSlice;

package/src/clone/errors/CloneError.ts

@@ -1,26 +0,0 @@
-import { ApiDOMStructuredError } from '@speclynx/apidom-error';
-import type { ApiDOMErrorOptions } from '@speclynx/apidom-error';
-
-/**
- * @public
- */
-export interface CloneErrorOptions extends ApiDOMErrorOptions {
-  readonly value: unknown;
-}
-
-/**
- * @public
- */
-class CloneError extends ApiDOMStructuredError {
-  public readonly value: unknown;
-
-  constructor(message?: string, structuredOptions?: CloneErrorOptions) {
-    super(message, structuredOptions);
-
-    if (typeof structuredOptions !== 'undefined') {
-      this.value = structuredOptions.value;
-    }
-  }
-}
-
-export default CloneError;

package/src/clone/errors/DeepCloneError.ts

@@ -1,8 +0,0 @@
-import CloneError from './CloneError.ts';
-
-/**
- * @public
- */
-class DeepCloneError extends CloneError {}
-
-export default DeepCloneError;