@redocly/openapi-language-server 0.10.13 → 0.10.15
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 +48 -47
- package/lib/index.js +34 -34
- package/package.json +2 -2
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';
|
|
@@ -141,14 +141,15 @@ declare module '@redocly/openapi-language-server/server/__tests__/utils.test' {
|
|
|
141
141
|
|
|
142
142
|
}
|
|
143
143
|
declare module '@redocly/openapi-language-server/server/bundle' {
|
|
144
|
-
import { type NormalizedProblem, type NormalizedNodeType } from '@redocly/openapi-core';
|
|
145
|
-
import { TextDocument } from 'vscode-languageserver-textdocument';
|
|
144
|
+
import { type NormalizedProblem, type NormalizedNodeType, type SpecVersion } from '@redocly/openapi-core';
|
|
145
|
+
import type { TextDocument } from 'vscode-languageserver-textdocument';
|
|
146
146
|
export type DefinitionData = {
|
|
147
147
|
name: string;
|
|
148
148
|
uri: string;
|
|
149
149
|
};
|
|
150
150
|
export type BundleData = DefinitionData & {
|
|
151
151
|
definition: Record<string, any>;
|
|
152
|
+
specVersion: SpecVersion;
|
|
152
153
|
rootType: NormalizedNodeType;
|
|
153
154
|
refTypes: [string, NormalizedNodeType][];
|
|
154
155
|
htmlTempalteStyles?: string | null;
|
|
@@ -160,7 +161,7 @@ declare module '@redocly/openapi-language-server/server/bundle' {
|
|
|
160
161
|
|
|
161
162
|
}
|
|
162
163
|
declare module '@redocly/openapi-language-server/server/completion/yaml/KeyCompletion' {
|
|
163
|
-
import { CompletionItem, CompletionItemKind, InsertTextFormat, Command } from 'vscode-languageserver/browser';
|
|
164
|
+
import { type CompletionItem, CompletionItemKind, InsertTextFormat, type Command } from 'vscode-languageserver/browser';
|
|
164
165
|
import type { CompletionItemOptions } from '@redocly/openapi-language-server/server/types/completion';
|
|
165
166
|
export interface KeyCompletionOptions extends CompletionItemOptions {
|
|
166
167
|
insertTextFormat?: InsertTextFormat;
|
|
@@ -180,15 +181,15 @@ declare module '@redocly/openapi-language-server/server/completion/yaml/KeyCompl
|
|
|
180
181
|
|
|
181
182
|
}
|
|
182
183
|
declare module '@redocly/openapi-language-server/server/completion/yaml/LocalFileCompletion' {
|
|
183
|
-
import { ValueCompletion, ValueCompletionOptions } from '@redocly/openapi-language-server/server/completion/yaml/ValueCompletion';
|
|
184
|
+
import { ValueCompletion, type ValueCompletionOptions } from '@redocly/openapi-language-server/server/completion/yaml/ValueCompletion';
|
|
184
185
|
export class LocalFileCompletion extends ValueCompletion {
|
|
185
186
|
constructor(completionOptions: ValueCompletionOptions);
|
|
186
187
|
}
|
|
187
188
|
|
|
188
189
|
}
|
|
189
190
|
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';
|
|
191
|
+
import { type Command } from 'vscode-languageserver/browser';
|
|
192
|
+
import { ValueCompletion, type ValueCompletionOptions } from '@redocly/openapi-language-server/server/completion/yaml/ValueCompletion';
|
|
192
193
|
export class LocalFolderCompletion extends ValueCompletion {
|
|
193
194
|
command: Command;
|
|
194
195
|
constructor(completionOptions: ValueCompletionOptions);
|
|
@@ -196,8 +197,8 @@ declare module '@redocly/openapi-language-server/server/completion/yaml/LocalFol
|
|
|
196
197
|
|
|
197
198
|
}
|
|
198
199
|
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';
|
|
200
|
+
import type { YAMLScalar } from '@redocly/yaml-language-server-parser';
|
|
201
|
+
import { type CompletionItem, CompletionItemKind, TextEdit, type InsertReplaceEdit, type Position, type Command } from 'vscode-languageserver/browser';
|
|
201
202
|
import type { CompletionItemOptions } from '@redocly/openapi-language-server/server/types/completion';
|
|
202
203
|
export interface ValueCompletionDataOptions {
|
|
203
204
|
position?: Position;
|
|
@@ -248,11 +249,11 @@ declare module '@redocly/openapi-language-server/server/completion/yaml/common'
|
|
|
248
249
|
|
|
249
250
|
}
|
|
250
251
|
declare module '@redocly/openapi-language-server/server/completion/yaml/completion' {
|
|
251
|
-
import { CompletionItem, Position } from 'vscode-languageserver/browser';
|
|
252
|
-
import {
|
|
252
|
+
import { type CompletionItem, type Position } from 'vscode-languageserver/browser';
|
|
253
|
+
import type { DocumentUri } from 'vscode-languageserver-textdocument';
|
|
253
254
|
import type * as yamlAst from '@redocly/yaml-language-server-parser';
|
|
254
255
|
import { ValueCompletion } from '@redocly/openapi-language-server/server/completion/yaml/ValueCompletion';
|
|
255
|
-
import { YamlCompletionContext } from '@redocly/openapi-language-server/server/completion/yaml/context';
|
|
256
|
+
import { type YamlCompletionContext } from '@redocly/openapi-language-server/server/completion/yaml/context';
|
|
256
257
|
export function getCompletionKeys(completionContext: YamlCompletionContext): CompletionItem[];
|
|
257
258
|
export function getCompletionValues(uri: DocumentUri, completionContext: YamlCompletionContext<yamlAst.YAMLScalar>): Promise<ValueCompletion[]>;
|
|
258
259
|
export function getCompletion(uri: DocumentUri, position: Position): Promise<CompletionItem[]>;
|
|
@@ -260,12 +261,12 @@ declare module '@redocly/openapi-language-server/server/completion/yaml/completi
|
|
|
260
261
|
|
|
261
262
|
}
|
|
262
263
|
declare module '@redocly/openapi-language-server/server/completion/yaml/config-completion' {
|
|
263
|
-
import { CompletionItem } from 'vscode-languageserver/browser';
|
|
264
|
-
import {
|
|
264
|
+
import { type CompletionItem } from 'vscode-languageserver/browser';
|
|
265
|
+
import type { DocumentUri } from 'vscode-languageserver-textdocument';
|
|
265
266
|
import type * as yamlAst from '@redocly/yaml-language-server-parser';
|
|
266
|
-
import {
|
|
267
|
+
import type { NodePath } from '@redocly/openapi-language-server/server/types/context-core';
|
|
267
268
|
import { ValueCompletion } from '@redocly/openapi-language-server/server/completion/yaml/ValueCompletion';
|
|
268
|
-
import {
|
|
269
|
+
import type { YamlCompletionContext } from '@redocly/openapi-language-server/server/completion/yaml/context';
|
|
269
270
|
export function isRulesSection(context: YamlCompletionContext): boolean;
|
|
270
271
|
export function isRuleSeverityPosition(context: YamlCompletionContext): boolean;
|
|
271
272
|
export function isExtendsItemPath(nodePath: NodePath): boolean;
|
|
@@ -276,11 +277,11 @@ declare module '@redocly/openapi-language-server/server/completion/yaml/config-c
|
|
|
276
277
|
|
|
277
278
|
}
|
|
278
279
|
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 {
|
|
280
|
+
import type { DocumentUri, Position } from 'vscode-languageserver-textdocument';
|
|
281
|
+
import { type YAMLNode } from '@redocly/yaml-language-server-parser';
|
|
282
|
+
import { type URI } from 'vscode-uri';
|
|
283
|
+
import type { NodePath } from '@redocly/openapi-language-server/server/types/context-core';
|
|
284
|
+
import type { ExtendedNormalizedNodeType } from '@redocly/openapi-language-server/server/types/completion';
|
|
284
285
|
export interface YamlCompletionContext<NodeType = YAMLNode> {
|
|
285
286
|
currentAst: YAMLNode;
|
|
286
287
|
node: NodeType;
|
|
@@ -318,12 +319,12 @@ declare module '@redocly/openapi-language-server/server/completion/yaml/insert-s
|
|
|
318
319
|
|
|
319
320
|
}
|
|
320
321
|
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';
|
|
322
|
+
import type { DocumentUri } from 'vscode-languageserver-textdocument';
|
|
323
|
+
import type { YAMLScalar } from '@redocly/yaml-language-server-parser';
|
|
324
|
+
import { type SupportedLanguage } from '@redocly/openapi-language-server/config';
|
|
324
325
|
import { LocalFolderCompletion } from '@redocly/openapi-language-server/server/completion/yaml/LocalFolderCompletion';
|
|
325
326
|
import { LocalFileCompletion } from '@redocly/openapi-language-server/server/completion/yaml/LocalFileCompletion';
|
|
326
|
-
import { YamlCompletionContext, RefPathResolverContext } from '@redocly/openapi-language-server/server/completion/yaml/context';
|
|
327
|
+
import { type YamlCompletionContext, type RefPathResolverContext } from '@redocly/openapi-language-server/server/completion/yaml/context';
|
|
327
328
|
export const LOCAL_FILES_SUPPORTED_SUGGESTIONS: SupportedLanguage[];
|
|
328
329
|
export enum FsNodeType {
|
|
329
330
|
File = 0,
|
|
@@ -349,8 +350,8 @@ declare module '@redocly/openapi-language-server/server/completion/yaml/paths' {
|
|
|
349
350
|
declare module '@redocly/openapi-language-server/server/context-core' {
|
|
350
351
|
import { type SpecVersion, type SpecMajorVersion, type NormalizedNodeType } from '@redocly/openapi-core';
|
|
351
352
|
import * as yamlAst from '@redocly/yaml-language-server-parser';
|
|
352
|
-
import {
|
|
353
|
-
import {
|
|
353
|
+
import type { Position } from 'vscode-languageserver/browser';
|
|
354
|
+
import type { ContextData, ExistingValues, OpenApiVersion, TextDocumentWithLineOffset, NodeWithPath, NodePath, NodeWithItems } from '@redocly/openapi-language-server/server/types/context-core';
|
|
354
355
|
export function getContextData(uri: string, position: Position): Promise<ContextData>;
|
|
355
356
|
export function getSpecVersion(uri: string): Promise<OpenApiVersion<SpecVersion>>;
|
|
356
357
|
export function getAstNodeByPath(currentAst: yamlAst.YAMLNode | null, path: (number | string)[]): yamlAst.YAMLNode | null;
|
|
@@ -369,7 +370,7 @@ declare module '@redocly/openapi-language-server/server/context-core' {
|
|
|
369
370
|
|
|
370
371
|
}
|
|
371
372
|
declare module '@redocly/openapi-language-server/server/documents' {
|
|
372
|
-
import { DocumentUri } from 'vscode-languageserver/browser';
|
|
373
|
+
import type { DocumentUri } from 'vscode-languageserver/browser';
|
|
373
374
|
import { TextDocument } from 'vscode-languageserver-textdocument';
|
|
374
375
|
import * as yamlAst from '@redocly/yaml-language-server-parser';
|
|
375
376
|
export type DocumentStats = {
|
|
@@ -419,7 +420,7 @@ declare module '@redocly/openapi-language-server/server/formatters/hover-formatt
|
|
|
419
420
|
|
|
420
421
|
}
|
|
421
422
|
declare module '@redocly/openapi-language-server/server/handlers/on-hover-handler' {
|
|
422
|
-
import { HoverParams } from 'vscode-languageserver';
|
|
423
|
+
import { type HoverParams } from 'vscode-languageserver';
|
|
423
424
|
import type { HoverWithMetadata } from '@redocly/openapi-language-server/server/types/hover';
|
|
424
425
|
export function onHover(params: HoverParams): Promise<HoverWithMetadata | null>;
|
|
425
426
|
|
|
@@ -431,8 +432,8 @@ declare module '@redocly/openapi-language-server/server/handlers/yaml-definition
|
|
|
431
432
|
|
|
432
433
|
}
|
|
433
434
|
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';
|
|
435
|
+
import { type CompletionItem } from 'vscode-languageserver/browser';
|
|
436
|
+
import type { ExtendedNormalizedNodeType } from '@redocly/openapi-language-server/server/types/completion';
|
|
436
437
|
export const START_SEQ_LABEL = "newItem";
|
|
437
438
|
export const START_MAP_LABEL = "propertyName";
|
|
438
439
|
export const ADD_NEW_LINE = "newLine";
|
|
@@ -458,7 +459,7 @@ declare module '@redocly/openapi-language-server/server/openapi-config' {
|
|
|
458
459
|
}
|
|
459
460
|
declare module '@redocly/openapi-language-server/server/openapi-extensions' {
|
|
460
461
|
import { mapTypeToComponent } from '@redocly/openapi-core';
|
|
461
|
-
import { ExtendedNormalizedNodeType } from '@redocly/openapi-language-server/server/types/completion';
|
|
462
|
+
import type { ExtendedNormalizedNodeType } from '@redocly/openapi-language-server/server/types/completion';
|
|
462
463
|
const typeExtensions: {
|
|
463
464
|
Schema: {
|
|
464
465
|
name: string;
|
|
@@ -536,7 +537,7 @@ declare module '@redocly/openapi-language-server/server/openapi-extensions' {
|
|
|
536
537
|
|
|
537
538
|
}
|
|
538
539
|
declare module '@redocly/openapi-language-server/server/path' {
|
|
539
|
-
import { DocumentUri } from 'vscode-languageserver/browser';
|
|
540
|
+
import type { DocumentUri } from 'vscode-languageserver/browser';
|
|
540
541
|
import { URI } from 'vscode-uri';
|
|
541
542
|
export function arePathsEqual(path1: string, path2: string): boolean;
|
|
542
543
|
export function parseUri(path: string): URI;
|
|
@@ -550,7 +551,7 @@ declare module '@redocly/openapi-language-server/server/path' {
|
|
|
550
551
|
|
|
551
552
|
}
|
|
552
553
|
declare module '@redocly/openapi-language-server/server/plugins' {
|
|
553
|
-
import {
|
|
554
|
+
import type { Config } from '@redocly/openapi-core';
|
|
554
555
|
export { clearPluginsCache } from '@redocly/openapi-core';
|
|
555
556
|
export function getPluginFiles(config: Config): Promise<string[]>;
|
|
556
557
|
export function isPluginFile(filePath: string, pluginFiles: string[]): boolean;
|
|
@@ -603,8 +604,8 @@ declare module '@redocly/openapi-language-server/server/sort' {
|
|
|
603
604
|
|
|
604
605
|
}
|
|
605
606
|
declare module '@redocly/openapi-language-server/server/types/completion' {
|
|
606
|
-
import { CompletionItemKind, TextEdit, InsertReplaceEdit } from 'vscode-languageserver/browser';
|
|
607
|
-
import {
|
|
607
|
+
import type { CompletionItemKind, TextEdit, InsertReplaceEdit } from 'vscode-languageserver/browser';
|
|
608
|
+
import type { NormalizedNodeType } from '@redocly/openapi-core';
|
|
608
609
|
type ExtendedNormalizedNodeType = Omit<NormalizedNodeType, 'properties'> & {
|
|
609
610
|
isExample?: true;
|
|
610
611
|
enum?: string[];
|
|
@@ -623,7 +624,7 @@ declare module '@redocly/openapi-language-server/server/types/completion' {
|
|
|
623
624
|
|
|
624
625
|
}
|
|
625
626
|
declare module '@redocly/openapi-language-server/server/types/context-core' {
|
|
626
|
-
import yamlAst from '@redocly/yaml-language-server-parser';
|
|
627
|
+
import type yamlAst from '@redocly/yaml-language-server-parser';
|
|
627
628
|
import type { TextDocument } from 'vscode-languageserver-textdocument';
|
|
628
629
|
import type { NormalizedNodeType, SpecMajorVersion } from '@redocly/openapi-core';
|
|
629
630
|
export enum ContextErrorCodes {
|
|
@@ -684,9 +685,9 @@ declare module '@redocly/openapi-language-server/server/types/hover' {
|
|
|
684
685
|
|
|
685
686
|
}
|
|
686
687
|
declare module '@redocly/openapi-language-server/server/utils' {
|
|
687
|
-
import { YAMLNode } from '@redocly/yaml-language-server-parser';
|
|
688
|
-
import {
|
|
689
|
-
import {
|
|
688
|
+
import { type YAMLNode } from '@redocly/yaml-language-server-parser';
|
|
689
|
+
import type { ResolvedConfig } from '@redocly/openapi-core';
|
|
690
|
+
import type { TextDocument } from 'vscode-languageserver-textdocument';
|
|
690
691
|
type Func<T> = (textDocument: TextDocument) => T | Promise<T>;
|
|
691
692
|
export function debounceDocument<T>(func: Func<T>, wait?: number, immediate?: boolean): Func<Promise<T>>;
|
|
692
693
|
export function removeCirculars(object: any): any;
|
|
@@ -739,7 +740,7 @@ declare module '@redocly/openapi-language-server/server/validation/__tests__/sco
|
|
|
739
740
|
declare module '@redocly/openapi-language-server/server/validation/index' {
|
|
740
741
|
import { type NormalizedProblem } from '@redocly/openapi-core';
|
|
741
742
|
import { type PublishDiagnosticsParams } from 'vscode-languageserver/browser';
|
|
742
|
-
import { TextDocument } from 'vscode-languageserver-textdocument';
|
|
743
|
+
import type { TextDocument } from 'vscode-languageserver-textdocument';
|
|
743
744
|
export const validateOpenAPI: (textDocument: TextDocument) => Promise<PublishDiagnosticsParams[]> | Promise<Promise<PublishDiagnosticsParams[]>>;
|
|
744
745
|
export function isSpecFile(fileContent: unknown): boolean;
|
|
745
746
|
export function revalidateAllDocuments(): (Promise<PublishDiagnosticsParams[]> | Promise<Promise<PublishDiagnosticsParams[]>>)[];
|
|
@@ -748,8 +749,8 @@ declare module '@redocly/openapi-language-server/server/validation/index' {
|
|
|
748
749
|
|
|
749
750
|
}
|
|
750
751
|
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';
|
|
752
|
+
import type { ScorecardConfig } from '@redocly/config';
|
|
753
|
+
import { type BaseResolver, type NormalizedProblem, type Document, type Plugin, type IgnoreConfig, type Config } from '@redocly/openapi-core';
|
|
753
754
|
type ScorecardTarget = NonNullable<ScorecardConfig['targets']>[number];
|
|
754
755
|
export function validateScorecard(document: Document, externalRefResolver: BaseResolver, scorecardConfig: ScorecardConfig, configPath?: string, pluginsCodeOrPlugins?: string | Plugin[], apiConfigMetadata?: Record<string, unknown>): Promise<(NormalizedProblem & {
|
|
755
756
|
scorecardLevel?: string;
|