@luvio/environments 0.111.3 → 0.112.0

package/dist/es/es2018/DurableStore.d.ts

@@ -1,3 +1,8 @@
+import type { StoreMetadata } from '@luvio/engine';
+export declare const DURABLE_METADATA_VERSION = "0.111.0";
+interface DurableStoreMetadata extends StoreMetadata {
+    metadataVersion: string;
+}
 /**
  * Contains store entry data along with any metadata for that entry that needs
  * to be persisted to durable storage
@@ -9,13 +14,7 @@
  */
 export interface DurableStoreEntry<T = unknown> {
     data: T;
-    metadata?: {
-        ingestionTimestamp: number;
-        expirationTimestamp: number;
-        namespace: string;
-        version: string;
-        representationName: string;
-    };
+    metadata?: DurableStoreMetadata;
 }
 export declare function isDeprecatedDurableStoreEntry(durableRecord: unknown): boolean;
 export interface DeprecatedDurableStoreEntry1<T = unknown> {
@@ -131,3 +130,4 @@ export interface DurableStore {
      */
     registerOnChangedListener(listener: OnDurableStoreChangedListener): () => Promise<void>;
 }
+export {};

package/dist/es/es2018/environments.js

@@ -1,9 +1,19 @@
 import { emitAdapterEvent, InMemoryStore, buildStaleWhileRevalidateImplementation, Reader } from '@luvio/engine';
 
+// the last version the metadata shape was altered
+const DURABLE_METADATA_VERSION = '0.111.0';
 function isDeprecatedDurableStoreEntry(durableRecord) {
     if (durableRecord.expiration !== undefined) {
         return true;
     }
+    const metadata = durableRecord.metadata;
+    if (metadata !== undefined) {
+        const { metadataVersion } = metadata;
+        // eventually we will want to assert that metadataVersion is defined
+        if (metadataVersion !== undefined && metadataVersion !== DURABLE_METADATA_VERSION) {
+            return true;
+        }
+    }
     // Add more deprecated shape checks here
     return false;
 }
@@ -297,7 +307,10 @@ function flushInMemoryStoreValuesToDurableStore(store, durableStore, durableStor
             data: copy(record),
         };
         if (metadata !== undefined) {
-            durableRecords[key].metadata = copy(metadata);
+            durableRecords[key].metadata = {
+                ...metadata,
+                metadataVersion: DURABLE_METADATA_VERSION,
+            };
         }
     }
     const durableStoreOperations = [];
@@ -357,7 +370,7 @@ async function reviveTTLOverrides(ttlStore, environment) {
 function buildIngestStagingStore(environment) {
     const store = new InMemoryStore();
     // need to make sure any TTL overrides are brought over from real L1
-    // because storePublishMetadata uses those overrides
+    // because publishStoreMetadata uses those overrides
     store.ttlOverrides = environment.storeGetTTLOverrides();
     store.defaultTTLOverride = environment.storeGetDefaultTTLOverride();
     return store;
@@ -844,4 +857,4 @@ function makeDurable(environment, { durableStore, instrumentation }) {
     });
 }
 
-export { DefaultDurableSegment, isDurableEnvironmentEvent, makeDurable, publishDurableStoreEntries };
+export { DURABLE_METADATA_VERSION, DefaultDurableSegment, isDurableEnvironmentEvent, makeDurable, publishDurableStoreEntries };

package/dist/es/es2018/main.d.ts

@@ -1,4 +1,4 @@
-export { DurableStore, DurableStoreEntries, DurableStoreEntry, DurableStoreChange, OnDurableStoreChangedListener, DefaultDurableSegment, DurableStoreOperation, DurableStoreOperationType, } from './DurableStore';
+export { DurableStore, DurableStoreEntries, DurableStoreEntry, DurableStoreChange, OnDurableStoreChangedListener, DefaultDurableSegment, DurableStoreOperation, DurableStoreOperationType, DURABLE_METADATA_VERSION, } from './DurableStore';
 export { DurableTTLOverride, DefaultDurableTTLOverride } from './DurableTTLStore';
 export { makeDurable, DurableEnvironment } from './makeDurable';
 export { publishDurableStoreEntries } from './makeDurable/revive';

package/dist/umd/es2018/DurableStore.d.ts

@@ -1,3 +1,8 @@
+import type { StoreMetadata } from '@luvio/engine';
+export declare const DURABLE_METADATA_VERSION = "0.111.0";
+interface DurableStoreMetadata extends StoreMetadata {
+    metadataVersion: string;
+}
 /**
  * Contains store entry data along with any metadata for that entry that needs
  * to be persisted to durable storage
@@ -9,13 +14,7 @@
  */
 export interface DurableStoreEntry<T = unknown> {
     data: T;
-    metadata?: {
-        ingestionTimestamp: number;
-        expirationTimestamp: number;
-        namespace: string;
-        version: string;
-        representationName: string;
-    };
+    metadata?: DurableStoreMetadata;
 }
 export declare function isDeprecatedDurableStoreEntry(durableRecord: unknown): boolean;
 export interface DeprecatedDurableStoreEntry1<T = unknown> {
@@ -131,3 +130,4 @@ export interface DurableStore {
      */
     registerOnChangedListener(listener: OnDurableStoreChangedListener): () => Promise<void>;
 }
+export {};

package/dist/umd/es2018/environments.js

@@ -4,10 +4,20 @@
     (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.luvioEnvironments = {}, global.luvioEngine));
 })(this, (function (exports, engine) { 'use strict';
 
+    // the last version the metadata shape was altered
+    const DURABLE_METADATA_VERSION = '0.111.0';
     function isDeprecatedDurableStoreEntry(durableRecord) {
         if (durableRecord.expiration !== undefined) {
             return true;
         }
+        const metadata = durableRecord.metadata;
+        if (metadata !== undefined) {
+            const { metadataVersion } = metadata;
+            // eventually we will want to assert that metadataVersion is defined
+            if (metadataVersion !== undefined && metadataVersion !== DURABLE_METADATA_VERSION) {
+                return true;
+            }
+        }
         // Add more deprecated shape checks here
         return false;
     }
@@ -301,7 +311,10 @@
                 data: copy(record),
             };
             if (metadata !== undefined) {
-                durableRecords[key].metadata = copy(metadata);
+                durableRecords[key].metadata = {
+                    ...metadata,
+                    metadataVersion: DURABLE_METADATA_VERSION,
+                };
             }
         }
         const durableStoreOperations = [];
@@ -361,7 +374,7 @@
     function buildIngestStagingStore(environment) {
         const store = new engine.InMemoryStore();
         // need to make sure any TTL overrides are brought over from real L1
-        // because storePublishMetadata uses those overrides
+        // because publishStoreMetadata uses those overrides
         store.ttlOverrides = environment.storeGetTTLOverrides();
         store.defaultTTLOverride = environment.storeGetDefaultTTLOverride();
         return store;
@@ -848,6 +861,7 @@
         });
     }
 
+    exports.DURABLE_METADATA_VERSION = DURABLE_METADATA_VERSION;
     exports.DefaultDurableSegment = DefaultDurableSegment;
     exports.isDurableEnvironmentEvent = isDurableEnvironmentEvent;
     exports.makeDurable = makeDurable;

package/dist/umd/es2018/main.d.ts

@@ -1,4 +1,4 @@
-export { DurableStore, DurableStoreEntries, DurableStoreEntry, DurableStoreChange, OnDurableStoreChangedListener, DefaultDurableSegment, DurableStoreOperation, DurableStoreOperationType, } from './DurableStore';
+export { DurableStore, DurableStoreEntries, DurableStoreEntry, DurableStoreChange, OnDurableStoreChangedListener, DefaultDurableSegment, DurableStoreOperation, DurableStoreOperationType, DURABLE_METADATA_VERSION, } from './DurableStore';
 export { DurableTTLOverride, DefaultDurableTTLOverride } from './DurableTTLStore';
 export { makeDurable, DurableEnvironment } from './makeDurable';
 export { publishDurableStoreEntries } from './makeDurable/revive';

package/dist/umd/es5/DurableStore.d.ts

@@ -1,3 +1,8 @@
+import type { StoreMetadata } from '@luvio/engine';
+export declare const DURABLE_METADATA_VERSION = "0.111.0";
+interface DurableStoreMetadata extends StoreMetadata {
+    metadataVersion: string;
+}
 /**
  * Contains store entry data along with any metadata for that entry that needs
  * to be persisted to durable storage
@@ -9,13 +14,7 @@
  */
 export interface DurableStoreEntry<T = unknown> {
     data: T;
-    metadata?: {
-        ingestionTimestamp: number;
-        expirationTimestamp: number;
-        namespace: string;
-        version: string;
-        representationName: string;
-    };
+    metadata?: DurableStoreMetadata;
 }
 export declare function isDeprecatedDurableStoreEntry(durableRecord: unknown): boolean;
 export interface DeprecatedDurableStoreEntry1<T = unknown> {
@@ -131,3 +130,4 @@ export interface DurableStore {
      */
     registerOnChangedListener(listener: OnDurableStoreChangedListener): () => Promise<void>;
 }
+export {};

package/dist/umd/es5/environments.js

@@ -4,10 +4,20 @@
     (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.luvioEnvironments = {}, global.luvioEngine));
 })(this, (function (exports, engine) { 'use strict';
 
+    // the last version the metadata shape was altered
+    var DURABLE_METADATA_VERSION = '0.111.0';
     function isDeprecatedDurableStoreEntry(durableRecord) {
         if (durableRecord.expiration !== undefined) {
             return true;
         }
+        var metadata = durableRecord.metadata;
+        if (metadata !== undefined) {
+            var metadataVersion = metadata.metadataVersion;
+            // eventually we will want to assert that metadataVersion is defined
+            if (metadataVersion !== undefined && metadataVersion !== DURABLE_METADATA_VERSION) {
+                return true;
+            }
+        }
         // Add more deprecated shape checks here
         return false;
     }
@@ -382,7 +392,7 @@
                 data: copy(record),
             };
             if (metadata !== undefined) {
-                durableRecords[key].metadata = copy(metadata);
+                durableRecords[key].metadata = __assign(__assign({}, metadata), { metadataVersion: DURABLE_METADATA_VERSION });
             }
         }
         var durableStoreOperations = [];
@@ -452,7 +462,7 @@
     function buildIngestStagingStore(environment) {
         var store = new engine.InMemoryStore();
         // need to make sure any TTL overrides are brought over from real L1
-        // because storePublishMetadata uses those overrides
+        // because publishStoreMetadata uses those overrides
         store.ttlOverrides = environment.storeGetTTLOverrides();
         store.defaultTTLOverride = environment.storeGetDefaultTTLOverride();
         return store;
@@ -991,6 +1001,7 @@
         });
     }
 
+    exports.DURABLE_METADATA_VERSION = DURABLE_METADATA_VERSION;
     exports.DefaultDurableSegment = DefaultDurableSegment;
     exports.isDurableEnvironmentEvent = isDurableEnvironmentEvent;
     exports.makeDurable = makeDurable;

package/dist/umd/es5/main.d.ts

@@ -1,4 +1,4 @@
-export { DurableStore, DurableStoreEntries, DurableStoreEntry, DurableStoreChange, OnDurableStoreChangedListener, DefaultDurableSegment, DurableStoreOperation, DurableStoreOperationType, } from './DurableStore';
+export { DurableStore, DurableStoreEntries, DurableStoreEntry, DurableStoreChange, OnDurableStoreChangedListener, DefaultDurableSegment, DurableStoreOperation, DurableStoreOperationType, DURABLE_METADATA_VERSION, } from './DurableStore';
 export { DurableTTLOverride, DefaultDurableTTLOverride } from './DurableTTLStore';
 export { makeDurable, DurableEnvironment } from './makeDurable';
 export { publishDurableStoreEntries } from './makeDurable/revive';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@luvio/environments",
-    "version": "0.111.3",
+    "version": "0.112.0",
     "description": "Luvio Environments",
     "repository": {
         "type": "git",
@@ -23,7 +23,7 @@
         "watch": "yarn build --watch"
     },
     "dependencies": {
-        "@luvio/engine": "0.111.3"
+        "@luvio/engine": "0.112.0"
     },
     "bundlesize": [
         {