@dcl/sdk 7.30.2-37804519171.commit-60e3717 → 7.30.2-37807847179.commit-24c42ea

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 (77) hide show
  1. package/atom.d.ts +19 -0
  2. package/atom.js +83 -0
  3. package/future.d.ts +8 -0
  4. package/future.js +26 -0
  5. package/internal/transports/rendererTransport.js +5 -2
  6. package/network/binary-message-bus.d.ts +6 -3
  7. package/network/binary-message-bus.js +9 -5
  8. package/network/chunking.d.ts +5 -0
  9. package/network/chunking.js +38 -0
  10. package/network/events/implementation.d.ts +93 -0
  11. package/network/events/implementation.js +221 -0
  12. package/network/events/index.d.ts +42 -0
  13. package/network/events/index.js +43 -0
  14. package/network/events/protocol.d.ts +27 -0
  15. package/network/events/protocol.js +66 -0
  16. package/network/events/registry.d.ts +8 -0
  17. package/network/events/registry.js +3 -0
  18. package/network/index.d.ts +8 -2
  19. package/network/index.js +16 -3
  20. package/network/message-bus-sync.d.ts +16 -3
  21. package/network/message-bus-sync.js +164 -103
  22. package/network/server/index.d.ts +14 -0
  23. package/network/server/index.js +256 -0
  24. package/network/server/utils.d.ts +18 -0
  25. package/network/server/utils.js +135 -0
  26. package/network/state.js +3 -5
  27. package/package.json +6 -6
  28. package/server/env-var.d.ts +15 -0
  29. package/server/env-var.js +31 -0
  30. package/server/index.d.ts +2 -0
  31. package/server/index.js +3 -0
  32. package/server/storage/constants.d.ts +80 -0
  33. package/server/storage/constants.js +19 -0
  34. package/server/storage/error-message.d.ts +1 -0
  35. package/server/storage/error-message.js +9 -0
  36. package/server/storage/index.d.ts +54 -0
  37. package/server/storage/index.js +60 -0
  38. package/server/storage/player.d.ts +60 -0
  39. package/server/storage/player.js +244 -0
  40. package/server/storage/scene.d.ts +55 -0
  41. package/server/storage/scene.js +232 -0
  42. package/server/storage/serialize.d.ts +1 -0
  43. package/server/storage/serialize.js +135 -0
  44. package/server/storage/value-cache.d.ts +1 -0
  45. package/server/storage/value-cache.js +67 -0
  46. package/server/storage/write-queue.d.ts +1 -0
  47. package/server/storage/write-queue.js +113 -0
  48. package/server/storage-url.d.ts +13 -0
  49. package/server/storage-url.js +42 -0
  50. package/server/utils.d.ts +35 -0
  51. package/server/utils.js +69 -0
  52. package/src/atom.ts +98 -0
  53. package/src/future.ts +38 -0
  54. package/src/internal/transports/rendererTransport.ts +4 -1
  55. package/src/network/binary-message-bus.ts +9 -4
  56. package/src/network/chunking.ts +45 -0
  57. package/src/network/events/implementation.ts +271 -0
  58. package/src/network/events/index.ts +48 -0
  59. package/src/network/events/protocol.ts +94 -0
  60. package/src/network/events/registry.ts +18 -0
  61. package/src/network/index.ts +40 -3
  62. package/src/network/message-bus-sync.ts +180 -112
  63. package/src/network/server/index.ts +341 -0
  64. package/src/network/server/utils.ts +189 -0
  65. package/src/network/state.ts +3 -4
  66. package/src/server/env-var.ts +36 -0
  67. package/src/server/index.ts +12 -0
  68. package/src/server/storage/constants.ts +112 -0
  69. package/src/server/storage/error-message.ts +8 -0
  70. package/src/server/storage/index.ts +83 -0
  71. package/src/server/storage/player.ts +345 -0
  72. package/src/server/storage/scene.ts +324 -0
  73. package/src/server/storage/serialize.ts +132 -0
  74. package/src/server/storage/value-cache.ts +119 -0
  75. package/src/server/storage/write-queue.ts +174 -0
  76. package/src/server/storage-url.ts +49 -0
  77. package/src/server/utils.ts +83 -0
@@ -0,0 +1,31 @@
1
+ import { getStorageServerUrl } from './storage-url';
2
+ import { assertIsServer, wrapSignedFetch } from './utils';
3
+ const MODULE_NAME = 'EnvVar';
4
+ /**
5
+ * EnvVar provides methods to fetch environment variables from the
6
+ * Server Side Storage service. This module only works when running
7
+ * on server-side scenes.
8
+ */
9
+ export const EnvVar = {
10
+ /**
11
+ * Fetches a specific environment variable by key as plain text.
12
+ *
13
+ * @param key - The name of the environment variable to fetch
14
+ * @returns A promise that resolves to the plain text value, or empty string if not found
15
+ * @throws Error if not running on a server-side scene
16
+ */
17
+ async get(key) {
18
+ assertIsServer(MODULE_NAME);
19
+ const baseUrl = await getStorageServerUrl();
20
+ const url = `${baseUrl}/env/${encodeURIComponent(key)}`;
21
+ const [error, data] = await wrapSignedFetch({
22
+ url
23
+ });
24
+ if (error) {
25
+ console.error(`Failed to fetch environment variable '${key}': ${error}`);
26
+ return '';
27
+ }
28
+ return data?.value ?? '';
29
+ }
30
+ };
31
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZW52LXZhci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9zZXJ2ZXIvZW52LXZhci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsbUJBQW1CLEVBQUUsTUFBTSxlQUFlLENBQUE7QUFDbkQsT0FBTyxFQUFFLGNBQWMsRUFBRSxlQUFlLEVBQUUsTUFBTSxTQUFTLENBQUE7QUFFekQsTUFBTSxXQUFXLEdBQUcsUUFBUSxDQUFBO0FBRTVCOzs7O0dBSUc7QUFDSCxNQUFNLENBQUMsTUFBTSxNQUFNLEdBQUc7SUFDcEI7Ozs7OztPQU1HO0lBQ0gsS0FBSyxDQUFDLEdBQUcsQ0FBQyxHQUFXO1FBQ25CLGNBQWMsQ0FBQyxXQUFXLENBQUMsQ0FBQTtRQUUzQixNQUFNLE9BQU8sR0FBRyxNQUFNLG1CQUFtQixFQUFFLENBQUE7UUFDM0MsTUFBTSxHQUFHLEdBQUcsR0FBRyxPQUFPLFFBQVEsa0JBQWtCLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQTtRQUV2RCxNQUFNLENBQUMsS0FBSyxFQUFFLElBQUksQ0FBQyxHQUFHLE1BQU0sZUFBZSxDQUFvQjtZQUM3RCxHQUFHO1NBQ0osQ0FBQyxDQUFBO1FBRUYsSUFBSSxLQUFLLEVBQUU7WUFDVCxPQUFPLENBQUMsS0FBSyxDQUFDLHlDQUF5QyxHQUFHLE1BQU0sS0FBSyxFQUFFLENBQUMsQ0FBQTtZQUN4RSxPQUFPLEVBQUUsQ0FBQTtTQUNWO1FBRUQsT0FBTyxJQUFJLEVBQUUsS0FBSyxJQUFJLEVBQUUsQ0FBQTtJQUMxQixDQUFDO0NBQ0YsQ0FBQSIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IGdldFN0b3JhZ2VTZXJ2ZXJVcmwgfSBmcm9tICcuL3N0b3JhZ2UtdXJsJ1xuaW1wb3J0IHsgYXNzZXJ0SXNTZXJ2ZXIsIHdyYXBTaWduZWRGZXRjaCB9IGZyb20gJy4vdXRpbHMnXG5cbmNvbnN0IE1PRFVMRV9OQU1FID0gJ0VudlZhcidcblxuLyoqXG4gKiBFbnZWYXIgcHJvdmlkZXMgbWV0aG9kcyB0byBmZXRjaCBlbnZpcm9ubWVudCB2YXJpYWJsZXMgZnJvbSB0aGVcbiAqIFNlcnZlciBTaWRlIFN0b3JhZ2Ugc2VydmljZS4gVGhpcyBtb2R1bGUgb25seSB3b3JrcyB3aGVuIHJ1bm5pbmdcbiAqIG9uIHNlcnZlci1zaWRlIHNjZW5lcy5cbiAqL1xuZXhwb3J0IGNvbnN0IEVudlZhciA9IHtcbiAgLyoqXG4gICAqIEZldGNoZXMgYSBzcGVjaWZpYyBlbnZpcm9ubWVudCB2YXJpYWJsZSBieSBrZXkgYXMgcGxhaW4gdGV4dC5cbiAgICpcbiAgICogQHBhcmFtIGtleSAtIFRoZSBuYW1lIG9mIHRoZSBlbnZpcm9ubWVudCB2YXJpYWJsZSB0byBmZXRjaFxuICAgKiBAcmV0dXJucyBBIHByb21pc2UgdGhhdCByZXNvbHZlcyB0byB0aGUgcGxhaW4gdGV4dCB2YWx1ZSwgb3IgZW1wdHkgc3RyaW5nIGlmIG5vdCBmb3VuZFxuICAgKiBAdGhyb3dzIEVycm9yIGlmIG5vdCBydW5uaW5nIG9uIGEgc2VydmVyLXNpZGUgc2NlbmVcbiAgICovXG4gIGFzeW5jIGdldChrZXk6IHN0cmluZyk6IFByb21pc2U8c3RyaW5nPiB7XG4gICAgYXNzZXJ0SXNTZXJ2ZXIoTU9EVUxFX05BTUUpXG5cbiAgICBjb25zdCBiYXNlVXJsID0gYXdhaXQgZ2V0U3RvcmFnZVNlcnZlclVybCgpXG4gICAgY29uc3QgdXJsID0gYCR7YmFzZVVybH0vZW52LyR7ZW5jb2RlVVJJQ29tcG9uZW50KGtleSl9YFxuXG4gICAgY29uc3QgW2Vycm9yLCBkYXRhXSA9IGF3YWl0IHdyYXBTaWduZWRGZXRjaDx7IHZhbHVlOiBzdHJpbmcgfT4oe1xuICAgICAgdXJsXG4gICAgfSlcblxuICAgIGlmIChlcnJvcikge1xuICAgICAgY29uc29sZS5lcnJvcihgRmFpbGVkIHRvIGZldGNoIGVudmlyb25tZW50IHZhcmlhYmxlICcke2tleX0nOiAke2Vycm9yfWApXG4gICAgICByZXR1cm4gJydcbiAgICB9XG5cbiAgICByZXR1cm4gZGF0YT8udmFsdWUgPz8gJydcbiAgfVxufVxuIl19
@@ -0,0 +1,2 @@
1
+ export { EnvVar } from './env-var';
2
+ export { Storage, IStorage, ISceneStorage, IPlayerStorage, GetOptions, GetValuesOptions, GetValuesResult, SetOptions, StorageOptions } from './storage';
@@ -0,0 +1,3 @@
1
+ export { EnvVar } from './env-var';
2
+ export { Storage } from './storage';
3
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvc2VydmVyL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxNQUFNLEVBQUUsTUFBTSxXQUFXLENBQUE7QUFDbEMsT0FBTyxFQUNMLE9BQU8sRUFTUixNQUFNLFdBQVcsQ0FBQSIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCB7IEVudlZhciB9IGZyb20gJy4vZW52LXZhcidcbmV4cG9ydCB7XG4gIFN0b3JhZ2UsXG4gIElTdG9yYWdlLFxuICBJU2NlbmVTdG9yYWdlLFxuICBJUGxheWVyU3RvcmFnZSxcbiAgR2V0T3B0aW9ucyxcbiAgR2V0VmFsdWVzT3B0aW9ucyxcbiAgR2V0VmFsdWVzUmVzdWx0LFxuICBTZXRPcHRpb25zLFxuICBTdG9yYWdlT3B0aW9uc1xufSBmcm9tICcuL3N0b3JhZ2UnXG4iXX0=
@@ -0,0 +1,80 @@
1
+ export declare const MODULE_NAME = "Storage";
2
+ /**
3
+ * Options for getValues pagination and filtering.
4
+ */
5
+ export interface GetValuesOptions {
6
+ prefix?: string;
7
+ limit?: number;
8
+ offset?: number;
9
+ }
10
+ /**
11
+ * Result of getValues with pagination metadata.
12
+ */
13
+ export interface GetValuesResult {
14
+ /** Key-value entries for the current page. */
15
+ data: Array<{
16
+ key: string;
17
+ value: unknown;
18
+ }>;
19
+ pagination: {
20
+ offset: number;
21
+ total: number;
22
+ };
23
+ }
24
+ /**
25
+ * Per-call options for Storage get().
26
+ */
27
+ export interface GetOptions {
28
+ /**
29
+ * When true, bypasses the read cache and forces a network read (the result
30
+ * still refreshes the cache). Concurrent gets for the same key still share
31
+ * one in-flight request. Default: false.
32
+ */
33
+ fresh?: boolean;
34
+ }
35
+ /**
36
+ * Per-call options for Storage set().
37
+ */
38
+ export interface SetOptions {
39
+ /**
40
+ * When true, skips the network write if the serialized value matches the
41
+ * last value known to be stored for this key (from a previous successful
42
+ * set(), get() or getValues()). Overrides the configured default. Default: true.
43
+ */
44
+ skipIfUnchanged?: boolean;
45
+ }
46
+ /**
47
+ * Module-wide configuration for Storage, applied to both scene-scoped and
48
+ * player-scoped storage via Storage.configure().
49
+ */
50
+ export interface StorageOptions {
51
+ /**
52
+ * Default for set()'s skipIfUnchanged when not passed per call. A skip only
53
+ * suppresses a proven no-op: the exact serialized value was confirmed stored
54
+ * by a previous network round-trip within cacheMaxAgeMs. Default: true.
55
+ */
56
+ skipIfUnchanged?: boolean;
57
+ /**
58
+ * When true, get() serves values from the local cache within cacheMaxAgeMs,
59
+ * including confirmed "not found" results, without a network request.
60
+ * Out-of-band writers (e.g. CLI storage commands) may not be visible for up
61
+ * to cacheMaxAgeMs; pass { fresh: true } per call to force a network read.
62
+ * Default: true.
63
+ */
64
+ cacheReads?: boolean;
65
+ /**
66
+ * Max cache entries per scope (scene / player) before oldest entries are
67
+ * evicted. Entries hold the serialized value body, so memory scales with
68
+ * value size — this bounds entry count, not bytes. Infinity removes the bound.
69
+ * Default: 512.
70
+ */
71
+ cacheMaxEntries?: number;
72
+ /**
73
+ * Max age of a cache entry in milliseconds, bounding both read-cache
74
+ * staleness and write-dedup trust; older entries are treated as unknown.
75
+ * The default is deliberately short so out-of-band writers (CLI storage
76
+ * commands, dashboards) become visible within a minute, while still
77
+ * absorbing hot per-frame reads. Infinity never expires. Default: 60000 (1 minute).
78
+ */
79
+ cacheMaxAgeMs?: number;
80
+ }
@@ -0,0 +1,19 @@
1
+ export const MODULE_NAME = 'Storage';
2
+ /**
3
+ * Default values for the resolved storage configuration.
4
+ * @internal
5
+ */
6
+ export const DEFAULT_STORAGE_CONFIG = {
7
+ skipIfUnchanged: true,
8
+ cacheReads: true,
9
+ cacheMaxEntries: 512,
10
+ cacheMaxAgeMs: 60 * 1000
11
+ };
12
+ /**
13
+ * Creates a mutable config object, later mutated by Storage.configure().
14
+ * @internal
15
+ */
16
+ export function createStorageConfig(overrides) {
17
+ return { ...DEFAULT_STORAGE_CONFIG, ...overrides };
18
+ }
19
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3NlcnZlci9zdG9yYWdlL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxNQUFNLENBQUMsTUFBTSxXQUFXLEdBQUcsU0FBUyxDQUFBO0FBOEZwQzs7O0dBR0c7QUFDSCxNQUFNLENBQUMsTUFBTSxzQkFBc0IsR0FBaUM7SUFDbEUsZUFBZSxFQUFFLElBQUk7SUFDckIsVUFBVSxFQUFFLElBQUk7SUFDaEIsZUFBZSxFQUFFLEdBQUc7SUFDcEIsYUFBYSxFQUFFLEVBQUUsR0FBRyxJQUFJO0NBQ3pCLENBQUE7QUFFRDs7O0dBR0c7QUFDSCxNQUFNLFVBQVUsbUJBQW1CLENBQUMsU0FBMEI7SUFDNUQsT0FBTyxFQUFFLEdBQUcsc0JBQXNCLEVBQUUsR0FBRyxTQUFTLEVBQUUsQ0FBQTtBQUNwRCxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IGNvbnN0IE1PRFVMRV9OQU1FID0gJ1N0b3JhZ2UnXG5cbi8qKlxuICogT3B0aW9ucyBmb3IgZ2V0VmFsdWVzIHBhZ2luYXRpb24gYW5kIGZpbHRlcmluZy5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBHZXRWYWx1ZXNPcHRpb25zIHtcbiAgcHJlZml4Pzogc3RyaW5nXG4gIGxpbWl0PzogbnVtYmVyXG4gIG9mZnNldD86IG51bWJlclxufVxuXG4vKipcbiAqIFJlc3VsdCBvZiBnZXRWYWx1ZXMgd2l0aCBwYWdpbmF0aW9uIG1ldGFkYXRhLlxuICovXG5leHBvcnQgaW50ZXJmYWNlIEdldFZhbHVlc1Jlc3VsdCB7XG4gIC8qKiBLZXktdmFsdWUgZW50cmllcyBmb3IgdGhlIGN1cnJlbnQgcGFnZS4gKi9cbiAgZGF0YTogQXJyYXk8eyBrZXk6IHN0cmluZzsgdmFsdWU6IHVua25vd24gfT5cbiAgcGFnaW5hdGlvbjoge1xuICAgIG9mZnNldDogbnVtYmVyXG4gICAgdG90YWw6IG51bWJlclxuICB9XG59XG5cbi8qKlxuICogUGVyLWNhbGwgb3B0aW9ucyBmb3IgU3RvcmFnZSBnZXQoKS5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBHZXRPcHRpb25zIHtcbiAgLyoqXG4gICAqIFdoZW4gdHJ1ZSwgYnlwYXNzZXMgdGhlIHJlYWQgY2FjaGUgYW5kIGZvcmNlcyBhIG5ldHdvcmsgcmVhZCAodGhlIHJlc3VsdFxuICAgKiBzdGlsbCByZWZyZXNoZXMgdGhlIGNhY2hlKS4gQ29uY3VycmVudCBnZXRzIGZvciB0aGUgc2FtZSBrZXkgc3RpbGwgc2hhcmVcbiAgICogb25lIGluLWZsaWdodCByZXF1ZXN0LiBEZWZhdWx0OiBmYWxzZS5cbiAgICovXG4gIGZyZXNoPzogYm9vbGVhblxufVxuXG4vKipcbiAqIFBlci1jYWxsIG9wdGlvbnMgZm9yIFN0b3JhZ2Ugc2V0KCkuXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgU2V0T3B0aW9ucyB7XG4gIC8qKlxuICAgKiBXaGVuIHRydWUsIHNraXBzIHRoZSBuZXR3b3JrIHdyaXRlIGlmIHRoZSBzZXJpYWxpemVkIHZhbHVlIG1hdGNoZXMgdGhlXG4gICAqIGxhc3QgdmFsdWUga25vd24gdG8gYmUgc3RvcmVkIGZvciB0aGlzIGtleSAoZnJvbSBhIHByZXZpb3VzIHN1Y2Nlc3NmdWxcbiAgICogc2V0KCksIGdldCgpIG9yIGdldFZhbHVlcygpKS4gT3ZlcnJpZGVzIHRoZSBjb25maWd1cmVkIGRlZmF1bHQuIERlZmF1bHQ6IHRydWUuXG4gICAqL1xuICBza2lwSWZVbmNoYW5nZWQ/OiBib29sZWFuXG59XG5cbi8qKlxuICogTW9kdWxlLXdpZGUgY29uZmlndXJhdGlvbiBmb3IgU3RvcmFnZSwgYXBwbGllZCB0byBib3RoIHNjZW5lLXNjb3BlZCBhbmRcbiAqIHBsYXllci1zY29wZWQgc3RvcmFnZSB2aWEgU3RvcmFnZS5jb25maWd1cmUoKS5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBTdG9yYWdlT3B0aW9ucyB7XG4gIC8qKlxuICAgKiBEZWZhdWx0IGZvciBzZXQoKSdzIHNraXBJZlVuY2hhbmdlZCB3aGVuIG5vdCBwYXNzZWQgcGVyIGNhbGwuIEEgc2tpcCBvbmx5XG4gICAqIHN1cHByZXNzZXMgYSBwcm92ZW4gbm8tb3A6IHRoZSBleGFjdCBzZXJpYWxpemVkIHZhbHVlIHdhcyBjb25maXJtZWQgc3RvcmVkXG4gICAqIGJ5IGEgcHJldmlvdXMgbmV0d29yayByb3VuZC10cmlwIHdpdGhpbiBjYWNoZU1heEFnZU1zLiBEZWZhdWx0OiB0cnVlLlxuICAgKi9cbiAgc2tpcElmVW5jaGFuZ2VkPzogYm9vbGVhblxuICAvKipcbiAgICogV2hlbiB0cnVlLCBnZXQoKSBzZXJ2ZXMgdmFsdWVzIGZyb20gdGhlIGxvY2FsIGNhY2hlIHdpdGhpbiBjYWNoZU1heEFnZU1zLFxuICAgKiBpbmNsdWRpbmcgY29uZmlybWVkIFwibm90IGZvdW5kXCIgcmVzdWx0cywgd2l0aG91dCBhIG5ldHdvcmsgcmVxdWVzdC5cbiAgICogT3V0LW9mLWJhbmQgd3JpdGVycyAoZS5nLiBDTEkgc3RvcmFnZSBjb21tYW5kcykgbWF5IG5vdCBiZSB2aXNpYmxlIGZvciB1cFxuICAgKiB0byBjYWNoZU1heEFnZU1zOyBwYXNzIHsgZnJlc2g6IHRydWUgfSBwZXIgY2FsbCB0byBmb3JjZSBhIG5ldHdvcmsgcmVhZC5cbiAgICogRGVmYXVsdDogdHJ1ZS5cbiAgICovXG4gIGNhY2hlUmVhZHM/OiBib29sZWFuXG4gIC8qKlxuICAgKiBNYXggY2FjaGUgZW50cmllcyBwZXIgc2NvcGUgKHNjZW5lIC8gcGxheWVyKSBiZWZvcmUgb2xkZXN0IGVudHJpZXMgYXJlXG4gICAqIGV2aWN0ZWQuIEVudHJpZXMgaG9sZCB0aGUgc2VyaWFsaXplZCB2YWx1ZSBib2R5LCBzbyBtZW1vcnkgc2NhbGVzIHdpdGhcbiAgICogdmFsdWUgc2l6ZSDigJQgdGhpcyBib3VuZHMgZW50cnkgY291bnQsIG5vdCBieXRlcy4gSW5maW5pdHkgcmVtb3ZlcyB0aGUgYm91bmQuXG4gICAqIERlZmF1bHQ6IDUxMi5cbiAgICovXG4gIGNhY2hlTWF4RW50cmllcz86IG51bWJlclxuICAvKipcbiAgICogTWF4IGFnZSBvZiBhIGNhY2hlIGVudHJ5IGluIG1pbGxpc2Vjb25kcywgYm91bmRpbmcgYm90aCByZWFkLWNhY2hlXG4gICAqIHN0YWxlbmVzcyBhbmQgd3JpdGUtZGVkdXAgdHJ1c3Q7IG9sZGVyIGVudHJpZXMgYXJlIHRyZWF0ZWQgYXMgdW5rbm93bi5cbiAgICogVGhlIGRlZmF1bHQgaXMgZGVsaWJlcmF0ZWx5IHNob3J0IHNvIG91dC1vZi1iYW5kIHdyaXRlcnMgKENMSSBzdG9yYWdlXG4gICAqIGNvbW1hbmRzLCBkYXNoYm9hcmRzKSBiZWNvbWUgdmlzaWJsZSB3aXRoaW4gYSBtaW51dGUsIHdoaWxlIHN0aWxsXG4gICAqIGFic29yYmluZyBob3QgcGVyLWZyYW1lIHJlYWRzLiBJbmZpbml0eSBuZXZlciBleHBpcmVzLiBEZWZhdWx0OiA2MDAwMCAoMSBtaW51dGUpLlxuICAgKi9cbiAgY2FjaGVNYXhBZ2VNcz86IG51bWJlclxufVxuXG4vKipcbiAqIEZ1bGx5LXJlc29sdmVkIHN0b3JhZ2UgY29uZmlndXJhdGlvbiBzaGFyZWQgYnkgc2NlbmUgYW5kIHBsYXllciBzdG9yYWdlLlxuICogQGludGVybmFsXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgU3RvcmFnZUNvbmZpZ1N0YXRlIHtcbiAgc2tpcElmVW5jaGFuZ2VkOiBib29sZWFuXG4gIGNhY2hlUmVhZHM6IGJvb2xlYW5cbiAgY2FjaGVNYXhFbnRyaWVzOiBudW1iZXJcbiAgY2FjaGVNYXhBZ2VNczogbnVtYmVyXG59XG5cbi8qKlxuICogRGVmYXVsdCB2YWx1ZXMgZm9yIHRoZSByZXNvbHZlZCBzdG9yYWdlIGNvbmZpZ3VyYXRpb24uXG4gKiBAaW50ZXJuYWxcbiAqL1xuZXhwb3J0IGNvbnN0IERFRkFVTFRfU1RPUkFHRV9DT05GSUc6IFJlYWRvbmx5PFN0b3JhZ2VDb25maWdTdGF0ZT4gPSB7XG4gIHNraXBJZlVuY2hhbmdlZDogdHJ1ZSxcbiAgY2FjaGVSZWFkczogdHJ1ZSxcbiAgY2FjaGVNYXhFbnRyaWVzOiA1MTIsXG4gIGNhY2hlTWF4QWdlTXM6IDYwICogMTAwMFxufVxuXG4vKipcbiAqIENyZWF0ZXMgYSBtdXRhYmxlIGNvbmZpZyBvYmplY3QsIGxhdGVyIG11dGF0ZWQgYnkgU3RvcmFnZS5jb25maWd1cmUoKS5cbiAqIEBpbnRlcm5hbFxuICovXG5leHBvcnQgZnVuY3Rpb24gY3JlYXRlU3RvcmFnZUNvbmZpZyhvdmVycmlkZXM/OiBTdG9yYWdlT3B0aW9ucyk6IFN0b3JhZ2VDb25maWdTdGF0ZSB7XG4gIHJldHVybiB7IC4uLkRFRkFVTFRfU1RPUkFHRV9DT05GSUcsIC4uLm92ZXJyaWRlcyB9XG59XG4iXX0=
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,9 @@
1
+ /**
2
+ * The message of a thrown value, or `fallback` when it carries none.
3
+ * @internal
4
+ */
5
+ export function errorMessage(error, fallback = 'unknown error') {
6
+ const message = error instanceof Error ? error.message : typeof error === 'string' ? error : '';
7
+ return message || fallback;
8
+ }
9
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXJyb3ItbWVzc2FnZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9zZXJ2ZXIvc3RvcmFnZS9lcnJvci1tZXNzYWdlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOzs7R0FHRztBQUNILE1BQU0sVUFBVSxZQUFZLENBQUMsS0FBYyxFQUFFLFFBQVEsR0FBRyxlQUFlO0lBQ3JFLE1BQU0sT0FBTyxHQUFHLEtBQUssWUFBWSxLQUFLLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLE9BQU8sS0FBSyxLQUFLLFFBQVEsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUE7SUFDL0YsT0FBTyxPQUFPLElBQUksUUFBUSxDQUFBO0FBQzVCLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIFRoZSBtZXNzYWdlIG9mIGEgdGhyb3duIHZhbHVlLCBvciBgZmFsbGJhY2tgIHdoZW4gaXQgY2FycmllcyBub25lLlxuICogQGludGVybmFsXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBlcnJvck1lc3NhZ2UoZXJyb3I6IHVua25vd24sIGZhbGxiYWNrID0gJ3Vua25vd24gZXJyb3InKTogc3RyaW5nIHtcbiAgY29uc3QgbWVzc2FnZSA9IGVycm9yIGluc3RhbmNlb2YgRXJyb3IgPyBlcnJvci5tZXNzYWdlIDogdHlwZW9mIGVycm9yID09PSAnc3RyaW5nJyA/IGVycm9yIDogJydcbiAgcmV0dXJuIG1lc3NhZ2UgfHwgZmFsbGJhY2tcbn1cbiJdfQ==
@@ -0,0 +1,54 @@
1
+ import { StorageOptions } from './constants';
2
+ import { ISceneStorage } from './scene';
3
+ import { IPlayerStorage } from './player';
4
+ export { GetOptions, GetValuesOptions, GetValuesResult, SetOptions, StorageOptions } from './constants';
5
+ export { ISceneStorage } from './scene';
6
+ export { IPlayerStorage } from './player';
7
+ /**
8
+ * Storage interface with methods for scene-scoped and player-scoped storage.
9
+ */
10
+ export interface IStorage extends ISceneStorage {
11
+ /** Player-scoped storage for key-value pairs */
12
+ player: IPlayerStorage;
13
+ /**
14
+ * Sets module-wide defaults for both scene-scoped and player-scoped storage.
15
+ * Merges the given partial options into the current configuration.
16
+ * Note: cacheMaxEntries applies per scope (scene and player each keep their
17
+ * own cache) and bounds entry count, not bytes (entries hold serialized
18
+ * value bodies).
19
+ */
20
+ configure(options: StorageOptions): void;
21
+ }
22
+ /**
23
+ * Storage provides methods to store and retrieve key-value data from the
24
+ * Server Side Storage service.
25
+ *
26
+ * - Use Storage.get/set/delete/getValues for scene-scoped storage
27
+ * - Use Storage.player.get/set/delete/getValues for player-scoped storage
28
+ * - Use Storage.configure to change module-wide defaults (e.g. skipIfUnchanged, cacheReads)
29
+ *
30
+ * A failure is never reported as absence. A read that fails throws; get() resolves
31
+ * null only for a confirmed absence (a 404, or a delete that landed) or a stored
32
+ * JSON null, and getValues() returns an empty page only for a genuinely empty
33
+ * listing. A delete that fails throws, and resolves false only for a confirmed 404.
34
+ * set() reports failure through its boolean result, and throws for a value that
35
+ * cannot be JSON-serialized. A get() issued while writes to its key are pending
36
+ * waits for them, so it reflects them; getValues() does not wait. Nothing is
37
+ * retried — that is the caller's to decide.
38
+ *
39
+ * Reads are cached by default: get() serves values known from a network
40
+ * round-trip within the last cacheMaxAgeMs (including confirmed "not found"
41
+ * results) without hitting the service, and concurrent gets for the same key
42
+ * share one request. Overlapping writes to the same key are serialized so the
43
+ * service commits them in issue order, and rapid writes coalesce to the
44
+ * latest value; a set()/delete() settles once its own write, or the newer
45
+ * write that replaced it, lands or fails. By default (skipIfUnchanged)
46
+ * an unchanged set is skipped, but only when a previous confirmed round-trip
47
+ * proved the exact value is already stored. Out-of-band writers (e.g. CLI storage commands)
48
+ * may not be visible for up to cacheMaxAgeMs; use get(key, { fresh: true })
49
+ * for an authoritative read or Storage.configure({ cacheReads: false }) to
50
+ * disable read caching.
51
+ *
52
+ * This module only works when running on server-side scenes.
53
+ */
54
+ export declare const Storage: IStorage;
@@ -0,0 +1,60 @@
1
+ import { createStorageConfig } from './constants';
2
+ import { createSceneStorage } from './scene';
3
+ import { createPlayerStorage } from './player';
4
+ /**
5
+ * Creates the Storage module with scene-scoped and player-scoped storage.
6
+ */
7
+ const createStorage = () => {
8
+ const config = createStorageConfig();
9
+ const sceneStorage = createSceneStorage(config);
10
+ const playerStorage = createPlayerStorage(config);
11
+ return {
12
+ // Spread scene storage methods at top level
13
+ get: sceneStorage.get,
14
+ set: sceneStorage.set,
15
+ delete: sceneStorage.delete,
16
+ getValues: sceneStorage.getValues,
17
+ // Keep player as nested property
18
+ player: playerStorage,
19
+ configure(options) {
20
+ for (const [key, value] of Object.entries(options)) {
21
+ if (value !== undefined)
22
+ config[key] = value;
23
+ }
24
+ }
25
+ };
26
+ };
27
+ /**
28
+ * Storage provides methods to store and retrieve key-value data from the
29
+ * Server Side Storage service.
30
+ *
31
+ * - Use Storage.get/set/delete/getValues for scene-scoped storage
32
+ * - Use Storage.player.get/set/delete/getValues for player-scoped storage
33
+ * - Use Storage.configure to change module-wide defaults (e.g. skipIfUnchanged, cacheReads)
34
+ *
35
+ * A failure is never reported as absence. A read that fails throws; get() resolves
36
+ * null only for a confirmed absence (a 404, or a delete that landed) or a stored
37
+ * JSON null, and getValues() returns an empty page only for a genuinely empty
38
+ * listing. A delete that fails throws, and resolves false only for a confirmed 404.
39
+ * set() reports failure through its boolean result, and throws for a value that
40
+ * cannot be JSON-serialized. A get() issued while writes to its key are pending
41
+ * waits for them, so it reflects them; getValues() does not wait. Nothing is
42
+ * retried — that is the caller's to decide.
43
+ *
44
+ * Reads are cached by default: get() serves values known from a network
45
+ * round-trip within the last cacheMaxAgeMs (including confirmed "not found"
46
+ * results) without hitting the service, and concurrent gets for the same key
47
+ * share one request. Overlapping writes to the same key are serialized so the
48
+ * service commits them in issue order, and rapid writes coalesce to the
49
+ * latest value; a set()/delete() settles once its own write, or the newer
50
+ * write that replaced it, lands or fails. By default (skipIfUnchanged)
51
+ * an unchanged set is skipped, but only when a previous confirmed round-trip
52
+ * proved the exact value is already stored. Out-of-band writers (e.g. CLI storage commands)
53
+ * may not be visible for up to cacheMaxAgeMs; use get(key, { fresh: true })
54
+ * for an authoritative read or Storage.configure({ cacheReads: false }) to
55
+ * disable read caching.
56
+ *
57
+ * This module only works when running on server-side scenes.
58
+ */
59
+ export const Storage = createStorage();
60
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvc2VydmVyL3N0b3JhZ2UvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLG1CQUFtQixFQUFrQixNQUFNLGFBQWEsQ0FBQTtBQUNqRSxPQUFPLEVBQUUsa0JBQWtCLEVBQWlCLE1BQU0sU0FBUyxDQUFBO0FBQzNELE9BQU8sRUFBRSxtQkFBbUIsRUFBa0IsTUFBTSxVQUFVLENBQUE7QUF3QjlEOztHQUVHO0FBQ0gsTUFBTSxhQUFhLEdBQUcsR0FBYSxFQUFFO0lBQ25DLE1BQU0sTUFBTSxHQUFHLG1CQUFtQixFQUFFLENBQUE7SUFDcEMsTUFBTSxZQUFZLEdBQUcsa0JBQWtCLENBQUMsTUFBTSxDQUFDLENBQUE7SUFDL0MsTUFBTSxhQUFhLEdBQUcsbUJBQW1CLENBQUMsTUFBTSxDQUFDLENBQUE7SUFFakQsT0FBTztRQUNMLDRDQUE0QztRQUM1QyxHQUFHLEVBQUUsWUFBWSxDQUFDLEdBQUc7UUFDckIsR0FBRyxFQUFFLFlBQVksQ0FBQyxHQUFHO1FBQ3JCLE1BQU0sRUFBRSxZQUFZLENBQUMsTUFBTTtRQUMzQixTQUFTLEVBQUUsWUFBWSxDQUFDLFNBQVM7UUFDakMsaUNBQWlDO1FBQ2pDLE1BQU0sRUFBRSxhQUFhO1FBQ3JCLFNBQVMsQ0FBQyxPQUF1QjtZQUMvQixLQUFLLE1BQU0sQ0FBQyxHQUFHLEVBQUUsS0FBSyxDQUFDLElBQUksTUFBTSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsRUFBRTtnQkFDbEQsSUFBSSxLQUFLLEtBQUssU0FBUztvQkFBRyxNQUE2QyxDQUFDLEdBQUcsQ0FBQyxHQUFHLEtBQUssQ0FBQTthQUNyRjtRQUNILENBQUM7S0FDRixDQUFBO0FBQ0gsQ0FBQyxDQUFBO0FBRUQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0ErQkc7QUFDSCxNQUFNLENBQUMsTUFBTSxPQUFPLEdBQWEsYUFBYSxFQUFFLENBQUEiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBjcmVhdGVTdG9yYWdlQ29uZmlnLCBTdG9yYWdlT3B0aW9ucyB9IGZyb20gJy4vY29uc3RhbnRzJ1xuaW1wb3J0IHsgY3JlYXRlU2NlbmVTdG9yYWdlLCBJU2NlbmVTdG9yYWdlIH0gZnJvbSAnLi9zY2VuZSdcbmltcG9ydCB7IGNyZWF0ZVBsYXllclN0b3JhZ2UsIElQbGF5ZXJTdG9yYWdlIH0gZnJvbSAnLi9wbGF5ZXInXG5cbi8vIFJlLWV4cG9ydCBpbnRlcmZhY2VzIGFuZCB0eXBlc1xuZXhwb3J0IHsgR2V0T3B0aW9ucywgR2V0VmFsdWVzT3B0aW9ucywgR2V0VmFsdWVzUmVzdWx0LCBTZXRPcHRpb25zLCBTdG9yYWdlT3B0aW9ucyB9IGZyb20gJy4vY29uc3RhbnRzJ1xuZXhwb3J0IHsgSVNjZW5lU3RvcmFnZSB9IGZyb20gJy4vc2NlbmUnXG5leHBvcnQgeyBJUGxheWVyU3RvcmFnZSB9IGZyb20gJy4vcGxheWVyJ1xuXG4vKipcbiAqIFN0b3JhZ2UgaW50ZXJmYWNlIHdpdGggbWV0aG9kcyBmb3Igc2NlbmUtc2NvcGVkIGFuZCBwbGF5ZXItc2NvcGVkIHN0b3JhZ2UuXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgSVN0b3JhZ2UgZXh0ZW5kcyBJU2NlbmVTdG9yYWdlIHtcbiAgLyoqIFBsYXllci1zY29wZWQgc3RvcmFnZSBmb3Iga2V5LXZhbHVlIHBhaXJzICovXG4gIHBsYXllcjogSVBsYXllclN0b3JhZ2VcblxuICAvKipcbiAgICogU2V0cyBtb2R1bGUtd2lkZSBkZWZhdWx0cyBmb3IgYm90aCBzY2VuZS1zY29wZWQgYW5kIHBsYXllci1zY29wZWQgc3RvcmFnZS5cbiAgICogTWVyZ2VzIHRoZSBnaXZlbiBwYXJ0aWFsIG9wdGlvbnMgaW50byB0aGUgY3VycmVudCBjb25maWd1cmF0aW9uLlxuICAgKiBOb3RlOiBjYWNoZU1heEVudHJpZXMgYXBwbGllcyBwZXIgc2NvcGUgKHNjZW5lIGFuZCBwbGF5ZXIgZWFjaCBrZWVwIHRoZWlyXG4gICAqIG93biBjYWNoZSkgYW5kIGJvdW5kcyBlbnRyeSBjb3VudCwgbm90IGJ5dGVzIChlbnRyaWVzIGhvbGQgc2VyaWFsaXplZFxuICAgKiB2YWx1ZSBib2RpZXMpLlxuICAgKi9cbiAgY29uZmlndXJlKG9wdGlvbnM6IFN0b3JhZ2VPcHRpb25zKTogdm9pZFxufVxuXG4vKipcbiAqIENyZWF0ZXMgdGhlIFN0b3JhZ2UgbW9kdWxlIHdpdGggc2NlbmUtc2NvcGVkIGFuZCBwbGF5ZXItc2NvcGVkIHN0b3JhZ2UuXG4gKi9cbmNvbnN0IGNyZWF0ZVN0b3JhZ2UgPSAoKTogSVN0b3JhZ2UgPT4ge1xuICBjb25zdCBjb25maWcgPSBjcmVhdGVTdG9yYWdlQ29uZmlnKClcbiAgY29uc3Qgc2NlbmVTdG9yYWdlID0gY3JlYXRlU2NlbmVTdG9yYWdlKGNvbmZpZylcbiAgY29uc3QgcGxheWVyU3RvcmFnZSA9IGNyZWF0ZVBsYXllclN0b3JhZ2UoY29uZmlnKVxuXG4gIHJldHVybiB7XG4gICAgLy8gU3ByZWFkIHNjZW5lIHN0b3JhZ2UgbWV0aG9kcyBhdCB0b3AgbGV2ZWxcbiAgICBnZXQ6IHNjZW5lU3RvcmFnZS5nZXQsXG4gICAgc2V0OiBzY2VuZVN0b3JhZ2Uuc2V0LFxuICAgIGRlbGV0ZTogc2NlbmVTdG9yYWdlLmRlbGV0ZSxcbiAgICBnZXRWYWx1ZXM6IHNjZW5lU3RvcmFnZS5nZXRWYWx1ZXMsXG4gICAgLy8gS2VlcCBwbGF5ZXIgYXMgbmVzdGVkIHByb3BlcnR5XG4gICAgcGxheWVyOiBwbGF5ZXJTdG9yYWdlLFxuICAgIGNvbmZpZ3VyZShvcHRpb25zOiBTdG9yYWdlT3B0aW9ucyk6IHZvaWQge1xuICAgICAgZm9yIChjb25zdCBba2V5LCB2YWx1ZV0gb2YgT2JqZWN0LmVudHJpZXMob3B0aW9ucykpIHtcbiAgICAgICAgaWYgKHZhbHVlICE9PSB1bmRlZmluZWQpIChjb25maWcgYXMgdW5rbm93biBhcyBSZWNvcmQ8c3RyaW5nLCB1bmtub3duPilba2V5XSA9IHZhbHVlXG4gICAgICB9XG4gICAgfVxuICB9XG59XG5cbi8qKlxuICogU3RvcmFnZSBwcm92aWRlcyBtZXRob2RzIHRvIHN0b3JlIGFuZCByZXRyaWV2ZSBrZXktdmFsdWUgZGF0YSBmcm9tIHRoZVxuICogU2VydmVyIFNpZGUgU3RvcmFnZSBzZXJ2aWNlLlxuICpcbiAqIC0gVXNlIFN0b3JhZ2UuZ2V0L3NldC9kZWxldGUvZ2V0VmFsdWVzIGZvciBzY2VuZS1zY29wZWQgc3RvcmFnZVxuICogLSBVc2UgU3RvcmFnZS5wbGF5ZXIuZ2V0L3NldC9kZWxldGUvZ2V0VmFsdWVzIGZvciBwbGF5ZXItc2NvcGVkIHN0b3JhZ2VcbiAqIC0gVXNlIFN0b3JhZ2UuY29uZmlndXJlIHRvIGNoYW5nZSBtb2R1bGUtd2lkZSBkZWZhdWx0cyAoZS5nLiBza2lwSWZVbmNoYW5nZWQsIGNhY2hlUmVhZHMpXG4gKlxuICogQSBmYWlsdXJlIGlzIG5ldmVyIHJlcG9ydGVkIGFzIGFic2VuY2UuIEEgcmVhZCB0aGF0IGZhaWxzIHRocm93czsgZ2V0KCkgcmVzb2x2ZXNcbiAqIG51bGwgb25seSBmb3IgYSBjb25maXJtZWQgYWJzZW5jZSAoYSA0MDQsIG9yIGEgZGVsZXRlIHRoYXQgbGFuZGVkKSBvciBhIHN0b3JlZFxuICogSlNPTiBudWxsLCBhbmQgZ2V0VmFsdWVzKCkgcmV0dXJucyBhbiBlbXB0eSBwYWdlIG9ubHkgZm9yIGEgZ2VudWluZWx5IGVtcHR5XG4gKiBsaXN0aW5nLiBBIGRlbGV0ZSB0aGF0IGZhaWxzIHRocm93cywgYW5kIHJlc29sdmVzIGZhbHNlIG9ubHkgZm9yIGEgY29uZmlybWVkIDQwNC5cbiAqIHNldCgpIHJlcG9ydHMgZmFpbHVyZSB0aHJvdWdoIGl0cyBib29sZWFuIHJlc3VsdCwgYW5kIHRocm93cyBmb3IgYSB2YWx1ZSB0aGF0XG4gKiBjYW5ub3QgYmUgSlNPTi1zZXJpYWxpemVkLiBBIGdldCgpIGlzc3VlZCB3aGlsZSB3cml0ZXMgdG8gaXRzIGtleSBhcmUgcGVuZGluZ1xuICogd2FpdHMgZm9yIHRoZW0sIHNvIGl0IHJlZmxlY3RzIHRoZW07IGdldFZhbHVlcygpIGRvZXMgbm90IHdhaXQuIE5vdGhpbmcgaXNcbiAqIHJldHJpZWQg4oCUIHRoYXQgaXMgdGhlIGNhbGxlcidzIHRvIGRlY2lkZS5cbiAqXG4gKiBSZWFkcyBhcmUgY2FjaGVkIGJ5IGRlZmF1bHQ6IGdldCgpIHNlcnZlcyB2YWx1ZXMga25vd24gZnJvbSBhIG5ldHdvcmtcbiAqIHJvdW5kLXRyaXAgd2l0aGluIHRoZSBsYXN0IGNhY2hlTWF4QWdlTXMgKGluY2x1ZGluZyBjb25maXJtZWQgXCJub3QgZm91bmRcIlxuICogcmVzdWx0cykgd2l0aG91dCBoaXR0aW5nIHRoZSBzZXJ2aWNlLCBhbmQgY29uY3VycmVudCBnZXRzIGZvciB0aGUgc2FtZSBrZXlcbiAqIHNoYXJlIG9uZSByZXF1ZXN0LiBPdmVybGFwcGluZyB3cml0ZXMgdG8gdGhlIHNhbWUga2V5IGFyZSBzZXJpYWxpemVkIHNvIHRoZVxuICogc2VydmljZSBjb21taXRzIHRoZW0gaW4gaXNzdWUgb3JkZXIsIGFuZCByYXBpZCB3cml0ZXMgY29hbGVzY2UgdG8gdGhlXG4gKiBsYXRlc3QgdmFsdWU7IGEgc2V0KCkvZGVsZXRlKCkgc2V0dGxlcyBvbmNlIGl0cyBvd24gd3JpdGUsIG9yIHRoZSBuZXdlclxuICogd3JpdGUgdGhhdCByZXBsYWNlZCBpdCwgbGFuZHMgb3IgZmFpbHMuIEJ5IGRlZmF1bHQgKHNraXBJZlVuY2hhbmdlZClcbiAqIGFuIHVuY2hhbmdlZCBzZXQgaXMgc2tpcHBlZCwgYnV0IG9ubHkgd2hlbiBhIHByZXZpb3VzIGNvbmZpcm1lZCByb3VuZC10cmlwXG4gKiBwcm92ZWQgdGhlIGV4YWN0IHZhbHVlIGlzIGFscmVhZHkgc3RvcmVkLiBPdXQtb2YtYmFuZCB3cml0ZXJzIChlLmcuIENMSSBzdG9yYWdlIGNvbW1hbmRzKVxuICogbWF5IG5vdCBiZSB2aXNpYmxlIGZvciB1cCB0byBjYWNoZU1heEFnZU1zOyB1c2UgZ2V0KGtleSwgeyBmcmVzaDogdHJ1ZSB9KVxuICogZm9yIGFuIGF1dGhvcml0YXRpdmUgcmVhZCBvciBTdG9yYWdlLmNvbmZpZ3VyZSh7IGNhY2hlUmVhZHM6IGZhbHNlIH0pIHRvXG4gKiBkaXNhYmxlIHJlYWQgY2FjaGluZy5cbiAqXG4gKiBUaGlzIG1vZHVsZSBvbmx5IHdvcmtzIHdoZW4gcnVubmluZyBvbiBzZXJ2ZXItc2lkZSBzY2VuZXMuXG4gKi9cbmV4cG9ydCBjb25zdCBTdG9yYWdlOiBJU3RvcmFnZSA9IGNyZWF0ZVN0b3JhZ2UoKVxuIl19
@@ -0,0 +1,60 @@
1
+ import { GetOptions, GetValuesOptions, GetValuesResult, SetOptions } from './constants';
2
+ /**
3
+ * Player-scoped storage interface for key-value pairs from the Server Side Storage service.
4
+ * This is NOT filesystem storage - data is stored in the remote storage service.
5
+ */
6
+ export interface IPlayerStorage {
7
+ /**
8
+ * Retrieves a value from a player's storage by key from the Server Side Storage service.
9
+ *
10
+ * By default (cacheReads), values read or written during the last cacheMaxAgeMs
11
+ * are served from a local cache without a network request, including confirmed
12
+ * "not found" results. Concurrent gets for the same player and key share one
13
+ * request. Out-of-band writers (e.g. CLI storage commands) may not be visible
14
+ * for up to cacheMaxAgeMs — pass { fresh: true } to force a network read.
15
+ * A read first waits for writes to the same key that were pending when it was
16
+ * issued, so it reflects every write issued before it.
17
+ * @param address - The player's wallet address
18
+ * @param key - The key to retrieve
19
+ * @param options - Optional { fresh } to bypass the read cache
20
+ * @returns A promise that resolves to the parsed JSON value, or null if not found
21
+ * @throws Error if the read fails, so a failure is never mistaken for a missing key
22
+ * @throws TypeError if the address or key is invalid
23
+ */
24
+ get<T = unknown>(address: string, key: string, options?: GetOptions): Promise<T | null>;
25
+ /**
26
+ * Stores a value in a player's storage in the Server Side Storage service.
27
+ * @param address - The player's wallet address
28
+ * @param key - The key to store the value under
29
+ * @param value - The value to store (will be JSON serialized)
30
+ * @param options - Optional { skipIfUnchanged } to skip the network write when the value is already stored
31
+ * @returns true once stored, or once a newer write that replaced this one lands
32
+ * (rapid writes coalesce); false if the write, or its replacement, fails
33
+ * @throws TypeError if the address or key is invalid, or the value cannot be stored unchanged: undefined,
34
+ * circular, a BigInt, or containing a function, a symbol, a non-finite number, an undefined array
35
+ * element or hole, a Map, Set, typed array or other built-in with no JSON form, or text with an
36
+ * unpaired surrogate or a NUL character. An undefined object property is dropped; a Date is
37
+ * stored as its ISO string and a class instance as its own enumerable data.
38
+ */
39
+ set<T = unknown>(address: string, key: string, value: T, options?: SetOptions): Promise<boolean>;
40
+ /**
41
+ * Deletes a value from a player's storage in the Server Side Storage service.
42
+ * @param address - The player's wallet address
43
+ * @param key - The key to delete
44
+ * @returns true once applied, or once a newer write that replaced it lands;
45
+ * false only for a confirmed 404
46
+ * @throws Error if the delete, or its replacement, fails; a failure is never reported as absence
47
+ * @throws TypeError if the address or key is invalid
48
+ */
49
+ delete(address: string, key: string): Promise<boolean>;
50
+ /**
51
+ * Returns key-value entries from a player's storage, optionally filtered by prefix.
52
+ * Supports pagination via limit and offset.
53
+ * @param address - The player's wallet address
54
+ * @param options - Optional { prefix, limit, offset } for filtering and pagination.
55
+ * @returns A promise that resolves to { data, pagination: { offset, total } } for pagination UI
56
+ * @throws Error if the read fails, so a failure is never mistaken for an empty page
57
+ * @throws TypeError if the address is invalid
58
+ */
59
+ getValues(address: string, options?: GetValuesOptions): Promise<GetValuesResult>;
60
+ }