lua-cli 3.23.2 → 3.24.0

package/dist/api-exports.d.ts

@@ -1046,6 +1046,22 @@ export declare interface ChatHistoryMessage {
  */
 export declare type ChatMessage = TextMessage | ImageMessage | FileMessage;
 
+/**
+ * Options for creating a custom data entry.
+ */
+declare interface CreateCustomDataOptions {
+    /** Text used for semantic (vector) search indexing of this entry. */
+    searchText?: string;
+    /**
+     * Declare `data` fields this agent queries with filters, so the platform
+     * maintains agent-scoped database indexes for them. Entries are a single
+     * field path (`'business_id'`) or a compound of up to 2 paths
+     * (`['country', 'business_id']`). Idempotent — declare on every write; an
+     * index whose declaration stops arriving is removed after ~14 days.
+     */
+    index?: Array<string | string[]>;
+}
+
 /**
  * Response from creating custom data entry.
  * Includes optional similarity score for search results.
@@ -1096,7 +1112,8 @@ declare interface CustomDataAPI {
      * @param searchText - Optional text for vector search indexing
      * @returns Promise resolving to created entry (DataEntryInstance)
      */
-    create(collectionName: string, data: Record<string, any>, searchText?: string): Promise<DataEntryInstance>;
+    collections(): Promise<CustomDataCollectionsResponse>;
+    create(collectionName: string, data: Record<string, any>, optionsOrSearchText?: string | CreateCustomDataOptions): Promise<DataEntryInstance>;
     /**
      * Gets entries from a collection with filtering and pagination.
      * @param collectionName - Collection name
@@ -1121,7 +1138,7 @@ declare interface CustomDataAPI {
      * @param searchText - Optional text for vector search indexing
      * @returns Promise resolving to update response
      */
-    update(collectionName: string, entryId: string, data: Record<string, any>, searchText?: string): Promise<UpdateCustomDataResponse>;
+    update(collectionName: string, entryId: string, data: Record<string, any>, optionsOrSearchText?: string | CreateCustomDataOptions): Promise<UpdateCustomDataResponse>;
     /** Atomically sets and removes top-level entry fields and optionally changes search text. */
     patch(collectionName: string, entryId: string, mutation: {
         set?: Record<string, any>;
@@ -1146,6 +1163,29 @@ declare interface CustomDataAPI {
     delete(collectionName: string, entryId: string): Promise<DeleteCustomDataResponse>;
 }
 
+/** One collection in the agent's Data namespace, from Data.collections(). */
+declare interface CustomDataCollectionInfo {
+    name: string;
+    entryCount: number;
+    lastUpdatedAt: number;
+    firstCreatedAt: number;
+    /** Managed index declarations for this collection — present only when declared. */
+    indexes?: CustomDataIndexStatus[];
+}
+
+declare interface CustomDataCollectionsResponse {
+    data: CustomDataCollectionInfo[];
+    count: number;
+}
+
+declare interface CustomDataEntry extends IdentifiedEntity, TimestampedEntity {
+    id: string;
+    data: Record<string, any>;
+    createdAt: number;
+    updatedAt: number;
+    searchText?: string;
+}
+
 /**
  * Custom data entry.
  * Represents a single entry in a custom data collection.
@@ -1155,12 +1195,15 @@ declare interface CustomDataAPI {
  * - Vector search via searchText
  * - Automatic timestamps
  */
-declare interface CustomDataEntry extends IdentifiedEntity, TimestampedEntity {
-    id: string;
-    data: Record<string, any>;
-    createdAt: number;
-    updatedAt: number;
-    searchText?: string;
+/** Status of one managed index declaration, from the collections listing. */
+declare interface CustomDataIndexStatus {
+    fields: string[];
+    /** pending | building | ready | failed | rejected */
+    status: string;
+    /** Populated when status is failed/rejected — the reason, verbatim. */
+    error?: string;
+    lastDeclaredAt: number;
+    lastUsedAt?: number;
 }
 
 /**
@@ -1168,18 +1211,59 @@ declare interface CustomDataEntry extends IdentifiedEntity, TimestampedEntity {
  * Store and retrieve custom data with vector search capabilities
  */
 export declare const Data: {
+    /**
+     * Lists this agent's data collections, including managed index status
+     * (fields, pending/building/ready/failed/rejected, error reasons) for any
+     * declared indexes — the fastest way to diagnose a declaration.
+     *
+     * @returns Promise resolving to `{ data: CustomDataCollectionInfo[], count }`
+     */
+    collections(): Promise<CustomDataCollectionsResponse>;
     /**
      * Creates a new entry in a custom data collection.
      *
+     * Declaring indexes: if your agent FILTERS this collection (e.g.
+     * `Data.get(c, { business_id: 123 })`), declare the filtered fields here so
+     * the platform maintains an index for them:
+     *
+     * ```typescript
+     * await Data.create('inference_cache', doc, { index: ['business_id'] });
+     * // Compound index (fields queried together) — note the NESTED array:
+     * await Data.create('inference_cache', doc, { index: [['country', 'business_id']] });
+     * // ['country', 'business_id'] WITHOUT nesting = two separate single-field
+     * // indexes, which will NOT serve a combined filter efficiently.
+     * ```
+     *
+     * Index semantics — read before relying on them:
+     * - Builds are ASYNCHRONOUS: allow minutes after first declaration before
+     *   expecting fast queries. Check status via `Data.collections()`.
+     * - A compound index serves filters on its leftmost field(s) only:
+     *   `[['country','business_id']]` serves `{country}` and
+     *   `{country, business_id}`, but NOT `{business_id}` alone.
+     * - Limits: 2 fields per index, 3 declarations per call, 5 indexes per
+     *   agent. Over-limit or invalid declarations are REJECTED (visible in
+     *   index status), never silently trimmed.
+     * - Lifecycle: an index stays while your agent uses it (declaring writes OR
+     *   matching filtered reads keep it alive) and is removed ~14 days after
+     *   all usage stops. No cleanup code needed.
+     *
      * @param collectionName - Name of the collection
      * @param data - Data to store
-     * @param searchText - Optional text for vector search indexing
+     * @param optionsOrSearchText - Options object `{ searchText?, index? }`.
+     *   Passing a bare string (legacy) sets `searchText` only — easy to confuse
+     *   with an index declaration, so prefer the object form.
      * @returns Promise resolving to created entry
      */
-    create(collectionName: string, data: Record<string, any>, searchText?: string): Promise<DataEntryInstance>;
+    create(collectionName: string, data: Record<string, any>, optionsOrSearchText?: string | CreateCustomDataOptions): Promise<DataEntryInstance>;
     /**
      * Retrieves entries from a collection with optional filtering and pagination.
      *
+     * Filtering a LARGE collection? Declare the filtered fields where you store
+     * data — `Data.create(c, doc, { index: ['your_field'] })` — or queries will
+     * slow down as the collection grows and eventually fail with an error
+     * message naming the unindexed field and the declaration to add. Filtered reads on a declared field keep its index
+     * alive automatically.
+     *
      * @param collectionName - Name of the collection
      * @param filter - Optional filter criteria
      * @param page - Page number (default: 1)
@@ -1204,7 +1288,7 @@ export declare const Data: {
      * @param searchText - Optional new search text for vector search indexing
      * @returns Promise resolving to update response
      */
-    update(collectionName: string, entryId: string, data: Record<string, any>, searchText?: string): Promise<UpdateCustomDataResponse>;
+    update(collectionName: string, entryId: string, data: Record<string, any>, optionsOrSearchText?: string | CreateCustomDataOptions): Promise<UpdateCustomDataResponse>;
     /**
      * Performs vector search on a collection.
      *

package/dist/api-exports.js

@@ -4476,17 +4476,42 @@ var init_custom_data_api_service = __esm({
         this.agentId = agentId;
       }
       /**
+      * Lists the agent's data collections with entry counts, timestamps, and —
+      * when declared — managed index status (fields, pending/building/ready/
+      * failed/rejected, error reason). The place to diagnose index declarations.
+      * @returns Promise resolving to the collections listing
+      */
+      async collections() {
+        const response = await this.httpGet(`/developer/agents/${this.agentId}/custom-data`, {
+          Authorization: `Bearer ${this.apiKey}`
+        });
+        if (response.success && response.data) {
+          return response.data;
+        }
+        throw new Error(response.error?.message || "Failed to list custom data collections");
+      }
+      /**
       * Creates a new custom data entry in a specified collection
       * @param collectionName - The name of the collection to create the entry in
       * @param data - The data object to store in the entry
-      * @param searchText - Optional text to be used for semantic search indexing
+      * @param optionsOrSearchText - Either a searchText string (legacy form) or an
+      *   options object: `searchText` for semantic search indexing, and `index` to
+      *   declare data fields this agent filters on (e.g. `['business_id']` or
+      *   compounds like `[['country', 'business_id']]`). Declared fields get
+      *   agent-scoped database indexes maintained by the platform: created when
+      *   first declared, removed automatically ~14 days after the code stops
+      *   declaring them. Declaring on every write is the intended, idempotent use.
       * @returns Promise resolving to a DataEntryInstance representing the created entry
       * @throws Error if the entry creation fails or the API request is unsuccessful
       */
-      async create(collectionName, data, searchText) {
+      async create(collectionName, data, optionsOrSearchText) {
+        const options = typeof optionsOrSearchText === "string" ? {
+          searchText: optionsOrSearchText
+        } : optionsOrSearchText ?? {};
         const response = await this.httpPost(`/developer/agents/${this.agentId}/custom-data/${collectionName}`, {
           data,
-          searchText
+          searchText: options.searchText,
+          index: options.index
         }, {
           Authorization: `Bearer ${this.apiKey}`
         });
@@ -4539,14 +4564,19 @@ var init_custom_data_api_service = __esm({
       * @param collectionName - The name of the collection containing the entry
       * @param entryId - The unique identifier of the entry to update
       * @param data - The data object to update
-      * @param searchText - Optional text to be used for semantic search indexing
+      * @param optionsOrSearchText - searchText string (legacy) or { searchText?, index? };
+      *   `index` refreshes this agent's index declarations (same semantics as create)
       * @returns Promise resolving to an UpdateCustomDataResponse with the updated entry details
       * @throws Error if the entry is not found or the update fails
       */
-      async update(collectionName, entryId, data, searchText) {
+      async update(collectionName, entryId, data, optionsOrSearchText) {
+        const options = typeof optionsOrSearchText === "string" ? {
+          searchText: optionsOrSearchText
+        } : optionsOrSearchText ?? {};
         const response = await this.httpPut(`/developer/agents/${this.agentId}/custom-data/${collectionName}/${entryId}`, {
           data,
-          searchText
+          searchText: options.searchText,
+          index: options.index
         }, {
           Authorization: `Bearer ${this.apiKey}`
         });
@@ -6893,21 +6923,65 @@ var User = {
   }
 };
 var Data = {
+  /**
+  * Lists this agent's data collections, including managed index status
+  * (fields, pending/building/ready/failed/rejected, error reasons) for any
+  * declared indexes — the fastest way to diagnose a declaration.
+  *
+  * @returns Promise resolving to `{ data: CustomDataCollectionInfo[], count }`
+  */
+  async collections() {
+    const instance = await getDataInstance();
+    return instance.collections();
+  },
   /**
   * Creates a new entry in a custom data collection.
   *
+  * Declaring indexes: if your agent FILTERS this collection (e.g.
+  * `Data.get(c, { business_id: 123 })`), declare the filtered fields here so
+  * the platform maintains an index for them:
+  *
+  * ```typescript
+  * await Data.create('inference_cache', doc, { index: ['business_id'] });
+  * // Compound index (fields queried together) — note the NESTED array:
+  * await Data.create('inference_cache', doc, { index: [['country', 'business_id']] });
+  * // ['country', 'business_id'] WITHOUT nesting = two separate single-field
+  * // indexes, which will NOT serve a combined filter efficiently.
+  * ```
+  *
+  * Index semantics — read before relying on them:
+  * - Builds are ASYNCHRONOUS: allow minutes after first declaration before
+  *   expecting fast queries. Check status via `Data.collections()`.
+  * - A compound index serves filters on its leftmost field(s) only:
+  *   `[['country','business_id']]` serves `{country}` and
+  *   `{country, business_id}`, but NOT `{business_id}` alone.
+  * - Limits: 2 fields per index, 3 declarations per call, 5 indexes per
+  *   agent. Over-limit or invalid declarations are REJECTED (visible in
+  *   index status), never silently trimmed.
+  * - Lifecycle: an index stays while your agent uses it (declaring writes OR
+  *   matching filtered reads keep it alive) and is removed ~14 days after
+  *   all usage stops. No cleanup code needed.
+  *
   * @param collectionName - Name of the collection
   * @param data - Data to store
-  * @param searchText - Optional text for vector search indexing
+  * @param optionsOrSearchText - Options object `{ searchText?, index? }`.
+  *   Passing a bare string (legacy) sets `searchText` only — easy to confuse
+  *   with an index declaration, so prefer the object form.
   * @returns Promise resolving to created entry
   */
-  async create(collectionName, data, searchText) {
+  async create(collectionName, data, optionsOrSearchText) {
     const instance = await getDataInstance();
-    return instance.create(collectionName, data, searchText);
+    return instance.create(collectionName, data, optionsOrSearchText);
   },
   /**
   * Retrieves entries from a collection with optional filtering and pagination.
   *
+  * Filtering a LARGE collection? Declare the filtered fields where you store
+  * data — `Data.create(c, doc, { index: ['your_field'] })` — or queries will
+  * slow down as the collection grows and eventually fail with an error
+  * message naming the unindexed field and the declaration to add. Filtered reads on a declared field keep its index
+  * alive automatically.
+  *
   * @param collectionName - Name of the collection
   * @param filter - Optional filter criteria
   * @param page - Page number (default: 1)
@@ -6938,9 +7012,9 @@ var Data = {
   * @param searchText - Optional new search text for vector search indexing
   * @returns Promise resolving to update response
   */
-  async update(collectionName, entryId, data, searchText) {
+  async update(collectionName, entryId, data, optionsOrSearchText) {
     const instance = await getDataInstance();
-    return instance.update(collectionName, entryId, data, searchText);
+    return instance.update(collectionName, entryId, data, optionsOrSearchText);
   },
   /**
   * Performs vector search on a collection.