Close #70, timestamp columns for postgres

Author: Jeongho Nam

.npmignore

@@ -5,7 +5,6 @@ node_modules/
 src/
 lib/test/
 
-*.js.map
 *.*ignore
 package-lock.json
 tsconfig.api.json

package.json

@@ -1,7 +1,7 @@
 {
   "name": "safe-typeorm",
-  "version": "1.0.13",
-  "description": "Safe Relationship Decorators for the TypeORM",
+  "version": "1.0.14",
+  "description": "Make TypeORM much safer",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "scripts": {

src/decorators/CreateTimestampColumn.ts

@@ -0,0 +1,24 @@
+import { ColumnOptions, CreateDateColumn } from "typeorm";
+
+/**
+ * Creation timstamp column for `postgres`.
+ * 
+ * When defining datetime column, time zone is very important when considering global
+ * service. However, default `CreateDateColumn` of `typeorm` does not archive the time zone
+ * when using `postgres` database. Furthermore, `typeorm` does not archive milliseconds.
+ * 
+ * I think it's a critical mistake of `typeorm`, but they think it's not a bug but spec.
+ * 
+ * Therefore, `safe-typeorm` supports custom creation timestamp column which supports time
+ * zone and milliseconds. When using `postgres` database, use this `CreateTimestampColumn` 
+ * instead of the `CreateDateColumn`.
+ * 
+ * @param options Additional options if required
+ * @returns Property decorator function
+ */
+export const CreateTimestampColumn = (options?: ColumnOptions) =>
+    CreateDateColumn({
+        ...(options || {}),
+        precision: 3,
+        type: "timestamp with time zone",
+    });

src/decorators/DeleteTimestampColumn.ts

@@ -0,0 +1,24 @@
+import { ColumnOptions, DeleteDateColumn } from "typeorm";
+
+/**
+ * Deletion timstamp column for `postgres`.
+ * 
+ * When defining datetime column, time zone is very important when considering global
+ * service. However, default `DeleteDateColumn` of `typeorm` does not archive the time zone
+ * when using `postgres` database. Furthermore, `typeorm` does not archive milliseconds.
+ * 
+ * I think it's a critical mistake of `typeorm`, but they think it's not a bug but spec.
+ * 
+ * Therefore, `safe-typeorm` supports custom deletion timestamp column which supports time
+ * zone and milliseconds. When using `postgres` database, use this `DeleteTimestampColumn` 
+ * instead of the `DeleteDateColumn`.
+ * 
+ * @param options Additional options if required
+ * @returns Property decorator function
+ */
+export const DeleteTimestampColumn = (options?: ColumnOptions) =>
+    DeleteDateColumn({
+        ...(options || {}),
+        precision: 3,
+        type: "timestamp with time zone",
+    });

src/decorators/TimestampColumn.ts

@@ -0,0 +1,11 @@
+import { Column } from "typeorm";
+import { ColumnCommonOptions } from "typeorm/decorator/options/ColumnCommonOptions";
+import { ColumnNumericOptions } from "typeorm/decorator/options/ColumnNumericOptions";
+
+export const TimestampColumn = (
+    options?: ColumnCommonOptions & Omit<ColumnNumericOptions, "precision">,
+) =>
+    Column("timestamp with time zone", {
+        ...(options || {}),
+        precision: 3,
+    });

src/decorators/UpdateTimestampColumn.ts

@@ -0,0 +1,24 @@
+import { ColumnOptions, UpdateDateColumn } from "typeorm";
+
+/**
+ * Update timstamp column for `postgres`.
+ * 
+ * When defining datetime column, time zone is very important when considering global
+ * service. However, default `UpdateDateColumn` of `typeorm` does not archive the time zone
+ * when using `postgres` database. Furthermore, `typeorm` does not archive milliseconds.
+ * 
+ * I think it's a critical mistake of `typeorm`, but they think it's not a bug but spec.
+ * 
+ * Therefore, `safe-typeorm` supports custom update timestamp column which supports time
+ * zone and milliseconds. When using `postgres` database, use this `UpdateTimestampColumn` 
+ * instead of the `UpdateDateColumn`.
+ * 
+ * @param options Additional options if required
+ * @returns Property decorator function
+ */
+export const UpdateTimestampColumn = (options?: ColumnOptions) =>
+    UpdateDateColumn({
+        ...(options || {}),
+        precision: 3,
+        type: "timestamp with time zone",
+    });

src/decorators/index.ts

@@ -1,3 +1,8 @@
 export * from "./Belongs";
 export * from "./EncryptedColumn";
-export * from "./Has";
+export * from "./Has";
+
+export * from "./CreateTimestampColumn";
+export * from "./DeleteTimestampColumn";
+export * from "./TimestampColumn";
+export * from "./UpdateTimestampColumn";

tsconfig.json

@@ -11,7 +11,7 @@
     // "checkJs": true,                       /* Report errors in .js files. */
     // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
     "declaration": true,                   /* Generates corresponding '.d.ts' file. */
-    "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
     "sourceMap": true,                     /* Generates corresponding '.map' file. */
     // "outFile": "./",                       /* Concatenate and emit output to single file. */
     "outDir": "./lib",                        /* Redirect output structure to the directory. */