@adonoustech/bacon-core 5.0.0 → 6.2.0

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;
 }

package/src/interfaces/i-oidc-identity.ts

@@ -1,8 +1,8 @@
-export interface IOIDCIdentity {
-    userId: string;
-    providerName: string;
-    providerType: string;
-    issuer: string | undefined;
-    primary: boolean;
-    dateCreated: number
+export interface IOIDCIdentity {
+    userId: string;
+    providerName: string;
+    providerType: string;
+    issuer: string | undefined;
+    primary: boolean;
+    dateCreated: number
 }

package/src/interfaces/i-oidc-profile.ts

@@ -1,45 +1,45 @@
-import { IOIDCAddressClaim } from "./i-oidc-address-claim";
-import { IOIDCIdentity } from "./i-oidc-identity";
-
-export interface IOIDCProfile {
-    sub: string;
-    name?: string; // Depending on OIDC provider, they may only provide given_name
-    email: string;
-    phone_number?: string;
-    given_name?: string;
-    family_name?: string;
-    middle_name?: string;
-    nickname?: string;
-    preferred_username?: string;
-    profile?: string;
-    picture?: string;
-    website?: string;
-    email_verified?: boolean;
-    gender?: string;
-    birthdate?: string;
-    zoneinfo?: string;
-    locale?: string;
-    phone_number_verified?: boolean;
-    address?:  IOIDCAddressClaim;
-    userPoolId?: string;
-    region?: string;
-
-    /**
-     * Cognito's PreAuthentication_Authentication event
-     * includes the "identities" property as a string.
-     * The caller must parse this value before accessing the contents
-     * in a strongly typed manner. 
-     * 
-     * We can parse this into an object implementing IOIDCIdentity 
-    */
-    identities?: string; // PreAuthentication_Authentication
-
-    /**
-     * Cognito's PostConfirmation_ConfirmSignUp event
-     * includes the cognito:user_status property as a string.
-     * This property will contain one of the following values: 
-     * EXTERNAL_PROVIDER if the user has authenticated with an external IdP
-     * CONFIRMED if the user has not authenticated with an external IdP
-     */
-    'cognito:user_status'?: string; // PostConfirmation_ConfirmSignUp
+import { IOIDCAddressClaim } from "./i-oidc-address-claim";
+import { IOIDCIdentity } from "./i-oidc-identity";
+
+export interface IOIDCProfile {
+    sub: string;
+    name?: string; // Depending on OIDC provider, they may only provide given_name
+    email: string;
+    phone_number?: string;
+    given_name?: string;
+    family_name?: string;
+    middle_name?: string;
+    nickname?: string;
+    preferred_username?: string;
+    profile?: string;
+    picture?: string;
+    website?: string;
+    email_verified?: boolean;
+    gender?: string;
+    birthdate?: string;
+    zoneinfo?: string;
+    locale?: string;
+    phone_number_verified?: boolean;
+    address?:  IOIDCAddressClaim;
+    userPoolId?: string;
+    region?: string;
+
+    /**
+     * Cognito's PreAuthentication_Authentication event
+     * includes the "identities" property as a string.
+     * The caller must parse this value before accessing the contents
+     * in a strongly typed manner. 
+     * 
+     * We can parse this into an object implementing IOIDCIdentity 
+    */
+    identities?: string; // PreAuthentication_Authentication
+
+    /**
+     * Cognito's PostConfirmation_ConfirmSignUp event
+     * includes the cognito:user_status property as a string.
+     * This property will contain one of the following values: 
+     * EXTERNAL_PROVIDER if the user has authenticated with an external IdP
+     * CONFIRMED if the user has not authenticated with an external IdP
+     */
+    'cognito:user_status'?: string; // PostConfirmation_ConfirmSignUp
 }

package/src/interfaces/i-token-time.ts

@@ -1,4 +1,4 @@
-export interface ITokenTime {
-    accessTokenExpiryDateTime: number;
-    refreshTokenExpiryDateTime: number;
+export interface ITokenTime {
+    accessTokenExpiryDateTime: number;
+    refreshTokenExpiryDateTime: number;
 }

package/src/interfaces/i-user.ts

@@ -1,6 +1,6 @@
-import { IOIDCProfile } from "./i-oidc-profile";
-export interface IUser {
-    id: string;
-    username: string;
-    attributes: IOIDCProfile;
+import { IOIDCProfile } from "./i-oidc-profile";
+export interface IUser {
+    id: string;
+    username: string;
+    attributes: IOIDCProfile;
 }

package/src/interfaces/index.ts

@@ -1,32 +1,40 @@
-export * from './i-actor-init-status';
-export * from './i-actor-init-trig-ctx';
-export * from './i-actor-init-trig-req';
-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-bacon-action-item-settings';
-export * from './i-bacon-action-item-snippet';
-export * from './i-bacon-admin-master-entry';
-export * from './i-bacon-authenticator-app';
-export * from './i-bacon-base-logger-event';
-export * from './i-bacon-client-checklist-item';
-export * from './i-bacon-client-error';
-export * from './i-bacon-cognito-request';
-export * from './i-bacon-file';
-export * from './i-bacon-mfa-status';
-export * from './i-bacon-object-layer-result';
-export * from './i-bacon-storage-item';
-export * from './i-bacon-totp-verification-model';
-export * from './i-bacon-totp-verification-result';
-export * from './i-bacon-update-mfa-pref-result';
-export * from './i-bacon-upload-request';
-export * from './i-bacon-ui-passthrough-input-event';
-export * from './i-cognito-admin-request-payload';
-export * from './i-flat-node';
-export * from './i-oidc-address-claim';
-export * from './i-oidc-identity';
-export * from './i-oidc-profile';
-export * from './i-iot-perms-request-payload';
-export * from './i-user';
-export * from './i-token-time';
+export * from './i-actor-init-status';
+export * from './i-actor-init-trig-ctx';
+export * from './i-actor-init-trig-req';
+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';
+export * from './i-client-acct-business-owner';
+export * from './i-client-acct-employee-info';
+export * from './i-client-acct-intake';
+export * from './i-bacon-action-item-snippet';
+export * from './i-bacon-admin-master-entry';
+export * from './i-bacon-authenticator-app';
+export * from './i-bacon-base-logger-event';
+export * from './i-bacon-client-checklist-item';
+export * from './i-bacon-client-error';
+export * from './i-bacon-cognito-request';
+export * from './i-bacon-file';
+export * from './i-bacon-mfa-status';
+export * from './i-bacon-object-layer-result';
+export * from './i-bacon-storage-item';
+export * from './i-bacon-totp-verification-model';
+export * from './i-bacon-totp-verification-result';
+export * from './i-bacon-update-mfa-pref-result';
+export * from './i-bacon-upload-request';
+export * from './i-bacon-ui-passthrough-input-event';
+export * from './i-cognito-admin-request-payload';
+export * from './i-flat-node';
+export * from './i-oidc-address-claim';
+export * from './i-oidc-identity';
+export * from './i-oidc-profile';
+export * from './i-iot-perms-request-payload';
+export * from './i-user';
+export * from './i-token-time';

package/src/maps/bacon-route-to-microservice.ts

@@ -1,24 +1,24 @@
-import { BaconRoutes } from "../enums";
-
-/**
- * Access microservice name from route. This runs in the context of a microservice, 
- * so the actual service names will be located in env variables. This allows for retrieving 
- * the microservice name regardless of the environment. These environment variables should be configured
- * in passthrough services with APIGW events
- * */ 
-// Check if process is defined, and if so, use its env, otherwise use an empty object.
-const env = typeof process !== 'undefined' ? process.env : {};
-
-const BaconRouteToMicroserviceMap: { [routeKey in BaconRoutes]?: string } = {
-    [BaconRoutes.ActionItemsAIRoute]: env.actionItemsAIService,
-    [BaconRoutes.AdminRoute]: env.adminService,
-    [BaconRoutes.DataRoute]: env.dataService,
-    [BaconRoutes.EmailRoute]: env.emailService,
-    [BaconRoutes.LoggerRoute]: env.loggerService,
-    [BaconRoutes.ObjectRoute]: env.objectService,
-    [BaconRoutes.QBORoute]: env.qboService,
-    [BaconRoutes.StripeRoute]: env.stripeService,
-    // add more routes here
-};
-
-export { BaconRouteToMicroserviceMap };
+import { BaconRoutes } from "../enums";
+
+/**
+ * Access microservice name from route. This runs in the context of a microservice, 
+ * so the actual service names will be located in env variables. This allows for retrieving 
+ * the microservice name regardless of the environment. These environment variables should be configured
+ * in passthrough services with APIGW events
+ * */ 
+// Check if process is defined, and if so, use its env, otherwise use an empty object.
+const env = typeof process !== 'undefined' ? process.env : {};
+
+const BaconRouteToMicroserviceMap: { [routeKey in BaconRoutes]?: string } = {
+    [BaconRoutes.ActionItemsAIRoute]: env.actionItemsAIService,
+    [BaconRoutes.AdminRoute]: env.adminService,
+    [BaconRoutes.DataRoute]: env.dataService,
+    [BaconRoutes.EmailRoute]: env.emailService,
+    [BaconRoutes.LoggerRoute]: env.loggerService,
+    [BaconRoutes.ObjectRoute]: env.objectService,
+    [BaconRoutes.QBORoute]: env.qboService,
+    [BaconRoutes.StripeRoute]: env.stripeService,
+    // add more routes here
+};
+
+export { BaconRouteToMicroserviceMap };

package/src/static/Bacon3PClientFactory.ts

@@ -1,13 +1,13 @@
-import { BaconBaseActor } from "../base/BaconBaseActor";
-import { BaconBaseActorFactory } from "../base/BaconBaseActorFactory";
-import { Bacon3PClient } from "../concrete/Bacon3PClient";
-import { IOIDCProfile } from "../interfaces/i-oidc-profile";
-
-export class Bacon3PClientFactory extends BaconBaseActorFactory {
-
-    static createActor(profile: IOIDCProfile): BaconBaseActor {
-        const actor: BaconBaseActor = new Bacon3PClient(profile);
-        return actor;
-    }
-
+import { BaconBaseActor } from "../base/BaconBaseActor";
+import { BaconBaseActorFactory } from "../base/BaconBaseActorFactory";
+import { Bacon3PClient } from "../concrete/Bacon3PClient";
+import { IOIDCProfile } from "../interfaces/i-oidc-profile";
+
+export class Bacon3PClientFactory extends BaconBaseActorFactory {
+
+    static createActor(profile: IOIDCProfile): BaconBaseActor {
+        const actor: BaconBaseActor = new Bacon3PClient(profile);
+        return actor;
+    }
+
 }

package/src/static/BaconAccessLoggerEvtFactory.ts

@@ -1,12 +1,12 @@
-import { BaconBaseLoggerEvent } from "../base/BaconBaseLoggerEvt";
-import { BaconBaseLoggerEventFactory } from "../base/BaconBaseLoggerEvtFact";
-import { BaconAccessLoggerEvent } from "../concrete/BaconAccessLoggerEvent";
-
-export class BaconAccessLoggerEventFactory extends BaconBaseLoggerEventFactory {
-
-    static createLoggerEvent(): BaconBaseLoggerEvent {
-        const loggerEvent: BaconBaseLoggerEvent = new BaconAccessLoggerEvent();
-        return loggerEvent;
-    }
-
+import { BaconBaseLoggerEvent } from "../base/BaconBaseLoggerEvt";
+import { BaconBaseLoggerEventFactory } from "../base/BaconBaseLoggerEvtFact";
+import { BaconAccessLoggerEvent } from "../concrete/BaconAccessLoggerEvent";
+
+export class BaconAccessLoggerEventFactory extends BaconBaseLoggerEventFactory {
+
+    static createLoggerEvent(): BaconBaseLoggerEvent {
+        const loggerEvent: BaconBaseLoggerEvent = new BaconAccessLoggerEvent();
+        return loggerEvent;
+    }
+
 }