@adonoustech/bacon-core 5.0.0 → 6.2.0

package/src/index.ts

@@ -1,15 +1,15 @@
-/**
- * Bacon Core
- * 
- * @module bacon-core
-*/
-
-export * from './base';
-export * from './concrete';
-export * from './constants';
-export * from './enums';
-export * from './interfaces';
-export * from './maps';
-export * from './static';
-export * from './utils';
-
+/**
+ * Bacon Core
+ * 
+ * @module bacon-core
+*/
+
+export * from './base';
+export * from './concrete';
+export * from './constants';
+export * from './enums';
+export * from './interfaces';
+export * from './maps';
+export * from './static';
+export * from './utils';
+

package/src/interfaces/i-actor-init-status.ts

@@ -1,7 +1,7 @@
-import { BaconActorInitStatuses } from "../enums/bacon-actor-init-statuses";
-
-export interface IBaconActorInitStatus {
-
-    actorInitStatus: BaconActorInitStatuses;
-
+import { BaconActorInitStatuses } from "../enums/bacon-actor-init-statuses";
+
+export interface IBaconActorInitStatus {
+
+    actorInitStatus: BaconActorInitStatuses;
+
 }

package/src/interfaces/i-actor-init-trig-ctx.ts

@@ -1,4 +1,4 @@
-export interface IBaconActorInitTrigCtx {
-    awsSdkVersion: string;
-    clientId: string;
+export interface IBaconActorInitTrigCtx {
+    awsSdkVersion: string;
+    clientId: string;
 }

package/src/interfaces/i-actor-init-trig-req.ts

@@ -1,6 +1,6 @@
-import { IOIDCProfile } from "./i-oidc-profile"
-
-export interface IBaconActorInitTrigReq {
-    userAttributes: IOIDCProfile;
-    validationData: any;
+import { IOIDCProfile } from "./i-oidc-profile"
+
+export interface IBaconActorInitTrigReq {
+    userAttributes: IOIDCProfile;
+    validationData: any;
 }

package/src/interfaces/i-actor-init-trig-resp.ts

@@ -1,5 +1,5 @@
-export interface IBaconActorInitTrigResp {
-    autoConfirmUser: boolean;
-    autoVerifyEmail: boolean;
-    autoVerifyPhone: boolean;
+export interface IBaconActorInitTrigResp {
+    autoConfirmUser: boolean;
+    autoVerifyEmail: boolean;
+    autoVerifyPhone: boolean;
 }

package/src/interfaces/i-actor-init-trig-user-attr.ts

@@ -1,3 +1,3 @@
-export interface IBaconActorInitTrigUserAttr {
-    [key: string]: String
+export interface IBaconActorInitTrigUserAttr {
+    [key: string]: String
 }

package/src/interfaces/i-actor-init-trigger-evt.ts

@@ -1,15 +1,15 @@
-import { BaconActorInitTriggerSources, BaconAWSRegions } from "../enums";
-import { IBaconActorInitTrigCtx } from "./i-actor-init-trig-ctx";
-import { IBaconActorInitTrigReq } from "./i-actor-init-trig-req";
-import { IBaconActorInitTrigResp } from "./i-actor-init-trig-resp";
-
-export interface IBaconActorInitTriggerEvent {
-    version: string;
-    triggerSource: BaconActorInitTriggerSources;
-    region: BaconAWSRegions;
-    userPoolId: string;
-    userName: string;
-    callerContext: IBaconActorInitTrigCtx;
-    request: IBaconActorInitTrigReq;
-    response: IBaconActorInitTrigResp;
+import { BaconActorInitTriggerSources, BaconAWSRegions } from "../enums";
+import { IBaconActorInitTrigCtx } from "./i-actor-init-trig-ctx";
+import { IBaconActorInitTrigReq } from "./i-actor-init-trig-req";
+import { IBaconActorInitTrigResp } from "./i-actor-init-trig-resp";
+
+export interface IBaconActorInitTriggerEvent {
+    version: string;
+    triggerSource: BaconActorInitTriggerSources;
+    region: BaconAWSRegions;
+    userPoolId: string;
+    userName: string;
+    callerContext: IBaconActorInitTrigCtx;
+    request: IBaconActorInitTrigReq;
+    response: IBaconActorInitTrigResp;
 }

package/src/interfaces/i-actor-status.ts

@@ -1,7 +1,7 @@
-import { BaconActorStatuses } from "../enums/bacon-actor-statuses";
-
-export interface IBaconActorStatus {
-
-    actorStatus: BaconActorStatuses;
-
+import { BaconActorStatuses } from "../enums/bacon-actor-statuses";
+
+export interface IBaconActorStatus {
+
+    actorStatus: BaconActorStatuses;
+
 }

package/src/interfaces/i-admin-client-detail.ts

@@ -0,0 +1,155 @@
+import { IBaconClientChecklistItem } from "./i-bacon-client-checklist-item";
+import { IClientAcctBusinessOwner } from "./i-client-acct-business-owner";
+import { IAdminClientActionItem, IAdminClientService } from "./i-admin-client";
+
+/**
+ * Business information structure for client detail view
+ */
+export interface IAdminClientDetailBusinessInfo {
+    /** Legal business name */
+    legalBusinessName?: string;
+    /** IRS Tax ID / EIN */
+    irsTaxIdEIN?: string;
+    /** Business entity type (S-Corporation, LLC, etc.) */
+    businessEntityType?: string;
+    /** Date of incorporation - ISO date string */
+    dateOfIncorporation?: string;
+    /** Date of S-Corp election - ISO date string (S-Corps only) */
+    dateOfSCorpElection?: string;
+    /** State of incorporation (2-letter code) */
+    stateOfIncorporation?: string;
+    /** State tax ID */
+    stateTaxId?: string;
+    /** Client acquisition date - ISO date string */
+    clientAcquisitionDate?: string;
+}
+
+/**
+ * Employee information structure for client detail view
+ */
+export interface IAdminClientDetailEmployeeInfo {
+    /** Number of shareholders on payroll (S-Corp/C-Corp only) */
+    shareholdersOnPayroll?: number;
+    /** Number of non-shareholder employees */
+    nonShareholderEmployees?: number;
+    /** B&O tax filing frequency */
+    boTaxFilingFrequency?: string;
+}
+
+/**
+ * Admin configuration flags for client detail view
+ */
+export interface IAdminClientDetailAdminConfig {
+    /** Whether LHA provides payroll services for this client */
+    providesPayroll: boolean;
+    /** Whether LHA provides state tax filings (B&O) for this client */
+    providesStateTaxFilingsBnO: boolean;
+    /** Whether this is a business tax client */
+    isBusinessTaxClient: boolean;
+    /** Whether this is a personal tax client */
+    isPersonalTaxClient: boolean;
+}
+
+/**
+ * Action items categorized by status for detail view
+ */
+export interface IAdminClientDetailActionItems {
+    /** Action items with lifeCycle !== 'Completed' */
+    pending: IAdminClientActionItem[];
+    /** Action items with lifeCycle === 'Completed' */
+    completed: IAdminClientActionItem[];
+    /** Total count of all action items */
+    total: number;
+}
+
+/**
+ * Checklist summary for client detail view
+ */
+export interface IAdminClientDetailChecklist {
+    /** All checklist items */
+    items: IBaconClientChecklistItem[];
+    /** Count of completed items */
+    completedCount: number;
+    /** Total count of items */
+    totalCount: number;
+    /** Completion percentage (0-100) */
+    progressPercent: number;
+}
+
+/**
+ * File sharing configuration for client detail view
+ */
+export interface IAdminClientDetailFileSharing {
+    /** Whether file sharing is enabled */
+    enabled: boolean;
+}
+
+/**
+ * Intake form status for client detail view
+ */
+export interface IAdminClientDetailIntakeStatus {
+    /** Whether the intake form is complete */
+    isComplete: boolean;
+    /** ISO timestamp of when intake was submitted */
+    submittedAt?: string;
+    /** ISO timestamp of last modification */
+    lastModified?: string;
+}
+
+/**
+ * Structured detail view model for individual client
+ * Used in the client detail panel/modal
+ *
+ * @description This interface provides a structured, organized view
+ * of all client data for the detail panel. Data is transformed from
+ * the raw IAdminClient format into logical groups for display.
+ */
+export interface IAdminClientDetail {
+    /** User unique identifier (Cognito sub) */
+    sub: string;
+
+    /** Client display name */
+    name: string;
+
+    /** Client email address */
+    email: string;
+
+    /** Client phone number */
+    phone?: string;
+
+    /** Account status */
+    status: "active" | "inactive";
+
+    /** Business information from intake form */
+    businessInfo: IAdminClientDetailBusinessInfo;
+
+    /** Array of business owners from intake form */
+    businessOwners: IClientAcctBusinessOwner[];
+
+    /** Employee information from intake form */
+    employeeInfo: IAdminClientDetailEmployeeInfo;
+
+    /** Admin configuration flags */
+    adminConfig: IAdminClientDetailAdminConfig;
+
+    /** Client's subscribed services */
+    services: IAdminClientService[];
+
+    /** Total value of all subscribed services */
+    totalServiceValue: number;
+
+    /** Whether client has private pricing (service ID 'EXT00') */
+    hasPrivatePricing: boolean;
+
+    /** Action items organized by status */
+    actionItems: IAdminClientDetailActionItems;
+
+    /** Onboarding checklist summary */
+    checklist: IAdminClientDetailChecklist;
+
+    /** File sharing configuration */
+    fileSharing: IAdminClientDetailFileSharing;
+
+    /** Intake form submission status */
+    intakeStatus: IAdminClientDetailIntakeStatus;
+}

package/src/interfaces/i-admin-client-table-row.ts

@@ -0,0 +1,77 @@
+import { IAdminClient } from "./i-admin-client";
+
+/**
+ * Flattened model for admin client table display
+ * Pre-calculated metrics for efficient rendering in MatTable
+ *
+ * @description This interface represents a single row in the admin
+ * client management table. All calculated fields are pre-computed
+ * during data transformation to optimize rendering performance.
+ */
+export interface IAdminClientTableRow {
+    /** User unique identifier (Cognito sub) */
+    sub: string;
+
+    /** Display name from general.name */
+    clientName: string;
+
+    /** Email address from general.email */
+    email: string;
+
+    /** Phone number from general.phone_number */
+    phoneNumber?: string;
+
+    /** Legal business name from intake form */
+    legalBusinessName?: string;
+
+    /** Business entity type from intake form (e.g., S-Corporation, LLC) */
+    businessEntityType?: string;
+
+    /** State of incorporation from intake form */
+    stateOfIncorporation?: string;
+
+    /** Count of subscribed services */
+    serviceCount: number;
+
+    /** Total value of all subscribed services */
+    serviceValue: number;
+
+    /** Count of action items with lifeCycle === 'Created' */
+    pendingActionCount: number;
+
+    /** Count of action items with lifeCycle === 'Completed' */
+    completedActionCount: number;
+
+    /** Checklist completion percentage (0-100) */
+    checklistProgress: number;
+
+    /** Account status */
+    status: "active" | "inactive";
+
+    /** Whether client has private pricing (service ID 'EXT00') */
+    isPrivatePricing: boolean;
+
+    /** Whether client has completed the intake form */
+    hasIntakeData: boolean;
+
+    /** Whether file sharing is enabled for this client */
+    fileShareEnabled: boolean;
+
+    /** Admin flag: Provides payroll services */
+    providesPayroll?: boolean;
+
+    /** Admin flag: Is a business tax client */
+    isBusinessTaxClient?: boolean;
+
+    /** Admin flag: Is a personal tax client */
+    isPersonalTaxClient?: boolean;
+
+    /** Client acquisition date from intake form */
+    clientAcquisitionDate?: string;
+
+    /** Last modified timestamp */
+    lastModified?: string;
+
+    /** Reference to the original full client data */
+    _raw?: IAdminClient;
+}

package/src/interfaces/i-admin-client.ts

@@ -0,0 +1,117 @@
+import { IBaconClientChecklistItem } from "./i-bacon-client-checklist-item";
+import { IClientAcctIntakeData } from "./i-client-acct-intake";
+
+/**
+ * General user information from Cognito
+ */
+export interface IAdminClientGeneral {
+    "cognito:user_status"?: string;
+    email: string;
+    email_verified?: string;
+    name: string;
+    phone_number?: string;
+    phone_number_verified?: string;
+    sub: string;
+    [key: string]: any;
+}
+
+/**
+ * Service interface for client subscriptions
+ * NOTE: Use IBaconService from @adonoustech/bacon-data for full service details
+ */
+export interface IAdminClientService {
+    active: boolean;
+    category: string;
+    description: string;
+    frequency: string;
+    id: string;
+    instanceId?: string;
+    lastActivationDate?: string;
+    lastDeactivationDate?: string;
+    maxAccounts?: number;
+    name: string;
+    pencePrice?: number;
+    price: number;
+    terms?: string;
+    type: string;
+    [key: string]: any;
+}
+
+/**
+ * Stripe object containing selected services
+ */
+export interface IAdminClientStripeObject {
+    selected: {
+        services: IAdminClientService[];
+    };
+    customerId?: string;
+    [key: string]: any;
+}
+
+/**
+ * Action item structure for client tasks
+ */
+export interface IAdminClientActionItem {
+    actionId?: string;
+    actionInstanceId?: string;
+    actionName?: string;
+    actionExplanation?: string;
+    actionInstruction?: string;
+    lifeCycle?: "Draft" | "Created" | "Acknowledged" | "Submitted" | "Completed";
+    severity?: "Low" | "Normal" | "High" | "Critical";
+    serviceId?: string;
+    serviceName?: string;
+    createdEntryTime?: string;
+    completedEntryTime?: string;
+    FromDate?: string;
+    ToDate?: string;
+    TransactionAmount?: number;
+    correspondence?: any[];
+    [key: string]: any;
+}
+
+/**
+ * Consolidated client data model for admin dashboard
+ * Aggregates data from multiple DynamoDB attributes
+ *
+ * @description This interface represents the complete client record
+ * as stored in DynamoDB, combining data from:
+ * - federated-identity: Auth provider information
+ * - general: Cognito user attributes
+ * - stripeobject: Billing and service subscriptions
+ * - action-items: Client tasks and action items
+ * - status: Active/inactive state
+ * - client-acct-intake: Accounting intake form data
+ * - new_client_checklist_items: Onboarding checklist
+ */
+export interface IAdminClient {
+    /** User unique identifier (Cognito sub) */
+    sub: string;
+
+    /** Federated identity provider string */
+    "federated-identity"?: string;
+
+    /** General user information from Cognito */
+    general: IAdminClientGeneral;
+
+    /** Stripe billing and services information */
+    stripeobject?: IAdminClientStripeObject;
+
+    /** Client action items and tasks */
+    "action-items"?: IAdminClientActionItem[];
+
+    /** Account status */
+    status: "active" | "inactive";
+
+    /** Client accounting intake form data */
+    "client-acct-intake"?: IClientAcctIntakeData;
+
+    /** New client onboarding checklist items */
+    new_client_checklist_items?: IBaconClientChecklistItem[];
+
+    /** File sharing enabled flag */
+    fileShareEnabled?: boolean;
+
+    /** Allow additional dynamic properties */
+    [key: string]: any;
+}

package/src/interfaces/i-bacon-action-item-settings.ts

@@ -1,6 +1,6 @@
-export interface IBaconActionItemSettings {
-    acceptUpload: boolean;
-    autoReminder: boolean;
-    highImportance: boolean;
-    phoneReminder: boolean;
+export interface IBaconActionItemSettings {
+    acceptUpload: boolean;
+    autoReminder: boolean;
+    highImportance: boolean;
+    phoneReminder: boolean;
 }

package/src/interfaces/i-bacon-admin-master-entry.ts

@@ -1,4 +1,4 @@
-export interface IBaconAdminMasterEntry {
-    sub: string;
-    federatedId: string;
+export interface IBaconAdminMasterEntry {
+    sub: string;
+    federatedId: string;
 }

package/src/interfaces/i-bacon-authenticator-app.ts

@@ -1,7 +1,7 @@
-export interface IBaconAuthenticatorApp {
-    name: string;
-    deepLink: string;
-    universalLink?: string;
-    playStoreUrl?: string;
-    appStoreUrl?: string;
+export interface IBaconAuthenticatorApp {
+    name: string;
+    deepLink: string;
+    universalLink?: string;
+    playStoreUrl?: string;
+    appStoreUrl?: string;
 }

package/src/interfaces/i-bacon-base-logger-event.ts

@@ -1,10 +1,10 @@
-import { BaconBusinessLayerKinds, BaconLoggerEventTypes } from "../enums";
-import { IOIDCProfile } from "./i-oidc-profile";
-
-export interface IBaconBaseLoggerEvent {
-    kind: BaconBusinessLayerKinds;
-    eventType: BaconLoggerEventTypes;
-    error: string;
-    actor: IOIDCProfile;
-    timestamp: string;
+import { BaconBusinessLayerKinds, BaconLoggerEventTypes } from "../enums";
+import { IOIDCProfile } from "./i-oidc-profile";
+
+export interface IBaconBaseLoggerEvent {
+    kind: BaconBusinessLayerKinds;
+    eventType: BaconLoggerEventTypes;
+    error: string;
+    actor: IOIDCProfile;
+    timestamp: string;
 }

package/src/interfaces/i-bacon-client-checklist-item.ts

@@ -1,8 +1,8 @@
-export interface IBaconClientChecklistItem {
-    action: string;
-    description: string;
-    index: number;
-    id: string;
-    explanation: string;
-    status: 'complete' | 'incomplete'
+export interface IBaconClientChecklistItem {
+    action: string;
+    description: string;
+    index: number;
+    id: string;
+    explanation: string;
+    status: 'complete' | 'incomplete'
 }

package/src/interfaces/i-bacon-client-error.ts

@@ -1,4 +1,4 @@
-export interface IBaconClientError {
-    canonicalMessage: string;
-    errorMessage: any;
+export interface IBaconClientError {
+    canonicalMessage: string;
+    errorMessage: any;
 }

package/src/interfaces/i-bacon-cognito-request.ts

@@ -1,4 +1,4 @@
-export interface BaconCognitoRequest {
-    action: "createUser" | "deleteUser" | "updateUserAttributes" | "signIn";
-    payload: any;
+export interface BaconCognitoRequest {
+    action: "createUser" | "deleteUser" | "updateUserAttributes" | "signIn";
+    payload: any;
 }

package/src/interfaces/i-bacon-file.ts

@@ -1,9 +1,9 @@
-export interface IBaconFile {
-    lastModified?: number;
-    lastModifiedDate?: string;
-    name?: string;
-    size?: number;
-    type?: string; 
-    currentKey?: string;
-    destinationKey?: string;
+export interface IBaconFile {
+    lastModified?: number;
+    lastModifiedDate?: string;
+    name?: string;
+    size?: number;
+    type?: string; 
+    currentKey?: string;
+    destinationKey?: string;
 }

package/src/interfaces/i-bacon-mfa-status.ts

@@ -1,8 +1,8 @@
-import { BaconAuthMfaTypes } from "../enums";
-
-export interface IBaconMfaStatus {
-    isEnabled: boolean;
-    isTOTPEnabled: boolean;
-    isSMSEnabled: boolean;
-    preferredMethod?: BaconAuthMfaTypes;
+import { BaconAuthMfaTypes } from "../enums";
+
+export interface IBaconMfaStatus {
+    isEnabled: boolean;
+    isTOTPEnabled: boolean;
+    isSMSEnabled: boolean;
+    preferredMethod?: BaconAuthMfaTypes;
 }

package/src/interfaces/i-bacon-object-layer-result.ts

@@ -1,7 +1,7 @@
-export interface IBaconObjectLayerResult {
-    statusCode: number;
-    headers: {
-        [key: string]: string
-    },
-    body: string
+export interface IBaconObjectLayerResult {
+    statusCode: number;
+    headers: {
+        [key: string]: string
+    },
+    body: string
 }

package/src/interfaces/i-bacon-storage-item.ts

@@ -1,8 +1,8 @@
-export interface IBaconStorageItem {
-    eTag: string;
-    key: string;
-    path?: string;
-    lastModified: string;
-    size: number;
-    index: number
+export interface IBaconStorageItem {
+    eTag: string;
+    key: string;
+    path?: string;
+    lastModified: string;
+    size: number;
+    index: number
 }

package/src/interfaces/i-bacon-totp-verification-model.ts

@@ -1,3 +1,3 @@
-export interface IBaconTotpVerificationNModel {
-    code: string;
+export interface IBaconTotpVerificationNModel {
+    code: string;
 }

package/src/interfaces/i-bacon-totp-verification-result.ts

@@ -1,7 +1,7 @@
-export interface IBaconTotpVerificationResult {
-    success: boolean;
-    error?: {
-        code: string;
-        message: string;
-    };
+export interface IBaconTotpVerificationResult {
+    success: boolean;
+    error?: {
+        code: string;
+        message: string;
+    };
 }