@onlive.ai/flow-client 0.1.34 → 0.1.35

package/client/client.service.d.cts

@@ -0,0 +1,71 @@
+import '@onlive.ai/tracker';
+import TrackingService from '../tracking/tracking.service.cjs';
+import { ClientOptions, GetStepOptions, FlowContext, GetStepTrigger } from './client.types.cjs';
+import '../tracking/tracking.types.cjs';
+import 'zod';
+
+/**
+ * Client for interacting with the Flow API.
+ * Manages user journey through a flow by handling step transitions and tracking user interactions.
+ */
+declare class FlowClient {
+    /**
+     * The base URL for API requests.
+     */
+    private baseURL;
+    /**
+     * HTTP headers to be sent with each request.
+     */
+    private headers;
+    /**
+     * The unique identifier of the flow.
+     */
+    private flowId;
+    /**
+     * Service for tracking user interactions and events.
+     * Only available if tracking is enabled in the options.
+     */
+    tracking: TrackingService;
+    /**
+     * Creates a new FlowClient instance.
+     * @param _options - Configuration options for the client
+     */
+    constructor(_options: ClientOptions);
+    /**
+     * Sends an HTTP request to the specified path and returns the response as a JSON object.
+     *
+     * @template T - The expected response type.
+     * @param {string} path - The path to which the request is sent.
+     * @param {RequestInit} [options={}] - Optional configuration for the request.
+     * @returns {Promise<T>} - A promise that resolves to the response data.
+     * @throws {Error} - Throws an error if the response status is not ok.
+     */
+    private request;
+    /**
+     * Initiates the first step of the flow process.
+     *
+     * @param {GetStepOptions} options - Optional parameters for getting the step.
+     * @returns {Promise<FlowContext>} A promise that resolves to the flow context.
+     */
+    firstStep(options?: GetStepOptions): Promise<FlowContext>;
+    /**
+     * Retrieves a specific step in the flow based on the provided step ID.
+     *
+     * @param {string} stepId - The unique identifier of the step to retrieve.
+     * @param {GetStepOptions} options - Optional parameters for customizing the step request.
+     * @returns {Promise<FlowContext>} A promise that resolves to the flow context containing the requested step information.
+     * @throws {Error} If the step ID is invalid or the step cannot be found.
+     */
+    getStep(stepId: string, options?: GetStepOptions): Promise<FlowContext>;
+    /**
+     * Advances to the next step in the flow based on the provided trigger action.
+     *
+     * @param {GetStepTrigger} trigger - Contains the current step ID and action ID to determine the next step.
+     * @param {GetStepOptions} options - Optional parameters to customize the step transition.
+     * @returns {Promise<FlowContext>} A promise that resolves to the updated flow context containing the next step information.
+     * @throws {Error} If the action is invalid or the next step cannot be determined.
+     */
+    nextStep(trigger: GetStepTrigger, options?: GetStepOptions): Promise<FlowContext>;
+}
+
+export { FlowClient, FlowClient as default };

package/client/client.service.d.ts

@@ -0,0 +1,71 @@
+import '@onlive.ai/tracker';
+import TrackingService from '../tracking/tracking.service.js';
+import { ClientOptions, GetStepOptions, FlowContext, GetStepTrigger } from './client.types.js';
+import '../tracking/tracking.types.js';
+import 'zod';
+
+/**
+ * Client for interacting with the Flow API.
+ * Manages user journey through a flow by handling step transitions and tracking user interactions.
+ */
+declare class FlowClient {
+    /**
+     * The base URL for API requests.
+     */
+    private baseURL;
+    /**
+     * HTTP headers to be sent with each request.
+     */
+    private headers;
+    /**
+     * The unique identifier of the flow.
+     */
+    private flowId;
+    /**
+     * Service for tracking user interactions and events.
+     * Only available if tracking is enabled in the options.
+     */
+    tracking: TrackingService;
+    /**
+     * Creates a new FlowClient instance.
+     * @param _options - Configuration options for the client
+     */
+    constructor(_options: ClientOptions);
+    /**
+     * Sends an HTTP request to the specified path and returns the response as a JSON object.
+     *
+     * @template T - The expected response type.
+     * @param {string} path - The path to which the request is sent.
+     * @param {RequestInit} [options={}] - Optional configuration for the request.
+     * @returns {Promise<T>} - A promise that resolves to the response data.
+     * @throws {Error} - Throws an error if the response status is not ok.
+     */
+    private request;
+    /**
+     * Initiates the first step of the flow process.
+     *
+     * @param {GetStepOptions} options - Optional parameters for getting the step.
+     * @returns {Promise<FlowContext>} A promise that resolves to the flow context.
+     */
+    firstStep(options?: GetStepOptions): Promise<FlowContext>;
+    /**
+     * Retrieves a specific step in the flow based on the provided step ID.
+     *
+     * @param {string} stepId - The unique identifier of the step to retrieve.
+     * @param {GetStepOptions} options - Optional parameters for customizing the step request.
+     * @returns {Promise<FlowContext>} A promise that resolves to the flow context containing the requested step information.
+     * @throws {Error} If the step ID is invalid or the step cannot be found.
+     */
+    getStep(stepId: string, options?: GetStepOptions): Promise<FlowContext>;
+    /**
+     * Advances to the next step in the flow based on the provided trigger action.
+     *
+     * @param {GetStepTrigger} trigger - Contains the current step ID and action ID to determine the next step.
+     * @param {GetStepOptions} options - Optional parameters to customize the step transition.
+     * @returns {Promise<FlowContext>} A promise that resolves to the updated flow context containing the next step information.
+     * @throws {Error} If the action is invalid or the next step cannot be determined.
+     */
+    nextStep(trigger: GetStepTrigger, options?: GetStepOptions): Promise<FlowContext>;
+}
+
+export { FlowClient, FlowClient as default };

package/client/client.service.spec.d.cts

@@ -0,0 +1,2 @@
+
+export {  }

package/client/client.service.spec.d.ts

@@ -0,0 +1,2 @@
+
+export {  }