@algorandfoundation/algokit-client-generator 2.3.0 → 2.3.1-beta.1

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 (3) hide show
  1. package/package.json +1 -1
  2. package/schema/application.schema.json +76 -29
  3. package/schema/contract.schema.json +61 -10
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "main": "index.js",
3
3
  "types": "index.d.ts",
4
4
  "name": "@algorandfoundation/algokit-client-generator",
5
- "version": "2.3.0",
5
+ "version": "2.3.1-beta.1",
6
6
  "description": "Generates a TypeScript client for interacting with, and deploying ARC-0032 smart contracts on the Algorand Blockchain.",
7
7
  "private": false,
8
8
  "bin": {
package/schema/application.schema.json CHANGED
@@ -2,8 +2,13 @@
2
2
  "$schema": "http://json-schema.org/draft-07/schema",
3
3
  "title": "AlgoAppSpec",
4
4
  "type": "object",
5
- "required": ["contract", "schema", "source", "state"],
6
- "additionalProperties": false,
5
+ "required": [
6
+ "contract",
7
+ "schema",
8
+ "source",
9
+ "state"
10
+ ],
11
+ "additionalProperties": true,
7
12
  "properties": {
8
13
  "hints": {
9
14
  "type": "object",
@@ -30,12 +35,18 @@
30
35
  "definitions": {
31
36
  "AVMType": {
32
37
  "description": "AVM data type",
33
- "enum": ["uint64", "bytes"]
38
+ "enum": [
39
+ "uint64",
40
+ "bytes"
41
+ ]
34
42
  },
35
43
  "DeclaredSchemaValueSpec": {
36
44
  "type": "object",
37
- "required": ["type", "key"],
38
- "additionalProperties": false,
45
+ "required": [
46
+ "type",
47
+ "key"
48
+ ],
49
+ "additionalProperties": true,
39
50
  "properties": {
40
51
  "type": {
41
52
  "description": "The type of the value",
@@ -57,7 +68,9 @@
57
68
  },
58
69
  "ReservedSchemaValueSpec": {
59
70
  "type": "object",
60
- "required": ["type"],
71
+ "required": [
72
+ "type"
73
+ ],
61
74
  "properties": {
62
75
  "type": {
63
76
  "description": "The type of the value",
@@ -75,8 +88,11 @@
75
88
  },
76
89
  "StateSchemaSpec": {
77
90
  "type": "object",
78
- "additionalProperties": false,
79
- "required": ["global", "local"],
91
+ "additionalProperties": true,
92
+ "required": [
93
+ "global",
94
+ "local"
95
+ ],
80
96
  "properties": {
81
97
  "global": {
82
98
  "$ref": "#/definitions/StateSchema"
@@ -88,8 +104,11 @@
88
104
  },
89
105
  "StateSchema": {
90
106
  "type": "object",
91
- "additionalProperties": false,
92
- "required": ["num_byte_slices", "num_uints"],
107
+ "additionalProperties": true,
108
+ "required": [
109
+ "num_byte_slices",
110
+ "num_uints"
111
+ ],
93
112
  "properties": {
94
113
  "num_uints": {
95
114
  "type": "integer"
@@ -102,7 +121,7 @@
102
121
  "SchemaSpec": {
103
122
  "description": "The schema for global and local storage",
104
123
  "type": "object",
105
- "additionalProperties": false,
124
+ "additionalProperties": true,
106
125
  "properties": {
107
126
  "global": {
108
127
  "$ref": "#/definitions/Schema"
@@ -114,7 +133,7 @@
114
133
  },
115
134
  "Schema": {
116
135
  "type": "object",
117
- "additionalProperties": false,
136
+ "additionalProperties": true,
118
137
  "properties": {
119
138
  "declared": {
120
139
  "type": "object",
@@ -132,7 +151,7 @@
132
151
  },
133
152
  "AppSources": {
134
153
  "type": "object",
135
- "additionalProperties": false,
154
+ "additionalProperties": true,
136
155
  "properties": {
137
156
  "approval": {
138
157
  "type": "string"
@@ -144,7 +163,7 @@
144
163
  },
145
164
  "Hint": {
146
165
  "type": "object",
147
- "additionalProperties": false,
166
+ "additionalProperties": true,
148
167
  "properties": {
149
168
  "read_only": {
150
169
  "type": "boolean"
@@ -192,12 +211,20 @@
192
211
  }
193
212
  },
194
213
  "CallConfigValue": {
195
- "enum": ["NEVER", "CALL", "CREATE", "ALL"]
214
+ "enum": [
215
+ "NEVER",
216
+ "CALL",
217
+ "CREATE",
218
+ "ALL"
219
+ ]
196
220
  },
197
221
  "Struct": {
198
222
  "type": "object",
199
- "additionalProperties": false,
200
- "required": ["name", "elements"],
223
+ "additionalProperties": true,
224
+ "required": [
225
+ "name",
226
+ "elements"
227
+ ],
201
228
  "properties": {
202
229
  "name": {
203
230
  "type": "string"
@@ -233,12 +260,17 @@
233
260
  "oneOf": [
234
261
  {
235
262
  "type": "object",
236
- "required": ["source", "data"],
237
- "additionalProperties": false,
263
+ "required": [
264
+ "source",
265
+ "data"
266
+ ],
267
+ "additionalProperties": true,
238
268
  "properties": {
239
269
  "source": {
240
270
  "description": "The default value should be fetched by invoking an ABI method",
241
- "enum": ["abi-method"]
271
+ "enum": [
272
+ "abi-method"
273
+ ]
242
274
  },
243
275
  "data": {
244
276
  "description": "The contract of the ABI method to invoke.",
@@ -248,12 +280,17 @@
248
280
  },
249
281
  {
250
282
  "type": "object",
251
- "required": ["source", "data"],
252
- "additionalProperties": false,
283
+ "required": [
284
+ "source",
285
+ "data"
286
+ ],
287
+ "additionalProperties": true,
253
288
  "properties": {
254
289
  "source": {
255
290
  "description": "The default value should be fetched from global state",
256
- "enum": ["global-state"]
291
+ "enum": [
292
+ "global-state"
293
+ ]
257
294
  },
258
295
  "data": {
259
296
  "description": "The key of the state variable",
@@ -263,12 +300,17 @@
263
300
  },
264
301
  {
265
302
  "type": "object",
266
- "required": ["source", "data"],
267
- "additionalProperties": false,
303
+ "required": [
304
+ "source",
305
+ "data"
306
+ ],
307
+ "additionalProperties": true,
268
308
  "properties": {
269
309
  "source": {
270
310
  "description": "The default value should be fetched from the local state of the sender user",
271
- "enum": ["local-state"]
311
+ "enum": [
312
+ "local-state"
313
+ ]
272
314
  },
273
315
  "data": {
274
316
  "description": "The key of the state variable",
@@ -278,12 +320,17 @@
278
320
  },
279
321
  {
280
322
  "type": "object",
281
- "required": ["source", "data"],
282
- "additionalProperties": false,
323
+ "required": [
324
+ "source",
325
+ "data"
326
+ ],
327
+ "additionalProperties": true,
283
328
  "properties": {
284
329
  "source": {
285
330
  "description": "The default value is a constant.",
286
- "enum": ["constant"]
331
+ "enum": [
332
+ "constant"
333
+ ]
287
334
  },
288
335
  "data": {
289
336
  "description": "The static default value to use.",
package/schema/contract.schema.json CHANGED
@@ -2,8 +2,11 @@
2
2
  "$schema": "http://json-schema.org/draft-07/schema",
3
3
  "title": "AbiContract",
4
4
  "type": "object",
5
- "required": ["name", "methods"],
6
- "additionalProperties": false,
5
+ "required": [
6
+ "name",
7
+ "methods"
8
+ ],
9
+ "additionalProperties": true,
7
10
  "properties": {
8
11
  "name": {
9
12
  "type": "string"
@@ -17,12 +20,20 @@
17
20
  "$ref": "#/definitions/ContractMethod"
18
21
  }
19
22
  },
23
+ "events": {
24
+ "type": "array",
25
+ "items": {
26
+ "$ref": "#/definitions/Event"
27
+ }
28
+ },
20
29
  "networks": {
21
30
  "type": "object",
22
31
  "additionalProperties": {
23
32
  "type": "object",
24
- "required": ["appID"],
25
- "additionalProperties": false,
33
+ "required": [
34
+ "appID"
35
+ ],
36
+ "additionalProperties": true,
26
37
  "properties": {
27
38
  "appID": {
28
39
  "type": "number"
@@ -34,8 +45,12 @@
34
45
  "definitions": {
35
46
  "ContractMethod": {
36
47
  "type": "object",
37
- "additionalProperties": false,
38
- "required": ["name", "args", "returns"],
48
+ "additionalProperties": true,
49
+ "required": [
50
+ "name",
51
+ "args",
52
+ "returns"
53
+ ],
39
54
  "properties": {
40
55
  "name": {
41
56
  "type": "string"
@@ -51,8 +66,10 @@
51
66
  },
52
67
  "returns": {
53
68
  "type": "object",
54
- "additionalProperties": false,
55
- "required": ["type"],
69
+ "additionalProperties": true,
70
+ "required": [
71
+ "type"
72
+ ],
56
73
  "properties": {
57
74
  "desc": {
58
75
  "type": "string"
@@ -61,13 +78,47 @@
61
78
  "$ref": "#/definitions/ABIType"
62
79
  }
63
80
  }
81
+ },
82
+ "readonly": {
83
+ "type": "boolean"
84
+ },
85
+ "events": {
86
+ "type": "array",
87
+ "items": {
88
+ "$ref": "#/definitions/Event"
89
+ }
90
+ }
91
+ }
92
+ },
93
+ "Event": {
94
+ "type": "object",
95
+ "additionalProperties": true,
96
+ "required": [
97
+ "name",
98
+ "args"
99
+ ],
100
+ "properties": {
101
+ "name": {
102
+ "type": "string"
103
+ },
104
+ "args": {
105
+ "type": "array",
106
+ "items": {
107
+ "$ref": "#/definitions/ContractMethodArg"
108
+ }
109
+ },
110
+ "desc": {
111
+ "type": "string"
64
112
  }
65
113
  }
66
114
  },
67
115
  "ContractMethodArg": {
68
116
  "type": "object",
69
- "additionalProperties": false,
70
- "required": ["name", "type"],
117
+ "additionalProperties": true,
118
+ "required": [
119
+ "name",
120
+ "type"
121
+ ],
71
122
  "properties": {
72
123
  "desc": {
73
124
  "type": "string"