feat(ls): add option to pass down reference options for validation (#5014)

Author: glowcloud

packages/apidom-ls/src/apidom-language-service.ts

@@ -95,6 +95,7 @@ export default function getLanguageService(context: LanguageServiceContext): Lan
     symbolsContext: context.symbolsContext,
     colorsContext: context.colorsContext,
     linksContext: context.linksContext,
+    referenceOptions: context.referenceOptions,
   };
   configureServices(languageSettings);
 

packages/apidom-ls/src/apidom-language-types.ts

@@ -27,6 +27,7 @@ import {
   ReferenceParams,
 } from 'vscode-languageserver-protocol';
 import { Element, ParseResultElement } from '@swagger-api/apidom-core';
+import { ApiDOMReferenceOptions } from '@swagger-api/apidom-reference';
 
 /**
  * @public
@@ -107,6 +108,7 @@ export interface LanguageServiceContext {
   colorsContext?: ColorsContext;
   linksContext?: LinksContext;
   refractorPlugins?: RefractorPlugins;
+  referenceOptions?: ApiDOMReferenceOptions;
 }
 
 /**
@@ -316,6 +318,7 @@ export interface LanguageSettings {
   symbolsContext?: SymbolsContext;
   colorsContext?: ColorsContext;
   linksContext?: LinksContext;
+  referenceOptions?: ApiDOMReferenceOptions;
 }
 
 // export type SeverityLevel = 'error' | 'warning' | 'ignore';

packages/apidom-ls/src/services/validation/validation-service.ts

@@ -237,6 +237,7 @@ export class DefaultValidationService implements ValidationService {
       : 'https://smartbear.com/';
     const apiReference = new Reference({ uri: baseURI, value: cloneDeep(result)! });
     const cachedParsers = options.parse.parsers.map(DefaultValidationService.createCachedParser);
+    const { referenceOptions } = this.settings || {};
 
     for (const [fragmentId, refEl] of refElements.entries()) {
       const referenceElementReference = new Reference({
@@ -248,14 +249,17 @@ export class DefaultValidationService implements ValidationService {
       try {
         const promise = dereferenceApiDOM(refEl, {
           resolve: {
+            ...(referenceOptions?.resolve ?? {}),
             baseURI: `${baseURI}#reference${fragmentId}`,
             external: !toValue((refEl as ObjectElement).get('$ref')).startsWith('#'),
           },
           parse: {
+            ...(referenceOptions?.parse ?? {}),
             parsers: cachedParsers,
             mediaType: nameSpace.mediaType,
           },
           dereference: {
+            ...(referenceOptions?.dereference ?? {}),
             refSet,
             immutable: false,
           },
@@ -339,6 +343,7 @@ export class DefaultValidationService implements ValidationService {
       : 'https://smartbear.com/';
     const apiReference = new Reference({ uri: baseURI, value: cloneDeep(result) });
     const cachedParsers = options.parse.parsers.map(DefaultValidationService.createCachedParser);
+    const { referenceOptions } = this.settings || {};
 
     for (const [fragmentId, refEl] of refElements.entries()) {
       const referenceElementReference = new Reference({
@@ -351,14 +356,17 @@ export class DefaultValidationService implements ValidationService {
         // eslint-disable-next-line no-await-in-loop
         await dereferenceApiDOM(refEl, {
           resolve: {
+            ...(referenceOptions?.resolve ?? {}),
             baseURI: `${baseURI}#reference${fragmentId}`,
             external: !toValue((refEl as ObjectElement).get('$ref')).startsWith('#'),
           },
           parse: {
+            ...(referenceOptions?.parse ?? {}),
             mediaType: nameSpace.mediaType,
             parsers: cachedParsers,
           },
           dereference: {
+            ...(referenceOptions?.dereference ?? {}),
             refSet,
             immutable: false,
           },