@redocly/openapi-core 0.0.0-snapshot.1737554067

package/lib/types/oas3_1.js

@@ -0,0 +1,285 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Oas3_1Types = exports.DependentRequired = exports.SchemaProperties = exports.Schema = void 0;
+const _1 = require(".");
+const oas3_1 = require("./oas3");
+const Root = {
+    properties: {
+        openapi: null,
+        info: 'Info',
+        servers: 'ServerList',
+        security: 'SecurityRequirementList',
+        tags: 'TagList',
+        externalDocs: 'ExternalDocs',
+        paths: 'Paths',
+        webhooks: 'WebhooksMap',
+        components: 'Components',
+        jsonSchemaDialect: { type: 'string' },
+    },
+    required: ['openapi', 'info'],
+    requiredOneOf: ['paths', 'components', 'webhooks'],
+    extensionsPrefix: 'x-',
+};
+const License = {
+    properties: {
+        name: { type: 'string' },
+        url: { type: 'string' },
+        identifier: { type: 'string' },
+    },
+    required: ['name'],
+    extensionsPrefix: 'x-',
+};
+const Info = {
+    properties: {
+        title: { type: 'string' },
+        version: { type: 'string' },
+        description: { type: 'string' },
+        termsOfService: { type: 'string' },
+        summary: { type: 'string' },
+        contact: 'Contact',
+        license: 'License',
+        'x-logo': 'Logo',
+    },
+    required: ['title', 'version'],
+    extensionsPrefix: 'x-',
+};
+const Components = {
+    properties: {
+        parameters: 'NamedParameters',
+        schemas: 'NamedSchemas',
+        responses: 'NamedResponses',
+        examples: 'NamedExamples',
+        requestBodies: 'NamedRequestBodies',
+        headers: 'NamedHeaders',
+        securitySchemes: 'NamedSecuritySchemes',
+        links: 'NamedLinks',
+        callbacks: 'NamedCallbacks',
+        pathItems: 'NamedPathItems',
+    },
+    extensionsPrefix: 'x-',
+};
+const Operation = {
+    properties: {
+        tags: {
+            type: 'array',
+            items: { type: 'string' },
+        },
+        summary: { type: 'string' },
+        description: { type: 'string' },
+        externalDocs: 'ExternalDocs',
+        operationId: { type: 'string' },
+        parameters: 'ParameterList',
+        security: 'SecurityRequirementList',
+        servers: 'ServerList',
+        requestBody: 'RequestBody',
+        responses: 'Responses',
+        deprecated: { type: 'boolean' },
+        callbacks: 'CallbacksMap',
+        'x-codeSamples': 'XCodeSampleList',
+        'x-code-samples': 'XCodeSampleList', // deprecated
+        'x-hideTryItPanel': { type: 'boolean' },
+    },
+    extensionsPrefix: 'x-',
+};
+exports.Schema = {
+    properties: {
+        $id: { type: 'string' },
+        $anchor: { type: 'string' },
+        id: { type: 'string' },
+        $schema: { type: 'string' },
+        definitions: 'NamedSchemas',
+        $defs: 'NamedSchemas',
+        $vocabulary: { type: 'string' },
+        externalDocs: 'ExternalDocs',
+        discriminator: 'Discriminator',
+        title: { type: 'string' },
+        multipleOf: { type: 'number', minimum: 0 },
+        maximum: { type: 'number' },
+        minimum: { type: 'number' },
+        exclusiveMaximum: { type: 'number' },
+        exclusiveMinimum: { type: 'number' },
+        maxLength: { type: 'integer', minimum: 0 },
+        minLength: { type: 'integer', minimum: 0 },
+        pattern: { type: 'string' },
+        maxItems: { type: 'integer', minimum: 0 },
+        minItems: { type: 'integer', minimum: 0 },
+        uniqueItems: { type: 'boolean' },
+        maxProperties: { type: 'integer', minimum: 0 },
+        minProperties: { type: 'integer', minimum: 0 },
+        required: { type: 'array', items: { type: 'string' } },
+        enum: { type: 'array' },
+        type: (value) => {
+            if (Array.isArray(value)) {
+                return {
+                    type: 'array',
+                    items: { enum: ['object', 'array', 'string', 'number', 'integer', 'boolean', 'null'] },
+                };
+            }
+            else {
+                return {
+                    enum: ['object', 'array', 'string', 'number', 'integer', 'boolean', 'null'],
+                };
+            }
+        },
+        allOf: (0, _1.listOf)('Schema'),
+        anyOf: (0, _1.listOf)('Schema'),
+        oneOf: (0, _1.listOf)('Schema'),
+        not: 'Schema',
+        if: 'Schema',
+        then: 'Schema',
+        else: 'Schema',
+        dependentSchemas: (0, _1.mapOf)('Schema'),
+        dependentRequired: 'DependentRequired',
+        prefixItems: (0, _1.listOf)('Schema'),
+        contains: 'Schema',
+        minContains: { type: 'integer', minimum: 0 },
+        maxContains: { type: 'integer', minimum: 0 },
+        patternProperties: 'PatternProperties',
+        propertyNames: 'Schema',
+        unevaluatedItems: (value) => {
+            if (typeof value === 'boolean') {
+                return { type: 'boolean' };
+            }
+            else {
+                return 'Schema';
+            }
+        },
+        unevaluatedProperties: (value) => {
+            if (typeof value === 'boolean') {
+                return { type: 'boolean' };
+            }
+            else {
+                return 'Schema';
+            }
+        },
+        summary: { type: 'string' },
+        properties: 'SchemaProperties',
+        items: (value) => {
+            if (typeof value === 'boolean') {
+                return { type: 'boolean' };
+            }
+            else {
+                return 'Schema';
+            }
+        },
+        additionalProperties: (value) => {
+            return typeof value === 'boolean' ? { type: 'boolean' } : 'Schema';
+        },
+        description: { type: 'string' },
+        format: { type: 'string' },
+        contentEncoding: { type: 'string' },
+        contentMediaType: { type: 'string' },
+        contentSchema: 'Schema',
+        default: null,
+        readOnly: { type: 'boolean' },
+        writeOnly: { type: 'boolean' },
+        xml: 'Xml',
+        examples: { type: 'array' },
+        example: { isExample: true },
+        deprecated: { type: 'boolean' },
+        const: null,
+        $comment: { type: 'string' },
+        'x-tags': { type: 'array', items: { type: 'string' } },
+        $dynamicAnchor: { type: 'string' },
+        $dynamicRef: { type: 'string' },
+    },
+    extensionsPrefix: 'x-',
+};
+exports.SchemaProperties = {
+    properties: {},
+    additionalProperties: (value) => {
+        if (typeof value === 'boolean') {
+            return { type: 'boolean' };
+        }
+        else {
+            return 'Schema';
+        }
+    },
+};
+const SecurityScheme = {
+    properties: {
+        type: { enum: ['apiKey', 'http', 'oauth2', 'openIdConnect', 'mutualTLS'] },
+        description: { type: 'string' },
+        name: { type: 'string' },
+        in: { type: 'string', enum: ['query', 'header', 'cookie'] },
+        scheme: { type: 'string' },
+        bearerFormat: { type: 'string' },
+        flows: 'OAuth2Flows',
+        openIdConnectUrl: { type: 'string' },
+    },
+    required(value) {
+        switch (value?.type) {
+            case 'apiKey':
+                return ['type', 'name', 'in'];
+            case 'http':
+                return ['type', 'scheme'];
+            case 'oauth2':
+                return ['type', 'flows'];
+            case 'openIdConnect':
+                return ['type', 'openIdConnectUrl'];
+            default:
+                return ['type'];
+        }
+    },
+    allowed(value) {
+        switch (value?.type) {
+            case 'apiKey':
+                return ['type', 'name', 'in', 'description'];
+            case 'http':
+                return ['type', 'scheme', 'bearerFormat', 'description'];
+            case 'oauth2':
+                switch (value?.flows) {
+                    case 'implicit':
+                        return ['type', 'flows', 'authorizationUrl', 'refreshUrl', 'description', 'scopes'];
+                    case 'password':
+                    case 'clientCredentials':
+                        return ['type', 'flows', 'tokenUrl', 'refreshUrl', 'description', 'scopes'];
+                    case 'authorizationCode':
+                        return [
+                            'type',
+                            'flows',
+                            'authorizationUrl',
+                            'refreshUrl',
+                            'tokenUrl',
+                            'description',
+                            'scopes',
+                        ];
+                    default:
+                        return [
+                            'type',
+                            'flows',
+                            'authorizationUrl',
+                            'refreshUrl',
+                            'tokenUrl',
+                            'description',
+                            'scopes',
+                        ];
+                }
+            case 'openIdConnect':
+                return ['type', 'openIdConnectUrl', 'description'];
+            case 'mutualTLS':
+                return ['type', 'description'];
+            default:
+                return ['type', 'description'];
+        }
+    },
+    extensionsPrefix: 'x-',
+};
+exports.DependentRequired = {
+    properties: {},
+    additionalProperties: { type: 'array', items: { type: 'string' } },
+};
+exports.Oas3_1Types = {
+    ...oas3_1.Oas3Types,
+    Info,
+    Root,
+    Schema: exports.Schema,
+    SchemaProperties: exports.SchemaProperties,
+    PatternProperties: exports.SchemaProperties,
+    License,
+    Components,
+    NamedPathItems: (0, _1.mapOf)('PathItem'),
+    SecurityScheme,
+    Operation,
+    DependentRequired: exports.DependentRequired,
+};

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

@@ -0,0 +1,26 @@
+import type { JSONSchema } from 'json-schema-to-ts';
+import type { NodeType } from '.';
+import type { Config } from '../config';
+declare const builtInOAS2Rules: readonly ["info-contact", "operation-operationId", "tag-description", "tags-alphabetical", "info-license-url", "info-license-strict", "info-license", "no-ambiguous-paths", "no-enum-type-mismatch", "no-http-verbs-in-paths", "no-identical-paths", "no-invalid-parameter-examples", "no-invalid-schema-examples", "no-path-trailing-slash", "operation-2xx-response", "operation-4xx-response", "operation-description", "operation-operationId-unique", "operation-operationId-url-safe", "operation-parameters-unique", "operation-singular-tag", "operation-summary", "operation-tag-defined", "parameter-description", "path-declaration-must-exist", "path-excludes-patterns", "path-http-verbs-order", "path-not-include-query", "path-params-defined", "path-parameters-defined", "path-segment-plural", "paths-kebab-case", "required-string-property-missing-min-length", "response-contains-header", "scalar-property-missing-example", "security-defined", "spec-strict-refs", "no-unresolved-refs", "no-required-schema-properties-undefined", "boolean-parameter-prefixes", "request-mime-type", "response-contains-property", "response-mime-type"];
+export type BuiltInOAS2RuleId = typeof builtInOAS2Rules[number];
+declare const builtInOAS3Rules: readonly ["info-contact", "operation-operationId", "tag-description", "tags-alphabetical", "info-license-url", "info-license-strict", "info-license", "no-ambiguous-paths", "no-enum-type-mismatch", "no-http-verbs-in-paths", "no-identical-paths", "no-invalid-parameter-examples", "no-invalid-schema-examples", "no-path-trailing-slash", "operation-2xx-response", "operation-4xx-response", "operation-description", "operation-operationId-unique", "operation-operationId-url-safe", "operation-parameters-unique", "operation-singular-tag", "operation-summary", "operation-tag-defined", "parameter-description", "path-declaration-must-exist", "path-excludes-patterns", "path-http-verbs-order", "path-not-include-query", "path-params-defined", "path-parameters-defined", "path-segment-plural", "paths-kebab-case", "required-string-property-missing-min-length", "response-contains-header", "scalar-property-missing-example", "security-defined", "spec-strict-refs", "no-unresolved-refs", "no-required-schema-properties-undefined", "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 ["info-contact", "info-license-strict", "operation-operationId", "tag-description", "tags-alphabetical", "channels-kebab-case", "no-channel-trailing-slash"];
+declare const builtInAsync3Rules: readonly ["info-contact", "info-license-strict", "operation-operationId", "tag-description", "tags-alphabetical", "channels-kebab-case", "no-channel-trailing-slash"];
+export type BuiltInAsync2RuleId = typeof builtInAsync2Rules[number];
+export type BuiltInAsync3RuleId = typeof builtInAsync3Rules[number];
+declare const builtInArazzo1Rules: readonly ["sourceDescription-type", "workflowId-unique", "stepId-unique", "sourceDescription-name-unique", "sourceDescriptions-not-empty", "workflow-dependsOn", "parameters-unique", "step-onSuccess-unique", "step-onFailure-unique", "spot-supported-versions", "requestBody-replacements-unique", "no-criteria-xpath", "criteria-unique"];
+export type BuiltInArazzo1RuleId = typeof builtInArazzo1Rules[number];
+declare const oas2NodeTypesList: readonly ["Root", "Tag", "TagList", "ExternalDocs", "SecurityRequirement", "SecurityRequirementList", "Info", "Contact", "License", "Paths", "PathItem", "Parameter", "ParameterList", "ParameterItems", "Operation", "Example", "ExamplesMap", "Examples", "Header", "Responses", "Response", "Schema", "Xml", "SchemaProperties", "NamedSchemas", "NamedResponses", "NamedParameters", "NamedSecuritySchemes", "SecurityScheme", "TagGroup", "TagGroups", "EnumDescriptions", "Logo", "XCodeSample", "XCodeSampleList", "XServer", "XServerList"];
+export type Oas2NodeType = typeof oas2NodeTypesList[number];
+declare const oas3NodeTypesList: readonly ["Root", "Tag", "TagList", "ExternalDocs", "Server", "ServerList", "ServerVariable", "ServerVariablesMap", "SecurityRequirement", "SecurityRequirementList", "Info", "Contact", "License", "Paths", "PathItem", "Parameter", "ParameterList", "Operation", "Callback", "CallbacksMap", "RequestBody", "MediaTypesMap", "MediaType", "Example", "ExamplesMap", "Encoding", "EncodingMap", "Header", "HeadersMap", "Responses", "Response", "Link", "LinksMap", "Schema", "Xml", "SchemaProperties", "DiscriminatorMapping", "Discriminator", "Components", "NamedSchemas", "NamedResponses", "NamedParameters", "NamedExamples", "NamedRequestBodies", "NamedHeaders", "NamedSecuritySchemes", "NamedLinks", "NamedCallbacks", "ImplicitFlow", "PasswordFlow", "ClientCredentials", "AuthorizationCode", "OAuth2Flows", "SecurityScheme", "TagGroup", "TagGroups", "EnumDescriptions", "Logo", "XCodeSample", "XCodeSampleList", "XUsePkce", "WebhooksMap"];
+export type Oas3NodeType = typeof oas3NodeTypesList[number];
+declare const oas3_1NodeTypesList: readonly ["Root", "Schema", "SchemaProperties", "PatternProperties", "Info", "License", "Components", "NamedPathItems", "SecurityScheme", "Operation", "DependentRequired"];
+export type Oas3_1NodeType = typeof oas3_1NodeTypesList[number];
+export declare function createConfigTypes(extraSchemas: JSONSchema, config?: Config): {
+    ConfigRoot: NodeType;
+    ConfigApisProperties: NodeType;
+    AssertionDefinitionSubject: NodeType;
+};
+export declare const ConfigTypes: Record<string, NodeType>;
+export {};