@arcgis/languages-sdk-spec 5.2.0-next.12 → 5.2.0-next.120

package/LICENSE.md

@@ -1,12 +1,14 @@
 # Licensing
 
-COPYRIGHT © Esri
+COPYRIGHT 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)](https://www.esri.com/content/dam/esrisites/en-us/media/legal/ma-full/ma-full.pdf), and is bound by the terms of that agreement.
+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 https://www.esri.com/content/dam/esrisites/en-us/media/legal/ma-full/ma-full.pdf.
+
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department

package/README.md

@@ -8,5 +8,5 @@ It is not intended to be used directly, but rather used as a dependency by other
 
 ## License
 
-This package is licensed under the terms described in the `LICENSE.md` file, located in the root of the package, and at https://js.arcgis.com/5.1/LICENSE.txt.
-For third party notices, see https://js.arcgis.com/5.1/third-party-notices.txt.
+This package is licensed under the terms described in the `LICENSE.md` file, located in the root of the package, and at https://js.arcgis.com/5.2/LICENSE.txt.
+For third party notices, see https://js.arcgis.com/5.2/third-party-notices.txt.

package/dist/index.d.ts

@@ -1,4 +1,6 @@
-export type * from './profile-types';
-export type * from './schema-types';
-export type * from './types';
-export type * from './t9n-types';
+export type * from "./profile-types/index.js";
+export type * from "./schema-types/index.js";
+export type * from "./types.js";
+export type * from "./t9n-types.js";
+export type * from "./runtimes/arcade.js";
+

package/dist/profile-types/arcade-profiles-types.d.ts

@@ -1,11 +1,10 @@
-import { ArcadeBundleType } from '../schema-types/arcade';
-import { BaseSdkPredefinedProfile } from './base';
-/**
- * The list of supported profiles
- */
+import type { ArcadeBundleType } from "../schema-types/arcade.js";
+import type { BaseSdkPredefinedProfile } from "./base.js";
+
+/** The list of supported profiles */
 export 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" | "experience-builder-data" | "experience-builder-dynamic-value" | "experience-builder-list-item-widget-formatting" | "experience-builder-widget-formatting" | "feature-display-title" | "feature-z" | "field-calculation" | "field-mapping" | "form-attachment-filename-calculation" | "form-calculation" | "form-constraint" | "geoanalytics" | "geotrigger-notification" | "labeling" | "layout" | "location-update-constraint" | "measure-visualization" | "minimalist" | "model-builder" | "popup-element-feature-reduction" | "popup-element-imagery" | "popup-element-voxel" | "popup-element" | "popup-feature-reduction" | "popup-imagery" | "popup-voxel" | "popup" | "quick-capture" | "tasks" | "velocity" | "visualization";
-/**
- * The predefined profiles for the Arcade language
- */
+
+/** The predefined profiles for the Arcade language */
 export type ArcadeSdkPredefinedProfile = BaseSdkPredefinedProfile<ArcadeProfileId, ArcadeBundleType>;
-export type ArcadeSdkPredefinedProfiles = BaseSdkPredefinedProfile<ArcadeProfileId, ArcadeBundleType>[];
+
+export type ArcadeSdkPredefinedProfiles = BaseSdkPredefinedProfile<ArcadeProfileId, ArcadeBundleType>[];

package/dist/profile-types/base.d.ts

@@ -1,59 +1,38 @@
-/**
- * Describes a profile
- */
+/** Describes a profile */
 export 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[];
+  /** 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
- */
+
+/** Supported profile variable types */
 export type SdkVariableType = "array" | "boolean" | "dataCatalogDatastore" | "date" | "dateOnly" | "dictionary" | "feature" | "featureSet" | "featureSetCollection" | "geometry" | "knowledgeGraph" | "number" | "pixel" | "text" | "time" | "voxel";
-/**
- * Describes variables
- */
+
+/** Describes variables */
 export interface SdkVariableBase {
-    /**
-     * Name of the variable.
-     */
-    name: string;
-    /**
-     * Type of the variable.
-     */
-    type: SdkVariableType;
-    /**
-     * Description of the variable.
-     */
-    description?: string;
+  /** 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.)
- */
+
+/** A variable that represents a simple type (boolean, number, feature, etc.) */
 export interface SdkValueVariable extends SdkVariableBase {
-    type: Exclude<SdkVariableType, "dictionary">;
+  type: Exclude<SdkVariableType, "dictionary">;
 }
-/**
- * A dictionary variable
- */
+
+/** A dictionary variable */
 export interface SdkDictionaryVariable extends SdkVariableBase {
-    type: "dictionary";
-    properties: SdkVariable[];
+  type: "dictionary";
+  properties: SdkVariable[];
 }
-/**
- * Profile variable
- */
-export type SdkVariable = SdkDictionaryVariable | SdkValueVariable;
+
+/** Profile variable */
+export type SdkVariable = SdkDictionaryVariable | SdkValueVariable;

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

@@ -1,11 +1,14 @@
-import { ArcadeSdkPredefinedProfile, ArcadeProfileId } from './arcade-profiles-types';
-import { SqlSdkPredefinedProfile, SqlProfileId } from './sql-profile-types';
+import type { ArcadeSdkPredefinedProfile, ArcadeProfileId } from "./arcade-profiles-types.js";
+import type { SqlSdkPredefinedProfile, SqlProfileId } from "./sql-profile-types.js";
+
+export type * from "./base.js";
+export type * from "./arcade-profiles-types.js";
+export type * from "./sql-profile-types.js";
+
+/** A union of all language predefined profiles */
 export type SdkPredefinedProfile = ArcadeSdkPredefinedProfile | SqlSdkPredefinedProfile;
+
 export type SdkPredefinedProfiles = SdkPredefinedProfile[];
-/**
- * A union of all language profile ids
- */
-export type ProfileId = ArcadeProfileId | SqlProfileId;
-export type * from './base';
-export type * from './arcade-profiles-types';
-export type * from './sql-profile-types';
+
+/** A union of all language profile ids */
+export type ProfileId = ArcadeProfileId | SqlProfileId;

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

@@ -1,11 +1,10 @@
-import { SqlBundleType } from '../schema-types/sql';
-import { BaseSdkPredefinedProfile } from './base';
-/**
- * The list of supported profiles
- */
+import type { SqlBundleType } from "../schema-types/sql.js";
+import type { BaseSdkPredefinedProfile } from "./base.js";
+
+/** The list of supported profiles */
 export type SqlProfileId = "field-calculation" | "where-clause";
-/**
- * The predefined profiles for the SQL language
- */
+
+/** The predefined profiles for the SQL language */
 export type SqlSdkPredefinedProfile = BaseSdkPredefinedProfile<SqlProfileId, SqlBundleType>;
-export type SqlSdkPredefinedProfiles = BaseSdkPredefinedProfile<SqlProfileId, SqlBundleType>[];
+
+export type SqlSdkPredefinedProfiles = BaseSdkPredefinedProfile<SqlProfileId, SqlBundleType>[];

package/dist/runtimes/arcade.d.ts

@@ -0,0 +1,120 @@
+export const proRuntimes: readonly [
+    "pro_3.8",
+    "pro_3.7",
+    "pro_3.6",
+    "pro_3.5",
+    "pro_3.4",
+    "pro_3.3",
+    "pro_3.2",
+    "pro_3.1",
+    "pro_3.0",
+    "pro_2.9",
+    "pro_2.8",
+    "pro_2.7",
+    "pro_2.6",
+    "pro_2.5",
+    "pro_2.4",
+    "pro_2.3",
+    "pro_2.2",
+    "pro_2.1",
+    "pro_2.0",
+    "pro_1.4"
+];
+
+export const jsSdkRuntimes: readonly [
+    "jsSdk_5.2",
+    "jsSdk_5.1",
+    "jsSdk_5.0",
+    "jsSdk_4.34",
+    "jsSdk_4.33",
+    "jsSdk_4.32",
+    "jsSdk_4.31",
+    "jsSdk_4.30",
+    "jsSdk_4.29",
+    "jsSdk_4.28",
+    "jsSdk_4.27",
+    "jsSdk_4.26",
+    "jsSdk_4.25",
+    "jsSdk_4.24",
+    "jsSdk_4.23",
+    "jsSdk_4.22",
+    "jsSdk_4.21",
+    "jsSdk_4.20",
+    "jsSdk_4.19",
+    "jsSdk_4.18",
+    "jsSdk_4.17",
+    "jsSdk_4.16",
+    "jsSdk_4.15",
+    "jsSdk_4.14",
+    "jsSdk_4.13",
+    "jsSdk_4.12",
+    "jsSdk_4.11",
+    "jsSdk_4.10",
+    "jsSdk_4.9",
+    "jsSdk_4.8",
+    "jsSdk_4.7",
+    "jsSdk_4.6",
+    "jsSdk_4.5",
+    "jsSdk_4.4",
+    "jsSdk_4.3",
+    "jsSdk_4.2",
+    "jsSdk_4.1",
+    "jsSdk_4.0",
+    "jsSdk_3.43",
+    "jsSdk_3.42",
+    "jsSdk_3.41",
+    "jsSdk_3.40",
+    "jsSdk_3.39",
+    "jsSdk_3.38",
+    "jsSdk_3.37",
+    "jsSdk_3.36",
+    "jsSdk_3.35",
+    "jsSdk_3.34",
+    "jsSdk_3.33",
+    "jsSdk_3.32",
+    "jsSdk_3.31",
+    "jsSdk_3.30",
+    "jsSdk_3.29",
+    "jsSdk_3.28",
+    "jsSdk_3.27",
+    "jsSdk_3.26",
+    "jsSdk_3.25",
+    "jsSdk_3.24",
+    "jsSdk_3.23",
+    "jsSdk_3.22",
+    "jsSdk_3.21",
+    "jsSdk_3.20",
+    "jsSdk_3.19"
+];
+
+export const nativeAppsRuntimes: readonly [
+    "nativeApps_300.1",
+    "nativeApps_300.0",
+    "nativeApps_200.8",
+    "nativeApps_200.7",
+    "nativeApps_200.6",
+    "nativeApps_200.5",
+    "nativeApps_200.4",
+    "nativeApps_200.3",
+    "nativeApps_200.2",
+    "nativeApps_200.1",
+    "nativeApps_200",
+    "nativeApps_100.15",
+    "nativeApps_100.14",
+    "nativeApps_100.13",
+    "nativeApps_100.12",
+    "nativeApps_100.11",
+    "nativeApps_100.10",
+    "nativeApps_100.9",
+    "nativeApps_100.8",
+    "nativeApps_100.7",
+    "nativeApps_100.6",
+    "nativeApps_100.5",
+    "nativeApps_100.4",
+    "nativeApps_100.3",
+    "nativeApps_100.2",
+    "nativeApps_100.1",
+    "nativeApps_100"
+];
+
+export type ArcadeRuntime = (typeof jsSdkRuntimes)[number] | (typeof nativeAppsRuntimes)[number] | (typeof proRuntimes)[number];

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

@@ -1,23 +1,20 @@
-import { BaseSchemaApiItem, GenericSchemaItemBase, BaseSchemaApiFunction, BaseSchemaApiConstant } from './base';
-/**
- * Supported function bundles
- */
+import type { BaseSchemaApiItem, GenericSchemaItemBase, BaseSchemaApiFunction, BaseSchemaApiConstant } from "./base.js";
+
+/** Supported function bundles */
 export type ArcadeBundleType = "ai" | "core" | "data-access" | "database" | "geometry" | "knowledge-graph" | "portal-access" | "track";
-/**
- * The profile names this definition belongs to
- */
+
+/** The profile names this definition belongs to */
 export type ArcadeProfileType = "Attribute Rule Calculation" | "Attribute Rules" | "Dashboard Data" | "Field Calculation" | "Form Calculation" | "GeoAnalytics" | "Popups" | "Tasks" | "Velocity";
+
 export type ArcadeValueType = "Any" | "Array<Any>" | "Array<Attachment>" | "Array<Boolean>" | "Array<Date>" | "Array<DateOnly>" | "Array<Dictionary>" | "Array<Extent>" | "Array<Feature>" | "Array<Geometry>" | "Array<KnowledgeGraph>" | "Array<Multipoint>" | "Array<Number>" | "Array<Number|Text>" | "Array<Point>" | "Array<Polygon>" | "Array<Polyline>" | "Array<Portal>" | "Array<Text>" | "Array<Time>" | "Attachment" | "Boolean" | "Date" | "DateOnly" | "Dictionary" | "Extent" | "Feature" | "FeatureSet" | "FeatureSetCollection" | "Function" | "Geometry" | "KnowledgeGraph" | "Multipoint" | "Null" | "Number" | "Pixel" | "Point" | "Polygon" | "Polyline" | "Portal" | "Text" | "Time" | "Voxel";
+
 export type ArcadeSchemaItemBase = GenericSchemaItemBase<ArcadeBundleType, ArcadeProfileType>;
-/**
- * Definition for Arcade Api function
- */
+
+/** Definition for Arcade Api function */
 export type ArcadeApiFunction = BaseSchemaApiFunction<ArcadeBundleType, ArcadeProfileType, ArcadeValueType>;
-/**
- * Definition for Arcade Api constant
- */
+
+/** Definition for Arcade Api constant */
 export type ArcadeApiConstant = BaseSchemaApiConstant<ArcadeBundleType, ArcadeProfileType>;
-/**
- * Arcade Api Item can be either a constant, a function, or an array of functions
- */
-export type ArcadeApiItem = BaseSchemaApiItem<ArcadeApiFunction, ArcadeApiConstant>;
+
+/** Arcade Api Item can be either a constant, a function, or an array of functions */
+export type ArcadeApiItem = BaseSchemaApiItem<ArcadeApiFunction, ArcadeApiConstant>;

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

@@ -1,163 +1,116 @@
-import { ArcadeApiConstant, SchemaApiFunction } from '.';
-import { BundleType, ProfileType, SchemaValueType } from './common';
-import { SqlApiFunction } from './sql';
-import { ArcadeApiFunction } from './arcade';
-/**
- * Definition for a schema category
- */
+import type { ArcadeApiConstant, ArcadeApiFunction } from "./arcade.js";
+import type { SchemaApiFunction } from "./index.js";
+import type { BundleType, ProfileType, SchemaValueType } from "./common.js";
+import type { SqlApiFunction } from "./sql.js";
+
+/** Definition for a schema category */
 export interface SchemaCategory {
-    title: string;
-    description: string[] | string;
-    page: string;
-    hideSummaryList?: boolean;
+  title: string;
+  description: string[] | string;
+  page: string;
+  hideSummaryList?: boolean;
 }
+
 export interface GenericSchemaItemBase<Bundle extends BundleType, Profile extends ProfileType> {
-    /**
-     * The name of the function or constant. Must start with a capital letter.
-     * @pattern ^[A-Z]+[a-zA-Z0-9.]*$
-     */
-    name: string;
-    /**
-     * A nice description for the constant or function. It can leverage Github Flavored Markdown formatting.
-     */
-    description: string[] | string;
-    /**
-     * Version string. Format x.y.
-     * @pattern ^1\.\d+$
-     */
-    sinceVersion?: string;
-    /**
-     * Indicates if the item should not be documented.
-     */
-    disableDocumentation?: boolean;
-    /**
-     * The profiles the constant or the function belongs to.
-     */
-    profiles?: Profile[];
-    /**
-     * The bundle the constant or the function belongs to.
-     */
-    bundle: Bundle;
-    /**
-     * The relative path to an image to illustate the constant or the function.
-     */
-    image?: string;
-    /**
-     * 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.
-     * @pattern ^[A-Z]+.*$
-     */
-    snippet: string;
-    /**
-     * The collection of examples
-     */
-    examples?: SchemaExample[];
-    /**
-     * A collection of links to resources
-     */
-    resourceLinks?: SchemaResourceLink[];
+  /**
+   * The name of the function or constant. Must start with a capital letter.
+   *
+   * @pattern ^[A-Z]+[a-zA-Z0-9.]*$
+   */
+  name: string;
+  /**
+   * Version string. Format x.y.
+   *
+   * @pattern ^1\.\d+$
+   */
+  sinceVersion?: string;
+  /** Indicates if the item should not be documented. */
+  disableDocumentation?: boolean;
+  /** The profiles the constant or the function belongs to. */
+  profiles?: Profile[];
+  /** The bundle the constant or the function belongs to. */
+  bundle: Bundle;
+  /** The relative path to an image to illustate the constant or the function. */
+  image?: string;
+  /**
+   * 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]+.*$
+   */
+  snippet: string;
+  /** The collection of examples */
+  examples?: SchemaExample[];
+  /** A collection of links to resources */
+  resourceLinks?: SchemaResourceLink[];
 }
-/**
- * Describes an Api Constant
- */
+
+/** Describes an Api Constant */
 export interface BaseSchemaApiConstant<Bundle extends BundleType = BundleType, Profile extends ProfileType = ProfileType> extends GenericSchemaItemBase<Bundle, Profile> {
-    /**
-     * For constant, the property is mandatory and always true
-     */
-    isConstant: true;
+  /** For constant, the property is mandatory and always true */
+  isConstant: true;
 }
+
 export type SchemaReturnValue<ValueType extends SchemaValueType = SchemaValueType> = SchemaReturnDefinition<ValueType> | ValueType | ValueType[];
-/**
- * Describes an Api Function.
- */
+
+/** Describes an Api Function. */
 export interface BaseSchemaApiFunction<Bundle extends BundleType, Profile extends ProfileType, ValueType extends SchemaValueType> extends GenericSchemaItemBase<Bundle, Profile> {
-    /**
-     * For function this property is optional and always false.
-     */
-    isConstant?: boolean;
-    /**
-     * The set of function parameters.
-     */
-    parameters?: SchemaProperty<ValueType>[];
-    /**
-     * The type of data returned by the function.
-     */
-    returnValue?: SchemaReturnValue<ValueType>;
+  /** For function this property is optional and always false. */
+  isConstant?: boolean;
+  /** The set of function parameters. */
+  parameters?: SchemaProperty<ValueType>[];
+  /** The type of data returned by the function. */
+  returnValue?: SchemaReturnValue<ValueType>;
 }
-/**
- * Describes the properties for the type Property
- */
+
+/** Describes the properties for the type Property */
 export interface SchemaProperty<ValueType extends SchemaValueType = SchemaValueType> {
-    /**
-     * The name of the property.
-     * @pattern ^([a-z]+[a-zA-Z0-9_]*|\[.*\])$
-     */
-    name: string;
-    /**
-     * The data type of the property value. If the property supports more than one type then use an array.
-     */
-    type: ValueType | ValueType[];
-    /**
-     * The description for the property.
-     */
-    description: string[] | string;
-    /**
-     * Indicates if the property is optional.
-     */
-    optional?: boolean;
-    /**
-     * The properties if the type is Dictionary.
-     */
-    properties?: SchemaProperty<ValueType>[];
+  /**
+   * The name of the property.
+   *
+   * @pattern ^([a-z]+[a-zA-Z0-9_]*|\[.*\])$
+   */
+  name: string;
+  /** The data type of the property value. If the property supports more than one type then use an array. */
+  type: ValueType | ValueType[];
+  /** The description for the property. */
+  description: string[] | string;
+  /** Indicates if the property is optional. */
+  optional?: boolean;
+  /** The properties if the type is Dictionary. */
+  properties?: SchemaProperty<ValueType>[];
 }
-/**
- * Describes the type fo data returned by a function.
- */
+
+/** Describes the type fo data returned by a function. */
 export interface SchemaReturnDefinition<T extends SchemaValueType = SchemaValueType> {
-    /**
-     * The data type of the value returned.
-     */
-    type: T;
-    /**
-     * A description for for the value returned.
-     */
-    description?: string[] | string;
-    /**
-     * The properties if the type returned is a Dictionary
-     */
-    properties?: SchemaProperty<T>[];
+  /** The data type of the value returned. */
+  type: T;
+  /** A description for for the value returned. */
+  description?: string[] | string;
+  /** The properties if the type returned is a Dictionary */
+  properties?: SchemaProperty<T>[];
 }
-/**
- * Describes an example
- */
+
+/** Describes an example */
 export interface SchemaExample {
-    /**
-     * A description for the example.
-     */
-    description?: string[] | string;
-    /**
-     * Either a single line string or an array of strings.
-     */
-    code: string[] | string;
+  /** A description for the example. */
+  description?: string[] | string;
+  /** Either a single line string or an array of strings. */
+  code: string[] | string;
 }
-/**
- * Describes a link to additional resources
- */
+
+/** Describes a link to additional resources */
 export interface SchemaResourceLink {
-    /**
-     * The text used to describe the resource link.
-     */
-    linkText: string;
-    /**
-     * The url to the resource.
-     */
-    url: string;
+  /** The text used to describe the resource link. */
+  linkText: string;
+  /** The url to the resource. */
+  url: string;
 }
-/**
- * Definition for simple item
- */
+
+/** Definition for simple item */
 export type SingularApiItem = ArcadeApiConstant | ArcadeApiFunction | SqlApiFunction;
+
 /**
  * Definition for a constant or a function.
  * An Api Item can be either a constant, a function, or an array of functions
  */
-export type BaseSchemaApiItem<LanguageApiFunction extends SchemaApiFunction, LanguageApiConstant extends BaseSchemaApiConstant | undefined = undefined> = LanguageApiFunction | LanguageApiFunction[] | (LanguageApiConstant extends undefined ? never : LanguageApiConstant);
+export type BaseSchemaApiItem<LanguageApiFunction extends SchemaApiFunction, LanguageApiConstant extends BaseSchemaApiConstant | undefined = undefined> = LanguageApiFunction | LanguageApiFunction[] | (LanguageApiConstant extends undefined ? never : LanguageApiConstant);

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

@@ -1,14 +1,18 @@
-import { ArcadeBundleType, ArcadeProfileType, ArcadeValueType } from './arcade';
-import { SqlBundleType, SqlProfileType, SqlValueType } from './sql';
 /**
- * Union of bundle types that can be used in any sdk schema
+ * This file contains union types that are used to constrain
+ * base schema types. It's a bit of a chicken and egg scenario
+ * where fields in the base schema types need a reference
+ * to the language specific Bundle and Profile types, creating
+ * a bit of circular dependency. This file breaks that cycle.
  */
+import type { ArcadeBundleType, ArcadeProfileType, ArcadeValueType } from "./arcade.js";
+import type { SqlBundleType, SqlProfileType, SqlValueType } from "./sql.js";
+
+/** Union of bundle types that can be used in any sdk schema */
 export type BundleType = ArcadeBundleType | SqlBundleType;
-/**
- * Union of profile types that can be used in any sdk schema
- */
+
+/** Union of profile types that can be used in any sdk schema */
 export type ProfileType = ArcadeProfileType | SqlProfileType;
-/**
- * The collection of supported return types.
- */
-export type SchemaValueType = ArcadeValueType | SqlValueType;
+
+/** The collection of supported return types. */
+export type SchemaValueType = ArcadeValueType | SqlValueType;

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/profiles.schema.json

@@ -16,7 +16,8 @@
         {
           "$ref": "#/definitions/SqlSdkPredefinedProfile"
         }
-      ]
+      ],
+      "description": "A union of all language predefined profiles"
     },
     "ArcadeSdkPredefinedProfile": {
       "$ref": "#/definitions/BaseSdkPredefinedProfile<ArcadeProfileId,ArcadeBundleType>",

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.12",
+  "version": "5.2.0-next.120",
   "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/"