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

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.
Files changed (12) hide show
  1. package/LICENSE.md +13 -0
  2. package/README.md +21 -0
  3. package/dist/index.d.ts +422 -0
  4. package/dist/index.js +0 -0
  5. package/dist/schemas/api-category.schema.json +40 -0
  6. package/dist/schemas/api-item.schema.json +666 -0
  7. package/dist/schemas/arcade-api-item.schema.json +444 -0
  8. package/dist/schemas/arcade-profiles.schema.json +178 -0
  9. package/dist/schemas/profiles.schema.json +241 -0
  10. package/dist/schemas/sql-api-item.schema.json +427 -0
  11. package/dist/schemas/sql-profiles.schema.json +136 -0
  12. package/package.json +22 -0
package/dist/schemas/profiles.schema.json ADDED
@@ -0,0 +1,241 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "$ref": "#/definitions/SdkPredefinedProfiles",
4
+ "definitions": {
5
+ "SdkPredefinedProfiles": {
6
+ "type": "array",
7
+ "items": {
8
+ "$ref": "#/definitions/SdkPredefinedProfile"
9
+ }
10
+ },
11
+ "SdkPredefinedProfile": {
12
+ "anyOf": [
13
+ {
14
+ "$ref": "#/definitions/ArcadeSdkPredefinedProfile"
15
+ },
16
+ {
17
+ "$ref": "#/definitions/SqlSdkPredefinedProfile"
18
+ }
19
+ ]
20
+ },
21
+ "ArcadeSdkPredefinedProfile": {
22
+ "$ref": "#/definitions/BaseSdkPredefinedProfile<ArcadeProfileId,ArcadeBundleType>",
23
+ "description": "The predefined profiles for the Arcade language"
24
+ },
25
+ "BaseSdkPredefinedProfile<ArcadeProfileId,ArcadeBundleType>": {
26
+ "type": "object",
27
+ "properties": {
28
+ "name": {
29
+ "type": "string",
30
+ "description": "Profile name for UI"
31
+ },
32
+ "id": {
33
+ "$ref": "#/definitions/ArcadeProfileId",
34
+ "description": "Profile id for docs"
35
+ },
36
+ "bundles": {
37
+ "type": "array",
38
+ "items": {
39
+ "$ref": "#/definitions/ArcadeBundleType"
40
+ },
41
+ "description": "Function bundles enabled for this profile"
42
+ },
43
+ "variables": {
44
+ "type": "array",
45
+ "items": {
46
+ "$ref": "#/definitions/SdkVariable"
47
+ },
48
+ "description": "Variable describing name, type, and providing description"
49
+ }
50
+ },
51
+ "required": [
52
+ "name",
53
+ "id",
54
+ "bundles",
55
+ "variables"
56
+ ],
57
+ "additionalProperties": false,
58
+ "description": "Describes a profile"
59
+ },
60
+ "ArcadeProfileId": {
61
+ "type": "string",
62
+ "enum": [
63
+ "aggregate-field",
64
+ "alias",
65
+ "attribute-rule-calculation",
66
+ "attribute-rule-constraint",
67
+ "attribute-rule-validation",
68
+ "dashboard-data",
69
+ "dashboard-indicator-formatting",
70
+ "dashboard-list-formatting",
71
+ "dashboard-table-formatting",
72
+ "data-pipelines",
73
+ "dictionary-renderer",
74
+ "feature-display-title",
75
+ "feature-z",
76
+ "field-calculation",
77
+ "field-mapping",
78
+ "form-calculation",
79
+ "form-constraint",
80
+ "geoanalytics",
81
+ "geotrigger-notification",
82
+ "labeling",
83
+ "layout",
84
+ "location-update-constraint",
85
+ "measure-visualization",
86
+ "minimalist",
87
+ "model-builder",
88
+ "popup-element-feature-reduction",
89
+ "popup-element",
90
+ "popup-feature-reduction",
91
+ "popup",
92
+ "quick-capture",
93
+ "tasks",
94
+ "velocity",
95
+ "visualization"
96
+ ],
97
+ "description": "The list of supported profiles"
98
+ },
99
+ "ArcadeBundleType": {
100
+ "type": "string",
101
+ "enum": [
102
+ "core",
103
+ "data-access",
104
+ "database",
105
+ "geometry",
106
+ "knowledge-graph",
107
+ "portal-access",
108
+ "track"
109
+ ],
110
+ "description": "Supported function bundles"
111
+ },
112
+ "SdkVariable": {
113
+ "anyOf": [
114
+ {
115
+ "$ref": "#/definitions/SdkDictionaryVariable"
116
+ },
117
+ {
118
+ "$ref": "#/definitions/SdkValueVariable"
119
+ }
120
+ ],
121
+ "description": "Profile variable"
122
+ },
123
+ "SdkDictionaryVariable": {
124
+ "type": "object",
125
+ "properties": {
126
+ "name": {
127
+ "type": "string",
128
+ "description": "Name of the variable."
129
+ },
130
+ "type": {
131
+ "type": "string",
132
+ "const": "dictionary",
133
+ "description": "Type of the variable."
134
+ },
135
+ "description": {
136
+ "type": "string",
137
+ "description": "Description of the variable."
138
+ },
139
+ "properties": {
140
+ "type": "array",
141
+ "items": {
142
+ "$ref": "#/definitions/SdkVariable"
143
+ }
144
+ }
145
+ },
146
+ "required": [
147
+ "name",
148
+ "properties",
149
+ "type"
150
+ ],
151
+ "additionalProperties": false,
152
+ "description": "A dictionary variable"
153
+ },
154
+ "SdkValueVariable": {
155
+ "type": "object",
156
+ "properties": {
157
+ "name": {
158
+ "type": "string",
159
+ "description": "Name of the variable."
160
+ },
161
+ "type": {
162
+ "type": "string",
163
+ "enum": [
164
+ "array",
165
+ "boolean",
166
+ "date",
167
+ "dateOnly",
168
+ "feature",
169
+ "featureSet",
170
+ "featureSetCollection",
171
+ "geometry",
172
+ "knowledgeGraph",
173
+ "number",
174
+ "text",
175
+ "time"
176
+ ],
177
+ "description": "Type of the variable."
178
+ },
179
+ "description": {
180
+ "type": "string",
181
+ "description": "Description of the variable."
182
+ }
183
+ },
184
+ "required": [
185
+ "name",
186
+ "type"
187
+ ],
188
+ "additionalProperties": false,
189
+ "description": "A variable that represents a simple type (boolean, number, feature, etc.)"
190
+ },
191
+ "SqlSdkPredefinedProfile": {
192
+ "$ref": "#/definitions/BaseSdkPredefinedProfile<SqlProfileId,SqlBundleType>",
193
+ "description": "The predefined profiles for the SQL language"
194
+ },
195
+ "BaseSdkPredefinedProfile<SqlProfileId,SqlBundleType>": {
196
+ "type": "object",
197
+ "properties": {
198
+ "name": {
199
+ "type": "string",
200
+ "description": "Profile name for UI"
201
+ },
202
+ "id": {
203
+ "$ref": "#/definitions/SqlProfileId",
204
+ "description": "Profile id for docs"
205
+ },
206
+ "bundles": {
207
+ "type": "array",
208
+ "items": {
209
+ "$ref": "#/definitions/SqlBundleType"
210
+ },
211
+ "description": "Function bundles enabled for this profile"
212
+ },
213
+ "variables": {
214
+ "type": "array",
215
+ "items": {
216
+ "$ref": "#/definitions/SdkVariable"
217
+ },
218
+ "description": "Variable describing name, type, and providing description"
219
+ }
220
+ },
221
+ "required": [
222
+ "name",
223
+ "id",
224
+ "bundles",
225
+ "variables"
226
+ ],
227
+ "additionalProperties": false,
228
+ "description": "Describes a profile"
229
+ },
230
+ "SqlProfileId": {
231
+ "type": "string",
232
+ "const": "field-calculation",
233
+ "description": "The list of supported profiles"
234
+ },
235
+ "SqlBundleType": {
236
+ "type": "string",
237
+ "const": "core",
238
+ "description": "Supported function bundles"
239
+ }
240
+ }
241
+ }
package/dist/schemas/sql-api-item.schema.json ADDED
@@ -0,0 +1,427 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "$ref": "#/definitions/SqlApiItem",
4
+ "definitions": {
5
+ "SqlApiItem": {
6
+ "$ref": "#/definitions/BaseSchemaApiItem<SqlBundleType,SqlProfileType>",
7
+ "description": "Narrowed api item type for sql"
8
+ },
9
+ "BaseSchemaApiItem<SqlBundleType,SqlProfileType>": {
10
+ "anyOf": [
11
+ {
12
+ "type": "array",
13
+ "items": {
14
+ "$ref": "#/definitions/BaseSchemaApiFunction<SqlBundleType,SqlProfileType>"
15
+ }
16
+ },
17
+ {
18
+ "$ref": "#/definitions/SchemaSimpleApiItem<SqlBundleType,SqlProfileType>"
19
+ }
20
+ ],
21
+ "description": "Definition for a constant or a function. An Api Item can be either a constant, a function, or an array of functions"
22
+ },
23
+ "BaseSchemaApiFunction<SqlBundleType,SqlProfileType>": {
24
+ "type": "object",
25
+ "properties": {
26
+ "name": {
27
+ "type": "string",
28
+ "description": "The name of the function or constant. Must start with a capital letter.",
29
+ "pattern": "^[A-Z]+[a-zA-Z0-9.]*$"
30
+ },
31
+ "description": {
32
+ "anyOf": [
33
+ {
34
+ "type": "array",
35
+ "items": {
36
+ "type": "string"
37
+ }
38
+ },
39
+ {
40
+ "type": "string"
41
+ }
42
+ ],
43
+ "description": "A nice description for the constant or function. It can leverage Github Flavored Markdown formatting."
44
+ },
45
+ "sinceVersion": {
46
+ "type": "string",
47
+ "description": "Version string. Format x.y.",
48
+ "pattern": "^1\\.\\d+$"
49
+ },
50
+ "disableDocumentation": {
51
+ "type": "boolean",
52
+ "description": "Indicates if the item should not be documented."
53
+ },
54
+ "profiles": {
55
+ "type": "array",
56
+ "items": {
57
+ "$ref": "#/definitions/SqlProfileType"
58
+ },
59
+ "description": "The profiles the constant or the function belongs to."
60
+ },
61
+ "bundle": {
62
+ "$ref": "#/definitions/SqlBundleType",
63
+ "description": "The bundle the constant or the function belongs to."
64
+ },
65
+ "image": {
66
+ "type": "string",
67
+ "description": "The relative path to an image to illustate the constant or the function."
68
+ },
69
+ "snippet": {
70
+ "type": "string",
71
+ "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.",
72
+ "pattern": "^[A-Z]+.*$"
73
+ },
74
+ "examples": {
75
+ "type": "array",
76
+ "items": {
77
+ "$ref": "#/definitions/SchemaExample"
78
+ },
79
+ "description": "The collection of examples"
80
+ },
81
+ "resourceLinks": {
82
+ "type": "array",
83
+ "items": {
84
+ "$ref": "#/definitions/SchemaResourceLink"
85
+ },
86
+ "description": "A collection of links to resources"
87
+ },
88
+ "isConstant": {
89
+ "type": "boolean",
90
+ "const": false,
91
+ "description": "For function this property is optional and always false."
92
+ },
93
+ "parameters": {
94
+ "type": "array",
95
+ "items": {
96
+ "$ref": "#/definitions/SchemaProperty"
97
+ },
98
+ "description": "The set of function parameters."
99
+ },
100
+ "returnValue": {
101
+ "$ref": "#/definitions/SchemaReturnValue",
102
+ "description": "The type of data returned by the function."
103
+ }
104
+ },
105
+ "additionalProperties": false,
106
+ "required": [
107
+ "bundle",
108
+ "description",
109
+ "name",
110
+ "snippet"
111
+ ],
112
+ "description": "Describes an Api Function."
113
+ },
114
+ "SqlProfileType": {
115
+ "type": "string",
116
+ "const": "Field Calculation",
117
+ "description": "Supported sql profile names"
118
+ },
119
+ "SqlBundleType": {
120
+ "type": "string",
121
+ "const": "core",
122
+ "description": "Supported function bundles"
123
+ },
124
+ "SchemaExample": {
125
+ "type": "object",
126
+ "properties": {
127
+ "description": {
128
+ "anyOf": [
129
+ {
130
+ "type": "array",
131
+ "items": {
132
+ "type": "string"
133
+ }
134
+ },
135
+ {
136
+ "type": "string"
137
+ }
138
+ ],
139
+ "description": "A description for the example."
140
+ },
141
+ "code": {
142
+ "anyOf": [
143
+ {
144
+ "type": "array",
145
+ "items": {
146
+ "type": "string"
147
+ }
148
+ },
149
+ {
150
+ "type": "string"
151
+ }
152
+ ],
153
+ "description": "Either a single line string or an array of strings."
154
+ }
155
+ },
156
+ "required": [
157
+ "code"
158
+ ],
159
+ "additionalProperties": false,
160
+ "description": "Describes an example"
161
+ },
162
+ "SchemaResourceLink": {
163
+ "type": "object",
164
+ "properties": {
165
+ "linkText": {
166
+ "type": "string",
167
+ "description": "The text used to describe the resource link."
168
+ },
169
+ "url": {
170
+ "type": "string",
171
+ "description": "The url to the resource."
172
+ }
173
+ },
174
+ "required": [
175
+ "linkText",
176
+ "url"
177
+ ],
178
+ "additionalProperties": false,
179
+ "description": "Describes a link to additional resources"
180
+ },
181
+ "SchemaProperty": {
182
+ "type": "object",
183
+ "properties": {
184
+ "name": {
185
+ "type": "string",
186
+ "description": "The name of the property.",
187
+ "pattern": "^([a-z]+[a-zA-Z0-9_]*|\\[.*\\])$"
188
+ },
189
+ "type": {
190
+ "anyOf": [
191
+ {
192
+ "$ref": "#/definitions/SchemaValueType"
193
+ },
194
+ {
195
+ "type": "array",
196
+ "items": {
197
+ "$ref": "#/definitions/SchemaValueType"
198
+ }
199
+ }
200
+ ],
201
+ "description": "The data type of the property value. If the property supports more than one type then use an array."
202
+ },
203
+ "description": {
204
+ "anyOf": [
205
+ {
206
+ "type": "array",
207
+ "items": {
208
+ "type": "string"
209
+ }
210
+ },
211
+ {
212
+ "type": "string"
213
+ }
214
+ ],
215
+ "description": "The description for the property."
216
+ },
217
+ "optional": {
218
+ "type": "boolean",
219
+ "description": "Indicates if the property is optional."
220
+ },
221
+ "properties": {
222
+ "type": "array",
223
+ "items": {
224
+ "$ref": "#/definitions/SchemaProperty"
225
+ },
226
+ "description": "The properties if the type is Dictionary."
227
+ }
228
+ },
229
+ "required": [
230
+ "name",
231
+ "type",
232
+ "description"
233
+ ],
234
+ "additionalProperties": false,
235
+ "description": "Describes the properties for the type Property"
236
+ },
237
+ "SchemaValueType": {
238
+ "type": "string",
239
+ "enum": [
240
+ "Any",
241
+ "Array<Any>",
242
+ "Array<Attachment>",
243
+ "Array<Boolean>",
244
+ "Array<Date>",
245
+ "Array<DateOnly>",
246
+ "Array<Dictionary>",
247
+ "Array<Extent>",
248
+ "Array<Feature>",
249
+ "Array<Geometry>",
250
+ "Array<KnowledgeGraph>",
251
+ "Array<Multipoint>",
252
+ "Array<Number>",
253
+ "Array<Number|Text>",
254
+ "Array<Point>",
255
+ "Array<Polygon>",
256
+ "Array<Polyline>",
257
+ "Array<Text>",
258
+ "Array<Time>",
259
+ "Attachment",
260
+ "Boolean",
261
+ "Date",
262
+ "DateOnly",
263
+ "Dictionary",
264
+ "Extent",
265
+ "Feature",
266
+ "FeatureSet",
267
+ "FeatureSetCollection",
268
+ "Function",
269
+ "Geometry",
270
+ "KnowledgeGraph",
271
+ "Multipoint",
272
+ "Null",
273
+ "Number",
274
+ "Point",
275
+ "Polygon",
276
+ "Polyline",
277
+ "Portal",
278
+ "Text",
279
+ "Time"
280
+ ],
281
+ "description": "The collection of supported types."
282
+ },
283
+ "SchemaReturnValue": {
284
+ "anyOf": [
285
+ {
286
+ "$ref": "#/definitions/SchemaReturnDefinition"
287
+ },
288
+ {
289
+ "$ref": "#/definitions/SchemaValueType"
290
+ },
291
+ {
292
+ "type": "array",
293
+ "items": {
294
+ "$ref": "#/definitions/SchemaValueType"
295
+ }
296
+ }
297
+ ]
298
+ },
299
+ "SchemaReturnDefinition": {
300
+ "type": "object",
301
+ "properties": {
302
+ "type": {
303
+ "$ref": "#/definitions/SchemaValueType",
304
+ "description": "The data type of the value returned."
305
+ },
306
+ "description": {
307
+ "anyOf": [
308
+ {
309
+ "type": "array",
310
+ "items": {
311
+ "type": "string"
312
+ }
313
+ },
314
+ {
315
+ "type": "string"
316
+ }
317
+ ],
318
+ "description": "A description for for the value returned."
319
+ },
320
+ "properties": {
321
+ "type": "array",
322
+ "items": {
323
+ "$ref": "#/definitions/SchemaProperty"
324
+ },
325
+ "description": "The properties if the type returned is a Dictionary"
326
+ }
327
+ },
328
+ "required": [
329
+ "type"
330
+ ],
331
+ "additionalProperties": false,
332
+ "description": "Describes the type fo data returned by a function."
333
+ },
334
+ "SchemaSimpleApiItem<SqlBundleType,SqlProfileType>": {
335
+ "anyOf": [
336
+ {
337
+ "$ref": "#/definitions/BaseSchemaApiConstant<SqlBundleType,SqlProfileType>"
338
+ },
339
+ {
340
+ "$ref": "#/definitions/BaseSchemaApiFunction<SqlBundleType,SqlProfileType>"
341
+ }
342
+ ],
343
+ "description": "Definition for simple item"
344
+ },
345
+ "BaseSchemaApiConstant<SqlBundleType,SqlProfileType>": {
346
+ "type": "object",
347
+ "properties": {
348
+ "name": {
349
+ "type": "string",
350
+ "description": "The name of the function or constant. Must start with a capital letter.",
351
+ "pattern": "^[A-Z]+[a-zA-Z0-9.]*$"
352
+ },
353
+ "description": {
354
+ "anyOf": [
355
+ {
356
+ "type": "array",
357
+ "items": {
358
+ "type": "string"
359
+ }
360
+ },
361
+ {
362
+ "type": "string"
363
+ }
364
+ ],
365
+ "description": "A nice description for the constant or function. It can leverage Github Flavored Markdown formatting."
366
+ },
367
+ "sinceVersion": {
368
+ "type": "string",
369
+ "description": "Version string. Format x.y.",
370
+ "pattern": "^1\\.\\d+$"
371
+ },
372
+ "disableDocumentation": {
373
+ "type": "boolean",
374
+ "description": "Indicates if the item should not be documented."
375
+ },
376
+ "profiles": {
377
+ "type": "array",
378
+ "items": {
379
+ "$ref": "#/definitions/SqlProfileType"
380
+ },
381
+ "description": "The profiles the constant or the function belongs to."
382
+ },
383
+ "bundle": {
384
+ "$ref": "#/definitions/SqlBundleType",
385
+ "description": "The bundle the constant or the function belongs to."
386
+ },
387
+ "image": {
388
+ "type": "string",
389
+ "description": "The relative path to an image to illustate the constant or the function."
390
+ },
391
+ "snippet": {
392
+ "type": "string",
393
+ "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.",
394
+ "pattern": "^[A-Z]+.*$"
395
+ },
396
+ "examples": {
397
+ "type": "array",
398
+ "items": {
399
+ "$ref": "#/definitions/SchemaExample"
400
+ },
401
+ "description": "The collection of examples"
402
+ },
403
+ "resourceLinks": {
404
+ "type": "array",
405
+ "items": {
406
+ "$ref": "#/definitions/SchemaResourceLink"
407
+ },
408
+ "description": "A collection of links to resources"
409
+ },
410
+ "isConstant": {
411
+ "type": "boolean",
412
+ "const": true,
413
+ "description": "For constant, the property is mandatory and always true"
414
+ }
415
+ },
416
+ "required": [
417
+ "bundle",
418
+ "description",
419
+ "isConstant",
420
+ "name",
421
+ "snippet"
422
+ ],
423
+ "additionalProperties": false,
424
+ "description": "Describes an Api Constant"
425
+ }
426
+ }
427
+ }