@bsv/wallet-toolbox 1.1.7 → 1.1.9

package/src/storage/schema/entities/__tests/usersTests.test.ts

@@ -1,5 +1,5 @@
-import { User } from '../../../../../src/storage/schema/entities/User'
-import { entity, table, sdk } from '../../../../../src'
+import { EntityUser } from '../../../../../src/storage/schema/entities/User'
+import { createSyncMap, sdk, SyncMap, TableUser } from '../../../../../src'
 import {
   TestUtilsWalletStorage as _tu,
   TestWalletNoSetup
@@ -34,7 +34,7 @@ describe('User class method tests', () => {
 
   // Test: Default constructor behavior
   test('1_creates_user_with_default_values', () => {
-    const user = new User()
+    const user = new EntityUser()
 
     // Default values
     expect(user.userId).toBe(0)
@@ -47,13 +47,13 @@ describe('User class method tests', () => {
   // Test: Constructor with provided API object
   test('2_creates_user_with_provided_api_object', () => {
     const now = new Date()
-    const apiObject: table.User = {
+    const apiObject: TableUser = {
       userId: 42,
       created_at: now,
       updated_at: now,
       identityKey: 'testIdentityKey'
     }
-    const user = new User(apiObject)
+    const user = new EntityUser(apiObject)
 
     // Verify all properties match the API object
     expect(user.userId).toBe(42)
@@ -64,7 +64,7 @@ describe('User class method tests', () => {
 
   // Test: Getters and setters behavior
   test('3_getters_and_setters_work_correctly', () => {
-    const user = new User()
+    const user = new EntityUser()
 
     // Test setting values
     const now = new Date()
@@ -87,7 +87,7 @@ describe('User class method tests', () => {
     for (const ctx1 of ctxs) {
       for (const ctx2 of ctxs2) {
         // Insert the first user into the first database
-        const user1 = new User({
+        const user1 = new EntityUser({
           userId: 2,
           identityKey: 'key1',
           created_at: new Date('2023-01-01'),
@@ -96,7 +96,7 @@ describe('User class method tests', () => {
         await ctx1.activeStorage.insertUser(user1.toApi())
 
         // Insert a matching user into the second database
-        const user2 = new User({
+        const user2 = new EntityUser({
           userId: 3, // Different ID
           identityKey: 'key1', // Same key
           created_at: new Date('2023-01-01'),
@@ -104,81 +104,7 @@ describe('User class method tests', () => {
         })
         await ctx2.activeStorage.insertUser(user2.toApi())
 
-        // Create a valid SyncMap mapping IDs from db1 to db2
-        const syncMap: entity.SyncMap = {
-          transaction: {
-            idMap: { [user1.userId]: user2.userId },
-            entityName: 'Transaction',
-            maxUpdated_at: undefined,
-            count: 1
-          },
-          provenTx: {
-            idMap: {},
-            entityName: 'ProvenTx',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          outputBasket: {
-            idMap: {},
-            entityName: 'OutputBasket',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          provenTxReq: {
-            idMap: {},
-            entityName: 'ProvenTxReq',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          txLabel: {
-            idMap: {},
-            entityName: 'TxLabel',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          txLabelMap: {
-            idMap: {},
-            entityName: 'TxLabelMap',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          output: {
-            idMap: {},
-            entityName: 'Output',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          outputTag: {
-            idMap: {},
-            entityName: 'OutputTag',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          outputTagMap: {
-            idMap: {},
-            entityName: 'OutputTagMap',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          certificate: {
-            idMap: {},
-            entityName: 'Certificate',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          certificateField: {
-            idMap: {},
-            entityName: 'CertificateField',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          commission: {
-            idMap: {},
-            entityName: 'Commission',
-            maxUpdated_at: undefined,
-            count: 0
-          }
-        }
+        const syncMap = createSyncMap()
 
         // Verify the entities match across databases
         expect(user1.equals(user2.toApi(), syncMap)).toBe(true) // Should match
@@ -191,7 +117,7 @@ describe('User class method tests', () => {
     for (const ctx1 of ctxs) {
       for (const ctx2 of ctxs2) {
         // Insert the first user into the first database
-        const user1 = new User({
+        const user1 = new EntityUser({
           userId: 4,
           identityKey: 'key2',
           created_at: new Date('2023-01-01'),
@@ -200,7 +126,7 @@ describe('User class method tests', () => {
         await ctx1.activeStorage.insertUser(user1.toApi())
 
         // Insert a user with a different key into the second database
-        const user2 = new User({
+        const user2 = new EntityUser({
           userId: 5, // Different ID
           identityKey: 'key3', // Different key
           created_at: new Date('2023-01-01'),
@@ -208,81 +134,7 @@ describe('User class method tests', () => {
         })
         await ctx2.activeStorage.insertUser(user2.toApi())
 
-        // Create a valid SyncMap mapping IDs from db1 to db2
-        const syncMap: entity.SyncMap = {
-          transaction: {
-            idMap: { [user1.userId]: user2.userId },
-            entityName: 'Transaction',
-            maxUpdated_at: undefined,
-            count: 1
-          },
-          provenTx: {
-            idMap: {},
-            entityName: 'ProvenTx',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          outputBasket: {
-            idMap: {},
-            entityName: 'OutputBasket',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          provenTxReq: {
-            idMap: {},
-            entityName: 'ProvenTxReq',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          txLabel: {
-            idMap: {},
-            entityName: 'TxLabel',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          txLabelMap: {
-            idMap: {},
-            entityName: 'TxLabelMap',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          output: {
-            idMap: {},
-            entityName: 'Output',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          outputTag: {
-            idMap: {},
-            entityName: 'OutputTag',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          outputTagMap: {
-            idMap: {},
-            entityName: 'OutputTagMap',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          certificate: {
-            idMap: {},
-            entityName: 'Certificate',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          certificateField: {
-            idMap: {},
-            entityName: 'CertificateField',
-            maxUpdated_at: undefined,
-            count: 0
-          },
-          commission: {
-            idMap: {},
-            entityName: 'Commission',
-            maxUpdated_at: undefined,
-            count: 0
-          }
-        }
+        const syncMap = createSyncMap()
 
         // Verify the entities do not match across databases
         expect(user1.equals(user2.toApi(), syncMap)).toBe(false) // Should not match
@@ -296,12 +148,12 @@ describe('User class method tests', () => {
     const pastDate = new Date(now.getTime() - 1000000)
 
     // Provide incomplete API object
-    const partialApiObject: Partial<table.User> = {
+    const partialApiObject: Partial<TableUser> = {
       userId: 123,
       created_at: pastDate
     }
 
-    const user = new User(partialApiObject as table.User)
+    const user = new EntityUser(partialApiObject as TableUser)
 
     // Default values should fill in missing fields
     expect(user.userId).toBe(123)
@@ -316,13 +168,13 @@ describe('User class method tests', () => {
     const largeUserId = Number.MAX_SAFE_INTEGER
     const longIdentityKey = 'x'.repeat(1000)
 
-    const apiObject: table.User = {
+    const apiObject: TableUser = {
       userId: largeUserId,
       created_at: now,
       updated_at: now,
       identityKey: longIdentityKey
     }
-    const user = new User(apiObject)
+    const user = new EntityUser(apiObject)
 
     expect(user.userId).toBe(largeUserId)
     expect(user.identityKey).toBe(longIdentityKey)
@@ -330,8 +182,8 @@ describe('User class method tests', () => {
 
   // Test: Handles empty API object
   test('10_handles_empty_api_object', () => {
-    const emptyApiObject: table.User = {} as table.User
-    const user = new User(emptyApiObject)
+    const emptyApiObject: TableUser = {} as TableUser
+    const user = new EntityUser(emptyApiObject)
 
     // Default values should be applied but constructor does not set default values for empty object
     expect(user.userId).toBeUndefined()
@@ -342,7 +194,7 @@ describe('User class method tests', () => {
 
   // Test: `id` getter and setter
   test('11_id_getter_and_setter_work_correctly', () => {
-    const user = new User()
+    const user = new EntityUser()
 
     user.id = 123 // Test setter
     expect(user.id).toBe(123) // Test getter
@@ -350,21 +202,21 @@ describe('User class method tests', () => {
 
   // Test: `entityName` getter
   test('12_entityName_returns_User', () => {
-    const user = new User()
+    const user = new EntityUser()
 
-    expect(user.entityName).toBe('User')
+    expect(user.entityName).toBe('user')
   })
 
   // Test: `entityTable` getter
   test('13_entityTable_returns_users', () => {
-    const user = new User()
+    const user = new EntityUser()
 
     expect(user.entityTable).toBe('users')
   })
 
   // Test: `mergeExisting` updates user when `ei.updated_at` is newer
   test('14_mergeExisting_updates_user_when_ei_updated_at_is_newer', async () => {
-    const user = new User({
+    const user = new EntityUser({
       userId: 1,
       created_at: new Date('2023-01-01'),
       updated_at: new Date('2023-01-01'),
@@ -372,7 +224,7 @@ describe('User class method tests', () => {
       activeStorage: 'oldStorage'
     })
 
-    const updatedEi: table.User = {
+    const updatedEi: TableUser = {
       userId: 1,
       created_at: new Date('2023-01-01'),
       updated_at: new Date('2023-02-01'), // Newer `updated_at`
@@ -382,7 +234,7 @@ describe('User class method tests', () => {
 
     const result = await user.mergeExisting(
       {
-        updateUser: async (id: number, data: table.User) => {
+        updateUser: async (id: number, data: TableUser) => {
           expect(id).toBe(1)
           expect(data.activeStorage).toBe('newStorage')
           expect(data.updated_at).toBeInstanceOf(Date)
@@ -399,7 +251,7 @@ describe('User class method tests', () => {
 
   // Test: `mergeExisting` does not update user when `ei.updated_at` is older
   test('15_mergeExisting_does_not_update_user_when_ei_updated_at_is_older', async () => {
-    const user = new User({
+    const user = new EntityUser({
       userId: 1,
       created_at: new Date('2023-01-01'),
       updated_at: new Date('2023-02-01'),
@@ -407,7 +259,7 @@ describe('User class method tests', () => {
       activeStorage: 'oldStorage'
     })
 
-    const olderEi: table.User = {
+    const olderEi: TableUser = {
       userId: 1,
       created_at: new Date('2023-01-01'),
       updated_at: new Date('2023-01-01'), // Older `updated_at`
@@ -432,7 +284,7 @@ describe('User class method tests', () => {
 
   // Test: `mergeExisting` updates user and uses `trx` when provided
   test('16_mergeExisting_updates_user_with_trx', async () => {
-    const user = new User({
+    const user = new EntityUser({
       userId: 1,
       created_at: new Date('2023-01-01'),
       updated_at: new Date('2023-01-01'),
@@ -440,7 +292,7 @@ describe('User class method tests', () => {
       activeStorage: 'oldStorage'
     })
 
-    const updatedEi: table.User = {
+    const updatedEi: TableUser = {
       userId: 1,
       created_at: new Date('2023-01-01'),
       updated_at: new Date('2023-02-01'), // Newer `updated_at`
@@ -452,7 +304,7 @@ describe('User class method tests', () => {
 
     const result = await user.mergeExisting(
       {
-        updateUser: async (id: number, data: table.User, trx: any) => {
+        updateUser: async (id: number, data: TableUser, trx: any) => {
           expect(id).toBe(1)
           expect(data.activeStorage).toBe('newStorage')
           expect(data.updated_at).toBeInstanceOf(Date)
@@ -471,7 +323,7 @@ describe('User class method tests', () => {
 
   // Test: `mergeNew` always throws an error
   test('17_mergeNew_always_throws_error', async () => {
-    const user = new User()
+    const user = new EntityUser()
     const storage = {} // Placeholder for `storage`, not used in this case.
     const userId = 123 // Example userId
     const syncMap = {} // Placeholder for `syncMap`, not used in this case.

package/src/storage/schema/tables/Certificate.ts

@@ -1,7 +1,7 @@
 import { Base64String, HexString, OutpointString, PubKeyHex } from '@bsv/sdk'
-import { sdk, table } from '../../../index.client'
+import { sdk, TableCertificateField } from '../../../index.client'
 
-export interface Certificate extends sdk.EntityTimeStamp {
+export interface TableCertificate extends sdk.EntityTimeStamp {
   created_at: Date
   updated_at: Date
   certificateId: number
@@ -16,6 +16,6 @@ export interface Certificate extends sdk.EntityTimeStamp {
   isDeleted: boolean
 }
 
-export interface CertificateX extends table.Certificate {
-  fields?: table.CertificateField[]
+export interface TableCertificateX extends TableCertificate {
+  fields?: TableCertificateField[]
 }

package/src/storage/schema/tables/CertificateField.ts

@@ -1,7 +1,7 @@
 import { Base64String } from '@bsv/sdk'
 import { sdk } from '../../../index.client'
 
-export interface CertificateField extends sdk.EntityTimeStamp {
+export interface TableCertificateField extends sdk.EntityTimeStamp {
   created_at: Date
   updated_at: Date
   userId: number

package/src/storage/schema/tables/Commission.ts

@@ -1,6 +1,6 @@
 import { sdk } from '../../../index.client'
 
-export interface Commission extends sdk.EntityTimeStamp {
+export interface TableCommission extends sdk.EntityTimeStamp {
   created_at: Date
   updated_at: Date
   commissionId: number

package/src/storage/schema/tables/MonitorEvent.ts

@@ -1,6 +1,6 @@
 import { sdk } from '../../../index.client'
 
-export interface MonitorEvent extends sdk.EntityTimeStamp {
+export interface TableMonitorEvent extends sdk.EntityTimeStamp {
   created_at: Date
   updated_at: Date
   id: number

package/src/storage/schema/tables/Output.ts

@@ -1,8 +1,8 @@
 import { Base64String, DescriptionString5to50Bytes, PubKeyHex } from '@bsv/sdk'
-import { OutputBasket, OutputTag } from '.'
+import { TableOutputBasket, TableOutputTag } from '.'
 import { sdk } from '../../../index.client'
 
-export interface Output extends sdk.EntityTimeStamp {
+export interface TableOutput extends sdk.EntityTimeStamp {
   created_at: Date
   updated_at: Date
   outputId: number
@@ -30,9 +30,9 @@ export interface Output extends sdk.EntityTimeStamp {
   lockingScript?: number[]
 }
 
-export interface OutputX extends Output {
-  basket?: OutputBasket
-  tags?: OutputTag[]
+export interface TableOutputX extends TableOutput {
+  basket?: TableOutputBasket
+  tags?: TableOutputTag[]
 }
 
 export const outputColumnsWithoutLockingScript = [

package/src/storage/schema/tables/OutputBasket.ts

@@ -1,6 +1,6 @@
 import { sdk } from '../../../index.client'
 
-export interface OutputBasket extends sdk.EntityTimeStamp {
+export interface TableOutputBasket extends sdk.EntityTimeStamp {
   created_at: Date
   updated_at: Date
   basketId: number

package/src/storage/schema/tables/OutputTag.ts

@@ -1,6 +1,6 @@
 import { sdk } from '../../../index.client'
 
-export interface OutputTag extends sdk.EntityTimeStamp {
+export interface TableOutputTag extends sdk.EntityTimeStamp {
   created_at: Date
   updated_at: Date
   outputTagId: number

package/src/storage/schema/tables/OutputTagMap.ts

@@ -1,6 +1,6 @@
 import { sdk } from '../../../index.client'
 
-export interface OutputTagMap extends sdk.EntityTimeStamp {
+export interface TableOutputTagMap extends sdk.EntityTimeStamp {
   created_at: Date
   updated_at: Date
   outputTagId: number

package/src/storage/schema/tables/ProvenTx.ts

@@ -1,6 +1,6 @@
 import { sdk } from '../../../index.client'
 
-export interface ProvenTx extends sdk.EntityTimeStamp {
+export interface TableProvenTx extends sdk.EntityTimeStamp {
   created_at: Date
   updated_at: Date
   provenTxId: number

package/src/storage/schema/tables/ProvenTxReq.ts

@@ -1,6 +1,6 @@
 import { sdk } from '../../../index.client'
 
-export interface ProvenTxReq extends ProvenTxReqDynamics {
+export interface TableProvenTxReq extends TableProvenTxReqDynamics {
   created_at: Date
   updated_at: Date
   provenTxReqId: number
@@ -36,7 +36,7 @@ export interface ProvenTxReq extends ProvenTxReqDynamics {
 /**
  * Table properties that may change after initial record insertion.
  */
-export interface ProvenTxReqDynamics extends sdk.EntityTimeStamp {
+export interface TableProvenTxReqDynamics extends sdk.EntityTimeStamp {
   updated_at: Date
   provenTxId?: number
   status: sdk.ProvenTxReqStatus

package/src/storage/schema/tables/SyncState.ts

@@ -1,6 +1,6 @@
 import { sdk } from '../../../index.client'
 
-export interface SyncState extends sdk.EntityTimeStamp {
+export interface TableSyncState extends sdk.EntityTimeStamp {
   created_at: Date
   updated_at: Date
   syncStateId: number

package/src/storage/schema/tables/{Settings.ts → TableSettings.ts}

@@ -1,6 +1,8 @@
 import { sdk } from '../../../index.client'
 
-export interface Settings extends sdk.StorageIdentity, sdk.EntityTimeStamp {
+export interface TableSettings
+  extends sdk.StorageIdentity,
+    sdk.EntityTimeStamp {
   created_at: Date
   updated_at: Date
   /**

package/src/storage/schema/tables/Transaction.ts

@@ -1,7 +1,7 @@
 import { Base64String } from '@bsv/sdk'
 import { sdk } from '../../../index.client'
 
-export interface Transaction extends sdk.EntityTimeStamp {
+export interface TableTransaction extends sdk.EntityTimeStamp {
   created_at: Date
   updated_at: Date
   transactionId: number

package/src/storage/schema/tables/TxLabel.ts

@@ -1,6 +1,6 @@
 import { sdk } from '../../../index.client'
 
-export interface TxLabel extends sdk.EntityTimeStamp {
+export interface TableTxLabel extends sdk.EntityTimeStamp {
   created_at: Date
   updated_at: Date
   txLabelId: number

package/src/storage/schema/tables/TxLabelMap.ts

@@ -1,6 +1,6 @@
 import { sdk } from '../../../index.client'
 
-export interface TxLabelMap extends sdk.EntityTimeStamp {
+export interface TableTxLabelMap extends sdk.EntityTimeStamp {
   created_at: Date
   updated_at: Date
   txLabelId: number

package/src/storage/schema/tables/User.ts

@@ -1,6 +1,6 @@
 import { sdk } from '../../../index.client'
 
-export interface User extends sdk.EntityTimeStamp {
+export interface TableUser extends sdk.EntityTimeStamp {
   created_at: Date
   updated_at: Date
   userId: number

package/src/storage/schema/tables/index.ts

@@ -1,4 +1,4 @@
-export * from './Settings'
+export * from './TableSettings'
 export * from './ProvenTx'
 export * from './ProvenTxReq'
 export * from './User'