@withpotter/lib 0.13.0-next.101

package/dist/api/types/campaigns.d.ts

@@ -0,0 +1,262 @@
+/**
+ * CAMPAIGNS API — as the API sends it.
+ *
+ * One slice of what was a 4,164-line `types.ts`. The sections were already
+ * here as comment fences; they are files now, so a type is found by the
+ * endpoint it belongs to rather than by scrolling.
+ */
+import type { AutomationSettings, ConditionGroup, FlowStep } from './automation-flow';
+export type CampaignChannel = 'email' | 'sms' | 'whatsapp' | 'push';
+export type CampaignStatus = 'draft' | 'scheduled' | 'sent' | 'failed';
+export interface VariantCounts {
+    sent?: number;
+    opens?: number;
+    clicks?: number;
+}
+export interface Campaign {
+    id: string;
+    channel: CampaignChannel;
+    status: CampaignStatus;
+    subject?: string;
+    /** A second subject line, tested against `subject`. Email only. */
+    subjectB?: string | null;
+    /** What each line earned: sent, opens and clicks, by variant. */
+    variantStats?: Partial<Record<'a' | 'b', VariantCounts>>;
+    previewText?: string;
+    body: string;
+    audienceLabel?: string;
+    recipientCount?: number;
+    sentCount?: number;
+    openCount?: number;
+    clickCount?: number;
+    /** Messages the provider could not deliver, for good. */
+    bounceCount?: number;
+    /** Recipients who reported it as spam. */
+    complaintCount?: number;
+    /** Recipients who unsubscribed from a link in it. */
+    unsubscribeCount?: number;
+    scheduledAt?: string;
+    sentAt?: string;
+    createdAt: string;
+}
+export interface CampaignStats {
+    totalSent: number;
+    avgOpenRate?: number;
+    avgClickRate?: number;
+    totalDelivered?: number;
+    creditsUsed?: number;
+    creditsRemaining?: number;
+}
+/** The fields POST /campaigns accepts. Anything else is rejected outright. */
+export interface CreateCampaignInput {
+    channel: CampaignChannel;
+    subject?: string;
+    /** A second subject line: half the audience gets each. Email only. */
+    subjectB?: string;
+    previewText?: string;
+    body: string;
+    audienceLabel?: string;
+    scheduledAt?: string;
+}
+export interface PaginatedCampaigns {
+    campaigns: Campaign[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}
+export type AutomationTrigger = 'new_customer' | 'abandoned_cart'
+/**
+ * Somebody sent an enquiry.
+ *
+ * The other eight all assume a purchase or a customer record, which a lead
+ * business never has. Backed by a real event on the API and published through
+ * `capabilities`, so the dashboard does not have to guess whether it fires.
+ */
+ | 'new_inquiry'
+/**
+ * An enquiry nobody has answered.
+ *
+ * The one `new_inquiry` cannot be: that fires on arrival, so a delay on it
+ * means "three days later" and not "three days later and we still have not
+ * replied". Found by a scan on the API, like `abandoned_cart`.
+ */
+ | 'inquiry_no_reply' | 'first_purchase' | 'repeat_purchase' | 'birthday' | 'lapsed_customer' | 'low_loyalty_points'
+/**
+ * A member moved up a loyalty tier. Emitted by the API once the points that
+ * earned the tier are committed; the enrolment is keyed on the tier, so a
+ * member is told once per tier.
+ */
+ | 'tier_reached' | 'order_refunded' | 'order_fulfilled' | 'order_delivered' | 'review_approved' | 'customer_tag_added' | 'marketing_subscribed' | 'booking_cancelled' | 'booking_no_show' | 'scheduled' | 'segment_joined' | 'stock_low' | 'stock_out' | 'back_in_stock' | 'custom';
+export type AutomationStatus = 'active' | 'paused' | 'draft';
+export type AutomationActionType = 'send_email' | 'send_sms' | 'add_tag' | 'add_to_segment';
+export interface AutomationAction {
+    type: AutomationActionType;
+    delayMinutes?: number;
+    subject?: string;
+    body?: string;
+    tag?: string;
+    segmentId?: string;
+}
+export interface Automation {
+    id: string;
+    name: string;
+    trigger: AutomationTrigger;
+    status: AutomationStatus;
+    /** From before the flow builder. `steps` is what runs now. */
+    actions: AutomationAction[];
+    /** The flow: always present on a read, read from `actions` on older rows. */
+    steps?: FlowStep[];
+    conditions?: ConditionGroup | null;
+    settings?: AutomationSettings;
+    /** Bumped on every edit; people already inside finish the version they entered on. */
+    version?: number;
+    /** Advice about this automation, such as many others sharing its trigger. */
+    warnings?: string[];
+    enrolledCount?: number;
+    completedCount?: number;
+    revenueAttributed?: number;
+    createdAt: string;
+    updatedAt?: string;
+}
+export interface PaginatedAutomations {
+    automations: Automation[];
+    total: number;
+}
+/**
+ * `expired` is gone. Nothing could ever produce it: `toAbandonedCart` returns
+ * 'recovered' when `data.recoveredAt` is stamped and 'pending' otherwise, and
+ * the API's query branches on those two only — so `status=expired` matched
+ * neither branch, applied NO where clause, and quietly returned every cart
+ * under a label promising the opposite. The Select dropped the option and the
+ * API dropped the branch; the union outlived both and was the last place the
+ * value could still be typed by accident.
+ */
+export type AbandonedCartStatus = 'pending' | 'recovered';
+/** A line the shopper left behind. `image` is what makes the row worth looking at. */
+export interface AbandonedCartItem {
+    contentId: string;
+    title: string;
+    slug?: string;
+    image?: string;
+    quantity: number;
+    unitPrice: number;
+}
+export interface AbandonedCart {
+    id: string;
+    customerName?: string;
+    customerEmail?: string;
+    /**
+     * WhatsApp is the channel that gets answered in this market, and a cart the
+     * email sweep has already given up on is where it matters. Absent for a
+     * guest, which is what makes that cart unreachable rather than merely
+     * un-emailed.
+     */
+    customerPhone?: string;
+    items: AbandonedCartItem[];
+    itemCount: number;
+    totalValue: number;
+    status: AbandonedCartStatus;
+    abandonedAt: string;
+    recoveredAt?: string;
+    /**
+     * How it came back. `order` is the one the system sets itself — the cart
+     * converted into a paid order — as against the three a merchant records
+     * having chased it down. Everything else here is a claim; this one is a fact.
+     */
+    recoveryChannel?: 'email' | 'sms' | 'manual' | 'order';
+}
+export interface AbandonedCartStats {
+    totalAbandoned: number;
+    totalRecovered: number;
+    /** 0..1 */
+    recoveryRate: number;
+    revenueRecovered: number;
+    avgCartValue: number;
+    /**
+     * Carts a person is the only remaining answer for: past the window the
+     * recovery sweep gives up on, still open, and attached to someone we hold an
+     * address for. The sidebar badge counts these and nothing else, because a
+     * badge that counts the whole population never reaches zero and is wallpaper
+     * inside a week.
+     */
+    needsAttention: number;
+}
+export interface PaginatedAbandonedCarts {
+    carts: AbandonedCart[];
+    total: number;
+    totalPages: number;
+}
+/**
+ * The shape /abandoned-carts actually returns: raw Cart rows, paged as
+ * `rows`/`count`. Nothing here matched what the dashboard was reading —
+ * `res.carts` and `res.total` were both undefined against `rows`/`count`, so
+ * the abandoned-cart list rendered zero rows no matter how many carts existed,
+ * and every money field on the stats card came back undefined and printed NaN.
+ */
+export interface RawAbandonedCart {
+    id: string;
+    member?: {
+        id: string;
+        name?: string | null;
+        email?: string | null;
+        phone?: string | null;
+    } | null;
+    items?: AbandonedCartItem[];
+    itemCount: number;
+    subtotal: number;
+    data?: {
+        recoveredAt?: string;
+        recoveryChannel?: 'email' | 'sms' | 'manual' | 'order';
+    } | null;
+    updatedAt: string;
+}
+export interface RawAbandonedCartStats {
+    total: number;
+    recovered: number;
+    pending: number;
+    recoveryRate: number;
+    revenueRecovered: number;
+    avgCartValue: number;
+    /** Past the sweep's window, still open, and reachable. The badge reads this. */
+    needsAttention: number;
+}
+export type InquiryStatus = 'new' | 'viewed' | 'in_progress' | 'waiting_response' | 'converted' | 'resolved' | 'closed' | 'spam';
+export type InquiryType = 'contact' | 'quote' | 'consultation' | 'support' | 'feedback' | 'partnership' | 'press' | 'other';
+/** One run of one automation step, for one person. */
+export type AutomationRunStatus = 'pending' | 'done' | 'failed' | 'skipped';
+/**
+ * Why a run did not send. The API records it on the skipped run; the dashboard
+ * words each in the merchant's terms (see `automation-activity.tsx`).
+ */
+export type AutomationSkipReason = 'automation_inactive' | 'action_missing' | 'member_missing' | 'no_consent' | 'suppressed' | 'no_address' | 'invalid_address' | 'no_credits' | 'quiet_hours' | 'frequency_cap' | 'no_member' | 'goal_reached' | 'no_longer_eligible';
+export interface AutomationActivityRun {
+    id: string;
+    status: AutomationRunStatus;
+    /** For a skipped run the reason code; for a failed one the error text. */
+    detail: string | null;
+    attempts: number;
+    /** From before the flow builder; null for a step of a journey. */
+    actionIndex: number | null;
+    stepId?: string | null;
+    /** What the step was: send_email, wait, condition's chosen step, and so on. */
+    stepType?: string | null;
+    runAt: string;
+    completedAt: string | null;
+    /** Null for a journey about a product rather than a person. */
+    member: {
+        id: string;
+        name: string | null;
+        email: string | null;
+    } | null;
+}
+export interface AutomationActivity {
+    summary: {
+        byStatus: Partial<Record<AutomationRunStatus, number>>;
+        skippedByReason: Record<string, number>;
+        /** Failed once and waiting for another try. */
+        retrying: number;
+    };
+    runs: AutomationActivityRun[];
+    total: number;
+}

package/dist/api/types/campaigns.js

@@ -0,0 +1 @@
+//# sourceMappingURL=campaigns.js.map

package/dist/api/types/campaigns.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/api/types/catalog.d.ts

@@ -0,0 +1,273 @@
+/**
+ * INVENTORY / PRODUCTS API — as the API sends it.
+ *
+ * One slice of what was a 4,164-line `types.ts`. The sections were already
+ * here as comment fences; they are files now, so a type is found by the
+ * endpoint it belongs to rather than by scrolling.
+ */
+export interface InventoryProduct {
+    id: string;
+    tenantId?: string;
+    type?: string;
+    title: string;
+    slug: string;
+    status: string;
+    description?: string | null;
+    shortDescription?: string | null;
+    category?: string | null;
+    tags?: string[];
+    featured?: boolean;
+    isActive?: boolean;
+    sortOrder?: number;
+    price: number;
+    compareAtPrice?: number;
+    costPrice?: number | string | null;
+    currency: string;
+    quantity: number;
+    reserved: number;
+    lowStockThreshold: number;
+    trackInventory: boolean;
+    image?: string | {
+        url: string;
+        type?: 'image' | 'video';
+        alt?: string;
+        width?: number;
+        height?: number;
+        thumbnail?: string;
+        duration?: number;
+    } | null;
+    gallery?: Array<{
+        url: string;
+        type?: 'image' | 'video';
+        alt?: string;
+        width?: number;
+        height?: number;
+        thumbnail?: string;
+        duration?: number;
+    }>;
+    data?: Record<string, unknown>;
+    sku?: string;
+    behaviors?: Record<string, boolean | {
+        enabled?: boolean;
+    }>;
+    /** The archetype key the product was filed under (`content.intent`). */
+    intent?: string | null;
+    hasVariants?: boolean;
+    variants?: Array<{
+        id: string;
+        name: string;
+        sku?: string;
+        price?: number;
+        costPrice?: number | null;
+        quantity?: number;
+        data?: Record<string, unknown>;
+    }>;
+    available: number;
+    isLowStock: boolean;
+    isOutOfStock: boolean;
+    /** UUIDs of tenant_members assigned as owners of this product. */
+    assigneeIds?: string[];
+    createdAt?: string | Date;
+    updatedAt?: string | Date;
+    publishedAt?: string | Date | null;
+}
+export interface BulkImportProductRow {
+    rowNumber: number;
+    title: string;
+    slug?: string;
+    description?: string;
+    shortDescription?: string;
+    price: number;
+    compareAtPrice?: number;
+    currency?: string;
+    category?: string;
+    tags?: string[];
+    sku?: string;
+    barcode?: string;
+    trackInventory?: boolean;
+    quantity?: number;
+    lowStockThreshold?: number;
+    isActive?: boolean;
+    imageUrl?: string;
+}
+export interface BulkImportProductsResult {
+    dryRun: boolean;
+    total: number;
+    valid: number;
+    created: number;
+    updated: number;
+    skipped: number;
+    failed: number;
+    errors: Array<{
+        rowNumber: number;
+        field?: string;
+        code: string;
+        message: string;
+    }>;
+}
+export interface ShippingZoneRegion {
+    countries?: string[];
+    states?: string[];
+    cities?: string[];
+    postalCodes?: string[];
+}
+export interface ShippingRateConditions {
+    minOrderAmount?: number;
+    maxOrderAmount?: number;
+    minWeight?: number;
+    maxWeight?: number;
+}
+export interface ShippingRateData {
+    id: string;
+    name: string;
+    description: string | null;
+    rateType: 'flat' | 'weight_based' | 'price_based' | 'free';
+    price: number;
+    estimatedDays: string | null;
+    conditions: ShippingRateConditions | null;
+    sortOrder: number;
+    isActive: boolean;
+}
+/**
+ * How the goods travel. `delivery` is the merchant's own rider, `shipping` is
+ * a courier. They are separate lists at checkout, and the narrowest-zone rule
+ * runs inside each one, so a city rider zone never hides the nationwide
+ * courier.
+ */
+export type ShippingZoneMethod = 'delivery' | 'shipping';
+export interface ShippingZoneData {
+    id: string;
+    tenantId: string;
+    name: string;
+    description: string | null;
+    regions: ShippingZoneRegion;
+    method: ShippingZoneMethod;
+    /** Which branch fulfils this zone. null means the main location. */
+    originLocationId: string | null;
+    status: 'active' | 'inactive';
+    sortOrder: number;
+    freeShippingThreshold: number | null;
+    rates: ShippingRateData[];
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreateShippingZoneData {
+    name: string;
+    description?: string;
+    regions: ShippingZoneRegion;
+    method?: ShippingZoneMethod;
+    originLocationId?: string | null;
+    status?: 'active' | 'inactive';
+    sortOrder?: number;
+    freeShippingThreshold?: number | null;
+    rates?: Omit<CreateShippingRateData, 'shippingZoneId'>[];
+}
+export interface CreateShippingRateData {
+    name: string;
+    description?: string;
+    rateType?: 'flat' | 'weight_based' | 'price_based' | 'free';
+    price: number;
+    estimatedDays?: string;
+    conditions?: ShippingRateConditions | null;
+    sortOrder?: number;
+    isActive?: boolean;
+}
+export interface LocationData {
+    id: string;
+    tenantId: string;
+    country: string;
+    state: string;
+    city: string;
+    isActive: boolean;
+    sortOrder: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreateLocationData {
+    country: string;
+    state: string;
+    city: string;
+    isActive?: boolean;
+    sortOrder?: number;
+}
+export type BusinessLocationStatus = 'active' | 'archived';
+/** The weekly shape Settings covers Hours writes, reused for one branch. */
+export interface WeeklyHours {
+    timezone?: string;
+    days: Record<string, {
+        enabled: boolean;
+        slots: {
+            start: string;
+            end: string;
+        }[];
+    }>;
+}
+/**
+ * What a branch may decide for itself about bookings.
+ *
+ * One field, because one field is what the engine enforces: `cancel-booking`
+ * compares the hours left against `freeCancellationHours` and records whether
+ * the guest was inside the window. The rest of the tenant's `noShowPolicy` is
+ * fee machinery nothing charges — Box holds no card — so it is deliberately
+ * not per branch.
+ */
+export interface LocationBookingPolicy {
+    /** Hours before the start that a booking may still be dropped for free. */
+    freeCancellationHours: number;
+}
+export interface BusinessLocation {
+    id: string;
+    tenantId: string;
+    name: string;
+    address: string | null;
+    city: string | null;
+    state: string | null;
+    country: string | null;
+    phoneNumber: string | null;
+    email: string | null;
+    /** IANA name. null means the business's own. */
+    timezone: string | null;
+    /** This branch's hours, or null when it keeps the business's. */
+    hours: WeeklyHours | null;
+    /**
+     * This branch's own booking rules, or null when it keeps the business's.
+     *
+     * OPTIONAL, and that is the deploy gate rather than sloppiness: an API
+     * without the column does not send the key at all, and the dashboard reads
+     * its absence as "this build cannot store one" rather than shipping a screen
+     * whose save is a 400. See `location-booking-policy.tsx`.
+     */
+    bookingPolicy?: LocationBookingPolicy | null;
+    latitude: number | null;
+    longitude: number | null;
+    showOnStorefront: boolean;
+    /** Whether customers may collect orders here. Needs an address. */
+    isPickupPoint: boolean;
+    pickupInstructions: string | null;
+    /** Roughly how long until an order is ready to collect. */
+    handoverMinutes: number | null;
+    isDefault: boolean;
+    status: BusinessLocationStatus;
+    sortOrder: number;
+    /** Members scoped to this location specifically. Unscoped members count nowhere. */
+    memberCount?: number;
+    createdAt: string;
+}
+export interface CreateBusinessLocationData {
+    name: string;
+    address?: string;
+    city?: string;
+    state?: string;
+    country?: string;
+    phoneNumber?: string;
+    sortOrder?: number;
+    email?: string | null;
+    timezone?: string | null;
+    hours?: WeeklyHours | null;
+    latitude?: number | null;
+    longitude?: number | null;
+    showOnStorefront?: boolean;
+    isPickupPoint?: boolean;
+    pickupInstructions?: string | null;
+    handoverMinutes?: number | null;
+}

package/dist/api/types/catalog.js

@@ -0,0 +1 @@
+//# sourceMappingURL=catalog.js.map

package/dist/api/types/catalog.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}