@viu/emporix-sdk 2.31.1 → 2.33.1

package/dist/index.cjs

@@ -737,7 +737,25 @@ var HttpClient = class {
       ...o.body !== void 0 && !isFormData ? { "Content-Type": "application/json" } : {}
     };
   }
+  /**
+   * Issues a request and returns the parsed body. Retries 5xx/429 on idempotent
+   * methods and re-auths once on a 401 — see {@link send}.
+   */
   async request(o) {
+    return (await this.send(o)).data;
+  }
+  /**
+   * Like {@link request}, but also hands back the response headers.
+   *
+   * Emporix puts pagination metadata there — `X-Total-Count` and, on the schema
+   * service's custom instances, `X-Next-Cursor` / `X-Prev-Cursor`. Facades
+   * should reach for `core/paged.ts`'s `requestPage` rather than calling this
+   * directly; it exists for metadata that does not fit the paginated shape.
+   */
+  async requestWithMeta(o) {
+    return this.send(o);
+  }
+  async send(o) {
     const requestId = `req-${++requestSeq}`;
     const log = this.opts.logger.child({ requestId });
     const url = new URL(this.opts.host + o.path);
@@ -804,7 +822,7 @@ var HttpClient = class {
       const parsed = text ? safeJson(text) : void 0;
       if (res.ok) {
         log.debug("http ok", { status: res.status });
-        return parsed;
+        return { data: parsed, headers: res.headers };
       }
       if (res.status === 401) {
         if (sdkManaged && !reauthed) {
@@ -965,7 +983,7 @@ var HttpClient = class {
 };
 
 // package.json
-var version = "2.31.1";
+var version = "2.33.1";
 
 // src/version.ts
 var SDK_VERSION = version;
@@ -1316,6 +1334,33 @@ async function* iterateAll(fetchPage, start = 1) {
   }
 }
 
+// src/core/paged.ts
+function intHeader(headers, name) {
+  const raw = headers.get(name);
+  if (raw === null || raw.trim() === "") return void 0;
+  const n = Number(raw);
+  return Number.isInteger(n) && n >= 0 ? n : void 0;
+}
+async function requestPage(http, o, page) {
+  const { data, headers } = await http.requestWithMeta(
+    page.totalCount === true ? { ...o, headers: { ...o.headers ?? {}, "X-Total-Count": "true" } } : o
+  );
+  const items = data ?? [];
+  const totalCount = intHeader(headers, "X-Total-Count");
+  const nextCursor = headers.get("X-Next-Cursor") ?? void 0;
+  const prevCursor = headers.get("X-Prev-Cursor") ?? void 0;
+  const hasNextPage = nextCursor !== void 0 ? true : totalCount !== void 0 ? page.pageNumber * page.pageSize < totalCount : items.length === page.pageSize;
+  return {
+    items,
+    pageNumber: page.pageNumber,
+    pageSize: page.pageSize,
+    hasNextPage,
+    ...totalCount === void 0 ? {} : { totalCount },
+    ...nextCursor === void 0 ? {} : { nextCursor },
+    ...prevCursor === void 0 ? {} : { prevCursor }
+  };
+}
+
 // src/core/query.ts
 function resolveQuery(q, cap) {
   if (typeof q === "string") return q;
@@ -1360,13 +1405,20 @@ var ProductService = class {
   async list(params = {}, auth2 = ANON) {
     const pageNumber = params.pageNumber ?? 1;
     const pageSize = params.pageSize ?? 50;
-    const items = await this.ctx.http.request({
-      method: "GET",
-      path: `/product/${this.ctx.tenant}/products`,
-      query: { pageNumber, pageSize },
-      auth: auth2
-    });
-    return { items, pageNumber, pageSize, hasNextPage: items.length === pageSize };
+    return requestPage(
+      this.ctx.http,
+      {
+        method: "GET",
+        path: `/product/${this.ctx.tenant}/products`,
+        query: { pageNumber, pageSize },
+        auth: auth2
+      },
+      {
+        pageNumber,
+        pageSize,
+        ...params.totalCount === void 0 ? {} : { totalCount: params.totalCount }
+      }
+    );
   }
   /** Async-iterates every product across pages. */
   listAll(params = {}, auth2 = ANON) {
@@ -1382,13 +1434,20 @@ var ProductService = class {
     const q = resolveQuery(query, { compoundLogicalQuery: true });
     const pageNumber = params.pageNumber ?? 1;
     const pageSize = params.pageSize ?? 50;
-    const items = await this.ctx.http.request({
-      method: "GET",
-      path: `/product/${this.ctx.tenant}/products`,
-      query: { q, pageNumber, pageSize },
-      auth: auth2
-    });
-    return { items, pageNumber, pageSize, hasNextPage: items.length === pageSize };
+    return requestPage(
+      this.ctx.http,
+      {
+        method: "GET",
+        path: `/product/${this.ctx.tenant}/products`,
+        query: { q, pageNumber, pageSize },
+        auth: auth2
+      },
+      {
+        pageNumber,
+        pageSize,
+        ...params.totalCount === void 0 ? {} : { totalCount: params.totalCount }
+      }
+    );
   }
   /**
    * Free-text product search by name. The product `q` is a `field:value` DSL,
@@ -1724,13 +1783,20 @@ var CategoryService = class {
   async list(params = {}, auth2 = ANON2) {
     const pageNumber = params.pageNumber ?? 1;
     const pageSize = params.pageSize ?? 50;
-    const items = await this.ctx.http.request({
-      method: "GET",
-      path: `/category/${this.ctx.tenant}/categories`,
-      query: { pageNumber, pageSize },
-      auth: auth2
-    });
-    return { items, pageNumber, pageSize, hasNextPage: items.length === pageSize };
+    return requestPage(
+      this.ctx.http,
+      {
+        method: "GET",
+        path: `/category/${this.ctx.tenant}/categories`,
+        query: { pageNumber, pageSize },
+        auth: auth2
+      },
+      {
+        pageNumber,
+        pageSize,
+        ...params.totalCount === void 0 ? {} : { totalCount: params.totalCount }
+      }
+    );
   }
   /**
    * Searches categories by a `q` filter — a raw Emporix DSL string or a built
@@ -1741,13 +1807,20 @@ var CategoryService = class {
     const q = resolveQuery(query, { compoundLogicalQuery: false });
     const pageNumber = params.pageNumber ?? 1;
     const pageSize = params.pageSize ?? 50;
-    const items = await this.ctx.http.request({
-      method: "GET",
-      path: `/category/${this.ctx.tenant}/categories`,
-      query: { q, pageNumber, pageSize },
-      auth: auth2
-    });
-    return { items, pageNumber, pageSize, hasNextPage: items.length === pageSize };
+    return requestPage(
+      this.ctx.http,
+      {
+        method: "GET",
+        path: `/category/${this.ctx.tenant}/categories`,
+        query: { q, pageNumber, pageSize },
+        auth: auth2
+      },
+      {
+        pageNumber,
+        pageSize,
+        ...params.totalCount === void 0 ? {} : { totalCount: params.totalCount }
+      }
+    );
   }
   /** Async-iterates every category across pages. */
   listAll(params = {}, auth2 = ANON2) {
@@ -1817,6 +1890,12 @@ var CategoryService = class {
    * references, and resolves them to full products via `/products/search`.
    * `hasNextPage` reflects the assignments page (the source of truth for
    * pagination).
+   *
+   * No `totalCount` opt-in here, deliberately. `X-Total-Count` on the
+   * assignments request would count **assignments** — including the `CATEGORY`
+   * references filtered out below — not the products this returns. A number
+   * that is wrong in the way that is hardest to notice. Same reason
+   * `segments.listMyProducts` stays on the guess.
    */
   async productsIn(categoryId, params = {}, auth2 = ANON2) {
     const pageNumber = params.pageNumber ?? 1;
@@ -1958,22 +2037,29 @@ var CategoryService = class {
     const q = resolveQuery(query, { compoundLogicalQuery: false });
     const pageNumber = params.pageNumber ?? 1;
     const pageSize = params.pageSize ?? 50;
-    const items = await this.ctx.http.request({
-      method: "POST",
-      path: `/category/${this.ctx.tenant}/categories/search`,
-      query: {
+    return requestPage(
+      this.ctx.http,
+      {
+        method: "POST",
+        path: `/category/${this.ctx.tenant}/categories/search`,
+        query: {
+          pageNumber,
+          pageSize,
+          ...params.sort === void 0 ? {} : { sort: params.sort },
+          ...params.showRoots === void 0 ? {} : { showRoots: String(params.showRoots) },
+          ...params.showUnpublished === void 0 ? {} : { showUnpublished: String(params.showUnpublished) }
+        },
+        body: { q },
+        idempotent: true,
+        // pure read over POST — safe to replay on 5xx/429
+        auth: auth2
+      },
+      {
         pageNumber,
         pageSize,
-        ...params.sort === void 0 ? {} : { sort: params.sort },
-        ...params.showRoots === void 0 ? {} : { showRoots: String(params.showRoots) },
-        ...params.showUnpublished === void 0 ? {} : { showUnpublished: String(params.showUnpublished) }
-      },
-      body: { q },
-      idempotent: true,
-      // pure read over POST — safe to replay on 5xx/429
-      auth: auth2
-    });
-    return { items, pageNumber, pageSize, hasNextPage: items.length === pageSize };
+        ...params.totalCount === void 0 ? {} : { totalCount: params.totalCount }
+      }
+    );
   }
   /**
    * Searches category trees via `POST /category-trees/search` — returns the
@@ -3036,18 +3122,17 @@ var MediaService = class {
   async list(query = {}, auth2 = SERVICE5) {
     const pageNumber = query.pageNumber ?? 1;
     const pageSize = query.pageSize ?? 60;
-    const items = await this.ctx.http.request({
-      method: "GET",
-      path: this.base(),
-      auth: auth2,
-      query: { ...query, pageNumber, pageSize }
-    });
-    return {
-      items,
-      pageNumber,
-      pageSize,
-      hasNextPage: items.length === pageSize
-    };
+    const { totalCount, ...rest } = query;
+    return requestPage(
+      this.ctx.http,
+      {
+        method: "GET",
+        path: this.base(),
+        auth: auth2,
+        query: { ...rest, pageNumber, pageSize }
+      },
+      { pageNumber, pageSize, ...totalCount === void 0 ? {} : { totalCount } }
+    );
   }
   /** Fetch an asset by id. */
   async get(assetId, auth2 = SERVICE5) {
@@ -3339,6 +3424,11 @@ var SegmentService = class {
    * the whole batch (`Promise.all`); use the id-list method + your own
    * tolerance strategy if partial success matters.
    */
+  // No `totalCount` opt-in, deliberately. This pages over the segment's
+  // ASSIGNMENTS and hydrates the hits in a second call, so `X-Total-Count` would
+  // count assignments — including the CATEGORY entries filtered out below — not
+  // the products returned. A number that is wrong in the way that is hardest to
+  // notice. Same reason `categories.productsIn` stays on the guess.
   async listMyProducts(query, auth2) {
     const pageNumber = query?.pageNumber ?? 1;
     const pageSize = query?.pageSize ?? 20;
@@ -3358,6 +3448,7 @@ var SegmentService = class {
    * real categories via one bulk `categories.searchByIds` call. Same
    * `hasNextPage` semantic as `listMyProducts`.
    */
+  // No `totalCount` opt-in — see the note on {@link listMyProducts}.
   async listMyCategories(query, auth2) {
     const pageNumber = query?.pageNumber ?? 1;
     const pageSize = query?.pageSize ?? 20;
@@ -4240,14 +4331,21 @@ var OrdersService = class {
       setIfDefined2(query, "q", resolveQuery(opts.q, { compoundLogicalQuery: false }));
     }
     const headers = this.saasHeader(opts.saasToken);
-    const items = await this.ctx.http.request({
-      method: "GET",
-      path: this.base(),
-      query,
-      auth: auth2,
-      ...headers ? { headers } : {}
-    });
-    return { items, pageNumber, pageSize, hasNextPage: items.length === pageSize };
+    return requestPage(
+      this.ctx.http,
+      {
+        method: "GET",
+        path: this.base(),
+        query,
+        auth: auth2,
+        ...headers ? { headers } : {}
+      },
+      {
+        pageNumber,
+        pageSize,
+        ...opts.totalCount === void 0 ? {} : { totalCount: opts.totalCount }
+      }
+    );
   }
   /** Fetches one of the calling customer's orders by id. */
   async get(orderId, auth2, opts = {}) {
@@ -4290,14 +4388,21 @@ var OrdersService = class {
       setIfDefined2(query, "q", resolveQuery(opts.q, { compoundLogicalQuery: false }));
     }
     const headers = this.saasHeader(opts.saasToken);
-    const items = await this.ctx.http.request({
-      method: "GET",
-      path: `/order-v2/${this.ctx.tenant}/legal-entity-orders/${legalEntityId}`,
-      query,
-      auth: auth2,
-      ...headers ? { headers } : {}
-    });
-    return { items, pageNumber, pageSize, hasNextPage: items.length === pageSize };
+    return requestPage(
+      this.ctx.http,
+      {
+        method: "GET",
+        path: `/order-v2/${this.ctx.tenant}/legal-entity-orders/${legalEntityId}`,
+        query,
+        auth: auth2,
+        ...headers ? { headers } : {}
+      },
+      {
+        pageNumber,
+        pageSize,
+        ...opts.totalCount === void 0 ? {} : { totalCount: opts.totalCount }
+      }
+    );
   }
   /**
    * Fetches one order within a legal entity
@@ -4352,13 +4457,20 @@ var SalesOrdersService = class {
     if (opts.q !== void 0) {
       setIfDefined2(query, "q", resolveQuery(opts.q, { compoundLogicalQuery: false }));
     }
-    const items = await this.ctx.http.request({
-      method: "GET",
-      path: this.base(),
-      query,
-      auth: auth2
-    });
-    return { items, pageNumber, pageSize, hasNextPage: items.length === pageSize };
+    return requestPage(
+      this.ctx.http,
+      {
+        method: "GET",
+        path: this.base(),
+        query,
+        auth: auth2
+      },
+      {
+        pageNumber,
+        pageSize,
+        ...opts.totalCount === void 0 ? {} : { totalCount: opts.totalCount }
+      }
+    );
   }
   /** Searches tenant sales-orders (`POST /salesorders/search`, body carries the `q` filter). */
   async search(query, auth2, opts = {}) {
@@ -4530,18 +4642,25 @@ var AvailabilityService = class {
   async listForSite(siteCode, params = {}, auth2 = ANON7) {
     const pageNumber = params.pageNumber ?? 1;
     const pageSize = params.pageSize ?? 50;
-    const items = await this.ctx.http.request({
-      method: "GET",
-      path: `/availability/${this.ctx.tenant}/availability/site/${encodeURIComponent(siteCode)}`,
-      query: {
+    return requestPage(
+      this.ctx.http,
+      {
+        method: "GET",
+        path: `/availability/${this.ctx.tenant}/availability/site/${encodeURIComponent(siteCode)}`,
+        query: {
+          pageNumber,
+          pageSize,
+          ...params.q === void 0 ? {} : { q: params.q },
+          ...params.sort === void 0 ? {} : { sort: params.sort }
+        },
+        auth: auth2
+      },
+      {
         pageNumber,
         pageSize,
-        ...params.q === void 0 ? {} : { q: params.q },
-        ...params.sort === void 0 ? {} : { sort: params.sort }
-      },
-      auth: auth2
-    });
-    return { items, pageNumber, pageSize, hasNextPage: items.length === pageSize };
+        ...params.totalCount === void 0 ? {} : { totalCount: params.totalCount }
+      }
+    );
   }
   // --- Admin writes. Default auth: service. ---
   /**
@@ -5038,13 +5157,17 @@ var FeeService = class {
   async list(query = {}, auth2 = SERVICE13) {
     const pageNumber = query.pageNumber ?? 1;
     const pageSize = query.pageSize ?? 60;
-    const items = await this.ctx.http.request({
-      method: "GET",
-      path: this.feesBase(),
-      auth: auth2,
-      query: { ...query, pageNumber, pageSize }
-    });
-    return { items, pageNumber, pageSize, hasNextPage: items.length === pageSize };
+    const { totalCount, ...rest } = query;
+    return requestPage(
+      this.ctx.http,
+      {
+        method: "GET",
+        path: this.feesBase(),
+        auth: auth2,
+        query: { ...rest, pageNumber, pageSize }
+      },
+      { pageNumber, pageSize, ...totalCount === void 0 ? {} : { totalCount } }
+    );
   }
   /** Retrieve one fee definition by id. */
   async get(id, auth2 = SERVICE13) {
@@ -5385,13 +5508,20 @@ var SchemaService = class {
     const q = { pageNumber, pageSize };
     if (query.q) q.q = query.q;
     if (query.type) q.type = query.type;
-    const items = await this.ctx.http.request({
-      method: "GET",
-      path: this.schemasBase(),
-      auth: auth2,
-      query: q
-    });
-    return { items, pageNumber, pageSize, hasNextPage: items.length === pageSize };
+    return requestPage(
+      this.ctx.http,
+      {
+        method: "GET",
+        path: this.schemasBase(),
+        auth: auth2,
+        query: q
+      },
+      {
+        pageNumber,
+        pageSize,
+        ...query.totalCount === void 0 ? {} : { totalCount: query.totalCount }
+      }
+    );
   }
   /** Retrieve one schema by id. */
   async getSchema(id, auth2 = SERVICE15) {
@@ -5517,13 +5647,41 @@ var SchemaService = class {
   async listInstances(type, query = {}, auth2 = SERVICE15) {
     const pageNumber = query.pageNumber ?? 1;
     const pageSize = query.pageSize ?? 60;
-    const items = await this.ctx.http.request({
-      method: "GET",
-      path: this.instancesBase(type),
-      auth: auth2,
-      query: { ...query, pageNumber, pageSize }
-    });
-    return { items, pageNumber, pageSize, hasNextPage: items.length === pageSize };
+    const { totalCount, ...rest } = query;
+    return requestPage(
+      this.ctx.http,
+      {
+        method: "GET",
+        path: this.instancesBase(type),
+        auth: auth2,
+        query: { ...rest, pageNumber, pageSize }
+      },
+      { pageNumber, pageSize, ...totalCount === void 0 ? {} : { totalCount } }
+    );
+  }
+  /**
+   * Async-iterates every instance of a type.
+   *
+   * Not built on `iterateAll`: that helper drives pagination by page number, and
+   * the server ignores `pageNumber` the moment a cursor is in play. This follows
+   * `nextCursor` while the server offers one and falls back to `pageNumber + 1`
+   * when it does not — so it is correct whether or not the tenant's deployment
+   * emits cursor headers on a request that carries no cursor.
+   */
+  async *listAllInstances(type, query = {}, auth2 = SERVICE15) {
+    let cursor;
+    let pageNumber = 1;
+    for (; ; ) {
+      const page = await this.listInstances(
+        type,
+        { ...query, pageNumber, ...cursor === void 0 ? {} : { next: cursor } },
+        auth2
+      );
+      for (const item of page.items) yield item;
+      if (!page.hasNextPage) return;
+      cursor = page.nextCursor;
+      if (cursor === void 0) pageNumber += 1;
+    }
   }
   /** Retrieve one instance by id. */
   async getInstance(type, id, auth2 = SERVICE15) {
@@ -5657,15 +5815,26 @@ var SchemaService = class {
   /**
    * Structured search over a custom entity's instances
    * (`POST /instances/search`), wrapped in {@link PaginatedItems}.
+   *
+   * The `query` parameter is third and `auth` fourth. This used to forward no
+   * query parameters at all and report a hard-coded `hasNextPage: false`, so a
+   * search could only ever return the server's default first page.
    */
-  async searchInstances(type, body, auth2 = SERVICE15) {
-    const items = await this.ctx.http.request({
-      method: "POST",
-      path: `${this.instancesBase(type)}/search`,
-      auth: auth2,
-      body
-    });
-    return { items, pageNumber: 1, pageSize: items.length, hasNextPage: false };
+  async searchInstances(type, body, query = {}, auth2 = SERVICE15) {
+    const pageNumber = query.pageNumber ?? 1;
+    const pageSize = query.pageSize ?? 60;
+    const { totalCount, ...rest } = query;
+    return requestPage(
+      this.ctx.http,
+      {
+        method: "POST",
+        path: `${this.instancesBase(type)}/search`,
+        auth: auth2,
+        body,
+        query: { ...rest, pageNumber, pageSize }
+      },
+      { pageNumber, pageSize, ...totalCount === void 0 ? {} : { totalCount } }
+    );
   }
   // --- (E) References ------------------------------------------------------
   /**
@@ -5686,13 +5855,20 @@ var SchemaService = class {
       if (query.q) q.q = query.q;
       if (query.fields) q.fields = query.fields;
       if (query.type) q.type = query.type;
-      const items = await this.ctx.http.request({
-        method: "GET",
-        path: this.referencesBase(),
-        auth: auth2,
-        query: q
-      });
-      return { items, pageNumber, pageSize, hasNextPage: items.length === pageSize };
+      return requestPage(
+        this.ctx.http,
+        {
+          method: "GET",
+          path: this.referencesBase(),
+          auth: auth2,
+          query: q
+        },
+        {
+          pageNumber,
+          pageSize,
+          ...query.totalCount === void 0 ? {} : { totalCount: query.totalCount }
+        }
+      );
     },
     /** Retrieve one reference by id. */
     get: async (id, auth2 = SERVICE15) => this.ctx.http.request({
@@ -7257,13 +7433,20 @@ var QuoteService = class {
     const q = { pageNumber, pageSize };
     if (query.q) q.q = query.q;
     if (query.sort) q.sort = query.sort;
-    const items = await this.ctx.http.request({
-      method: "GET",
-      path: this.quotesBase(),
-      auth: auth2,
-      query: q
-    });
-    return { items, pageNumber, pageSize, hasNextPage: items.length === pageSize };
+    return requestPage(
+      this.ctx.http,
+      {
+        method: "GET",
+        path: this.quotesBase(),
+        auth: auth2,
+        query: q
+      },
+      {
+        pageNumber,
+        pageSize,
+        ...query.totalCount === void 0 ? {} : { totalCount: query.totalCount }
+      }
+    );
   }
   /** Create a quote (`POST /quotes`, 201). */
   async create(draft, auth2) {
@@ -7333,13 +7516,20 @@ var QuoteReasonsResource = class {
   async list(query, auth2) {
     const pageNumber = query.pageNumber ?? 1;
     const pageSize = query.pageSize ?? 60;
-    const items = await this.ctx.http.request({
-      method: "GET",
-      path: this.base(),
-      auth: auth2,
-      query: { pageNumber, pageSize }
-    });
-    return { items, pageNumber, pageSize, hasNextPage: items.length === pageSize };
+    return requestPage(
+      this.ctx.http,
+      {
+        method: "GET",
+        path: this.base(),
+        auth: auth2,
+        query: { pageNumber, pageSize }
+      },
+      {
+        pageNumber,
+        pageSize,
+        ...query.totalCount === void 0 ? {} : { totalCount: query.totalCount }
+      }
+    );
   }
   /** Retrieve one reason by id. */
   async get(reasonId, auth2) {
@@ -7567,13 +7757,20 @@ var IndexingService = class {
     const pageSize = opts.pageSize ?? 50;
     const query = { pageNumber, pageSize };
     if (opts.q !== void 0) query.q = opts.q;
-    const items = await this.ctx.http.request({
-      method: "GET",
-      path: `${this.base()}/reindex-jobs`,
-      query,
-      auth: auth2
-    });
-    return { items, pageNumber, pageSize, hasNextPage: items.length === pageSize };
+    return requestPage(
+      this.ctx.http,
+      {
+        method: "GET",
+        path: `${this.base()}/reindex-jobs`,
+        query,
+        auth: auth2
+      },
+      {
+        pageNumber,
+        pageSize,
+        ...opts.totalCount === void 0 ? {} : { totalCount: opts.totalCount }
+      }
+    );
   }
   /** Fetch one reindex job by id. */
   async getReindexJob(reindexJobId, auth2 = SERVICE29) {