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

package/dist/common/http.client.js

@@ -1,10 +1,22 @@
 /**
  * Generic HTTP client with common error handling
+ * Provides a base class for all API service classes with standardized HTTP methods
  */
 export class HttpClient {
+    /**
+     * Creates an instance of HttpClient
+     * @param baseUrl - The base URL for all API requests
+     */
     constructor(baseUrl) {
         this.baseUrl = baseUrl;
     }
+    /**
+     * Makes an HTTP request with standardized error handling
+     * @param url - The full URL to request
+     * @param options - Fetch API request options
+     * @returns Promise resolving to an ApiResponse with typed data
+     * @private
+     */
     async request(url, options = {}) {
         try {
             const response = await fetch(url, {
@@ -53,9 +65,24 @@ export class HttpClient {
             };
         }
     }
+    /**
+     * Performs an HTTP GET request
+     * @param url - The relative URL path to request (will be appended to baseUrl)
+     * @param headers - Optional HTTP headers to include in the request
+     * @returns Promise resolving to an ApiResponse with typed data
+     * @protected
+     */
     async httpGet(url, headers) {
         return this.request(this.baseUrl + url, { method: 'GET', headers });
     }
+    /**
+     * Performs an HTTP POST request
+     * @param url - The relative URL path to request (will be appended to baseUrl)
+     * @param data - Optional request body data (will be JSON stringified)
+     * @param headers - Optional HTTP headers to include in the request
+     * @returns Promise resolving to an ApiResponse with typed data
+     * @protected
+     */
     async httpPost(url, data, headers) {
         return this.request(this.baseUrl + url, {
             method: 'POST',
@@ -63,6 +90,14 @@ export class HttpClient {
             headers,
         });
     }
+    /**
+     * Performs an HTTP PUT request
+     * @param url - The relative URL path to request (will be appended to baseUrl)
+     * @param data - Optional request body data (will be JSON stringified)
+     * @param headers - Optional HTTP headers to include in the request
+     * @returns Promise resolving to an ApiResponse with typed data
+     * @protected
+     */
     async httpPut(url, data, headers) {
         return this.request(this.baseUrl + url, {
             method: 'PUT',
@@ -70,9 +105,24 @@ export class HttpClient {
             headers,
         });
     }
+    /**
+     * Performs an HTTP DELETE request
+     * @param url - The relative URL path to request (will be appended to baseUrl)
+     * @param headers - Optional HTTP headers to include in the request
+     * @returns Promise resolving to an ApiResponse with typed data
+     * @protected
+     */
     async httpDelete(url, headers) {
         return this.request(this.baseUrl + url, { method: 'DELETE', headers });
     }
+    /**
+     * Performs an HTTP PATCH request
+     * @param url - The relative URL path to request (will be appended to baseUrl)
+     * @param data - Optional request body data (will be JSON stringified)
+     * @param headers - Optional HTTP headers to include in the request
+     * @returns Promise resolving to an ApiResponse with typed data
+     * @protected
+     */
     async httpPatch(url, data, headers) {
         return this.request(this.baseUrl + url, {
             method: 'PATCH',

package/dist/common/order.instance.d.ts

@@ -1,5 +1,9 @@
 import OrderApi from "../api/order.api.service.js";
 import { OrderResponse, OrderStatus } from "../interfaces/orders.js";
+/**
+ * Order instance class providing a fluent API for managing orders
+ * Provides methods for updating order status and order data
+ */
 export default class OrderInstance {
     private data;
     private common;
@@ -8,11 +12,29 @@ export default class OrderInstance {
     private agentId;
     private orderId;
     private orderAPI;
+    /**
+     * Creates a new OrderInstance
+     * @param api - The OrderApi instance for making API calls
+     * @param order - The order response data from the API
+     */
     constructor(api: OrderApi, order: OrderResponse);
     /**
      * Custom toJSON method to control what gets serialized when logging
+     * @returns Serialized order data combining data and common fields
      */
     toJSON(): Record<string, any>;
+    /**
+     * Updates the order's status
+     * @param status - The new order status (e.g., 'pending', 'processing', 'shipped', 'delivered', 'cancelled')
+     * @returns Promise resolving to the updated order data
+     * @throws Error if the status update fails
+     */
     updateStatus(status: OrderStatus): Promise<any>;
+    /**
+     * Updates the order's data
+     * @param data - The data fields to update (e.g., shipping info, notes, metadata)
+     * @returns Promise resolving to the updated order data
+     * @throws Error if the data update fails
+     */
     update(data: Record<string, any>): Promise<any>;
 }

package/dist/common/order.instance.js

@@ -1,4 +1,13 @@
+/**
+ * Order instance class providing a fluent API for managing orders
+ * Provides methods for updating order status and order data
+ */
 export default class OrderInstance {
+    /**
+     * Creates a new OrderInstance
+     * @param api - The OrderApi instance for making API calls
+     * @param order - The order response data from the API
+     */
     constructor(api, order) {
         this.data = order.data;
         this.common = order.common;
@@ -16,37 +25,55 @@ export default class OrderInstance {
     }
     /**
      * Custom toJSON method to control what gets serialized when logging
+     * @returns Serialized order data combining data and common fields
      */
     toJSON() {
         return {
             ...this.data,
-            ...this.common
+            ...this.common,
+            id: this.id
         };
     }
     /**
      * Custom inspect method for Node.js console.log
+     * @returns Formatted order data for console output
      */
     [Symbol.for('nodejs.util.inspect.custom')]() {
         return {
             ...this.data,
-            ...this.common
+            ...this.common,
+            id: this.id
         };
     }
+    /**
+     * Updates the order's status
+     * @param status - The new order status (e.g., 'pending', 'processing', 'shipped', 'delivered', 'cancelled')
+     * @returns Promise resolving to the updated order data
+     * @throws Error if the status update fails
+     */
     async updateStatus(status) {
         const response = await this.orderAPI.updateStatus(status, this.id);
         this.common = response.common;
         return {
             ...this.data,
-            ...this.common
+            ...this.common,
+            id: this.id
         };
     }
+    /**
+     * Updates the order's data
+     * @param data - The data fields to update (e.g., shipping info, notes, metadata)
+     * @returns Promise resolving to the updated order data
+     * @throws Error if the data update fails
+     */
     async update(data) {
         const response = await this.orderAPI.updateData(data, this.id);
         this.data = response.data;
         this.common = response.common;
         return {
             ...this.data,
-            ...this.common
+            ...this.common,
+            id: this.id
         };
     }
 }

package/dist/common/product.instance.d.ts

@@ -1,12 +1,33 @@
-import { Product } from "../interfaces/product";
+import { Product } from "../interfaces/product.js";
+/**
+ * Product instance class providing a fluent API for managing individual products
+ * Provides methods for updating and deleting products
+ */
 export default class ProductInstance {
     data: Product;
     private productAPI;
+    /**
+     * Creates a new ProductInstance
+     * @param api - The ProductAPI instance for making API calls
+     * @param product - The product data from the API
+     */
     constructor(api: any, product: Product);
     /**
      * Custom toJSON method to control what gets serialized when logging
+     * @returns Serialized product data
      */
     toJSON(): Record<string, any>;
+    /**
+     * Updates the product's data
+     * @param data - The product fields to update (partial update supported)
+     * @returns Promise resolving to the updated Product
+     * @throws Error if the update fails or the product is not found
+     */
     update(data: Record<string, any>): Promise<Product>;
+    /**
+     * Deletes the product from the catalog
+     * @returns Promise resolving to an empty Product object if deletion was successful
+     * @throws Error if the deletion fails or the product is not found
+     */
     delete(): Promise<Product>;
 }

package/dist/common/product.instance.js

@@ -1,4 +1,13 @@
+/**
+ * Product instance class providing a fluent API for managing individual products
+ * Provides methods for updating and deleting products
+ */
 export default class ProductInstance {
+    /**
+     * Creates a new ProductInstance
+     * @param api - The ProductAPI instance for making API calls
+     * @param product - The product data from the API
+     */
     constructor(api, product) {
         this.data = product;
         // Make productAPI non-enumerable so it doesn't show up in console.log
@@ -11,20 +20,24 @@ export default class ProductInstance {
     }
     /**
      * Custom toJSON method to control what gets serialized when logging
+     * @returns Serialized product data
      */
     toJSON() {
-        return {
-            data: this.data
-        };
+        return this.data;
     }
     /**
      * Custom inspect method for Node.js console.log
+     * @returns Formatted product data for console output
      */
     [Symbol.for('nodejs.util.inspect.custom')]() {
-        return {
-            data: this.data
-        };
+        return this.data;
     }
+    /**
+     * Updates the product's data
+     * @param data - The product fields to update (partial update supported)
+     * @returns Promise resolving to the updated Product
+     * @throws Error if the update fails or the product is not found
+     */
     async update(data) {
         const response = await this.productAPI.update(data, this.data.id);
         if (response.updated) {
@@ -35,6 +48,11 @@ export default class ProductInstance {
             throw new Error('Failed to update product');
         }
     }
+    /**
+     * Deletes the product from the catalog
+     * @returns Promise resolving to an empty Product object if deletion was successful
+     * @throws Error if the deletion fails or the product is not found
+     */
     async delete() {
         const response = await this.productAPI.delete(this.data.id);
         if (response.deleted) {

package/dist/common/product.pagination.instance.d.ts

@@ -1,5 +1,9 @@
-import { ProductsResponse } from "../interfaces/product";
-import ProductInstance from "./product.instance";
+import { ProductsResponse } from "../interfaces/product.js";
+import ProductInstance from "./product.instance.js";
+/**
+ * Product pagination instance class providing a fluent API for paginated product results
+ * Provides methods for navigating through pages of products
+ */
 export default class ProductPaginationInstance {
     products: ProductInstance[];
     pagination: {
@@ -13,11 +17,27 @@ export default class ProductPaginationInstance {
         prevPage: number | null;
     };
     private productAPI;
+    /**
+     * Creates a new ProductPaginationInstance
+     * @param api - The ProductAPI instance for making API calls
+     * @param results - The paginated product results from the API
+     */
     constructor(api: any, results: ProductsResponse);
     /**
      * Custom toJSON method to control what gets serialized when logging
+     * @returns Serialized products and pagination data
      */
     toJSON(): Record<string, any>;
+    /**
+     * Fetches the next page of products
+     * @returns Promise resolving to a new ProductPaginationInstance for the next page
+     * @throws Error if there is no next page available
+     */
     nextPage(): Promise<ProductPaginationInstance>;
+    /**
+     * Fetches the previous page of products
+     * @returns Promise resolving to a new ProductPaginationInstance for the previous page
+     * @throws Error if there is no previous page available
+     */
     prevPage(): Promise<ProductPaginationInstance>;
 }

package/dist/common/product.pagination.instance.js

@@ -1,5 +1,14 @@
-import ProductInstance from "./product.instance";
+import ProductInstance from "./product.instance.js";
+/**
+ * Product pagination instance class providing a fluent API for paginated product results
+ * Provides methods for navigating through pages of products
+ */
 export default class ProductPaginationInstance {
+    /**
+     * Creates a new ProductPaginationInstance
+     * @param api - The ProductAPI instance for making API calls
+     * @param results - The paginated product results from the API
+     */
     constructor(api, results) {
         this.products = results.data?.map(product => new ProductInstance(api, product)) || [];
         this.pagination = results.pagination || {
@@ -22,6 +31,7 @@ export default class ProductPaginationInstance {
     }
     /**
      * Custom toJSON method to control what gets serialized when logging
+     * @returns Serialized products and pagination data
      */
     toJSON() {
         return {
@@ -31,6 +41,7 @@ export default class ProductPaginationInstance {
     }
     /**
      * Custom inspect method for Node.js console.log
+     * @returns Formatted products and pagination data for console output
      */
     [Symbol.for('nodejs.util.inspect.custom')]() {
         return {
@@ -38,12 +49,22 @@ export default class ProductPaginationInstance {
             pagination: this.pagination
         };
     }
+    /**
+     * Fetches the next page of products
+     * @returns Promise resolving to a new ProductPaginationInstance for the next page
+     * @throws Error if there is no next page available
+     */
     async nextPage() {
         if (!this.pagination.nextPage) {
             throw new Error('No next page');
         }
         return await this.productAPI.get(this.pagination.nextPage, this.pagination.limit);
     }
+    /**
+     * Fetches the previous page of products
+     * @returns Promise resolving to a new ProductPaginationInstance for the previous page
+     * @throws Error if there is no previous page available
+     */
     async prevPage() {
         if (!this.pagination.prevPage) {
             throw new Error('No previous page');

package/dist/common/product.search.instance.d.ts

@@ -1,12 +1,22 @@
-import { SearchProductsResponse } from "../interfaces/product";
-import { ProductAPI } from "../types";
-import ProductInstance from "./product.instance";
+import { SearchProductsResponse } from "../interfaces/product.js";
+import { ProductAPI } from "../types/index.js";
+import ProductInstance from "./product.instance.js";
+/**
+ * Product search instance class providing a fluent API for product search results
+ * Contains an array of ProductInstance objects matching the search query
+ */
 export default class ProductSearchInstance {
     products: ProductInstance[];
     private productAPI;
+    /**
+     * Creates a new ProductSearchInstance
+     * @param api - The ProductAPI instance for making API calls
+     * @param results - The product search results from the API
+     */
     constructor(api: ProductAPI, results: SearchProductsResponse);
     /**
      * Custom toJSON method to control what gets serialized when logging
+     * @returns Serialized search results with product data
      */
     toJSON(): Record<string, any>;
 }

package/dist/common/product.search.instance.js

@@ -1,5 +1,14 @@
-import ProductInstance from "./product.instance";
+import ProductInstance from "./product.instance.js";
+/**
+ * Product search instance class providing a fluent API for product search results
+ * Contains an array of ProductInstance objects matching the search query
+ */
 export default class ProductSearchInstance {
+    /**
+     * Creates a new ProductSearchInstance
+     * @param api - The ProductAPI instance for making API calls
+     * @param results - The product search results from the API
+     */
     constructor(api, results) {
         this.products = results.data?.map(product => new ProductInstance(api, product)) || [];
         // Make productAPI non-enumerable so it doesn't show up in console.log
@@ -12,6 +21,7 @@ export default class ProductSearchInstance {
     }
     /**
      * Custom toJSON method to control what gets serialized when logging
+     * @returns Serialized search results with product data
      */
     toJSON() {
         return {
@@ -20,6 +30,7 @@ export default class ProductSearchInstance {
     }
     /**
      * Custom inspect method for Node.js console.log
+     * @returns Formatted search results for console output
      */
     [Symbol.for('nodejs.util.inspect.custom')]() {
         return {

package/dist/common/user.instance.d.ts

@@ -1,17 +1,41 @@
-import { UserData } from "../interfaces/admin";
-import { UserDataAPI } from "../types";
+import { UserData } from "../interfaces/admin.js";
+import { UserDataAPI } from "../types/index.js";
+/**
+ * User data instance class providing a fluent API for managing user data
+ * Automatically sanitizes sensitive fields and provides methods for updating and clearing data
+ */
 export default class UserDataInstance {
     data: Record<string, any>;
     private userAPI;
+    /**
+     * Creates a new UserDataInstance
+     * @param api - The UserDataAPI instance for making API calls
+     * @param data - The user data from the API (will be sanitized automatically)
+     */
     constructor(api: UserDataAPI, data: UserData);
     /**
-     * Remove sensitive fields from the data before storing
+     * Removes sensitive fields from the data before storing
+     * @param data - The raw user data to sanitize
+     * @returns Sanitized data with sensitive fields removed
+     * @private
      */
     private sanitizeData;
     /**
      * Custom toJSON method to control what gets serialized when logging
+     * @returns Serialized user data
      */
     toJSON(): Record<string, any>;
+    /**
+     * Updates the user's data
+     * @param data - The data fields to update or add to user data
+     * @returns Promise resolving to the updated sanitized user data
+     * @throws Error if the update fails
+     */
     update(data: Record<string, any>): Promise<any>;
+    /**
+     * Clears all user data for the current user
+     * @returns Promise resolving to true if clearing was successful
+     * @throws Error if the clear operation fails
+     */
     clear(): Promise<boolean>;
 }

package/dist/common/user.instance.js

@@ -1,4 +1,13 @@
+/**
+ * User data instance class providing a fluent API for managing user data
+ * Automatically sanitizes sensitive fields and provides methods for updating and clearing data
+ */
 export default class UserDataInstance {
+    /**
+     * Creates a new UserDataInstance
+     * @param api - The UserDataAPI instance for making API calls
+     * @param data - The user data from the API (will be sanitized automatically)
+     */
     constructor(api, data) {
         this.data = this.sanitizeData(data);
         // Make userAPI non-enumerable so it doesn't show up in console.log
@@ -10,7 +19,10 @@ export default class UserDataInstance {
         });
     }
     /**
-     * Remove sensitive fields from the data before storing
+     * Removes sensitive fields from the data before storing
+     * @param data - The raw user data to sanitize
+     * @returns Sanitized data with sensitive fields removed
+     * @private
      */
     sanitizeData(data) {
         if (!data || typeof data !== 'object') {
@@ -27,20 +39,24 @@ export default class UserDataInstance {
     }
     /**
      * Custom toJSON method to control what gets serialized when logging
+     * @returns Serialized user data
      */
     toJSON() {
-        return {
-            data: this.data
-        };
+        return this.data;
     }
     /**
      * Custom inspect method for Node.js console.log
+     * @returns Formatted user data for console output
      */
     [Symbol.for('nodejs.util.inspect.custom')]() {
-        return {
-            data: this.data
-        };
+        return this.data;
     }
+    /**
+     * Updates the user's data
+     * @param data - The data fields to update or add to user data
+     * @returns Promise resolving to the updated sanitized user data
+     * @throws Error if the update fails
+     */
     async update(data) {
         try {
             const response = await this.userAPI.update(data);
@@ -51,6 +67,11 @@ export default class UserDataInstance {
             throw new Error('Failed to update user data');
         }
     }
+    /**
+     * Clears all user data for the current user
+     * @returns Promise resolving to true if clearing was successful
+     * @throws Error if the clear operation fails
+     */
     async clear() {
         try {
             await this.userAPI.clear();

package/dist/config/auth.constants.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Constants for authentication service
+ */
+/**
+ * Keytar service name for secure credential storage
+ */
+export declare const KEYTAR_SERVICE = "lua-cli";
+/**
+ * Keytar account name for API key storage
+ */
+export declare const KEYTAR_ACCOUNT = "api-key";

package/dist/config/auth.constants.js

@@ -0,0 +1,11 @@
+/**
+ * Constants for authentication service
+ */
+/**
+ * Keytar service name for secure credential storage
+ */
+export const KEYTAR_SERVICE = "lua-cli";
+/**
+ * Keytar account name for API key storage
+ */
+export const KEYTAR_ACCOUNT = "api-key";

package/dist/config/compile.constants.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Constants for the compile command
+ */
+import { BuildOptions } from "esbuild";
+/**
+ * Directory names used during compilation
+ */
+export declare const COMPILE_DIRS: {
+    readonly DIST: "dist";
+    readonly LUA: ".lua";
+    readonly TOOLS: "tools";
+};
+/**
+ * File names used during compilation
+ */
+export declare const COMPILE_FILES: {
+    readonly DEPLOYMENT_JSON: "deployment.json";
+    readonly DEPLOY_JSON: "deploy.json";
+    readonly INDEX_TS: "index.ts";
+    readonly INDEX_JS: "index.js";
+    readonly PACKAGE_JSON: "package.json";
+    readonly TSCONFIG_JSON: "tsconfig.json";
+    readonly LUA_SKILL_YAML: "lua.skill.yaml";
+};
+/**
+ * Default values for skill metadata
+ */
+export declare const SKILL_DEFAULTS: {
+    readonly NAME: "lua-skill";
+    readonly VERSION: "1.0.0";
+    readonly DESCRIPTION: "";
+    readonly CONTEXT: "";
+};
+/**
+ * External packages that should not be bundled with tools
+ * These are either lua-cli modules, native modules, or modules
+ * that should be provided by the runtime environment
+ */
+export declare const EXTERNAL_PACKAGES: readonly ["lua-cli/skill", "lua-cli", "lua-cli/user-data-api", "lua-cli/product-api", "lua-cli/custom-data-api", "zod", "keytar", "esbuild", "commander", "inquirer", "node-fetch", "ws", "socket.io-client", "ts-morph"];
+/**
+ * Common esbuild configuration for tool bundling
+ */
+export declare const ESBUILD_TOOL_CONFIG: Partial<BuildOptions>;
+/**
+ * Common esbuild configuration for main index bundling
+ */
+export declare const ESBUILD_INDEX_CONFIG: Partial<BuildOptions>;
+/**
+ * Default input schema for tools without explicit schema
+ */
+export declare const DEFAULT_INPUT_SCHEMA: {
+    readonly type: "object";
+};
+/**
+ * JSON formatting options
+ */
+export declare const JSON_FORMAT: {
+    readonly INDENT: 2;
+};
+/**
+ * YAML formatting options
+ */
+export declare const YAML_FORMAT: {
+    readonly INDENT: 2;
+    readonly LINE_WIDTH: -1;
+    readonly NO_REFS: true;
+};