@temboplus/afloat 0.1.60 → 0.1.62

package/script/npm/src/src/models/contact/derivatives/contact_info.js

@@ -1,260 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BankContactInfo = exports.MobileContactInfo = void 0;
-const frontend_core_1 = require("@temboplus/frontend-core");
-const validation_js_1 = require("../validation.js");
-/**
- * Abstract base class that provides a common interface for different types of contact information.
- * This class defines the structure and validation requirements for both mobile and bank contacts.
- *
- * @abstract
- * @class BaseContactInfo
- * @property {ContactType} type - The type of contact (either "Mobile" or "Bank")
- */
-class BaseContactInfo {
-    /**
-     * Creates a new instance of BaseContactInfo
-     * @param {ContactType} type - The type of contact to create
-     */
-    constructor(type) {
-        Object.defineProperty(this, "type", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.type = type;
-    }
-}
-/**
- * Implementation of BaseContactInfo for mobile phone contacts.
- * Handles storage and validation of contact details specific to mobile numbers.
- *
- * @extends BaseContactInfo
- * @class MobileContactInfo
- * @property {string} name - The contact's personal name
- * @property {TZPhoneNumber} phoneNumber - The contact's phone number object
- */
-class MobileContactInfo extends BaseContactInfo {
-    /**
-     * Creates a new mobile contact
-     * @param {string} name - The contact's personal name
-     * @param {TZPhoneNumber} phoneNumber - The contact's phone number
-     */
-    constructor(name, phoneNumber) {
-        super("Mobile");
-        Object.defineProperty(this, "name", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: name
-        });
-        Object.defineProperty(this, "phoneNumber", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: phoneNumber
-        });
-    }
-    /**
-     * Validates the mobile contact information
-     * Checks that:
-     * - Phone number is defined and valid
-     * - Contact name is not empty
-     * @returns {boolean} True if all validation checks pass
-     */
-    validate() {
-        return this.phoneNumber !== undefined &&
-            frontend_core_1.TZPhoneNumber.canConstruct(this.phoneNumber.compactNumber) &&
-            this.name.length > 0;
-    }
-    /**
-     * Validates if an unknown value is a valid MobileContactInfo object.
-     * Checks both the structural integrity and data validity of name and phone number properties.
-     *
-     * @param {unknown} obj - The value to validate
-     * @returns {obj is MobileContactInfo} Type predicate indicating if the value is a valid MobileContactInfo
-     *
-     * @example
-     * const maybeContact = JSON.parse(someData);
-     * if (MobileContactInfo.is(maybeContact)) {
-     *   // maybeContact is typed as MobileContactInfo
-     *   console.log(maybeContact.name);
-     *   console.log(maybeContact.TZPhoneNumber.label);
-     * }
-     *
-     * @remarks
-     * - Name must be a non-empty string
-     * - Phone number can be either:
-     *   - A string that can be parsed into a valid TZPhoneNumber
-     *   - A TZPhoneNumber object with valid properties
-     * - Returns false if either property is invalid or missing
-     */
-    static is(obj) {
-        if (!obj || typeof obj !== "object")
-            return false;
-        const mobileContactInfo = obj;
-        // checks if name exists and is a string
-        if (typeof mobileContactInfo.name !== "string")
-            return false;
-        const name = mobileContactInfo.name;
-        // checks if TZPhoneNumber exists and is valid
-        let phone_number = undefined;
-        if (typeof mobileContactInfo.phoneNumber === "string") {
-            phone_number = frontend_core_1.TZPhoneNumber.from(mobileContactInfo.phoneNumber);
-        }
-        if (typeof mobileContactInfo.phoneNumber === "object") {
-            const obj = mobileContactInfo.phoneNumber;
-            const isValidPhone = frontend_core_1.TZPhoneNumber.is(obj);
-            if (isValidPhone) {
-                phone_number = obj;
-            }
-        }
-        const validName = name.trim().length > 0;
-        const validPhone = phone_number !== undefined;
-        return validName && validPhone;
-    }
-    get displayName() {
-        return this.name;
-    }
-    /**
-     * Gets the phone number formatted according to the 255 standard
-     * @returns {string} Formatted phone number
-     */
-    get accNumber() {
-        return this.phoneNumber.getWithFormat(frontend_core_1.PhoneNumberFormat.INTERNATIONAL);
-    }
-    get channel() {
-        return this.phoneNumber.networkOperator.mobileMoneyService;
-    }
-    get displayNameLabel() {
-        return "Name";
-    }
-    get accNumberLabel() {
-        return "Phone Number";
-    }
-    get channelLabel() {
-        return "Channel";
-    }
-}
-exports.MobileContactInfo = MobileContactInfo;
-/**
- * Implementation of BaseContactInfo for bank account contacts.
- * Handles storage and validation of contact details specific to bank accounts.
- *
- * @extends BaseContactInfo
- * @class BankContactInfo
- * @property {string} accName - The bank account holder's name
- * @property {Bank} bank - The bank object containing institution details
- * @property {string} accNo - The bank account number
- */
-class BankContactInfo extends BaseContactInfo {
-    /**
-     * Creates a new bank contact
-     * @param {string} accName - The account holder's name
-     * @param {Bank} bank - The bank object
-     * @param {string} accNo - The account number
-     */
-    constructor(accName, bank, accNo) {
-        super("Bank");
-        Object.defineProperty(this, "accName", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: accName
-        });
-        Object.defineProperty(this, "bank", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: bank
-        });
-        Object.defineProperty(this, "accNo", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: accNo
-        });
-    }
-    /**
-     * Validates the bank contact information
-     * Checks that:
-     * - Bank object is valid
-     * - Account name meets requirements
-     * - Account number meets bank-specific format requirements
-     * @returns {boolean} True if all validation checks pass
-     */
-    validate() {
-        return this.bank.validate() &&
-            (0, validation_js_1.validateAccName)(this.accName) &&
-            (0, validation_js_1.validateBankAccNo)(this.accNumber);
-    }
-    /**
-     * Validates if an unknown value is a valid BankContactInfo object.
-     * Checks both the structural integrity and data validity of account name, account number, and bank details.
-     *
-     * @param {unknown} obj - The value to validate
-     * @returns {obj is BankContactInfo} Type predicate indicating if the value is a valid BankContactInfo
-     *
-     * @example
-     * const maybeBank = JSON.parse(someData);
-     * if (BankContactInfo.is(maybeBank)) {
-     *   // maybeBank is typed as BankContactInfo
-     *   console.log(maybeBank.accName);
-     *   console.log(maybeBank.accNumber);
-     *   console.log(maybeBank.bank.name);
-     * }
-     *
-     * @remarks
-     * - Account name must be a valid string (validated by {@link validateAccName})
-     * - Account number must be a valid string (validated by {@link validateBankAccNo})
-     * - Bank must be a valid Bank object (validated by {@link Bank.is})
-     * - Returns false if any property is invalid or missing
-     * - All properties are required and must pass their respective validations
-     */
-    static is(obj) {
-        if (!obj || typeof obj !== "object")
-            return false;
-        const bankContactInfo = obj;
-        // checks if acc. name exists and is a string
-        if (typeof bankContactInfo.accName !== "string")
-            return false;
-        const accName = bankContactInfo.accName;
-        // checks if acc. no. exists and is a string
-        if (typeof bankContactInfo.accNumber !== "string")
-            return false;
-        const accNumber = bankContactInfo.accNumber;
-        // checks if TZPhoneNumber exists and is valid
-        let bank = undefined;
-        if (typeof bankContactInfo.bank === "object") {
-            const obj = bankContactInfo.bank;
-            const isValidBank = frontend_core_1.Bank.is(obj);
-            if (isValidBank) {
-                bank = obj;
-            }
-        }
-        const validAccName = (0, validation_js_1.validateAccName)(accName);
-        const validAccNumber = (0, validation_js_1.validateBankAccNo)(accNumber);
-        const validBank = bank !== undefined;
-        return validAccName && validAccNumber && validBank;
-    }
-    get displayName() {
-        return this.accName;
-    }
-    get accNumber() {
-        return this.accNo;
-    }
-    get channel() {
-        return this.bank.shortName;
-    }
-    get displayNameLabel() {
-        return "Acc. Name";
-    }
-    get accNumberLabel() {
-        return "Bank Acc. No.";
-    }
-    get channelLabel() {
-        return "Bank";
-    }
-}
-exports.BankContactInfo = BankContactInfo;

package/script/npm/src/src/models/contact/derivatives/contact_info.test.d.ts

@@ -1 +0,0 @@
-//# sourceMappingURL=contact_info.test.d.ts.map

package/script/npm/src/src/models/contact/derivatives/contact_info.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"contact_info.test.d.ts","sourceRoot":"","sources":["../../../../../../../src/src/models/contact/derivatives/contact_info.test.ts"],"names":[],"mappings":""}

package/script/npm/src/src/models/contact/derivatives/contact_info.test.js

@@ -1,331 +0,0 @@
-"use strict";
-// import { assertEquals } from "jsr:@std/assert";
-// import {
-//   BankContactInfo,
-//   MobileContactInfo,
-// } from "@models/contact/derivatives/contact_info.ts";
-// import { Bank, TZPhoneNumber } from "@temboplus/frontend-core";
-// Deno.test("MobileContactInfo.is", async (t) => {
-//   // Valid inputs with string phone number
-//   await t.step("accepts valid object with string phone number", () => {
-//     assertEquals(
-//       MobileContactInfo.is({
-//         name: "John Doe",
-//         phoneNumber: "+255712345678",
-//       }),
-//       true,
-//     );
-//     assertEquals(
-//       MobileContactInfo.is({
-//         name: "Jane Doe",
-//         phoneNumber: "0712345678",
-//       }),
-//       true,
-//     );
-//   });
-//   // Valid inputs with PhoneNumber object
-//   await t.step("accepts valid object with PhoneNumber instance", () => {
-//     const phoneNumber = TZPhoneNumber.from("+255712345678");
-//     assertEquals(
-//       MobileContactInfo.is({
-//         name: "John Doe",
-//         phoneNumber,
-//       }),
-//       true,
-//     );
-//   });
-//   // Invalid inputs - not an object
-//   await t.step("rejects non-object inputs", () => {
-//     assertEquals(MobileContactInfo.is(undefined), false);
-//     assertEquals(MobileContactInfo.is(null), false);
-//     assertEquals(MobileContactInfo.is(""), false);
-//     assertEquals(MobileContactInfo.is(123), false);
-//     assertEquals(MobileContactInfo.is(true), false);
-//   });
-//   // Invalid inputs - missing properties
-//   await t.step("rejects objects with missing properties", () => {
-//     assertEquals(MobileContactInfo.is({}), false);
-//     assertEquals(MobileContactInfo.is({ name: "John Doe" }), false);
-//     assertEquals(MobileContactInfo.is({ phoneNumber: "+255712345678" }), false);
-//   });
-//   // Invalid inputs - empty name
-//   await t.step("rejects empty name", () => {
-//     assertEquals(
-//       MobileContactInfo.is({
-//         name: "",
-//         phoneNumber: "+255712345678",
-//       }),
-//       false,
-//     );
-//     assertEquals(
-//       MobileContactInfo.is({
-//         name: "   ",
-//         phoneNumber: "+255712345678",
-//       }),
-//       false,
-//     );
-//   });
-//   // Invalid inputs - wrong property types
-//   await t.step("rejects invalid property types", () => {
-//     assertEquals(
-//       MobileContactInfo.is({
-//         name: 123,
-//         phoneNumber: "+255712345678",
-//       }),
-//       false,
-//     );
-//     assertEquals(
-//       MobileContactInfo.is({
-//         name: true,
-//         phoneNumber: "+255712345678",
-//       }),
-//       false,
-//     );
-//     assertEquals(
-//       MobileContactInfo.is({
-//         name: {},
-//         phoneNumber: "+255712345678",
-//       }),
-//       false,
-//     );
-//     assertEquals(
-//       MobileContactInfo.is({
-//         name: [],
-//         phoneNumber: "+255712345678",
-//       }),
-//       false,
-//     );
-//   });
-//   // Invalid inputs - invalid phone numbers
-//   await t.step("rejects invalid phone numbers", () => {
-//     assertEquals(
-//       MobileContactInfo.is({
-//         name: "John Doe",
-//         phoneNumber: "invalid",
-//       }),
-//       false,
-//     );
-//     assertEquals(
-//       MobileContactInfo.is({
-//         name: "John Doe",
-//         phoneNumber: "12345", // Too short
-//       }),
-//       false,
-//     );
-//     assertEquals(
-//       MobileContactInfo.is({
-//         name: "John Doe",
-//         phoneNumber: "+255999999999", // Invalid prefix
-//       }),
-//       false,
-//     );
-//     assertEquals(
-//       MobileContactInfo.is({
-//         name: "John Doe",
-//         phoneNumber: {}, // Empty object
-//       }),
-//       false,
-//     );
-//     assertEquals(
-//       MobileContactInfo.is({
-//         name: "John Doe",
-//         phoneNumber: { invalid: "object" }, // Invalid phone number object
-//       }),
-//       false,
-//     );
-//   });
-//   // Edge cases
-//   await t.step("handles edge cases correctly", () => {
-//     // Extra properties should not affect validation
-//     assertEquals(
-//       MobileContactInfo.is({
-//         name: "John Doe",
-//         phoneNumber: "+255712345678",
-//         extraProp: "something",
-//       }),
-//       true,
-//     );
-//     // Name with special characters should be valid
-//     assertEquals(
-//       MobileContactInfo.is({
-//         name: "John-Doe O'Connor",
-//         phoneNumber: "+255712345678",
-//       }),
-//       true,
-//     );
-//     // Minimum valid name length
-//     assertEquals(
-//       MobileContactInfo.is({
-//         name: "J",
-//         phoneNumber: "+255712345678",
-//       }),
-//       true,
-//     );
-//   });
-// });
-// Deno.test("BankContactInfo.is", async (t) => {
-//   // Setup valid bank object for tests
-//   const validBank = Bank.fromSWIFTCode("CORUTZTZ")
-//   // Valid cases with all properties correct
-//   await t.step("accepts valid object with all correct properties", () => {
-//     assertEquals(
-//       BankContactInfo.is({
-//         accName: "John Doe",
-//         accNumber: "1234567890",
-//         bank: validBank,
-//       }),
-//       true,
-//     );
-//   });
-//   // Invalid inputs - not an object
-//   await t.step("rejects non-object inputs", () => {
-//     assertEquals(BankContactInfo.is(undefined), false);
-//     assertEquals(BankContactInfo.is(null), false);
-//     assertEquals(BankContactInfo.is(""), false);
-//     assertEquals(BankContactInfo.is(123), false);
-//     assertEquals(BankContactInfo.is(true), false);
-//   });
-//   // Invalid inputs - missing properties
-//   await t.step("rejects objects with missing properties", () => {
-//     assertEquals(BankContactInfo.is({}), false);
-//     assertEquals(
-//       BankContactInfo.is({
-//         accName: "John Doe",
-//       }),
-//       false,
-//     );
-//     assertEquals(
-//       BankContactInfo.is({
-//         accName: "John Doe",
-//         accNumber: "1234567890",
-//       }),
-//       false,
-//     );
-//     assertEquals(
-//       BankContactInfo.is({
-//         accNumber: "1234567890",
-//         bank: validBank,
-//       }),
-//       false,
-//     );
-//     assertEquals(
-//       BankContactInfo.is({
-//         accName: "John Doe",
-//         bank: validBank,
-//       }),
-//       false,
-//     );
-//   });
-//   // Invalid inputs - wrong property types
-//   await t.step("rejects invalid property types", () => {
-//     assertEquals(
-//       BankContactInfo.is({
-//         accName: 123,
-//         accNumber: "1234567890",
-//         bank: validBank,
-//       }),
-//       false,
-//     );
-//     assertEquals(
-//       BankContactInfo.is({
-//         accName: "John Doe",
-//         accNumber: 1234567890,
-//         bank: validBank,
-//       }),
-//       false,
-//     );
-//     assertEquals(
-//       BankContactInfo.is({
-//         accName: "John Doe",
-//         accNumber: "1234567890",
-//         bank: "CRDB", // bank should be object
-//       }),
-//       false,
-//     );
-//   });
-//   // Invalid inputs - empty or invalid strings
-//   await t.step("rejects invalid string values", () => {
-//     assertEquals(
-//       BankContactInfo.is({
-//         accName: "",
-//         accNumber: "1234567890",
-//         bank: validBank,
-//       }),
-//       false,
-//     );
-//     assertEquals(
-//       BankContactInfo.is({
-//         accName: "John Doe",
-//         accNumber: "",
-//         bank: validBank,
-//       }),
-//       false,
-//     );
-//     assertEquals(
-//       BankContactInfo.is({
-//         accName: "   ",
-//         accNumber: "1234567890",
-//         bank: validBank,
-//       }),
-//       false,
-//     );
-//   });
-//   // Invalid inputs - invalid bank object
-//   await t.step("rejects invalid bank object", () => {
-//     assertEquals(
-//       BankContactInfo.is({
-//         accName: "John Doe",
-//         accNumber: "1234567890",
-//         bank: {},
-//       }),
-//       false,
-//     );
-//     assertEquals(
-//       BankContactInfo.is({
-//         accName: "John Doe",
-//         accNumber: "1234567890",
-//         bank: { name: "CRDB" }, // incomplete bank object
-//       }),
-//       false,
-//     );
-//     assertEquals(
-//       BankContactInfo.is({
-//         accName: "John Doe",
-//         accNumber: "1234567890",
-//         bank: { invalid: "object" },
-//       }),
-//       false,
-//     );
-//   });
-//   // Edge cases
-//   await t.step("handles edge cases correctly", () => {
-//     // Extra properties should not affect validation
-//     assertEquals(
-//       BankContactInfo.is({
-//         accName: "John Doe",
-//         accNumber: "1234567890",
-//         bank: validBank,
-//         extraProp: "something",
-//       }),
-//       true,
-//     );
-//     // Account name with special characters (assuming validateAccName allows them)
-//     assertEquals(
-//       BankContactInfo.is({
-//         accName: "John-Doe O'Connor",
-//         accNumber: "1234567890",
-//         bank: validBank,
-//       }),
-//       true,
-//     );
-//     // Account number with special formatting (assuming validateBankAccNo handles it)
-//     assertEquals(
-//       BankContactInfo.is({
-//         accName: "John Doe",
-//         accNumber: "1234-5678-90",
-//         bank: validBank,
-//       }),
-//       false,
-//     );
-//   });
-// });

package/script/npm/src/src/models/contact/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./schemas.js";
-export * from "./validation.js";
-export * from "./derivatives/contact_info.js";
-export * from "./derivatives/contact.js";
-//# sourceMappingURL=index.d.ts.map

package/script/npm/src/src/models/contact/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/src/models/contact/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC"}

package/script/npm/src/src/models/contact/index.js

@@ -1,20 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./schemas.js"), exports);
-__exportStar(require("./validation.js"), exports);
-__exportStar(require("./derivatives/contact_info.js"), exports);
-__exportStar(require("./derivatives/contact.js"), exports);

package/script/npm/src/src/models/contact/schemas.d.ts

@@ -1,66 +0,0 @@
-import { z } from "zod";
-/**
- * Valid contact channel types.
- * Inferred from the contactTypeSchema.
- *
- * @see {@link contactTypeSchema} for validation rules
- */
-export type ContactType = z.infer<typeof ContactSchemas.contactType>;
-/**
- * Schema type definition for contact input validation.
- *
- * @internal
- * This is an internal type used to enforce type consistency
- * in the contactInputSchema.
- */
-type _ContactInput = z.ZodObject<{
-    displayName: z.ZodString;
-    accountNo: z.ZodString;
-    channel: z.ZodString;
-    type: z.ZodEnum<["Bank", "Mobile"]>;
-}>;
-/**
- * Type representing user-provided contact information.
- * Used for creating or updating contacts.
- *
- * @see {@link contactInputSchema} for validation rules
- * @see {@link ContactSchemas} for all available schemas
- */
-export type ContactInput = z.infer<typeof ContactSchemas.contactInput>;
-/**
- * Schema type definition for complete contact records.
- *
- * @internal
- * Extends ContactInput with system-generated fields like
- * IDs and timestamps.
- */
-type _Contact = z.ZodObject<{
-    displayName: z.ZodString;
-    accountNo: z.ZodString;
-    channel: z.ZodString;
-    type: z.ZodEnum<["Bank", "Mobile"]>;
-    id: z.ZodString;
-    profileId: z.ZodString;
-    createdAt: z.ZodDate;
-    updatedAt: z.ZodDate;
-}>;
-/**
- * Type representing a complete contact record.
- * Includes both user-provided and system-generated fields.
- *
- * @see {@link contactSchema} for validation rules
- */
-export type ContactData = z.infer<typeof ContactSchemas.contactData>;
-/**
- * Collection of all contact-related schemas.
- */
-export declare const ContactSchemas: {
-    /** Schema for complete contact records */
-    contactData: _Contact;
-    /** Schema for contact input validation */
-    contactInput: _ContactInput;
-    /** Schema for contact channel types */
-    contactType: z.ZodEnum<["Bank", "Mobile"]>;
-};
-export {};
-//# sourceMappingURL=schemas.d.ts.map