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

package/dist/api/skills.api.service.js

@@ -3,37 +3,83 @@ import { HttpClient } from "../common/http.client.js";
  * Skill API calls
  */
 export default class SkillApi extends HttpClient {
+    /**
+     * Creates an instance of SkillApi
+     * @param baseUrl - The base URL for the API
+     * @param apiKey - The API key for authentication
+     * @param agentId - The unique identifier of the agent
+     */
     constructor(baseUrl, apiKey, agentId) {
         super(baseUrl);
         this.apiKey = apiKey;
         this.agentId = agentId;
     }
+    /**
+     * Creates a new skill for the agent
+     * @param skillData - The skill data including name, description, and optional context
+     * @returns Promise resolving to an ApiResponse containing the created skill details
+     * @throws Error if the skill creation fails or validation errors occur
+     */
     async createSkill(skillData) {
-        // console.log(`Skill data:`, skillData);
         return this.httpPost(`/developer/skills/${this.agentId}`, skillData, {
             Authorization: `Bearer ${this.apiKey}`,
         });
     }
+    /**
+     * Pushes a new version of a skill to production
+     * @param skillId - The unique identifier of the skill
+     * @param versionData - The version data including code, configuration, and metadata
+     * @returns Promise resolving to an ApiResponse containing the created version details
+     * @throws Error if the skill is not found or the push operation fails
+     */
     async pushSkill(skillId, versionData) {
         return this.httpPost(`/developer/skills/${this.agentId}/${skillId}/version`, versionData, {
             Authorization: `Bearer ${this.apiKey}`,
         });
     }
+    /**
+     * Pushes a new development/sandbox version of a skill for testing
+     * @param skillId - The unique identifier of the skill
+     * @param versionData - The version data including code, configuration, and metadata
+     * @returns Promise resolving to an ApiResponse containing the development version details
+     * @throws Error if the skill is not found or the push operation fails
+     */
     async pushDevSkill(skillId, versionData) {
         return this.httpPost(`/developer/skills/${this.agentId}/${skillId}/version/sandbox`, versionData, {
             Authorization: `Bearer ${this.apiKey}`,
         });
     }
+    /**
+     * Updates an existing development/sandbox version of a skill
+     * @param skillId - The unique identifier of the skill
+     * @param sandboxVersionId - The unique identifier of the sandbox version to update
+     * @param versionData - The updated version data including code, configuration, and metadata
+     * @returns Promise resolving to an ApiResponse containing the updated version details
+     * @throws Error if the skill or version is not found or the update fails
+     */
     async updateDevSkill(skillId, sandboxVersionId, versionData) {
         return this.httpPut(`/developer/skills/${this.agentId}/${skillId}/version/sandbox/${sandboxVersionId}`, versionData, {
             Authorization: `Bearer ${this.apiKey}`,
         });
     }
+    /**
+     * Retrieves all versions of a specific skill
+     * @param skillId - The unique identifier of the skill
+     * @returns Promise resolving to an ApiResponse containing an array of skill versions
+     * @throws Error if the skill is not found or the request fails
+     */
     async getSkillVersions(skillId) {
         return this.httpGet(`/developer/skills/${this.agentId}/${skillId}/versions`, {
             Authorization: `Bearer ${this.apiKey}`,
         });
     }
+    /**
+     * Publishes a specific version of a skill to production
+     * @param skillId - The unique identifier of the skill
+     * @param version - The version identifier to publish
+     * @returns Promise resolving to an ApiResponse containing publication confirmation details
+     * @throws Error if the skill or version is not found or the publish operation fails
+     */
     async publishSkillVersion(skillId, version) {
         return this.httpPut(`/developer/skills/${this.agentId}/${skillId}/${version}/publish`, undefined, {
             Authorization: `Bearer ${this.apiKey}`,

package/dist/api/tool.api.service.d.ts

@@ -1,14 +1,52 @@
 import { HttpClient } from "../common/http.client.js";
-import { ApiResponse } from "../interfaces/admin";
+import { ApiResponse } from "../interfaces/common.js";
 /**
  * Tool API calls (for compile command)
  */
 export default class ToolApi extends HttpClient {
     private apiKey;
+    /**
+     * Creates an instance of ToolApi
+     * @param baseUrl - The base URL for the API
+     * @param apiKey - The API key for authentication
+     */
     constructor(baseUrl: string, apiKey: string);
+    /**
+     * Performs a GET request to a tool endpoint
+     * @param url - The full or relative URL to request
+     * @returns Promise resolving to an ApiResponse with the tool's response data
+     * @throws Error if the request fails
+     */
     getTool(url: string): Promise<ApiResponse<any>>;
+    /**
+     * Performs a POST request to a tool endpoint
+     * @param url - The full or relative URL to request
+     * @param data - The data to send in the request body
+     * @returns Promise resolving to an ApiResponse with the tool's response data
+     * @throws Error if the request fails
+     */
     postTool(url: string, data: any): Promise<ApiResponse<any>>;
+    /**
+     * Performs a PUT request to a tool endpoint
+     * @param url - The full or relative URL to request
+     * @param data - The data to send in the request body
+     * @returns Promise resolving to an ApiResponse with the tool's response data
+     * @throws Error if the request fails
+     */
     putTool(url: string, data: any): Promise<ApiResponse<any>>;
+    /**
+     * Performs a DELETE request to a tool endpoint
+     * @param url - The full or relative URL to request
+     * @returns Promise resolving to an ApiResponse with the tool's response data
+     * @throws Error if the request fails
+     */
     deleteTool(url: string): Promise<ApiResponse<any>>;
+    /**
+     * Performs a PATCH request to a tool endpoint
+     * @param url - The full or relative URL to request
+     * @param data - The data to send in the request body
+     * @returns Promise resolving to an ApiResponse with the tool's response data
+     * @throws Error if the request fails
+     */
     patchTool(url: string, data: any): Promise<ApiResponse<any>>;
 }

package/dist/api/tool.api.service.js

@@ -3,30 +3,68 @@ import { HttpClient } from "../common/http.client.js";
  * Tool API calls (for compile command)
  */
 export default class ToolApi extends HttpClient {
+    /**
+     * Creates an instance of ToolApi
+     * @param baseUrl - The base URL for the API
+     * @param apiKey - The API key for authentication
+     */
     constructor(baseUrl, apiKey) {
         super(baseUrl);
         this.apiKey = apiKey;
     }
+    /**
+     * Performs a GET request to a tool endpoint
+     * @param url - The full or relative URL to request
+     * @returns Promise resolving to an ApiResponse with the tool's response data
+     * @throws Error if the request fails
+     */
     async getTool(url) {
         return this.httpGet(url, {
             Authorization: `Bearer ${this.apiKey}`,
         });
     }
+    /**
+     * Performs a POST request to a tool endpoint
+     * @param url - The full or relative URL to request
+     * @param data - The data to send in the request body
+     * @returns Promise resolving to an ApiResponse with the tool's response data
+     * @throws Error if the request fails
+     */
     async postTool(url, data) {
         return this.httpPost(url, data, {
             Authorization: `Bearer ${this.apiKey}`,
         });
     }
+    /**
+     * Performs a PUT request to a tool endpoint
+     * @param url - The full or relative URL to request
+     * @param data - The data to send in the request body
+     * @returns Promise resolving to an ApiResponse with the tool's response data
+     * @throws Error if the request fails
+     */
     async putTool(url, data) {
         return this.httpPut(url, data, {
             Authorization: `Bearer ${this.apiKey}`,
         });
     }
+    /**
+     * Performs a DELETE request to a tool endpoint
+     * @param url - The full or relative URL to request
+     * @returns Promise resolving to an ApiResponse with the tool's response data
+     * @throws Error if the request fails
+     */
     async deleteTool(url) {
         return this.httpDelete(url, {
             Authorization: `Bearer ${this.apiKey}`,
         });
     }
+    /**
+     * Performs a PATCH request to a tool endpoint
+     * @param url - The full or relative URL to request
+     * @param data - The data to send in the request body
+     * @returns Promise resolving to an ApiResponse with the tool's response data
+     * @throws Error if the request fails
+     */
     async patchTool(url, data) {
         return this.httpPatch(url, data, {
             Authorization: `Bearer ${this.apiKey}`,

package/dist/api/user.data.api.service.d.ts

@@ -1,11 +1,33 @@
 import { HttpClient } from "../common/http.client.js";
 import UserDataInstance from "../common/user.instance.js";
-import { UserDataAPI } from "../types";
+import { UserDataAPI } from "../types/index.js";
 export default class UserDataApi extends HttpClient implements UserDataAPI {
     private apiKey;
     private agentId;
+    /**
+     * Creates an instance of UserDataApi
+     * @param baseUrl - The base URL for the API
+     * @param apiKey - The API key for authentication
+     * @param agentId - The unique identifier of the agent
+     */
     constructor(baseUrl: string, apiKey: string, agentId: string);
+    /**
+     * Retrieves the current user's data for the specific agent
+     * @returns Promise resolving to a UserDataInstance containing the user's data
+     * @throws Error if the user data cannot be retrieved or the request fails
+     */
     get(): Promise<UserDataInstance>;
+    /**
+     * Updates the current user's data for the specific agent
+     * @param data - The data object containing fields to update or add to user data
+     * @returns Promise resolving to the updated user data
+     * @throws Error if the update fails or the request is unsuccessful
+     */
     update(data: Record<string, any>): Promise<any>;
+    /**
+     * Clears all user data for the current user and specific agent
+     * @returns Promise resolving to an empty object upon successful deletion
+     * @throws Error if the clear operation fails or the request is unsuccessful
+     */
     clear(): Promise<any>;
 }

package/dist/api/user.data.api.service.js

@@ -2,11 +2,22 @@ import { HttpClient } from "../common/http.client.js";
 import UserDataInstance from "../common/user.instance.js";
 // User Data API calls
 export default class UserDataApi extends HttpClient {
+    /**
+     * Creates an instance of UserDataApi
+     * @param baseUrl - The base URL for the API
+     * @param apiKey - The API key for authentication
+     * @param agentId - The unique identifier of the agent
+     */
     constructor(baseUrl, apiKey, agentId) {
         super(baseUrl);
         this.apiKey = apiKey;
         this.agentId = agentId;
     }
+    /**
+     * Retrieves the current user's data for the specific agent
+     * @returns Promise resolving to a UserDataInstance containing the user's data
+     * @throws Error if the user data cannot be retrieved or the request fails
+     */
     async get() {
         const response = await this.httpGet(`/developer/user/data/agent/${this.agentId}`, {
             Authorization: `Bearer ${this.apiKey}`,
@@ -16,6 +27,12 @@ export default class UserDataApi extends HttpClient {
         }
         return new UserDataInstance(this, response.data);
     }
+    /**
+     * Updates the current user's data for the specific agent
+     * @param data - The data object containing fields to update or add to user data
+     * @returns Promise resolving to the updated user data
+     * @throws Error if the update fails or the request is unsuccessful
+     */
     async update(data) {
         const response = await this.httpPut(`/developer/user/data/agent/${this.agentId}`, data, {
             Authorization: `Bearer ${this.apiKey}`,
@@ -25,6 +42,11 @@ export default class UserDataApi extends HttpClient {
         }
         return response.data;
     }
+    /**
+     * Clears all user data for the current user and specific agent
+     * @returns Promise resolving to an empty object upon successful deletion
+     * @throws Error if the clear operation fails or the request is unsuccessful
+     */
     async clear() {
         const response = await this.httpDelete(`/developer/user/data/agent/${this.agentId}`, {
             Authorization: `Bearer ${this.apiKey}`,

package/dist/api-exports.d.ts

@@ -1,40 +1,271 @@
-import { LuaSkill, LuaTool } from "./skill.js";
+/**
+ * Lua Skill API Exports
+ *
+ * Public API surface for LuaSkill tools.
+ * This module provides simplified interfaces to Lua platform APIs
+ * for use within skill implementations.
+ *
+ * Available APIs:
+ * - User: User data management
+ * - Data: Custom data collections (vector search, CRUD)
+ * - Products: Product catalog management
+ * - Baskets: Shopping basket operations
+ * - Orders: Order management
+ *
+ * Usage in skills:
+ * ```typescript
+ * import { User, Data, Products, Baskets, Orders } from 'lua-cli';
+ *
+ * // Get user data
+ * const user = await User.get();
+ *
+ * // Create custom data entry
+ * await Data.create('customers', { name: 'John' });
+ *
+ * // Search products
+ * const products = await Products.search('laptop');
+ * ```
+ */
+import { LuaSkill, LuaTool, env } from "./types/skill.js";
 import { BasketStatus } from "./interfaces/baskets.js";
 import { OrderStatus } from "./interfaces/orders.js";
+/**
+ * User Data API
+ * Access user information and preferences
+ */
 export declare const User: {
+    /**
+     * Retrieves current user data.
+     *
+     * @returns Promise resolving to user data
+     */
     get(): Promise<import("./common/user.instance.js").default>;
-    update(data: Record<string, any>): Promise<any>;
-    clear(): Promise<any>;
 };
+/**
+ * Custom Data API
+ * Store and retrieve custom data with vector search capabilities
+ */
 export declare const Data: {
+    /**
+     * Creates a new entry in a custom data collection.
+     *
+     * @param collectionName - Name of the collection
+     * @param data - Data to store
+     * @param searchText - Optional text for vector search indexing
+     * @returns Promise resolving to created entry
+     */
     create(collectionName: string, data: any, searchText?: string): Promise<import("./common/data.entry.instance.js").default>;
+    /**
+     * Retrieves entries from a collection with optional filtering and pagination.
+     *
+     * @param collectionName - Name of the collection
+     * @param filter - Optional filter criteria
+     * @param page - Page number (default: 1)
+     * @param limit - Items per page (default: 10)
+     * @returns Promise resolving to array of entries
+     */
     get(collectionName: string, filter?: any, page?: number, limit?: number): Promise<import("./interfaces/custom.data.js").GetCustomDataResponse>;
+    /**
+     * Retrieves a specific entry by ID.
+     *
+     * @param collectionName - Name of the collection
+     * @param entryId - ID of the entry
+     * @returns Promise resolving to entry data
+     */
     getEntry(collectionName: string, entryId: string): Promise<import("./common/data.entry.instance.js").default>;
+    /**
+     * Updates an existing entry.
+     *
+     * @param collectionName - Name of the collection
+     * @param entryId - ID of the entry to update
+     * @param data - Updated data
+     * @returns Promise resolving to updated entry
+     */
     update(collectionName: string, entryId: string, data: any): Promise<import("./interfaces/custom.data.js").UpdateCustomDataResponse>;
+    /**
+     * Performs vector search on a collection.
+     *
+     * @param collectionName - Name of the collection
+     * @param searchText - Text to search for
+     * @param limit - Maximum results to return
+     * @param scoreThreshold - Minimum similarity score (0-1)
+     * @returns Promise resolving to search results
+     */
     search(collectionName: string, searchText: string, limit?: number, scoreThreshold?: number): Promise<import("./common/data.entry.instance.js").default[]>;
+    /**
+     * Deletes an entry from a collection.
+     *
+     * @param collectionName - Name of the collection
+     * @param entryId - ID of the entry to delete
+     * @returns Promise resolving when deletion is complete
+     */
     delete(collectionName: string, entryId: string): Promise<import("./interfaces/custom.data.js").DeleteCustomDataResponse>;
 };
+/**
+ * Products API
+ * Manage product catalog
+ */
 export declare const Products: {
+    /**
+     * Retrieves products with pagination.
+     *
+     * @param limit - Items per page
+     * @param page - Page number
+     * @returns Promise resolving to product list
+     */
     get(limit?: number, page?: number): Promise<import("./common/product.pagination.instance.js").default>;
+    /**
+     * Creates a new product.
+     *
+     * @param product - Product data
+     * @returns Promise resolving to created product
+     */
     create(product: any): Promise<import("./common/product.instance.js").default>;
+    /**
+     * 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<import("./interfaces/product.js").UpdateProductResponse>;
+    /**
+     * Deletes a product.
+     *
+     * @param id - Product ID
+     * @returns Promise resolving when deletion is complete
+     */
     delete(id: string): Promise<import("./interfaces/product.js").DeleteProductResponse>;
+    /**
+     * Searches products by query string.
+     *
+     * @param query - Search query
+     * @returns Promise resolving to search results
+     */
     search(query: string): Promise<import("./common/product.search.instance.js").default>;
+    /**
+     * Retrieves a specific product by ID.
+     *
+     * @param id - Product ID
+     * @returns Promise resolving to product data
+     */
+    getById(id: string): Promise<import("./common/product.instance.js").default>;
 };
+/**
+ * Baskets API
+ * Manage shopping baskets
+ */
 export declare const Baskets: {
+    /**
+     * Creates a new basket.
+     *
+     * @param basketData - Basket initialization data
+     * @returns Promise resolving to created basket
+     */
     create(basketData: any): Promise<import("./common/basket.instance.js").default>;
+    /**
+     * Retrieves baskets, optionally filtered by status.
+     *
+     * @param status - Optional basket status filter
+     * @returns Promise resolving to basket list
+     */
     get(status?: any): Promise<import("./common/basket.instance.js").default[]>;
+    /**
+     * 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<import("./interfaces/baskets.js").Basket>;
+    /**
+     * 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<import("./interfaces/baskets.js").Basket>;
+    /**
+     * Clears all items from a basket.
+     *
+     * @param basketId - Basket ID
+     * @returns Promise resolving to cleared basket
+     */
     clear(basketId: string): Promise<import("./interfaces/baskets.js").Basket>;
+    /**
+     * Updates basket status.
+     *
+     * @param basketId - Basket ID
+     * @param status - New basket status
+     * @returns Promise resolving to updated basket
+     */
     updateStatus(basketId: string, status: any): Promise<BasketStatus>;
-    updateMetadata(basketId: string, metadata: any): Promise<import("./interfaces/custom.data.js").UpdateBasketMetadataResponse>;
+    /**
+     * Updates basket metadata.
+     *
+     * @param basketId - Basket ID
+     * @param metadata - Metadata to update
+     * @returns Promise resolving to updated basket
+     */
+    updateMetadata(basketId: string, metadata: any): Promise<import("./interfaces/baskets.js").UpdateBasketMetadataResponse>;
+    /**
+     * Converts basket to order.
+     *
+     * @param data - Order data
+     * @param basketId - Basket ID to convert
+     * @returns Promise resolving to created order
+     */
     placeOrder(data: Record<string, any>, basketId: string): Promise<import("./common/order.instance.js").default>;
+    /**
+     * Retrieves a specific basket by ID.
+     *
+     * @param basketId - Basket ID
+     * @returns Promise resolving to basket data
+     */
+    getById(basketId: string): Promise<import("./common/basket.instance.js").default>;
 };
+/**
+ * Orders API
+ * Manage orders
+ */
 export declare const Orders: {
+    /**
+     * Creates a new order.
+     *
+     * @param orderData - Order data
+     * @returns Promise resolving to created order
+     */
     create(orderData: any): Promise<import("./common/order.instance.js").default>;
+    /**
+     * Updates order status.
+     *
+     * @param status - New order status
+     * @param orderId - Order ID
+     * @returns Promise resolving to updated order
+     */
     updateStatus(status: any, orderId: string): Promise<import("./interfaces/orders.js").OrderResponse>;
+    /**
+     * 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<import("./interfaces/orders.js").OrderResponse>;
+    /**
+     * Retrieves orders, optionally filtered by status.
+     *
+     * @param status - Optional order status filter
+     * @returns Promise resolving to order list
+     */
     get(status?: any): Promise<import("./common/order.instance.js").default[]>;
+    /**
+     * Retrieves a specific order by ID.
+     *
+     * @param orderId - Order ID
+     * @returns Promise resolving to order data
+     */
+    getById(orderId: string): Promise<import("./common/order.instance.js").default>;
 };
-export { LuaSkill, LuaTool, BasketStatus, OrderStatus };
+export { LuaSkill, LuaTool, BasketStatus, OrderStatus, env };