@arcgis/coding-components 4.31.0-next.2 → 4.31.0-next.3

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

@@ -0,0 +1,540 @@
+import type { IRange, Position, editor, languages } from "monaco-editor";
+import { standardizedFunctions } from "./DependentFiles/standardizedFunctions";
+import type { SqlExprDefaults } from "./sql-expr-defaults";
+export declare class SqlExprCompletionProvider implements languages.CompletionItemProvider {
+    private _defaults;
+    constructor(_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 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-language-syntax.d.ts

@@ -0,0 +1,8 @@
+import * as monaco from "monaco-editor";
+/**
+ * This file is mostly ported from https://github.com/microsoft/monaco-editor/blob/main/src/basic-languages/sql/sql.ts
+ */
+import IMonarchLanguage = monaco.languages.IMonarchLanguage;
+import LanguageConfiguration = monaco.languages.LanguageConfiguration;
+export declare const sqlExprLanguageConfig: LanguageConfiguration;
+export declare const sqlExprLanguageSyntax: IMonarchLanguage;

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

@@ -0,0 +1,10 @@
+import type { Uri } from "monaco-editor";
+import type { ISqlExprWorker } from "./types";
+import { type SqlExprDefaults } from "./sql-expr-defaults";
+/**
+ * Returns the sql-expression worker for the model uris.
+ * @param uris The model uris for which to get the worker.
+ * @returns The sql-expression worker.
+ */
+export declare function getSqlExprWorker(...uris: Uri[]): Promise<ISqlExprWorker>;
+export declare function setupMode(defaults: SqlExprDefaults): void;

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

@@ -0,0 +1,3 @@
+import { editor } from "monaco-editor";
+import type { SqlExprDefaults } from "./sql-expr-defaults";
+export default function sqlExprValidation(model: editor.ITextModel | null, defaults: SqlExprDefaults): Promise<void>;

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

@@ -0,0 +1,41 @@
+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",
+    ExpectedToken = "ExpectedToken",
+    FunctionNotSupported = "FunctionNotSupported",
+    IncompatibleListDataType = "IncompatibleListDataType",
+    IncorrectArgumentLength = "IncorrectArgumentLength",
+    IncorrectCastParameters = "IncorrectCastParameters",
+    IncorrectExtractParameters = "IncorrectExtractParameters",
+    IncorrectSubstringParameters = "IncorrectSubstringParameters",
+    IncorrectTrimParameters = "IncorrectTrimParameters",
+    InvalidElseClause = "InvalidElseClause",
+    InvalidThenClause = "InvalidThenClause",
+    InvalidEndOnWhen = "InvalidEndOnWhen",
+    InvalidTrimCharacter = "InvalidTrimCharacter",
+    MismatchedTypes = "MismatchedTypes",
+    MissingValueInCaseClause = "MissingValueInCaseClause",
+    NotCallable = "NotCallable",
+    TypeNotAssignable = "TypeNotAssignable",
+    UnexpectedEnd = "UnexpectedEnd.",
+    UnexpectedIdentifier = "UnexpectedIdentifier",
+    UnexpectedNumber = "UnexpectedNumber",
+    UnexpectedTextLiteral = "UnexpectedTextLiteral",
+    UnexpectedToken = "UnexpectedToken",
+    UnknownField = "UnknownField",
+    UnsupportedOperator = "UnsupportedOperator",
+    UnsupportedSyntax = "UnsupportedSyntax",
+    InvalidIntervalQualifier = "InvalidIntervalQualifier",
+    EmptyCaseExpression = "EmptyCaseExpression"
+}
+export declare const DiagnosticMessages: {
+    [key in ValidationDiagnosticCodes]: string;
+};
+export declare const getDiagnosticMessage: (diagnosticCode: ValidationDiagnosticCodes, replacements?: Record<string, number | string>) => string;

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

@@ -0,0 +1,99 @@
+import * as monaco from "monaco-editor";
+import type { SQLNode } from "./DependentFiles/WhereGrammar";
+import type { ArcGISFieldType, PeggyError, SqlExpressionLiteral, PeggyLocation } from "./types";
+export interface ValidationSyntaxContext {
+    token: string;
+    range: monaco.IRange;
+    startDelimiter?: boolean;
+    content?: ValidationSyntaxContext[];
+}
+export declare enum TokenType {
+    Single = "SINGLE",
+    EmptyField = "EMPTY_FIELD",
+    Error = "ERROR",
+    Field = "FIELD",
+    KeywordIn = "IN",
+    KeywordNotIn = "NOT IN",
+    KeywordBetween = "BETWEEN",
+    KeywordNotBetween = "NOT BETWEEN",
+    List = "LIST",
+    Negation = "NOT",
+    Number = "NUMBER",
+    Operator = "OPERATOR",
+    Parentheses = "PARENTHESES",
+    String = "STRING",
+    Unknown = "UNKNOWN"
+}
+export declare enum Token {
+    Case = "CASE",
+    CaseElse = "ELSE",
+    CaseThen = "THEN",
+    CaseWhen = "WHEN",
+    Comma = ",",
+    DoubleQuote = "\"",
+    Empty = "",
+    End = "END",
+    Interval = "INTERVAL",
+    LeftParentheses = "(",
+    NewLine = "\n",
+    RightParentheses = ")",
+    SingleQuote = "'",
+    WhiteSpace = " "
+}
+export declare enum BinaryOperator {
+    And = "AND",
+    Or = "OR",
+    Is = "IS",
+    IsNot = "ISNOT",
+    In = "IN",
+    NotIn = "NOT IN",
+    Between = "BETWEEN",
+    NotBetween = "NOTBETWEEN",
+    Like = "LIKE",
+    NotLike = "NOT LIKE",
+    NotEquals = "<>",
+    LessThan = "<",
+    GreaterThan = ">",
+    GreaterThanEqual = ">=",
+    LessThanEqual = "<=",
+    Equal = "=",
+    Multiply = "*",
+    Subtract = "-",
+    Add = "+",
+    Divide = "/",
+    Concatenate = "||"
+}
+export declare enum NodeReturnType {
+    Boolean = "BOOLEAN",
+    Double = "DOUBLE",
+    ExpressionList = "EXPRESSION-LIST",
+    Float = "FLOAT",
+    Integer = "INTEGER",
+    Null = "NULL",
+    Number = "NUMBER",
+    Real = "REAL",
+    String = "STRING",
+    SmallInt = "SMALLINT",
+    UnknownFunction = "UNKNOWN_FUNCTION"
+}
+export declare enum CallableExpressionResponse {
+    Function = "FUNCTION",
+    ExpressionList = "EXPRESSION_LIST",
+    Success = "SUCCESS",
+    NonCallable = "NON_CALLABLE"
+}
+export declare const tokenizationRegex: RegExp;
+export declare const isValidIntervalValue: RegExp;
+export declare const validOps: string[];
+export declare const relationalTypes: SqlExpressionLiteral[];
+export declare const qualifiers: TokenType[];
+export declare function convertArcgisTypeToSqlReturnType(arcgisType: ArcGISFieldType): SqlExpressionLiteral;
+export declare const identifyNodeReturnType: (node: SQLNode, fields: __esri.FeatureLayer["fields"]) => SqlExpressionLiteral | "time-only" | "unknown_function";
+export declare const isNumericType: (type: SqlExpressionLiteral) => boolean;
+export declare const formatListToString: (types: SqlExpressionLiteral[], delimiter: string) => string;
+export declare const formatType: (type: string) => string;
+export declare const getValueFromNode: (node: SQLNode) => number | string;
+export declare const addNewMarker: (message: string, range: monaco.IRange | PeggyLocation, markers: monaco.editor.IMarkerData[], isNodeFormat?: boolean) => void;
+export declare const validateTypeMatch: (node: SQLNode, expectedType: NodeReturnType, markers: monaco.editor.IMarkerData[], fields: __esri.FeatureLayer["fields"]) => void;
+export declare function isSyntaxError(error: PeggyError): boolean;
+export declare function formatSyntaxError(error: PeggyError): string;