@open-apime/sdk 0.3.1 → 0.4.0

package/dist/index.cjs

@@ -29,6 +29,7 @@ __export(index_exports, {
   ConfigurationError: () => ConfigurationError,
   ConflictError: () => ConflictError,
   ConnectionError: () => ConnectionError,
+  DEFAULT_HEALTH_TIMEOUT_MS: () => DEFAULT_HEALTH_TIMEOUT_MS,
   InvalidRequestError: () => InvalidRequestError,
   InvalidSignatureError: () => InvalidSignatureError,
   NotFoundError: () => NotFoundError,
@@ -37,6 +38,7 @@ __export(index_exports, {
   SessionUnavailableError: () => SessionUnavailableError,
   TimeoutError: () => TimeoutError,
   UnprocessableError: () => UnprocessableError,
+  checkHealth: () => checkHealth,
   constructEvent: () => constructEvent,
   hasSentry: () => hasSentry,
   verifyWebhookSignature: () => verifyWebhookSignature
@@ -785,6 +787,31 @@ var Apime = {
   }
 };
 
+// src/health.ts
+var DEFAULT_HEALTH_TIMEOUT_MS = 1e4;
+async function checkHealth(baseUrl, options = {}) {
+  const url = buildUrl(assertUsableBaseUrl(baseUrl), "/healthz");
+  const impl = options.fetch ?? globalThis.fetch;
+  const timeoutMs = options.timeoutMs ?? DEFAULT_HEALTH_TIMEOUT_MS;
+  const controller = new AbortController();
+  const timer = setTimeout(() => controller.abort(), timeoutMs);
+  try {
+    const response = await impl(url, { method: "GET", signal: controller.signal });
+    if (!response.ok) {
+      throw new ApimeError(`apime respondeu ${response.status} no healthz`, { status: response.status });
+    }
+    return await response.json();
+  } catch (cause) {
+    if (cause instanceof ApimeError) throw cause;
+    if (controller.signal.aborted) {
+      throw new TimeoutError(`o healthz passou de ${timeoutMs}ms`, { cause });
+    }
+    throw new ConnectionError("falha de rede ao falar com o apime", { cause });
+  } finally {
+    clearTimeout(timer);
+  }
+}
+
 // src/webhook/index.ts
 var import_node_crypto = require("crypto");
 var InvalidSignatureError = class extends ApimeError {
@@ -822,6 +849,7 @@ function constructEvent(rawBody, signature, secret) {
   ConfigurationError,
   ConflictError,
   ConnectionError,
+  DEFAULT_HEALTH_TIMEOUT_MS,
   InvalidRequestError,
   InvalidSignatureError,
   NotFoundError,
@@ -830,6 +858,7 @@ function constructEvent(rawBody, signature, secret) {
   SessionUnavailableError,
   TimeoutError,
   UnprocessableError,
+  checkHealth,
   constructEvent,
   hasSentry,
   verifyWebhookSignature

package/dist/index.d.cts

@@ -523,4 +523,16 @@ declare const Apime: {
     }, options: ClientOptions): ApimeInstanceClient;
 };
 
-export { type ApiToken, type ApiTokenAuth, Apime, ApimeError, ApimeInstanceClient, ApimeUserClient, type Auth, type AuthKind, type CheckNumberResult, type ClientOptions, type ContactEntry, type CreateInstanceInput, EventLogEntry, type FailureInfo, type GroupInfo, type GroupParticipant, Instance, InstanceInfo, type InstanceTokenAuth, type IpFamily, type JoinRequestAction, type MarkReadInput, type Observer, type ParticipantAction, type PresenceState, Profile, QrCode, type QuoteInput, type RequestInfo, type RequestOptions, type SendAudioInput, type SendContactInput, type SendDocumentInput, type SendLocationInput, type SendMediaInput, type SendTextInput, SentMessage, type SuccessInfo, type UpdateInstanceInput, type User, type UserAuth, type UserJwtAuth, hasSentry };
+interface HealthOptions {
+    /** Kept short on purpose: a health check that hangs is worse than one that fails. */
+    timeoutMs?: number;
+    fetch?: typeof globalThis.fetch;
+}
+interface HealthResult {
+    status?: string;
+    [key: string]: unknown;
+}
+declare const DEFAULT_HEALTH_TIMEOUT_MS = 10000;
+declare function checkHealth(baseUrl: string, options?: HealthOptions): Promise<HealthResult>;
+
+export { type ApiToken, type ApiTokenAuth, Apime, ApimeError, ApimeInstanceClient, ApimeUserClient, type Auth, type AuthKind, type CheckNumberResult, type ClientOptions, type ContactEntry, type CreateInstanceInput, DEFAULT_HEALTH_TIMEOUT_MS, EventLogEntry, type FailureInfo, type GroupInfo, type GroupParticipant, type HealthOptions, type HealthResult, Instance, InstanceInfo, type InstanceTokenAuth, type IpFamily, type JoinRequestAction, type MarkReadInput, type Observer, type ParticipantAction, type PresenceState, Profile, QrCode, type QuoteInput, type RequestInfo, type RequestOptions, type SendAudioInput, type SendContactInput, type SendDocumentInput, type SendLocationInput, type SendMediaInput, type SendTextInput, SentMessage, type SuccessInfo, type UpdateInstanceInput, type User, type UserAuth, type UserJwtAuth, checkHealth, hasSentry };

package/dist/index.d.ts

@@ -523,4 +523,16 @@ declare const Apime: {
     }, options: ClientOptions): ApimeInstanceClient;
 };
 
-export { type ApiToken, type ApiTokenAuth, Apime, ApimeError, ApimeInstanceClient, ApimeUserClient, type Auth, type AuthKind, type CheckNumberResult, type ClientOptions, type ContactEntry, type CreateInstanceInput, EventLogEntry, type FailureInfo, type GroupInfo, type GroupParticipant, Instance, InstanceInfo, type InstanceTokenAuth, type IpFamily, type JoinRequestAction, type MarkReadInput, type Observer, type ParticipantAction, type PresenceState, Profile, QrCode, type QuoteInput, type RequestInfo, type RequestOptions, type SendAudioInput, type SendContactInput, type SendDocumentInput, type SendLocationInput, type SendMediaInput, type SendTextInput, SentMessage, type SuccessInfo, type UpdateInstanceInput, type User, type UserAuth, type UserJwtAuth, hasSentry };
+interface HealthOptions {
+    /** Kept short on purpose: a health check that hangs is worse than one that fails. */
+    timeoutMs?: number;
+    fetch?: typeof globalThis.fetch;
+}
+interface HealthResult {
+    status?: string;
+    [key: string]: unknown;
+}
+declare const DEFAULT_HEALTH_TIMEOUT_MS = 10000;
+declare function checkHealth(baseUrl: string, options?: HealthOptions): Promise<HealthResult>;
+
+export { type ApiToken, type ApiTokenAuth, Apime, ApimeError, ApimeInstanceClient, ApimeUserClient, type Auth, type AuthKind, type CheckNumberResult, type ClientOptions, type ContactEntry, type CreateInstanceInput, DEFAULT_HEALTH_TIMEOUT_MS, EventLogEntry, type FailureInfo, type GroupInfo, type GroupParticipant, type HealthOptions, type HealthResult, Instance, InstanceInfo, type InstanceTokenAuth, type IpFamily, type JoinRequestAction, type MarkReadInput, type Observer, type ParticipantAction, type PresenceState, Profile, QrCode, type QuoteInput, type RequestInfo, type RequestOptions, type SendAudioInput, type SendContactInput, type SendDocumentInput, type SendLocationInput, type SendMediaInput, type SendTextInput, SentMessage, type SuccessInfo, type UpdateInstanceInput, type User, type UserAuth, type UserJwtAuth, checkHealth, hasSentry };

package/dist/index.js

@@ -715,6 +715,31 @@ var Apime = {
     );
   }
 };
+
+// src/health.ts
+var DEFAULT_HEALTH_TIMEOUT_MS = 1e4;
+async function checkHealth(baseUrl, options = {}) {
+  const url = buildUrl(assertUsableBaseUrl(baseUrl), "/healthz");
+  const impl = options.fetch ?? globalThis.fetch;
+  const timeoutMs = options.timeoutMs ?? DEFAULT_HEALTH_TIMEOUT_MS;
+  const controller = new AbortController();
+  const timer = setTimeout(() => controller.abort(), timeoutMs);
+  try {
+    const response = await impl(url, { method: "GET", signal: controller.signal });
+    if (!response.ok) {
+      throw new ApimeError(`apime respondeu ${response.status} no healthz`, { status: response.status });
+    }
+    return await response.json();
+  } catch (cause) {
+    if (cause instanceof ApimeError) throw cause;
+    if (controller.signal.aborted) {
+      throw new TimeoutError(`o healthz passou de ${timeoutMs}ms`, { cause });
+    }
+    throw new ConnectionError("falha de rede ao falar com o apime", { cause });
+  } finally {
+    clearTimeout(timer);
+  }
+}
 export {
   ApiError,
   Apime,
@@ -725,6 +750,7 @@ export {
   ConfigurationError,
   ConflictError,
   ConnectionError,
+  DEFAULT_HEALTH_TIMEOUT_MS,
   InvalidRequestError,
   InvalidSignatureError,
   NotFoundError,
@@ -733,6 +759,7 @@ export {
   SessionUnavailableError,
   TimeoutError,
   UnprocessableError,
+  checkHealth,
   constructEvent,
   hasSentry,
   verifyWebhookSignature

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-apime/sdk",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Cliente TypeScript da API do apime: WhatsApp, instâncias e webhooks",
   "license": "MIT",
   "repository": {