lua-cli 2.2.8-alpha.2 → 2.3.0-alpha.2

package/dist/interfaces/product.d.ts

@@ -1,35 +1,63 @@
+/**
+ * Product Interfaces
+ * Product catalog management
+ */
+import { Pagination } from './common.js';
+/**
+ * Product entity.
+ * Flexible schema allows any properties to be stored.
+ *
+ * @example
+ * ```typescript
+ * const product: Product = {
+ *   id: '123',
+ *   name: 'Laptop',
+ *   price: 999.99,
+ *   category: 'Electronics',
+ *   inStock: true
+ * };
+ * ```
+ */
 export interface Product {
     id: string;
     [key: string]: any;
 }
+/**
+ * Response from get products API.
+ * Includes pagination for large catalogs.
+ */
 export interface ProductsResponse {
     success: boolean;
     data?: Product[];
     message?: string;
-    pagination?: {
-        currentPage: number;
-        totalPages: number;
-        totalCount: number;
-        limit: number;
-        hasNextPage: boolean;
-        hasPrevPage: boolean;
-        nextPage: number | null;
-        prevPage: number | null;
-    };
+    pagination?: Pagination;
 }
+/**
+ * Response from product creation.
+ * Indicates if product was newly created or updated existing.
+ */
 export interface CreateProductResponse {
     updated: boolean;
     isNew: boolean;
     product: Product;
 }
+/**
+ * Response from product update.
+ */
 export interface UpdateProductResponse {
     updated: boolean;
     isNew: boolean;
     product: Product;
 }
+/**
+ * Response from product deletion.
+ */
 export interface DeleteProductResponse {
     deleted: boolean;
 }
+/**
+ * Response from product search.
+ */
 export interface SearchProductsResponse {
     success: boolean;
     message: string;

package/dist/interfaces/product.js

@@ -1 +1,5 @@
+/**
+ * Product Interfaces
+ * Product catalog management
+ */
 export {};

package/dist/interfaces/push.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Interface definitions for push command
+ */
+/**
+ * Response from push version API endpoint
+ */
+export interface PushVersionResponse {
+    success: boolean;
+    data?: {
+        skillsId: string;
+        version: string;
+        context: string;
+        description: string;
+        tools: any[];
+        _id: string;
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+        __v: number;
+    };
+    error?: {
+        message: string;
+        error: string;
+        statusCode: number;
+    };
+}

package/dist/interfaces/push.js

@@ -0,0 +1,4 @@
+/**
+ * Interface definitions for push command
+ */
+export {};

package/dist/interfaces/test.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Interface definitions for test command
+ */
+/**
+ * Tool information from deploy.json
+ */
+export interface ToolData {
+    name: string;
+    description: string;
+    inputSchema: any;
+    execute: string;
+    skillName?: string;
+}
+/**
+ * Tool choice for inquirer prompt
+ */
+export interface ToolChoice {
+    name: string;
+    value: ToolData;
+}
+/**
+ * Schema property definition
+ */
+export interface SchemaProperty {
+    type: string;
+    properties?: Record<string, SchemaProperty>;
+    required?: string[];
+    description?: string;
+}
+/**
+ * Input schema structure
+ */
+export interface InputSchema {
+    properties?: Record<string, SchemaProperty>;
+    required?: string[];
+}

package/dist/interfaces/test.js

@@ -0,0 +1,4 @@
+/**
+ * Interface definitions for test command
+ */
+export {};

package/dist/services/auth.d.ts

@@ -1,106 +1,61 @@
-import { UserData } from "../types";
+/**
+ * Authentication Service
+ * Handles all authentication operations including API key management and OTP flows
+ */
+import { UserData } from "../interfaces/admin.js";
+/**
+ * Saves API key to secure system keychain.
+ * Uses the system's native credential storage (Keychain on macOS,
+ * Credential Vault on Windows, libsecret on Linux).
+ *
+ * @param apiKey - The API key to store securely
+ * @returns Promise that resolves when key is saved
+ */
 export declare function saveApiKey(apiKey: string): Promise<void>;
+/**
+ * Loads API key from secure system keychain.
+ *
+ * @returns Promise resolving to API key or null if not found
+ */
 export declare function loadApiKey(): Promise<string | null>;
+/**
+ * Deletes API key from secure system keychain.
+ * This is used for logout functionality.
+ *
+ * @returns Promise resolving to true if deleted, false if not found
+ */
 export declare function deleteApiKey(): Promise<boolean>;
+/**
+ * Validates an API key with the server and retrieves user data.
+ * This function will exit the process if the API key is invalid.
+ *
+ * @param apiKey - The API key to validate
+ * @returns Promise resolving to user data including admin info and organizations
+ * @throws Exits process with code 1 if API key is invalid
+ */
 export declare function checkApiKey(apiKey: string): Promise<UserData>;
+/**
+ * Requests an OTP (One-Time Password) to be sent to the specified email.
+ * The OTP will be valid for a limited time and can be used once.
+ *
+ * @param email - Email address to send OTP to
+ * @returns Promise resolving to true if OTP sent successfully, false otherwise
+ */
 export declare function requestEmailOTP(email: string): Promise<boolean>;
+/**
+ * Verifies an OTP code and retrieves a sign-in token.
+ * The sign-in token can be used to generate an API key.
+ *
+ * @param email - Email address the OTP was sent to
+ * @param pin - The OTP code received via email
+ * @returns Promise resolving to sign-in token or null if verification failed
+ */
 export declare function verifyOTPAndGetToken(email: string, pin: string): Promise<string | null>;
+/**
+ * Generates a permanent API key using a sign-in token.
+ * The sign-in token is obtained from successful OTP verification.
+ *
+ * @param signInToken - Token obtained from OTP verification
+ * @returns Promise resolving to API key or null if generation failed
+ */
 export declare function generateApiKey(signInToken: string): Promise<string | null>;
-export interface CreateSkillResponse {
-    success: boolean;
-    data?: {
-        name: string;
-        public: boolean;
-        agentId: string;
-        active: boolean;
-        _id: string;
-        id: string;
-        createdAt: string;
-        updatedAt: string;
-        __v: number;
-    };
-    error?: {
-        message: string;
-        error: string;
-        statusCode: number;
-    };
-}
-export interface AgentType {
-    id: string;
-    name: string;
-    features: Record<string, any>;
-    requiredSubAgentMetadata?: string[];
-}
-export interface CreateAgentRequest {
-    id: string;
-    type: string;
-    metadata: Record<string, any>;
-    persona: {
-        agentName: string;
-        businessType: string;
-        brandPersonality: string;
-        brandTraits: string;
-    };
-    features: Record<string, boolean>;
-    channels: any[];
-    org: {
-        registeredName: string;
-    };
-}
-export interface CreateAgentResponse {
-    success: boolean;
-    data?: {
-        agentId: string;
-        name: string;
-        baseAgentId: string;
-        persona: string;
-        createdAt: string;
-        welcomeMessage: string;
-        featuresOverride: Record<string, any>;
-        _id: string;
-        updatedAt: string;
-        __v: number;
-        org: {
-            registeredName: string;
-            type: string;
-            agents: string[];
-            paymentMethods: any[];
-            _id: string;
-            id: string;
-            createdAt: number;
-            __v: number;
-        };
-    };
-    error?: {
-        message: string;
-        error: string;
-        statusCode: number;
-    };
-}
-export interface AgentDetailsResponse {
-    success: boolean;
-    data?: {
-        _id: string;
-        agentId: string;
-        name: string;
-        baseAgentId: string;
-        persona: string;
-        createdAt: string;
-        welcomeMessage: string;
-        featuresOverride: Record<string, any>;
-        updatedAt: string;
-        __v: number;
-        personaConfig: {
-            agentName: string;
-            businessType: string;
-            brandPersonality: string;
-            brandTraits: string;
-        };
-        skills: any[];
-    };
-    error?: {
-        message: string;
-        error: string;
-        statusCode: number;
-    };
-}

package/dist/services/auth.js

@@ -1,27 +1,76 @@
+/**
+ * Authentication Service
+ * Handles all authentication operations including API key management and OTP flows
+ */
 import keytar from "keytar";
-import { ApiService } from "./api.js";
-const SERVICE = "lua-cli";
-const ACCOUNT = "api-key";
+import AuthApi from "../api/auth.api.service.js";
+import { BASE_URLS } from "../config/constants.js";
+import { KEYTAR_SERVICE, KEYTAR_ACCOUNT } from "../config/auth.constants.js";
+// ============================================================================
+// KEYTAR OPERATIONS (Secure Local Storage)
+// ============================================================================
+/**
+ * Saves API key to secure system keychain.
+ * Uses the system's native credential storage (Keychain on macOS,
+ * Credential Vault on Windows, libsecret on Linux).
+ *
+ * @param apiKey - The API key to store securely
+ * @returns Promise that resolves when key is saved
+ */
 export async function saveApiKey(apiKey) {
-    await keytar.setPassword(SERVICE, ACCOUNT, apiKey);
+    await keytar.setPassword(KEYTAR_SERVICE, KEYTAR_ACCOUNT, apiKey);
 }
+/**
+ * Loads API key from secure system keychain.
+ *
+ * @returns Promise resolving to API key or null if not found
+ */
 export async function loadApiKey() {
-    return keytar.getPassword(SERVICE, ACCOUNT);
+    return keytar.getPassword(KEYTAR_SERVICE, KEYTAR_ACCOUNT);
 }
+/**
+ * Deletes API key from secure system keychain.
+ * This is used for logout functionality.
+ *
+ * @returns Promise resolving to true if deleted, false if not found
+ */
 export async function deleteApiKey() {
-    return keytar.deletePassword(SERVICE, ACCOUNT);
+    return keytar.deletePassword(KEYTAR_SERVICE, KEYTAR_ACCOUNT);
 }
+// ============================================================================
+// API OPERATIONS (Server Authentication)
+// ============================================================================
+/**
+ * Validates an API key with the server and retrieves user data.
+ * This function will exit the process if the API key is invalid.
+ *
+ * @param apiKey - The API key to validate
+ * @returns Promise resolving to user data including admin info and organizations
+ * @throws Exits process with code 1 if API key is invalid
+ */
 export async function checkApiKey(apiKey) {
-    const result = await ApiService.Auth.checkApiKey(apiKey);
+    const authApi = new AuthApi(BASE_URLS.API);
+    const result = await authApi.checkApiKey(apiKey);
     if (!result.success) {
         console.error(`❌ Invalid API key`);
         process.exit(1);
     }
     return result.data;
 }
+// ============================================================================
+// EMAIL OTP AUTHENTICATION FLOW
+// ============================================================================
+/**
+ * Requests an OTP (One-Time Password) to be sent to the specified email.
+ * The OTP will be valid for a limited time and can be used once.
+ *
+ * @param email - Email address to send OTP to
+ * @returns Promise resolving to true if OTP sent successfully, false otherwise
+ */
 export async function requestEmailOTP(email) {
     try {
-        const result = await ApiService.Auth.sendOtp(email);
+        const authApi = new AuthApi(BASE_URLS.AUTH);
+        const result = await authApi.sendOtp(email);
         return result.success;
     }
     catch (error) {
@@ -29,9 +78,18 @@ export async function requestEmailOTP(email) {
         return false;
     }
 }
+/**
+ * Verifies an OTP code and retrieves a sign-in token.
+ * The sign-in token can be used to generate an API key.
+ *
+ * @param email - Email address the OTP was sent to
+ * @param pin - The OTP code received via email
+ * @returns Promise resolving to sign-in token or null if verification failed
+ */
 export async function verifyOTPAndGetToken(email, pin) {
     try {
-        const result = await ApiService.Auth.verifyOtp(email, pin);
+        const authApi = new AuthApi(BASE_URLS.AUTH);
+        const result = await authApi.verifyOtp(email, pin);
         return result.success ? result.data.signInToken : null;
     }
     catch (error) {
@@ -39,9 +97,17 @@ export async function verifyOTPAndGetToken(email, pin) {
         return null;
     }
 }
+/**
+ * Generates a permanent API key using a sign-in token.
+ * The sign-in token is obtained from successful OTP verification.
+ *
+ * @param signInToken - Token obtained from OTP verification
+ * @returns Promise resolving to API key or null if generation failed
+ */
 export async function generateApiKey(signInToken) {
     try {
-        const result = await ApiService.Auth.getApiKey(signInToken);
+        const authApi = new AuthApi(BASE_URLS.AUTH);
+        const result = await authApi.getApiKey(signInToken);
         return result.success ? result.data.apiKey : null;
     }
     catch (error) {
@@ -49,5 +115,3 @@ export async function generateApiKey(signInToken) {
         return null;
     }
 }
-// API functions moved to centralized ApiService and api.ts
-// Use ApiService.getAgentTypes(), ApiService.createAgent(), ApiService.getAgentDetails() instead

package/dist/types/api-contracts.d.ts

@@ -0,0 +1,211 @@
+/**
+ * API Contract Interfaces
+ * TypeScript interfaces that API service classes must implement
+ *
+ * These interfaces define the contract that API services must fulfill.
+ * They ensure consistent method signatures across all API implementations.
+ */
+/**
+ * User Data API contract.
+ * Defines operations for managing user data.
+ */
+export interface UserDataAPI {
+    /**
+     * Retrieves current user data.
+     * @returns Promise resolving to user data
+     */
+    get(): Promise<any>;
+    /**
+     * Updates user data.
+     * @param data - Data to update
+     * @returns Promise resolving to updated user data
+     */
+    update(data: Record<string, any>): Promise<any>;
+    /**
+     * Clears user data.
+     * @returns Promise resolving when data is cleared
+     */
+    clear(): Promise<any>;
+}
+/**
+ * Product API contract.
+ * Defines operations for managing products.
+ */
+export interface ProductAPI {
+    /**
+     * Gets products with pagination.
+     * @param limit - Items per page
+     * @param page - Page number
+     * @returns Promise resolving to product list
+     */
+    get(limit?: number, page?: number): Promise<any>;
+    /**
+     * Creates a new product.
+     * @param product - Product data
+     * @returns Promise resolving to created product
+     */
+    create(product: any): Promise<any>;
+    /**
+     * Updates an existing product.
+     * @param data - Updated product data
+     * @param id - Product ID
+     * @returns Promise resolving to updated product
+     */
+    update(data: any, id: string): Promise<any>;
+    /**
+     * Deletes a product.
+     * @param id - Product ID
+     * @returns Promise resolving when deletion is complete
+     */
+    delete(id: string): Promise<any>;
+    /**
+     * Searches products.
+     * @param query - Search query
+     * @returns Promise resolving to search results
+     */
+    search(query: string): Promise<any>;
+}
+/**
+ * Basket API contract.
+ * Defines operations for managing shopping baskets.
+ */
+export interface BasketAPI {
+    /**
+     * Creates a new basket.
+     * @param basketData - Basket initialization data
+     * @returns Promise resolving to created basket
+     */
+    create(basketData: any): Promise<any>;
+    /**
+     * Gets baskets, optionally filtered by status.
+     * @param status - Optional status filter
+     * @returns Promise resolving to basket list
+     */
+    get(status?: any): Promise<any>;
+    /**
+     * Adds an item to a basket.
+     * @param basketId - Basket ID
+     * @param itemData - Item data to add
+     * @returns Promise resolving to updated basket
+     */
+    addItem(basketId: string, itemData: any): Promise<any>;
+    /**
+     * Removes an item from a basket.
+     * @param basketId - Basket ID
+     * @param itemId - Item ID to remove
+     * @returns Promise resolving to updated basket
+     */
+    removeItem(basketId: string, itemId: string): Promise<any>;
+    /**
+     * Clears all items from a basket.
+     * @param basketId - Basket ID
+     * @returns Promise resolving to cleared basket
+     */
+    clear(basketId: string): Promise<any>;
+    /**
+     * Updates basket status.
+     * @param basketId - Basket ID
+     * @param status - New status
+     * @returns Promise resolving to updated basket
+     */
+    updateStatus(basketId: string, status: any): Promise<any>;
+    /**
+     * Updates basket metadata.
+     * @param basketId - Basket ID
+     * @param metadata - Metadata to update
+     * @returns Promise resolving to updated basket
+     */
+    updateMetadata(basketId: string, metadata: any): Promise<any>;
+    /**
+     * Converts basket to order.
+     * @param data - Order data
+     * @param basketId - Basket ID
+     * @returns Promise resolving to created order
+     */
+    placeOrder(data: Record<string, any>, basketId: string): Promise<any>;
+}
+/**
+ * Order API contract.
+ * Defines operations for managing orders.
+ */
+export interface OrderAPI {
+    /**
+     * Creates a new order.
+     * @param orderData - Order data
+     * @returns Promise resolving to created order
+     */
+    create(orderData: any): Promise<any>;
+    /**
+     * Updates order status.
+     * @param status - New status
+     * @param orderId - Order ID
+     * @returns Promise resolving to updated order
+     */
+    updateStatus(status: any, orderId: string): Promise<any>;
+    /**
+     * Updates order data.
+     * @param data - Data to update
+     * @param orderId - Order ID
+     * @returns Promise resolving to updated order
+     */
+    updateData(data: Record<string, any>, orderId: string): Promise<any>;
+    /**
+     * Gets orders, optionally filtered by status.
+     * @param status - Optional status filter
+     * @returns Promise resolving to order list
+     */
+    get(status?: any): Promise<any>;
+}
+/**
+ * Custom Data API contract.
+ * Defines operations for managing custom data collections with vector search.
+ */
+export interface CustomDataAPI {
+    /**
+     * Creates a new entry in a custom data collection.
+     * @param collectionName - Collection name
+     * @param data - Data to store
+     * @returns Promise resolving to created entry
+     */
+    create(collectionName: string, data: any): Promise<any>;
+    /**
+     * Gets entries from a collection with filtering and pagination.
+     * @param collectionName - Collection name
+     * @param filter - Optional filter criteria
+     * @param page - Page number
+     * @param limit - Items per page
+     * @returns Promise resolving to entries
+     */
+    get(collectionName: string, filter?: any, page?: number, limit?: number): Promise<any>;
+    /**
+     * Gets a specific entry by ID.
+     * @param collectionName - Collection name
+     * @param entryId - Entry ID
+     * @returns Promise resolving to entry data
+     */
+    getEntry(collectionName: string, entryId: string): Promise<any>;
+    /**
+     * Updates an existing entry.
+     * @param collectionName - Collection name
+     * @param entryId - Entry ID
+     * @param data - Updated data
+     * @returns Promise resolving to updated entry
+     */
+    update(collectionName: string, entryId: string, data: any): Promise<any>;
+    /**
+     * Performs vector search on a collection.
+     * @param collectionName - Collection name
+     * @param searchText - Text to search for
+     * @param limit - Maximum results
+     * @param scoreThreshold - Minimum similarity score
+     * @returns Promise resolving to search results
+     */
+    search(collectionName: string, searchText: string, limit?: number, scoreThreshold?: number): Promise<any>;
+    /**
+     * Deletes an entry from a collection.
+     * @param collectionName - Collection name
+     * @param entryId - Entry ID to delete
+     * @returns Promise resolving when deletion is complete
+     */
+    delete(collectionName: string, entryId: string): Promise<any>;
+}

package/dist/types/api-contracts.js

@@ -0,0 +1,8 @@
+/**
+ * API Contract Interfaces
+ * TypeScript interfaces that API service classes must implement
+ *
+ * These interfaces define the contract that API services must fulfill.
+ * They ensure consistent method signatures across all API implementations.
+ */
+export {};