@redocly/openapi-language-server 0.10.12 → 0.10.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.d.ts +46 -46
- package/lib/index.js +17 -17
- package/package.json +3 -3
package/lib/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
declare module '@redocly/openapi-language-server/config' {
|
|
2
|
-
import { TextDocuments } from 'vscode-languageserver/browser';
|
|
3
|
-
import { TextDocument } from 'vscode-languageserver-textdocument';
|
|
4
|
-
import { URI } from 'vscode-uri';
|
|
2
|
+
import type { TextDocuments } from 'vscode-languageserver/browser';
|
|
3
|
+
import type { TextDocument } from 'vscode-languageserver-textdocument';
|
|
4
|
+
import { type URI } from 'vscode-uri';
|
|
5
5
|
import { type ResolvedConfig } from '@redocly/openapi-core';
|
|
6
6
|
export interface SupportedLanguage {
|
|
7
7
|
languageId: string;
|
|
@@ -54,8 +54,8 @@ declare module '@redocly/openapi-language-server/esbuild' {
|
|
|
54
54
|
|
|
55
55
|
}
|
|
56
56
|
declare module '@redocly/openapi-language-server/index' {
|
|
57
|
-
import { CompletionItem,
|
|
58
|
-
import { TextDocument } from 'vscode-languageserver-textdocument';
|
|
57
|
+
import type { CompletionItem, CompletionParams, DefinitionParams, DidChangeWatchedFilesParams, HoverParams, LocationLink } from 'vscode-languageserver/browser';
|
|
58
|
+
import type { TextDocument } from 'vscode-languageserver-textdocument';
|
|
59
59
|
import { loadOpenAPIConfig, isConfigFile, isIgnoreFile, getConfigData } from '@redocly/openapi-language-server/server/openapi-config';
|
|
60
60
|
import { clearPluginsCache, getPluginFiles, isPluginFile } from '@redocly/openapi-language-server/server/plugins';
|
|
61
61
|
import { isEntityFile } from '@redocly/openapi-language-server/server/documents';
|
|
@@ -142,7 +142,7 @@ declare module '@redocly/openapi-language-server/server/__tests__/utils.test' {
|
|
|
142
142
|
}
|
|
143
143
|
declare module '@redocly/openapi-language-server/server/bundle' {
|
|
144
144
|
import { type NormalizedProblem, type NormalizedNodeType } from '@redocly/openapi-core';
|
|
145
|
-
import { TextDocument } from 'vscode-languageserver-textdocument';
|
|
145
|
+
import type { TextDocument } from 'vscode-languageserver-textdocument';
|
|
146
146
|
export type DefinitionData = {
|
|
147
147
|
name: string;
|
|
148
148
|
uri: string;
|
|
@@ -160,7 +160,7 @@ declare module '@redocly/openapi-language-server/server/bundle' {
|
|
|
160
160
|
|
|
161
161
|
}
|
|
162
162
|
declare module '@redocly/openapi-language-server/server/completion/yaml/KeyCompletion' {
|
|
163
|
-
import { CompletionItem, CompletionItemKind, InsertTextFormat, Command } from 'vscode-languageserver/browser';
|
|
163
|
+
import { type CompletionItem, CompletionItemKind, InsertTextFormat, type Command } from 'vscode-languageserver/browser';
|
|
164
164
|
import type { CompletionItemOptions } from '@redocly/openapi-language-server/server/types/completion';
|
|
165
165
|
export interface KeyCompletionOptions extends CompletionItemOptions {
|
|
166
166
|
insertTextFormat?: InsertTextFormat;
|
|
@@ -180,15 +180,15 @@ declare module '@redocly/openapi-language-server/server/completion/yaml/KeyCompl
|
|
|
180
180
|
|
|
181
181
|
}
|
|
182
182
|
declare module '@redocly/openapi-language-server/server/completion/yaml/LocalFileCompletion' {
|
|
183
|
-
import { ValueCompletion, ValueCompletionOptions } from '@redocly/openapi-language-server/server/completion/yaml/ValueCompletion';
|
|
183
|
+
import { ValueCompletion, type ValueCompletionOptions } from '@redocly/openapi-language-server/server/completion/yaml/ValueCompletion';
|
|
184
184
|
export class LocalFileCompletion extends ValueCompletion {
|
|
185
185
|
constructor(completionOptions: ValueCompletionOptions);
|
|
186
186
|
}
|
|
187
187
|
|
|
188
188
|
}
|
|
189
189
|
declare module '@redocly/openapi-language-server/server/completion/yaml/LocalFolderCompletion' {
|
|
190
|
-
import { Command } from 'vscode-languageserver/browser';
|
|
191
|
-
import { ValueCompletion, ValueCompletionOptions } from '@redocly/openapi-language-server/server/completion/yaml/ValueCompletion';
|
|
190
|
+
import { type Command } from 'vscode-languageserver/browser';
|
|
191
|
+
import { ValueCompletion, type ValueCompletionOptions } from '@redocly/openapi-language-server/server/completion/yaml/ValueCompletion';
|
|
192
192
|
export class LocalFolderCompletion extends ValueCompletion {
|
|
193
193
|
command: Command;
|
|
194
194
|
constructor(completionOptions: ValueCompletionOptions);
|
|
@@ -196,8 +196,8 @@ declare module '@redocly/openapi-language-server/server/completion/yaml/LocalFol
|
|
|
196
196
|
|
|
197
197
|
}
|
|
198
198
|
declare module '@redocly/openapi-language-server/server/completion/yaml/ValueCompletion' {
|
|
199
|
-
import { YAMLScalar } from '@redocly/yaml-language-server-parser';
|
|
200
|
-
import { CompletionItem, CompletionItemKind, TextEdit, InsertReplaceEdit, Position, Command } from 'vscode-languageserver/browser';
|
|
199
|
+
import type { YAMLScalar } from '@redocly/yaml-language-server-parser';
|
|
200
|
+
import { type CompletionItem, CompletionItemKind, TextEdit, type InsertReplaceEdit, type Position, type Command } from 'vscode-languageserver/browser';
|
|
201
201
|
import type { CompletionItemOptions } from '@redocly/openapi-language-server/server/types/completion';
|
|
202
202
|
export interface ValueCompletionDataOptions {
|
|
203
203
|
position?: Position;
|
|
@@ -248,11 +248,11 @@ declare module '@redocly/openapi-language-server/server/completion/yaml/common'
|
|
|
248
248
|
|
|
249
249
|
}
|
|
250
250
|
declare module '@redocly/openapi-language-server/server/completion/yaml/completion' {
|
|
251
|
-
import { CompletionItem, Position } from 'vscode-languageserver/browser';
|
|
252
|
-
import {
|
|
251
|
+
import { type CompletionItem, type Position } from 'vscode-languageserver/browser';
|
|
252
|
+
import type { DocumentUri } from 'vscode-languageserver-textdocument';
|
|
253
253
|
import type * as yamlAst from '@redocly/yaml-language-server-parser';
|
|
254
254
|
import { ValueCompletion } from '@redocly/openapi-language-server/server/completion/yaml/ValueCompletion';
|
|
255
|
-
import { YamlCompletionContext } from '@redocly/openapi-language-server/server/completion/yaml/context';
|
|
255
|
+
import { type YamlCompletionContext } from '@redocly/openapi-language-server/server/completion/yaml/context';
|
|
256
256
|
export function getCompletionKeys(completionContext: YamlCompletionContext): CompletionItem[];
|
|
257
257
|
export function getCompletionValues(uri: DocumentUri, completionContext: YamlCompletionContext<yamlAst.YAMLScalar>): Promise<ValueCompletion[]>;
|
|
258
258
|
export function getCompletion(uri: DocumentUri, position: Position): Promise<CompletionItem[]>;
|
|
@@ -260,12 +260,12 @@ declare module '@redocly/openapi-language-server/server/completion/yaml/completi
|
|
|
260
260
|
|
|
261
261
|
}
|
|
262
262
|
declare module '@redocly/openapi-language-server/server/completion/yaml/config-completion' {
|
|
263
|
-
import { CompletionItem } from 'vscode-languageserver/browser';
|
|
264
|
-
import {
|
|
263
|
+
import { type CompletionItem } from 'vscode-languageserver/browser';
|
|
264
|
+
import type { DocumentUri } from 'vscode-languageserver-textdocument';
|
|
265
265
|
import type * as yamlAst from '@redocly/yaml-language-server-parser';
|
|
266
|
-
import {
|
|
266
|
+
import type { NodePath } from '@redocly/openapi-language-server/server/types/context-core';
|
|
267
267
|
import { ValueCompletion } from '@redocly/openapi-language-server/server/completion/yaml/ValueCompletion';
|
|
268
|
-
import {
|
|
268
|
+
import type { YamlCompletionContext } from '@redocly/openapi-language-server/server/completion/yaml/context';
|
|
269
269
|
export function isRulesSection(context: YamlCompletionContext): boolean;
|
|
270
270
|
export function isRuleSeverityPosition(context: YamlCompletionContext): boolean;
|
|
271
271
|
export function isExtendsItemPath(nodePath: NodePath): boolean;
|
|
@@ -276,11 +276,11 @@ declare module '@redocly/openapi-language-server/server/completion/yaml/config-c
|
|
|
276
276
|
|
|
277
277
|
}
|
|
278
278
|
declare module '@redocly/openapi-language-server/server/completion/yaml/context' {
|
|
279
|
-
import {
|
|
280
|
-
import { YAMLNode } from '@redocly/yaml-language-server-parser';
|
|
281
|
-
import { URI } from 'vscode-uri';
|
|
282
|
-
import {
|
|
283
|
-
import {
|
|
279
|
+
import type { DocumentUri, Position } from 'vscode-languageserver-textdocument';
|
|
280
|
+
import { type YAMLNode } from '@redocly/yaml-language-server-parser';
|
|
281
|
+
import { type URI } from 'vscode-uri';
|
|
282
|
+
import type { NodePath } from '@redocly/openapi-language-server/server/types/context-core';
|
|
283
|
+
import type { ExtendedNormalizedNodeType } from '@redocly/openapi-language-server/server/types/completion';
|
|
284
284
|
export interface YamlCompletionContext<NodeType = YAMLNode> {
|
|
285
285
|
currentAst: YAMLNode;
|
|
286
286
|
node: NodeType;
|
|
@@ -318,12 +318,12 @@ declare module '@redocly/openapi-language-server/server/completion/yaml/insert-s
|
|
|
318
318
|
|
|
319
319
|
}
|
|
320
320
|
declare module '@redocly/openapi-language-server/server/completion/yaml/paths' {
|
|
321
|
-
import { DocumentUri } from 'vscode-languageserver-textdocument';
|
|
322
|
-
import { YAMLScalar } from '@redocly/yaml-language-server-parser';
|
|
323
|
-
import { SupportedLanguage } from '@redocly/openapi-language-server/config';
|
|
321
|
+
import type { DocumentUri } from 'vscode-languageserver-textdocument';
|
|
322
|
+
import type { YAMLScalar } from '@redocly/yaml-language-server-parser';
|
|
323
|
+
import { type SupportedLanguage } from '@redocly/openapi-language-server/config';
|
|
324
324
|
import { LocalFolderCompletion } from '@redocly/openapi-language-server/server/completion/yaml/LocalFolderCompletion';
|
|
325
325
|
import { LocalFileCompletion } from '@redocly/openapi-language-server/server/completion/yaml/LocalFileCompletion';
|
|
326
|
-
import { YamlCompletionContext, RefPathResolverContext } from '@redocly/openapi-language-server/server/completion/yaml/context';
|
|
326
|
+
import { type YamlCompletionContext, type RefPathResolverContext } from '@redocly/openapi-language-server/server/completion/yaml/context';
|
|
327
327
|
export const LOCAL_FILES_SUPPORTED_SUGGESTIONS: SupportedLanguage[];
|
|
328
328
|
export enum FsNodeType {
|
|
329
329
|
File = 0,
|
|
@@ -349,8 +349,8 @@ declare module '@redocly/openapi-language-server/server/completion/yaml/paths' {
|
|
|
349
349
|
declare module '@redocly/openapi-language-server/server/context-core' {
|
|
350
350
|
import { type SpecVersion, type SpecMajorVersion, type NormalizedNodeType } from '@redocly/openapi-core';
|
|
351
351
|
import * as yamlAst from '@redocly/yaml-language-server-parser';
|
|
352
|
-
import {
|
|
353
|
-
import {
|
|
352
|
+
import type { Position } from 'vscode-languageserver/browser';
|
|
353
|
+
import type { ContextData, ExistingValues, OpenApiVersion, TextDocumentWithLineOffset, NodeWithPath, NodePath, NodeWithItems } from '@redocly/openapi-language-server/server/types/context-core';
|
|
354
354
|
export function getContextData(uri: string, position: Position): Promise<ContextData>;
|
|
355
355
|
export function getSpecVersion(uri: string): Promise<OpenApiVersion<SpecVersion>>;
|
|
356
356
|
export function getAstNodeByPath(currentAst: yamlAst.YAMLNode | null, path: (number | string)[]): yamlAst.YAMLNode | null;
|
|
@@ -369,7 +369,7 @@ declare module '@redocly/openapi-language-server/server/context-core' {
|
|
|
369
369
|
|
|
370
370
|
}
|
|
371
371
|
declare module '@redocly/openapi-language-server/server/documents' {
|
|
372
|
-
import { DocumentUri } from 'vscode-languageserver/browser';
|
|
372
|
+
import type { DocumentUri } from 'vscode-languageserver/browser';
|
|
373
373
|
import { TextDocument } from 'vscode-languageserver-textdocument';
|
|
374
374
|
import * as yamlAst from '@redocly/yaml-language-server-parser';
|
|
375
375
|
export type DocumentStats = {
|
|
@@ -419,7 +419,7 @@ declare module '@redocly/openapi-language-server/server/formatters/hover-formatt
|
|
|
419
419
|
|
|
420
420
|
}
|
|
421
421
|
declare module '@redocly/openapi-language-server/server/handlers/on-hover-handler' {
|
|
422
|
-
import { HoverParams } from 'vscode-languageserver';
|
|
422
|
+
import { type HoverParams } from 'vscode-languageserver';
|
|
423
423
|
import type { HoverWithMetadata } from '@redocly/openapi-language-server/server/types/hover';
|
|
424
424
|
export function onHover(params: HoverParams): Promise<HoverWithMetadata | null>;
|
|
425
425
|
|
|
@@ -431,8 +431,8 @@ declare module '@redocly/openapi-language-server/server/handlers/yaml-definition
|
|
|
431
431
|
|
|
432
432
|
}
|
|
433
433
|
declare module '@redocly/openapi-language-server/server/hints' {
|
|
434
|
-
import { CompletionItem } from 'vscode-languageserver/browser';
|
|
435
|
-
import { ExtendedNormalizedNodeType } from '@redocly/openapi-language-server/server/types/completion';
|
|
434
|
+
import { type CompletionItem } from 'vscode-languageserver/browser';
|
|
435
|
+
import type { ExtendedNormalizedNodeType } from '@redocly/openapi-language-server/server/types/completion';
|
|
436
436
|
export const START_SEQ_LABEL = "newItem";
|
|
437
437
|
export const START_MAP_LABEL = "propertyName";
|
|
438
438
|
export const ADD_NEW_LINE = "newLine";
|
|
@@ -458,7 +458,7 @@ declare module '@redocly/openapi-language-server/server/openapi-config' {
|
|
|
458
458
|
}
|
|
459
459
|
declare module '@redocly/openapi-language-server/server/openapi-extensions' {
|
|
460
460
|
import { mapTypeToComponent } from '@redocly/openapi-core';
|
|
461
|
-
import { ExtendedNormalizedNodeType } from '@redocly/openapi-language-server/server/types/completion';
|
|
461
|
+
import type { ExtendedNormalizedNodeType } from '@redocly/openapi-language-server/server/types/completion';
|
|
462
462
|
const typeExtensions: {
|
|
463
463
|
Schema: {
|
|
464
464
|
name: string;
|
|
@@ -536,7 +536,7 @@ declare module '@redocly/openapi-language-server/server/openapi-extensions' {
|
|
|
536
536
|
|
|
537
537
|
}
|
|
538
538
|
declare module '@redocly/openapi-language-server/server/path' {
|
|
539
|
-
import { DocumentUri } from 'vscode-languageserver/browser';
|
|
539
|
+
import type { DocumentUri } from 'vscode-languageserver/browser';
|
|
540
540
|
import { URI } from 'vscode-uri';
|
|
541
541
|
export function arePathsEqual(path1: string, path2: string): boolean;
|
|
542
542
|
export function parseUri(path: string): URI;
|
|
@@ -550,7 +550,7 @@ declare module '@redocly/openapi-language-server/server/path' {
|
|
|
550
550
|
|
|
551
551
|
}
|
|
552
552
|
declare module '@redocly/openapi-language-server/server/plugins' {
|
|
553
|
-
import {
|
|
553
|
+
import type { Config } from '@redocly/openapi-core';
|
|
554
554
|
export { clearPluginsCache } from '@redocly/openapi-core';
|
|
555
555
|
export function getPluginFiles(config: Config): Promise<string[]>;
|
|
556
556
|
export function isPluginFile(filePath: string, pluginFiles: string[]): boolean;
|
|
@@ -603,8 +603,8 @@ declare module '@redocly/openapi-language-server/server/sort' {
|
|
|
603
603
|
|
|
604
604
|
}
|
|
605
605
|
declare module '@redocly/openapi-language-server/server/types/completion' {
|
|
606
|
-
import { CompletionItemKind, TextEdit, InsertReplaceEdit } from 'vscode-languageserver/browser';
|
|
607
|
-
import {
|
|
606
|
+
import type { CompletionItemKind, TextEdit, InsertReplaceEdit } from 'vscode-languageserver/browser';
|
|
607
|
+
import type { NormalizedNodeType } from '@redocly/openapi-core';
|
|
608
608
|
type ExtendedNormalizedNodeType = Omit<NormalizedNodeType, 'properties'> & {
|
|
609
609
|
isExample?: true;
|
|
610
610
|
enum?: string[];
|
|
@@ -623,7 +623,7 @@ declare module '@redocly/openapi-language-server/server/types/completion' {
|
|
|
623
623
|
|
|
624
624
|
}
|
|
625
625
|
declare module '@redocly/openapi-language-server/server/types/context-core' {
|
|
626
|
-
import yamlAst from '@redocly/yaml-language-server-parser';
|
|
626
|
+
import type yamlAst from '@redocly/yaml-language-server-parser';
|
|
627
627
|
import type { TextDocument } from 'vscode-languageserver-textdocument';
|
|
628
628
|
import type { NormalizedNodeType, SpecMajorVersion } from '@redocly/openapi-core';
|
|
629
629
|
export enum ContextErrorCodes {
|
|
@@ -684,9 +684,9 @@ declare module '@redocly/openapi-language-server/server/types/hover' {
|
|
|
684
684
|
|
|
685
685
|
}
|
|
686
686
|
declare module '@redocly/openapi-language-server/server/utils' {
|
|
687
|
-
import { YAMLNode } from '@redocly/yaml-language-server-parser';
|
|
688
|
-
import {
|
|
689
|
-
import {
|
|
687
|
+
import { type YAMLNode } from '@redocly/yaml-language-server-parser';
|
|
688
|
+
import type { ResolvedConfig } from '@redocly/openapi-core';
|
|
689
|
+
import type { TextDocument } from 'vscode-languageserver-textdocument';
|
|
690
690
|
type Func<T> = (textDocument: TextDocument) => T | Promise<T>;
|
|
691
691
|
export function debounceDocument<T>(func: Func<T>, wait?: number, immediate?: boolean): Func<Promise<T>>;
|
|
692
692
|
export function removeCirculars(object: any): any;
|
|
@@ -739,7 +739,7 @@ declare module '@redocly/openapi-language-server/server/validation/__tests__/sco
|
|
|
739
739
|
declare module '@redocly/openapi-language-server/server/validation/index' {
|
|
740
740
|
import { type NormalizedProblem } from '@redocly/openapi-core';
|
|
741
741
|
import { type PublishDiagnosticsParams } from 'vscode-languageserver/browser';
|
|
742
|
-
import { TextDocument } from 'vscode-languageserver-textdocument';
|
|
742
|
+
import type { TextDocument } from 'vscode-languageserver-textdocument';
|
|
743
743
|
export const validateOpenAPI: (textDocument: TextDocument) => Promise<PublishDiagnosticsParams[]> | Promise<Promise<PublishDiagnosticsParams[]>>;
|
|
744
744
|
export function isSpecFile(fileContent: unknown): boolean;
|
|
745
745
|
export function revalidateAllDocuments(): (Promise<PublishDiagnosticsParams[]> | Promise<Promise<PublishDiagnosticsParams[]>>)[];
|
|
@@ -748,8 +748,8 @@ declare module '@redocly/openapi-language-server/server/validation/index' {
|
|
|
748
748
|
|
|
749
749
|
}
|
|
750
750
|
declare module '@redocly/openapi-language-server/server/validation/scorecard' {
|
|
751
|
-
import {
|
|
752
|
-
import { BaseResolver, type NormalizedProblem, type Document, type Plugin, type IgnoreConfig, type Config } from '@redocly/openapi-core';
|
|
751
|
+
import type { ScorecardConfig } from '@redocly/config';
|
|
752
|
+
import { type BaseResolver, type NormalizedProblem, type Document, type Plugin, type IgnoreConfig, type Config } from '@redocly/openapi-core';
|
|
753
753
|
type ScorecardTarget = NonNullable<ScorecardConfig['targets']>[number];
|
|
754
754
|
export function validateScorecard(document: Document, externalRefResolver: BaseResolver, scorecardConfig: ScorecardConfig, configPath?: string, pluginsCodeOrPlugins?: string | Plugin[], apiConfigMetadata?: Record<string, unknown>): Promise<(NormalizedProblem & {
|
|
755
755
|
scorecardLevel?: string;
|