Merge pull request #130 from brandongregoryscott/feature/default-values-factory

Immutable record default values utilities

Author: brandongregoryscott

package-lock.json

@@ -12,17 +12,17 @@
     },
     "description": "Common patterns, functions, etc... used when building react applications",
     "devDependencies": {
-        "@types/faker": "4.1.12",
+        "@types/faker": "5.5.6",
         "@types/humanize-plus": "1.8.0",
         "@types/jest": "25.1.5",
         "@types/lodash": "4.14.108",
         "@types/node": "13.11.0",
-        "@types/rosie": "0.0.37",
-        "andculturecode-javascript-testing": "0.0.1",
+        "@types/rosie": "0.0.39",
+        "andculturecode-javascript-testing": "0.2.1",
         "axios": "0.21.1",
         "cross-env": "6.0.3",
         "cypress": "3.8.3",
-        "faker": "4.1.0",
+        "faker": "5.5.3",
         "humanize-plus": "1.8.2",
         "i18next": "19.4.5",
         "i18next-browser-languagedetector": "6.0.1",
@@ -32,7 +32,7 @@
         "lodash": "4.17.21",
         "prettier": "1.19.1",
         "rimraf": "2.6.2",
-        "rosie": "2.0.1",
+        "rosie": "2.1.0",
         "ts-jest": "25.5.1",
         "ts-loader": "8.0.4",
         "tslint": "6.1.2",
@@ -72,7 +72,7 @@
         "url": "git+https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core.git"
     },
     "scripts": {
-        "build": "tsc --pretty && webpack && npm run validate-peer-dependencies",
+        "build": "tsc --pretty --project tsconfig.dist.json && webpack && npm run validate-peer-dependencies",
         "clean": "rimraf dist && rimraf coverage",
         "configure:git": "echo Ensuring git hooksPath is set to .githooks directory && git config core.hooksPath .githooks && chmod +x .githooks/*",
         "coverage": "jest ./src --coverage",

package.json

@@ -0,0 +1,25 @@
+import { Auditable } from "../interfaces/auditable";
+
+// -----------------------------------------------------------------------------------------
+// #region Constants
+// -----------------------------------------------------------------------------------------
+
+const AuditableDefaultValues: Auditable = {
+    createdById: undefined,
+    createdOn: undefined,
+    deletedById: undefined,
+    deletedOn: undefined,
+    id: undefined,
+    updatedById: undefined,
+    updatedOn: undefined,
+};
+
+// #endregion Constants
+
+// -----------------------------------------------------------------------------------------
+// #region Exports
+// -----------------------------------------------------------------------------------------
+
+export { AuditableDefaultValues };
+
+// #endregion Exports

src/constants/auditable-default-values.ts

@@ -2,6 +2,7 @@
 // #region Constants
 // -----------------------------------------------------------------------------------------
 
+export { AuditableDefaultValues } from "./constants/auditable-default-values";
 export { EmailConstants } from "./constants/email-constants";
 export { Rfc4646LanguageCodes } from "./constants/rfc4646-language-codes";
 export { VideoResolutions } from "./constants/video-resolutions";
@@ -63,7 +64,10 @@ export { CancellablePromise } from "./types/cancellable-promise";
 export { CatchResultHandler } from "./types/catch-result-handler";
 export { Constructor } from "./types/constructor";
 export { FinallyHandler } from "./types/finally-handler";
+export { OmitKeys } from "./types/omit-keys";
 export { SyncWorkload } from "./types/sync-workload";
+export { RequiredOr } from "./types/required-or";
+export { RequiredOrUndefined } from "./types/required-or-undefined";
 export { TimerFunctionReturn } from "./types/timer-function-return";
 
 // #endregion Types

src/index.ts

@@ -1,4 +1,6 @@
-export { AxiosResponseFactory } from "andculturecode-javascript-testing";
+export {
+    AxiosResponseFactory,
+    StubResourceRecordFactory,
+} from "andculturecode-javascript-testing";
 export * from "./result-error-record-factory";
 export * from "./result-record-factory";
-export * from "./stub-resource-record-factory";

src/tests/factories/index.ts

@@ -1,18 +1,18 @@
 // -----------------------------------------------------------------------------------------
-// #region Interfaces
+// #region Types
 // -----------------------------------------------------------------------------------------
 
-interface StubResource {
-    id: number;
-    name?: string;
-}
+/**
+ * Omit all keys from `TSource` that intersect with `TExclusion`
+ */
+type OmitKeys<TSource, TExclusion> = Omit<TSource, keyof TExclusion>;
 
-// #endregion Interfaces
+// #endregion Types
 
 // -----------------------------------------------------------------------------------------
-// #region Export
+// #region Exports
 // -----------------------------------------------------------------------------------------
 
-export { StubResource };
+export { OmitKeys };
 
-// #endregion Export
+// #endregion Exports

src/tests/factories/stub-resource-record-factory.ts

@@ -0,0 +1,20 @@
+import { RequiredOr } from "./required-or";
+
+// -----------------------------------------------------------------------------------------
+// #region Types
+// -----------------------------------------------------------------------------------------
+
+/**
+ * Mark all properties of `T` as required or explicitly set as undefined
+ */
+type RequiredOrUndefined<T> = RequiredOr<T, undefined>;
+
+// #endregion Types
+
+// -----------------------------------------------------------------------------------------
+// #region Exports
+// -----------------------------------------------------------------------------------------
+
+export { RequiredOrUndefined };
+
+// #endregion Exports

src/tests/stubs/stub-resource-record.ts

@@ -0,0 +1,20 @@
+// -----------------------------------------------------------------------------------------
+// #region Types
+// -----------------------------------------------------------------------------------------
+
+/**
+ * Mark all properties of `T` as required from the original type _or_ another type
+ */
+type RequiredOr<T, TOrType> = {
+    [Property in keyof Required<T>]: T[Property] | TOrType;
+};
+
+// #endregion Types
+
+// -----------------------------------------------------------------------------------------
+// #region Exports
+// -----------------------------------------------------------------------------------------
+
+export { RequiredOr };
+
+// #endregion Exports