@viu/emporix-sdk 2.31.1 → 2.32.0

package/dist/companies.d.cts

@@ -1,4 +1,4 @@
-import { C as ClientContext, b as AuthContext } from './context-CpLIDl0P.cjs';
+import { C as ClientContext, b as AuthContext } from './context-DK8jg6y5.cjs';
 import { L as LegalEntity, e as LegalEntityCreate, f as LegalEntityUpdate } from './types.gen-C_wOXYZB.cjs';
 export { A as AccountLimit, d as CustomerGroup, g as LegalInfo } from './types.gen-C_wOXYZB.cjs';
 

package/dist/companies.d.ts

@@ -1,4 +1,4 @@
-import { C as ClientContext, b as AuthContext } from './context-CpLIDl0P.js';
+import { C as ClientContext, b as AuthContext } from './context-DK8jg6y5.js';
 import { L as LegalEntity, e as LegalEntityCreate, f as LegalEntityUpdate } from './types.gen-C_wOXYZB.js';
 export { A as AccountLimit, d as CustomerGroup, g as LegalInfo } from './types.gen-C_wOXYZB.js';
 

package/dist/contacts.d.cts

@@ -1,4 +1,4 @@
-import { C as ClientContext, b as AuthContext } from './context-CpLIDl0P.cjs';
+import { C as ClientContext, b as AuthContext } from './context-DK8jg6y5.cjs';
 import { C as ContactAssignment, a as ContactAssignmentCreate, b as ContactAssignmentUpdate } from './types.gen-C_wOXYZB.cjs';
 
 /**

package/dist/contacts.d.ts

@@ -1,4 +1,4 @@
-import { C as ClientContext, b as AuthContext } from './context-CpLIDl0P.js';
+import { C as ClientContext, b as AuthContext } from './context-DK8jg6y5.js';
 import { C as ContactAssignment, a as ContactAssignmentCreate, b as ContactAssignmentUpdate } from './types.gen-C_wOXYZB.js';
 
 /**

package/dist/{context-CpLIDl0P.d.cts → context-DK8jg6y5.d.cts}

@@ -352,7 +352,11 @@ interface RequestOptions {
     method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
     path: string;
     auth: AuthContext;
-    query?: Record<string, string | number | undefined>;
+    /**
+     * Query parameters. Booleans are serialized with `String(v)`, so a facade can
+     * pass one straight through instead of stringifying it at the call site.
+     */
+    query?: Record<string, string | number | boolean | undefined>;
     body?: unknown;
     /** Extra request headers (merged before auth; cannot override Authorization). */
     headers?: Record<string, string>;
@@ -366,6 +370,17 @@ interface RequestOptions {
      */
     idempotent?: boolean;
 }
+/**
+ * A successful response: the parsed body plus its headers.
+ *
+ * `Headers` rather than the whole `Response` on purpose — by the time this
+ * returns, the body has been consumed, and a `Response` whose body cannot be
+ * read again is a trap in a caller's hands.
+ */
+interface HttpResult<T> {
+    data: T;
+    headers: Headers;
+}
 /** Construction options for {@link HttpClient}. */
 interface HttpClientOptions {
     host: string;
@@ -404,7 +419,21 @@ declare class HttpClient {
     private readonly doFetch;
     constructor(opts: HttpClientOptions);
     private buildHeaders;
+    /**
+     * Issues a request and returns the parsed body. Retries 5xx/429 on idempotent
+     * methods and re-auths once on a 401 — see {@link send}.
+     */
     request<T = unknown>(o: RequestOptions): Promise<T>;
+    /**
+     * 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.
+     */
+    requestWithMeta<T = unknown>(o: RequestOptions): Promise<HttpResult<T>>;
+    private send;
     /**
      * Single-shot fetch that returns the raw {@link Response} unparsed. Used by
      * endpoints whose responses are not JSON (binary downloads, redirect-only
@@ -448,6 +477,23 @@ interface PaginatedItems<T> {
     pageNumber: number;
     pageSize: number;
     hasNextPage: boolean;
+    /**
+     * Absolute number of matches, when the caller asked for it and the endpoint
+     * answered. Opt-in per call (`totalCount: true`), because Emporix computes it
+     * with a second query — see `core/paged.ts`.
+     *
+     * Always `undefined` in cursor mode: the server ignores the request header
+     * and omits the response header there.
+     */
+    totalCount?: number;
+    /**
+     * Opaque cursor for the next page, on the endpoints that offer one (today:
+     * the schema service's custom instances). Pass it back as the `next` query
+     * parameter. Absence means "this endpoint said nothing", NOT "last page".
+     */
+    nextCursor?: string;
+    /** Opaque cursor for the previous page. Same caveat as {@link nextCursor}. */
+    prevCursor?: string;
 }
 /**
  * Async-iterates every item across pages of a `PaginatedItems<T>` source.
@@ -458,4 +504,4 @@ interface PaginatedItems<T> {
  */
 declare function iterateAll<T>(fetchPage: (pageNumber: number) => Promise<PaginatedItems<T>>, start?: number): AsyncIterable<T>;
 
-export { type AnonymousSession as A, type ClientContext as C, DEFAULT_HOST as D, type EmporixConfig as E, HttpClient as H, LEVEL as L, type PaginatedItems as P, type RequestOptions as R, type ServiceCredentials as S, type TokenProvider as T, type AnonymousSessionStore as a, type AuthContext as b, type AuthKind as c, CustomerRefreshRegistry as d, type CustomerTokenRefresher as e, DefaultTokenProvider as f, type HttpClientOptions as g, LevelResolver as h, type LogFields as i, type LogLevel as j, type Logger as k, type LoggerConfig as l, type LoggerObjectConfig as m, type ResolvedConfig as n, type ServiceName as o, type StoredAnonymousSession as p, type StorefrontCredentials as q, auth as r, createConsoleLogger as s, createNoopLogger as t, iterateAll as u, redact as v, resolveToken as w, validateConfig as x };
+export { type AnonymousSession as A, type ClientContext as C, DEFAULT_HOST as D, type EmporixConfig as E, HttpClient as H, LEVEL as L, type PaginatedItems as P, type RequestOptions as R, type ServiceCredentials as S, type TokenProvider as T, type AnonymousSessionStore as a, type AuthContext as b, type AuthKind as c, CustomerRefreshRegistry as d, type CustomerTokenRefresher as e, DefaultTokenProvider as f, type HttpClientOptions as g, type HttpResult as h, LevelResolver as i, type LogFields as j, type LogLevel as k, type Logger as l, type LoggerConfig as m, type LoggerObjectConfig as n, type ResolvedConfig as o, type ServiceName as p, type StoredAnonymousSession as q, type StorefrontCredentials as r, auth as s, createConsoleLogger as t, createNoopLogger as u, iterateAll as v, redact as w, resolveToken as x, validateConfig as y };

package/dist/{context-CpLIDl0P.d.ts → context-DK8jg6y5.d.ts}

@@ -352,7 +352,11 @@ interface RequestOptions {
     method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
     path: string;
     auth: AuthContext;
-    query?: Record<string, string | number | undefined>;
+    /**
+     * Query parameters. Booleans are serialized with `String(v)`, so a facade can
+     * pass one straight through instead of stringifying it at the call site.
+     */
+    query?: Record<string, string | number | boolean | undefined>;
     body?: unknown;
     /** Extra request headers (merged before auth; cannot override Authorization). */
     headers?: Record<string, string>;
@@ -366,6 +370,17 @@ interface RequestOptions {
      */
     idempotent?: boolean;
 }
+/**
+ * A successful response: the parsed body plus its headers.
+ *
+ * `Headers` rather than the whole `Response` on purpose — by the time this
+ * returns, the body has been consumed, and a `Response` whose body cannot be
+ * read again is a trap in a caller's hands.
+ */
+interface HttpResult<T> {
+    data: T;
+    headers: Headers;
+}
 /** Construction options for {@link HttpClient}. */
 interface HttpClientOptions {
     host: string;
@@ -404,7 +419,21 @@ declare class HttpClient {
     private readonly doFetch;
     constructor(opts: HttpClientOptions);
     private buildHeaders;
+    /**
+     * Issues a request and returns the parsed body. Retries 5xx/429 on idempotent
+     * methods and re-auths once on a 401 — see {@link send}.
+     */
     request<T = unknown>(o: RequestOptions): Promise<T>;
+    /**
+     * 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.
+     */
+    requestWithMeta<T = unknown>(o: RequestOptions): Promise<HttpResult<T>>;
+    private send;
     /**
      * Single-shot fetch that returns the raw {@link Response} unparsed. Used by
      * endpoints whose responses are not JSON (binary downloads, redirect-only
@@ -448,6 +477,23 @@ interface PaginatedItems<T> {
     pageNumber: number;
     pageSize: number;
     hasNextPage: boolean;
+    /**
+     * Absolute number of matches, when the caller asked for it and the endpoint
+     * answered. Opt-in per call (`totalCount: true`), because Emporix computes it
+     * with a second query — see `core/paged.ts`.
+     *
+     * Always `undefined` in cursor mode: the server ignores the request header
+     * and omits the response header there.
+     */
+    totalCount?: number;
+    /**
+     * Opaque cursor for the next page, on the endpoints that offer one (today:
+     * the schema service's custom instances). Pass it back as the `next` query
+     * parameter. Absence means "this endpoint said nothing", NOT "last page".
+     */
+    nextCursor?: string;
+    /** Opaque cursor for the previous page. Same caveat as {@link nextCursor}. */
+    prevCursor?: string;
 }
 /**
  * Async-iterates every item across pages of a `PaginatedItems<T>` source.
@@ -458,4 +504,4 @@ interface PaginatedItems<T> {
  */
 declare function iterateAll<T>(fetchPage: (pageNumber: number) => Promise<PaginatedItems<T>>, start?: number): AsyncIterable<T>;
 
-export { type AnonymousSession as A, type ClientContext as C, DEFAULT_HOST as D, type EmporixConfig as E, HttpClient as H, LEVEL as L, type PaginatedItems as P, type RequestOptions as R, type ServiceCredentials as S, type TokenProvider as T, type AnonymousSessionStore as a, type AuthContext as b, type AuthKind as c, CustomerRefreshRegistry as d, type CustomerTokenRefresher as e, DefaultTokenProvider as f, type HttpClientOptions as g, LevelResolver as h, type LogFields as i, type LogLevel as j, type Logger as k, type LoggerConfig as l, type LoggerObjectConfig as m, type ResolvedConfig as n, type ServiceName as o, type StoredAnonymousSession as p, type StorefrontCredentials as q, auth as r, createConsoleLogger as s, createNoopLogger as t, iterateAll as u, redact as v, resolveToken as w, validateConfig as x };
+export { type AnonymousSession as A, type ClientContext as C, DEFAULT_HOST as D, type EmporixConfig as E, HttpClient as H, LEVEL as L, type PaginatedItems as P, type RequestOptions as R, type ServiceCredentials as S, type TokenProvider as T, type AnonymousSessionStore as a, type AuthContext as b, type AuthKind as c, CustomerRefreshRegistry as d, type CustomerTokenRefresher as e, DefaultTokenProvider as f, type HttpClientOptions as g, type HttpResult as h, LevelResolver as i, type LogFields as j, type LogLevel as k, type Logger as l, type LoggerConfig as m, type LoggerObjectConfig as n, type ResolvedConfig as o, type ServiceName as p, type StoredAnonymousSession as q, type StorefrontCredentials as r, auth as s, createConsoleLogger as t, createNoopLogger as u, iterateAll as v, redact as w, resolveToken as x, validateConfig as y };

package/dist/{customer-groups-DJVbdrEP.d.cts → customer-groups-D0OCm8kJ.d.cts}

@@ -1,4 +1,4 @@
-import { C as ClientContext, b as AuthContext } from './context-CpLIDl0P.cjs';
+import { C as ClientContext, b as AuthContext } from './context-DK8jg6y5.cjs';
 
 /**
  * Access control metadata.

package/dist/{customer-groups-DhpCTCTg.d.ts → customer-groups-WSt4aT62.d.ts}

@@ -1,4 +1,4 @@
-import { C as ClientContext, b as AuthContext } from './context-CpLIDl0P.js';
+import { C as ClientContext, b as AuthContext } from './context-DK8jg6y5.js';
 
 /**
  * Access control metadata.

package/dist/customer-groups.d.cts

@@ -1,2 +1,2 @@
-export { g as CustomerGroupsService, j as IamGroup, c as IamGroupMemberAssignment } from './customer-groups-DJVbdrEP.cjs';
-import './context-CpLIDl0P.cjs';
+export { g as CustomerGroupsService, j as IamGroup, c as IamGroupMemberAssignment } from './customer-groups-D0OCm8kJ.cjs';
+import './context-DK8jg6y5.cjs';

package/dist/customer-groups.d.ts

@@ -1,2 +1,2 @@
-export { g as CustomerGroupsService, j as IamGroup, c as IamGroupMemberAssignment } from './customer-groups-DhpCTCTg.js';
-import './context-CpLIDl0P.js';
+export { g as CustomerGroupsService, j as IamGroup, c as IamGroupMemberAssignment } from './customer-groups-WSt4aT62.js';
+import './context-DK8jg6y5.js';

package/dist/customer.d.cts

@@ -1,4 +1,4 @@
-import { C as ClientContext, A as AnonymousSession, b as AuthContext } from './context-CpLIDl0P.cjs';
+import { C as ClientContext, A as AnonymousSession, b as AuthContext } from './context-DK8jg6y5.cjs';
 
 type AccountId = {
     /**

package/dist/customer.d.ts

@@ -1,4 +1,4 @@
-import { C as ClientContext, A as AnonymousSession, b as AuthContext } from './context-CpLIDl0P.js';
+import { C as ClientContext, A as AnonymousSession, b as AuthContext } from './context-DK8jg6y5.js';
 
 type AccountId = {
     /**