@gusto/embedded-react-sdk 0.0.1

package/dist/src/helpers/LRUCache.d.ts

@@ -0,0 +1,7 @@
+export declare class LRUCache {
+    capacity: number;
+    map: Map<string, () => Record<string, string>>;
+    constructor(capacity: number);
+    get(key: string): (() => Record<string, string>) | null;
+    put(key: string, value: () => Record<string, string>): void;
+}

package/dist/src/helpers/formattedStrings.d.ts

@@ -0,0 +1,7 @@
+import { AddressType, EmployeeType } from '../types';
+export declare const firstLastName: ({ first_name, last_name }: EmployeeType) => string;
+export declare const addressInline: (address: AddressType) => string;
+export declare const currentDateString: () => string;
+export declare function isNumberKey({ which, keyCode }: KeyboardEvent): boolean;
+export declare const booleanToString: (value: boolean) => "true" | "false";
+export declare const amountStr: (amount: string, isPercentage: boolean) => string;

package/dist/src/helpers/formatters.d.ts

@@ -0,0 +1,2 @@
+export declare const currency: (value: number) => string;
+export declare const shortDate: (value: Date) => string;

package/dist/src/helpers/normalizeSSN.d.ts

@@ -0,0 +1 @@
+export declare const normalizeSSN: (value: string) => string;

package/dist/src/helpers/payRateCalculator.d.ts

@@ -0,0 +1,2 @@
+export declare const hourlyRate: (amount: number, paymentUnit: "Hour" | "Week" | "Month" | "Year" | "Paycheck") => number;
+export declare const yearlyRate: (amount: number, paymentUnit: "Hour" | "Week" | "Month" | "Year" | "Paycheck") => number;

package/dist/src/i18n/I18n.d.ts

@@ -0,0 +1,8 @@
+import { default as Resources } from '../types/i18nresources';
+export declare const defaultNS = "common";
+/**
+ * Hook that allows component to load custom dictionary
+ * @param @private {string} ns - Namespace - should match component name exactly - not exposed to consumers
+ * @param {} overrideResource - Resource object with key/value pairs of strings
+ */
+export declare const useI18n: (ns: keyof Resources | null, overrideResource?: Record<string, unknown>) => void;

package/dist/src/i18n/en/common.json.d.ts

@@ -0,0 +1,99 @@
+declare const _default: {
+  "status": {
+    "loading": "Loading component...",
+    "requiredField": "is a required field"
+  },
+  "optionalLabel": " (optional)",
+  "errors": {
+    "globalReactError": "Error while rendering SDK component: {{error}}",
+    "missingParamsOrContext": "{{component}} is missing {{param}} parameter or is used outside {{provider}}",
+    "unhandledEvent": "Unhandled event type: {{event}}",
+    "unknownEventType": "Unprocessed event type"
+  },
+  "icons": {
+    "selectArrow": "Show options",
+    "magnifyingGlass": "Magnifying glass"
+  },
+  "labels": {
+    "back": "Back",
+    "saveContinue": "Save & continue",
+    "submit": "Submit",
+    "name": "Name",
+    "yes": "Yes",
+    "no": "No"
+  },
+  "onboardingStatus": {
+    "undefined": "N/A",
+    "onboarding_completed": "Completed",
+    "admin_onboarding_incomplete": "Admin-onboarding Incomplete",
+    "self_onboarding_pending_invite": "Self-onboarding: Pending Invite",
+    "self_onboarding_invited": "Self-onboarding: Invited",
+    "self_onboarding_invited_started": "Self-onboarding started",
+    "self_onboarding_invited_overdue": "Self-onboarding: Overdue",
+    "self_onboarding_completed_by_employee": "Self-onboarding: Completed",
+    "self_onboarding_awaiting_admin_review": "Self-onboarding: Admin review"
+  },
+  "validations": {
+    "accountName": "Account name is required",
+    "routingNumber": "Routing number should be a number (9 digits)",
+    "accountNumber": "Account number is a required field",
+    "ssn": "Please enter valid SSN: must be 9 digits",
+    "location": "Location is not valid",
+    "dob": "Date of birth is required"
+  },
+  "statesHash": {
+    "AL": "Alabama",
+    "AK": "Alaska",
+    "AZ": "Arizona",
+    "AR": "Arkansas",
+    "CA": "California",
+    "CO": "Colorado",
+    "CT": "Connecticut",
+    "DE": "Delaware",
+    "FL": "Florida",
+    "GA": "Georgia",
+    "HI": "Hawaii",
+    "ID": "Idaho",
+    "IL": "Illinois",
+    "IN": "Indiana",
+    "IA": "Iowa",
+    "KS": "Kansas",
+    "KY": "Kentucky",
+    "LA": "Louisiana",
+    "ME": "Maine",
+    "MD": "Maryland",
+    "MA": "Massachusetts",
+    "MI": "Michigan",
+    "MN": "Minnesota",
+    "MS": "Mississippi",
+    "MO": "Missouri",
+    "MT": "Montana",
+    "NE": "Nebraska",
+    "NV": "Nevada",
+    "NH": "New Hampshire",
+    "NJ": "New Jersey",
+    "NM": "New Mexico",
+    "NY": "New York",
+    "NC": "North Carolina",
+    "ND": "North Dakota",
+    "OH": "Ohio",
+    "OK": "Oklahoma",
+    "OR": "Oregon",
+    "PA": "Pennsylvania",
+    "RI": "Rhode Island",
+    "SC": "South Carolina",
+    "SD": "South Dakota",
+    "TN": "Tennessee",
+    "TX": "Texas",
+    "UT": "Utah",
+    "VT": "Vermont",
+    "VA": "Virginia",
+    "WA": "Washington",
+    "WV": "West Virginia",
+    "WI": "Wisconsin",
+    "WY": "Wyoming"
+  }
+}
+;
+
+export default _default;

package/dist/src/i18n/index.d.ts

@@ -0,0 +1 @@
+export * from './I18n';

package/dist/src/index.d.ts

@@ -0,0 +1,7 @@
+export { GustoApiContextProvider } from './api/context';
+export * from './api/client';
+export * from './api/queries';
+export * from './api/queries/helpers';
+export * from './components';
+export * from './contexts';
+export * from './types';

package/dist/src/models/PayPeriod.d.ts

@@ -0,0 +1,18 @@
+interface PayPeriodConstructor {
+    payScheduleUuid: string;
+    startDate: Date;
+    endDate: Date;
+}
+export interface PayPeriodAPIData {
+    pay_schedule_uuid: string;
+    start_date: string;
+    end_date: string;
+}
+declare class PayPeriod {
+    payScheduleUuid: string;
+    startDate: Date;
+    endDate: Date;
+    constructor({ payScheduleUuid, startDate, endDate }: PayPeriodConstructor);
+    static fromPayPeriodData(data: PayPeriodAPIData): PayPeriod;
+}
+export { PayPeriod };

package/dist/src/models/Payroll.d.ts

@@ -0,0 +1,40 @@
+import { PayPeriod } from './PayPeriod';
+import { PayrollTotals } from './PayrollTotals';
+interface PayrollConstructor {
+    uuid: string;
+    payPeriod: PayPeriod | null;
+    totals: PayrollTotals | null;
+    processed: boolean;
+    checkDate: Date;
+    payrollDeadline: Date;
+    payrollStatusMeta: PayrollStatusMeta | null;
+}
+declare class Payroll {
+    uuid: string;
+    payPeriod: PayPeriod | null;
+    totals: PayrollTotals | null;
+    processed: boolean;
+    checkDate: Date;
+    payrollDeadline: Date;
+    payrollStatusMeta: PayrollStatusMeta | null;
+    constructor({ uuid, payPeriod, totals, processed, checkDate, payrollDeadline, payrollStatusMeta, }: PayrollConstructor);
+    get expectedDebitDate(): Date;
+}
+interface PayrollStatusMetaConstructor {
+    cancellable: boolean;
+    payrollLate: boolean;
+    expectedCheckDate: Date;
+    initialCheckDate: Date;
+    expectedDebitTime: Date;
+    initialDebitCutoffTime: Date;
+}
+declare class PayrollStatusMeta {
+    cancellable: boolean;
+    payrollLate: boolean;
+    expectedCheckDate: Date;
+    initialCheckDate: Date;
+    expectedDebitTime: Date;
+    initialDebitCutoffTime: Date;
+    constructor({ cancellable, payrollLate, expectedCheckDate, initialCheckDate, expectedDebitTime, initialDebitCutoffTime, }: PayrollStatusMetaConstructor);
+}
+export { Payroll, PayrollStatusMeta };

package/dist/src/models/PayrollTotals.d.ts

@@ -0,0 +1,24 @@
+interface PayrollTotalsConstructor {
+    grossPay?: number;
+    employerTaxes?: number;
+    reimbursements?: number;
+    benefits?: number;
+    companyDebit?: number;
+}
+export interface PayrollTotalsAPIData {
+    gross_pay: string;
+    employer_taxes: string;
+    reimbursements: string;
+    benefits: string;
+}
+declare class PayrollTotals {
+    grossPay?: number;
+    employerTaxes?: number;
+    reimbursements?: number;
+    companyDebit?: number;
+    benefits?: number;
+    constructor({ grossPay, employerTaxes, reimbursements, benefits, companyDebit, }: PayrollTotalsConstructor);
+    static fromPayrollTotalsData(data: PayrollTotalsAPIData): PayrollTotals;
+    get payrollTotal(): number;
+}
+export { PayrollTotals };

package/dist/src/shared/constants.d.ts

@@ -0,0 +1,124 @@
+export declare const employeeEvents: {
+    readonly EMPLOYEE_CREATE: "employee/create";
+    readonly EMPLOYEE_CREATED: "employee/created";
+    readonly EMPLOYEE_UPDATE: "employee/update";
+    readonly EMPLOYEE_UPDATED: "employee/updated";
+    readonly EMPLOYEE_DELETED: "employee/deleted";
+    readonly EMPLOYEE_PROFILE_DONE: "employee/profile/done";
+    readonly VIEW_EMPLOYEE_ADDRESSES: "employee/addresses";
+    readonly EMPLOYEE_HOME_ADDRESS: "employee/addresses/home";
+    readonly EMPLOYEE_HOME_ADDRESS_CREATED: "employee/addresses/home/created";
+    readonly EMPLOYEE_HOME_ADDRESS_UPDATED: "employee/addresses/home/updated";
+    readonly EMPLOYEE_WORK_ADDRESS: "employee/addresses/work";
+    readonly EMPLOYEE_WORK_ADDRESS_CREATED: "employee/addresses/work/created";
+    readonly EMPLOYEE_WORK_ADDRESS_UPDATED: "employee/addresses/work/updated";
+    readonly VIEW_EMPLOYEE_DEDUCTIONS: "employee/deductions";
+    readonly EMPLOYEE_DEDUCTION_CREATE: "employee/deductions/create";
+    readonly EMPLOYEE_DEDUCTION_EDIT: "employee/deductions/edit";
+    readonly EMPLOYEE_DEDUCTION_UPDATED: "employee/deductions/updated";
+    readonly EMPLOYEE_DEDUCTION_DELETED: "employee/deductions/deleted";
+    readonly EMPLOYEE_COMPENSATION_CREATE: "employee/compensations/create";
+    readonly EMPLOYEE_COMPENSATION_CREATED: "employee/compensations/created";
+    readonly EMPLOYEE_COMPENSATION_UPDATED: "employee/compensations/updated";
+    readonly EMPLOYEE_COMPENSATION_DONE: "employee/compensations/done";
+    readonly EMPLOYEE_PAYMENT_METHOD_UPDATED: "employee/paymentMethod/updated";
+    readonly EMPLOYEE_SPLIT_PAYMENT: "employee/paymentMethod/split";
+    readonly EMPLOYEE_BANK_ACCOUNT_CREATE: "employee/bankAccount/create";
+    readonly EMPLOYEE_BANK_ACCOUNT_CREATED: "employee/bankAccount/created";
+    readonly EMPLOYEE_BANK_ACCOUNT_DELETED: "employee/bankAccount/deleted";
+    readonly EMPLOYEE_FEDERAL_TAXES_VIEW: "employee/federalTaxes/view";
+    readonly EMPLOYEE_FEDERAL_TAXES_UPDATED: "employee/federalTaxes/updated";
+    readonly EMPLOYEE_STATE_TAXES_UPDATED: "employee/stateTaxes/updated";
+    readonly EMPLOYEE_TAXES_DONE: "employee/taxes/done";
+    readonly EMPLOYEE_SPLIT_PAYCHECK: "employee/bankAccount/split";
+    readonly EMPLOYEE_JOB_CREATED: "employee/job/created";
+    readonly EMPLOYEE_JOB_UPDATED: "employee/job/updated";
+    readonly EMPLOYEE_SUMMARY_VIEW: "employee/summary";
+    readonly EMPLOYEE_FILE_NEW_HIRE_REPORT: "employee/newHireReport";
+    readonly EMPLOYEES_LIST: "company/employees";
+};
+export declare const companyEvents: {
+    readonly COMPANY_ADDRESSES: "company/addresses";
+    readonly COMPANY_ADDRESSE_EDIT: "company/address/edit";
+    readonly COMPANY_INDUSTRY: "company/industry";
+    readonly COMPANY_FEDERAL_TAXES_UPDATED: "company/federalTaxes/updated";
+};
+export declare const componentEvents: {
+    readonly COMPANY_ADDRESSES: "company/addresses";
+    readonly COMPANY_ADDRESSE_EDIT: "company/address/edit";
+    readonly COMPANY_INDUSTRY: "company/industry";
+    readonly COMPANY_FEDERAL_TAXES_UPDATED: "company/federalTaxes/updated";
+    readonly EMPLOYEE_CREATE: "employee/create";
+    readonly EMPLOYEE_CREATED: "employee/created";
+    readonly EMPLOYEE_UPDATE: "employee/update";
+    readonly EMPLOYEE_UPDATED: "employee/updated";
+    readonly EMPLOYEE_DELETED: "employee/deleted";
+    readonly EMPLOYEE_PROFILE_DONE: "employee/profile/done";
+    readonly VIEW_EMPLOYEE_ADDRESSES: "employee/addresses";
+    readonly EMPLOYEE_HOME_ADDRESS: "employee/addresses/home";
+    readonly EMPLOYEE_HOME_ADDRESS_CREATED: "employee/addresses/home/created";
+    readonly EMPLOYEE_HOME_ADDRESS_UPDATED: "employee/addresses/home/updated";
+    readonly EMPLOYEE_WORK_ADDRESS: "employee/addresses/work";
+    readonly EMPLOYEE_WORK_ADDRESS_CREATED: "employee/addresses/work/created";
+    readonly EMPLOYEE_WORK_ADDRESS_UPDATED: "employee/addresses/work/updated";
+    readonly VIEW_EMPLOYEE_DEDUCTIONS: "employee/deductions";
+    readonly EMPLOYEE_DEDUCTION_CREATE: "employee/deductions/create";
+    readonly EMPLOYEE_DEDUCTION_EDIT: "employee/deductions/edit";
+    readonly EMPLOYEE_DEDUCTION_UPDATED: "employee/deductions/updated";
+    readonly EMPLOYEE_DEDUCTION_DELETED: "employee/deductions/deleted";
+    readonly EMPLOYEE_COMPENSATION_CREATE: "employee/compensations/create";
+    readonly EMPLOYEE_COMPENSATION_CREATED: "employee/compensations/created";
+    readonly EMPLOYEE_COMPENSATION_UPDATED: "employee/compensations/updated";
+    readonly EMPLOYEE_COMPENSATION_DONE: "employee/compensations/done";
+    readonly EMPLOYEE_PAYMENT_METHOD_UPDATED: "employee/paymentMethod/updated";
+    readonly EMPLOYEE_SPLIT_PAYMENT: "employee/paymentMethod/split";
+    readonly EMPLOYEE_BANK_ACCOUNT_CREATE: "employee/bankAccount/create";
+    readonly EMPLOYEE_BANK_ACCOUNT_CREATED: "employee/bankAccount/created";
+    readonly EMPLOYEE_BANK_ACCOUNT_DELETED: "employee/bankAccount/deleted";
+    readonly EMPLOYEE_FEDERAL_TAXES_VIEW: "employee/federalTaxes/view";
+    readonly EMPLOYEE_FEDERAL_TAXES_UPDATED: "employee/federalTaxes/updated";
+    readonly EMPLOYEE_STATE_TAXES_UPDATED: "employee/stateTaxes/updated";
+    readonly EMPLOYEE_TAXES_DONE: "employee/taxes/done";
+    readonly EMPLOYEE_SPLIT_PAYCHECK: "employee/bankAccount/split";
+    readonly EMPLOYEE_JOB_CREATED: "employee/job/created";
+    readonly EMPLOYEE_JOB_UPDATED: "employee/job/updated";
+    readonly EMPLOYEE_SUMMARY_VIEW: "employee/summary";
+    readonly EMPLOYEE_FILE_NEW_HIRE_REPORT: "employee/newHireReport";
+    readonly EMPLOYEES_LIST: "company/employees";
+    readonly SUCCESS: "SUCCESS";
+    readonly ERROR: "ERROR";
+    readonly CANCEL: "CANCEL";
+    readonly SUBMIT: "SUBMIT";
+    readonly LOAD_COMPONENT: "LOAD_COMPONENT";
+    readonly NAVIGATE: "NAVIGATE";
+};
+export type EventType = (typeof componentEvents)[keyof typeof componentEvents];
+export declare const EmployeeOnboardingStatus: {
+    ADMIN_ONBOARDING_INCOMPLETE: string;
+    SELF_ONBOARDING_PENDING_INVITE: string;
+    SELF_ONBOARDING_INVITED: string;
+    SELF_ONBOARDING_INVITED_STARTED: string;
+    SELF_ONBOARDING_INVITED_OVERDUE: string;
+    SELF_ONBOARDING_COMPLETED_BY_EMPLOYEE: string;
+    SELF_ONBOARDING_AWAITING_ADMIN_REVIEW: string;
+    ONBOARDING_COMPLETED: string;
+};
+/**Map of API response flsa statuses */
+export declare const FlsaStatus: {
+    readonly EXEMPT: "Exempt";
+    readonly SALARIED_NONEXEMPT: "Salaried Nonexempt";
+    readonly NONEXEMPT: "Nonexempt";
+    readonly OWNER: "Owner";
+    readonly COMMISSION_ONLY_EXEMPT: "Commission Only Exempt";
+    readonly COMISSION_ONLY_NONEXEMPT: "Commission Only Nonexempt";
+};
+export declare const FLSA_OVERTIME_SALARY_LIMIT = 43888;
+export declare const HOURS_PER_PAY_PERIOD_DAILY = 5.69863;
+export declare const HOURS_PER_PAY_PERIOD_WEEKLY = 40;
+export declare const HOURS_PER_PAY_PERIOD_BIWEEKLY = 80;
+export declare const HOURS_PER_PAY_PERIOD_SEMIMONTHLY = 86.666667;
+export declare const HOURS_PER_PAY_PERIOD_MONTHLY = 173.333333;
+export declare const HOURS_PER_PAY_PERIOD_QUARTERLY = 520;
+export declare const HOURS_PER_PAY_PERIOD_SEMIANNUALLY = 1040;
+export declare const HOURS_PER_PAY_PERIOD_ANNUALLY = 2080;
+export declare const STATES_ABBR: readonly ["AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY"];

package/dist/src/types.d.ts

@@ -0,0 +1,10 @@
+import { components, operations } from './generated/schema';
+export type Schemas = components['schemas'];
+export type Operations = operations;
+export type DeductionType = components['schemas']['Garnishment'];
+export type EmployeeType = components['schemas']['Employee'];
+export type AddressType = components['schemas']['Address'];
+export type PaymentMethodType = components['schemas']['Employee-Payment-Method'];
+export type CompanyFederalTaxDetailsType = components['schemas']['Federal-Tax-Details'];
+export type CompanyIndustryType = components['schemas']['Industry'];
+export type EmployeeFederalTaxType = components['schemas']['Employee-Federal-Tax'];