@myapihq/sdk 2.4.2 → 2.5.0

package/dist/client.d.ts

@@ -25,6 +25,14 @@ export interface RequestOptions {
     retryUnsafe?: boolean;
     /** Caller-supplied AbortSignal, composed with the timeout. */
     signal?: AbortSignal;
+    /**
+     * Called when the backend answered from its idempotency cache instead of
+     * executing — i.e. a retry collapsed into the original request rather than
+     * running again. "Succeeded" and "already succeeded" are different facts to
+     * an agent deciding whether to count a charge, so this is surfaced rather
+     * than swallowed.
+     */
+    onReplay?: () => void;
 }
 export declare function request<T>(method: string, url: string, apiKey?: string, body?: unknown, extraHeaders?: Record<string, string>, opts?: RequestOptions): Promise<T>;
 export interface Page<T> {

package/dist/client.js

@@ -196,9 +196,39 @@ async function requestFull(method, url, apiKey, body, extraHeaders, opts) {
             await sleep(after ?? backoffMs(attempt));
             continue;
         }
+        // Idempotency-Replayed: true means the backend served its cached response
+        // for this key and never ran the handler. Only meaningful on the billable
+        // endpoints that opt into retry, but the header is cheap to check.
+        if (opts?.onReplay && response.headers.get('idempotency-replayed') === 'true') {
+            opts.onReplay();
+        }
         return await parseResponse(upper, url, response);
     }
 }
+// A bare "invalid_json_response" reads as a platform fault. A user building on
+// MyAPI hit it three times on an oversized container deploy and, in their
+// words, "went looking for an outage" — the actual cause was a 198 MB upload
+// context. The status code and the shape of the body usually say which side
+// the problem is on, so say it rather than making the caller guess.
+function diagnoseNonJson(status, raw) {
+    const looksHtml = /^\s*<(?:!doctype|html)/i.test(raw);
+    if (status === 413) {
+        return '→ The request body was too large. This is a client-side limit, not an outage — send less (for a deploy, exclude build artefacts and node_modules from the upload context).';
+    }
+    if (status === 0 || status === 502 || status === 503 || status === 504) {
+        return '→ The service did not answer. This one probably IS transient — retry shortly.';
+    }
+    if (looksHtml && status >= 500) {
+        return '→ An HTML error page in place of JSON means the edge replaced the origin\'s response, so the real reason is not in this body. Check the service logs for the underlying error.';
+    }
+    if (looksHtml) {
+        return '→ An HTML page came back instead of JSON, which usually means the request never reached the API (wrong URL, a proxy, or a captive network) rather than the API failing.';
+    }
+    if (status >= 400 && status < 500) {
+        return '→ A 4xx with a non-JSON body is usually the request being rejected before it reached the API — check the URL and the payload size.';
+    }
+    return '→ If the body above looks truncated or empty, the connection was probably cut mid-response.';
+}
 async function parseResponse(method, url, response) {
     if (response.status === 204) {
         return { success: true, data: null, error: null, meta: {} };
@@ -213,7 +243,7 @@ async function parseResponse(method, url, response) {
     }
     catch {
         const snippet = raw.slice(0, 200).replace(/\s+/g, ' ').trim();
-        throw new MyApiError('invalid_json_response', response.status, `${method} ${url} returned non-JSON (status ${response.status}): ${snippet}`);
+        throw new MyApiError('invalid_json_response', response.status, `${method} ${url} returned non-JSON (status ${response.status}): ${snippet}\n${diagnoseNonJson(response.status, raw)}`);
     }
     if (!response.ok) {
         throw toError(result?.error, response.status);

package/dist/container.d.ts

@@ -69,3 +69,6 @@ export interface DomainBinding {
 }
 export declare function bindDomain(apiKey: string, orgId: string, containerId: string, domain: string): Promise<DomainBinding>;
 export declare function unbindDomain(apiKey: string, orgId: string, containerId: string): Promise<void>;
+export declare function buildLogs(apiKey: string, orgId: string, id: string, tail?: number): Promise<{
+    logs: string[];
+}>;

package/dist/container.js

@@ -10,6 +10,7 @@ exports.deployContainerSource = deployContainerSource;
 exports.getContainerLogs = getContainerLogs;
 exports.bindDomain = bindDomain;
 exports.unbindDomain = unbindDomain;
+exports.buildLogs = buildLogs;
 const client_1 = require("./client");
 const config_1 = require("./config");
 // Backend: my-container-api per myapi-hq/internal/routes/container/. Phase 1
@@ -24,6 +25,7 @@ exports.EXPOSES = [
     'GET /container/orgs/{org_id}/containers/{id}/logs',
     'POST /container/orgs/{org_id}/containers/{id}/domain',
     'DELETE /container/orgs/{org_id}/containers/{id}/domain',
+    'GET /container/orgs/{org_id}/containers/{id}/build-logs',
 ];
 async function createContainer(apiKey, orgId, payload) {
     return (0, client_1.request)('POST', `${config_1.CONTAINER_BASE}/container/orgs/${encodeURIComponent(orgId)}/containers`, apiKey, payload);
@@ -86,3 +88,13 @@ async function bindDomain(apiKey, orgId, containerId, domain) {
 async function unbindDomain(apiKey, orgId, containerId) {
     return (0, client_1.request)('DELETE', domainUrl(orgId, containerId), apiKey);
 }
+// Build logs for the most recent source build, oldest first.
+//
+// Distinct from `logs`, which is the running container's stream and — as a
+// user reported — interleaves multi-kilobyte platform audit records with your
+// own output. When a `deploy --source` fails, this is the endpoint that says
+// why, without the noise.
+async function buildLogs(apiKey, orgId, id, tail) {
+    const q = tail !== undefined ? `?tail=${encodeURIComponent(String(tail))}` : '';
+    return (0, client_1.request)('GET', `${config_1.CONTAINER_BASE}/container/orgs/${encodeURIComponent(orgId)}/containers/${encodeURIComponent(id)}/build-logs${q}`, apiKey);
+}

package/dist/email.d.ts

@@ -1,3 +1,4 @@
+import { type RequestOptions } from './client';
 import type { Exposes } from './exposes';
 export declare const EXPOSES: Exposes;
 export interface EmailMessage {
@@ -96,7 +97,7 @@ export declare function sendEmail(apiKey: string, payload: {
     text?: string;
     template_id?: string;
     template_vars?: Record<string, string>;
-}): Promise<{
+}, opts?: RequestOptions): Promise<{
     message_id: string;
 }>;
 export declare function getEmailStatus(apiKey: string, messageId: string): Promise<{

package/dist/email.js

@@ -124,8 +124,10 @@ async function deleteForwarding(apiKey, address) {
     return (0, client_1.request)('DELETE', `${config_1.EMAIL_BASE}/email/mailboxes/${encodeURIComponent(address)}/forwarding`, apiKey);
 }
 // ── Sending and reading (account-scoped) ─────────────────────────────────────
-async function sendEmail(apiKey, payload) {
-    return (0, client_1.request)('POST', `${config_1.EMAIL_BASE}/email/send`, apiKey, payload);
+async function sendEmail(apiKey, payload, opts) {
+    // Retryable: deduplicated on Idempotency-Key, so a retry after a timeout
+    // replays rather than sending the recipient a second copy.
+    return (0, client_1.request)('POST', `${config_1.EMAIL_BASE}/email/send`, apiKey, payload, undefined, { retryUnsafe: true, ...opts });
 }
 async function getEmailStatus(apiKey, messageId) {
     return (0, client_1.request)('GET', `${config_1.EMAIL_BASE}/email/status/${encodeURIComponent(messageId)}`, apiKey);

package/dist/hq.d.ts

@@ -1,3 +1,4 @@
+import { type RequestOptions } from './client';
 import type { Exposes } from './exposes';
 export declare const EXPOSES: Exposes;
 export interface Org {
@@ -58,6 +59,8 @@ export interface ApiKey {
     spend_cap_period: string;
     current_period_spend_cents?: number;
     api_key?: string;
+    created_at?: string;
+    last_used_at?: string | null;
 }
 export declare function createAnonymousAccount(): Promise<AuthResult & {
     subdomain_url: string;
@@ -135,7 +138,7 @@ export declare function getBillingUsage(apiKey: string, period?: 'month' | '30d'
 export declare function setupPayment(apiKey: string): Promise<{
     url: string;
 }>;
-export declare function topUp(apiKey: string, amountDollars: number): Promise<{
+export declare function topUp(apiKey: string, amountDollars: number, opts?: RequestOptions): Promise<{
     new_balance_display: string;
 }>;
 export type RechargeStatus = 'succeeded' | 'failed' | 'capped' | 'no_pm' | 'pending';
@@ -192,3 +195,4 @@ export interface DoctorReport {
     };
 }
 export declare function getDoctor(apiKey: string, orgId: string): Promise<DoctorReport>;
+export declare function setAccountDefaultOrg(apiKey: string, orgId: string | null): Promise<void>;

package/dist/hq.js

@@ -31,9 +31,11 @@ exports.getAutoRecharge = getAutoRecharge;
 exports.setAutoRecharge = setAutoRecharge;
 exports.disableAutoRecharge = disableAutoRecharge;
 exports.getDoctor = getDoctor;
+exports.setAccountDefaultOrg = setAccountDefaultOrg;
 const client_1 = require("./client");
 const config_1 = require("./config");
 exports.EXPOSES = [
+    'PATCH /hq/account/default-org',
     'POST /hq/account/anonymous',
     'POST /hq/account/send-code',
     'POST /hq/account/verify-code',
@@ -173,8 +175,10 @@ async function getBillingUsage(apiKey, period) {
 async function setupPayment(apiKey) {
     return (0, client_1.request)('POST', `${config_1.HQ_BASE}/hq/billing/setup-payment`, apiKey);
 }
-async function topUp(apiKey, amountDollars) {
-    return (0, client_1.request)('POST', `${config_1.HQ_BASE}/hq/billing/topup`, apiKey, { amount_dollars: amountDollars });
+async function topUp(apiKey, amountDollars, opts) {
+    // Retryable: the backend deduplicates on Idempotency-Key (24h), so a retry
+    // after a timeout replays the original rather than topping up twice.
+    return (0, client_1.request)('POST', `${config_1.HQ_BASE}/hq/billing/topup`, apiKey, { amount_dollars: amountDollars }, undefined, { retryUnsafe: true, ...opts });
 }
 async function getAutoRecharge(apiKey) {
     return (0, client_1.request)('GET', `${config_1.HQ_BASE}/hq/billing/auto-recharge`, apiKey);
@@ -194,3 +198,9 @@ async function disableAutoRecharge(apiKey) {
 async function getDoctor(apiKey, orgId) {
     return (0, client_1.request)('GET', `${config_1.HQ_BASE}/hq/orgs/${encodeURIComponent(orgId)}/doctor`, apiKey);
 }
+// Pin the org that `login` hands back as default_org — sticky across sessions
+// AND machines, unlike the local default in ~/.myapi/config.json. Pass null to
+// clear it and revert to "most recently created".
+async function setAccountDefaultOrg(apiKey, orgId) {
+    return (0, client_1.request)('PATCH', `${config_1.HQ_BASE}/hq/account/default-org`, apiKey, { org_id: orgId });
+}

package/dist/payments.d.ts

@@ -1,3 +1,4 @@
+import { type RequestOptions } from './client';
 import type { Exposes } from './exposes';
 export declare const EXPOSES: Exposes;
 export interface ConnectStatus {
@@ -36,7 +37,7 @@ export interface CreateChargePayload {
 }
 export declare function connect(apiKey: string, orgId: string, stripeSecretKey: string, tier?: 't0' | 't1'): Promise<ConnectStatus>;
 export declare function getConnect(apiKey: string, orgId: string): Promise<ConnectStatus>;
-export declare function createCharge(apiKey: string, orgId: string, payload: CreateChargePayload): Promise<CreateChargeResponse>;
+export declare function createCharge(apiKey: string, orgId: string, payload: CreateChargePayload, opts?: RequestOptions): Promise<CreateChargeResponse>;
 export declare function listCharges(apiKey: string, orgId: string): Promise<Charge[]>;
 export declare function getCharge(apiKey: string, orgId: string, chargeId: string): Promise<Charge>;
 export declare function refundCharge(apiKey: string, orgId: string, chargeId: string): Promise<{

package/dist/payments.js

@@ -39,8 +39,10 @@ async function getConnect(apiKey, orgId) {
 }
 // createCharge opens a Stripe Checkout Session on the org's connected
 // account. `every` makes it a subscription; otherwise a one-off payment.
-async function createCharge(apiKey, orgId, payload) {
-    return (0, client_1.request)('POST', `${config_1.PAYMENTS_BASE}/payments/orgs/${encodeURIComponent(orgId)}/charges`, apiKey, payload);
+async function createCharge(apiKey, orgId, payload, opts) {
+    // Retryable: deduplicated on Idempotency-Key, so a retried charge cannot
+    // double-charge — it replays the original response.
+    return (0, client_1.request)('POST', `${config_1.PAYMENTS_BASE}/payments/orgs/${encodeURIComponent(orgId)}/charges`, apiKey, payload, undefined, { retryUnsafe: true, ...opts });
 }
 async function listCharges(apiKey, orgId) {
     return (0, client_1.request)('GET', `${config_1.PAYMENTS_BASE}/payments/orgs/${encodeURIComponent(orgId)}/charges`, apiKey);

package/dist/pixel.d.ts

@@ -66,3 +66,7 @@ export declare function getIdentity(apiKey: string, orgId: string, pixelId: stri
     latency_ms: number;
 }>;
 export declare function getGeoSample(apiKey: string, orgId: string): Promise<Record<string, unknown>>;
+export declare function identify(apiKey: string, orgId: string, pixelId: string, who: {
+    email?: string;
+    externalId?: string;
+}): Promise<Record<string, unknown>>;

package/dist/pixel.js

@@ -6,9 +6,11 @@ exports.getVisits = getVisits;
 exports.getEvents = getEvents;
 exports.getIdentity = getIdentity;
 exports.getGeoSample = getGeoSample;
+exports.identify = identify;
 const client_1 = require("./client");
 const config_1 = require("./config");
 exports.EXPOSES = [
+    'POST /pixel/orgs/{org_id}/identify',
     'GET /pixel/orgs/{org_id}/interactions',
     'GET /pixel/orgs/{org_id}/visits',
     'GET /pixel/orgs/{org_id}/events',
@@ -59,3 +61,16 @@ async function getIdentity(apiKey, orgId, pixelId, website) {
 async function getGeoSample(apiKey, orgId) {
     return (0, client_1.request)('GET', `${config_1.PIXEL_BASE}/pixel/orgs/${encodeURIComponent(orgId)}/audience/get_geo_sample`, apiKey);
 }
+// Link a known identity to an anonymous pixel visitor.
+//
+// The write half of identity resolution: call it on form submit or straight
+// after sign-in and the visitor's whole prior anonymous graph resolves to that
+// person. Without it, `pixel identity` can only ever report anonymous nodes.
+async function identify(apiKey, orgId, pixelId, who) {
+    const body = { pixel_id: pixelId };
+    if (who.email)
+        body.email = who.email;
+    if (who.externalId)
+        body.external_id = who.externalId;
+    return (0, client_1.request)('POST', `${config_1.PIXEL_BASE}/pixel/orgs/${encodeURIComponent(orgId)}/identify`, apiKey, body);
+}

package/dist/storage.d.ts

@@ -8,6 +8,7 @@ export interface Asset {
 }
 export declare function ingestAsset(apiKey: string, orgId: string, url: string, name?: string): Promise<Asset>;
 export type UploadContentType = 'image/jpeg' | 'image/png' | 'image/gif' | 'image/webp' | 'image/svg+xml' | 'application/pdf' | 'video/mp4' | 'video/webm';
-export declare function uploadAsset(apiKey: string, orgId: string, file: Blob | Buffer, contentType: UploadContentType, name?: string): Promise<Asset>;
+export type UploadContentTypeInput = UploadContentType | (string & {});
+export declare function uploadAsset(apiKey: string, orgId: string, file: Blob | Buffer, contentType: UploadContentTypeInput, name?: string): Promise<Asset>;
 export declare function listAssets(apiKey: string, orgId: string): Promise<Asset[]>;
 export declare function deleteAsset(apiKey: string, orgId: string, assetId: string): Promise<void>;

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.4.2";
+export declare const SDK_VERSION = "2.5.0";

package/dist/version.js

@@ -8,4 +8,4 @@ exports.SDK_VERSION = void 0;
 // Why a constant and not a package.json read: the SDK runs inside edge
 // functions (Cloudflare Workers), so it must not import node:fs. A literal
 // is the only version source that works in every runtime we ship to.
-exports.SDK_VERSION = '2.4.2';
+exports.SDK_VERSION = '2.5.0';

package/dist/webhook.d.ts

@@ -20,6 +20,19 @@ export interface Delivery {
     last_forward_at?: string;
     last_forward_error?: string;
 }
+export interface ListDeliveriesOptions {
+    /** Restrict to one endpoint. An id the org doesn't own is a 404, not an empty page. */
+    endpointId?: string;
+    /** 1-200, default 50 server-side. */
+    limit?: number;
+    /** `next_cursor` from the previous page. An unknown cursor is a 400, never a silent restart. */
+    cursor?: string;
+}
+export interface DeliveriesPage {
+    deliveries: Delivery[];
+    next_cursor?: string;
+    has_more?: boolean;
+}
 export interface CreateEndpointOptions {
     description?: string;
     crm_email_path?: string;
@@ -36,3 +49,4 @@ export declare function updateEndpoint(apiKey: string, orgId: string, endpointId
 export declare function listEndpoints(apiKey: string, orgId: string): Promise<WebhookEndpoint[]>;
 export declare function deleteEndpoint(apiKey: string, orgId: string, endpointId: string): Promise<void>;
 export declare function getDelivery(apiKey: string, orgId: string, deliveryId: string): Promise<Delivery>;
+export declare function listDeliveries(apiKey: string, orgId: string, opts?: ListDeliveriesOptions): Promise<DeliveriesPage>;

package/dist/webhook.js

@@ -6,6 +6,7 @@ exports.updateEndpoint = updateEndpoint;
 exports.listEndpoints = listEndpoints;
 exports.deleteEndpoint = deleteEndpoint;
 exports.getDelivery = getDelivery;
+exports.listDeliveries = listDeliveries;
 const client_1 = require("./client");
 const config_1 = require("./config");
 exports.EXPOSES = [
@@ -14,6 +15,7 @@ exports.EXPOSES = [
     'PATCH /webhook/orgs/{org_id}/endpoints/{endpoint_id}',
     'DELETE /webhook/orgs/{org_id}/endpoints/{endpoint_id}',
     'GET /webhook/orgs/{org_id}/deliveries/{delivery_id}',
+    'GET /webhook/orgs/{org_id}/deliveries',
 ];
 async function createEndpoint(apiKey, orgId, name, opts = {}) {
     const body = { name };
@@ -37,3 +39,28 @@ async function deleteEndpoint(apiKey, orgId, endpointId) {
 async function getDelivery(apiKey, orgId, deliveryId) {
     return (0, client_1.request)('GET', `${config_1.WEBHOOK_BASE}/webhook/orgs/${encodeURIComponent(orgId)}/deliveries/${encodeURIComponent(deliveryId)}`, apiKey);
 }
+// listDeliveries — the deliveries an endpoint has received, newest first.
+//
+// This closes the gap that made webhooks unreadable to the agent that built
+// them: `getDelivery` needs an id, and that id is only ever returned to
+// whoever POSTed — for a funnel form, the visitor's browser. Without a list,
+// an agent could not see the submissions its own form collected.
+//
+// Keyset-paginated (backend `envelope.WrapPage`), so use requestPage to keep
+// the cursor. Two backend behaviours worth knowing: an endpoint_id the org
+// doesn't own is a 404 rather than an empty page (an empty 200 would confirm
+// the id exists to someone guessing), and an unknown cursor is a 400 rather
+// than a silent restart from the top (a polling agent handed "start over"
+// would reprocess every lead it had already handled).
+async function listDeliveries(apiKey, orgId, opts = {}) {
+    const qs = new URLSearchParams();
+    if (opts.endpointId)
+        qs.set('endpoint_id', opts.endpointId);
+    if (opts.limit !== undefined)
+        qs.set('limit', String(opts.limit));
+    if (opts.cursor)
+        qs.set('cursor', opts.cursor);
+    const query = qs.toString() ? `?${qs.toString()}` : '';
+    const page = await (0, client_1.requestPage)('GET', `${config_1.WEBHOOK_BASE}/webhook/orgs/${encodeURIComponent(orgId)}/deliveries${query}`, apiKey);
+    return { deliveries: page.data, next_cursor: page.next_cursor, has_more: page.has_more };
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@myapihq/sdk",
   "license": "Apache-2.0",
-  "version": "2.4.2",
+  "version": "2.5.0",
   "description": "TypeScript SDK for the MyAPI ecosystem",
   "repository": {
     "type": "git",