@arcgis/arcade-languageservice 1.22.0-next.10

package/dist/assets/t9n/profile.t9n.vi.json

@@ -0,0 +1,33 @@
+{
+  "layer": "Đ_Layer___________ớ",
+  "featureservice": "Đ_Feature service________________ớ",
+  "mapservice": "Đ_Map service____________ớ",
+  "webmap": "Đ_Web Map_______________ớ",
+  "webmapformat": "Đ_Web map: {webMapTitle}_______________________ớ",
+  "item": "Đ_Item_________ớ",
+  "invoking": "Đ_Invoking_________________ớ",
+  "fields": "Đ_Field names____________ớ",
+  "values": "Đ_Values_____________ớ",
+  "relationships": "Đ_Related features_________________ớ",
+  "layers": "Đ_Layers_____________ớ",
+  "tables": "Đ_Tables_____________ớ",
+  "geometry": "Đ_Geometry_________________ớ",
+  "dictionary": "Đ_Dictionary_____________________ớ",
+  "feature": "Đ_Feature_______________ớ",
+  "featureset": "Đ_Feature set____________ớ",
+  "featuresetcollection": "Đ_Feature set collection_______________________ớ",
+  "oid": "Đ_Feature ID_____________________ớ",
+  "number": "Đ_Number_____________ớ",
+  "string": "Đ_String_____________ớ",
+  "date": "Đ_Date_________ớ",
+  "blob": "Đ_Binary_____________ớ",
+  "raster": "Đ_Raster_____________ớ",
+  "guid": "Đ_GUID_________ớ",
+  "global-id": "Đ_Global ID___________________ớ",
+  "xml": "Đ_XML_______ớ",
+  "function": "Đ_Function_________________ớ",
+  "domainvalues": "Đ_Domain values______________ớ",
+  "subtypes": "Đ_Subtypes_________________ớ",
+  "domainvaluesfortypeformat": "Đ_{fieldName} - Domain values for type '{typeName}'__________________________ớ",
+  "domainvaluesbysubtypes": "Đ_Domain values by subtypes__________________________ớ"
+}

package/dist/assets/t9n/profile.t9n.zh-CN.json

@@ -0,0 +1,33 @@
+{
+  "layer": "试_Layer___________验",
+  "featureservice": "试_Feature service________________验",
+  "mapservice": "试_Map service____________验",
+  "webmap": "试_Web Map_______________验",
+  "webmapformat": "试_Web map: {webMapTitle}_______________________验",
+  "item": "试_Item_________验",
+  "invoking": "试_Invoking_________________验",
+  "fields": "试_Field names____________验",
+  "values": "试_Values_____________验",
+  "relationships": "试_Related features_________________验",
+  "layers": "试_Layers_____________验",
+  "tables": "试_Tables_____________验",
+  "geometry": "试_Geometry_________________验",
+  "dictionary": "试_Dictionary_____________________验",
+  "feature": "试_Feature_______________验",
+  "featureset": "试_Feature set____________验",
+  "featuresetcollection": "试_Feature set collection_______________________验",
+  "oid": "试_Feature ID_____________________验",
+  "number": "试_Number_____________验",
+  "string": "试_String_____________验",
+  "date": "试_Date_________验",
+  "blob": "试_Binary_____________验",
+  "raster": "试_Raster_____________验",
+  "guid": "试_GUID_________验",
+  "global-id": "试_Global ID___________________验",
+  "xml": "试_XML_______验",
+  "function": "试_Function_________________验",
+  "domainvalues": "试_Domain values______________验",
+  "subtypes": "试_Subtypes_________________验",
+  "domainvaluesfortypeformat": "试_{fieldName} - Domain values for type '{typeName}'__________________________验",
+  "domainvaluesbysubtypes": "试_Domain values by subtypes__________________________验"
+}

package/dist/assets/t9n/profile.t9n.zh-HK.json

@@ -0,0 +1,33 @@
+{
+  "layer": "試_Layer___________驗",
+  "featureservice": "試_Feature service________________驗",
+  "mapservice": "試_Map service____________驗",
+  "webmap": "試_Web Map_______________驗",
+  "webmapformat": "試_Web map: {webMapTitle}_______________________驗",
+  "item": "試_Item_________驗",
+  "invoking": "試_Invoking_________________驗",
+  "fields": "試_Field names____________驗",
+  "values": "試_Values_____________驗",
+  "relationships": "試_Related features_________________驗",
+  "layers": "試_Layers_____________驗",
+  "tables": "試_Tables_____________驗",
+  "geometry": "試_Geometry_________________驗",
+  "dictionary": "試_Dictionary_____________________驗",
+  "feature": "試_Feature_______________驗",
+  "featureset": "試_Feature set____________驗",
+  "featuresetcollection": "試_Feature set collection_______________________驗",
+  "oid": "試_Feature ID_____________________驗",
+  "number": "試_Number_____________驗",
+  "string": "試_String_____________驗",
+  "date": "試_Date_________驗",
+  "blob": "試_Binary_____________驗",
+  "raster": "試_Raster_____________驗",
+  "guid": "試_GUID_________驗",
+  "global-id": "試_Global ID___________________驗",
+  "xml": "試_XML_______驗",
+  "function": "試_Function_________________驗",
+  "domainvalues": "試_Domain values______________驗",
+  "subtypes": "試_Subtypes_________________驗",
+  "domainvaluesfortypeformat": "試_{fieldName} - Domain values for type '{typeName}'__________________________驗",
+  "domainvaluesbysubtypes": "試_Domain values by subtypes__________________________驗"
+}

package/dist/assets/t9n/profile.t9n.zh-TW.json

@@ -0,0 +1,33 @@
+{
+  "layer": "試_Layer___________驗",
+  "featureservice": "試_Feature service________________驗",
+  "mapservice": "試_Map service____________驗",
+  "webmap": "試_Web Map_______________驗",
+  "webmapformat": "試_Web map: {webMapTitle}_______________________驗",
+  "item": "試_Item_________驗",
+  "invoking": "試_Invoking_________________驗",
+  "fields": "試_Field names____________驗",
+  "values": "試_Values_____________驗",
+  "relationships": "試_Related features_________________驗",
+  "layers": "試_Layers_____________驗",
+  "tables": "試_Tables_____________驗",
+  "geometry": "試_Geometry_________________驗",
+  "dictionary": "試_Dictionary_____________________驗",
+  "feature": "試_Feature_______________驗",
+  "featureset": "試_Feature set____________驗",
+  "featuresetcollection": "試_Feature set collection_______________________驗",
+  "oid": "試_Feature ID_____________________驗",
+  "number": "試_Number_____________驗",
+  "string": "試_String_____________驗",
+  "date": "試_Date_________驗",
+  "blob": "試_Binary_____________驗",
+  "raster": "試_Raster_____________驗",
+  "guid": "試_GUID_________驗",
+  "global-id": "試_Global ID___________________驗",
+  "xml": "試_XML_______驗",
+  "function": "試_Function_________________驗",
+  "domainvalues": "試_Domain values______________驗",
+  "subtypes": "試_Subtypes_________________驗",
+  "domainvaluesfortypeformat": "試_{fieldName} - Domain values for type '{typeName}'__________________________驗",
+  "domainvaluesbysubtypes": "試_Domain values by subtypes__________________________驗"
+}

package/dist/esm/index.d.ts

@@ -0,0 +1,478 @@
+import { CompletionItem, Range, DiagnosticSeverity, Position, CompletionList, TextEdit } from 'vscode-languageserver-types';
+export { DiagnosticSeverity } from 'vscode-languageserver-types';
+import { TextDocument } from 'vscode-languageserver-textdocument';
+
+/**
+ * Supported function bundles
+ */
+type BundleType = "core" | "data-access" | "database" | "geometry" | "portal-access" | "track";
+
+/**
+ * The list of supported profiles
+ */
+type ProfileId = "minimalist" | "alias" | "attribute-rule-calculation" | "attribute-rule-constraint" | "attribute-rule-validation" | "dashboard-indicator-formatting" | "dashboard-list-formatting" | "dashboard-table-formatting" | "dashboard-data" | "dictionary-renderer" | "feature-z" | "field-calculation" | "field-mapping" | "form-calculation" | "form-constraint" | "geoanalytics" | "geotrigger-notification" | "labeling" | "layout" | "location-update-constraint" | "measure-visualization" | "popup" | "popup-element" | "popup-feature-reduction" | "popup-element-feature-reduction" | "quick-capture" | "tasks" | "velocity" | "visualization";
+/**
+ * Describes a profile
+ */
+interface SdkPredefinedProfile {
+    /**
+     * Profile name for UI
+     */
+    name: string;
+    /**
+     * Profile id for docs
+     */
+    id: ProfileId;
+    /**
+     * Function bundles enabled for this profile
+     */
+    bundles: BundleType[];
+    /**
+     * Variable describing name, type, and providing description
+     */
+    variables: SdkVariable[];
+}
+/**
+ * Supported profile variable types
+ */
+type SdkVariableType = "number" | "text" | "date" | "boolean" | "dictionary" | "array" | "geometry" | "feature" | "featureSet" | "featureSetCollection";
+/**
+ * Describes variables
+ */
+interface SdkVariableBase {
+    /**
+     * Name of the variable.
+     */
+    name: string;
+    /**
+     * Type of the variable.
+     */
+    type: SdkVariableType;
+    /**
+     * Description of the variable.
+     */
+    description?: string;
+}
+/**
+ * A variable that represents a simple type (boolean, number, feature, etc.)
+ */
+interface SdkValueVariable extends SdkVariableBase {
+    type: Exclude<SdkVariableType, "dictionary">;
+}
+/**
+ * A dictionary variable
+ */
+interface SdkDictionaryVariable extends SdkVariableBase {
+    type: "dictionary";
+    properties: SdkVariable[];
+}
+/**
+ * Profile variable
+ */
+type SdkVariable = SdkValueVariable | SdkDictionaryVariable;
+
+/**
+ * Represents an api category and its items
+ */
+interface SdkCategory {
+    /**
+     * The unique ID for the category
+     */
+    id: string;
+    /**
+     * The title for the category
+     */
+    title: string;
+    /**
+     * The collection of api items for the category
+     */
+    items: SdkItem[];
+}
+interface SdkItemBase {
+    /**
+     * The name of the function or constant.
+     */
+    name: string;
+    /**
+     * The version string when the api item was introduced. If undefined then it was from the origin.
+     */
+    sinceVersion?: string;
+    /**
+     * The api bundle this item belongs to.
+     */
+    bundle: BundleType;
+    /**
+     * Markdown description of the item.
+     */
+    description: string;
+    /**
+     * Markdown containing examples.
+     */
+    examples: string;
+    /**
+     * Link for additional information about the item.
+     */
+    link: string;
+    /**
+     * Completion item directly leveraged by the editor.
+     */
+    completion: CompletionItem;
+    /**
+     * Indicates if the documentation for this item should be disabled.
+     */
+    disableDocumentation?: boolean;
+}
+/**
+ * Represents a constant in the arcade api.
+ */
+interface SdkConstant extends SdkItemBase {
+    type: "constant";
+}
+/**
+ * Represents a function in the arcade api
+ */
+interface SdkFunction extends SdkItemBase {
+    type: "function";
+    /**
+     * Information leveraged by the editor to validate function call.
+     * Indicates the minimum number of expected parameters and the maximum number of parameters expected.
+     */
+    parametersInfo: {
+        min: number;
+        max: number;
+    };
+}
+/**
+ * Represents an item in the arcade api.
+ */
+type SdkItem = SdkConstant | SdkFunction | SdkFunction[];
+
+/**
+ * Describes the formatting options
+ */
+interface FormattingOptions {
+    /**
+     * Number of spaces the formatter should use for indentation.
+     * If you do not pass this option explicitly, it will be
+     * (quite reliably!) inferred from the original code.
+     * @default 2
+     */
+    indentWidth?: number;
+    /**
+     * Some of the formatter code (such as that for printing function
+     * parameter lists) makes a valiant attempt to prevent really long
+     * lines. You can adjust the limit by changing this option; however,
+     * there is no guarantee that line length will fit inside this limit.
+     * @default 80
+     */
+    wrapColumn?: number;
+    /**
+     * If you want to override the quotes used in string literals, specify
+     * either "single", "double", or "auto" here ("auto" will select the one
+     * which results in the shorter literal) Otherwise, use double quotes.
+     * @default null
+     */
+    quote?: "single" | "double" | "auto" | null;
+}
+
+/**
+ * The editor can be extended with custom snippets
+ */
+interface ApiSnippet {
+    /**
+     * The label for the snippet. The editor will use it to offer the snippet based on the text typed in the editor.
+     * It's recommended to keep it short and as close as possible to what the user may be looking for.
+     * For example: 'polyline'
+     */
+    label: string;
+    /**
+     * A slightly longer description of what the snippet offers.
+     */
+    detail: string;
+    /**
+     * A string that should be inserted into the script when selecting
+     * this snippet.
+     *
+     * The `insertText` is subject to interpretation by the editor.
+     * Use this rules: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#snippet_syntax
+     */
+    insertText: string;
+}
+/**
+ * Language service api options
+ */
+interface ApiContext {
+    /**
+     * The profile (variables, additional api items, bundles, etc.)
+     */
+    profile?: ApiProfile;
+    /**
+     * The locale for the Api
+     */
+    locale?: string;
+    /**
+     * Options to control how the script should be formatted
+     */
+    formattingOptions?: FormattingOptions;
+    /**
+     * Allows to augment the arcade snippets with a collection of snippets
+     */
+    snippets?: ApiSnippet[];
+}
+/**
+ * Language service profile
+ */
+interface ApiProfile {
+    /**
+     * The wellknown profile id if applicable
+     */
+    id?: ProfileId;
+    /**
+     * The set of profile variables
+     */
+    variables: ApiVariable[];
+    /**
+     * The api version to use
+     */
+    apiVersion?: string;
+    /**
+     * The api bundles to use
+     */
+    bundles?: BundleType[];
+    /**
+     * A collection of api item names to hide.
+     */
+    hiddenApiItems?: Array<string>;
+}
+/**
+ * The type for value variable.
+ */
+type ApiValueVariableType = Exclude<SdkVariableType, "dictionary">;
+interface ApiVariableBase {
+    /**
+     * Name of the variable
+     */
+    name: string;
+    /**
+     * Optional short description for the variable
+     */
+    description?: string;
+    /**
+     * Completion item for the variable, leveraged bu the editor
+     */
+    completion?: CompletionItem;
+}
+/**
+ * Describes a dictionary type (feature, dictionary)
+ */
+interface ApiDictionaryVariable extends ApiVariableBase {
+    type: "dictionary";
+    /**
+     * Dictionary properties
+     */
+    properties: ApiVariable[];
+}
+/**
+ * Describes a simple variable type (number, featureSet, etc.)
+ */
+interface ApiValueVariable extends ApiVariableBase {
+    type: ApiValueVariableType;
+}
+/**
+ * The profile variable type
+ */
+type ApiVariable = ApiDictionaryVariable | ApiValueVariable;
+/**
+ * Helper function to test if a variable is a value variable
+ */
+declare function isValueVariable(variable: ApiVariable | null | undefined): variable is ApiValueVariable;
+/**
+ * Helper function to test if a variable is a dictionary variable
+ */
+declare function isDictionaryVariable(variable: ApiVariable | null | undefined): variable is ApiDictionaryVariable;
+
+declare enum Literals {
+    False = "false",
+    Null = "null",
+    True = "true"
+}
+declare enum Keywords {
+    Break = "break",
+    Continue = "continue",
+    Else = "else",
+    For = "for",
+    From = "from",
+    Function = "function",
+    If = "if",
+    Import = "import",
+    Export = "export",
+    In = "in",
+    Return = "return",
+    Var = "var",
+    While = "while"
+}
+declare enum DiagnosticCodes$1 {
+    InvalidModuleUri = "InvalidModuleUri",
+    ForInOfLoopInitializer = "ForInOfLoopInitializer",
+    IdentiferExpected = "IdentiferExpected",
+    InvalidEscapedReservedWord = "InvalidEscapedReservedWord",
+    InvalidExpression = "InvalidExpression",
+    InvalidFunctionIdentifier = "InvalidFunctionIdentifier",
+    InvalidHexEscapeSequence = "InvalidHexEscapeSequence",
+    InvalidLeftHandSideInAssignment = "InvalidLeftHandSideInAssignment",
+    InvalidLeftHandSideInForIn = "InvalidLeftHandSideInForIn",
+    InvalidTemplateHead = "InvalidTemplateHead",
+    InvalidVariableAssignment = "InvalidVariableAssignment",
+    KeyMustBeString = "KeyMustBeString",
+    NoFunctionInsideBlock = "NoFunctionInsideBlock",
+    NoFunctionInsideFunction = "NoFunctionInsideFunction",
+    ModuleExportRootOnly = "ModuleExportRootOnly",
+    ModuleImportRootOnly = "ModuleImportRootOnly",
+    PunctuatorExpected = "PunctuatorExpected",
+    TemplateOctalLiteral = "TemplateOctalLiteral",
+    UnexpectedBoolean = "UnexpectedBoolean",
+    UnexpectedEndOfScript = "UnexpectedEndOfScript",
+    UnexpectedIdentifier = "UnexpectedIdentifier",
+    UnexpectedKeyword = "UnexpectedKeyword",
+    UnexpectedNull = "UnexpectedNull",
+    UnexpectedNumber = "UnexpectedNumber",
+    UnexpectedPunctuator = "UnexpectedPunctuator",
+    UnexpectedString = "UnexpectedString",
+    UnexpectedTemplate = "UnexpectedTemplate",
+    UnexpectedToken = "UnexpectedToken"
+}
+
+/**
+ * Represents the data associated with a diagnostic.
+ * For example in case of an error associated to an identifier,
+ * the DiagnosticData will contain a key 'identifier' and its value.
+ */
+type DiagnosticData = Record<string, number | string>;
+/**
+ * The combined diagnostic codes
+ */
+type DiagnosticCodes = DiagnosticCodes$1 | ValidationDiagnosticCodes;
+/**
+ * Represents a diagnostic, such as a parsing error or warning.
+ */
+interface Diagnostic {
+    /**
+     * The range at which the message applies
+     */
+    range: Range;
+    /**
+     * The diagnostic's severity. Can be omitted. If omitted it is up to the
+     * client to interpret diagnostics as error, warning, info or hint.
+     */
+    severity?: DiagnosticSeverity;
+    /**
+     * The diagnostic's code.
+     */
+    code: DiagnosticCodes;
+    /**
+     * The diagnostic's message. It usually appears in the user interface
+     */
+    message: string;
+    /**
+     * A data entry field that is preserved between a `textDocument/publishDiagnostics`
+     * notification and `textDocument/codeAction` request.
+     */
+    data?: DiagnosticData | null;
+}
+declare enum ValidationDiagnosticCodes {
+    AlreadyDefined = "AlreadyDefined",
+    ApiConflict = "ApiConflict",
+    AssignedNeverUsed = "AssignedNeverUsed",
+    DefinedNeverAssigned = "DefinedNeverAssigned",
+    DefinedNeverUsed = "DefinedNeverUsed",
+    EmptyBlockStatement = "EmptyBlockStatement",
+    ExecutionError = "ExecutionError",
+    InvalidApiFunctionUsage = "InvalidApiFunctionUsage",
+    InvalidConstantIdentifier = "InvalidConstantIdentifier",
+    InvalidPropertyIdentifier = "InvalidPropertyIdentifier",
+    NoArgumentExpected = "NoArgumentExpected",
+    NotADictionary = "NotADictionary",
+    NotDefined = "NotDefined",
+    NotEnoughArguments = "NotEnoughArguments",
+    ProfileVariablesAreImmutable = "ProfileVariablesAreImmutable",
+    ProfileVariablesConflict = "ProfileVariablesConflict",
+    ReservedKeyword = "ReservedKeyword",
+    TooManyArguments = "TooManyArguments",
+    UnexpectedEmptyFunction = "UnexpectedEmptyFunction",
+    UnexpectedPropertyIdentifier = "UnexpectedPropertyIdentifier",
+    UnknownPropertyIdentifier = "UnknownPropertyIdentifier"
+}
+declare const DiagnosticMessages: {
+    [key in ValidationDiagnosticCodes & DiagnosticCodes$1]: string;
+};
+
+/**
+ * Represent items stored in the library
+ */
+type ApiItem = SdkConstant | SdkFunction;
+/**
+ * Represent a category of api items in the api library
+ */
+interface ApiCategory extends SdkCategory {
+    items: ApiItem[];
+}
+
+declare const ArcadeKeywords: Keywords[];
+declare const ArcadeLiterals: Literals[];
+declare const ArcadeReservedKeywords: string[];
+
+/**
+ * Language service settings
+ */
+interface ArcadeLanguageServiceSettings {
+    /**
+     * The path to the assets folder where the arcade api files are stored
+     */
+    assetsPath?: string;
+}
+
+declare class ArcadeLanguageService {
+    private languageOptions;
+    private apiService;
+    configure(languageOptions?: ArcadeLanguageServiceSettings): void;
+    doValidation(document: TextDocument, context: ApiContext): Promise<Diagnostic[]>;
+    doComplete(document: TextDocument, position: Position, context: ApiContext): Promise<CompletionList>;
+    doFormat(document: TextDocument, context: ApiContext): TextEdit[];
+    getApiLibrary(context: ApiContext): Promise<ApiCategory[]>;
+}
+
+type ProfileStrings = {
+    layer: string;
+    featureservice: string;
+    mapservice: string;
+    webmap: string;
+    webmapformat: string;
+    item: string;
+    invoking: string;
+    fields: string;
+    values: string;
+    relationships: string;
+    layers: string;
+    tables: string;
+    geometry: string;
+    dictionary: string;
+    feature: string;
+    featureset: string;
+    featuresetcollection: string;
+    oid: string;
+    number: string;
+    string: string;
+    date: string;
+    blob: string;
+    raster: string;
+    guid: string;
+    "global-id": string;
+    xml: string;
+    function: string;
+    domainvalues: string;
+    subtypes: string;
+    domainvaluesfortypeformat: string;
+    domainvaluesbysubtypes: string;
+};
+
+export { type ApiCategory, type SdkConstant as ApiConstant, type ApiContext, type ApiDictionaryVariable, type SdkFunction as ApiFunction, type ApiItem, type ApiProfile, type ApiSnippet, type ApiValueVariable, type ApiValueVariableType, type ApiVariable, type SdkVariableType as ApiVariableType, ArcadeKeywords, ArcadeLanguageService, type ArcadeLanguageServiceSettings, ArcadeLiterals, ArcadeReservedKeywords, type BundleType, type Diagnostic, type DiagnosticCodes, type DiagnosticData, DiagnosticMessages, type FormattingOptions, type ProfileId, type ProfileStrings, type SdkPredefinedProfile, ValidationDiagnosticCodes, isDictionaryVariable, isValueVariable };