@arcgis/languages-sdk-spec 4.33.0-next.99 → 4.34.0-next.1

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

@@ -14,23 +14,31 @@
       "description": "Union of API items that can be used in any sdk schema"
     },
     "ArcadeApiItem": {
-      "$ref": "#/definitions/BaseSchemaApiItem<ArcadeBundleType,ArcadeProfileType>"
+      "$ref": "#/definitions/BaseSchemaApiItem<ArcadeApiFunction,ArcadeApiConstant>",
+      "description": "Arcade Api Item can be either a constant, a function, or an array of functions"
     },
-    "BaseSchemaApiItem<ArcadeBundleType,ArcadeProfileType>": {
+    "BaseSchemaApiItem<ArcadeApiFunction,ArcadeApiConstant>": {
       "anyOf": [
+        {
+          "$ref": "#/definitions/ArcadeApiFunction"
+        },
         {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/BaseSchemaApiFunction<ArcadeBundleType,ArcadeProfileType>"
+            "$ref": "#/definitions/ArcadeApiFunction"
           }
         },
         {
-          "$ref": "#/definitions/SchemaSimpleApiItem<ArcadeBundleType,ArcadeProfileType>"
+          "$ref": "#/definitions/ArcadeApiConstant"
         }
       ],
       "description": "Definition for a constant or a function. An Api Item can be either a constant, a function, or an array of functions"
     },
-    "BaseSchemaApiFunction<ArcadeBundleType,ArcadeProfileType>": {
+    "ArcadeApiFunction": {
+      "$ref": "#/definitions/BaseSchemaApiFunction<ArcadeBundleType,ArcadeProfileType,ArcadeValueType>",
+      "description": "Definition for Arcade Api function"
+    },
+    "BaseSchemaApiFunction<ArcadeBundleType,ArcadeProfileType,ArcadeValueType>": {
       "type": "object",
       "properties": {
         "name": {
@@ -97,18 +105,17 @@
         },
         "isConstant": {
           "type": "boolean",
-          "const": false,
           "description": "For function this property is optional and always false."
         },
         "parameters": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/SchemaProperty"
+            "$ref": "#/definitions/SchemaProperty<ArcadeValueType>"
           },
           "description": "The set of function parameters."
         },
         "returnValue": {
-          "$ref": "#/definitions/SchemaReturnValue",
+          "$ref": "#/definitions/SchemaReturnValue<ArcadeValueType>",
           "description": "The type of data returned by the function."
         }
       },
@@ -139,6 +146,7 @@
     "ArcadeBundleType": {
       "type": "string",
       "enum": [
+        "ai",
         "core",
         "data-access",
         "database",
@@ -206,7 +214,7 @@
       "additionalProperties": false,
       "description": "Describes a link to additional resources"
     },
-    "SchemaProperty": {
+    "SchemaProperty<ArcadeValueType>": {
       "type": "object",
       "properties": {
         "name": {
@@ -217,12 +225,12 @@
         "type": {
           "anyOf": [
             {
-              "$ref": "#/definitions/SchemaValueType"
+              "$ref": "#/definitions/ArcadeValueType"
             },
             {
               "type": "array",
               "items": {
-                "$ref": "#/definitions/SchemaValueType"
+                "$ref": "#/definitions/ArcadeValueType"
               }
             }
           ],
@@ -249,7 +257,7 @@
         "properties": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/SchemaProperty"
+            "$ref": "#/definitions/SchemaProperty<ArcadeValueType>"
           },
           "description": "The properties if the type is Dictionary."
         }
@@ -262,7 +270,7 @@
       "additionalProperties": false,
       "description": "Describes the properties for the type Property"
     },
-    "SchemaValueType": {
+    "ArcadeValueType": {
       "type": "string",
       "enum": [
         "Any",
@@ -306,30 +314,29 @@
         "Text",
         "Time",
         "Voxel"
-      ],
-      "description": "The collection of supported types."
+      ]
     },
-    "SchemaReturnValue": {
+    "SchemaReturnValue<ArcadeValueType>": {
       "anyOf": [
         {
-          "$ref": "#/definitions/SchemaReturnDefinition"
+          "$ref": "#/definitions/SchemaReturnDefinition<ArcadeValueType>"
         },
         {
-          "$ref": "#/definitions/SchemaValueType"
+          "$ref": "#/definitions/ArcadeValueType"
         },
         {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/SchemaValueType"
+            "$ref": "#/definitions/ArcadeValueType"
           }
         }
       ]
     },
-    "SchemaReturnDefinition": {
+    "SchemaReturnDefinition<ArcadeValueType>": {
       "type": "object",
       "properties": {
         "type": {
-          "$ref": "#/definitions/SchemaValueType",
+          "$ref": "#/definitions/ArcadeValueType",
           "description": "The data type of the value returned."
         },
         "description": {
@@ -349,7 +356,7 @@
         "properties": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/SchemaProperty"
+            "$ref": "#/definitions/SchemaProperty<ArcadeValueType>"
           },
           "description": "The properties if the type returned is a Dictionary"
         }
@@ -360,16 +367,9 @@
       "additionalProperties": false,
       "description": "Describes the type fo data returned by a function."
     },
-    "SchemaSimpleApiItem<ArcadeBundleType,ArcadeProfileType>": {
-      "anyOf": [
-        {
-          "$ref": "#/definitions/BaseSchemaApiConstant<ArcadeBundleType,ArcadeProfileType>"
-        },
-        {
-          "$ref": "#/definitions/BaseSchemaApiFunction<ArcadeBundleType,ArcadeProfileType>"
-        }
-      ],
-      "description": "Definition for simple item"
+    "ArcadeApiConstant": {
+      "$ref": "#/definitions/BaseSchemaApiConstant<ArcadeBundleType,ArcadeProfileType>",
+      "description": "Definition for Arcade Api constant"
     },
     "BaseSchemaApiConstant<ArcadeBundleType,ArcadeProfileType>": {
       "type": "object",
@@ -453,31 +453,63 @@
       "description": "Describes an Api Constant"
     },
     "SqlApiItem": {
-      "$ref": "#/definitions/BaseSchemaApiItem<SqlBundleType,SqlProfileType>",
-      "description": "Narrowed api item type for sql"
+      "$ref": "#/definitions/BaseSchemaApiItem<SqlApiFunction>",
+      "description": "Narrowed api item type for sql. Sql does not have constants so all sql items are \"functions\"."
     },
-    "BaseSchemaApiItem<SqlBundleType,SqlProfileType>": {
+    "BaseSchemaApiItem<SqlApiFunction>": {
       "anyOf": [
+        {
+          "$ref": "#/definitions/SqlApiFunction"
+        },
         {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/BaseSchemaApiFunction<SqlBundleType,SqlProfileType>"
+            "$ref": "#/definitions/SqlApiFunction"
           }
-        },
-        {
-          "$ref": "#/definitions/SchemaSimpleApiItem<SqlBundleType,SqlProfileType>"
         }
       ],
       "description": "Definition for a constant or a function. An Api Item can be either a constant, a function, or an array of functions"
     },
-    "BaseSchemaApiFunction<SqlBundleType,SqlProfileType>": {
+    "SqlApiFunction": {
       "type": "object",
+      "additionalProperties": false,
       "properties": {
         "name": {
           "type": "string",
           "description": "The name of the function or constant. Must start with a capital letter.",
           "pattern": "^[A-Z]+[a-zA-Z0-9.]*$"
         },
+        "isSpecialRegister": {
+          "type": "boolean",
+          "description": "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."
+        },
+        "keywords": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "The name of the keyword."
+              },
+              "description": {
+                "type": "string",
+                "description": "The description for the keyword."
+              },
+              "position": {
+                "type": "number",
+                "description": "(optional) position of the keyword in the function signature, default is to interlace with parameters"
+              }
+            },
+            "required": [
+              "name",
+              "description"
+            ],
+            "additionalProperties": false,
+            "description": "Describes a keyword used in a function"
+          },
+          "description": "The set of keywords that are used in the function."
+        },
         "description": {
           "anyOf": [
             {
@@ -537,29 +569,27 @@
         },
         "isConstant": {
           "type": "boolean",
-          "const": false,
           "description": "For function this property is optional and always false."
         },
         "parameters": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/SchemaProperty"
+            "$ref": "#/definitions/SchemaProperty<SqlValueType>"
           },
           "description": "The set of function parameters."
         },
         "returnValue": {
-          "$ref": "#/definitions/SchemaReturnValue",
+          "$ref": "#/definitions/SchemaReturnValue<SqlValueType>",
           "description": "The type of data returned by the function."
         }
       },
-      "additionalProperties": false,
       "required": [
         "bundle",
         "description",
         "name",
         "snippet"
       ],
-      "description": "Describes an Api Function."
+      "description": "Narrowed api function type for sql"
     },
     "SqlProfileType": {
       "type": "string",
@@ -568,27 +598,34 @@
     },
     "SqlBundleType": {
       "type": "string",
-      "const": "core",
-      "description": "Supported function bundles"
-    },
-    "SchemaSimpleApiItem<SqlBundleType,SqlProfileType>": {
-      "anyOf": [
-        {
-          "$ref": "#/definitions/BaseSchemaApiConstant<SqlBundleType,SqlProfileType>"
-        },
-        {
-          "$ref": "#/definitions/BaseSchemaApiFunction<SqlBundleType,SqlProfileType>"
-        }
+      "enum": [
+        "date",
+        "numeric",
+        "string"
       ],
-      "description": "Definition for simple item"
+      "description": "Supported function bundles"
     },
-    "BaseSchemaApiConstant<SqlBundleType,SqlProfileType>": {
+    "SchemaProperty<SqlValueType>": {
       "type": "object",
       "properties": {
         "name": {
           "type": "string",
-          "description": "The name of the function or constant. Must start with a capital letter.",
-          "pattern": "^[A-Z]+[a-zA-Z0-9.]*$"
+          "description": "The name of the property.",
+          "pattern": "^([a-z]+[a-zA-Z0-9_]*|\\[.*\\])$"
+        },
+        "type": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/SqlValueType"
+            },
+            {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/SqlValueType"
+              }
+            }
+          ],
+          "description": "The data type of the property value. If the property supports more than one type then use an array."
         },
         "description": {
           "anyOf": [
@@ -602,66 +639,86 @@
               "type": "string"
             }
           ],
-          "description": "A nice description for the constant or function. It can leverage Github Flavored Markdown formatting."
-        },
-        "sinceVersion": {
-          "type": "string",
-          "description": "Version string. Format x.y.",
-          "pattern": "^1\\.\\d+$"
+          "description": "The description for the property."
         },
-        "disableDocumentation": {
+        "optional": {
           "type": "boolean",
-          "description": "Indicates if the item should not be documented."
+          "description": "Indicates if the property is optional."
         },
-        "profiles": {
+        "properties": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/SqlProfileType"
+            "$ref": "#/definitions/SchemaProperty<SqlValueType>"
           },
-          "description": "The profiles the constant or the function belongs to."
-        },
-        "bundle": {
-          "$ref": "#/definitions/SqlBundleType",
-          "description": "The bundle the constant or the function belongs to."
-        },
-        "image": {
-          "type": "string",
-          "description": "The relative path to an image to illustate the constant or the function."
+          "description": "The properties if the type is Dictionary."
+        }
+      },
+      "required": [
+        "name",
+        "type",
+        "description"
+      ],
+      "additionalProperties": false,
+      "description": "Describes the properties for the type Property"
+    },
+    "SqlValueType": {
+      "type": "string",
+      "enum": [
+        "Datetime",
+        "Number",
+        "String"
+      ]
+    },
+    "SchemaReturnValue<SqlValueType>": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/SchemaReturnDefinition<SqlValueType>"
         },
-        "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.",
-          "pattern": "^[A-Z]+.*$"
+        {
+          "$ref": "#/definitions/SqlValueType"
         },
-        "examples": {
+        {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/SchemaExample"
-          },
-          "description": "The collection of examples"
+            "$ref": "#/definitions/SqlValueType"
+          }
+        }
+      ]
+    },
+    "SchemaReturnDefinition<SqlValueType>": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "$ref": "#/definitions/SqlValueType",
+          "description": "The data type of the value returned."
         },
-        "resourceLinks": {
+        "description": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description": "A description for for the value returned."
+        },
+        "properties": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/SchemaResourceLink"
+            "$ref": "#/definitions/SchemaProperty<SqlValueType>"
           },
-          "description": "A collection of links to resources"
-        },
-        "isConstant": {
-          "type": "boolean",
-          "const": true,
-          "description": "For constant, the property is mandatory and always true"
+          "description": "The properties if the type returned is a Dictionary"
         }
       },
       "required": [
-        "bundle",
-        "description",
-        "isConstant",
-        "name",
-        "snippet"
+        "type"
       ],
       "additionalProperties": false,
-      "description": "Describes an Api Constant"
+      "description": "Describes the type fo data returned by a function."
     }
   }
 }

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

@@ -3,23 +3,31 @@
   "$ref": "#/definitions/ArcadeApiItem",
   "definitions": {
     "ArcadeApiItem": {
-      "$ref": "#/definitions/BaseSchemaApiItem<ArcadeBundleType,ArcadeProfileType>"
+      "$ref": "#/definitions/BaseSchemaApiItem<ArcadeApiFunction,ArcadeApiConstant>",
+      "description": "Arcade Api Item can be either a constant, a function, or an array of functions"
     },
-    "BaseSchemaApiItem<ArcadeBundleType,ArcadeProfileType>": {
+    "BaseSchemaApiItem<ArcadeApiFunction,ArcadeApiConstant>": {
       "anyOf": [
+        {
+          "$ref": "#/definitions/ArcadeApiFunction"
+        },
         {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/BaseSchemaApiFunction<ArcadeBundleType,ArcadeProfileType>"
+            "$ref": "#/definitions/ArcadeApiFunction"
           }
         },
         {
-          "$ref": "#/definitions/SchemaSimpleApiItem<ArcadeBundleType,ArcadeProfileType>"
+          "$ref": "#/definitions/ArcadeApiConstant"
         }
       ],
       "description": "Definition for a constant or a function. An Api Item can be either a constant, a function, or an array of functions"
     },
-    "BaseSchemaApiFunction<ArcadeBundleType,ArcadeProfileType>": {
+    "ArcadeApiFunction": {
+      "$ref": "#/definitions/BaseSchemaApiFunction<ArcadeBundleType,ArcadeProfileType,ArcadeValueType>",
+      "description": "Definition for Arcade Api function"
+    },
+    "BaseSchemaApiFunction<ArcadeBundleType,ArcadeProfileType,ArcadeValueType>": {
       "type": "object",
       "properties": {
         "name": {
@@ -86,18 +94,17 @@
         },
         "isConstant": {
           "type": "boolean",
-          "const": false,
           "description": "For function this property is optional and always false."
         },
         "parameters": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/SchemaProperty"
+            "$ref": "#/definitions/SchemaProperty<ArcadeValueType>"
           },
           "description": "The set of function parameters."
         },
         "returnValue": {
-          "$ref": "#/definitions/SchemaReturnValue",
+          "$ref": "#/definitions/SchemaReturnValue<ArcadeValueType>",
           "description": "The type of data returned by the function."
         }
       },
@@ -128,6 +135,7 @@
     "ArcadeBundleType": {
       "type": "string",
       "enum": [
+        "ai",
         "core",
         "data-access",
         "database",
@@ -195,7 +203,7 @@
       "additionalProperties": false,
       "description": "Describes a link to additional resources"
     },
-    "SchemaProperty": {
+    "SchemaProperty<ArcadeValueType>": {
       "type": "object",
       "properties": {
         "name": {
@@ -206,12 +214,12 @@
         "type": {
           "anyOf": [
             {
-              "$ref": "#/definitions/SchemaValueType"
+              "$ref": "#/definitions/ArcadeValueType"
             },
             {
               "type": "array",
               "items": {
-                "$ref": "#/definitions/SchemaValueType"
+                "$ref": "#/definitions/ArcadeValueType"
               }
             }
           ],
@@ -238,7 +246,7 @@
         "properties": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/SchemaProperty"
+            "$ref": "#/definitions/SchemaProperty<ArcadeValueType>"
           },
           "description": "The properties if the type is Dictionary."
         }
@@ -251,7 +259,7 @@
       "additionalProperties": false,
       "description": "Describes the properties for the type Property"
     },
-    "SchemaValueType": {
+    "ArcadeValueType": {
       "type": "string",
       "enum": [
         "Any",
@@ -295,30 +303,29 @@
         "Text",
         "Time",
         "Voxel"
-      ],
-      "description": "The collection of supported types."
+      ]
     },
-    "SchemaReturnValue": {
+    "SchemaReturnValue<ArcadeValueType>": {
       "anyOf": [
         {
-          "$ref": "#/definitions/SchemaReturnDefinition"
+          "$ref": "#/definitions/SchemaReturnDefinition<ArcadeValueType>"
         },
         {
-          "$ref": "#/definitions/SchemaValueType"
+          "$ref": "#/definitions/ArcadeValueType"
         },
         {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/SchemaValueType"
+            "$ref": "#/definitions/ArcadeValueType"
           }
         }
       ]
     },
-    "SchemaReturnDefinition": {
+    "SchemaReturnDefinition<ArcadeValueType>": {
       "type": "object",
       "properties": {
         "type": {
-          "$ref": "#/definitions/SchemaValueType",
+          "$ref": "#/definitions/ArcadeValueType",
           "description": "The data type of the value returned."
         },
         "description": {
@@ -338,7 +345,7 @@
         "properties": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/SchemaProperty"
+            "$ref": "#/definitions/SchemaProperty<ArcadeValueType>"
           },
           "description": "The properties if the type returned is a Dictionary"
         }
@@ -349,16 +356,9 @@
       "additionalProperties": false,
       "description": "Describes the type fo data returned by a function."
     },
-    "SchemaSimpleApiItem<ArcadeBundleType,ArcadeProfileType>": {
-      "anyOf": [
-        {
-          "$ref": "#/definitions/BaseSchemaApiConstant<ArcadeBundleType,ArcadeProfileType>"
-        },
-        {
-          "$ref": "#/definitions/BaseSchemaApiFunction<ArcadeBundleType,ArcadeProfileType>"
-        }
-      ],
-      "description": "Definition for simple item"
+    "ArcadeApiConstant": {
+      "$ref": "#/definitions/BaseSchemaApiConstant<ArcadeBundleType,ArcadeProfileType>",
+      "description": "Definition for Arcade Api constant"
     },
     "BaseSchemaApiConstant<ArcadeBundleType,ArcadeProfileType>": {
       "type": "object",

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

@@ -87,6 +87,7 @@
     "ArcadeBundleType": {
       "type": "string",
       "enum": [
+        "ai",
         "core",
         "data-access",
         "database",

package/dist/schemas/profiles.schema.json

@@ -101,6 +101,7 @@
     "ArcadeBundleType": {
       "type": "string",
       "enum": [
+        "ai",
         "core",
         "data-access",
         "database",
@@ -237,7 +238,11 @@
     },
     "SqlBundleType": {
       "type": "string",
-      "const": "core",
+      "enum": [
+        "date",
+        "numeric",
+        "string"
+      ],
       "description": "Supported function bundles"
     }
   }