@withpotter/lib 0.13.0-next.101

package/dist/admin-newsletter-contacts-api.js

@@ -0,0 +1,20 @@
+import { apiFetch } from "./api";
+const BASE = "/platform-admin/v1/newsletters/contacts";
+const post = (path, body) => apiFetch(`${BASE}${path}`, {
+  method: "POST",
+  body: JSON.stringify(body)
+});
+const adminNewsletterContactsApi = {
+  list: (query) => apiFetch(`${BASE}${query}`),
+  /** Answers with the CSV file's text. */
+  exportCsv: (query) => apiFetch(`${BASE}/export${query}`),
+  get: (id) => apiFetch(`${BASE}/${id}`),
+  deliveries: (id, query) => apiFetch(`${BASE}/${id}/deliveries${query}`),
+  unsubscribe: (id, note) => post(`/${id}/unsubscribe`, { note }),
+  /** Refused with 409 for a bounced, unverified or inactive contact. */
+  resubscribe: (id, note) => post(`/${id}/resubscribe`, { note })
+};
+export {
+  adminNewsletterContactsApi
+};
+//# sourceMappingURL=admin-newsletter-contacts-api.js.map

package/dist/admin-newsletter-contacts-api.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/admin-newsletter-contacts-api.ts"],"sourcesContent":["import { apiFetch } from './api';\nimport type { Delivery } from './admin-newsletter-deliveries-api';\n\nexport type ContactStatus =\n  | 'subscribed'\n  | 'unsubscribed'\n  | 'bounced'\n  | 'unverified'\n  | 'inactive';\nexport type ContactSource = 'account' | 'manual' | 'import';\nexport type UnsubscribedVia = 'link' | 'mailbox' | 'admin';\n\n/** One email address the newsletter can know about, and where it stands. */\nexport interface Contact {\n  id: string;\n  email: string;\n  name: string | null;\n  status: ContactStatus;\n  source: ContactSource;\n  importId: string | null;\n  sourceNote: string | null;\n  accountId: string | null;\n  consent: boolean;\n  unsubscribedAt: string | null;\n  unsubscribedVia: UnsubscribedVia | null;\n  unsubscribedNewsletter: { id: string; subject: string } | null;\n  bouncedAt: string | null;\n  /** What an admin typed when they changed the status by hand. */\n  statusNote: string | null;\n  createdAt: string;\n  segments: { id: string; name: string }[];\n  lastSent: { newsletterId: string; subject: string; sentAt: string } | null;\n}\n\n/** `notEmailable` is unverified and inactive together. */\nexport interface ContactCounts {\n  all: number;\n  subscribed: number;\n  unsubscribed: number;\n  bounced: number;\n  notEmailable: number;\n}\n\nexport interface ContactPage {\n  items: Contact[];\n  total: number;\n  page: number;\n  limit: number;\n  counts: ContactCounts;\n}\n\nexport type ContactDelivery = Delivery & { subject: string };\n\nexport interface ContactDeliveryPage {\n  items: ContactDelivery[];\n  total: number;\n  page: number;\n  limit: number;\n}\n\nconst BASE = '/platform-admin/v1/newsletters/contacts';\nconst post = <T>(path: string, body: unknown) =>\n  apiFetch<T>(`${BASE}${path}`, {\n    method: 'POST',\n    body: JSON.stringify(body),\n  });\n\n/** `query` is a ready query string (\"?status=bounced&page=1\"), or empty. */\nexport const adminNewsletterContactsApi = {\n  list: (query: string) => apiFetch<ContactPage>(`${BASE}${query}`),\n  /** Answers with the CSV file's text. */\n  exportCsv: (query: string) => apiFetch<string>(`${BASE}/export${query}`),\n  get: (id: string) => apiFetch<Contact>(`${BASE}/${id}`),\n  deliveries: (id: string, query: string) =>\n    apiFetch<ContactDeliveryPage>(`${BASE}/${id}/deliveries${query}`),\n  unsubscribe: (id: string, note: string) =>\n    post<Contact>(`/${id}/unsubscribe`, { note }),\n  /** Refused with 409 for a bounced, unverified or inactive contact. */\n  resubscribe: (id: string, note: string) =>\n    post<Contact>(`/${id}/resubscribe`, { note }),\n};\n"],"mappings":"AAAA,SAAS,gBAAgB;AA4DzB,MAAM,OAAO;AACb,MAAM,OAAO,CAAI,MAAc,SAC7B,SAAY,GAAG,IAAI,GAAG,IAAI,IAAI;AAAA,EAC5B,QAAQ;AAAA,EACR,MAAM,KAAK,UAAU,IAAI;AAC3B,CAAC;AAGI,MAAM,6BAA6B;AAAA,EACxC,MAAM,CAAC,UAAkB,SAAsB,GAAG,IAAI,GAAG,KAAK,EAAE;AAAA;AAAA,EAEhE,WAAW,CAAC,UAAkB,SAAiB,GAAG,IAAI,UAAU,KAAK,EAAE;AAAA,EACvE,KAAK,CAAC,OAAe,SAAkB,GAAG,IAAI,IAAI,EAAE,EAAE;AAAA,EACtD,YAAY,CAAC,IAAY,UACvB,SAA8B,GAAG,IAAI,IAAI,EAAE,cAAc,KAAK,EAAE;AAAA,EAClE,aAAa,CAAC,IAAY,SACxB,KAAc,IAAI,EAAE,gBAAgB,EAAE,KAAK,CAAC;AAAA;AAAA,EAE9C,aAAa,CAAC,IAAY,SACxB,KAAc,IAAI,EAAE,gBAAgB,EAAE,KAAK,CAAC;AAChD;","names":[]}

package/dist/admin-newsletter-deliveries-api.d.ts

@@ -0,0 +1,47 @@
+import type { Newsletter } from "./admin-newsletters-api";
+export type DeliveryStatus = "queued" | "sent" | "failed" | "skipped";
+/**
+ * What the recipients list can be narrowed to (`?status=`). `sent`,
+ * `delivered` and `opened` are a funnel: sent counts every email the
+ * provider took (bounces included), delivered every one that reached the
+ * inbox (opened included), opened every one that was opened.
+ */
+export type DeliveryFilter = "sent" | "delivered" | "opened" | "bounced" | "complained" | "failed" | "skipped" | "queued";
+/** How many recipients each filter holds. */
+export type DeliveryOutcomes = Record<DeliveryFilter, number>;
+/**
+ * What the platform's mail service said after taking the message:
+ * `accepted` (the provider took it) or a provider outcome.
+ */
+export type ProviderStatus = "accepted" | "delivered" | "opened" | "bounced" | "failed" | "delayed" | "complained";
+/** One address in one send: what happened to it, and why. */
+export interface Delivery {
+    id: string;
+    newsletterId: string;
+    email: string;
+    name: string | null;
+    accountId: string | null;
+    contactId: string | null;
+    status: DeliveryStatus;
+    /** Null until the provider reports back; absent on an older server. */
+    providerStatus?: ProviderStatus | null;
+    /** Failed: the provider's message. Skipped: why the address was left off. */
+    reason: string | null;
+    attempts: number;
+    sentAt: string | null;
+    updatedAt: string;
+}
+export interface DeliveryPage {
+    items: Delivery[];
+    total: number;
+    page: number;
+    limit: number;
+}
+/** `query` is a ready query string ("?status=failed&page=1"), or empty. */
+export declare const adminNewsletterDeliveriesApi: {
+    list: (id: string, query: string) => Promise<DeliveryPage>;
+    /** Answers with the CSV file's text. */
+    exportCsv: (id: string, query: string) => Promise<string>;
+    /** Sends again to these rows. Rows that did not fail are ignored. */
+    retry: (id: string, ids: string[]) => Promise<Newsletter>;
+};

package/dist/admin-newsletter-deliveries-api.js

@@ -0,0 +1,16 @@
+import { apiFetch } from "./api";
+const BASE = "/platform-admin/v1/newsletters";
+const adminNewsletterDeliveriesApi = {
+  list: (id, query) => apiFetch(`${BASE}/${id}/deliveries${query}`),
+  /** Answers with the CSV file's text. */
+  exportCsv: (id, query) => apiFetch(`${BASE}/${id}/deliveries/export${query}`),
+  /** Sends again to these rows. Rows that did not fail are ignored. */
+  retry: (id, ids) => apiFetch(`${BASE}/${id}/deliveries/retry`, {
+    method: "POST",
+    body: JSON.stringify({ ids })
+  })
+};
+export {
+  adminNewsletterDeliveriesApi
+};
+//# sourceMappingURL=admin-newsletter-deliveries-api.js.map

package/dist/admin-newsletter-deliveries-api.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/admin-newsletter-deliveries-api.ts"],"sourcesContent":["import { apiFetch } from \"./api\";\nimport type { Newsletter } from \"./admin-newsletters-api\";\n\nexport type DeliveryStatus = \"queued\" | \"sent\" | \"failed\" | \"skipped\";\n\n/**\n * What the recipients list can be narrowed to (`?status=`). `sent`,\n * `delivered` and `opened` are a funnel: sent counts every email the\n * provider took (bounces included), delivered every one that reached the\n * inbox (opened included), opened every one that was opened.\n */\nexport type DeliveryFilter =\n  | \"sent\"\n  | \"delivered\"\n  | \"opened\"\n  | \"bounced\"\n  | \"complained\"\n  | \"failed\"\n  | \"skipped\"\n  | \"queued\";\n\n/** How many recipients each filter holds. */\nexport type DeliveryOutcomes = Record<DeliveryFilter, number>;\n\n/**\n * What the platform's mail service said after taking the message:\n * `accepted` (the provider took it) or a provider outcome.\n */\nexport type ProviderStatus =\n  | \"accepted\"\n  | \"delivered\"\n  | \"opened\"\n  | \"bounced\"\n  | \"failed\"\n  | \"delayed\"\n  | \"complained\";\n\n/** One address in one send: what happened to it, and why. */\nexport interface Delivery {\n  id: string;\n  newsletterId: string;\n  email: string;\n  name: string | null;\n  accountId: string | null;\n  contactId: string | null;\n  status: DeliveryStatus;\n  /** Null until the provider reports back; absent on an older server. */\n  providerStatus?: ProviderStatus | null;\n  /** Failed: the provider's message. Skipped: why the address was left off. */\n  reason: string | null;\n  attempts: number;\n  sentAt: string | null;\n  updatedAt: string;\n}\n\nexport interface DeliveryPage {\n  items: Delivery[];\n  total: number;\n  page: number;\n  limit: number;\n}\n\nconst BASE = \"/platform-admin/v1/newsletters\";\n\n/** `query` is a ready query string (\"?status=failed&page=1\"), or empty. */\nexport const adminNewsletterDeliveriesApi = {\n  list: (id: string, query: string) =>\n    apiFetch<DeliveryPage>(`${BASE}/${id}/deliveries${query}`),\n  /** Answers with the CSV file's text. */\n  exportCsv: (id: string, query: string) =>\n    apiFetch<string>(`${BASE}/${id}/deliveries/export${query}`),\n  /** Sends again to these rows. Rows that did not fail are ignored. */\n  retry: (id: string, ids: string[]) =>\n    apiFetch<Newsletter>(`${BASE}/${id}/deliveries/retry`, {\n      method: \"POST\",\n      body: JSON.stringify({ ids }),\n    }),\n};\n"],"mappings":"AAAA,SAAS,gBAAgB;AA8DzB,MAAM,OAAO;AAGN,MAAM,+BAA+B;AAAA,EAC1C,MAAM,CAAC,IAAY,UACjB,SAAuB,GAAG,IAAI,IAAI,EAAE,cAAc,KAAK,EAAE;AAAA;AAAA,EAE3D,WAAW,CAAC,IAAY,UACtB,SAAiB,GAAG,IAAI,IAAI,EAAE,qBAAqB,KAAK,EAAE;AAAA;AAAA,EAE5D,OAAO,CAAC,IAAY,QAClB,SAAqB,GAAG,IAAI,IAAI,EAAE,qBAAqB;AAAA,IACrD,QAAQ;AAAA,IACR,MAAM,KAAK,UAAU,EAAE,IAAI,CAAC;AAAA,EAC9B,CAAC;AACL;","names":[]}

package/dist/admin-newsletters-api.d.ts

@@ -0,0 +1,118 @@
+import type { NewsletterSignature } from "./admin-signatures-api";
+import type { DeliveryOutcomes } from "./admin-newsletter-deliveries-api";
+export type { NewsletterSignature };
+export type NewsletterLayout = "plain" | "announcement" | "digest";
+export type NewsletterStatus = "draft" | "sending" | "sent" | "failed" | "cancelled";
+export interface PlainContent {
+    heading: string;
+    body: string;
+}
+export interface AnnouncementContent {
+    imageUrl: string;
+    heading: string;
+    body: string;
+    buttonLabel: string;
+    buttonUrl: string;
+}
+export interface DigestItem {
+    heading: string;
+    text: string;
+    linkLabel: string;
+    linkUrl: string;
+}
+export interface DigestContent {
+    intro: string;
+    items: DigestItem[];
+}
+/**
+ * `content` as it travels: the fields of whichever layout the newsletter has.
+ * A new draft may arrive with none of them, so every field is optional here
+ * and `content.ts` fills the shape before anything reads it.
+ */
+export type NewsletterContent = Partial<PlainContent & AnnouncementContent & DigestContent>;
+export interface NewsletterPerson {
+    id: string;
+    name: string;
+}
+export interface NewsletterCounts {
+    total: number;
+    sent: number;
+    failed: number;
+    skipped: number;
+}
+export interface Newsletter {
+    id: string;
+    subject: string;
+    previewText: string;
+    layout: NewsletterLayout;
+    content: NewsletterContent;
+    status: NewsletterStatus;
+    createdBy: NewsletterPerson | null;
+    updatedBy: NewsletterPerson | null;
+    sentBy: NewsletterPerson | null;
+    createdAt: string;
+    updatedAt: string;
+    sentAt: string | null;
+    counts: NewsletterCounts;
+    /** How many recipients each filter holds. On one newsletter only; absent on an older server. */
+    outcomes?: DeliveryOutcomes;
+    signature: NewsletterSignature | null;
+    /** Who a send went to. Null on a draft, and on a send from before this was kept. */
+    sendMode?: "live" | "admins_only" | null;
+}
+/** The part of a newsletter an admin writes. */
+export type NewsletterDraft = Pick<Newsletter, "subject" | "previewText" | "layout" | "content">;
+/**
+ * What a save sends. `signatureId` copies that saved signature into the
+ * draft, `null` removes it, and leaving it out keeps what the draft has.
+ */
+export type NewsletterPatch = NewsletterDraft & {
+    updatedAt?: string;
+    signatureId?: string | null;
+};
+export interface NewsletterPage {
+    items: Newsletter[];
+    total: number;
+    page: number;
+    limit: number;
+}
+export interface NewsletterAudience {
+    recipients: number;
+    skipped: {
+        unsubscribed: number;
+        unverified: number;
+        inactive: number;
+    };
+    mode: "live" | "admins_only";
+}
+export interface NewsletterPreview {
+    subject: string;
+    previewText: string;
+    html: string;
+}
+export declare const adminNewslettersApi: {
+    list(params: {
+        status?: NewsletterStatus;
+        page: number;
+        limit: number;
+    }): Promise<NewsletterPage>;
+    audience: () => Promise<NewsletterAudience>;
+    get: (id: string) => Promise<Newsletter>;
+    create: (layout: NewsletterLayout) => Promise<Newsletter>;
+    /** Omit `updatedAt` to overwrite whatever the server holds. */
+    update: (id: string, patch: NewsletterPatch, init?: RequestInit) => Promise<Newsletter>;
+    remove: (id: string) => Promise<void>;
+    duplicate: (id: string) => Promise<Newsletter>;
+    preview: (id: string) => Promise<NewsletterPreview>;
+    /** No address: the server sends to the signed-in admin's own. */
+    test: (id: string) => Promise<{
+        sentTo: string;
+    }>;
+    send: (id: string) => Promise<Newsletter>;
+    /** Multipart, one `file` field. Answers with the image's public address. */
+    uploadImage(file: File): Promise<{
+        url: string;
+    }>;
+    cancel: (id: string) => Promise<Newsletter>;
+    retry: (id: string) => Promise<Newsletter>;
+};

package/dist/admin-newsletters-api.js

@@ -0,0 +1,47 @@
+import { apiFetch } from "./api";
+const BASE = "/platform-admin/v1/newsletters";
+const post = (path, body, init) => apiFetch(`${BASE}${path}`, {
+  ...init,
+  method: "POST",
+  body: JSON.stringify(body ?? {})
+});
+const adminNewslettersApi = {
+  list(params) {
+    const qs = new URLSearchParams({
+      page: String(params.page),
+      limit: String(params.limit)
+    });
+    if (params.status) qs.set("status", params.status);
+    return apiFetch(`${BASE}?${qs.toString()}`);
+  },
+  audience: () => apiFetch(`${BASE}/audience`),
+  get: (id) => apiFetch(`${BASE}/${id}`),
+  create: (layout) => post("", { layout }),
+  /** Omit `updatedAt` to overwrite whatever the server holds. */
+  update: (id, patch, init) => apiFetch(`${BASE}/${id}`, {
+    ...init,
+    method: "PATCH",
+    body: JSON.stringify(patch)
+  }),
+  remove: (id) => apiFetch(`${BASE}/${id}`, { method: "DELETE" }),
+  duplicate: (id) => post(`/${id}/duplicate`),
+  preview: (id) => post(`/${id}/preview`),
+  /** No address: the server sends to the signed-in admin's own. */
+  test: (id) => post(`/${id}/test`),
+  send: (id) => post(`/${id}/send`, { confirm: "SEND" }),
+  /** Multipart, one `file` field. Answers with the image's public address. */
+  uploadImage(file) {
+    const body = new FormData();
+    body.append("file", file);
+    return apiFetch(`${BASE}/images`, {
+      method: "POST",
+      body
+    });
+  },
+  cancel: (id) => post(`/${id}/cancel`),
+  retry: (id) => post(`/${id}/retry`)
+};
+export {
+  adminNewslettersApi
+};
+//# sourceMappingURL=admin-newsletters-api.js.map

package/dist/admin-newsletters-api.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/admin-newsletters-api.ts"],"sourcesContent":["import { apiFetch } from \"./api\";\nimport type { NewsletterSignature } from \"./admin-signatures-api\";\nimport type { DeliveryOutcomes } from \"./admin-newsletter-deliveries-api\";\n\nexport type { NewsletterSignature };\n\nexport type NewsletterLayout = \"plain\" | \"announcement\" | \"digest\";\nexport type NewsletterStatus =\n  | \"draft\"\n  | \"sending\"\n  | \"sent\"\n  | \"failed\"\n  | \"cancelled\";\n\nexport interface PlainContent {\n  heading: string;\n  body: string;\n}\n\nexport interface AnnouncementContent {\n  imageUrl: string;\n  heading: string;\n  body: string;\n  buttonLabel: string;\n  buttonUrl: string;\n}\n\nexport interface DigestItem {\n  heading: string;\n  text: string;\n  linkLabel: string;\n  linkUrl: string;\n}\n\nexport interface DigestContent {\n  intro: string;\n  items: DigestItem[];\n}\n\n/**\n * `content` as it travels: the fields of whichever layout the newsletter has.\n * A new draft may arrive with none of them, so every field is optional here\n * and `content.ts` fills the shape before anything reads it.\n */\nexport type NewsletterContent = Partial<\n  PlainContent & AnnouncementContent & DigestContent\n>;\n\nexport interface NewsletterPerson {\n  id: string;\n  name: string;\n}\n\nexport interface NewsletterCounts {\n  total: number;\n  sent: number;\n  failed: number;\n  skipped: number;\n}\n\nexport interface Newsletter {\n  id: string;\n  subject: string;\n  previewText: string;\n  layout: NewsletterLayout;\n  content: NewsletterContent;\n  status: NewsletterStatus;\n  createdBy: NewsletterPerson | null;\n  updatedBy: NewsletterPerson | null;\n  sentBy: NewsletterPerson | null;\n  createdAt: string;\n  updatedAt: string;\n  sentAt: string | null;\n  counts: NewsletterCounts;\n  /** How many recipients each filter holds. On one newsletter only; absent on an older server. */\n  outcomes?: DeliveryOutcomes;\n  signature: NewsletterSignature | null;\n  /** Who a send went to. Null on a draft, and on a send from before this was kept. */\n  sendMode?: \"live\" | \"admins_only\" | null;\n}\n\n/** The part of a newsletter an admin writes. */\nexport type NewsletterDraft = Pick<\n  Newsletter,\n  \"subject\" | \"previewText\" | \"layout\" | \"content\"\n>;\n\n/**\n * What a save sends. `signatureId` copies that saved signature into the\n * draft, `null` removes it, and leaving it out keeps what the draft has.\n */\nexport type NewsletterPatch = NewsletterDraft & {\n  updatedAt?: string;\n  signatureId?: string | null;\n};\n\nexport interface NewsletterPage {\n  items: Newsletter[];\n  total: number;\n  page: number;\n  limit: number;\n}\n\nexport interface NewsletterAudience {\n  recipients: number;\n  skipped: { unsubscribed: number; unverified: number; inactive: number };\n  mode: \"live\" | \"admins_only\";\n}\n\nexport interface NewsletterPreview {\n  subject: string;\n  previewText: string;\n  html: string;\n}\n\nconst BASE = \"/platform-admin/v1/newsletters\";\nconst post = <T>(path: string, body?: unknown, init?: RequestInit) =>\n  apiFetch<T>(`${BASE}${path}`, {\n    ...init,\n    method: \"POST\",\n    body: JSON.stringify(body ?? {}),\n  });\n\nexport const adminNewslettersApi = {\n  list(params: { status?: NewsletterStatus; page: number; limit: number }) {\n    const qs = new URLSearchParams({\n      page: String(params.page),\n      limit: String(params.limit),\n    });\n\n    if (params.status) qs.set(\"status\", params.status);\n\n    return apiFetch<NewsletterPage>(`${BASE}?${qs.toString()}`);\n  },\n  audience: () => apiFetch<NewsletterAudience>(`${BASE}/audience`),\n  get: (id: string) => apiFetch<Newsletter>(`${BASE}/${id}`),\n  create: (layout: NewsletterLayout) => post<Newsletter>(\"\", { layout }),\n  /** Omit `updatedAt` to overwrite whatever the server holds. */\n  update: (id: string, patch: NewsletterPatch, init?: RequestInit) =>\n    apiFetch<Newsletter>(`${BASE}/${id}`, {\n      ...init,\n      method: \"PATCH\",\n      body: JSON.stringify(patch),\n    }),\n  remove: (id: string) => apiFetch<void>(`${BASE}/${id}`, { method: \"DELETE\" }),\n  duplicate: (id: string) => post<Newsletter>(`/${id}/duplicate`),\n  preview: (id: string) => post<NewsletterPreview>(`/${id}/preview`),\n  /** No address: the server sends to the signed-in admin's own. */\n  test: (id: string) => post<{ sentTo: string }>(`/${id}/test`),\n  send: (id: string) => post<Newsletter>(`/${id}/send`, { confirm: \"SEND\" }),\n  /** Multipart, one `file` field. Answers with the image's public address. */\n  uploadImage(file: File) {\n    const body = new FormData();\n\n    body.append(\"file\", file);\n\n    return apiFetch<{ url: string }>(`${BASE}/images`, {\n      method: \"POST\",\n      body,\n    });\n  },\n  cancel: (id: string) => post<Newsletter>(`/${id}/cancel`),\n  retry: (id: string) => post<Newsletter>(`/${id}/retry`),\n};\n"],"mappings":"AAAA,SAAS,gBAAgB;AAmHzB,MAAM,OAAO;AACb,MAAM,OAAO,CAAI,MAAc,MAAgB,SAC7C,SAAY,GAAG,IAAI,GAAG,IAAI,IAAI;AAAA,EAC5B,GAAG;AAAA,EACH,QAAQ;AAAA,EACR,MAAM,KAAK,UAAU,QAAQ,CAAC,CAAC;AACjC,CAAC;AAEI,MAAM,sBAAsB;AAAA,EACjC,KAAK,QAAoE;AACvE,UAAM,KAAK,IAAI,gBAAgB;AAAA,MAC7B,MAAM,OAAO,OAAO,IAAI;AAAA,MACxB,OAAO,OAAO,OAAO,KAAK;AAAA,IAC5B,CAAC;AAED,QAAI,OAAO,OAAQ,IAAG,IAAI,UAAU,OAAO,MAAM;AAEjD,WAAO,SAAyB,GAAG,IAAI,IAAI,GAAG,SAAS,CAAC,EAAE;AAAA,EAC5D;AAAA,EACA,UAAU,MAAM,SAA6B,GAAG,IAAI,WAAW;AAAA,EAC/D,KAAK,CAAC,OAAe,SAAqB,GAAG,IAAI,IAAI,EAAE,EAAE;AAAA,EACzD,QAAQ,CAAC,WAA6B,KAAiB,IAAI,EAAE,OAAO,CAAC;AAAA;AAAA,EAErE,QAAQ,CAAC,IAAY,OAAwB,SAC3C,SAAqB,GAAG,IAAI,IAAI,EAAE,IAAI;AAAA,IACpC,GAAG;AAAA,IACH,QAAQ;AAAA,IACR,MAAM,KAAK,UAAU,KAAK;AAAA,EAC5B,CAAC;AAAA,EACH,QAAQ,CAAC,OAAe,SAAe,GAAG,IAAI,IAAI,EAAE,IAAI,EAAE,QAAQ,SAAS,CAAC;AAAA,EAC5E,WAAW,CAAC,OAAe,KAAiB,IAAI,EAAE,YAAY;AAAA,EAC9D,SAAS,CAAC,OAAe,KAAwB,IAAI,EAAE,UAAU;AAAA;AAAA,EAEjE,MAAM,CAAC,OAAe,KAAyB,IAAI,EAAE,OAAO;AAAA,EAC5D,MAAM,CAAC,OAAe,KAAiB,IAAI,EAAE,SAAS,EAAE,SAAS,OAAO,CAAC;AAAA;AAAA,EAEzE,YAAY,MAAY;AACtB,UAAM,OAAO,IAAI,SAAS;AAE1B,SAAK,OAAO,QAAQ,IAAI;AAExB,WAAO,SAA0B,GAAG,IAAI,WAAW;AAAA,MACjD,QAAQ;AAAA,MACR;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EACA,QAAQ,CAAC,OAAe,KAAiB,IAAI,EAAE,SAAS;AAAA,EACxD,OAAO,CAAC,OAAe,KAAiB,IAAI,EAAE,QAAQ;AACxD;","names":[]}

package/dist/admin-pos-api.d.ts

@@ -0,0 +1,16 @@
+import { type ShiftFilters, type TerminalFilters } from './admin-pos-query';
+import type { PosPage, PosShift, PosSummary, PosTerminal, PosTerminalDetail, PosTerminalHistory, PosWindow, TenantPos } from './admin-pos-types';
+export type TerminalAct = 'suspend' | 'resume' | 'revoke';
+export declare const adminPosApi: {
+    summary: (w?: PosWindow) => Promise<PosSummary>;
+    terminals: (filters?: TerminalFilters) => Promise<PosPage<PosTerminal>>;
+    /** 404 when there is no such terminal. */
+    terminal: (terminalId: string, w?: PosWindow) => Promise<PosTerminalDetail>;
+    history: (terminalId: string) => Promise<PosTerminalHistory>;
+    shifts: (filters?: ShiftFilters) => Promise<PosPage<PosShift>>;
+    tenant: (tenantId: string, w?: PosWindow) => Promise<TenantPos>;
+    /** 409 when the terminal's status no longer allows it. */
+    setTerminalStatus: (terminalId: string, act: TerminalAct, reason: string) => Promise<PosTerminalDetail>;
+    /** Signs the shift out at its till. 409 when it is no longer open. */
+    closeShift: (shiftId: string, reason: string) => Promise<PosShift>;
+};

package/dist/admin-pos-api.js

@@ -0,0 +1,35 @@
+import { apiFetch } from "./api";
+import {
+  shiftsQuery,
+  terminalsQuery,
+  toQuery
+} from "./admin-pos-query";
+const BASE = "/platform-admin/v1/pos";
+const id = (value) => encodeURIComponent(value);
+const post = (path, body) => apiFetch(path, { method: "POST", body: JSON.stringify(body) });
+const windowQuery = (w = {}) => toQuery({ from: w.from, to: w.to });
+const adminPosApi = {
+  summary: (w) => apiFetch(`${BASE}/summary${windowQuery(w)}`),
+  terminals: (filters) => apiFetch(
+    `${BASE}/terminals${terminalsQuery(filters)}`
+  ),
+  /** 404 when there is no such terminal. */
+  terminal: (terminalId, w) => apiFetch(
+    `${BASE}/terminals/${id(terminalId)}${windowQuery(w)}`
+  ),
+  history: (terminalId) => apiFetch(`${BASE}/terminals/${id(terminalId)}/history`),
+  shifts: (filters) => apiFetch(`${BASE}/shifts${shiftsQuery(filters)}`),
+  tenant: (tenantId, w) => apiFetch(
+    `/platform-admin/v1/tenants/${id(tenantId)}/pos${windowQuery(w)}`
+  ),
+  /** 409 when the terminal's status no longer allows it. */
+  setTerminalStatus: (terminalId, act, reason) => post(`${BASE}/terminals/${id(terminalId)}/${act}`, {
+    reason
+  }),
+  /** Signs the shift out at its till. 409 when it is no longer open. */
+  closeShift: (shiftId, reason) => post(`${BASE}/shifts/${id(shiftId)}/close`, { reason })
+};
+export {
+  adminPosApi
+};
+//# sourceMappingURL=admin-pos-api.js.map

package/dist/admin-pos-api.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/admin-pos-api.ts"],"sourcesContent":["import { apiFetch } from './api';\nimport {\n  shiftsQuery,\n  terminalsQuery,\n  toQuery,\n  type ShiftFilters,\n  type TerminalFilters,\n} from './admin-pos-query';\nimport type {\n  PosPage,\n  PosShift,\n  PosSummary,\n  PosTerminal,\n  PosTerminalDetail,\n  PosTerminalHistory,\n  PosWindow,\n  TenantPos,\n} from './admin-pos-types';\n\n/**\n * Terminals and till shifts across every business, as the platform desk\n * works them. Same `apiFetch` and cookie session as the rest of the console;\n * reads need `pos.read`, every action `pos.manage` and a reason. Shapes:\n * `admin-pos-types.ts`.\n */\n\nconst BASE = '/platform-admin/v1/pos';\n\nconst id = (value: string) => encodeURIComponent(value);\n\nconst post = <T>(path: string, body: unknown) =>\n  apiFetch<T>(path, { method: 'POST', body: JSON.stringify(body) });\n\nconst windowQuery = (w: PosWindow = {}) => toQuery({ from: w.from, to: w.to });\n\nexport type TerminalAct = 'suspend' | 'resume' | 'revoke';\n\nexport const adminPosApi = {\n  summary: (w?: PosWindow) =>\n    apiFetch<PosSummary>(`${BASE}/summary${windowQuery(w)}`),\n\n  terminals: (filters?: TerminalFilters) =>\n    apiFetch<PosPage<PosTerminal>>(\n      `${BASE}/terminals${terminalsQuery(filters)}`,\n    ),\n\n  /** 404 when there is no such terminal. */\n  terminal: (terminalId: string, w?: PosWindow) =>\n    apiFetch<PosTerminalDetail>(\n      `${BASE}/terminals/${id(terminalId)}${windowQuery(w)}`,\n    ),\n\n  history: (terminalId: string) =>\n    apiFetch<PosTerminalHistory>(`${BASE}/terminals/${id(terminalId)}/history`),\n\n  shifts: (filters?: ShiftFilters) =>\n    apiFetch<PosPage<PosShift>>(`${BASE}/shifts${shiftsQuery(filters)}`),\n\n  tenant: (tenantId: string, w?: PosWindow) =>\n    apiFetch<TenantPos>(\n      `/platform-admin/v1/tenants/${id(tenantId)}/pos${windowQuery(w)}`,\n    ),\n\n  /** 409 when the terminal's status no longer allows it. */\n  setTerminalStatus: (terminalId: string, act: TerminalAct, reason: string) =>\n    post<PosTerminalDetail>(`${BASE}/terminals/${id(terminalId)}/${act}`, {\n      reason,\n    }),\n\n  /** Signs the shift out at its till. 409 when it is no longer open. */\n  closeShift: (shiftId: string, reason: string) =>\n    post<PosShift>(`${BASE}/shifts/${id(shiftId)}/close`, { reason }),\n};\n"],"mappings":"AAAA,SAAS,gBAAgB;AACzB;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OAGK;AAmBP,MAAM,OAAO;AAEb,MAAM,KAAK,CAAC,UAAkB,mBAAmB,KAAK;AAEtD,MAAM,OAAO,CAAI,MAAc,SAC7B,SAAY,MAAM,EAAE,QAAQ,QAAQ,MAAM,KAAK,UAAU,IAAI,EAAE,CAAC;AAElE,MAAM,cAAc,CAAC,IAAe,CAAC,MAAM,QAAQ,EAAE,MAAM,EAAE,MAAM,IAAI,EAAE,GAAG,CAAC;AAItE,MAAM,cAAc;AAAA,EACzB,SAAS,CAAC,MACR,SAAqB,GAAG,IAAI,WAAW,YAAY,CAAC,CAAC,EAAE;AAAA,EAEzD,WAAW,CAAC,YACV;AAAA,IACE,GAAG,IAAI,aAAa,eAAe,OAAO,CAAC;AAAA,EAC7C;AAAA;AAAA,EAGF,UAAU,CAAC,YAAoB,MAC7B;AAAA,IACE,GAAG,IAAI,cAAc,GAAG,UAAU,CAAC,GAAG,YAAY,CAAC,CAAC;AAAA,EACtD;AAAA,EAEF,SAAS,CAAC,eACR,SAA6B,GAAG,IAAI,cAAc,GAAG,UAAU,CAAC,UAAU;AAAA,EAE5E,QAAQ,CAAC,YACP,SAA4B,GAAG,IAAI,UAAU,YAAY,OAAO,CAAC,EAAE;AAAA,EAErE,QAAQ,CAAC,UAAkB,MACzB;AAAA,IACE,8BAA8B,GAAG,QAAQ,CAAC,OAAO,YAAY,CAAC,CAAC;AAAA,EACjE;AAAA;AAAA,EAGF,mBAAmB,CAAC,YAAoB,KAAkB,WACxD,KAAwB,GAAG,IAAI,cAAc,GAAG,UAAU,CAAC,IAAI,GAAG,IAAI;AAAA,IACpE;AAAA,EACF,CAAC;AAAA;AAAA,EAGH,YAAY,CAAC,SAAiB,WAC5B,KAAe,GAAG,IAAI,WAAW,GAAG,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC;AACpE;","names":[]}

package/dist/admin-pos-query.d.ts

@@ -0,0 +1,43 @@
+import type { PosShiftStatus, PosTerminalStatus } from './admin-pos-types';
+/**
+ * Filters to query strings for the POS lists. Pure, so the rules the API
+ * enforces (limit 1–100, open-over-hours only on open shifts) are tested
+ * here rather than discovered as a 400.
+ */
+export declare const POS_PAGE_SIZE = 25;
+export interface TerminalFilters {
+    status?: PosTerminalStatus | '';
+    /** '' is either; the API takes a boolean. */
+    online?: 'online' | 'offline' | '';
+    tenantId?: string;
+    search?: string;
+    from?: string;
+    to?: string;
+    page?: number;
+    limit?: number;
+}
+export interface ShiftFilters {
+    status?: PosShiftStatus | '';
+    tenantId?: string;
+    /** The terminal's id. */
+    deviceId?: string;
+    openOverHours?: number;
+    page?: number;
+    limit?: number;
+}
+type Value = string | number | boolean | undefined | null;
+/** `?a=1&b=2`, or '' when nothing is set. Empty strings and false are left out. */
+export declare function toQuery(params: Record<string, Value>): string;
+/** A page number the API accepts: a whole number from 1. */
+export declare function clampPage(page: number | undefined): number | undefined;
+/** A page size the API accepts: 1 to 100. */
+export declare function clampLimit(limit: number | undefined): number | undefined;
+export declare function terminalsQuery(f?: TerminalFilters): string;
+/**
+ * `openOverHours` only applies to open shifts, so asking for it makes the
+ * status `open`.
+ */
+export declare function shiftsQuery(f?: ShiftFilters): string;
+/** How many filters narrow the terminal list, for the clear-all control. */
+export declare function activeTerminalFilters(f: TerminalFilters): number;
+export {};

package/dist/admin-pos-query.js

@@ -0,0 +1,55 @@
+const POS_PAGE_SIZE = 25;
+function toQuery(params) {
+  const qs = new URLSearchParams();
+  for (const [key, value] of Object.entries(params)) {
+    if (value === void 0 || value === null || value === "") continue;
+    if (value === false) continue;
+    qs.set(key, String(value));
+  }
+  const q = qs.toString();
+  return q ? `?${q}` : "";
+}
+function clampPage(page) {
+  if (page === void 0 || !Number.isFinite(page)) return void 0;
+  return Math.max(1, Math.floor(page));
+}
+function clampLimit(limit) {
+  if (limit === void 0 || !Number.isFinite(limit)) return void 0;
+  return Math.min(100, Math.max(1, Math.floor(limit)));
+}
+function terminalsQuery(f = {}) {
+  return toQuery({
+    status: f.status,
+    online: f.online === "online" ? true : f.online === "offline" ? "false" : void 0,
+    tenantId: f.tenantId,
+    search: f.search?.trim().slice(0, 100),
+    from: f.from,
+    to: f.to,
+    page: clampPage(f.page),
+    limit: clampLimit(f.limit)
+  });
+}
+function shiftsQuery(f = {}) {
+  const longOpen = f.openOverHours !== void 0 && Number.isFinite(f.openOverHours);
+  return toQuery({
+    status: longOpen ? "open" : f.status,
+    tenantId: f.tenantId,
+    deviceId: f.deviceId,
+    openOverHours: longOpen ? Math.max(0, f.openOverHours) : void 0,
+    page: clampPage(f.page),
+    limit: clampLimit(f.limit)
+  });
+}
+function activeTerminalFilters(f) {
+  return [f.status, f.online, f.tenantId, f.search?.trim()].filter(Boolean).length;
+}
+export {
+  POS_PAGE_SIZE,
+  activeTerminalFilters,
+  clampLimit,
+  clampPage,
+  shiftsQuery,
+  terminalsQuery,
+  toQuery
+};
+//# sourceMappingURL=admin-pos-query.js.map

package/dist/admin-pos-query.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/admin-pos-query.ts"],"sourcesContent":["import type { PosShiftStatus, PosTerminalStatus } from './admin-pos-types';\n\n/**\n * Filters to query strings for the POS lists. Pure, so the rules the API\n * enforces (limit 1–100, open-over-hours only on open shifts) are tested\n * here rather than discovered as a 400.\n */\n\nexport const POS_PAGE_SIZE = 25;\n\nexport interface TerminalFilters {\n  status?: PosTerminalStatus | '';\n  /** '' is either; the API takes a boolean. */\n  online?: 'online' | 'offline' | '';\n  tenantId?: string;\n  search?: string;\n  from?: string;\n  to?: string;\n  page?: number;\n  limit?: number;\n}\n\nexport interface ShiftFilters {\n  status?: PosShiftStatus | '';\n  tenantId?: string;\n  /** The terminal's id. */\n  deviceId?: string;\n  openOverHours?: number;\n  page?: number;\n  limit?: number;\n}\n\ntype Value = string | number | boolean | undefined | null;\n\n/** `?a=1&b=2`, or '' when nothing is set. Empty strings and false are left out. */\nexport function toQuery(params: Record<string, Value>): string {\n  const qs = new URLSearchParams();\n\n  for (const [key, value] of Object.entries(params)) {\n    if (value === undefined || value === null || value === '') continue;\n\n    if (value === false) continue;\n\n    qs.set(key, String(value));\n  }\n\n  const q = qs.toString();\n\n  return q ? `?${q}` : '';\n}\n\n/** A page number the API accepts: a whole number from 1. */\nexport function clampPage(page: number | undefined): number | undefined {\n  if (page === undefined || !Number.isFinite(page)) return undefined;\n\n  return Math.max(1, Math.floor(page));\n}\n\n/** A page size the API accepts: 1 to 100. */\nexport function clampLimit(limit: number | undefined): number | undefined {\n  if (limit === undefined || !Number.isFinite(limit)) return undefined;\n\n  return Math.min(100, Math.max(1, Math.floor(limit)));\n}\n\nexport function terminalsQuery(f: TerminalFilters = {}): string {\n  return toQuery({\n    status: f.status,\n    online:\n      f.online === 'online'\n        ? true\n        : f.online === 'offline'\n          ? 'false'\n          : undefined,\n    tenantId: f.tenantId,\n    search: f.search?.trim().slice(0, 100),\n    from: f.from,\n    to: f.to,\n    page: clampPage(f.page),\n    limit: clampLimit(f.limit),\n  });\n}\n\n/**\n * `openOverHours` only applies to open shifts, so asking for it makes the\n * status `open`.\n */\nexport function shiftsQuery(f: ShiftFilters = {}): string {\n  const longOpen =\n    f.openOverHours !== undefined && Number.isFinite(f.openOverHours);\n\n  return toQuery({\n    status: longOpen ? 'open' : f.status,\n    tenantId: f.tenantId,\n    deviceId: f.deviceId,\n    openOverHours: longOpen\n      ? Math.max(0, f.openOverHours as number)\n      : undefined,\n    page: clampPage(f.page),\n    limit: clampLimit(f.limit),\n  });\n}\n\n/** How many filters narrow the terminal list, for the clear-all control. */\nexport function activeTerminalFilters(f: TerminalFilters): number {\n  return [f.status, f.online, f.tenantId, f.search?.trim()].filter(Boolean)\n    .length;\n}\n"],"mappings":"AAQO,MAAM,gBAAgB;AA2BtB,SAAS,QAAQ,QAAuC;AAC7D,QAAM,KAAK,IAAI,gBAAgB;AAE/B,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,MAAM,GAAG;AACjD,QAAI,UAAU,UAAa,UAAU,QAAQ,UAAU,GAAI;AAE3D,QAAI,UAAU,MAAO;AAErB,OAAG,IAAI,KAAK,OAAO,KAAK,CAAC;AAAA,EAC3B;AAEA,QAAM,IAAI,GAAG,SAAS;AAEtB,SAAO,IAAI,IAAI,CAAC,KAAK;AACvB;AAGO,SAAS,UAAU,MAA8C;AACtE,MAAI,SAAS,UAAa,CAAC,OAAO,SAAS,IAAI,EAAG,QAAO;AAEzD,SAAO,KAAK,IAAI,GAAG,KAAK,MAAM,IAAI,CAAC;AACrC;AAGO,SAAS,WAAW,OAA+C;AACxE,MAAI,UAAU,UAAa,CAAC,OAAO,SAAS,KAAK,EAAG,QAAO;AAE3D,SAAO,KAAK,IAAI,KAAK,KAAK,IAAI,GAAG,KAAK,MAAM,KAAK,CAAC,CAAC;AACrD;AAEO,SAAS,eAAe,IAAqB,CAAC,GAAW;AAC9D,SAAO,QAAQ;AAAA,IACb,QAAQ,EAAE;AAAA,IACV,QACE,EAAE,WAAW,WACT,OACA,EAAE,WAAW,YACX,UACA;AAAA,IACR,UAAU,EAAE;AAAA,IACZ,QAAQ,EAAE,QAAQ,KAAK,EAAE,MAAM,GAAG,GAAG;AAAA,IACrC,MAAM,EAAE;AAAA,IACR,IAAI,EAAE;AAAA,IACN,MAAM,UAAU,EAAE,IAAI;AAAA,IACtB,OAAO,WAAW,EAAE,KAAK;AAAA,EAC3B,CAAC;AACH;AAMO,SAAS,YAAY,IAAkB,CAAC,GAAW;AACxD,QAAM,WACJ,EAAE,kBAAkB,UAAa,OAAO,SAAS,EAAE,aAAa;AAElE,SAAO,QAAQ;AAAA,IACb,QAAQ,WAAW,SAAS,EAAE;AAAA,IAC9B,UAAU,EAAE;AAAA,IACZ,UAAU,EAAE;AAAA,IACZ,eAAe,WACX,KAAK,IAAI,GAAG,EAAE,aAAuB,IACrC;AAAA,IACJ,MAAM,UAAU,EAAE,IAAI;AAAA,IACtB,OAAO,WAAW,EAAE,KAAK;AAAA,EAC3B,CAAC;AACH;AAGO,SAAS,sBAAsB,GAA4B;AAChE,SAAO,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,KAAK,CAAC,EAAE,OAAO,OAAO,EACrE;AACL;","names":[]}

package/dist/admin-pos-types.d.ts

@@ -0,0 +1,122 @@
+/**
+ * The platform-admin POS routes' shapes (api-next `tms-admin`, `src/pos`).
+ *
+ * Every amount is `amountMinor`, a string of minor units at the currency's
+ * own exponent, as Box Money keeps it. Amounts in different currencies are
+ * listed side by side and never added together.
+ */
+export type PosTerminalStatus = 'active' | 'suspended' | 'revoked';
+export type PosShiftStatus = 'open' | 'closed';
+export interface PosMoney {
+    currency: string;
+    amountMinor: string;
+}
+export interface PosTakings {
+    count: number;
+    amounts: PosMoney[];
+}
+export interface PosTenantRef {
+    id: string;
+    name: string;
+}
+export interface PosPage<T> {
+    data: T[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}
+export interface PosSummary {
+    from: string;
+    to: string;
+    /** Every terminal that is not revoked. */
+    terminals: number;
+    online: number;
+    offlineOverDay: number;
+    suspended: number;
+    revoked: number;
+    paymentsCount: number;
+    paymentsAmount: PosMoney[];
+    openShiftsOverTwelveHours: number;
+}
+export interface PosTerminal {
+    id: string;
+    label: string;
+    status: PosTerminalStatus;
+    online: boolean;
+    lastSeenAt: string | null;
+    tenant: PosTenantRef;
+    /** The card terminal vendor and its TID, once an admin has given it one. */
+    provider: string | null;
+    tid: string | null;
+    operatorAccess: 'any_member' | 'assigned';
+    paymentsInPeriod: PosTakings;
+    lastSaleAt: string | null;
+    enrolledAt: string;
+}
+export interface PosOperator {
+    id: string;
+    name: string;
+    role: string;
+    active: boolean;
+}
+export interface PosMachine {
+    model: string | null;
+    serial: string | null;
+    os: string | null;
+    appVersion: string | null;
+}
+export interface PosTerminalDetail extends PosTerminal {
+    machine: PosMachine | null;
+    operators: PosOperator[];
+}
+export interface PosHistoryEntry {
+    at: string;
+    source: 'admin_action' | 'merchant';
+    /** `pos_terminal.suspend` and so on, or a till event (`till.renamed`, …). */
+    event: string;
+    summary: string | null;
+    reason: string | null;
+    by: {
+        type: 'admin' | 'merchant';
+        name: string | null;
+    };
+}
+export interface PosTerminalHistory {
+    terminal: {
+        id: string;
+        label: string;
+    };
+    tenant: PosTenantRef;
+    entries: PosHistoryEntry[];
+}
+export interface PosShift {
+    id: string;
+    tenant: PosTenantRef;
+    /** Label null when the terminal record is gone. */
+    terminal: {
+        id: string;
+        label: string | null;
+    };
+    operatorName: string | null;
+    status: PosShiftStatus;
+    closedReason: string | null;
+    openedAt: string;
+    closedAt: string | null;
+    /** Whole hours open; null once closed. */
+    openHours: number | null;
+    takings: PosTakings;
+    flagged: boolean;
+}
+export interface TenantPos {
+    tenant: PosTenantRef;
+    from: string;
+    to: string;
+    terminals: PosTerminal[];
+    openShifts: PosShift[];
+    takings: PosTakings;
+}
+export interface PosWindow {
+    from?: string;
+    to?: string;
+}

package/dist/admin-pos-types.js

@@ -0,0 +1 @@
+//# sourceMappingURL=admin-pos-types.js.map

package/dist/admin-pos-types.js.map

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