@jentic/arazzo-parser 1.0.0-alpha.6 → 1.0.0-alpha.7

package/types/arazzo-parser.d.ts

@@ -2,17 +2,29 @@ import type { ApiDOMReferenceOptions } from '@speclynx/apidom-reference';
 import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import type { PartialDeep } from 'type-fest';
 
+/**
+ * Options for parsing Arazzo Documents.
+ * @public
+ */
+export declare type ArazzoOptions = PartialDeep<ApiDOMReferenceOptions>;
+
 /**
  * Default reference options for parsing Arazzo Documents.
  * @public
  */
-export declare const defaultOptions: Options;
+export declare const defaultArazzoOptions: ArazzoOptions;
 
 /**
- * Options for parsing Arazzo Documents.
+ * Default reference options for parsing OpenAPI Documents.
  * @public
  */
-export declare type Options = PartialDeep<ApiDOMReferenceOptions>;
+export declare const defaultOpenAPIOptions: OpenAPIOptions;
+
+/**
+ * Options for parsing OpenAPI Documents.
+ * @public
+ */
+export declare type OpenAPIOptions = PartialDeep<ApiDOMReferenceOptions>;
 
 /**
  * Parses an Arazzo Document from an object.
@@ -22,7 +34,7 @@ export declare type Options = PartialDeep<ApiDOMReferenceOptions>;
  * @throws ParseError - When parsing fails for any reason. The original error is available via the `cause` property.
  * @public
  */
-export declare function parseArazzo(source: Record<string, unknown>, options?: Options): Promise<ParseResultElement>;
+export declare function parseArazzo(source: Record<string, unknown>, options?: ArazzoOptions): Promise<ParseResultElement>;
 
 /**
  * Parses an Arazzo Document from a string or URI.
@@ -32,6 +44,26 @@ export declare function parseArazzo(source: Record<string, unknown>, options?: O
  * @throws ParseError - When parsing fails for any reason. The original error is available via the `cause` property.
  * @public
  */
-export declare function parseArazzo(source: string, options?: Options): Promise<ParseResultElement>;
+export declare function parseArazzo(source: string, options?: ArazzoOptions): Promise<ParseResultElement>;
+
+/**
+ * Parses an OpenAPI Document from an object.
+ * @param source - The OpenAPI Document as a plain object
+ * @param options - Reference options (uses defaultOptions when not provided)
+ * @returns A promise that resolves to the parsed OpenAPI Document as ApiDOM data model
+ * @throws ParseError - When parsing fails for any reason. The original error is available via the `cause` property.
+ * @public
+ */
+export declare function parseOpenAPI(source: Record<string, unknown>, options?: OpenAPIOptions): Promise<ParseResultElement>;
+
+/**
+ * Parses an OpenAPI Document from a string or URI.
+ * @param source - The OpenAPI Document as string content, or a file system path / HTTP(S) URL
+ * @param options - Reference options (uses defaultOptions when not provided)
+ * @returns A promise that resolves to the parsed OpenAPI Document as ApiDOM data model
+ * @throws ParseError - When parsing fails for any reason. The original error is available via the `cause` property.
+ * @public
+ */
+export declare function parseOpenAPI(source: string, options?: OpenAPIOptions): Promise<ParseResultElement>;
 
 export { }