@ama-openapi/redocly-plugin 14.3.0-rc.5 → 14.4.0-prerelease.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ama-openapi/redocly-plugin",
-  "version": "14.3.0-rc.5",
+  "version": "14.4.0-prerelease.3",
   "type": "module",
   "publishConfig": {
     "access": "public"
@@ -30,13 +30,13 @@
     "postbuild": "patch-package-json-main"
   },
   "dependencies": {
-    "@ama-openapi/core": "~14.3.0-rc.5",
+    "@ama-openapi/core": "~14.4.0-prerelease.3",
     "dotenv": "~17.3.0",
     "tslib": "^2.6.2",
     "yargs": "~18.0.0"
   },
   "peerDependencies": {
-    "@o3r/telemetry": "~14.3.0-rc.5",
+    "@o3r/telemetry": "~14.4.0-prerelease.3",
     "@redocly/openapi-core": "^2.11.0"
   },
   "peerDependenciesMeta": {
@@ -52,10 +52,10 @@
     "@nx/eslint-plugin": "~22.7.0",
     "@nx/js": "~22.7.0",
     "@nx/vitest": "~22.7.0",
-    "@o3r/build-helpers": "~14.3.0-rc.5",
-    "@o3r/eslint-plugin": "~14.3.0-rc.5",
-    "@o3r/telemetry": "~14.3.0-rc.5",
-    "@o3r/test-helpers": "~14.3.0-rc.5",
+    "@o3r/build-helpers": "~14.4.0-prerelease.3",
+    "@o3r/eslint-plugin": "~14.4.0-prerelease.3",
+    "@o3r/telemetry": "~14.4.0-prerelease.3",
+    "@o3r/test-helpers": "~14.4.0-prerelease.3",
     "@redocly/openapi-core": "~2.25.0",
     "@stylistic/eslint-plugin": "~5.10.0",
     "@types/minimist": "^1.2.2",

package/src/plugin.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.mts","sourceRoot":"","sources":["../../src/plugin.mts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,MAAM,EACZ,MAAM,uBAAuB,CAAC;AAe/B,OAAO,EAEL,KAAK,yBAAyB,EAC/B,MAAM,6CAA6C,CAAC;AAIrD,qCAAqC;AACrC,MAAM,WAAW,uBAAwB,SAAQ,OAAO,CAAC,yBAAyB,CAAC;CAClF;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAU,UAAU,uBAAuB,KAAG,OAAO,CAAC,MAAM,CAiCxF,CAAC"}
+{"version":3,"file":"plugin.d.mts","sourceRoot":"","sources":["../../src/plugin.mts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,MAAM,EACZ,MAAM,uBAAuB,CAAC;AAmB/B,OAAO,EAEL,KAAK,yBAAyB,EAC/B,MAAM,6CAA6C,CAAC;AAIrD,qCAAqC;AACrC,MAAM,WAAW,uBAAwB,SAAQ,OAAO,CAAC,yBAAyB,CAAC;CAClF;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAU,UAAU,uBAAuB,KAAG,OAAO,CAAC,MAAM,CAqCxF,CAAC"}

package/src/plugin.mjs

@@ -1,5 +1,6 @@
 import { config, } from 'dotenv';
 import { ENVIRONMENT_VARIABLE_PREFIX, } from './constants.mjs';
+import { DECORATOR_ID_ENFORCE_DISCRIMINATOR_MANDATORY, enforceDiscriminatorMandatoryDecorator, } from './plugins/decorators/common/enforce-discriminator-mandatory/enforce-discriminator-mandatory.decorator.mjs';
 import { DECORATOR_ID_REDIRECT_REF, redirectRefsDecorator, } from './plugins/decorators/common/replace-refs/replace-refs.decorator.mjs';
 import { DECORATOR_ID_REMOVE_UNUSED_COMPONENTS, removeUnusedComponentsDecorator, } from './plugins/decorators/oas3/remove-unused-components/remove-unused-components.decorator.mjs';
 import { retrieveDependency, } from './plugins/meta/retrieve-dependency.meta.mjs';
@@ -20,16 +21,20 @@ export const amaOpenapiPlugin = async (options) => {
         id: 'ama-openapi',
         decorators: {
             oas2: {
+                [DECORATOR_ID_ENFORCE_DISCRIMINATOR_MANDATORY]: enforceDiscriminatorMandatoryDecorator,
                 [DECORATOR_ID_REDIRECT_REF]: redirectRefsDecorator
             },
             oas3: {
+                [DECORATOR_ID_ENFORCE_DISCRIMINATOR_MANDATORY]: enforceDiscriminatorMandatoryDecorator,
                 [DECORATOR_ID_REDIRECT_REF]: redirectRefsDecorator,
                 [DECORATOR_ID_REMOVE_UNUSED_COMPONENTS]: removeUnusedComponentsDecorator
             },
             async2: {
+                [DECORATOR_ID_ENFORCE_DISCRIMINATOR_MANDATORY]: enforceDiscriminatorMandatoryDecorator,
                 [DECORATOR_ID_REDIRECT_REF]: redirectRefsDecorator
             },
             async3: {
+                [DECORATOR_ID_ENFORCE_DISCRIMINATOR_MANDATORY]: enforceDiscriminatorMandatoryDecorator,
                 [DECORATOR_ID_REDIRECT_REF]: redirectRefsDecorator
             }
         }

package/src/plugin.mjs.map

@@ -1 +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,yBAAyB,EACzB,qBAAqB,GACtB,MAAM,qEAAqE,CAAC;AAC7E,OAAO,EACL,qCAAqC,EACrC,+BAA+B,GAChC,MAAM,2FAA2F,CAAC;AACnG,OAAO,EACL,kBAAkB,GAEnB,MAAM,6CAA6C,CAAC;AAErD,MAAM,eAAe,GAAa,OAAO,CAAC;AAM1C;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,EAAE,OAAiC,EAAmB,EAAE;IAC3F,MAAM,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAExC,MAAM,EACJ,CAAC,GAAG,2BAA2B,UAAU,CAAC,EAAE,OAAO,EACnD,CAAC,GAAG,2BAA2B,QAAQ,CAAC,EAAE,KAAK,EAC/C,CAAC,GAAG,2BAA2B,oBAAoB,CAAC,EAAE,eAAe,EACtE,GAAG,OAAO,CAAC,GAAG,CAAC;IAEhB,MAAM,kBAAkB,CAAC;QACvB,QAAQ,EAAE,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,QAAQ,IAAI,eAAe,CAAC;QAC/E,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,IAAI,KAAK;QACzD,eAAe,EAAE,eAAe,CAAC,CAAC,CAAC,eAAe,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,eAAe,IAAI,KAAK;KAClG,CAAC,CAAC;IAEH,OAAO;QACL,EAAE,EAAE,aAAa;QACjB,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,CAAC,yBAAyB,CAAC,EAAE,qBAAqB;aACnD;YACD,IAAI,EAAE;gBACJ,CAAC,yBAAyB,CAAC,EAAE,qBAAqB;gBAClD,CAAC,qCAAqC,CAAC,EAAE,+BAA+B;aACzE;YACD,MAAM,EAAE;gBACN,CAAC,yBAAyB,CAAC,EAAE,qBAAqB;aACnD;YACD,MAAM,EAAE;gBACN,CAAC,yBAAyB,CAAC,EAAE,qBAAqB;aACnD;SACF;KACF,CAAC;AACJ,CAAC,CAAC"}
+{"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,4CAA4C,EAC5C,sCAAsC,GACvC,MAAM,2GAA2G,CAAC;AACnH,OAAO,EACL,yBAAyB,EACzB,qBAAqB,GACtB,MAAM,qEAAqE,CAAC;AAC7E,OAAO,EACL,qCAAqC,EACrC,+BAA+B,GAChC,MAAM,2FAA2F,CAAC;AACnG,OAAO,EACL,kBAAkB,GAEnB,MAAM,6CAA6C,CAAC;AAErD,MAAM,eAAe,GAAa,OAAO,CAAC;AAM1C;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,EAAE,OAAiC,EAAmB,EAAE;IAC3F,MAAM,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAExC,MAAM,EACJ,CAAC,GAAG,2BAA2B,UAAU,CAAC,EAAE,OAAO,EACnD,CAAC,GAAG,2BAA2B,QAAQ,CAAC,EAAE,KAAK,EAC/C,CAAC,GAAG,2BAA2B,oBAAoB,CAAC,EAAE,eAAe,EACtE,GAAG,OAAO,CAAC,GAAG,CAAC;IAEhB,MAAM,kBAAkB,CAAC;QACvB,QAAQ,EAAE,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,QAAQ,IAAI,eAAe,CAAC;QAC/E,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,IAAI,KAAK;QACzD,eAAe,EAAE,eAAe,CAAC,CAAC,CAAC,eAAe,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,eAAe,IAAI,KAAK;KAClG,CAAC,CAAC;IAEH,OAAO;QACL,EAAE,EAAE,aAAa;QACjB,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,CAAC,4CAA4C,CAAC,EAAE,sCAAsC;gBACtF,CAAC,yBAAyB,CAAC,EAAE,qBAAqB;aACnD;YACD,IAAI,EAAE;gBACJ,CAAC,4CAA4C,CAAC,EAAE,sCAAsC;gBACtF,CAAC,yBAAyB,CAAC,EAAE,qBAAqB;gBAClD,CAAC,qCAAqC,CAAC,EAAE,+BAA+B;aACzE;YACD,MAAM,EAAE;gBACN,CAAC,4CAA4C,CAAC,EAAE,sCAAsC;gBACtF,CAAC,yBAAyB,CAAC,EAAE,qBAAqB;aACnD;YACD,MAAM,EAAE;gBACN,CAAC,4CAA4C,CAAC,EAAE,sCAAsC;gBACtF,CAAC,yBAAyB,CAAC,EAAE,qBAAqB;aACnD;SACF;KACF,CAAC;AACJ,CAAC,CAAC"}

package/src/plugins/decorators/common/enforce-discriminator-mandatory/enforce-discriminator-mandatory.decorator.d.mts

@@ -0,0 +1,31 @@
+import type { Async2Preprocessor, Async3Preprocessor, Oas2Preprocessor, Oas3Preprocessor } from '@redocly/openapi-core';
+type Preprocessor = Oas2Preprocessor & Oas3Preprocessor & Async2Preprocessor & Async3Preprocessor;
+/** Name of the enforce-discriminator-mandatory custom decorator */
+export declare const DECORATOR_ID_ENFORCE_DISCRIMINATOR_MANDATORY = "enforce-discriminator-mandatory";
+/** Options for the enforce-discriminator-mandatory custom decorator */
+export interface EnforceDiscriminatorMandatoryDecoratorOptions {
+    /**
+     * Optional flag to indicate if the discriminator property was added to the required array
+     * @default false
+     */
+    flagAddedDiscriminator?: boolean;
+}
+/**
+ * Custom decorator to enforce that discriminator fields are required in OpenAPI schemas.
+ * This decorator works with OAS 2.0, 3.0, and 3.1 specifications.
+ * @param options
+ * @example Basic usage in redocly.yaml
+ * ```yaml
+ * plugins:
+ *   - '@ama-openapi/redocly-plugin'
+ *
+ * apis:
+ *   mySpec:
+ *     root: apis/mySpec.json
+ *     decorators:
+ *       ama-openapi/enforce-discriminator-mandatory: on
+ * ```
+ */
+export declare const enforceDiscriminatorMandatoryDecorator: Preprocessor;
+export {};
+//# sourceMappingURL=enforce-discriminator-mandatory.decorator.d.mts.map

package/src/plugins/decorators/common/enforce-discriminator-mandatory/enforce-discriminator-mandatory.decorator.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enforce-discriminator-mandatory.decorator.d.mts","sourceRoot":"","sources":["../../../../../../src/plugins/decorators/common/enforce-discriminator-mandatory/enforce-discriminator-mandatory.decorator.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,uBAAuB,CAAC;AAE/B,KAAK,YAAY,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,CAAC;AAElG,mEAAmE;AACnE,eAAO,MAAM,4CAA4C,oCAAoC,CAAC;AAK9F,uEAAuE;AACvE,MAAM,WAAW,6CAA6C;IAC5D;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,sCAAsC,EAAE,YAkCpD,CAAC"}

package/src/plugins/decorators/common/enforce-discriminator-mandatory/enforce-discriminator-mandatory.decorator.mjs

@@ -0,0 +1,52 @@
+/** Name of the enforce-discriminator-mandatory custom decorator */
+export const DECORATOR_ID_ENFORCE_DISCRIMINATOR_MANDATORY = 'enforce-discriminator-mandatory';
+/** Flag to indicate if the discriminator property was added to the required array */
+const X_FLAG_ADDED_DISCRIMINATOR = 'x-added-required-discriminator';
+/**
+ * Custom decorator to enforce that discriminator fields are required in OpenAPI schemas.
+ * This decorator works with OAS 2.0, 3.0, and 3.1 specifications.
+ * @param options
+ * @example Basic usage in redocly.yaml
+ * ```yaml
+ * plugins:
+ *   - '@ama-openapi/redocly-plugin'
+ *
+ * apis:
+ *   mySpec:
+ *     root: apis/mySpec.json
+ *     decorators:
+ *       ama-openapi/enforce-discriminator-mandatory: on
+ * ```
+ */
+export const enforceDiscriminatorMandatoryDecorator = (options) => {
+    return {
+        Schema: {
+            // use `any` type because schema OAS 2.0 is not exposed in the core, and we want to support both OAS 2.0 and 3.0 schemas
+            leave: (node) => {
+                // Check if schema has a discriminator
+                if (!node.discriminator) {
+                    return;
+                }
+                // Get the discriminator property name
+                // In OAS 2.0, discriminator is a string
+                // In OAS 3.0+, discriminator is an object with a propertyName field
+                const discriminatorProperty = typeof node.discriminator === 'string'
+                    ? node.discriminator
+                    : node.discriminator.propertyName;
+                if (!discriminatorProperty) {
+                    return;
+                }
+                // Ensure the required array exists
+                node.required ||= [];
+                // Add discriminator property to required if not already present
+                if (!node.required.includes(discriminatorProperty)) {
+                    node.required.push(discriminatorProperty);
+                    if (options?.flagAddedDiscriminator) {
+                        node[X_FLAG_ADDED_DISCRIMINATOR] = true;
+                    }
+                }
+            }
+        }
+    };
+};
+//# sourceMappingURL=enforce-discriminator-mandatory.decorator.mjs.map

package/src/plugins/decorators/common/enforce-discriminator-mandatory/enforce-discriminator-mandatory.decorator.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"enforce-discriminator-mandatory.decorator.mjs","sourceRoot":"","sources":["../../../../../../src/plugins/decorators/common/enforce-discriminator-mandatory/enforce-discriminator-mandatory.decorator.mts"],"names":[],"mappings":"AASA,mEAAmE;AACnE,MAAM,CAAC,MAAM,4CAA4C,GAAG,iCAAiC,CAAC;AAE9F,qFAAqF;AACrF,MAAM,0BAA0B,GAAG,gCAAgC,CAAC;AAWpE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,sCAAsC,GAAiB,CAAC,OAAsD,EAAE,EAAE;IAC7H,OAAO;QACL,MAAM,EAAE;YACN,wHAAwH;YACxH,KAAK,EAAE,CAAC,IAAS,EAAE,EAAE;gBACnB,sCAAsC;gBACtC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;oBACxB,OAAO;gBACT,CAAC;gBAED,sCAAsC;gBACtC,wCAAwC;gBACxC,oEAAoE;gBACpE,MAAM,qBAAqB,GAAG,OAAO,IAAI,CAAC,aAAa,KAAK,QAAQ;oBAClE,CAAC,CAAC,IAAI,CAAC,aAAa;oBACpB,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC;gBAEpC,IAAI,CAAC,qBAAqB,EAAE,CAAC;oBAC3B,OAAO;gBACT,CAAC;gBAED,mCAAmC;gBACnC,IAAI,CAAC,QAAQ,KAAK,EAAE,CAAC;gBAErB,gEAAgE;gBAChE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,CAAC;oBACnD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;oBAC1C,IAAI,OAAO,EAAE,sBAAsB,EAAE,CAAC;wBACpC,IAAI,CAAC,0BAA0B,CAAC,GAAG,IAAI,CAAC;oBAC1C,CAAC;gBACH,CAAC;YACH,CAAC;SACF;KACF,CAAC;AACJ,CAAC,CAAC"}