@speclynx/apidom-datamodel 3.2.0 → 4.0.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.0.0](https://github.com/speclynx/apidom/compare/v3.2.1...v4.0.0) (2026-03-11)
+
+**Note:** Version bump only for package @speclynx/apidom-datamodel
+
+## [3.2.1](https://github.com/speclynx/apidom/compare/v3.2.0...v3.2.1) (2026-03-09)
+
+**Note:** Version bump only for package @speclynx/apidom-datamodel
+
 # [3.2.0](https://github.com/speclynx/apidom/compare/v3.1.0...v3.2.0) (2026-03-08)
 
 ### Features

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speclynx/apidom-datamodel",
-  "version": "3.2.0",
+  "version": "4.0.0",
   "description": "Data model primitives for ApiDOM.",
   "keywords": [
     "apidom",
@@ -55,7 +55,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.28.4",
-    "@speclynx/apidom-error": "3.2.0",
+    "@speclynx/apidom-error": "4.0.0",
     "ramda": "~0.32.0"
   },
   "files": [
@@ -68,5 +68,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "eeb2f01cd34fb0a95617f02bc1b6683aefc028f2"
+  "gitHead": "384ff82a1bb68d015fd6801de641898b4b582876"
 }

package/src/KeyValuePair.cjs

@@ -1,31 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-/**
- * 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 {
-  key;
-  value;
-  constructor(key, value) {
-    this.key = key;
-    this.value = value;
-  }
-
-  /**
-   * Converts to a plain JavaScript object representation.
-   */
-  toValue() {
-    return {
-      key: this.key?.toValue(),
-      value: this.value?.toValue()
-    };
-  }
-}
-var _default = exports.default = KeyValuePair;

package/src/KeyValuePair.mjs

@@ -1,27 +0,0 @@
-/**
- * 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 {
-  key;
-  value;
-  constructor(key, value) {
-    this.key = key;
-    this.value = value;
-  }
-
-  /**
-   * Converts to a plain JavaScript object representation.
-   */
-  toValue() {
-    return {
-      key: this.key?.toValue(),
-      value: this.value?.toValue()
-    };
-  }
-}
-export default KeyValuePair;

package/src/Metadata.cjs

@@ -1,91 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _ramda = require("ramda");
-/**
- * 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
-
-  get(name) {
-    return this[name];
-  }
-  set(name, value) {
-    this[name] = value;
-  }
-  hasKey(name) {
-    return Object.hasOwn(this, name);
-  }
-  keys() {
-    return Object.keys(this);
-  }
-  remove(name) {
-    delete this[name];
-  }
-  get isEmpty() {
-    return Object.keys(this).length === 0;
-  }
-  get isFrozen() {
-    return Object.isFrozen(this);
-  }
-  freeze() {
-    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() {
-    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) {
-    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() {
-    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, (0, _ramda.clone)(value));
-      }
-    }
-    return copy;
-  }
-}
-var _default = exports.default = Metadata;

package/src/Metadata.mjs

@@ -1,87 +0,0 @@
-import { clone } from 'ramda';
-/**
- * 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
-
-  get(name) {
-    return this[name];
-  }
-  set(name, value) {
-    this[name] = value;
-  }
-  hasKey(name) {
-    return Object.hasOwn(this, name);
-  }
-  keys() {
-    return Object.keys(this);
-  }
-  remove(name) {
-    delete this[name];
-  }
-  get isEmpty() {
-    return Object.keys(this).length === 0;
-  }
-  get isFrozen() {
-    return Object.isFrozen(this);
-  }
-  freeze() {
-    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() {
-    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) {
-    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() {
-    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.cjs

@@ -1,212 +0,0 @@
-"use strict";
-
-var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _JSONSerialiser = _interopRequireDefault(require("./serialisers/JSONSerialiser.cjs"));
-var elements = _interopRequireWildcard(require("./registration.cjs"));
-const isNull = value => value === null;
-const isString = value => typeof value === 'string';
-const isNumber = value => typeof value === 'number';
-const isBoolean = value => typeof value === 'boolean';
-const isObject = value => value !== null && typeof value === 'object';
-
-/**
- * Constructor type for Element classes.
- * @public
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-
-/**
- * Function to test if a value should be converted to a specific element type.
- * @public
- */
-
-/**
- * Tuple of detection test and element class.
- * @public
- */
-
-/**
- * Options for Namespace constructor.
- * @public
- */
-
-/**
- * Plugin interface for extending Namespace.
- * @public
- */
-
-/**
- * Map of registered element classes.
- * @public
- */
-
-/**
- * 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 {
-  elementMap = {};
-  elementDetection = [];
-  Element;
-  KeyValuePair;
-  _elements;
-  _attributeElementKeys = [];
-  _attributeElementArrayKeys = [];
-  constructor(options) {
-    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) {
-    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() {
-    // 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, ElementClass) {
-    this._elements = undefined;
-    this.elementMap[name] = ElementClass;
-    return this;
-  }
-
-  /**
-   * Unregister a previously registered class for an element.
-   */
-  unregister(name) {
-    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, ElementClass, givenPrepend) {
-    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) {
-    if (value instanceof this.Element) {
-      return value;
-    }
-    let element;
-    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) {
-    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;
-    }
-    return ElementClass;
-  }
-
-  /**
-   * Convert a refract document into refract element instances.
-   */
-  fromRefract(doc) {
-    return this.serialiser.deserialise(doc);
-  }
-
-  /**
-   * Convert an element to a Refracted JSON object.
-   */
-  toRefract(element) {
-    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() {
-    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() {
-    return new _JSONSerialiser.default(this);
-  }
-}
-
-// Set up the circular reference for JSONSerialiser
-_JSONSerialiser.default.prototype.Namespace = Namespace;
-var _default = exports.default = Namespace;

package/src/Namespace.mjs

@@ -1,206 +0,0 @@
-import JSONSerialiser from "./serialisers/JSONSerialiser.mjs";
-import * as elements from "./registration.mjs";
-const isNull = value => value === null;
-const isString = value => typeof value === 'string';
-const isNumber = value => typeof value === 'number';
-const isBoolean = value => typeof value === 'boolean';
-const isObject = value => value !== null && typeof value === 'object';
-
-/**
- * Constructor type for Element classes.
- * @public
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-
-/**
- * Function to test if a value should be converted to a specific element type.
- * @public
- */
-
-/**
- * Tuple of detection test and element class.
- * @public
- */
-
-/**
- * Options for Namespace constructor.
- * @public
- */
-
-/**
- * Plugin interface for extending Namespace.
- * @public
- */
-
-/**
- * Map of registered element classes.
- * @public
- */
-
-/**
- * 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 {
-  elementMap = {};
-  elementDetection = [];
-  Element;
-  KeyValuePair;
-  _elements;
-  _attributeElementKeys = [];
-  _attributeElementArrayKeys = [];
-  constructor(options) {
-    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) {
-    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() {
-    // 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, ElementClass) {
-    this._elements = undefined;
-    this.elementMap[name] = ElementClass;
-    return this;
-  }
-
-  /**
-   * Unregister a previously registered class for an element.
-   */
-  unregister(name) {
-    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, ElementClass, givenPrepend) {
-    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) {
-    if (value instanceof this.Element) {
-      return value;
-    }
-    let element;
-    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) {
-    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;
-    }
-    return ElementClass;
-  }
-
-  /**
-   * Convert a refract document into refract element instances.
-   */
-  fromRefract(doc) {
-    return this.serialiser.deserialise(doc);
-  }
-
-  /**
-   * Convert an element to a Refracted JSON object.
-   */
-  toRefract(element) {
-    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() {
-    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() {
-    return new JSONSerialiser(this);
-  }
-}
-
-// Set up the circular reference for JSONSerialiser
-JSONSerialiser.prototype.Namespace = Namespace;
-export default Namespace;