@workwae/sdk 0.1.0-alpha.1 → 0.1.0-alpha.3

package/contract/plans/credit-packs.d.ts

@@ -0,0 +1,30 @@
+import * as z from "zod";
+export interface PackTerms {
+    credits: number;
+    amount: number;
+}
+export declare const PlanCreditPack: z.ZodObject<{
+    credits: z.ZodNumber;
+    amount: z.ZodNumber;
+}, z.core.$strip>;
+export type PlanCreditPack = z.infer<typeof PlanCreditPack>;
+export declare const PlanCreditPacks: z.ZodArray<z.ZodObject<{
+    credits: z.ZodNumber;
+    amount: z.ZodNumber;
+}, z.core.$strip>>;
+export interface CreditPackProblem {
+    index: number;
+    field: "credits" | "amount";
+    message: string;
+}
+export declare function creditPackProblems(packs: readonly PackTerms[]): CreditPackProblem[];
+export interface PackLine<P extends PackTerms> {
+    pack: P;
+    count: number;
+}
+export interface PackPurchase<P extends PackTerms> {
+    lines: PackLine<P>[];
+    credits: number;
+    amount: number;
+}
+export declare function cheapestPurchase<P extends PackTerms>(ladder: readonly P[], credits: number): PackPurchase<P> | null;

package/contract/plans/models.d.ts

@@ -0,0 +1,208 @@
+import * as z from "zod";
+export declare const PlanModules: z.ZodObject<{
+    mail: z.ZodBoolean;
+    calendar: z.ZodBoolean;
+    contacts: z.ZodBoolean;
+    tracking: z.ZodBoolean;
+    ai: z.ZodBoolean;
+    meetings: z.ZodBoolean;
+    sharedMailboxes: z.ZodBoolean;
+}, z.core.$strip>;
+export type PlanModules = z.infer<typeof PlanModules>;
+export type PlanModule = keyof PlanModules;
+export declare const PLAN_MODULE_IDS: readonly [
+    "mail",
+    "calendar",
+    "contacts",
+    "tracking",
+    "ai",
+    "meetings",
+    "sharedMailboxes"
+];
+export declare const BILLING_COMPONENTS: readonly [
+    "mail",
+    "calendarContacts",
+    "ai",
+    "sharedMailboxes",
+    "meetings"
+];
+export type BillingComponent = (typeof BILLING_COMPONENTS)[number];
+export declare const COMPONENT_MODULES: {
+    readonly mail: readonly [
+        "mail"
+    ];
+    readonly calendarContacts: readonly [
+        "calendar",
+        "contacts"
+    ];
+    readonly ai: readonly [
+        "ai"
+    ];
+    readonly sharedMailboxes: readonly [
+        "sharedMailboxes"
+    ];
+    readonly meetings: readonly [
+        "meetings"
+    ];
+};
+export declare const MODULE_TOGGLES: readonly [
+    "mail",
+    "calendarContacts",
+    "ai",
+    "sharedMailboxes",
+    "meetings",
+    "tracking"
+];
+export type ModuleToggle = (typeof MODULE_TOGGLES)[number];
+export declare const PLAN_MODULE_NAMES: Record<ModuleToggle | PlanModule, string>;
+export declare const TOGGLE_MODULES: {
+    readonly tracking: readonly [
+        "tracking"
+    ];
+    readonly mail: readonly [
+        "mail"
+    ];
+    readonly calendarContacts: readonly [
+        "calendar",
+        "contacts"
+    ];
+    readonly ai: readonly [
+        "ai"
+    ];
+    readonly sharedMailboxes: readonly [
+        "sharedMailboxes"
+    ];
+    readonly meetings: readonly [
+        "meetings"
+    ];
+};
+export declare const ACCOUNT_COUNTS: readonly [
+    "mailAccounts",
+    "calendarContactsAccounts",
+    "meetingAccounts"
+];
+export type AccountCount = (typeof ACCOUNT_COUNTS)[number];
+export declare const COMPONENT_COUNT: {
+    readonly mail: "mailAccounts";
+    readonly calendarContacts: "calendarContactsAccounts";
+    readonly ai: "mailAccounts";
+    readonly sharedMailboxes: "mailAccounts";
+    readonly meetings: "meetingAccounts";
+};
+export declare function componentsOf(modules: PlanModules): BillingComponent[];
+export declare const METERS: readonly [
+    "mailAccounts",
+    "calendarContactsAccounts",
+    "meetingAccounts",
+    "sends",
+    "aiClassifications",
+    "aiDrafts",
+    "storage"
+];
+export declare const Meter: z.ZodEnum<{
+    mailAccounts: "mailAccounts";
+    calendarContactsAccounts: "calendarContactsAccounts";
+    meetingAccounts: "meetingAccounts";
+    sends: "sends";
+    aiClassifications: "aiClassifications";
+    aiDrafts: "aiDrafts";
+    storage: "storage";
+}>;
+export type Meter = z.infer<typeof Meter>;
+export declare const PlanIncluded: z.ZodObject<{
+    mailAccounts: z.ZodNullable<z.ZodNumber>;
+    calendarContactsAccounts: z.ZodNullable<z.ZodNumber>;
+    meetingAccounts: z.ZodNullable<z.ZodNumber>;
+    sendsPerMonth: z.ZodNullable<z.ZodNumber>;
+    aiClassificationsPerMonth: z.ZodNullable<z.ZodNumber>;
+    aiDraftsPerMonth: z.ZodNullable<z.ZodNumber>;
+    storageBytes: z.ZodNullable<z.ZodNumber>;
+    validationCredits: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+export type PlanIncluded = z.infer<typeof PlanIncluded>;
+export declare const PlanPricing: z.ZodObject<{
+    currency: z.ZodString;
+    baseMonthly: z.ZodNumber;
+    baseAnnual: z.ZodNullable<z.ZodNumber>;
+    components: z.ZodObject<{
+        mail: z.ZodNumber;
+        calendarContacts: z.ZodNumber;
+        ai: z.ZodNumber;
+        sharedMailboxes: z.ZodNumber;
+        meetings: z.ZodNumber;
+    }, z.core.$strip>;
+    sendsPer1k: z.ZodNumber;
+    aiClassificationsPer1k: z.ZodNumber;
+    aiDraftsPer1k: z.ZodNumber;
+    storagePerGbMonth: z.ZodNumber;
+    creditPacks: z.ZodArray<z.ZodObject<{
+        credits: z.ZodNumber;
+        amount: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PlanPricing = z.infer<typeof PlanPricing>;
+export declare const MIN_AUDIT_LOG_RETENTION_DAYS = 1;
+export declare const MAX_AUDIT_LOG_RETENTION_DAYS = 3650;
+export declare const PlanFeatures: z.ZodObject<{
+    sso: z.ZodBoolean;
+    scim: z.ZodBoolean;
+    auditLogRetentionDays: z.ZodNullable<z.ZodNumber>;
+    sla: z.ZodBoolean;
+    customDpa: z.ZodBoolean;
+    prioritySupport: z.ZodBoolean;
+}, z.core.$strip>;
+export type PlanFeatures = z.infer<typeof PlanFeatures>;
+export declare const GATED_PLAN_FEATURES: readonly [
+    "sso",
+    "scim"
+];
+export type GatedPlanFeature = (typeof GATED_PLAN_FEATURES)[number];
+export declare const PlanLimits: z.ZodObject<{
+    maxAccounts: z.ZodNullable<z.ZodNumber>;
+    sendsPerDay: z.ZodNullable<z.ZodNumber>;
+    emailValidationsPerDay: z.ZodNullable<z.ZodNumber>;
+    apiCallsPerMinute: z.ZodNullable<z.ZodNumber>;
+    apiCallsPerMinutePerKey: z.ZodNullable<z.ZodNumber>;
+    webhookEndpoints: z.ZodNullable<z.ZodNumber>;
+    bodyStorageAllowed: z.ZodBoolean;
+    storageBytes: z.ZodNullable<z.ZodNumber>;
+    included: z.ZodObject<{
+        mailAccounts: z.ZodNullable<z.ZodNumber>;
+        calendarContactsAccounts: z.ZodNullable<z.ZodNumber>;
+        meetingAccounts: z.ZodNullable<z.ZodNumber>;
+        sendsPerMonth: z.ZodNullable<z.ZodNumber>;
+        aiClassificationsPerMonth: z.ZodNullable<z.ZodNumber>;
+        aiDraftsPerMonth: z.ZodNullable<z.ZodNumber>;
+        storageBytes: z.ZodNullable<z.ZodNumber>;
+        validationCredits: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>;
+    pricing: z.ZodNullable<z.ZodObject<{
+        currency: z.ZodString;
+        baseMonthly: z.ZodNumber;
+        baseAnnual: z.ZodNullable<z.ZodNumber>;
+        components: z.ZodObject<{
+            mail: z.ZodNumber;
+            calendarContacts: z.ZodNumber;
+            ai: z.ZodNumber;
+            sharedMailboxes: z.ZodNumber;
+            meetings: z.ZodNumber;
+        }, z.core.$strip>;
+        sendsPer1k: z.ZodNumber;
+        aiClassificationsPer1k: z.ZodNumber;
+        aiDraftsPer1k: z.ZodNumber;
+        storagePerGbMonth: z.ZodNumber;
+        creditPacks: z.ZodArray<z.ZodObject<{
+            credits: z.ZodNumber;
+            amount: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    features: z.ZodObject<{
+        sso: z.ZodBoolean;
+        scim: z.ZodBoolean;
+        auditLogRetentionDays: z.ZodNullable<z.ZodNumber>;
+        sla: z.ZodBoolean;
+        customDpa: z.ZodBoolean;
+        prioritySupport: z.ZodBoolean;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PlanLimits = z.infer<typeof PlanLimits>;

package/contract/primitives.d.ts

@@ -1,131 +1,76 @@
 import type { OpenAPI } from "@orpc/contract";
 import * as z from "zod";
-/** Every schema registered as an OpenAPI component, by its name. The API's document generator
- * emits each under components/schemas and refers to it with $ref wherever it appears. */
 export declare const openApiComponents: Map<string, z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
-/** Registers `schema` as the OpenAPI component `name`, which is its TypeScript name too. */
 export declare function named<T extends z.ZodType>(name: string, schema: T): T;
-/** A uuid: every id workwae issues. */
 export declare const Id: z.ZodUUID;
-/** An opaque non-uuid id: one a provider issues (thread, attachment, directory user). */
 export declare const ProviderId: z.ZodString;
-/** An event's sequence id, as decimal digits: the webhook-id header and the dedupe key. */
 export declare const EventId: z.ZodString;
-/** Opaque pagination cursor. */
 export declare const Cursor: z.ZodString;
 export declare const Email: z.ZodEmail;
-/** Every date-time a response carries. */
 export declare const Timestamp: z.ZodPreprocess<z.ZodDate, Date>;
-/** A date-time a query string or a request body carries: a Date, or ISO 8601 text. */
 export declare const QueryTimestamp: z.ZodPreprocess<z.ZodDate, string | Date>;
-/** A calendar date without a time, YYYY-MM-DD. */
 export declare const DateOnly: z.ZodISODate;
-/** Non-empty text, trimmed, of at most `max` characters. */
 export declare function trimmed(max: number): z.ZodString;
-/** See MAX_NAME_LENGTH. */
 export declare const Name: z.ZodString;
 export declare const ExternalRef: z.ZodString;
-/** An address with its display name, as a message, an event or a contact carries it. */
 export declare const Address: z.ZodObject<{
     name: z.ZodNullable<z.ZodString>;
     address: z.ZodString;
 }, z.core.$strip>;
 export type Address = z.infer<typeof Address>;
-/** An address a request names; the name is optional. */
 export declare const AddressInput: z.ZodObject<{
     name: z.ZodOptional<z.ZodString>;
     address: z.ZodEmail;
 }, z.core.$strip>;
 export type AddressInput = z.infer<typeof AddressInput>;
-/** A query-string flag: `true` and `false` arrive as text. */
-export declare const QueryBoolean: z.ZodPipe<z.ZodUnion<readonly [z.ZodBoolean, z.ZodEnum<{
-    true: "true";
-    false: "false";
-}>]>, z.ZodTransform<boolean, boolean | "true" | "false">>;
-/** A cursor-paged list: the shape every paged /v1 list answers with. */
+export declare const QueryBoolean: z.ZodPipe<z.ZodUnion<readonly [
+    z.ZodBoolean,
+    z.ZodEnum<{
+        true: "true";
+        false: "false";
+    }>
+]>, z.ZodTransform<boolean, boolean | "true" | "false">>;
 export interface Page<T> {
     items: T[];
-    /** Pass back as `cursor` for the next page; null on the last one. */
     nextCursor: string | null;
 }
-/** The fields of a page of `item`, for a page that adds envelope fields of its own (SearchPage). */
 export declare const pageFields: <T extends z.ZodType>(item: T) => {
     items: z.ZodArray<T>;
     nextCursor: z.ZodNullable<z.ZodString>;
 };
-/** The page of a named entity `X`, registered as the component `XPage`. */
 export declare const Page: <T extends z.ZodType>(item: T) => z.ZodObject<{
     items: z.ZodArray<T>;
     nextCursor: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
-/**
- * The one cursor loop every paged reader runs (the SDK's pages and change feed, the board's
- * listings): pages from `cursor` on, each fetched with the cursor `next` read off the page
- * before, until `next` answers undefined.
- */
 export declare function followCursor<P>(fetch: (cursor: string | undefined) => PromiseLike<P>, cursor: string | undefined, next: (page: P) => string | undefined): AsyncGenerator<P, void, undefined>;
-/** The fields of a list of `item`, for a list that adds envelope fields of its own. */
 export declare const listFields: <T extends z.ZodType>(item: T) => {
     items: z.ZodArray<T>;
 };
-/** A small bounded list of a named entity `X`, registered as the component `XList`. */
 export declare const List: <T extends z.ZodType>(item: T) => z.ZodObject<{
     items: z.ZodArray<T>;
 }, z.core.$strip>;
-/**
- * The API error reason a refinement's issue answers with instead of invalid_input, carried in the
- * zod issue's `params.reason`. The gate answers a validation failure whose issues all carry the
- * same reason with that reason.
- */
 export declare function issueReason(issue: unknown): string | null;
-/** A day in milliseconds: what a range's span in days is checked against (withDateRange). */
 export declare const DAY_MS = 86400000;
-/**
- * `schema` refined so its `to` field comes after its `from` field (on or after it when
- * `inclusive`, as date-only ranges are), spanning at most `maxSpanMs`. Either end left out is not
- * checked. A violation answers invalid_range (issueReason), so services need not check again.
- * Apply it last: zod refuses to extend a refined object.
- */
 export declare function withDateRange<T extends z.ZodObject, K extends keyof z.output<T> & string>(schema: T, range: {
     from: K;
     to: K;
     maxSpanMs?: number;
     inclusive?: boolean;
 }): T;
-/** A page size of at most `max`, `fallback` when omitted. */
 export declare function pageLimit(max: number, fallback: number): z.ZodDefault<z.ZodCoercedNumber<unknown>>;
-/** A page size; listings that allow more or fewer say so with their own pageLimit. */
 export declare const Limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
-/** The paging fields of a listing that takes the default page size. */
 export declare const Paged: {
     limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
     cursor: z.ZodOptional<z.ZodString>;
 };
-/** The account a route is scoped to: /v1/accounts/{accountId}/... */
 export declare const AccountIdInput: z.ZodObject<{
     accountId: z.ZodUUID;
 }, z.core.$strip>;
 export type AccountIdInput = z.infer<typeof AccountIdInput>;
-/**
- * A download the API streams: the handler answers the bytes as a ReadableStream, with their type,
- * name and size in the response headers, and a client receives them as a File (which is what the
- * SDK's response validation then sees, so it passes too). For /v1 only: the RPC protocol carries
- * a file as multipart, so a download the board reads (a contact photo) stays a z.file().
- */
 export declare const StreamedFile: z.ZodPipe<z.ZodCustom<ReadableStream<Uint8Array<ArrayBufferLike>>, ReadableStream<Uint8Array<ArrayBufferLike>>>, z.ZodTransform<File, ReadableStream<Uint8Array<ArrayBufferLike>>>>;
-/** Whether a procedure's output is a file, its bytes the response body, rather than JSON. */
 export declare function isFileOutput(schema: unknown): boolean;
 type Operation = OpenAPI.OperationObject;
-/**
- * A route's `spec` for an operation that takes no bearer: the token in its path is the credential
- * (the hosted connect page's routes).
- */
 export declare const publicOperation: (operation: Operation) => Operation;
-/**
- * A route's `spec` for a file output, which the generator documents as any media type and nothing
- * more: names the media type (a wildcard where the type is the file's own), the
- * Content-Disposition the handler sets, and any further headers.
- */
 export declare function fileResponse(file: {
     mediaType: string;
     description: string;

package/contract/public.d.ts

@@ -3,24 +3,31 @@ export * from "./ai/models.js";
 export * from "./audit-log/models.js";
 export * from "./calendar/models.js";
 export * from "./connect/models.js";
+export * from "./connect-domain/models.js";
 export * from "./contacts/models.js";
+export * from "./email-validation/models.js";
 export * from "./errors.js";
 export * from "./events/models.js";
 export * from "./exports/models.js";
 export * from "./identities/models.js";
 export * from "./limits.js";
 export * from "./mail/models.js";
+export * from "./mcp-keys/models.js";
 export * from "./meetings/models.js";
 export * from "./oauth-apps/models.js";
 export * from "./org-connections/models.js";
+export * from "./plans/credit-packs.js";
+export * from "./plans/models.js";
 export * from "./primitives.js";
 export * from "./reasons.js";
 export * from "./router.js";
+export * from "./scheduling/models.js";
 export * from "./send/models.js";
 export * from "./settings/models.js";
 export * from "./suppressions/models.js";
 export * from "./templates/models.js";
 export * from "./threads/models.js";
+export * from "./tracking-domain/models.js";
 export * from "./usage/models.js";
 export * from "./webhooks/models.js";
 export * from "./webhooks/signing.js";