@viu/emporix-sdk 3.4.1 → 3.5.0

package/dist/index.d.cts

@@ -3765,6 +3765,10 @@ type AgentTrigger = {
          */
         events: string;
         filter?: CommerceEventTriggerFilter;
+        /**
+         * Optional IAM scopes used to obtain an Emporix token when the agent runs from a Commerce Event. When omitted or empty, the agent does not receive `emporix-token`. Each value must be a scope the caller is allowed to grant.
+         */
+        eventScopes?: Array<string>;
     };
 };
 /**
@@ -8810,7 +8814,7 @@ type IndexPublicConfiguration = {
  */
 type IndexConfiguration = IndexPublicConfiguration & {
     /**
-     * API key used for write purposes.
+     * API key used for write purposes. For `BATTERY_INCLUDED`, this key is validated before the configuration is created or updated.
      */
     writeKey?: string;
     /**
@@ -8876,12 +8880,21 @@ interface ListReindexJobsOptions {
     pageSize?: number;
     /** Raw Emporix `q` filter string. */
     q?: string;
+    /** Emporix sort syntax, e.g. `"metadata.createdAt:desc"`. */
+    sort?: string;
     /** Ask for `X-Total-Count` — becomes a request header, not a query parameter. */
     totalCount?: boolean;
 }
 /**
  * Emporix Indexing Service (`/indexing/{tenant}/…`): search-index provider
  * configurations and reindex. Server-side; defaults to the service token.
+ *
+ * On the `BATTERY_INCLUDED` provider every write validates the stored
+ * `indexName`/`writeKey` against the search backend *before* it takes effect:
+ * invalid credentials fail with `400` and when that validation is itself
+ * unreachable the call fails with `502`. Either way nothing is written — so a
+ * `400` from these methods can mean the credentials are wrong rather than the
+ * request body.
  */
 declare class IndexingService {
     private readonly ctx;
@@ -8892,9 +8905,9 @@ declare class IndexingService {
     listConfigurations(auth?: AuthContext): Promise<IndexConfig[]>;
     /** Get a configuration by provider name. */
     getConfiguration(provider: string, auth?: AuthContext): Promise<IndexConfig>;
-    /** Create a configuration. */
+    /** Create a configuration. Nothing is stored if credential validation fails. */
     createConfiguration(input: IndexConfig, auth?: AuthContext): Promise<IndexConfigCreated>;
-    /** Update a configuration by provider name. */
+    /** Update a configuration. Left unchanged if credential validation fails. */
     updateConfiguration(provider: string, input: IndexConfig, auth?: AuthContext): Promise<void>;
     /** Delete a configuration by provider name. */
     deleteConfiguration(provider: string, auth?: AuthContext): Promise<void>;
@@ -8907,6 +8920,9 @@ declare class IndexingService {
      * given `entityType`; set `rag: true` to also rebuild the RAG vector index
      * (PRODUCT only). Resolves to the created job (`201`) or, when a job for that
      * `entityType` is already `IN_PROGRESS`, that running job (`200`).
+     *
+     * On `BATTERY_INCLUDED` with `entityType: "PRODUCT"` the stored credentials
+     * are validated first; no job is created on the `400`/`502` cases above.
      */
     createReindexJob(input: ReindexJobInput, auth?: AuthContext): Promise<ReindexJob>;
     /** List reindex jobs (paginated). */
@@ -8914,7 +8930,8 @@ declare class IndexingService {
     /** Fetch one reindex job by id. */
     getReindexJob(reindexJobId: string, auth?: AuthContext): Promise<ReindexJob>;
     /**
-     * Trigger a reindex.
+     * Trigger a reindex. On `BATTERY_INCLUDED` the same credential validation
+     * runs first, so this can fail with `400`/`502` before any job starts.
      * @deprecated since 2026-06-18, removal 2026-12-01 — use {@link createReindexJob}
      * (`createReindexJob({ entityType: "PRODUCT" })`), which returns a trackable job.
      */

package/dist/index.d.ts

@@ -3765,6 +3765,10 @@ type AgentTrigger = {
          */
         events: string;
         filter?: CommerceEventTriggerFilter;
+        /**
+         * Optional IAM scopes used to obtain an Emporix token when the agent runs from a Commerce Event. When omitted or empty, the agent does not receive `emporix-token`. Each value must be a scope the caller is allowed to grant.
+         */
+        eventScopes?: Array<string>;
     };
 };
 /**
@@ -8810,7 +8814,7 @@ type IndexPublicConfiguration = {
  */
 type IndexConfiguration = IndexPublicConfiguration & {
     /**
-     * API key used for write purposes.
+     * API key used for write purposes. For `BATTERY_INCLUDED`, this key is validated before the configuration is created or updated.
      */
     writeKey?: string;
     /**
@@ -8876,12 +8880,21 @@ interface ListReindexJobsOptions {
     pageSize?: number;
     /** Raw Emporix `q` filter string. */
     q?: string;
+    /** Emporix sort syntax, e.g. `"metadata.createdAt:desc"`. */
+    sort?: string;
     /** Ask for `X-Total-Count` — becomes a request header, not a query parameter. */
     totalCount?: boolean;
 }
 /**
  * Emporix Indexing Service (`/indexing/{tenant}/…`): search-index provider
  * configurations and reindex. Server-side; defaults to the service token.
+ *
+ * On the `BATTERY_INCLUDED` provider every write validates the stored
+ * `indexName`/`writeKey` against the search backend *before* it takes effect:
+ * invalid credentials fail with `400` and when that validation is itself
+ * unreachable the call fails with `502`. Either way nothing is written — so a
+ * `400` from these methods can mean the credentials are wrong rather than the
+ * request body.
  */
 declare class IndexingService {
     private readonly ctx;
@@ -8892,9 +8905,9 @@ declare class IndexingService {
     listConfigurations(auth?: AuthContext): Promise<IndexConfig[]>;
     /** Get a configuration by provider name. */
     getConfiguration(provider: string, auth?: AuthContext): Promise<IndexConfig>;
-    /** Create a configuration. */
+    /** Create a configuration. Nothing is stored if credential validation fails. */
     createConfiguration(input: IndexConfig, auth?: AuthContext): Promise<IndexConfigCreated>;
-    /** Update a configuration by provider name. */
+    /** Update a configuration. Left unchanged if credential validation fails. */
     updateConfiguration(provider: string, input: IndexConfig, auth?: AuthContext): Promise<void>;
     /** Delete a configuration by provider name. */
     deleteConfiguration(provider: string, auth?: AuthContext): Promise<void>;
@@ -8907,6 +8920,9 @@ declare class IndexingService {
      * given `entityType`; set `rag: true` to also rebuild the RAG vector index
      * (PRODUCT only). Resolves to the created job (`201`) or, when a job for that
      * `entityType` is already `IN_PROGRESS`, that running job (`200`).
+     *
+     * On `BATTERY_INCLUDED` with `entityType: "PRODUCT"` the stored credentials
+     * are validated first; no job is created on the `400`/`502` cases above.
      */
     createReindexJob(input: ReindexJobInput, auth?: AuthContext): Promise<ReindexJob>;
     /** List reindex jobs (paginated). */
@@ -8914,7 +8930,8 @@ declare class IndexingService {
     /** Fetch one reindex job by id. */
     getReindexJob(reindexJobId: string, auth?: AuthContext): Promise<ReindexJob>;
     /**
-     * Trigger a reindex.
+     * Trigger a reindex. On `BATTERY_INCLUDED` the same credential validation
+     * runs first, so this can fail with `400`/`502` before any job starts.
      * @deprecated since 2026-06-18, removal 2026-12-01 — use {@link createReindexJob}
      * (`createReindexJob({ entityType: "PRODUCT" })`), which returns a trackable job.
      */

package/dist/index.js

@@ -945,7 +945,7 @@ var HttpClient = class {
 };
 
 // package.json
-var version = "3.4.1";
+var version = "3.5.0";
 
 // src/version.ts
 var SDK_VERSION = version;
@@ -4144,7 +4144,7 @@ var IndexingService = class {
       auth: auth2
     });
   }
-  /** Create a configuration. */
+  /** Create a configuration. Nothing is stored if credential validation fails. */
   async createConfiguration(input, auth2 = SERVICE21) {
     return this.ctx.http.request({
       method: "POST",
@@ -4153,7 +4153,7 @@ var IndexingService = class {
       body: input
     });
   }
-  /** Update a configuration by provider name. */
+  /** Update a configuration. Left unchanged if credential validation fails. */
   async updateConfiguration(provider, input, auth2 = SERVICE21) {
     await this.ctx.http.request({
       method: "PUT",
@@ -4187,6 +4187,9 @@ var IndexingService = class {
    * given `entityType`; set `rag: true` to also rebuild the RAG vector index
    * (PRODUCT only). Resolves to the created job (`201`) or, when a job for that
    * `entityType` is already `IN_PROGRESS`, that running job (`200`).
+   *
+   * On `BATTERY_INCLUDED` with `entityType: "PRODUCT"` the stored credentials
+   * are validated first; no job is created on the `400`/`502` cases above.
    */
   async createReindexJob(input, auth2 = SERVICE21) {
     return this.ctx.http.request({
@@ -4202,6 +4205,7 @@ var IndexingService = class {
     const pageSize = opts.pageSize ?? 50;
     const query = { pageNumber, pageSize };
     if (opts.q !== void 0) query.q = opts.q;
+    if (opts.sort !== void 0) query.sort = opts.sort;
     return requestPage(
       this.ctx.http,
       {
@@ -4226,7 +4230,8 @@ var IndexingService = class {
     });
   }
   /**
-   * Trigger a reindex.
+   * Trigger a reindex. On `BATTERY_INCLUDED` the same credential validation
+   * runs first, so this can fail with `400`/`502` before any job starts.
    * @deprecated since 2026-06-18, removal 2026-12-01 — use {@link createReindexJob}
    * (`createReindexJob({ entityType: "PRODUCT" })`), which returns a trackable job.
    */