@ama-openapi/redocly-plugin 0.0.0-placeholder

package/package.json

@@ -0,0 +1,98 @@
+{
+  "name": "@ama-openapi/redocly-plugin",
+  "version": "0.0.0-placeholder",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Redocly plugins library to manage OpenAPI models",
+  "keywords": [
+    "otter",
+    "otter-module",
+    "openapi",
+    "redocly"
+  ],
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "module": "./src/public_api.mjs",
+      "typings": "./src/public_api.d.mts",
+      "default": "./src/public_api.mjs"
+    }
+  },
+  "scripts": {
+    "nx": "nx",
+    "ng": "yarn nx",
+    "build:source": "tsc -b tsconfig.build.json && yarn cpy package.json dist/",
+    "build": "yarn nx build ama-openapi-redocly",
+    "postbuild": "patch-package-json-main"
+  },
+  "dependencies": {
+    "@ama-openapi/core": "workspace:~",
+    "dotenv": "~17.2.3",
+    "tslib": "^2.6.2",
+    "yargs": "~18.0.0"
+  },
+  "peerDependencies": {
+    "@o3r/telemetry": "workspace:~",
+    "@redocly/openapi-core": "^2.8.0"
+  },
+  "peerDependenciesMeta": {
+    "@o3r/telemetry": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@babel/core": "~7.28.0",
+    "@babel/preset-env": "~7.28.0",
+    "@babel/preset-typescript": "~7.28.0",
+    "@compodoc/compodoc": "^1.1.19",
+    "@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": "workspace:~",
+    "@o3r/eslint-plugin": "workspace:~",
+    "@o3r/telemetry": "workspace:~",
+    "@o3r/test-helpers": "workspace:~",
+    "@redocly/openapi-core": "~2.8.0",
+    "@stylistic/eslint-plugin": "~5.5.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",
+    "@types/yargs": "~17.0.33",
+    "@typescript-eslint/parser": "~8.46.0",
+    "angular-eslint": "~20.4.0",
+    "babel-jest": "^29.7.0",
+    "cpy-cli": "^6.0.0",
+    "eslint": "~9.38.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-jsdoc": "~54.7.0",
+    "eslint-plugin-prefer-arrow": "~1.2.3",
+    "eslint-plugin-unicorn": "~60.0.0",
+    "eslint-plugin-unused-imports": "~4.3.0",
+    "globals": "^16.0.0",
+    "jest": "~29.7.0",
+    "jest-junit": "~16.0.0",
+    "jest-resolve": "~29.7.0",
+    "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",
+    "typescript": "~5.9.2",
+    "typescript-eslint": "~8.46.0"
+  },
+  "engines": {
+    "node": "^20.19.0 || ^22.17.0 || ^24.0.0"
+  }
+}

package/src/constants.d.mts

@@ -0,0 +1,3 @@
+/** Prefix for environment variables used by ama-openapi Redocly plugin */
+export declare const ENVIRONMENT_VARIABLE_PREFIX = "AMA_OPENAPI_REDOCLY";
+//# sourceMappingURL=constants.d.mts.map

package/src/constants.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.mts","sourceRoot":"","sources":["../../src/constants.mts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,eAAO,MAAM,2BAA2B,wBAAwB,CAAC"}

package/src/constants.mjs

@@ -0,0 +1,3 @@
+/** Prefix for environment variables used by ama-openapi Redocly plugin */
+export const ENVIRONMENT_VARIABLE_PREFIX = 'AMA_OPENAPI_REDOCLY';
+//# sourceMappingURL=constants.mjs.map

package/src/constants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.mjs","sourceRoot":"","sources":["../../src/constants.mts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,MAAM,CAAC,MAAM,2BAA2B,GAAG,qBAAqB,CAAC"}

package/src/logger.d.mts

@@ -0,0 +1,26 @@
+import type { Logger } from '@ama-openapi/core';
+import type { LocationObject, RuleSeverity } from '@redocly/openapi-core';
+/** Duplicate of Problem not exposed by @redocly/openapi-core */
+type Problem = {
+    message: string;
+    suggest?: string[];
+    location?: Partial<LocationObject> | Partial<LocationObject>[];
+    from?: LocationObject;
+    forceSeverity?: RuleSeverity;
+    ruleId?: string;
+};
+/** Log levels for logger */
+export type LogLevel = 'silent' | 'error' | 'warn' | 'info' | 'debug';
+/**
+ * Create a Logger from a report function
+ * @param report
+ */
+export declare const getLoggerFromReport: (report: (problem: Problem) => void) => Logger;
+/**
+ * Get a logger with the specified log level
+ * @param level
+ * @param logger
+ */
+export declare const getLogger: (level?: LogLevel, logger?: Logger) => Logger;
+export {};
+//# sourceMappingURL=logger.d.mts.map

package/src/logger.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.mts","sourceRoot":"","sources":["../../src/logger.mts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,MAAM,EACP,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EACV,cAAc,EACd,YAAY,EACb,MAAM,uBAAuB,CAAC;AAE/B,gEAAgE;AAChE,KAAK,OAAO,GAAG;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;IAC/D,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,aAAa,CAAC,EAAE,YAAY,CAAC;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAIF,4BAA4B;AAC5B,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEtE;;;GAGG;AACH,eAAO,MAAM,mBAAmB,GAAI,QAAQ,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,KAAG,MAMvE,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,SAAS,GAAI,QAAQ,QAAQ,EAAE,SAAQ,MAAgB,WAqBnE,CAAC"}

package/src/logger.mjs

@@ -0,0 +1,41 @@
+import { EOL, } from 'node:os';
+const noop = () => { };
+/**
+ * Create a Logger from a report function
+ * @param report
+ */
+export const getLoggerFromReport = (report) => ({
+    error: (...messages) => report({ forceSeverity: 'error', message: messages.map((msg) => JSON.stringify(msg)).join(EOL) }),
+    warn: (...messages) => report({ forceSeverity: 'warn', message: messages.map((msg) => JSON.stringify(msg)).join(EOL) }),
+    info: (...messages) => report({ message: messages.map((msg) => JSON.stringify(msg)).join(EOL) }),
+    debug: (...messages) => report({ message: messages.map((msg) => JSON.stringify(msg)).join(EOL) }),
+    log: (...messages) => report({ message: messages.map((msg) => JSON.stringify(msg)).join(EOL) })
+});
+/**
+ * Get a logger with the specified log level
+ * @param level
+ * @param logger
+ */
+export const getLogger = (level, logger = console) => {
+    if (level) {
+        switch (level) {
+            case 'silent': {
+                logger = { ...logger, error: noop };
+            }
+            // eslint-disable-next-line no-fallthrough -- done on purpose to disable multiple levels
+            case 'error': {
+                logger = { ...logger, warn: noop };
+            }
+            // eslint-disable-next-line no-fallthrough -- done on purpose to disable multiple levels
+            case 'warn': {
+                logger = { ...logger, info: noop };
+            }
+            // eslint-disable-next-line no-fallthrough -- done on purpose to disable multiple levels
+            case 'info': {
+                logger = { ...logger, debug: noop };
+            }
+        }
+    }
+    return logger;
+};
+//# sourceMappingURL=logger.mjs.map

package/src/logger.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.mjs","sourceRoot":"","sources":["../../src/logger.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,GAAG,GACJ,MAAM,SAAS,CAAC;AAmBjB,MAAM,IAAI,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;AAKtB;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAAkC,EAAU,EAAE,CAAC,CAAC;IAClF,KAAK,EAAE,CAAC,GAAG,QAAe,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IAChI,IAAI,EAAE,CAAC,GAAG,QAAe,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IAC9H,IAAI,EAAE,CAAC,GAAG,QAAe,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IACvG,KAAK,EAAE,CAAC,GAAG,QAAe,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IACxG,GAAG,EAAE,CAAC,GAAG,QAAe,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;CACvG,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAgB,EAAE,SAAiB,OAAO,EAAE,EAAE;IACtE,IAAI,KAAK,EAAE,CAAC;QACV,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;YACtC,CAAC;YACD,wFAAwF;YACxF,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YACrC,CAAC;YACD,wFAAwF;YACxF,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YACrC,CAAC;YACD,wFAAwF;YACxF,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;YACtC,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/src/plugin.d.mts

@@ -0,0 +1,13 @@
+import { type InstallDependenciesOptions } from '@ama-openapi/core';
+import { Plugin } from '@redocly/openapi-core';
+/** Options for ama-openapi plugin */
+export interface AmaOpenapiPluginOptions extends InstallDependenciesOptions {
+    /** Skip the download of dependency */
+    skipDependencyDownload?: boolean;
+}
+/**
+ * Ama OpenAPI Redocly Plugin
+ * @param options
+ */
+export declare const amaOpenapiPlugin: (options?: AmaOpenapiPluginOptions) => Promise<Plugin>;
+//# sourceMappingURL=plugin.d.mts.map

package/src/plugin.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.mts","sourceRoot":"","sources":["../../src/plugin.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,0BAA0B,EAChC,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,MAAM,EACP,MAAM,uBAAuB,CAAC;AAW/B,qCAAqC;AACrC,MAAM,WAAW,uBAAwB,SAAQ,0BAA0B;IACzE,sCAAsC;IACtC,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAU,UAAU,uBAAuB,KAAG,OAAO,CAAC,MAAM,CAaxF,CAAC"}

package/src/plugin.mjs

@@ -0,0 +1,19 @@
+import { config, } from 'dotenv';
+import { ENVIRONMENT_VARIABLE_PREFIX, } from './constants.mjs';
+import { retrieveDependency, } from './plugins/meta/retrieve-dependency.meta.mjs';
+/**
+ * Ama OpenAPI Redocly Plugin
+ * @param options
+ */
+export const amaOpenapiPlugin = async (options) => {
+    config({ override: true });
+    options = {
+        skipDependencyDownload: !!process.env[`${ENVIRONMENT_VARIABLE_PREFIX}_SKIP_DOWNLOAD`],
+        ...options
+    };
+    await retrieveDependency(options);
+    return {
+        id: 'ama-openapi'
+    };
+};
+//# sourceMappingURL=plugin.mjs.map

package/src/plugin.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.mjs","sourceRoot":"","sources":["../../src/plugin.mts"],"names":[],"mappings":"AAMA,OAAO,EACL,MAAM,GACP,MAAM,QAAQ,CAAC;AAChB,OAAO,EACL,2BAA2B,GAC5B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,kBAAkB,GACnB,MAAM,6CAA6C,CAAC;AAQrD;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,EAAE,OAAiC,EAAmB,EAAE;IAC3F,MAAM,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IAE3B,OAAO,GAAG;QACR,sBAAsB,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,2BAA2B,gBAAgB,CAAC;QACrF,GAAG,OAAO;KACX,CAAC;IAEF,MAAM,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAElC,OAAO;QACL,EAAE,EAAE,aAAa;KAClB,CAAC;AACJ,CAAC,CAAC"}

package/src/plugins/meta/retrieve-dependency.meta.d.mts

@@ -0,0 +1,17 @@
+import { type InstallDependenciesOptions } from '@ama-openapi/core';
+import { type LogLevel } from '../../logger.mjs';
+export interface RetrieveDependencyOptions extends InstallDependenciesOptions {
+    /**
+     * Define the logging level
+     * @default 'error'
+     */
+    logLevel?: LogLevel;
+    /** Continue on dependency download failure */
+    noBail?: boolean;
+}
+/**
+ * Retrieve dependencies according to manifest files
+ * @param options
+ */
+export declare const retrieveDependency: (options?: RetrieveDependencyOptions) => Promise<void>;
+//# sourceMappingURL=retrieve-dependency.meta.d.mts.map

package/src/plugins/meta/retrieve-dependency.meta.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retrieve-dependency.meta.d.mts","sourceRoot":"","sources":["../../../../src/plugins/meta/retrieve-dependency.meta.mts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,0BAA0B,EAChC,MAAM,mBAAmB,CAAC;AAI3B,OAAO,EAEL,KAAK,QAAQ,EACd,MAAM,kBAAkB,CAAC;AAE1B,MAAM,WAAW,yBAA0B,SAAQ,0BAA0B;IAC3E;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB,8CAA8C;IAC9C,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAMD;;;GAGG;AACH,eAAO,MAAM,kBAAkB,GAAU,UAAU,yBAAyB,kBAiB3E,CAAC"}

package/src/plugins/meta/retrieve-dependency.meta.mjs

@@ -0,0 +1,30 @@
+import { installDependencies, } from '@ama-openapi/core';
+import { ENVIRONMENT_VARIABLE_PREFIX, } from '../../constants.mjs';
+import { getLogger, } from '../../logger.mjs';
+const DEFAULT_OPTIONS = {
+    logLevel: 'error'
+};
+/**
+ * Retrieve dependencies according to manifest files
+ * @param options
+ */
+export const retrieveDependency = async (options) => {
+    options = {
+        ...DEFAULT_OPTIONS,
+        noBail: !!process.env[`${ENVIRONMENT_VARIABLE_PREFIX}_NO_BAIL`],
+        ...options
+    };
+    const logger = getLogger(options?.logLevel || DEFAULT_OPTIONS.logLevel, options?.logger);
+    try {
+        await installDependencies(process.cwd(), { ...options, logger });
+    }
+    catch (e) {
+        if (options?.noBail) {
+            logger?.error(e);
+        }
+        else {
+            throw e;
+        }
+    }
+};
+//# sourceMappingURL=retrieve-dependency.meta.mjs.map

package/src/plugins/meta/retrieve-dependency.meta.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"retrieve-dependency.meta.mjs","sourceRoot":"","sources":["../../../../src/plugins/meta/retrieve-dependency.meta.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,GAEpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,2BAA2B,GAC5B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,SAAS,GAEV,MAAM,kBAAkB,CAAC;AAa1B,MAAM,eAAe,GAA8B;IACjD,QAAQ,EAAE,OAAO;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,EAAE,OAAmC,EAAE,EAAE;IAC9E,OAAO,GAAG;QACR,GAAG,eAAe;QAClB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,2BAA2B,UAAU,CAAC;QAC/D,GAAG,OAAO;KACX,CAAC;IACF,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,EAAE,QAAQ,IAAI,eAAe,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAEzF,IAAI,CAAC;QACH,MAAM,mBAAmB,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IACnE,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;AACH,CAAC,CAAC"}

package/src/public_api.d.mts

@@ -0,0 +1,3 @@
+export * from './plugin.mjs';
+export { amaOpenapiPlugin as default } from './plugin.mjs';
+//# sourceMappingURL=public_api.d.mts.map

package/src/public_api.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"public_api.d.mts","sourceRoot":"","sources":["../../src/public_api.mts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAE7B,OAAO,EAAE,gBAAgB,IAAI,OAAO,EAAE,MAAM,cAAc,CAAC"}

package/src/public_api.mjs

@@ -0,0 +1,3 @@
+export * from './plugin.mjs';
+export { amaOpenapiPlugin as default } from './plugin.mjs';
+//# sourceMappingURL=public_api.mjs.map

package/src/public_api.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"public_api.mjs","sourceRoot":"","sources":["../../src/public_api.mts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAE7B,OAAO,EAAE,gBAAgB,IAAI,OAAO,EAAE,MAAM,cAAc,CAAC"}