@withpotter/lib 0.13.0-next.101

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

@@ -0,0 +1,237 @@
+import { type BuyXGetYConfig, type DiscountConditions, type DiscountStatus, type DiscountType } from './crm';
+/**
+ * DISCOUNTS 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 Discount {
+    id: string;
+    tenantId: string;
+    name: string;
+    description: string | null;
+    code: string;
+    discountType: DiscountType;
+    value: number | null;
+    maxDiscountAmount: number | null;
+    buyXGetYConfig: BuyXGetYConfig | null;
+    conditions: DiscountConditions;
+    startsAt: string | null;
+    endsAt: string | null;
+    usageLimit: number | null;
+    usageCount: number;
+    usageLimitPerCustomer: number | null;
+    status: DiscountStatus;
+    autoApply: boolean;
+    isValid: boolean;
+    isExpired: boolean;
+    createdAt: string;
+    updatedAt: string;
+    /**
+     * What this code earned and what it cost, on the orders that stuck.
+     *
+     * Only the LIST hydrates these — one grouped query for the page — so they are
+     * optional, and absent means nobody counted rather than nothing was earned.
+     * `paidOrders` is not `usageCount`: that one counts redemptions including the
+     * orders that were later cancelled.
+     */
+    revenue?: number;
+    savings?: number;
+    paidOrders?: number;
+}
+export interface CreateDiscountData {
+    name: string;
+    description?: string;
+    code: string;
+    discountType: DiscountType;
+    value?: number;
+    maxDiscountAmount?: number;
+    buyXGetYConfig?: BuyXGetYConfig;
+    conditions?: DiscountConditions;
+    startsAt?: string;
+    endsAt?: string;
+    usageLimit?: number;
+    usageLimitPerCustomer?: number;
+    status?: DiscountStatus;
+    autoApply?: boolean;
+}
+export type UpdateDiscountData = Partial<CreateDiscountData>;
+export interface DiscountAnalytics {
+    totalUses: number;
+    totalSavings: number;
+    totalRevenue: number;
+    averageOrderValue: number;
+    uniqueCustomers: number;
+    orders: {
+        id: string;
+        orderNumber: string;
+        customerName: string;
+        customerEmail: string;
+        total: number;
+        discountAmount: number;
+        createdAt: string;
+        status: string;
+    }[];
+    customers: {
+        id: string;
+        name: string;
+        email: string;
+        timesUsed: number;
+        totalSaved: number;
+        lastUsedAt: string;
+    }[];
+    usageOverTime: {
+        date: string;
+        uses: number;
+        revenue: number;
+    }[];
+}
+export interface PaginatedDiscounts {
+    discounts: Discount[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}
+export interface DiscountStats {
+    total: number;
+    active: number;
+    scheduled: number;
+    expired: number;
+    inactive: number;
+    /** Redemptions across every discount; not derivable from a page. */
+    totalUses: number;
+}
+/**
+ * Which optional endpoints the environment this dashboard is talking to
+ * actually serves. Every flag is false on a build that predates the feature,
+ * including one too old to have this endpoint at all, which is why the caller
+ * treats a failed read as "nothing optional is available".
+ */
+export interface ApiFeatures {
+    campaignScheduling: boolean;
+    campaignSearch: boolean;
+    campaignAudienceSend: boolean;
+    discountStats: boolean;
+    /** The passkey ceremonies under /accounts/passkeys. */
+    passkeys: boolean;
+    /** The discounts LIST carries what each code earned and gave away. */
+    discountRevenue: boolean;
+    /** GET /analytics/attribution: revenue by source, medium and campaign. */
+    attributionReport: boolean;
+    /** That report accepts `model=first_touch` without the pipe rejecting it. */
+    attributionModels: boolean;
+    /** GET /analytics/search-terms exists. */
+    searchTerms: boolean;
+    automationsEngine: boolean;
+    /**
+     * The triggers that actually enrol anyone. Shorter than the trigger enum:
+     * some of those have no event behind them yet.
+     */
+    automationTriggers: string[];
+    /** Record a payment taken outside the gateway, and refund one. */
+    bookingManualPayments: boolean;
+    /**
+     * `GET /products?eventFrom=&eventUntil=` and `sortBy=eventDate`.
+     *
+     * The window is what makes an event listing an event listing rather than a
+     * catalogue in date order. Gated because the products query runs
+     * `forbidNonWhitelisted`: sending it to a build that has not got it is a 400
+     * on the whole catalogue, not a filter that quietly does nothing.
+     */
+    eventWindow: boolean;
+    /** GET /products accepts `assigneeId=` — one member's assigned items. */
+    productAssigneeFilter: boolean;
+    /**
+     * GET /products accepts `includeDrafts=true` — drafts alongside published.
+     *
+     * The list is active-only by default and `isActive` cannot ask for both, so
+     * a screen listing drafts beside live items had no single request for it.
+     * Gated for the reason `eventWindow` is: an unknown param is a 400.
+     */
+    includeDrafts: boolean;
+}
+export type GiftCardStatus = 'active' | 'used' | 'expired' | 'cancelled';
+export type GiftCardOccasion = 'general' | 'birthday' | 'thank_you' | 'congratulations';
+export interface GiftCardDesignSnapshot {
+    designId: string | null;
+    name: string;
+    imageUrl: string | null;
+    palette: {
+        background: string;
+        foreground: string;
+        accent: string;
+    };
+    occasion: GiftCardOccasion;
+}
+export interface GiftCardRedemption {
+    id: string;
+    /** Negative on a reversal, e.g. the order it paid for was cancelled. */
+    amount: number;
+    orderId?: string;
+    redeemedAt: string;
+    redeemedBy?: string;
+    note?: string;
+}
+export interface GiftCard {
+    id: string;
+    tenantId: string;
+    code: string;
+    originalAmount: number;
+    balance: number;
+    currency: string;
+    /** Which card design it was issued as. */
+    design?: GiftCardDesignSnapshot | null;
+    redemptions: GiftCardRedemption[];
+    recipientName: string | null;
+    recipientEmail: string | null;
+    personalMessage: string | null;
+    purchaserName: string | null;
+    purchaserEmail: string | null;
+    orderId: string | null;
+    status: GiftCardStatus;
+    expiresAt: string | null;
+    activatedAt: string | null;
+    lastUsedAt: string | null;
+    emailSent: boolean;
+    emailSentAt: string | null;
+    scheduledDeliveryDate: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface GiftCardStats {
+    totalIssued: number;
+    outstanding: number;
+    redeemed: number;
+    activeCards: number;
+}
+export interface CreateGiftCardData {
+    originalAmount: number;
+    currency?: string;
+    design?: GiftCardDesignSnapshot;
+    recipientName?: string;
+    recipientEmail?: string;
+    purchaserName?: string;
+    purchaserEmail?: string;
+    personalMessage?: string;
+    expiresAt?: string;
+    /** Hold delivery until this date, for a card bought ahead of the occasion. */
+    scheduledDeliveryDate?: string;
+}
+export interface UpdateGiftCardData {
+    recipientName?: string;
+    recipientEmail?: string;
+    message?: string;
+    expiresAt?: string;
+}
+export interface GiftCardBalance {
+    valid: boolean;
+    balance?: number;
+    error?: string;
+}
+export type GiftCardBalanceResult = GiftCardBalance;
+export interface PaginatedGiftCards {
+    rows: GiftCard[];
+    count: number;
+}

package/dist/api/types/discounts.js

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

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

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

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

@@ -0,0 +1,258 @@
+import { type DeviceStats, type FunnelStats, type OverviewStats, type SalesStats, type TimeSeriesPoint, type TopContent, type TopPage, type TrafficSource } from './collections';
+import { type CampaignStat, type CustomerStats, type GeoStat, type InventoryStats, type OrderStats, type RecentEvent } from './analytics';
+/**
+ * Filters the API has always accepted and the dashboard never sent — 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 PageDwellTime {
+    pageUrl: string;
+    avgDuration: number;
+    views: number;
+}
+export interface ClientError {
+    pageUrl: string;
+    message: string;
+    count: number;
+    lastSeen: string;
+}
+export interface SessionJourney {
+    sessionId: string;
+    visitorId: string;
+    visitorSessionCount: number;
+    entryPage: string;
+    exitPage: string;
+    startedAt: string;
+    endedAt: string;
+    durationSeconds: number;
+    pageViews: number;
+    eventCount: number;
+    purchased: boolean;
+    completed: boolean;
+}
+export interface ReviewAnalytics {
+    totalApproved: number;
+    totalAll: number;
+    averageRating: number;
+    ratingDistribution: {
+        rating: number;
+        count: number;
+    }[];
+    pendingCount: number;
+    withResponseCount: number;
+    responseRate: number;
+    /**
+     * The AVERAGE RATING per day, with the count that produced it.
+     *
+     * This used to be a count of reviews per day, which is a fact about volume
+     * and cannot answer the question the series is drawn for — whether the rating
+     * is slipping. A busy day and a bad day looked identical. `count` rides along
+     * so a 5.0 from one review reads differently from a 4.6 from forty.
+     */
+    timeSeries: (TimeSeriesPoint & {
+        count?: number;
+    })[];
+    topProducts: {
+        contentId: string;
+        title: string;
+        reviewCount: number;
+        averageRating: number;
+    }[];
+}
+export interface DashboardStats {
+    overview: OverviewStats;
+    sales: SalesStats;
+    topContent: TopContent[];
+    topPages: TopPage[];
+    trafficSources: TrafficSource[];
+    devices: DeviceStats[];
+    geo: GeoStat[];
+    campaigns: CampaignStat[];
+    funnel: FunnelStats;
+    pageViewsTimeSeries: TimeSeriesPoint[];
+    visitorsTimeSeries: TimeSeriesPoint[];
+    sessionsTimeSeries: TimeSeriesPoint[];
+    revenueTimeSeries: TimeSeriesPoint[];
+    bounceRateTimeSeries: TimeSeriesPoint[];
+    recentEvents: RecentEvent[];
+    sessionJourneys?: SessionJourney[];
+    orderStats: OrderStats;
+    channelSales?: {
+        storefront: ChannelSalesMetric;
+        inPerson: ChannelSalesMetric;
+    };
+    walkInCustomers?: WalkInCustomerStats;
+    customerStats: CustomerStats;
+    inventoryStats: InventoryStats;
+    pageDwellTime: PageDwellTime[];
+    clientErrors: ClientError[];
+    reviewStats: ReviewAnalytics;
+}
+export interface WalkInCustomerStats {
+    inPersonSales: number;
+    knownCustomerSales: number;
+    identifiedWalkInProfiles: number;
+    anonymousSales: number;
+    cardSales: number;
+    estimatedCardProfiles: number;
+    transferSales: number;
+    identifiedTransferProfiles: number;
+    cashSales: number;
+    identifiedCashProfiles: number;
+    otherTenderSales: number;
+}
+export interface ChannelSalesMetric {
+    orderCount: number;
+    revenue: number;
+    averageOrderValue: number;
+    revenueTimeSeries?: TimeSeriesPoint[];
+    orderCountTimeSeries?: TimeSeriesPoint[];
+}
+export interface AnalyticsQuery {
+    startDate: string;
+    endDate: string;
+    granularity?: 'hour' | 'day' | 'week' | 'month';
+    limit?: number;
+    /** Only orders that arrived this way, as the order records it. */
+    channel?: string;
+    /** Only orders that belong to this location. */
+    locationId?: string;
+}
+export type OrderStatus = 'pending' | 'confirmed' | 'processing' | 'checked_in' | 'completed' | 'cancelled' | 'refunded';
+export type PaymentStatus = 'unpaid' | 'awaiting_confirmation' | 'paid' | 'partially_refunded' | 'refunded';
+export type FulfillmentStatus = 'unfulfilled' | 'partial'
+/** Pickup only: packed and waiting at the counter. */
+ | 'ready' | 'fulfilled'
+/** Pickup only: the customer has it. */
+ | 'collected' | 'delivered';
+/**
+ * How an order reaches the customer. `none` covers everything that goes
+ * nowhere: a download, a booking, a sale handed over at the counter.
+ */
+export type DeliveryMethod = 'pickup' | 'delivery' | 'shipping' | 'none';
+export interface OrderAddress {
+    firstName: string;
+    lastName: string;
+    company?: string;
+    address1: string;
+    address2?: string;
+    city: string;
+    state: string;
+    postalCode: string;
+    country: string;
+    phone?: string;
+}
+export interface OrderItem {
+    id: string;
+    contentId?: string | null;
+    productId?: string;
+    variantId?: string;
+    sku?: string | null;
+    name?: string;
+    title: string;
+    variant?: {
+        id: string;
+        name: string;
+        [key: string]: unknown;
+    } | null;
+    variantName?: string;
+    quantity: number;
+    unitPrice: number;
+    discount: number;
+    total: number;
+    subtotal?: number;
+    fulfilledQuantity: number;
+    imageUrl?: string | null;
+    /** Active behavior keys (ticketed, bookable, …), flattened by the API. */
+    behaviors?: string[];
+    ticketData?: {
+        tierId: string;
+        tierName: string;
+        tierPrice: number;
+    };
+}
+export interface Order {
+    id: string;
+    tenantId: string;
+    memberId?: string;
+    orderNumber: string;
+    /**
+     * Which branch this order is against. Not the same as `channel`, which is
+     * how the sale arrived. Null only on rows written before branches existed.
+     */
+    locationId?: string | null;
+    /** How it reaches the customer. Null on rows written before methods existed. */
+    deliveryMethod?: DeliveryMethod | null;
+    /**
+     * Which machine rang it, by the merchant's own name for that machine.
+     *
+     * Null online, which is most orders. Optional because the api and the
+     * dashboard deploy separately — read it defensively.
+     */
+    deviceId?: string | null;
+    /** Who was signed in at the machine. A uuid; `operatorName` is the word. */
+    operatorAccountId?: string | null;
+    /** Their name, frozen at the sale, so nothing here resolves a uuid. */
+    operatorName?: string | null;
+    /** The drawer session it passed through. Null when none was open. */
+    shiftId?: string | null;
+    status: OrderStatus;
+    subtotal: number;
+    discountTotal: number;
+    taxTotal: number;
+    shippingTotal: number;
+    total: number;
+    currency: string;
+    paymentStatus: PaymentStatus;
+    paymentMethod?: string;
+    paymentReference?: string;
+    payer?: {
+        name: string | null;
+        accountNumber: string | null;
+        bankName: string | null;
+        cardLast4: string | null;
+    };
+    /**
+     * How much of this order has already been refunded, in major units.
+     *
+     * Detail responses only, and optional because it is newer than the clients
+     * reading it: absent means this dashboard cannot know the remaining balance,
+     * which is a different thing from knowing it is zero.
+     */
+    refundedAmount?: number;
+    fulfillmentStatus: FulfillmentStatus;
+    /** Who is carrying it: a courier, or the rider's name. */
+    carrier?: string | null;
+    trackingNumber?: string | null;
+    trackingUrl?: string | null;
+    /** The day it should arrive, as `YYYY-MM-DD`. Null when nobody promised one. */
+    estimatedDelivery?: string | null;
+    customerEmail: string;
+    customerName?: string;
+    customerPhone?: string;
+    shippingAddress?: OrderAddress;
+    billingAddress?: OrderAddress;
+    customerNote?: string;
+    internalNote?: string;
+    items: OrderItem[];
+    createdAt: string;
+    updatedAt: string;
+    completedAt?: string;
+    cancelledAt?: string;
+    checkIn?: {
+        total: number;
+        checkedIn: number;
+    };
+    /** Free-form order data. Carries `transferClaim` for bank-transfer orders. */
+    data?: Record<string, unknown> | null;
+}
+export interface OrdersListResponse {
+    orders: Order[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}
+export type OrderEventType = 'created' | 'status_changed' | 'payment_changed' | 'fulfillment_changed' | 'refunded' | 'note';

package/dist/api/types/filters.js

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

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

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

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

@@ -0,0 +1,31 @@
+/**
+ * Every response and request shape the dashboard knows, by domain.
+ *
+ * This was one 4,164-line file. Nothing imports from the slices directly —
+ * `@withpotter/lib/api/types` still resolves here and this re-exports all of them, so
+ * none of the ~200 importers changed.
+ */
+export * from './auth';
+export * from './onboarding';
+export * from './templates';
+export * from './bookings';
+export * from './waitlist';
+export * from './collections';
+export * from './analytics';
+export * from './analytics-attribution';
+export * from './operations';
+export * from './record-analytics';
+export * from './filters';
+export * from './orders';
+export * from './customers';
+export * from './tabs';
+export * from './crm';
+export * from './discounts';
+export * from './catalog';
+export * from './locations';
+export * from './campaigns';
+export * from './automation-flow';
+export * from './inquiries';
+export * from './devices';
+export * from './sales-patterns';
+export * from './pos';

package/dist/api/types/index.js

@@ -0,0 +1,25 @@
+export * from "./auth";
+export * from "./onboarding";
+export * from "./templates";
+export * from "./bookings";
+export * from "./waitlist";
+export * from "./collections";
+export * from "./analytics";
+export * from "./analytics-attribution";
+export * from "./operations";
+export * from "./record-analytics";
+export * from "./filters";
+export * from "./orders";
+export * from "./customers";
+export * from "./tabs";
+export * from "./crm";
+export * from "./discounts";
+export * from "./catalog";
+export * from "./locations";
+export * from "./campaigns";
+export * from "./automation-flow";
+export * from "./inquiries";
+export * from "./devices";
+export * from "./sales-patterns";
+export * from "./pos";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/api/types/index.ts"],"sourcesContent":["/**\n * Every response and request shape the dashboard knows, by domain.\n *\n * This was one 4,164-line file. Nothing imports from the slices directly —\n * `@withpotter/lib/api/types` still resolves here and this re-exports all of them, so\n * none of the ~200 importers changed.\n */\n\nexport * from './auth';\nexport * from './onboarding';\nexport * from './templates';\nexport * from './bookings';\nexport * from './waitlist';\nexport * from './collections';\nexport * from './analytics';\nexport * from './analytics-attribution';\nexport * from './operations';\nexport * from './record-analytics';\nexport * from './filters';\nexport * from './orders';\nexport * from './customers';\nexport * from './tabs';\nexport * from './crm';\nexport * from './discounts';\nexport * from './catalog';\nexport * from './locations';\nexport * from './campaigns';\nexport * from './automation-flow';\nexport * from './inquiries';\nexport * from './devices';\nexport * from './sales-patterns';\nexport * from './pos';\n"],"mappings":"AAQA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}