Merge pull request #7 from samhuk/story/6

Story 6 - createLink() -> create(), typing for includeDateCreated, sql fixes for it, etc.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-pg-orm",
-  "version": "4.1.3",
+  "version": "4.1.4",
   "description": "Typescript PostgreSQL ORM",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/examples/realDbTest/index.ts

@@ -91,6 +91,7 @@ const ORM = createTsPgOrm()
       type: RelationType.MANY_TO_MANY,
       fieldRef1: dfs.user.fieldRefs.id,
       fieldRef2: dfs.userGroup.fieldRefs.id,
+      includeDateCreated: true,
     },
   ] as const)
 
@@ -179,7 +180,7 @@ const addData = async (stores: Stores) => {
     { userId: 2, userGroupId: 2 },
     { userId: 3, userGroupId: 3 },
   ]
-  await Promise.all(createUserToUserGroupLinkOptions.map(stores['user.id <<-->> userGroup.id'].createlink))
+  await Promise.all(createUserToUserGroupLinkOptions.map(stores['user.id <<-->> userGroup.id'].create))
 }
 
 const getResult = (stores: Stores) => (

src/index.spec.ts

@@ -70,7 +70,7 @@ describe('createTsPgOrm', () => {
       })
 
       // -- Act
-      const joinTableRecord = await stores['user.id <<-->> userGroup.id'].createlink({ userGroupId: 2, userId: 3 })
+      const joinTableRecord = await stores['user.id <<-->> userGroup.id'].create({ userGroupId: 2, userId: 3 })
 
       // -- Assert
       expect(joinTableRecord).toEqual({
@@ -80,7 +80,7 @@ describe('createTsPgOrm', () => {
       })
 
       // -- Act
-      const deletedJoinTableRecord = await stores['user.id <<-->> userGroup.id'].deleteLinkById({ id: joinTableRecord.id, return: true })
+      const deletedJoinTableRecord = await stores['user.id <<-->> userGroup.id'].deleteById({ id: joinTableRecord.id, return: true })
 
       // -- Assert
       expect(deletedJoinTableRecord).toEqual({

src/relations/sql.ts

@@ -37,7 +37,7 @@ export const createManyToManyJoinTableSql = (r: RelationDeclaration<DataFormatDe
     id serial primary key,
     ${columnName1} integer not null,
     ${columnName2} integer not null,
-    ${(r.includeDateCreated ?? false) ? 'date_created not null default CURRENT_TIMESTAMP,' : ''}
+    ${(r.includeDateCreated ?? false) ? 'date_created timestamp with time zone not null default CURRENT_TIMESTAMP,' : ''}
     constraint ${fkeyName1} foreign key (${columnName1})
         references public.${tableName1} (${fieldName1}) match simple
         ${(r.fieldRef1OnUpdateNoAction ?? true) ? 'on update no action' : ''}

src/store/joinTable/index.spec.ts

@@ -4,7 +4,7 @@ import { createMockDbService } from '../../mock/dbService'
 import { tsPgOrm } from '../../testData'
 
 describe('joinTable', () => {
-  describe('createLink', () => {
+  describe('create', () => {
     test('basic test', async () => {
       const db = createMockDbService()
       const manyToManyRelationsList = filterForManyToManyRelations(tsPgOrm.relations)
@@ -19,7 +19,7 @@ describe('joinTable', () => {
         user_group_id: 3,
       })
 
-      const newJoinTableRecord = await joinStoresDict['user.id <<-->> userGroup.id'].createlink({ userId: 2, userGroupId: 3 })
+      const newJoinTableRecord = await joinStoresDict['user.id <<-->> userGroup.id'].create({ userId: 2, userGroupId: 3 })
 
       expect(newJoinTableRecord).toEqual({
         id: 1,
@@ -37,7 +37,7 @@ values ($1, $2) returning *`,
     })
   })
 
-  describe('createLinks', () => {
+  describe('createMultiple', () => {
     test('basic test', async () => {
       const db = createMockDbService()
       const manyToManyRelationsList = filterForManyToManyRelations(tsPgOrm.relations)
@@ -48,7 +48,7 @@ values ($1, $2) returning *`,
 
       db.queueResponse(true)
 
-      await joinStoresDict['user.id <<-->> userGroup.id'].createLinks([
+      await joinStoresDict['user.id <<-->> userGroup.id'].createMultiple([
         { userId: 2, userGroupId: 3 },
         { userId: 3, userGroupId: 4 },
         { userId: 4, userGroupId: 5 },
@@ -70,7 +70,7 @@ values ($5, $6) returning *`,
     })
   })
 
-  describe('deleteLinkById', () => {
+  describe('deleteById', () => {
     test('basic test', async () => {
       const db = createMockDbService()
       const manyToManyRelationsList = filterForManyToManyRelations(tsPgOrm.relations)
@@ -85,7 +85,7 @@ values ($5, $6) returning *`,
         user_group_id: 3,
       })
 
-      const newJoinTableRecord = await joinStoresDict['user.id <<-->> userGroup.id'].deleteLinkById({ id: 2, return: true })
+      const newJoinTableRecord = await joinStoresDict['user.id <<-->> userGroup.id'].deleteById({ id: 2, return: true })
 
       expect(newJoinTableRecord).toEqual({
         id: 1,

src/store/joinTable/index.ts

@@ -102,9 +102,9 @@ const createJoinTableStore = <T extends DataFormatDeclarations>(
   return {
     provision: () => db.query(relation.sql.createJoinTableSql).then(() => true as any),
     unprovision: () => db.query(relation.sql.dropJoinTableSql).then(() => true as any),
-    createlink: options => createLink(options as any),
-    createLinks: options => createLinks(options as any),
-    deleteLinkById: options => deleteLink(options),
+    create: options => createLink(options as any) as any,
+    createMultiple: options => createLinks(options as any),
+    deleteById: options => deleteLink(options) as any,
   }
 }
 

src/store/joinTable/types.ts

@@ -1,5 +1,5 @@
 import { DataFormatDeclarations, DataFormatFieldToRecordPropertyValue } from '../../dataFormat/types'
-import { OmitTyped } from '../../helpers/types'
+import { ExpandRecursively } from '../../helpers/types'
 import {
   ExtractRelationNamesOfManyToManyRelations,
   Relation,
@@ -9,7 +9,7 @@ import {
   RelationType,
 } from '../../relations/types'
 
-type JoinTableRecord<
+type JoinTableRecordLinkedFields<
   T extends DataFormatDeclarations,
   TFieldRef1DataFormat extends T[number],
   TFieldRef2DataFormat extends T[number],
@@ -19,15 +19,34 @@ type JoinTableRecord<
   [fieldRef1FieldName in `${TFieldRef1DataFormat['name']}${Capitalize<TFieldRef1Field['name']>}`]: DataFormatFieldToRecordPropertyValue<TFieldRef1Field>
 } & {
   [fieldRef2FieldName in `${TFieldRef2DataFormat['name']}${Capitalize<TFieldRef2Field['name']>}`]: DataFormatFieldToRecordPropertyValue<TFieldRef2Field>
-} & { id: number } // TODO: Do we need to make this configurable?
+}
+
+type JoinTableRecord<
+  T extends DataFormatDeclarations,
+  TFieldRef1DataFormat extends T[number],
+  TFieldRef2DataFormat extends T[number],
+  TFieldRef1Field extends T[number]['fields'][number],
+  TFieldRef2Field extends T[number]['fields'][number],
+  TRelation extends AnyManyToManyRelation<T> = AnyManyToManyRelation<T>
+> = ExpandRecursively<
+  JoinTableRecordLinkedFields<T, TFieldRef1DataFormat, TFieldRef2DataFormat, TFieldRef1Field, TFieldRef2Field>
+  & {
+    id: number // TODO: Do we need to make this configurable?
+  }
+  & (TRelation extends { includeDateCreated: boolean }
+    ? TRelation['includeDateCreated'] extends true
+      ? { dateCreated: string }
+      : {}
+    : {})
+>
 
 type CreateJoinTableRecordOptions<
   T extends DataFormatDeclarations,
   TFieldRef1DataFormat extends T[number],
   TFieldRef2DataFormat extends T[number],
   TFieldRef1Field extends T[number]['fields'][number],
   TFieldRef2Field extends T[number]['fields'][number],
-> = OmitTyped<JoinTableRecord<T, TFieldRef1DataFormat, TFieldRef2DataFormat, TFieldRef1Field, TFieldRef2Field>, 'id'>
+> = JoinTableRecordLinkedFields<T, TFieldRef1DataFormat, TFieldRef2DataFormat, TFieldRef1Field, TFieldRef2Field>
 
 export type _CreateJoinTableRecordOptions<
   T extends DataFormatDeclarations = DataFormatDeclarations,
@@ -39,14 +58,16 @@ export type _CreateJoinTableRecordOptions<
   Extract<Extract<T[number], { name: TRelation['fieldRef1']['formatName'] }>['fields'][number], { name: TRelation['fieldRef1']['fieldName'] }>,
   Extract<Extract<T[number], { name: TRelation['fieldRef2']['formatName'] }>['fields'][number], { name: TRelation['fieldRef2']['fieldName'] }>
 >
+
 type CreateLinkFunction<
   T extends DataFormatDeclarations,
   TFieldRef1DataFormat extends T[number],
   TFieldRef2DataFormat extends T[number],
   TFieldRef1Field extends T[number]['fields'][number],
   TFieldRef2Field extends T[number]['fields'][number],
+  TRelation extends AnyManyToManyRelation<T> = AnyManyToManyRelation<T>,
 > = (options: CreateJoinTableRecordOptions<T, TFieldRef1DataFormat, TFieldRef2DataFormat, TFieldRef1Field, TFieldRef2Field>) => (
-  Promise<JoinTableRecord<T, TFieldRef1DataFormat, TFieldRef2DataFormat, TFieldRef1Field, TFieldRef2Field>>
+  Promise<JoinTableRecord<T, TFieldRef1DataFormat, TFieldRef2DataFormat, TFieldRef1Field, TFieldRef2Field, TRelation>>
 )
 
 export type _CreateLinkFunction<
@@ -57,7 +78,8 @@ export type _CreateLinkFunction<
   Extract<T[number], { name: TRelation['fieldRef1']['formatName'] }>,
   Extract<T[number], { name: TRelation['fieldRef2']['formatName'] }>,
   Extract<Extract<T[number], { name: TRelation['fieldRef1']['formatName'] }>['fields'][number], { name: TRelation['fieldRef1']['fieldName'] }>,
-  Extract<Extract<T[number], { name: TRelation['fieldRef2']['formatName'] }>['fields'][number], { name: TRelation['fieldRef2']['fieldName'] }>
+  Extract<Extract<T[number], { name: TRelation['fieldRef2']['formatName'] }>['fields'][number], { name: TRelation['fieldRef2']['fieldName'] }>,
+  TRelation
 >
 
 type CreateLinksFunction<
@@ -92,10 +114,11 @@ type DeleteLinkByIdFunctionResult<
   TFieldRef2DataFormat extends T[number],
   TFieldRef1Field extends T[number]['fields'][number],
   TFieldRef2Field extends T[number]['fields'][number],
-  TOptions extends DeleteLinkByIdFunctionOptions
+  TOptions extends DeleteLinkByIdFunctionOptions,
+  TRelation extends AnyManyToManyRelation<T> = AnyManyToManyRelation<T>
 > = TOptions extends { return: boolean }
   ? TOptions['return'] extends true
-    ? JoinTableRecord<T, TFieldRef1DataFormat, TFieldRef2DataFormat, TFieldRef1Field, TFieldRef2Field> | null
+    ? JoinTableRecord<T, TFieldRef1DataFormat, TFieldRef2DataFormat, TFieldRef1Field, TFieldRef2Field, TRelation> | null
     : boolean
   : boolean
 
@@ -105,10 +128,11 @@ type DeleteLinkByIdFunction<
   TFieldRef2DataFormat extends T[number],
   TFieldRef1Field extends T[number]['fields'][number],
   TFieldRef2Field extends T[number]['fields'][number],
+  TRelation extends AnyManyToManyRelation<T> = AnyManyToManyRelation<T>
 > = <TOptions extends DeleteLinkByIdFunctionOptions = DeleteLinkByIdFunctionOptions>(
   options: TOptions
 ) => Promise<
-  DeleteLinkByIdFunctionResult<T, TFieldRef1DataFormat, TFieldRef2DataFormat, TFieldRef1Field, TFieldRef2Field, TOptions>
+  DeleteLinkByIdFunctionResult<T, TFieldRef1DataFormat, TFieldRef2DataFormat, TFieldRef1Field, TFieldRef2Field, TOptions, TRelation>
 >
 
 export type _DeleteLinkByIdFunction<
@@ -128,12 +152,13 @@ export type _JoinTableStore<
   TFieldRef2DataFormat extends T[number],
   TFieldRef1Field extends T[number]['fields'][number],
   TFieldRef2Field extends T[number]['fields'][number],
+  TRelation extends AnyManyToManyRelation<T> = AnyManyToManyRelation<T>,
 > = {
   provision: () => Promise<void>
   unprovision: () => Promise<void>
-  createlink: CreateLinkFunction<T, TFieldRef1DataFormat, TFieldRef2DataFormat, TFieldRef1Field, TFieldRef2Field>
-  createLinks: CreateLinksFunction<T, TFieldRef1DataFormat, TFieldRef2DataFormat, TFieldRef1Field, TFieldRef2Field>
-  deleteLinkById: DeleteLinkByIdFunction<T, TFieldRef1DataFormat, TFieldRef2DataFormat, TFieldRef1Field, TFieldRef2Field>
+  create: CreateLinkFunction<T, TFieldRef1DataFormat, TFieldRef2DataFormat, TFieldRef1Field, TFieldRef2Field, TRelation>
+  createMultiple: CreateLinksFunction<T, TFieldRef1DataFormat, TFieldRef2DataFormat, TFieldRef1Field, TFieldRef2Field>
+  deleteById: DeleteLinkByIdFunction<T, TFieldRef1DataFormat, TFieldRef2DataFormat, TFieldRef1Field, TFieldRef2Field, TRelation>
 }
 
 type AnyManyToManyRelation<T extends DataFormatDeclarations> =
@@ -147,7 +172,8 @@ export type JoinTableStore<
   Extract<T[number], { name: TRelation['fieldRef1']['formatName'] }>,
   Extract<T[number], { name: TRelation['fieldRef2']['formatName'] }>,
   Extract<Extract<T[number], { name: TRelation['fieldRef1']['formatName'] }>['fields'][number], { name: TRelation['fieldRef1']['fieldName'] }>,
-  Extract<Extract<T[number], { name: TRelation['fieldRef2']['formatName'] }>['fields'][number], { name: TRelation['fieldRef2']['fieldName'] }>
+  Extract<Extract<T[number], { name: TRelation['fieldRef2']['formatName'] }>['fields'][number], { name: TRelation['fieldRef2']['fieldName'] }>,
+  TRelation
 >
 
 export type JoinTableStoresDict<