@arcgis/languages-api-utils 5.2.0-next.98 → 6.0.0-next.0

package/dist/ApiService.d.ts

@@ -1,21 +1,23 @@
-import { ApiCategory, ApiContext } from './types';
-import { ApiDatabase } from './utils';
-/**
- * Language service settings
- */
+import type { ApiCategory, ApiContext } from "./types.js";
+import type { ApiDatabase } from "./utils.js";
+
+/** 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[]>;
+  getApiLibrary: (locale: string) => Promise<ApiCategory[]>;
 }
+
+export class ApiService<TApiContext extends ApiContext = ApiContext> {
+  constructor(settings: LanguageServiceSettings);
+  /**
+   * Returns the API definitions for the given settings: definitions, constant definitions, and function definitions
+   *
+   * @param context
+   */
+  getApiDatabase(context: TApiContext): Promise<ApiDatabase>;
+  /**
+   * Returns the API definitions
+   *
+   * @param context
+   */
+  getApiLibrary(context: TApiContext): Promise<ApiCategory[]>;
+}

package/dist/index.d.ts

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

package/dist/index.js

@@ -95,11 +95,18 @@ function C(n) {
   return n?.type === "dictionary";
 }
 class D {
+  /**
+   * @public
+   * @param settings
+   */
   constructor(r) {
     this._settings = r, this.localeToApiLibraryPromiseMap = /* @__PURE__ */ new Map();
   }
   /**
    * Returns the API definitions for the given settings: definitions, constant definitions, and function definitions
+   *
+   * @public
+   * @param context
    */
   async getApiDatabase(r) {
     const { locale: t = "en" } = r;
@@ -108,6 +115,9 @@ class D {
   }
   /**
    * Returns the API definitions
+   *
+   * @public
+   * @param context
    */
   async getApiLibrary(r) {
     const { categories: t } = await this.getApiDatabase(r);

package/dist/types.d.ts

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

package/dist/utils.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/languages-api-utils",
-  "version": "5.2.0-next.98",
+  "version": "6.0.0-next.0",
   "description": "ArcGIS Languages API Utilities",
   "homepage": "https://developers.arcgis.com/javascript/latest/",
   "type": "module",
@@ -12,7 +12,7 @@
   ],
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@arcgis/languages-sdk-spec": "5.2.0-next.98",
+    "@arcgis/languages-sdk-spec": "6.0.0-next.0",
     "tslib": "^2.8.1",
     "vscode-languageserver-types": "^3.17.5"
   }