@gusto/embedded-react-sdk 0.55.5 → 0.55.7

package/dist/helpers/dateFormatting.d.ts

@@ -1,186 +0,0 @@
-/**
- * Normalizes any date input (string, Date, or undefined) to a Date object.
- *
- * @remarks Handles `YYYY-MM-DD` strings by parsing them in local time to avoid
- * timezone drift. Also accepts ISO timestamp strings and existing `Date`
- * instances. Returns `null` for nullish, empty, or unparseable input.
- *
- * @param dateInput - The date value to normalize.
- * @returns A `Date` instance, or `null` if the input is missing or invalid.
- * @internal
- */
-export declare const normalizeToDate: (dateInput?: string | Date | null) => Date | null;
-/**
- * Formats a date as a short weekday plus short month and day (e.g. `Mon, Jan 5`).
- *
- * @internal
- */
-export declare const formatDateShortWithWeekday: (dateInput?: string | Date | null, locale?: string) => string;
-/**
- * Formats a date as a short weekday, short month, day, and year (e.g. `Mon, Jan 5, 2025`).
- *
- * @internal
- */
-export declare const formatDateShortWithWeekdayAndYear: (dateInput?: string | Date | null, locale?: string) => string;
-/**
- * Formats a date as a short month and day (e.g. `Jan 5`).
- *
- * @internal
- */
-export declare const formatDateShort: (dateInput?: string | Date | null, locale?: string) => string;
-/**
- * Formats a date as a short month, day, and year (e.g. `Jan 5, 2025`).
- *
- * @internal
- */
-export declare const formatDateShortWithYear: (dateInput?: string | Date | null, locale?: string) => string;
-/**
- * Formats a date as a long month and day (e.g. `January 5`).
- *
- * @internal
- */
-export declare const formatDateLong: (dateInput?: string | Date | null, locale?: string) => string;
-/**
- * Formats a date as a long month, day, and year (e.g. `January 5, 2025`).
- *
- * @internal
- */
-export declare const formatDateLongWithYear: (dateInput?: string | Date | null, locale?: string) => string;
-/**
- * Splits a date into separate locale-formatted time and date strings.
- *
- * @param dateInput - The date value to format.
- * @param locale - Optional BCP 47 locale tag passed to `toLocaleString`.
- * @returns An object with `time` (e.g. `3:45 PM EST`) and `date` (e.g. `Mon, Jan 5`).
- * Both fields are empty strings when the input cannot be parsed.
- * @internal
- */
-export declare const formatDateWithTime: (dateInput?: string | Date | null, locale?: string) => {
-    time: string;
-    date: string;
-};
-/**
- * Formats a pay period start and end date for display as separate fields.
- *
- * @remarks Start date renders with the long month and day; end date renders
- * with the short month, day, and year.
- *
- * @param startDateInput - Pay period start date.
- * @param endDateInput - Pay period end date.
- * @param locale - Optional BCP 47 locale tag passed to `toLocaleDateString`.
- * @returns Formatted `startDate` and `endDate` strings. Both fields are empty
- * strings when either input cannot be parsed.
- * @internal
- */
-export declare const formatPayPeriod: (startDateInput?: string | Date | null, endDateInput?: string | Date | null, locale?: string) => {
-    startDate: string;
-    endDate: string;
-};
-/**
- * Formats a pay period as a single en-dash–separated range string.
- *
- * @param startDateInput - Pay period start date.
- * @param endDateInput - Pay period end date.
- * @param locale - Optional BCP 47 locale tag passed to `toLocaleDateString`.
- * @param options - When `useShortMonth` is true, both ends use short month names.
- * Otherwise the start uses the long month name and the end uses short.
- * @returns The formatted range (e.g. `January 1–Jan 15, 2025`), or an empty
- * string when either input cannot be parsed.
- * @internal
- */
-export declare const formatPayPeriodRange: (startDateInput?: string | Date | null, endDateInput?: string | Date | null, locale?: string, options?: {
-    useShortMonth?: boolean;
-}) => string;
-/**
- * Formats a `Date` as a `YYYY-MM-DD` string using the local year, month, and day.
- *
- * @param date - The date to format.
- * @returns A zero-padded `YYYY-MM-DD` string, or `null` when the input is an invalid date.
- * @internal
- */
-export declare const formatDateToStringDate: (date: Date) => string | null;
-/**
- * Converts any parseable date string to a `YYYY-MM-DD` ISO string using local time.
- *
- * @remarks Reads the local year, month, and day so the calendar date is
- * preserved regardless of the runtime timezone. Safe for dates parsed from
- * locale-format strings (e.g. `4/16/1998`) or ISO strings, both of which land
- * at local midnight when normalized.
- *
- * @param value - The date string to convert.
- * @returns A `YYYY-MM-DD` string, or `''` for nullish, empty, or unparseable input.
- * @internal
- */
-export declare const normalizeToISOString: (value?: string | null) => string;
-/**
- * Normalizes a `Date` to local midnight, stripping any time-of-day component.
- *
- * @param date - The date to normalize, or `null`.
- * @returns A new `Date` at local midnight, or `null` when the input is missing or invalid.
- * @internal
- */
-export declare const normalizeDateToLocal: (date: Date | null) => Date | null;
-/**
- * Number of milliseconds in one hour.
- *
- * @internal
- */
-export declare const MS_PER_HOUR: number;
-/**
- * Returns the number of hours from now until a deadline.
- *
- * @param deadline - Target date in the future (or past, for negative results).
- * @returns Hours until `deadline` (fractional, negative if `deadline` is in
- * the past), or `null` when the input cannot be parsed.
- * @internal
- */
-export declare const getHoursUntil: (deadline?: Date | string | null) => number | null;
-/**
- * Returns the number of days from now until a deadline.
- *
- * @param deadline - Target date in the future (or past, for negative results).
- * @returns Days until `deadline` (fractional, negative if `deadline` is in
- * the past), or `null` when the input cannot be parsed.
- * @internal
- */
-export declare const getDaysUntil: (deadline?: Date | string | null) => number | null;
-/**
- * Returns a new `Date` offset from the input by a given number of days.
- *
- * @param date - The base date. Not mutated.
- * @param days - Number of days to add (negative values subtract).
- * @returns A new `Date` shifted by `days`.
- * @internal
- */
-export declare const addDays: (date: Date, days: number) => Date;
-/**
- * Returns a new `Date` offset by a given number of business days (Monday–Friday).
- *
- * @remarks Skips Saturdays and Sundays when counting. The result is normalized
- * to local midnight. Does not account for holidays.
- *
- * @param startDate - The base date. Not mutated.
- * @param businessDays - Number of business days to add.
- * @returns A new `Date` shifted forward by `businessDays` weekdays.
- * @internal
- */
-export declare const addBusinessDays: (startDate: Date, businessDays: number) => Date;
-/**
- * Formats numeric month and day as a zero-padded `MM-DD` string.
- *
- * @param month - Month number, 1–12.
- * @param day - Day-of-month number, 1–31.
- * @returns A `MM-DD` string, or `undefined` when either argument is missing.
- * @internal
- */
-export declare function formatMonthDay(month?: number, day?: number): string | undefined;
-/**
- * Returns the number of days in a given month (1-indexed).
- *
- * @remarks Uses a non-leap year, so February always returns 28.
- *
- * @param month - Month number, 1–12.
- * @returns The number of days in that month.
- * @internal
- */
-export declare function getDaysInMonth(month: number): number;

package/dist/helpers/formattedStrings.d.ts

@@ -1,181 +0,0 @@
-import { Location } from '@gusto/embedded-api/models/components/location';
-import { EmployeeAddress } from '@gusto/embedded-api/models/components/employeeaddress';
-import { TFunction } from 'i18next';
-/**
- * Joins a first and last name into a single capitalized display string.
- *
- * @remarks Each name part is capitalized at its first character. A space is
- * inserted between the parts only when the last name is present. Missing
- * parts are treated as empty.
- *
- * @param name - Object with optional `first_name` and `last_name` fields.
- * @returns The combined name, e.g. `Jane Doe`, `Jane`, or `''`.
- * @internal
- */
-export declare const firstLastName: ({ first_name, last_name, }: {
-    first_name?: string | null;
-    last_name?: string | null;
-}) => string;
-/**
- * Combines an address's two street lines with a comma separator.
- *
- * @remarks Each line is prefixed with a leading space when present, producing
- * a string like ` 123 Main St, Apt 4`. Prefer {@link formatStreetForDisplay}
- * for new display code; this function is retained for legacy callers.
- *
- * @param address - Address whose `street1` and `street2` are joined.
- * @returns The joined street string.
- * @internal
- */
-export declare const getStreet: (address: EmployeeAddress | Location) => string;
-/**
- * Joins an address's street lines with a comma for display.
- *
- * @remarks Trims each line and skips empty values, avoiding the leading-space
- * and trailing-comma artifacts of {@link getStreet}.
- *
- * @param address - Address whose `street1` and `street2` are joined.
- * @returns The display-formatted street string, e.g. `123 Main St, Apt 4`.
- * @internal
- */
-export declare const formatStreetForDisplay: (address: EmployeeAddress | Location) => string;
-/**
- * Formats an address's city, state, and zip into a single display string.
- *
- * @param address - Address whose `city`, `state`, and `zip` are joined.
- * @returns A `City, State Zip` string. Empty fields are skipped.
- * @internal
- */
-export declare const getCityStateZip: (address: EmployeeAddress | Location) => string;
-/**
- * Formats a full address as a single inline string.
- *
- * @param address - The address to format.
- * @returns The combined street and city/state/zip string.
- * @internal
- */
-export declare const addressInline: (address: EmployeeAddress | Location) => string;
-/**
- * Formats a number as a USD currency string with two decimal places.
- *
- * @param amount - The numeric value to format.
- * @param locale - Optional BCP 47 locale tag passed to `toLocaleString`.
- * Defaults to `en-US`.
- * @returns A `$1,234.56` style currency string.
- * @internal
- */
-export declare const formatNumberAsCurrency: (amount: number, locale?: string) => string;
-/**
- * Formats a pay rate with its payment unit, annualizing weekly and monthly values.
- *
- * @remarks Hourly, yearly, and paycheck rates are displayed at the input
- * value. Weekly rates are multiplied by 52 and monthly rates by 12 to express
- * an annualized amount. Unknown payment units render as the currency value
- * alone.
- *
- * @param args - Formatting inputs: `rate` (numeric value), `paymentUnit`
- * (`Hour`, `Week`, `Month`, `Year`, or `Paycheck`), `t` (i18next translation
- * function), and optional `locale` (BCP 47 tag, default `en-US`).
- * @returns The translated, formatted pay rate string.
- * @internal
- */
-export declare const formatPayRate: ({ rate, paymentUnit, t, locale, }: {
-    rate: number;
-    paymentUnit: string;
-    t: TFunction;
-    locale?: string;
-}) => string;
-/**
- * Formats a compensation rate as-is, without annualizing weekly or monthly values.
- *
- * @remarks Use for displaying compensation card data where the stored rate
- * should be shown directly (e.g. `$950 per week`, `$3,500 per month`).
- * Unknown payment units render as the currency value alone.
- *
- * @param args - Formatting inputs: `rate` (numeric value), `paymentUnit`
- * (`Hour`, `Week`, `Month`, `Year`, or `Paycheck`), `t` (i18next translation
- * function), and optional `locale` (BCP 47 tag, default `en-US`).
- * @returns The translated, formatted compensation rate string.
- * @internal
- */
-export declare const formatCompensationRate: ({ rate, paymentUnit, t, locale, }: {
-    rate: number;
-    paymentUnit: string;
-    t: TFunction;
-    locale?: string;
-}) => string;
-/**
- * Hook that returns a memoized {@link formatCompensationRate} bound to the active locale.
- *
- * @returns A callback `(rate, paymentUnit) => string`.
- * @internal
- */
-export declare const useFormatCompensationRate: () => (rate: number, paymentUnit: string) => string;
-/**
- * Sanitizes an HTML string for use with React's `dangerouslySetInnerHTML`.
- *
- * @remarks Only `<a>`, `<b>`, and `<strong>` tags are allowed, and `<a>`
- * elements may retain only `href` and `target` attributes. All other markup
- * is stripped via DOMPurify.
- *
- * @param dirty - The raw HTML string to sanitize.
- * @returns An object shaped for `dangerouslySetInnerHTML`. The `__html`
- * field is `''` when the input is empty.
- * @internal
- */
-export declare function createMarkup(dirty: string): {
-    __html: string;
-};
-/**
- * Removes all non-digit characters from a string.
- *
- * @param value - The string to filter.
- * @returns The input with only the digit characters `0`–`9` retained.
- * @internal
- */
-export declare const removeNonDigits: (value: string) => string;
-/**
- * Strips the trailing `.value` segment from an API error path.
- *
- * @remarks API validation errors target a `.value` field on the inner
- * object, but react-hook-form registers the field under its bare name.
- * Stripping `.value` aligns the error path with the form field name.
- *
- * @param errorKey - The dotted error path returned by the API.
- * @returns The error key without a trailing `.value`.
- * @internal
- */
-export declare const normalizeErrorKeyForForm: (errorKey: string) => string;
-/**
- * Converts a `snake_case` string to `camelCase`.
- *
- * @param s - The snake_case string to convert.
- * @returns The camelCase equivalent.
- * @internal
- */
-export declare const snakeCaseToCamelCase: (s: string) => string;
-/**
- * Converts a `camelCase` or `PascalCase` string to `snake_case`.
- *
- * @remarks Handles consecutive uppercase letters by inserting a separator
- * before the final letter of a run that is followed by a lowercase letter
- * (e.g. `HTMLParser` becomes `html_parser`).
- *
- * @param s - The camelCase or PascalCase string to convert.
- * @returns The snake_case equivalent in lower case.
- * @internal
- */
-export declare const camelCaseToSnakeCase: (s: string) => string;
-/**
- * Formats a US phone number as `NNN-NNN-NNNN` for display.
- *
- * @remarks Strips non-digit characters before formatting. A leading `1`
- * country code on 11-digit inputs is dropped. Inputs that are not 10 or 11
- * digits are returned as the raw digit string. Returns an empty string for
- * nullish input.
- *
- * @param phoneNumber - The phone number to format.
- * @returns The formatted phone number, the digit-only fallback, or `''`.
- * @internal
- */
-export declare const formatPhoneNumber: (phoneNumber: string | number | null | undefined) => string;

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

@@ -1,197 +0,0 @@
-declare const _default: {
-  "status": {
-    "loading": "Loading component...",
-    "loadingOptions": "Loading options...",
-    "requiredField": "is a required field",
-    "errorEncountered": "There was a problem with your submission",
-    "multipleErrorsEncountered": "There were multiple problems with your submission"
-  },
-  "optionalLabel": "(optional)",
-  "selectPlaceholder": "Select an option...",
-  "progressBarLabel": "You are on step {{currentStep}} of {{totalSteps}}",
-  "back": "Back",
-  "errors": {
-    "errorHeading": "Error",
-    "globalReactError": "Error while rendering SDK component: {{error}}",
-    "resetGlobalError": "Try again",
-    "unknownError": "Unknown Error",
-    "missingParamsOrContext": "{{component}} is missing {{param}} parameter or is used outside {{provider}}",
-    "unhandledEvent": "Unhandled event type: {{event}}",
-    "unknownEventType": "Unprocessed event type",
-    "ensureRequired": "Required prop is missing"
-  },
-  "icons": {
-    "selectArrow": "Show options",
-    "calendarArrow": "Show calendar",
-    "nextMonth": "Show next month",
-    "previousMonth": "Show previous month",
-    "paginationFirst": "Navigate to first page",
-    "paginationPrev": "Navigate to previous page",
-    "paginationNext": "Navigate to next page",
-    "paginationLast": "Navigate to last page"
-  },
-  "labels": {
-    "paginationControlCountLabel": "Items per page",
-    "paginationFetchingLabel": "Fetching data...",
-    "openMenu": "Open menu",
-    "menuLabel": "Menu",
-    "tabNavigation": "Tab navigation",
-    "selectedItems": "Selected {{label}}",
-    "removeItem": "Remove {{label}}"
-  },
-  "onboardingStatus": {
-    "contractor": {
-      "undefined": "N/A",
-      "admin_onboarding_incomplete": "Admin-onboarding Incomplete",
-      "admin_onboarding_review": "Admin-onboarding review",
-      "onboarding_completed": "Completed",
-      "self_onboarding_not_invited": "Self-onboarding: Not Invited",
-      "self_onboarding_invited": "Self-onboarding: Invited",
-      "self_onboarding_started": "Self-onboarding started",
-      "self_onboarding_review": "Self-onboarding: Review"
-    },
-    "employee": {
-      "undefined": "N/A",
-      "admin_onboarding_incomplete": "Admin-onboarding Incomplete",
-      "onboarding_completed": "Completed",
-      "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"
-    }
-  },
-  "inputs": {
-    "ssn": {
-      "placeholder": "***-**-****"
-    },
-    "ein": {
-      "placeholder": "**-*******"
-    },
-    "workersCompensationRatePerHourAdornment": "/hr"
-  },
-  "payRateFormats": {
-    "hourly": "{{amount}}/hr",
-    "weekly": "{{amount}}/yr",
-    "monthly": "{{amount}}/yr",
-    "yearly": "{{amount}}/yr",
-    "paycheck": "{{amount}}/paycheck"
-  },
-  "compensationRateFormats": {
-    "hourly": "{{amount}} per hour",
-    "weekly": "{{amount}} per week",
-    "monthly": "{{amount}} per month",
-    "yearly": "{{amount}} per year",
-    "paycheck": "{{amount}} per paycheck"
-  },
-  "validations": {
-    "accountName": "Account name is required",
-    "routingNumber": "Routing number should be a number (9 digits)",
-    "accountNumber": "Account number is a required field",
-    "ssn": "The SSN must be exactly 9 digits long, cannot contain all zeros in any group, and the first three digits cannot be '666' or in the range 900–999.",
-    "ssnRequired": "Social Security Number is required",
-    "location": "Location is not valid",
-    "dob": "Date of birth is required",
-    "percentageMin": "Minimum value is {{min}}%",
-    "percentageMax": "Maximum value is {{max}}%"
-  },
-  "statesHash": {
-    "AL": "Alabama",
-    "AK": "Alaska",
-    "AZ": "Arizona",
-    "AR": "Arkansas",
-    "CA": "California",
-    "CO": "Colorado",
-    "CT": "Connecticut",
-    "DE": "Delaware",
-    "DC": "District of Columbia",
-    "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"
-  },
-  "table": {
-    "selectRowHeader": "Select row",
-    "selectRowLabel": "Select row",
-    "selectAllRowsLabel": "Select all rows",
-    "actionsColumnHeader": "Actions"
-  },
-  "card": {
-    "selectRowLabel": "Select row",
-    "selectAllRowsLabel": "Select all rows"
-  },
-  "signatoryTitles": {
-    "owner": "Owner",
-    "president": "President",
-    "vice_president": "Vice President",
-    "treasurer": "Treasurer",
-    "corporate_officer": "Corporate Officer",
-    "partner": "Partner",
-    "member": "Member"
-  },
-  "fileInput": {
-    "uploadInstructions": "<clickToUpload>Click to upload</clickToUpload> or drag and drop",
-    "acceptedTypes": "Only {{types}} files are permitted",
-    "removeFile": "Remove file"
-  },
-  "reorderableList": {
-    "itemMovedDown": "Item {{item}} moved down to position {{position}} of {{total}}",
-    "itemMovedUp": "Item {{item}} moved up to position {{position}} of {{total}}",
-    "dragStarted": "Started dragging item {{item}}",
-    "dragEnded": "Finished dragging item {{item}}",
-    "movedUp": "Item {{item}} moved up to position {{position}} of {{total}}",
-    "movedDown": "Item {{item}} moved down to position {{position}} of {{total}}",
-    "reorderingCanceled": "Reordering mode canceled for item {{item}}",
-    "reorderingExited": "Exited reordering mode for item {{item}}",
-    "reorderingStarted": "Entered reordering mode for item {{item}}. Use arrow keys to move, Escape to cancel, or Space to finish.",
-    "reorderingComplete": "Reordering complete for item {{item}}",
-    "draggableLabel": "Press Space or Enter to start reordering item {{item}}",
-    "draggableLabelActive": "Press arrow keys to move item {{item}}, or press Space/Enter to finish reordering",
-    "draggablePosition": "Item {{item}} at position {{position}} of {{total}}",
-    "item": "Item {{position}}",
-    "dropItemHere": "Drop item here",
-    "draggableItem": "Draggable item"
-  }
-}
-;
-
-export default _default;