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

package/src/predicates.mjs

@@ -0,0 +1,195 @@
+import { isStringElement } from '@speclynx/apidom-datamodel';
+import { toValue } from '@speclynx/apidom-core';
+import CallbackElement from "./elements/Callback.mjs";
+import ComponentsElement from "./elements/Components.mjs";
+import ContactElement from "./elements/Contact.mjs";
+import ExampleElement from "./elements/Example.mjs";
+import ExternalDocumentationElement from "./elements/ExternalDocumentation.mjs";
+import HeaderElement from "./elements/Header.mjs";
+import InfoElement from "./elements/Info.mjs";
+import JsonSchemaDialectElement from "./elements/JsonSchemaDialect.mjs";
+import LicenseElement from "./elements/License.mjs";
+import LinkElement from "./elements/Link.mjs";
+import OpenapiElement from "./elements/Openapi.mjs";
+import OpenApi3_1Element from "./elements/OpenApi3-1.mjs";
+import OperationElement from "./elements/Operation.mjs";
+import ParameterElement from "./elements/Parameter.mjs";
+import PathItemElement from "./elements/PathItem.mjs";
+import PathsElement from "./elements/Paths.mjs";
+import ReferenceElement from "./elements/Reference.mjs";
+import RequestBodyElement from "./elements/RequestBody.mjs";
+import ResponseElement from "./elements/Response.mjs";
+import ResponsesElement from "./elements/Responses.mjs";
+import SchemaElement from "./elements/Schema.mjs";
+import SecurityRequirementElement from "./elements/SecurityRequirement.mjs";
+import SecuritySchemeElement from "./elements/SecurityScheme.mjs";
+import ServerElement from "./elements/Server.mjs";
+import ServerVariableElement from "./elements/ServerVariable.mjs";
+import MediaTypeElement from "./elements/MediaType.mjs";
+export { isBooleanJSONSchemaElement } from '@speclynx/apidom-ns-json-schema-2020-12';
+
+/**
+ * @public
+ */
+export const isCallbackElement = element => element instanceof CallbackElement;
+
+/**
+ * @public
+ */
+export const isComponentsElement = element => element instanceof ComponentsElement;
+
+/**
+ * @public
+ */
+export const isContactElement = element => element instanceof ContactElement;
+
+/**
+ * @public
+ */
+export const isExampleElement = element => element instanceof ExampleElement;
+
+/**
+ * @public
+ */
+export const isExternalDocumentationElement = element => element instanceof ExternalDocumentationElement;
+
+/**
+ * @public
+ */
+export const isHeaderElement = element => element instanceof HeaderElement;
+
+/**
+ * @public
+ */
+export const isInfoElement = element => element instanceof InfoElement;
+
+/**
+ * @public
+ */
+export const isJsonSchemaDialectElement = element => element instanceof JsonSchemaDialectElement;
+
+/**
+ * @public
+ */
+export const isLicenseElement = element => element instanceof LicenseElement;
+
+/**
+ * @public
+ */
+export const isLinkElement = element => element instanceof LinkElement;
+
+/**
+ * @public
+ */
+export const isOpenapiElement = element => element instanceof OpenapiElement;
+
+/**
+ * @public
+ */
+export const isOpenApi3_1Element = element => element instanceof OpenApi3_1Element;
+
+/**
+ * @public
+ */
+export const isOperationElement = element => element instanceof OperationElement;
+
+/**
+ * @public
+ */
+export const isParameterElement = element => element instanceof ParameterElement;
+
+/**
+ * @public
+ */
+export const isPathItemElement = element => element instanceof PathItemElement;
+
+/**
+ * @deprecated
+ * Determining whether a PathItemElement is external or internal is not possible by just looking
+ * at value of the $ref fixed field. The value of the $ref field needs to be resolved in runtime
+ * using the referring document as the Base URI.
+ * @public
+ */
+export const isPathItemElementExternal = element => {
+  if (!isPathItemElement(element)) {
+    return false;
+  }
+  if (!isStringElement(element.$ref)) {
+    return false;
+  }
+  const value = toValue(element.$ref);
+  return typeof value === 'string' && value.length > 0 && !value.startsWith('#');
+};
+
+/**
+ * @public
+ */
+export const isPathsElement = element => element instanceof PathsElement;
+
+/**
+ * @public
+ */
+export const isReferenceElement = element => element instanceof ReferenceElement;
+
+/**
+ * @deprecated
+ * Determining whether a ReferenceElement is external or internal is not possible by just looking
+ * at value of the $ref fixed field. The value of the $ref field needs to be resolved in runtime
+ * using the referring document as the Base URI.
+ * @public
+ */
+export const isReferenceElementExternal = element => {
+  if (!isReferenceElement(element)) {
+    return false;
+  }
+  if (!isStringElement(element.$ref)) {
+    return false;
+  }
+  const value = toValue(element.$ref);
+  return typeof value === 'string' && value.length > 0 && !value.startsWith('#');
+};
+
+/**
+ * @public
+ */
+export const isRequestBodyElement = element => element instanceof RequestBodyElement;
+
+/**
+ * @public
+ */
+export const isResponseElement = element => element instanceof ResponseElement;
+
+/**
+ * @public
+ */
+export const isResponsesElement = element => element instanceof ResponsesElement;
+
+/**
+ * @public
+ */
+export const isSchemaElement = element => element instanceof SchemaElement;
+
+/**
+ * @public
+ */
+export const isSecurityRequirementElement = element => element instanceof SecurityRequirementElement;
+
+/**
+ * @public
+ */
+export const isSecuritySchemeElement = element => element instanceof SecuritySchemeElement;
+
+/**
+ * @public
+ */
+export const isServerElement = element => element instanceof ServerElement;
+
+/**
+ * @public
+ */
+export const isServerVariableElement = element => element instanceof ServerVariableElement;
+
+/**
+ * @public
+ */
+export const isMediaTypeElement = element => element instanceof MediaTypeElement;

package/src/predicates.ts

@@ -0,0 +1,229 @@
+import { isStringElement } from '@speclynx/apidom-datamodel';
+import { toValue } from '@speclynx/apidom-core';
+
+import CallbackElement from './elements/Callback.ts';
+import ComponentsElement from './elements/Components.ts';
+import ContactElement from './elements/Contact.ts';
+import ExampleElement from './elements/Example.ts';
+import ExternalDocumentationElement from './elements/ExternalDocumentation.ts';
+import HeaderElement from './elements/Header.ts';
+import InfoElement from './elements/Info.ts';
+import JsonSchemaDialectElement from './elements/JsonSchemaDialect.ts';
+import LicenseElement from './elements/License.ts';
+import LinkElement from './elements/Link.ts';
+import OpenapiElement from './elements/Openapi.ts';
+import OpenApi3_1Element from './elements/OpenApi3-1.ts';
+import OperationElement from './elements/Operation.ts';
+import ParameterElement from './elements/Parameter.ts';
+import PathItemElement from './elements/PathItem.ts';
+import PathsElement from './elements/Paths.ts';
+import ReferenceElement from './elements/Reference.ts';
+import RequestBodyElement from './elements/RequestBody.ts';
+import ResponseElement from './elements/Response.ts';
+import ResponsesElement from './elements/Responses.ts';
+import SchemaElement from './elements/Schema.ts';
+import SecurityRequirementElement from './elements/SecurityRequirement.ts';
+import SecuritySchemeElement from './elements/SecurityScheme.ts';
+import ServerElement from './elements/Server.ts';
+import ServerVariableElement from './elements/ServerVariable.ts';
+import MediaTypeElement from './elements/MediaType.ts';
+
+export { isBooleanJSONSchemaElement } from '@speclynx/apidom-ns-json-schema-2020-12';
+
+/**
+ * @public
+ */
+export const isCallbackElement = (element: unknown): element is CallbackElement =>
+  element instanceof CallbackElement;
+
+/**
+ * @public
+ */
+export const isComponentsElement = (element: unknown): element is ComponentsElement =>
+  element instanceof ComponentsElement;
+
+/**
+ * @public
+ */
+export const isContactElement = (element: unknown): element is ContactElement =>
+  element instanceof ContactElement;
+
+/**
+ * @public
+ */
+export const isExampleElement = (element: unknown): element is ExampleElement =>
+  element instanceof ExampleElement;
+
+/**
+ * @public
+ */
+export const isExternalDocumentationElement = (
+  element: unknown,
+): element is ExternalDocumentationElement => element instanceof ExternalDocumentationElement;
+
+/**
+ * @public
+ */
+export const isHeaderElement = (element: unknown): element is HeaderElement =>
+  element instanceof HeaderElement;
+
+/**
+ * @public
+ */
+export const isInfoElement = (element: unknown): element is InfoElement =>
+  element instanceof InfoElement;
+
+/**
+ * @public
+ */
+export const isJsonSchemaDialectElement = (element: unknown): element is JsonSchemaDialectElement =>
+  element instanceof JsonSchemaDialectElement;
+
+/**
+ * @public
+ */
+export const isLicenseElement = (element: unknown): element is LicenseElement =>
+  element instanceof LicenseElement;
+
+/**
+ * @public
+ */
+export const isLinkElement = (element: unknown): element is LinkElement =>
+  element instanceof LinkElement;
+
+/**
+ * @public
+ */
+export const isOpenapiElement = (element: unknown): element is OpenapiElement =>
+  element instanceof OpenapiElement;
+
+/**
+ * @public
+ */
+export const isOpenApi3_1Element = (element: unknown): element is OpenApi3_1Element =>
+  element instanceof OpenApi3_1Element;
+
+/**
+ * @public
+ */
+export const isOperationElement = (element: unknown): element is OperationElement =>
+  element instanceof OperationElement;
+
+/**
+ * @public
+ */
+export const isParameterElement = (element: unknown): element is ParameterElement =>
+  element instanceof ParameterElement;
+
+/**
+ * @public
+ */
+export const isPathItemElement = (element: unknown): element is PathItemElement =>
+  element instanceof PathItemElement;
+
+/**
+ * @deprecated
+ * Determining whether a PathItemElement is external or internal is not possible by just looking
+ * at value of the $ref fixed field. The value of the $ref field needs to be resolved in runtime
+ * using the referring document as the Base URI.
+ * @public
+ */
+export const isPathItemElementExternal = (element: unknown): element is PathItemElement => {
+  if (!isPathItemElement(element)) {
+    return false;
+  }
+  if (!isStringElement(element.$ref)) {
+    return false;
+  }
+
+  const value = toValue(element.$ref);
+
+  return typeof value === 'string' && value.length > 0 && !value.startsWith('#');
+};
+
+/**
+ * @public
+ */
+export const isPathsElement = (element: unknown): element is PathsElement =>
+  element instanceof PathsElement;
+
+/**
+ * @public
+ */
+export const isReferenceElement = (element: unknown): element is ReferenceElement =>
+  element instanceof ReferenceElement;
+
+/**
+ * @deprecated
+ * Determining whether a ReferenceElement is external or internal is not possible by just looking
+ * at value of the $ref fixed field. The value of the $ref field needs to be resolved in runtime
+ * using the referring document as the Base URI.
+ * @public
+ */
+export const isReferenceElementExternal = (element: unknown): element is ReferenceElement => {
+  if (!isReferenceElement(element)) {
+    return false;
+  }
+  if (!isStringElement(element.$ref)) {
+    return false;
+  }
+
+  const value = toValue(element.$ref);
+
+  return typeof value === 'string' && value.length > 0 && !value.startsWith('#');
+};
+
+/**
+ * @public
+ */
+export const isRequestBodyElement = (element: unknown): element is RequestBodyElement =>
+  element instanceof RequestBodyElement;
+
+/**
+ * @public
+ */
+export const isResponseElement = (element: unknown): element is ResponseElement =>
+  element instanceof ResponseElement;
+
+/**
+ * @public
+ */
+export const isResponsesElement = (element: unknown): element is ResponsesElement =>
+  element instanceof ResponsesElement;
+
+/**
+ * @public
+ */
+export const isSchemaElement = (element: unknown): element is SchemaElement =>
+  element instanceof SchemaElement;
+
+/**
+ * @public
+ */
+export const isSecurityRequirementElement = (
+  element: unknown,
+): element is SecurityRequirementElement => element instanceof SecurityRequirementElement;
+
+/**
+ * @public
+ */
+export const isSecuritySchemeElement = (element: unknown): element is SecuritySchemeElement =>
+  element instanceof SecuritySchemeElement;
+
+/**
+ * @public
+ */
+export const isServerElement = (element: unknown): element is ServerElement =>
+  element instanceof ServerElement;
+
+/**
+ * @public
+ */
+export const isServerVariableElement = (element: unknown): element is ServerVariableElement =>
+  element instanceof ServerVariableElement;
+
+/**
+ * @public
+ */
+export const isMediaTypeElement = (element: unknown): element is MediaTypeElement =>
+  element instanceof MediaTypeElement;