@jentic/arazzo-parser 1.0.0-alpha.20 → 1.0.0-alpha.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jentic/arazzo-parser",
-  "version": "1.0.0-alpha.20",
+  "version": "1.0.0-alpha.22",
   "description": "Parser for Arazzo Documents producing SpecLynx ApiDOM data model.",
   "keywords": [
     "arazzo",
@@ -48,22 +48,24 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.28.4",
-    "@speclynx/apidom-core": "^2.12.2",
-    "@speclynx/apidom-datamodel": "^2.12.2",
-    "@speclynx/apidom-error": "^2.12.2",
-    "@speclynx/apidom-ns-arazzo-1": "^2.12.2",
-    "@speclynx/apidom-parser-adapter-arazzo-json-1": "^2.12.2",
-    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "^2.12.2",
-    "@speclynx/apidom-parser-adapter-openapi-json-2": "^2.12.2",
-    "@speclynx/apidom-parser-adapter-openapi-json-3-0": "^2.12.2",
-    "@speclynx/apidom-parser-adapter-openapi-json-3-1": "^2.12.2",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-2": "^2.12.2",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-3-0": "^2.12.2",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-3-1": "^2.12.2",
-    "@speclynx/apidom-reference": "^2.12.2",
+    "@speclynx/apidom-datamodel": "^3.2.1",
+    "@speclynx/apidom-error": "^3.2.1",
+    "@speclynx/apidom-ns-arazzo-1": "^3.2.1",
+    "@speclynx/apidom-parser-adapter-arazzo-json-1": "^3.2.1",
+    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "^3.2.1",
+    "@speclynx/apidom-parser-adapter-openapi-json-2": "^3.2.1",
+    "@speclynx/apidom-parser-adapter-openapi-json-3-0": "^3.2.1",
+    "@speclynx/apidom-parser-adapter-openapi-json-3-1": "^3.2.1",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-2": "^3.2.1",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-3-0": "^3.2.1",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-3-1": "^3.2.1",
+    "@speclynx/apidom-reference": "^3.2.1",
     "ramda-adjunct": "^6.0.0",
     "type-fest": "^5.4.3"
   },
+  "devDependencies": {
+    "@speclynx/apidom-core": "^3.2.1"
+  },
   "files": [
     "src/**/*.mjs",
     "src/**/*.cjs",
@@ -74,5 +76,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "64f8b4b3109900b622fa7f378e58659a43ab57d8"
+  "gitHead": "9f03b72cf574d1e18d83fa85051e2d0e41929491"
 }

package/src/errors/ParseError.cjs

@@ -1,11 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomError = require("@speclynx/apidom-error");
-class ParseError extends _apidomError.ApiDOMError {
-  constructor(message, options) {
-    super(message, options);
-  }
-}
-var _default = exports.default = ParseError;

package/src/errors/ParseError.mjs

@@ -1,7 +0,0 @@
-import { ApiDOMError } from '@speclynx/apidom-error';
-class ParseError extends ApiDOMError {
-  constructor(message, options) {
-    super(message, options);
-  }
-}
-export default ParseError;

package/src/index.cjs

@@ -1,10 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.parseOpenAPI = exports.parseArazzo = exports.defaultOpenAPIOptions = exports.defaultArazzoOptions = void 0;
-var _parseArazzo = require("./parse-arazzo.cjs");
-exports.parseArazzo = _parseArazzo.parse;
-exports.defaultArazzoOptions = _parseArazzo.defaultOptions;
-var _parseOpenapi = require("./parse-openapi.cjs");
-exports.parseOpenAPI = _parseOpenapi.parse;
-exports.defaultOpenAPIOptions = _parseOpenapi.defaultOptions;

package/src/index.mjs

@@ -1,2 +0,0 @@
-export { parse as parseArazzo, defaultOptions as defaultArazzoOptions } from "./parse-arazzo.mjs";
-export { parse as parseOpenAPI, defaultOptions as defaultOpenAPIOptions } from "./parse-openapi.mjs";

package/src/parse-arazzo.cjs

@@ -1,195 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.defaultOptions = void 0;
-exports.parse = parse;
-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
-    }), new _arazzoYaml.default({
-      allowEmpty: false
-    }), new _openapiJson.default({
-      allowEmpty: false
-    }), new _openapiYaml.default({
-      allowEmpty: false
-    }), new _openapiJson2.default({
-      allowEmpty: false
-    }), new _openapiYaml2.default({
-      allowEmpty: false
-    }), new _openapiJson3.default({
-      allowEmpty: false
-    }), new _openapiYaml3.default({
-      allowEmpty: false
-    })],
-    parserOpts: {
-      sourceMap: false,
-      style: 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 document = JSON.stringify(source, null, 2);
-    mergedOptions = (0, _empty.mergeOptions)(mergedOptions, {
-      resolve: {
-        resolverOpts: {
-          document
-        }
-      }
-    });
-    source = 'memory://arazzo.json';
-    sourceProvenance = '[object]';
-  } else if (await (0, _apidomParserAdapterArazzoJson.detect)(source, {
-    strict
-  })) {
-    mergedOptions = (0, _empty.mergeOptions)(mergedOptions, {
-      resolve: {
-        resolverOpts: {
-          document: source
-        }
-      }
-    });
-    source = 'memory://arazzo.json';
-    sourceProvenance = '[inline JSON]';
-  } else if (await (0, _apidomParserAdapterArazzoYaml.detect)(source, {
-    strict
-  })) {
-    mergedOptions = (0, _empty.mergeOptions)(mergedOptions, {
-      resolve: {
-        resolverOpts: {
-          document: 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)) {
-      throw new _empty.UnmatchedParserError(`Could not find a parser that can parse "${sourceProvenance}" as an Arazzo specification`);
-    }
-    return parseResult;
-  } catch (error) {
-    throw new _ParseError.default(`Failed to parse Arazzo Document from "${sourceProvenance}"`, {
-      cause: error
-    });
-  }
-}

package/src/parse-arazzo.mjs

@@ -1,188 +0,0 @@
-import { parse as parseURI, mergeOptions, UnmatchedParserError } 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
-    }), new ArazzoYAML1Parser({
-      allowEmpty: false
-    }), new OpenApiJSON2Parser({
-      allowEmpty: false
-    }), new OpenApiYAML2Parser({
-      allowEmpty: false
-    }), new OpenApiJSON3_0Parser({
-      allowEmpty: false
-    }), new OpenApiYAML3_0Parser({
-      allowEmpty: false
-    }), new OpenApiJSON3_1Parser({
-      allowEmpty: false
-    }), new OpenApiYAML3_1Parser({
-      allowEmpty: false
-    })],
-    parserOpts: {
-      sourceMap: false,
-      style: 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 document = JSON.stringify(source, null, 2);
-    mergedOptions = mergeOptions(mergedOptions, {
-      resolve: {
-        resolverOpts: {
-          document
-        }
-      }
-    });
-    source = 'memory://arazzo.json';
-    sourceProvenance = '[object]';
-  } else if (await detectArazzoJSON(source, {
-    strict
-  })) {
-    mergedOptions = mergeOptions(mergedOptions, {
-      resolve: {
-        resolverOpts: {
-          document: source
-        }
-      }
-    });
-    source = 'memory://arazzo.json';
-    sourceProvenance = '[inline JSON]';
-  } else if (await detectArazzoYAML(source, {
-    strict
-  })) {
-    mergedOptions = mergeOptions(mergedOptions, {
-      resolve: {
-        resolverOpts: {
-          document: 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)) {
-      throw new UnmatchedParserError(`Could not find a parser that can parse "${sourceProvenance}" as an Arazzo specification`);
-    }
-    return parseResult;
-  } catch (error) {
-    throw new ParseError(`Failed to parse Arazzo Document from "${sourceProvenance}"`, {
-      cause: error
-    });
-  }
-}