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

package/package.json

@@ -1,6 +1,47 @@
 {
   "name": "@workwae/sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0-alpha.1",
+  "description": "Typed client for the workwae email, calendar and contacts API, with pagination, error and webhook signature helpers",
+  "license": "UNLICENSED",
+  "homepage": "https://workwae.com",
+  "bugs": "https://workwae.com/support",
+  "keywords": [
+    "workwae",
+    "email",
+    "calendar",
+    "contacts",
+    "gmail",
+    "microsoft-graph",
+    "imap",
+    "webhooks",
+    "sdk"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "**/*.js",
+    "**/*.js.map",
+    "**/*.d.ts"
+  ],
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "types": "./index.d.ts",
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "@orpc/client": "1.15.5",
+    "@orpc/contract": "1.15.5",
+    "@orpc/openapi-client": "1.15.5",
+    "zod": "4.6.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/pagination.d.ts

@@ -0,0 +1,40 @@
+import { type Event, type EventFeedPage, type Page } from "./contract/public.js";
+/** Per-request options forwarded to every call a helper makes. */
+export interface CallOptions {
+    signal?: AbortSignal;
+}
+/** A procedure that takes a cursor in its input. */
+export type CursorCall<TInput, TOutput> = (input: TInput, options?: CallOptions) => PromiseLike<TOutput>;
+/** Every page of a list, from `input.cursor` (or the start) to the last page. */
+export declare function pages<TInput extends {
+    cursor?: string;
+}, TItem>(list: CursorCall<TInput, Page<TItem>>, input: NoInfer<TInput>, options?: CallOptions): AsyncGenerator<Page<TItem>, void, undefined>;
+/**
+ * Every item of a list, following `nextCursor` until the last page:
+ * `for await (const account of paginate(workwae.accounts.list, { limit: 100 }))`.
+ */
+export declare function paginate<TInput extends {
+    cursor?: string;
+}, TItem>(list: CursorCall<TInput, Page<TItem>>, input: NoInfer<TInput>, options?: CallOptions): AsyncGenerator<TItem, void, undefined>;
+/**
+ * Reads the change feed from `input.cursor` until it is caught up (an empty page). `cursor` moves
+ * past a page only once its last event has been consumed, so persisting it after processing
+ * gives at-least-once delivery: stopping mid-page replays that page next time.
+ */
+export declare class ChangeFeed<TInput extends {
+    cursor?: string;
+}> implements AsyncIterable<Event> {
+    #private;
+    private readonly list;
+    private readonly input;
+    private readonly options?;
+    constructor(list: CursorCall<TInput, EventFeedPage>, input: TInput, options?: CallOptions | undefined);
+    /** Where to resume: pass it as `cursor` next time. Undefined until the first page is read when
+     * no cursor was given. */
+    get cursor(): string | undefined;
+    [Symbol.asyncIterator](): AsyncGenerator<Event, void, undefined>;
+}
+/** `const feed = changes(workwae.changes.list, { cursor: saved })`; iterate, then save `feed.cursor`. */
+export declare function changes<TInput extends {
+    cursor?: string;
+}>(list: CursorCall<TInput, EventFeedPage>, input: NoInfer<TInput>, options?: CallOptions): ChangeFeed<TInput>;

package/webhooks.d.ts

@@ -0,0 +1,28 @@
+import { Event, type VerifyWebhookOptions, type WebhookHeaders } from "./contract/public.js";
+export { checkWebhookSignature, MAX_SIGNATURE_CANDIDATES, type VerifyWebhookOptions, verifyWebhook, WEBHOOK_TOLERANCE_SECONDS, type WebhookHeaders, WebhookVerificationError, type WebhookVerificationFailure, } from "./contract/public.js";
+/** An event of a type this SDK knows, its data checked against that type's schema. Check
+ * `event.type` to narrow `event.data`. */
+export type KnownEvent = Event & {
+    known: true;
+};
+/** An event of a type added to the platform after this build: its data is passed on unchecked. */
+export interface UnknownEvent {
+    id: string;
+    type: string;
+    accountId: string | null;
+    createdAt: Date;
+    data: {
+        [key: string]: unknown;
+    };
+    isTest?: true;
+    known: false;
+}
+/** What parseWebhook returns. Check `known` first: a known event then narrows on `type`. */
+export type WebhookEvent = KnownEvent | UnknownEvent;
+/**
+ * Verifies the delivery, then returns its event with its dates as Dates; throws
+ * WebhookVerificationError otherwise. Pass the raw request body exactly as received. A known type
+ * whose body does not match its schema is refused (failure "payload"); a type added after this
+ * build is returned with `known: false`. Envelope fields added after this build are kept.
+ */
+export declare function parseWebhook(secret: string, headers: WebhookHeaders, body: string | Uint8Array | ArrayBuffer, options?: VerifyWebhookOptions): Promise<WebhookEvent>;