@swagger-api/apidom-ns-openapi-3-1 1.0.0-alpha.0 → 1.0.0-alpha.10

package/types/dist.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="@swagger-api/apidom-core/types/minim" />
-import * as _swagger_api_apidom_core from '@swagger-api/apidom-core';
 import { MediaTypes, NamespacePluginOptions, ObjectElement, Meta, Attributes, StringElement, ArrayElement, Element, NumberElement, BooleanElement, ElementPredicate, isElement, isStringElement, isArrayElement, isObjectElement, isMemberElement, includesClasses, hasElementSourceMap, Namespace } from '@swagger-api/apidom-core';
 export { isArrayElement, isBooleanElement, isElement, isLinkElement as isLinkPrimitiveElement, isMemberElement, isNullElement, isNumberElement, isObjectElement, isRefElement, isStringElement } from '@swagger-api/apidom-core';
 import * as minim from 'minim';
@@ -438,10 +436,21 @@ type Predicates = typeof openApi3_1Predicates & {
     includesClasses: typeof includesClasses;
     hasElementSourceMap: typeof hasElementSourceMap;
 };
-declare const createToolbox: () => {
+interface Toolbox {
     predicates: Predicates;
-    namespace: _swagger_api_apidom_core.Namespace;
-};
+    ancestorLineageToJSONPointer: typeof ancestorLineageToJSONPointer;
+    namespace: Namespace;
+}
+/**
+ * Translates visitor ancestor lineage to a JSON Pointer tokens.
+ * Ancestor lineage is constructed of following visitor method arguments:
+ *
+ *  - ancestors
+ *  - parent
+ *  - element
+ */
+declare const ancestorLineageToJSONPointer: <T extends (Element | Element[])[]>(elementPath: T) => string;
+declare const createToolbox: () => Toolbox;
 
 declare const plugin$6: () => ({ predicates }: {
     predicates: Predicates;
@@ -459,17 +468,24 @@ declare const plugin$6: () => ({ predicates }: {
  * A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item,
  * the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters.
  * A unique parameter is defined by a combination of a name and location.
+ *
+ * NOTE: this plugin is idempotent
  */
-declare const plugin$5: () => ({ predicates }: {
-    predicates: Predicates;
-}) => {
+interface PluginOptions$5 {
+    storageField?: string;
+}
+declare const plugin$5: ({ storageField }?: PluginOptions$5) => (toolbox: Toolbox) => {
     visitor: {
+        OpenApi3_1Element: {
+            enter(element: OpenApi3_1): void;
+            leave(): void;
+        };
         PathItemElement: {
-            enter(pathItemElement: PathItem, key: any, parent: any, path: any, ancestors: any[]): void;
+            enter(pathItemElement: PathItem, key: string | number, parent: Element | undefined, path: (string | number)[], ancestors: [Element | Element[]]): void;
             leave(): void;
         };
         OperationElement: {
-            leave(operationElement: Operation): void;
+            leave(operationElement: Operation, key: string | number, parent: Element | undefined, path: (string | number)[], ancestors: [Element | Element[]]): void;
         };
     };
 };
@@ -483,17 +499,20 @@ declare const plugin$5: () => ({ predicates }: {
  * To remove a top-level security declaration, an empty array can be used.
  * When a list of Security Requirement Objects is defined on the OpenAPI Object or Operation Object,
  * only one of the Security Requirement Objects in the list needs to be satisfied to authorize the request.
+ *
+ * NOTE: this plugin is idempotent
  */
-declare const plugin$4: () => ({ predicates }: {
-    predicates: Predicates;
-}) => {
+interface PluginOptions$4 {
+    storageField?: string;
+}
+declare const plugin$4: ({ storageField }?: PluginOptions$4) => (toolbox: Toolbox) => {
     visitor: {
         OpenApi3_1Element: {
             enter(openapiElement: OpenApi3_1): void;
             leave(): void;
         };
         OperationElement: {
-            leave(operationElement: Operation, key: any, parent: any, path: any, ancestors: any[]): void;
+            leave(operationElement: Operation, key: string | number, parent: Element | undefined, path: (string | number)[], ancestors: [Element | Element[]]): void;
         };
     };
 };
@@ -510,14 +529,17 @@ declare const plugin$4: () => ({ predicates }: {
  * If an alternative server object is specified at the Path Item Object level, it will override OpenAPI.servers.
  * If an alternative server object is specified at the Operation Object level, it will override PathItem.servers and OpenAPI.servers respectively.
  */
-declare const plugin$3: () => ({ predicates, namespace }: {
-    predicates: Predicates;
-    namespace: Namespace;
-}) => {
+interface PluginOptions$3 {
+    storageField?: string;
+}
+declare const plugin$3: ({ storageField }?: PluginOptions$3) => (toolbox: Toolbox) => {
     visitor: {
-        OpenApi3_1Element(openapiElement: OpenApi3_1): void;
-        PathItemElement(pathItemElement: PathItem, key: any, parent: any, path: any, ancestors: any[]): void;
-        OperationElement(operationElement: Operation, key: any, parent: any, path: any, ancestors: any[]): void;
+        OpenApi3_1Element: {
+            enter(openapiElement: OpenApi3_1): void;
+            leave(): void;
+        };
+        PathItemElement(pathItemElement: PathItem, key: string | number, parent: Element | undefined, path: (string | number)[], ancestors: [Element | Element[]]): void;
+        OperationElement(operationElement: Operation, key: string | number, parent: Element | undefined, path: (string | number)[], ancestors: [Element | Element[]]): void;
     };
 };
 
@@ -535,15 +557,16 @@ declare const plugin$3: () => ({ predicates, namespace }: {
  * This plugin also guarantees the uniqueness of all defined Operation.operationId fields,
  * and make sure Link.operationId fields are pointing to correct and normalized Operation.operationId fields.
  *
+ * NOTE: this plugin is idempotent
  */
-declare const plugin$2: ({ operationIdNormalizer }?: {
-    operationIdNormalizer?: ((operationId: string, path: string, method: string) => string) | undefined;
-}) => ({ predicates, namespace }: {
-    predicates: Predicates;
-    namespace: Namespace;
-}) => {
+interface PluginOptions$2 {
+    storageField?: string;
+    operationIdNormalizer?: (operationId: string, path: string, method: string) => string;
+}
+declare const plugin$2: ({ storageField, operationIdNormalizer, }?: PluginOptions$2) => (toolbox: Toolbox) => {
     visitor: {
         OpenApi3_1Element: {
+            enter(element: OpenApi3_1): void;
             leave(): void;
         };
         PathItemElement: {
@@ -551,7 +574,7 @@ declare const plugin$2: ({ operationIdNormalizer }?: {
             leave(): void;
         };
         OperationElement: {
-            enter(operationElement: Operation): void;
+            enter(operationElement: Operation, key: string | number, parent: Element | undefined, path: (string | number)[], ancestors: [Element | Element[]]): void;
         };
         LinkElement: {
             leave(linkElement: Link): void;
@@ -570,13 +593,20 @@ declare const plugin$2: ({ operationIdNormalizer }?: {
  *
  * The example value SHALL override the example provided by the schema.
  * Furthermore, if referencing a schema that contains an example, the examples value SHALL override the example provided by the schema.
+ *
+ * NOTE: this plugin is idempotent
  */
-declare const plugin$1: () => ({ predicates }: {
-    predicates: Predicates;
-}) => {
+interface PluginOptions$1 {
+    storageField?: string;
+}
+declare const plugin$1: ({ storageField }?: PluginOptions$1) => (toolbox: Toolbox) => {
     visitor: {
+        OpenApi3_1Element: {
+            enter(element: OpenApi3_1): void;
+            leave(): void;
+        };
         ParameterElement: {
-            leave(parameterElement: Parameter, key: any, parent: any, path: any, ancestors: any[]): void;
+            leave(parameterElement: Parameter, key: string | number, parent: Element | undefined, path: (string | number)[], ancestors: [Element | Element[]]): void;
         };
     };
 };
@@ -592,13 +622,20 @@ declare const plugin$1: () => ({ predicates }: {
  *
  * The example value SHALL override the example provided by the schema.
  * Furthermore, if referencing a schema that contains an example, the examples value SHALL override the example provided by the schema.
+ *
+ * NOTE: this plugin is idempotent
  */
-declare const plugin: () => ({ predicates }: {
-    predicates: Predicates;
-}) => {
+interface PluginOptions {
+    storageField?: string;
+}
+declare const plugin: ({ storageField }?: PluginOptions) => (toolbox: Toolbox) => {
     visitor: {
+        OpenApi3_1Element: {
+            enter(element: OpenApi3_1): void;
+            leave(): void;
+        };
         HeaderElement: {
-            leave(headerElement: Header, key: any, parent: any, path: any, ancestors: any[]): void;
+            leave(headerElement: Header, key: string | number, parent: Element | undefined, path: (string | number)[], ancestors: [Element | Element[]]): void;
         };
     };
 };