@tiempo/sdk 0.0.0-stage → 0.1.1

package/dist/cjs/errors.d.ts

@@ -0,0 +1,86 @@
+import type { Conflict } from './generated/types.js';
+/**
+ * The `error` object in Tiempo's error envelope. Besides these four, an error can carry fields of
+ * its own, merged straight in: `conflicts` on `booking_conflict` and `session_conflicted`, `occurrences` on
+ * `series_update_conflict`, `seats_available` on `seats_unavailable`.
+ */
+export interface TiempoErrorBody {
+    type?: string;
+    code?: string;
+    message?: string;
+    param?: string | null;
+    [key: string]: unknown;
+}
+/** A series occurrence that doesn't fit an edit (`series_update_conflict`). */
+export interface UnplaceableOccurrence {
+    booking: string;
+    occurrence_key: string;
+    conflicts: Conflict[];
+}
+export interface TiempoErrorInit {
+    message: string;
+    type?: string | undefined;
+    code?: string | undefined;
+    param?: string | undefined;
+    details?: Record<string, unknown> | undefined;
+    statusCode?: number | undefined;
+    headers?: Record<string, string> | undefined;
+    raw?: unknown;
+    cause?: unknown;
+}
+/** Base class for every error the SDK throws. */
+export declare class TiempoError extends Error {
+    /** The server's error `type`, for example `invalid_request_error`. */
+    readonly type: string | undefined;
+    /** A machine-readable code, for example `parameter_invalid`. */
+    readonly code: string | undefined;
+    /** The request parameter the error is about, when there is one. */
+    readonly param: string | undefined;
+    /**
+     * The error's own fields beyond type, code, message and param, for example `{ conflicts: [...] }`.
+     * Empty when there are none. {@link TiempoConflictError} has typed shortcuts.
+     */
+    readonly details: Record<string, unknown>;
+    /** HTTP status, when the server answered. */
+    readonly statusCode: number | undefined;
+    /** Response headers (lower-case names), when the server answered. */
+    readonly headers: Record<string, string>;
+    /** The parsed response body (or text), when the server answered. */
+    readonly raw: unknown;
+    constructor(init: TiempoErrorInit);
+}
+/** 400/404/422: the request was invalid (bad params, unknown id, …). */
+export declare class TiempoInvalidRequestError extends TiempoError {
+}
+/** 401: missing or bad API key. */
+export declare class TiempoAuthenticationError extends TiempoError {
+}
+/** 403: the key can't do this (for example live mode not activated). */
+export declare class TiempoPermissionError extends TiempoError {
+}
+/** 409: the request conflicts with current state (slot taken, already cancelled, …). */
+export declare class TiempoConflictError extends TiempoError {
+    /** Why the time isn't available, per segment (`booking_conflict`, `session_conflicted`). Empty for other conflicts. */
+    get conflicts(): Conflict[];
+    /** Occurrences a series edit couldn't place (`series_update_conflict`). */
+    get occurrences(): UnplaceableOccurrence[];
+    /** Seats still free in the session (`seats_unavailable`). */
+    get seatsAvailable(): number | undefined;
+}
+/** An `Idempotency-Key` was reused with different params, or is still in flight. */
+export declare class TiempoIdempotencyError extends TiempoError {
+}
+/** 429: too many requests. */
+export declare class TiempoRateLimitError extends TiempoError {
+}
+/** 5xx: something went wrong on Tiempo's side. */
+export declare class TiempoAPIError extends TiempoError {
+}
+/** The request never got a response: network failure or timeout. */
+export declare class TiempoConnectionError extends TiempoError {
+}
+/** A webhook's `Tiempo-Signature` didn't verify. */
+export declare class TiempoSignatureVerificationError extends TiempoError {
+}
+/** Builds the right error subclass from an HTTP error response. */
+export declare function errorFromResponse(statusCode: number, headers: Record<string, string>, raw: unknown): TiempoError;

package/dist/cjs/errors.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TiempoSignatureVerificationError = exports.TiempoConnectionError = exports.TiempoAPIError = exports.TiempoRateLimitError = exports.TiempoIdempotencyError = exports.TiempoConflictError = exports.TiempoPermissionError = exports.TiempoAuthenticationError = exports.TiempoInvalidRequestError = exports.TiempoError = void 0;
+exports.errorFromResponse = errorFromResponse;
+/** Base class for every error the SDK throws. */
+class TiempoError extends Error {
+    /** The server's error `type`, for example `invalid_request_error`. */
+    type;
+    /** A machine-readable code, for example `parameter_invalid`. */
+    code;
+    /** The request parameter the error is about, when there is one. */
+    param;
+    /**
+     * The error's own fields beyond type, code, message and param, for example `{ conflicts: [...] }`.
+     * Empty when there are none. {@link TiempoConflictError} has typed shortcuts.
+     */
+    details;
+    /** HTTP status, when the server answered. */
+    statusCode;
+    /** Response headers (lower-case names), when the server answered. */
+    headers;
+    /** The parsed response body (or text), when the server answered. */
+    raw;
+    constructor(init) {
+        super(init.message, init.cause !== undefined ? { cause: init.cause } : undefined);
+        this.name = new.target.name;
+        this.type = init.type;
+        this.code = init.code;
+        this.param = init.param;
+        this.details = init.details ?? {};
+        this.statusCode = init.statusCode;
+        this.headers = init.headers ?? {};
+        this.raw = init.raw;
+    }
+}
+exports.TiempoError = TiempoError;
+/** 400/404/422: the request was invalid (bad params, unknown id, …). */
+class TiempoInvalidRequestError extends TiempoError {
+}
+exports.TiempoInvalidRequestError = TiempoInvalidRequestError;
+/** 401: missing or bad API key. */
+class TiempoAuthenticationError extends TiempoError {
+}
+exports.TiempoAuthenticationError = TiempoAuthenticationError;
+/** 403: the key can't do this (for example live mode not activated). */
+class TiempoPermissionError extends TiempoError {
+}
+exports.TiempoPermissionError = TiempoPermissionError;
+/** 409: the request conflicts with current state (slot taken, already cancelled, …). */
+class TiempoConflictError extends TiempoError {
+    /** Why the time isn't available, per segment (`booking_conflict`, `session_conflicted`). Empty for other conflicts. */
+    get conflicts() {
+        return Array.isArray(this.details.conflicts) ? this.details.conflicts : [];
+    }
+    /** Occurrences a series edit couldn't place (`series_update_conflict`). */
+    get occurrences() {
+        return Array.isArray(this.details.occurrences) ? this.details.occurrences : [];
+    }
+    /** Seats still free in the session (`seats_unavailable`). */
+    get seatsAvailable() {
+        return typeof this.details.seats_available === 'number' ? this.details.seats_available : undefined;
+    }
+}
+exports.TiempoConflictError = TiempoConflictError;
+/** An `Idempotency-Key` was reused with different params, or is still in flight. */
+class TiempoIdempotencyError extends TiempoError {
+}
+exports.TiempoIdempotencyError = TiempoIdempotencyError;
+/** 429: too many requests. */
+class TiempoRateLimitError extends TiempoError {
+}
+exports.TiempoRateLimitError = TiempoRateLimitError;
+/** 5xx: something went wrong on Tiempo's side. */
+class TiempoAPIError extends TiempoError {
+}
+exports.TiempoAPIError = TiempoAPIError;
+/** The request never got a response: network failure or timeout. */
+class TiempoConnectionError extends TiempoError {
+}
+exports.TiempoConnectionError = TiempoConnectionError;
+/** A webhook's `Tiempo-Signature` didn't verify. */
+class TiempoSignatureVerificationError extends TiempoError {
+}
+exports.TiempoSignatureVerificationError = TiempoSignatureVerificationError;
+const BY_TYPE = {
+    invalid_request_error: TiempoInvalidRequestError,
+    authentication_error: TiempoAuthenticationError,
+    permission_error: TiempoPermissionError,
+    conflict_error: TiempoConflictError,
+    idempotency_error: TiempoIdempotencyError,
+    rate_limit_error: TiempoRateLimitError,
+    api_error: TiempoAPIError,
+    internal_error: TiempoAPIError,
+};
+function byStatus(status) {
+    if (status === 401)
+        return TiempoAuthenticationError;
+    if (status === 403)
+        return TiempoPermissionError;
+    if (status === 409)
+        return TiempoConflictError;
+    if (status === 429)
+        return TiempoRateLimitError;
+    if (status >= 400 && status < 500)
+        return TiempoInvalidRequestError;
+    return TiempoAPIError;
+}
+/** Builds the right error subclass from an HTTP error response. */
+function errorFromResponse(statusCode, headers, raw) {
+    const body = raw && typeof raw === 'object' && 'error' in raw && raw.error && typeof raw.error === 'object'
+        ? raw.error
+        : undefined;
+    const Cls = (body?.type && BY_TYPE[body.type]) || byStatus(statusCode);
+    const message = body?.message ?? (typeof raw === 'string' && raw.length > 0 && raw.length < 500 ? raw : `HTTP ${statusCode}`);
+    return new Cls({
+        message,
+        type: body?.type,
+        code: body?.code,
+        param: body?.param ?? undefined,
+        details: body ? extraFields(body) : undefined,
+        statusCode,
+        headers,
+        raw,
+    });
+}
+const ENVELOPE_FIELDS = new Set(['type', 'code', 'message', 'param']);
+function extraFields(body) {
+    const out = {};
+    for (const [key, value] of Object.entries(body)) {
+        if (!ENVELOPE_FIELDS.has(key))
+            out[key] = value;
+    }
+    return out;
+}

package/dist/cjs/events.d.ts

@@ -0,0 +1,23 @@
+import { EVENT_TYPES, type EventObjectMap, type TiempoEventType } from './generated/events.js';
+import type { components } from './generated/openapi.js';
+export { EVENT_TYPES };
+export type { EventObjectMap, TiempoEventType };
+/** The object an event of type `T` carries in `data.object`. */
+export type EventObject<T extends TiempoEventType> = EventObjectMap[T];
+type EventEnvelope = Omit<components['schemas']['Event'], 'type' | 'data'>;
+/** One event of a specific type. */
+export interface TiempoEventOf<T extends TiempoEventType> extends EventEnvelope {
+    type: T;
+    data: {
+        /** The object the event is about, as it was just after the change. */
+        object: EventObject<T>;
+        /** On `*.updated`: the changed fields' previous values. Null otherwise. */
+        previous_attributes: Partial<EventObject<T>> | null;
+    };
+}
+/** Any Tiempo event. Narrow on `type` to get a typed `data.object`. */
+export type TiempoEvent = {
+    [T in TiempoEventType]: TiempoEventOf<T>;
+}[TiempoEventType];
+/** True if `type` is one this SDK knows about. */
+export declare function isKnownEventType(type: string): type is TiempoEventType;

package/dist/cjs/events.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVENT_TYPES = void 0;
+exports.isKnownEventType = isKnownEventType;
+const events_js_1 = require("./generated/events.js");
+Object.defineProperty(exports, "EVENT_TYPES", { enumerable: true, get: function () { return events_js_1.EVENT_TYPES; } });
+/** True if `type` is one this SDK knows about. */
+function isKnownEventType(type) {
+    return events_js_1.EVENT_TYPES.includes(type);
+}

package/dist/cjs/generated/events.d.ts

@@ -0,0 +1,51 @@
+import type { Account, Attendee, Block, Booking, Location, Resource, Schedule, ScheduleOverride, Series, SkippedOccurrence } from './types.js';
+/** Every event type Tiempo sends (from the spec's Event.type). */
+export declare const EVENT_TYPES: readonly ["account.created", "account.updated", "account.deleted", "location.created", "location.updated", "location.deleted", "resource.created", "resource.updated", "resource.archived", "resource.unarchived", "resource.deleted", "schedule.created", "schedule.updated", "schedule.deleted", "schedule_override.created", "schedule_override.updated", "schedule_override.deleted", "block.created", "block.updated", "block.deleted", "booking.created", "booking.confirmed", "booking.rescheduled", "booking.cancelled", "booking.expired", "booking.completed", "booking.no_show", "booking.updated", "booking.conflicted", "booking.conflict_resolved", "booking.imported", "attendee.created", "attendee.confirmed", "attendee.cancelled", "attendee.expired", "attendee.completed", "attendee.no_show", "attendee.updated", "series.created", "series.updated", "series.split", "series.cancelled", "series.ended", "series.occurrence_skipped"];
+export type TiempoEventType = (typeof EVENT_TYPES)[number];
+/** The object each event type carries in `data.object`. */
+export interface EventObjectMap {
+    "account.created": Account;
+    "account.updated": Account;
+    "account.deleted": Account;
+    "location.created": Location;
+    "location.updated": Location;
+    "location.deleted": Location;
+    "resource.created": Resource;
+    "resource.updated": Resource;
+    "resource.archived": Resource;
+    "resource.unarchived": Resource;
+    "resource.deleted": Resource;
+    "schedule.created": Schedule;
+    "schedule.updated": Schedule;
+    "schedule.deleted": Schedule;
+    "schedule_override.created": ScheduleOverride;
+    "schedule_override.updated": ScheduleOverride;
+    "schedule_override.deleted": ScheduleOverride;
+    "block.created": Block;
+    "block.updated": Block;
+    "block.deleted": Block;
+    "booking.created": Booking;
+    "booking.confirmed": Booking;
+    "booking.rescheduled": Booking;
+    "booking.cancelled": Booking;
+    "booking.expired": Booking;
+    "booking.completed": Booking;
+    "booking.no_show": Booking;
+    "booking.updated": Booking;
+    "booking.conflicted": Booking;
+    "booking.conflict_resolved": Booking;
+    "booking.imported": Booking;
+    "attendee.created": Attendee;
+    "attendee.confirmed": Attendee;
+    "attendee.cancelled": Attendee;
+    "attendee.expired": Attendee;
+    "attendee.completed": Attendee;
+    "attendee.no_show": Attendee;
+    "attendee.updated": Attendee;
+    "series.created": Series;
+    "series.updated": Series;
+    "series.split": Series;
+    "series.cancelled": Series;
+    "series.ended": Series;
+    "series.occurrence_skipped": SkippedOccurrence;
+}

package/dist/cjs/generated/events.js

@@ -0,0 +1,51 @@
+"use strict";
+// Code generated by scripts/generate.mjs from openapi.json. DO NOT EDIT.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVENT_TYPES = void 0;
+/** Every event type Tiempo sends (from the spec's Event.type). */
+exports.EVENT_TYPES = [
+    "account.created",
+    "account.updated",
+    "account.deleted",
+    "location.created",
+    "location.updated",
+    "location.deleted",
+    "resource.created",
+    "resource.updated",
+    "resource.archived",
+    "resource.unarchived",
+    "resource.deleted",
+    "schedule.created",
+    "schedule.updated",
+    "schedule.deleted",
+    "schedule_override.created",
+    "schedule_override.updated",
+    "schedule_override.deleted",
+    "block.created",
+    "block.updated",
+    "block.deleted",
+    "booking.created",
+    "booking.confirmed",
+    "booking.rescheduled",
+    "booking.cancelled",
+    "booking.expired",
+    "booking.completed",
+    "booking.no_show",
+    "booking.updated",
+    "booking.conflicted",
+    "booking.conflict_resolved",
+    "booking.imported",
+    "attendee.created",
+    "attendee.confirmed",
+    "attendee.cancelled",
+    "attendee.expired",
+    "attendee.completed",
+    "attendee.no_show",
+    "attendee.updated",
+    "series.created",
+    "series.updated",
+    "series.split",
+    "series.cancelled",
+    "series.ended",
+    "series.occurrence_skipped",
+];

package/dist/cjs/generated/meta.d.ts

@@ -0,0 +1,4 @@
+/** The dated API version this SDK's types describe. Sent as `Tiempo-Version` on every request. */
+export declare const API_VERSION = "2026-10-16";
+/** This package's version. */
+export declare const SDK_VERSION = "0.1.1";

package/dist/cjs/generated/meta.js

@@ -0,0 +1,8 @@
+"use strict";
+// Code generated by scripts/generate.mjs from openapi.json. DO NOT EDIT.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SDK_VERSION = exports.API_VERSION = void 0;
+/** The dated API version this SDK's types describe. Sent as `Tiempo-Version` on every request. */
+exports.API_VERSION = "2026-10-16";
+/** This package's version. */
+exports.SDK_VERSION = "0.1.1";