@e22m4u/js-openapi 0.0.5 → 0.0.7

package/src/errors/oa-data-validation-error.d.ts

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

package/src/errors/oa-data-validation-error.js

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

package/src/errors/oa-data-validation-error.spec.js

@@ -1,17 +0,0 @@
-import {expect} from 'chai';
-import {InvalidArgumentError} from '@e22m4u/js-format';
-import {OADataValidationError} from './oa-data-validation-error.js';
-
-describe('OADataValidationError', function () {
-  describe('constructor', function () {
-    it('should interpolate an error message with given arguments', function () {
-      const res = new OADataValidationError('message %v %s', 'str', 10);
-      expect(res.message).to.be.eql('message "str" 10');
-    });
-
-    it('should not extend the InvalidArgumentError class', function () {
-      const res = new OADataValidationError('message');
-      expect(res).to.be.not.instanceOf(InvalidArgumentError);
-    });
-  });
-});

package/src/oa-document-object/validate-shallow-oa-document.d.ts

@@ -1,10 +0,0 @@
-import {OADocumentObject} from '../oa-specification.js';
-
-/**
- * Validate shallow OADocumentObject.
- *
- * @param documentObject
- */
-export declare function validateShallowOADocument(
-  documentObject: OADocumentObject,
-): void;

package/src/oa-document-object/validate-shallow-oa-document.js

@@ -1,209 +0,0 @@
-import {InvalidArgumentError} from '@e22m4u/js-format';
-
-/**
- * Validate shallow OADocumentObject.
- *
- * @param {object} documentObject
- */
-export function validateShallowOADocument(documentObject) {
-  if (
-    !documentObject ||
-    typeof documentObject !== 'object' ||
-    Array.isArray(documentObject)
-  ) {
-    throw new InvalidArgumentError(
-      'OpenAPI Document Object must be an Object, but %v was given.',
-      documentObject,
-    );
-  }
-  // openapi
-  if (!documentObject.openapi || typeof documentObject.openapi !== 'string') {
-    throw new InvalidArgumentError(
-      'Property "openapi" must be a non-empty String, but %v was given.',
-      documentObject.openapi,
-    );
-  }
-  // info
-  if (
-    !documentObject.info ||
-    typeof documentObject.info !== 'object' ||
-    Array.isArray(documentObject.info)
-  ) {
-    throw new InvalidArgumentError(
-      'Property "info" must be an Object, but %v was given.',
-      documentObject.info,
-    );
-  }
-  // info.title
-  if (
-    !documentObject.info.title ||
-    typeof documentObject.info.title !== 'string'
-  ) {
-    throw new InvalidArgumentError(
-      'Property "info.title" must be a non-empty String, but %v was given.',
-      documentObject.info.title,
-    );
-  }
-  // info.version
-  if (
-    !documentObject.info.version ||
-    typeof documentObject.info.version !== 'string'
-  ) {
-    throw new InvalidArgumentError(
-      'Property "info.version" must be a non-empty String, but %v was given.',
-      documentObject.info.version,
-    );
-  }
-  // jsonSchemaDialect
-  if (documentObject.jsonSchemaDialect !== undefined) {
-    if (
-      !documentObject.jsonSchemaDialect ||
-      typeof documentObject.jsonSchemaDialect !== 'string'
-    ) {
-      throw new InvalidArgumentError(
-        'Property "jsonSchemaDialect" must be a non-empty String, ' +
-          'but %v was given.',
-        documentObject.jsonSchemaDialect,
-      );
-    }
-  }
-  // servers
-  if (documentObject.servers !== undefined) {
-    if (!Array.isArray(documentObject.servers)) {
-      throw new InvalidArgumentError(
-        'Property "servers" must be an Array, but %v was given.',
-        documentObject.servers,
-      );
-    }
-    // servers[n]
-    documentObject.servers.forEach((serverObject, index) => {
-      if (
-        !serverObject ||
-        typeof serverObject !== 'object' ||
-        Array.isArray(serverObject)
-      ) {
-        throw new InvalidArgumentError(
-          'Element "servers[%d]" must be an Object, but %v was given.',
-          index,
-          serverObject,
-        );
-      }
-      // servers[n].url
-      if (!serverObject.url || typeof serverObject.url !== 'string') {
-        throw new InvalidArgumentError(
-          'Property "servers[%d].url" must be a non-empty String, ' +
-            'but %v was given.',
-          index,
-          serverObject.url,
-        );
-      }
-    });
-  }
-  // paths
-  if (documentObject.paths !== undefined) {
-    if (
-      !documentObject.paths ||
-      typeof documentObject.paths !== 'object' ||
-      Array.isArray(documentObject.paths)
-    ) {
-      throw new InvalidArgumentError(
-        'Property "paths" must be an Object, but %v was given.',
-        documentObject.paths,
-      );
-    }
-  }
-  // webhooks
-  if (documentObject.webhooks !== undefined) {
-    if (
-      !documentObject.webhooks ||
-      typeof documentObject.webhooks !== 'object' ||
-      Array.isArray(documentObject.webhooks)
-    ) {
-      throw new InvalidArgumentError(
-        'Property "webhooks" must be an Object, but %v was given.',
-        documentObject.webhooks,
-      );
-    }
-  }
-  // components
-  if (documentObject.components !== undefined) {
-    if (
-      !documentObject.components ||
-      typeof documentObject.components !== 'object' ||
-      Array.isArray(documentObject.components)
-    ) {
-      throw new InvalidArgumentError(
-        'Property "components" must be an Object, but %v was given.',
-        documentObject.components,
-      );
-    }
-  }
-  // security
-  if (documentObject.security !== undefined) {
-    if (!Array.isArray(documentObject.security)) {
-      throw new InvalidArgumentError(
-        'Property "security" must be an Array, but %v was given.',
-        documentObject.security,
-      );
-    }
-    // security[n]
-    documentObject.security.forEach((securityRequirementObject, index) => {
-      if (
-        !securityRequirementObject ||
-        typeof securityRequirementObject !== 'object' ||
-        Array.isArray(securityRequirementObject)
-      ) {
-        throw new InvalidArgumentError(
-          'Element "security[%d]" must be an Object, but %v was given.',
-          index,
-          securityRequirementObject,
-        );
-      }
-    });
-  }
-  // tags
-  if (documentObject.tags !== undefined) {
-    if (!Array.isArray(documentObject.tags)) {
-      throw new InvalidArgumentError(
-        'Property "tags" must be an Array, but %v was given.',
-        documentObject.tags,
-      );
-    }
-    // tags[n]
-    documentObject.tags.forEach((tagObject, index) => {
-      if (
-        !tagObject ||
-        typeof tagObject !== 'object' ||
-        Array.isArray(tagObject)
-      ) {
-        throw new InvalidArgumentError(
-          'Element "tags[%d]" must be an Object, but %v was given.',
-          index,
-          tagObject,
-        );
-      }
-      // tags[n].name
-      if (!tagObject.name || typeof tagObject.name !== 'string') {
-        throw new InvalidArgumentError(
-          'Property "tags[%d].name" must be a non-empty String, ' +
-            'but %v was given.',
-          index,
-          tagObject.name,
-        );
-      }
-    });
-  }
-  // externalDocs
-  if (documentObject.externalDocs !== undefined) {
-    if (
-      !documentObject.externalDocs ||
-      typeof documentObject.externalDocs !== 'object' ||
-      Array.isArray(documentObject.externalDocs)
-    ) {
-      throw new InvalidArgumentError(
-        'Property "externalDocs" must be an Object, but %v was given.',
-        documentObject.externalDocs,
-      );
-    }
-  }
-}

package/src/oa-document-object/validate-shallow-oa-document.spec.js

@@ -1,362 +0,0 @@
-import {expect} from 'chai';
-import {format} from '@e22m4u/js-format';
-import {OPENAPI_VERSION} from '../oa-specification.js';
-import {validateShallowOADocument} from './validate-shallow-oa-document.js';
-
-const MINIMAL_DOCUMENT = {
-  openapi: OPENAPI_VERSION,
-  info: {title: 'API Documentation', version: '0.0.1'},
-};
-
-describe('validateShallowOADocument', function () {
-  it('should require the first parameter to be an Object', function () {
-    const throwable = v => () => validateShallowOADocument(v);
-    const error = s =>
-      format('OpenAPI Document Object must be an Object, but %s was given.', s);
-    expect(throwable('str')).to.throw(error('"str"'));
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable([])).to.throw(error('Array'));
-    expect(throwable(undefined)).to.throw(error('undefined'));
-    expect(throwable(null)).to.throw(error('null'));
-    throwable(MINIMAL_DOCUMENT)();
-  });
-
-  it('should require the "openapi" property to be a non-empty String', function () {
-    const throwable = v => () =>
-      validateShallowOADocument({
-        ...MINIMAL_DOCUMENT,
-        openapi: v,
-      });
-    const error = s =>
-      format(
-        'Property "openapi" must be a non-empty String, but %s was given.',
-        s,
-      );
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable([])).to.throw(error('Array'));
-    expect(throwable({})).to.throw(error('Object'));
-    expect(throwable(undefined)).to.throw(error('undefined'));
-    expect(throwable(null)).to.throw(error('null'));
-    throwable('3.1.0')();
-  });
-
-  it('should require the "info" property to be an Object', function () {
-    const throwable = v => () =>
-      validateShallowOADocument({
-        openapi: OPENAPI_VERSION,
-        info: v,
-      });
-    const error = s =>
-      format('Property "info" must be an Object, but %s was given.', s);
-    expect(throwable('str')).to.throw(error('"str"'));
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable([])).to.throw(error('Array'));
-    expect(throwable(undefined)).to.throw(error('undefined'));
-    expect(throwable(null)).to.throw(error('null'));
-    throwable({title: 'API Documentation', version: '0.0.1'})();
-  });
-
-  it('should require the "info.title" property to be a non-empty String', function () {
-    const throwable = v => () =>
-      validateShallowOADocument({
-        openapi: OPENAPI_VERSION,
-        info: {
-          title: v,
-          version: '0.0.1',
-        },
-      });
-    const error = s =>
-      format(
-        'Property "info.title" must be a non-empty String, but %s was given.',
-        s,
-      );
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable([])).to.throw(error('Array'));
-    expect(throwable({})).to.throw(error('Object'));
-    expect(throwable(undefined)).to.throw(error('undefined'));
-    expect(throwable(null)).to.throw(error('null'));
-    throwable('API Documentation')();
-  });
-
-  it('should require the "jsonSchemaDialect" property to be a non-empty String', function () {
-    const throwable = v => () =>
-      validateShallowOADocument({
-        ...MINIMAL_DOCUMENT,
-        jsonSchemaDialect: v,
-      });
-    const error = s =>
-      format(
-        'Property "jsonSchemaDialect" must be a non-empty String, but %s was given.',
-        s,
-      );
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable([])).to.throw(error('Array'));
-    expect(throwable({})).to.throw(error('Object'));
-    expect(throwable(null)).to.throw(error('null'));
-    throwable('https://json-schema.org/draft/2020-12/schema')();
-    throwable(undefined)();
-  });
-
-  it('should require the "servers" property to be an Array', function () {
-    const throwable = v => () =>
-      validateShallowOADocument({
-        ...MINIMAL_DOCUMENT,
-        servers: v,
-      });
-    const error = s =>
-      format('Property "servers" must be an Array, but %s was given.', s);
-    expect(throwable('str')).to.throw(error('"str"'));
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable({})).to.throw(error('Object'));
-    expect(throwable(null)).to.throw(error('null'));
-    throwable([{url: 'http://localhost'}])();
-    throwable([])();
-  });
-
-  it('should require elements of the "servers" property to be an Object', function () {
-    const throwable = v => () =>
-      validateShallowOADocument({
-        ...MINIMAL_DOCUMENT,
-        servers: [v],
-      });
-    const error = s =>
-      format('Element "servers[0]" must be an Object, but %s was given.', s);
-    expect(throwable('str')).to.throw(error('"str"'));
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable([])).to.throw(error('Array'));
-    expect(throwable(null)).to.throw(error('null'));
-    throwable({url: 'http://localhost'})();
-  });
-
-  it('should require the "servers[n].url" property to be a non-empty String', function () {
-    const throwable = v => () =>
-      validateShallowOADocument({
-        ...MINIMAL_DOCUMENT,
-        servers: [{url: v}],
-      });
-    const error = s =>
-      format(
-        'Property "servers[0].url" must be a non-empty String, ' +
-          'but %s was given.',
-        s,
-      );
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable([])).to.throw(error('Array'));
-    expect(throwable({})).to.throw(error('Object'));
-    expect(throwable(undefined)).to.throw(error('undefined'));
-    expect(throwable(null)).to.throw(error('null'));
-    throwable('http://localhost')();
-  });
-
-  it('should require the "paths" property to be an Object', function () {
-    const throwable = v => () =>
-      validateShallowOADocument({
-        ...MINIMAL_DOCUMENT,
-        paths: v,
-      });
-    const error = s =>
-      format('Property "paths" must be an Object, but %s was given.', s);
-    expect(throwable('str')).to.throw(error('"str"'));
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable([])).to.throw(error('Array'));
-    expect(throwable(null)).to.throw(error('null'));
-    throwable({})();
-  });
-
-  it('should require the "webhooks" property to be an Object', function () {
-    const throwable = v => () =>
-      validateShallowOADocument({
-        ...MINIMAL_DOCUMENT,
-        webhooks: v,
-      });
-    const error = s =>
-      format('Property "webhooks" must be an Object, but %s was given.', s);
-    expect(throwable('str')).to.throw(error('"str"'));
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable([])).to.throw(error('Array'));
-    expect(throwable(null)).to.throw(error('null'));
-    throwable({})();
-  });
-
-  it('should require the "components" property to be an Object', function () {
-    const throwable = v => () =>
-      validateShallowOADocument({
-        ...MINIMAL_DOCUMENT,
-        components: v,
-      });
-    const error = s =>
-      format('Property "components" must be an Object, but %s was given.', s);
-    expect(throwable('str')).to.throw(error('"str"'));
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable([])).to.throw(error('Array'));
-    expect(throwable(null)).to.throw(error('null'));
-    throwable({})();
-  });
-
-  it('should require the "security" property to be an Array', function () {
-    const throwable = v => () =>
-      validateShallowOADocument({
-        ...MINIMAL_DOCUMENT,
-        security: v,
-      });
-    const error = s =>
-      format('Property "security" must be an Array, but %s was given.', s);
-    expect(throwable('str')).to.throw(error('"str"'));
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable({})).to.throw(error('Object'));
-    expect(throwable(null)).to.throw(error('null'));
-    throwable([{}])();
-    throwable([])();
-  });
-
-  it('should require elements of the "security" property to be an Object', function () {
-    const throwable = v => () =>
-      validateShallowOADocument({
-        ...MINIMAL_DOCUMENT,
-        security: [v],
-      });
-    const error = s =>
-      format('Element "security[0]" must be an Object, but %s was given.', s);
-    expect(throwable('str')).to.throw(error('"str"'));
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable([])).to.throw(error('Array'));
-    expect(throwable(null)).to.throw(error('null'));
-    throwable({apiKey: []})();
-    throwable({})();
-  });
-
-  it('should require the "tags" property to be an Array', function () {
-    const throwable = v => () =>
-      validateShallowOADocument({
-        ...MINIMAL_DOCUMENT,
-        tags: v,
-      });
-    const error = s =>
-      format('Property "tags" must be an Array, but %s was given.', s);
-    expect(throwable('str')).to.throw(error('"str"'));
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable({})).to.throw(error('Object'));
-    expect(throwable(null)).to.throw(error('null'));
-    throwable([{name: 'tag'}])();
-    throwable([])();
-  });
-
-  it('should require elements of the "tags" property to be an Object', function () {
-    const throwable = v => () =>
-      validateShallowOADocument({
-        ...MINIMAL_DOCUMENT,
-        tags: [v],
-      });
-    const error = s =>
-      format('Element "tags[0]" must be an Object, but %s was given.', s);
-    expect(throwable('str')).to.throw(error('"str"'));
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable([])).to.throw(error('Array'));
-    expect(throwable(null)).to.throw(error('null'));
-    throwable({name: 'tag'})();
-  });
-
-  it('should require the "tags[n].name" property to be a non-empty String', function () {
-    const throwable = v => () =>
-      validateShallowOADocument({
-        ...MINIMAL_DOCUMENT,
-        tags: [{name: v}],
-      });
-    const error = s =>
-      format(
-        'Property "tags[0].name" must be a non-empty String, ' +
-          'but %s was given.',
-        s,
-      );
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable([])).to.throw(error('Array'));
-    expect(throwable({})).to.throw(error('Object'));
-    expect(throwable(undefined)).to.throw(error('undefined'));
-    expect(throwable(null)).to.throw(error('null'));
-    throwable('tag')();
-  });
-
-  it('should require the "externalDocs" property to be an Object', function () {
-    const throwable = v => () =>
-      validateShallowOADocument({
-        ...MINIMAL_DOCUMENT,
-        externalDocs: v,
-      });
-    const error = s =>
-      format('Property "externalDocs" must be an Object, but %s was given.', s);
-    expect(throwable('str')).to.throw(error('"str"'));
-    expect(throwable('')).to.throw(error('""'));
-    expect(throwable(10)).to.throw(error('10'));
-    expect(throwable(0)).to.throw(error('0'));
-    expect(throwable(true)).to.throw(error('true'));
-    expect(throwable(false)).to.throw(error('false'));
-    expect(throwable([])).to.throw(error('Array'));
-    expect(throwable(null)).to.throw(error('null'));
-    throwable({url: 'https://example.com'})();
-    throwable(undefined)();
-  });
-});

package/src/utils/count-unicode.d.ts

@@ -1,11 +0,0 @@
-/**
- * Count unicode.
- *
- * Подсчет длины строки выполняется с учетом символов, выходящих
- * за пределы BMP (Basic Multilingual Plane) например, эмодзи
- * или некоторые иероглифы в JS имеют `.length === 2`,
- * но должны считаться за один символ.
- *
- * @param data
- */
-export function countUnicode(data: string): number;

package/src/utils/count-unicode.js

@@ -1,15 +0,0 @@
-/**
- * Count unicode.
- *
- * Подсчет длины строки выполняется с учетом символов, выходящих
- * за пределы BMP (Basic Multilingual Plane) например, эмодзи
- * или некоторые иероглифы в JS имеют `.length === 2`,
- * но должны считаться за один символ.
- *
- * @param {string} data
- * @returns {number}
- */
-export function countUnicode(data) {
-  const matchedChars = String(data).match(/[\s\S]/gu);
-  return Array.isArray(matchedChars) ? matchedChars.length : 0;
-}

package/src/utils/index.d.ts

@@ -1,5 +0,0 @@
-export * from './join-path.js';
-export * from './count-unicode.js';
-export * from './normalize-path.js';
-export * from './to-spaced-json.js';
-export * from './to-pascal-case.js';

package/src/utils/index.js

@@ -1,5 +0,0 @@
-export * from './join-path.js';
-export * from './count-unicode.js';
-export * from './normalize-path.js';
-export * from './to-spaced-json.js';
-export * from './to-pascal-case.js';

package/src/utils/join-path.d.ts

@@ -1,6 +0,0 @@
-/**
- * Joins URL paths.
- *
- * @param segments
- */
-export declare function joinPath(...segments: (string | number)[]): string;