@atribu/node 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,198 @@
+import { H as HttpClientLike, p as paths, R as RequestOptions } from './api.d-BXINTQo6.cjs';
+import { A as AtribuError } from './errors-D3ApBz8J.cjs';
+export { a as ApiErrorBody, b as ApiErrorCode, c as AtribuApiError, d as AtribuConfigError, e as AtribuOauthError, f as AtribuTransportError, g as AtribuWebhookError, O as OauthErrorCode, R as RetryHint, W as WebhookErrorCode } from './errors-D3ApBz8J.cjs';
+
+interface AtribuClientConfig {
+    apiKey: string;
+    baseUrl?: string;
+    fetch?: typeof fetch;
+    timeoutMs?: number;
+    userAgent?: string;
+    defaultIdempotencyKeyGenerator?: () => string;
+}
+
+type SendBody = NonNullable<paths["/api/v1/messages"]["post"]["requestBody"]>["content"]["application/json"];
+type SendResponse = paths["/api/v1/messages"]["post"]["responses"][200]["content"]["application/json"];
+type MessageSendInput = SendBody;
+type MessageContent = SendBody["content"];
+type MessageSendResponse = SendResponse["data"];
+interface SendOptions {
+    idempotencyKey?: string;
+    signal?: AbortSignal;
+}
+declare class MessagesResource {
+    private readonly http;
+    constructor(http: HttpClientLike);
+    send(input: MessageSendInput, opts?: SendOptions): Promise<MessageSendResponse>;
+}
+
+type ReplyBody = NonNullable<paths["/api/v1/comments/{comment_id}/reply"]["post"]["requestBody"]>["content"]["application/json"];
+type PrivateReplyBody = NonNullable<paths["/api/v1/comments/{comment_id}/private-reply"]["post"]["requestBody"]>["content"]["application/json"];
+type ReplyResponse = paths["/api/v1/comments/{comment_id}/reply"]["post"]["responses"][200]["content"]["application/json"];
+type CommentReplyInput = ReplyBody & {
+    comment_id: string;
+};
+type CommentPrivateReplyInput = PrivateReplyBody & {
+    comment_id: string;
+};
+type CommentReplyResponse = ReplyResponse["data"];
+interface CommentReplyOptions {
+    idempotencyKey?: string;
+    signal?: AbortSignal;
+}
+declare class CommentsResource {
+    private readonly http;
+    constructor(http: HttpClientLike);
+    reply(input: CommentReplyInput, opts?: CommentReplyOptions): Promise<CommentReplyResponse>;
+    privateReply(input: CommentPrivateReplyInput, opts?: CommentReplyOptions): Promise<CommentReplyResponse>;
+}
+
+type ListResponse = paths["/api/v1/webhooks/subscriptions"]["get"]["responses"][200]["content"]["application/json"];
+type CreateBody = NonNullable<paths["/api/v1/webhooks/subscriptions"]["post"]["requestBody"]>["content"]["application/json"];
+type CreateResponse = paths["/api/v1/webhooks/subscriptions"]["post"]["responses"][201]["content"]["application/json"];
+type UpdateBody = NonNullable<paths["/api/v1/webhooks/subscriptions/{id}"]["patch"]["requestBody"]>["content"]["application/json"];
+type RotateBody = NonNullable<NonNullable<paths["/api/v1/webhooks/subscriptions/{id}/rotate-secret"]["post"]["requestBody"]>["content"]["application/json"]>;
+type RotateResponse = paths["/api/v1/webhooks/subscriptions/{id}/rotate-secret"]["post"]["responses"][200]["content"]["application/json"];
+type TestResponse = paths["/api/v1/webhooks/test/{id}"]["post"]["responses"][200]["content"]["application/json"];
+type WebhookSubscription = ListResponse["data"][number];
+type WebhookSubscriptionWithSecret = CreateResponse["data"];
+type WebhookSubscriptionCreateInput = CreateBody;
+type WebhookSubscriptionUpdateInput = UpdateBody;
+type WebhookSubscriptionRotateOptions = RotateBody;
+type WebhookSubscriptionRotateResult = RotateResponse["data"];
+type WebhookSubscriptionTestResult = TestResponse["data"];
+interface MutationOptions {
+    idempotencyKey?: string;
+    signal?: AbortSignal;
+}
+declare class WebhookSubscriptionsResource {
+    private readonly http;
+    constructor(http: HttpClientLike);
+    list(opts?: {
+        signal?: AbortSignal;
+    }): Promise<WebhookSubscription[]>;
+    create(input: WebhookSubscriptionCreateInput, opts?: MutationOptions): Promise<WebhookSubscriptionWithSecret>;
+    update(id: string, input: WebhookSubscriptionUpdateInput, opts?: MutationOptions): Promise<WebhookSubscription>;
+    delete(id: string, opts?: MutationOptions): Promise<void>;
+    rotateSecret(id: string, options?: WebhookSubscriptionRotateOptions, opts?: MutationOptions): Promise<WebhookSubscriptionRotateResult>;
+    test(id: string, opts?: MutationOptions): Promise<WebhookSubscriptionTestResult>;
+}
+
+type ReplayResponse = paths["/api/v1/webhooks/deliveries/{id}/replay"]["post"]["responses"][200]["content"]["application/json"];
+type WebhookDeliveryReplayResult = ReplayResponse["data"];
+interface ReplayOptions {
+    idempotencyKey?: string;
+    signal?: AbortSignal;
+}
+declare class WebhookDeliveriesResource {
+    private readonly http;
+    constructor(http: HttpClientLike);
+    replay(id: string, opts?: ReplayOptions): Promise<WebhookDeliveryReplayResult>;
+}
+
+/**
+ * Opt-in retry layer.
+ *
+ * Why opt-in: hiding retries inside the SDK by default obscures backpressure
+ * signals and amplifies load on a failing server. Consumers that want them
+ * call `.withRetry({...})`; others write their own retry logic against the
+ * typed `retry` hint on AtribuApiError.
+ *
+ * What gets retried:
+ *   - `AtribuApiError` with `retry.action === "retry"` (5xx, 408)
+ *   - `AtribuApiError` with `retry.action === "retry_after"` (429, 503 w/
+ *     Retry-After) — honors retryAfterMs
+ *   - `AtribuTransportError` (network glitches, ECONNRESET, timeouts)
+ *
+ * What does NOT retry:
+ *   - `AtribuApiError` with `retry.action === "do_not_retry"` (403)
+ *   - `AtribuApiError` with `retry.action === "fix_and_retry"` (422 etc — the
+ *     caller's input is wrong; retrying with the same body won't help)
+ *   - `AtribuApiError` with `retry.action === "refresh_token"` (401 — needs
+ *     credential refresh, not a retry)
+ *   - `AtribuConfigError`, `AtribuWebhookError`, anything else
+ */
+
+type BackoffStrategy = "exponential" | "fixed" | "none";
+interface RetryOptions {
+    /**
+     * Max attempts including the initial call. `maxAttempts: 3` = initial + 2
+     * retries. Must be ≥ 1. Default 3.
+     */
+    maxAttempts?: number;
+    /**
+     * Backoff strategy between retries. "exponential" = `baseDelayMs * 2^n`
+     * (capped by `maxDelayMs`). "fixed" = `baseDelayMs`. "none" = no delay.
+     * Default "exponential".
+     */
+    backoff?: BackoffStrategy;
+    /** Base delay between retries in ms. Default 500. */
+    baseDelayMs?: number;
+    /** Cap on the delay between retries. Default 30000 (30s). */
+    maxDelayMs?: number;
+    /**
+     * Jitter factor 0..1. Multiplies the computed delay by `1 + random*jitter`
+     * (jitter=0 means deterministic). Default 0.3.
+     */
+    jitter?: number;
+    /** Inject for tests. Default `(ms) => new Promise(r => setTimeout(r, ms))`. */
+    sleep?: (ms: number) => Promise<void>;
+    /** Inject for jitter tests. Default Math.random. */
+    random?: () => number;
+}
+declare class RetryingHttpClient implements HttpClientLike {
+    private readonly base;
+    private readonly r;
+    constructor(base: HttpClientLike, options: RetryOptions);
+    request<T>(opts: RequestOptions): Promise<T>;
+    /**
+     * Returns the delay in ms before the next attempt, or null if the error
+     * is non-retryable (caller should throw immediately).
+     */
+    private computeDelay;
+    private backoffDelay;
+    private applyJitter;
+}
+declare function isRetryableError(err: unknown): err is AtribuError;
+
+interface ResourceBundle {
+    messages: MessagesResource;
+    comments: CommentsResource;
+    webhooks: {
+        subscriptions: WebhookSubscriptionsResource;
+        deliveries: WebhookDeliveriesResource;
+    };
+}
+declare class AtribuClient {
+    readonly messages: MessagesResource;
+    readonly comments: CommentsResource;
+    readonly webhooks: ResourceBundle["webhooks"];
+    /** @internal — exposed for `withRetry` chaining; do not depend on this. */
+    protected readonly _http: HttpClientLike;
+    constructor(config: AtribuClientConfig);
+    /**
+     * Returns a new AtribuClient that retries on transient errors. The
+     * original client is not mutated. The wrapper respects the typed
+     * `retry` hint on AtribuApiError — `do_not_retry`, `fix_and_retry`,
+     * and `refresh_token` are NOT retried (those need caller action, not
+     * a repeat call).
+     *
+     * @example
+     *   const client = new AtribuClient({...}).withRetry({
+     *     maxAttempts: 3,
+     *     backoff: "exponential",
+     *     baseDelayMs: 500,
+     *   });
+     *   await client.messages.send({...});
+     */
+    withRetry(options: RetryOptions): AtribuClient;
+    private static _fromHttp;
+}
+
+declare const SDK_VERSION = "0.1.0";
+
+type Runtime = "node" | "bun" | "deno" | "edge" | "browser" | "unknown";
+declare function detectRuntime(): Runtime;
+declare function runtimeTag(): string;
+
+export { AtribuClient, type AtribuClientConfig, AtribuError, type BackoffStrategy, type CommentPrivateReplyInput, type CommentReplyInput, type CommentReplyOptions, type CommentReplyResponse, type MessageContent, type MessageSendInput, type MessageSendResponse, type MutationOptions, type ReplayOptions, type RetryOptions, RetryingHttpClient, type Runtime, SDK_VERSION, type SendOptions, type WebhookDeliveryReplayResult, type WebhookSubscription, type WebhookSubscriptionCreateInput, type WebhookSubscriptionRotateOptions, type WebhookSubscriptionRotateResult, type WebhookSubscriptionTestResult, type WebhookSubscriptionUpdateInput, type WebhookSubscriptionWithSecret, detectRuntime, isRetryableError, runtimeTag };

package/dist/index.d.ts

@@ -0,0 +1,198 @@
+import { H as HttpClientLike, p as paths, R as RequestOptions } from './api.d-BXINTQo6.js';
+import { A as AtribuError } from './errors-D3ApBz8J.js';
+export { a as ApiErrorBody, b as ApiErrorCode, c as AtribuApiError, d as AtribuConfigError, e as AtribuOauthError, f as AtribuTransportError, g as AtribuWebhookError, O as OauthErrorCode, R as RetryHint, W as WebhookErrorCode } from './errors-D3ApBz8J.js';
+
+interface AtribuClientConfig {
+    apiKey: string;
+    baseUrl?: string;
+    fetch?: typeof fetch;
+    timeoutMs?: number;
+    userAgent?: string;
+    defaultIdempotencyKeyGenerator?: () => string;
+}
+
+type SendBody = NonNullable<paths["/api/v1/messages"]["post"]["requestBody"]>["content"]["application/json"];
+type SendResponse = paths["/api/v1/messages"]["post"]["responses"][200]["content"]["application/json"];
+type MessageSendInput = SendBody;
+type MessageContent = SendBody["content"];
+type MessageSendResponse = SendResponse["data"];
+interface SendOptions {
+    idempotencyKey?: string;
+    signal?: AbortSignal;
+}
+declare class MessagesResource {
+    private readonly http;
+    constructor(http: HttpClientLike);
+    send(input: MessageSendInput, opts?: SendOptions): Promise<MessageSendResponse>;
+}
+
+type ReplyBody = NonNullable<paths["/api/v1/comments/{comment_id}/reply"]["post"]["requestBody"]>["content"]["application/json"];
+type PrivateReplyBody = NonNullable<paths["/api/v1/comments/{comment_id}/private-reply"]["post"]["requestBody"]>["content"]["application/json"];
+type ReplyResponse = paths["/api/v1/comments/{comment_id}/reply"]["post"]["responses"][200]["content"]["application/json"];
+type CommentReplyInput = ReplyBody & {
+    comment_id: string;
+};
+type CommentPrivateReplyInput = PrivateReplyBody & {
+    comment_id: string;
+};
+type CommentReplyResponse = ReplyResponse["data"];
+interface CommentReplyOptions {
+    idempotencyKey?: string;
+    signal?: AbortSignal;
+}
+declare class CommentsResource {
+    private readonly http;
+    constructor(http: HttpClientLike);
+    reply(input: CommentReplyInput, opts?: CommentReplyOptions): Promise<CommentReplyResponse>;
+    privateReply(input: CommentPrivateReplyInput, opts?: CommentReplyOptions): Promise<CommentReplyResponse>;
+}
+
+type ListResponse = paths["/api/v1/webhooks/subscriptions"]["get"]["responses"][200]["content"]["application/json"];
+type CreateBody = NonNullable<paths["/api/v1/webhooks/subscriptions"]["post"]["requestBody"]>["content"]["application/json"];
+type CreateResponse = paths["/api/v1/webhooks/subscriptions"]["post"]["responses"][201]["content"]["application/json"];
+type UpdateBody = NonNullable<paths["/api/v1/webhooks/subscriptions/{id}"]["patch"]["requestBody"]>["content"]["application/json"];
+type RotateBody = NonNullable<NonNullable<paths["/api/v1/webhooks/subscriptions/{id}/rotate-secret"]["post"]["requestBody"]>["content"]["application/json"]>;
+type RotateResponse = paths["/api/v1/webhooks/subscriptions/{id}/rotate-secret"]["post"]["responses"][200]["content"]["application/json"];
+type TestResponse = paths["/api/v1/webhooks/test/{id}"]["post"]["responses"][200]["content"]["application/json"];
+type WebhookSubscription = ListResponse["data"][number];
+type WebhookSubscriptionWithSecret = CreateResponse["data"];
+type WebhookSubscriptionCreateInput = CreateBody;
+type WebhookSubscriptionUpdateInput = UpdateBody;
+type WebhookSubscriptionRotateOptions = RotateBody;
+type WebhookSubscriptionRotateResult = RotateResponse["data"];
+type WebhookSubscriptionTestResult = TestResponse["data"];
+interface MutationOptions {
+    idempotencyKey?: string;
+    signal?: AbortSignal;
+}
+declare class WebhookSubscriptionsResource {
+    private readonly http;
+    constructor(http: HttpClientLike);
+    list(opts?: {
+        signal?: AbortSignal;
+    }): Promise<WebhookSubscription[]>;
+    create(input: WebhookSubscriptionCreateInput, opts?: MutationOptions): Promise<WebhookSubscriptionWithSecret>;
+    update(id: string, input: WebhookSubscriptionUpdateInput, opts?: MutationOptions): Promise<WebhookSubscription>;
+    delete(id: string, opts?: MutationOptions): Promise<void>;
+    rotateSecret(id: string, options?: WebhookSubscriptionRotateOptions, opts?: MutationOptions): Promise<WebhookSubscriptionRotateResult>;
+    test(id: string, opts?: MutationOptions): Promise<WebhookSubscriptionTestResult>;
+}
+
+type ReplayResponse = paths["/api/v1/webhooks/deliveries/{id}/replay"]["post"]["responses"][200]["content"]["application/json"];
+type WebhookDeliveryReplayResult = ReplayResponse["data"];
+interface ReplayOptions {
+    idempotencyKey?: string;
+    signal?: AbortSignal;
+}
+declare class WebhookDeliveriesResource {
+    private readonly http;
+    constructor(http: HttpClientLike);
+    replay(id: string, opts?: ReplayOptions): Promise<WebhookDeliveryReplayResult>;
+}
+
+/**
+ * Opt-in retry layer.
+ *
+ * Why opt-in: hiding retries inside the SDK by default obscures backpressure
+ * signals and amplifies load on a failing server. Consumers that want them
+ * call `.withRetry({...})`; others write their own retry logic against the
+ * typed `retry` hint on AtribuApiError.
+ *
+ * What gets retried:
+ *   - `AtribuApiError` with `retry.action === "retry"` (5xx, 408)
+ *   - `AtribuApiError` with `retry.action === "retry_after"` (429, 503 w/
+ *     Retry-After) — honors retryAfterMs
+ *   - `AtribuTransportError` (network glitches, ECONNRESET, timeouts)
+ *
+ * What does NOT retry:
+ *   - `AtribuApiError` with `retry.action === "do_not_retry"` (403)
+ *   - `AtribuApiError` with `retry.action === "fix_and_retry"` (422 etc — the
+ *     caller's input is wrong; retrying with the same body won't help)
+ *   - `AtribuApiError` with `retry.action === "refresh_token"` (401 — needs
+ *     credential refresh, not a retry)
+ *   - `AtribuConfigError`, `AtribuWebhookError`, anything else
+ */
+
+type BackoffStrategy = "exponential" | "fixed" | "none";
+interface RetryOptions {
+    /**
+     * Max attempts including the initial call. `maxAttempts: 3` = initial + 2
+     * retries. Must be ≥ 1. Default 3.
+     */
+    maxAttempts?: number;
+    /**
+     * Backoff strategy between retries. "exponential" = `baseDelayMs * 2^n`
+     * (capped by `maxDelayMs`). "fixed" = `baseDelayMs`. "none" = no delay.
+     * Default "exponential".
+     */
+    backoff?: BackoffStrategy;
+    /** Base delay between retries in ms. Default 500. */
+    baseDelayMs?: number;
+    /** Cap on the delay between retries. Default 30000 (30s). */
+    maxDelayMs?: number;
+    /**
+     * Jitter factor 0..1. Multiplies the computed delay by `1 + random*jitter`
+     * (jitter=0 means deterministic). Default 0.3.
+     */
+    jitter?: number;
+    /** Inject for tests. Default `(ms) => new Promise(r => setTimeout(r, ms))`. */
+    sleep?: (ms: number) => Promise<void>;
+    /** Inject for jitter tests. Default Math.random. */
+    random?: () => number;
+}
+declare class RetryingHttpClient implements HttpClientLike {
+    private readonly base;
+    private readonly r;
+    constructor(base: HttpClientLike, options: RetryOptions);
+    request<T>(opts: RequestOptions): Promise<T>;
+    /**
+     * Returns the delay in ms before the next attempt, or null if the error
+     * is non-retryable (caller should throw immediately).
+     */
+    private computeDelay;
+    private backoffDelay;
+    private applyJitter;
+}
+declare function isRetryableError(err: unknown): err is AtribuError;
+
+interface ResourceBundle {
+    messages: MessagesResource;
+    comments: CommentsResource;
+    webhooks: {
+        subscriptions: WebhookSubscriptionsResource;
+        deliveries: WebhookDeliveriesResource;
+    };
+}
+declare class AtribuClient {
+    readonly messages: MessagesResource;
+    readonly comments: CommentsResource;
+    readonly webhooks: ResourceBundle["webhooks"];
+    /** @internal — exposed for `withRetry` chaining; do not depend on this. */
+    protected readonly _http: HttpClientLike;
+    constructor(config: AtribuClientConfig);
+    /**
+     * Returns a new AtribuClient that retries on transient errors. The
+     * original client is not mutated. The wrapper respects the typed
+     * `retry` hint on AtribuApiError — `do_not_retry`, `fix_and_retry`,
+     * and `refresh_token` are NOT retried (those need caller action, not
+     * a repeat call).
+     *
+     * @example
+     *   const client = new AtribuClient({...}).withRetry({
+     *     maxAttempts: 3,
+     *     backoff: "exponential",
+     *     baseDelayMs: 500,
+     *   });
+     *   await client.messages.send({...});
+     */
+    withRetry(options: RetryOptions): AtribuClient;
+    private static _fromHttp;
+}
+
+declare const SDK_VERSION = "0.1.0";
+
+type Runtime = "node" | "bun" | "deno" | "edge" | "browser" | "unknown";
+declare function detectRuntime(): Runtime;
+declare function runtimeTag(): string;
+
+export { AtribuClient, type AtribuClientConfig, AtribuError, type BackoffStrategy, type CommentPrivateReplyInput, type CommentReplyInput, type CommentReplyOptions, type CommentReplyResponse, type MessageContent, type MessageSendInput, type MessageSendResponse, type MutationOptions, type ReplayOptions, type RetryOptions, RetryingHttpClient, type Runtime, SDK_VERSION, type SendOptions, type WebhookDeliveryReplayResult, type WebhookSubscription, type WebhookSubscriptionCreateInput, type WebhookSubscriptionRotateOptions, type WebhookSubscriptionRotateResult, type WebhookSubscriptionTestResult, type WebhookSubscriptionUpdateInput, type WebhookSubscriptionWithSecret, detectRuntime, isRetryableError, runtimeTag };