@arcgis/languages-sdk-spec 5.2.0-next.13 → 5.2.0-next.130

package/dist/schema-types/index.d.ts

@@ -1,21 +1,15 @@
-import { ArcadeApiFunction, ArcadeApiItem, ArcadeSchemaItemBase } from './arcade';
-import { SqlApiFunction, SqlApiItem, SqlSchemaItemBase } from './sql';
-/**
- *
- */
-export type { ArcadeApiItem, ArcadeApiConstant } from './arcade';
-export type { SqlApiItem } from './sql';
-/**
- * Union of API items that can be used in any sdk schema
- */
+import type { ArcadeApiFunction, ArcadeApiItem, ArcadeSchemaItemBase } from "./arcade.js";
+import type { SqlApiFunction, SqlApiItem, SqlSchemaItemBase } from "./sql.js";
+
+export { type ArcadeApiItem, type ArcadeApiConstant } from "./arcade.js";
+export type * from "./base.js";
+export type * from "./common.js";
+
+/** Union of API items that can be used in any sdk schema */
 export type SchemaApiItem = ArcadeApiItem | SqlApiItem;
-/**
- * Union of API functions that can be used in any sdk schema
- */
+
+/** Union of API functions that can be used in any sdk schema */
 export type SchemaApiFunction = ArcadeApiFunction | SqlApiFunction;
-/**
- * Union of schema items that can be used in any sdk schema
- */
-export type SchemaItemBase = ArcadeSchemaItemBase | SqlSchemaItemBase;
-export type * from './base';
-export type * from './common';
+
+/** Union of schema items that can be used in any sdk schema */
+export type SchemaItemBase = ArcadeSchemaItemBase | SqlSchemaItemBase;

package/dist/schema-types/sql.d.ts

@@ -1,55 +1,40 @@
-import { BaseSchemaApiFunction, BaseSchemaApiItem, GenericSchemaItemBase } from './base';
-/**
- * Supported function bundles
- */
+import type { BaseSchemaApiFunction, BaseSchemaApiItem, GenericSchemaItemBase } from "./base.js";
+
+/** Supported function bundles */
 export type SqlBundleType = "date" | "numeric" | "string";
-/**
- * Supported sql profile names
- */
+
+/** Supported sql profile names */
 export type SqlProfileType = "Field Calculation";
+
 export type SqlValueType = "Datetime" | "Number" | "String";
-/**
- * Narrowed schema item type for sql
- */
+
+/** Narrowed schema item type for sql */
 export type SqlSchemaItemBase = GenericSchemaItemBase<SqlBundleType, SqlProfileType>;
-/**
- * Narrowed api function type for sql
- */
-export type SqlApiFunction = BaseSchemaApiFunction<SqlBundleType, SqlProfileType, SqlValueType> & {
-    /**
-     * The name of the function.
-     */
-    name: string;
-    /**
-     * SQL functions may be "special registers" that are not called like regular functions.
-     * For example, CURRENT_DATE is a special register.
-     * These functions are not called with parentheses or arguments.
-     */
-    isSpecialRegister?: boolean;
-    /**
-     * The set of keywords that are used in the function.
-     */
-    keywords?: SchemaKeyword[];
+
+/** Narrowed api function type for sql */
+export type SqlApiFunction = BaseSchemaApiFunction<SqlBundleType, SqlProfileType, SqlValueType>
+  & {
+  /** The name of the function. */
+  name: string;
+  /**
+   * SQL functions may be "special registers" that are not called like regular functions.
+   * For example, CURRENT_DATE is a special register.
+   * These functions are not called with parentheses or arguments.
+   */
+  isSpecialRegister?: boolean;
+  /** The set of keywords that are used in the function. */
+  keywords?: SchemaKeyword[];
 };
-/**
- * Narrowed api item type for sql. Sql does not have constants so all sql items are "functions".
- */
+
+/** Narrowed api item type for sql. Sql does not have constants so all sql items are "functions". */
 export type SqlApiItem = BaseSchemaApiItem<SqlApiFunction>;
-/**
- * Describes a keyword used in a function
- */
-interface SchemaKeyword {
-    /**
-     * The name of the keyword.
-     */
-    name: string;
-    /**
-     * The description for the keyword.
-     */
-    description: string;
-    /**
-     * (optional) position of the keyword in the function signature, default is to interlace with parameters
-     */
-    position?: number;
-}
-export {};
+
+/** Describes a keyword used in a function */
+export interface SchemaKeyword {
+  /** The name of the keyword. */
+  name: string;
+  /** The description for the keyword. */
+  description: string;
+  /** (optional) position of the keyword in the function signature, default is to interlace with parameters */
+  position?: number;
+}

package/dist/schemas/api-item.schema.json

@@ -86,7 +86,7 @@
         },
         "snippet": {
           "type": "string",
-          "description": "The code that will be injected in the classic editor. Must start with a capital letter and match the name of the funtion or constant.",
+          "description": "The code that will be injected in the classic editor. Must start with a capital letter and match the name of the function or constant.",
           "pattern": "^[A-Z]+.*$"
         },
         "examples": {
@@ -117,6 +117,10 @@
         "returnValue": {
           "$ref": "#/definitions/SchemaReturnValue<ArcadeValueType>",
           "description": "The type of data returned by the function."
+        },
+        "consumesCredits": {
+          "type": "boolean",
+          "description": "Indicates if the function consumes credits when called."
         }
       },
       "additionalProperties": false,
@@ -421,7 +425,7 @@
         },
         "snippet": {
           "type": "string",
-          "description": "The code that will be injected in the classic editor. Must start with a capital letter and match the name of the funtion or constant.",
+          "description": "The code that will be injected in the classic editor. Must start with a capital letter and match the name of the function or constant.",
           "pattern": "^[A-Z]+.*$"
         },
         "examples": {
@@ -552,7 +556,7 @@
         },
         "snippet": {
           "type": "string",
-          "description": "The code that will be injected in the classic editor. Must start with a capital letter and match the name of the funtion or constant.",
+          "description": "The code that will be injected in the classic editor. Must start with a capital letter and match the name of the function or constant.",
           "pattern": "^[A-Z]+.*$"
         },
         "examples": {
@@ -583,6 +587,10 @@
         "returnValue": {
           "$ref": "#/definitions/SchemaReturnValue<SqlValueType>",
           "description": "The type of data returned by the function."
+        },
+        "consumesCredits": {
+          "type": "boolean",
+          "description": "Indicates if the function consumes credits when called."
         }
       },
       "required": [

package/dist/schemas/arcade-api-item.schema.json

@@ -75,7 +75,7 @@
         },
         "snippet": {
           "type": "string",
-          "description": "The code that will be injected in the classic editor. Must start with a capital letter and match the name of the funtion or constant.",
+          "description": "The code that will be injected in the classic editor. Must start with a capital letter and match the name of the function or constant.",
           "pattern": "^[A-Z]+.*$"
         },
         "examples": {
@@ -106,6 +106,10 @@
         "returnValue": {
           "$ref": "#/definitions/SchemaReturnValue<ArcadeValueType>",
           "description": "The type of data returned by the function."
+        },
+        "consumesCredits": {
+          "type": "boolean",
+          "description": "Indicates if the function consumes credits when called."
         }
       },
       "additionalProperties": false,
@@ -410,7 +414,7 @@
         },
         "snippet": {
           "type": "string",
-          "description": "The code that will be injected in the classic editor. Must start with a capital letter and match the name of the funtion or constant.",
+          "description": "The code that will be injected in the classic editor. Must start with a capital letter and match the name of the function or constant.",
           "pattern": "^[A-Z]+.*$"
         },
         "examples": {

package/dist/schemas/arcade-profiles.schema.json

@@ -68,6 +68,7 @@
         "form-attachment-filename-calculation",
         "form-calculation",
         "form-constraint",
+        "form-dynamic-choice",
         "geoanalytics",
         "geotrigger-notification",
         "labeling",

package/dist/schemas/profiles.schema.json

@@ -16,7 +16,8 @@
         {
           "$ref": "#/definitions/SqlSdkPredefinedProfile"
         }
-      ]
+      ],
+      "description": "A union of all language predefined profiles"
     },
     "ArcadeSdkPredefinedProfile": {
       "$ref": "#/definitions/BaseSdkPredefinedProfile<ArcadeProfileId,ArcadeBundleType>",
@@ -82,6 +83,7 @@
         "form-attachment-filename-calculation",
         "form-calculation",
         "form-constraint",
+        "form-dynamic-choice",
         "geoanalytics",
         "geotrigger-notification",
         "labeling",

package/dist/schemas/sql-api-item.schema.json

@@ -100,7 +100,7 @@
         },
         "snippet": {
           "type": "string",
-          "description": "The code that will be injected in the classic editor. Must start with a capital letter and match the name of the funtion or constant.",
+          "description": "The code that will be injected in the classic editor. Must start with a capital letter and match the name of the function or constant.",
           "pattern": "^[A-Z]+.*$"
         },
         "examples": {
@@ -131,6 +131,10 @@
         "returnValue": {
           "$ref": "#/definitions/SchemaReturnValue<SqlValueType>",
           "description": "The type of data returned by the function."
+        },
+        "consumesCredits": {
+          "type": "boolean",
+          "description": "Indicates if the function consumes credits when called."
         }
       },
       "required": [

package/dist/scripting/index.d.ts

@@ -1 +1,2 @@
-export * from './utilities';
+export * from "./utilities.js";
+

package/dist/scripting/utilities.d.ts

@@ -1,58 +1,144 @@
-import { ArcadeApiConstant, SchemaApiFunction, SchemaApiItem, SchemaCategory, SchemaExample, SchemaProperty, SchemaResourceLink, SchemaReturnDefinition, SchemaReturnValue, SingularApiItem } from '../schema-types';
-import { SqlApiFunction } from '../schema-types/sql';
-import { SdkDictionaryVariable, SdkVariable } from '../profile-types';
+import type { ArcadeApiConstant } from "../schema-types/arcade.js";
+import type { SchemaCategory, SchemaExample, SchemaProperty, SchemaResourceLink, SchemaReturnDefinition, SchemaReturnValue, SingularApiItem } from "../schema-types/base.js";
+import type { SchemaApiFunction, SchemaApiItem } from "../schema-types/index.js";
+import type { SqlApiFunction } from "../schema-types/sql.js";
+import type { SdkDictionaryVariable, SdkVariable } from "../profile-types/base.js";
+
 export type Paths = {
-    relativePath: string;
-    absolutePath: string;
+  relativePath: string;
+  absolutePath: string;
 };
-export declare function isSchemaDictionaryVariable(variable: SdkVariable): variable is SdkDictionaryVariable;
-export declare function getDirectoryNames(path: string): Promise<string[]>;
-export declare function getFileNames(path: string): Promise<string[]>;
-/**
- * Structure used when reading the API Files
- */
+
+/** @param variable */
+export function isSchemaDictionaryVariable(variable: SdkVariable): variable is SdkDictionaryVariable;
+
+/** @param path */
+export function getDirectoryNames(path: string): Promise<string[]>;
+
+/** @param path */
+export function getFileNames(path: string): Promise<string[]>;
+
+/** Structure used when reading the API Files */
 export interface ApiDatabase {
-    categories: ApiCategories;
-    resources: ApiResources;
+  categories: ApiCategories;
+  resources: ApiResources;
 }
+
 export type ApiCategories = Record<string, {
     definition: SchemaCategory;
     items: Map<string, SchemaApiItem>;
 }>;
+
 export type ApiResources = Record<string, string>;
-export declare const DefaultApiResources: ApiResources;
-export declare function isSchemaFunction(item: SchemaApiItem): item is SchemaApiFunction;
-export declare function isSchemaConstant(item: SchemaApiItem): item is ArcadeApiConstant;
-export declare function isSchemaReturnDefinition(item: SchemaReturnValue): item is SchemaReturnDefinition;
-export declare function loadApiDatabase(languageFileName: string): Promise<ApiDatabase>;
-export declare const toLocalConfig: {
+
+export const DefaultApiResources: ApiResources;
+
+/** @param item */
+export function isSchemaFunction(item: SchemaApiItem): item is SchemaApiFunction;
+
+/** @param item */
+export function isSchemaConstant(item: SchemaApiItem): item is ArcadeApiConstant;
+
+/** @param item */
+export function isSchemaReturnDefinition(item: SchemaReturnValue): item is SchemaReturnDefinition;
+
+/** @param languageFileName */
+export function loadApiDatabase(languageFileName: string): Promise<ApiDatabase>;
+
+export const toLocalConfig: {
     minimumIntegerDigits: number;
     useGrouping: boolean;
 };
-export declare function convertStringArrayToObject(array: string[] | string | undefined): Record<string, string>;
-export declare function convertObjectToArray<T>(obj: Record<string, T> | undefined): T[] | undefined;
-export declare function headingPattern(level: number): string;
-export declare function isFunction(apiItem: SingularApiItem): apiItem is SchemaApiFunction;
-export declare function assembleMarkdownString(value: string[] | string | undefined): string;
-export declare function apiItemName(item: SchemaApiItem): string;
-export declare function generateSinceVersionSection(resources: ApiResources, apiItem: SingularApiItem, paths: Paths, relative?: boolean): string[];
-export declare function generateSignature(apiItem: SingularApiItem, paths: Paths, { relative, typeLink, needsHtmlEntity }?: {
-    relative?: boolean | undefined;
-    typeLink?: boolean | undefined;
-    needsHtmlEntity?: boolean | undefined;
-}): string;
-export declare function generateTypeLink(values: string[] | string, paths: Paths, relative?: boolean): string;
-export declare function generateParametersSection(resources: ApiResources, parameters: SchemaProperty[] | undefined, paths: Paths, relative?: boolean, useTypeLinks?: boolean): string[];
-export declare function generateReturnSection(resources: ApiResources, returnDefinition: SchemaReturnValue, paths: Paths, relative?: boolean, useTypeLinks?: boolean): string[];
-export declare function generateExamplesSection(resources: ApiResources, examples: SchemaExample[] | undefined, headingPattern: "**" | "#####", language: string): string[];
-export declare function generateAdditionalResourcesSection(resources: ApiResources, resourceLinks: SchemaResourceLink[] | undefined, headingPattern: "**" | "####"): string[];
-export declare function fixUrl(description: string, paths: Paths, relative?: boolean): string;
+
+/** @param array */
+export function convertStringArrayToObject(array: string[] | string | undefined): Record<string, string>;
+
+/** @param object */
+export function convertObjectToArray<T>(object: Record<string, T> | undefined): T[] | undefined;
+
+/** @param level */
+export function headingPattern(level: number): string;
+
+/** @param apiItem */
+export function isFunction(apiItem: SingularApiItem): apiItem is SchemaApiFunction;
+
+/** @param value */
+export function assembleMarkdownString(value: string[] | string | undefined): string;
+
+/** @param item */
+export function apiItemName(item: SchemaApiItem): string;
+
+/**
+ * @param resources
+ * @param apiItem
+ * @param paths
+ * @param relative
+ */
+export function generateSinceVersionSection(resources: ApiResources, apiItem: SingularApiItem, paths: Paths, relative?: boolean): string[];
+
+/**
+ * @param apiItem
+ * @param paths
+ * @param param2
+ */
+export function generateSignature(apiItem: SingularApiItem, paths: Paths, param2?: {}): string;
+
+/**
+ * @param values
+ * @param paths
+ * @param relative
+ */
+export function generateTypeLink(values: string[] | string, paths: Paths, relative?: boolean): string;
+
+/**
+ * @param resources
+ * @param parameters
+ * @param paths
+ * @param relative
+ * @param useTypeLinks
+ */
+export function generateParametersSection(resources: ApiResources, parameters: SchemaProperty[] | undefined, paths: Paths, relative?: boolean, useTypeLinks?: boolean): string[];
+
+/**
+ * @param resources
+ * @param returnDefinition
+ * @param paths
+ * @param relative
+ * @param useTypeLinks
+ */
+export function generateReturnSection(resources: ApiResources, returnDefinition: SchemaReturnValue, paths: Paths, relative?: boolean, useTypeLinks?: boolean): string[];
+
+/**
+ * @param resources
+ * @param examples
+ * @param headingPattern
+ * @param language
+ */
+export function generateExamplesSection(resources: ApiResources, examples: SchemaExample[] | undefined, headingPattern: "**" | "#####", language: string): string[];
+
+/**
+ * @param resources
+ * @param resourceLinks
+ * @param headingPattern
+ */
+export function generateAdditionalResourcesSection(resources: ApiResources, resourceLinks: SchemaResourceLink[] | undefined, headingPattern: "**" | "####"): string[];
+
+/**
+ * @param description
+ * @param paths
+ * @param relative
+ */
+export function fixUrl(description: string, paths: Paths, relative?: boolean): string;
+
 /**
  * Interlaces two arrays and joins them into a string with spaces.
+ *
  * @param array1 - The first array.
  * @param array2 - The second array.
  * @param positions - Optional positions for the second array elements.
  * @returns - The interlaced array.
  */
-export declare function interlaceArrays(array1: string[], array2: string[], positions?: number[]): string;
-export declare function isSqlApiFunction(apiItem: SchemaApiItem): apiItem is SqlApiFunction;
+export function interlaceArrays(array1: string[], array2: string[], positions?: number[]): string;
+
+/** @param apiItem */
+export function isSqlApiFunction(apiItem: SchemaApiItem): apiItem is SqlApiFunction;

package/dist/t9n-types.d.ts

@@ -1,28 +1,37 @@
 export interface T9NApiRoot {
-    resources: Record<string, string>;
-    categories: T9NCategories;
+  resources: Record<string, string>;
+  categories: T9NCategories;
 }
+
 export type T9NCategories = Record<string, T9NCategory>;
+
 export interface T9NCategory {
-    title: string;
-    description?: Record<string, string>;
-    items: T9NApiItems;
+  title: string;
+  description?: Record<string, string>;
+  items: T9NApiItems;
 }
+
 export type T9NResource = Record<string, string>;
+
 export type T9NApiItems = Record<string, Record<string, T9NApiItem> | T9NApiItem>;
+
 export interface T9NProperty {
-    description?: Record<string, string>;
-    properties?: Record<string, T9NProperty>;
+  description?: Record<string, string>;
+  properties?: Record<string, T9NProperty>;
 }
+
 export interface T9NApiItem {
-    description: Record<string, string>;
-    examples?: Record<string, Record<string, string>>;
-    parameters?: Record<string, T9NProperty>;
-    returnValue?: T9NProperty;
+  description: Record<string, string>;
+  examples?: Record<string, Record<string, string>>;
+  parameters?: Record<string, T9NProperty>;
+  returnValue?: T9NProperty;
 }
+
 export type T9NProfiles = Record<string, T9NProfileVariables>;
+
 export type T9NProfileVariables = Record<string, T9NProfileVariable>;
+
 export interface T9NProfileVariable {
-    description?: string;
-    properties?: T9NProfileVariables;
-}
+  description?: string;
+  properties?: T9NProfileVariables;
+}

package/dist/types.d.ts

@@ -1,79 +1,59 @@
-import { BundleType } from './schema-types';
-import { CompletionItem } from 'vscode-languageserver-types';
-import { ProfileId, SdkPredefinedProfile, SdkVariable, SdkValueVariable, SdkDictionaryVariable, SdkVariableType } from './profile-types';
-/**
- * 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[];
+import type { BundleType } from "./schema-types/common.js";
+import type { CompletionItem } from "vscode-languageserver-types";
+
+export { type CompletionItem } from "vscode-languageserver-types";
+
+/** Represents an api category and its items */
+export 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;
+
+export 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 constant in the arcade api. */
+export 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 a function in the arcade api */
+export 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;
+  };
+  /**
+   * Indicates whether invoking this function consumes credits.
+   * Used by the editor to drive UX.
+   */
+  consumesCredits?: boolean;
 }
-/**
- * Represents an item in the arcade api.
- */
-type SdkItem = SdkConstant | SdkFunction | SdkFunction[];
-export type { CompletionItem, ProfileId, BundleType, SdkPredefinedProfile, SdkVariable, SdkValueVariable, SdkDictionaryVariable, SdkVariableType, SdkCategory, SdkItem, SdkItemBase, SdkConstant, SdkFunction, };
+
+/** Represents an item in the arcade api. */
+export type SdkItem = SdkConstant | SdkFunction | SdkFunction[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/languages-sdk-spec",
-  "version": "5.2.0-next.13",
+  "version": "5.2.0-next.130",
   "description": "ArcGIS languages types and schemas for design a language sdk",
   "homepage": "https://developers.arcgis.com/javascript/latest/",
   "type": "module",
@@ -10,7 +10,8 @@
   "exports": {
     ".": "./dist/index.js",
     "./scripting": "./dist/scripting/index.js",
-    "./dist/schemas/*.schema.json": "./dist/schemas/*.schema.json"
+    "./dist/schemas/*.schema.json": "./dist/schemas/*.schema.json",
+    "./package.json": "./package.json"
   },
   "files": [
     "dist/"