@adonoustech/bacon-core 6.0.0 → 6.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonoustech/bacon-core",
-  "version": "6.0.0",
+  "version": "6.2.0",
   "scripts": {
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "build:es": "tsc -p tsconfig.es.json",
@@ -39,5 +39,5 @@
   "bugs": {
     "url": "https://github.com/AdonousTech/bacon-core/issues"
   },
-  "gitHead": "0d6214f54623568a0a08fb67625c432639a40a87"
+  "gitHead": "f5f1355daddae0fffb6b4fb3a6b2cba593b06150"
 }

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/index.ts

@@ -5,6 +5,9 @@ export * from './i-actor-init-trig-resp';
 export * from './i-actor-init-trig-user-attr';
 export * from './i-actor-init-trigger-evt';
 export * from './i-actor-status';
+export * from './i-admin-client';
+export * from './i-admin-client-detail';
+export * from './i-admin-client-table-row';
 export * from './i-bacon-action-item-settings';
 export * from './i-client-acct-admin-fields';
 export * from './i-client-acct-business-info';