@aneuhold/core-ts-db-lib 1.0.8 → 1.0.10

package/lib/documents/common/ApiKey.d.ts

@@ -1,11 +1,15 @@
 import { ObjectId } from 'bson';
 import BaseDocument from '../BaseDocument';
-import BaseDocumentWithUserId from '../BaseDocumentWithUserId';
+import RequiredUserId from '../../schemas/required-refs/RequiredUserId';
+export declare const validateApiKey: (apiKey: ApiKey) => {
+    updatedDoc: ApiKey;
+    errors: string[];
+};
 /**
  * A document containing an API key for a particular user. This is stored
  * separately from the {@link User} document to enhance security a bit.
  */
-export default class ApiKey extends BaseDocument implements BaseDocumentWithUserId {
+export default class ApiKey extends BaseDocument implements RequiredUserId {
     /**
      * The API key for the user. This is indexed in the DB.
      */

package/lib/documents/common/ApiKey.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiKey.d.ts","sourceRoot":"","sources":["../../../src/documents/common/ApiKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAEhC,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAC3C,OAAO,sBAAsB,MAAM,2BAA2B,CAAC;AAE/D;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,MACnB,SAAQ,YACR,YAAW,sBAAsB;IAEjC;;OAEG;IACH,GAAG,sDAAuB;IAE1B;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;gBACS,MAAM,EAAE,QAAQ;CAI7B"}
+{"version":3,"file":"ApiKey.d.ts","sourceRoot":"","sources":["../../../src/documents/common/ApiKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAEhC,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAC3C,OAAO,cAAc,MAAM,4CAA4C,CAAC;AAGxE,eAAO,MAAM,cAAc,WAAY,MAAM;;;CAQ5C,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,YAAa,YAAW,cAAc;IACxE;;OAEG;IACH,GAAG,sDAAuB;IAE1B;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;gBACS,MAAM,EAAE,QAAQ;CAI7B"}

package/lib/documents/common/ApiKey.js

@@ -3,8 +3,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateApiKey = void 0;
+const bson_1 = require("bson");
 const crypto_1 = __importDefault(require("crypto"));
 const BaseDocument_1 = __importDefault(require("../BaseDocument"));
+const ValidateUtil_1 = __importDefault(require("../../schemas/validators/ValidateUtil"));
+const validateApiKey = (apiKey) => {
+    const errors = [];
+    const exampleApiKey = new ApiKey(new bson_1.ObjectId());
+    const validate = new ValidateUtil_1.default(apiKey, errors);
+    validate.string('key', exampleApiKey.key);
+    return { updatedDoc: apiKey, errors };
+};
+exports.validateApiKey = validateApiKey;
 /**
  * A document containing an API key for a particular user. This is stored
  * separately from the {@link User} document to enhance security a bit.

package/lib/documents/common/User.d.ts

@@ -1,5 +1,7 @@
 import { ObjectId } from 'bson';
 import BaseDocument from '../BaseDocument';
+import { DocumentValidator } from '../../schemas/validators/DocumentValidator';
+export declare const validateUser: DocumentValidator<User>;
 /**
  * A standard user of all personal projects. This should be linked to from
  * other documents that need to reference a user, instead of cluttering the

package/lib/documents/common/User.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"User.d.ts","sourceRoot":"","sources":["../../../src/documents/common/User.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAE3C;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,YAAY;IAC5C,GAAG,WAAkB;IAErB,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE;QACJ,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAM;IAEP,aAAa;;MAEX;IAEF;;OAEG;gBACS,QAAQ,EAAE,MAAM;CAI7B"}
+{"version":3,"file":"User.d.ts","sourceRoot":"","sources":["../../../src/documents/common/User.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAG/E,eAAO,MAAM,YAAY,EAAE,iBAAiB,CAAC,IAAI,CAiBhD,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,YAAY;IAC5C,GAAG,WAAkB;IAErB,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE;QACJ,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAM;IAEP,aAAa;;MAEX;IAEF;;OAEG;gBACS,QAAQ,EAAE,MAAM;CAI7B"}

package/lib/documents/common/User.js

@@ -3,8 +3,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateUser = void 0;
 const bson_1 = require("bson");
 const BaseDocument_1 = __importDefault(require("../BaseDocument"));
+const ValidateUtil_1 = __importDefault(require("../../schemas/validators/ValidateUtil"));
+const validateUser = (user) => {
+    const errors = [];
+    const validate = new ValidateUtil_1.default(user, errors);
+    const exampleUser = new User('example');
+    validate.string('userName', 'UsernameUnknown');
+    validate.optionalString('password');
+    validate.optionalString('email');
+    validate.object('auth', exampleUser.auth);
+    validate.optionalString('auth.googleId');
+    validate.object('projectAccess', exampleUser.projectAccess);
+    validate.boolean('projectAccess.dashboard', exampleUser.projectAccess.dashboard);
+    return { updatedDoc: user, errors };
+};
+exports.validateUser = validateUser;
 /**
  * A standard user of all personal projects. This should be linked to from
  * other documents that need to reference a user, instead of cluttering the

package/lib/documents/dashboard/UserConfig.d.ts

@@ -1,7 +1,11 @@
 import { ObjectId } from 'bson';
 import BaseDocumentWithType from '../BaseDocumentWithType';
-import BaseDocumentWithUserId from '../BaseDocumentWithUserId';
-export default class DashboardUserConfig extends BaseDocumentWithType implements BaseDocumentWithUserId {
+import RequiredUserId from '../../schemas/required-refs/RequiredUserId';
+export declare const validateDashboardUserConfig: (config: DashboardUserConfig) => {
+    updatedDoc: DashboardUserConfig;
+    errors: string[];
+};
+export default class DashboardUserConfig extends BaseDocumentWithType implements RequiredUserId {
     static docType: string;
     docType: string;
     /**

package/lib/documents/dashboard/UserConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UserConfig.d.ts","sourceRoot":"","sources":["../../../src/documents/dashboard/UserConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,oBAAoB,MAAM,yBAAyB,CAAC;AAC3D,OAAO,sBAAsB,MAAM,2BAA2B,CAAC;AAE/D,MAAM,CAAC,OAAO,OAAO,mBACnB,SAAQ,oBACR,YAAW,sBAAsB;IAEjC,MAAM,CAAC,OAAO,SAAgB;IAE9B,OAAO,SAA+B;IAEtC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,aAAa,UAAS;gBAEV,OAAO,EAAE,QAAQ;CAI9B"}
+{"version":3,"file":"UserConfig.d.ts","sourceRoot":"","sources":["../../../src/documents/dashboard/UserConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,oBAAoB,MAAM,yBAAyB,CAAC;AAC3D,OAAO,cAAc,MAAM,4CAA4C,CAAC;AAGxE,eAAO,MAAM,2BAA2B,WAAY,mBAAmB;;;CAQtE,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,mBACnB,SAAQ,oBACR,YAAW,cAAc;IAEzB,MAAM,CAAC,OAAO,SAAgB;IAE9B,OAAO,SAA+B;IAEtC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;IACH,aAAa,UAAS;gBAEV,OAAO,EAAE,QAAQ;CAI9B"}

package/lib/documents/dashboard/UserConfig.js

@@ -3,7 +3,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateDashboardUserConfig = void 0;
+const bson_1 = require("bson");
 const BaseDocumentWithType_1 = __importDefault(require("../BaseDocumentWithType"));
+const ValidateUtil_1 = __importDefault(require("../../schemas/validators/ValidateUtil"));
+const validateDashboardUserConfig = (config) => {
+    const errors = [];
+    const validate = new ValidateUtil_1.default(config, errors);
+    const exampleConfig = new DashboardUserConfig(new bson_1.ObjectId());
+    validate.boolean('enableDevMode', exampleConfig.enableDevMode);
+    return { updatedDoc: config, errors };
+};
+exports.validateDashboardUserConfig = validateDashboardUserConfig;
 class DashboardUserConfig extends BaseDocumentWithType_1.default {
     static docType = 'userConfig';
     docType = DashboardUserConfig.docType;

package/lib/index.d.ts

@@ -1,9 +1,9 @@
 import BaseDocument from './documents/BaseDocument';
 import BaseDocumentWithType from './documents/BaseDocumentWithType';
-import BaseDocumentWithUserId from './documents/BaseDocumentWithUserId';
 import ApiKey from './documents/common/ApiKey';
 import User from './documents/common/User';
 import DashboardUserConfig from './documents/dashboard/UserConfig';
-export { User, ApiKey, DashboardUserConfig, BaseDocument, BaseDocumentWithType, BaseDocumentWithUserId };
+import RequiredUserId from './schemas/required-refs/RequiredUserId';
+export { User, ApiKey, DashboardUserConfig, BaseDocument, BaseDocumentWithType, RequiredUserId };
 export type {};
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,sBAAsB,MAAM,oCAAoC,CAAC;AACxE,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAC/C,OAAO,IAAI,MAAM,yBAAyB,CAAC;AAC3C,OAAO,mBAAmB,MAAM,kCAAkC,CAAC;AAGnE,OAAO,EACL,IAAI,EACJ,MAAM,EACN,mBAAmB,EACnB,YAAY,EACZ,oBAAoB,EACpB,sBAAsB,EACvB,CAAC;AAGF,YAAY,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAC/C,OAAO,IAAI,MAAM,yBAAyB,CAAC;AAC3C,OAAO,mBAAmB,MAAM,kCAAkC,CAAC;AACnE,OAAO,cAAc,MAAM,wCAAwC,CAAC;AAGpE,OAAO,EACL,IAAI,EACJ,MAAM,EACN,mBAAmB,EACnB,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACf,CAAC;AAGF,YAAY,EAAE,CAAC"}

package/lib/index.js

@@ -3,16 +3,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseDocumentWithUserId = exports.BaseDocumentWithType = exports.BaseDocument = exports.DashboardUserConfig = exports.ApiKey = exports.User = void 0;
+exports.RequiredUserId = exports.BaseDocumentWithType = exports.BaseDocument = exports.DashboardUserConfig = exports.ApiKey = exports.User = void 0;
 const BaseDocument_1 = __importDefault(require("./documents/BaseDocument"));
 exports.BaseDocument = BaseDocument_1.default;
 const BaseDocumentWithType_1 = __importDefault(require("./documents/BaseDocumentWithType"));
 exports.BaseDocumentWithType = BaseDocumentWithType_1.default;
-const BaseDocumentWithUserId_1 = __importDefault(require("./documents/BaseDocumentWithUserId"));
-exports.BaseDocumentWithUserId = BaseDocumentWithUserId_1.default;
 const ApiKey_1 = __importDefault(require("./documents/common/ApiKey"));
 exports.ApiKey = ApiKey_1.default;
 const User_1 = __importDefault(require("./documents/common/User"));
 exports.User = User_1.default;
 const UserConfig_1 = __importDefault(require("./documents/dashboard/UserConfig"));
 exports.DashboardUserConfig = UserConfig_1.default;
+const RequiredUserId_1 = __importDefault(require("./schemas/required-refs/RequiredUserId"));
+exports.RequiredUserId = RequiredUserId_1.default;

package/lib/schemas/required-refs/RequiredUserId.d.ts

@@ -0,0 +1,9 @@
+import { ObjectId } from 'bson';
+import BaseDocument from '../../documents/BaseDocument';
+/**
+ * A document that has a `userId` that must be associated to be valid.
+ */
+export default abstract class RequiredUserId extends BaseDocument {
+    abstract userId: ObjectId;
+}
+//# sourceMappingURL=RequiredUserId.d.ts.map

package/lib/schemas/required-refs/RequiredUserId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequiredUserId.d.ts","sourceRoot":"","sources":["../../../src/schemas/required-refs/RequiredUserId.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,YAAY,MAAM,8BAA8B,CAAC;AAExD;;GAEG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,cAAe,SAAQ,YAAY;IAC/D,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;CAC3B"}

package/lib/schemas/required-refs/RequiredUserId.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseDocument_1 = __importDefault(require("../../documents/BaseDocument"));
+/**
+ * A document that has a `userId` that must be associated to be valid.
+ */
+class RequiredUserId extends BaseDocument_1.default {
+}
+exports.default = RequiredUserId;

package/lib/schemas/required_refs/RequiredUserId.d.ts

@@ -0,0 +1,9 @@
+import { ObjectId } from 'bson';
+import BaseDocument from '../../documents/BaseDocument';
+/**
+ * A document that has a `userId` that must be associated to be valid.
+ */
+export default abstract class RequiredUserId extends BaseDocument {
+    abstract userId: ObjectId;
+}
+//# sourceMappingURL=RequiredUserId.d.ts.map

package/lib/schemas/required_refs/RequiredUserId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequiredUserId.d.ts","sourceRoot":"","sources":["../../../src/schemas/required_refs/RequiredUserId.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,YAAY,MAAM,8BAA8B,CAAC;AAExD;;GAEG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,cAAe,SAAQ,YAAY;IAC/D,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;CAC3B"}

package/lib/schemas/required_refs/RequiredUserId.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const BaseDocument_1 = __importDefault(require("../../documents/BaseDocument"));
+/**
+ * A document that has a `userId` that must be associated to be valid.
+ */
+class RequiredUserId extends BaseDocument_1.default {
+}
+exports.default = RequiredUserId;

package/lib/schemas/type-guards/commonTypeGuards.d.ts

@@ -0,0 +1,6 @@
+export declare function isOptionalObject(value: unknown): value is undefined | object;
+export declare function isOptionalArray(value: unknown): value is undefined | Array<unknown>;
+export declare function isOptionalString(value: unknown): value is undefined | string;
+export declare function isOptionalNumber(value: unknown): value is undefined | number;
+export declare function isOptionalBoolean(value: unknown): value is undefined | boolean;
+//# sourceMappingURL=commonTypeGuards.d.ts.map

package/lib/schemas/type-guards/commonTypeGuards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commonTypeGuards.d.ts","sourceRoot":"","sources":["../../../src/schemas/type-guards/commonTypeGuards.ts"],"names":[],"mappings":"AAAA,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,GAAG,MAAM,CAE5E;AAED,wBAAgB,eAAe,CAC7B,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,CAErC;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,GAAG,MAAM,CAE5E;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,GAAG,MAAM,CAE5E;AAED,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,SAAS,GAAG,OAAO,CAE9B"}

package/lib/schemas/type-guards/commonTypeGuards.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isOptionalBoolean = exports.isOptionalNumber = exports.isOptionalString = exports.isOptionalArray = exports.isOptionalObject = void 0;
+function isOptionalObject(value) {
+    return value === undefined || typeof value === 'object';
+}
+exports.isOptionalObject = isOptionalObject;
+function isOptionalArray(value) {
+    return value === undefined || Array.isArray(value);
+}
+exports.isOptionalArray = isOptionalArray;
+function isOptionalString(value) {
+    return value === undefined || typeof value === 'string';
+}
+exports.isOptionalString = isOptionalString;
+function isOptionalNumber(value) {
+    return value === undefined || typeof value === 'number';
+}
+exports.isOptionalNumber = isOptionalNumber;
+function isOptionalBoolean(value) {
+    return value === undefined || typeof value === 'boolean';
+}
+exports.isOptionalBoolean = isOptionalBoolean;

package/lib/schemas/validators/DocumentValidator.d.ts

@@ -0,0 +1,6 @@
+import BaseDocument from '../../documents/BaseDocument';
+export type DocumentValidator<TDocType extends BaseDocument> = (doc: TDocType) => {
+    updatedDoc: TDocType;
+    errors: string[];
+};
+//# sourceMappingURL=DocumentValidator.d.ts.map

package/lib/schemas/validators/DocumentValidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocumentValidator.d.ts","sourceRoot":"","sources":["../../../src/schemas/validators/DocumentValidator.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,8BAA8B,CAAC;AAExD,MAAM,MAAM,iBAAiB,CAAC,QAAQ,SAAS,YAAY,IAAI,CAC7D,GAAG,EAAE,QAAQ,KACV;IAAE,UAAU,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC"}

package/lib/schemas/validators/DocumentValidator.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/schemas/validators/ValidateUtil.d.ts

@@ -0,0 +1,45 @@
+type IndexableObject = {
+    [keyName: string]: unknown;
+};
+/**
+ * All the validators in this class will modify the parent object to the
+ * default value if the field is not correct. If the field is optional, it
+ * will update the value to be undefined if it is not correct.
+ *
+ * This class can be used to validate nested objects by using a field path
+ * (e.g. 'projectAccess.dashboard'). If the field path is invalid, then
+ * this class will not report an error, because it is assumed that the
+ * parent of the field path will report the error.
+ *
+ * Document relations are not validated by this class. That is the job of the
+ * Document's repository.
+ */
+export default class Validate {
+    private errorsArray;
+    parentObject: IndexableObject;
+    constructor(parentObject: object, errorsArray: string[]);
+    optionalString(fieldName: string): void;
+    optionalNumber(fieldName: string): void;
+    optionalBoolean(fieldName: string): void;
+    optionalArray(fieldName: string): void;
+    string(fieldName: string, defaultValue: string): void;
+    object(fieldName: string, defaultValue: object): void;
+    number(fieldName: string, defaultValue: number): void;
+    boolean(fieldName: string, defaultValue: boolean): void;
+    /**
+     * Checks if the provided field path is valid. In other words, if the
+     * field path is of length 1, it always returns true. If the field path
+     * is any longer than 1, it will check to make sure the final field is
+     * defined in the parent object.
+     *
+     * The idea is that if the field path is invalid, then this class will
+     * not report an error, because it is assumed that the parent of the field
+     * path will report the error.
+     */
+    private fieldPathIsValid;
+    private updateField;
+    private getField;
+    private deleteField;
+}
+export {};
+//# sourceMappingURL=ValidateUtil.d.ts.map

package/lib/schemas/validators/ValidateUtil.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidateUtil.d.ts","sourceRoot":"","sources":["../../../src/schemas/validators/ValidateUtil.ts"],"names":[],"mappings":"AAOA,KAAK,eAAe,GAAG;IAAE,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAEtD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAKzB,OAAO,CAAC,WAAW;IAJrB,YAAY,EAAE,eAAe,CAAC;gBAG5B,YAAY,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EAAE;IAK/B,cAAc,CAAC,SAAS,EAAE,MAAM;IAUhC,cAAc,CAAC,SAAS,EAAE,MAAM;IAUhC,eAAe,CAAC,SAAS,EAAE,MAAM;IAUjC,aAAa,CAAC,SAAS,EAAE,MAAM;IAU/B,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAU9C,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAU9C,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAU9C,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO;IAUhD;;;;;;;;;OASG;IACH,OAAO,CAAC,gBAAgB;IAexB,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,QAAQ;IAShB,OAAO,CAAC,WAAW;CAWpB"}

package/lib/schemas/validators/ValidateUtil.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commonTypeGuards_1 = require("../type-guards/commonTypeGuards");
+/**
+ * All the validators in this class will modify the parent object to the
+ * default value if the field is not correct. If the field is optional, it
+ * will update the value to be undefined if it is not correct.
+ *
+ * This class can be used to validate nested objects by using a field path
+ * (e.g. 'projectAccess.dashboard'). If the field path is invalid, then
+ * this class will not report an error, because it is assumed that the
+ * parent of the field path will report the error.
+ *
+ * Document relations are not validated by this class. That is the job of the
+ * Document's repository.
+ */
+class Validate {
+    errorsArray;
+    parentObject;
+    constructor(parentObject, errorsArray) {
+        this.errorsArray = errorsArray;
+        this.parentObject = parentObject;
+    }
+    optionalString(fieldName) {
+        if (this.fieldPathIsValid(fieldName) &&
+            !(0, commonTypeGuards_1.isOptionalString)(this.getField(fieldName))) {
+            this.errorsArray.push(`${fieldName} must be a string or undefined`);
+            this.deleteField(fieldName);
+        }
+    }
+    optionalNumber(fieldName) {
+        if (this.fieldPathIsValid(fieldName) &&
+            !(0, commonTypeGuards_1.isOptionalNumber)(this.getField(fieldName))) {
+            this.errorsArray.push(`${fieldName} must be a number or undefined`);
+            this.deleteField(fieldName);
+        }
+    }
+    optionalBoolean(fieldName) {
+        if (this.fieldPathIsValid(fieldName) &&
+            !(0, commonTypeGuards_1.isOptionalBoolean)(this.getField(fieldName))) {
+            this.errorsArray.push(`${fieldName} must be a boolean or undefined`);
+            this.deleteField(fieldName);
+        }
+    }
+    optionalArray(fieldName) {
+        if (this.fieldPathIsValid(fieldName) &&
+            !(0, commonTypeGuards_1.isOptionalArray)(this.getField(fieldName))) {
+            this.errorsArray.push(`${fieldName} must be an array or undefined`);
+            this.deleteField(fieldName);
+        }
+    }
+    string(fieldName, defaultValue) {
+        if (this.fieldPathIsValid(fieldName) &&
+            typeof this.getField(fieldName) !== 'string') {
+            this.errorsArray.push(`${fieldName} must be a string`);
+            this.updateField(fieldName, defaultValue);
+        }
+    }
+    object(fieldName, defaultValue) {
+        if (this.fieldPathIsValid(fieldName) &&
+            typeof this.getField(fieldName) !== 'object') {
+            this.errorsArray.push(`${fieldName} must be an object`);
+            this.updateField(fieldName, defaultValue);
+        }
+    }
+    number(fieldName, defaultValue) {
+        if (this.fieldPathIsValid(fieldName) &&
+            typeof this.getField(fieldName) !== 'number') {
+            this.errorsArray.push(`${fieldName} must be a number`);
+            this.updateField(fieldName, defaultValue);
+        }
+    }
+    boolean(fieldName, defaultValue) {
+        if (this.fieldPathIsValid(fieldName) &&
+            typeof this.getField(fieldName) !== 'boolean') {
+            this.errorsArray.push(`${fieldName} must be a boolean`);
+            this.updateField(fieldName, defaultValue);
+        }
+    }
+    /**
+     * Checks if the provided field path is valid. In other words, if the
+     * field path is of length 1, it always returns true. If the field path
+     * is any longer than 1, it will check to make sure the final field is
+     * defined in the parent object.
+     *
+     * The idea is that if the field path is invalid, then this class will
+     * not report an error, because it is assumed that the parent of the field
+     * path will report the error.
+     */
+    fieldPathIsValid(fieldName) {
+        const fieldPath = fieldName.split('.');
+        if (fieldPath.length === 1) {
+            return true;
+        }
+        let currentObject = this.parentObject;
+        for (let i = 0; i < fieldPath.length - 1; i += 1) {
+            if (currentObject[fieldPath[i]] === undefined) {
+                return false;
+            }
+            currentObject = currentObject[fieldPath[i]];
+        }
+        return true;
+    }
+    updateField(fieldName, defaultValue) {
+        const fieldPath = fieldName.split('.');
+        let currentObject = this.parentObject;
+        fieldPath.forEach((field, index) => {
+            if (index === fieldPath.length - 1) {
+                currentObject[field] = defaultValue;
+            }
+            else {
+                currentObject = currentObject[field];
+            }
+        });
+    }
+    getField(fieldName) {
+        const fieldPath = fieldName.split('.');
+        let currentObject = this.parentObject;
+        fieldPath.forEach((field) => {
+            currentObject = currentObject[field];
+        });
+        return currentObject;
+    }
+    deleteField(fieldName) {
+        const fieldPath = fieldName.split('.');
+        let currentObject = this.parentObject;
+        fieldPath.forEach((field, index) => {
+            if (index === fieldPath.length - 1) {
+                delete currentObject[field];
+            }
+            else {
+                currentObject = currentObject[field];
+            }
+        });
+    }
+}
+exports.default = Validate;

package/lib/schemas/validators/ValidateUtil.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ValidateUtil.spec.d.ts.map

package/lib/schemas/validators/ValidateUtil.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidateUtil.spec.d.ts","sourceRoot":"","sources":["../../../src/schemas/validators/ValidateUtil.spec.ts"],"names":[],"mappings":""}

package/lib/schemas/validators/ValidateUtil.spec.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ValidateUtil_1 = __importDefault(require("./ValidateUtil"));
+describe('Validate', () => {
+    let errorsArray;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    let parentObject;
+    beforeEach(() => {
+        errorsArray = [];
+        parentObject = {};
+    });
+    it('should validate optional string', () => {
+        const validate = new ValidateUtil_1.default(parentObject, errorsArray);
+        parentObject.testField = 123;
+        validate.optionalString('testField');
+        expect(errorsArray).toContain('testField must be a string or undefined');
+        errorsArray = [];
+        parentObject.testField = 'test';
+        validate.optionalString('testField');
+        expect(errorsArray.length).toBe(0);
+    });
+    it('should validate optional number', () => {
+        const validate = new ValidateUtil_1.default(parentObject, errorsArray);
+        parentObject.testField = true;
+        validate.optionalNumber('testField');
+        expect(errorsArray).toContain('testField must be a number or undefined');
+        errorsArray = [];
+        parentObject.testField = 123;
+        validate.optionalNumber('testField');
+        expect(errorsArray.length).toBe(0);
+    });
+    it('should validate optional boolean', () => {
+        const validate = new ValidateUtil_1.default(parentObject, errorsArray);
+        parentObject.testField = 123;
+        validate.optionalBoolean('testField');
+        expect(errorsArray).toContain('testField must be a boolean or undefined');
+        errorsArray = [];
+        parentObject.testField = true;
+        validate.optionalBoolean('testField');
+        expect(errorsArray.length).toBe(0);
+    });
+    it('should validate optional array', () => {
+        const validate = new ValidateUtil_1.default(parentObject, errorsArray);
+        parentObject.testField = 123;
+        validate.optionalArray('testField');
+        expect(errorsArray).toContain('testField must be an array or undefined');
+        errorsArray = [];
+        parentObject.testField = [];
+        validate.optionalArray('testField');
+        expect(errorsArray.length).toBe(0);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aneuhold/core-ts-db-lib",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "A core database library used for personal projects",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",