@arcgis/coding-components 4.31.0-next.4 → 4.31.0-next.41

package/dist/types/utils/sql-expr-monaco/sql-expr-language-features.d.ts

@@ -1,540 +1,24 @@
-import type { IRange, Position, editor, languages } from "monaco-editor";
-import { standardizedFunctions } from "./DependentFiles/standardizedFunctions";
+import { editor } from "monaco-editor";
+import type { Position, languages } from "monaco-editor";
 import type { SqlExprDefaults } from "./sql-expr-defaults";
+import type { ISqlExprWorkerAccessor } from "./types";
+import type { SqlExprDiagnosticService } from "./sql-expr-mode";
 export declare class SqlExprCompletionProvider implements languages.CompletionItemProvider {
+    private _worker;
     private _defaults;
-    constructor(_defaults: SqlExprDefaults);
+    constructor(_worker: ISqlExprWorkerAccessor, _defaults: SqlExprDefaults);
     provideCompletionItems(model: editor.ITextModel, position: Position): Promise<languages.CompletionList | undefined>;
 }
-export declare const apiFunctions: {
-    char_length: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    coalesce: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string[];
-            description: string;
-        }[];
-        returnValue: string[];
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    concat: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    lower: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    position: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    substring: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    }[];
-    trim: {
-        description: string;
-        parameters: ({
-            name: string;
-            type: string[];
-            description: string;
-        } | {
-            name: string;
-            type: string;
-            description: string;
-        })[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    upper: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    abs: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    acos: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    asin: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    atan: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    cast: {
-        description: string;
-        parameters: ({
-            name: string;
-            type: string;
-            description: string;
-        } | {
-            name: string;
-            type: string[];
-            description: string;
-        })[];
-        returnValue: string[];
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    ceiling: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    cos: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    floor: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    log: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    log10: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    mod: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    nullif: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string[];
-            description: string;
-        }[];
-        returnValue: string[];
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    power: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    round: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    sign: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    sin: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    tan: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    truncate: {
-        description: string;
-        parameters: {
-            name: string;
-            type: string;
-            description: string;
-        }[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-    current_date: {
-        description: string;
-        parameters: never[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string[];
-        name: string;
-        bundle: string;
-    };
-    current_time: {
-        description: string;
-        parameters: never[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string[];
-        name: string;
-        bundle: string;
-    };
-    current_timestamp: {
-        description: string;
-        parameters: never[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string[];
-        name: string;
-        bundle: string;
-    };
-    extract: {
-        description: string;
-        parameters: ({
-            name: string;
-            type: string[];
-            description: string;
-        } | {
-            name: string;
-            type: string;
-            description: string;
-        })[];
-        returnValue: string;
-        examples: {
-            description: string;
-            code: string;
-        }[];
-        snippet: string;
-        name: string;
-        bundle: string;
-    };
-};
-export declare const sqlParenLessFunctions: string[];
-export declare const sqlFunctions: string[];
-export declare const dataTypes: string[];
-export declare const getKeywords: (identifier: string) => string[] | undefined;
-export declare const getDelimiterPosition: (index: number, node: any, model: editor.ITextModel, lastIndex: number) => IRange;
-export declare const isSqlParenLessFunction: (word: string) => boolean;
-export declare const getCursorWithinRange: (position: Position, startPos: IRange, endPos: IRange) => boolean[];
-export declare const generateTypeDescription: (name: string, parameters: {
-    description: string;
-    name: string;
-    type: string[] | string;
-}[], returnType: string[] | string) => string;
-export declare const generateCompletionDocumentation: (description: string, examples: {
-    code: string;
-    description: string;
-}[]) => string;
-export declare function getFunction(functionName: string): (typeof standardizedFunctions)[keyof typeof standardizedFunctions];
-export declare enum ChildBearingProperties {
-    ARGS = "args",
-    CLAUSES = "clauses",
-    ELSE = "else",
-    END = "end",
-    EXPR = "expr",
-    LEFT = "left",
-    OPERAND = "operand",
-    QUALIFIER = "qualifier",
-    RIGHT = "right",
-    START = "start",
-    VALUE = "value"
-}
-export declare enum ChildBearingNodeTypes {
-    CASE_EXPRESSION = "case-expression",
-    EXPRESSION_LIST = "expression-list",
-    FUNCTION = "function",
-    INTERVAL = "interval",
-    INTERVAL_QUALIFIER = "interval-qualifier",
-    WHEN_CLAUSE = "when-clause",
-    UNARY_EXPRESSION = "unary-expression",
-    BINARY_EXPRESSION = "binary-expression"
+export declare class SqlExprDiagnosticsAdapter {
+    private _languageId;
+    private _worker;
+    private _disposables;
+    private _listener;
+    private _diagnosticsService;
+    private _defaults;
+    constructor(_languageId: string, _worker: ISqlExprWorkerAccessor, { defaults, diagnosticService, }: {
+        defaults: SqlExprDefaults;
+        diagnosticService: SqlExprDiagnosticService;
+    });
+    private _doValidate;
 }
-export declare const CHILD_BEARING_PROPERTIES: {
-    readonly "case-expression": readonly [ChildBearingProperties.CLAUSES, ChildBearingProperties.OPERAND, ChildBearingProperties.ELSE];
-    readonly "when-clause": readonly [ChildBearingProperties.OPERAND, ChildBearingProperties.VALUE];
-    readonly "expression-list": readonly [ChildBearingProperties.VALUE];
-    readonly "unary-expression": readonly [ChildBearingProperties.EXPR];
-    readonly "binary-expression": readonly [ChildBearingProperties.LEFT, ChildBearingProperties.RIGHT];
-    readonly function: readonly [ChildBearingProperties.ARGS];
-    readonly interval: readonly [ChildBearingProperties.VALUE, ChildBearingProperties.QUALIFIER];
-    readonly "interval-qualifier": readonly [ChildBearingProperties.START, ChildBearingProperties.END];
-};

package/dist/types/utils/sql-expr-monaco/sql-expr-mode.d.ts

@@ -1,4 +1,4 @@
-import type { Uri } from "monaco-editor";
+import type { IEvent, Uri, editor } from "monaco-editor";
 import type { ISqlExprWorker } from "./types";
 import { type SqlExprDefaults } from "./sql-expr-defaults";
 /**
@@ -7,4 +7,37 @@ import { type SqlExprDefaults } from "./sql-expr-defaults";
  * @returns The sql-expression worker.
  */
 export declare function getSqlExprWorker(...uris: Uri[]): Promise<ISqlExprWorker>;
+export interface ISqlExprDiagnosticEvent {
+    /**
+     * The uri of the model for which the diagnostics changed.
+     */
+    uri: Uri;
+    /**
+     * The diagnostics for the model.
+     */
+    diagnostics: editor.IMarkerData[];
+}
+export interface ISqlExprDiagnosticService {
+    onDiagnosticsChange: IEvent<ISqlExprDiagnosticEvent>;
+}
+declare class SqlExprDiagnosticService implements ISqlExprDiagnosticService {
+    private _onDiagnosticsChange;
+    /**
+     * An event to signal changes to the diagnostics.
+     * The event value is the uri string and the diagnostics.
+     */
+    get onDiagnosticsChange(): IEvent<ISqlExprDiagnosticEvent>;
+    /**
+     * Fires the diagnostics change event.
+     * @param uri The uri of the model for which the diagnostics changed.
+     * @param diagnostics The diagnostics for the model.
+     */
+    fireDiagnosticsChange(uri: Uri, diagnostics: editor.IMarkerData[]): void;
+}
+export type { SqlExprDiagnosticService };
+/**
+ *
+ * @returns The Sql Expression Diagnostic Service.
+ */
+export declare function getSqlExprDiagnosticService(): ISqlExprDiagnosticService;
 export declare function setupMode(defaults: SqlExprDefaults): void;

package/dist/types/utils/sql-expr-monaco/sql-expr-parser-utils.d.ts

@@ -0,0 +1,30 @@
+import { ChildBearingProperties } from "./sql-expr-constants";
+export declare function isSqlSyntaxError(err: unknown): err is __esri.SQLSyntaxError;
+export declare function isUnexpectedTokenError(error: __esri.SQLSyntaxError): boolean;
+export declare function getExpectedTokens(error: __esri.SQLSyntaxError): string[] | undefined;
+export declare function formatSyntaxError(error: __esri.SQLSyntaxError): string;
+type ExpectedLiteral = {
+    category: "functions" | "keywords" | "operators";
+    text: string;
+};
+/**
+ * parses the error from the parser and returns the expected literals, used to provide suggestions.
+ * it will only return literals that do not contain special characters or numbers.
+ */
+export declare function getExpectedLiterals(error: __esri.SQLSyntaxError): ExpectedLiteral[];
+export declare const callerIndexAt = -2;
+/**
+ * returns the slot position of the node in the context root
+ * @param node the node we want to find the slot position for
+ * @param contextRoot the context root of the node, see {@link identifyContextRoot}
+ */
+export declare function getSlotPosition(node: __esri.SQLNode, contextRoot: __esri.SQLNode): ChildBearingProperties | number;
+/**
+ * Identifies the context root of the searchNode in the searchTree. The context root is the first "non-terminal" node within the node's parent context (searchTree).
+ * see {@link terminalTypes} for the list of terminal types.
+ * @param searchNode the node we want to find the context root for
+ * @param searchTree all the nodes contained in the searchNode's parent context
+ * @returns The context root of the searchNode
+ */
+export declare function identifyContextRoot(searchNode: __esri.SQLNode, searchTree: __esri.SQLNode[]): __esri.SQLNode;
+export {};

package/dist/types/utils/sql-expr-monaco/sql-expr-service-accessors.d.ts

@@ -0,0 +1,19 @@
+import type * as sqlExprModeModule from "./sql-expr-mode";
+import type { ISqlExprWorker } from "./types";
+import type { Uri } from "monaco-editor";
+type SqlExprModeType = typeof sqlExprModeModule;
+/**
+ * Returns the sql-expression worker for the model.
+ * Example:
+ * ```ts
+ * const sqlExpressionWorker = await getSqlExpressionWorker(model.uri);
+ * ```
+ * @returns sql-expression worker
+ */
+export declare function getSqlExprWorker(uri: Uri): Promise<ISqlExprWorker>;
+/**
+ * Request the sql-expression mode
+ * @returns sql-expression mode module
+ */
+export declare function getMode(): Promise<SqlExprModeType>;
+export {};

package/dist/types/utils/sql-expr-monaco/sql-expr-validation-diagnostic-adapter.d.ts

@@ -1,10 +1,3 @@
-import * as monaco from "monaco-editor";
-export declare const MarkerType: {
-    Hint: monaco.MarkerSeverity;
-    Info: monaco.MarkerSeverity;
-    Warning: monaco.MarkerSeverity;
-    Error: monaco.MarkerSeverity;
-};
 export declare enum ValidationDiagnosticCodes {
     ExpectedDateTimeValue = "ExpectedDateTimeValue",
     ExpectedNumericalLiteral = "ExpectedNumericalLiteral",