@arcgis/languages-api-utils 4.31.0-next.15

package/LICENSE.md

@@ -0,0 +1,13 @@
+# Licensing
+
+COPYRIGHT © 2024 Esri
+
+All rights reserved under the copyright laws of the United States and applicable international laws, treaties, and conventions.
+
+This material is licensed for use under the Esri Master License Agreement (MLA), and is bound by the terms of that agreement. You may redistribute and use this code without modification, provided you adhere to the terms of the MLA and include this copyright notice.
+
+See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
+
+For additional information, contact: Environmental Systems Research Institute, Inc. Attn: Contracts and Legal Services Department 380 New York Street Redlands, California, USA 92373 USA
+
+email: contracts@esri.com

package/README.md

@@ -0,0 +1,22 @@
+# ArcGIS Maps SDK for JavaScript - Languages API Utils
+
+This package is part of the [ArcGIS Maps SDK for JavaScript](https://developers.arcgis.com/javascript/latest/).
+
+The package provides a set of classes and utilities to work with custom programming languages inside
+monaco-editor.
+
+It is not intended to be used directly, but rather used as a dependency by other packages in the SDK.
+
+## License
+
+COPYRIGHT © 2024 Esri
+
+All rights reserved under the copyright laws of the United States and applicable international laws, treaties, and conventions.
+
+This material is licensed for use under the Esri Master License Agreement (MLA), and is bound by the terms of that agreement. You may redistribute and use this code without modification, provided you adhere to the terms of the MLA and include this copyright notice.
+
+See use restrictions at <http://www.esri.com/legal/pdfs/mla_e204_e300/english>
+
+For additional information, contact: Environmental Systems Research Institute, Inc. Attn: Contracts and Legal Services Department 380 New York Street Redlands, California, USA 92373 USA
+
+email: contracts@esri.com

package/dist/cjs/index.cjs

@@ -0,0 +1,3 @@
+"use strict";var f=Object.defineProperty;var b=Object.getOwnPropertyDescriptor;var C=Object.getOwnPropertyNames;var x=Object.prototype.hasOwnProperty;var S=(e,t)=>{for(var i in t)f(e,i,{get:t[i],enumerable:!0})},k=(e,t,i,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let r of C(t))!x.call(e,r)&&r!==i&&f(e,r,{get:()=>t[r],enumerable:!(n=b(t,r))||n.enumerable});return e};var V=e=>k(f({},"__esModule",{value:!0}),e);var F={};S(F,{ApiService:()=>g,isDictionaryVariable:()=>I,isValueVariable:()=>P});module.exports=V(F);var s=require("vscode-languageserver-types");function D(e){return Array.isArray(e.testSdkCategories)}async function h(e,t){try{let i=await e,n=new Map,r=new Map,a=[],o=T(t);return i.forEach(c=>{let l=[];c.items.forEach(p=>v(l,r,n,o,p)),l.length&&a.push({...c,items:l})}),{categories:a,functionDefinitions:n,constantDefinitions:r}}catch{return{categories:[],functionDefinitions:new Map,constantDefinitions:new Map}}}var g=class{constructor(t){this._settings=t;this.sdkCategoriesCache=new Map}async getApiDatabase(t){let{locale:i="en"}=t,n=this.sdkCategoriesCache.get(i);if(!n){let{assetsPath:r}=this._settings;if(!r)return{categories:[],functionDefinitions:new Map,constantDefinitions:new Map};n=this.loadSdkApiLibrary(i,r),this.sdkCategoriesCache.set(i,n)}return await h(n,t)}async getApiLibrary(t){let{categories:i}=await this.getApiDatabase(t);return i}async loadSdkApiLibrary(t="en",i=""){if(D(this._settings))return this._settings.testSdkCategories;if(i=i.replace(/\/$/u,""),!i)return[];try{let n=this._settings.apiPathTemplate.replace("${assetsPath}",i).replace("${locale}",t),r=await fetch(n);return r.ok?await r.json():t==="en"?[]:await this.loadSdkApiLibrary("en",i)}catch{return[]}}};function T(e){let{profile:{apiVersion:t,bundles:i,hiddenApiItems:n=[]}={}}=e,r=y(t),a=Array.isArray(i)&&i.length>0?new Set(["core",...i]):void 0;return o=>M(r,o.sinceVersion)&&(!a||a.has(o.bundle))&&!n.includes(o.name)}function v(e,t,i,n,r){if(Array.isArray(r)){r.forEach(a=>A(e,i,n,a));return}r.type==="constant"?w(e,t,n,r):A(e,i,n,r)}function A(e,t,i,n){if(!i(n))return;n.disableDocumentation||e.push(n);let{completion:{label:r}}=n,a=r.toLowerCase(),o=t.get(a);o||(o={type:"functionDefinition",key:a,overloads:[]},t.set(a,o)),o.overloads.push(n)}function w(e,t,i,n){if(!i(n))return;e.push(n);let{completion:{label:r}}=n,a=r.toLowerCase();t.set(a,n);let[o,c]=n.completion.label.split(".");if(!c)return;let l=o.toLowerCase(),p=t.get(l);p||(p={type:"namespace",key:l,members:[],completion:{label:o,detail:o,insertText:o,insertTextMode:s.InsertTextMode.adjustIndentation,insertTextFormat:s.InsertTextFormat.PlainText,kind:s.CompletionItemKind.Enum}},t.set(l,p));let u=structuredClone(n);u.name=c,u.completion.label=c,u.completion.insertText=c,u.completion.kind=s.CompletionItemKind.Constant,p.members.push(u),p.completion.documentation=p.members.reduce((d,m)=>(d.value=`${d.value}${d.value?`
+
+`:""}**${m.completion.label}**: ${m.description}`,d),{kind:s.MarkupKind.Markdown,value:""})}function y(e){if(!e||typeof e!="string")return null;let t=e.split(".").map(r=>Number.parseInt(r));if(t.some(Number.isNaN))return console.error("Invalid API version string",e),null;let[i,n]=t.slice(0,2);return{major:i,minor:n}}function M(e,t){if(!e)return!0;let i=y(t);return i?e.major>i.major?!1:e.minor===void 0||i.minor===void 0?!0:i.minor<=e.minor:!0}function P(e){return!!e&&e.type!=="dictionary"}function I(e){return e?.type==="dictionary"}0&&(module.exports={ApiService,isDictionaryVariable,isValueVariable});

package/dist/cjs/index.d.cts

@@ -0,0 +1,325 @@
+import { CompletionItem } from 'vscode-languageserver-types';
+
+/**
+ * Supported function bundles
+ */
+type BundleType = "core" | "data-access" | "database" | "geometry" | "knowledge-graph" | "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" | "knowledgeGraph";
+/**
+ * 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[];
+
+/**
+ * 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;
+    /**
+     * Allows to augment the language 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?: 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;
+
+/**
+ * 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[];
+}
+
+/**
+ * Language service settings
+ */
+interface LanguageServiceSettings {
+    /**
+     * The path to the assets folder where the api files are stored
+     */
+    assetsPath?: string;
+    /**
+     * A template string for constructing the path to the api definition
+     * example: `${assetsPath}/api/arcade-api.t9n.${locale}.json`
+     */
+    apiPathTemplate: string;
+    /**
+     * The language id
+     */
+    languageId: string;
+}
+
+type ApiConstantNamespace = {
+    type: "namespace";
+    key: string;
+    members: SdkConstant[];
+    completion: CompletionItem;
+};
+type ApiConstantDefinition = SdkConstant | ApiConstantNamespace;
+type ApiFunctionDefinition = {
+    type: "functionDefinition";
+    key: string;
+    overloads: SdkFunction[];
+};
+/**
+ * Describes the API properties
+ */
+interface ApiDatabase {
+    categories: ApiCategory[];
+    functionDefinitions: Map<string, ApiFunctionDefinition>;
+    constantDefinitions: Map<string, ApiConstantDefinition>;
+}
+declare class ApiService<TApiContext extends ApiContext = ApiContext> {
+    private _settings;
+    private sdkCategoriesCache;
+    constructor(_settings: LanguageServiceSettings);
+    /**
+     * Returns the API defintions for the given settings: definitions, constant definitions, and function definitons
+     */
+    getApiDatabase(context: TApiContext): Promise<ApiDatabase>;
+    /**
+     * Returns the API definitions
+     */
+    getApiLibrary(context: TApiContext): Promise<ApiCategory[]>;
+    private loadSdkApiLibrary;
+}
+
+export { type ApiCategory, type SdkConstant as ApiConstant, type ApiConstantDefinition, type ApiConstantNamespace, type ApiContext, type ApiDatabase, type ApiDictionaryVariable, type SdkFunction as ApiFunction, type ApiFunctionDefinition, type ApiItem, type ApiProfile, ApiService, type ApiSnippet, type ApiValueVariable, type ApiValueVariableType, type ApiVariable, type SdkVariableType as ApiVariableType, type BundleType, type LanguageServiceSettings, type ProfileId, type SdkPredefinedProfile, isDictionaryVariable, isValueVariable };

package/dist/esm/index.d.ts

@@ -0,0 +1,325 @@
+import { CompletionItem } from 'vscode-languageserver-types';
+
+/**
+ * Supported function bundles
+ */
+type BundleType = "core" | "data-access" | "database" | "geometry" | "knowledge-graph" | "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" | "knowledgeGraph";
+/**
+ * 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[];
+
+/**
+ * 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;
+    /**
+     * Allows to augment the language 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?: 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;
+
+/**
+ * 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[];
+}
+
+/**
+ * Language service settings
+ */
+interface LanguageServiceSettings {
+    /**
+     * The path to the assets folder where the api files are stored
+     */
+    assetsPath?: string;
+    /**
+     * A template string for constructing the path to the api definition
+     * example: `${assetsPath}/api/arcade-api.t9n.${locale}.json`
+     */
+    apiPathTemplate: string;
+    /**
+     * The language id
+     */
+    languageId: string;
+}
+
+type ApiConstantNamespace = {
+    type: "namespace";
+    key: string;
+    members: SdkConstant[];
+    completion: CompletionItem;
+};
+type ApiConstantDefinition = SdkConstant | ApiConstantNamespace;
+type ApiFunctionDefinition = {
+    type: "functionDefinition";
+    key: string;
+    overloads: SdkFunction[];
+};
+/**
+ * Describes the API properties
+ */
+interface ApiDatabase {
+    categories: ApiCategory[];
+    functionDefinitions: Map<string, ApiFunctionDefinition>;
+    constantDefinitions: Map<string, ApiConstantDefinition>;
+}
+declare class ApiService<TApiContext extends ApiContext = ApiContext> {
+    private _settings;
+    private sdkCategoriesCache;
+    constructor(_settings: LanguageServiceSettings);
+    /**
+     * Returns the API defintions for the given settings: definitions, constant definitions, and function definitons
+     */
+    getApiDatabase(context: TApiContext): Promise<ApiDatabase>;
+    /**
+     * Returns the API definitions
+     */
+    getApiLibrary(context: TApiContext): Promise<ApiCategory[]>;
+    private loadSdkApiLibrary;
+}
+
+export { type ApiCategory, type SdkConstant as ApiConstant, type ApiConstantDefinition, type ApiConstantNamespace, type ApiContext, type ApiDatabase, type ApiDictionaryVariable, type SdkFunction as ApiFunction, type ApiFunctionDefinition, type ApiItem, type ApiProfile, ApiService, type ApiSnippet, type ApiValueVariable, type ApiValueVariableType, type ApiVariable, type SdkVariableType as ApiVariableType, type BundleType, type LanguageServiceSettings, type ProfileId, type SdkPredefinedProfile, isDictionaryVariable, isValueVariable };

package/dist/esm/index.js

@@ -0,0 +1,3 @@
+import{CompletionItemKind as f,InsertTextFormat as y,InsertTextMode as b,MarkupKind as C}from"vscode-languageserver-types";function x(i){return Array.isArray(i.testSdkCategories)}async function S(i,n){try{let e=await i,t=new Map,r=new Map,a=[],o=k(n);return e.forEach(p=>{let c=[];p.items.forEach(s=>V(c,r,t,o,s)),c.length&&a.push({...p,items:c})}),{categories:a,functionDefinitions:t,constantDefinitions:r}}catch{return{categories:[],functionDefinitions:new Map,constantDefinitions:new Map}}}var g=class{constructor(n){this._settings=n;this.sdkCategoriesCache=new Map}async getApiDatabase(n){let{locale:e="en"}=n,t=this.sdkCategoriesCache.get(e);if(!t){let{assetsPath:r}=this._settings;if(!r)return{categories:[],functionDefinitions:new Map,constantDefinitions:new Map};t=this.loadSdkApiLibrary(e,r),this.sdkCategoriesCache.set(e,t)}return await S(t,n)}async getApiLibrary(n){let{categories:e}=await this.getApiDatabase(n);return e}async loadSdkApiLibrary(n="en",e=""){if(x(this._settings))return this._settings.testSdkCategories;if(e=e.replace(/\/$/u,""),!e)return[];try{let t=this._settings.apiPathTemplate.replace("${assetsPath}",e).replace("${locale}",n),r=await fetch(t);return r.ok?await r.json():n==="en"?[]:await this.loadSdkApiLibrary("en",e)}catch{return[]}}};function k(i){let{profile:{apiVersion:n,bundles:e,hiddenApiItems:t=[]}={}}=i,r=A(n),a=Array.isArray(e)&&e.length>0?new Set(["core",...e]):void 0;return o=>h(r,o.sinceVersion)&&(!a||a.has(o.bundle))&&!t.includes(o.name)}function V(i,n,e,t,r){if(Array.isArray(r)){r.forEach(a=>m(i,e,t,a));return}r.type==="constant"?D(i,n,t,r):m(i,e,t,r)}function m(i,n,e,t){if(!e(t))return;t.disableDocumentation||i.push(t);let{completion:{label:r}}=t,a=r.toLowerCase(),o=n.get(a);o||(o={type:"functionDefinition",key:a,overloads:[]},n.set(a,o)),o.overloads.push(t)}function D(i,n,e,t){if(!e(t))return;i.push(t);let{completion:{label:r}}=t,a=r.toLowerCase();n.set(a,t);let[o,p]=t.completion.label.split(".");if(!p)return;let c=o.toLowerCase(),s=n.get(c);s||(s={type:"namespace",key:c,members:[],completion:{label:o,detail:o,insertText:o,insertTextMode:b.adjustIndentation,insertTextFormat:y.PlainText,kind:f.Enum}},n.set(c,s));let l=structuredClone(t);l.name=p,l.completion.label=p,l.completion.insertText=p,l.completion.kind=f.Constant,s.members.push(l),s.completion.documentation=s.members.reduce((u,d)=>(u.value=`${u.value}${u.value?`
+
+`:""}**${d.completion.label}**: ${d.description}`,u),{kind:C.Markdown,value:""})}function A(i){if(!i||typeof i!="string")return null;let n=i.split(".").map(r=>Number.parseInt(r));if(n.some(Number.isNaN))return console.error("Invalid API version string",i),null;let[e,t]=n.slice(0,2);return{major:e,minor:t}}function h(i,n){if(!i)return!0;let e=A(n);return e?i.major>e.major?!1:i.minor===void 0||e.minor===void 0?!0:e.minor<=i.minor:!0}function w(i){return!!i&&i.type!=="dictionary"}function M(i){return i?.type==="dictionary"}export{g as ApiService,M as isDictionaryVariable,w as isValueVariable};

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@arcgis/languages-api-utils",
+  "version": "4.31.0-next.15",
+  "description": "ArcGIS Languages API Utilities",
+  "homepage": "https://developers.arcgis.com/javascript/latest/",
+  "type": "module",
+  "main": "dist/esm/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "license": "SEE LICENSE IN LICENSE.md",
+  "scripts": {
+    "build:dev": "yarn build:esm --sourcemap",
+    "build:cjs": "tsup --format cjs --outDir dist/cjs --silent --minify",
+    "build:esm": "tsup --format esm --outDir dist/esm --silent --minify",
+    "build": "npm run build:cjs && npm run build:esm",
+    "clean": "rimraf ./node_modules ./turbo ./dist",
+    "test": "jest"
+  },
+  "dependencies": {
+    "vscode-languageserver-textdocument": "^1.0.11",
+    "vscode-languageserver-types": "^3.17.5"
+  },
+  "devDependencies": {
+    "@arcgis/arcade-sdk": "~1.26.5",
+    "@arcgis/typescript-config": "4.31.0-next.15",
+    "@swc/core": "^1.5.6",
+    "@swc/jest": "^0.2.36",
+    "@types/jest": "^29.5.0",
+    "@types/node": "^20.2.5",
+    "eslint": "^8.55.0",
+    "jest": "^29.5.0",
+    "rimraf": "^5.0.0",
+    "tsup": "^8.1.0",
+    "typescript": "~5.4.0"
+  },
+  "gitHead": "679024353d5112dbab349c81b3d2c89358492044"
+}