@redocly/openapi-language-server 0.1.1 → 0.1.3

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.
Files changed (3) hide show
  1. package/lib/index.d.ts +65 -14
  2. package/lib/index.js +58 -58
  3. package/package.json +18 -23
package/lib/index.d.ts CHANGED
@@ -17,24 +17,42 @@ declare module '@redocly/openapi-language-server/config' {
17
17
  }>;
18
18
  exists(uri: URI): Promise<boolean>;
19
19
  }
20
+ type ConfigFinder = (uri: string) => Promise<string | undefined>;
20
21
  export class Configuration {
21
22
  private _fs;
22
23
  private _documentManager;
24
+ private _findConfig;
25
+ private _getRootWorkspaceFolderURI;
26
+ constructor();
23
27
  supportedLanguages: SupportedLanguage[];
24
28
  registerFileSystemProvider(fsProvider: FileSystemProvider): void;
25
29
  registerDocumentsProvider(documentProvider: TextDocuments<TextDocument>): void;
30
+ registerConfigFinder(configFinder: ConfigFinder): void;
31
+ registerRootWorkspaceFolderURIGetter(rootWorkspaceFolderURIGetter: () => Promise<string>): void;
26
32
  get fs(): FileSystemProvider;
27
33
  get documents(): TextDocuments<TextDocument>;
34
+ get findConfig(): ConfigFinder;
35
+ get getRootWorkspaceFolderURI(): () => Promise<string>;
28
36
  }
29
37
  export const languageServerConfig: Configuration;
38
+ export {};
30
39
 
31
40
  }
32
41
  declare module '@redocly/openapi-language-server/index' {
33
42
  import { CompletionItem, CompletionParams, DidChangeWatchedFilesParams } from 'vscode-languageserver/browser';
34
- import { isConfigFile } from '@redocly/openapi-language-server/server/openapi-config';
35
43
  import { TextDocument } from 'vscode-languageserver-textdocument';
36
- import { languageServerConfig } from '@redocly/openapi-language-server/config';
37
- class OpenapiLanguageServer {
44
+ import { updateOpenAPIConfigByURI, isConfigFile, getConfigData } from '@redocly/openapi-language-server/server/openapi-config';
45
+ import { revalidateAllDocuments, validateOpenAPI } from '@redocly/openapi-language-server/server/validation/index';
46
+ import { getCompletion, resolveCompletion } from '@redocly/openapi-language-server/server/completion/yaml/completion';
47
+ export { getCompletion, resolveCompletion, revalidateAllDocuments, validateOpenAPI, updateOpenAPIConfigByURI, isConfigFile, getConfigData, };
48
+ export { languageServerConfig } from '@redocly/openapi-language-server/config';
49
+ export { getDocumentByURI, isJsonFile, isYamlFile } from '@redocly/openapi-language-server/server/documents';
50
+ export { getContextData } from '@redocly/openapi-language-server/server/context-core';
51
+ export { parseUri, uriToAbsFSPath, isHttpPath } from '@redocly/openapi-language-server/server/path';
52
+ export { removeCirculars } from '@redocly/openapi-language-server/server/utils';
53
+ export * from '@redocly/openapi-language-server/server/types/context-core';
54
+ export { DefinitionData, BundleData, bundleOpenAPI, getBundles } from '@redocly/openapi-language-server/server/bundle';
55
+ export class OpenapiLanguageServer {
38
56
  onCompletion(params: CompletionParams): Promise<CompletionItem[]>;
39
57
  onCompletionResolve(item: CompletionItem): Promise<CompletionItem>;
40
58
  validateOpenAPI(textDocument: TextDocument): Promise<import("vscode-languageserver/browser").PublishDiagnosticsParams[]>;
@@ -42,7 +60,30 @@ declare module '@redocly/openapi-language-server/index' {
42
60
  onDidConfigChange(uri: string): Promise<(Promise<import("vscode-languageserver/browser").PublishDiagnosticsParams[]> | Promise<Promise<import("vscode-languageserver/browser").PublishDiagnosticsParams[]>>)[]>;
43
61
  onDidChangeConfiguration(): Promise<(Promise<import("vscode-languageserver/browser").PublishDiagnosticsParams[]> | Promise<Promise<import("vscode-languageserver/browser").PublishDiagnosticsParams[]>>)[]>;
44
62
  }
45
- export { OpenapiLanguageServer, languageServerConfig, isConfigFile };
63
+
64
+ }
65
+ declare module '@redocly/openapi-language-server/server/__tests__/documents.test' {
66
+ export {};
67
+
68
+ }
69
+ declare module '@redocly/openapi-language-server/server/__tests__/openapi-config.test' {
70
+ export {};
71
+
72
+ }
73
+ declare module '@redocly/openapi-language-server/server/__tests__/path-completion.test' {
74
+ export {};
75
+
76
+ }
77
+ declare module '@redocly/openapi-language-server/server/__tests__/path-resolver-context.test' {
78
+ export {};
79
+
80
+ }
81
+ declare module '@redocly/openapi-language-server/server/__tests__/path.test' {
82
+ export {};
83
+
84
+ }
85
+ declare module '@redocly/openapi-language-server/server/__tests__/utils.test' {
86
+ export {};
46
87
 
47
88
  }
48
89
  declare module '@redocly/openapi-language-server/server/bundle' {
@@ -61,7 +102,6 @@ declare module '@redocly/openapi-language-server/server/bundle' {
61
102
  errors?: NormalizedProblem[];
62
103
  };
63
104
  export function bundleOpenAPI(textDocument: TextDocument, errors: NormalizedProblem[]): Promise<void>;
64
- export function getBundle(path: string): any;
65
105
  export function getBundles(): BundleData[];
66
106
  export function getRefTypes(path: string): NormalizedNodeType | undefined | null;
67
107
 
@@ -127,6 +167,14 @@ declare module '@redocly/openapi-language-server/server/completion/yaml/ValueCom
127
167
  getTextEdit(node: YAMLScalar, position: Position, lineOffset: number): TextEdit | InsertReplaceEdit;
128
168
  }
129
169
 
170
+ }
171
+ declare module '@redocly/openapi-language-server/server/completion/yaml/__tests__/KeyCompletion.test' {
172
+ export {};
173
+
174
+ }
175
+ declare module '@redocly/openapi-language-server/server/completion/yaml/__tests__/insert-snippet-utils.test' {
176
+ export {};
177
+
130
178
  }
131
179
  declare module '@redocly/openapi-language-server/server/completion/yaml/common' {
132
180
  export const fieldNames: {
@@ -139,9 +187,9 @@ declare module '@redocly/openapi-language-server/server/completion/yaml/common'
139
187
 
140
188
  }
141
189
  declare module '@redocly/openapi-language-server/server/completion/yaml/completion' {
142
- import * as yamlAst from '@redocly/yaml-language-server-parser';
143
190
  import { CompletionItem, Position } from 'vscode-languageserver/browser';
144
191
  import { DocumentUri } from 'vscode-languageserver-textdocument';
192
+ import type * as yamlAst from '@redocly/yaml-language-server-parser';
145
193
  import { ValueCompletion } from '@redocly/openapi-language-server/server/completion/yaml/ValueCompletion';
146
194
  import { YamlCompletionContext } from '@redocly/openapi-language-server/server/completion/yaml/context';
147
195
  export function getCompletionKeys(completionContext: YamlCompletionContext): CompletionItem[];
@@ -230,8 +278,7 @@ declare module '@redocly/openapi-language-server/server/context-core' {
230
278
  import * as yamlAst from '@redocly/yaml-language-server-parser';
231
279
  import type { Position } from 'vscode-languageserver/browser';
232
280
  import type { NormalizedNodeType } from '@redocly/openapi-language-server/server/types/oas';
233
- import type { ContextData, ExistingValues } from '@redocly/openapi-language-server/server/types/context-core';
234
- import type { OpenApiVersion, TextDocumentWithLineOffset, NodeWithPath, NodePath } from '@redocly/openapi-language-server/server/types/context-core';
281
+ import type { ContextData, ExistingValues, OpenApiVersion, TextDocumentWithLineOffset, NodeWithPath, NodePath } from '@redocly/openapi-language-server/server/types/context-core';
235
282
  export function getContextData(uri: string, position: Position): Promise<ContextData>;
236
283
  export function getAstNodeByPath(currentAst: yamlAst.YAMLNode | null, path: (number | string)[]): yamlAst.YAMLNode | null;
237
284
  export function getAstNodeByPosition(start: NodeWithPath, position: Position, document: TextDocumentWithLineOffset, isContextData?: boolean): NodeWithPath;
@@ -274,6 +321,9 @@ declare module '@redocly/openapi-language-server/server/external-resolver' {
274
321
  loadExternalRef(absoluteRef: string): Promise<Source>;
275
322
  }
276
323
 
324
+ }
325
+ declare module '@redocly/openapi-language-server/server/fixtures/dir1/file1' {
326
+
277
327
  }
278
328
  declare module '@redocly/openapi-language-server/server/hints' {
279
329
  import { CompletionItem } from 'vscode-languageserver/browser';
@@ -290,7 +340,6 @@ declare module '@redocly/openapi-language-server/server/openapi-config' {
290
340
  import type { Document } from '@redocly/openapi-core/lib/resolve';
291
341
  import type { DocumentUri } from 'vscode-languageserver/node';
292
342
  export { CONFIG_FILE_NAMES };
293
- export function findConfig(uri?: string): Promise<string | undefined>;
294
343
  export type ConfigData = {
295
344
  config: RedoclyConfig;
296
345
  configPath?: string;
@@ -298,14 +347,16 @@ declare module '@redocly/openapi-language-server/server/openapi-config' {
298
347
  };
299
348
  export function loadOpenAPIConfig(uri?: string): Promise<RedoclyConfig>;
300
349
  export function getConfigData(): Promise<ConfigData>;
301
- export function updateOpenAPIConfigByURI(uri: DocumentUri): Promise<RedoclyConfig>;
350
+ export function updateOpenAPIConfigByURI(uri: DocumentUri, opts?: {
351
+ createEventHandleLoadConfigError?: (message: string) => void;
352
+ }): Promise<RedoclyConfig>;
302
353
  export function isConfigFile(uri: string): boolean;
303
354
  export function isRootConfigFile(uri: string): boolean;
304
355
 
305
356
  }
306
357
  declare module '@redocly/openapi-language-server/server/openapi-extensions' {
307
- import { ExtendedNormalizedNodeType } from '@redocly/openapi-language-server/server/types/completion';
308
358
  import { mapTypeToComponent } from '@redocly/openapi-core';
359
+ import { ExtendedNormalizedNodeType } from '@redocly/openapi-language-server/server/types/completion';
309
360
  const typeExtensions: {
310
361
  Schema: {
311
362
  name: string;
@@ -510,15 +561,15 @@ declare module '@redocly/openapi-language-server/server/types/oas' {
510
561
 
511
562
  }
512
563
  declare module '@redocly/openapi-language-server/server/utils' {
513
- import { YAMLNode } from '@redocly/yaml-language-server-parser';
564
+ import type { YAMLNode } from '@redocly/yaml-language-server-parser';
514
565
  import type { TextDocument } from 'vscode-languageserver-textdocument';
515
566
  import type { ResolvedApi } from '@redocly/openapi-core';
516
567
  type Func<T> = (textDocument: TextDocument) => T | Promise<T>;
517
568
  export function debounceDocument<T>(func: Func<T>, wait?: number, immediate?: boolean): Func<Promise<T>>;
518
569
  export function removeCirculars(object: any): any;
519
570
  export function isRefField(field: string): boolean;
520
- export function getRootFilePath(apiRoot: string): Promise<string>;
521
- export function getCurrentApiAlias(apis: Record<string, ResolvedApi>, rootFilePath: string): Promise<string | undefined>;
571
+ export function getRootFilePath(apiRoot: string, rootFolderURI: string): Promise<string>;
572
+ export function getCurrentApiAlias(apis: Record<string, ResolvedApi>, rootFilePath: string, rootFolderURI: string): Promise<string | undefined>;
522
573
  export function isString<T>(value: T): boolean;
523
574
  export function isFunction<T>(f: T): boolean;
524
575
  export function isPromise<T>(value: T): boolean;