@adonoustech/bacon-core 5.0.0 → 6.0.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-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;
+    };
 }

package/src/interfaces/i-bacon-ui-passthrough-input-event.ts

@@ -1,65 +1,65 @@
-// represents incoming APIGW HTTP API lambda event
-// https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
-
-// as of today, there are no typescript definitions for this event type
-export interface IBaconUIPassthroughInputEvent 
-{
-  "version"?: string,
-  "routeKey"?: string,
-  "rawPath"?: string,
-  "rawQueryString"?: string,
-  "cookies"?: string[],
-  "headers"?: {
-    [header: string]: string 
-  },
-  "queryStringParameters"?: {
-    [param: string]: string
-  },
-  "requestContext"?: {
-    "accountId": string,
-    "apiId": string,
-    "authentication": {
-      "clientCert": {
-        "clientCertPem": string,
-        "subjectDN": string,
-        "issuerDN": string,
-        "serialNumber": string,
-        "validity": {
-          "notBefore": string,
-          "notAfter": string
-        }
-      }
-    },
-    "authorizer": {
-      "jwt": {
-        "claims": {
-          [claim: string]: string
-        },
-        "scopes": string[]
-      }
-    },
-    "domainName": string,
-    "domainPrefix": string,
-    "http": {
-      "method": string,
-      "path": string,
-      "protocol": string,
-      "sourceIp": string,
-      "userAgent": string
-    },
-    "requestId": string,
-    "routeKey": string,
-    "stage": string,
-    "time": string,
-    "timeEpoch": number
-  },
-  "body"?: string,
-  "pathParameters": {
-    "proxy": string, // hardcoding proxy here because it's the only path parameter we use
-  },
-  "isBase64Encoded"?: false,
-  "stageVariables"?: {
-    "stageVariable1": string,
-    "stageVariable2": string
-  }
+// represents incoming APIGW HTTP API lambda event
+// https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
+
+// as of today, there are no typescript definitions for this event type
+export interface IBaconUIPassthroughInputEvent 
+{
+  "version"?: string,
+  "routeKey"?: string,
+  "rawPath"?: string,
+  "rawQueryString"?: string,
+  "cookies"?: string[],
+  "headers"?: {
+    [header: string]: string 
+  },
+  "queryStringParameters"?: {
+    [param: string]: string
+  },
+  "requestContext"?: {
+    "accountId": string,
+    "apiId": string,
+    "authentication": {
+      "clientCert": {
+        "clientCertPem": string,
+        "subjectDN": string,
+        "issuerDN": string,
+        "serialNumber": string,
+        "validity": {
+          "notBefore": string,
+          "notAfter": string
+        }
+      }
+    },
+    "authorizer": {
+      "jwt": {
+        "claims": {
+          [claim: string]: string
+        },
+        "scopes": string[]
+      }
+    },
+    "domainName": string,
+    "domainPrefix": string,
+    "http": {
+      "method": string,
+      "path": string,
+      "protocol": string,
+      "sourceIp": string,
+      "userAgent": string
+    },
+    "requestId": string,
+    "routeKey": string,
+    "stage": string,
+    "time": string,
+    "timeEpoch": number
+  },
+  "body"?: string,
+  "pathParameters": {
+    "proxy": string, // hardcoding proxy here because it's the only path parameter we use
+  },
+  "isBase64Encoded"?: false,
+  "stageVariables"?: {
+    "stageVariable1": string,
+    "stageVariable2": string
+  }
 }

package/src/interfaces/i-bacon-update-mfa-pref-result.ts

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

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

@@ -1,6 +1,6 @@
-import { IBaconFile } from "./i-bacon-file";
-
-export interface IBaconUploadRequest {
-    files: IBaconFile[];
-    destination: string;
+import { IBaconFile } from "./i-bacon-file";
+
+export interface IBaconUploadRequest {
+    files: IBaconFile[];
+    destination: string;
 }

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

@@ -0,0 +1,14 @@
+/**
+ * Admin-only hidden fields for client accounting intake
+ * These fields are set by admin via the admin dashboard, not by the client
+ */
+export interface IClientAcctAdminFields {
+    /** Whether we provide payroll services for this client */
+    providesPayroll: boolean;
+    /** Whether we provide 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;
+}

package/src/interfaces/i-client-acct-business-info.ts

@@ -0,0 +1,23 @@
+import { ClientAcctIntakeBusinessEntityTypes } from "../enums/client-acct-intake-business-entity-types";
+
+/**
+ * Business information section of the client accounting intake form
+ */
+export interface IClientAcctBusinessInfo {
+    /** Client acquisition date - hidden field, auto-set on creation */
+    clientAcquisitionDate: string;
+    /** Legal business name as registered with government agencies */
+    legalBusinessName: string;
+    /** IRS Tax ID (EIN) - format XX-XXXXXXX, optional */
+    irsTaxIdEIN: string;
+    /** Business entity type */
+    businessEntityType: ClientAcctIntakeBusinessEntityTypes;
+    /** Date of incorporation or formation date/date on business license */
+    dateOfIncorporation: string;
+    /** Date of S-Corporation election - applicable only for S-Corps */
+    dateOfSCorpElection: string;
+    /** State of incorporation / state where business is registered */
+    stateOfIncorporation: string;
+    /** State Tax ID - optional */
+    stateTaxId: string;
+}

package/src/interfaces/i-client-acct-business-owner.ts

@@ -0,0 +1,20 @@
+/**
+ * Business owner entry for client accounting intake form
+ * Supports up to 10 owners per client
+ */
+export interface IClientAcctBusinessOwner {
+    /** Full name of the business owner */
+    ownerName: string;
+    /** Email address of the owner */
+    ownerEmail: string;
+    /** Cellphone number of the owner */
+    ownerCellphone: string;
+    /** Date of birth - ISO date string */
+    ownerDOB: string;
+    /** Social Security Number - format XXX-XX-XXXX */
+    ownerSSN: string;
+    /** Percent ownership for partnerships/QJV (0-100) */
+    percentOwnership: number;
+    /** Number of shares owned for S-Corp/C-Corp */
+    sharesOwned: number;
+}

package/src/interfaces/i-client-acct-employee-info.ts

@@ -0,0 +1,13 @@
+import { ClientAcctIntakeBOFilingFrequencies } from "../enums/client-acct-intake-bo-filing-frequencies";
+
+/**
+ * Employee information section of the client accounting intake form
+ */
+export interface IClientAcctEmployeeInfo {
+    /** Number of shareholders on payroll - applicable for S-Corp/C-Corp */
+    shareholdersOnPayroll: number;
+    /** Number of non-shareholder employees on payroll */
+    nonShareholderEmployees: number;
+    /** Business and Operations (B&O) tax filing frequency - WA state specific */
+    boTaxFilingFrequency: ClientAcctIntakeBOFilingFrequencies;
+}

package/src/interfaces/i-client-acct-intake.ts

@@ -0,0 +1,35 @@
+import { IClientAcctAdminFields } from "./i-client-acct-admin-fields";
+import { IClientAcctBusinessInfo } from "./i-client-acct-business-info";
+import { IClientAcctBusinessOwner } from "./i-client-acct-business-owner";
+import { IClientAcctEmployeeInfo } from "./i-client-acct-employee-info";
+
+/**
+ * Complete client accounting intake data model
+ * Stored in DynamoDB under the key 'client-acct-intake'
+ */
+export interface IClientAcctIntakeData {
+    /** Business information section */
+    businessInfo: IClientAcctBusinessInfo;
+    /** Array of business owners - maximum 10 entries */
+    businessOwners: IClientAcctBusinessOwner[];
+    /** Employee information section */
+    employeeInfo: IClientAcctEmployeeInfo;
+    /** Admin-only hidden fields */
+    adminFields: IClientAcctAdminFields;
+    /** ISO timestamp of last modification */
+    lastModified: string;
+    /** Whether the intake form is complete and submitted */
+    isComplete: boolean;
+    /** ISO timestamp of when the intake was submitted */
+    submittedAt: string;
+}
+
+/**
+ * Constants for client accounting intake
+ */
+export const CLIENT_ACCT_INTAKE_CONSTANTS = {
+    /** Maximum number of business owners allowed */
+    MAX_BUSINESS_OWNERS: 10,
+    /** DynamoDB object key for intake data */
+    DB_OBJECT_KEY: "client-acct-intake"
+} as const;

package/src/interfaces/i-cognito-admin-request-payload.ts

@@ -1,9 +1,9 @@
-export interface BaconCognitoAdminRequestPayload {
-    username: string;
-    customAttributes?: {
-        [key: string]: string;
-    };
-    userAttributes?: {
-        [key: string]: string;
-    };
+export interface BaconCognitoAdminRequestPayload {
+    username: string;
+    customAttributes?: {
+        [key: string]: string;
+    };
+    userAttributes?: {
+        [key: string]: string;
+    };
 }

package/src/interfaces/i-flat-node.ts

@@ -1,6 +1,6 @@
-export interface IFlatNode {
-    expandable: boolean;
-    name: string;
-    level: number;
-    isExpanded?: boolean;
+export interface IFlatNode {
+    expandable: boolean;
+    name: string;
+    level: number;
+    isExpanded?: boolean;
 }

package/src/interfaces/i-iot-perms-request-payload.ts

@@ -1,3 +1,3 @@
-export interface BaconIOTPermsRequestPayload {
-    identityId: string;
+export interface BaconIOTPermsRequestPayload {
+    identityId: string;
 }

package/src/interfaces/i-oidc-address-claim.ts

@@ -1,8 +1,8 @@
-export interface IOIDCAddressClaim {
-    street_address?: string;
-    formatted?: string;
-    locality?: string;
-    region?: string;
-    postal_code?: string;
-    country?: string;
+export interface IOIDCAddressClaim {
+    street_address?: string;
+    formatted?: string;
+    locality?: string;
+    region?: string;
+    postal_code?: string;
+    country?: string;
 }