@redocly/openapi-core 1.10.3 → 1.10.5

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @redocly/openapi-core
 
+## 1.10.5
+
+### Patch Changes
+
+- Updated license text for date and organization naming accuracy.
+
+## 1.10.4
+
+### Patch Changes
+
+- Added a platform check so `@redocly/openapi-core` can support running inside a worker.
+- Allowed additional properties in `theme.openapi` config schema to enable libraries that use `@redocly/openapi-core` for configuration linting to extend this part of the schema.
+
 ## 1.10.3
 
 ### Patch Changes

package/lib/bundle.d.ts

@@ -47,4 +47,4 @@ export declare function bundleDocument(opts: {
     removeUnusedComponents?: boolean;
     keepUrlRefs?: boolean;
 }): Promise<BundleResult>;
-export declare function mapTypeToComponent(typeName: string, version: SpecMajorVersion): "parameters" | "examples" | "headers" | "schemas" | "responses" | "requestBodies" | "securitySchemes" | "links" | "callbacks" | "definitions" | null;
+export declare function mapTypeToComponent(typeName: string, version: SpecMajorVersion): "definitions" | "examples" | "links" | "responses" | "parameters" | "headers" | "schemas" | "requestBodies" | "securitySchemes" | "callbacks" | null;

package/lib/config/types.d.ts

@@ -157,14 +157,4 @@ export type ThemeRawConfig = {
     mockServer?: Record<string, any>;
 };
 export type RulesFields = 'rules' | 'oas2Rules' | 'oas3_0Rules' | 'oas3_1Rules' | 'async2Rules' | 'preprocessors' | 'oas2Preprocessors' | 'oas3_0Preprocessors' | 'oas3_1Preprocessors' | 'async2Preprocessors' | 'decorators' | 'oas2Decorators' | 'oas3_0Decorators' | 'oas3_1Decorators' | 'async2Decorators';
-export declare enum AuthProviderType {
-    OIDC = "OIDC",
-    SAML2 = "SAML2",
-    BASIC = "BASIC"
-}
-export declare enum ApigeeDevOnboardingIntegrationAuthType {
-    SERVICE_ACCOUNT = "SERVICE_ACCOUNT",
-    OAUTH2 = "OAUTH2"
-}
-export declare const DEFAULT_TEAM_CLAIM_NAME = "https://redocly.com/sso/teams";
 export {};

package/lib/config/types.js

@@ -1,15 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_TEAM_CLAIM_NAME = exports.ApigeeDevOnboardingIntegrationAuthType = exports.AuthProviderType = void 0;
-var AuthProviderType;
-(function (AuthProviderType) {
-    AuthProviderType["OIDC"] = "OIDC";
-    AuthProviderType["SAML2"] = "SAML2";
-    AuthProviderType["BASIC"] = "BASIC";
-})(AuthProviderType || (exports.AuthProviderType = AuthProviderType = {}));
-var ApigeeDevOnboardingIntegrationAuthType;
-(function (ApigeeDevOnboardingIntegrationAuthType) {
-    ApigeeDevOnboardingIntegrationAuthType["SERVICE_ACCOUNT"] = "SERVICE_ACCOUNT";
-    ApigeeDevOnboardingIntegrationAuthType["OAUTH2"] = "OAUTH2";
-})(ApigeeDevOnboardingIntegrationAuthType || (exports.ApigeeDevOnboardingIntegrationAuthType = ApigeeDevOnboardingIntegrationAuthType = {}));
-exports.DEFAULT_TEAM_CLAIM_NAME = 'https://redocly.com/sso/teams';

package/lib/env.js

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

package/lib/oas-types.d.ts

@@ -24,4 +24,4 @@ export type Oas2DecoratorsSet = Record<string, Oas2Preprocessor>;
 export type Async2DecoratorsSet = Record<string, Async2Preprocessor>;
 export declare function detectSpec(root: any): SpecVersion;
 export declare function getMajorSpecVersion(version: SpecVersion): SpecMajorVersion;
-export declare function getTypes(spec: SpecVersion): Record<string, import("./types").NodeType> | Record<"Root" | "Tag" | "ExternalDocs" | "SecurityRequirement" | "Info" | "Contact" | "License" | "Paths" | "PathItem" | "Parameter" | "Operation" | "Example" | "Header" | "Responses" | "Response" | "Schema" | "Xml" | "SchemaProperties" | "NamedSchemas" | "NamedResponses" | "NamedParameters" | "NamedSecuritySchemes" | "SecurityScheme" | "Examples" | "ExamplesMap" | "TagList" | "SecurityRequirementList" | "ParameterList" | "ParameterItems" | "TagGroup" | "TagGroups" | "EnumDescriptions" | "Logo" | "XCodeSample" | "XCodeSampleList" | "XServer" | "XServerList", import("./types").NodeType> | Record<"Root" | "Tag" | "ExternalDocs" | "Server" | "ServerVariable" | "SecurityRequirement" | "Info" | "Contact" | "License" | "Paths" | "PathItem" | "Callback" | "CallbacksMap" | "Parameter" | "Operation" | "RequestBody" | "MediaTypesMap" | "MediaType" | "Example" | "Encoding" | "Header" | "Responses" | "Response" | "Link" | "Schema" | "Xml" | "SchemaProperties" | "DiscriminatorMapping" | "Discriminator" | "Components" | "NamedSchemas" | "NamedResponses" | "NamedParameters" | "NamedExamples" | "NamedRequestBodies" | "NamedHeaders" | "NamedSecuritySchemes" | "NamedLinks" | "NamedCallbacks" | "ImplicitFlow" | "PasswordFlow" | "ClientCredentials" | "AuthorizationCode" | "OAuth2Flows" | "SecurityScheme" | "ServerVariablesMap" | "ExamplesMap" | "EncodingMap" | "HeadersMap" | "LinksMap" | "WebhooksMap" | "TagList" | "SecurityRequirementList" | "ParameterList" | "TagGroup" | "TagGroups" | "EnumDescriptions" | "Logo" | "XCodeSample" | "XCodeSampleList" | "ServerList" | "XUsePkce", import("./types").NodeType> | Record<"Root" | "Info" | "License" | "Operation" | "Schema" | "SchemaProperties" | "Components" | "SecurityScheme" | "NamedPathItems", import("./types").NodeType>;
+export declare function getTypes(spec: SpecVersion): Record<string, import("./types").NodeType> | Record<"Root" | "Tag" | "ExternalDocs" | "SecurityRequirement" | "Info" | "Contact" | "License" | "Paths" | "PathItem" | "Parameter" | "Operation" | "Example" | "Header" | "Responses" | "Response" | "Schema" | "Xml" | "SchemaProperties" | "NamedSchemas" | "NamedResponses" | "NamedParameters" | "NamedSecuritySchemes" | "SecurityScheme" | "Examples" | "ExamplesMap" | "TagList" | "SecurityRequirementList" | "ParameterList" | "ParameterItems" | "TagGroup" | "TagGroups" | "EnumDescriptions" | "Logo" | "XCodeSample" | "XCodeSampleList" | "XServer" | "XServerList", import("./types").NodeType> | Record<"Root" | "Tag" | "ExternalDocs" | "Server" | "ServerVariable" | "SecurityRequirement" | "Info" | "Contact" | "License" | "Paths" | "PathItem" | "Callback" | "CallbacksMap" | "Parameter" | "Operation" | "RequestBody" | "MediaTypesMap" | "MediaType" | "Example" | "Encoding" | "Header" | "Responses" | "Response" | "Link" | "Schema" | "Xml" | "SchemaProperties" | "DiscriminatorMapping" | "Discriminator" | "Components" | "NamedSchemas" | "NamedResponses" | "NamedParameters" | "NamedExamples" | "NamedRequestBodies" | "NamedHeaders" | "NamedSecuritySchemes" | "NamedLinks" | "NamedCallbacks" | "ImplicitFlow" | "PasswordFlow" | "ClientCredentials" | "AuthorizationCode" | "OAuth2Flows" | "SecurityScheme" | "ServerVariablesMap" | "ExamplesMap" | "EncodingMap" | "HeadersMap" | "LinksMap" | "TagList" | "SecurityRequirementList" | "ParameterList" | "TagGroup" | "TagGroups" | "EnumDescriptions" | "Logo" | "XCodeSample" | "XCodeSampleList" | "ServerList" | "XUsePkce" | "WebhooksMap", import("./types").NodeType> | Record<"Root" | "Info" | "License" | "Operation" | "Schema" | "SchemaProperties" | "Components" | "SecurityScheme" | "NamedPathItems", import("./types").NodeType>;

package/lib/types/redocly-yaml.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigTypes = exports.createConfigTypes = void 0;
-const portal_config_schema_1 = require("./portal-config-schema");
+const config_1 = require("@redocly/config");
 const _1 = require(".");
 const utils_1 = require("../utils");
 const json_schema_adapter_1 = require("./json-schema-adapter");
@@ -888,7 +888,7 @@ const ConfigReferenceDocs = {
         preserveOriginalExtensionsName: { type: 'boolean' },
         markdownHeadingsAnchorLevel: { type: 'number' },
     },
-    additionalProperties: { type: 'string' },
+    additionalProperties: {},
 };
 const ConfigMockServer = {
     properties: {
@@ -964,4 +964,4 @@ const CoreConfigTypes = {
     AssertionDefinitionAssertions,
     AssertionDefinitionSubject,
 };
-exports.ConfigTypes = (0, exports.createConfigTypes)(portal_config_schema_1.rootRedoclyConfigSchema);
+exports.ConfigTypes = (0, exports.createConfigTypes)(config_1.rootRedoclyConfigSchema);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.10.3",
+  "version": "1.10.5",
   "description": "",
   "main": "lib/index.js",
   "engines": {
@@ -35,6 +35,7 @@
   ],
   "dependencies": {
     "@redocly/ajv": "^8.11.0",
+    "@redocly/config": "^0.1.4",
     "colorette": "^1.2.0",
     "js-levenshtein": "^1.1.6",
     "js-yaml": "^4.1.0",

package/src/__tests__/lint.test.ts

@@ -6,7 +6,7 @@ import { BaseResolver } from '../resolve';
 import { loadConfig } from '../config/load';
 import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../__tests__/utils';
 import { detectSpec } from '../oas-types';
-import { themeConfigSchema } from '../types/theme-config';
+import { rootRedoclyConfigSchema } from '@redocly/config';
 import { createConfigTypes } from '../types/redocly-yaml';
 
 const testPortalConfig = parseYamlToDocument(
@@ -1124,20 +1124,6 @@ describe('lint', () => {
           "severity": "error",
           "suggest": [],
         },
-        {
-          "from": undefined,
-          "location": [
-            {
-              "pointer": "#/theme/footer/items/0/items/0/href",
-              "reportOnKey": true,
-              "source": "",
-            },
-          ],
-          "message": "Property \`href\` is not expected here.",
-          "ruleId": "configuration spec",
-          "severity": "error",
-          "suggest": [],
-        },
         {
           "from": undefined,
           "location": [
@@ -1204,7 +1190,7 @@ describe('lint', () => {
       document,
       externalConfigTypes: createConfigTypes({
         type: 'object',
-        properties: { theme: themeConfigSchema },
+        properties: { theme: rootRedoclyConfigSchema.properties.theme },
         additionalProperties: false,
       }),
     });
@@ -1379,20 +1365,6 @@ describe('lint', () => {
           "severity": "error",
           "suggest": [],
         },
-        {
-          "from": undefined,
-          "location": [
-            {
-              "pointer": "#/theme/footer/items/0/items/0/href",
-              "reportOnKey": true,
-              "source": "",
-            },
-          ],
-          "message": "Property \`href\` is not expected here.",
-          "ruleId": "configuration spec",
-          "severity": "error",
-          "suggest": [],
-        },
         {
           "from": undefined,
           "location": [

package/src/config/types.ts

@@ -243,16 +243,3 @@ export type RulesFields =
   | 'oas3_0Decorators'
   | 'oas3_1Decorators'
   | 'async2Decorators';
-
-export enum AuthProviderType {
-  OIDC = 'OIDC',
-  SAML2 = 'SAML2',
-  BASIC = 'BASIC',
-}
-
-export enum ApigeeDevOnboardingIntegrationAuthType {
-  SERVICE_ACCOUNT = 'SERVICE_ACCOUNT',
-  OAUTH2 = 'OAUTH2',
-}
-
-export const DEFAULT_TEAM_CLAIM_NAME = 'https://redocly.com/sso/teams';

package/src/env.ts

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

package/src/types/redocly-yaml.ts

@@ -1,4 +1,4 @@
-import { rootRedoclyConfigSchema } from './portal-config-schema';
+import { rootRedoclyConfigSchema } from '@redocly/config';
 import { listOf } from '.';
 import { omitObjectProps, pickObjectProps, isCustomRuleId } from '../utils';
 import { getNodeTypesFromJSONSchema } from './json-schema-adapter';
@@ -1050,7 +1050,7 @@ const ConfigReferenceDocs: NodeType = {
     preserveOriginalExtensionsName: { type: 'boolean' },
     markdownHeadingsAnchorLevel: { type: 'number' },
   },
-  additionalProperties: { type: 'string' },
+  additionalProperties: {},
 };
 
 const ConfigMockServer: NodeType = {