@declaro/data 2.0.0-beta.127 → 2.0.0-beta.129

package/dist/ts/domain/services/model-service.d.ts

@@ -29,6 +29,25 @@ export declare class ModelService<TSchema extends AnyModelSchema> extends ReadOn
      * @returns The normalized input data.
      */
     protected normalizeInput(input: InferInput<TSchema>, args: INormalizeInputArgs<TSchema>): Promise<InferInput<TSchema>>;
+    /**
+     * Converts a detail object to a valid input for this service's schema.
+     * Picks only fields that exist in the input model and validates/coerces
+     * them through the input schema. Useful for duplicating entities or
+     * converting a detail from one entity type into an input for another.
+     * @param detail The detail object to convert (can be from any schema).
+     * @returns A validated input object with coerced values.
+     */
+    detailsToInput(detail: Record<string, unknown>): Promise<InferInput<TSchema>>;
+    /**
+     * Duplicates an existing entity by loading it, converting to input, removing the
+     * primary key, and creating a new record. Accepts an optional partial input to
+     * merge on top of the converted copy before creation.
+     * @param lookup The lookup criteria to find the record to duplicate.
+     * @param overrides Optional partial input to merge on top of the duplicated data.
+     * @param options Optional create options.
+     * @returns The newly created duplicate record.
+     */
+    duplicate(lookup: InferLookup<TSchema>, overrides?: Partial<InferInput<TSchema>>, options?: ICreateOptions): Promise<InferDetail<TSchema>>;
     /**
      * Removes a record by its lookup criteria.
      * @param lookup The lookup criteria to find the record.

package/dist/ts/domain/services/model-service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"model-service.d.ts","sourceRoot":"","sources":["../../../../src/domain/services/model-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAqB,MAAM,eAAe,CAAA;AACxF,OAAO,KAAK,EACR,WAAW,EACX,YAAY,EACZ,UAAU,EACV,WAAW,EACX,YAAY,EACf,MAAM,qCAAqC,CAAA;AAG5C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAC7D,OAAO,EAAE,oBAAoB,EAAE,KAAK,YAAY,EAAE,MAAM,2BAA2B,CAAA;AACnF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D,MAAM,WAAW,cAAe,SAAQ,cAAc;IAClD;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAChC;AACD,MAAM,WAAW,cAAe,SAAQ,cAAc;IAClD;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAChC;AAED,MAAM,WAAW,mBAAmB,CAAC,OAAO,SAAS,cAAc;IAC/D,QAAQ,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC/B,UAAU,EAAE,gBAAgB,CAAA;CAC/B;AAED,qBAAa,YAAY,CAAC,OAAO,SAAS,cAAc,CAAE,SAAQ,oBAAoB,CAAC,OAAO,CAAC;gBAC/E,IAAI,EAAE,iBAAiB,CAAC,OAAO,CAAC;IAI5C;;;;;;OAMG;cACa,cAAc,CAC1B,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,EAC1B,IAAI,EAAE,mBAAmB,CAAC,OAAO,CAAC,GACnC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAI/B;;;;OAIG;IACG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAsBlG;;;;;OAKG;IACG,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAsB7F,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IA+B3F,MAAM,CACR,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,EAC5B,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,EAC1B,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAiChC;;;;;OAKG;IACG,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAiElH;;;;;OAKG;IACG,UAAU,CACZ,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,EAC7B,OAAO,CAAC,EAAE,cAAc,GAAG,cAAc,GAC1C,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;IAiIlC;;;;OAIG;IACG,UAAU,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAsBlE;;;;OAIG;IACG,0BAA0B,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAsB9F;;;;OAIG;IACG,iBAAiB,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;CAqBxF"}
+{"version":3,"file":"model-service.d.ts","sourceRoot":"","sources":["../../../../src/domain/services/model-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAgC,MAAM,eAAe,CAAA;AACnG,OAAO,KAAK,EACR,WAAW,EACX,YAAY,EACZ,UAAU,EACV,WAAW,EACX,YAAY,EACf,MAAM,qCAAqC,CAAA;AAG5C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAC7D,OAAO,EAAE,oBAAoB,EAAE,KAAK,YAAY,EAAE,MAAM,2BAA2B,CAAA;AACnF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAE1D,MAAM,WAAW,cAAe,SAAQ,cAAc;IAClD;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAChC;AACD,MAAM,WAAW,cAAe,SAAQ,cAAc;IAClD;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAChC;AAED,MAAM,WAAW,mBAAmB,CAAC,OAAO,SAAS,cAAc;IAC/D,QAAQ,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAC/B,UAAU,EAAE,gBAAgB,CAAA;CAC/B;AAED,qBAAa,YAAY,CAAC,OAAO,SAAS,cAAc,CAAE,SAAQ,oBAAoB,CAAC,OAAO,CAAC;gBAC/E,IAAI,EAAE,iBAAiB,CAAC,OAAO,CAAC;IAI5C;;;;;;OAMG;cACa,cAAc,CAC1B,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,EAC1B,IAAI,EAAE,mBAAmB,CAAC,OAAO,CAAC,GACnC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAI/B;;;;;;;OAOG;IACG,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAuBnF;;;;;;;;OAQG;IACG,SAAS,CACX,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,EAC5B,SAAS,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,EACxC,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAsBhC;;;;OAIG;IACG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAsBlG;;;;;OAKG;IACG,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAsB7F,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IA+B3F,MAAM,CACR,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,EAC5B,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,EAC1B,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAiChC;;;;;OAKG;IACG,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAiElH;;;;;OAKG;IACG,UAAU,CACZ,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,EAC7B,OAAO,CAAC,EAAE,cAAc,GAAG,cAAc,GAC1C,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;IAiIlC;;;;OAIG;IACG,UAAU,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAsBlE;;;;OAIG;IACG,0BAA0B,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAsB9F;;;;OAIG;IACG,iBAAiB,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;CAqBxF"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@declaro/data",
-    "version": "2.0.0-beta.127",
+    "version": "2.0.0-beta.129",
     "description": "A data-mapper framework for managing application data across integrated systems.",
     "main": "dist/node/index.cjs",
     "module": "dist/node/index.js",
@@ -22,9 +22,9 @@
         "@declaro/zod": "^2.0.0-beta.51"
     },
     "devDependencies": {
-        "@declaro/auth": "^2.0.0-beta.127",
-        "@declaro/core": "^2.0.0-beta.127",
-        "@declaro/zod": "^2.0.0-beta.127",
+        "@declaro/auth": "^2.0.0-beta.129",
+        "@declaro/core": "^2.0.0-beta.129",
+        "@declaro/zod": "^2.0.0-beta.129",
         "crypto-browserify": "^3.12.1",
         "typescript": "^5.8.3",
         "uuid": "^11.1.0",
@@ -37,11 +37,11 @@
         "src/**/*"
     ],
     "exports": {
-        "bun": "./src/index.ts",
         "types": "./dist/ts/index.d.ts",
         "import": "./dist/node/index.js",
         "require": "./dist/node/index.cjs",
-        "browser": "./dist/browser/index.js"
+        "browser": "./dist/browser/index.js",
+        "default": "./dist/node/index.js"
     },
-    "gitHead": "202022ddd09776b9e2e02daac5af2359191ae108"
+    "gitHead": "b50c976a2f294d82d3d1d03a71cb6c6053a114df"
 }

package/src/domain/services/model-service.test.ts

@@ -935,6 +935,186 @@ describe('ModelService', () => {
         })
     })
 
+    describe('detailsToInput', () => {
+        it('should convert a detail object to an input by picking only input fields', async () => {
+            const detail = { id: 42, title: 'Test Book', author: 'Author Name', publishedDate: new Date('2023-06-15') }
+            const input = await service.detailsToInput(detail)
+
+            expect(input.title).toBe('Test Book')
+            expect(input.author).toBe('Author Name')
+            expect(input.publishedDate).toEqual(new Date('2023-06-15'))
+        })
+
+        it('should exclude fields not present in the input model', async () => {
+            const detailWithExtras = {
+                id: 42,
+                title: 'Test Book',
+                author: 'Author Name',
+                publishedDate: new Date('2023-06-15'),
+                extraField: 'should be excluded',
+                anotherExtra: 123,
+            }
+            const input = await service.detailsToInput(detailWithExtras)
+
+            expect(input.title).toBe('Test Book')
+            expect(input.author).toBe('Author Name')
+            expect((input as any).extraField).toBeUndefined()
+            expect((input as any).anotherExtra).toBeUndefined()
+        })
+
+        it('should coerce values through the input schema', async () => {
+            // publishedDate uses z.coerce.date(), so a string should be coerced to a Date
+            const detailWithStringDate = {
+                id: 42,
+                title: 'Test Book',
+                author: 'Author Name',
+                publishedDate: '2023-06-15T00:00:00.000Z',
+            }
+            const input = await service.detailsToInput(detailWithStringDate)
+
+            expect(input.publishedDate).toBeInstanceOf(Date)
+            expect(input.publishedDate).toEqual(new Date('2023-06-15T00:00:00.000Z'))
+        })
+
+        it('should include the primary key field when present in the source', async () => {
+            const detail = { id: 42, title: 'Test Book', author: 'Author Name', publishedDate: new Date() }
+            const input = await service.detailsToInput(detail)
+
+            // id is optional in the input model but should be included if present
+            expect(input.id).toBe(42)
+        })
+
+        it('should work with partial source data that satisfies required input fields', async () => {
+            const minimalDetail = {
+                title: 'Minimal Book',
+                author: 'Some Author',
+                publishedDate: new Date(),
+            }
+            const input = await service.detailsToInput(minimalDetail)
+
+            expect(input.title).toBe('Minimal Book')
+            expect(input.author).toBe('Some Author')
+            expect(input.id).toBeUndefined()
+        })
+
+        it('should produce a valid input that can be used with create', async () => {
+            const detail = { id: 42, title: 'Test Book', author: 'Author Name', publishedDate: new Date('2023-06-15') }
+            const input = await service.detailsToInput(detail)
+
+            // Remove the primary key and create a new record
+            delete (input as any).id
+            const created = await service.create(input)
+
+            expect(created.title).toBe('Test Book')
+            expect(created.author).toBe('Author Name')
+            expect(created.id).toBeDefined()
+            expect(created.id).not.toBe(42)
+        })
+    })
+
+    describe('duplicate', () => {
+        it('should create a duplicate of an existing record with a new primary key', async () => {
+            const original = { id: 42, title: 'Original Book', author: 'Author Name', publishedDate: new Date('2023-06-15') }
+            await repository.create(original)
+
+            const duplicate = await service.duplicate({ id: 42 })
+
+            expect(duplicate.title).toBe('Original Book')
+            expect(duplicate.author).toBe('Author Name')
+            expect(duplicate.publishedDate).toEqual(new Date('2023-06-15'))
+            expect(duplicate.id).toBeDefined()
+            expect(duplicate.id).not.toBe(42)
+        })
+
+        it('should apply overrides to the duplicated record', async () => {
+            const original = { id: 42, title: 'Original Book', author: 'Author Name', publishedDate: new Date('2023-06-15') }
+            await repository.create(original)
+
+            const duplicate = await service.duplicate({ id: 42 }, { title: 'Duplicated Book' })
+
+            expect(duplicate.title).toBe('Duplicated Book')
+            expect(duplicate.author).toBe('Author Name')
+            expect(duplicate.id).toBeDefined()
+            expect(duplicate.id).not.toBe(42)
+        })
+
+        it('should throw an error when trying to duplicate a non-existent record', async () => {
+            await expect(service.duplicate({ id: 999 })).rejects.toThrow()
+        })
+
+        it('should trigger create events for the duplicate', async () => {
+            const original = { id: 42, title: 'Original Book', author: 'Author Name', publishedDate: new Date() }
+            await repository.create(original)
+
+            beforeCreateSpy.mockClear()
+            afterCreateSpy.mockClear()
+
+            await service.duplicate({ id: 42 })
+
+            expect(beforeCreateSpy).toHaveBeenCalledTimes(1)
+            expect(afterCreateSpy).toHaveBeenCalledTimes(1)
+        })
+
+        it('should not modify the original record', async () => {
+            const original = { id: 42, title: 'Original Book', author: 'Author Name', publishedDate: new Date('2023-06-15') }
+            await repository.create(original)
+
+            await service.duplicate({ id: 42 }, { title: 'Modified Title' })
+
+            const loaded = await repository.load({ id: 42 })
+            expect(loaded?.title).toBe('Original Book')
+            expect(loaded?.author).toBe('Author Name')
+        })
+
+        it('should allow overriding multiple fields', async () => {
+            const original = { id: 42, title: 'Original Book', author: 'Author Name', publishedDate: new Date('2023-06-15') }
+            await repository.create(original)
+
+            const newDate = new Date('2024-01-01')
+            const duplicate = await service.duplicate({ id: 42 }, {
+                title: 'New Title',
+                author: 'New Author',
+                publishedDate: newDate,
+            })
+
+            expect(duplicate.title).toBe('New Title')
+            expect(duplicate.author).toBe('New Author')
+            expect(duplicate.publishedDate).toEqual(newDate)
+            expect(duplicate.id).not.toBe(42)
+        })
+
+        it('should create independent records that can be modified separately', async () => {
+            const original = { id: 42, title: 'Original Book', author: 'Author Name', publishedDate: new Date('2023-06-15') }
+            await repository.create(original)
+
+            const duplicate = await service.duplicate({ id: 42 })
+
+            // Update the duplicate
+            await service.update({ id: duplicate.id }, { title: 'Updated Duplicate', author: 'Updated Author', publishedDate: new Date() })
+
+            // Verify original is unchanged
+            const loadedOriginal = await repository.load({ id: 42 })
+            expect(loadedOriginal?.title).toBe('Original Book')
+
+            // Verify duplicate was updated
+            const loadedDuplicate = await repository.load({ id: duplicate.id })
+            expect(loadedDuplicate?.title).toBe('Updated Duplicate')
+        })
+
+        it('should respect doNotDispatchEvents option', async () => {
+            const original = { id: 42, title: 'Original Book', author: 'Author Name', publishedDate: new Date() }
+            await repository.create(original)
+
+            beforeCreateSpy.mockClear()
+            afterCreateSpy.mockClear()
+
+            await service.duplicate({ id: 42 }, undefined, { doNotDispatchEvents: true })
+
+            expect(beforeCreateSpy).not.toHaveBeenCalled()
+            expect(afterCreateSpy).not.toHaveBeenCalled()
+        })
+    })
+
     describe('doNotDispatchEvents option', () => {
         const beforeLoadSpy = mock(() => {})
         const afterLoadSpy = mock(() => {})

package/src/domain/services/model-service.ts

@@ -1,4 +1,4 @@
-import type { ActionDescriptor, AnyModelSchema, IActionDescriptor } from '@declaro/core'
+import type { ActionDescriptor, AnyModelSchema, IActionDescriptor, IAnyModel } from '@declaro/core'
 import type {
     InferDetail,
     InferFilters,
@@ -49,6 +49,72 @@ export class ModelService<TSchema extends AnyModelSchema> extends ReadOnlyModelS
         return input
     }
 
+    /**
+     * Converts a detail object to a valid input for this service's schema.
+     * Picks only fields that exist in the input model and validates/coerces
+     * them through the input schema. Useful for duplicating entities or
+     * converting a detail from one entity type into an input for another.
+     * @param detail The detail object to convert (can be from any schema).
+     * @returns A validated input object with coerced values.
+     */
+    async detailsToInput(detail: Record<string, unknown>): Promise<InferInput<TSchema>> {
+        const inputModel: IAnyModel = this.schema.definition.input
+        const inputJsonSchema = inputModel.toJSONSchema()
+        const inputFields = Object.keys(inputJsonSchema.properties ?? {})
+
+        // Pick only fields that exist in the input model
+        const picked: Record<string, unknown> = {}
+        for (const field of inputFields) {
+            if (field in detail) {
+                picked[field] = detail[field]
+            }
+        }
+
+        // Validate through the input model to coerce values
+        const result = await inputModel.validate(picked as any)
+
+        if ('value' in result) {
+            return result.value as InferInput<TSchema>
+        }
+
+        return picked as InferInput<TSchema>
+    }
+
+    /**
+     * Duplicates an existing entity by loading it, converting to input, removing the
+     * primary key, and creating a new record. Accepts an optional partial input to
+     * merge on top of the converted copy before creation.
+     * @param lookup The lookup criteria to find the record to duplicate.
+     * @param overrides Optional partial input to merge on top of the duplicated data.
+     * @param options Optional create options.
+     * @returns The newly created duplicate record.
+     */
+    async duplicate(
+        lookup: InferLookup<TSchema>,
+        overrides?: Partial<InferInput<TSchema>>,
+        options?: ICreateOptions,
+    ): Promise<InferDetail<TSchema>> {
+        // Load the existing entity
+        const existing = await this.load(lookup)
+        if (!existing) {
+            throw new Error('Item not found')
+        }
+
+        // Convert the detail to an input
+        const input = await this.detailsToInput(existing as Record<string, unknown>)
+
+        // Remove the primary key to ensure a new record gets created
+        if (this.entityMetadata?.primaryKey) {
+            delete (input as Record<string, unknown>)[this.entityMetadata.primaryKey]
+        }
+
+        // Merge optional overrides
+        const finalInput = overrides ? Object.assign({}, input, overrides) : input
+
+        // Create the new record
+        return this.create(finalInput as InferInput<TSchema>, options)
+    }
+
     /**
      * Removes a record by its lookup criteria.
      * @param lookup The lookup criteria to find the record.