@arcgis/languages-sdk-spec 4.32.0-next.82

package/LICENSE.md

@@ -0,0 +1,13 @@
+# Licensing
+
+COPYRIGHT © 2024 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), 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 http://www.esri.com/legal/pdfs/mla_e204_e300/english
+
+For additional information, contact: Environmental Systems Research Institute, Inc. Attn: Contracts and Legal Services Department 380 New York Street Redlands, California, USA 92373 USA
+
+email: contracts@esri.com

package/README.md

@@ -0,0 +1,21 @@
+# ArcGIS Maps SDK for JavaScript - Languages SDK Spec
+
+**No Esri Technical Support included.**
+
+Package that is part of the [ArcGIS Maps SDK for JavaScript](https://developers.arcgis.com/javascript).
+
+It is not intended to be used directly, but rather used as a dependency by other packages in the SDK.
+
+## License
+
+COPYRIGHT © 2024 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), 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 <http://www.esri.com/legal/pdfs/mla_e204_e300/english>
+
+For additional information, contact: Environmental Systems Research Institute, Inc. Attn: Contracts and Legal Services Department 380 New York Street Redlands, California, USA 92373 USA
+
+email: contracts@esri.com

package/dist/index.d.ts

@@ -0,0 +1,422 @@
+import { CompletionItem } from 'vscode-languageserver-types';
+export { CompletionItem } from 'vscode-languageserver-types';
+
+/**
+ * Supported function bundles
+ */
+type SqlBundleType = "core";
+/**
+ * Supported sql profile names
+ */
+type SqlProfileType = "Field Calculation";
+/**
+ * Narrowed schema item type for sql
+ */
+type SqlSchemaItemBase = GenericSchemaItemBase<SqlBundleType, SqlProfileType>;
+/**
+ * Narrowed api item type for sql
+ */
+type SqlApiItem = BaseSchemaApiItem<SqlBundleType, SqlProfileType>;
+/**
+ * Narrowed api function type for sql
+ */
+type SqlApiFunction = BaseSchemaApiFunction<SqlBundleType, SqlProfileType>;
+
+/**
+ * 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.
+ */
+/**
+ * Union of bundle types that can be used in any sdk schema
+ */
+type BundleType = ArcadeBundleType | SqlBundleType;
+/**
+ * Union of profile types that can be used in any sdk schema
+ */
+type ProfileType = ArcadeProfileType | SqlProfileType;
+
+/**
+ * Definition for a schema category
+ */
+interface SchemaCategory {
+    title: string;
+    description: string[] | string;
+    page: string;
+    hideSummaryList?: boolean;
+}
+/**
+ * The collection of supported types.
+ */
+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";
+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[];
+}
+/**
+ * Describes an Api Constant
+ */
+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;
+}
+type SchemaReturnValue = SchemaReturnDefinition | SchemaValueType | SchemaValueType[];
+/**
+ * Describes an Api Function.
+ */
+interface BaseSchemaApiFunction<Bundle extends BundleType, Profile extends ProfileType> extends GenericSchemaItemBase<Bundle, Profile> {
+    /**
+     * For function this property is optional and always false.
+     */
+    isConstant?: false;
+    /**
+     * The set of function parameters.
+     */
+    parameters?: SchemaProperty[];
+    /**
+     * The type of data returned by the function.
+     */
+    returnValue?: SchemaReturnValue;
+}
+/**
+ * Describes the properties for the type Property
+ */
+interface SchemaProperty {
+    /**
+     * 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: SchemaValueType | SchemaValueType[];
+    /**
+     * 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[];
+}
+/**
+ * Describes the type fo data returned by a function.
+ */
+interface SchemaReturnDefinition {
+    /**
+     * The data type of the value returned.
+     */
+    type: SchemaValueType;
+    /**
+     * A description for for the value returned.
+     */
+    description?: string[] | string;
+    /**
+     * The properties if the type returned is a Dictionary
+     */
+    properties?: SchemaProperty[];
+}
+/**
+ * Describes an example
+ */
+interface SchemaExample {
+    /**
+     * 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
+ */
+interface SchemaResourceLink {
+    /**
+     * The text used to describe the resource link.
+     */
+    linkText: string;
+    /**
+     * The url to the resource.
+     */
+    url: string;
+}
+/**
+ * Definition for simple item
+ */
+type SchemaSimpleApiItem<Bundle extends BundleType = BundleType, Profile extends ProfileType = ProfileType> = BaseSchemaApiConstant<Bundle, Profile> | BaseSchemaApiFunction<Bundle, Profile>;
+/**
+ * Definition for a constant or a function.
+ * An Api Item can be either a constant, a function, or an array of functions
+ */
+type BaseSchemaApiItem<Bundle extends BundleType, Profile extends ProfileType = ProfileType> = BaseSchemaApiFunction<Bundle, Profile>[] | SchemaSimpleApiItem<Bundle, Profile>;
+
+/**
+ * Supported function bundles
+ */
+type ArcadeBundleType = "core" | "data-access" | "database" | "geometry" | "knowledge-graph" | "portal-access" | "track";
+/**
+ * The profile names this definition belongs to
+ */
+type ArcadeProfileType = "Attribute Rule Calculation" | "Attribute Rules" | "Dashboard Data" | "Field Calculation" | "Form Calculation" | "GeoAnalytics" | "Popups" | "Tasks" | "Velocity";
+type ArcadeSchemaItemBase = GenericSchemaItemBase<ArcadeBundleType, ArcadeProfileType>;
+type ArcadeApiItem = BaseSchemaApiItem<ArcadeBundleType, ArcadeProfileType>;
+type ArcadeApiFunction = BaseSchemaApiFunction<ArcadeBundleType, ArcadeProfileType>;
+
+/**
+ * Describes a profile
+ */
+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[];
+}
+/**
+ * Supported profile variable types
+ */
+type SdkVariableType = "array" | "boolean" | "date" | "dateOnly" | "dictionary" | "feature" | "featureSet" | "featureSetCollection" | "geometry" | "knowledgeGraph" | "number" | "text" | "time";
+/**
+ * Describes variables
+ */
+interface SdkVariableBase {
+    /**
+     * 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.)
+ */
+interface SdkValueVariable extends SdkVariableBase {
+    type: Exclude<SdkVariableType, "dictionary">;
+}
+/**
+ * A dictionary variable
+ */
+interface SdkDictionaryVariable extends SdkVariableBase {
+    type: "dictionary";
+    properties: SdkVariable[];
+}
+/**
+ * Profile variable
+ */
+type SdkVariable = SdkDictionaryVariable | SdkValueVariable;
+
+/**
+ * The list of supported profiles
+ */
+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" | "feature-display-title" | "feature-z" | "field-calculation" | "field-mapping" | "form-calculation" | "form-constraint" | "geoanalytics" | "geotrigger-notification" | "labeling" | "layout" | "location-update-constraint" | "measure-visualization" | "minimalist" | "model-builder" | "popup-element-feature-reduction" | "popup-element" | "popup-feature-reduction" | "popup" | "quick-capture" | "tasks" | "velocity" | "visualization";
+/**
+ * The predefined profiles for the Arcade language
+ */
+type ArcadeSdkPredefinedProfile = BaseSdkPredefinedProfile<ArcadeProfileId, ArcadeBundleType>;
+type ArcadeSdkPredefinedProfiles = BaseSdkPredefinedProfile<ArcadeProfileId, ArcadeBundleType>[];
+
+/**
+ * The list of supported profiles
+ */
+type SqlProfileId = "field-calculation";
+/**
+ * The predefined profiles for the SQL language
+ */
+type SqlSdkPredefinedProfile = BaseSdkPredefinedProfile<SqlProfileId, SqlBundleType>;
+type SqlSdkPredefinedProfiles = BaseSdkPredefinedProfile<SqlProfileId, SqlBundleType>[];
+
+type SdkPredefinedProfile = ArcadeSdkPredefinedProfile | SqlSdkPredefinedProfile;
+type SdkPredefinedProfiles = SdkPredefinedProfile[];
+/**
+ * A union of all language profile ids
+ */
+type ProfileId = ArcadeProfileId | SqlProfileId;
+
+/**
+ * Union of API items that can be used in any sdk schema
+ */
+type SchemaApiItem = ArcadeApiItem | SqlApiItem;
+/**
+ * Union of API functions that can be used in any sdk schema
+ */
+type SchemaApiFunction = ArcadeApiFunction | SqlApiFunction;
+/**
+ * Union of schema items that can be used in any sdk schema
+ */
+type SchemaItemBase = ArcadeSchemaItemBase | SqlSchemaItemBase;
+
+/**
+ * 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[];
+}
+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 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 an item in the arcade api.
+ */
+type SdkItem = SdkConstant | SdkFunction | SdkFunction[];
+
+interface T9NApiRoot {
+    resources: Record<string, string>;
+    categories: T9NCategories;
+}
+type T9NCategories = Record<string, T9NCategory>;
+interface T9NCategory {
+    title: string;
+    description?: Record<string, string>;
+    items: T9NApiItems;
+}
+type T9NResource = Record<string, string>;
+type T9NApiItems = Record<string, Record<string, T9NApiItem> | T9NApiItem>;
+interface T9NProperty {
+    description?: Record<string, string>;
+    properties?: Record<string, T9NProperty>;
+}
+interface T9NApiItem {
+    description: Record<string, string>;
+    examples?: Record<string, Record<string, string>>;
+    parameters?: Record<string, T9NProperty>;
+    returnValue?: T9NProperty;
+}
+type T9NProfiles = Record<string, T9NProfileVariables>;
+type T9NProfileVariables = Record<string, T9NProfileVariable>;
+interface T9NProfileVariable {
+    description?: string;
+    properties?: T9NProfileVariables;
+}
+
+export type { ArcadeProfileId, ArcadeSdkPredefinedProfile, ArcadeSdkPredefinedProfiles, BaseSchemaApiConstant, BaseSchemaApiFunction, BaseSchemaApiItem, BaseSdkPredefinedProfile, BundleType, GenericSchemaItemBase, ProfileId, ProfileType, SchemaApiFunction, SchemaApiItem, SchemaCategory, SchemaExample, SchemaItemBase, SchemaProperty, SchemaResourceLink, SchemaReturnDefinition, SchemaReturnValue, SchemaSimpleApiItem, SchemaValueType, SdkCategory, SdkConstant, SdkDictionaryVariable, SdkFunction, SdkItem, SdkItemBase, SdkPredefinedProfile, SdkPredefinedProfiles, SdkValueVariable, SdkVariable, SdkVariableBase, SdkVariableType, SqlProfileId, SqlSdkPredefinedProfile, SqlSdkPredefinedProfiles, T9NApiItem, T9NApiItems, T9NApiRoot, T9NCategories, T9NCategory, T9NProfileVariable, T9NProfileVariables, T9NProfiles, T9NProperty, T9NResource };

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

@@ -0,0 +1,40 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/SchemaCategory",
+  "definitions": {
+    "SchemaCategory": {
+      "type": "object",
+      "properties": {
+        "title": {
+          "type": "string"
+        },
+        "description": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "string"
+            }
+          ]
+        },
+        "page": {
+          "type": "string"
+        },
+        "hideSummaryList": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "title",
+        "description",
+        "page"
+      ],
+      "additionalProperties": false,
+      "description": "Definition for a schema category"
+    }
+  }
+}