@arcgis/arcade-languageservice 4.28.0-beta.11 → 4.28.0-beta.12

package/dist/esm/index.d.ts

@@ -1,11 +1,152 @@
-import { ProfileId, BundleType, SdkVariableType, SdkConstant, SdkFunction, SdkCategory } from '@arcgis/arcade-sdk';
-export { SdkConstant as ApiConstant, SdkFunction as ApiFunction, SdkVariableType as ApiVariableType, BundleType, ProfileId, SdkPredefinedProfile } from '@arcgis/arcade-sdk';
 import { CompletionItem, Range, DiagnosticSeverity, Position, CompletionList, TextEdit } from 'vscode-languageserver-types';
 export { DiagnosticSeverity } from 'vscode-languageserver-types';
-import * as Parser from '@arcgis/arcade-parser';
-import { Keywords, Literals } from '@arcgis/arcade-parser';
 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" | "dateOnly" | "time" | "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
  */
@@ -150,6 +291,57 @@ declare function isValueVariable(variable: ApiVariable | null | undefined): vari
  */
 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,
@@ -159,7 +351,7 @@ type DiagnosticData = Record<string, number | string>;
 /**
  * The combined diagnostic codes
  */
-type DiagnosticCodes = Parser.DiagnosticCodes | ValidationDiagnosticCodes;
+type DiagnosticCodes = DiagnosticCodes$1 | ValidationDiagnosticCodes;
 /**
  * Represents a diagnostic, such as a parsing error or warning.
  */
@@ -211,7 +403,7 @@ declare enum ValidationDiagnosticCodes {
     UnknownPropertyIdentifier = "UnknownPropertyIdentifier"
 }
 declare const DiagnosticMessages: {
-    [key in ValidationDiagnosticCodes & Parser.DiagnosticCodes]: string;
+    [key in ValidationDiagnosticCodes & DiagnosticCodes$1]: string;
 };
 
 /**
@@ -283,4 +475,4 @@ type ProfileStrings = {
     domainvaluesbysubtypes: string;
 };
 
-export { ApiCategory, ApiContext, ApiDictionaryVariable, ApiItem, ApiProfile, ApiSnippet, ApiValueVariable, ApiValueVariableType, ApiVariable, ArcadeKeywords, ArcadeLanguageService, ArcadeLanguageServiceSettings, ArcadeLiterals, ArcadeReservedKeywords, Diagnostic, DiagnosticCodes, DiagnosticData, DiagnosticMessages, FormattingOptions, ProfileStrings, ValidationDiagnosticCodes, isDictionaryVariable, isValueVariable };
+export { ApiCategory, SdkConstant as ApiConstant, ApiContext, ApiDictionaryVariable, SdkFunction as ApiFunction, ApiItem, ApiProfile, ApiSnippet, ApiValueVariable, ApiValueVariableType, ApiVariable, SdkVariableType as ApiVariableType, ArcadeKeywords, ArcadeLanguageService, ArcadeLanguageServiceSettings, ArcadeLiterals, ArcadeReservedKeywords, BundleType, Diagnostic, DiagnosticCodes, DiagnosticData, DiagnosticMessages, FormattingOptions, ProfileId, ProfileStrings, SdkPredefinedProfile, ValidationDiagnosticCodes, isDictionaryVariable, isValueVariable };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@arcgis/arcade-languageservice",
   "description": "Arcade Language Service",
-  "version": "4.28.0-beta.11",
+  "version": "4.28.0-beta.12",
   "type": "module",
   "module": "dist/esm/index.js",
   "main": "dist/esm/index.js",
@@ -33,7 +33,7 @@
     "@arcgis/arcade-parser": "1.20.5",
     "@arcgis/arcade-sdk": "1.24.0-next.5",
     "@arcgis/arcade-tests": "^1.20.0",
-    "@arcgis/components-plugins": "4.28.0-beta.11",
+    "@arcgis/components-plugins": "4.28.0-beta.12",
     "@arcgis/eslint-config": "1.0.0",
     "@arcgis/typescript-config": "1.0.0",
     "@types/fs-extra": "^11.0.1",
@@ -53,5 +53,5 @@
     "tsup": "^7.2.0",
     "typescript": "4.9.5"
   },
-  "gitHead": "4a899ae3940bdcf125ca40ea41a73d9ae0b159a6"
+  "gitHead": "0fc81414d18e1e8b9e1feb27b355c429e5f79024"
 }