@workwae/sdk 0.0.0-stage → 0.1.0-alpha.1

package/contract/webhooks/signing.d.ts

@@ -0,0 +1,35 @@
+/** Allowed clock skew between the platform and a receiver, per the specification. */
+export declare const WEBHOOK_TOLERANCE_SECONDS = 300;
+/** A fetch `Headers`, or a plain record such as Node's `req.headers` (any key case). */
+export type WebhookHeaders = Headers | Record<string, string | string[] | undefined>;
+export interface VerifyWebhookOptions {
+    /** Default WEBHOOK_TOLERANCE_SECONDS. */
+    toleranceSeconds?: number;
+    /** The receiver's clock; default the current time. */
+    now?: Date;
+}
+/** Why a delivery was refused: payload is a signed body that is not an event. */
+export type WebhookVerificationFailure = "missing_headers" | "timestamp" | "signature" | "payload";
+/** What each failure says, as WebhookVerificationError's message. */
+export declare const WEBHOOK_VERIFICATION_MESSAGES: Record<WebhookVerificationFailure, string>;
+export declare class WebhookVerificationError extends Error {
+    readonly failure: WebhookVerificationFailure;
+    constructor(failure: WebhookVerificationFailure, message?: string);
+}
+/** The webhook-signature header value for a delivery: `v1,<base64 HMAC>`. */
+export declare function signWebhook(secret: string, msg: {
+    id: string;
+    timestamp: number;
+    body: string;
+}): Promise<string>;
+/**
+ * Why the delivery's signature does not verify, or null when it does: it is signed with `secret`
+ * and its timestamp is within the tolerance. Pass the raw request body exactly as received:
+ * re-serialized JSON does not verify. The body itself is not looked at.
+ */
+export declare function checkWebhookSignature(secret: string, headers: WebhookHeaders, body: string | Uint8Array | ArrayBuffer, options?: VerifyWebhookOptions): Promise<Exclude<WebhookVerificationFailure, "payload"> | null>;
+/**
+ * True when the delivery is signed with `secret` and its timestamp is within the tolerance.
+ * Pass the raw request body exactly as received: re-serialized JSON does not verify.
+ */
+export declare function verifyWebhook(secret: string, headers: WebhookHeaders, body: string | Uint8Array | ArrayBuffer, options?: VerifyWebhookOptions): Promise<boolean>;

package/errors.d.ts

@@ -0,0 +1,15 @@
+import { ORPCError, type ORPCErrorCode } from "@orpc/client";
+import { type ErrorReason, type ReasonData } from "./contract/public.js";
+export { isDefinedError, ORPCError, safe } from "@orpc/client";
+export type { ErrorReason } from "./contract/public.js";
+declare module "@orpc/client" {
+    interface ORPCError<TCode extends ORPCErrorCode, TData> {
+        /** The X-Request-Id of the answer the error came in; undefined when no answer named one. */
+        requestId?: string;
+    }
+}
+/** An API error with reason `R`; over a union of reasons, the union of each one's error, so
+ * checking `code` narrows `data` to that reason's. */
+type ApiError<R extends ErrorReason> = R extends ErrorReason ? ORPCError<R, ReasonData<R>> : never;
+/** True for an API error carrying a reason, and with `reason`, only for that reason. */
+export declare function isApiError<R extends ErrorReason = ErrorReason>(error: unknown, reason?: R): error is ApiError<R>;

package/index.d.ts

@@ -0,0 +1,6 @@
+export type * from "./contract/public.js";
+export { EVENT_TYPES, MAX_TEMPLATE_BODY_LENGTH, MAX_TEMPLATE_DESCRIPTION_LENGTH, MAX_TEMPLATE_NAME_LENGTH, MAX_TEMPLATE_PREVIEW_TEXT_LENGTH, MAX_TEMPLATE_SUBJECT_LENGTH, } from "./contract/public.js";
+export { type CallContext, type ClientOptions, createClient, type RetryOptions, type WorkwaeClient, } from "./client.js";
+export * from "./errors.js";
+export { type CallOptions, ChangeFeed, type CursorCall, changes, pages, paginate, } from "./pagination.js";
+export * from "./webhooks.js";