@arcgis/languages-sdk-spec 5.2.0-next.15 → 5.2.0-next.151

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
- */
-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
- */
+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" | "form-dynamic-choice" | "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 */
 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;