@ikatec/digisac-api-sdk 4.8.0 → 4.10.0

package/dist/core/BaseApiClient.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"BaseApiClient.mjs","names":[],"sources":["../../src/core/BaseApiClient.ts"],"sourcesContent":["import type { ApiClient, HttpMethod } from './ApiClient'\nimport { ApiConnectionError, ApiError } from './errors'\nimport { DEFAULT_QUERY_FORMAT, type QueryFormat } from './queryString'\n\nexport interface BaseApiClientOptions {\n  /** How list/get queries are serialized in the URL. Defaults to `'json'`. */\n  queryFormat?: QueryFormat\n}\n\nexport class BaseApiClient implements ApiClient {\n  protected readonly baseUrl: string\n  protected accessToken: string | null = null\n  public readonly queryFormat: QueryFormat\n\n  constructor(baseUrl: string, accessToken?: string, options: BaseApiClientOptions = {}) {\n    this.baseUrl = baseUrl.replace(/\\/$/, '')\n    this.accessToken = accessToken || null\n    this.queryFormat = options.queryFormat ?? DEFAULT_QUERY_FORMAT\n  }\n\n  setAccessToken(accessToken: string): this {\n    this.accessToken = accessToken\n    return this\n  }\n\n  async request<TResponse = unknown, TBody = unknown>(\n    method: HttpMethod,\n    endpoint: string,\n    body?: TBody,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    const url = `${this.baseUrl}/${endpoint.replace(/^\\//, '')}`\n    const init: RequestInit = {\n      method,\n      headers: {\n        'Content-Type': 'application/json',\n        ...(this.accessToken && { Authorization: `Bearer ${this.accessToken}` }),\n        ...headers,\n      },\n      ...(body !== undefined && { body: JSON.stringify(body) }),\n    }\n\n    let response: Response\n    try {\n      response = await fetch(url, init)\n    } catch (error) {\n      const reason = error instanceof Error ? error.message : String(error)\n      throw new ApiConnectionError(`Request to ${method} ${url} failed: ${reason}`, {\n        cause: error,\n      })\n    }\n\n    return this.handleResponse<TResponse>(response)\n  }\n\n  protected async handleResponse<TResponse>(response: Response): Promise<TResponse> {\n    if (!response.ok) {\n      throw ApiError.fromResponse(\n        response.status,\n        response.statusText,\n        response.headers,\n        await this.readErrorBody(response),\n      )\n    }\n\n    // 204 No Content never has a body; short-circuit before reading the stream.\n    if (response.status === 204) {\n      return undefined as unknown as TResponse\n    }\n\n    // Read body as text once and treat an empty body as \"no content\" regardless of\n    // Content-Type. Servers sometimes return 200 with Content-Type: application/json\n    // and an empty body (e.g. POST endpoints whose framework keeps the default JSON\n    // content-type even when nothing is written). `response.json()` would throw\n    // \"Unexpected end of input\" in that case.\n    const text = await response.text()\n    if (!text) {\n      return undefined as unknown as TResponse\n    }\n\n    const contentType = response.headers.get('Content-Type')\n    const isJson = contentType?.includes('application/json') ?? false\n\n    if (isJson) {\n      return JSON.parse(text) as TResponse\n    }\n\n    try {\n      return JSON.parse(text) as TResponse\n    } catch {\n      return text as unknown as TResponse\n    }\n  }\n\n  /** Reads an error body: parsed JSON when possible, the raw text otherwise, `undefined` when empty. */\n  protected async readErrorBody(response: Response): Promise<unknown> {\n    let text: string\n    try {\n      text = await response.text()\n    } catch {\n      return undefined\n    }\n    if (!text) {\n      return undefined\n    }\n    try {\n      return JSON.parse(text)\n    } catch {\n      return text\n    }\n  }\n\n  get<TResponse = unknown>(endpoint: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.request<TResponse>('GET', endpoint, undefined, headers)\n  }\n\n  post<TResponse = unknown, TBody = unknown>(\n    endpoint: string,\n    body?: TBody,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    return this.request<TResponse, TBody>('POST', endpoint, body, headers)\n  }\n\n  put<TResponse = unknown, TBody = unknown>(\n    endpoint: string,\n    body?: TBody,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    return this.request<TResponse, TBody>('PUT', endpoint, body, headers)\n  }\n\n  patch<TResponse = unknown, TBody = unknown>(\n    endpoint: string,\n    body?: TBody,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    return this.request<TResponse, TBody>('PATCH', endpoint, body, headers)\n  }\n\n  delete<TResponse = unknown>(\n    endpoint: string,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    return this.request<TResponse>('DELETE', endpoint, undefined, headers)\n  }\n}\n"],"mappings":";;;;AASA,IAAa,gBAAb,MAAgD;CAC9C,AAAmB;CACnB,AAAU,cAA6B;CACvC,AAAgB;CAEhB,YAAY,SAAiB,aAAsB,UAAgC,EAAE,EAAE;AACrF,OAAK,UAAU,QAAQ,QAAQ,OAAO,GAAG;AACzC,OAAK,cAAc,eAAe;AAClC,OAAK,cAAc,QAAQ,eAAe;;CAG5C,eAAe,aAA2B;AACxC,OAAK,cAAc;AACnB,SAAO;;CAGT,MAAM,QACJ,QACA,UACA,MACA,SACoB;EACpB,MAAM,MAAM,GAAG,KAAK,QAAQ,GAAG,SAAS,QAAQ,OAAO,GAAG;EAC1D,MAAM,OAAoB;GACxB;GACA,SAAS;IACP,gBAAgB;IAChB,GAAI,KAAK,eAAe,EAAE,eAAe,UAAU,KAAK,eAAe;IACvE,GAAG;IACJ;GACD,GAAI,SAAS,UAAa,EAAE,MAAM,KAAK,UAAU,KAAK,EAAE;GACzD;EAED,IAAI;AACJ,MAAI;AACF,cAAW,MAAM,MAAM,KAAK,KAAK;WAC1B,OAAO;AAEd,SAAM,IAAI,mBAAmB,cAAc,OAAO,GAAG,IAAI,WAD1C,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM,IACS,EAC5E,OAAO,OACR,CAAC;;AAGJ,SAAO,KAAK,eAA0B,SAAS;;CAGjD,MAAgB,eAA0B,UAAwC;AAChF,MAAI,CAAC,SAAS,GACZ,OAAM,SAAS,aACb,SAAS,QACT,SAAS,YACT,SAAS,SACT,MAAM,KAAK,cAAc,SAAS,CACnC;AAIH,MAAI,SAAS,WAAW,IACtB;EAQF,MAAM,OAAO,MAAM,SAAS,MAAM;AAClC,MAAI,CAAC,KACH;AAMF,MAHoB,SAAS,QAAQ,IAAI,eAAe,EAC5B,SAAS,mBAAmB,IAAI,MAG1D,QAAO,KAAK,MAAM,KAAK;AAGzB,MAAI;AACF,UAAO,KAAK,MAAM,KAAK;UACjB;AACN,UAAO;;;;CAKX,MAAgB,cAAc,UAAsC;EAClE,IAAI;AACJ,MAAI;AACF,UAAO,MAAM,SAAS,MAAM;UACtB;AACN;;AAEF,MAAI,CAAC,KACH;AAEF,MAAI;AACF,UAAO,KAAK,MAAM,KAAK;UACjB;AACN,UAAO;;;CAIX,IAAyB,UAAkB,SAAsD;AAC/F,SAAO,KAAK,QAAmB,OAAO,UAAU,QAAW,QAAQ;;CAGrE,KACE,UACA,MACA,SACoB;AACpB,SAAO,KAAK,QAA0B,QAAQ,UAAU,MAAM,QAAQ;;CAGxE,IACE,UACA,MACA,SACoB;AACpB,SAAO,KAAK,QAA0B,OAAO,UAAU,MAAM,QAAQ;;CAGvE,MACE,UACA,MACA,SACoB;AACpB,SAAO,KAAK,QAA0B,SAAS,UAAU,MAAM,QAAQ;;CAGzE,OACE,UACA,SACoB;AACpB,SAAO,KAAK,QAAmB,UAAU,UAAU,QAAW,QAAQ"}
+{"version":3,"file":"BaseApiClient.mjs","names":[],"sources":["../../src/core/BaseApiClient.ts"],"sourcesContent":["import type { ApiClient, HttpMethod } from './ApiClient'\nimport { ApiConnectionError, ApiError } from './errors'\nimport { DEFAULT_QUERY_FORMAT, type QueryFormat } from './queryString'\nimport { requestExternal } from './requestExternal'\n\nexport interface BaseApiClientOptions {\n  /** How list/get queries are serialized in the URL. Defaults to `'json'`. */\n  queryFormat?: QueryFormat\n}\n\nexport class BaseApiClient implements ApiClient {\n  protected readonly baseUrl: string\n  protected accessToken: string | null = null\n  public readonly queryFormat: QueryFormat\n\n  constructor(baseUrl: string, accessToken?: string, options: BaseApiClientOptions = {}) {\n    this.baseUrl = baseUrl.replace(/\\/$/, '')\n    this.accessToken = accessToken || null\n    this.queryFormat = options.queryFormat ?? DEFAULT_QUERY_FORMAT\n  }\n\n  setAccessToken(accessToken: string): this {\n    this.accessToken = accessToken\n    return this\n  }\n\n  async request<TResponse = unknown, TBody = unknown>(\n    method: HttpMethod,\n    endpoint: string,\n    body?: TBody,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    return this.handleResponse<TResponse>(await this.send(method, endpoint, body, headers))\n  }\n\n  /**\n   * Sends the request and resolves the raw `Response` of a 2xx answer (headers and body\n   * untouched, so a binary body can be read with `arrayBuffer()`). Non-2xx throws the\n   * `ApiError` subclass, as {@link request} does.\n   */\n  async requestRaw<TBody = unknown>(\n    method: HttpMethod,\n    endpoint: string,\n    body?: TBody,\n    headers?: Record<string, string>,\n  ): Promise<Response> {\n    const response = await this.send(method, endpoint, body, headers)\n    if (!response.ok) {\n      throw ApiError.fromResponse(\n        response.status,\n        response.statusText,\n        response.headers,\n        await this.readErrorBody(response),\n      )\n    }\n    return response\n  }\n\n  /**\n   * Sends a request to an absolute URL outside the API, without the base URL, the access token\n   * and the JSON serialization. Resolves the raw `Response` of a 2xx answer; non-2xx throws the\n   * `ApiError` subclass. Override it to intercept those requests as well.\n   */\n  requestExternal(\n    method: HttpMethod,\n    url: string,\n    body?: BodyInit,\n    headers?: Record<string, string>,\n  ): Promise<Response> {\n    return requestExternal(method, url, body, headers)\n  }\n\n  /** Builds and sends the request; a network failure is thrown as `ApiConnectionError`. */\n  protected async send<TBody = unknown>(\n    method: HttpMethod,\n    endpoint: string,\n    body?: TBody,\n    headers?: Record<string, string>,\n  ): Promise<Response> {\n    const url = `${this.baseUrl}/${endpoint.replace(/^\\//, '')}`\n    const init: RequestInit = {\n      method,\n      headers: {\n        'Content-Type': 'application/json',\n        ...(this.accessToken && { Authorization: `Bearer ${this.accessToken}` }),\n        ...headers,\n      },\n      ...(body !== undefined && { body: JSON.stringify(body) }),\n    }\n\n    try {\n      return await fetch(url, init)\n    } catch (error) {\n      const reason = error instanceof Error ? error.message : String(error)\n      throw new ApiConnectionError(`Request to ${method} ${url} failed: ${reason}`, {\n        cause: error,\n      })\n    }\n  }\n\n  protected async handleResponse<TResponse>(response: Response): Promise<TResponse> {\n    if (!response.ok) {\n      throw ApiError.fromResponse(\n        response.status,\n        response.statusText,\n        response.headers,\n        await this.readErrorBody(response),\n      )\n    }\n\n    // 204 No Content never has a body; short-circuit before reading the stream.\n    if (response.status === 204) {\n      return undefined as unknown as TResponse\n    }\n\n    // Read body as text once and treat an empty body as \"no content\" regardless of\n    // Content-Type. Servers sometimes return 200 with Content-Type: application/json\n    // and an empty body (e.g. POST endpoints whose framework keeps the default JSON\n    // content-type even when nothing is written). `response.json()` would throw\n    // \"Unexpected end of input\" in that case.\n    const text = await response.text()\n    if (!text) {\n      return undefined as unknown as TResponse\n    }\n\n    const contentType = response.headers.get('Content-Type')\n    const isJson = contentType?.includes('application/json') ?? false\n\n    if (isJson) {\n      return JSON.parse(text) as TResponse\n    }\n\n    try {\n      return JSON.parse(text) as TResponse\n    } catch {\n      return text as unknown as TResponse\n    }\n  }\n\n  /** Reads an error body: parsed JSON when possible, the raw text otherwise, `undefined` when empty. */\n  protected async readErrorBody(response: Response): Promise<unknown> {\n    let text: string\n    try {\n      text = await response.text()\n    } catch {\n      return undefined\n    }\n    if (!text) {\n      return undefined\n    }\n    try {\n      return JSON.parse(text)\n    } catch {\n      return text\n    }\n  }\n\n  get<TResponse = unknown>(endpoint: string, headers?: Record<string, string>): Promise<TResponse> {\n    return this.request<TResponse>('GET', endpoint, undefined, headers)\n  }\n\n  post<TResponse = unknown, TBody = unknown>(\n    endpoint: string,\n    body?: TBody,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    return this.request<TResponse, TBody>('POST', endpoint, body, headers)\n  }\n\n  put<TResponse = unknown, TBody = unknown>(\n    endpoint: string,\n    body?: TBody,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    return this.request<TResponse, TBody>('PUT', endpoint, body, headers)\n  }\n\n  patch<TResponse = unknown, TBody = unknown>(\n    endpoint: string,\n    body?: TBody,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    return this.request<TResponse, TBody>('PATCH', endpoint, body, headers)\n  }\n\n  delete<TResponse = unknown>(\n    endpoint: string,\n    headers?: Record<string, string>,\n  ): Promise<TResponse> {\n    return this.request<TResponse>('DELETE', endpoint, undefined, headers)\n  }\n}\n"],"mappings":";;;;;AAUA,IAAa,gBAAb,MAAgD;CAC9C,AAAmB;CACnB,AAAU,cAA6B;CACvC,AAAgB;CAEhB,YAAY,SAAiB,aAAsB,UAAgC,EAAE,EAAE;AACrF,OAAK,UAAU,QAAQ,QAAQ,OAAO,GAAG;AACzC,OAAK,cAAc,eAAe;AAClC,OAAK,cAAc,QAAQ,eAAe;;CAG5C,eAAe,aAA2B;AACxC,OAAK,cAAc;AACnB,SAAO;;CAGT,MAAM,QACJ,QACA,UACA,MACA,SACoB;AACpB,SAAO,KAAK,eAA0B,MAAM,KAAK,KAAK,QAAQ,UAAU,MAAM,QAAQ,CAAC;;;;;;;CAQzF,MAAM,WACJ,QACA,UACA,MACA,SACmB;EACnB,MAAM,WAAW,MAAM,KAAK,KAAK,QAAQ,UAAU,MAAM,QAAQ;AACjE,MAAI,CAAC,SAAS,GACZ,OAAM,SAAS,aACb,SAAS,QACT,SAAS,YACT,SAAS,SACT,MAAM,KAAK,cAAc,SAAS,CACnC;AAEH,SAAO;;;;;;;CAQT,gBACE,QACA,KACA,MACA,SACmB;AACnB,SAAO,gBAAgB,QAAQ,KAAK,MAAM,QAAQ;;;CAIpD,MAAgB,KACd,QACA,UACA,MACA,SACmB;EACnB,MAAM,MAAM,GAAG,KAAK,QAAQ,GAAG,SAAS,QAAQ,OAAO,GAAG;EAC1D,MAAM,OAAoB;GACxB;GACA,SAAS;IACP,gBAAgB;IAChB,GAAI,KAAK,eAAe,EAAE,eAAe,UAAU,KAAK,eAAe;IACvE,GAAG;IACJ;GACD,GAAI,SAAS,UAAa,EAAE,MAAM,KAAK,UAAU,KAAK,EAAE;GACzD;AAED,MAAI;AACF,UAAO,MAAM,MAAM,KAAK,KAAK;WACtB,OAAO;AAEd,SAAM,IAAI,mBAAmB,cAAc,OAAO,GAAG,IAAI,WAD1C,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM,IACS,EAC5E,OAAO,OACR,CAAC;;;CAIN,MAAgB,eAA0B,UAAwC;AAChF,MAAI,CAAC,SAAS,GACZ,OAAM,SAAS,aACb,SAAS,QACT,SAAS,YACT,SAAS,SACT,MAAM,KAAK,cAAc,SAAS,CACnC;AAIH,MAAI,SAAS,WAAW,IACtB;EAQF,MAAM,OAAO,MAAM,SAAS,MAAM;AAClC,MAAI,CAAC,KACH;AAMF,MAHoB,SAAS,QAAQ,IAAI,eAAe,EAC5B,SAAS,mBAAmB,IAAI,MAG1D,QAAO,KAAK,MAAM,KAAK;AAGzB,MAAI;AACF,UAAO,KAAK,MAAM,KAAK;UACjB;AACN,UAAO;;;;CAKX,MAAgB,cAAc,UAAsC;EAClE,IAAI;AACJ,MAAI;AACF,UAAO,MAAM,SAAS,MAAM;UACtB;AACN;;AAEF,MAAI,CAAC,KACH;AAEF,MAAI;AACF,UAAO,KAAK,MAAM,KAAK;UACjB;AACN,UAAO;;;CAIX,IAAyB,UAAkB,SAAsD;AAC/F,SAAO,KAAK,QAAmB,OAAO,UAAU,QAAW,QAAQ;;CAGrE,KACE,UACA,MACA,SACoB;AACpB,SAAO,KAAK,QAA0B,QAAQ,UAAU,MAAM,QAAQ;;CAGxE,IACE,UACA,MACA,SACoB;AACpB,SAAO,KAAK,QAA0B,OAAO,UAAU,MAAM,QAAQ;;CAGvE,MACE,UACA,MACA,SACoB;AACpB,SAAO,KAAK,QAA0B,SAAS,UAAU,MAAM,QAAQ;;CAGzE,OACE,UACA,SACoB;AACpB,SAAO,KAAK,QAAmB,UAAU,UAAU,QAAW,QAAQ"}

package/dist/core/requestExternal.cjs

@@ -0,0 +1,33 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_core_errors = require('./errors.cjs');
+
+//#region src/core/requestExternal.ts
+/** The URL without its query string, which may carry a signature that must not reach the logs. */
+function withoutQuery(url) {
+	return url.replace(/[?#].*$/s, "");
+}
+/**
+* Sends a request to an absolute URL outside the API (e.g. a signed storage URL): no base URL, no
+* `Authorization` header and no JSON serialization, `body` goes as is. Resolves the raw `Response`
+* of a 2xx answer; non-2xx throws the `ApiError` subclass with the body as text, and a network
+* failure throws `ApiConnectionError`.
+*/
+async function requestExternal(method, url, body, headers) {
+	let response;
+	try {
+		response = await fetch(url, {
+			method,
+			...headers && { headers },
+			...body !== void 0 && { body }
+		});
+	} catch (error) {
+		const reason = error instanceof Error ? error.message : String(error);
+		throw new require_core_errors.ApiConnectionError(`Request to ${method} ${withoutQuery(url)} failed: ${reason}`, { cause: error });
+	}
+	if (!response.ok) throw require_core_errors.ApiError.fromResponse(response.status, response.statusText, response.headers, await response.text().catch(() => void 0) || void 0);
+	return response;
+}
+
+//#endregion
+exports.requestExternal = requestExternal;
+//# sourceMappingURL=requestExternal.cjs.map

package/dist/core/requestExternal.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestExternal.cjs","names":["ApiConnectionError","ApiError"],"sources":["../../src/core/requestExternal.ts"],"sourcesContent":["import type { HttpMethod } from './ApiClient'\nimport { ApiConnectionError, ApiError } from './errors'\n\n/** The URL without its query string, which may carry a signature that must not reach the logs. */\nfunction withoutQuery(url: string): string {\n  return url.replace(/[?#].*$/s, '')\n}\n\n/**\n * Sends a request to an absolute URL outside the API (e.g. a signed storage URL): no base URL, no\n * `Authorization` header and no JSON serialization, `body` goes as is. Resolves the raw `Response`\n * of a 2xx answer; non-2xx throws the `ApiError` subclass with the body as text, and a network\n * failure throws `ApiConnectionError`.\n */\nexport async function requestExternal(\n  method: HttpMethod,\n  url: string,\n  body?: BodyInit,\n  headers?: Record<string, string>,\n): Promise<Response> {\n  let response: Response\n  try {\n    response = await fetch(url, {\n      method,\n      ...(headers && { headers }),\n      ...(body !== undefined && { body }),\n    })\n  } catch (error) {\n    const reason = error instanceof Error ? error.message : String(error)\n    throw new ApiConnectionError(`Request to ${method} ${withoutQuery(url)} failed: ${reason}`, {\n      cause: error,\n    })\n  }\n  if (!response.ok) {\n    throw ApiError.fromResponse(\n      response.status,\n      response.statusText,\n      response.headers,\n      (await response.text().catch(() => undefined)) || undefined,\n    )\n  }\n  return response\n}\n"],"mappings":";;;;;AAIA,SAAS,aAAa,KAAqB;AACzC,QAAO,IAAI,QAAQ,YAAY,GAAG;;;;;;;;AASpC,eAAsB,gBACpB,QACA,KACA,MACA,SACmB;CACnB,IAAI;AACJ,KAAI;AACF,aAAW,MAAM,MAAM,KAAK;GAC1B;GACA,GAAI,WAAW,EAAE,SAAS;GAC1B,GAAI,SAAS,UAAa,EAAE,MAAM;GACnC,CAAC;UACK,OAAO;EACd,MAAM,SAAS,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM;AACrE,QAAM,IAAIA,uCAAmB,cAAc,OAAO,GAAG,aAAa,IAAI,CAAC,WAAW,UAAU,EAC1F,OAAO,OACR,CAAC;;AAEJ,KAAI,CAAC,SAAS,GACZ,OAAMC,6BAAS,aACb,SAAS,QACT,SAAS,YACT,SAAS,SACR,MAAM,SAAS,MAAM,CAAC,YAAY,OAAU,IAAK,OACnD;AAEH,QAAO"}

package/dist/core/requestExternal.d.ts

@@ -0,0 +1,9 @@
+import type { HttpMethod } from './ApiClient';
+/**
+ * Sends a request to an absolute URL outside the API (e.g. a signed storage URL): no base URL, no
+ * `Authorization` header and no JSON serialization, `body` goes as is. Resolves the raw `Response`
+ * of a 2xx answer; non-2xx throws the `ApiError` subclass with the body as text, and a network
+ * failure throws `ApiConnectionError`.
+ */
+export declare function requestExternal(method: HttpMethod, url: string, body?: BodyInit, headers?: Record<string, string>): Promise<Response>;
+//# sourceMappingURL=requestExternal.d.ts.map

package/dist/core/requestExternal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestExternal.d.ts","sourceRoot":"","sources":["../../src/core/requestExternal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAQ7C;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,QAAQ,EACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,QAAQ,CAAC,CAuBnB"}

package/dist/core/requestExternal.mjs

@@ -0,0 +1,32 @@
+import { ApiConnectionError, ApiError } from "./errors.mjs";
+
+//#region src/core/requestExternal.ts
+/** The URL without its query string, which may carry a signature that must not reach the logs. */
+function withoutQuery(url) {
+	return url.replace(/[?#].*$/s, "");
+}
+/**
+* Sends a request to an absolute URL outside the API (e.g. a signed storage URL): no base URL, no
+* `Authorization` header and no JSON serialization, `body` goes as is. Resolves the raw `Response`
+* of a 2xx answer; non-2xx throws the `ApiError` subclass with the body as text, and a network
+* failure throws `ApiConnectionError`.
+*/
+async function requestExternal(method, url, body, headers) {
+	let response;
+	try {
+		response = await fetch(url, {
+			method,
+			...headers && { headers },
+			...body !== void 0 && { body }
+		});
+	} catch (error) {
+		const reason = error instanceof Error ? error.message : String(error);
+		throw new ApiConnectionError(`Request to ${method} ${withoutQuery(url)} failed: ${reason}`, { cause: error });
+	}
+	if (!response.ok) throw ApiError.fromResponse(response.status, response.statusText, response.headers, await response.text().catch(() => void 0) || void 0);
+	return response;
+}
+
+//#endregion
+export { requestExternal };
+//# sourceMappingURL=requestExternal.mjs.map

package/dist/core/requestExternal.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestExternal.mjs","names":[],"sources":["../../src/core/requestExternal.ts"],"sourcesContent":["import type { HttpMethod } from './ApiClient'\nimport { ApiConnectionError, ApiError } from './errors'\n\n/** The URL without its query string, which may carry a signature that must not reach the logs. */\nfunction withoutQuery(url: string): string {\n  return url.replace(/[?#].*$/s, '')\n}\n\n/**\n * Sends a request to an absolute URL outside the API (e.g. a signed storage URL): no base URL, no\n * `Authorization` header and no JSON serialization, `body` goes as is. Resolves the raw `Response`\n * of a 2xx answer; non-2xx throws the `ApiError` subclass with the body as text, and a network\n * failure throws `ApiConnectionError`.\n */\nexport async function requestExternal(\n  method: HttpMethod,\n  url: string,\n  body?: BodyInit,\n  headers?: Record<string, string>,\n): Promise<Response> {\n  let response: Response\n  try {\n    response = await fetch(url, {\n      method,\n      ...(headers && { headers }),\n      ...(body !== undefined && { body }),\n    })\n  } catch (error) {\n    const reason = error instanceof Error ? error.message : String(error)\n    throw new ApiConnectionError(`Request to ${method} ${withoutQuery(url)} failed: ${reason}`, {\n      cause: error,\n    })\n  }\n  if (!response.ok) {\n    throw ApiError.fromResponse(\n      response.status,\n      response.statusText,\n      response.headers,\n      (await response.text().catch(() => undefined)) || undefined,\n    )\n  }\n  return response\n}\n"],"mappings":";;;;AAIA,SAAS,aAAa,KAAqB;AACzC,QAAO,IAAI,QAAQ,YAAY,GAAG;;;;;;;;AASpC,eAAsB,gBACpB,QACA,KACA,MACA,SACmB;CACnB,IAAI;AACJ,KAAI;AACF,aAAW,MAAM,MAAM,KAAK;GAC1B;GACA,GAAI,WAAW,EAAE,SAAS;GAC1B,GAAI,SAAS,UAAa,EAAE,MAAM;GACnC,CAAC;UACK,OAAO;EACd,MAAM,SAAS,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM;AACrE,QAAM,IAAI,mBAAmB,cAAc,OAAO,GAAG,aAAa,IAAI,CAAC,WAAW,UAAU,EAC1F,OAAO,OACR,CAAC;;AAEJ,KAAI,CAAC,SAAS,GACZ,OAAM,SAAS,aACb,SAAS,QACT,SAAS,YACT,SAAS,SACR,MAAM,SAAS,MAAM,CAAC,YAAY,OAAU,IAAK,OACnD;AAEH,QAAO"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ikatec/digisac-api-sdk",
-  "version": "4.8.0",
+  "version": "4.10.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",

package/src/apis/absence/AbsenceApi.ts

@@ -1,9 +1,28 @@
 import type { ApiClient } from '../../core/ApiClient'
 import { BaseCrudApi } from '../../core/BaseCrudApi'
+import type { GetByIdQuery } from '../../core/types'
 import type { Absence, CreateAbsencePayload, UpdateAbsencePayload } from './types'
 
+/**
+ * Absences of the users. The backend serves the report (`GET /absence`), `POST /absence` and
+ * `PUT /absence/:id`; there is no read by id nor delete.
+ */
 export class AbsenceApi extends BaseCrudApi<Absence, CreateAbsencePayload, UpdateAbsencePayload> {
   constructor(client: ApiClient) {
     super(client, '/absence')
   }
+
+  /** @deprecated Not served: the backend has no GET /absence/:id, so this route answers 404. */
+  override getById(
+    id: string,
+    query?: GetByIdQuery<Absence>,
+    headers?: Record<string, string>,
+  ): Promise<Absence> {
+    return super.getById(id, query, headers)
+  }
+
+  /** @deprecated Not served: the backend has no DELETE /absence/:id, so this route answers 404. */
+  override deleteById(id: string, headers?: Record<string, string>): Promise<Absence> {
+    return super.deleteById(id, headers)
+  }
 }

package/src/apis/acceptanceTerms/AcceptanceTermsApi.ts

@@ -1,4 +1,5 @@
 import type { ApiClient } from '../../core/ApiClient'
+import type { ListQuery } from '../../core/types'
 import { BaseCrudApi } from '../../core/BaseCrudApi'
 import type {
   AcceptanceTerm,
@@ -9,9 +10,20 @@ import type {
 export class AcceptanceTermsApi extends BaseCrudApi<
   AcceptanceTerm,
   CreateAcceptanceTermPayload,
-  UpdateAcceptanceTermPayload
+  UpdateAcceptanceTermPayload,
+  ListQuery<AcceptanceTerm>,
+  void
 > {
   constructor(client: ApiClient) {
     super(client, '/acceptance-terms')
   }
+
+  /**
+   * Deletes an acceptance term. Resolves with no body; a term in use answers 404 `{ message: 'Term
+   * in use' }`.
+   * @permissions acceptanceTerms.view OR acceptanceTerms.destroy
+   */
+  override deleteById(id: string, headers?: Record<string, string>): Promise<void> {
+    return super.deleteById(id, headers)
+  }
 }

package/src/apis/accounts/AccountsApi.ts

@@ -2,6 +2,11 @@ import type { ApiClient } from '../../core/ApiClient'
 import { BaseCrudApi } from '../../core/BaseCrudApi'
 import type { Account, CreateAccountPayload, UpdateAccountPayload } from './types'
 
+/**
+ * @deprecated Not served: the backend mounts no `/accounts` route, so every method answers 404
+ * `Route not found.`. Read and update the account of the user with `MeApi.getAccount` and
+ * `MeApi.updateAccount`; `/admin/accounts` is a super admin route, kept out of the SDK.
+ */
 export class AccountsApi extends BaseCrudApi<Account, CreateAccountPayload, UpdateAccountPayload> {
   constructor(client: ApiClient) {
     super(client, '/accounts')

package/src/apis/accounts/types.ts

@@ -121,6 +121,8 @@ export type AccountSettingsCampaign = {
 }
 
 export type AccountSettings = {
+  /** Enables the block list (required by `ContactsApi.block`). */
+  isBlockListActive?: boolean
   /** Feature flags that toggle specific platform capabilities. */
   flags?: AccountSettingsFlags
   /** Enables/disables specific communication channels (whatsapp, telegram, webchat, etc.). */

package/src/apis/activityLog/ActivityLogApi.ts

@@ -2,6 +2,10 @@ import type { ApiClient } from '../../core/ApiClient'
 import { BaseCrudApi } from '../../core/BaseCrudApi'
 import type { ActivityLog, CreateActivityLogPayload, UpdateActivityLogPayload } from './types'
 
+/**
+ * Activity log of the account (stored in MongoDB: the routes answer 503 when it is unavailable).
+ * The backend serves `GET /log`, `GET /log/:id` and `POST /log`; there is no update or delete.
+ */
 export class ActivityLogApi extends BaseCrudApi<
   ActivityLog,
   CreateActivityLogPayload,
@@ -10,4 +14,18 @@ export class ActivityLogApi extends BaseCrudApi<
   constructor(client: ApiClient) {
     super(client, '/log')
   }
+
+  /** @deprecated Not served: the backend has no PUT /log/:id, so this route answers 404. */
+  override updateById(
+    id: string,
+    body: UpdateActivityLogPayload,
+    headers?: Record<string, string>,
+  ): Promise<ActivityLog> {
+    return super.updateById(id, body, headers)
+  }
+
+  /** @deprecated Not served: the backend has no DELETE /log/:id, so this route answers 404. */
+  override deleteById(id: string, headers?: Record<string, string>): Promise<ActivityLog> {
+    return super.deleteById(id, headers)
+  }
 }

package/src/apis/categories/CategoriesApi.ts

@@ -1,13 +1,24 @@
 import type { ApiClient } from '../../core/ApiClient'
+import type { ListQuery } from '../../core/types'
 import { BaseCrudApi } from '../../core/BaseCrudApi'
 import type { Category, CreateCategoryPayload, UpdateCategoryPayload } from './types'
 
 export class CategoriesApi extends BaseCrudApi<
   Category,
   CreateCategoryPayload,
-  UpdateCategoryPayload
+  UpdateCategoryPayload,
+  ListQuery<Category>,
+  'OK'
 > {
   constructor(client: ApiClient) {
     super(client, '/categories')
   }
+
+  /**
+   * Deletes a category. Resolves the text `'OK'`; an unknown id answers 500. The route checks no
+   * permission.
+   */
+  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {
+    return super.deleteById(id, headers)
+  }
 }

package/src/apis/clientFeedback/ClientFeedbackApi.ts

@@ -8,7 +8,11 @@ export class ClientFeedbackApi
 {
   private readonly basePath = '/client-feedback'
 
-  /** Creates a client feedback record for a ticket (accountId, ticketId, and feedback text are required). */
+  /**
+   * @deprecated The route is broken in the backend: it is mounted with no authentication (the
+   * account context throws, 500) and calls a `createFeedback` the resource does not have. The
+   * feedback on the AI summary is stored when the ticket is closed.
+   */
   create(
     body: CreateClientFeedbackPayload,
     headers?: Record<string, string>,

package/src/apis/contactBlockLists/ContactBlockListsApi.ts

@@ -1,4 +1,5 @@
 import type { ApiClient } from '../../core/ApiClient'
+import type { ListQuery } from '../../core/types'
 import { BaseCrudApi } from '../../core/BaseCrudApi'
 import type {
   ContactBlockList,
@@ -9,9 +10,20 @@ import type {
 export class ContactBlockListsApi extends BaseCrudApi<
   ContactBlockList,
   CreateContactBlockListPayload,
-  UpdateContactBlockListPayload
+  UpdateContactBlockListPayload,
+  ListQuery<ContactBlockList>,
+  'OK'
 > {
   constructor(client: ApiClient) {
     super(client, '/contact-block-lists')
   }
+
+  /**
+   * Deletes a block list and its numbers. Resolves the text `'OK'`; a list being processed (or with
+   * a block/unblock in progress) answers 500.
+   * @permissions contacts.view OR contacts.destroy OR contacts.block
+   */
+  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {
+    return super.deleteById(id, headers)
+  }
 }

package/src/apis/contactBlockListsControls/ContactBlockListsControlsApi.ts

@@ -1,4 +1,5 @@
 import type { ApiClient } from '../../core/ApiClient'
+import type { ListQuery } from '../../core/types'
 import { BaseCrudApi } from '../../core/BaseCrudApi'
 import type {
   ContactBlockListsControl,
@@ -9,9 +10,19 @@ import type {
 export class ContactBlockListsControlsApi extends BaseCrudApi<
   ContactBlockListsControl,
   CreateContactBlockListsControlPayload,
-  UpdateContactBlockListsControlPayload
+  UpdateContactBlockListsControlPayload,
+  ListQuery<ContactBlockListsControl>,
+  'OK'
 > {
   constructor(client: ApiClient) {
     super(client, '/contact-block-lists-controls')
   }
+
+  /**
+   * Deletes a block/unblock run. Resolves the text `'OK'`.
+   * @permissions contacts.view OR contacts.destroy OR contacts.block
+   */
+  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {
+    return super.deleteById(id, headers)
+  }
 }

package/src/apis/contacts/ContactsApi.test.ts

@@ -202,12 +202,13 @@ describe('ContactsApi', () => {
   // ── exportTemplate ───────────────────────────────────────────────
 
   describe('exportTemplate', () => {
-    it('calls client.post with /contacts/export-template and body', async () => {
-      vi.mocked(client.post).mockResolvedValue({ ok: true })
-      const body: ExportTemplatePayload = { serviceType: 'whatsapp', type: 'csv' }
+    it('calls client.post with /contacts/export-template and resolves the CSV text', async () => {
+      const csv = 'Nome;DDI;Número;Atendente Padrão;Departamento Padrão;Tags;Criado em\n'
+      vi.mocked(client.post).mockResolvedValue(csv)
+      const body: ExportTemplatePayload = { serviceType: 'whatsapp' }
       const result = await api.exportTemplate(body)
       expect(client.post).toHaveBeenCalledWith('/contacts/export-template', body, undefined)
-      expect(result).toEqual({ ok: true })
+      expect(result).toBe(csv)
     })
 
     it('forwards custom headers', async () => {
@@ -476,6 +477,21 @@ describe('ContactsApi', () => {
 
   // ── block ────────────────────────────────────────────────────────
 
+  describe('summarizeTicket', () => {
+    it('calls client.post with /contacts/:id/ticket/summary and no body', async () => {
+      vi.mocked(client.post).mockResolvedValue({ success: true })
+      const result = await api.summarizeTicket('c1')
+      expect(client.post).toHaveBeenCalledWith('/contacts/c1/ticket/summary', undefined, undefined)
+      expect(result).toEqual({ success: true })
+    })
+
+    it('forwards custom headers', async () => {
+      const headers = { 'X-Custom': 'value' }
+      await api.summarizeTicket('c1', headers)
+      expect(client.post).toHaveBeenCalledWith('/contacts/c1/ticket/summary', undefined, headers)
+    })
+  })
+
   describe('block', () => {
     it('calls client.post with /contacts/:id/block and body', async () => {
       vi.mocked(client.post).mockResolvedValue({ ...contact, block: true })

package/src/apis/contacts/ContactsApi.ts

@@ -21,6 +21,7 @@ import type {
   SyncContactPayload,
   TransferTicketPayload,
   UpdateContactPayload,
+  SummarizeTicketResult,
 } from './types'
 
 export class ContactsApi extends BaseCrudApi<Contact, CreateContactPayload, UpdateContactPayload> {
@@ -29,11 +30,12 @@ export class ContactsApi extends BaseCrudApi<Contact, CreateContactPayload, Upda
   }
 
   /**
-   * Downloads a CSV template for importing contacts, with columns based on the service type.
+   * Downloads the CSV template (`;`-separated header line, in the language of the user) for
+   * importing contacts, with columns based on the service type. Answered with no Content-Type.
    * @permissions contacts.view AND contacts.export
    */
-  exportTemplate(body: ExportTemplatePayload, headers?: Record<string, string>): Promise<unknown> {
-    return this.client.post<unknown, ExportTemplatePayload>(
+  exportTemplate(body: ExportTemplatePayload, headers?: Record<string, string>): Promise<string> {
+    return this.client.post<string, ExportTemplatePayload>(
       `${this.basePath}/export-template`,
       body,
       headers,
@@ -172,7 +174,9 @@ export class ContactsApi extends BaseCrudApi<Contact, CreateContactPayload, Upda
 
   /**
    * Starts the import of a CSV file previously uploaded through `FilesApi`. The import runs
-   * in the background; the header line is validated against the service type template.
+   * in the background; `csvHeaderLine` is validated against the service type template, with
+   * every column of `exportTemplate` (including "Criado em"/"Created at"): a different header
+   * answers 403 `Csv File - Invalid Header`. The file itself is only read by the job.
    * Resolves to `'OK'`.
    * @permissions contacts.view OR contacts.update OR contacts.create
    */
@@ -199,7 +203,8 @@ export class ContactsApi extends BaseCrudApi<Contact, CreateContactPayload, Upda
 
   /**
    * Blocks or unblocks a contact. Blocking closes the contact's open ticket. Requires the
-   * block list to be active on the account.
+   * block list to be active on the account (`settings.isBlockListActive`; 400 otherwise).
+   * `byUserId` and `description` are stored as sent: the backend does not fill in the user.
    * @permissions contacts.block
    */
   block(id: string, body: BlockContactPayload, headers?: Record<string, string>): Promise<Contact> {
@@ -210,6 +215,20 @@ export class ContactsApi extends BaseCrudApi<Contact, CreateContactPayload, Upda
     )
   }
 
+  /**
+   * Generates an AI summary of the open ticket of the contact. Consumes AI credits; resolves
+   * `{ success, limitReached? }`. A contact with no open ticket (or an unknown contact) answers
+   * 400.
+   * @permissions tickets.update
+   */
+  summarizeTicket(id: string, headers?: Record<string, string>): Promise<SummarizeTicketResult> {
+    return this.client.post<SummarizeTicketResult>(
+      `${this.basePath}/${id}/ticket/summary`,
+      undefined,
+      headers,
+    )
+  }
+
   /**
    * Resets the contact's unread counter. Resolves to `'OK'`.
    * @permissions contacts.view OR contacts.update

package/src/apis/contacts/types.ts

@@ -176,9 +176,15 @@ export type UpdateContactPayload = {
   tagIds?: string[]
 }
 
+/** Result of `ContactsApi.summarizeTicket`. */
+export type SummarizeTicketResult = {
+  success: boolean
+  limitReached?: boolean
+}
+
 export type ExportTemplatePayload = {
   serviceType: string
-  type: string
+  type?: string
 }
 
 export type CountContactsQuery = ListQuery<Contact> & {

package/src/apis/creditMovements/CreditMovementsApi.ts

@@ -6,6 +6,11 @@ import type {
   UpdateCreditMovementPayload,
 } from './types'
 
+/**
+ * Credit movements of the account (SMS and AI credits), only for reading: the writes are super
+ * admin routes (`/admin/credit-movements`). The backend serves only `GET /credit-movements` and
+ * `GET /credit-movements/:id`.
+ */
 export class CreditMovementsApi extends BaseCrudApi<
   CreditMovement,
   CreateCreditMovementPayload,
@@ -14,4 +19,26 @@ export class CreditMovementsApi extends BaseCrudApi<
   constructor(client: ApiClient) {
     super(client, '/credit-movements')
   }
+
+  /** @deprecated Not served: the backend has no POST /credit-movements, so this route answers 404. */
+  override create(
+    body: CreateCreditMovementPayload,
+    headers?: Record<string, string>,
+  ): Promise<CreditMovement> {
+    return super.create(body, headers)
+  }
+
+  /** @deprecated Not served: the backend has no PUT /credit-movements/:id, so this route answers 404. */
+  override updateById(
+    id: string,
+    body: UpdateCreditMovementPayload,
+    headers?: Record<string, string>,
+  ): Promise<CreditMovement> {
+    return super.updateById(id, body, headers)
+  }
+
+  /** @deprecated Not served: the backend has no DELETE /credit-movements/:id, so this route answers 404. */
+  override deleteById(id: string, headers?: Record<string, string>): Promise<CreditMovement> {
+    return super.deleteById(id, headers)
+  }
 }

package/src/apis/customFields/CustomFieldsApi.ts

@@ -1,13 +1,24 @@
 import type { ApiClient } from '../../core/ApiClient'
+import type { ListQuery } from '../../core/types'
 import { BaseCrudApi } from '../../core/BaseCrudApi'
 import type { CustomField, CreateCustomFieldPayload, UpdateCustomFieldPayload } from './types'
 
 export class CustomFieldsApi extends BaseCrudApi<
   CustomField,
   CreateCustomFieldPayload,
-  UpdateCustomFieldPayload
+  UpdateCustomFieldPayload,
+  ListQuery<CustomField>,
+  'OK'
 > {
   constructor(client: ApiClient) {
     super(client, '/custom-fields')
   }
+
+  /**
+   * Deletes a custom field. Resolves the text `'OK'`.
+   * @permissions customFields.view OR customFields.destroy
+   */
+  override deleteById(id: string, headers?: Record<string, string>): Promise<'OK'> {
+    return super.deleteById(id, headers)
+  }
 }

package/src/apis/departments/DepartmentsApi.test.ts

@@ -0,0 +1,88 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { DepartmentsApi } from './DepartmentsApi'
+import type { ApiClient } from '../../core/ApiClient'
+import type { Department } from './types'
+
+// ── Mock client factory ──────────────────────────────────────────────
+
+function createMockClient(): ApiClient {
+  return {
+    setAccessToken: vi.fn().mockReturnThis(),
+    request: vi.fn(),
+    get: vi.fn(),
+    post: vi.fn(),
+    put: vi.fn(),
+    patch: vi.fn(),
+    delete: vi.fn(),
+  }
+}
+
+const department: Department = {
+  id: 'dep-1',
+  name: 'Support',
+  accountId: 'acc-1',
+  distributionId: null,
+  archivedAt: '2026-01-01T00:00:00Z',
+  createdAt: '2026-01-01T00:00:00Z',
+  updatedAt: '2026-01-01T00:00:00Z',
+}
+
+// ── Tests ────────────────────────────────────────────────────────────
+
+describe('DepartmentsApi', () => {
+  let client: ReturnType<typeof createMockClient>
+  let api: DepartmentsApi
+
+  beforeEach(() => {
+    client = createMockClient()
+    api = new DepartmentsApi(client)
+  })
+
+  describe('archiveWithValidation', () => {
+    it('calls client.post with /departments/:id/archive and { archive: true }', async () => {
+      vi.mocked(client.post).mockResolvedValue(department)
+      const result = await api.archiveWithValidation('dep-1', { archive: true })
+      expect(client.post).toHaveBeenCalledWith(
+        '/departments/dep-1/archive',
+        { archive: true },
+        undefined,
+      )
+      expect(result).toEqual(department)
+    })
+
+    it('restores with { archive: false } and forwards custom headers', async () => {
+      const headers = { 'X-Custom': 'value' }
+      await api.archiveWithValidation('dep-1', { archive: false }, headers)
+      expect(client.post).toHaveBeenCalledWith(
+        '/departments/dep-1/archive',
+        { archive: false },
+        headers,
+      )
+    })
+  })
+
+  describe('archive / unarchive (PUT { archivedAt })', () => {
+    it('archive sends the current time in archivedAt', async () => {
+      await api.archive('dep-1')
+      expect(client.put).toHaveBeenCalledWith(
+        '/departments/dep-1',
+        { archivedAt: expect.any(String) },
+        undefined,
+      )
+    })
+
+    it('unarchive sends archivedAt null', async () => {
+      await api.unarchive('dep-1')
+      expect(client.put).toHaveBeenCalledWith('/departments/dep-1', { archivedAt: null }, undefined)
+    })
+  })
+
+  describe('deleteById', () => {
+    it("calls client.delete with /departments/:id and resolves 'OK'", async () => {
+      vi.mocked(client.delete).mockResolvedValue('OK')
+      const result = await api.deleteById('dep-1')
+      expect(client.delete).toHaveBeenCalledWith('/departments/dep-1', undefined)
+      expect(result).toBe('OK')
+    })
+  })
+})