@redocly/openapi-core 1.17.1 → 1.18.0

package/src/types/arazzo.ts

@@ -0,0 +1,386 @@
+import type { NodeType } from '.';
+
+import { getNodeTypesFromJSONSchema } from './json-schema-adapter';
+
+export const ARAZZO_ROOT_TYPE = 'Root';
+
+const operationMethod = {
+  type: 'string',
+  enum: ['get', 'post', 'put', 'delete', 'patch'],
+} as const;
+const expectSchema = {
+  type: 'object',
+  properties: {
+    statusCode: { type: 'number' },
+    mimeType: { type: 'string' },
+    body: {},
+    schema: {
+      type: 'object',
+      additionalProperties: true,
+    },
+  },
+  additionalProperties: false,
+  oneOf: [
+    { required: ['statusCode'] },
+    { required: ['mimeType'] },
+    { required: ['body'] },
+    { required: ['schema'] },
+  ],
+} as const;
+const openAPISourceDescriptionSchema = {
+  type: 'object',
+  properties: {
+    name: { type: 'string' },
+    type: { type: 'string', enum: ['openapi'] },
+    url: { type: 'string' },
+    'x-serverUrl': { type: 'string' },
+  },
+  additionalProperties: false,
+  required: ['name', 'type', 'url'],
+} as const;
+const noneSourceDescriptionSchema = {
+  type: 'object',
+  properties: {
+    name: { type: 'string' },
+    type: { type: 'string', enum: ['none'] },
+    'x-serverUrl': { type: 'string' },
+  },
+  additionalProperties: false,
+  required: ['name', 'type', 'x-serverUrl'],
+} as const;
+const arazzoSourceDescriptionSchema = {
+  type: 'object',
+  properties: {
+    name: { type: 'string' },
+    type: { type: 'string', enum: ['arazzo'] },
+    url: { type: 'string' },
+  },
+  additionalProperties: false,
+  required: ['name', 'type', 'url'],
+} as const;
+const sourceDescriptionSchema = {
+  type: 'object',
+  oneOf: [
+    openAPISourceDescriptionSchema,
+    noneSourceDescriptionSchema,
+    arazzoSourceDescriptionSchema,
+  ],
+} as const;
+const sourceDescriptionsSchema = {
+  type: 'array',
+  items: sourceDescriptionSchema,
+} as const;
+const extendedOperation = {
+  type: 'object',
+  properties: {
+    path: { type: 'string' },
+    method: operationMethod,
+    sourceDescriptionName: { type: 'string' },
+    serverUrl: { type: 'string' },
+  },
+  additionalProperties: false,
+  required: ['path', 'method'],
+} as const;
+const parameter = {
+  type: 'object',
+  oneOf: [
+    {
+      type: 'object',
+      properties: {
+        in: { type: 'string', enum: ['header', 'query', 'path', 'cookie', 'body'] },
+        name: { type: 'string' },
+        value: {
+          oneOf: [{ type: 'string' }, { type: 'number' }, { type: 'boolean' }],
+        },
+      },
+      required: ['name', 'value'],
+      additionalProperties: false,
+    },
+    {
+      type: 'object',
+      properties: {
+        $ref: { type: 'string' },
+        value: {
+          oneOf: [{ type: 'string' }, { type: 'number' }, { type: 'boolean' }],
+        },
+      },
+      required: ['$ref'],
+      additionalProperties: false,
+    },
+    {
+      type: 'object',
+      properties: {
+        reference: { type: 'string' },
+        value: {
+          oneOf: [{ type: 'string' }, { type: 'number' }, { type: 'boolean' }],
+        },
+      },
+      required: ['reference'],
+      additionalProperties: false,
+    },
+  ],
+} as const;
+const parameters = {
+  type: 'array',
+  items: parameter,
+} as const;
+const infoObject = {
+  type: 'object',
+  properties: {
+    title: { type: 'string' },
+    description: { type: 'string' },
+    summary: { type: 'string' },
+    version: { type: 'string' },
+  },
+  additionalProperties: false,
+  required: ['title', 'version'],
+} as const;
+const replacement = {
+  type: 'object',
+  properties: {
+    target: { type: 'string' },
+    value: {
+      oneOf: [
+        { type: 'string' },
+        { type: 'object' },
+        { type: 'array' },
+        { type: 'number' },
+        { type: 'boolean' },
+      ],
+    },
+  },
+} as const;
+const requestBody = {
+  type: 'object',
+  properties: {
+    contentType: { type: 'string' },
+    payload: {
+      oneOf: [
+        { type: 'string' },
+        { type: 'object', additionalProperties: true },
+        { type: 'array' },
+        { type: 'number' },
+        { type: 'boolean' },
+      ],
+    },
+    encoding: { type: 'string' },
+    replacements: {
+      type: 'array',
+      items: replacement,
+    },
+  },
+  additionalProperties: false,
+  required: ['payload'],
+} as const;
+const criteriaObject = {
+  type: 'object',
+  properties: {
+    condition: { type: 'string' },
+    context: { type: 'string' },
+    type: {
+      oneOf: [
+        { type: 'string', enum: ['regex', 'jsonpath', 'simple', 'xpath'] },
+        {
+          type: 'object',
+          properties: {
+            type: { type: 'string', enum: ['jsonpath'] },
+            version: { type: 'string', enum: ['draft-goessner-dispatch-jsonpath-00'] },
+          },
+        },
+        {
+          type: 'object',
+          properties: {
+            type: { type: 'string', enum: ['xpath'] },
+            version: { type: 'string', enum: ['xpath-30', 'xpath-20', 'xpath-10'] },
+          },
+        },
+      ],
+    },
+  },
+  required: ['condition'],
+  additionalProperties: false,
+} as const;
+const criteriaObjects = {
+  type: 'array',
+  items: criteriaObject,
+} as const;
+const inherit = {
+  type: 'string',
+  enum: ['auto', 'none'],
+} as const;
+const onSuccessObject = {
+  type: 'object',
+  properties: {
+    name: { type: 'string' },
+    type: { type: 'string', enum: ['goto', 'end'] },
+    stepId: { type: 'string' },
+    workflowId: { type: 'string' },
+    criteria: criteriaObjects,
+  },
+  additionalProperties: false,
+  required: ['type', 'name'],
+} as const;
+const onSuccessList = {
+  type: 'array',
+  items: onSuccessObject,
+} as const;
+const onFailureObject = {
+  type: 'object',
+  properties: {
+    name: { type: 'string' },
+    type: { type: 'string', enum: ['goto', 'retry', 'end'] },
+    workflowId: { type: 'string' },
+    stepId: { type: 'string' },
+    retryAfter: { type: 'number' },
+    retryLimit: { type: 'number' },
+    criteria: criteriaObjects,
+  },
+  additionalProperties: false,
+  required: ['type', 'name'],
+} as const;
+const onFailureList = {
+  type: 'array',
+  items: onFailureObject,
+} as const;
+const step = {
+  type: 'object',
+  properties: {
+    stepId: { type: 'string' },
+    description: { type: 'string' },
+    operationId: { type: 'string' },
+    operationPath: { type: 'string' },
+    workflowId: { type: 'string' },
+    parameters: parameters,
+    successCriteria: criteriaObjects,
+    onSuccess: onSuccessList,
+    onFailure: onFailureList,
+    outputs: {
+      type: 'object',
+      additionalProperties: {
+        type: 'string',
+      },
+    },
+    'x-inherit': inherit,
+    'x-expect': expectSchema,
+    'x-assert': { type: 'string' },
+    'x-operation': extendedOperation,
+    requestBody: requestBody,
+  },
+  required: ['stepId'],
+  oneOf: [
+    { required: ['x-operation'] },
+    { required: ['operationId'] },
+    { required: ['operationPath'] },
+    { required: ['workflowId'] },
+  ],
+} as const;
+const steps = {
+  type: 'array',
+  items: step,
+} as const;
+const JSONSchema = {
+  type: 'object',
+  properties: {
+    type: {
+      type: 'string',
+      enum: ['object', 'array', 'string', 'number', 'integer', 'boolean', 'null'],
+    },
+    properties: {
+      type: 'object',
+      additionalProperties: true,
+    },
+    required: {
+      type: 'array',
+      items: { type: 'string' },
+    },
+    items: {
+      type: 'object',
+      additionalProperties: true,
+    },
+  },
+  required: ['type'],
+  additionalProperties: true,
+} as const;
+const workflow = {
+  type: 'object',
+  properties: {
+    workflowId: { type: 'string' },
+    summary: { type: 'string' },
+    description: { type: 'string' },
+    parameters: parameters,
+    dependsOn: { type: 'array', items: { type: 'string' } },
+    inputs: JSONSchema,
+    outputs: {
+      type: 'object',
+      additionalProperties: {
+        type: 'string',
+      },
+    },
+    steps: steps,
+    successActions: {
+      type: 'array',
+      items: onSuccessObject,
+    },
+    failureActions: {
+      type: 'array',
+      items: onFailureObject,
+    },
+  },
+  additionalProperties: false,
+  required: ['workflowId', 'steps'],
+} as const;
+const workflows = {
+  type: 'array',
+  items: workflow,
+} as const;
+export const arazzoSchema = {
+  type: 'object',
+  properties: {
+    arazzo: { type: 'string', enum: ['1.0.0'] },
+    info: infoObject,
+    sourceDescriptions: sourceDescriptionsSchema,
+    'x-parameters': parameters,
+    workflows: workflows,
+    components: {
+      type: 'object',
+      properties: {
+        inputs: {
+          type: 'object',
+          additionalProperties: {
+            type: 'object',
+            additionalProperties: true,
+            properties: {
+              type: {
+                type: 'string',
+              },
+              properties: {
+                type: 'object',
+                additionalProperties: true,
+              },
+            },
+            required: ['type'],
+          },
+        },
+        parameters: {
+          type: 'object',
+          additionalProperties: parameter,
+        },
+        successActions: {
+          type: 'object',
+          additionalProperties: onSuccessObject,
+        },
+        failureActions: {
+          type: 'object',
+          additionalProperties: onFailureObject,
+        },
+      },
+    },
+  },
+  additionalProperties: false,
+  required: ['arazzo', 'info', 'sourceDescriptions', 'workflows'],
+} as const;
+
+export const ArazzoTypes: Record<string, NodeType> = getNodeTypesFromJSONSchema(
+  ARAZZO_ROOT_TYPE,
+  arazzoSchema
+);

package/src/types/oas3.ts

@@ -346,13 +346,6 @@ const Schema: NodeType = {
         return 'Schema';
       }
     },
-    additionalItems: (value: any) => {
-      if (typeof value === 'boolean') {
-        return { type: 'boolean' };
-      } else {
-        return 'Schema';
-      }
-    },
     additionalProperties: (value: any) => {
       if (typeof value === 'boolean') {
         return { type: 'boolean' };

package/src/types/redocly-yaml.ts

@@ -8,17 +8,12 @@ import type { JSONSchema } from 'json-schema-to-ts';
 import { SpecVersion, getTypes } from '../oas-types';
 import { Config } from '../config';
 
-const builtInCommonRules = [
+const builtInCommonOASRules = [
   'spec',
   'info-contact',
   'operation-operationId',
   'tag-description',
   'tags-alphabetical',
-] as const;
-
-export type BuiltInCommonRuleId = typeof builtInCommonRules[number];
-
-const builtInCommonOASRules = [
   'info-license-url',
   'info-license',
   'no-ambiguous-paths',
@@ -87,16 +82,28 @@ const builtInOAS3Rules = [
 
 export type BuiltInOAS3RuleId = typeof builtInOAS3Rules[number];
 
-const builtInAsync2Rules = ['channels-kebab-case', 'no-channel-trailing-slash'] as const;
+const builtInAsync2Rules = [
+  'spec',
+  'info-contact',
+  'operation-operationId',
+  'tag-description',
+  'tags-alphabetical',
+  'channels-kebab-case',
+  'no-channel-trailing-slash',
+] as const;
 
 export type BuiltInAsync2RuleId = typeof builtInAsync2Rules[number];
 
+const builtInArazzoRules = ['spec'] as const;
+
+export type BuiltInArazzoRuleId = typeof builtInArazzoRules[number];
+
 const builtInRules = [
-  ...builtInCommonRules,
   ...builtInCommonOASRules,
   ...builtInOAS2Rules,
   ...builtInOAS3Rules,
   ...builtInAsync2Rules,
+  ...builtInArazzoRules,
 ] as const;
 
 type BuiltInRuleId = typeof builtInRules[number];
@@ -238,16 +245,19 @@ const ConfigStyleguide: NodeType = {
     oas3_0Rules: 'Rules',
     oas3_1Rules: 'Rules',
     async2Rules: 'Rules',
+    arazzoRules: 'Rules',
     preprocessors: { type: 'object' },
     oas2Preprocessors: { type: 'object' },
     oas3_0Preprocessors: { type: 'object' },
     oas3_1Preprocessors: { type: 'object' },
     async2Preprocessors: { type: 'object' },
+    arazzoPreprocessors: { type: 'object' },
     decorators: { type: 'object' },
     oas2Decorators: { type: 'object' },
     oas3_0Decorators: { type: 'object' },
     oas3_1Decorators: { type: 'object' },
     async2Decorators: { type: 'object' },
+    arazzoDecorators: { type: 'object' },
   },
 };
 

package/src/typings/arazzo.ts

@@ -0,0 +1,4 @@
+import type { FromSchema } from 'json-schema-to-ts';
+import type { arazzoSchema } from '../types/arazzo';
+
+export type ArazzoDefinition = FromSchema<typeof arazzoSchema>;

package/src/visitors.ts

@@ -50,6 +50,7 @@ import type {
   Oas2SecurityScheme,
 } from './typings/swagger';
 import type { Async2Definition } from './typings/asyncapi';
+import type { ArazzoDefinition } from './typings/arazzo';
 
 export type SkipFunctionContext = Pick<
   UserContext,
@@ -212,6 +213,10 @@ type Async2FlatVisitor = {
   Root?: VisitFunctionOrObject<Async2Definition>;
 };
 
+type ArazzoFlatVisitor = {
+  Root?: VisitFunctionOrObject<ArazzoDefinition>;
+};
+
 const legacyTypesMap = {
   Root: 'DefinitionRoot',
   ServerVariablesMap: 'ServerVariableMap',
@@ -244,6 +249,12 @@ type Async2NestedVisitor = {
     : Async2FlatVisitor[T] & NestedVisitor<Async2NestedVisitor>;
 };
 
+type ArazzoNestedVisitor = {
+  [T in keyof ArazzoFlatVisitor]: ArazzoFlatVisitor[T] extends Function
+    ? ArazzoFlatVisitor[T]
+    : ArazzoFlatVisitor[T] & NestedVisitor<ArazzoNestedVisitor>;
+};
+
 export type Oas3Visitor = BaseVisitor &
   Oas3NestedVisitor &
   Record<string, VisitFunction<any> | NestedVisitObject<any, Oas3NestedVisitor>>;
@@ -256,6 +267,10 @@ export type Async2Visitor = BaseVisitor &
   Async2NestedVisitor &
   Record<string, VisitFunction<any> | NestedVisitObject<any, Async2NestedVisitor>>;
 
+export type ArazzoVisitor = BaseVisitor &
+  ArazzoNestedVisitor &
+  Record<string, VisitFunction<any> | NestedVisitObject<any, ArazzoNestedVisitor>>;
+
 export type NestedVisitor<T> = Exclude<T, 'any' | 'ref' | 'Root'>;
 
 export type NormalizedOasVisitors<T extends BaseVisitor> = {
@@ -278,12 +293,15 @@ 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 ArazzoRule = (options: Record<string, any>) => ArazzoVisitor | ArazzoVisitor[];
 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 ArazzoPreprocessor = (options: Record<string, any>) => ArazzoVisitor;
 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 ArazzoDecorator = (options: Record<string, any>) => ArazzoVisitor;
 
 // alias for the latest version supported
 // every time we update it - consider semver