@arcgis/languages-api-utils 5.2.0-next.3 → 5.2.0-next.31

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/languages-api-utils",
-  "version": "5.2.0-next.3",
+  "version": "5.2.0-next.31",
   "description": "ArcGIS Languages API Utilities",
   "homepage": "https://developers.arcgis.com/javascript/latest/",
   "type": "module",
@@ -14,6 +14,6 @@
   "dependencies": {
     "tslib": "^2.8.1",
     "vscode-languageserver-types": "^3.17.5",
-    "@arcgis/languages-sdk-spec": "5.2.0-next.3"
+    "@arcgis/languages-sdk-spec": "5.2.0-next.31"
   }
 }

package/dist/ApiService.d.cts

@@ -1,21 +0,0 @@
-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

@@ -1,3 +0,0 @@
-"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

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

package/dist/types.d.cts

@@ -1,117 +0,0 @@
-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

@@ -1,36 +0,0 @@
-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;