@jentic/arazzo-parser 1.0.0-alpha.3 → 1.0.0-alpha.30

package/src/resolve/resolvers/memory/index.mjs

@@ -0,0 +1,25 @@
+import { Resolver, ResolverError } from '@speclynx/apidom-reference/configuration/empty';
+/**
+ * @public
+ */
+class MemoryResolver extends Resolver {
+  constructor() {
+    super({
+      name: 'memory'
+    });
+  }
+  canRead(file) {
+    return file.uri.startsWith('memory://') && this.document !== undefined;
+  }
+  async read(file) {
+    try {
+      const encoder = new TextEncoder();
+      return encoder.encode(this.document);
+    } catch (error) {
+      throw new ResolverError(`Error opening file "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+export default MemoryResolver;

package/types/arazzo-parser.d.ts

@@ -1,56 +1,91 @@
+import type { ApiDOMReferenceOptions } from '@speclynx/apidom-reference/configuration/empty';
 import { ParseResultElement } from '@speclynx/apidom-datamodel';
+import type { PartialDeep } from 'type-fest';
 
 /**
- * Default options for parsing Arazzo Documents.
+ * Default reference options for parsing Arazzo Documents.
  * @public
  */
-export declare const defaultParseOptions: Required<ParseOptions>;
+export declare const defaultParseArazzoOptions: ParseArazzoOptions;
+
+/**
+ * Default reference options for parsing OpenAPI Documents.
+ * @public
+ */
+export declare const defaultParseOpenAPIOptions: ParseOpenAPIOptions;
 
 /**
  * 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?: ParseArazzoOptions): 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 parseArazzo(source: string, options?: ParseArazzoOptions): Promise<ParseResultElement>;
+
+/**
+ * Parses an Arazzo Document from a string, object, or URI.
+ * @param source - The Arazzo Document as a plain object, string content, or URI
+ * @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 | Record<string, unknown>, options?: ParseArazzoOptions): Promise<ParseResultElement>;
 
 /**
  * Options for parsing Arazzo Documents.
  * @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 type ParseArazzoOptions = PartialDeep<ApiDOMReferenceOptions>;
+
+/**
+ * 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?: ParseOpenAPIOptions): 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?: ParseOpenAPIOptions): Promise<ParseResultElement>;
+
+/**
+ * Parses an OpenAPI Document from a string, object, or URI.
+ * @param source - The OpenAPI Document as a plain object, string content, or URI
+ * @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 | Record<string, unknown>, options?: ParseOpenAPIOptions): Promise<ParseResultElement>;
+
+/**
+ * Options for parsing OpenAPI Documents.
+ * @public
+ */
+export declare type ParseOpenAPIOptions = PartialDeep<ApiDOMReferenceOptions>;
+
+export { ParseResultElement }
 
 export { }