@speclynx/apidom-reference 2.5.0 → 2.6.0

package/src/parse/parsers/arazzo-yaml-1/index.cjs

@@ -7,6 +7,7 @@ var _ramda = require("ramda");
 var _apidomParserAdapterArazzoYaml = require("@speclynx/apidom-parser-adapter-arazzo-yaml-1");
 var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));
 var _Parser = _interopRequireDefault(require("../Parser.cjs"));
+var _sourceDescription = require("../arazzo-json-1/source-description.cjs");
 /**
  * @public
  */
@@ -16,8 +17,10 @@ var _Parser = _interopRequireDefault(require("../Parser.cjs"));
  */
 class ArazzoYAML1Parser extends _Parser.default {
   refractorOpts;
+  parseFn;
   constructor(options) {
     const {
+      parseFn,
       fileExtensions = [],
       mediaTypes = _apidomParserAdapterArazzoYaml.mediaTypes,
       ...rest
@@ -28,6 +31,7 @@ class ArazzoYAML1Parser extends _Parser.default {
       fileExtensions,
       mediaTypes
     });
+    this.parseFn = parseFn;
   }
   async canParse(file) {
     const hasSupportedFileExtension = this.fileExtensions.length === 0 ? true : this.fileExtensions.includes(file.extension);
@@ -39,11 +43,17 @@ class ArazzoYAML1Parser extends _Parser.default {
     }
     return false;
   }
-  async parse(file) {
+  async parse(file, options) {
     const source = file.toString();
     try {
       const parserOpts = (0, _ramda.pick)(['sourceMap', 'strict', 'refractorOpts'], this);
-      return await (0, _apidomParserAdapterArazzoYaml.parse)(source, parserOpts);
+      const parseResult = await (0, _apidomParserAdapterArazzoYaml.parse)(source, parserOpts);
+      const shouldParseSourceDescriptions = options?.parse?.parserOpts?.[this.name]?.sourceDescriptions ?? options?.parse?.parserOpts?.sourceDescriptions;
+      if (shouldParseSourceDescriptions) {
+        const sourceDescriptions = await _sourceDescription.parseSourceDescriptions.call(this, parseResult.api, file, options);
+        parseResult.push(...sourceDescriptions);
+      }
+      return parseResult;
     } catch (error) {
       throw new _ParserError.default(`Error parsing "${file.uri}"`, {
         cause: error

package/src/parse/parsers/arazzo-yaml-1/index.mjs

@@ -2,6 +2,7 @@ import { pick } from 'ramda';
 import { parse, mediaTypes as ArazzoYAML1MediaTypes, detect } from '@speclynx/apidom-parser-adapter-arazzo-yaml-1';
 import ParserError from "../../../errors/ParserError.mjs";
 import Parser from "../Parser.mjs";
+import { parseSourceDescriptions } from "../arazzo-json-1/source-description.mjs";
 /**
  * @public
  */
@@ -10,8 +11,10 @@ import Parser from "../Parser.mjs";
  */
 class ArazzoYAML1Parser extends Parser {
   refractorOpts;
+  parseFn;
   constructor(options) {
     const {
+      parseFn,
       fileExtensions = [],
       mediaTypes = ArazzoYAML1MediaTypes,
       ...rest
@@ -22,6 +25,7 @@ class ArazzoYAML1Parser extends Parser {
       fileExtensions,
       mediaTypes
     });
+    this.parseFn = parseFn;
   }
   async canParse(file) {
     const hasSupportedFileExtension = this.fileExtensions.length === 0 ? true : this.fileExtensions.includes(file.extension);
@@ -33,11 +37,17 @@ class ArazzoYAML1Parser extends Parser {
     }
     return false;
   }
-  async parse(file) {
+  async parse(file, options) {
     const source = file.toString();
     try {
       const parserOpts = pick(['sourceMap', 'strict', 'refractorOpts'], this);
-      return await parse(source, parserOpts);
+      const parseResult = await parse(source, parserOpts);
+      const shouldParseSourceDescriptions = options?.parse?.parserOpts?.[this.name]?.sourceDescriptions ?? options?.parse?.parserOpts?.sourceDescriptions;
+      if (shouldParseSourceDescriptions) {
+        const sourceDescriptions = await parseSourceDescriptions.call(this, parseResult.api, file, options);
+        parseResult.push(...sourceDescriptions);
+      }
+      return parseResult;
     } catch (error) {
       throw new ParserError(`Error parsing "${file.uri}"`, {
         cause: error

package/src/resolve/util.cjs

@@ -26,7 +26,7 @@ const readFile = async (file, options) => {
   try {
     const {
       result
-    } = await plugins.run('read', [file], resolvers);
+    } = await plugins.run('read', [file, options], resolvers);
     return result;
   } catch (error) {
     throw new _ResolveError.default(`Error while reading file "${file.uri}"`, {

package/src/resolve/util.mjs

@@ -20,7 +20,7 @@ export const readFile = async (file, options) => {
   try {
     const {
       result
-    } = await plugins.run('read', [file], resolvers);
+    } = await plugins.run('read', [file, options], resolvers);
     return result;
   } catch (error) {
     throw new ResolveError(`Error while reading file "${file.uri}"`, {

package/types/apidom-reference.d.ts

@@ -344,8 +344,8 @@ export declare abstract class Parser {
      */
     mediaTypes: string[];
     constructor({ name, allowEmpty, sourceMap, strict, fileExtensions, mediaTypes, }: ParserOptions);
-    abstract canParse(file: File_2): boolean | Promise<boolean>;
-    abstract parse(file: File_2): ParseResultElement | Promise<ParseResultElement>;
+    abstract canParse(file: File_2, options?: ApiDOMReferenceOptions): boolean | Promise<boolean>;
+    abstract parse(file: File_2, options?: ApiDOMReferenceOptions): ParseResultElement | Promise<ParseResultElement>;
 }
 
 /**
@@ -457,8 +457,8 @@ export declare class ResolveError extends ApiDOMError {
 export declare abstract class Resolver {
     readonly name: string;
     constructor({ name }: ResolverOptions);
-    abstract canRead(file: File_2): boolean;
-    abstract read(file: File_2): Promise<Buffer>;
+    abstract canRead(file: File_2, options?: ApiDOMReferenceOptions): boolean;
+    abstract read(file: File_2, options?: ApiDOMReferenceOptions): Promise<Buffer>;
 }
 
 /**

package/types/parse/parsers/Parser.d.ts

@@ -1,5 +1,6 @@
 import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import File from '../../File.ts';
+import type { ReferenceOptions } from '../../options/index.ts';
 /**
  * @public
  */
@@ -37,7 +38,7 @@ declare abstract class Parser {
      */
     mediaTypes: string[];
     constructor({ name, allowEmpty, sourceMap, strict, fileExtensions, mediaTypes, }: ParserOptions);
-    abstract canParse(file: File): boolean | Promise<boolean>;
-    abstract parse(file: File): ParseResultElement | Promise<ParseResultElement>;
+    abstract canParse(file: File, options?: ReferenceOptions): boolean | Promise<boolean>;
+    abstract parse(file: File, options?: ReferenceOptions): ParseResultElement | Promise<ParseResultElement>;
 }
 export default Parser;

package/types/parse/parsers/arazzo-json-1/index.d.ts

@@ -1,20 +1,24 @@
 import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
+import type { ReferenceOptions } from '../../../options/index.ts';
+import type ParseFn from '../../index.ts';
 export type { default as Parser, ParserOptions } from '../Parser.ts';
 export type { default as File, FileOptions } from '../../../File.ts';
 /**
  * @public
  */
 export interface ArazzoJSON1ParserOptions extends Omit<ParserOptions, 'name'> {
+    readonly parseFn?: typeof ParseFn;
 }
 /**
  * @public
  */
 declare class ArazzoJSON1Parser extends Parser {
     refractorOpts: object;
+    parseFn?: typeof ParseFn;
     constructor(options?: ArazzoJSON1ParserOptions);
     canParse(file: File): Promise<boolean>;
-    parse(file: File): Promise<ParseResultElement>;
+    parse(file: File, options?: ReferenceOptions): Promise<ParseResultElement>;
 }
 export default ArazzoJSON1Parser;

package/types/parse/parsers/arazzo-json-1/source-description.d.ts

@@ -0,0 +1,13 @@
+import { Element, ParseResultElement } from '@speclynx/apidom-datamodel';
+import File from '../../../File.ts';
+import type { ReferenceOptions } from '../../../options/index.ts';
+import type ParseFn from '../../index.ts';
+/**
+ * Shared function for parsing source descriptions.
+ * Call with `.call(this, ...)` where `this` has `name` and `parseFn` properties.
+ * @public
+ */
+export declare function parseSourceDescriptions(this: {
+    name: string;
+    parseFn?: typeof ParseFn;
+}, api: Element | undefined, file: File, options: ReferenceOptions): Promise<ParseResultElement[]>;

package/types/parse/parsers/arazzo-yaml-1/index.d.ts

@@ -1,20 +1,24 @@
 import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
+import type { ReferenceOptions } from '../../../options/index.ts';
+import type ParseFn from '../../index.ts';
 export type { default as Parser, ParserOptions } from '../Parser.ts';
 export type { default as File, FileOptions } from '../../../File.ts';
 /**
  * @public
  */
 export interface ArazzoYAML1ParserOptions extends Omit<ParserOptions, 'name'> {
+    readonly parseFn?: typeof ParseFn;
 }
 /**
  * @public
  */
 declare class ArazzoYAML1Parser extends Parser {
     refractorOpts: object;
+    parseFn?: typeof ParseFn;
     constructor(options?: ArazzoYAML1ParserOptions);
     canParse(file: File): Promise<boolean>;
-    parse(file: File): Promise<ParseResultElement>;
+    parse(file: File, options?: ReferenceOptions): Promise<ParseResultElement>;
 }
 export default ArazzoYAML1Parser;

package/types/resolve/resolvers/Resolver.d.ts

@@ -1,4 +1,5 @@
 import File from '../../File.ts';
+import type { ReferenceOptions } from '../../options/index.ts';
 /**
  * @public
  */
@@ -11,7 +12,7 @@ export interface ResolverOptions {
 declare abstract class Resolver {
     readonly name: string;
     constructor({ name }: ResolverOptions);
-    abstract canRead(file: File): boolean;
-    abstract read(file: File): Promise<Buffer>;
+    abstract canRead(file: File, options?: ReferenceOptions): boolean;
+    abstract read(file: File, options?: ReferenceOptions): Promise<Buffer>;
 }
 export default Resolver;