Story - 5.1 (#20)

* initial commit

* INcremental improvement in createRelation() code. Early support for circular relations

* fix remote ts issue

* fix store unprovisioning

* public api

* type fixes, simplifications, etc.

* provide default for version

* ts-config dist improvements

* set to beta package json

* tsconfig fix attempt 1

* update

* find the needle in the haystack

* sort out all ts configs. Tidy up,

* add in jsx-a11y again

* version to 5.1.0, non-beta.

Author: samhuk

.eslintrc.json

@@ -40,7 +40,7 @@
   "settings": {
     "import/resolver": {
       "node": {
-        "extensions": [".ts", ".tsx", ".js"]
+        "extensions": [".ts", ".js"]
       }
     }
   },

.github/workflows/ci.yaml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x]
+        node-version: [14.x, 16.x, 18.x]
     steps:
     - uses: actions/checkout@v3
     - name: Use Node.js ${{ matrix.node-version }}

.gitignore

@@ -2,6 +2,7 @@
 /build
 /dist
 /build-test
+/build-ts
 /build-integration-test
 .DS_Store
 /debug.log

README.md

@@ -39,9 +39,10 @@ Start by viewing the [Getting Started](https://github.com/samhuk/ts-pg-orm/wiki/
 Define data formats, relations, and database connectivity to create type-safe auto-completing data stores:
 
 ```typescript
+import { createDataFormat, createTsPgOrm, ... } from 'ts-pg-orm'
 const userDF = createDataFormat(...)
-const orm = createTsPgOrm([userDF, ...] as const).setRelations([...] as const)
-await orm.initDbClient({ host: 'localhost', port: 5432, ... })
+const ORM = createTsPgOrm([userDF, ...] as const).setRelations([...] as const)
+const orm = await ORM.initDbClient({ host: 'localhost', port: 5432, ... })
 await orm.provisionStores()
 ```
 
@@ -57,6 +58,7 @@ const userFound = await orm.stores.user.get({
   relations: { // Recursively include related data
     userGroups: {
       query: { ... },
+      relations: { ... }
     },
   },
 })
@@ -91,8 +93,8 @@ export type UserGroupRecord = ToRecord<typeof USER_GROUP_DFD>
 Use type-enforced sql information to create bespoke SQL statements:
 
 ```typescript
-const sql = orm.dataFormats.user.sql
-const customUserSql = `select ${sql.columnNames.name} from ${sql.tableName}`
+const userSql = ORM.dataFormats.user.sql
+const customUserSql = `select ${userSql.columnNames.name} from ${userSql.tableName}`
 ```
 
 ## Examples

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-pg-orm",
-  "version": "5.0.1",
+  "version": "5.1.0",
   "description": "Typescript PostgreSQL ORM",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -27,15 +27,14 @@
     "tests": "npm run clean-tests && npm run build-tests && npm run run-tests",
     "tests-ci": "npm run clean-tests && npm run build-tests && npm run run-tests-ci",
 
-    "lint": "eslint -c .eslintrc.json ./src --ext .ts,.tsx",
-    "lint-errors-only": "eslint -c .eslintrc.json ./src --ext .ts,.tsx --quiet",
+    "lint": "eslint -c .eslintrc.json ./src --ext .ts",
+    "lint-errors-only": "eslint -c .eslintrc.json ./src --ext .ts --quiet",
 
-    "clean": "rimraf ./dist",
-    "build-ts": "npm run clean && tsc -p ./tsconfig.dist.json",
+    "clean-ts-dist": "rimraf ./dist",
+    "build-ts-dist": "npm run clean-ts-dist && tsc -p ./tsconfig.dist.json",
 
-    "check": "npm rum lint-errors-only && npm run build-ts && npm run tests && echo Done!",
-
-    "start": "tsc -p ./src/tsconfig.json --watch",
+    "clean-ts": "rimraf ./build-ts",
+    "build-ts": "npm run clean-ts && tsc -p ./tsconfig.all.json",
 
     "clean-examples": "rimraf ./build-examples",
     "build-examples": "tsc -p ./tsconfig.examples.json",
@@ -44,7 +43,9 @@
     "article-api": "npm run clean-examples && npm run build-examples && npm run run-article-api",
     "real-db-test": "npm run clean-examples && npm run build-examples && npm run run-real-db-test",
 
-    "clean-all": "npm run clean-unit-tests && npm run clean-integration-tests && npm run clean && npm run clean-examples"
+    "clean": "npm run clean-unit-tests && npm run clean-integration-tests && npm run clean-ts && npm run clean-ts-dist && npm run clean-examples",
+
+    "check": "npm rum lint-errors-only && npm run build-ts && npm run tests && echo Done!"
   },
   "repository": "https://github.com/samhuk/ts-pg-orm",
   "author": "",
@@ -55,25 +56,25 @@
   "dependencies": {
     "@samhuk/data-filter": "^1.1.1",
     "@samhuk/data-query": "^1.2.1",
-    "simple-pg-client": "^1.0.5"
+    "simple-pg-client": "^1.1.0"
   },
   "devDependencies": {
-    "@types/jest": "^28.1.1",
-    "@types/node": "^17.0.19",
+    "@types/jest": "^29.1.2",
+    "@types/node": "^18.8.3",
     "@types/pg": "^8.6.5",
-    "@typescript-eslint/eslint-plugin": "^5.12.1",
-    "@typescript-eslint/parser": "^5.12.1",
-    "babel-jest": "^28.1.1",
-    "concurrently": "^7.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.40.0",
+    "@typescript-eslint/parser": "^5.40.0",
+    "babel-jest": "^29.1.2",
+    "concurrently": "^7.4.0",
     "env-cmd": "^10.1.0",
-    "eslint": "^8.9.0",
+    "eslint": "^8.25.0",
     "eslint-config-airbnb": "^19.0.4",
-    "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-jsx-a11y": "^6.5.1",
-    "eslint-plugin-react": "^7.30.1",
-    "jest": "^28.1.1",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jsx-a11y": "^6.6.1",
+    "eslint-plugin-react": "^7.31.9",
+    "jest": "^29.1.2",
     "rimraf": "^3.0.2",
-    "ts-jest": "^28.0.4",
-    "typescript": "^4.5.5"
+    "ts-jest": "^29.0.3",
+    "typescript": "^4.8.4"
   }
 }

src/dataFormat/field.ts

@@ -1,6 +1,12 @@
 import { camelCaseToSnakeCase, quote } from '../helpers/string'
 import { Field, FieldOptions, FieldsOptions } from './types/field'
 
+/**
+ * For creating a reusable group of fields that can be used across Data Formats.
+ *
+ * This is useful when multiple of your Data Formats share some common fields, like
+ * "dateCreated", "dataDeleted", "name", and so on.
+ */
 export const createCommonFields = <T extends FieldsOptions>(v: T): T => v
 
 export const createField = (fieldName: string, fieldOptions: FieldOptions): Field => {

src/dataFormat/index.ts

@@ -1,5 +1,6 @@
 import { mapDict, toDict } from '../helpers/dict'
 import { camelCaseToSnakeCase, capitalize, quote } from '../helpers/string'
+import { StringKeysOf } from '../helpers/types'
 import { NonManyToManyRelationList } from '../relations/types'
 import { filterForCreateRecordField } from './createRecord'
 import { createField } from './field'
@@ -18,7 +19,7 @@ export const createDataFormat = <
     fieldsOptions: TFieldsOptions,
     pluralizedName?: TPluralizedName,
     tableName?: string,
-  ): DataFormat<TName, TPluralizedName, TFieldsOptions, FieldSubSetsOptions<(keyof TFieldsOptions) & string>> => {
+  ): DataFormat<TName, TPluralizedName, TFieldsOptions, FieldSubSetsOptions<StringKeysOf<TFieldsOptions>>> => {
   const unquotedCols = mapDict(fieldsOptions, (f, fName) => f.columnName ?? camelCaseToSnakeCase(fName))
   const cols = mapDict(unquotedCols, unquotedColName => quote(unquotedColName))
   const unquotedTableName = tableName ?? camelCaseToSnakeCase(name)
@@ -36,10 +37,10 @@ export const createDataFormat = <
     capitalizedPluralizedName: capitalize(_pluralizedName) as any,
     fields: fields as any,
     fieldList: fieldList as any,
-    fieldNameList: Object.keys(fieldsOptions),
+    fieldNameList: Object.keys(fieldsOptions) as any,
     fieldSubSets: {}, // TODO later
     fieldRefs: fieldRefs as any,
-    createRecordFieldNameList: createRecordFields.map(f => f.name),
+    createRecordFieldNameList: createRecordFields.map(f => f.name) as any,
     sql: {
       cols: cols as any,
       unquotedCols: unquotedCols as any,
@@ -48,7 +49,7 @@ export const createDataFormat = <
       tableName: _tableName,
       unquotedTableName,
       createRecordCols: toDict(createRecordFields, item => ({ key: item.name, value: item.sql.columnName })) as any,
-      createRecordColumnNameList: createRecordFields.map(f => name),
+      createRecordColumnNameList: createRecordFields.map(f => f.sql.columnName),
       createTableSql: (relations: NonManyToManyRelationList) => createTableSql(_tableName, fieldList, relations),
       dropTableSql: `drop table if exists ${_tableName};`,
     },

src/dataFormat/sql.ts

@@ -175,14 +175,6 @@ const createColumnsSql = (
     .join(',\n  ')
 )
 
-const createForeignKeysSql = (
-  relations: Relation<RelationType.ONE_TO_MANY | RelationType.ONE_TO_ONE>[],
-): string => (
-  relations
-    .map(r => r.sql.foreignKeySql)
-    .join(',\n')
-)
-
 export const createTableSql = (
   quotedTableName: string,
   fieldList: FieldList,
@@ -191,11 +183,10 @@ export const createTableSql = (
   const oneToOneRelations = relations
     ?.filter(r => r.type === RelationType.ONE_TO_ONE) as Relation<RelationType.ONE_TO_ONE>[] ?? []
   const columnsSql = createColumnsSql(fieldList, oneToOneRelations)
-  const foreignKeysSql = relations != null ? createForeignKeysSql(relations) : ''
 
   return `create table if not exists public.${quotedTableName}
 (
-  ${[columnsSql, foreignKeysSql].filter(s => s != null && s.length > 0).join(',\n')}
+  ${columnsSql}
 )
 
 tablespace pg_default;

src/dataFormat/types/dataType.ts

@@ -51,6 +51,10 @@ export type DataTypeToSubType = {
   [DataType.JSON]: JsonSubType
 }
 
+export type AnySubType = StrSubType | NumSubType | EpochSubType | JsonSubType
+
+export type AnyDataType = DataType.STR | DataType.NUM | DataType.BOOL | DataType.EPOCH | DataType.JSON
+
 export enum ThreeStepNumberSize {
   SMALL,
   REGULAR,

src/dataFormat/types/field.ts

@@ -1,5 +1,6 @@
 import { TypeDependantBaseIntersection, ValuesUnionFromDict } from '../../helpers/types'
 import {
+  AnySubType,
   DataType,
   DataTypeToDefaultValueType,
   DataTypeToSubType,
@@ -20,7 +21,7 @@ type FieldToDefaultValueType<TField extends Field> = TField extends { type: Data
   : DataTypeToDefaultValueType[TField['type']]
 
 type DataTypeToOptions<
-  TSubType extends ValuesUnionFromDict<DataTypeToSubType> = ValuesUnionFromDict<DataTypeToSubType>
+  TSubType extends AnySubType = AnySubType
 > = {
   // -- Str
   [DataType.STR]: TypeDependantBaseIntersection<StrSubType, {
@@ -132,7 +133,7 @@ export type Fields<TFieldsOptions extends FieldsOptions = FieldsOptions> = {
       ? TFieldsOptions[TFieldName]['subType']
       : undefined,
     TFieldsOptions[TFieldName],
-    TFieldName & string
+    TFieldName
   >
 }