@speclynx/apidom-overlay 4.3.1 → 4.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speclynx/apidom-overlay",
-  "version": "4.3.1",
+  "version": "4.5.0",
   "description": "Apply Overlay 1.x.y documents to API definitions.",
   "keywords": [
     "apidom",
@@ -18,7 +18,7 @@
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org",
-    "provenance": false
+    "provenance": true
   },
   "type": "module",
   "sideEffects": false,
@@ -53,12 +53,12 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.28.4",
-    "@speclynx/apidom-core": "4.3.1",
-    "@speclynx/apidom-datamodel": "4.3.1",
-    "@speclynx/apidom-error": "4.3.1",
-    "@speclynx/apidom-json-path": "4.3.1",
-    "@speclynx/apidom-ns-overlay-1": "4.3.1",
-    "@speclynx/apidom-reference": "4.3.1"
+    "@speclynx/apidom-core": "4.5.0",
+    "@speclynx/apidom-datamodel": "4.5.0",
+    "@speclynx/apidom-error": "4.5.0",
+    "@speclynx/apidom-json-path": "4.5.0",
+    "@speclynx/apidom-ns-overlay-1": "4.5.0",
+    "@speclynx/apidom-reference": "4.5.0"
   },
   "files": [
     "src/**/*.mjs",
@@ -69,5 +69,6 @@
     "NOTICE",
     "README.md",
     "CHANGELOG.md"
-  ]
+  ],
+  "gitHead": "2df7f3dcd368bdbc0644117fb677610a8b4a03a5"
 }

package/src/{apply.cjs → apply/apidom.cjs}

@@ -2,13 +2,13 @@
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
-exports.applyUpdateAction = exports.applyRemoveAction = exports.applyOverlayApiDOM = exports.applyCopyAction = exports.applyAction = void 0;
+exports.applyUpdateAction = exports.applyRemoveAction = exports.applyOverlay = exports.applyCopyAction = exports.applyAction = void 0;
 var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _apidomCore = require("@speclynx/apidom-core");
 var _apidomJsonPath = require("@speclynx/apidom-json-path");
 var _apidomNsOverlay = require("@speclynx/apidom-ns-overlay-1");
-var _OverlayError = _interopRequireDefault(require("./errors/OverlayError.cjs"));
-var _validate = require("./validate.cjs");
+var _OverlayError = _interopRequireDefault(require("../errors/OverlayError.cjs"));
+var _validate = require("../validate.cjs");
 /**
  * @public
  */
@@ -214,7 +214,7 @@ const applyAction = (actionElement, targetElement, options = defaultApplyOptions
  * @public
  */
 exports.applyAction = applyAction;
-const applyOverlayApiDOM = (overlayElement, targetElement, options = defaultApplyOptions) => {
+const applyOverlay = (overlayElement, targetElement, options = defaultApplyOptions) => {
   const overlay = overlayElement instanceof _apidomDatamodel.ParseResultElement ? overlayElement.api : overlayElement;
   if (!(0, _apidomNsOverlay.isOverlay1Element)(overlay)) {
     throw new _OverlayError.default('First argument must be an Overlay 1.x document');
@@ -240,4 +240,4 @@ const applyOverlayApiDOM = (overlayElement, targetElement, options = defaultAppl
   }
   return target;
 };
-exports.applyOverlayApiDOM = applyOverlayApiDOM;
+exports.applyOverlay = applyOverlay;

package/src/{apply.mjs → apply/apidom.mjs}

@@ -2,8 +2,8 @@ import { isObjectElement, isArrayElement, cloneDeep, ParseResultElement } from '
 import { deepmerge, toValue } from '@speclynx/apidom-core';
 import { evaluate, NormalizedPath } from '@speclynx/apidom-json-path';
 import { isOverlay1Element } from '@speclynx/apidom-ns-overlay-1';
-import OverlayError from "./errors/OverlayError.mjs";
-import { validateAction, validateTargetNodes } from "./validate.mjs";
+import OverlayError from "../errors/OverlayError.mjs";
+import { validateAction, validateTargetNodes } from "../validate.mjs";
 /**
  * @public
  */
@@ -204,7 +204,7 @@ export const applyAction = (actionElement, targetElement, options = defaultApply
  *
  * @public
  */
-export const applyOverlayApiDOM = (overlayElement, targetElement, options = defaultApplyOptions) => {
+export const applyOverlay = (overlayElement, targetElement, options = defaultApplyOptions) => {
   const overlay = overlayElement instanceof ParseResultElement ? overlayElement.api : overlayElement;
   if (!isOverlay1Element(overlay)) {
     throw new OverlayError('First argument must be an Overlay 1.x document');

package/src/apply/pojo.cjs

@@ -0,0 +1,23 @@
+"use strict";
+
+exports.__esModule = true;
+exports.applyOverlay = exports.applyAction = void 0;
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _apidomCore = require("@speclynx/apidom-core");
+var _apidomNsOverlay = require("@speclynx/apidom-ns-overlay-1");
+var _apidom = require("./apidom.cjs");
+/**
+ * Applies a single overlay action (POJO) to a target (POJO).
+ *
+ * @public
+ */
+const applyAction = (action, target) => (0, _apidomCore.toValue)((0, _apidom.applyAction)((0, _apidomNsOverlay.refractAction)(action), (0, _apidomDatamodel.refract)(target)));
+
+/**
+ * Applies an entire overlay document (POJO) to a target (POJO).
+ *
+ * @public
+ */
+exports.applyAction = applyAction;
+const applyOverlay = (overlay, target) => (0, _apidomCore.toValue)((0, _apidom.applyOverlay)((0, _apidomNsOverlay.refractOverlay1)(overlay), (0, _apidomDatamodel.refract)(target)));
+exports.applyOverlay = applyOverlay;

package/src/apply/pojo.mjs

@@ -0,0 +1,17 @@
+import { refract } from '@speclynx/apidom-datamodel';
+import { toValue } from '@speclynx/apidom-core';
+import { refractAction, refractOverlay1 } from '@speclynx/apidom-ns-overlay-1';
+import { applyAction as applyActionApiDOM, applyOverlay as applyOverlayApiDOM } from "./apidom.mjs";
+/**
+ * Applies a single overlay action (POJO) to a target (POJO).
+ *
+ * @public
+ */
+export const applyAction = (action, target) => toValue(applyActionApiDOM(refractAction(action), refract(target)));
+
+/**
+ * Applies an entire overlay document (POJO) to a target (POJO).
+ *
+ * @public
+ */
+export const applyOverlay = (overlay, target) => toValue(applyOverlayApiDOM(refractOverlay1(overlay), refract(target)));

package/src/{apply-uri.cjs → apply/uri.cjs}

@@ -6,8 +6,8 @@ exports.default = void 0;
 var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _apidomNsOverlay = require("@speclynx/apidom-ns-overlay-1");
 var _apidomReference = require("@speclynx/apidom-reference");
-var _apply = require("./apply.cjs");
-var _OverlayError = _interopRequireDefault(require("./errors/OverlayError.cjs"));
+var _apidom = require("./apidom.cjs");
+var _OverlayError = _interopRequireDefault(require("../errors/OverlayError.cjs"));
 /**
  * @public
  */
@@ -75,6 +75,6 @@ const applyOverlay = async (overlayURI, targetURI, options = {
   }
 
   // apply overlay actions to the target (returns targetParseResult with result replaced)
-  return (0, _apply.applyOverlayApiDOM)(overlayParseResult, targetParseResult, options);
+  return (0, _apidom.applyOverlay)(overlayParseResult, targetParseResult, options);
 };
 var _default = exports.default = applyOverlay;

package/src/{apply-uri.mjs → apply/uri.mjs}

@@ -1,8 +1,8 @@
 import { isParseResultElement } from '@speclynx/apidom-datamodel';
 import { isOverlay1Element } from '@speclynx/apidom-ns-overlay-1';
 import { parse, mergeOptions } from '@speclynx/apidom-reference';
-import { applyOverlayApiDOM } from "./apply.mjs";
-import OverlayError from "./errors/OverlayError.mjs";
+import { applyOverlay as applyOverlayApiDOM } from "./apidom.mjs";
+import OverlayError from "../errors/OverlayError.mjs";
 /**
  * @public
  */

package/src/index.cjs

@@ -2,13 +2,16 @@
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
-exports.validateAction = exports.default = exports.applyOverlayApiDOM = exports.applyAction = exports.OverlayError = void 0;
-var _apply = require("./apply.cjs");
-exports.applyAction = _apply.applyAction;
-exports.applyOverlayApiDOM = _apply.applyOverlayApiDOM;
+exports.validateAction = exports.applyOverlayPOJO = exports.applyOverlayApiDOM = exports.applyOverlay = exports.applyActionPOJO = exports.applyActionApiDOM = exports.OverlayError = void 0;
+var _apidom = require("./apply/apidom.cjs");
+exports.applyActionApiDOM = _apidom.applyAction;
+exports.applyOverlayApiDOM = _apidom.applyOverlay;
+var _uri = _interopRequireDefault(require("./apply/uri.cjs"));
+exports.applyOverlay = _uri.default;
+var _pojo = require("./apply/pojo.cjs");
+exports.applyActionPOJO = _pojo.applyAction;
+exports.applyOverlayPOJO = _pojo.applyOverlay;
 var _validate = require("./validate.cjs");
 exports.validateAction = _validate.validateAction;
 var _OverlayError = _interopRequireDefault(require("./errors/OverlayError.cjs"));
-exports.OverlayError = _OverlayError.default;
-var _applyUri = _interopRequireDefault(require("./apply-uri.cjs"));
-exports.default = _applyUri.default;
+exports.OverlayError = _OverlayError.default;

package/src/index.mjs

@@ -1,4 +1,5 @@
-export { applyAction, applyOverlayApiDOM } from "./apply.mjs";
+export { applyAction as applyActionApiDOM, applyOverlay as applyOverlayApiDOM } from "./apply/apidom.mjs";
+export { default as applyOverlay } from "./apply/uri.mjs";
+export { applyAction as applyActionPOJO, applyOverlay as applyOverlayPOJO } from "./apply/pojo.mjs";
 export { validateAction } from "./validate.mjs";
-export { default as OverlayError } from "./errors/OverlayError.mjs";
-export { default } from "./apply-uri.mjs";
+export { default as OverlayError } from "./errors/OverlayError.mjs";

package/types/apidom-overlay.d.ts

@@ -13,7 +13,14 @@ import { ParseResultElement } from '@speclynx/apidom-datamodel';
  *
  * @public
  */
-export declare const applyAction: (actionElement: ActionElement, targetElement: Element_2, options?: ApplyOptions) => Element_2;
+export declare const applyActionApiDOM: (actionElement: ActionElement, targetElement: Element_2, options?: ApplyOptions) => Element_2;
+
+/**
+ * Applies a single overlay action (POJO) to a target (POJO).
+ *
+ * @public
+ */
+export declare const applyActionPOJO: (action: Record<string, unknown>, target: Record<string, unknown>) => unknown;
 
 /**
  * @public
@@ -38,8 +45,7 @@ export declare interface ApplyOptions {
  *
  * @public
  */
-declare const applyOverlay: (overlayURI: string, targetURI?: string, options?: ApplyOverlayOptions) => Promise<ParseResultElement>;
-export default applyOverlay;
+export declare const applyOverlay: (overlayURI: string, targetURI?: string, options?: ApplyOverlayOptions) => Promise<ParseResultElement>;
 
 /**
  * Applies an entire overlay document to a target element.
@@ -55,6 +61,13 @@ export declare const applyOverlayApiDOM: <T extends Element_2 | ParseResultEleme
 export declare interface ApplyOverlayOptions extends Partial<ApiDOMReferenceOptions>, ApplyOptions {
 }
 
+/**
+ * Applies an entire overlay document (POJO) to a target (POJO).
+ *
+ * @public
+ */
+export declare const applyOverlayPOJO: (overlay: Record<string, unknown>, target: Record<string, unknown>) => unknown;
+
 /**
  * @public
  */