@speclynx/apidom-ns-openapi-3-0 4.0.1 → 4.0.3

package/src/refractor/visitors/open-api-3-0/path-item/index.ts

@@ -0,0 +1,53 @@
+import { always } from 'ramda';
+import { StringElement, ObjectElement, isStringElement } from '@speclynx/apidom-datamodel';
+import { toValue } from '@speclynx/apidom-core';
+import { Path } from '@speclynx/apidom-traverse';
+
+import PathItemElement from '../../../../elements/PathItem.ts';
+import OperationElement from '../../../../elements/Operation.ts';
+import { isOperationElement } from '../../../../predicates.ts';
+import { SpecPath } from '../../generics/FixedFieldsVisitor.ts';
+import { BaseFixedFieldsVisitor, BaseFixedFieldsVisitorOptions } from '../bases.ts';
+
+/**
+ * @public
+ */
+export type { BaseFixedFieldsVisitorOptions as PathItemVisitorOptions };
+
+/**
+ * @public
+ */
+class PathItemVisitor extends BaseFixedFieldsVisitor {
+  declare public readonly element: PathItemElement;
+
+  declare protected readonly specPath: SpecPath<['document', 'objects', 'PathItem']>;
+
+  constructor(options: BaseFixedFieldsVisitorOptions) {
+    super(options);
+    this.element = new PathItemElement();
+    this.specPath = always(['document', 'objects', 'PathItem']);
+    this.consumeSafe = true;
+  }
+
+  ObjectElement(path: Path<ObjectElement>) {
+    BaseFixedFieldsVisitor.prototype.ObjectElement.call(this, path);
+
+    // decorate Operation elements with HTTP method
+    this.element
+      .filter(isOperationElement)
+      // @ts-ignore
+      .forEach((operationElement: OperationElement, httpMethodElementCI: StringElement) => {
+        operationElement.meta.set(
+          'http-method',
+          (toValue(httpMethodElementCI) as string).toUpperCase(),
+        );
+      });
+
+    // mark this PathItemElement with reference metadata
+    if (isStringElement(this.element.$ref)) {
+      this.element.classes.push('reference-element');
+    }
+  }
+}
+
+export default PathItemVisitor;

package/src/refractor/visitors/open-api-3-0/paths/index.cjs

@@ -0,0 +1,40 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _ramda = require("ramda");
+var _apidomCore = require("@speclynx/apidom-core");
+var _Paths = _interopRequireDefault(require("../../../../elements/Paths.cjs"));
+var _predicates = require("../../../../predicates.cjs");
+var _bases = require("../bases.cjs");
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class PathsVisitor extends _bases.BasePatternedFieldsVisitor {
+  constructor(options) {
+    super(options);
+    this.element = new _Paths.default();
+    this.specPath = (0, _ramda.always)(['document', 'objects', 'PathItem']);
+    this.canSupportSpecificationExtensions = true;
+    this.consumeSafe = true;
+    this.fieldPatternPredicate = _ramda.T;
+  }
+  ObjectElement(path) {
+    _bases.BasePatternedFieldsVisitor.prototype.ObjectElement.call(this, path);
+
+    // decorate every PathItemElement with path metadata
+    this.element.filter(_predicates.isPathItemElement)
+    // @ts-ignore
+    .forEach((pathItemElement, key) => {
+      key.classes.push('openapi-path-template');
+      key.classes.push('path-template');
+      pathItemElement.meta.set('path', (0, _apidomCore.toValue)(key));
+    });
+  }
+}
+var _default = exports.default = PathsVisitor;

package/src/refractor/visitors/open-api-3-0/paths/index.mjs

@@ -0,0 +1,34 @@
+import { T as stubTrue, always } from 'ramda';
+import { toValue } from '@speclynx/apidom-core';
+import PathsElement from "../../../../elements/Paths.mjs";
+import { isPathItemElement } from "../../../../predicates.mjs";
+import { BasePatternedFieldsVisitor } from "../bases.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class PathsVisitor extends BasePatternedFieldsVisitor {
+  constructor(options) {
+    super(options);
+    this.element = new PathsElement();
+    this.specPath = always(['document', 'objects', 'PathItem']);
+    this.canSupportSpecificationExtensions = true;
+    this.consumeSafe = true;
+    this.fieldPatternPredicate = stubTrue;
+  }
+  ObjectElement(path) {
+    BasePatternedFieldsVisitor.prototype.ObjectElement.call(this, path);
+
+    // decorate every PathItemElement with path metadata
+    this.element.filter(isPathItemElement)
+    // @ts-ignore
+    .forEach((pathItemElement, key) => {
+      key.classes.push('openapi-path-template');
+      key.classes.push('path-template');
+      pathItemElement.meta.set('path', toValue(key));
+    });
+  }
+}
+export default PathsVisitor;

package/src/refractor/visitors/open-api-3-0/paths/index.ts

@@ -0,0 +1,51 @@
+import { T as stubTrue, always } from 'ramda';
+import { ObjectElement, StringElement } from '@speclynx/apidom-datamodel';
+import { toValue } from '@speclynx/apidom-core';
+import { Path } from '@speclynx/apidom-traverse';
+
+import PathsElement from '../../../../elements/Paths.ts';
+import PathItemElement from '../../../../elements/PathItem.ts';
+import { SpecPath } from '../../generics/PatternedFieldsVisitor.ts';
+import { isPathItemElement } from '../../../../predicates.ts';
+import { BasePatternedFieldsVisitor, BasePatternedFieldsVisitorOptions } from '../bases.ts';
+
+/**
+ * @public
+ */
+export type { BasePatternedFieldsVisitorOptions as PathsVisitorOptions };
+
+/**
+ * @public
+ */
+class PathsVisitor extends BasePatternedFieldsVisitor {
+  declare public readonly element: PathsElement;
+
+  declare protected readonly specPath: SpecPath<['document', 'objects', 'PathItem']>;
+
+  declare protected readonly canSupportSpecificationExtensions: true;
+
+  constructor(options: BasePatternedFieldsVisitorOptions) {
+    super(options);
+    this.element = new PathsElement();
+    this.specPath = always(['document', 'objects', 'PathItem']);
+    this.canSupportSpecificationExtensions = true;
+    this.consumeSafe = true;
+    this.fieldPatternPredicate = stubTrue;
+  }
+
+  ObjectElement(path: Path<ObjectElement>) {
+    BasePatternedFieldsVisitor.prototype.ObjectElement.call(this, path);
+
+    // decorate every PathItemElement with path metadata
+    this.element
+      .filter(isPathItemElement)
+      // @ts-ignore
+      .forEach((pathItemElement: PathItemElement, key: StringElement) => {
+        key.classes.push('openapi-path-template');
+        key.classes.push('path-template');
+        pathItemElement.meta.set('path', toValue(key) as string);
+      });
+  }
+}
+
+export default PathsVisitor;

package/src/refractor/visitors/open-api-3-0/reference/$RefVisitor.cjs

@@ -0,0 +1,16 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _FallbackVisitor = _interopRequireDefault(require("../../FallbackVisitor.cjs"));
+/**
+ * @public
+ */
+class $RefVisitor extends _FallbackVisitor.default {
+  StringElement(path) {
+    super.enter(path);
+    this.element.classes.push('reference-value');
+  }
+}
+var _default = exports.default = $RefVisitor;

package/src/refractor/visitors/open-api-3-0/reference/$RefVisitor.mjs

@@ -0,0 +1,11 @@
+import FallbackVisitor from "../../FallbackVisitor.mjs";
+/**
+ * @public
+ */
+class $RefVisitor extends FallbackVisitor {
+  StringElement(path) {
+    super.enter(path);
+    this.element.classes.push('reference-value');
+  }
+}
+export default $RefVisitor;

package/src/refractor/visitors/open-api-3-0/reference/$RefVisitor.ts

@@ -0,0 +1,20 @@
+import { StringElement } from '@speclynx/apidom-datamodel';
+import { Path } from '@speclynx/apidom-traverse';
+
+import FallbackVisitor, { FallbackVisitorOptions } from '../../FallbackVisitor.ts';
+
+export type { FallbackVisitorOptions as $RefVisitorOptions };
+
+/**
+ * @public
+ */
+class $RefVisitor extends FallbackVisitor {
+  declare public readonly element: StringElement;
+
+  StringElement(path: Path<StringElement>) {
+    super.enter(path);
+    this.element.classes.push('reference-value');
+  }
+}
+
+export default $RefVisitor;

package/src/refractor/visitors/open-api-3-0/reference/index.cjs

@@ -0,0 +1,33 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _ramda = require("ramda");
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _Reference = _interopRequireDefault(require("../../../../elements/Reference.cjs"));
+var _bases = require("../bases.cjs");
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class ReferenceVisitor extends _bases.BaseFixedFieldsVisitor {
+  constructor(options) {
+    super(options);
+    this.element = new _Reference.default();
+    this.specPath = (0, _ramda.always)(['document', 'objects', 'Reference']);
+    this.canSupportSpecificationExtensions = false;
+  }
+  ObjectElement(path) {
+    _bases.BaseFixedFieldsVisitor.prototype.ObjectElement.call(this, path);
+
+    // mark this ReferenceElement with reference metadata
+    if ((0, _apidomDatamodel.isStringElement)(this.element.$ref)) {
+      this.element.classes.push('reference-element');
+    }
+  }
+}
+var _default = exports.default = ReferenceVisitor;

package/src/refractor/visitors/open-api-3-0/reference/index.mjs

@@ -0,0 +1,27 @@
+import { always } from 'ramda';
+import { isStringElement } from '@speclynx/apidom-datamodel';
+import ReferenceElement from "../../../../elements/Reference.mjs";
+import { BaseFixedFieldsVisitor } from "../bases.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class ReferenceVisitor extends BaseFixedFieldsVisitor {
+  constructor(options) {
+    super(options);
+    this.element = new ReferenceElement();
+    this.specPath = always(['document', 'objects', 'Reference']);
+    this.canSupportSpecificationExtensions = false;
+  }
+  ObjectElement(path) {
+    BaseFixedFieldsVisitor.prototype.ObjectElement.call(this, path);
+
+    // mark this ReferenceElement with reference metadata
+    if (isStringElement(this.element.$ref)) {
+      this.element.classes.push('reference-element');
+    }
+  }
+}
+export default ReferenceVisitor;

package/src/refractor/visitors/open-api-3-0/reference/index.ts

@@ -0,0 +1,41 @@
+import { always } from 'ramda';
+import { ObjectElement, isStringElement } from '@speclynx/apidom-datamodel';
+import { Path } from '@speclynx/apidom-traverse';
+
+import ReferenceElement from '../../../../elements/Reference.ts';
+import { SpecPath } from '../../generics/FixedFieldsVisitor.ts';
+import { BaseFixedFieldsVisitor, BaseFixedFieldsVisitorOptions } from '../bases.ts';
+
+/**
+ * @public
+ */
+export type { BaseFixedFieldsVisitorOptions as ReferenceVisitorOptions };
+
+/**
+ * @public
+ */
+class ReferenceVisitor extends BaseFixedFieldsVisitor {
+  declare public readonly element: ReferenceElement;
+
+  declare protected readonly specPath: SpecPath<['document', 'objects', 'Reference']>;
+
+  declare protected readonly canSupportSpecificationExtensions: false;
+
+  constructor(options: BaseFixedFieldsVisitorOptions) {
+    super(options);
+    this.element = new ReferenceElement();
+    this.specPath = always(['document', 'objects', 'Reference']);
+    this.canSupportSpecificationExtensions = false;
+  }
+
+  ObjectElement(path: Path<ObjectElement>) {
+    BaseFixedFieldsVisitor.prototype.ObjectElement.call(this, path);
+
+    // mark this ReferenceElement with reference metadata
+    if (isStringElement(this.element.$ref)) {
+      this.element.classes.push('reference-element');
+    }
+  }
+}
+
+export default ReferenceVisitor;

package/src/refractor/visitors/open-api-3-0/request-body/ContentVisitor.cjs

@@ -0,0 +1,17 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _RequestBodyContent = _interopRequireDefault(require("../../../../elements/nces/RequestBodyContent.cjs"));
+var _ContentVisitor = _interopRequireDefault(require("../ContentVisitor.cjs"));
+/**
+ * @public
+ */
+class ContentVisitor extends _ContentVisitor.default {
+  constructor(options) {
+    super(options);
+    this.element = new _RequestBodyContent.default();
+  }
+}
+var _default = exports.default = ContentVisitor;

package/src/refractor/visitors/open-api-3-0/request-body/ContentVisitor.mjs

@@ -0,0 +1,12 @@
+import RequestBodyContentElement from "../../../../elements/nces/RequestBodyContent.mjs";
+import BaseContentVisitor from "../ContentVisitor.mjs";
+/**
+ * @public
+ */
+class ContentVisitor extends BaseContentVisitor {
+  constructor(options) {
+    super(options);
+    this.element = new RequestBodyContentElement();
+  }
+}
+export default ContentVisitor;

package/src/refractor/visitors/open-api-3-0/request-body/ContentVisitor.ts

@@ -0,0 +1,18 @@
+import RequestBodyContentElement from '../../../../elements/nces/RequestBodyContent.ts';
+import BaseContentVisitor, { ContentVisitorOptions } from '../ContentVisitor.ts';
+
+export type { ContentVisitorOptions };
+
+/**
+ * @public
+ */
+class ContentVisitor extends BaseContentVisitor {
+  declare public readonly element: RequestBodyContentElement;
+
+  constructor(options: ContentVisitorOptions) {
+    super(options);
+    this.element = new RequestBodyContentElement();
+  }
+}
+
+export default ContentVisitor;

package/src/refractor/visitors/open-api-3-0/request-body/index.cjs

@@ -0,0 +1,39 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _ramda = require("ramda");
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _apidomCore = require("@speclynx/apidom-core");
+var _RequestBody = _interopRequireDefault(require("../../../../elements/RequestBody.cjs"));
+var _FixedFieldsVisitor = _interopRequireDefault(require("../../generics/FixedFieldsVisitor.cjs"));
+var _predicates = require("../../../../predicates.cjs");
+var _bases = require("../bases.cjs");
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class RequestBodyVisitor extends _bases.BaseFixedFieldsVisitor {
+  constructor(options) {
+    super(options);
+    this.element = new _RequestBody.default();
+    this.specPath = (0, _ramda.always)(['document', 'objects', 'RequestBody']);
+  }
+  ObjectElement(path) {
+    _FixedFieldsVisitor.default.prototype.ObjectElement.call(this, path);
+
+    // decorate every MediaTypeElement with media type metadata
+    if ((0, _apidomDatamodel.isObjectElement)(this.element.contentField)) {
+      this.element.contentField.filter(_predicates.isMediaTypeElement)
+      // @ts-ignore
+      .forEach((mediaTypeElement, key) => {
+        mediaTypeElement.meta.set('media-type', (0, _apidomCore.toValue)(key));
+      });
+    }
+  }
+}
+var _default = exports.default = RequestBodyVisitor;

package/src/refractor/visitors/open-api-3-0/request-body/index.mjs

@@ -0,0 +1,33 @@
+import { always } from 'ramda';
+import { isObjectElement } from '@speclynx/apidom-datamodel';
+import { toValue } from '@speclynx/apidom-core';
+import RequestBodyElement from "../../../../elements/RequestBody.mjs";
+import FixedFieldsVisitor from "../../generics/FixedFieldsVisitor.mjs";
+import { isMediaTypeElement } from "../../../../predicates.mjs";
+import { BaseFixedFieldsVisitor } from "../bases.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class RequestBodyVisitor extends BaseFixedFieldsVisitor {
+  constructor(options) {
+    super(options);
+    this.element = new RequestBodyElement();
+    this.specPath = always(['document', 'objects', 'RequestBody']);
+  }
+  ObjectElement(path) {
+    FixedFieldsVisitor.prototype.ObjectElement.call(this, path);
+
+    // decorate every MediaTypeElement with media type metadata
+    if (isObjectElement(this.element.contentField)) {
+      this.element.contentField.filter(isMediaTypeElement)
+      // @ts-ignore
+      .forEach((mediaTypeElement, key) => {
+        mediaTypeElement.meta.set('media-type', toValue(key));
+      });
+    }
+  }
+}
+export default RequestBodyVisitor;

package/src/refractor/visitors/open-api-3-0/request-body/index.ts

@@ -0,0 +1,46 @@
+import { always } from 'ramda';
+import { StringElement, ObjectElement, isObjectElement } from '@speclynx/apidom-datamodel';
+import { toValue } from '@speclynx/apidom-core';
+import { Path } from '@speclynx/apidom-traverse';
+
+import RequestBodyElement from '../../../../elements/RequestBody.ts';
+import MediaTypeElement from '../../../../elements/MediaType.ts';
+import FixedFieldsVisitor, { SpecPath } from '../../generics/FixedFieldsVisitor.ts';
+import { isMediaTypeElement } from '../../../../predicates.ts';
+import { BaseFixedFieldsVisitor, BaseFixedFieldsVisitorOptions } from '../bases.ts';
+
+/**
+ * @public
+ */
+export type { BaseFixedFieldsVisitorOptions as RequestBodyVisitorOptions };
+
+/**
+ * @public
+ */
+class RequestBodyVisitor extends BaseFixedFieldsVisitor {
+  declare public readonly element: RequestBodyElement;
+
+  declare protected readonly specPath: SpecPath<['document', 'objects', 'RequestBody']>;
+
+  constructor(options: BaseFixedFieldsVisitorOptions) {
+    super(options);
+    this.element = new RequestBodyElement();
+    this.specPath = always(['document', 'objects', 'RequestBody']);
+  }
+
+  ObjectElement(path: Path<ObjectElement>) {
+    FixedFieldsVisitor.prototype.ObjectElement.call(this, path);
+
+    // decorate every MediaTypeElement with media type metadata
+    if (isObjectElement(this.element.contentField)) {
+      this.element.contentField
+        .filter(isMediaTypeElement)
+        // @ts-ignore
+        .forEach((mediaTypeElement: MediaTypeElement, key: StringElement) => {
+          mediaTypeElement.meta.set('media-type', toValue(key));
+        });
+    }
+  }
+}
+
+export default RequestBodyVisitor;

package/src/refractor/visitors/open-api-3-0/response/ContentVisitor.cjs

@@ -0,0 +1,17 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _ResponseContent = _interopRequireDefault(require("../../../../elements/nces/ResponseContent.cjs"));
+var _ContentVisitor = _interopRequireDefault(require("../ContentVisitor.cjs"));
+/**
+ * @public
+ */
+class ContentVisitor extends _ContentVisitor.default {
+  constructor(options) {
+    super(options);
+    this.element = new _ResponseContent.default();
+  }
+}
+var _default = exports.default = ContentVisitor;

package/src/refractor/visitors/open-api-3-0/response/ContentVisitor.mjs

@@ -0,0 +1,12 @@
+import ResponseContentElement from "../../../../elements/nces/ResponseContent.mjs";
+import BaseContentVisitor from "../ContentVisitor.mjs";
+/**
+ * @public
+ */
+class ContentVisitor extends BaseContentVisitor {
+  constructor(options) {
+    super(options);
+    this.element = new ResponseContentElement();
+  }
+}
+export default ContentVisitor;

package/src/refractor/visitors/open-api-3-0/response/ContentVisitor.ts

@@ -0,0 +1,18 @@
+import ResponseContentElement from '../../../../elements/nces/ResponseContent.ts';
+import BaseContentVisitor, { ContentVisitorOptions } from '../ContentVisitor.ts';
+
+export type { ContentVisitorOptions };
+
+/**
+ * @public
+ */
+class ContentVisitor extends BaseContentVisitor {
+  declare public readonly element: ResponseContentElement;
+
+  constructor(options: ContentVisitorOptions) {
+    super(options);
+    this.element = new ResponseContentElement();
+  }
+}
+
+export default ContentVisitor;

package/src/refractor/visitors/open-api-3-0/response/HeadersVisitor.cjs

@@ -0,0 +1,42 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomCore = require("@speclynx/apidom-core");
+var _ResponseHeaders = _interopRequireDefault(require("../../../../elements/nces/ResponseHeaders.cjs"));
+var _predicates = require("../../../predicates.cjs");
+var _predicates2 = require("../../../../predicates.cjs");
+var _bases = require("../bases.cjs");
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class HeadersVisitor extends _bases.BaseMapVisitor {
+  constructor(options) {
+    super(options);
+    this.element = new _ResponseHeaders.default();
+    this.specPath = element => (0, _predicates.isReferenceLikeElement)(element) ? ['document', 'objects', 'Reference'] : ['document', 'objects', 'Header'];
+  }
+  ObjectElement(path) {
+    _bases.BaseMapVisitor.prototype.ObjectElement.call(this, path);
+
+    // decorate every ReferenceElement with metadata about their referencing type
+    // @ts-ignore
+    this.element.filter(_predicates2.isReferenceElement).forEach(referenceElement => {
+      referenceElement.meta.set('referenced-element', 'header');
+    });
+
+    // decorate every HeaderElement with metadata about their name
+    // @ts-ignore
+    this.element.forEach((value, key) => {
+      if (!(0, _predicates2.isHeaderElement)(value)) return;
+      const headerName = (0, _apidomCore.toValue)(key);
+      value.meta.set('header-name', headerName);
+    });
+  }
+}
+var _default = exports.default = HeadersVisitor;

package/src/refractor/visitors/open-api-3-0/response/HeadersVisitor.mjs

@@ -0,0 +1,36 @@
+import { toValue } from '@speclynx/apidom-core';
+import ResponseHeadersElement from "../../../../elements/nces/ResponseHeaders.mjs";
+import { isReferenceLikeElement } from "../../../predicates.mjs";
+import { isHeaderElement, isReferenceElement } from "../../../../predicates.mjs";
+import { BaseMapVisitor } from "../bases.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class HeadersVisitor extends BaseMapVisitor {
+  constructor(options) {
+    super(options);
+    this.element = new ResponseHeadersElement();
+    this.specPath = element => isReferenceLikeElement(element) ? ['document', 'objects', 'Reference'] : ['document', 'objects', 'Header'];
+  }
+  ObjectElement(path) {
+    BaseMapVisitor.prototype.ObjectElement.call(this, path);
+
+    // decorate every ReferenceElement with metadata about their referencing type
+    // @ts-ignore
+    this.element.filter(isReferenceElement).forEach(referenceElement => {
+      referenceElement.meta.set('referenced-element', 'header');
+    });
+
+    // decorate every HeaderElement with metadata about their name
+    // @ts-ignore
+    this.element.forEach((value, key) => {
+      if (!isHeaderElement(value)) return;
+      const headerName = toValue(key);
+      value.meta.set('header-name', headerName);
+    });
+  }
+}
+export default HeadersVisitor;