@myop/sdk 0.2.3 → 0.2.5

package/dist/module/helpers/CloudRepository.d.ts

@@ -1,196 +1,38 @@
-import { IUserFlow } from "../common";
+import { IUserFlow, v2_IVariantConfig } from "../common";
 /**
+ * CloudRepository - Unified cloud data access layer for Myop components
  *
- * ## Overview
- *
- * The `CloudRepository` class serves as a centralized data access layer for retrieving user flows and components from the Myop.dev cloud service. It implements a singleton pattern and provides caching mechanisms to optimize API calls and improve performance.
- *
- * ## Class Structure
- *
- * ### Constructor
- *
- * ```typescript
- * constructor(private _baseUrl = 'https://cloud.myop.dev')
- * ```
- *
- * **Parameters:**
- * - `_baseUrl` (optional): The base URL for the Myop.dev cloud API. Defaults to `'https://cloud.myop.dev'`
- *
- * ### Static Properties
- *
- * #### Main
- * ```typescript
- * static Main = new CloudRepository();
- * ```
- *
- * A singleton instance of the `CloudRepository` class that can be used throughout the application without creating multiple instances.
- *
- * ### Private Properties
- *
- * #### userFlows
- * ```typescript
- * private userFlows: Record<string, Promise<IUserFlow>> = {};
- * ```
- *
- * A cache object that stores promises for user flows, indexed by flow ID. This prevents duplicate API calls for the same flow and ensures consistent data retrieval.
- *
- * #### _baseUrl
- * ```typescript
- * private _baseUrl: string
- * ```
- *
- * The base URL for the cloud API endpoints, set during construction.
- *
- * ## Methods
- *
- * ### fetchFlow(flowId: string)
- *
- * Retrieves a complete user flow from the cloud repository, including all resolved components.
- *
- * **Parameters:**
- * - `flowId`: The unique identifier for the user flow to retrieve
- *
- * **Returns:**
- * - `Promise<IUserFlow>`: A promise that resolves to the complete user flow object
- *
- * **Behavior:**
- * - Implements request caching to avoid duplicate API calls for the same flow ID
- * - Makes a GET request to `/flow?id={flowId}&resolve=components`
- * - Automatically resolves component references within the flow
- * - Stores the promise in the cache for future use
- *
- * **Example Usage:**
- * ```typescript
- * const flow = await CloudRepository.Main.fetchFlow('my-flow-id');
- * console.log(flow.components);
- * ```
- *
- * ### fetchComponent(componentId: string, flowId: string)
- *
- * Retrieves a specific component from within a user flow.
- *
- * **Parameters:**
- * - `componentId`: The unique identifier for the component to retrieve
- * - `flowId`: The unique identifier for the user flow containing the component
- *
- * **Returns:**
- * - `Promise<Component | undefined>`: A promise that resolves to the component object if found, or undefined if not found
- *
- * **Behavior:**
- * - First fetches the complete flow using `fetchFlow()`
- * - Searches through the flow's components array to find the matching component
- * - Uses the component's `type.id` property for matching
- *
- * **Example Usage:**
- * ```typescript
- * const component = await CloudRepository.Main.fetchComponent('button-component', 'my-flow-id');
- * if (component) {
- *     console.log('Component found:', component);
- * } else {
- *     console.log('Component not found in flow');
- * }
- * ```
- *
- * ## API Integration
- *
- * ### Endpoint Structure
- *
- * The class integrates with the following Myop.dev cloud API endpoint:
- *
- * ```
- * GET {baseUrl}/flow?id={flowId}&resolve=components
- * ```
- *
- * **Query Parameters:**
- * - `id`: The flow identifier
- * - `resolve=components`: Instructs the API to include resolved component data in the response
- *
- * ### Response Format
- *
- * The API is expected to return a JSON response with the following structure:
- *
- * ```json
- * {
- *     "item": {
- *         // IUserFlow object with resolved components
- *         "components": [
- *             {
- *                 "type": {
- *                     "id": "component-id"
- *                 }
- *                 // ... other component properties
- *             }
- *         ]
- *         // ... other flow properties
- *     }
- * }
- * ```
- *
- * ## Caching Strategy
- *
- * The `CloudRepository` implements a promise-based caching mechanism:
- *
- * 1. **Cache Key**: Flow ID is used as the cache key
- * 2. **Cache Value**: Promises are cached rather than resolved values to handle concurrent requests
- * 3. **Cache Duration**: Cache persists for the lifetime of the repository instance
- * 4. **Cache Invalidation**: No automatic cache invalidation is implemented
- *
- * ## Error Handling
- *
- * - Network errors and API failures are propagated through promise rejection
- * - No specific error handling or retry logic is implemented at the repository level
- * - Consumers should implement appropriate error handling when calling repository methods
- *
- * ## Usage Patterns
- *
- * ### Singleton Access
- * ```typescript
- * import { CloudRepository } from './path/to/CloudRepository';
- *
- * // Use the singleton instance
- * const flow = await CloudRepository.Main.fetchFlow('flow-id');
- * ```
- *
- * ### Custom Instance
- * ```typescript
- * // Create a custom instance with different base URL
- * const customRepo = new CloudRepository('https://custom-api.example.com');
- * const flow = await customRepo.fetchFlow('flow-id');
- * ```
- *
- * ### Component Retrieval
- * ```typescript
- * // Get a specific component from a flow
- * const component = await CloudRepository.Main.fetchComponent('component-id', 'flow-id');
- * ```
- *
- * ## Dependencies
- *
- * - **IUserFlow**: Interface imported from `../common` that defines the structure of user flow objects
- * - **Fetch API**: Uses the native `fetch` function for HTTP requests
- *
- * ## Performance Considerations
- *
- * - **Caching**: Prevents duplicate API calls for the same flow ID
- * - **Promise Caching**: Handles concurrent requests efficiently by caching promises
- * - **Component Resolution**: The `resolve=components` parameter ensures components are fully resolved in a single API call
- *
- * ## Future Enhancements
- *
- * The class structure suggests planned functionality that could be implemented:
- *
- * - **Component Caching**: The commented `components` property indicates potential individual component caching
- * - **Cache Invalidation**: Methods to clear or refresh cached data
- * - **Error Retry Logic**: Automatic retry mechanisms for failed requests
- * - **Batch Operations**: Methods to fetch multiple flows or components in a single request
- *
+ * Supports both v2 (default) and v1 modes:
+ * - v2: Uses /consume endpoint for fetching variants
+ * - v1: Uses /flow endpoint for fetching user flows
  */
 export declare class CloudRepository {
     private _baseUrl;
     static Main: CloudRepository;
+    private variants;
     private userFlows;
     constructor(_baseUrl?: string);
-    fetchComponent(componentId: string, flowId?: string): Promise<import("../common").IComponentConfig>;
+    /**
+     * Check if a component is already cached/preloaded (v2)
+     */
+    isPreloaded(componentId: string): boolean;
+    /**
+     * Fetch a v2 component variant
+     */
+    fetchComponentV2(componentId: string, environmentIdentifier?: string): Promise<v2_IVariantConfig>;
+    /**
+     * Fetch a v1 component from a flow
+     */
+    fetchComponentV1(componentId: string, flowId?: string): Promise<import("../common").IComponentConfig>;
     fetchAutoFlow(componentId: string): Promise<IUserFlow>;
     fetchFlow(flowId: string): Promise<IUserFlow>;
+    /**
+     * @deprecated Use fetchComponentV2 or fetchComponentV1 explicitly
+     * Defaults to v1 behavior for backward compatibility with existing code
+     */
+    fetchComponent(componentId: string, flowId?: string): Promise<import("../common").IComponentConfig>;
 }
+/**
+ * @deprecated Use CloudRepository instead
+ */
+export declare const v2_CloudRepository: typeof CloudRepository;

package/dist/module/helpers/index.d.ts

@@ -4,4 +4,3 @@ export * from "./classList";
 export * from "./configBuilder";
 export * from "./CloudRepository";
 export * from "./exec";
-export * from "./enableV2";