@virjay/playscope-cocos 0.0.0-stage → 0.2.0

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 (92) hide show
  1. package/CHANGELOG.md +30 -0
  2. package/README.md +314 -2
  3. package/USAGE.md +372 -0
  4. package/VALIDATION.md +93 -0
  5. package/dist/adapters/levelplay/index.d.ts +15 -0
  6. package/dist/adapters/levelplay/index.js +14 -0
  7. package/dist/cocos/Storage.d.ts +16 -0
  8. package/dist/cocos/Storage.js +16 -0
  9. package/dist/cocos/XhrJsonTransport.d.ts +8 -0
  10. package/dist/cocos/XhrJsonTransport.js +65 -0
  11. package/dist/cocos/index.d.ts +48 -0
  12. package/dist/cocos/index.js +134 -0
  13. package/dist/core/ClientOwnership.d.ts +6 -0
  14. package/dist/core/ClientOwnership.js +39 -0
  15. package/dist/core/ClientScope.d.ts +5 -0
  16. package/dist/core/ClientScope.js +34 -0
  17. package/dist/core/ConfigurationSync.d.ts +18 -0
  18. package/dist/core/ConfigurationSync.js +66 -0
  19. package/dist/core/FactEncoding.d.ts +10 -0
  20. package/dist/core/FactEncoding.js +29 -0
  21. package/dist/core/HttpError.d.ts +10 -0
  22. package/dist/core/HttpError.js +17 -0
  23. package/dist/core/OutboxStore.d.ts +31 -0
  24. package/dist/core/OutboxStore.js +228 -0
  25. package/dist/core/PersistentState.d.ts +33 -0
  26. package/dist/core/PersistentState.js +92 -0
  27. package/dist/core/PlayScopeClient.d.ts +65 -0
  28. package/dist/core/PlayScopeClient.js +422 -0
  29. package/dist/core/QueueAdmission.d.ts +4 -0
  30. package/dist/core/QueueAdmission.js +29 -0
  31. package/dist/core/index.d.ts +7 -0
  32. package/dist/core/index.js +27 -0
  33. package/dist/core/revenue.d.ts +33 -0
  34. package/dist/core/revenue.js +23 -0
  35. package/dist/core/types.d.ts +155 -0
  36. package/dist/core/types.js +2 -0
  37. package/dist/core/uuid.d.ts +1 -0
  38. package/dist/core/uuid.js +9 -0
  39. package/dist/esm/adapters/levelplay/index.js +11 -0
  40. package/dist/esm/cocos/Storage.js +12 -0
  41. package/dist/esm/cocos/XhrJsonTransport.js +61 -0
  42. package/dist/esm/cocos/index.js +115 -0
  43. package/dist/esm/core/ClientOwnership.js +34 -0
  44. package/dist/esm/core/ClientScope.js +30 -0
  45. package/dist/esm/core/ConfigurationSync.js +62 -0
  46. package/dist/esm/core/FactEncoding.js +24 -0
  47. package/dist/esm/core/HttpError.js +12 -0
  48. package/dist/esm/core/OutboxStore.js +224 -0
  49. package/dist/esm/core/PersistentState.js +85 -0
  50. package/dist/esm/core/PlayScopeClient.js +415 -0
  51. package/dist/esm/core/QueueAdmission.js +25 -0
  52. package/dist/esm/core/index.js +7 -0
  53. package/dist/esm/core/revenue.js +20 -0
  54. package/dist/esm/core/types.js +1 -0
  55. package/dist/esm/core/uuid.js +6 -0
  56. package/dist/esm/package.json +1 -0
  57. package/dist/esm/protocols/game-v1/index.js +21 -0
  58. package/dist/protocols/game-v1/index.d.ts +8 -0
  59. package/dist/protocols/game-v1/index.js +25 -0
  60. package/doc/README.md +4 -0
  61. package/doc//344/275/277/347/224/250/346/214/207/345/215/227/README.md +585 -0
  62. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231/0.1.1-types/adapters/levelplay/index.d.ts +15 -0
  63. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231/0.1.1-types/cocos/Storage.d.ts +13 -0
  64. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231/0.1.1-types/cocos/XhrJsonTransport.d.ts +8 -0
  65. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231/0.1.1-types/cocos/index.d.ts +38 -0
  66. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231/0.1.1-types/core/PlayScopeClient.d.ts +46 -0
  67. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231/0.1.1-types/core/index.d.ts +3 -0
  68. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231/0.1.1-types/core/revenue.d.ts +25 -0
  69. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231/0.1.1-types/core/types.d.ts +81 -0
  70. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231/exports.json +89 -0
  71. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231/public-api.d.ts +281 -0
  72. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231//346/234/215/345/212/241/347/253/257/client-context.schema.json +103 -0
  73. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231//346/234/215/345/212/241/347/253/257/game-ad-properties.json +765 -0
  74. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231//346/234/215/345/212/241/347/253/257/game-builtin-properties.json +479 -0
  75. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231//346/234/215/345/212/241/347/253/257/game-event.json +278 -0
  76. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231//346/234/215/345/212/241/347/253/257/product-events.json +2878 -0
  77. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231//346/234/215/345/212/241/347/253/257/standard-contract.json +183 -0
  78. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231//346/234/215/345/212/241/347/253/257//344/272/247/345/223/201/344/272/213/344/273/266/347/264/242/345/274/225.md +87 -0
  79. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//345/217/202/350/200/203/350/265/204/346/226/231//346/235/245/346/272/220/344/270/216/347/211/210/346/234/254.json +35 -0
  80. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//347/244/272/344/276/213/CoreIntegration.ts +13 -0
  81. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//347/244/272/344/276/213/LevelPlayTelemetry.ts +119 -0
  82. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//347/244/272/344/276/213/PlayScopeExample.ts +46 -0
  83. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//347/244/272/344/276/213/QuestGarden.ts +129 -0
  84. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//347/244/272/344/276/213/README.md +23 -0
  85. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//347/244/272/344/276/213/project-fixture.json +188 -0
  86. package/doc//344/275/277/347/224/250/346/214/207/345/215/227//347/244/272/344/276/213/tsconfig.json +20 -0
  87. package/examples/cocos-minimal/PlayScopeExample.ts +27 -0
  88. package/examples/quest-garden/QuestGarden.ts +129 -0
  89. package/examples/quest-garden/README.md +180 -0
  90. package/examples/quest-garden/project-fixture.json +188 -0
  91. package/examples/quest-garden/tsconfig.json +12 -0
  92. package/package.json +73 -4
@@ -0,0 +1,479 @@
1
+ {
2
+ "app_first_open": {
3
+ "type": "object",
4
+ "additionalProperties": false,
5
+ "$defs": {
6
+ "Summary": {
7
+ "type": "object",
8
+ "properties": {
9
+ "score": {
10
+ "type": "number",
11
+ "minimum": -1000000000000,
12
+ "maximum": 1000000000000
13
+ },
14
+ "durationMs": {
15
+ "type": "integer",
16
+ "minimum": 0,
17
+ "maximum": 7776000000
18
+ },
19
+ "metrics": {
20
+ "type": "object",
21
+ "additionalProperties": {
22
+ "type": "number"
23
+ }
24
+ }
25
+ },
26
+ "additionalProperties": false
27
+ }
28
+ }
29
+ },
30
+ "app_foreground": {
31
+ "type": "object",
32
+ "additionalProperties": false,
33
+ "$defs": {
34
+ "Summary": {
35
+ "type": "object",
36
+ "properties": {
37
+ "score": {
38
+ "type": "number",
39
+ "minimum": -1000000000000,
40
+ "maximum": 1000000000000
41
+ },
42
+ "durationMs": {
43
+ "type": "integer",
44
+ "minimum": 0,
45
+ "maximum": 7776000000
46
+ },
47
+ "metrics": {
48
+ "type": "object",
49
+ "additionalProperties": {
50
+ "type": "number"
51
+ }
52
+ }
53
+ },
54
+ "additionalProperties": false
55
+ }
56
+ }
57
+ },
58
+ "app_background": {
59
+ "type": "object",
60
+ "additionalProperties": false,
61
+ "$defs": {
62
+ "Summary": {
63
+ "type": "object",
64
+ "properties": {
65
+ "score": {
66
+ "type": "number",
67
+ "minimum": -1000000000000,
68
+ "maximum": 1000000000000
69
+ },
70
+ "durationMs": {
71
+ "type": "integer",
72
+ "minimum": 0,
73
+ "maximum": 7776000000
74
+ },
75
+ "metrics": {
76
+ "type": "object",
77
+ "additionalProperties": {
78
+ "type": "number"
79
+ }
80
+ }
81
+ },
82
+ "additionalProperties": false
83
+ }
84
+ }
85
+ },
86
+ "screen_view": {
87
+ "type": "object",
88
+ "required": [
89
+ "screen"
90
+ ],
91
+ "properties": {
92
+ "screen": {
93
+ "type": "string",
94
+ "minLength": 1,
95
+ "maxLength": 256
96
+ }
97
+ },
98
+ "additionalProperties": false,
99
+ "$defs": {
100
+ "Summary": {
101
+ "type": "object",
102
+ "properties": {
103
+ "score": {
104
+ "type": "number",
105
+ "minimum": -1000000000000,
106
+ "maximum": 1000000000000
107
+ },
108
+ "durationMs": {
109
+ "type": "integer",
110
+ "minimum": 0,
111
+ "maximum": 7776000000
112
+ },
113
+ "metrics": {
114
+ "type": "object",
115
+ "additionalProperties": {
116
+ "type": "number"
117
+ }
118
+ }
119
+ },
120
+ "additionalProperties": false
121
+ }
122
+ }
123
+ },
124
+ "activity_heartbeat": {
125
+ "type": "object",
126
+ "required": [
127
+ "foregroundDeltaMs",
128
+ "gameplayDeltaMs"
129
+ ],
130
+ "properties": {
131
+ "foregroundDeltaMs": {
132
+ "type": "integer",
133
+ "minimum": 0,
134
+ "maximum": 86400000
135
+ },
136
+ "gameplayDeltaMs": {
137
+ "type": "integer",
138
+ "minimum": 0,
139
+ "maximum": 86400000
140
+ }
141
+ },
142
+ "additionalProperties": false,
143
+ "$defs": {
144
+ "Summary": {
145
+ "type": "object",
146
+ "properties": {
147
+ "score": {
148
+ "type": "number",
149
+ "minimum": -1000000000000,
150
+ "maximum": 1000000000000
151
+ },
152
+ "durationMs": {
153
+ "type": "integer",
154
+ "minimum": 0,
155
+ "maximum": 7776000000
156
+ },
157
+ "metrics": {
158
+ "type": "object",
159
+ "additionalProperties": {
160
+ "type": "number"
161
+ }
162
+ }
163
+ },
164
+ "additionalProperties": false
165
+ }
166
+ }
167
+ },
168
+ "run_created": {
169
+ "type": "object",
170
+ "additionalProperties": false,
171
+ "$defs": {
172
+ "Summary": {
173
+ "type": "object",
174
+ "properties": {
175
+ "score": {
176
+ "type": "number",
177
+ "minimum": -1000000000000,
178
+ "maximum": 1000000000000
179
+ },
180
+ "durationMs": {
181
+ "type": "integer",
182
+ "minimum": 0,
183
+ "maximum": 7776000000
184
+ },
185
+ "metrics": {
186
+ "type": "object",
187
+ "additionalProperties": {
188
+ "type": "number"
189
+ }
190
+ }
191
+ },
192
+ "additionalProperties": false
193
+ }
194
+ }
195
+ },
196
+ "run_started": {
197
+ "type": "object",
198
+ "additionalProperties": false,
199
+ "$defs": {
200
+ "Summary": {
201
+ "type": "object",
202
+ "properties": {
203
+ "score": {
204
+ "type": "number",
205
+ "minimum": -1000000000000,
206
+ "maximum": 1000000000000
207
+ },
208
+ "durationMs": {
209
+ "type": "integer",
210
+ "minimum": 0,
211
+ "maximum": 7776000000
212
+ },
213
+ "metrics": {
214
+ "type": "object",
215
+ "additionalProperties": {
216
+ "type": "number"
217
+ }
218
+ }
219
+ },
220
+ "additionalProperties": false
221
+ }
222
+ }
223
+ },
224
+ "run_paused": {
225
+ "type": "object",
226
+ "additionalProperties": false,
227
+ "$defs": {
228
+ "Summary": {
229
+ "type": "object",
230
+ "properties": {
231
+ "score": {
232
+ "type": "number",
233
+ "minimum": -1000000000000,
234
+ "maximum": 1000000000000
235
+ },
236
+ "durationMs": {
237
+ "type": "integer",
238
+ "minimum": 0,
239
+ "maximum": 7776000000
240
+ },
241
+ "metrics": {
242
+ "type": "object",
243
+ "additionalProperties": {
244
+ "type": "number"
245
+ }
246
+ }
247
+ },
248
+ "additionalProperties": false
249
+ }
250
+ }
251
+ },
252
+ "run_resumed": {
253
+ "type": "object",
254
+ "additionalProperties": false,
255
+ "$defs": {
256
+ "Summary": {
257
+ "type": "object",
258
+ "properties": {
259
+ "score": {
260
+ "type": "number",
261
+ "minimum": -1000000000000,
262
+ "maximum": 1000000000000
263
+ },
264
+ "durationMs": {
265
+ "type": "integer",
266
+ "minimum": 0,
267
+ "maximum": 7776000000
268
+ },
269
+ "metrics": {
270
+ "type": "object",
271
+ "additionalProperties": {
272
+ "type": "number"
273
+ }
274
+ }
275
+ },
276
+ "additionalProperties": false
277
+ }
278
+ }
279
+ },
280
+ "run_checkpoint": {
281
+ "type": "object",
282
+ "required": [
283
+ "summary"
284
+ ],
285
+ "properties": {
286
+ "summary": {
287
+ "$ref": "#/$defs/Summary"
288
+ }
289
+ },
290
+ "additionalProperties": false,
291
+ "$defs": {
292
+ "Summary": {
293
+ "type": "object",
294
+ "properties": {
295
+ "score": {
296
+ "type": "number",
297
+ "minimum": -1000000000000,
298
+ "maximum": 1000000000000
299
+ },
300
+ "durationMs": {
301
+ "type": "integer",
302
+ "minimum": 0,
303
+ "maximum": 7776000000
304
+ },
305
+ "metrics": {
306
+ "type": "object",
307
+ "additionalProperties": {
308
+ "type": "number"
309
+ }
310
+ }
311
+ },
312
+ "additionalProperties": false
313
+ }
314
+ }
315
+ },
316
+ "run_failed": {
317
+ "type": "object",
318
+ "required": [
319
+ "failureIndex"
320
+ ],
321
+ "properties": {
322
+ "failureIndex": {
323
+ "type": "integer",
324
+ "minimum": 1,
325
+ "maximum": 9007199254740991
326
+ },
327
+ "summary": {
328
+ "$ref": "#/$defs/Summary"
329
+ }
330
+ },
331
+ "additionalProperties": false,
332
+ "$defs": {
333
+ "Summary": {
334
+ "type": "object",
335
+ "properties": {
336
+ "score": {
337
+ "type": "number",
338
+ "minimum": -1000000000000,
339
+ "maximum": 1000000000000
340
+ },
341
+ "durationMs": {
342
+ "type": "integer",
343
+ "minimum": 0,
344
+ "maximum": 7776000000
345
+ },
346
+ "metrics": {
347
+ "type": "object",
348
+ "additionalProperties": {
349
+ "type": "number"
350
+ }
351
+ }
352
+ },
353
+ "additionalProperties": false
354
+ }
355
+ }
356
+ },
357
+ "run_revived": {
358
+ "type": "object",
359
+ "required": [
360
+ "failureIndex"
361
+ ],
362
+ "properties": {
363
+ "failureIndex": {
364
+ "type": "integer",
365
+ "minimum": 1,
366
+ "maximum": 9007199254740991
367
+ }
368
+ },
369
+ "additionalProperties": false,
370
+ "$defs": {
371
+ "Summary": {
372
+ "type": "object",
373
+ "properties": {
374
+ "score": {
375
+ "type": "number",
376
+ "minimum": -1000000000000,
377
+ "maximum": 1000000000000
378
+ },
379
+ "durationMs": {
380
+ "type": "integer",
381
+ "minimum": 0,
382
+ "maximum": 7776000000
383
+ },
384
+ "metrics": {
385
+ "type": "object",
386
+ "additionalProperties": {
387
+ "type": "number"
388
+ }
389
+ }
390
+ },
391
+ "additionalProperties": false
392
+ }
393
+ }
394
+ },
395
+ "run_ended": {
396
+ "type": "object",
397
+ "required": [
398
+ "outcome"
399
+ ],
400
+ "properties": {
401
+ "outcome": {
402
+ "enum": [
403
+ "won",
404
+ "lost",
405
+ "completed",
406
+ "draw",
407
+ "quit",
408
+ "restarted",
409
+ "replaced"
410
+ ]
411
+ },
412
+ "summary": {
413
+ "$ref": "#/$defs/Summary"
414
+ }
415
+ },
416
+ "additionalProperties": false,
417
+ "$defs": {
418
+ "Summary": {
419
+ "type": "object",
420
+ "properties": {
421
+ "score": {
422
+ "type": "number",
423
+ "minimum": -1000000000000,
424
+ "maximum": 1000000000000
425
+ },
426
+ "durationMs": {
427
+ "type": "integer",
428
+ "minimum": 0,
429
+ "maximum": 7776000000
430
+ },
431
+ "metrics": {
432
+ "type": "object",
433
+ "additionalProperties": {
434
+ "type": "number"
435
+ }
436
+ }
437
+ },
438
+ "additionalProperties": false
439
+ }
440
+ }
441
+ },
442
+ "config_received": {
443
+ "type": "object",
444
+ "required": [
445
+ "revision"
446
+ ],
447
+ "properties": {
448
+ "revision": {
449
+ "type": "string",
450
+ "pattern": "^[a-zA-Z0-9._-]{1,64}$"
451
+ }
452
+ },
453
+ "additionalProperties": false,
454
+ "$defs": {
455
+ "Summary": {
456
+ "type": "object",
457
+ "properties": {
458
+ "score": {
459
+ "type": "number",
460
+ "minimum": -1000000000000,
461
+ "maximum": 1000000000000
462
+ },
463
+ "durationMs": {
464
+ "type": "integer",
465
+ "minimum": 0,
466
+ "maximum": 7776000000
467
+ },
468
+ "metrics": {
469
+ "type": "object",
470
+ "additionalProperties": {
471
+ "type": "number"
472
+ }
473
+ }
474
+ },
475
+ "additionalProperties": false
476
+ }
477
+ }
478
+ }
479
+ }