@remoteoss/remote-flows 1.49.0 → 1.50.0

package/dist/{types-Clzf4xjV.d.ts → types-1IycaCkN.d.ts}

@@ -1,10 +1,10 @@
-import { e as EmploymentCreationResponse, g as EmploymentResponse, S as SuccessResponse, U as UnprocessableEntityResponse, T as TooManyRequestsResponse, z as ConflictResponse, B as BadRequestResponse, F as ForbiddenResponse, N as NotFoundResponse, E as Employment$1, A as File, P as PreOnboardingRequirement, a3 as Company, a as UnauthorizedResponse, ak as EmploymentCreateParams, al as EmploymentFullParams, am as EmploymentEngagementAgreementDetailsParams, an as UnifiedEmploymentUpsertBenefitOffersRequest, ao as ConvertCurrencyResponse, ap as ConvertCurrencyParams, aq as CreateContractEligibilityParams, ar as CreatePreOnboardingDocumentResponse, as as PostV1OnboardingEmploymentsEmploymentIdPreOnboardingRequirementsRequirementSlugDocumentsData, j as Signatory, k as ContractorContractDocumentStatus, at as CreatePreOnboardingAcknowledgementResponse } from './types.gen-BmtA4XNd.js';
+import { f as EmploymentCreationResponse, h as EmploymentResponse, S as SuccessResponse, U as UnprocessableEntityResponse, T as TooManyRequestsResponse, D as ConflictResponse, w as BadRequestResponse, F as ForbiddenResponse, N as NotFoundResponse, E as Employment$1, G as File, P as PreOnboardingRequirement, ak as Company, am as EngagementAgreementDetailsFile, a as UnauthorizedResponse, an as EmploymentCreateParams, ao as EmploymentFullParams, ap as EmploymentEngagementAgreementDetailsParams, aq as UnifiedEmploymentUpsertBenefitOffersRequest, ar as ConvertCurrencyResponse, as as ConvertCurrencyParams, at as CreateContractEligibilityParams, au as CreatePreOnboardingDocumentResponse, av as PostV1OnboardingEmploymentsEmploymentIdPreOnboardingRequirementsRequirementSlugDocumentsData, k as Signatory, l as ContractorContractDocumentStatus, aw as CreatePreOnboardingAcknowledgementResponse } from './types.gen-TcbORUL-.js';
 import * as React$1 from 'react';
 import { OnboardingBack } from './flows/Onboarding/components/OnboardingBack.js';
 import { OnboardingInvite } from './flows/Onboarding/components/OnboardingInvite.js';
-import { N as NormalizedFieldError, S as SuccessResponse$1, E as ErrorResponse } from './mutations-DQjVuza-.js';
+import { N as NormalizedFieldError, S as SuccessResponse$1, E as ErrorResponse } from './mutations-Dg60ZjS0.js';
 import { OnboardingSubmit } from './flows/Onboarding/components/OnboardingSubmit.js';
-import { C as Components, J as JSFFields, N as NestedMeta, a as JSFFieldset } from './remoteFlows-B_JbhzWp.js';
+import { C as Components, J as JSFFields, N as NestedMeta, a as JSFFieldset } from './remoteFlows-7WBvzlJt.js';
 import * as _tanstack_query_core from '@tanstack/query-core';
 import { ValidationResult } from '@remoteoss/remote-json-schema-form-kit';
 import { Step } from './flows/useStepState.js';
@@ -428,9 +428,7 @@ declare const useEmploymentEngagementAgreementDetails: (employmentId: string | u
     break_time_per_day?: number | null;
     business_expenses?: string | null;
     cba?: string | null;
-    cba_document?: {
-        [key: string]: unknown;
-    } | null;
+    cba_document?: Array<EngagementAgreementDetailsFile> | null;
     covenants?: Array<string> | null;
     has_allowances?: string | null;
     has_bonus?: string | null;

package/dist/{types-D3U8Wi3X.d.ts → types-CI8Tx4se.d.ts}

@@ -1,8 +1,8 @@
-import { x as CompanyResponse, N as NotFoundResponse, U as UnprocessableEntityResponse, T as TooManyRequestsResponse, B as BadRequestResponse, a as UnauthorizedResponse } from './types.gen-BmtA4XNd.js';
-import { F as FieldError, N as NormalizedFieldError } from './mutations-DQjVuza-.js';
+import { z as CompanyResponse, N as NotFoundResponse, U as UnprocessableEntityResponse, T as TooManyRequestsResponse, w as BadRequestResponse, a as UnauthorizedResponse } from './types.gen-TcbORUL-.js';
+import { F as FieldError, N as NormalizedFieldError } from './mutations-Dg60ZjS0.js';
 import * as React$1 from 'react';
 import { FieldValues } from 'react-hook-form';
-import { J as JSFFields, M as Meta, a as JSFFieldset } from './remoteFlows-B_JbhzWp.js';
+import { J as JSFFields, M as Meta, a as JSFFieldset } from './remoteFlows-7WBvzlJt.js';
 import { ValidationResult } from '@remoteoss/remote-json-schema-form-kit';
 import { FlowOptions, JSFModify } from './flows/types.js';
 import { CreateCompanySubmit } from './flows/CreateCompany/components/CreateCompanySubmit.js';

package/dist/{types-B93nzmoE.d.ts → types-CJHW5xRl.d.ts}

@@ -1,4 +1,4 @@
-import { L as ListTimeoffResponse, J as TimeoffStatus, K as TimeoffType, Q as ListLeavePoliciesSummaryResponse, E as Employment } from './types.gen-BmtA4XNd.js';
+import { L as ListTimeoffResponse, Q as TimeoffStatus, W as TimeoffType, X as ListLeavePoliciesSummaryResponse, E as Employment } from './types.gen-TcbORUL-.js';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseQueryResult } from '@tanstack/react-query';
 import { BookedTimeoffBeforeDateResponse, SummaryTimeOffDataResponse } from './flows/Termination/api.js';

package/dist/{types-1mH_uuoA.d.ts → types-CT7w2kHS.d.ts}

@@ -1,6 +1,6 @@
-import { O as OffboardingResponse, X as PayrollCalendarEor, E as Employment, G as TerminationDetailsParams, N as NotFoundResponse, U as UnprocessableEntityResponse, T as TooManyRequestsResponse, B as BadRequestResponse, a as UnauthorizedResponse, R as RequestError } from './types.gen-BmtA4XNd.js';
+import { O as OffboardingResponse, ae as PayrollCalendarEor, E as Employment, I as TerminationDetailsParams, N as NotFoundResponse, U as UnprocessableEntityResponse, T as TooManyRequestsResponse, w as BadRequestResponse, a as UnauthorizedResponse, R as RequestError } from './types.gen-TcbORUL-.js';
 import * as React$1 from 'react';
-import { E as ErrorResponse, S as SuccessResponse } from './mutations-DQjVuza-.js';
+import { E as ErrorResponse, S as SuccessResponse } from './mutations-Dg60ZjS0.js';
 import * as _remoteoss_json_schema_form from '@remoteoss/json-schema-form';
 import * as _remoteoss_json_schema_form_v0_deprecated from '@remoteoss/json-schema-form-v0-deprecated';
 import { Step } from './flows/useStepState.js';

package/dist/{types-CdC2MYpf.d.ts → types-CgNwKzZf.d.ts}

@@ -1,12 +1,12 @@
 import { FlowOptions, JSONSchemaFormResultWithFieldsets, GPStepCallbacks } from './flows/types.js';
 import * as React$1 from 'react';
-import { l as CompanyLegalEntity, H as Step$1, e as EmploymentCreationResponse, D as EmploymentDetailsOnlyResponse } from './types.gen-BmtA4XNd.js';
-import './remoteFlows-B_JbhzWp.js';
-import { FieldValues } from 'react-hook-form';
+import { m as CompanyLegalEntity, J as Step$1, f as EmploymentCreationResponse, H as EmploymentDetailsOnlyResponse } from './types.gen-TcbORUL-.js';
+import './remoteFlows-7WBvzlJt.js';
 import * as _remoteoss_json_schema_form from '@remoteoss/json-schema-form';
+import * as _tanstack_query_core from '@tanstack/query-core';
+import { FieldValues } from 'react-hook-form';
 import * as _remoteoss_json_schema_form_v0_deprecated from '@remoteoss/json-schema-form-v0-deprecated';
 import { Step } from './flows/useStepState.js';
-import * as _tanstack_query_core from '@tanstack/query-core';
 
 type AdminStepKey = 'select_country' | 'contract_details' | 'administrative_details' | 'invite';
 declare const usePayrollAdminOnboarding: ({ companyId, legalEntityId: providedLegalEntityId, countryCode: initialCountryCode, employmentId: initialEmploymentId, initialValues, options, }: Omit<PayrollAdminOnboardingFlowProps, "render">) => {

package/dist/{types-BFzhRUSU.d.ts → types-DPlWZa2M.d.ts}

@@ -1,12 +1,12 @@
 import { FlowOptions, JSONSchemaFormResultWithFieldsets, GPStepCallbacks } from './flows/types.js';
 import * as React$1 from 'react';
-import { H as Step$1, I as SubStep, S as SuccessResponse, D as EmploymentDetailsOnlyResponse } from './types.gen-BmtA4XNd.js';
-import './remoteFlows-B_JbhzWp.js';
-import { FieldValues } from 'react-hook-form';
+import { J as Step$1, K as SubStep, S as SuccessResponse, H as EmploymentDetailsOnlyResponse } from './types.gen-TcbORUL-.js';
+import './remoteFlows-7WBvzlJt.js';
 import * as _remoteoss_json_schema_form from '@remoteoss/json-schema-form';
+import * as _tanstack_query_core from '@tanstack/query-core';
+import { FieldValues } from 'react-hook-form';
 import * as _remoteoss_json_schema_form_v0_deprecated from '@remoteoss/json-schema-form-v0-deprecated';
 import { Step } from './flows/useStepState.js';
-import * as _tanstack_query_core from '@tanstack/query-core';
 
 type EmployeeStepKey = 'personal_details' | 'home_address' | 'bank_account' | 'federal_taxes' | 'state_taxes';
 declare const usePayrollEmployeeOnboarding: ({ employmentId, countryCode: countryCodeProp, jurisdiction: jurisdictionProp, initialValues, options, }: Omit<PayrollEmployeeOnboardingFlowProps, "render">) => {

package/dist/{types-CoYsxVTI.d.ts → types-DmvLgred.d.ts}

@@ -1,5 +1,5 @@
 import { FieldValues } from 'react-hook-form';
-import { a as JSFFieldset } from './remoteFlows-B_JbhzWp.js';
+import { a as JSFFieldset } from './remoteFlows-7WBvzlJt.js';
 import * as _remoteoss_json_schema_form_v0_deprecated from '@remoteoss/json-schema-form-v0-deprecated';
 import * as _remoteoss_json_schema_form from '@remoteoss/json-schema-form';
 import { JsonSchemaPlaygroundForm } from './flows/JsonSchemaPlayground/JsonSchemaPlaygroundForm.js';

package/dist/types.gen-Dtb8ECVb.d.ts

@@ -0,0 +1,308 @@
+type AuthToken = string | undefined;
+interface Auth {
+    /**
+     * Which part of the request do we use to send the auth?
+     *
+     * @default 'header'
+     */
+    in?: 'header' | 'query' | 'cookie';
+    /**
+     * Header or query parameter name.
+     *
+     * @default 'Authorization'
+     */
+    name?: string;
+    scheme?: 'basic' | 'bearer';
+    type: 'apiKey' | 'http';
+}
+
+interface SerializerOptions<T> {
+    /**
+     * @default true
+     */
+    explode: boolean;
+    style: T;
+}
+type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited';
+type ObjectStyle = 'form' | 'deepObject';
+
+type QuerySerializer = (query: Record<string, unknown>) => string;
+type BodySerializer = (body: unknown) => unknown;
+type QuerySerializerOptionsObject = {
+    allowReserved?: boolean;
+    array?: Partial<SerializerOptions<ArrayStyle>>;
+    object?: Partial<SerializerOptions<ObjectStyle>>;
+};
+type QuerySerializerOptions = QuerySerializerOptionsObject & {
+    /**
+     * Per-parameter serialization overrides. When provided, these settings
+     * override the global array/object settings for specific parameter names.
+     */
+    parameters?: Record<string, QuerySerializerOptionsObject>;
+};
+
+type HttpMethod = 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace';
+type Client$1<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
+    /**
+     * Returns the final request URL.
+     */
+    buildUrl: BuildUrlFn;
+    getConfig: () => Config;
+    request: RequestFn;
+    setConfig: (config: Config) => Config;
+} & {
+    [K in HttpMethod]: MethodFn;
+} & ([SseFn] extends [never] ? {
+    sse?: never;
+} : {
+    sse: {
+        [K in HttpMethod]: SseFn;
+    };
+});
+interface Config$1 {
+    /**
+     * Auth token or a function returning auth token. The resolved value will be
+     * added to the request payload as defined by its `security` array.
+     */
+    auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
+    /**
+     * A function for serializing request body parameter. By default,
+     * {@link JSON.stringify()} will be used.
+     */
+    bodySerializer?: BodySerializer | null;
+    /**
+     * An object containing any HTTP headers that you want to pre-populate your
+     * `Headers` object with.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
+     */
+    headers?: RequestInit['headers'] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
+    /**
+     * The request method.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
+     */
+    method?: Uppercase<HttpMethod>;
+    /**
+     * A function for serializing request query parameters. By default, arrays
+     * will be exploded in form style, objects will be exploded in deepObject
+     * style, and reserved characters are percent-encoded.
+     *
+     * This method will have no effect if the native `paramsSerializer()` Axios
+     * API function is used.
+     *
+     * {@link https://swagger.io/docs/specification/serialization/#query View examples}
+     */
+    querySerializer?: QuerySerializer | QuerySerializerOptions;
+    /**
+     * A function validating request data. This is useful if you want to ensure
+     * the request conforms to the desired shape, so it can be safely sent to
+     * the server.
+     */
+    requestValidator?: (data: unknown) => Promise<unknown>;
+    /**
+     * A function transforming response data before it's returned. This is useful
+     * for post-processing data, e.g., converting ISO strings into Date objects.
+     */
+    responseTransformer?: (data: unknown) => Promise<unknown>;
+    /**
+     * A function validating response data. This is useful if you want to ensure
+     * the response conforms to the desired shape, so it can be safely passed to
+     * the transformers and returned to the user.
+     */
+    responseValidator?: (data: unknown) => Promise<unknown>;
+}
+
+type ServerSentEventsOptions<TData = unknown> = Omit<RequestInit, 'method'> & Pick<Config$1, 'method' | 'responseTransformer' | 'responseValidator'> & {
+    /**
+     * Fetch API implementation. You can use this option to provide a custom
+     * fetch instance.
+     *
+     * @default globalThis.fetch
+     */
+    fetch?: typeof fetch;
+    /**
+     * Implementing clients can call request interceptors inside this hook.
+     */
+    onRequest?: (url: string, init: RequestInit) => Promise<Request>;
+    /**
+     * Callback invoked when a network or parsing error occurs during streaming.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @param error The error that occurred.
+     */
+    onSseError?: (error: unknown) => void;
+    /**
+     * Callback invoked when an event is streamed from the server.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @param event Event streamed from the server.
+     * @returns Nothing (void).
+     */
+    onSseEvent?: (event: StreamEvent<TData>) => void;
+    serializedBody?: RequestInit['body'];
+    /**
+     * Default retry delay in milliseconds.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @default 3000
+     */
+    sseDefaultRetryDelay?: number;
+    /**
+     * Maximum number of retry attempts before giving up.
+     */
+    sseMaxRetryAttempts?: number;
+    /**
+     * Maximum retry delay in milliseconds.
+     *
+     * Applies only when exponential backoff is used.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @default 30000
+     */
+    sseMaxRetryDelay?: number;
+    /**
+     * Optional sleep function for retry backoff.
+     *
+     * Defaults to using `setTimeout`.
+     */
+    sseSleepFn?: (ms: number) => Promise<void>;
+    url: string;
+};
+interface StreamEvent<TData = unknown> {
+    data: TData;
+    event?: string;
+    id?: string;
+    retry?: number;
+}
+type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> = {
+    stream: AsyncGenerator<TData extends Record<string, unknown> ? TData[keyof TData] : TData, TReturn, TNext>;
+};
+
+type ErrInterceptor<Err, Res, Req, Options> = (error: Err, response: Res, request: Req, options: Options) => Err | Promise<Err>;
+type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
+type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
+declare class Interceptors<Interceptor> {
+    fns: Array<Interceptor | null>;
+    clear(): void;
+    eject(id: number | Interceptor): void;
+    exists(id: number | Interceptor): boolean;
+    getInterceptorIndex(id: number | Interceptor): number;
+    update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
+    use(fn: Interceptor): number;
+}
+interface Middleware<Req, Res, Err, Options> {
+    error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
+    request: Interceptors<ReqInterceptor<Req, Options>>;
+    response: Interceptors<ResInterceptor<Res, Req, Options>>;
+}
+
+type ResponseStyle = 'data' | 'fields';
+interface Config<T extends ClientOptions = ClientOptions> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Config$1 {
+    /**
+     * Base URL for all requests made by this client.
+     */
+    baseUrl?: T['baseUrl'];
+    /**
+     * Fetch API implementation. You can use this option to provide a custom
+     * fetch instance.
+     *
+     * @default globalThis.fetch
+     */
+    fetch?: typeof fetch;
+    /**
+     * Please don't use the Fetch client for Next.js applications. The `next`
+     * options won't have any effect.
+     *
+     * Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
+     */
+    next?: never;
+    /**
+     * Return the response data parsed in a specified format. By default, `auto`
+     * will infer the appropriate method from the `Content-Type` response header.
+     * You can override this behavior with any of the {@link Body} methods.
+     * Select `stream` if you don't want to parse response data at all.
+     *
+     * @default 'auto'
+     */
+    parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
+    /**
+     * Should we return only data or multiple fields (data, error, response, etc.)?
+     *
+     * @default 'fields'
+     */
+    responseStyle?: ResponseStyle;
+    /**
+     * Throw an error instead of returning it in the response?
+     *
+     * @default false
+     */
+    throwOnError?: T['throwOnError'];
+}
+interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
+    responseStyle: TResponseStyle;
+    throwOnError: ThrowOnError;
+}>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
+    /**
+     * Any body that you want to add to your request.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
+     */
+    body?: unknown;
+    path?: Record<string, unknown>;
+    query?: Record<string, unknown>;
+    /**
+     * Security mechanism(s) to use for the request.
+     */
+    security?: ReadonlyArray<Auth>;
+    url: Url;
+}
+interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
+    serializedBody?: string;
+}
+type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
+    data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
+    request: Request;
+    response: Response;
+}> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
+    data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
+    error: undefined;
+} | {
+    data: undefined;
+    error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
+}) & {
+    request: Request;
+    response: Response;
+}>;
+interface ClientOptions {
+    baseUrl?: string;
+    responseStyle?: ResponseStyle;
+    throwOnError?: boolean;
+}
+type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
+type SseFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
+type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
+type BuildUrlFn = <TData extends {
+    body?: unknown;
+    path?: Record<string, unknown>;
+    query?: Record<string, unknown>;
+    url: string;
+}>(options: TData & Options<TData>) => string;
+type Client = Client$1<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
+    interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
+};
+interface TDataShape {
+    body?: unknown;
+    headers?: unknown;
+    path?: unknown;
+    query?: unknown;
+    url: string;
+}
+type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
+type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
+
+export type { Client as C };