@ama-openapi/core 0.0.0-placeholder.9 → 13.5.0-prerelease.13

package/LICENSE

@@ -0,0 +1,26 @@
+Copyright Amadeus SAS
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation and/or
+other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+may be used to endorse or promote products derived from this software without
+specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,65 @@
+# @ama-openapi/core Documentation
+
+This package provides a **dependency management system for OpenAPI specifications** in JavaScript/TypeScript projects, enabling modular and reusable OpenAPI definitions.
+
+## Core Concept
+
+The system leverages **NPM's package resolution mechanism** to manage OpenAPI specification dependencies, allowing you to:
+
+- Install OpenAPI specs as NPM packages
+- Reference external models in your specifications
+- Apply transformations to imported models
+- Handle complex versioning and conflict resolution
+
+> [!NOTE]
+> Get complete information regarding the concept in the [Dependency Resolution Concept documentation](https://github.com/AmadeusITGroup/otter/tree/main/docs/openapi/DEPENDENCY_RESOLUTION_CONCEPT.md).
+
+## Key Workflow
+
+1. **Install Dependencies**: Add OpenAPI packages via `npm install @my/dep-spec` or create a new project thanks to the [project initializer](https://npmjs.com/package/@ama-openapi/create).
+2. **Configure Manifest**: Define which models to extract in `openapi.manifest.json` (or other) that can be defined following [manifest documentation](https://github.com/AmadeusITGroup/otter/tree/main/docs/openapi/MANIFEST_CONFIGURATION.md)
+3. **Extract Models**: Run the command `ama-openapi install` from [@ama-openapi/cli](https://npmjs.com/package/@ama-openapi/cli) to extract models into `models_external/` directory
+4. **Reference Models**: Use [extracted models](https://github.com/AmadeusITGroup/otter/tree/main/docs/openapi/EXTRACTED_MODEL_DETAILS.md) in your specification files
+5. **Bundle**: Use `redocly bundle` to create the final specification
+
+## Transformation Features
+
+Models can be transformed during extraction:
+
+- **rename**: Rename model files (e.g., `"myPrefix_$1"`)
+- **titleRename**: Rename model titles
+- **mask**: Filter/override/add properties using Stoplight mask syntax
+
+> [!NOTE]
+> Get complete documentation regarding the transformation features in [Transform documentation](https://github.com/AmadeusITGroup/otter/tree/main/docs/openapi/TRANSFORM.md)
+
+## Model Extraction Types
+
+According to if a mask is applied or not on the referred models, the extraction process will:
+
+- generates a simple redirect file with `$ref` pointing to `node_modules`
+- generates modified model with applied transformations and annotations (`x-internal-*` fields)
+
+A description of the extracted models is available on [extracted models documentation](https://github.com/AmadeusITGroup/otter/tree/main/docs/openapi/DEPENDENCY_RESOLUTION_CONCEPT.md).
+
+## Shareable Specifications
+
+To create a shareable specification:
+
+1. Create valid `package.json` with `name`, `version`, and `exports` field
+2. List external dependencies in `dependencies`
+3. Extract external models during `postinstall` lifecycle
+4. Publish to NPM registry
+
+> [!NOTE]
+> Complete documentation is available on [dedicated shaerable specification section](https://github.com/AmadeusITGroup/otter/tree/main/docs/openapi/SHAREABLE_SPECIFICATION.md).
+
+## Integration
+
+This package works in the **Ama OpenApi ecosystem** including:
+
+- [@ama-openapi/cli](https://npmjs.com/package/@ama-openapi/cli) - Manual dependency installation
+- [@ama-openapi/redocly-plugin](https://npmjs.com/package/@ama-openapi/redocly-plugin) - Redocly CLI integration
+- [@ama-openapi/create](https://npmjs.com/package/@ama-openapi/create) - Project scaffolding
+
+The package **@ama-openapi/core** exposed divers items to facilitate a manual setup in the [technical documentation](https://github.com/AmadeusITGroup/otter/tree/main/docs/openapi/TECHNICAL_INFORMATION.md).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ama-openapi/core",
-  "version": "0.0.0-placeholder.9",
+  "version": "13.5.0-prerelease.13",
   "type": "module",
   "publishConfig": {
     "access": "public"
@@ -40,7 +40,7 @@
   },
   "dependencies": {
     "ajv": "~8.17.1",
-    "js-yaml": "^4.1.0",
+    "js-yaml": "^4.1.1",
     "semver": "^7.5.2",
     "tslib": "^2.6.2"
   },
@@ -56,33 +56,33 @@
     "@babel/core": "~7.28.0",
     "@babel/preset-env": "~7.28.0",
     "@babel/preset-typescript": "~7.28.0",
-    "@compodoc/compodoc": "^1.1.19",
+    "@compodoc/compodoc": "^1.1.32",
     "@eslint-community/eslint-plugin-eslint-comments": "^4.4.0",
     "@nx/eslint": "~21.6.0",
     "@nx/eslint-plugin": "~21.6.0",
     "@nx/jest": "~21.6.0",
     "@nx/js": "~21.6.0",
-    "@o3r/build-helpers": "0.0.0-placeholder.9",
-    "@o3r/eslint-plugin": "0.0.0-placeholder.9",
-    "@o3r/telemetry": "0.0.0-placeholder.9",
-    "@o3r/test-helpers": "0.0.0-placeholder.9",
-    "@stylistic/eslint-plugin": "~5.5.0",
+    "@o3r/build-helpers": "~13.5.0-prerelease.13",
+    "@o3r/eslint-plugin": "~13.5.0-prerelease.13",
+    "@o3r/telemetry": "~13.5.0-prerelease.13",
+    "@o3r/test-helpers": "~13.5.0-prerelease.13",
+    "@stylistic/eslint-plugin": "~5.6.0",
     "@types/jest": "~29.5.2",
     "@types/js-yaml": "^4.0.5",
     "@types/minimist": "^1.2.2",
     "@types/node": "~22.18.0",
     "@types/semver": "^7.3.13",
-    "@typescript-eslint/parser": "~8.46.0",
-    "angular-eslint": "~20.5.0",
+    "@typescript-eslint/parser": "~8.47.0",
+    "angular-eslint": "~20.6.0",
     "babel-jest": "^29.7.0",
     "babel-plugin-transform-import-meta": "^2.0.0",
     "cpy-cli": "^6.0.0",
-    "eslint": "~9.38.0",
+    "eslint": "~9.39.0",
     "eslint-import-resolver-node": "~0.3.9",
     "eslint-import-resolver-typescript": "~4.4.0",
     "eslint-plugin-import": "~2.32.0",
     "eslint-plugin-import-newlines": "~1.4.0",
-    "eslint-plugin-jest": "~29.0.0",
+    "eslint-plugin-jest": "~29.1.0",
     "eslint-plugin-jsdoc": "~54.7.0",
     "eslint-plugin-prefer-arrow": "~1.2.3",
     "eslint-plugin-unicorn": "~60.0.0",
@@ -94,13 +94,81 @@
     "jest-util": "~29.7.0",
     "jsonc-eslint-parser": "~2.4.0",
     "nx": "~21.6.0",
-    "pid-from-port": "^1.1.3",
     "ts-jest": "~29.4.0",
     "type-fest": "^4.30.1",
     "typescript": "~5.9.2",
-    "typescript-eslint": "~8.46.0"
+    "typescript-eslint": "~8.47.0"
   },
   "engines": {
     "node": "^20.19.0 || ^22.17.0 || ^24.0.0"
-  }
-}
+  },
+  "contributors": [
+    {
+      "name": "Yannick Adam",
+      "url": "https://github.com/yannickadam",
+      "email": "yannickadam@users.noreply.github.com"
+    },
+    {
+      "name": "Kilian Panot",
+      "url": "https://github.com/kpanot",
+      "email": "kpanot@users.noreply.github.com"
+    },
+    {
+      "name": "Jeremy Bourgeois",
+      "url": "https://github.com/jbourgeois-1A",
+      "email": "jbourgeois-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Pierre Henri Ginoux",
+      "url": "https://github.com/pginoux-1A",
+      "email": "pginoux-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Mircea Vasile Rednic",
+      "url": "https://github.com/mrednic-1A",
+      "email": "mrednic-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Stephane Dalle",
+      "url": "https://github.com/sdalle-1A",
+      "email": "sdalle-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Nicolas Hoffmann",
+      "url": "https://github.com/nhoffmann-1A",
+      "email": "nhoffmann-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Victor Scaiceanu",
+      "url": "https://github.com/vscaiceanu-1a",
+      "email": "vscaiceanu-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Florian Paul",
+      "url": "https://github.com/fpaul-1A",
+      "email": "fpaul-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Corinne Paulve",
+      "url": "https://github.com/cpaulve-1A",
+      "email": "cpaulve-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Matthieu Crouzet",
+      "url": "https://github.com/matthieu-crouzet",
+      "email": "matthieu-crouzet@users.noreply.github.com"
+    },
+    {
+      "name": "Salome Do",
+      "url": "https://github.com/sdo-1A",
+      "email": "sdo-1A@users.noreply.github.com"
+    }
+  ],
+  "bugs": "https://github.com/AmadeusITGroup/otter/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AmadeusITGroup/otter.git"
+  },
+  "license": "BSD-3-Clause",
+  "homepage": "https://amadeusitgroup.github.io/otter/"
+}

package/schemas/manifest.schema.json

@@ -1,6 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "OpenApi specification package manifest",
+  "$id": "@ama-openapi/core/schemas/manifest.schema.json",
   "type": "object",
   "properties": {
     "models": {
@@ -19,39 +20,7 @@
     "transform": {
       "oneOf": [
         {
-          "type": "object",
-          "examples": [
-            {
-              "mask": { "data": true },
-              "fileRename": "MyPrefix_$1"
-            }
-          ],
-          "properties": {
-            "mask": {
-              "type": "object",
-              "description": "Mask to apply"
-            },
-            "titleRename": {
-              "type": "string",
-              "description": "Rename the model title. The keyword `$1` can be used to refer to original name (ex: a prefix would be `myPrefix_$1`)",
-              "examples": [
-                "myPrefix_$1",
-                "myModel"
-              ]
-            },
-            "fileRename": {
-              "type": "string",
-              "description": "Rename the outputted file. The keyword `$1` can be used to refer to original name (ex: a prefix would be `my-prefix-$1`)",
-              "examples": [
-                "my-prefix-$1",
-                "myModel.v1.yaml"
-              ]
-            }
-          },
-          "additionalProperties": false,
-          "required": [
-            "fileRename"
-          ]
+          "$ref": "./transform.schema.json"
         },
         {
           "type": "string",
@@ -67,7 +36,7 @@
           "path": "models/ExampleModel.v1.yaml",
           "transform": {
             "mask": { "properties": { "field": true } },
-            "fileRename": "MyPrefix_$1"
+            "rename": "MyPrefix_$1"
           }
         }
       ],
@@ -90,18 +59,7 @@
               "description": "Path to the specific model to include as is. The path is relative to the artifact root (e.g., 'models/ExampleModel.v1.yaml')"
             },
             "transform": {
-              "oneOf": [
-                {
-                  "$ref": "#/definitions/transform"
-                },
-                {
-                  "type": "array",
-                  "description": "List of transforms to apply in sequence. Each transform will result to a new model being created in the output.",
-                  "items": {
-                    "$ref": "#/definitions/transform"
-                  }
-                }
-              ]
+              "$ref": "#/definitions/transform"
             }
           },
           "required": [

package/schemas/transform.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "@ama-openapi/core/schemas/transform.schema.json",
+  "title": "OpenApi mask definition",
+  "type": "object",
+  "examples": [
+    {
+      "mask": {
+        "data": true
+      }
+    },
+    {
+      "rename": "MyPrefix_$1"
+    },
+    {
+      "mask": {
+        "data": true
+      },
+      "rename": "MyPrefix_$1"
+    }
+  ],
+  "properties": {
+    "mask": {
+      "type": "object",
+      "description": "Mask to apply"
+    },
+    "titleRename": {
+      "type": "string",
+      "description": "Rename the model title. The keyword `$1` can be used to refer to original name (ex: a prefix would be `myPrefix_$1`)",
+      "examples": [
+        "myPrefix_$1",
+        "myModel"
+      ]
+    },
+    "rename": {
+      "type": "string",
+      "description": "Rename the outputted file. The keyword `$1` can be used to refer to the original name (ex: a prefix would be `my-prefix-$1`)",
+      "examples": [
+        "my-prefix-$1",
+        "myModel.v1.yaml"
+      ]
+    }
+  },
+  "additionalProperties": false
+}

package/src/constants.d.mts

@@ -1,5 +1,6 @@
 /** Directory containing the extracted module */
 export declare const OUTPUT_DIRECTORY = "models_external";
+/** Directory containing masked model when the mask is applied to referenced models */
 export declare const SUB_MASK_DIRECTORY = "sub-masks";
 /** Default manifest filenames to look for */
 export declare const DEFAULT_MANIFEST_FILENAMES: readonly ["ama-openapi.manifest.json", "ama-openapi.manifest.yaml", "ama-openapi.manifest.yml", "openapi.manifest.json", "openapi.manifest.yaml", "openapi.manifest.yml", "package.json"];

package/src/constants.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.mts","sourceRoot":"","sources":["../../src/constants.mts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,eAAO,MAAM,gBAAgB,oBAAoB,CAAC;AAElD,eAAO,MAAM,kBAAkB,cAAc,CAAC;AAE9C,6CAA6C;AAC7C,eAAO,MAAM,0BAA0B,2LAQ7B,CAAC;AAIX,oCAAoC;AACpC,eAAO,MAAM,mBAAmB,sBAAsB,CAAC;AACvD,qCAAqC;AACrC,eAAO,MAAM,oBAAoB,uBAAuB,CAAC;AACzD,8EAA8E;AAC9E,eAAO,MAAM,mBAAmB,sBAAsB,CAAC;AACvD,+CAA+C;AAC/C,eAAO,MAAM,oBAAoB,uBAAuB,CAAC;AACzD,iDAAiD;AACjD,eAAO,MAAM,0BAA0B,mCAAmC,CAAC;AAC3E,gDAAgD;AAChD,eAAO,MAAM,0BAA0B,mCAAmC,CAAC"}
+{"version":3,"file":"constants.d.mts","sourceRoot":"","sources":["../../src/constants.mts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,eAAO,MAAM,gBAAgB,oBAAoB,CAAC;AAElD,sFAAsF;AACtF,eAAO,MAAM,kBAAkB,cAAc,CAAC;AAE9C,6CAA6C;AAC7C,eAAO,MAAM,0BAA0B,2LAQ7B,CAAC;AAIX,oCAAoC;AACpC,eAAO,MAAM,mBAAmB,sBAAsB,CAAC;AACvD,qCAAqC;AACrC,eAAO,MAAM,oBAAoB,uBAAuB,CAAC;AACzD,8EAA8E;AAC9E,eAAO,MAAM,mBAAmB,sBAAsB,CAAC;AACvD,+CAA+C;AAC/C,eAAO,MAAM,oBAAoB,uBAAuB,CAAC;AACzD,iDAAiD;AACjD,eAAO,MAAM,0BAA0B,mCAAmC,CAAC;AAC3E,gDAAgD;AAChD,eAAO,MAAM,0BAA0B,mCAAmC,CAAC"}

package/src/constants.mjs

@@ -1,5 +1,6 @@
 /** Directory containing the extracted module */
 export const OUTPUT_DIRECTORY = 'models_external';
+/** Directory containing masked model when the mask is applied to referenced models */
 export const SUB_MASK_DIRECTORY = 'sub-masks';
 /** Default manifest filenames to look for */
 export const DEFAULT_MANIFEST_FILENAMES = [

package/src/constants.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"constants.mjs","sourceRoot":"","sources":["../../src/constants.mts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,MAAM,CAAC,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AAElD,MAAM,CAAC,MAAM,kBAAkB,GAAG,WAAW,CAAC;AAE9C,6CAA6C;AAC7C,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,2BAA2B;IAC3B,2BAA2B;IAC3B,0BAA0B;IAC1B,uBAAuB;IACvB,uBAAuB;IACvB,sBAAsB;IACtB,cAAc;CACN,CAAC;AAEX,2BAA2B;AAE3B,oCAAoC;AACpC,MAAM,CAAC,MAAM,mBAAmB,GAAG,mBAAmB,CAAC;AACvD,qCAAqC;AACrC,MAAM,CAAC,MAAM,oBAAoB,GAAG,oBAAoB,CAAC;AACzD,8EAA8E;AAC9E,MAAM,CAAC,MAAM,mBAAmB,GAAG,mBAAmB,CAAC;AACvD,+CAA+C;AAC/C,MAAM,CAAC,MAAM,oBAAoB,GAAG,oBAAoB,CAAC;AACzD,iDAAiD;AACjD,MAAM,CAAC,MAAM,0BAA0B,GAAG,gCAAgC,CAAC;AAC3E,gDAAgD;AAChD,MAAM,CAAC,MAAM,0BAA0B,GAAG,gCAAgC,CAAC"}
+{"version":3,"file":"constants.mjs","sourceRoot":"","sources":["../../src/constants.mts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,MAAM,CAAC,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AAElD,sFAAsF;AACtF,MAAM,CAAC,MAAM,kBAAkB,GAAG,WAAW,CAAC;AAE9C,6CAA6C;AAC7C,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,2BAA2B;IAC3B,2BAA2B;IAC3B,0BAA0B;IAC1B,uBAAuB;IACvB,uBAAuB;IACvB,sBAAsB;IACtB,cAAc;CACN,CAAC;AAEX,2BAA2B;AAE3B,oCAAoC;AACpC,MAAM,CAAC,MAAM,mBAAmB,GAAG,mBAAmB,CAAC;AACvD,qCAAqC;AACrC,MAAM,CAAC,MAAM,oBAAoB,GAAG,oBAAoB,CAAC;AACzD,8EAA8E;AAC9E,MAAM,CAAC,MAAM,mBAAmB,GAAG,mBAAmB,CAAC;AACvD,+CAA+C;AAC/C,MAAM,CAAC,MAAM,oBAAoB,GAAG,oBAAoB,CAAC;AACzD,iDAAiD;AACjD,MAAM,CAAC,MAAM,0BAA0B,GAAG,gCAAgC,CAAC;AAC3E,gDAAgD;AAChD,MAAM,CAAC,MAAM,0BAA0B,GAAG,gCAAgC,CAAC"}

package/src/context.d.mts

@@ -1,6 +1,6 @@
 import type { Logger } from './logger.mjs';
 /**
- * Context interface for AMA OpenAPI processing
+ * Context interface for Ama OpenAPI processing
  */
 export interface Context {
     /** Current working directory */

package/src/core/file-system/parse-file.d.mts

@@ -1,10 +1,10 @@
 /**
- * Check if the file is a JSON file
+ * Parse a file content based on its extension
  * @param filePath
  */
 export declare const isJsonFile: (filePath: string) => boolean;
 /**
- *n Parse a file content based on its extension
+ * Parse a file content based on its extension
  * @param filePath
  */
 export declare const parseFile: <S>(filePath: string) => Promise<S>;

package/src/core/file-system/parse-file.mjs

@@ -1,14 +1,14 @@
 import { promises as fs, } from 'node:fs';
 import { load, } from 'js-yaml';
 /**
- * Check if the file is a JSON file
+ * Parse a file content based on its extension
  * @param filePath
  */
 export const isJsonFile = (filePath) => {
     return filePath.toLowerCase().endsWith('.json');
 };
 /**
- *n Parse a file content based on its extension
+ * Parse a file content based on its extension
  * @param filePath
  */
 export const parseFile = async (filePath) => {

package/src/core/file-system/relative-path.d.mts

@@ -0,0 +1,6 @@
+/**
+ *  Determine if a path is relative
+ * @param path
+ */
+export declare const isRelativePath: (path: string) => boolean;
+//# sourceMappingURL=relative-path.d.mts.map

package/src/core/file-system/relative-path.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relative-path.d.mts","sourceRoot":"","sources":["../../../../src/core/file-system/relative-path.mts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,MAAM,MAAM,KAAG,OAE7C,CAAC"}

package/src/core/file-system/relative-path.mjs

@@ -0,0 +1,9 @@
+import { isAbsolute, } from 'node:path/posix';
+/**
+ *  Determine if a path is relative
+ * @param path
+ */
+export const isRelativePath = (path) => {
+    return !URL.canParse(path) && !isAbsolute(path);
+};
+//# sourceMappingURL=relative-path.mjs.map

package/src/core/file-system/relative-path.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"relative-path.mjs","sourceRoot":"","sources":["../../../../src/core/file-system/relative-path.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,GACX,MAAM,iBAAiB,CAAC;AAEzB;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAY,EAAW,EAAE;IACtD,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AAClD,CAAC,CAAC"}

package/src/core/file-system/write-model.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"write-model.d.mts","sourceRoot":"","sources":["../../../../src/core/file-system/write-model.mts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACV,OAAO,EACR,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EACV,wBAAwB,EACzB,MAAM,2CAA2C,CAAC;AAEnD;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAU,gBAAgB,wBAAwB,EAAE,SAAS,OAAO,kBAY9F,CAAC"}
+{"version":3,"file":"write-model.d.mts","sourceRoot":"","sources":["../../../../src/core/file-system/write-model.mts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EACV,OAAO,EACR,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EACV,wBAAwB,EACzB,MAAM,2CAA2C,CAAC;AAEnD;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAU,gBAAgB,wBAAwB,EAAE,SAAS,OAAO,kBAiB9F,CAAC"}

package/src/core/file-system/write-model.mjs

@@ -1,4 +1,5 @@
-import { promises as fs, } from 'node:fs';
+import { existsSync, promises as fs, } from 'node:fs';
+import { EOL, } from 'node:os';
 import { dirname, } from 'node:path';
 /**
  * Write the model file in the dependencies folder.
@@ -16,6 +17,10 @@ export const writeModelFile = async (retrievedModel, context) => {
     catch {
         logger?.debug?.(`Directory ${directory} may already exist, continuing...`);
     }
+    if (existsSync(outputFilePath)) {
+        logger?.warn(`The file ${outputFilePath} already exist and will be replaced.`
+            + `${EOL}This may be due to a previous model extraction, please verify or apply a "rename" value to the associated Transform.`);
+    }
     await fs.writeFile(outputFilePath, content, { encoding: 'utf8' });
 };
 //# sourceMappingURL=write-model.mjs.map

package/src/core/file-system/write-model.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"write-model.mjs","sourceRoot":"","sources":["../../../../src/core/file-system/write-model.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,IAAI,EAAE,GACf,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,OAAO,GACR,MAAM,WAAW,CAAC;AAQnB;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAAE,cAAwC,EAAE,OAAgB,EAAE,EAAE;IACjG,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,cAAc,CAAC;IACnD,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAC3B,MAAM,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC1C,IAAI,CAAC;QACH,MAAM,EAAE,KAAK,EAAE,CAAC,wCAAwC,SAAS,EAAE,CAAC,CAAC;QACrE,MAAM,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,EAAE,KAAK,EAAE,CAAC,aAAa,SAAS,mCAAmC,CAAC,CAAC;IAC7E,CAAC;IAED,MAAM,EAAE,CAAC,SAAS,CAAC,cAAc,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;AACpE,CAAC,CAAC"}
+{"version":3,"file":"write-model.mjs","sourceRoot":"","sources":["../../../../src/core/file-system/write-model.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,QAAQ,IAAI,EAAE,GACf,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,GAAG,GACJ,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,OAAO,GACR,MAAM,WAAW,CAAC;AAQnB;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAAE,cAAwC,EAAE,OAAgB,EAAE,EAAE;IACjG,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,cAAc,CAAC;IACnD,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAC3B,MAAM,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC1C,IAAI,CAAC;QACH,MAAM,EAAE,KAAK,EAAE,CAAC,wCAAwC,SAAS,EAAE,CAAC,CAAC;QACrE,MAAM,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,EAAE,KAAK,EAAE,CAAC,aAAa,SAAS,mCAAmC,CAAC,CAAC;IAC7E,CAAC;IAED,IAAI,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;QAC/B,MAAM,EAAE,IAAI,CAAC,YAAY,cAAc,sCAAsC;cACzE,GAAG,GAAG,sHAAsH,CAAC,CAAC;IACpI,CAAC;IAED,MAAM,EAAE,CAAC,SAAS,CAAC,cAAc,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;AACpE,CAAC,CAAC"}

package/src/core/manifest/extract-dependency-models.d.mts

@@ -13,9 +13,7 @@ export interface RetrievedDependencyModel {
     /** Content of the model file */
     content: string;
     /** Model definition from the manifest */
-    model: Model & {
-        path: string;
-    };
+    model: Model & Required<Pick<Model, 'path'>>;
     /** Indicates if the input model file is a JSON file */
     isInputJson: boolean;
     /** Indicates if the output model file is a JSON file */

package/src/core/manifest/extract-dependency-models.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"extract-dependency-models.d.mts","sourceRoot":"","sources":["../../../../src/core/manifest/extract-dependency-models.mts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,EACV,OAAO,EACR,MAAM,mBAAmB,CAAC;AAO3B,OAAO,KAAK,EACV,QAAQ,EACR,KAAK,EACL,SAAS,EACV,MAAM,gBAAgB,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,2BAA2B;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,yCAAyC;IACzC,KAAK,EAAE,KAAK,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAChC,uDAAuD;IACvD,WAAW,EAAE,OAAO,CAAC;IACrB,wDAAwD;IACxD,YAAY,EAAE,OAAO,CAAC;IACtB,gDAAgD;IAChD,gBAAgB,EAAE,MAAM,CAAC;IACzB,yDAAyD;IACzD,cAAc,EAAE,MAAM,CAAC;IACvB,oBAAoB;IACpB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAoED;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B,GACxC,cAAc,MAAM,EACpB,OAAO,KAAK,EACZ,kBAAkB,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,EAChD,SAAS,OAAO,EAChB,wBAAkC,KAAG,OAAO,CAAC,wBAAwB,CA8BtE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,GAAI,UAAU,QAAQ,EAAE,SAAS,OAAO,wCAa3E,CAAC"}
+{"version":3,"file":"extract-dependency-models.d.mts","sourceRoot":"","sources":["../../../../src/core/manifest/extract-dependency-models.mts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EACV,OAAO,EACR,MAAM,mBAAmB,CAAC;AAQ3B,OAAO,KAAK,EACV,QAAQ,EACR,KAAK,EACL,SAAS,EACV,MAAM,gBAAgB,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,2BAA2B;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,yCAAyC;IACzC,KAAK,EAAE,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IAC7C,uDAAuD;IACvD,WAAW,EAAE,OAAO,CAAC;IACrB,wDAAwD;IACxD,YAAY,EAAE,OAAO,CAAC;IACtB,gDAAgD;IAChD,gBAAgB,EAAE,MAAM,CAAC;IACzB,yDAAyD;IACzD,cAAc,EAAE,MAAM,CAAC;IACvB,oBAAoB;IACpB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAgGD;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B,GACxC,cAAc,MAAM,EACpB,OAAO,KAAK,EACZ,kBAAkB,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,EAChD,SAAS,OAAO,EAChB,wBAAkC,KAAG,OAAO,CAAC,wBAAwB,CA8BtE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,GAAI,UAAU,QAAQ,EAAE,SAAS,OAAO,wCAU3E,CAAC"}

package/src/core/manifest/extract-dependency-models.mjs

@@ -1,9 +1,8 @@
 import { promises as fs, } from 'node:fs';
 import { createRequire, } from 'node:module';
 import { basename, dirname, extname, join, resolve, } from 'node:path';
-import { load, } from 'js-yaml';
 import { OUTPUT_DIRECTORY, } from '../../constants.mjs';
-import { isJsonFile, } from '../file-system/parse-file.mjs';
+import { isJsonFile, parseFile, } from '../file-system/parse-file.mjs';
 /**
  * Sanitize the package path to be used in file system
  * @param artifactName
@@ -13,6 +12,23 @@ const sanitizePackagePath = (artifactName) => {
         .replace('/', '-')
         .replace(/^@/, '');
 };
+/**
+ * Get the path to the file containing the model
+ * @param modelPath
+ */
+const getFilePathFromModelPath = (modelPath) => {
+    return modelPath.replace(/#[\\/].+$/, '');
+};
+/**
+ * Get the file name resulting of a model path
+ * @param modelPath
+ */
+const getOutFilePathFromModelPath = (modelPath) => {
+    const match = modelPath.match(/^(.*)#[\\/](.+)?$/);
+    return match
+        ? join(dirname(match[1]), match[2] + extname(match[1]))
+        : modelPath;
+};
 /**
  * Retrieve the transform object from the manifest
  * @param cwd
@@ -21,13 +37,22 @@ const sanitizePackagePath = (artifactName) => {
 const retrieveTransform = async (cwd, transform) => {
     if (typeof transform === 'string') {
         const transformPath = resolve(cwd, transform);
-        const fileContent = await fs.readFile(transformPath, { encoding: 'utf8' });
-        return extname(transformPath).toLowerCase() === '.json'
-            ? JSON.parse(fileContent)
-            : load(fileContent);
+        return parseFile(transformPath);
     }
     return transform;
 };
+/**
+ * Get information for artifactory manifest file
+ * @param require
+ * @param artifactName
+ */
+const getArtifactInfo = async (require, artifactName) => {
+    const artifactPackageJson = require.resolve(`${artifactName}/package.json`);
+    const artifactBasePath = dirname(artifactPackageJson);
+    const packageJsonContent = await fs.readFile(artifactPackageJson, { encoding: 'utf8' });
+    const version = JSON.parse(packageJsonContent).version || 'latest';
+    return { artifactBasePath, version };
+};
 /**
  * Extract dependency model given simple model definition (as string or boolean)
  * @param cwd
@@ -39,14 +64,13 @@ const retrieveTransform = async (cwd, transform) => {
 const extractDependencyModelsSimple = async (cwd, artifactName, modelName, logger, outputDirectory = OUTPUT_DIRECTORY) => {
     logger?.debug?.(`extracting model ${modelName} from ${outputDirectory}`);
     const require = createRequire(resolve(cwd, 'package.json'));
-    const artifactPackageJson = require.resolve(`${artifactName}/package.json`);
-    const artifactBasePath = dirname(artifactPackageJson);
+    const { artifactBasePath, version } = await getArtifactInfo(require, artifactName);
     const modelPath = typeof modelName === 'string' ? join(artifactBasePath, modelName) : require.resolve(artifactName);
-    const version = await fs.readFile(artifactPackageJson, { encoding: 'utf8' }).then((data) => JSON.parse(data).version || 'latest');
-    const content = await fs.readFile(modelPath, { encoding: 'utf8' });
+    const content = await fs.readFile(getFilePathFromModelPath(modelPath), { encoding: 'utf8' });
     const path = typeof modelName === 'string' ? modelName : artifactName;
     const model = { path };
-    const outputFilePath = resolve(cwd, outputDirectory, sanitizePackagePath(artifactName), model.path);
+    const fileNameOutput = getOutFilePathFromModelPath(model.path);
+    const outputFilePath = resolve(cwd, outputDirectory, sanitizePackagePath(artifactName), fileNameOutput);
     return {
         outputFilePath,
         artifactBasePath,
@@ -73,15 +97,15 @@ export const extractDependencyModelsObject = async (artifactName, model, transfo
     const { cwd, logger } = context;
     const require = createRequire(resolve(cwd, 'package.json'));
     const transform = await transformPromise;
-    const artifactPackageJson = require.resolve(`${artifactName}/package.json`);
-    const artifactBasePath = dirname(artifactPackageJson);
+    const { artifactBasePath, version } = await getArtifactInfo(require, artifactName);
     const modelPath = model.path ? join(artifactBasePath, model.path) : require.resolve(artifactName);
-    const version = await fs.readFile(artifactPackageJson, { encoding: 'utf8' }).then((data) => JSON.parse(data).version || 'latest');
-    const content = await fs.readFile(modelPath, { encoding: 'utf8' });
+    const content = await fs.readFile(getFilePathFromModelPath(modelPath), { encoding: 'utf8' });
     logger?.debug?.(`extracting model ${modelPath} from ${outputDirectory}`);
     const path = model.path || require.resolve(artifactName).split(artifactName)[1];
-    const replaceName = transform?.fileRename && path.replace(new RegExp(`(${basename(path).replaceAll('.', '\\.')})$`), transform.fileRename);
-    const fileNameOutput = replaceName || path;
+    const fileName = getFilePathFromModelPath(path);
+    const fileNameOutput = transform?.rename
+        ? fileName.replace(new RegExp(`(${basename(fileName).replaceAll('.', '\\.')})$`), transform.rename)
+        : getOutFilePathFromModelPath(path);
     const outputFilePath = resolve(cwd, outputDirectory, sanitizePackagePath(artifactName), fileNameOutput);
     return {
         transform,
@@ -108,14 +132,9 @@ export const extractDependencyModels = (manifest, context) => {
     const { logger, cwd } = context;
     logger?.info(`${Object.keys(manifest.models).length} dependencies models found in the manifest`);
     logger?.debug?.('Extracting information from the manifest configuration: ', manifest);
-    return Object.entries(manifest.models).flatMap(([dependencyName, modelDefinition]) => {
-        const models = Array.isArray(modelDefinition) ? modelDefinition : [modelDefinition];
-        return models
-            .flatMap((model) => typeof model === 'string' || typeof model === 'boolean'
-            ? [extractDependencyModelsSimple(cwd, dependencyName, model, logger)]
-            : (Array.isArray(model.transform)
-                ? (model.transform.length > 0 ? model.transform : [undefined]).map((transform) => extractDependencyModelsObject(dependencyName, model, retrieveTransform(cwd, transform), context))
-                : [extractDependencyModelsObject(dependencyName, model, retrieveTransform(cwd, model.transform), context)]));
-    });
+    return Object.entries(manifest.models).flatMap(([dependencyName, modelDefinition]) => (Array.isArray(modelDefinition) ? modelDefinition : [modelDefinition])
+        .map((model) => (typeof model === 'string' || typeof model === 'boolean')
+        ? extractDependencyModelsSimple(cwd, dependencyName, model, logger)
+        : extractDependencyModelsObject(dependencyName, model, retrieveTransform(cwd, model.transform), context)));
 };
 //# sourceMappingURL=extract-dependency-models.mjs.map