@withpotter/lib 0.13.0-next.101

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

@@ -0,0 +1,398 @@
+import type { PosPermissions } from './devices';
+/**
+ * Template Settings API (draft / saved / published state model) — 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 TemplateSettingsDiff {
+    appearance: {
+        changed: boolean;
+    };
+    pages: Record<string, {
+        slug: string;
+        title: string;
+        changed: boolean;
+        changedSectionIds: string[];
+        seoChanged: boolean;
+        neverPublished: boolean;
+    }>;
+    hasAnyChanges: boolean;
+}
+export type PreviewTokenKind = 'saved' | 'draft';
+export interface PreviewTokenResult {
+    token: string;
+    expiresAt: string;
+    /** Query-string fragment (`?pb_preview=…&pb_preview_token=…`) — dashboard composes the final URL. */
+    url: string;
+}
+export interface OrgMemberResponse {
+    id: string;
+    organizationId: string;
+    accountId?: string;
+    account?: {
+        id: string;
+        email: string;
+        name: string;
+        avatarUrl?: string;
+    };
+    role: 'owner' | 'admin' | 'member';
+    status: 'active' | 'invited' | 'removed';
+    joinedAt?: string;
+    createdAt: string;
+}
+export interface TeamMemberResponse {
+    id: string;
+    tenantId: string;
+    accountId: string | null;
+    role: 'owner' | 'manager' | 'staff' | 'viewer';
+    /** UUID of the assigned team_roles row (custom or system). May be null on legacy rows. */
+    roleId: string | null;
+    /** Display name from team_roles (falls back to the enum-derived label if role is missing). */
+    roleName: string | null;
+    /**
+     * The member's own name. The API has always returned this (see
+     * TeamMemberResponseDto.name) and this type simply omitted it, so every
+     * surface fell back to deriving a name from the email — and rows without an
+     * email, which is most owners, rendered as "Unknown".
+     */
+    name: string | null;
+    /**
+     * When their till passcode was set. Null means they have none.
+     *
+     * The date and never the code, because there is nothing to send back: the
+     * server keeps a hash it cannot reverse, which is the point of a passcode.
+     *
+     * Optional because the api and the dashboard deploy separately — read it
+     * defensively, the same way `avatarUrl` below is read.
+     */
+    posPasscodeSetAt?: string | null;
+    /** What this person may do at a machine. See `PosPermissions`. */
+    posPermissions?: PosPermissions;
+    /**
+     * The person's own picture, off their account.
+     *
+     * Optional because the api and the dashboard deploy separately — read it
+     * defensively. Null for a pending invite: there is no account behind it yet,
+     * so keep the generated mark for those.
+     */
+    avatarUrl?: string | null;
+    /**
+     * Whether this person has two-step verification on.
+     *
+     * `null` where there is nothing to report — a pending invite has no account
+     * yet — so a workspace requiring two-step does not put a red mark against
+     * somebody who has not been asked. Optional because the api and the
+     * dashboard deploy separately: read it defensively.
+     */
+    twoFactorEnabled?: boolean | null;
+    status: 'active' | 'invited' | 'removed';
+    permissions: Record<string, boolean>;
+    effectivePermissions: Record<string, boolean>;
+    email: string;
+    phoneNumber: string | null;
+    inviteEmail: string | null;
+    /**
+     * Which locations this person works at. **Empty means every location** — the
+     * state owners and everyone at a single-site business are in. Never render
+     * an empty list as "no locations".
+     */
+    locationIds: string[];
+    /**
+     * Present only on the invite response. `false` means the member was created
+     * but the invitation email did not go out, so the owner has to be told
+     * rather than shown a success and left wondering why nobody arrived.
+     */
+    inviteEmailSent?: boolean;
+    inviteDelivery?: 'sent' | 'failed';
+    joinedAt: string | null;
+    /**
+     * Last seen using the dashboard. Optional because the api and the dashboard
+     * deploy separately — read it defensively, never assume it is there.
+     */
+    lastActiveAt?: string | null;
+    /** When a pending invite stops working. Optional for the same reason. */
+    inviteExpiresAt?: string | null;
+    createdAt: string;
+}
+/** A tenant-scoped role definition (system or custom). */
+export interface TeamRoleResponse {
+    id: string;
+    tenantId: string;
+    name: string;
+    description: string | null;
+    permissions: Record<string, boolean>;
+    isSystem: boolean;
+    systemKey: 'owner' | 'manager' | 'staff' | 'viewer' | null;
+    memberCount?: number;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * One thing that happened in the workspace.
+ *
+ * Derived, not audited: the API normalises these from timestamped domain rows
+ * (orders, members, content) because no per-action log exists for tenants. So
+ * `actor` is who the record CONCERNS, not who performed the action — a refund
+ * entry names the customer's order, and cannot name the staff member who
+ * pressed refund. Do not label this screen "audit".
+ */
+export interface TeamActivityEntry {
+    /** Source-prefixed and unique across sources, e.g. `order:<uuid>`. */
+    id: string;
+    actor?: {
+        id: string;
+        name: string;
+        email?: string;
+        /**
+         * The person's own picture, off their account. Present only on a
+         * `recorded` entry — a derived one's `actor` is the customer a record is
+         * ABOUT, and giving them a face is how a feed of staff actions comes to
+         * look like it was performed by customers.
+         *
+         * Optional because the api and the dashboard deploy separately.
+         */
+        avatarUrl?: string | null;
+    };
+    /** Machine key, e.g. `order.refunded`, `member.created`. */
+    action: string;
+    summary: string;
+    target?: {
+        type: string;
+        id: string;
+        label?: string;
+    };
+    /**
+     * Whether `actor` PERFORMED the action or is merely who the record is about.
+     *
+     * Optional because the api and the dashboard deploy separately. Absent means
+     * an older api that only ever produced derived entries, so treat it as
+     * 'derived' rather than assuming attribution that was never there.
+     */
+    attribution?: 'recorded' | 'derived';
+    createdAt: string;
+}
+export interface TeamActivityPage {
+    entries: TeamActivityEntry[];
+    /** Pass back as `?cursor=` for older entries; null when exhausted. */
+    nextCursor: string | null;
+}
+/** A single permission key with UI metadata (label + group). */
+export interface PermissionCatalogItem {
+    key: string;
+    label: string;
+    description?: string;
+    group: string;
+}
+export interface PermissionCatalogResponse {
+    items: PermissionCatalogItem[];
+    groups: string[];
+}
+export interface Package {
+    id: number;
+    documentId: string;
+    title: string;
+    slug: string;
+    description: string;
+    shortDescription?: string;
+    price: number;
+    currency: string;
+    image: string | null;
+    featured: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreatePackageInput {
+    title: string;
+    description?: string;
+    shortDescription?: string;
+    price: number;
+    image?: string;
+    featured?: boolean;
+}
+/**
+ * A tenant's settings blob. Known keys are typed; the index signature keeps it
+ * open for the many refinements written elsewhere (salesChannel, contact, bio,
+ * etc.) without forcing every one into this shape.
+ */
+export interface TenantSettings {
+    /**
+     * Whether the always-on flows run for this workspace.
+     *
+     * Three separate keys because they were un-hardcoded at three different
+     * times, by three different builds, and the shapes are the API's — not ours
+     * to tidy from this side. `recovery` and `bookingSettings.reminders` carry
+     * timing alongside the switch; `reviewRequests` is the switch alone.
+     *
+     * Absent means ON everywhere. Each flow ran for every workspace before it
+     * became a setting, and the default has to keep meaning what the constant
+     * did or turning the switch on for the first time would change behaviour for
+     * a merchant who never touched it.
+     */
+    recovery?: {
+        abandonedCart?: {
+            enabled?: boolean;
+            afterHours?: number;
+        };
+    };
+    bookingSettings?: {
+        reminders?: {
+            enabled?: boolean;
+            reminderHours?: number[];
+            emailEnabled?: boolean;
+            smsEnabled?: boolean;
+        };
+    };
+    reviewRequests?: {
+        enabled?: boolean;
+        externalUrl?: string;
+    };
+    /** `doubleOptIn` is on unless this says `false`. */
+    newsletter?: {
+        doubleOptIn?: boolean;
+    };
+    /**
+     * How many marketing messages one person may get, across campaigns and
+     * automations. On unless `enabled` is false; 3 in 24 hours when no figures
+     * are given. Campaigns count toward it and are only held back by it when
+     * `applyToCampaigns` is true.
+     */
+    marketingFrequency?: {
+        enabled?: boolean;
+        maxMessages?: number;
+        perHours?: number;
+        applyToCampaigns?: boolean;
+    };
+    /**
+     * Moves a paid order from Pending to Confirmed by itself. Off unless this says
+     * `true`; in-person orders and cash or transfer orders confirmed by hand are
+     * never touched by it.
+     */
+    autoConfirmPaidOrders?: boolean;
+    businessName?: string;
+    tagline?: string;
+    logo?: {
+        url: string;
+        alternativeText?: string;
+    };
+    email?: string;
+    phone?: string;
+    colors?: {
+        primary?: string;
+        secondary?: string;
+        accent?: string;
+    };
+    /**
+     * ISO 4217, e.g. 'NGN'. Reachable through the index signature before this
+     * line existed, which is why nothing read it and every amount in the app
+     * formatted as dollars. See `setActiveCurrency`.
+     */
+    currency?: string;
+    /**
+     * VAT, as Settings → Taxes writes it. Typed here because the invoice editor
+     * reads it: reachable through the index signature below, it came back `{}`
+     * and every field on it was a type error, which is a good part of why the
+     * setting sat unread for as long as it did.
+     */
+    tax?: {
+        mode?: 'disabled' | 'pass_through' | 'absorb';
+        /** 750 = 7.5%. Null means "use the region's default". */
+        rateBps?: number | null;
+        label?: string | null;
+        customerFacingNote?: string | null;
+        registrationNumber?: string | null;
+    };
+    enabledBehaviors?: string[];
+    hiddenModules?: string[];
+    moduleLabels?: Record<string, string>;
+    moduleOrder?: string[];
+    [key: string]: unknown;
+}
+/**
+ * The single canonical Tenant type for the app. `id` is a UUID string (backend:
+ * @PrimaryKey @Default(UUIDV4) @Column(UUID)) — not a number. auth-context
+ * re-exports this so there is exactly one Tenant shape across the codebase.
+ */
+export interface Tenant {
+    id: string;
+    slug: string;
+    businessName: string;
+    businessLogo?: string;
+    contactEmail?: string;
+    contactPhone?: string;
+    templateId?: string;
+    customDomain?: string;
+    status?: 'active' | 'suspended' | 'pending' | 'deleted';
+    industryKey?: string | null;
+    organizationId?: string;
+    settings?: TenantSettings;
+    /**
+     * Who to ask when your role does not cover something.
+     *
+     * Optional because the api and the dashboard deploy separately — read it
+     * defensively and fall back rather than rendering an empty sentence. Added
+     * to /team/my-tenants in api#416.
+     */
+    ownerName?: string | null;
+}
+export interface TenantUpdateInput {
+    businessName?: string;
+    email?: string;
+    phone?: string;
+    templateId?: string;
+    status?: 'active' | 'suspended' | 'pending';
+    settings?: Record<string, unknown>;
+}
+export interface ContentItem {
+    id: string;
+    tenantId: string;
+    type: string;
+    title: string;
+    slug: string;
+    description?: string;
+    /** Backend uses isActive boolean; status is derived on the frontend */
+    isActive: boolean;
+    featured: boolean;
+    sortOrder: number;
+    price?: number;
+    currency?: string;
+    images?: string[];
+    data: Record<string, unknown>;
+    behaviors?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+    seoTitle?: string;
+    seoDescription?: string;
+    publishedAt?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ContentListResponse {
+    data: ContentItem[];
+    meta?: {
+        pagination?: {
+            page: number;
+            pageSize: number;
+            pageCount: number;
+            total: number;
+        };
+    };
+}
+export interface ContentItemResponse {
+    data: ContentItem;
+}
+export interface CreateContentInput {
+    title: string;
+    slug?: string;
+    description?: string;
+    isActive?: boolean;
+    featured?: boolean;
+    sortOrder?: number;
+    price?: number;
+    currency?: string;
+    images?: string[];
+    data?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+    seoTitle?: string;
+    seoDescription?: string;
+}

package/dist/api/types/templates.js

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

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

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