@crawlee/core 4.0.0-beta.65 → 4.0.0-beta.67

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 (127) hide show
  1. package/README.md +10 -10
  2. package/autoscaling/snapshotter.js +1 -1
  3. package/autoscaling/snapshotter.js.map +1 -1
  4. package/configuration.d.ts +3 -0
  5. package/configuration.d.ts.map +1 -1
  6. package/configuration.js +3 -0
  7. package/configuration.js.map +1 -1
  8. package/crawlers/crawler_commons.d.ts +1 -1
  9. package/crawlers/crawler_commons.d.ts.map +1 -1
  10. package/crawlers/statistics.d.ts +1 -1
  11. package/crawlers/statistics.js +2 -2
  12. package/crawlers/statistics.js.map +1 -1
  13. package/enqueue_links/enqueue_links.d.ts +1 -1
  14. package/enqueue_links/enqueue_links.d.ts.map +1 -1
  15. package/events/event_manager.d.ts +26 -2
  16. package/events/event_manager.d.ts.map +1 -1
  17. package/events/event_manager.js +1 -0
  18. package/events/event_manager.js.map +1 -1
  19. package/index.d.ts +2 -1
  20. package/index.d.ts.map +1 -1
  21. package/index.js +1 -0
  22. package/index.js.map +1 -1
  23. package/memory-storage/consts.d.ts +5 -0
  24. package/memory-storage/consts.d.ts.map +1 -0
  25. package/memory-storage/consts.js +5 -0
  26. package/memory-storage/consts.js.map +1 -0
  27. package/memory-storage/index.d.ts +2 -0
  28. package/memory-storage/index.d.ts.map +1 -0
  29. package/memory-storage/index.js +2 -0
  30. package/memory-storage/index.js.map +1 -0
  31. package/memory-storage/memory-storage.d.ts +47 -0
  32. package/memory-storage/memory-storage.d.ts.map +1 -0
  33. package/memory-storage/memory-storage.js +137 -0
  34. package/memory-storage/memory-storage.js.map +1 -0
  35. package/memory-storage/resource-clients/common/base-client.d.ts +5 -0
  36. package/memory-storage/resource-clients/common/base-client.d.ts.map +1 -0
  37. package/memory-storage/resource-clients/common/base-client.js +7 -0
  38. package/memory-storage/resource-clients/common/base-client.js.map +1 -0
  39. package/memory-storage/resource-clients/dataset.d.ts +41 -0
  40. package/memory-storage/resource-clients/dataset.d.ts.map +1 -0
  41. package/memory-storage/resource-clients/dataset.js +114 -0
  42. package/memory-storage/resource-clients/dataset.js.map +1 -0
  43. package/memory-storage/resource-clients/key-value-store.d.ts +64 -0
  44. package/memory-storage/resource-clients/key-value-store.d.ts.map +1 -0
  45. package/memory-storage/resource-clients/key-value-store.js +204 -0
  46. package/memory-storage/resource-clients/key-value-store.js.map +1 -0
  47. package/memory-storage/resource-clients/request-queue.d.ts +97 -0
  48. package/memory-storage/resource-clients/request-queue.d.ts.map +1 -0
  49. package/memory-storage/resource-clients/request-queue.js +422 -0
  50. package/memory-storage/resource-clients/request-queue.js.map +1 -0
  51. package/memory-storage/utils.d.ts +12 -0
  52. package/memory-storage/utils.d.ts.map +1 -0
  53. package/memory-storage/utils.js +28 -0
  54. package/memory-storage/utils.js.map +1 -0
  55. package/package.json +8 -5
  56. package/service_locator.d.ts +17 -17
  57. package/service_locator.d.ts.map +1 -1
  58. package/service_locator.js +31 -26
  59. package/service_locator.js.map +1 -1
  60. package/session_pool/consts.d.ts +1 -1
  61. package/session_pool/consts.d.ts.map +1 -1
  62. package/session_pool/consts.js +1 -1
  63. package/session_pool/consts.js.map +1 -1
  64. package/session_pool/session_pool.d.ts +1 -1
  65. package/storages/access_checking.d.ts.map +1 -1
  66. package/storages/access_checking.js +5 -1
  67. package/storages/access_checking.js.map +1 -1
  68. package/storages/dataset.d.ts +10 -3
  69. package/storages/dataset.d.ts.map +1 -1
  70. package/storages/dataset.js +28 -13
  71. package/storages/dataset.js.map +1 -1
  72. package/storages/index.d.ts +3 -4
  73. package/storages/index.d.ts.map +1 -1
  74. package/storages/index.js +3 -4
  75. package/storages/index.js.map +1 -1
  76. package/storages/key_value_store.d.ts +61 -13
  77. package/storages/key_value_store.d.ts.map +1 -1
  78. package/storages/key_value_store.js +119 -86
  79. package/storages/key_value_store.js.map +1 -1
  80. package/storages/key_value_store_codec.d.ts +33 -0
  81. package/storages/key_value_store_codec.d.ts.map +1 -0
  82. package/storages/key_value_store_codec.js +114 -0
  83. package/storages/key_value_store_codec.js.map +1 -0
  84. package/storages/request_list.d.ts +1 -1
  85. package/storages/request_list.d.ts.map +1 -1
  86. package/storages/request_list.js +4 -4
  87. package/storages/request_list.js.map +1 -1
  88. package/storages/request_loader.d.ts +5 -5
  89. package/storages/request_loader.d.ts.map +1 -1
  90. package/storages/request_manager.d.ts +10 -1
  91. package/storages/request_manager.d.ts.map +1 -1
  92. package/storages/request_manager_tandem.d.ts +13 -2
  93. package/storages/request_manager_tandem.d.ts.map +1 -1
  94. package/storages/request_manager_tandem.js +23 -4
  95. package/storages/request_manager_tandem.js.map +1 -1
  96. package/storages/request_queue.d.ts +283 -44
  97. package/storages/request_queue.d.ts.map +1 -1
  98. package/storages/request_queue.js +593 -212
  99. package/storages/request_queue.js.map +1 -1
  100. package/storages/sitemap_request_loader.d.ts +1 -1
  101. package/storages/sitemap_request_loader.d.ts.map +1 -1
  102. package/storages/sitemap_request_loader.js +2 -2
  103. package/storages/sitemap_request_loader.js.map +1 -1
  104. package/storages/storage_instance_manager.d.ts +10 -10
  105. package/storages/storage_instance_manager.d.ts.map +1 -1
  106. package/storages/storage_instance_manager.js +33 -33
  107. package/storages/storage_instance_manager.js.map +1 -1
  108. package/storages/storage_stats.d.ts +49 -0
  109. package/storages/storage_stats.d.ts.map +1 -0
  110. package/storages/storage_stats.js +30 -0
  111. package/storages/storage_stats.js.map +1 -0
  112. package/storages/utils.d.ts +7 -7
  113. package/storages/utils.d.ts.map +1 -1
  114. package/storages/utils.js +4 -4
  115. package/storages/utils.js.map +1 -1
  116. package/validators.d.ts +4 -0
  117. package/validators.d.ts.map +1 -1
  118. package/validators.js +4 -0
  119. package/validators.js.map +1 -1
  120. package/storages/request_provider.d.ts +0 -325
  121. package/storages/request_provider.d.ts.map +0 -1
  122. package/storages/request_provider.js +0 -619
  123. package/storages/request_provider.js.map +0 -1
  124. package/storages/request_queue_v2.d.ts +0 -88
  125. package/storages/request_queue_v2.d.ts.map +0 -1
  126. package/storages/request_queue_v2.js +0 -437
  127. package/storages/request_queue_v2.js.map +0 -1
@@ -0,0 +1,137 @@
1
+ import { randomUUID } from 'node:crypto';
2
+ import { DatasetBackend } from './resource-clients/dataset.js';
3
+ import { KeyValueStoreBackend } from './resource-clients/key-value-store.js';
4
+ import { RequestQueueBackend } from './resource-clients/request-queue.js';
5
+ export class MemoryStorageBackend {
6
+ logger;
7
+ /**
8
+ * Unique per-instance cache partition key. Mirrors the way `FileSystemStorageBackend` partitions its
9
+ * cache by storage directory: two distinct `MemoryStorageBackend` instances must not share cached backends.
10
+ */
11
+ instanceCacheKey = `MemoryStorageBackend:${randomUUID()}`;
12
+ keyValueStoreBackendCache = [];
13
+ datasetBackendCache = [];
14
+ requestQueueBackendCache = [];
15
+ constructor(options = {}) {
16
+ this.logger = options.logger;
17
+ }
18
+ /**
19
+ * Return a per-instance unique cache key so that distinct `MemoryStorageBackend` instances get separate
20
+ * cache partitions in the storage backend cache.
21
+ */
22
+ getStorageBackendCacheKey() {
23
+ return this.instanceCacheKey;
24
+ }
25
+ static resolveStorageKey(options) {
26
+ const isAlias = 'alias' in options && !!options.alias;
27
+ const rawKey = isAlias ? options.alias : (options.name ?? options.id);
28
+ // Normalize the internal __default__ alias to the user-facing 'default' name.
29
+ const cacheKey = rawKey === '__default__' ? 'default' : rawKey;
30
+ return { isAlias, cacheKey };
31
+ }
32
+ async createDatasetBackend(options = {}) {
33
+ const { isAlias, cacheKey } = MemoryStorageBackend.resolveStorageKey(options);
34
+ if (cacheKey) {
35
+ const found = this.datasetBackendCache.find((store) => store.id === cacheKey ||
36
+ store.name?.toLowerCase() === cacheKey.toLowerCase() ||
37
+ store.cacheKey.toLowerCase() === cacheKey.toLowerCase());
38
+ if (found) {
39
+ return found;
40
+ }
41
+ }
42
+ const newStore = new DatasetBackend({
43
+ name: isAlias ? undefined : cacheKey,
44
+ cacheKey,
45
+ storageBackend: this,
46
+ });
47
+ this.datasetBackendCache.push(newStore);
48
+ return newStore;
49
+ }
50
+ async createKeyValueStoreBackend(options = {}) {
51
+ const { isAlias, cacheKey } = MemoryStorageBackend.resolveStorageKey(options);
52
+ if (cacheKey) {
53
+ const found = this.keyValueStoreBackendCache.find((store) => store.id === cacheKey ||
54
+ store.name?.toLowerCase() === cacheKey.toLowerCase() ||
55
+ store.cacheKey.toLowerCase() === cacheKey.toLowerCase());
56
+ if (found) {
57
+ return found;
58
+ }
59
+ }
60
+ const newStore = new KeyValueStoreBackend({
61
+ name: isAlias ? undefined : cacheKey,
62
+ cacheKey,
63
+ storageBackend: this,
64
+ });
65
+ this.keyValueStoreBackendCache.push(newStore);
66
+ return newStore;
67
+ }
68
+ async createRequestQueueBackend(options = {}) {
69
+ const { isAlias, cacheKey } = MemoryStorageBackend.resolveStorageKey(options);
70
+ if (cacheKey) {
71
+ const found = this.requestQueueBackendCache.find((queue) => queue.id === cacheKey ||
72
+ queue.name?.toLowerCase() === cacheKey.toLowerCase() ||
73
+ queue.cacheKey.toLowerCase() === cacheKey.toLowerCase());
74
+ if (found) {
75
+ return found;
76
+ }
77
+ }
78
+ const newStore = new RequestQueueBackend({
79
+ name: isAlias ? undefined : cacheKey,
80
+ cacheKey,
81
+ storageBackend: this,
82
+ });
83
+ this.requestQueueBackendCache.push(newStore);
84
+ return newStore;
85
+ }
86
+ async storageExists(id, type) {
87
+ let backends;
88
+ switch (type) {
89
+ case 'Dataset':
90
+ backends = this.datasetBackendCache;
91
+ break;
92
+ case 'KeyValueStore':
93
+ backends = this.keyValueStoreBackendCache;
94
+ break;
95
+ case 'RequestQueue':
96
+ backends = this.requestQueueBackendCache;
97
+ break;
98
+ default:
99
+ return false;
100
+ }
101
+ // In-memory storage only knows about backends in its cache.
102
+ return backends.some((store) => store.id === id);
103
+ }
104
+ /**
105
+ * Cleans up the default storages before the run starts. For the in-memory storage this simply
106
+ * resets the in-memory state of the cached default dataset, key-value store and request queue.
107
+ *
108
+ * As with `FileSystemStorageBackend`, the run's input (the `INPUT` key in the default key-value
109
+ * store) is preserved — only the rest of the default storages is cleared.
110
+ */
111
+ async purge() {
112
+ // The run default is opened via `{ alias: '__default__' }`, which `resolveStorageKey`
113
+ // normalizes to `cacheKey === 'default'` (with `name === undefined`) — that is the clause
114
+ // that actually matches it. The `name === 'default'` clause additionally covers a store a user
115
+ // explicitly opened via `{ name: 'default' }`. (`'__default__'` never reaches `cacheKey`,
116
+ // as it is always normalized to `'default'` first, so it does not need to be checked here.)
117
+ const isDefault = (store) => store.name === 'default' || store.cacheKey === 'default';
118
+ const purgeDefaults = async (cache, purgeStore) => {
119
+ await Promise.all(cache.filter(isDefault).map(async (store) => purgeStore(store)));
120
+ };
121
+ await Promise.all([
122
+ // Preserve the run input (INPUT) when purging the default key-value store, matching
123
+ // `FileSystemStorageBackend`.
124
+ purgeDefaults(this.keyValueStoreBackendCache, async (store) => store.purgeExceptInput()),
125
+ purgeDefaults(this.datasetBackendCache, async (store) => store.purge()),
126
+ purgeDefaults(this.requestQueueBackendCache, async (store) => store.purge()),
127
+ ]);
128
+ }
129
+ /**
130
+ * This method should be called at the end of the process. The in-memory storage holds no resources
131
+ * that outlive the process (no file handles, no cross-process locks), so there is nothing to do.
132
+ */
133
+ async teardown() {
134
+ // Nothing to tear down for in-memory storage.
135
+ }
136
+ }
137
+ //# sourceMappingURL=memory-storage.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"memory-storage.js","sourceRoot":"","sources":["../../src/memory-storage/memory-storage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAKzC,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAS1E,MAAM,OAAO,oBAAoB;IACpB,MAAM,CAAiB;IAEhC;;;OAGG;IACc,gBAAgB,GAAG,wBAAwB,UAAU,EAAE,EAAE,CAAC;IAElE,yBAAyB,GAA2B,EAAE,CAAC;IACvD,mBAAmB,GAAqB,EAAE,CAAC;IAC3C,wBAAwB,GAA0B,EAAE,CAAC;IAE9D,YAAY,UAAgC,EAAE;QAC1C,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IACjC,CAAC;IAED;;;OAGG;IACH,yBAAyB;QACrB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,OAAuD;QAIpF,MAAM,OAAO,GAAG,OAAO,IAAI,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;QACtD,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,EAAE,CAAC,CAAC;QACtE,8EAA8E;QAC9E,MAAM,QAAQ,GAAG,MAAM,KAAK,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;QAC/D,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,UAA+C,EAAE;QACxE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAE9E,IAAI,QAAQ,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CACvC,CAAC,KAAK,EAAE,EAAE,CACN,KAAK,CAAC,EAAE,KAAK,QAAQ;gBACrB,KAAK,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,QAAQ,CAAC,WAAW,EAAE;gBACpD,KAAK,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,WAAW,EAAE,CAC9D,CAAC;YACF,IAAI,KAAK,EAAE,CAAC;gBACR,OAAO,KAAK,CAAC;YACjB,CAAC;QACL,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,cAAc,CAAC;YAChC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ;YACpC,QAAQ;YACR,cAAc,EAAE,IAAI;SACvB,CAAC,CAAC;QACH,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAExC,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,0BAA0B,CAC5B,UAAqD,EAAE;QAEvD,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAE9E,IAAI,QAAQ,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAC7C,CAAC,KAAK,EAAE,EAAE,CACN,KAAK,CAAC,EAAE,KAAK,QAAQ;gBACrB,KAAK,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,QAAQ,CAAC,WAAW,EAAE;gBACpD,KAAK,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,WAAW,EAAE,CAC9D,CAAC;YACF,IAAI,KAAK,EAAE,CAAC;gBACR,OAAO,KAAK,CAAC;YACjB,CAAC;QACL,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,oBAAoB,CAAC;YACtC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ;YACpC,QAAQ;YACR,cAAc,EAAE,IAAI;SACvB,CAAC,CAAC;QACH,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE9C,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,yBAAyB,CAC3B,UAAoD,EAAE;QAEtD,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAE9E,IAAI,QAAQ,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAC5C,CAAC,KAAK,EAAE,EAAE,CACN,KAAK,CAAC,EAAE,KAAK,QAAQ;gBACrB,KAAK,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,QAAQ,CAAC,WAAW,EAAE;gBACpD,KAAK,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,WAAW,EAAE,CAC9D,CAAC;YACF,IAAI,KAAK,EAAE,CAAC;gBACR,OAAO,KAAK,CAAC;YACjB,CAAC;QACL,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,mBAAmB,CAAC;YACrC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ;YACpC,QAAQ;YACR,cAAc,EAAE,IAAI;SACvB,CAAC,CAAC;QACH,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE7C,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,EAAU,EAAE,IAAkD;QAC9E,IAAI,QAA0B,CAAC;QAE/B,QAAQ,IAAI,EAAE,CAAC;YACX,KAAK,SAAS;gBACV,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC;gBACpC,MAAM;YACV,KAAK,eAAe;gBAChB,QAAQ,GAAG,IAAI,CAAC,yBAAyB,CAAC;gBAC1C,MAAM;YACV,KAAK,cAAc;gBACf,QAAQ,GAAG,IAAI,CAAC,wBAAwB,CAAC;gBACzC,MAAM;YACV;gBACI,OAAO,KAAK,CAAC;QACrB,CAAC;QAED,4DAA4D;QAC5D,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK;QACP,sFAAsF;QACtF,0FAA0F;QAC1F,+FAA+F;QAC/F,0FAA0F;QAC1F,4FAA4F;QAC5F,MAAM,SAAS,GAAG,CAAC,KAA0C,EAAE,EAAE,CAC7D,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC;QAE7D,MAAM,aAAa,GAAG,KAAK,EACvB,KAAU,EACV,UAAuC,EACzC,EAAE;YACA,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACvF,CAAC,CAAC;QAEF,MAAM,OAAO,CAAC,GAAG,CAAC;YACd,oFAAoF;YACpF,8BAA8B;YAC9B,aAAa,CAAC,IAAI,CAAC,yBAAyB,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC;YACxF,aAAa,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACvE,aAAa,CAAC,IAAI,CAAC,wBAAwB,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;SAC/E,CAAC,CAAC;IACP,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ;QACV,8CAA8C;IAClD,CAAC;CACJ"}
@@ -0,0 +1,5 @@
1
+ export declare class BaseClient {
2
+ id: string;
3
+ constructor(id: string);
4
+ }
5
+ //# sourceMappingURL=base-client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"base-client.d.ts","sourceRoot":"","sources":["../../../../src/memory-storage/resource-clients/common/base-client.ts"],"names":[],"mappings":"AAAA,qBAAa,UAAU;IACnB,EAAE,EAAE,MAAM,CAAC;gBAEC,EAAE,EAAE,MAAM;CAGzB"}
@@ -0,0 +1,7 @@
1
+ export class BaseClient {
2
+ id;
3
+ constructor(id) {
4
+ this.id = id;
5
+ }
6
+ }
7
+ //# sourceMappingURL=base-client.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"base-client.js","sourceRoot":"","sources":["../../../../src/memory-storage/resource-clients/common/base-client.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,UAAU;IACnB,EAAE,CAAS;IAEX,YAAY,EAAU;QAClB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACjB,CAAC;CACJ"}
@@ -0,0 +1,41 @@
1
+ import type * as storage from '@crawlee/types';
2
+ import type { Dictionary } from '@crawlee/types';
3
+ import type { MemoryStorageBackend } from '../memory-storage.js';
4
+ import { BaseClient } from './common/base-client.js';
5
+ export interface DatasetBackendOptions {
6
+ id?: string;
7
+ name?: string;
8
+ /**
9
+ * The key used for cache lookup. When provided, takes precedence over `name` and `id`.
10
+ * This allows alias-opened storages to have a cache key that differs from their
11
+ * metadata `name` (which is `undefined` for unnamed storages).
12
+ */
13
+ cacheKey?: string;
14
+ storageBackend: MemoryStorageBackend;
15
+ }
16
+ export declare class DatasetBackend<Data extends Dictionary = Dictionary> extends BaseClient implements storage.DatasetBackend<Data> {
17
+ name?: string;
18
+ /**
19
+ * The key used for cache lookup. For named storages, this equals the name. For alias (unnamed)
20
+ * storages, this is the alias string. Falls back to id.
21
+ */
22
+ cacheKey: string;
23
+ createdAt: Date;
24
+ accessedAt: Date;
25
+ modifiedAt: Date;
26
+ itemCount: number;
27
+ private readonly datasetEntries;
28
+ private readonly storageBackend;
29
+ constructor(options: DatasetBackendOptions);
30
+ getMetadata(): Promise<storage.DatasetInfo>;
31
+ drop(): Promise<void>;
32
+ purge(): Promise<void>;
33
+ getData(options?: storage.DatasetBackendListOptions): Promise<storage.PaginatedList<Data>>;
34
+ private getDataPage;
35
+ pushData(items: Data[]): Promise<void>;
36
+ toDatasetInfo(): storage.DatasetInfo;
37
+ private generateLocalEntryName;
38
+ private getStartAndEndIndexes;
39
+ private updateTimestamps;
40
+ }
41
+ //# sourceMappingURL=dataset.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"dataset.d.ts","sourceRoot":"","sources":["../../../src/memory-storage/resource-clients/dataset.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAGjD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAcrD,MAAM,WAAW,qBAAqB;IAClC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,oBAAoB,CAAC;CACxC;AAED,qBAAa,cAAc,CAAC,IAAI,SAAS,UAAU,GAAG,UAAU,CAC5D,SAAQ,UACR,YAAW,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC;IAEvC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,OAAc;IACvB,UAAU,OAAc;IACxB,UAAU,OAAc;IACxB,SAAS,SAAK;IAEd,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA2B;IAC1D,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAuB;gBAE1C,OAAO,EAAE,qBAAqB;IAOpC,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IAK3C,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAUrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAO5B,OAAO,CAAC,OAAO,GAAE,OAAO,CAAC,yBAA8B,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAgBhF,WAAW;IA2BnB,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAS5C,aAAa,IAAI,OAAO,CAAC,WAAW;IAWpC,OAAO,CAAC,sBAAsB;IAI9B,OAAO,CAAC,qBAAqB;IAM7B,OAAO,CAAC,gBAAgB;CAO3B"}
@@ -0,0 +1,114 @@
1
+ import { randomUUID } from 'node:crypto';
2
+ import { s } from '@sapphire/shapeshift';
3
+ import { BaseClient } from './common/base-client.js';
4
+ /**
5
+ * This is what API returns in the x-apify-pagination-limit
6
+ * header when no limit query parameter is used.
7
+ */
8
+ const LIST_ITEMS_LIMIT = 999_999_999_999;
9
+ /**
10
+ * Number of characters of the dataset item entry names.
11
+ * E.g.: 000000019 - 9 digits
12
+ */
13
+ const LOCAL_ENTRY_NAME_DIGITS = 9;
14
+ export class DatasetBackend extends BaseClient {
15
+ name;
16
+ /**
17
+ * The key used for cache lookup. For named storages, this equals the name. For alias (unnamed)
18
+ * storages, this is the alias string. Falls back to id.
19
+ */
20
+ cacheKey;
21
+ createdAt = new Date();
22
+ accessedAt = new Date();
23
+ modifiedAt = new Date();
24
+ itemCount = 0;
25
+ datasetEntries = new Map();
26
+ storageBackend;
27
+ constructor(options) {
28
+ super(options.id ?? randomUUID());
29
+ this.name = options.name;
30
+ this.cacheKey = options.cacheKey ?? this.name ?? this.id;
31
+ this.storageBackend = options.storageBackend;
32
+ }
33
+ async getMetadata() {
34
+ this.updateTimestamps(false);
35
+ return this.toDatasetInfo();
36
+ }
37
+ async drop() {
38
+ const storeIndex = this.storageBackend.datasetBackendCache.findIndex((store) => store.id === this.id);
39
+ if (storeIndex !== -1) {
40
+ const [oldBackend] = this.storageBackend.datasetBackendCache.splice(storeIndex, 1);
41
+ oldBackend.itemCount = 0;
42
+ oldBackend.datasetEntries.clear();
43
+ }
44
+ }
45
+ async purge() {
46
+ this.itemCount = 0;
47
+ this.datasetEntries.clear();
48
+ this.updateTimestamps(true);
49
+ }
50
+ getData(options = {}) {
51
+ const { desc, limit, offset } = s
52
+ .object({
53
+ desc: s.boolean().optional(),
54
+ limit: s.number().int().optional(),
55
+ offset: s.number().int().optional(),
56
+ })
57
+ .parse(options);
58
+ return this.getDataPage({
59
+ desc,
60
+ offset: offset ?? 0,
61
+ limit: Math.min(limit ?? LIST_ITEMS_LIMIT, LIST_ITEMS_LIMIT),
62
+ });
63
+ }
64
+ async getDataPage(options = {}) {
65
+ const { limit = LIST_ITEMS_LIMIT, offset = 0, desc } = options;
66
+ const [start, end] = this.getStartAndEndIndexes(desc ? Math.max(this.itemCount - offset - limit, 0) : offset, limit);
67
+ const items = [];
68
+ for (let idx = start; idx < end; idx++) {
69
+ const entryNumber = this.generateLocalEntryName(idx);
70
+ items.push(this.datasetEntries.get(entryNumber));
71
+ }
72
+ this.updateTimestamps(false);
73
+ return {
74
+ count: items.length,
75
+ desc: desc ?? false,
76
+ items: desc ? items.reverse() : items,
77
+ limit,
78
+ offset,
79
+ total: this.itemCount,
80
+ };
81
+ }
82
+ async pushData(items) {
83
+ for (const entry of items) {
84
+ const idx = this.generateLocalEntryName(++this.itemCount);
85
+ this.datasetEntries.set(idx, JSON.parse(JSON.stringify(entry)));
86
+ }
87
+ this.updateTimestamps(true);
88
+ }
89
+ toDatasetInfo() {
90
+ return {
91
+ id: this.id,
92
+ accessedAt: this.accessedAt,
93
+ createdAt: this.createdAt,
94
+ itemCount: this.itemCount,
95
+ modifiedAt: this.modifiedAt,
96
+ name: this.name,
97
+ };
98
+ }
99
+ generateLocalEntryName(idx) {
100
+ return idx.toString().padStart(LOCAL_ENTRY_NAME_DIGITS, '0');
101
+ }
102
+ getStartAndEndIndexes(offset, limit = this.itemCount) {
103
+ const start = offset + 1;
104
+ const end = Math.min(offset + limit, this.itemCount) + 1;
105
+ return [start, end];
106
+ }
107
+ updateTimestamps(hasBeenModified) {
108
+ this.accessedAt = new Date();
109
+ if (hasBeenModified) {
110
+ this.modifiedAt = new Date();
111
+ }
112
+ }
113
+ }
114
+ //# sourceMappingURL=dataset.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"dataset.js","sourceRoot":"","sources":["../../../src/memory-storage/resource-clients/dataset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAIzC,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAGzC,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD;;;GAGG;AACH,MAAM,gBAAgB,GAAG,eAAe,CAAC;AAEzC;;;GAGG;AACH,MAAM,uBAAuB,GAAG,CAAC,CAAC;AAclC,MAAM,OAAO,cACT,SAAQ,UAAU;IAGlB,IAAI,CAAU;IACd;;;OAGG;IACH,QAAQ,CAAS;IACjB,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IACvB,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;IACxB,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;IACxB,SAAS,GAAG,CAAC,CAAC;IAEG,cAAc,GAAG,IAAI,GAAG,EAAgB,CAAC;IACzC,cAAc,CAAuB;IAEtD,YAAY,OAA8B;QACtC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,UAAU,EAAE,CAAC,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;QACzD,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IACjD,CAAC;IAED,KAAK,CAAC,WAAW;QACb,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,IAAI;QACN,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;QAEtG,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;YACpB,MAAM,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;YACnF,UAAU,CAAC,SAAS,GAAG,CAAC,CAAC;YACzB,UAAU,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QACtC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,KAAK;QACP,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAE5B,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,OAAO,CAAC,UAA6C,EAAE;QACnD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC;aAC5B,MAAM,CAAC;YACJ,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;YAC5B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;YAClC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;SACtC,CAAC;aACD,KAAK,CAAC,OAAO,CAAC,CAAC;QAEpB,OAAO,IAAI,CAAC,WAAW,CAAC;YACpB,IAAI;YACJ,MAAM,EAAE,MAAM,IAAI,CAAC;YACnB,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,gBAAgB,EAAE,gBAAgB,CAAC;SAC/D,CAAC,CAAC;IACP,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,UAA6C,EAAE;QACrE,MAAM,EAAE,KAAK,GAAG,gBAAgB,EAAE,MAAM,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;QAE/D,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAC3C,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,GAAG,MAAM,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAC5D,KAAK,CACR,CAAC;QAEF,MAAM,KAAK,GAAW,EAAE,CAAC;QAEzB,KAAK,IAAI,GAAG,GAAG,KAAK,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;YACrC,MAAM,WAAW,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;YACrD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,WAAW,CAAE,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAE7B,OAAO;YACH,KAAK,EAAE,KAAK,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,IAAI,KAAK;YACnB,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK;YACrC,KAAK;YACL,MAAM;YACN,KAAK,EAAE,IAAI,CAAC,SAAS;SACxB,CAAC;IACN,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,KAAa;QACxB,KAAK,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;YACxB,MAAM,GAAG,GAAG,IAAI,CAAC,sBAAsB,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1D,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAS,CAAC,CAAC;QAC5E,CAAC;QAED,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,aAAa;QACT,OAAO;YACH,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,IAAI,EAAE,IAAI,CAAC,IAAI;SAClB,CAAC;IACN,CAAC;IAEO,sBAAsB,CAAC,GAAW;QACtC,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;IACjE,CAAC;IAEO,qBAAqB,CAAC,MAAc,EAAE,KAAK,GAAG,IAAI,CAAC,SAAS;QAChE,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,CAAC;QACzB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACzD,OAAO,CAAC,KAAK,EAAE,GAAG,CAAU,CAAC;IACjC,CAAC;IAEO,gBAAgB,CAAC,eAAwB;QAC7C,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;QAE7B,IAAI,eAAe,EAAE,CAAC;YAClB,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;QACjC,CAAC;IACL,CAAC;CACJ"}
@@ -0,0 +1,64 @@
1
+ import type * as storage from '@crawlee/types';
2
+ import type { MemoryStorageBackend } from '../memory-storage.js';
3
+ import { BaseClient } from './common/base-client.js';
4
+ export interface KeyValueStoreBackendOptions {
5
+ name?: string;
6
+ id?: string;
7
+ /**
8
+ * The key used for cache lookup. When provided, takes precedence over `name` and `id`.
9
+ * This allows alias-opened storages to have a cache key that differs from their
10
+ * metadata `name` (which is `undefined` for unnamed storages).
11
+ */
12
+ cacheKey?: string;
13
+ storageBackend: MemoryStorageBackend;
14
+ }
15
+ export interface InternalKeyRecord {
16
+ key: string;
17
+ value: Buffer;
18
+ contentType?: string;
19
+ extension: string;
20
+ }
21
+ export declare class KeyValueStoreBackend extends BaseClient implements storage.KeyValueStoreBackend {
22
+ name?: string;
23
+ /**
24
+ * The key used for cache lookup. For named storages, this equals the name. For alias (unnamed)
25
+ * storages, this is the alias string. Falls back to id.
26
+ */
27
+ cacheKey: string;
28
+ createdAt: Date;
29
+ accessedAt: Date;
30
+ modifiedAt: Date;
31
+ private readonly keyValueEntries;
32
+ private readonly storageBackend;
33
+ constructor(options: KeyValueStoreBackendOptions);
34
+ getMetadata(): Promise<storage.KeyValueStoreInfo>;
35
+ drop(): Promise<void>;
36
+ purge(): Promise<void>;
37
+ /**
38
+ * Purges every record except the run's input. Used by {@link MemoryStorageBackend.purge} for the
39
+ * default key-value store, mirroring `FileSystemStorageBackend`, which preserves `INPUT` (and its
40
+ * extension variants) when purging the default store. The in-memory key has no extension, so we
41
+ * preserve the bare `INPUT` key only.
42
+ */
43
+ purgeExceptInput(): Promise<void>;
44
+ listKeys(options?: storage.KeyValueStoreListKeysOptions): Promise<storage.KeyValueStoreListKeysResult>;
45
+ /**
46
+ * In-memory records are not file-backed, so there is no public file URL to return.
47
+ * Always resolves to `undefined`.
48
+ * @param key The key of the record to generate the public URL for.
49
+ */
50
+ getPublicUrl(key: string): Promise<string | undefined>;
51
+ /**
52
+ * Tests whether a record with the given key exists in the key-value store without retrieving its value.
53
+ *
54
+ * @param key The queried record key.
55
+ * @returns `true` if the record exists, `false` if it does not.
56
+ */
57
+ recordExists(key: string): Promise<boolean>;
58
+ getValue(key: string): Promise<storage.KeyValueStoreRecord | undefined>;
59
+ setValue(record: storage.KeyValueStoreInputRecord): Promise<void>;
60
+ deleteValue(key: string): Promise<void>;
61
+ toKeyValueStoreInfo(): storage.KeyValueStoreInfo;
62
+ private updateTimestamps;
63
+ }
64
+ //# sourceMappingURL=key-value-store.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"key-value-store.d.ts","sourceRoot":"","sources":["../../../src/memory-storage/resource-clients/key-value-store.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAG/C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAEjE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAWrD,MAAM,WAAW,2BAA2B;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,oBAAoB,CAAC;CACxC;AAED,MAAM,WAAW,iBAAiB;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,qBAAa,oBAAqB,SAAQ,UAAW,YAAW,OAAO,CAAC,oBAAoB;IACxF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,OAAc;IACvB,UAAU,OAAc;IACxB,UAAU,OAAc;IAExB,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAwC;IACxE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAuB;gBAE1C,OAAO,EAAE,2BAA2B;IAO1C,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC;IAKjD,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IASrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAK5B;;;;;OAKG;IACG,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAUjC,QAAQ,CAAC,OAAO,GAAE,OAAO,CAAC,4BAAiC,GAAG,OAAO,CAAC,OAAO,CAAC,2BAA2B,CAAC;IAoDhH;;;;OAIG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAM5D;;;;;OAKG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAM3C,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAwBvE,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqDjE,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAS7C,mBAAmB,IAAI,OAAO,CAAC,iBAAiB;IAUhD,OAAO,CAAC,gBAAgB;CAO3B"}
@@ -0,0 +1,204 @@
1
+ import { randomUUID } from 'node:crypto';
2
+ import { s } from '@sapphire/shapeshift';
3
+ import { isStream, toBuffer } from '../utils.js';
4
+ import { BaseClient } from './common/base-client.js';
5
+ import mime from 'mime-types';
6
+ const DEFAULT_LOCAL_FILE_EXTENSION = 'bin';
7
+ /**
8
+ * Key under which a run's input is stored in the default key-value store. Matches Crawlee's default
9
+ * `inputKey` (`CRAWLEE_INPUT_KEY`) and the `INPUT` files `FileSystemStorageBackend` preserves on purge.
10
+ */
11
+ const KEY_VALUE_STORE_INPUT_KEY = 'INPUT';
12
+ export class KeyValueStoreBackend extends BaseClient {
13
+ name;
14
+ /**
15
+ * The key used for cache lookup. For named storages, this equals the name. For alias (unnamed)
16
+ * storages, this is the alias string. Falls back to id.
17
+ */
18
+ cacheKey;
19
+ createdAt = new Date();
20
+ accessedAt = new Date();
21
+ modifiedAt = new Date();
22
+ keyValueEntries = new Map();
23
+ storageBackend;
24
+ constructor(options) {
25
+ super(options.id ?? randomUUID());
26
+ this.name = options.name;
27
+ this.cacheKey = options.cacheKey ?? this.name ?? this.id;
28
+ this.storageBackend = options.storageBackend;
29
+ }
30
+ async getMetadata() {
31
+ this.updateTimestamps(false);
32
+ return this.toKeyValueStoreInfo();
33
+ }
34
+ async drop() {
35
+ const storeIndex = this.storageBackend.keyValueStoreBackendCache.findIndex((store) => store.id === this.id);
36
+ if (storeIndex !== -1) {
37
+ const [oldBackend] = this.storageBackend.keyValueStoreBackendCache.splice(storeIndex, 1);
38
+ oldBackend.keyValueEntries.clear();
39
+ }
40
+ }
41
+ async purge() {
42
+ this.keyValueEntries.clear();
43
+ this.updateTimestamps(true);
44
+ }
45
+ /**
46
+ * Purges every record except the run's input. Used by {@link MemoryStorageBackend.purge} for the
47
+ * default key-value store, mirroring `FileSystemStorageBackend`, which preserves `INPUT` (and its
48
+ * extension variants) when purging the default store. The in-memory key has no extension, so we
49
+ * preserve the bare `INPUT` key only.
50
+ */
51
+ async purgeExceptInput() {
52
+ for (const key of this.keyValueEntries.keys()) {
53
+ if (key !== KEY_VALUE_STORE_INPUT_KEY) {
54
+ this.keyValueEntries.delete(key);
55
+ }
56
+ }
57
+ this.updateTimestamps(true);
58
+ }
59
+ async listKeys(options = {}) {
60
+ const { prefix, exclusiveStartKey, limit } = s
61
+ .object({
62
+ prefix: s.string().optional(),
63
+ exclusiveStartKey: s.string().optional(),
64
+ limit: s.number().int().greaterThan(0).optional(),
65
+ })
66
+ .parse(options);
67
+ const items = [];
68
+ for (const record of this.keyValueEntries.values()) {
69
+ const size = Buffer.byteLength(record.value);
70
+ items.push({
71
+ key: record.key,
72
+ size,
73
+ contentType: record.contentType ?? 'application/octet-stream',
74
+ });
75
+ }
76
+ // Lexically sort to emulate API.
77
+ items.sort((a, b) => a.key.localeCompare(b.key));
78
+ let filteredItems = items.filter((item) => !prefix || item.key.startsWith(prefix));
79
+ if (exclusiveStartKey) {
80
+ const keyPos = filteredItems.findIndex((item) => item.key === exclusiveStartKey);
81
+ if (keyPos === -1) {
82
+ throw new Error(`exclusiveStartKey "${exclusiveStartKey}" was not found in the key-value store. ` +
83
+ `This is likely a bug — the key may have been deleted between paginated listKeys calls.`);
84
+ }
85
+ filteredItems = filteredItems.slice(keyPos + 1);
86
+ }
87
+ const isTruncated = limit !== undefined && filteredItems.length > limit;
88
+ const pageItems = isTruncated ? filteredItems.slice(0, limit) : filteredItems;
89
+ const nextExclusiveStartKey = isTruncated ? pageItems[pageItems.length - 1].key : undefined;
90
+ this.updateTimestamps(false);
91
+ return {
92
+ items: pageItems,
93
+ count: pageItems.length,
94
+ limit: limit ?? pageItems.length,
95
+ exclusiveStartKey,
96
+ isTruncated,
97
+ nextExclusiveStartKey,
98
+ };
99
+ }
100
+ /**
101
+ * In-memory records are not file-backed, so there is no public file URL to return.
102
+ * Always resolves to `undefined`.
103
+ * @param key The key of the record to generate the public URL for.
104
+ */
105
+ async getPublicUrl(key) {
106
+ s.string().parse(key);
107
+ return undefined;
108
+ }
109
+ /**
110
+ * Tests whether a record with the given key exists in the key-value store without retrieving its value.
111
+ *
112
+ * @param key The queried record key.
113
+ * @returns `true` if the record exists, `false` if it does not.
114
+ */
115
+ async recordExists(key) {
116
+ s.string().parse(key);
117
+ return this.keyValueEntries.has(key);
118
+ }
119
+ async getValue(key) {
120
+ s.string().parse(key);
121
+ const entry = this.keyValueEntries.get(key);
122
+ if (!entry) {
123
+ return undefined;
124
+ }
125
+ // Return raw bytes + verbatim content type. Parsing is the frontend's job (see the
126
+ // KeyValueStore codec). The mime fallback reconstructs the content type for on-disk records.
127
+ const record = {
128
+ key: entry.key,
129
+ value: entry.value,
130
+ // mime.contentType returns `false` for unknown extensions; fall back to undefined so the
131
+ // frontend treats it as "no content type" rather than a bogus value.
132
+ contentType: entry.contentType ?? (mime.contentType(entry.extension) || undefined),
133
+ };
134
+ this.updateTimestamps(false);
135
+ return record;
136
+ }
137
+ async setValue(record) {
138
+ s.object({
139
+ key: s.string().lengthGreaterThan(0),
140
+ value: s.union([
141
+ s.null(),
142
+ s.string(),
143
+ s.number(),
144
+ s.instance(Buffer),
145
+ s.instance(ArrayBuffer),
146
+ s.typedArray(),
147
+ // disabling validation will make shapeshift only check the object given is an actual object, not null, nor array
148
+ s.object({}).setValidationEnabled(false),
149
+ ]),
150
+ contentType: s.string().lengthGreaterThan(0).optional(),
151
+ }).parse(record);
152
+ const { key } = record;
153
+ let { value } = record;
154
+ // The frontend (KeyValueStore codec) serializes the value and resolves its content type
155
+ // before it reaches the backend. We only need it here for on-disk extension bookkeeping.
156
+ const contentType = record.contentType ?? 'application/octet-stream';
157
+ const extension = mime.extension(contentType) || DEFAULT_LOCAL_FILE_EXTENSION;
158
+ // Draining a stream into a Buffer for storage is the backend's responsibility.
159
+ if (isStream(value)) {
160
+ const chunks = [];
161
+ for await (const chunk of value) {
162
+ chunks.push(chunk);
163
+ }
164
+ value = Buffer.concat(chunks);
165
+ }
166
+ // This backend is a byte transport: it stores and returns raw bytes regardless of the input
167
+ // shape. Streams were drained above; encode strings to UTF-8 bytes and normalize
168
+ // ArrayBuffer / typed-array views to a Buffer over the same memory.
169
+ const normalizedValue = typeof value === 'string'
170
+ ? Buffer.from(value, 'utf-8')
171
+ : toBuffer(value);
172
+ const _record = {
173
+ extension,
174
+ key,
175
+ value: normalizedValue,
176
+ contentType,
177
+ };
178
+ this.keyValueEntries.set(key, _record);
179
+ this.updateTimestamps(true);
180
+ }
181
+ async deleteValue(key) {
182
+ s.string().parse(key);
183
+ if (this.keyValueEntries.has(key)) {
184
+ this.keyValueEntries.delete(key);
185
+ this.updateTimestamps(true);
186
+ }
187
+ }
188
+ toKeyValueStoreInfo() {
189
+ return {
190
+ id: this.id,
191
+ name: this.name,
192
+ accessedAt: this.accessedAt,
193
+ createdAt: this.createdAt,
194
+ modifiedAt: this.modifiedAt,
195
+ };
196
+ }
197
+ updateTimestamps(hasBeenModified) {
198
+ this.accessedAt = new Date();
199
+ if (hasBeenModified) {
200
+ this.modifiedAt = new Date();
201
+ }
202
+ }
203
+ }
204
+ //# sourceMappingURL=key-value-store.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"key-value-store.js","sourceRoot":"","sources":["../../../src/memory-storage/resource-clients/key-value-store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAGzC,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAGzC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,IAAI,MAAM,YAAY,CAAC;AAE9B,MAAM,4BAA4B,GAAG,KAAK,CAAC;AAE3C;;;GAGG;AACH,MAAM,yBAAyB,GAAG,OAAO,CAAC;AAqB1C,MAAM,OAAO,oBAAqB,SAAQ,UAAU;IAChD,IAAI,CAAU;IACd;;;OAGG;IACH,QAAQ,CAAS;IACjB,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IACvB,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;IACxB,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;IAEP,eAAe,GAAG,IAAI,GAAG,EAA6B,CAAC;IACvD,cAAc,CAAuB;IAEtD,YAAY,OAAoC;QAC5C,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,UAAU,EAAE,CAAC,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;QACzD,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IACjD,CAAC;IAED,KAAK,CAAC,WAAW;QACb,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,IAAI;QACN,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;QAE5G,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;YACpB,MAAM,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,yBAAyB,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;YACzF,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QACvC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,KAAK;QACP,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAC7B,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,gBAAgB;QAClB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,EAAE,CAAC;YAC5C,IAAI,GAAG,KAAK,yBAAyB,EAAE,CAAC;gBACpC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACrC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,UAAgD,EAAE;QAC7D,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAE,GAAG,CAAC;aACzC,MAAM,CAAC;YACJ,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAC7B,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YACxC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;SACpD,CAAC;aACD,KAAK,CAAC,OAAO,CAAC,CAAC;QAEpB,MAAM,KAAK,GAAoC,EAAE,CAAC;QAElD,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,EAAE,CAAC;YACjD,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC7C,KAAK,CAAC,IAAI,CAAC;gBACP,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI;gBACJ,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,0BAA0B;aAChE,CAAC,CAAC;QACP,CAAC;QAED,iCAAiC;QACjC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAEjD,IAAI,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QAEnF,IAAI,iBAAiB,EAAE,CAAC;YACpB,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,KAAK,iBAAiB,CAAC,CAAC;YACjF,IAAI,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CACX,sBAAsB,iBAAiB,0CAA0C;oBAC7E,wFAAwF,CAC/F,CAAC;YACN,CAAC;YACD,aAAa,GAAG,aAAa,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,WAAW,GAAG,KAAK,KAAK,SAAS,IAAI,aAAa,CAAC,MAAM,GAAG,KAAK,CAAC;QACxE,MAAM,SAAS,GAAG,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;QAC9E,MAAM,qBAAqB,GAAG,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;QAE5F,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAE7B,OAAO;YACH,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,SAAS,CAAC,MAAM;YACvB,KAAK,EAAE,KAAK,IAAI,SAAS,CAAC,MAAM;YAChC,iBAAiB;YACjB,WAAW;YACX,qBAAqB;SACxB,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,GAAW;QAC1B,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEtB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,GAAW;QAC1B,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEtB,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,GAAW;QACtB,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEtB,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAE5C,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,mFAAmF;QACnF,6FAA6F;QAC7F,MAAM,MAAM,GAAgC;YACxC,GAAG,EAAE,KAAK,CAAC,GAAG;YACd,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,yFAAyF;YACzF,qEAAqE;YACrE,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC;SACrF,CAAC;QAEF,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAE7B,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,MAAwC;QACnD,CAAC,CAAC,MAAM,CAAC;YACL,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC;YACpC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC;gBACX,CAAC,CAAC,IAAI,EAAE;gBACR,CAAC,CAAC,MAAM,EAAE;gBACV,CAAC,CAAC,MAAM,EAAE;gBACV,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;gBAClB,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;gBACvB,CAAC,CAAC,UAAU,EAAE;gBACd,iHAAiH;gBACjH,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,oBAAoB,CAAC,KAAK,CAAC;aAC3C,CAAC;YACF,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;SAC1D,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAEjB,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;QACvB,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;QACvB,wFAAwF;QACxF,yFAAyF;QACzF,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,0BAA0B,CAAC;QAErE,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,4BAA4B,CAAC;QAE9E,+EAA+E;QAC/E,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAClB,MAAM,MAAM,GAAG,EAAE,CAAC;YAClB,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;gBAC9B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;YACD,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAClC,CAAC;QAED,4FAA4F;QAC5F,iFAAiF;QACjF,oEAAoE;QACpE,MAAM,eAAe,GACjB,OAAO,KAAK,KAAK,QAAQ;YACrB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC;YAC7B,CAAC,CAAC,QAAQ,CAAC,KAA+C,CAAC,CAAC;QAEpE,MAAM,OAAO,GAAG;YACZ,SAAS;YACT,GAAG;YACH,KAAK,EAAE,eAAe;YACtB,WAAW;SACc,CAAC;QAE9B,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAEvC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,GAAW;QACzB,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEtB,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;IACL,CAAC;IAED,mBAAmB;QACf,OAAO;YACH,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,UAAU,EAAE,IAAI,CAAC,UAAU;SAC9B,CAAC;IACN,CAAC;IAEO,gBAAgB,CAAC,eAAwB;QAC7C,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;QAE7B,IAAI,eAAe,EAAE,CAAC;YAClB,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;QACjC,CAAC;IACL,CAAC;CACJ"}