@stackshift-cloud/sdk 1.0.0 → 1.2.0

package/dist/mail-migration.d.ts

@@ -0,0 +1,16 @@
+import type { StackShift } from './client.js';
+export interface MailMigrationChecklist {
+    domain: string;
+    provider: string;
+    completed: string[];
+    revision: number;
+    updatedAt?: string;
+}
+export declare class MailMigrationClient {
+    private readonly client;
+    constructor(client: StackShift);
+    audit(domain: string, selectors?: string[]): Promise<Record<string, unknown>>;
+    plan(domain: string, provider: string, selectors?: string[]): Promise<Record<string, unknown>>;
+    checklist(domain: string, provider: string): Promise<MailMigrationChecklist>;
+    saveChecklist(input: MailMigrationChecklist): Promise<MailMigrationChecklist>;
+}

package/dist/mail-migration.js

@@ -0,0 +1,10 @@
+export class MailMigrationClient {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    audit(domain, selectors = []) { return this.client.request(`/mail/audit?${new URLSearchParams({ domain, selectors: selectors.join(',') })}`); }
+    plan(domain, provider, selectors = []) { return this.client.request(`/mail/migration-plan?${new URLSearchParams({ domain, provider, selectors: selectors.join(',') })}`); }
+    checklist(domain, provider) { return this.client.mailRequest(`/mail/migration/checklist?${new URLSearchParams({ domain, provider })}`); }
+    saveChecklist(input) { return this.client.mailRequest('/mail/migration/checklist', { method: 'PUT', body: { domain: input.domain, provider: input.provider, completed: input.completed, revision: input.revision } }); }
+}

package/dist/mail-otp-types.d.ts

@@ -1,6 +1,8 @@
+import type { MailMode, MailSimulationOptions } from './mail-simulation.js';
 import type { JsonValue } from './types.js';
 export type MailOtpStatus = 'pending' | 'verified' | 'expired' | 'failed' | 'canceled';
 export interface MailOtpSendInput {
+    simulation?: MailSimulationOptions;
     to: string;
     purpose: string;
     from?: string;
@@ -25,6 +27,7 @@ export interface MailOtpChallengeListOptions {
     cursor?: string;
 }
 export interface MailOtpChallenge {
+    mode?: MailMode;
     id: string;
     to: string;
     purpose: string;
@@ -46,6 +49,7 @@ export interface MailOtpChallengeListResult {
     nextCursor?: string | null;
 }
 export interface MailOtpSendResponse {
+    mode?: MailMode;
     id: string;
     to: string;
     purpose: string;

package/dist/mail-simulation.d.ts

@@ -0,0 +1,4 @@
+export type MailMode = 'live' | 'test';
+export interface MailSimulationOptions {
+    scenario: 'delivered' | 'bounced' | 'complained' | 'delayed';
+}

package/dist/mail-simulation.js

@@ -0,0 +1 @@
+export {};

package/dist/mail-subscribers.d.ts

@@ -0,0 +1,39 @@
+export type MailImportMode = 'recorded_consent' | 'confirmation';
+export interface MailImportRow {
+    row: number;
+    email: string;
+    outcome: 'imported' | 'updated' | 'invalid' | 'skipped';
+    code: string;
+    reason: string;
+    status?: string;
+}
+export interface MailImportResult {
+    imported: number;
+    skipped: number;
+    summary: {
+        imported: number;
+        updated: number;
+        invalid: number;
+        skipped: number;
+        pending: number;
+    };
+    rows: MailImportRow[];
+    preview: boolean;
+}
+export interface MailSendingDomainHealth {
+    state: 'healthy' | 'suspect' | 'degraded';
+    lastResult: 'verified' | 'failed' | 'indeterminate' | 'unknown';
+    lastCheckedAt: string | null;
+    lastSuccessAt: string | null;
+    nextCheckAt: string;
+    degradedAt: string | null;
+    issues: {
+        type?: string;
+        record: string;
+        name: string;
+        expected: string;
+        observed: string[];
+        status: string;
+        scope: 'customer' | 'platform';
+    }[];
+}

package/dist/mail-subscribers.js

@@ -0,0 +1 @@
+export {};

package/dist/mail-template-types.d.ts

@@ -1,3 +1,5 @@
+import type { MailMode, MailSimulationOptions } from './mail-simulation.js';
+import type { MailTrackingOptions } from './mail-tracking.js';
 import type { JsonValue, MailAddressInput, MailIdempotencyStatus, MailStatus } from './types.js';
 export type MailTemplateStatus = 'active' | 'archived' | 'deleted';
 export interface MailTemplateCreateInput {
@@ -22,6 +24,7 @@ export interface MailTemplateListOptions {
     search?: string;
 }
 export interface MailTemplate {
+    mode?: MailMode;
     id: string;
     name: string;
     slug: string;
@@ -61,16 +64,20 @@ export interface MailTemplatePreviewInput {
     versionId?: string;
 }
 export interface MailTemplateTestSendInput {
+    simulation?: MailSimulationOptions;
     to: MailAddressInput;
     from?: MailAddressInput;
     data: Record<string, JsonValue>;
     versionId?: string;
 }
 export interface MailTemplateTestSendResponse {
+    mode?: MailMode;
     messageId: string;
     status: MailStatus;
 }
 export interface MailSendTemplateInput {
+    simulation?: MailSimulationOptions;
+    tracking?: MailTrackingOptions;
     template: string;
     versionId?: string;
     to: MailAddressInput;
@@ -88,6 +95,7 @@ export interface MailSendTemplateInput {
     }>;
 }
 export interface MailSendTemplateResponse {
+    mode?: MailMode;
     id: string;
     status: MailStatus;
     templateId: string;

package/dist/mail-tracking.d.ts

@@ -0,0 +1,59 @@
+import type { StackShift } from './client.js';
+export interface MailTrackingOptions {
+    opens?: boolean;
+    clicks?: boolean;
+}
+export interface MailTrackingSettings {
+    opens: boolean;
+    clicks: boolean;
+}
+export interface MailEngagementCount {
+    kind: 'open' | 'click';
+    variant: string;
+    link?: string;
+    total: number;
+    unique: number;
+    suspectedAutomated: number;
+    firstAt?: string;
+    lastAt?: string;
+}
+export interface MailEngagementReport {
+    counts: MailEngagementCount[];
+    openEligible: number;
+    clickEligible: number;
+    openEngagedDelivered: number;
+    clickEngagedDelivered: number;
+    openDelivered: number;
+    clickDelivered: number;
+    scope: 'message' | 'recipient';
+    retentionDays: number;
+}
+export interface MailTrackingDomain {
+    id: string;
+    domainId: string;
+    hostname: string;
+    ownershipToken: string;
+    enabled: boolean;
+    status: 'pending' | 'provisioning' | 'active' | 'degraded' | 'revoked';
+    checkedAt?: string;
+    dnsValidUntil?: string;
+}
+export declare class MailTrackingClient {
+    private readonly client;
+    constructor(client: StackShift);
+    settings(): Promise<{
+        settings: MailTrackingSettings;
+        available: boolean;
+    }>;
+    updateSettings(input: MailTrackingSettings): Promise<MailTrackingSettings>;
+    message(id: string): Promise<MailEngagementReport>;
+    campaign(id: string): Promise<MailEngagementReport>;
+    domains(): Promise<{
+        data: MailTrackingDomain[];
+        target: string;
+        available: boolean;
+    }>;
+    createDomain(domainId: string, hostname: string): Promise<MailTrackingDomain>;
+    verifyDomain(id: string): Promise<MailTrackingDomain>;
+    updateDomain(id: string, enabled: boolean, revoke?: boolean): Promise<void>;
+}

package/dist/mail-tracking.js

@@ -0,0 +1,14 @@
+export class MailTrackingClient {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    settings() { return this.client.mailRequest('/mail/tracking/settings'); }
+    updateSettings(input) { return this.client.mailRequest('/mail/tracking/settings', { method: 'PUT', body: input }); }
+    message(id) { return this.client.mailRequest(`/mail/messages/${encodeURIComponent(id)}/engagement`); }
+    campaign(id) { return this.client.mailRequest(`/mail/campaigns/${encodeURIComponent(id)}/engagement`); }
+    domains() { return this.client.mailRequest('/mail/tracking/domains'); }
+    createDomain(domainId, hostname) { return this.client.mailRequest('/mail/tracking/domains', { method: 'POST', body: { domainId, hostname } }); }
+    verifyDomain(id) { return this.client.mailRequest(`/mail/tracking/domains/${encodeURIComponent(id)}/verify`, { method: 'POST' }); }
+    updateDomain(id, enabled, revoke = false) { return this.client.mailRequest(`/mail/tracking/domains/${encodeURIComponent(id)}`, { method: 'PUT', body: { enabled, revoke } }); }
+}

package/dist/mail-webhook-types.d.ts

@@ -1,6 +1,8 @@
+import type { MailMode } from './mail-simulation.js';
 import type { JsonValue } from './types.js';
-export type MailEventType = 'mail.message.accepted' | 'mail.message.queued' | 'mail.message.sending' | 'mail.message.mta_accepted' | 'mail.delivery.delayed' | 'mail.delivery.delivered' | 'mail.message.failed' | 'mail.message.bounced' | 'mail.message.suppressed' | 'mail.message.complained' | 'mail.suppression.created' | 'mail.suppression.deleted' | 'mail.otp.created' | 'mail.otp.sent' | 'mail.otp.verified' | 'mail.otp.failed_attempt' | 'mail.otp.failed' | 'mail.otp.expired' | 'mail.otp.canceled' | 'mail.template.created' | 'mail.template.updated' | 'mail.template.deleted' | 'mail.template.version.created' | 'mail.template.test_queued' | 'mail.domain.created' | 'mail.domain.verified' | 'mail.domain.failed' | 'mail.domain.deleted' | 'mail.webhook.created' | 'mail.webhook.updated' | 'mail.webhook.disabled' | 'mail.webhook.delivery.succeeded' | 'mail.webhook.delivery.failed' | 'mail.audience.created' | 'mail.audience.members.imported' | 'mail.campaign.created' | 'mail.campaign.queued';
+export type MailEventType = 'mail.message.opened' | 'mail.message.clicked' | 'mail.message.accepted' | 'mail.message.queued' | 'mail.message.sending' | 'mail.message.mta_accepted' | 'mail.delivery.delayed' | 'mail.delivery.delivered' | 'mail.message.failed' | 'mail.message.bounced' | 'mail.message.suppressed' | 'mail.message.complained' | 'mail.suppression.created' | 'mail.suppression.deleted' | 'mail.otp.created' | 'mail.otp.sent' | 'mail.otp.verified' | 'mail.otp.failed_attempt' | 'mail.otp.failed' | 'mail.otp.expired' | 'mail.otp.canceled' | 'mail.template.created' | 'mail.template.updated' | 'mail.template.deleted' | 'mail.template.version.created' | 'mail.template.test_queued' | 'mail.domain.created' | 'mail.domain.verified' | 'mail.domain.failed' | 'mail.domain.deleted' | 'mail.webhook.created' | 'mail.webhook.updated' | 'mail.webhook.disabled' | 'mail.webhook.delivery.succeeded' | 'mail.webhook.delivery.failed' | 'mail.audience.created' | 'mail.audience.members.imported' | 'mail.campaign.created' | 'mail.campaign.queued';
 export interface MailEvent {
+    mode?: MailMode;
     id: string;
     type: MailEventType | string;
     resourceType?: string | null;
@@ -64,6 +66,7 @@ export interface MailWebhookListResult {
     nextCursor?: string | null;
 }
 export interface MailWebhookDelivery {
+    mode?: MailMode;
     id: string;
     endpointId: string;
     eventId: string;

package/dist/mail.d.ts

@@ -1,3 +1,8 @@
+import { MailAutomationsClient, MailFormsClient, MailSegmentsClient } from './mail-marketing.js';
+import { MailBillingClient } from './mail-billing.js';
+import { MailMigrationClient } from './mail-migration.js';
+import { MailBrandsClient } from './mail-brands.js';
+import { MailTrackingClient } from './mail-tracking.js';
 import type { StackShift } from './client.js';
 import type { MailLog, MailDomain, MailDomainListResult, MailMessage, MailMessageListOptions, MailMessageListResult, MailSendAttempt, MailSendInput, MailSendResponse } from './types.js';
 import type { MailBounce, MailBounceListOptions, MailBounceListResult, MailSuppression, MailSuppressionCreateInput, MailSuppressionListOptions, MailSuppressionListResult } from './mail-delivery-types.js';
@@ -17,6 +22,10 @@ export { MailExportsClient } from './mail-exports.js';
 import type { MailTemplateDiagnosticInput, MailTemplateDiagnosticResult } from './mail-diagnostics.js';
 export declare class MailClient {
     private readonly client;
+    readonly automations: MailAutomationsClient;
+    readonly forms: MailFormsClient;
+    readonly segments: MailSegmentsClient;
+    readonly tracking: MailTrackingClient;
     readonly domains: MailDomainsClient;
     readonly messages: MailMessagesClient;
     readonly suppressions: MailSuppressionsClient;
@@ -26,6 +35,9 @@ export declare class MailClient {
     readonly events: MailEventsClient;
     readonly webhooks: MailWebhooksClient;
     readonly streams: MailStreamsClient;
+    readonly billing: MailBillingClient;
+    readonly migration: MailMigrationClient;
+    readonly brands: MailBrandsClient;
     readonly audiences: MailAudiencesClient;
     readonly campaigns: MailCampaignsClient;
     readonly exports: MailExportsClient;

package/dist/mail.js

@@ -1,3 +1,8 @@
+import { MailAutomationsClient, MailFormsClient, MailSegmentsClient } from './mail-marketing.js';
+import { MailBillingClient } from './mail-billing.js';
+import { MailMigrationClient } from './mail-migration.js';
+import { MailBrandsClient } from './mail-brands.js';
+import { MailTrackingClient } from './mail-tracking.js';
 import { MailAnalyticsClient, MailBatchClient, MailInboundClient, MailScheduledClient } from './mail-advanced.js';
 export { MailAnalyticsClient, MailBatchClient, MailInboundClient, MailScheduledClient } from './mail-advanced.js';
 export { MailEventsClient, MailWebhooksClient, verifyWebhookSignature } from './mail-events-webhooks.js';
@@ -10,6 +15,10 @@ import { MailExportsClient } from './mail-exports.js';
 export { MailExportsClient } from './mail-exports.js';
 export class MailClient {
     client;
+    automations;
+    forms;
+    segments;
+    tracking;
     domains;
     messages;
     suppressions;
@@ -19,6 +28,9 @@ export class MailClient {
     events;
     webhooks;
     streams;
+    billing;
+    migration;
+    brands;
     audiences;
     campaigns;
     exports;
@@ -30,6 +42,7 @@ export class MailClient {
     analytics;
     constructor(client) {
         this.client = client;
+        this.tracking = new MailTrackingClient(client);
         this.domains = new MailDomainsClient(client);
         this.messages = new MailMessagesClient(client);
         this.suppressions = new MailSuppressionsClient(client);
@@ -39,6 +52,12 @@ export class MailClient {
         this.events = new MailEventsClient(client);
         this.webhooks = new MailWebhooksClient(client);
         this.streams = new MailStreamsClient(client);
+        this.billing = new MailBillingClient(client);
+        this.automations = new MailAutomationsClient(client);
+        this.forms = new MailFormsClient(client);
+        this.segments = new MailSegmentsClient(client);
+        this.migration = new MailMigrationClient(client);
+        this.brands = new MailBrandsClient(client);
         this.audiences = new MailAudiencesClient(client);
         this.campaigns = new MailCampaignsClient(client);
         this.exports = new MailExportsClient(client);

package/dist/types.d.ts

@@ -1,8 +1,11 @@
+import type { MailMode, MailSimulationOptions } from './mail-simulation.js';
+import type { MailTrackingOptions } from './mail-tracking.js';
 export type JsonValue = string | number | boolean | null | JsonValue[] | {
     [key: string]: JsonValue;
 };
 export type AssetVisibility = 'public' | 'private';
 export interface StackShiftOptions {
+    assetSpaceId?: string;
     apiKey?: string;
     baseUrl?: string;
     mailBaseUrl?: string;
@@ -23,6 +26,7 @@ export interface MailDnsRecord {
     explanation?: string;
 }
 export interface MailDomain {
+    health?: import('./mail-subscribers.js').MailSendingDomainHealth;
     id: string;
     domain: string;
     status: MailDomainStatus;
@@ -45,6 +49,8 @@ export interface MailAddress {
 }
 export type MailAddressInput = string | MailAddress | Array<string | MailAddress>;
 export interface MailSendInput {
+    simulation?: MailSimulationOptions;
+    tracking?: MailTrackingOptions;
     from: string | MailAddress;
     to: MailAddressInput;
     cc?: MailAddressInput;
@@ -67,11 +73,13 @@ export interface MailSendInput {
     stream?: string;
 }
 export interface MailSendResponse {
+    mode?: MailMode;
     id: string;
     status: MailStatus;
     idempotencyStatus: MailIdempotencyStatus;
 }
 export interface MailMessage {
+    mode?: MailMode;
     id: string;
     from: MailAddress;
     to: string[];
@@ -138,6 +146,7 @@ export interface MailRecipientSummary {
     complained: number;
 }
 export interface MailMessageSummary {
+    mode?: MailMode;
     id: string;
     from: string;
     to: string[];
@@ -269,6 +278,7 @@ export interface AssetVersion {
     created_at: string;
 }
 export interface AssetCollection {
+    revision: number;
     id: string;
     name: string;
     description?: string;
@@ -298,6 +308,9 @@ export interface AssetUploadOptions {
     metadata?: Record<string, JsonValue>;
 }
 export interface AssetListOptions {
+    collectionId?: string;
+    duplicates?: boolean;
+    security?: 'all' | 'clean' | 'pending' | 'failed';
     bucket?: string;
     prefix?: string;
     visibility?: AssetVisibility;
@@ -362,6 +375,12 @@ export interface AssetBucket {
     allowed_origins: string[];
     lifecycle_policy: Record<string, unknown>;
     custom_domain_id?: string;
+    storage_mode: 'managed' | 'byob' | 'stackshift_s2';
+    connection_id?: string;
+    s2_bucket_id?: string;
+    object_prefix: string;
+    derivative_prefix: string;
+    auto_extract_text: boolean;
     revision: number;
     created_at: string;
     updated_at: string;

package/dist/upload-controller.d.ts

@@ -0,0 +1,70 @@
+export interface UploadProgress {
+    loaded: number;
+    total: number;
+    percent: number;
+}
+export interface UploadedPart {
+    partNumber: number;
+    size: number;
+    checksumSHA256?: string;
+}
+export interface ChunkUploadSession {
+    id: string;
+    uploadToken: string;
+    expiresAt: string;
+    maxBytes: number;
+    partSize: number;
+    parts: UploadedPart[];
+    resumeContext?: string;
+}
+export interface ChunkUploadRequest {
+    key: string;
+    fileName: string;
+    mimeType: string;
+    metadata?: Record<string, unknown>;
+}
+export interface ChunkUploadCallbacks {
+    signal?: AbortSignal;
+    onProgress?: (progress: UploadProgress) => void;
+    onPartProgress?: (partNumber: number, progress: UploadProgress) => void;
+    onSession?: (session: ChunkUploadSession) => void;
+}
+export interface ChunkUploadTransport<TResult> {
+    create(file: Blob, request: ChunkUploadRequest): Promise<ChunkUploadSession>;
+    resume(resumeContext: string): Promise<ChunkUploadSession>;
+    uploadPart(session: ChunkUploadSession, partNumber: number, chunk: Blob, checksum: string, callbacks: ChunkUploadCallbacks): Promise<void>;
+    complete(session: ChunkUploadSession): Promise<TResult>;
+    cancel(session: ChunkUploadSession): Promise<void>;
+}
+export interface UploadResumeRecord {
+    key: string;
+    fingerprint: string;
+    session: ChunkUploadSession;
+    updatedAt: string;
+}
+export interface UploadResumeStore {
+    get(key: string): Promise<UploadResumeRecord | undefined>;
+    set(record: UploadResumeRecord): Promise<void>;
+    delete(key: string): Promise<void>;
+}
+export interface ChunkedUploadOptions extends ChunkUploadCallbacks {
+    resumeKey?: string;
+    concurrency?: number;
+    retryAttempts?: number;
+    cancelOnAbort?: boolean;
+}
+export declare class UploadResumeInvalidError extends Error {
+    constructor(message?: string);
+}
+export declare class ChunkedUploadController<TResult> {
+    private readonly transport;
+    private readonly store?;
+    private persistence;
+    constructor(transport: ChunkUploadTransport<TResult>, store?: UploadResumeStore | undefined);
+    upload(file: Blob, request: ChunkUploadRequest, options?: ChunkedUploadOptions): Promise<TResult>;
+    cancel(resumeKey: string): Promise<void>;
+    private restore;
+    private persist;
+}
+export declare function putBlob(url: string, blob: Blob, callbacks?: ChunkUploadCallbacks, headers?: Record<string, string>, fetcher?: typeof fetch): Promise<void>;
+export declare function sha256Blob(blob: Blob): Promise<string>;