@e22m4u/js-openapi 0.0.5 → 0.0.6

package/src/ajv.js

@@ -0,0 +1,32 @@
+import addFormats from 'ajv-formats';
+import Ajv2020 from 'ajv/dist/2020.js';
+import schema from '../schema/openapi-3-1/schema.js';
+import schemaBase from '../schema/openapi-3-1/schema-base.js';
+import vocabularySchema from '../schema/openapi-3-1/meta/base.js';
+import dialectSchema from '../schema/openapi-3-1/dialect/base.js';
+
+export const ajv = new Ajv2020({
+  strictTypes: false,
+  validateFormats: true,
+  allowUnionTypes: true,
+  allowMatchingProperties: true,
+});
+addFormats(ajv);
+
+ajv.addFormat('media-range', {
+  type: 'string',
+  validate: value => {
+    return /^[a-z]+\/([a-z0-9\-+.]+|\*)$/i.test(value);
+  },
+});
+
+ajv.addSchema(vocabularySchema, 'https://spec.openapis.org/oas/3.1/meta/base');
+ajv.addSchema(dialectSchema, 'https://spec.openapis.org/oas/3.1/dialect/base');
+ajv.addSchema(schemaBase, 'https://spec.openapis.org/oas/3.1/schema-base');
+ajv.addSchema(schema, 'https://spec.openapis.org/oas/3.1/schema');
+
+export const OA_DOCUMENT_OBJECT_JSON_SCHEMA_URI =
+  'https://spec.openapis.org/oas/3.1/schema';
+
+// pre-compilation (170ms)
+ajv.getSchema(OA_DOCUMENT_OBJECT_JSON_SCHEMA_URI);

package/src/errors/index.d.ts

@@ -1 +1 @@
-export * from './oa-data-validation-error.js';
+export * from './oa-document-object-validation-error.js';

package/src/errors/index.js

@@ -1 +1 @@
-export * from './oa-data-validation-error.js';
+export * from './oa-document-object-validation-error.js';

package/src/errors/oa-document-object-validation-error.d.ts

@@ -0,0 +1,6 @@
+import {Errorf} from '@e22m4u/js-format';
+
+/**
+ * Document object validation error.
+ */
+export declare class OADocumentObjectValidationError extends Errorf {}

package/src/errors/oa-document-object-validation-error.js

@@ -0,0 +1,6 @@
+import {Errorf} from '@e22m4u/js-format';
+
+/**
+ * Document object validation error.
+ */
+export class OADocumentObjectValidationError extends Errorf {}

package/src/errors/oa-document-object-validation-error.spec.js

@@ -0,0 +1,10 @@
+import {expect} from 'chai';
+import {Errorf} from '@e22m4u/js-format';
+import {OADocumentObjectValidationError} from './oa-document-object-validation-error.js';
+
+describe('OADocumentObjectValidationError', function () {
+  it('should extend the Errorf class', function () {
+    const error = new OADocumentObjectValidationError();
+    expect(error).to.be.instanceof(Errorf);
+  });
+});

package/src/index.d.ts

@@ -1,9 +1,7 @@
 export * from './errors/index.js';
-export * from './data-type/index.js';
 export * from './oa-specification.js';
-export * from './oa-document-scope.js';
 export * from './json-pointer/index.js';
+export * from './oa-operation-group.js';
 export * from './oa-document-builder.js';
-export * from './data-validation/index.js';
 export * from './oa-document-object/index.js';
 export * from './oa-reference-object/index.js';

package/src/index.js

@@ -1,9 +1,7 @@
 export * from './errors/index.js';
-export * from './data-type/index.js';
 export * from './oa-specification.js';
-export * from './oa-document-scope.js';
 export * from './json-pointer/index.js';
+export * from './oa-operation-group.js';
 export * from './oa-document-builder.js';
-export * from './data-validation/index.js';
 export * from './oa-document-object/index.js';
 export * from './oa-reference-object/index.js';

package/src/json-pointer/resolve-json-pointer.js

@@ -37,7 +37,7 @@ export function resolveJsonPointer(document, pointer) {
   // в противном случае выбрасывается ошибка
   if (!pointer.startsWith('/')) {
     throw new InvalidArgumentError(
-      'JSON pointer must start with a forward slash "/", but %v was given.',
+      'JSON pointer must start with "/", but %v was given.',
       pointer,
     );
   }

package/src/json-pointer/unescape-json-pointer.d.ts

@@ -2,7 +2,6 @@
  * Unescape JSON Pointer.
  * Replaces "~1" with "/" and "~0" with "~".
  *
- * @param {string} jsonPointer
- * @returns {string}
+ * @param jsonPointer
  */
 export declare function unescapeJsonPointer(jsonPointer: string): string;

package/src/oa-document-builder.d.ts

@@ -1,6 +1,10 @@
 import {Optional} from './types.js';
 import {Service, ServiceContainer} from '@e22m4u/js-service';
-import {OADocumentScope, OADocumentScopeOptions} from './oa-document-scope.js';
+
+import {
+  OAOperationGroup,
+  OAOperationGroupOptions,
+} from './oa-operation-group.js';
 
 import {
   OADocumentObject,
@@ -50,96 +54,15 @@ export declare const OA_COMPONENT_TYPES: OAComponentType[];
  * Component type to components key map.
  */
 export declare const OA_COMPONENT_TYPE_TO_COMPONENTS_KEY_MAP: {
-  [OAComponentType.SCHEMA]: 'schemas';
-  [OAComponentType.RESPONSE]: 'responses';
-  [OAComponentType.PARAMETER]: 'parameters';
-  [OAComponentType.EXAMPLE]: 'examples';
-  [OAComponentType.REQUEST_BODY]: 'requestBodies';
-  [OAComponentType.HEADER]: 'headers';
-  [OAComponentType.SECURITY_SCHEME]: 'securitySchemes';
-  [OAComponentType.LINK]: 'links';
-  [OAComponentType.CALLBACK]: 'callbacks';
-  [OAComponentType.PATH_ITEM]: 'pathItems';
-};
-
-/**
- * Schema component definition.
- */
-export type OASchemaComponentDefinition = {
-  name: string;
-  schema: OASchemaObject;
-};
-
-/**
- * Response component definition.
- */
-export type OAResponseComponentDefinition = {
-  name: string;
-  response: OAResponseObject | OAReferenceObject;
-};
-
-/**
- * Parameter component definition.
- */
-export type OAParameterComponentDefinition = {
-  name: string;
-  parameter: OAParameterObject | OAReferenceObject;
-};
-
-/**
- * Example component definition.
- */
-export type OAExampleComponentDefinition = {
-  name: string;
-  example: OAExampleObject | OAReferenceObject;
+  [k in OAComponentType]: string | undefined;
 };
 
 /**
- * Request body component definition.
+ * Component type to definition name map.
+ * "#/$defs/${name}"
  */
-export type OARequestBodyComponentDefinition = {
-  name: string;
-  requestBody: OARequestBodyObject | OAReferenceObject;
-};
-
-/**
- * Header component definition.
- */
-export type OAHeaderComponentDefinition = {
-  name: string;
-  header: OAHeaderObject | OAReferenceObject;
-};
-
-/**
- * Security scheme component definition.
- */
-export type OASecuritySchemeComponentDefinition = {
-  name: string;
-  securityScheme: OASecuritySchemeObject | OAReferenceObject;
-};
-
-/**
- * Link component definition.
- */
-export type OALinkComponentDefinition = {
-  name: string;
-  link: OALinkObject | OAReferenceObject;
-};
-
-/**
- * Callback component definition.
- */
-export type OACallbackComponentDefinition = {
-  name: string;
-  callback: OACallbackObject | OAReferenceObject;
-};
-
-/**
- * Path item component definition.
- */
-export type OAPathItemComponentDefinition = {
-  name: string;
-  pathItem: OAPathItemObject | OAReferenceObject;
+export declare const OA_COMPONENT_TYPE_TO_DEFINITION_NAME_MAP: {
+  [k in OAComponentType]: string | undefined;
 };
 
 /**
@@ -148,7 +71,7 @@ export type OAPathItemComponentDefinition = {
 export type OAOperationDefinition = {
   path: string;
   method: OAOperationMethod;
-  operation: OAOperationObject;
+  operation?: OAOperationObject;
 };
 
 /**
@@ -186,13 +109,138 @@ export declare class OADocumentBuilder extends Service {
     document?: OADocumentInput,
   );
 
+  /**
+   * Get document object reference.
+   */
+  getDocumentObjectRef(): OADocumentObject;
+
+  /**
+   * Define component (schema).
+   *
+   * @param type
+   * @param definition
+   */
+  defineComponent(
+    type: typeof OAComponentType.SCHEMA,
+    name: string,
+    component: OASchemaObject | OAReferenceObject,
+  ): this;
+
+  /**
+   * Define component (response).
+   *
+   * @param type
+   * @param definition
+   */
+  defineComponent(
+    type: typeof OAComponentType.RESPONSE,
+    name: string,
+    component: OAResponseObject | OAReferenceObject,
+  ): this;
+
+  /**
+   * Define component (parameter).
+   *
+   * @param type
+   * @param definition
+   */
+  defineComponent(
+    type: typeof OAComponentType.PARAMETER,
+    name: string,
+    component: OAParameterObject | OAReferenceObject,
+  ): this;
+
+  /**
+   * Define component (example).
+   *
+   * @param type
+   * @param definition
+   */
+  defineComponent(
+    type: typeof OAComponentType.EXAMPLE,
+    name: string,
+    component: OAExampleObject | OAReferenceObject,
+  ): this;
+
+  /**
+   * Define component (request body).
+   *
+   * @param type
+   * @param definition
+   */
+  defineComponent(
+    type: typeof OAComponentType.REQUEST_BODY,
+    name: string,
+    component: OARequestBodyObject | OAReferenceObject,
+  ): this;
+
+  /**
+   * Define component (header).
+   *
+   * @param type
+   * @param definition
+   */
+  defineComponent(
+    type: typeof OAComponentType.HEADER,
+    name: string,
+    component: OAHeaderObject | OAReferenceObject,
+  ): this;
+
+  /**
+   * Define component (security scheme).
+   *
+   * @param type
+   * @param definition
+   */
+  defineComponent(
+    type: typeof OAComponentType.SECURITY_SCHEME,
+    name: string,
+    component: OASecuritySchemeObject | OAReferenceObject,
+  ): this;
+
+  /**
+   * Define component (link).
+   *
+   * @param type
+   * @param definition
+   */
+  defineComponent(
+    type: typeof OAComponentType.LINK,
+    name: string,
+    component: OALinkObject | OAReferenceObject,
+  ): this;
+
+  /**
+   * Define component (callback).
+   *
+   * @param type
+   * @param definition
+   */
+  defineComponent(
+    type: typeof OAComponentType.CALLBACK,
+    name: string,
+    component: OACallbackObject | OAReferenceObject,
+  ): this;
+
+  /**
+   * Define component (path item).
+   *
+   * @param type
+   * @param definition
+   */
+  defineComponent(
+    type: typeof OAComponentType.PATH_ITEM,
+    name: string,
+    component: OAPathItemObject | OAReferenceObject,
+  ): this;
+
   /**
    * Define component.
    *
    * @param type
    * @param definition
    */
-  defineComponent(type: OAComponentType, definition: object): this;
+  defineComponent(type: OAComponentType, name: string, component: object): this;
 
   /**
    * Has component.
@@ -202,6 +250,116 @@ export declare class OADocumentBuilder extends Service {
    */
   hasComponent(type: OAComponentType, name: string): boolean;
 
+  /**
+   * Get component (schema).
+   *
+   * @param type
+   * @param definition
+   */
+  getComponent(
+    type: typeof OAComponentType.SCHEMA,
+    name: string,
+  ): OASchemaObject | OAReferenceObject;
+
+  /**
+   * Get component (response).
+   *
+   * @param type
+   * @param definition
+   */
+  getComponent(
+    type: typeof OAComponentType.RESPONSE,
+    name: string,
+  ): OAResponseObject | OAReferenceObject;
+
+  /**
+   * Get component (parameter).
+   *
+   * @param type
+   * @param definition
+   */
+  getComponent(
+    type: typeof OAComponentType.PARAMETER,
+    name: string,
+  ): OAParameterObject | OAReferenceObject;
+
+  /**
+   * Get component (example).
+   *
+   * @param type
+   * @param definition
+   */
+  getComponent(
+    type: typeof OAComponentType.EXAMPLE,
+    name: string,
+  ): OAExampleObject | OAReferenceObject;
+
+  /**
+   * Get component (request body).
+   *
+   * @param type
+   * @param definition
+   */
+  getComponent(
+    type: typeof OAComponentType.REQUEST_BODY,
+    name: string,
+  ): OARequestBodyObject | OAReferenceObject;
+
+  /**
+   * Get component (header).
+   *
+   * @param type
+   * @param definition
+   */
+  getComponent(
+    type: typeof OAComponentType.HEADER,
+    name: string,
+  ): OAHeaderObject | OAReferenceObject;
+
+  /**
+   * Get component (security scheme).
+   *
+   * @param type
+   * @param definition
+   */
+  getComponent(
+    type: typeof OAComponentType.SECURITY_SCHEME,
+    name: string,
+  ): OASecuritySchemeObject | OAReferenceObject;
+
+  /**
+   * Get component (link).
+   *
+   * @param type
+   * @param definition
+   */
+  getComponent(
+    type: typeof OAComponentType.LINK,
+    name: string,
+  ): OALinkObject | OAReferenceObject;
+
+  /**
+   * Get component (callback).
+   *
+   * @param type
+   * @param definition
+   */
+  getComponent(
+    type: typeof OAComponentType.CALLBACK,
+    name: string,
+  ): OACallbackObject | OAReferenceObject;
+
+  /**
+   * Get component (path item).
+   *
+   * @param type
+   * @param definition
+   */
+  getComponent(
+    type: typeof OAComponentType.PATH_ITEM,
+    name: string,
+  ): OAPathItemObject | OAReferenceObject;
+
   /**
    * Get component.
    *
@@ -213,76 +371,109 @@ export declare class OADocumentBuilder extends Service {
   /**
    * Define schema component.
    *
-   * @param schemaDef
+   * @param name
+   * @param component
    */
-  defineSchemaComponent(schemaDef: OASchemaComponentDefinition): this;
+  defineSchemaComponent(
+    name: string,
+    component: OASchemaObject | OAReferenceObject,
+  ): this;
 
   /**
    * Define response component.
    *
-   * @param responseDef
+   * @param name
+   * @param component
    */
-  defineResponseComponent(responseDef: OAResponseComponentDefinition): this;
+  defineResponseComponent(
+    name: string,
+    component: OAResponseObject | OAReferenceObject,
+  ): this;
 
   /**
    * Define parameter component.
    *
-   * @param parameterDef
+   * @param name
+   * @param component
    */
-  defineParameterComponent(parameterDef: OAParameterComponentDefinition): this;
+  defineParameterComponent(
+    name: string,
+    component: OAParameterObject | OAReferenceObject,
+  ): this;
 
   /**
    * Define example component.
    *
-   * @param exampleDef
+   * @param name
+   * @param component
    */
-  defineExampleComponent(exampleDef: OAExampleComponentDefinition): this;
+  defineExampleComponent(
+    name: string,
+    component: OAExampleObject | OAReferenceObject,
+  ): this;
 
   /**
    * Define request body component.
    *
-   * @param requestBodyDef
+   * @param name
+   * @param component
    */
   defineRequestBodyComponent(
-    requestBodyDef: OARequestBodyComponentDefinition,
+    name: string,
+    component: OARequestBodyObject | OAReferenceObject,
   ): this;
 
   /**
    * Define header component.
    *
-   * @param headerDef
+   * @param name
+   * @param component
    */
-  defineHeaderComponent(headerDef: OAHeaderComponentDefinition): this;
+  defineHeaderComponent(
+    name: string,
+    component: OAHeaderObject | OAReferenceObject,
+  ): this;
 
   /**
    * Define security scheme component.
    *
-   * @param securitySchemeDef
+   * @param name
+   * @param component
    */
   defineSecuritySchemeComponent(
-    securitySchemeDef: OASecuritySchemeComponentDefinition,
+    name: string,
+    component: OASecuritySchemeObject | OAReferenceObject,
   ): this;
 
   /**
    * Define link component.
    *
-   * @param linkDef
+   * @param name
+   * @param component
    */
-  defineLinkComponent(linkDef: OALinkComponentDefinition): this;
+  defineLinkComponent(
+    name: string,
+    component: OALinkObject | OAReferenceObject,
+  ): this;
 
   /**
    * Define callback component.
    *
-   * @param callbackDef
+   * @param name
+   * @param component
    */
-  defineCallbackComponent(callbackDef: OACallbackComponentDefinition): this;
+  defineCallbackComponent(
+    name: string,
+    component: OACallbackObject | OAReferenceObject,
+  ): this;
 
   /**
    * Define path item component.
    *
-   * @param pathItemDef
+   * @param name
+   * @param component
    */
-  definePathItemComponent(pathItemDef: OAPathItemComponentDefinition): this;
+  definePathItemComponent(name: string, component: OAPathItemObject): this;
 
   /**
    * Define operation.
@@ -292,11 +483,11 @@ export declare class OADocumentBuilder extends Service {
   defineOperation(operationDef: OAOperationDefinition): this;
 
   /**
-   * Create scope.
+   * Create operation group.
    *
    * @param options
    */
-  createScope(options?: OADocumentScopeOptions): OADocumentScope;
+  createOperationGroup(options?: OAOperationGroupOptions): OAOperationGroup;
 
   /**
    * Build.