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

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,22 +1,40 @@
 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;
+
+/**
+ * Default reference options for parsing OpenAPI Documents.
+ * @public
+ */
+export declare const defaultOpenAPIOptions: OpenAPIOptions;
 
-declare type Options = PartialDeep<ApiDOMReferenceOptions>;
+/**
+ * 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 - 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?: Options): Promise<ParseResultElement>;
+export declare function parseArazzo(source: Record<string, unknown>, options?: ArazzoOptions): Promise<ParseResultElement>;
 
 /**
  * Parses an Arazzo Document from a string or URI.
@@ -26,10 +44,26 @@ export declare function parse(source: Record<string, unknown>, options?: Options
  * @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?: Options): Promise<ParseResultElement>;
+export declare function parseArazzo(source: string, options?: ArazzoOptions): Promise<ParseResultElement>;
 
-declare type PartialDeep<T> = {
-    [P in keyof T]?: T[P] extends object ? PartialDeep<T[P]> : T[P];
-};
+/**
+ * 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 { }