@speclynx/apidom-core 2.3.0 → 2.4.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.4.0](https://github.com/speclynx/apidom/compare/v2.3.0...v2.4.0) (2026-01-29)
+
+### Features
+
+- **core:** use standardized field inspection ([#52](https://github.com/speclynx/apidom/issues/52)) ([cc4506c](https://github.com/speclynx/apidom/commit/cc4506c5cbd4bd03943e271ef93a7ab5574ac978))
+
 # [2.3.0](https://github.com/speclynx/apidom/compare/v2.2.3...v2.3.0) (2026-01-27)
 
 **Note:** Version bump only for package @speclynx/apidom-core

package/README.md

@@ -651,3 +651,44 @@ const numberElement = new NumberElement(1);
 
 toString(numberElement); // => '{"element":"number","content":1}'
 ```
+
+---
+
+## Field introspection
+
+### fixedFields
+
+Returns the fixed fields for an Element class or instance.
+This is useful for introspecting which fields an element type supports.
+
+```js
+import { fixedFields } from '@speclynx/apidom-core';
+import { InfoElement } from '@speclynx/apidom-ns-openapi-3-1';
+
+// Get fixed fields as array
+const fields = fixedFields(InfoElement);
+// => [{ name: 'title', ... }, { name: 'description', ... }, { name: 'termsOfService', ... }, ...]
+
+// Get fixed fields from an instance
+const infoElement = new InfoElement({ title: 'My API' });
+const fieldsFromInstance = fixedFields(infoElement);
+// => [{ name: 'title', ... }, { name: 'description', ... }, { name: 'termsOfService', ... }, ...]
+```
+
+#### indexed option
+
+Use the `indexed` option for O(1) lookups by field name:
+
+```js
+import { fixedFields } from '@speclynx/apidom-core';
+import { InfoElement } from '@speclynx/apidom-ns-openapi-3-1';
+
+// Get fixed fields as indexed object for O(1) lookups
+const fieldsIndex = fixedFields(InfoElement, { indexed: true });
+// => { title: { name: 'title', ... }, description: { name: 'description', ... }, ... }
+
+// Check if a field exists
+if (Object.hasOwn(fieldsIndex, 'description')) {
+  // field exists
+}
+```

package/dist/apidom-core.browser.js

@@ -17352,6 +17352,57 @@ function _includes(a, list) {
 
 /***/ },
 
+/***/ 6269
+(__unused_webpack_module, __webpack_exports__, __webpack_require__) {
+
+__webpack_require__.r(__webpack_exports__);
+/* harmony export */ __webpack_require__.d(__webpack_exports__, {
+/* harmony export */   "default": () => (__WEBPACK_DEFAULT_EXPORT__),
+/* harmony export */   fixedFields: () => (/* binding */ fixedFields)
+/* harmony export */ });
+/* harmony import */ var _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(728);
+
+
+/**
+ * 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 _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_0__["default"] ? elementOrClass.constructor : elementOrClass;
+  const fields = constructor.fixedFields ?? [];
+  if (options?.indexed) {
+    return Object.fromEntries(fields.map(f => [f.name, f]));
+  }
+  return fields;
+}
+/* harmony default export */ const __WEBPACK_DEFAULT_EXPORT__ = (fixedFields);
+
+/***/ },
+
 /***/ 6390
 (__unused_webpack___webpack_module__, __webpack_exports__, __webpack_require__) {
 
@@ -28662,6 +28713,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */   defaultIdentityManager: () => (/* reexport safe */ _identity_index_ts__WEBPACK_IMPORTED_MODULE_7__.defaultIdentityManager),
 /* harmony export */   dehydrate: () => (/* reexport safe */ _transformers_dehydrate_ts__WEBPACK_IMPORTED_MODULE_13__["default"]),
 /* harmony export */   dispatchRefractorPlugins: () => (/* reexport safe */ _refractor_plugins_dispatcher_index_ts__WEBPACK_IMPORTED_MODULE_0__.dispatchPluginsSync),
+/* harmony export */   fixedFields: () => (/* reexport safe */ _fields_index_ts__WEBPACK_IMPORTED_MODULE_19__.fixedFields),
 /* harmony export */   from: () => (/* reexport safe */ _transformers_from_ts__WEBPACK_IMPORTED_MODULE_9__["default"]),
 /* harmony export */   mergeLeft: () => (/* reexport safe */ _merge_merge_left_ts__WEBPACK_IMPORTED_MODULE_18__["default"]),
 /* harmony export */   mergeRight: () => (/* reexport safe */ _merge_merge_right_ts__WEBPACK_IMPORTED_MODULE_17__["default"]),
@@ -28694,6 +28746,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _merge_deepmerge_ts__WEBPACK_IMPORTED_MODULE_16__ = __webpack_require__(4386);
 /* harmony import */ var _merge_merge_right_ts__WEBPACK_IMPORTED_MODULE_17__ = __webpack_require__(7715);
 /* harmony import */ var _merge_merge_left_ts__WEBPACK_IMPORTED_MODULE_18__ = __webpack_require__(9763);
+/* harmony import */ var _fields_index_ts__WEBPACK_IMPORTED_MODULE_19__ = __webpack_require__(6269);
 
 
 
@@ -28739,6 +28792,7 @@ __webpack_require__.r(__webpack_exports__);
 
 
 
+
 /******/ 	return __webpack_exports__;
 /******/ })()
 ;