@arcgis/languages-sdk-spec 4.33.0-next.98 → 4.34.0-next.0

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

@@ -2,12 +2,22 @@ import { BaseSchemaApiItem, GenericSchemaItemBase, BaseSchemaApiFunction, BaseSc
 /**
  * Supported function bundles
  */
-export type ArcadeBundleType = "core" | "data-access" | "database" | "geometry" | "knowledge-graph" | "portal-access" | "track";
+export type ArcadeBundleType = "ai" | "core" | "data-access" | "database" | "geometry" | "knowledge-graph" | "portal-access" | "track";
 /**
  * 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<Text>" | "Array<Time>" | "Attachment" | "Boolean" | "Date" | "DateOnly" | "Dictionary" | "Extent" | "Feature" | "FeatureSet" | "FeatureSetCollection" | "Function" | "Geometry" | "KnowledgeGraph" | "Multipoint" | "Null" | "Number" | "Point" | "Polygon" | "Polyline" | "Portal" | "Text" | "Time" | "Voxel";
 export type ArcadeSchemaItemBase = GenericSchemaItemBase<ArcadeBundleType, ArcadeProfileType>;
-export type ArcadeApiItem = BaseSchemaApiItem<ArcadeBundleType, ArcadeProfileType>;
-export type ArcadeApiFunction = BaseSchemaApiFunction<ArcadeBundleType, ArcadeProfileType>;
+/**
+ * Definition for Arcade Api function
+ */
+export type ArcadeApiFunction = BaseSchemaApiFunction<ArcadeBundleType, ArcadeProfileType, ArcadeValueType>;
+/**
+ * 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>;

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

@@ -1,4 +1,7 @@
-import { BundleType, ProfileType } from './common';
+import { ArcadeApiConstant, SchemaApiFunction } from '.';
+import { BundleType, ProfileType, SchemaValueType } from './common';
+import { SqlApiFunction } from './sql';
+import { ArcadeApiFunction } from './arcade';
 /**
  * Definition for a schema category
  */
@@ -8,10 +11,6 @@ export interface SchemaCategory {
     page: string;
     hideSummaryList?: boolean;
 }
-/**
- * The collection of supported types.
- */
-export type SchemaValueType = "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<Text>" | "Array<Time>" | "Attachment" | "Boolean" | "Date" | "DateOnly" | "Dictionary" | "Extent" | "Feature" | "FeatureSet" | "FeatureSetCollection" | "Function" | "Geometry" | "KnowledgeGraph" | "Multipoint" | "Null" | "Number" | "Point" | "Polygon" | "Polyline" | "Portal" | "Text" | "Time" | "Voxel";
 export interface GenericSchemaItemBase<Bundle extends BundleType, Profile extends ProfileType> {
     /**
      * The name of the function or constant. Must start with a capital letter.
@@ -66,28 +65,28 @@ export interface BaseSchemaApiConstant<Bundle extends BundleType = BundleType, P
      */
     isConstant: true;
 }
-export type SchemaReturnValue = SchemaReturnDefinition | SchemaValueType | SchemaValueType[];
+export type SchemaReturnValue<ValueType extends SchemaValueType = SchemaValueType> = SchemaReturnDefinition<ValueType> | ValueType | ValueType[];
 /**
  * Describes an Api Function.
  */
-export interface BaseSchemaApiFunction<Bundle extends BundleType, Profile extends ProfileType> extends GenericSchemaItemBase<Bundle, Profile> {
+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?: false;
+    isConstant?: boolean;
     /**
      * The set of function parameters.
      */
-    parameters?: SchemaProperty[];
+    parameters?: SchemaProperty<ValueType>[];
     /**
      * The type of data returned by the function.
      */
-    returnValue?: SchemaReturnValue;
+    returnValue?: SchemaReturnValue<ValueType>;
 }
 /**
  * Describes the properties for the type Property
  */
-export interface SchemaProperty {
+export interface SchemaProperty<ValueType extends SchemaValueType = SchemaValueType> {
     /**
      * The name of the property.
      * @pattern ^([a-z]+[a-zA-Z0-9_]*|\[.*\])$
@@ -96,7 +95,7 @@ export interface SchemaProperty {
     /**
      * The data type of the property value. If the property supports more than one type then use an array.
      */
-    type: SchemaValueType | SchemaValueType[];
+    type: ValueType | ValueType[];
     /**
      * The description for the property.
      */
@@ -108,16 +107,16 @@ export interface SchemaProperty {
     /**
      * The properties if the type is Dictionary.
      */
-    properties?: SchemaProperty[];
+    properties?: SchemaProperty<ValueType>[];
 }
 /**
  * Describes the type fo data returned by a function.
  */
-export interface SchemaReturnDefinition {
+export interface SchemaReturnDefinition<T extends SchemaValueType = SchemaValueType> {
     /**
      * The data type of the value returned.
      */
-    type: SchemaValueType;
+    type: T;
     /**
      * A description for for the value returned.
      */
@@ -125,7 +124,7 @@ export interface SchemaReturnDefinition {
     /**
      * The properties if the type returned is a Dictionary
      */
-    properties?: SchemaProperty[];
+    properties?: SchemaProperty<T>[];
 }
 /**
  * Describes an example
@@ -156,9 +155,9 @@ export interface SchemaResourceLink {
 /**
  * Definition for simple item
  */
-export type SchemaSimpleApiItem<Bundle extends BundleType = BundleType, Profile extends ProfileType = ProfileType> = BaseSchemaApiConstant<Bundle, Profile> | BaseSchemaApiFunction<Bundle, Profile>;
+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<Bundle extends BundleType, Profile extends ProfileType = ProfileType> = BaseSchemaApiFunction<Bundle, Profile>[] | SchemaSimpleApiItem<Bundle, Profile>;
+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,5 +1,5 @@
-import { ArcadeBundleType, ArcadeProfileType } from './arcade';
-import { SqlBundleType, SqlProfileType } from './sql';
+import { ArcadeBundleType, ArcadeProfileType, ArcadeValueType } from './arcade';
+import { SqlBundleType, SqlProfileType, SqlValueType } from './sql';
 /**
  * Union of bundle types that can be used in any sdk schema
  */
@@ -8,3 +8,7 @@ export type BundleType = ArcadeBundleType | SqlBundleType;
  * 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;

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

@@ -1,5 +1,10 @@
 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
  */

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

@@ -2,20 +2,54 @@ import { BaseSchemaApiFunction, BaseSchemaApiItem, GenericSchemaItemBase } from
 /**
  * Supported function bundles
  */
-export type SqlBundleType = "core";
+export type SqlBundleType = "date" | "numeric" | "string";
 /**
  * Supported sql profile names
  */
 export type SqlProfileType = "Field Calculation";
+export type SqlValueType = "Datetime" | "Number" | "String";
 /**
  * Narrowed schema item type for sql
  */
 export type SqlSchemaItemBase = GenericSchemaItemBase<SqlBundleType, SqlProfileType>;
 /**
- * Narrowed api item type for sql
+ * Narrowed api function type for sql
  */
-export type SqlApiItem = BaseSchemaApiItem<SqlBundleType, SqlProfileType>;
+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
+ * 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
  */
-export type SqlApiFunction = BaseSchemaApiFunction<SqlBundleType, SqlProfileType>;
+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 {};