@jentic/arazzo-parser 1.0.0-alpha.2 → 1.0.0-alpha.21

package/types/arazzo-parser.d.ts

@@ -1,56 +1,69 @@
+import type { ApiDOMReferenceOptions } from '@speclynx/apidom-reference';
 import { ParseResultElement } from '@speclynx/apidom-datamodel';
+import type { PartialDeep } from 'type-fest';
 
 /**
- * Default options for parsing Arazzo Documents.
+ * Options for parsing Arazzo Documents.
+ * @public
+ */
+export declare type ArazzoOptions = PartialDeep<ApiDOMReferenceOptions>;
+
+/**
+ * Default reference options for parsing Arazzo Documents.
  * @public
  */
-export declare const defaultParseOptions: Required<ParseOptions>;
+export declare const defaultArazzoOptions: ArazzoOptions;
+
+/**
+ * Default reference options for parsing OpenAPI Documents.
+ * @public
+ */
+export declare const defaultOpenAPIOptions: OpenAPIOptions;
+
+/**
+ * Options for parsing OpenAPI Documents.
+ * @public
+ */
+export declare type OpenAPIOptions = PartialDeep<ApiDOMReferenceOptions>;
 
 /**
  * Parses an Arazzo Document from an object.
  * @param source - The Arazzo Document as a plain object
- * @param options - Parsing options
+ * @param options - Reference options (uses defaultOptions when not provided)
  * @returns A promise that resolves to the parsed Arazzo 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 parse(source: Record<string, unknown>, options?: ParseOptions): Promise<ParseResultElement>;
+export declare function parseArazzo(source: Record<string, unknown>, options?: ArazzoOptions): Promise<ParseResultElement>;
 
 /**
  * Parses an Arazzo Document from a string or URI.
  * @param source - The Arazzo Document as string content, or a file system path / HTTP(S) URL
- * @param options - Parsing options
+ * @param options - Reference options (uses defaultOptions when not provided)
  * @returns A promise that resolves to the parsed Arazzo 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 parse(source: string, options?: ParseOptions): Promise<ParseResultElement>;
+export declare function parseArazzo(source: string, options?: ArazzoOptions): Promise<ParseResultElement>;
 
 /**
- * Options for parsing Arazzo Documents.
+ * 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 interface ParseOptions {
-    /**
-     * Whether to enforce strict parsing mode.
-     * Strict parsing mode is using native JSON and YAML parsers without source maps and error recovery.
-     * @defaultValue true
-     */
-    readonly strict?: boolean;
-    /**
-     * Whether to include source maps in the parsed result.
-     * @defaultValue false
-     */
-    readonly sourceMap?: boolean;
-    /**
-     * Additional options passed to the underlying parsers.
-     * @defaultValue \{\}
-     */
-    readonly parserOpts?: Record<string, unknown>;
-    /**
-     * Additional options passed to the underlying resolvers.
-     * @defaultValue \{\}
-     */
-    readonly resolverOpts?: Record<string, unknown>;
-}
+export declare function parseOpenAPI(source: string, options?: OpenAPIOptions): Promise<ParseResultElement>;
 
 export { }