@dynamatix/gb-schemas 2.17.12 → 2.19.1

package/dist/users/user.type.d.ts

@@ -0,0 +1,56 @@
+/// <reference path="../value-objects/pound.d.ts" />
+/// <reference path="../value-objects/account-number.d.ts" />
+/// <reference path="../value-objects/sort-code.d.ts" />
+/// <reference path="../shared/encryption/encrypted-field-map.d.ts" />
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import { Document, Types } from "mongoose";
+export interface IClaim {
+    key: string;
+    value: string;
+}
+export interface IUser extends Document {
+    accountId: number;
+    email: string;
+    fullName: string;
+    password: string;
+    organisationId?: any;
+    status: string;
+    groups: Types.ObjectId[];
+    claims: IClaim[];
+    externalData?: any;
+    modifiedOn?: string;
+    modifiedById?: string;
+    createdOnInApprivo?: string;
+    createdById?: string;
+    deletedOn?: string;
+    deletedById?: string;
+    token?: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export type UserDocument = IUser;
+//# sourceMappingURL=user.type.d.ts.map

package/dist/users/user.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.type.d.ts","sourceRoot":"","sources":["../../users/user.type.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAE3C,MAAM,WAAW,MAAM;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,KAAM,SAAQ,QAAQ;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC;IACzB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACnB;AAED,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC"}

package/dist/users/user.type.js

@@ -0,0 +1 @@
+export {};

package/dist/value-objects/account-number.d.ts

@@ -0,0 +1,43 @@
+/// <reference path="pound.d.ts" />
+/// <reference path="sort-code.d.ts" />
+/// <reference path="../shared/encryption/encrypted-field-map.d.ts" />
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import mongoose from 'mongoose';
+declare module 'mongoose' {
+    namespace Schema {
+        namespace Types {
+            class AccountNumber extends SchemaType {
+            }
+        }
+    }
+}
+declare class AccountNumber extends mongoose.SchemaType {
+    constructor(key: string, options: mongoose.AnyObject | undefined);
+    cast(val: any): any;
+}
+export { AccountNumber };
+//# sourceMappingURL=account-number.d.ts.map

package/dist/value-objects/account-number.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-number.d.ts","sourceRoot":"","sources":["../../value-objects/account-number.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAEhC,OAAO,QAAQ,UAAU,CAAC;IACtB,UAAU,MAAM,CAAC;QACb,UAAU,KAAK,CAAC;YACZ,MAAM,aAAc,SAAQ,UAAU;aAAI;SAC7C;KACJ;CACJ;AAED,cAAM,aAAc,SAAQ,QAAQ,CAAC,UAAU;gBAC/B,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,SAAS,GAAG,SAAS;IAIhE,IAAI,CAAC,GAAG,EAAE,GAAG;CAwBhB;AAKD,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist/value-objects/account-number.js

@@ -0,0 +1,24 @@
+import mongoose from 'mongoose';
+class AccountNumber extends mongoose.SchemaType {
+    constructor(key, options) {
+        super(key, options, 'AccountNumber');
+    }
+    cast(val) {
+        if (val == null) {
+            return val; // Allow null or undefined
+        }
+        let input = val;
+        // Convert number to string if input is a number
+        if (typeof val === 'number') {
+            input = val.toString(); // Convert to string without padding
+        }
+        if (typeof input !== 'string') {
+            throw new mongoose.Error.CastError('AccountNumber', val, this.path, new Error('AccountNumber must be a string or number'));
+        }
+        // Return the input as-is to preserve leading zeros
+        return input;
+    }
+}
+// Register the custom type globally with Mongoose
+mongoose.Schema.Types.AccountNumber = AccountNumber;
+export { AccountNumber };

package/dist/value-objects/pound.d.ts

@@ -0,0 +1,44 @@
+/// <reference path="account-number.d.ts" />
+/// <reference path="sort-code.d.ts" />
+/// <reference path="../shared/encryption/encrypted-field-map.d.ts" />
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import mongoose from 'mongoose';
+declare module 'mongoose' {
+    namespace Schema {
+        namespace Types {
+            class Pound extends SchemaType {
+            }
+        }
+    }
+}
+declare class Pound extends mongoose.SchemaType {
+    constructor(key: string, options: mongoose.AnyObject | undefined);
+    cast(val: any): any;
+}
+export declare function formatPound(val: any): string | null;
+export { Pound };
+//# sourceMappingURL=pound.d.ts.map

package/dist/value-objects/pound.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pound.d.ts","sourceRoot":"","sources":["../../value-objects/pound.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAGhC,OAAO,QAAQ,UAAU,CAAC;IACtB,UAAU,MAAM,CAAC;QACb,UAAU,KAAK,CAAC;YACZ,MAAM,KAAM,SAAQ,UAAU;aAAI;SACrC;KACJ;CACJ;AAED,cAAM,KAAM,SAAQ,QAAQ,CAAC,UAAU;gBACvB,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,SAAS,GAAG,SAAS;IAKhE,IAAI,CAAC,GAAG,EAAE,GAAG;CAkDhB;AAMD,wBAAgB,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,GAAG,IAAI,CAMnD;AAED,OAAO,EAAE,KAAK,EAAE,CAAC"}

package/dist/value-objects/pound.js

@@ -0,0 +1,50 @@
+// pound.ts
+import mongoose from 'mongoose';
+class Pound extends mongoose.SchemaType {
+    constructor(key, options) {
+        super(key, options, 'Pound');
+    }
+    // Casting method that validates and formats the value when saving
+    cast(val) {
+        if (val == null) {
+            return val; // Allow null or undefined values
+        }
+        // Handle empty string by treating it as 0
+        if (val === '') {
+            return 0.00;
+        }
+        // If it's already a number, validate and return
+        if (typeof val === 'number') {
+            if (isNaN(val)) {
+                throw new mongoose.Error.CastError('Pound', val, this.path, new Error(`${val} is not a valid currency value`));
+            }
+            return parseFloat(val.toFixed(2));
+        }
+        // If it's a string, try to parse it
+        if (typeof val === 'string') {
+            // Remove pound sign, commas, and spaces
+            const cleanedValue = val.replace(/[£,\s]/g, '');
+            // Check if the cleaned value is a valid number
+            const numValue = parseFloat(cleanedValue);
+            if (isNaN(numValue)) {
+                throw new mongoose.Error.CastError('Pound', val, this.path, new Error(`${val} is not a valid currency value`));
+            }
+            // Return as number with 2 decimal places
+            return parseFloat(numValue.toFixed(2));
+        }
+        throw new mongoose.Error.CastError('Pound', val, this.path, new Error('Pound value must be a string or number'));
+    }
+}
+// Register custom type
+mongoose.Schema.Types.Pound = Pound;
+// Common function to format value as UK pound string
+export function formatPound(val) {
+    return val;
+    if (val == null || val === '')
+        return '£0.00';
+    let num = typeof val === 'string' ? Number(val) : val;
+    if (typeof num !== 'number' || isNaN(num) || !isFinite(num))
+        return '£0.00';
+    return '£' + num.toLocaleString('en-GB', { minimumFractionDigits: 2, maximumFractionDigits: 2 });
+}
+export { Pound };

package/dist/value-objects/sort-code.d.ts

@@ -0,0 +1,43 @@
+/// <reference path="pound.d.ts" />
+/// <reference path="account-number.d.ts" />
+/// <reference path="../shared/encryption/encrypted-field-map.d.ts" />
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import mongoose from 'mongoose';
+declare module 'mongoose' {
+    namespace Schema {
+        namespace Types {
+            class SortCode extends SchemaType {
+            }
+        }
+    }
+}
+declare class SortCode extends mongoose.SchemaType {
+    constructor(key: string, options: mongoose.AnyObject | undefined);
+    cast(val: any): any;
+}
+export { SortCode };
+//# sourceMappingURL=sort-code.d.ts.map

package/dist/value-objects/sort-code.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-code.d.ts","sourceRoot":"","sources":["../../value-objects/sort-code.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAEhC,OAAO,QAAQ,UAAU,CAAC;IACtB,UAAU,MAAM,CAAC;QACb,UAAU,KAAK,CAAC;YACZ,MAAM,QAAS,SAAQ,UAAU;aAAI;SACxC;KACJ;CACJ;AAED,cAAM,QAAS,SAAQ,QAAQ,CAAC,UAAU;gBAC1B,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,SAAS,GAAG,SAAS;IAIhE,IAAI,CAAC,GAAG,EAAE,GAAG;CA0ChB;AAKD,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/dist/value-objects/sort-code.js

@@ -0,0 +1,34 @@
+import mongoose from 'mongoose';
+class SortCode extends mongoose.SchemaType {
+    constructor(key, options) {
+        super(key, options, 'SortCode');
+    }
+    cast(val) {
+        if (val == null) {
+            return val; // Allow null or undefined
+        }
+        let input = val;
+        // Convert number to string if input is a number
+        if (typeof val === 'number') {
+            input = val.toString();
+        }
+        if (typeof input !== 'string') {
+            throw new mongoose.Error.CastError('SortCode', val, this.path, new Error('SortCode must be a string or number'));
+        }
+        // Remove non-digit characters (e.g., hyphens in "01-00-00")
+        const cleaned = input.replace(/\D/g, '');
+        // Validate that the cleaned input is exactly 6 digits
+        if (cleaned.length !== 6) {
+            throw new mongoose.Error.CastError('SortCode', val, this.path, new Error(`${val} is not a valid UK sort code. Must contain exactly 6 digits.`));
+        }
+        // If the original input was a string, try to preserve its exact format
+        const digitMatch = input.replace(/\D/g, '');
+        if (digitMatch === cleaned && input.match(/^\d{6}$/)) {
+            return input; // Preserve exact input
+        }
+        return cleaned;
+    }
+}
+// Register the custom type globally with Mongoose
+mongoose.Schema.Types.SortCode = SortCode;
+export { SortCode };

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@dynamatix/gb-schemas",
-  "version": "2.17.12",
+  "version": "2.19.1",
   "description": "All the schemas for gatehouse bank back-end .",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
   "scripts": {
     "build": "tsc",
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "vitest run",
     "test:workflow": "npm run build && node test-workflow.js",
     "test:workflow:env": "npm run build && WORKFLOW_API_KEY=test-key WORKFLOW_API_URL=http://localhost:3000/api/workflows node test-workflow-with-env.js",
     "example:app": "npm run build && node example-app-usage.js",
@@ -39,6 +39,7 @@
     "@dynamatix/cat-shared": "^0.0.169",
     "dotenv": "^16.4.5",
     "mongodb": "^6.14.2",
+    "mongodb-client-encryption": "^6.5.0",
     "mongoose": "^8.9.5"
   },
   "files": [
@@ -81,7 +82,9 @@
   "devDependencies": {
     "@types/mongoose": "^5.11.96",
     "@types/node": "^22.14.0",
+    "mongodb-memory-server": "^11.2.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "vitest": "^4.1.10"
   }
 }