@speclynx/apidom-core 2.2.3 → 2.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speclynx/apidom-core",
-  "version": "2.2.3",
+  "version": "2.4.0",
   "description": "Tools for manipulating ApiDOM structures.",
   "publishConfig": {
     "access": "public",
@@ -25,7 +25,7 @@
     "lint": "eslint ./",
     "lint:fix": "eslint ./ --fix",
     "clean": "rimraf --glob 'src/**/*.mjs' 'src/**/*.cjs' 'test/**/*.mjs' ./dist ./types",
-    "typescript:check-types": "tsc --noEmit && tsc -p ./test/tsconfig.json --noEmit",
+    "typescript:check-types": "tsc --noEmit",
     "typescript:declaration": "tsc -p tsconfig.declaration.json && api-extractor run -l -c ./config/api-extractor/api-extractor.json",
     "test": "npm run build:es && cross-env BABEL_ENV=es babel test --out-dir test --extensions '.ts' --out-file-extension '.mjs' --root-mode 'upward' && cross-env NODE_ENV=test mocha",
     "test:update-snapshots": "cross-env UPDATE_SNAPSHOT=1 NODE_ENV=test mocha",
@@ -40,9 +40,9 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.28.4",
-    "@speclynx/apidom-datamodel": "^2.2.3",
-    "@speclynx/apidom-error": "^2.2.3",
-    "@speclynx/apidom-traverse": "^2.2.3",
+    "@speclynx/apidom-datamodel": "^2.4.0",
+    "@speclynx/apidom-error": "^2.4.0",
+    "@speclynx/apidom-traverse": "^2.4.0",
     "ramda": "~0.32.0",
     "ramda-adjunct": "^6.0.0",
     "short-unique-id": "^5.3.2",
@@ -59,5 +59,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "e08f97d01904015b1cf621e093145fe55de0d02d"
+  "gitHead": "f127ee0b98cc108b83a690bf317895e17a32b4d4"
 }

package/src/fields/fixed-fields.cjs

@@ -0,0 +1,43 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+exports.fixedFields = fixedFields;
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+/**
+ * Represents a fixed field definition.
+ * @public
+ */
+
+/**
+ * Returns the fixed fields for an Element class or instance.
+ *
+ * @param elementOrClass - Element instance or class
+ * @param options - Options for return format
+ * @returns Array of fixed fields, or object indexed by name if options.indexed is true
+ *
+ * @example
+ * ```ts
+ * import { fixedFields } from '@speclynx/apidom-core';
+ *
+ * // Get fixed fields as array
+ * const fields = fixedFields(ParameterElement);
+ *
+ * // Get fixed fields as indexed object for O(1) lookups
+ * const fieldsIndex = fixedFields(ParameterElement, { indexed: true });
+ * if (Object.hasOwn(fieldsIndex, 'description')) {
+ *   // field exists
+ * }
+ * ```
+ *
+ * @public
+ */
+function fixedFields(elementOrClass, options) {
+  const constructor = elementOrClass instanceof _apidomDatamodel.Element ? elementOrClass.constructor : elementOrClass;
+  const fields = constructor.fixedFields ?? [];
+  if (options?.indexed) {
+    return Object.fromEntries(fields.map(f => [f.name, f]));
+  }
+  return fields;
+}
+var _default = exports.default = fixedFields;

package/src/fields/fixed-fields.mjs

@@ -0,0 +1,39 @@
+import { Element } from '@speclynx/apidom-datamodel';
+
+/**
+ * Represents a fixed field definition.
+ * @public
+ */
+
+/**
+ * Returns the fixed fields for an Element class or instance.
+ *
+ * @param elementOrClass - Element instance or class
+ * @param options - Options for return format
+ * @returns Array of fixed fields, or object indexed by name if options.indexed is true
+ *
+ * @example
+ * ```ts
+ * import { fixedFields } from '@speclynx/apidom-core';
+ *
+ * // Get fixed fields as array
+ * const fields = fixedFields(ParameterElement);
+ *
+ * // Get fixed fields as indexed object for O(1) lookups
+ * const fieldsIndex = fixedFields(ParameterElement, { indexed: true });
+ * if (Object.hasOwn(fieldsIndex, 'description')) {
+ *   // field exists
+ * }
+ * ```
+ *
+ * @public
+ */
+export function fixedFields(elementOrClass, options) {
+  const constructor = elementOrClass instanceof Element ? elementOrClass.constructor : elementOrClass;
+  const fields = constructor.fixedFields ?? [];
+  if (options?.indexed) {
+    return Object.fromEntries(fields.map(f => [f.name, f]));
+  }
+  return fields;
+}
+export default fixedFields;

package/src/fields/index.cjs

@@ -0,0 +1,8 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
+exports.__esModule = true;
+exports.fixedFields = exports.default = void 0;
+var _fixedFields = _interopRequireWildcard(require("./fixed-fields.cjs"));
+exports.fixedFields = _fixedFields.fixedFields;
+exports.default = _fixedFields.default;

package/src/fields/index.mjs

@@ -0,0 +1 @@
+export { fixedFields, default } from "./fixed-fields.mjs";

package/src/index.cjs

@@ -3,7 +3,7 @@
 var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
-exports.transclude = exports.toYAML = exports.toValue = exports.toString = exports.toJSON = exports.sexprs = exports.resolveSpecification = exports.refractorPluginSemanticElementIdentity = exports.refractorPluginElementIdentity = exports.mergeRight = exports.mergeLeft = exports.from = exports.dispatchRefractorPlugins = exports.dehydrate = exports.defaultIdentityManager = exports.deepmerge = exports.createToolbox = exports.Transcluder = exports.MediaTypes = exports.IdentityManager = exports.ElementIdentityError = void 0;
+exports.transclude = exports.toYAML = exports.toValue = exports.toString = exports.toJSON = exports.sexprs = exports.resolveSpecification = exports.refractorPluginSemanticElementIdentity = exports.refractorPluginElementIdentity = exports.mergeRight = exports.mergeLeft = exports.from = exports.fixedFields = exports.dispatchRefractorPlugins = exports.dehydrate = exports.defaultIdentityManager = exports.deepmerge = exports.createToolbox = exports.Transcluder = exports.MediaTypes = exports.IdentityManager = exports.ElementIdentityError = void 0;
 var _index = require("./refractor/plugins/dispatcher/index.cjs");
 exports.dispatchRefractorPlugins = _index.dispatchPluginsSync;
 var _toolbox = _interopRequireDefault(require("./refractor/toolbox.cjs"));
@@ -43,4 +43,6 @@ exports.deepmerge = _deepmerge.default;
 var _mergeRight = _interopRequireDefault(require("./merge/merge-right.cjs"));
 exports.mergeRight = _mergeRight.default;
 var _mergeLeft = _interopRequireDefault(require("./merge/merge-left.cjs"));
-exports.mergeLeft = _mergeLeft.default;
+exports.mergeLeft = _mergeLeft.default;
+var _index4 = require("./fields/index.cjs");
+exports.fixedFields = _index4.fixedFields;

package/src/index.mjs

@@ -37,4 +37,5 @@ export { default as toString } from "./transformers/to-string.mjs";
 export { default as sexprs } from "./transformers/sexprs.mjs";
 export { default as deepmerge } from "./merge/deepmerge.mjs";
 export { default as mergeRight } from "./merge/merge-right.mjs";
-export { default as mergeLeft } from "./merge/merge-left.mjs";
+export { default as mergeLeft } from "./merge/merge-left.mjs";
+export { fixedFields } from "./fields/index.mjs";

package/types/apidom-core.d.ts

@@ -146,6 +146,10 @@ export declare interface DispatchPluginsSync {
  */
 export declare const dispatchRefractorPlugins: DispatchPluginsSync;
 
+declare type ElementClass = typeof Element_2 & {
+    fixedFields?: FixedField[];
+};
+
 /**
  * @public
  */
@@ -161,6 +165,42 @@ export declare interface ElementIdentityErrorOptions extends ApiDOMErrorOptions
     readonly value: unknown;
 }
 
+/**
+ * Represents a fixed field definition.
+ * @public
+ */
+export declare interface FixedField {
+    name: string;
+    [key: string]: unknown;
+}
+
+/**
+ * Returns the fixed fields for an Element class or instance.
+ *
+ * @param elementOrClass - Element instance or class
+ * @param options - Options for return format
+ * @returns Array of fixed fields, or object indexed by name if options.indexed is true
+ *
+ * @example
+ * ```ts
+ * import { fixedFields } from '@speclynx/apidom-core';
+ *
+ * // Get fixed fields as array
+ * const fields = fixedFields(ParameterElement);
+ *
+ * // Get fixed fields as indexed object for O(1) lookups
+ * const fieldsIndex = fixedFields(ParameterElement, { indexed: true });
+ * if (Object.hasOwn(fieldsIndex, 'description')) {
+ *   // field exists
+ * }
+ * ```
+ *
+ * @public
+ */
+export declare function fixedFields<T extends boolean = false>(elementOrClass: Element_2 | ElementClass, options?: {
+    indexed?: T;
+}): T extends true ? Record<string, FixedField> : FixedField[];
+
 /**
  * Transforms data to an Element from a particular namespace.
  *