@open-apime/sdk 0.4.1 → 0.5.0

package/dist/index.cjs

@@ -490,6 +490,18 @@ var MessagesResource = class {
     form.set("file", input.file, input.filename ?? fileName(input.file, "media"));
     return this.http.request({ method: "POST", path: `${this.base}/media`, body: form, ...options ? { options } : {} });
   }
+  sendGif(input, options) {
+    const form = toForm(input, ["file", "filename"]);
+    form.set("type", "gif");
+    form.set("file", input.file, input.filename ?? fileName(input.file, "animation.mp4"));
+    return this.http.request({ method: "POST", path: `${this.base}/media`, body: form, ...options ? { options } : {} });
+  }
+  sendSticker(input, options) {
+    const form = toForm(input, ["file", "filename"]);
+    form.set("type", "sticker");
+    form.set("file", input.file, input.filename ?? fileName(input.file, "sticker.webp"));
+    return this.http.request({ method: "POST", path: `${this.base}/media`, body: form, ...options ? { options } : {} });
+  }
   sendAudio(input, options) {
     const form = toForm(input, ["file", "filename"]);
     form.set("file", input.file, input.filename ?? fileName(input.file, "audio.ogg"));

package/dist/index.d.cts

@@ -230,6 +230,32 @@ interface SendMediaInput extends QuoteInput, MarkReadInput {
     filename?: string;
     caption?: string;
 }
+/**
+ * A GIF on WhatsApp is an MP4 VIDEO carrying the gif-playback flag, which is what makes the client
+ * loop it with no controls. Sending a real `.gif` file arrives as a still image, so it gets a method
+ * of its own rather than a `type` on sendMedia: the name is what warns the caller at the call site.
+ */
+interface SendGifInput extends QuoteInput, MarkReadInput {
+    to: string;
+    /** MP4 bytes. A `.gif` file is NOT what WhatsApp expects here. */
+    file: Blob | File;
+    filename?: string;
+    caption?: string;
+}
+/**
+ * WhatsApp takes stickers as WebP 512x512, up to 500 KB, transparent background; animated ones are
+ * animated WebP. The server validates and refuses outside that, because a sticker off-spec is
+ * accepted by the wire and then fails to render, with nothing reporting it.
+ *
+ * There is no caption: the protocol has no such field on a sticker, so one would be dropped in
+ * silence. That is why this does not reuse `SendMediaInput`.
+ */
+interface SendStickerInput extends QuoteInput, MarkReadInput {
+    to: string;
+    /** WebP bytes, 512x512, up to 500 KB. */
+    file: Blob | File;
+    filename?: string;
+}
 interface SendAudioInput extends QuoteInput, MarkReadInput {
     to: string;
     file: Blob | File;
@@ -275,6 +301,8 @@ declare class MessagesResource {
     private get base();
     sendText(input: SendTextInput, options?: RequestOptions): Promise<SentMessage>;
     sendMedia(input: SendMediaInput, options?: RequestOptions): Promise<SentMessage>;
+    sendGif(input: SendGifInput, options?: RequestOptions): Promise<SentMessage>;
+    sendSticker(input: SendStickerInput, options?: RequestOptions): Promise<SentMessage>;
     sendAudio(input: SendAudioInput, options?: RequestOptions): Promise<SentMessage>;
     sendDocument(input: SendDocumentInput, options?: RequestOptions): Promise<SentMessage>;
     sendContact(input: SendContactInput, options?: RequestOptions): Promise<SentMessage>;
@@ -535,4 +563,4 @@ interface HealthResult {
 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 };
+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 SendGifInput, type SendLocationInput, type SendMediaInput, type SendStickerInput, type SendTextInput, SentMessage, type SuccessInfo, type UpdateInstanceInput, type User, type UserAuth, type UserJwtAuth, checkHealth, hasSentry };

package/dist/index.d.ts

@@ -230,6 +230,32 @@ interface SendMediaInput extends QuoteInput, MarkReadInput {
     filename?: string;
     caption?: string;
 }
+/**
+ * A GIF on WhatsApp is an MP4 VIDEO carrying the gif-playback flag, which is what makes the client
+ * loop it with no controls. Sending a real `.gif` file arrives as a still image, so it gets a method
+ * of its own rather than a `type` on sendMedia: the name is what warns the caller at the call site.
+ */
+interface SendGifInput extends QuoteInput, MarkReadInput {
+    to: string;
+    /** MP4 bytes. A `.gif` file is NOT what WhatsApp expects here. */
+    file: Blob | File;
+    filename?: string;
+    caption?: string;
+}
+/**
+ * WhatsApp takes stickers as WebP 512x512, up to 500 KB, transparent background; animated ones are
+ * animated WebP. The server validates and refuses outside that, because a sticker off-spec is
+ * accepted by the wire and then fails to render, with nothing reporting it.
+ *
+ * There is no caption: the protocol has no such field on a sticker, so one would be dropped in
+ * silence. That is why this does not reuse `SendMediaInput`.
+ */
+interface SendStickerInput extends QuoteInput, MarkReadInput {
+    to: string;
+    /** WebP bytes, 512x512, up to 500 KB. */
+    file: Blob | File;
+    filename?: string;
+}
 interface SendAudioInput extends QuoteInput, MarkReadInput {
     to: string;
     file: Blob | File;
@@ -275,6 +301,8 @@ declare class MessagesResource {
     private get base();
     sendText(input: SendTextInput, options?: RequestOptions): Promise<SentMessage>;
     sendMedia(input: SendMediaInput, options?: RequestOptions): Promise<SentMessage>;
+    sendGif(input: SendGifInput, options?: RequestOptions): Promise<SentMessage>;
+    sendSticker(input: SendStickerInput, options?: RequestOptions): Promise<SentMessage>;
     sendAudio(input: SendAudioInput, options?: RequestOptions): Promise<SentMessage>;
     sendDocument(input: SendDocumentInput, options?: RequestOptions): Promise<SentMessage>;
     sendContact(input: SendContactInput, options?: RequestOptions): Promise<SentMessage>;
@@ -535,4 +563,4 @@ interface HealthResult {
 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 };
+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 SendGifInput, type SendLocationInput, type SendMediaInput, type SendStickerInput, type SendTextInput, SentMessage, type SuccessInfo, type UpdateInstanceInput, type User, type UserAuth, type UserJwtAuth, checkHealth, hasSentry };

package/dist/index.js

@@ -419,6 +419,18 @@ var MessagesResource = class {
     form.set("file", input.file, input.filename ?? fileName(input.file, "media"));
     return this.http.request({ method: "POST", path: `${this.base}/media`, body: form, ...options ? { options } : {} });
   }
+  sendGif(input, options) {
+    const form = toForm(input, ["file", "filename"]);
+    form.set("type", "gif");
+    form.set("file", input.file, input.filename ?? fileName(input.file, "animation.mp4"));
+    return this.http.request({ method: "POST", path: `${this.base}/media`, body: form, ...options ? { options } : {} });
+  }
+  sendSticker(input, options) {
+    const form = toForm(input, ["file", "filename"]);
+    form.set("type", "sticker");
+    form.set("file", input.file, input.filename ?? fileName(input.file, "sticker.webp"));
+    return this.http.request({ method: "POST", path: `${this.base}/media`, body: form, ...options ? { options } : {} });
+  }
   sendAudio(input, options) {
     const form = toForm(input, ["file", "filename"]);
     form.set("file", input.file, input.filename ?? fileName(input.file, "audio.ogg"));

package/docs/guia.md

@@ -48,6 +48,20 @@ await conexao.messages.sendMedia(
   { idempotencyKey: mensagem.id },
 );
 
+// GIF é MP4 com reprodução em laço, não arquivo .gif: mandar um .gif de verdade
+// faz a mensagem chegar como imagem parada.
+await conexao.messages.sendGif(
+  { to: "5511999999999", file: mp4Blob },
+  { idempotencyKey: mensagem.id },
+);
+
+// Figurinha exige WebP 512x512 até 500 KB (animada ou não), e não tem legenda:
+// o protocolo não traz esse campo. Fora da especificação, o apime recusa com 400.
+await conexao.messages.sendSticker(
+  { to: "5511999999999", file: webpBlob },
+  { idempotencyKey: mensagem.id },
+);
+
 await conexao.whatsapp.groups.updateParticipants(grupoJid, {
   action: "add",
   participants: ["5511999999999@s.whatsapp.net"],

package/package.json

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