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

package/src/parse-arazzo.mjs

@@ -0,0 +1,206 @@
+import { toValue } from '@speclynx/apidom-core';
+import { AnnotationElement } from '@speclynx/apidom-datamodel';
+import { parse as parseURI, mergeOptions } from '@speclynx/apidom-reference/configuration/empty';
+import ArazzoJSON1Parser from '@speclynx/apidom-reference/parse/parsers/arazzo-json-1';
+import ArazzoYAML1Parser from '@speclynx/apidom-reference/parse/parsers/arazzo-yaml-1';
+import OpenApiJSON2Parser from '@speclynx/apidom-reference/parse/parsers/openapi-json-2';
+import OpenApiYAML2Parser from '@speclynx/apidom-reference/parse/parsers/openapi-yaml-2';
+import OpenApiJSON3_0Parser from '@speclynx/apidom-reference/parse/parsers/openapi-json-3-0';
+import OpenApiYAML3_0Parser from '@speclynx/apidom-reference/parse/parsers/openapi-yaml-3-0';
+import OpenApiJSON3_1Parser from '@speclynx/apidom-reference/parse/parsers/openapi-json-3-1';
+import OpenApiYAML3_1Parser from '@speclynx/apidom-reference/parse/parsers/openapi-yaml-3-1';
+import FileResolver from '@speclynx/apidom-reference/resolve/resolvers/file';
+import HTTPResolverAxios from '@speclynx/apidom-reference/resolve/resolvers/http-axios';
+import { detect as detectArazzoJSON } from '@speclynx/apidom-parser-adapter-arazzo-json-1';
+import { isArazzoSpecification1Element } from '@speclynx/apidom-ns-arazzo-1';
+import { detect as detectArazzoYAML } from '@speclynx/apidom-parser-adapter-arazzo-yaml-1';
+import { isPlainObject } from 'ramda-adjunct';
+import ParseError from "./errors/ParseError.mjs";
+import MemoryResolver from "./resolve/resolvers/memory/index.mjs";
+/**
+ * Options for parsing Arazzo Documents.
+ * @public
+ */
+/**
+ * Default reference options for parsing Arazzo Documents.
+ * @public
+ */
+export const defaultOptions = {
+  parse: {
+    parsers: [new ArazzoJSON1Parser({
+      allowEmpty: false,
+      fileExtensions: ['.json'],
+      parseFn: parseURI
+    }), new ArazzoYAML1Parser({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml'],
+      parseFn: parseURI
+    }), new OpenApiJSON2Parser({
+      allowEmpty: false,
+      fileExtensions: ['.json']
+    }), new OpenApiYAML2Parser({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml']
+    }), new OpenApiJSON3_0Parser({
+      allowEmpty: false,
+      fileExtensions: ['.json']
+    }), new OpenApiYAML3_0Parser({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml']
+    }), new OpenApiJSON3_1Parser({
+      allowEmpty: false,
+      fileExtensions: ['.json']
+    }), new OpenApiYAML3_1Parser({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml']
+    })],
+    parserOpts: {
+      sourceMap: false,
+      strict: true,
+      sourceDescriptions: false
+    }
+  },
+  resolve: {
+    resolvers: [new MemoryResolver(), new FileResolver({
+      fileAllowList: ['*.json', '*.yaml', '*.yml']
+    }), new HTTPResolverAxios({
+      timeout: 5000,
+      redirects: 5,
+      withCredentials: false
+    })],
+    resolverOpts: {}
+  }
+};
+
+/**
+ * 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
+ */
+
+/**
+ * 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 - 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
+ */
+
+/**
+ * Parses an Arazzo Document from a string, object, or URI.
+ *
+ * The function handles three types of input:
+ * 1. Object - converts to JSON string and parses (source maps supported with `strict: false`)
+ * 2. String content - uses Arazzo detection to identify and parse inline JSON or YAML content
+ * 3. URI string - if not detected as Arazzo content, treats as file system path or HTTP(S) URL
+ *
+ * @param source - The Arazzo Document as an object, 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 Arazzo Document as ApiDOM data model
+ * @throws ParseError - When parsing fails for any reason. The original error is available via the `cause` property.
+ *
+ * @example
+ * Parse from object
+ * ```typescript
+ * const result = await parseArazzo({ arazzo: '1.0.1', info: {...} });
+ * ```
+ *
+ * @example
+ * Parse inline JSON
+ * ```typescript
+ * const result = await parseArazzo('{"arazzo": "1.0.1", "info": {...}}');
+ * ```
+ *
+ * @example
+ * Parse from file
+ * ```typescript
+ * const result = await parseArazzo('/path/to/arazzo.json');
+ * ```
+ *
+ * @example
+ * Parse from URL
+ * ```typescript
+ * const result = await parseArazzo('https://example.com/arazzo.yaml');
+ * ```
+ *
+ * @example
+ * Parse with custom options
+ * ```typescript
+ * const result = await parseArazzo('/path/to/arazzo.json', customOptions);
+ * ```
+ * @public
+ */
+export async function parse(source, options = {}) {
+  let mergedOptions = mergeOptions(defaultOptions, options);
+  const strict = mergedOptions.parse?.parserOpts?.strict ?? true;
+  let sourceProvenance;
+  if (isPlainObject(source)) {
+    const arazzoDocument = JSON.stringify(source, null, 2);
+    mergedOptions = mergeOptions(mergedOptions, {
+      resolve: {
+        resolverOpts: {
+          arazzoDocument
+        }
+      }
+    });
+    source = 'memory://arazzo.json';
+    sourceProvenance = '[object]';
+  } else if (await detectArazzoJSON(source, {
+    strict
+  })) {
+    mergedOptions = mergeOptions(mergedOptions, {
+      resolve: {
+        resolverOpts: {
+          arazzoDocument: source
+        }
+      }
+    });
+    source = 'memory://arazzo.json';
+    sourceProvenance = '[inline JSON]';
+  } else if (await detectArazzoYAML(source, {
+    strict
+  })) {
+    mergedOptions = mergeOptions(mergedOptions, {
+      resolve: {
+        resolverOpts: {
+          arazzoDocument: source
+        }
+      }
+    });
+    source = 'memory://arazzo.yaml';
+    sourceProvenance = '[inline YAML]';
+  } else {
+    sourceProvenance = source;
+  }
+
+  // next we assume that source is either file system URI or HTTP(S) URL
+  try {
+    const parseResult = await parseURI(source, mergedOptions);
+
+    // set retrievalURI metadata for file/URL sources (not for inline content)
+    if (!source.startsWith('memory://')) {
+      parseResult.meta.set('retrievalURI', source);
+    }
+
+    // validate that the parsed document is an Arazzo specification
+    if (!isArazzoSpecification1Element(parseResult.api)) {
+      const annotation = new AnnotationElement('Document is not a valid Arazzo specification. Expected an Arazzo document with "arazzo" version field.', {
+        classes: ['error']
+      });
+      // remove 'api' class so .api returns undefined, but keep parsed result available
+      if (parseResult.api) {
+        parseResult.api.classes = parseResult.api.classes.filter(cls => toValue(cls) !== 'api');
+      }
+      parseResult.push(annotation);
+    }
+    return parseResult;
+  } catch (error) {
+    throw new ParseError(`Failed to parse Arazzo Document from "${sourceProvenance}"`, {
+      cause: error
+    });
+  }
+}

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

@@ -0,0 +1,29 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _empty = require("@speclynx/apidom-reference/configuration/empty");
+/**
+ * @public
+ */
+class MemoryResolver extends _empty.Resolver {
+  constructor() {
+    super({
+      name: 'memory'
+    });
+  }
+  canRead(file) {
+    return file.uri.startsWith('memory://') && typeof this.arazzoDocument === 'string';
+  }
+  async read(file) {
+    try {
+      const encoder = new TextEncoder();
+      return encoder.encode(this.arazzoDocument);
+    } catch (error) {
+      throw new _empty.ResolverError(`Error opening file "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+var _default = exports.default = MemoryResolver;

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://') && typeof this.arazzoDocument === 'string';
+  }
+  async read(file) {
+    try {
+      const encoder = new TextEncoder();
+      return encoder.encode(this.arazzoDocument);
+    } catch (error) {
+      throw new ResolverError(`Error opening file "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+export default MemoryResolver;

package/types/arazzo-parser.d.ts

@@ -1,5 +1,6 @@
 import type { ApiDOMReferenceOptions } from '@speclynx/apidom-reference';
 import { ParseResultElement } from '@speclynx/apidom-datamodel';
+import type { PartialDeep } from 'type-fest';
 
 /**
  * Default reference options for parsing Arazzo Documents.
@@ -7,16 +8,21 @@ import { ParseResultElement } from '@speclynx/apidom-datamodel';
  */
 export declare const defaultOptions: Options;
 
-declare type Options = PartialDeep<ApiDOMReferenceOptions>;
+/**
+ * Options for parsing Arazzo Documents.
+ * @public
+ */
+export declare type Options = 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?: Options): Promise<ParseResultElement>;
 
 /**
  * Parses an Arazzo Document from a string or URI.
@@ -26,10 +32,6 @@ 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>;
-
-declare type PartialDeep<T> = {
-    [P in keyof T]?: T[P] extends object ? PartialDeep<T[P]> : T[P];
-};
+export declare function parseArazzo(source: string, options?: Options): Promise<ParseResultElement>;
 
 export { }