@forge/kvs 1.2.7-next.0-experimental-3fd1b86 → 1.3.0-next.1-experimental-fd4d1a2

package/out/__test__/index.test.js

@@ -30,23 +30,62 @@ describe('KVS', () => {
             body: JSON.stringify({ key: 'foo' })
         }));
     });
-    it('should get with metadata fields correctly', async () => {
-        const response = new Response(JSON.stringify({ key: 'foo', value: 'bar', createdAt: 1718236800, updatedAt: 1718236800 }), {
+    it('should get with metadata fields correctly for get', async () => {
+        const response = new Response(JSON.stringify({
+            key: 'foo',
+            value: 'bar',
+            createdAt: 1718236800,
+            updatedAt: 1718236800,
+            expireTime: '2025-01-12T13:00:00Z'
+        }), {
             status: 200,
             headers: { 'x-trace-id': traceId }
         });
         const { sut, apiClient } = prepare(response);
-        const rs = await sut.get('foo', { metadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT] });
+        const rs = await sut.get('foo', {
+            metadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME]
+        });
         expect(rs).toEqual({
             key: 'foo',
             value: 'bar',
             createdAt: 1718236800,
-            updatedAt: 1718236800
+            updatedAt: 1718236800,
+            expireTime: '2025-01-12T13:00:00Z'
         });
         expect(apiClient).toHaveBeenCalledWith('/api/v1/get', expect.objectContaining({
             body: JSON.stringify({
                 key: 'foo',
-                options: { metadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT] }
+                options: { metadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME] }
+            })
+        }));
+    });
+    it('should get with metadata fields correctly for entity.get', async () => {
+        const response = new Response(JSON.stringify({
+            key: 'key-foo',
+            value: { foo: 'bar' },
+            createdAt: 1718236800,
+            updatedAt: 1718236800,
+            expireTime: '2025-01-12T13:00:00Z'
+        }), {
+            status: 200,
+            headers: { 'x-trace-id': traceId }
+        });
+        const { sut, apiClient } = prepare(response);
+        const rs = await sut.entity('foo').get('key-foo', {
+            metadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME]
+        });
+        expect(rs).toEqual({
+            key: 'key-foo',
+            value: { foo: 'bar' },
+            createdAt: 1718236800,
+            updatedAt: 1718236800,
+            expireTime: '2025-01-12T13:00:00Z'
+        });
+        expect(apiClient).toHaveBeenCalledWith('/api/v1/entity/get', expect.objectContaining({
+            body: JSON.stringify({
+                entityName: 'foo',
+                key: 'key-foo',
+                options: { metadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME] }
             })
         }));
     });
@@ -104,22 +143,31 @@ describe('KVS', () => {
         }));
     });
     it('should getSecret with metadata fields correctly', async () => {
-        const response = new Response(JSON.stringify({ key: 'foo', value: 'bar', createdAt: 1718236800, updatedAt: 1718236800 }), {
+        const response = new Response(JSON.stringify({
+            key: 'foo',
+            value: 'bar',
+            createdAt: 1718236800,
+            updatedAt: 1718236800,
+            expireTime: '2025-01-12T13:00:00Z'
+        }), {
             status: 200,
             headers: { 'x-trace-id': traceId }
         });
         const { sut, apiClient } = prepare(response);
-        const rs = await sut.getSecret('foo', { metadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT] });
+        const rs = await sut.getSecret('foo', {
+            metadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME]
+        });
         expect(rs).toEqual({
             key: 'foo',
             value: 'bar',
             createdAt: 1718236800,
-            updatedAt: 1718236800
+            updatedAt: 1718236800,
+            expireTime: '2025-01-12T13:00:00Z'
         });
         expect(apiClient).toHaveBeenCalledWith('/api/v1/secret/get', expect.objectContaining({
             body: JSON.stringify({
                 key: 'foo',
-                options: { metadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT] }
+                options: { metadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME] }
             })
         }));
     });
@@ -148,25 +196,32 @@ describe('KVS', () => {
         }));
     });
     it('should getEntity with metadata fields correctly', async () => {
-        const response = new Response(JSON.stringify({ key: 'foo', value: { name: 'Jane Doe' }, createdAt: 1718236800, updatedAt: 1718236800 }), {
+        const response = new Response(JSON.stringify({
+            key: 'foo',
+            value: { name: 'Jane Doe' },
+            createdAt: 1718236800,
+            updatedAt: 1718236800,
+            expireTime: '2025-01-12T13:00:00Z'
+        }), {
             status: 200,
             headers: { 'x-trace-id': traceId }
         });
         const { sut, apiClient } = prepare(response);
         const rs = await sut
             .entity('employees')
-            .get('foo', { metadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT] });
+            .get('foo', { metadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME] });
         expect(rs).toEqual({
             key: 'foo',
             value: { name: 'Jane Doe' },
             createdAt: 1718236800,
-            updatedAt: 1718236800
+            updatedAt: 1718236800,
+            expireTime: '2025-01-12T13:00:00Z'
         });
         expect(apiClient).toHaveBeenCalledWith('/api/v1/entity/get', expect.objectContaining({
             body: JSON.stringify({
                 entityName: 'employees',
                 key: 'foo',
-                options: { metadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT] }
+                options: { metadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME] }
             })
         }));
     });
@@ -194,6 +249,93 @@ describe('KVS', () => {
             body: JSON.stringify({ key: 'foo', value: 'bar' })
         }));
     });
+    it('should set correctly with TTL', async () => {
+        const response = new Response(undefined, {
+            status: 204,
+            headers: { 'x-trace-id': traceId }
+        });
+        const { sut, apiClient } = prepare(response);
+        const rs = await sut.set('foo', 'bar', { ttl: { value: 5, unit: 'MINUTES' } });
+        expect(rs).toBeUndefined();
+        expect(apiClient).toHaveBeenCalledWith('/api/v1/set', expect.objectContaining({
+            body: JSON.stringify({ key: 'foo', value: 'bar', options: { ttl: { value: 5, unit: 'MINUTES' } } })
+        }));
+    });
+    it('should set correctly with keyPolicy "FAIL_IF_EXISTS"', async () => {
+        const response = new Response(undefined, {
+            status: 204,
+            headers: { 'x-trace-id': traceId }
+        });
+        const { sut, apiClient } = prepare(response);
+        const rs = await sut.set('foo', 'bar', { ttl: { value: 5, unit: 'MINUTES' }, keyPolicy: 'FAIL_IF_EXISTS' });
+        expect(rs).toBeUndefined();
+        expect(apiClient).toHaveBeenCalledWith('/api/v1/set', expect.objectContaining({
+            body: JSON.stringify({
+                key: 'foo',
+                value: 'bar',
+                options: { ttl: { value: 5, unit: 'MINUTES' }, keyPolicy: 'FAIL_IF_EXISTS' }
+            })
+        }));
+    });
+    it('should set correctly with keyPolicy "OVERRIDE" and return value', async () => {
+        const responseBody = {
+            key: 'foo',
+            value: 'bar',
+            createdAt: Date.now(),
+            updatedAt: Date.now(),
+            expireTime: '2025-01-12T13:00:00Z'
+        };
+        const response = new Response(JSON.stringify(responseBody), {
+            status: 200,
+            headers: { 'x-trace-id': traceId }
+        });
+        const { sut, apiClient } = prepare(response);
+        const rs = await sut.set('foo', 'bar', {
+            ttl: { value: 5, unit: 'MINUTES' },
+            keyPolicy: 'OVERRIDE',
+            returnValue: 'LATEST',
+            returnMetadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME]
+        });
+        expect(rs).toEqual(responseBody);
+        expect(apiClient).toHaveBeenCalledWith('/api/v1/set', expect.objectContaining({
+            body: JSON.stringify({
+                key: 'foo',
+                value: 'bar',
+                options: {
+                    ttl: { value: 5, unit: 'MINUTES' },
+                    keyPolicy: 'OVERRIDE',
+                    returnValue: 'LATEST',
+                    returnMetadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME]
+                }
+            })
+        }));
+    });
+    it('should set and return undefined when no previous value exists', async () => {
+        const response = new Response(undefined, {
+            status: 204,
+            headers: { 'x-trace-id': traceId }
+        });
+        const { sut, apiClient } = prepare(response);
+        const rs = await sut.set('foo', 'bar', {
+            ttl: { value: 5, unit: 'MINUTES' },
+            keyPolicy: 'OVERRIDE',
+            returnValue: 'PREVIOUS',
+            returnMetadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME]
+        });
+        expect(rs).toEqual(undefined);
+        expect(apiClient).toHaveBeenCalledWith('/api/v1/set', expect.objectContaining({
+            body: JSON.stringify({
+                key: 'foo',
+                value: 'bar',
+                options: {
+                    ttl: { value: 5, unit: 'MINUTES' },
+                    keyPolicy: 'OVERRIDE',
+                    returnValue: 'PREVIOUS',
+                    returnMetadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME]
+                }
+            })
+        }));
+    });
     it('should setSecret correctly', async () => {
         const response = new Response(undefined, {
             status: 204,
@@ -206,6 +348,93 @@ describe('KVS', () => {
             body: JSON.stringify({ key: 'foo', value: 'bar' })
         }));
     });
+    it('should setSecret correctly with TTL', async () => {
+        const response = new Response(undefined, {
+            status: 204,
+            headers: { 'x-trace-id': traceId }
+        });
+        const { sut, apiClient } = prepare(response);
+        const rs = await sut.setSecret('foo', 'bar', { ttl: { value: 5, unit: 'MINUTES' } });
+        expect(rs).toBeUndefined();
+        expect(apiClient).toHaveBeenCalledWith('/api/v1/secret/set', expect.objectContaining({
+            body: JSON.stringify({ key: 'foo', value: 'bar', options: { ttl: { value: 5, unit: 'MINUTES' } } })
+        }));
+    });
+    it('should setSecret correctly with keyPolicy "FAIL_IF_EXISTS"', async () => {
+        const response = new Response(undefined, {
+            status: 204,
+            headers: { 'x-trace-id': traceId }
+        });
+        const { sut, apiClient } = prepare(response);
+        const rs = await sut.setSecret('foo', 'bar', { ttl: { value: 5, unit: 'MINUTES' }, keyPolicy: 'FAIL_IF_EXISTS' });
+        expect(rs).toBeUndefined();
+        expect(apiClient).toHaveBeenCalledWith('/api/v1/secret/set', expect.objectContaining({
+            body: JSON.stringify({
+                key: 'foo',
+                value: 'bar',
+                options: { ttl: { value: 5, unit: 'MINUTES' }, keyPolicy: 'FAIL_IF_EXISTS' }
+            })
+        }));
+    });
+    it('should setSecret correctly with keyPolicy "OVERRIDE" and return value', async () => {
+        const responseBody = {
+            key: 'foo',
+            value: 'bar',
+            createdAt: Date.now(),
+            updatedAt: Date.now(),
+            expireTime: '2025-01-12T13:00:00Z'
+        };
+        const response = new Response(JSON.stringify(responseBody), {
+            status: 200,
+            headers: { 'x-trace-id': traceId }
+        });
+        const { sut, apiClient } = prepare(response);
+        const rs = await sut.setSecret('foo', 'bar', {
+            ttl: { value: 5, unit: 'MINUTES' },
+            keyPolicy: 'OVERRIDE',
+            returnValue: 'LATEST',
+            returnMetadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME]
+        });
+        expect(rs).toEqual(responseBody);
+        expect(apiClient).toHaveBeenCalledWith('/api/v1/secret/set', expect.objectContaining({
+            body: JSON.stringify({
+                key: 'foo',
+                value: 'bar',
+                options: {
+                    ttl: { value: 5, unit: 'MINUTES' },
+                    keyPolicy: 'OVERRIDE',
+                    returnValue: 'LATEST',
+                    returnMetadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME]
+                }
+            })
+        }));
+    });
+    it('should setSecret and return undefined when no previous value exists', async () => {
+        const response = new Response(undefined, {
+            status: 204,
+            headers: { 'x-trace-id': traceId }
+        });
+        const { sut, apiClient } = prepare(response);
+        const rs = await sut.setSecret('foo', 'bar', {
+            ttl: { value: 5, unit: 'MINUTES' },
+            keyPolicy: 'OVERRIDE',
+            returnValue: 'PREVIOUS',
+            returnMetadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME]
+        });
+        expect(rs).toEqual(undefined);
+        expect(apiClient).toHaveBeenCalledWith('/api/v1/secret/set', expect.objectContaining({
+            body: JSON.stringify({
+                key: 'foo',
+                value: 'bar',
+                options: {
+                    ttl: { value: 5, unit: 'MINUTES' },
+                    keyPolicy: 'OVERRIDE',
+                    returnValue: 'PREVIOUS',
+                    returnMetadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME]
+                }
+            })
+        }));
+    });
     it('should setEntity correctly', async () => {
         const response = new Response(undefined, {
             status: 204,
@@ -218,6 +447,103 @@ describe('KVS', () => {
             body: JSON.stringify({ entityName: 'employees', key: 'foo', value: { name: 'Jane Doe' } })
         }));
     });
+    it('should setEntity correctly with TTL', async () => {
+        const response = new Response(undefined, {
+            status: 204,
+            headers: { 'x-trace-id': traceId }
+        });
+        const { sut, apiClient } = prepare(response);
+        const rs = await sut.entity('employees').set('foo', { name: 'Jane Doe' }, { ttl: { value: 5, unit: 'MINUTES' } });
+        expect(rs).toBeUndefined();
+        expect(apiClient).toHaveBeenCalledWith('/api/v1/entity/set', expect.objectContaining({
+            body: JSON.stringify({
+                entityName: 'employees',
+                key: 'foo',
+                value: { name: 'Jane Doe' },
+                options: { ttl: { value: 5, unit: 'MINUTES' } }
+            })
+        }));
+    });
+    it('should setEntity correctly with "FAIL_IF_EXISTS"', async () => {
+        const response = new Response(undefined, {
+            status: 204,
+            headers: { 'x-trace-id': traceId }
+        });
+        const { sut, apiClient } = prepare(response);
+        const rs = await sut
+            .entity('employees')
+            .set('foo', { name: 'Jane Doe' }, { ttl: { value: 5, unit: 'MINUTES' }, keyPolicy: 'FAIL_IF_EXISTS' });
+        expect(rs).toBeUndefined();
+        expect(apiClient).toHaveBeenCalledWith('/api/v1/entity/set', expect.objectContaining({
+            body: JSON.stringify({
+                entityName: 'employees',
+                key: 'foo',
+                value: { name: 'Jane Doe' },
+                options: { ttl: { value: 5, unit: 'MINUTES' }, keyPolicy: 'FAIL_IF_EXISTS' }
+            })
+        }));
+    });
+    it('should setEntity correctly with "OVERRIDE" and return value', async () => {
+        const responseBody = {
+            key: 'foo',
+            value: 'bar',
+            createdAt: Date.now(),
+            updatedAt: Date.now(),
+            expireTime: '2025-01-12T13:00:00Z'
+        };
+        const response = new Response(JSON.stringify(responseBody), {
+            status: 200,
+            headers: { 'x-trace-id': traceId }
+        });
+        const { sut, apiClient } = prepare(response);
+        const rs = await sut.entity('employees').set('foo', { name: 'Jane Doe' }, {
+            ttl: { value: 5, unit: 'MINUTES' },
+            keyPolicy: 'OVERRIDE',
+            returnValue: 'LATEST',
+            returnMetadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME]
+        });
+        expect(rs).toEqual(responseBody);
+        expect(apiClient).toHaveBeenCalledWith('/api/v1/entity/set', expect.objectContaining({
+            body: JSON.stringify({
+                entityName: 'employees',
+                key: 'foo',
+                value: { name: 'Jane Doe' },
+                options: {
+                    ttl: { value: 5, unit: 'MINUTES' },
+                    keyPolicy: 'OVERRIDE',
+                    returnValue: 'LATEST',
+                    returnMetadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME]
+                }
+            })
+        }));
+    });
+    it('should setEntity and return undefined when no previous value exists', async () => {
+        const response = new Response(undefined, {
+            status: 204,
+            headers: { 'x-trace-id': traceId }
+        });
+        const { sut, apiClient } = prepare(response);
+        const rs = await sut.entity('employees').set('foo', { name: 'Jane Doe' }, {
+            ttl: { value: 5, unit: 'MINUTES' },
+            keyPolicy: 'OVERRIDE',
+            returnValue: 'PREVIOUS',
+            returnMetadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME]
+        });
+        expect(rs).toBeUndefined();
+        expect(apiClient).toHaveBeenCalledWith('/api/v1/entity/set', expect.objectContaining({
+            body: JSON.stringify({
+                entityName: 'employees',
+                key: 'foo',
+                value: { name: 'Jane Doe' },
+                options: {
+                    ttl: { value: 5, unit: 'MINUTES' },
+                    keyPolicy: 'OVERRIDE',
+                    returnValue: 'PREVIOUS',
+                    returnMetadataFields: [types_1.MetadataField.CREATED_AT, types_1.MetadataField.UPDATED_AT, types_1.MetadataField.EXPIRE_TIME]
+                }
+            })
+        }));
+    });
     it('should delete correctly', async () => {
         const response = new Response(undefined, {
             status: 204,
@@ -314,6 +640,36 @@ describe('KVS', () => {
             })
         }));
     });
+    it('should query correctly with TTL fields', async () => {
+        const response = new Response(JSON.stringify({
+            cursor: 'third-page',
+            data: [{ key: 'foo', value: 'bar', expireTime: '2025-01-12T13:00:00Z' }]
+        }), {
+            status: 200,
+            headers: { 'x-trace-id': traceId }
+        });
+        const { sut, apiClient } = prepare(response);
+        const rs = await sut
+            .query({ metadataFields: [types_1.MetadataField.EXPIRE_TIME] })
+            .cursor('second-page')
+            .limit(1)
+            .where('key', conditions_1.WhereConditions.beginsWith('fo'))
+            .getMany();
+        expect(rs).toEqual({
+            results: [{ key: 'foo', value: 'bar', expireTime: '2025-01-12T13:00:00Z' }],
+            nextCursor: 'third-page'
+        });
+        expect(apiClient).toHaveBeenCalledWith('/api/v1/query', expect.objectContaining({
+            body: JSON.stringify({
+                limit: 1,
+                after: 'second-page',
+                where: [{ property: 'key', condition: 'BEGINS_WITH', values: ['fo'] }],
+                options: {
+                    metadataFields: [types_1.MetadataField.EXPIRE_TIME]
+                }
+            })
+        }));
+    });
     it('should getOne out of a list of results', async () => {
         const response = new Response(JSON.stringify({
             data: [
@@ -343,25 +699,28 @@ describe('KVS', () => {
             body: JSON.stringify({ limit: 1 })
         }));
     });
-    it('should query entity correctly and pass partition with index', async () => {
-        const response = new Response(JSON.stringify({ data: [{ key: 'foo', value: { name: 'Jane Doe' } }] }), {
+    it('should query entity correctly and pass partition with index and metadata fields', async () => {
+        const response = new Response(JSON.stringify({ data: [{ key: 'foo', value: { name: 'Jane Doe' }, expireTime: '2025-01-12T13:00:00Z' }] }), {
             status: 200,
             headers: { 'x-trace-id': traceId }
         });
         const { sut, apiClient } = prepare(response);
         const rs = await sut
             .entity('employees')
-            .query()
+            .query({ metadataFields: [types_1.MetadataField.EXPIRE_TIME] })
             .index('by-employmentyear', { partition: [2000] })
             .getMany();
         expect(rs).toEqual({
-            results: [{ key: 'foo', value: { name: 'Jane Doe' } }]
+            results: [{ key: 'foo', value: { name: 'Jane Doe' }, expireTime: '2025-01-12T13:00:00Z' }]
         });
         expect(apiClient).toHaveBeenCalledWith('/api/v1/entity/query', expect.objectContaining({
             body: JSON.stringify({
                 entityName: 'employees',
                 indexName: 'by-employmentyear',
-                partition: [2000]
+                partition: [2000],
+                options: {
+                    metadataFields: [types_1.MetadataField.EXPIRE_TIME]
+                }
             })
         }));
     });
@@ -658,6 +1017,24 @@ describe('KVS', () => {
             })
         }));
     });
+    it('should sumbit transaction correctly with TTL', async () => {
+        const response = new Response(undefined, {
+            status: 200,
+            headers: { 'x-trace-id': traceId }
+        });
+        const { sut, apiClient } = prepare(response);
+        await sut
+            .transact()
+            .set('foo', 'bar', undefined, { ttl: { unit: 'SECONDS', value: 5 } })
+            .delete('bar')
+            .execute();
+        expect(apiClient).toHaveBeenCalledWith('/api/v1/transaction', expect.objectContaining({
+            body: JSON.stringify({
+                set: [{ key: 'foo', value: 'bar', options: { ttl: { unit: 'SECONDS', value: 5 } } }],
+                delete: [{ key: 'bar' }]
+            })
+        }));
+    });
     it('should batchSet correctly with mixed entity and non-entity items', async () => {
         const response = new Response(JSON.stringify({
             successfulKeys: [{ key: 'foo', entityName: 'employees' }, { key: 'bar' }],
@@ -693,6 +1070,43 @@ describe('KVS', () => {
             body: JSON.stringify(items)
         }));
     });
+    it('should batchSet correctly with mixed entity and non-entity items with TTL', async () => {
+        const response = new Response(JSON.stringify({
+            successfulKeys: [{ key: 'foo', entityName: 'employees' }, { key: 'bar' }, { key: 'xxx' }],
+            failedKeys: [
+                {
+                    key: 'baz',
+                    entityName: 'departments',
+                    error: { code: 'VALIDATION_ERROR', message: 'Invalid value' }
+                }
+            ]
+        }), {
+            status: 200,
+            headers: { 'x-trace-id': traceId }
+        });
+        const { sut, apiClient } = prepare(response);
+        const ttl = { value: 10, unit: 'MINUTES' };
+        const items = [
+            { key: 'foo', value: 'John Doe', entityName: 'employees', options: { ttl } },
+            { key: 'bar', value: 'simple value', options: { ttl } },
+            { key: 'baz', value: 'IT Department', entityName: 'departments', options: { ttl } },
+            { key: 'xxx', value: 'yyy', options: { ttl } }
+        ];
+        const rs = await sut.batchSet(items);
+        expect(rs).toEqual({
+            successfulKeys: [{ key: 'foo', entityName: 'employees' }, { key: 'bar' }, { key: 'xxx' }],
+            failedKeys: [
+                {
+                    key: 'baz',
+                    entityName: 'departments',
+                    error: { code: 'VALIDATION_ERROR', message: 'Invalid value' }
+                }
+            ]
+        });
+        expect(apiClient).toHaveBeenCalledWith('/api/v1/batch/set', expect.objectContaining({
+            body: JSON.stringify(items)
+        }));
+    });
     it('should handle batchSet with all successful keys', async () => {
         const response = new Response(JSON.stringify({
             successfulKeys: [{ key: 'foo' }, { key: 'bar' }],

package/out/entity-query.d.ts

@@ -1,9 +1,10 @@
-import { EntityFilterClauses, AndFilter, EntityQueryBuilder, IndexQueryBuilder, Filter, FilterItem, IndexOptions, OrFilter } from './interfaces/entity-query';
+import { EntityFilterClauses, EntityQueryOptions, AndFilter, EntityQueryBuilder, IndexQueryBuilder, Filter, FilterItem, IndexOptions, OrFilter } from './interfaces/entity-query';
 import { StorageApi } from './storage-api';
 export declare class KvsIndexQueryBuilder<T> implements IndexQueryBuilder<T> {
     private readonly entityName;
     private readonly storageApi;
-    constructor(entityName: string, storageApi: StorageApi);
+    private readonly options?;
+    constructor(entityName: string, storageApi: StorageApi, options?: Partial<EntityQueryOptions<T>> | undefined);
     index(name: string, indexOptions?: IndexOptions<T>): EntityQueryBuilder<T>;
 }
 export declare abstract class BaseFilter<T> {

package/out/entity-query.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entity-query.d.ts","sourceRoot":"","sources":["../src/entity-query.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EAGnB,SAAS,EACT,kBAAkB,EAClB,iBAAiB,EACjB,MAAM,EACN,UAAU,EACV,YAAY,EACZ,QAAQ,EACT,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,qBAAa,oBAAoB,CAAC,CAAC,CAAE,YAAW,iBAAiB,CAAC,CAAC,CAAC;IAEhE,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU;gBADV,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,UAAU;IAGzC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC;CAQ3E;AAwDD,8BAAsB,UAAU,CAAC,CAAC;IACpB,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;gBAA3B,KAAK,GAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAM;IAExD,OAAO,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAI/B,QAAQ;CAGhB;AAED,qBAAa,aAAa,CAAC,CAAC,CAAE,SAAQ,UAAU,CAAC,CAAC,CAAE,YAAW,MAAM,CAAC,CAAC,CAAC;IACtE,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,gBAAgB,CAAC,CAAC,CAAC;IAIxE,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,eAAe,CAAC,CAAC,CAAC;CAGvE;AAED,cAAM,gBAAgB,CAAC,CAAC,CAAE,SAAQ,UAAU,CAAC,CAAC,CAAE,YAAW,SAAS,CAAC,CAAC,CAAC;IACrE,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,IAAI;CAI1D;AAED,cAAM,eAAe,CAAC,CAAC,CAAE,SAAQ,UAAU,CAAC,CAAC,CAAE,YAAW,QAAQ,CAAC,CAAC,CAAC;IACnE,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,IAAI;CAIzD"}
+{"version":3,"file":"entity-query.d.ts","sourceRoot":"","sources":["../src/entity-query.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAElB,SAAS,EACT,kBAAkB,EAClB,iBAAiB,EACjB,MAAM,EACN,UAAU,EACV,YAAY,EACZ,QAAQ,EACT,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,qBAAa,oBAAoB,CAAC,CAAC,CAAE,YAAW,iBAAiB,CAAC,CAAC,CAAC;IAEhE,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAFR,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,UAAU,EACtB,OAAO,CAAC,4CAAgC;IAG3D,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC;CAU3E;AA4DD,8BAAsB,UAAU,CAAC,CAAC;IACpB,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;gBAA3B,KAAK,GAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAM;IAExD,OAAO,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAI/B,QAAQ;CAGhB;AAED,qBAAa,aAAa,CAAC,CAAC,CAAE,SAAQ,UAAU,CAAC,CAAC,CAAE,YAAW,MAAM,CAAC,CAAC,CAAC;IACtE,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,gBAAgB,CAAC,CAAC,CAAC;IAIxE,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,eAAe,CAAC,CAAC,CAAC;CAGvE;AAED,cAAM,gBAAgB,CAAC,CAAC,CAAE,SAAQ,UAAU,CAAC,CAAC,CAAE,YAAW,SAAS,CAAC,CAAC,CAAC;IACrE,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,IAAI;CAI1D;AAED,cAAM,eAAe,CAAC,CAAC,CAAE,SAAQ,UAAU,CAAC,CAAC,CAAE,YAAW,QAAQ,CAAC,CAAC,CAAC;IACnE,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,IAAI;CAIzD"}

package/out/entity-query.js

@@ -4,12 +4,15 @@ exports.FilterBuilder = exports.BaseFilter = exports.KvsIndexQueryBuilder = void
 class KvsIndexQueryBuilder {
     entityName;
     storageApi;
-    constructor(entityName, storageApi) {
+    options;
+    constructor(entityName, storageApi, options) {
         this.entityName = entityName;
         this.storageApi = storageApi;
+        this.options = options;
     }
     index(name, indexOptions) {
         return new KvsEntityQueryBuilder(this.storageApi, {
+            ...this.options,
             entityName: this.entityName,
             indexName: name,
             partition: indexOptions?.partition,
@@ -54,16 +57,20 @@ class KvsEntityQueryBuilder {
         return undefined;
     }
     async getMany() {
-        const { filters, filterOperator, ...rest } = this.queryOptions;
+        const maybeOptions = {
+            ...(this.queryOptions?.metadataFields ? { options: { metadataFields: this.queryOptions.metadataFields } } : {})
+        };
+        const { filters, filterOperator, metadataFields, ...rest } = this.queryOptions;
         if (filters && filterOperator && filters.length > 0) {
             return this.storageApi.queryEntity({
                 ...rest,
+                ...maybeOptions,
                 filters: {
                     [filterOperator]: filters
                 }
             });
         }
-        return this.storageApi.queryEntity(rest);
+        return this.storageApi.queryEntity({ ...rest, ...maybeOptions });
     }
 }
 class BaseFilter {

package/out/entity.d.ts

@@ -1,6 +1,6 @@
-import { IndexQueryBuilder } from './interfaces/entity-query';
+import { EntityQueryOptions, IndexQueryBuilder } from './interfaces/entity-query';
 import { KvsEntity } from './interfaces/kvs';
-import { GetOptions, GetResult } from './interfaces/types';
+import { GetOptions, GetResult, SetOptions, PolicySetOptions, OverrideAndReturnSetOptions, SetResult } from './interfaces/types';
 import { StorageApi } from './storage-api';
 export declare class EntityImpl<T> implements KvsEntity<T> {
     private readonly entityName;
@@ -8,8 +8,10 @@ export declare class EntityImpl<T> implements KvsEntity<T> {
     constructor(entityName: string, storageApi: StorageApi);
     get(key: string): Promise<T | undefined>;
     get(key: string, options: GetOptions): Promise<GetResult<T> | undefined>;
-    set(key: string, value: T): Promise<void>;
+    set(key: string, value: T, options?: SetOptions): Promise<void>;
+    set(key: string, value: T, options: PolicySetOptions): Promise<void>;
+    set<U = T>(key: string, value: T, options: OverrideAndReturnSetOptions): Promise<SetResult<U> | undefined>;
     delete(key: string): Promise<void>;
-    query(): IndexQueryBuilder<T>;
+    query(options?: Pick<EntityQueryOptions<T>, 'metadataFields'>): IndexQueryBuilder<T>;
 }
 //# sourceMappingURL=entity.d.ts.map

package/out/entity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../src/entity.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,qBAAa,UAAU,CAAC,CAAC,CAAE,YAAW,SAAS,CAAC,CAAC,CAAC;IAE9C,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU;gBADV,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,UAAU;IAGzC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IACxC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IASxE,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAQzC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOlC,KAAK,IAAI,iBAAiB,CAAC,CAAC,CAAC;CAG9B"}
+{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../src/entity.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAClF,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EACL,UAAU,EACV,SAAS,EACT,UAAU,EACV,gBAAgB,EAChB,2BAA2B,EAC3B,SAAS,EAEV,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,qBAAa,UAAU,CAAC,CAAC,CAAE,YAAW,SAAS,CAAC,CAAC,CAAC;IAE9C,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU;gBADV,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,UAAU;IAGzC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IACxC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IASxE,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAC/D,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IACpE,GAAG,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAU1G,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOlC,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC;CAGrF"}