@stapel/listings-react 0.3.1 → 0.4.0

package/src/i18n/keys.ts

@@ -144,8 +144,15 @@ export const LISTINGS_I18N_KEYS = {
   mineEmpty: "listings.mine.empty",
   mineRetry: "listings.mine.retry",
   mineCountersFailed: "listings.mine.counters_failed",
-  /** The upstream gap, named on screen — see `headless/MyListings.tsx`. */
-  mineSourceMissing: "listings.mine.source_missing",
+  /** Per-tab empties: "no drafts" and "nothing sold yet" are different
+   * sentences, and one generic "nothing here" says neither. */
+  mineEmptyActive: "listings.mine.empty.active",
+  mineEmptyDrafts: "listings.mine.empty.drafts",
+  mineEmptyArchived: "listings.mine.empty.archived",
+  /** The takedowns — the rows no tab folds in (`my/counters` counts them in
+   * none), shown outside the tabs so they cannot be missed. */
+  mineBlockedTitle: "listings.mine.blocked.title",
+  mineBlockedLoadFailed: "listings.mine.blocked.load_failed",
   mineLiveUnderReview: "listings.mine.live_under_review",
   mineEdit: "listings.mine.edit",
   mineArchive: "listings.mine.archive",
@@ -313,8 +320,13 @@ export const listingsI18nBundleEn: Record<string, string> = {
   "listings.mine.empty": "Nothing here yet",
   "listings.mine.retry": "Try again",
   "listings.mine.counters_failed": "We could not count your listings",
-  "listings.mine.source_missing":
-    "This app cannot list your own listings yet: the listings service has no owner-scoped list endpoint. Your counts below are real.",
+  "listings.mine.empty.active": "Nothing of yours is live or awaiting review",
+  "listings.mine.empty.drafts": "No drafts — anything you start appears here",
+  "listings.mine.empty.archived": "Nothing archived, paused, expired or sold yet",
+  "listings.mine.blocked.title":
+    "{count} of your listings were taken down by moderation",
+  "listings.mine.blocked.load_failed":
+    "We could not check whether any of your listings were taken down",
   "listings.mine.live_under_review":
     "Published, changes under review",
   "listings.mine.edit": "Edit",

package/src/i18n/ru.ts

@@ -37,12 +37,14 @@ export { listingsErrorBundleRu } from "./generated/errors.ru.gen.js";
 export const listingsI18nBundleRu: I18nDictionary = {
   ...listingsErrorBundleRu,
 
-  // ── the 9 stapel_listings-owned codes, pair-authored ─────────────────────
+  // ── the 10 stapel_listings-owned codes, pair-authored ────────────────────
   "error.400.category_required": "Нужно выбрать категорию",
   "error.400.image_required":
     "Чтобы опубликовать объявление, добавьте хотя бы одно фото",
   "error.400.listing_feature_not_allowed":
     "Характеристика «{feature}» не относится к этой категории",
+  "error.400.listing_invalid_status_filter":
+    "Неизвестный статус объявления: «{status}»",
   "error.400.publish_validation_failed":
     "Объявление не прошло проверку и не опубликовано",
   "error.403.listing_not_owner": "Это не ваше объявление",
@@ -177,8 +179,13 @@ export const listingsI18nBundleRu: I18nDictionary = {
   "listings.mine.empty": "Здесь пока пусто",
   "listings.mine.retry": "Повторить",
   "listings.mine.counters_failed": "Не удалось посчитать ваши объявления",
-  "listings.mine.source_missing":
-    "Приложение пока не может перечислить ваши объявления: у сервиса объявлений нет списка, ограниченного владельцем. Счётчики ниже — настоящие.",
+  "listings.mine.empty.active": "Ни одно ваше объявление не опубликовано и не ждёт проверки",
+  "listings.mine.empty.drafts": "Черновиков нет — всё начатое появится здесь",
+  "listings.mine.empty.archived": "Пока ничего не в архиве, не снято, не истекло и не продано",
+  "listings.mine.blocked.title":
+    "Модерация сняла ваших объявлений: {count}",
+  "listings.mine.blocked.load_failed":
+    "Не удалось проверить, снимала ли модерация ваши объявления",
   "listings.mine.live_under_review": "Опубликовано, правки на проверке",
   "listings.mine.edit": "Редактировать",
   "listings.mine.archive": "В архив",

package/src/index.ts

@@ -38,9 +38,10 @@
  *    a grey button and never a hidden one.
  * 4. **An absence is never rendered as a zero.** A soft-deleted listing says
  *    it was removed rather than 404-ing like a typo; a stored feature this
- *    build cannot read is counted rather than dropped; and the owner's own
- *    listings — which stapel-listings 0.6.1 has NO endpoint for — arrive as a
- *    named failure rather than an empty grid (`headless/MyListings.tsx`).
+ *    build cannot read is counted rather than dropped; an empty dashboard tab
+ *    says WHICH emptiness it is; and a moderation takedown — the one status
+ *    `my/counters` counts in no tab at all — is shown outside the tabs rather
+ *    than falling out of the screen (`headless/MyListings.tsx`).
  *
  * ── The seams, and why they are not imports ────────────────────────────────
  *
@@ -88,7 +89,10 @@ export type {
   ListingPageParams,
   ListingStatusInfo,
   MyCounters,
+  MyListingCard,
+  MyListingsParams,
   PaginatedListingCards,
+  PaginatedMyListingCards,
   PublishResponse,
   Schemas,
 } from "./api/types.js";
@@ -97,6 +101,7 @@ export type {
 export {
   MY_LISTINGS_TABS,
   MY_LISTINGS_TAB_STATUSES,
+  MY_LISTINGS_UNTABBED_STATUSES,
   isPubliclyVisible,
   lifecycleCaption,
   listingStatusView,
@@ -112,9 +117,15 @@ export type {
 } from "./model/status.js";
 export { LISTING_TRANSITIONS, canDelete, canTransition } from "./model/transitions.js";
 
-// ── model: the owner-list gap, named ─────────────────────────────────────────
-export { MY_LISTINGS_SOURCE_MISSING } from "./model/mineSource.js";
+// ── model: the owner's own rows ──────────────────────────────────────────────
+export { defaultMyListingsSource } from "./model/mineSource.js";
 export type { MyListingsSource } from "./model/mineSource.js";
+export {
+  myListingImages,
+  myListingPrice,
+  myListingTitle,
+  showsDraft,
+} from "./model/mine.js";
 
 // ── model: the draft twin ────────────────────────────────────────────────────
 export {

package/src/model/mine.ts

@@ -0,0 +1,70 @@
+/**
+ * What an owner's row SAYS, when half its fields may still be a draft.
+ *
+ * A listing carries every user-editable value twice: the `*_draft` twin the
+ * owner is writing, and the published field `publish` promotes it onto. The
+ * public card reads the published half — correct for a shop window, and empty
+ * for a listing that has never been published. A drafts tab built on it is a
+ * column of blank rows.
+ *
+ * So the rule, in one place rather than at three call sites: **show the
+ * published value when there is one, and the draft otherwise.** Not "always
+ * the draft" — a live listing being edited must go on reading as what
+ * strangers currently see, or the seller cannot tell what is on the shelf
+ * from what they are about to put there.
+ *
+ * Pure, so `test/mine.test.tsx` asserts the table directly.
+ */
+import type { MyListingCard } from "../api/types.js";
+
+/** Is this string field's published half absent? `""` counts: the model
+ * declares `title = CharField(blank=True, default="")`, so an unpublished
+ * listing carries the empty string, not `null`. */
+function empty(value: string | null | undefined): boolean {
+  return value === null || value === undefined || value === "";
+}
+
+/**
+ * The row's heading: the published title, the draft title, or `undefined`.
+ *
+ * `undefined` and not the id: a caller that wants "Listing #41" as a last
+ * resort can say so, and one that wants to render a placeholder can do that
+ * instead. Inventing the fallback here would take the choice away.
+ */
+export function myListingTitle(row: MyListingCard): string | undefined {
+  if (!empty(row.title)) return row.title as string;
+  if (!empty(row.title_draft)) return row.title_draft as string;
+  return undefined;
+}
+
+/**
+ * The row's price, published half first. A decimal STRING on the wire
+ * (`DecimalField` → `"200.00"`), passed through untouched — formatting it is
+ * a skin's job and rounding it here would lose the trailing zero a currency
+ * needs.
+ */
+export function myListingPrice(row: MyListingCard): string | undefined {
+  if (!empty(row.price)) return row.price as string;
+  if (!empty(row.price_draft)) return row.price_draft as string;
+  return undefined;
+}
+
+/** The row's images, published half first — `[]` when neither has any. */
+export function myListingImages(row: MyListingCard): readonly string[] {
+  const published = row.images;
+  if (published !== null && published !== undefined && published.length > 0) {
+    return published;
+  }
+  return row.images_draft ?? [];
+}
+
+/**
+ * Is what this row shows the DRAFT rather than what strangers see?
+ *
+ * The half of the rule a person is owed on screen: a row whose title came off
+ * the draft twin is showing something nobody else can read yet, and a skin
+ * that did not mark it would be quietly claiming otherwise.
+ */
+export function showsDraft(row: MyListingCard): boolean {
+  return empty(row.title) && !empty(row.title_draft);
+}

package/src/model/mineSource.ts

@@ -1,55 +1,60 @@
 /**
- * THE GAP: stapel-listings cannot list a person their own listings.
+ * THE GAP, AND THE ROUTE THAT CLOSED IT.
  *
- * This is the one place in the pair where a contract is missing rather than
- * awkward, so it gets its own module and its own name.
+ * This file used to open "stapel-listings cannot list a person their own
+ * listings", and that was the only place in the pair where a contract was
+ * missing rather than awkward. `GET /listings/` answers `qs.published()` and
+ * takes no owner parameter (`views.ListingViewSet.get_queryset`): it returns
+ * the whole marketplace's shop window and can be narrowed to nobody. The only
+ * owner-scoped reads were `my/counters` (three integers) and `my/favorites`,
+ * so a seller's own DRAFTS were unreachable by any call the contract offered
+ * — and drafts are not indexed either, so routing around it through
+ * `@stapel/search-react`'s `owner=` would have returned the published subset
+ * and quietly called it "everything". The dashboard shipped with a
+ * host-injected source and NAMED the absence on screen, because "we cannot
+ * ask" and "you have no listings" are different sentences.
  *
- * `GET /listings/` answers `qs.published()` and takes no owner parameter
- * (`views.ListingViewSet.get_queryset`): it returns the whole marketplace's
- * shop window and can be narrowed to nobody. The only owner-scoped reads in
- * the module are `my/counters` (three integers) and `my/favorites`. So a
- * seller's own DRAFTS are unreachable by any call this contract offers — and
- * drafts are not indexed either, so routing around it through
- * `@stapel/search-react`'s `owner=` would return the published subset and
- * quietly call it "everything".
+ * **stapel-listings 0.7.0 answers it**: `GET /listings/my/listings/`, the
+ * caller's own rows in every status, `?status=` for a tab's set, the same
+ * `IDAnchorPagination` envelope the other two owner reads use. So
+ * {@link defaultMyListingsSource} is what the dashboard runs on now, and
+ * there is no failure state left to name — the missing-source error and its
+ * i18n key are gone rather than kept as a comment about a thing that no
+ * longer happens.
  *
- * The storefront spec assumed `GET /listings/` was "for mine" (§4.1). It is
- * not, and this pair records the gap rather than papering over it.
- *
- * Two upstream asks, in preference order:
- *  1. an `?owner=me` filter (or a `my/listings` action) on the list endpoint,
- *     with the same `IDAnchorPagination` envelope the other two use;
- *  2. failing that, a `status` filter on it, so at least the published subset
- *     can be narrowed without a search module.
- *
- * Until then a host injects a {@link MyListingsSource} and the dashboard
- * works completely; without one it shows the real counters and NAMES the
- * absence, because "we cannot ask" and "you have no listings" are different
- * sentences.
+ * {@link MyListingsSource} stays, as a seam and not as a workaround: a
+ * deployment that keeps its sellers' rows somewhere else (a read model, a
+ * legacy table, a host that has already fetched the page) hands one in and
+ * the dashboard renders it unchanged. What it must return is one page of the
+ * owner card — including the `moderation_status` and the `*_draft` twins,
+ * which is why the type is {@link PaginatedMyListingCards} and not the public
+ * card envelope.
  */
-import { StapelApiError } from "@stapel/core";
-import type { ListingPageParams, PaginatedListingCards } from "../api/types.js";
+import type { ListingsApi } from "../api/listingsApi.js";
+import type { MyListingsParams, PaginatedMyListingCards } from "../api/types.js";
 import type { MyListingsTab } from "./status.js";
-import { LISTINGS_I18N_KEYS } from "../i18n/keys.js";
+import { MY_LISTINGS_TAB_STATUSES } from "./status.js";
 
-/** One page of the caller's own listings, however the host can get them. */
+/** One page of the caller's own listings, however the host gets them. */
 export type MyListingsSource = (args: {
   readonly tab: MyListingsTab;
-  readonly page: ListingPageParams;
+  readonly page: MyListingsParams;
   readonly signal?: AbortSignal;
-}) => Promise<PaginatedListingCards>;
+}) => Promise<PaginatedMyListingCards>;
 
 /**
- * The error a dashboard without a source reports.
+ * The source the dashboard uses unless a host replaces it: the contract's own
+ * route, narrowed to the tab's statuses.
  *
- * `status: 0` on purpose: this is a fact about the deployment's wiring, not
- * something a server said, and a client-side refusal must never be
- * indistinguishable from one that came over the wire.
+ * The tab → statuses table is `MY_LISTINGS_TAB_STATUSES`, which is a copy of
+ * the SERVER's grouping in `views.my_counters`. That is the whole point: the
+ * rows this fetches and the count on the tab beside them are the same set,
+ * asserted upstream (`tests/test_my_listings.py`) and here.
  */
-export const MY_LISTINGS_SOURCE_MISSING: StapelApiError = new StapelApiError({
-  code: LISTINGS_I18N_KEYS.mineSourceMissing,
-  message:
-    "No MyListingsSource was supplied, and stapel-listings has no " +
-    "owner-scoped list endpoint to fall back on.",
-  status: 0,
-});
+export function defaultMyListingsSource(api: ListingsApi): MyListingsSource {
+  return ({ tab, page, signal }) =>
+    api.myListings(
+      { ...page, status: MY_LISTINGS_TAB_STATUSES[tab] },
+      signal !== undefined ? { signal } : {}
+    );
+}

package/src/model/mutations.ts

@@ -27,10 +27,13 @@ import { listingsQueryKeys } from "./queryKeys.js";
  * ── The invalidation rule ──────────────────────────────────────────────────
  *
  * A write that can move `status` or `moderation_status` invalidates the
- * DETAIL, the STATUS probe and the COUNTERS — the counters because their
- * three tabs are defined by status sets (`views.my_counters`), so a publish
- * silently moves a row from "drafts" to "active" and a dashboard that did not
- * refetch would show the old number beside the new row.
+ * DETAIL, the STATUS probe, the COUNTERS and the owner's ROWS — the counters
+ * because their three tabs are defined by status sets (`views.my_counters`),
+ * so a publish silently moves a row from "drafts" to "active" and a dashboard
+ * that did not refetch would show the old number beside the new row; the rows
+ * for the same reason, since stapel-listings 0.7.0 gave them a route and they
+ * are narrowed by exactly those status sets. Invalidating one and not the
+ * other is the shape of the bug where the badge says 2 and the tab shows 3.
  *
  * Nothing here is optimistic except the favourite toggle, and that exception
  * is argued at its own hook.
@@ -46,6 +49,7 @@ function invalidateListing(queryClient: QueryClient, id: number): void {
   void queryClient.invalidateQueries({
     queryKey: listingsQueryKeys.validateDraft(id),
   });
+  void queryClient.invalidateQueries({ queryKey: listingsQueryKeys.allMine() });
 }
 
 /** Start a draft. The server forces `owner` and `status=draft`. */
@@ -63,6 +67,9 @@ export function useCreateDraft(): UseMutationResult<
       void queryClient.invalidateQueries({
         queryKey: listingsQueryKeys.myCounters(),
       });
+      void queryClient.invalidateQueries({
+        queryKey: listingsQueryKeys.allMine(),
+      });
     },
   });
 }

package/src/model/queryKeys.ts

@@ -49,12 +49,17 @@ export const listingsQueryKeys: {
   myFavorites(
     page: ListingPageKey
   ): readonly ["listings", "my", "favorites", ListingPageKey];
-  /** The owner's own rows, per tab — see `headless/MyListings.tsx` for why
-   * this read goes through an injected source. */
+  /** The owner's own rows, per tab (`GET my/listings/?status=…`). */
   mine(
     tab: string,
     page: ListingPageKey
   ): readonly ["listings", "my", "listings", string, ListingPageKey];
+  /** The owner's rows no tab folds in — a takedown. A sibling of `mine` and
+   * not one of its tabs, because it answers a different question and must not
+   * be evicted when a tab pages. */
+  mineUntabbed(): readonly ["listings", "my", "listings", "untabbed"];
+  /** Every owner-row page, for an invalidation after a write. */
+  allMine(): readonly ["listings", "my", "listings"];
   /** `GET /{pk}/validate-draft/` — the dry run of a publish. */
   validateDraft(id: number): readonly ["listings", "validate-draft", number];
   /** Every favourites PAGE, for an invalidation after a toggle — the cursor
@@ -70,6 +75,8 @@ export const listingsQueryKeys: {
   myCounters: () => [ROOT, "my", "counters"],
   myFavorites: (page) => [ROOT, "my", "favorites", page],
   mine: (tab, page) => [ROOT, "my", "listings", tab, page],
+  mineUntabbed: () => [ROOT, "my", "listings", "untabbed"],
+  allMine: () => [ROOT, "my", "listings"],
   validateDraft: (id) => [ROOT, "validate-draft", id],
   allFavorites: () => [ROOT, "my", "favorites"],
   allLists: () => [ROOT, "list"],

package/src/model/status.ts

@@ -29,6 +29,7 @@
  * asserts the whole 9 × 4 table, so a state added upstream is a red test and
  * not a bare enum value on a page.
  */
+import { LISTING_STATUSES } from "../api/types.js";
 import type {
   ListingLifecycleStatus,
   ListingModerationStatus,
@@ -277,3 +278,17 @@ export function tabOf(
   }
   return undefined;
 }
+
+/**
+ * The statuses no tab folds in — `blocked`, and nothing else today.
+ *
+ * DERIVED, not written down a second time: a status added upstream and left
+ * out of the counter groupings lands here automatically and gets shown, which
+ * is the opposite of what a hardcoded `["blocked"]` would do the day it goes
+ * stale. The dashboard renders these rows OUTSIDE the tabs (see
+ * `default/MyListingsPane.tsx`) rather than folding them into one, because a
+ * tab's rows and its `my/counters` badge have to describe the same set — and
+ * `my/counters` counts a takedown in no tab at all.
+ */
+export const MY_LISTINGS_UNTABBED_STATUSES: readonly ListingLifecycleStatus[] =
+  LISTING_STATUSES.filter((status) => tabOf(status) === undefined);