@redocly/openapi-core 1.4.0 → 1.5.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @redocly/openapi-core
 
+## 1.5.0
+
+### Minor Changes
+
+- Added new rule `array-parameter-serialization` to require that serialization parameters `style` and `explode` are present on array parameters.
+
+## 1.4.1
+
+### Patch Changes
+
+- OpenAPI 3.1.x defaults to JSON Schema draft 2020-12 and the value of property names defined in `properties` was updated since OpenAPI 3.0.x and JSON Schema draft-04.
+
+  In the new JSON Schema specification, each property value within a `properties` schema accepts a `boolean` or `object` schema.
+
+  https://json-schema.org/draft/2020-12/json-schema-core#section-10.3.2.1
+
+- Fixed incorrect browser detection by removing check for 'self' as Bun also exposes it by default.
+
 ## 1.4.0
 
 ### Minor Changes

package/README.md

@@ -3,10 +3,10 @@
 See https://github.com/Redocly/redocly-cli
 
 > [!IMPORTANT]
-The `openapi-core package` is designed for our internal use; the interfaces that are considered safe to use are documented below.
-Some of the function arguments are not documented below because they are not intended for public use.
-Avoid using any functions or features that are not documented below.
-If your use case is not documented below, please open an issue.
+> The `openapi-core package` is designed for our internal use; the interfaces that are considered safe to use are documented below.
+> Some of the function arguments are not documented below because they are not intended for public use.
+> Avoid using any functions or features that are not documented below.
+> If your use case is not documented below, please open an issue.
 
 ## Basic usage
 
@@ -265,4 +265,4 @@ Helper function to stringify a javascript object to YAML.
 
 ```ts
 function stringifyYaml(obj: object): string;
-```
+```

package/lib/bundle.js

@@ -21,8 +21,8 @@ const rules_1 = require("./config/rules");
 const no_unresolved_refs_1 = require("./rules/no-unresolved-refs");
 const utils_1 = require("./utils");
 const redocly_1 = require("./redocly");
-const remove_unused_components_1 = require("./rules/oas2/remove-unused-components");
-const remove_unused_components_2 = require("./rules/oas3/remove-unused-components");
+const remove_unused_components_1 = require("./decorators/oas2/remove-unused-components");
+const remove_unused_components_2 = require("./decorators/oas3/remove-unused-components");
 var OasVersion;
 (function (OasVersion) {
     OasVersion["Version2"] = "oas2";

package/lib/config/all.js

@@ -78,6 +78,7 @@ const all = {
         'component-name-unique': 'error',
         'response-contains-property': 'error',
         'spec-components-invalid-map-name': 'error',
+        'array-parameter-serialization': 'error',
     },
     oas3_1Rules: {
         'no-invalid-media-type-examples': 'error',
@@ -101,6 +102,7 @@ const all = {
         'component-name-unique': 'error',
         'response-contains-property': 'error',
         'spec-components-invalid-map-name': 'error',
+        'array-parameter-serialization': 'error',
     },
     async2Rules: {
         'channels-kebab-case': 'error',

package/lib/config/minimal.js

@@ -66,6 +66,7 @@ const minimal = {
         'request-mime-type': 'off',
         'response-contains-property': 'off',
         'response-mime-type': 'off',
+        'array-parameter-serialization': 'off',
     },
     oas3_1Rules: {
         'no-invalid-media-type-examples': 'warn',
@@ -83,6 +84,7 @@ const minimal = {
         'request-mime-type': 'off',
         'response-contains-property': 'off',
         'response-mime-type': 'off',
+        'array-parameter-serialization': 'off',
     },
     async2Rules: {
         'channels-kebab-case': 'off',

package/lib/config/recommended-strict.js

@@ -66,6 +66,7 @@ const recommendedStrict = {
         'request-mime-type': 'off',
         'response-contains-property': 'off',
         'response-mime-type': 'off',
+        'array-parameter-serialization': 'off',
     },
     oas3_1Rules: {
         'no-invalid-media-type-examples': 'error',
@@ -83,6 +84,7 @@ const recommendedStrict = {
         'request-mime-type': 'off',
         'response-contains-property': 'off',
         'response-mime-type': 'off',
+        'array-parameter-serialization': 'off',
     },
     async2Rules: {
         'channels-kebab-case': 'off',

package/lib/config/recommended.js

@@ -66,6 +66,7 @@ const recommended = {
         'request-mime-type': 'off',
         'response-contains-property': 'off',
         'response-mime-type': 'off',
+        'array-parameter-serialization': 'off',
     },
     oas3_1Rules: {
         'no-invalid-media-type-examples': 'warn',
@@ -83,6 +84,7 @@ const recommended = {
         'request-mime-type': 'off',
         'response-contains-property': 'off',
         'response-mime-type': 'off',
+        'array-parameter-serialization': 'off',
     },
     async2Rules: {
         'channels-kebab-case': 'off',

package/lib/decorators/oas2/remove-unused-components.d.ts

@@ -0,0 +1,2 @@
+import type { Oas2Decorator } from '../../visitors';
+export declare const RemoveUnusedComponents: Oas2Decorator;

package/lib/decorators/oas3/remove-unused-components.d.ts

@@ -0,0 +1,2 @@
+import type { Oas3Decorator } from '../../visitors';
+export declare const RemoveUnusedComponents: Oas3Decorator;

package/lib/env.js

@@ -4,5 +4,5 @@ exports.env = exports.isBrowser = void 0;
 exports.isBrowser = 
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
-typeof window !== 'undefined' || typeof self !== 'undefined' || typeof process === 'undefined'; // main and worker thread
+typeof window !== 'undefined' || typeof process === 'undefined'; // main and worker thread
 exports.env = exports.isBrowser ? {} : process.env || {};

package/lib/rules/oas3/array-parameter-serialization.d.ts

@@ -0,0 +1,5 @@
+import { Oas3Rule } from '../../visitors';
+export type ArrayParameterSerializationOptions = {
+    in?: string[];
+};
+export declare const ArrayParameterSerialization: Oas3Rule;

package/lib/rules/oas3/array-parameter-serialization.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArrayParameterSerialization = void 0;
+const ref_utils_1 = require("../../ref-utils");
+const ArrayParameterSerialization = (options) => {
+    return {
+        Parameter: {
+            leave(node, ctx) {
+                if (!node.schema) {
+                    return;
+                }
+                const schema = (0, ref_utils_1.isRef)(node.schema)
+                    ? ctx.resolve(node.schema).node
+                    : node.schema;
+                if (schema && shouldReportMissingStyleAndExplode(node, schema, options)) {
+                    ctx.report({
+                        message: `Parameter \`${node.name}\` should have \`style\` and \`explode \` fields`,
+                        location: ctx.location,
+                    });
+                }
+            },
+        },
+    };
+};
+exports.ArrayParameterSerialization = ArrayParameterSerialization;
+function shouldReportMissingStyleAndExplode(node, schema, options) {
+    var _a;
+    return ((schema.type === 'array' || schema.items || schema.prefixItems) &&
+        (node.style === undefined || node.explode === undefined) &&
+        (!options.in || (node.in && ((_a = options.in) === null || _a === void 0 ? void 0 : _a.includes(node.in)))));
+}

package/lib/rules/oas3/index.js

@@ -54,6 +54,7 @@ const operation_4xx_problem_details_rfc7807_1 = require("./operation-4xx-problem
 const required_string_property_missing_min_length_1 = require("../common/required-string-property-missing-min-length");
 const spec_strict_refs_1 = require("../common/spec-strict-refs");
 const component_name_unique_1 = require("./component-name-unique");
+const array_parameter_serialization_1 = require("./array-parameter-serialization");
 exports.rules = {
     spec: spec_1.Spec,
     'info-contact': info_contact_1.InfoContact,
@@ -109,5 +110,6 @@ exports.rules = {
     'required-string-property-missing-min-length': required_string_property_missing_min_length_1.RequiredStringPropertyMissingMinLength,
     'spec-strict-refs': spec_strict_refs_1.SpecStrictRefs,
     'component-name-unique': component_name_unique_1.ComponentNameUnique,
+    'array-parameter-serialization': array_parameter_serialization_1.ArrayParameterSerialization,
 };
 exports.preprocessors = {};

package/lib/types/oas3_1.js

@@ -181,6 +181,17 @@ const Schema = {
     },
     extensionsPrefix: 'x-',
 };
+const SchemaProperties = {
+    properties: {},
+    additionalProperties: (value) => {
+        if (typeof value === 'boolean') {
+            return { type: 'boolean' };
+        }
+        else {
+            return 'Schema';
+        }
+    },
+};
 const SecurityScheme = {
     properties: {
         type: { enum: ['apiKey', 'http', 'oauth2', 'openIdConnect', 'mutualTLS'] },
@@ -253,6 +264,7 @@ const SecurityScheme = {
 exports.Oas3_1Types = Object.assign(Object.assign({}, oas3_1.Oas3Types), { Info,
     Root,
     Schema,
+    SchemaProperties,
     License,
     Components, NamedPathItems: (0, _1.mapOf)('PathItem'), SecurityScheme,
     Operation });

package/lib/types/redocly-yaml.d.ts

@@ -5,7 +5,7 @@ declare const builtInCommonOASRules: readonly ["info-license-url", "info-license
 export type BuiltInCommonOASRuleId = typeof builtInCommonOASRules[number];
 declare const builtInOAS2Rules: readonly ["boolean-parameter-prefixes", "request-mime-type", "response-contains-property", "response-mime-type"];
 export type BuiltInOAS2RuleId = typeof builtInOAS2Rules[number];
-declare const builtInOAS3Rules: readonly ["boolean-parameter-prefixes", "component-name-unique", "no-empty-servers", "no-example-value-and-externalValue", "no-invalid-media-type-examples", "no-server-example.com", "no-server-trailing-slash", "no-server-variables-empty-enum", "no-undefined-server-variable", "no-unused-components", "operation-4xx-problem-details-rfc7807", "request-mime-type", "response-contains-property", "response-mime-type", "spec-components-invalid-map-name"];
+declare const builtInOAS3Rules: readonly ["boolean-parameter-prefixes", "component-name-unique", "no-empty-servers", "no-example-value-and-externalValue", "no-invalid-media-type-examples", "no-server-example.com", "no-server-trailing-slash", "no-server-variables-empty-enum", "no-undefined-server-variable", "no-unused-components", "operation-4xx-problem-details-rfc7807", "request-mime-type", "response-contains-property", "response-mime-type", "spec-components-invalid-map-name", "array-parameter-serialization"];
 export type BuiltInOAS3RuleId = typeof builtInOAS3Rules[number];
 declare const builtInAsync2Rules: readonly ["channels-kebab-case", "no-channel-trailing-slash"];
 export type BuiltInAsync2RuleId = typeof builtInAsync2Rules[number];

package/lib/types/redocly-yaml.js

@@ -70,6 +70,7 @@ const builtInOAS3Rules = [
     'response-contains-property',
     'response-mime-type',
     'spec-components-invalid-map-name',
+    'array-parameter-serialization',
 ];
 const builtInAsync2Rules = ['channels-kebab-case', 'no-channel-trailing-slash'];
 const builtInRules = [

package/lib/typings/openapi.d.ts

@@ -150,6 +150,7 @@ export interface Oas3Schema {
 export type Oas3_1Schema = Oas3Schema & {
     type?: string | string[];
     examples?: any[];
+    prefixItems?: Oas3_1Schema[];
 };
 export interface Oas3_1Definition extends Oas3Definition {
     webhooks?: Oas3_1Webhooks;

package/lib/visitors.d.ts

@@ -133,6 +133,7 @@ type Oas2FlatVisitor = {
     NamedResponses?: VisitFunctionOrObject<Record<string, Oas2Response>>;
     NamedParameters?: VisitFunctionOrObject<Record<string, Oas2Parameter>>;
     SecurityScheme?: VisitFunctionOrObject<Oas2SecurityScheme>;
+    NamedSecuritySchemes?: VisitFunctionOrObject<Record<string, Oas2SecurityScheme>>;
     SpecExtension?: VisitFunctionOrObject<unknown>;
 };
 type Async2FlatVisitor = {
@@ -150,9 +151,6 @@ type Async2NestedVisitor = {
 export type Oas3Visitor = BaseVisitor & Oas3NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Oas3NestedVisitor>>;
 export type Oas2Visitor = BaseVisitor & Oas2NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Oas2NestedVisitor>>;
 export type Async2Visitor = BaseVisitor & Async2NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Async2NestedVisitor>>;
-export type Oas3TransformVisitor = BaseVisitor & Oas3FlatVisitor & Record<string, VisitFunction<any> | VisitObject<any>>;
-export type Oas2TransformVisitor = BaseVisitor & Oas2FlatVisitor & Record<string, VisitFunction<any> | VisitObject<any>>;
-export type Async2TransformVisitor = BaseVisitor & Async2FlatVisitor & Record<string, VisitFunction<any> | VisitObject<any>>;
 export type NestedVisitor<T> = Exclude<T, 'any' | 'ref' | 'Root'>;
 export type NormalizedOasVisitors<T extends BaseVisitor> = {
     [V in keyof T]-?: {
@@ -172,12 +170,12 @@ export type NormalizedOasVisitors<T extends BaseVisitor> = {
 export type Oas3Rule = (options: Record<string, any>) => Oas3Visitor | Oas3Visitor[];
 export type Oas2Rule = (options: Record<string, any>) => Oas2Visitor | Oas2Visitor[];
 export type Async2Rule = (options: Record<string, any>) => Async2Visitor | Async2Visitor[];
-export type Oas3Preprocessor = (options: Record<string, any>) => Oas3TransformVisitor;
-export type Oas2Preprocessor = (options: Record<string, any>) => Oas2TransformVisitor;
-export type Async2Preprocessor = (options: Record<string, any>) => Async2TransformVisitor;
-export type Oas3Decorator = (options: Record<string, any>) => Oas3TransformVisitor;
-export type Oas2Decorator = (options: Record<string, any>) => Oas2TransformVisitor;
-export type Async2Decorator = (options: Record<string, any>) => Async2TransformVisitor;
+export type Oas3Preprocessor = (options: Record<string, any>) => Oas3Visitor;
+export type Oas2Preprocessor = (options: Record<string, any>) => Oas2Visitor;
+export type Async2Preprocessor = (options: Record<string, any>) => Async2Visitor;
+export type Oas3Decorator = (options: Record<string, any>) => Oas3Visitor;
+export type Oas2Decorator = (options: Record<string, any>) => Oas2Visitor;
+export type Async2Decorator = (options: Record<string, any>) => Async2Visitor;
 export type OasRule = Oas3Rule;
 export type OasPreprocessor = Oas3Preprocessor;
 export type OasDecorator = Oas3Decorator;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "",
   "main": "lib/index.js",
   "engines": {

package/src/bundle.ts

@@ -17,8 +17,8 @@ import { reportUnresolvedRef } from './rules/no-unresolved-refs';
 import { isPlainObject, isTruthy } from './utils';
 import { OasRef } from './typings/openapi';
 import { isRedoclyRegistryURL } from './redocly';
-import { RemoveUnusedComponents as RemoveUnusedComponentsOas2 } from './rules/oas2/remove-unused-components';
-import { RemoveUnusedComponents as RemoveUnusedComponentsOas3 } from './rules/oas3/remove-unused-components';
+import { RemoveUnusedComponents as RemoveUnusedComponentsOas2 } from './decorators/oas2/remove-unused-components';
+import { RemoveUnusedComponents as RemoveUnusedComponentsOas3 } from './decorators/oas3/remove-unused-components';
 
 import type { Config, StyleguideConfig } from './config';
 
@@ -126,8 +126,8 @@ export async function bundleDocument(opts: {
     config
   );
 
-  const preprocessors = initRules(rules as any, config, 'preprocessors', specVersion);
-  const decorators = initRules(rules as any, config, 'decorators', specVersion);
+  const preprocessors = initRules(rules, config, 'preprocessors', specVersion);
+  const decorators = initRules(rules, config, 'decorators', specVersion);
 
   const ctx: BundleContext = {
     problems: [],

package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap

@@ -21,6 +21,7 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
   "oas3_0Decorators": {},
   "oas3_0Preprocessors": {},
   "oas3_0Rules": {
+    "array-parameter-serialization": "off",
     "boolean-parameter-prefixes": "error",
     "component-name-unique": "off",
     "no-empty-servers": "error",
@@ -40,6 +41,7 @@ exports[`resolveConfig should ignore minimal from the root and read local file 1
   "oas3_1Decorators": {},
   "oas3_1Preprocessors": {},
   "oas3_1Rules": {
+    "array-parameter-serialization": "off",
     "boolean-parameter-prefixes": "error",
     "component-name-unique": "off",
     "no-empty-servers": "error",
@@ -125,6 +127,7 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
   "oas3_0Decorators": {},
   "oas3_0Preprocessors": {},
   "oas3_0Rules": {
+    "array-parameter-serialization": "off",
     "boolean-parameter-prefixes": "error",
     "component-name-unique": "off",
     "no-empty-servers": "error",
@@ -144,6 +147,7 @@ exports[`resolveStyleguideConfig should resolve extends with local file config w
   "oas3_1Decorators": {},
   "oas3_1Preprocessors": {},
   "oas3_1Rules": {
+    "array-parameter-serialization": "off",
     "boolean-parameter-prefixes": "error",
     "component-name-unique": "off",
     "no-empty-servers": "error",

package/src/config/all.ts

@@ -78,6 +78,7 @@ const all: PluginStyleguideConfig<'built-in'> = {
     'component-name-unique': 'error',
     'response-contains-property': 'error',
     'spec-components-invalid-map-name': 'error',
+    'array-parameter-serialization': 'error',
   },
   oas3_1Rules: {
     'no-invalid-media-type-examples': 'error',
@@ -101,6 +102,7 @@ const all: PluginStyleguideConfig<'built-in'> = {
     'component-name-unique': 'error',
     'response-contains-property': 'error',
     'spec-components-invalid-map-name': 'error',
+    'array-parameter-serialization': 'error',
   },
   async2Rules: {
     'channels-kebab-case': 'error',

package/src/config/minimal.ts

@@ -66,6 +66,7 @@ const minimal: PluginStyleguideConfig<'built-in'> = {
     'request-mime-type': 'off',
     'response-contains-property': 'off',
     'response-mime-type': 'off',
+    'array-parameter-serialization': 'off',
   },
   oas3_1Rules: {
     'no-invalid-media-type-examples': 'warn',
@@ -83,6 +84,7 @@ const minimal: PluginStyleguideConfig<'built-in'> = {
     'request-mime-type': 'off',
     'response-contains-property': 'off',
     'response-mime-type': 'off',
+    'array-parameter-serialization': 'off',
   },
   async2Rules: {
     'channels-kebab-case': 'off',

package/src/config/recommended-strict.ts

@@ -66,6 +66,7 @@ const recommendedStrict: PluginStyleguideConfig<'built-in'> = {
     'request-mime-type': 'off',
     'response-contains-property': 'off',
     'response-mime-type': 'off',
+    'array-parameter-serialization': 'off',
   },
   oas3_1Rules: {
     'no-invalid-media-type-examples': 'error',
@@ -83,6 +84,7 @@ const recommendedStrict: PluginStyleguideConfig<'built-in'> = {
     'request-mime-type': 'off',
     'response-contains-property': 'off',
     'response-mime-type': 'off',
+    'array-parameter-serialization': 'off',
   },
   async2Rules: {
     'channels-kebab-case': 'off',

package/src/config/recommended.ts

@@ -66,6 +66,7 @@ const recommended: PluginStyleguideConfig<'built-in'> = {
     'request-mime-type': 'off',
     'response-contains-property': 'off',
     'response-mime-type': 'off',
+    'array-parameter-serialization': 'off',
   },
   oas3_1Rules: {
     'no-invalid-media-type-examples': 'warn',
@@ -83,6 +84,7 @@ const recommended: PluginStyleguideConfig<'built-in'> = {
     'request-mime-type': 'off',
     'response-contains-property': 'off',
     'response-mime-type': 'off',
+    'array-parameter-serialization': 'off',
   },
   async2Rules: {
     'channels-kebab-case': 'off',

package/src/{rules → decorators}/oas2/remove-unused-components.ts

@@ -1,9 +1,9 @@
-import { Oas2Rule } from '../../visitors';
+import type { Oas2Decorator } from '../../visitors';
 import { Location } from '../../ref-utils';
-import { Oas2Components } from '../../typings/swagger';
+import type { Oas2Components } from '../../typings/swagger';
 import { isEmptyObject } from '../../utils';
 
-export const RemoveUnusedComponents: Oas2Rule = () => {
+export const RemoveUnusedComponents: Oas2Decorator = () => {
   const components = new Map<
     string,
     { used: boolean; componentType?: keyof Oas2Components; name: string }

package/src/{rules → decorators}/oas3/remove-unused-components.ts

@@ -1,9 +1,9 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Decorator } from '../../visitors';
 import { Location } from '../../ref-utils';
-import { Oas3Components } from '../../typings/openapi';
+import type { Oas3Components } from '../../typings/openapi';
 import { isEmptyObject } from '../../utils';
 
-export const RemoveUnusedComponents: Oas3Rule = () => {
+export const RemoveUnusedComponents: Oas3Decorator = () => {
   const components = new Map<
     string,
     { used: boolean; componentType?: keyof Oas3Components; name: string }

package/src/env.ts

@@ -1,5 +1,5 @@
 export const isBrowser =
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
-  typeof window !== 'undefined' || typeof self !== 'undefined' || typeof process === 'undefined'; // main and worker thread
+  typeof window !== 'undefined' || typeof process === 'undefined'; // main and worker thread
 export const env = isBrowser ? {} : process.env || {};