@arcgis/languages-sdk-spec 5.2.0-next.9 → 5.2.0-next.91

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE.md CHANGED
@@ -1,12 +1,14 @@
1
1
  # Licensing
2
2
 
3
- COPYRIGHT © Esri
3
+ COPYRIGHT Esri
4
4
 
5
5
  All rights reserved under the copyright laws of the United States and applicable international laws, treaties, and conventions.
6
6
 
7
- 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.
7
+ This material is licensed for use under the Esri Master License Agreement (MLA), and is bound by the terms of that agreement.
8
8
  You may redistribute and use this code without modification, provided you adhere to the terms of the MLA and include this copyright notice.
9
9
 
10
+ See use restrictions at https://www.esri.com/content/dam/esrisites/en-us/media/legal/ma-full/ma-full.pdf.
11
+
10
12
  For additional information, contact:
11
13
  Environmental Systems Research Institute, Inc.
12
14
  Attn: Contracts and Legal Services Department
package/README.md CHANGED
@@ -8,5 +8,5 @@ It is not intended to be used directly, but rather used as a dependency by other
8
8
 
9
9
  ## License
10
10
 
11
- 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.
12
- For third party notices, see https://js.arcgis.com/5.1/third-party-notices.txt.
11
+ 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.
12
+ For third party notices, see https://js.arcgis.com/5.2/third-party-notices.txt.
@@ -82,6 +82,10 @@ export interface BaseSchemaApiFunction<Bundle extends BundleType, Profile extend
82
82
  * The type of data returned by the function.
83
83
  */
84
84
  returnValue?: SchemaReturnValue<ValueType>;
85
+ /**
86
+ * Indicates if the function consumes credits when called.
87
+ */
88
+ consumesCredits?: boolean;
85
89
  }
86
90
  /**
87
91
  * Describes the properties for the type Property
@@ -117,6 +117,10 @@
117
117
  "returnValue": {
118
118
  "$ref": "#/definitions/SchemaReturnValue<ArcadeValueType>",
119
119
  "description": "The type of data returned by the function."
120
+ },
121
+ "consumesCredits": {
122
+ "type": "boolean",
123
+ "description": "Indicates if the function consumes credits when called."
120
124
  }
121
125
  },
122
126
  "additionalProperties": false,
@@ -583,6 +587,10 @@
583
587
  "returnValue": {
584
588
  "$ref": "#/definitions/SchemaReturnValue<SqlValueType>",
585
589
  "description": "The type of data returned by the function."
590
+ },
591
+ "consumesCredits": {
592
+ "type": "boolean",
593
+ "description": "Indicates if the function consumes credits when called."
586
594
  }
587
595
  },
588
596
  "required": [
@@ -106,6 +106,10 @@
106
106
  "returnValue": {
107
107
  "$ref": "#/definitions/SchemaReturnValue<ArcadeValueType>",
108
108
  "description": "The type of data returned by the function."
109
+ },
110
+ "consumesCredits": {
111
+ "type": "boolean",
112
+ "description": "Indicates if the function consumes credits when called."
109
113
  }
110
114
  },
111
115
  "additionalProperties": false,
@@ -131,6 +131,10 @@
131
131
  "returnValue": {
132
132
  "$ref": "#/definitions/SchemaReturnValue<SqlValueType>",
133
133
  "description": "The type of data returned by the function."
134
+ },
135
+ "consumesCredits": {
136
+ "type": "boolean",
137
+ "description": "Indicates if the function consumes credits when called."
134
138
  }
135
139
  },
136
140
  "required": [
package/dist/types.d.ts CHANGED
@@ -71,6 +71,11 @@ interface SdkFunction extends SdkItemBase {
71
71
  min: number;
72
72
  max: number;
73
73
  };
74
+ /**
75
+ * Indicates whether invoking this function consumes credits.
76
+ * Used by the editor to drive UX.
77
+ */
78
+ consumesCredits?: boolean;
74
79
  }
75
80
  /**
76
81
  * Represents an item in the arcade api.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arcgis/languages-sdk-spec",
3
- "version": "5.2.0-next.9",
3
+ "version": "5.2.0-next.91",
4
4
  "description": "ArcGIS languages types and schemas for design a language sdk",
5
5
  "homepage": "https://developers.arcgis.com/javascript/latest/",
6
6
  "type": "module",
@@ -10,7 +10,8 @@
10
10
  "exports": {
11
11
  ".": "./dist/index.js",
12
12
  "./scripting": "./dist/scripting/index.js",
13
- "./dist/schemas/*.schema.json": "./dist/schemas/*.schema.json"
13
+ "./dist/schemas/*.schema.json": "./dist/schemas/*.schema.json",
14
+ "./package.json": "./package.json"
14
15
  },
15
16
  "files": [
16
17
  "dist/"