@luvio/environments 0.154.20 → 0.155.0

package/dist/environments.js

@@ -278,7 +278,7 @@ class DurableTTLStore {
     }
 }
 
-function flushInMemoryStoreValuesToDurableStore(store, durableStore, durableStoreErrorHandler, redirects, additionalDurableStoreOperations = [], enableDurableMetadataRefresh = false) {
+function flushInMemoryStoreValuesToDurableStore(store, durableStore, durableStoreErrorHandler, redirects, shouldFlush, additionalDurableStoreOperations = [], enableDurableMetadataRefresh = false) {
     const durableRecords = create(null);
     const refreshedDurableRecords = create(null);
     const evictedRecords = create(null);
@@ -306,7 +306,16 @@ function flushInMemoryStoreValuesToDurableStore(store, durableStore, durableStor
         const entries = wasVisited === true || enableDurableMetadataRefresh === false
             ? durableRecords
             : refreshedDurableRecords;
-        setRecordTo(entries, key, record, metadata);
+        const { flushValue: flushValue, forceFlushMetadata: flushMetadata } = shouldFlush(key, record);
+        if (flushValue) {
+            setRecordTo(entries, key, record, metadata);
+        }
+        else {
+            // If the record is not to be flushed, we still need to update the metadata
+            if (flushMetadata === true) {
+                setRecordTo(refreshedDurableRecords, key, record, metadata);
+            }
+        }
     }
     const durableStoreOperations = additionalDurableStoreOperations;
     const recordKeys = keys(durableRecords);
@@ -510,7 +519,7 @@ function isUnfulfilledSnapshot(cachedSnapshotResult) {
  * @param durableStore A DurableStore implementation
  * @param instrumentation An instrumentation function implementation
  */
-function makeDurable(environment, { durableStore, instrumentation, useRevivingStore, enableDurableMetadataRefresh = false, disableDeepFreeze = false, }) {
+function makeDurable(environment, { durableStore, instrumentation, useRevivingStore, shouldFlush, enableDurableMetadataRefresh = false, disableDeepFreeze = false, }) {
     // runtimes can choose to disable deepFreeze, e.g. headless mobile runtime
     setBypassDeepFreeze(disableDeepFreeze);
     let stagingStore = null;
@@ -717,7 +726,7 @@ function makeDurable(environment, { durableStore, instrumentation, useRevivingSt
         if (stagingStore === null) {
             return Promise.resolve();
         }
-        const promise = flushInMemoryStoreValuesToDurableStore(stagingStore, durableStore, durableStoreErrorHandler, new Map(pendingStoreRedirects), additionalDurableStoreOperations, enableDurableMetadataRefresh);
+        const promise = flushInMemoryStoreValuesToDurableStore(stagingStore, durableStore, durableStoreErrorHandler, new Map(pendingStoreRedirects), shouldFlush !== null && shouldFlush !== void 0 ? shouldFlush : (() => ({ flushValue: true })), additionalDurableStoreOperations, enableDurableMetadataRefresh);
         pendingStoreRedirects.clear();
         stagingStore = null;
         return promise;

package/dist/types/main.d.ts

@@ -3,3 +3,4 @@ export { DurableTTLOverride, DefaultDurableTTLOverride } from './DurableTTLStore
 export { makeDurable, DurableEnvironment } from './makeDurable';
 export { publishDurableStoreEntries } from './makeDurable/revive';
 export { isDurableEnvironmentEvent } from './events';
+export type { ShouldFlushFn } from './makeDurable/flush';

package/dist/types/makeDurable/flush.d.ts

@@ -1,4 +1,8 @@
 import type { InMemoryStore } from '@luvio/engine';
 import type { DurableStore, DurableStoreOperation } from '../DurableStore';
 import type { DurableStoreRejectionHandler } from './error';
-export declare function flushInMemoryStoreValuesToDurableStore(store: InMemoryStore, durableStore: DurableStore, durableStoreErrorHandler: DurableStoreRejectionHandler, redirects: Map<string, string>, additionalDurableStoreOperations?: DurableStoreOperation<unknown>[], enableDurableMetadataRefresh?: boolean): Promise<void>;
+export type ShouldFlushFn = (key: string, data: unknown) => {
+    flushValue: boolean;
+    forceFlushMetadata?: true;
+};
+export declare function flushInMemoryStoreValuesToDurableStore(store: InMemoryStore, durableStore: DurableStore, durableStoreErrorHandler: DurableStoreRejectionHandler, redirects: Map<string, string>, shouldFlush: ShouldFlushFn, additionalDurableStoreOperations?: DurableStoreOperation<unknown>[], enableDurableMetadataRefresh?: boolean): Promise<void>;

package/dist/types/makeDurable.d.ts

@@ -2,6 +2,7 @@ import type { Environment, RecordSource, InMemoryStore } from '@luvio/engine';
 import type { DurableStore, DurableStoreOperation } from './DurableStore';
 import type { InstrumentationFunction } from './makeDurable/error';
 import type { TTLOverridesMap } from './DurableTTLStore';
+import { type ShouldFlushFn } from './makeDurable/flush';
 export interface DurableEnvironment extends Environment {
     /**
      * Disposes the environment and detaches the durable store listener
@@ -42,6 +43,7 @@ interface MakeDurableOptions {
     enableDurableMetadataRefresh?: boolean;
     useRevivingStore?: boolean;
     disableDeepFreeze?: boolean;
+    shouldFlush?: ShouldFlushFn;
 }
 /**
  * Configures the environment to persist data into a durable store and attempt to resolve
@@ -52,5 +54,5 @@ interface MakeDurableOptions {
  * @param durableStore A DurableStore implementation
  * @param instrumentation An instrumentation function implementation
  */
-export declare function makeDurable(environment: Environment, { durableStore, instrumentation, useRevivingStore, enableDurableMetadataRefresh, disableDeepFreeze, }: MakeDurableOptions): DurableEnvironment;
+export declare function makeDurable(environment: Environment, { durableStore, instrumentation, useRevivingStore, shouldFlush, enableDurableMetadataRefresh, disableDeepFreeze, }: MakeDurableOptions): DurableEnvironment;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@luvio/environments",
-    "version": "0.154.20",
+    "version": "0.155.0",
     "description": "Luvio Environments",
     "repository": {
         "type": "git",
@@ -27,7 +27,7 @@
         "watch": "yarn build --watch"
     },
     "dependencies": {
-        "@luvio/engine": "^0.154.20"
+        "@luvio/engine": "^0.155.0"
     },
     "volta": {
         "extends": "../../../package.json"