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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jentic/arazzo-parser",
-  "version": "1.0.0-alpha.5",
+  "version": "1.0.0-alpha.6",
   "description": "Parser for Arazzo Documents producing SpecLynx ApiDOM data model.",
   "keywords": [
     "arazzo",
@@ -48,14 +48,15 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.28.4",
-    "@speclynx/apidom-datamodel": "2.5.1",
-    "@speclynx/apidom-error": "2.5.1",
-    "@speclynx/apidom-ns-arazzo-1": "2.5.1",
-    "@speclynx/apidom-parser": "2.5.1",
-    "@speclynx/apidom-parser-adapter-arazzo-json-1": "2.5.1",
-    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "2.5.1",
-    "@speclynx/apidom-reference": "2.5.1",
-    "ramda-adjunct": "^6.0.0"
+    "@speclynx/apidom-core": "2.6.0",
+    "@speclynx/apidom-datamodel": "2.6.0",
+    "@speclynx/apidom-error": "2.6.0",
+    "@speclynx/apidom-ns-arazzo-1": "2.6.0",
+    "@speclynx/apidom-parser-adapter-arazzo-json-1": "2.6.0",
+    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "2.6.0",
+    "@speclynx/apidom-reference": "2.6.0",
+    "ramda-adjunct": "^6.0.0",
+    "type-fest": "^5.4.3"
   },
   "files": [
     "src/**/*.mjs",
@@ -67,5 +68,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "65bd559465321bc72189e7367e5465b2d91565be"
+  "gitHead": "dfdeb6d475ae72ac6bbdb0a4532e661419d87d3f"
 }

package/src/index.cjs

@@ -1,150 +1,7 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
 exports.__esModule = true;
-exports.defaultOptions = void 0;
-exports.parse = parse;
-var _apidomDatamodel = require("@speclynx/apidom-datamodel");
-var _apidomNsArazzo = require("@speclynx/apidom-ns-arazzo-1");
-var _apidomParser = _interopRequireWildcard(require("@speclynx/apidom-parser"));
-var jsonParserAdapter = _interopRequireWildcard(require("@speclynx/apidom-parser-adapter-arazzo-json-1"));
-var yamlParserAdapter = _interopRequireWildcard(require("@speclynx/apidom-parser-adapter-arazzo-yaml-1"));
-var _empty = require("@speclynx/apidom-reference/configuration/empty");
-var _arazzoJson = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/arazzo-json-1"));
-var _arazzoYaml = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/arazzo-yaml-1"));
-var _file = _interopRequireDefault(require("@speclynx/apidom-reference/resolve/resolvers/file"));
-var _httpAxios = _interopRequireDefault(require("@speclynx/apidom-reference/resolve/resolvers/http-axios"));
-var _ramdaAdjunct = require("ramda-adjunct");
-var _ParseError = _interopRequireDefault(require("./errors/ParseError.cjs"));
-/**
- * Default reference options for parsing Arazzo Documents.
- * @public
- */
-const defaultOptions = exports.defaultOptions = {
-  parse: {
-    parsers: [new _arazzoJson.default({
-      allowEmpty: false,
-      sourceMap: false
-    }), new _arazzoYaml.default({
-      allowEmpty: false,
-      sourceMap: false
-    })],
-    parserOpts: {}
-  },
-  resolve: {
-    resolvers: [new _file.default({
-      fileAllowList: ['*.json', '*.yaml', '*.yml']
-    }), new _httpAxios.default({
-      timeout: 5000,
-      redirects: 5,
-      withCredentials: false
-    })],
-    resolverOpts: {}
-  }
-};
-const parser = new _apidomParser.default();
-parser.use(jsonParserAdapter);
-parser.use(yamlParserAdapter);
-
-/**
- * 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
- * @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 - directly refracts the object into an Arazzo specification element
- * 2. String content - attempts to parse as an inline Arazzo Document (JSON or YAML)
- * 3. URI string - treats as a file system path or HTTP(S) URL and resolves the document
- *
- * @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 parse({ arazzo: '1.0.1', info: {...} });
- * ```
- *
- * @example
- * Parse inline JSON
- * ```typescript
- * const result = await parse('{"arazzo": "1.0.1", "info": {...}}');
- * ```
- *
- * @example
- * Parse from file
- * ```typescript
- * const result = await parse('/path/to/arazzo.json');
- * ```
- *
- * @example
- * Parse from URL
- * ```typescript
- * const result = await parse('https://example.com/arazzo.yaml');
- * ```
- *
- * @example
- * Parse with custom options
- * ```typescript
- * const result = await parse('/path/to/arazzo.json', customOptions);
- * ```
- * @public
- */
-async function parse(source, options = {}) {
-  const mergedOptions = (0, _empty.mergeOptions)(defaultOptions, options);
-
-  // attempt to parse source as plain object
-  if ((0, _ramdaAdjunct.isPlainObject)(source)) {
-    if (mergedOptions.parse?.parserOpts?.sourceMap) {
-      throw new _ParseError.default('sourceMap option is not supported when parsing from object: source maps cannot be inferred from plain objects');
-    }
-    const parseResult = new _apidomDatamodel.ParseResultElement();
-    const element = (0, _apidomNsArazzo.refractArazzoSpecification1)(source);
-    element.classes.push('result');
-    parseResult.push(element);
-    return parseResult;
-  }
-
-  // next try to parse the source assuming it contains Arazzo Document
-  try {
-    return await parser.parse(source, {
-      sourceMap: mergedOptions.parse?.parserOpts?.sourceMap,
-      strict: mergedOptions.parse?.parserOpts?.strict
-    });
-  } catch (error) {
-    if (error instanceof _apidomParser.ParserError && error.message !== 'Source did not match any registered parsers') {
-      throw new _ParseError.default('Failed to parse Arazzo Document', {
-        cause: error
-      });
-    }
-  }
-
-  // next we assume that source is either file system URI or HTTP(S) URL
-  try {
-    const parseResult = await (0, _empty.parse)(source, mergedOptions);
-    parseResult.meta.set('retrievalURI', source);
-    return parseResult;
-  } catch (error) {
-    throw new _ParseError.default(`Failed to parse Arazzo Document from "${source}"`, {
-      cause: error
-    });
-  }
-}
+exports.parseArazzo = exports.defaultOptions = void 0;
+var _parseArazzo = require("./parse-arazzo.cjs");
+exports.parseArazzo = _parseArazzo.parse;
+exports.defaultOptions = _parseArazzo.defaultOptions;

package/src/index.mjs

@@ -1,143 +1 @@
-import { ParseResultElement } from '@speclynx/apidom-datamodel';
-import { refractArazzoSpecification1 } from '@speclynx/apidom-ns-arazzo-1';
-import ApiDOMParser, { ParserError } from '@speclynx/apidom-parser';
-import * as jsonParserAdapter from '@speclynx/apidom-parser-adapter-arazzo-json-1';
-import * as yamlParserAdapter from '@speclynx/apidom-parser-adapter-arazzo-yaml-1';
-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 FileResolver from '@speclynx/apidom-reference/resolve/resolvers/file';
-import HTTPResolverAxios from '@speclynx/apidom-reference/resolve/resolvers/http-axios';
-import { isPlainObject } from 'ramda-adjunct';
-import ParseError from "./errors/ParseError.mjs";
-/**
- * Default reference options for parsing Arazzo Documents.
- * @public
- */
-export const defaultOptions = {
-  parse: {
-    parsers: [new ArazzoJSON1Parser({
-      allowEmpty: false,
-      sourceMap: false
-    }), new ArazzoYAML1Parser({
-      allowEmpty: false,
-      sourceMap: false
-    })],
-    parserOpts: {}
-  },
-  resolve: {
-    resolvers: [new FileResolver({
-      fileAllowList: ['*.json', '*.yaml', '*.yml']
-    }), new HTTPResolverAxios({
-      timeout: 5000,
-      redirects: 5,
-      withCredentials: false
-    })],
-    resolverOpts: {}
-  }
-};
-const parser = new ApiDOMParser();
-parser.use(jsonParserAdapter);
-parser.use(yamlParserAdapter);
-
-/**
- * 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
- * @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 - directly refracts the object into an Arazzo specification element
- * 2. String content - attempts to parse as an inline Arazzo Document (JSON or YAML)
- * 3. URI string - treats as a file system path or HTTP(S) URL and resolves the document
- *
- * @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 parse({ arazzo: '1.0.1', info: {...} });
- * ```
- *
- * @example
- * Parse inline JSON
- * ```typescript
- * const result = await parse('{"arazzo": "1.0.1", "info": {...}}');
- * ```
- *
- * @example
- * Parse from file
- * ```typescript
- * const result = await parse('/path/to/arazzo.json');
- * ```
- *
- * @example
- * Parse from URL
- * ```typescript
- * const result = await parse('https://example.com/arazzo.yaml');
- * ```
- *
- * @example
- * Parse with custom options
- * ```typescript
- * const result = await parse('/path/to/arazzo.json', customOptions);
- * ```
- * @public
- */
-export async function parse(source, options = {}) {
-  const mergedOptions = mergeOptions(defaultOptions, options);
-
-  // attempt to parse source as plain object
-  if (isPlainObject(source)) {
-    if (mergedOptions.parse?.parserOpts?.sourceMap) {
-      throw new ParseError('sourceMap option is not supported when parsing from object: source maps cannot be inferred from plain objects');
-    }
-    const parseResult = new ParseResultElement();
-    const element = refractArazzoSpecification1(source);
-    element.classes.push('result');
-    parseResult.push(element);
-    return parseResult;
-  }
-
-  // next try to parse the source assuming it contains Arazzo Document
-  try {
-    return await parser.parse(source, {
-      sourceMap: mergedOptions.parse?.parserOpts?.sourceMap,
-      strict: mergedOptions.parse?.parserOpts?.strict
-    });
-  } catch (error) {
-    if (error instanceof ParserError && error.message !== 'Source did not match any registered parsers') {
-      throw new ParseError('Failed to parse Arazzo Document', {
-        cause: error
-      });
-    }
-  }
-
-  // next we assume that source is either file system URI or HTTP(S) URL
-  try {
-    const parseResult = await parseURI(source, mergedOptions);
-    parseResult.meta.set('retrievalURI', source);
-    return parseResult;
-  } catch (error) {
-    throw new ParseError(`Failed to parse Arazzo Document from "${source}"`, {
-      cause: error
-    });
-  }
-}
+export { parse as parseArazzo, defaultOptions } from "./parse-arazzo.mjs";

package/src/parse-arazzo.cjs

@@ -0,0 +1,213 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.defaultOptions = void 0;
+exports.parse = parse;
+var _apidomCore = require("@speclynx/apidom-core");
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _empty = require("@speclynx/apidom-reference/configuration/empty");
+var _arazzoJson = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/arazzo-json-1"));
+var _arazzoYaml = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/arazzo-yaml-1"));
+var _openapiJson = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/openapi-json-2"));
+var _openapiYaml = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/openapi-yaml-2"));
+var _openapiJson2 = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/openapi-json-3-0"));
+var _openapiYaml2 = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/openapi-yaml-3-0"));
+var _openapiJson3 = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/openapi-json-3-1"));
+var _openapiYaml3 = _interopRequireDefault(require("@speclynx/apidom-reference/parse/parsers/openapi-yaml-3-1"));
+var _file = _interopRequireDefault(require("@speclynx/apidom-reference/resolve/resolvers/file"));
+var _httpAxios = _interopRequireDefault(require("@speclynx/apidom-reference/resolve/resolvers/http-axios"));
+var _apidomParserAdapterArazzoJson = require("@speclynx/apidom-parser-adapter-arazzo-json-1");
+var _apidomNsArazzo = require("@speclynx/apidom-ns-arazzo-1");
+var _apidomParserAdapterArazzoYaml = require("@speclynx/apidom-parser-adapter-arazzo-yaml-1");
+var _ramdaAdjunct = require("ramda-adjunct");
+var _ParseError = _interopRequireDefault(require("./errors/ParseError.cjs"));
+var _index = _interopRequireDefault(require("./resolve/resolvers/memory/index.cjs"));
+/**
+ * Options for parsing Arazzo Documents.
+ * @public
+ */
+
+/**
+ * Default reference options for parsing Arazzo Documents.
+ * @public
+ */
+const defaultOptions = exports.defaultOptions = {
+  parse: {
+    parsers: [new _arazzoJson.default({
+      allowEmpty: false,
+      fileExtensions: ['.json'],
+      parseFn: _empty.parse
+    }), new _arazzoYaml.default({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml'],
+      parseFn: _empty.parse
+    }), new _openapiJson.default({
+      allowEmpty: false,
+      fileExtensions: ['.json']
+    }), new _openapiYaml.default({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml']
+    }), new _openapiJson2.default({
+      allowEmpty: false,
+      fileExtensions: ['.json']
+    }), new _openapiYaml2.default({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml']
+    }), new _openapiJson3.default({
+      allowEmpty: false,
+      fileExtensions: ['.json']
+    }), new _openapiYaml3.default({
+      allowEmpty: false,
+      fileExtensions: ['.yaml', '.yml']
+    })],
+    parserOpts: {
+      sourceMap: false,
+      strict: true,
+      sourceDescriptions: false
+    }
+  },
+  resolve: {
+    resolvers: [new _index.default(), new _file.default({
+      fileAllowList: ['*.json', '*.yaml', '*.yml']
+    }), new _httpAxios.default({
+      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
+ */
+async function parse(source, options = {}) {
+  let mergedOptions = (0, _empty.mergeOptions)(defaultOptions, options);
+  const strict = mergedOptions.parse?.parserOpts?.strict ?? true;
+  let sourceProvenance;
+  if ((0, _ramdaAdjunct.isPlainObject)(source)) {
+    const arazzoDocument = JSON.stringify(source, null, 2);
+    mergedOptions = (0, _empty.mergeOptions)(mergedOptions, {
+      resolve: {
+        resolverOpts: {
+          arazzoDocument
+        }
+      }
+    });
+    source = 'memory://arazzo.json';
+    sourceProvenance = '[object]';
+  } else if (await (0, _apidomParserAdapterArazzoJson.detect)(source, {
+    strict
+  })) {
+    mergedOptions = (0, _empty.mergeOptions)(mergedOptions, {
+      resolve: {
+        resolverOpts: {
+          arazzoDocument: source
+        }
+      }
+    });
+    source = 'memory://arazzo.json';
+    sourceProvenance = '[inline JSON]';
+  } else if (await (0, _apidomParserAdapterArazzoYaml.detect)(source, {
+    strict
+  })) {
+    mergedOptions = (0, _empty.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 (0, _empty.parse)(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 (!(0, _apidomNsArazzo.isArazzoSpecification1Element)(parseResult.api)) {
+      const annotation = new _apidomDatamodel.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 => (0, _apidomCore.toValue)(cls) !== 'api');
+      }
+      parseResult.push(annotation);
+    }
+    return parseResult;
+  } catch (error) {
+    throw new _ParseError.default(`Failed to parse Arazzo Document from "${sourceProvenance}"`, {
+      cause: error
+    });
+  }
+}