@arcgis/languages-api-utils 4.33.0-next.13 → 4.33.0-next.133

package/dist/ApiService.d.cts

@@ -0,0 +1,21 @@
+import { ApiCategory, ApiContext } from './types';
+import { ApiDatabase } from './utils';
+/**
+ * Language service settings
+ */
+export interface LanguageServiceSettings {
+    getApiLibrary: (locale: string) => Promise<ApiCategory[]>;
+}
+export declare class ApiService<TApiContext extends ApiContext = ApiContext> {
+    private _settings;
+    private localeToApiLibraryPromiseMap;
+    constructor(_settings: LanguageServiceSettings);
+    /**
+     * Returns the API definitions for the given settings: definitions, constant definitions, and function definitions
+     */
+    getApiDatabase(context: TApiContext): Promise<ApiDatabase>;
+    /**
+     * Returns the API definitions
+     */
+    getApiLibrary(context: TApiContext): Promise<ApiCategory[]>;
+}

package/dist/ApiService.d.ts

@@ -0,0 +1,21 @@
+import { ApiCategory, ApiContext } from './types';
+import { ApiDatabase } from './utils';
+/**
+ * Language service settings
+ */
+export interface LanguageServiceSettings {
+    getApiLibrary: (locale: string) => Promise<ApiCategory[]>;
+}
+export declare class ApiService<TApiContext extends ApiContext = ApiContext> {
+    private _settings;
+    private localeToApiLibraryPromiseMap;
+    constructor(_settings: LanguageServiceSettings);
+    /**
+     * Returns the API definitions for the given settings: definitions, constant definitions, and function definitions
+     */
+    getApiDatabase(context: TApiContext): Promise<ApiDatabase>;
+    /**
+     * Returns the API definitions
+     */
+    getApiLibrary(context: TApiContext): Promise<ApiCategory[]>;
+}

package/dist/index.cjs

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

package/dist/index.d.cts

@@ -0,0 +1,3 @@
+export * from './ApiService';
+export type * from './types';
+export * from './utils';

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './ApiService';
+export type * from './types';
+export * from './utils';

package/dist/index.js

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

package/dist/types.d.cts

@@ -0,0 +1,117 @@
+import { SdkConstant as ApiConstant, SdkFunction as ApiFunction, SdkVariableType as ApiVariableType, SdkPredefinedProfile, BundleType, ProfileId, SdkCategory, ArcadeSdkPredefinedProfile, SqlSdkPredefinedProfile } from '@arcgis/languages-sdk-spec';
+import { CompletionItem } from 'vscode-languageserver-types';
+export type { ApiConstant, ApiFunction, BundleType };
+/**
+ * Represent items stored in the library
+ */
+export type ApiItem = ApiConstant | ApiFunction;
+/**
+ * Represent a category of api items in the api library
+ */
+export interface ApiCategory extends SdkCategory {
+    items: ApiItem[];
+}
+export type { ProfileId, ApiVariableType, SdkPredefinedProfile, ArcadeSdkPredefinedProfile, SqlSdkPredefinedProfile };
+/**
+ * The editor can be extended with custom snippets
+ */
+export 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
+ */
+export 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
+ */
+export 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.
+ */
+export type ApiValueVariableType = Exclude<ApiVariableType, "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)
+ */
+export interface ApiDictionaryVariable extends ApiVariableBase {
+    type: "dictionary";
+    /**
+     * Dictionary properties
+     */
+    properties?: ApiVariable[];
+}
+/**
+ * Describes a simple variable type (number, featureSet, etc.)
+ */
+export interface ApiValueVariable extends ApiVariableBase {
+    type: ApiValueVariableType;
+}
+/**
+ * The profile variable type
+ */
+export type ApiVariable = ApiDictionaryVariable | ApiValueVariable;

package/dist/types.d.ts

@@ -0,0 +1,117 @@
+import { SdkConstant as ApiConstant, SdkFunction as ApiFunction, SdkVariableType as ApiVariableType, SdkPredefinedProfile, BundleType, ProfileId, SdkCategory, ArcadeSdkPredefinedProfile, SqlSdkPredefinedProfile } from '@arcgis/languages-sdk-spec';
+import { CompletionItem } from 'vscode-languageserver-types';
+export type { ApiConstant, ApiFunction, BundleType };
+/**
+ * Represent items stored in the library
+ */
+export type ApiItem = ApiConstant | ApiFunction;
+/**
+ * Represent a category of api items in the api library
+ */
+export interface ApiCategory extends SdkCategory {
+    items: ApiItem[];
+}
+export type { ProfileId, ApiVariableType, SdkPredefinedProfile, ArcadeSdkPredefinedProfile, SqlSdkPredefinedProfile };
+/**
+ * The editor can be extended with custom snippets
+ */
+export 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
+ */
+export 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
+ */
+export 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.
+ */
+export type ApiValueVariableType = Exclude<ApiVariableType, "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)
+ */
+export interface ApiDictionaryVariable extends ApiVariableBase {
+    type: "dictionary";
+    /**
+     * Dictionary properties
+     */
+    properties?: ApiVariable[];
+}
+/**
+ * Describes a simple variable type (number, featureSet, etc.)
+ */
+export interface ApiValueVariable extends ApiVariableBase {
+    type: ApiValueVariableType;
+}
+/**
+ * The profile variable type
+ */
+export type ApiVariable = ApiDictionaryVariable | ApiValueVariable;

package/dist/utils.d.cts

@@ -0,0 +1,36 @@
+import { SdkConstant as ApiConstant, SdkFunction as ApiFunction, SdkCategory } from '@arcgis/languages-sdk-spec';
+import { ApiCategory, ApiContext, ApiDictionaryVariable, ApiValueVariable, ApiVariable } from './types';
+import { CompletionItem } from 'vscode-languageserver-types';
+export interface ApiVersion {
+    major: number;
+    minor?: number;
+}
+export type ApiConstantNamespace = {
+    type: "namespace";
+    key: string;
+    members: ApiConstant[];
+    completion: CompletionItem;
+};
+export type ApiConstantDefinition = ApiConstant | ApiConstantNamespace;
+export type ApiFunctionDefinition = {
+    type: "functionDefinition";
+    key: string;
+    overloads: ApiFunction[];
+};
+/**
+ * Describes the API properties
+ */
+export interface ApiDatabase {
+    categories: ApiCategory[];
+    functionDefinitions: Map<string, ApiFunctionDefinition>;
+    constantDefinitions: Map<string, ApiConstantDefinition>;
+}
+export declare function filterApiLibraryForContext(apiLibraryPromise: Promise<SdkCategory[]>, context: ApiContext): Promise<ApiDatabase>;
+/**
+ * Helper function to test if a variable is a value variable
+ */
+export declare function isValueVariable(variable: ApiVariable | null | undefined): variable is ApiValueVariable;
+/**
+ * Helper function to test if a variable is a dictionary variable
+ */
+export declare function isDictionaryVariable(variable: ApiVariable | null | undefined): variable is ApiDictionaryVariable;

package/dist/utils.d.ts

@@ -0,0 +1,36 @@
+import { SdkConstant as ApiConstant, SdkFunction as ApiFunction, SdkCategory } from '@arcgis/languages-sdk-spec';
+import { ApiCategory, ApiContext, ApiDictionaryVariable, ApiValueVariable, ApiVariable } from './types';
+import { CompletionItem } from 'vscode-languageserver-types';
+export interface ApiVersion {
+    major: number;
+    minor?: number;
+}
+export type ApiConstantNamespace = {
+    type: "namespace";
+    key: string;
+    members: ApiConstant[];
+    completion: CompletionItem;
+};
+export type ApiConstantDefinition = ApiConstant | ApiConstantNamespace;
+export type ApiFunctionDefinition = {
+    type: "functionDefinition";
+    key: string;
+    overloads: ApiFunction[];
+};
+/**
+ * Describes the API properties
+ */
+export interface ApiDatabase {
+    categories: ApiCategory[];
+    functionDefinitions: Map<string, ApiFunctionDefinition>;
+    constantDefinitions: Map<string, ApiConstantDefinition>;
+}
+export declare function filterApiLibraryForContext(apiLibraryPromise: Promise<SdkCategory[]>, context: ApiContext): Promise<ApiDatabase>;
+/**
+ * Helper function to test if a variable is a value variable
+ */
+export declare function isValueVariable(variable: ApiVariable | null | undefined): variable is ApiValueVariable;
+/**
+ * Helper function to test if a variable is a dictionary variable
+ */
+export declare function isDictionaryVariable(variable: ApiVariable | null | undefined): variable is ApiDictionaryVariable;

package/package.json

@@ -1,18 +1,19 @@
 {
   "name": "@arcgis/languages-api-utils",
-  "version": "4.33.0-next.13",
+  "version": "4.33.0-next.133",
   "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",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
     "dist/"
   ],
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "tslib": "^2.7.0",
+    "@arcgis/languages-sdk-spec": "4.33.0-next.133",
+    "tslib": "^2.8.1",
     "vscode-languageserver-textdocument": "^1.0.11",
     "vscode-languageserver-types": "^3.17.5"
   }

package/dist/cjs/index.cjs

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

package/dist/cjs/index.d.cts

@@ -1,347 +0,0 @@
-import { CompletionItem } from 'vscode-languageserver-types';
-
-/**
- * Supported function bundles
- */
-type SqlBundleType = "core";
-
-/**
- * Union of bundle types that can be used in any sdk schema
- */
-type BundleType = ArcadeBundleType | SqlBundleType;
-
-/**
- * Supported function bundles
- */
-type ArcadeBundleType = "core" | "data-access" | "database" | "geometry" | "knowledge-graph" | "portal-access" | "track";
-
-/**
- * Describes a profile
- */
-interface BaseSdkPredefinedProfile<ProfileId extends string, Bundle extends string> {
-    /**
-     * Profile name for UI
-     */
-    name: string;
-    /**
-     * Profile id for docs
-     */
-    id: ProfileId;
-    /**
-     * Function bundles enabled for this profile
-     */
-    bundles: Bundle[];
-    /**
-     * Variable describing name, type, and providing description
-     */
-    variables: SdkVariable[];
-}
-/**
- * Supported profile variable types
- */
-type SdkVariableType = "array" | "boolean" | "date" | "dateOnly" | "dictionary" | "feature" | "featureSet" | "featureSetCollection" | "geometry" | "knowledgeGraph" | "number" | "text" | "time" | "voxel";
-/**
- * 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 = SdkDictionaryVariable | SdkValueVariable;
-
-/**
- * The list of supported profiles
- */
-type ArcadeProfileId = "aggregate-field" | "alias" | "attribute-rule-calculation" | "attribute-rule-constraint" | "attribute-rule-validation" | "dashboard-data" | "dashboard-indicator-formatting" | "dashboard-list-formatting" | "dashboard-table-formatting" | "data-pipelines" | "dictionary-renderer" | "feature-display-title" | "feature-z" | "field-calculation" | "field-mapping" | "form-calculation" | "form-constraint" | "geoanalytics" | "geotrigger-notification" | "labeling" | "layout" | "location-update-constraint" | "measure-visualization" | "minimalist" | "model-builder" | "popup-element-feature-reduction" | "popup-element-voxel" | "popup-element" | "popup-feature-reduction" | "popup-voxel" | "popup" | "quick-capture" | "tasks" | "velocity" | "visualization";
-/**
- * The predefined profiles for the Arcade language
- */
-type ArcadeSdkPredefinedProfile = BaseSdkPredefinedProfile<ArcadeProfileId, ArcadeBundleType>;
-
-/**
- * The list of supported profiles
- */
-type SqlProfileId = "field-calculation";
-/**
- * The predefined profiles for the SQL language
- */
-type SqlSdkPredefinedProfile = BaseSdkPredefinedProfile<SqlProfileId, SqlBundleType>;
-
-type SdkPredefinedProfile = ArcadeSdkPredefinedProfile | SqlSdkPredefinedProfile;
-/**
- * A union of all language profile ids
- */
-type ProfileId = ArcadeProfileId | SqlProfileId;
-
-/**
- * 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[];
-
-/**
- * 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[];
-}
-
-/**
- * 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;
-
-interface ApiVersion {
-    major: number;
-    minor?: number;
-}
-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 function filterApiLibraryForContext(apiLibraryPromise: Promise<SdkCategory[]>, context: ApiContext): Promise<ApiDatabase>;
-/**
- * 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;
-
-/**
- * Language service settings
- */
-interface LanguageServiceSettings {
-    getApiLibrary: (locale: string) => Promise<ApiCategory[]>;
-}
-declare class ApiService<TApiContext extends ApiContext = ApiContext> {
-    private _settings;
-    private localeToApiLibraryPromiseMap;
-    constructor(_settings: LanguageServiceSettings);
-    /**
-     * Returns the API definitions for the given settings: definitions, constant definitions, and function definitions
-     */
-    getApiDatabase(context: TApiContext): Promise<ApiDatabase>;
-    /**
-     * Returns the API definitions
-     */
-    getApiLibrary(context: TApiContext): Promise<ApiCategory[]>;
-}
-
-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 ApiVersion, type ArcadeSdkPredefinedProfile, type BundleType, type LanguageServiceSettings, type ProfileId, type SdkPredefinedProfile, type SqlSdkPredefinedProfile, filterApiLibraryForContext, isDictionaryVariable, isValueVariable };

package/dist/esm/index.d.ts

@@ -1,347 +0,0 @@
-import { CompletionItem } from 'vscode-languageserver-types';
-
-/**
- * Supported function bundles
- */
-type SqlBundleType = "core";
-
-/**
- * Union of bundle types that can be used in any sdk schema
- */
-type BundleType = ArcadeBundleType | SqlBundleType;
-
-/**
- * Supported function bundles
- */
-type ArcadeBundleType = "core" | "data-access" | "database" | "geometry" | "knowledge-graph" | "portal-access" | "track";
-
-/**
- * Describes a profile
- */
-interface BaseSdkPredefinedProfile<ProfileId extends string, Bundle extends string> {
-    /**
-     * Profile name for UI
-     */
-    name: string;
-    /**
-     * Profile id for docs
-     */
-    id: ProfileId;
-    /**
-     * Function bundles enabled for this profile
-     */
-    bundles: Bundle[];
-    /**
-     * Variable describing name, type, and providing description
-     */
-    variables: SdkVariable[];
-}
-/**
- * Supported profile variable types
- */
-type SdkVariableType = "array" | "boolean" | "date" | "dateOnly" | "dictionary" | "feature" | "featureSet" | "featureSetCollection" | "geometry" | "knowledgeGraph" | "number" | "text" | "time" | "voxel";
-/**
- * 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 = SdkDictionaryVariable | SdkValueVariable;
-
-/**
- * The list of supported profiles
- */
-type ArcadeProfileId = "aggregate-field" | "alias" | "attribute-rule-calculation" | "attribute-rule-constraint" | "attribute-rule-validation" | "dashboard-data" | "dashboard-indicator-formatting" | "dashboard-list-formatting" | "dashboard-table-formatting" | "data-pipelines" | "dictionary-renderer" | "feature-display-title" | "feature-z" | "field-calculation" | "field-mapping" | "form-calculation" | "form-constraint" | "geoanalytics" | "geotrigger-notification" | "labeling" | "layout" | "location-update-constraint" | "measure-visualization" | "minimalist" | "model-builder" | "popup-element-feature-reduction" | "popup-element-voxel" | "popup-element" | "popup-feature-reduction" | "popup-voxel" | "popup" | "quick-capture" | "tasks" | "velocity" | "visualization";
-/**
- * The predefined profiles for the Arcade language
- */
-type ArcadeSdkPredefinedProfile = BaseSdkPredefinedProfile<ArcadeProfileId, ArcadeBundleType>;
-
-/**
- * The list of supported profiles
- */
-type SqlProfileId = "field-calculation";
-/**
- * The predefined profiles for the SQL language
- */
-type SqlSdkPredefinedProfile = BaseSdkPredefinedProfile<SqlProfileId, SqlBundleType>;
-
-type SdkPredefinedProfile = ArcadeSdkPredefinedProfile | SqlSdkPredefinedProfile;
-/**
- * A union of all language profile ids
- */
-type ProfileId = ArcadeProfileId | SqlProfileId;
-
-/**
- * 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[];
-
-/**
- * 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[];
-}
-
-/**
- * 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;
-
-interface ApiVersion {
-    major: number;
-    minor?: number;
-}
-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 function filterApiLibraryForContext(apiLibraryPromise: Promise<SdkCategory[]>, context: ApiContext): Promise<ApiDatabase>;
-/**
- * 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;
-
-/**
- * Language service settings
- */
-interface LanguageServiceSettings {
-    getApiLibrary: (locale: string) => Promise<ApiCategory[]>;
-}
-declare class ApiService<TApiContext extends ApiContext = ApiContext> {
-    private _settings;
-    private localeToApiLibraryPromiseMap;
-    constructor(_settings: LanguageServiceSettings);
-    /**
-     * Returns the API definitions for the given settings: definitions, constant definitions, and function definitions
-     */
-    getApiDatabase(context: TApiContext): Promise<ApiDatabase>;
-    /**
-     * Returns the API definitions
-     */
-    getApiLibrary(context: TApiContext): Promise<ApiCategory[]>;
-}
-
-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 ApiVersion, type ArcadeSdkPredefinedProfile, type BundleType, type LanguageServiceSettings, type ProfileId, type SdkPredefinedProfile, type SqlSdkPredefinedProfile, filterApiLibraryForContext, isDictionaryVariable, isValueVariable };

package/dist/esm/index.js

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