orionplace-react 0.7.8 → 0.8.0

package/README.md

@@ -1,620 +1,13 @@
-# orionplace-react
+# orionplace-react → basklee-react
 
-**A complete Next.js 16 storefront for your Orionplace marketplace, set up with one command.**
+This package is now **[basklee-react](https://www.npmjs.com/package/basklee-react)**. This last release runs
+`basklee-react@latest` with the same command.
 
-`orionplace-react` creates a server-rendered shop connected to your personal
-marketplace API: catalog and search, product pages, cart and checkout, customer
-account, journal and support, in English, Russian and Spanish. The package includes a
-setup CLI and the full storefront source, so every page and component in your
-project is yours to change.
-
-- **Setup CLI:** `init`, `set backend`, `add frontend`, `set mimic`, `sitemap rebuild` and `update`.
-- **Server install:** `install` builds the storefront on your Linux server and
-  runs it as a system service behind nginx with HTTPS.
-- **API gateway:** the browser calls `/api/...` on your own domain; the server
-  forwards it to your marketplace backend with cookies bound to the storefront.
-- **Typed store:** one Application Load request fills it before the first render.
-- **124 storefront components**, each with an English and Russian README
-  ([list](#components)).
-- **Several storefront domains** on one backend, each with its own mapping.
-- **Android app** from the same project with Capacitor 8.
-
-**Contents:** [Quick start](#quick-start-from-zero) ·
-[Existing project](#existing-nextjs-16-project) · [Components](#components) ·
-[Commands](#commands) · [Server install](#install-on-your-server) ·
-[Android app](#android-app) · [Update](#update-an-existing-project)
-
-Requires Node.js 20.9+ and a Node server deployment. Static export and edge-only
-hosting are not supported by this filesystem-based integration; only the Android
-app build below is a static export.
-
-## Android app
-
-The same project builds as an Android app with Capacitor 8. Set
-`ORIONPLACE_APP_ORIGIN` to your deployed public storefront (HTTPS) for that
-build: `androidAppConfig` in `next.config.ts` (`orionplace/runtime/app.mjs`)
-then makes `next build` a static export of one app page to `out/`. The page runs
-the same route table as the website's server pages
-(`app/_storefront/storefrontRoutes.tsx`) in the app, and every API request goes
-to `<origin>/api/...` through Capacitor's native HTTP with the storefront
-Origin (`lib/orionplace/nativeApp.ts`). With the `@capacitor/app` plugin
-installed, the Android back button closes an open dialog, opens the previous
-page, or leaves the app on the first page. With `@capacitor/filesystem` and
-`@capacitor/share`, a purchased file is saved in the app and opened from the
-Android share sheet. Without the variable the website
-build is unchanged. Setup, build and release steps:
-[Android app guide](https://orionmarket.place/en/sandbox/android-app?framework=react).
-
-```bash
-ORIONPLACE_APP_ORIGIN=https://shop.example.com npx next build
-npx cap sync android
-```
-
-## Asset loading
-
-The starter leaves route chunk selection to the current Next.js route and does
-not add speculative preload links. Storefront image components emit intrinsic
-dimensions or a stable aspect ratio to reserve layout space. Product cards
-include the primary image in server HTML and add secondary images after hover or
-keyboard focus.
-
-## Quick start from zero
-
-Your personal backend domain is already provided in your account at
-[orionmarket.place](https://orionmarket.place). You can change it there.
-Replace `your-project.orionplace.app` below with that domain and
-`shop.example.com` with the public domain of your own storefront.
-With Node.js 20.9+ and npm installed, run this from the parent folder;
-no existing Next.js project is needed:
-
-```bash
-npx --yes orionplace-react init my-marketplace
-cd my-marketplace
-npm install
-npx orionplace-react set backend your-project.orionplace.app
-npx orionplace-react add frontend shop.example.com
-npm run dev
-```
-
-The first command creates the Next.js configuration, the complete App Router
-storefront and its integration README. The first frontend becomes the local
-MIMIC domain. Open the local URL printed by Next.js (normally
-http://localhost:3000). The home page should show the configured catalog and
-storefront content. If it shows the initialization error state, check the domain
-mapping and backend response. The backend command accepts either a hostname or
-its full HTTPS `/api` URL. The frontend command accepts a public hostname or its
-root HTTPS URL.
-
-## Existing Next.js 16 project
-
-```bash
-npm install orionplace-react
-npx orionplace-react init --dry-run
-npx orionplace-react set backend your-project.orionplace.app
-npx orionplace-react add frontend shop.example.com
-npm install
-npm run dev
-```
-
-The CLI preserves unrelated Next.js settings, scripts, and environment variables.
-It supports the App Router in `app/` or `src/app/`, and never replaces your own
-`layout.tsx`, `page.tsx`, global styles or `proxy.ts`. Resolve an existing `/api`
-rewrite, redirect or catch-all route before setup. Projects using the Pages
-Router or `output: 'export'` require manual integration.
-
-No install or postinstall hook changes your application. Only explicitly running
-the CLI writes files. Use `--cwd <directory>` to select a project and `--dry-run`
-to inspect planned changes without writing them.
-
-## Import aliases
-
-Application imports use `@/`. In `tsconfig.json`, merge these entries into
-`compilerOptions.paths` while keeping your other settings:
-
-```json
-{
-	"@/*": ["./*"],
-	"@orionplace-runtime/*": ["./orionplace/runtime/*"]
-}
-```
-
-For a `src/app/` project, use `"@/*": ["./src/*"]` instead. The gateway alias
-still points to the project-root `orionplace/runtime/` directory. Setup writes
-these mappings for new projects and updates unchanged generated configuration.
-If you already own `tsconfig.json`, it is preserved; merge these aliases before
-starting the application. Imports then work at any component directory depth.
-
-<!-- components:start (generated by scripts/generate-package-readme-components.mjs) -->
-## Components
-
-The starter includes **126 storefront components**, copied into
-`components/orionplace/` of your project. Each one has a README in English and Russian
-next to its source that describes its inputs, data and actions.
-
-### Storefront structure
-
-Main pages and the shared storefront frame.
-
-| Component | Name | What it does |
-| --- | --- | --- |
-| **Header** | `StorefrontHeader` | The storefront header and its search, catalog, manufacturer and journal links, locale, currency, account, wishlist and cart controls. |
-| **Storefront logo** | `BrandLogos` | Displays one logo from store.init.logos. |
-| **Product search** | `MainSearch` | A search input with suggestions in the storefront language. |
-| **Language selector** | `MainLanguageSwitcher` | Selects the storefront language and its associated currency and measurement units. |
-| **Currency selector** | `MainCurrencySwitcher` | Selects the current storefront currency from the available options. |
-| **Storefront account** | `StorefrontAccount` | Guest sign-in button and signed-in account menu with profile and wallet actions. |
-| **Wallet balance** | `WalletBalance` | Displays the wallet balance in the selected storefront currency. |
-| **Sign-out page** | `StorefrontLogout` | Session sign-out, failure retry and return to the storefront. |
-| **Wishlist button** | `StorefrontWishlistButton` | Displays the wishlist count and links to the wishlist page. |
-| **Cart button** | `StorefrontCartButton` | Displays the cart count and emits a request to open the cart page. |
-| **Cart preview** | `CartPreview` | A compact dropdown under the header's cart button with cart products, quantities and amounts in the selected currency. |
-| **Catalog menu** | `CatalogHeader` | Category navigation with nested sections and representative product cards. |
-| **Catalog representative** | `CatalogRepresentative` | A compact product card used in the catalog menu, with the same navigation, variant, wishlist and purchase actions. |
-| **Storefront home** | `StorefrontHome` | Banners, the optional Popular categories block, product sections, storefront events and recommendations. |
-| **Storefront banners** | `MainBanner` | A carousel of banner images for the current storefront language, with responsive image formats. |
-| **Popular categories block** | `CategoryGroup` | Optional home-page block of public category tiles. |
-| **Product group** | `ProductGroup` | Displays a collection of product cards with images, prices, variant selection and purchase controls. |
-| **Product card** | `ProductCard` | Combines a product’s image, name, price, variants, wishlist button and purchase controls in one card. |
-| **Product photo viewer** | `HoverImageViewer` | A separate product photo viewer with dot buttons: it switches photos with the pointer, with a swipe and from the keyboard, and a click passes the chosen photo's address to the application. |
-| **Product card title** | `ProductCardTitle` | Displays the localized product name in the card. |
-| **Product card description** | `ProductCardDescription` | Displays the localized short product description as plain text, with HTML tags removed. |
-| **Product card badges** | `ProductCardBadges` | Marks new, popular, good-deal and low-stock products with badges in the card. |
-| **Product card wishlist button** | `ProductCardFavorite` | Requests adding or removing the product from the wishlist; the supplied storefront sends guests to sign-in. |
-| **Seller in the product card** | `ProductCardSeller` | Displays the product seller’s name and rating in the card. |
-| **Product card rating** | `ProductCardRating` | Displays the product’s average rating and review count in the card. |
-| **Product card variants** | `ProductCardVariants` | Selects a primary or secondary product variant. |
-| **Secondary variant selector** | `ProductSecondaryVariantModal` | Shows primary and secondary product choices in a modal and can continue the selected purchase action. |
-| **Product card price** | `ProductCardPrice` | Displays the price in the selected currency and the original price when the product is discounted. |
-| **Low-stock notice** | `ProductCardStockNotice` | Warns that the product will soon run out of stock. |
-| **Product card purchase controls** | `ProductCardActions` | Product-card controls for the cart, quantity, availability notifications and preorder when available. |
-| **Preorder dialog** | `ProductPreorderDialog` | The selected product and contact details for a preorder request. |
-| **Storefront events** | `EventsBlock` | A full-width carousel of layout-event images for the current storefront language, with responsive image formats. |
-| **Event block and promotion enrollment** | `EventEnrollmentDialog` | Displaying the event block and opening promotion enrollment from the selected event. |
-| **Footer** | `StorefrontFooter` | Store identity, navigation, a contact-page link and social links. |
-| **Social links** | `SocialLinks` | Display the store’s published social links and icons. |
-| **Error page** | `StorefrontErrorPage` | Page-not-found (404) and failure (500) page with Home, Catalog and Retry actions. |
-| **Storefront theme** | `OrionplaceThemeProvider` | Applies the selected light or dark storefront theme and optional color overrides to its content. |
-
-### Catalog and discovery
-
-Browse categories, search results and product sources.
-
-| Component | Name | What it does |
-| --- | --- | --- |
-| **Catalog component** | `StorefrontCatalog` | The component shows store categories, subcategories and product links. |
-| **Category page** | `StorefrontCategory` | A category with its breadcrumb path, subcategories, filters and paginated product cards. |
-| **Search results** | `ProductSearchResults` | Filters, products, loading and empty states for search, category, seller and recommendation results. |
-| **Search filters** | `SearchFilters` | Price, discount, rating, review, category, seller, manufacturer and variant facets with selectable values and optional result counts. |
-| **Sellers** | `StorefrontSellers` | Seller directory with filters and sorting, and a seller profile with its products. |
-| **Seller filters** | `SellerFilters` | Seller name, minimum rating and category filters for the seller directory. |
-| **Seller summary** | `SellerSummary` | Seller logo, name, rating, selling-since badge, product count and description. |
-| **Seller photos** | `SellerPhotoGallery` | The seller’s approved photos as a square grid with a photo viewer. |
-| **Stores** | `StorefrontStores` | Store addresses, map, phone numbers, opening hours and products. |
-| **Manufacturers and their products** | `StorefrontManufacturers` | Alphabetical index, letter-based lists and manufacturer details. |
-| **Manufacturer index** | `ManufacturerIndex` | Manufacturer logos and letter groups. |
-
-### Products and shopping
-
-Product details, saved items and the cart.
-
-| Component | Name | What it does |
-| --- | --- | --- |
-| **Product details** | `StorefrontProduct` | Loads and displays a published product or a secret-key preview with images, purchase choices, details and reviews. |
-| **Page path** | `OrionplaceBreadcrumbs` | Linked path from the storefront home page through parent categories to the current page. |
-| **Product characteristics** | `ProductSpecificationsDialog` | Every characteristic of the product in a dialog over the page. |
-| **Product reviews** | `ProductReviews` | Reviews, replies, ratings and the user’s submissions. |
-| **Review form** | `ProductReviewForm` | Rating, text and photos for a review or reply. |
-| **Customer review photos** | `ProductReviewGallery` | Review photos for the selected product. |
-| **Review photo viewer** | `ProductReviewImageViewer` | The photos of one review, shown large on the same page. |
-| **Promo code products** | `PromoProducts` | The products a promo code offer applies to, with the offer’s conditions. |
-| **Wishlist and availability notices** | `StorefrontWishlist` | Saved products and products with availability notifications, shown as standard product cards. |
-| **Cart and checkout** | `StorefrontCart` | Cart items, promo codes, delivery, payment and order creation. |
-| **Cart item** | `CartLineItem` | Item name, image, price, quantity and removal. |
-| **Cart item options** | `CartItemOptions` | Option products as product cards, with text and file attachment for an item. |
-| **Checkout details** | `CartCheckoutDetails` | Delivery address, payment method, recipient and comment. |
-| **Shipment delivery selection** | `CartDeliverySelector` | Delivery methods with icons, pickup points and their map for one shipment. |
-| **Delivery map** | `DeliveryMap` | Selectable locations on Yandex Maps for delivery pickup and the store directory. |
-
-### Customer account
-
-Profile, orders, addresses and account activity.
-
-| Component | Name | What it does |
-| --- | --- | --- |
-| **Account sections** | `AccountSection` | Account navigation and sign-in for private storefront sections. |
-| **Personal profile** | `StorefrontProfile` | Account overview and forms for personal details, verified email, notification preferences, avatar, password and account deletion. |
-| **Profile photo** | `ProfileAvatar` | Upload or remove the current account’s avatar. |
-| **Personal details** | `ProfileDetailsForm` | Edit the account holder’s name and date of birth. |
-| **Email and notifications** | `ProfileEmailSettings` | Verify an email address and choose optional email-notification and email-language preferences. |
-| **Account password** | `ProfilePasswordForm` | Create or change the account password. |
-| **Password field** | `OrionplacePasswordInput` | Password input with a button that shows or hides the entered password. |
-| **Delete account** | `ProfileDeleteAccount` | Delete the signed-in customer's own account. |
-| **Account sign-in** | `ProfileSignIn` | Phone-based account sign-in and registration. |
-| **User promo codes** | `AccountPromocodes` | Available promo codes and applying a selected code to the cart. |
-| **My activity** | `AccountActivity` | The user’s promo codes, reviews and sign-in history. |
-| **Sign-in history** | `SignInHistory` | The user’s sign-in dates, devices, browsers and IP addresses. |
-| **User orders** | `StorefrontOrders` | Order history, purchased items, payment, cancellation and repeat. |
-| **Order details** | `OrderDetails` | Order items, shipments, tracking, purchased content and attachments. |
-| **Order payment selection** | `OrderPaymentForm` | Available payment-method selection for an existing order. |
-| **User addresses** | `StorefrontAddresses` | Saved addresses, address editing and default delivery selection. |
-| **Address form** | `AddressForm` | Address creation and editing with country selection, region search, text suggestions and location lookup. |
-| **Value selector** | `OrionplaceSelect` | Selects one value from a labeled list, with keyboard controls, country flags and option icons. |
-| **Search selector** | `OrionplaceSearchSelect` | Selects one value from options searched as the user types, with a loading spinner and retry. |
-| **Wallet and payments** | `StorefrontWallet` | Payment history, balance top-ups and cancellation of unpaid invoices. |
-| **Wallet top-up form** | `WalletTopUpForm` | Amount, currency and payment-method selection for a wallet top-up. |
-| **Payment panel** | `PaymentPanel` | Opens the payment link and lets the user refresh its status. |
-| **Pagination** | `StorefrontPagination` | Previous and next controls with the current page for a returned list. |
-
-### Subscriptions and support
-
-Plans, active subscriptions and support requests.
-
-| Component | Name | What it does |
-| --- | --- | --- |
-| **Subscription plans** | `StorefrontTariffs` | Plans grouped by subscription, with search, sign-in for guests and subscription purchase. |
-| **Subscription plan details** | `StorefrontTariff` | One public plan with its media, description, features, periods, options and subscription purchase. |
-| **Subscription plans** | `TariffCards` | Plan cards in a responsive grid. |
-| **Subscription plan card** | `TariffCard` | A plan card with its image, trial badge, name, description, the modules and limits of the plan, the option chooser, period prices and subscribe actions. |
-| **Plan image** | `TariffCardImage` | The first small plan image. |
-| **Plan name** | `TariffCardTitle` | The tariff name in its card, in the selected language. |
-| **Plan description** | `TariffCardDescription` | The short plan description without HTML tags, and the full description under Details. |
-| **Plan modules, limits and options** | `TariffCardFeatures` | The modules and limits of a plan from `tariff_variables_json`, each with its explanation, and the chooser of the plan options. |
-| **Information hint** | `OrionplaceInfoHint` | Small information button that explains the term beside it. |
-| **Plan prices** | `TariffCardPrices` | The period switcher, the price for the chosen period and the Subscribe and Try actions. |
-| **Plan purchase** | `TariffSubscriptionModal` | Select an option, enter a promotion code and confirm a subscription purchase. |
-| **My subscriptions** | `StorefrontSubscriptions` | Subscription dates, plan, usage, service details, automatic renewal, renewal payment and support. |
-| **Renewal payment** | `SubscriptionExtendDialog` | The period, the promo code and the amount for extending a subscription. |
-| **Automatic renewal** | `SubscriptionRenewalDialog` | The period that is paid automatically, or turning it off. |
-| **Plan and option change** | `SubscriptionChangeDialog` | The new plan or service option, its period and the amount that is charged. |
-| **Subscription cancellation** | `SubscriptionCancelDialog` | The confirmation that stops automatic renewal and keeps the paid period. |
-| **Plan and usage** | `SubscriptionPlanSummary` | The plan picture, description and parameters with the usage the subscription service reported. |
-| **Subscription service details** | `SubscriptionRemoteDetails` | The identifier, confirmation time and host a subscription service returned. |
-| **Support conversations** | `StorefrontSupport` | Customer support conversations for general questions, sellers, order items and subscriptions. |
-| **Conversation messages** | `TicketConversation` | Messages, attachments, conversation closing and support rating. |
-| **Conversation item** | `TicketItemCard` | The purchased item a conversation is about, with its image, variant or option, quantity and paid amount. |
-| **Subscription of a conversation** | `TicketSubscriptionCard` | The subscription a support conversation is about: plan, number, state, paid-until date and automatic renewal. |
-| **Conversation image** | `TicketImage` | Loading and viewing an image from the user’s conversation. |
-| **Support message form** | `TicketMessageForm` | Message text and images for a new conversation or reply. |
-
-### Content and contact
-
-Journal content and customer contact flows.
-
-| Component | Name | What it does |
-| --- | --- | --- |
-| **Journal** | `StorefrontJournal` | Paged journal of store articles with category and author filters. |
-| **Journal article** | `BlogArticle` | An article, subscription access and its discussion. |
-| **Article comments** | `BlogComments` | Discussion, replies and the user’s own comments. |
-| **Comment form** | `BlogCommentForm` | Text for a new comment, reply or edit. |
-| **Blog posts** | `BlogPostGroup` | Publication previews in a grid, list or layout with a lead card. |
-| **Blog post card** | `BlogPostCard` | Publication image, localized title, plain-text preview and reading time. |
-| **Contact page** | `StorefrontContact` | Company contact and registration details, with a form for messaging the store. |
-| **Contact details** | `AboutPage` | Display the store’s published company and contact information. |
-| **Contact form** | `ContactForm` | Sending a question to the store. |
-| **Unsubscribe from emails** | `EmailUnsubscribe` | Confirming an unsubscribe request from an email link. |
-| **Privacy policy page** | `StorefrontPrivacy` | The store’s personal data policy with a cookies section and the operator’s details. |
-| **Cookie notice** | `CookieNotice` | A small notice about the necessary cookies with a link to the cookies section of the policy. |
-
-### Shared interface
-
-Small reusable states and identity elements.
-
-| Component | Name | What it does |
-| --- | --- | --- |
-| **Empty state** | `OrionplaceEmptyState` | Line drawing and message shown when a list, history or search result has no items. |
-| **Avatar** | `OrionplaceAvatar` | Round user photo with initials when no photo is available. |
-| **Storefront image** | `OrionplaceImage` | Loads a safe public image lazily and shows an accessible placeholder when the image is missing or fails. |
-| **Measurement unit selector** | `UnitSwitcher` | Selects a weight or length unit from those available in the storefront. |
-
-<!-- components:end -->
-
-## Commands
-
-```bash
-npx orionplace-react init [directory]
-npx orionplace-react update
-npx orionplace-react set backend your-project.orionplace.app
-npx orionplace-react add frontend shop.example.com
-npx orionplace-react add frontend www.shop.example.com
-npx orionplace-react remove frontend www.shop.example.com
-npx orionplace-react set mimic shop.example.com
-npx orionplace-react sitemap rebuild [shop.example.com]
-npx orionplace-react sitemap status
-sudo npx orionplace-react install
-npx orionplace-react status
-sudo npx orionplace-react restart
-npx orionplace-react help
-```
-
-Either domain command can run first. Both settings are needed for a usable mapping.
-After setup, these npm script aliases are also available:
-
-```bash
-npm run orionplace:backend -- your-project.orionplace.app
-npm run orionplace:add-frontend -- shop.example.com
-npm run orionplace:remove-frontend -- www.shop.example.com
-npm run orionplace:mimic -- shop.example.com
-npm run orionplace:help
-npm run orionplace:update
-npm run orionplace:sitemap
-```
-
-The storefront serves `/robots.txt` and `/sitemap.xml` (public pages, categories,
-products and journal publications in every language). The sitemap is rebuilt
-from the backend once an hour; `npm run orionplace:sitemap` rebuilds it at once,
-for example after new publications, and the running storefront serves it without
-a restart.
-
-`npm set` belongs to npm's own configuration system; use the commands above.
-The setup commands configure local integration files. They do not provision a
-backend, change your account or create DNS records. `install` deploys the
-storefront on your server; see [Install on your server](#install-on-your-server).
-
-## Install on your server
-
-Prepare a Linux server once with the OrionMarketplace server script: it installs
-Node.js, nginx and certbot and adds the `orionplace` command
-([server guide](https://orionmarket.place/en/sandbox/install)).
-
-```bash
-curl -fsSLo orionplace.sh https://orionmarket.place/downloads/orionplace.sh
-sudo sh orionplace.sh setup
-```
-
-Then create the storefront in `/srv/orionplace` and install it:
-
-```bash
-cd /srv/orionplace
-sudo npx --yes orionplace-react init shop
-cd shop
-sudo npm install
-sudo npx orionplace-react install
-```
-
-`install` asks for your backend and storefront domain when they are missing,
-builds the project, runs it as the system service `orionplace-shop` on a free
-local port and connects each storefront domain with nginx and a Let's Encrypt
-certificate. Run it again after code or package updates; the service keeps its
-port. Options: `--name <service>`, `--port <port>`, `--user <user>`,
-`--no-build` (install the build already in the folder), `--no-domains`, `--yes`,
-`--dry-run`. Full guide:
-[Install a storefront](https://orionmarket.place/en/sandbox/install/storefront?framework=react).
-
-### Manage the service
-
-Run these in the project folder, or name the service from anywhere with
-`--name shop`:
-
-```bash
-npx orionplace-react status            # running?, autostart, port, home page answer, domains
-sudo npx orionplace-react start
-sudo npx orionplace-react stop
-sudo npx orionplace-react restart      # waits until the home page answers again
-sudo npx orionplace-react logs 200     # last log lines; --follow keeps reading
-npx orionplace-react list              # every storefront service on this server
-sudo npx orionplace-react uninstall    # stop and remove the service (alias: cleanup)
-```
-
-`start` and `restart` wait up to 90 seconds for the home page and print the
-last log lines when it does not answer. `status` ends with code 3 when the
-storefront is stopped or does not answer, so scripts and monitors can use it.
-`uninstall` (or `cleanup`) stops the service, takes it out of autostart and
-deletes its unit file and registration; the project folder and its build stay.
-With the `orionplace` server tool it runs `orionplace app remove`, which also
-turns the storefront's domains into a placeholder page. `--dry-run` shows what it
-would remove; `--yes` skips the question.
-
-## Generated files
-
-| Path                                    | Purpose                                                                          |
-| --------------------------------------- | -------------------------------------------------------------------------------- |
-| `app/api/[...orionplace]/route.ts`      | Route handler serving `/api/...` from your project.                              |
-| `app/ps3/blog/[...orionplace]/route.ts` | Route handler serving guarded blog images and videos under `/ps3/blog/...`.      |
-| `app/layout.tsx`                        | Awaits initialization and provides the marketplace store.                        |
-| `app/StorefrontShell.tsx`               | Shows initialization failures and mounts storefront content after success.       |
-| `app/page.tsx`, `app/*/page.tsx`        | Server-rendered public and account storefront routes.                            |
-| `app/_storefront/`                      | Route controllers that connect components, navigation and API actions.           |
-| `proxy.ts`                              | Marks personalized pages `private, no-store`.                                    |
-| `lib/orionplace/`                       | Server transport, browser transport, envelope checks and domain resolution.      |
-| `stores/orionplace.ts`                  | Typed snapshot, status, merged discovery and selectors.                          |
-| `stores/orionplaceSelections.ts`        | Current locale, currency and unit choices with availability fallbacks.           |
-| `stores/orionplaceCatalog.ts`           | Categories and subscription plans from initialization or later requests.         |
-| `stores/orionplaceProducts.ts`          | Request-scoped product collections and customer-session product updates.         |
-| `stores/orionplaceBrowse.ts`            | Search choices, selected filters and journal results.                            |
-| `stores/orionplaceScope.ts`             | Creates and synchronizes the stores before child components render.              |
-| `components/orionplace/`                | Maintained React components, styles and bilingual component contracts.           |
-| `themes/orionplace.ts`                  | Light and dark storefront palettes and scoped color overrides.                   |
-| `providers/OrionplaceProvider.tsx`      | Provides one coordinated store scope per browser session.                        |
-| `hooks/useOrionplaceAppLoad.ts`         | Explicit initialize, refresh and reset actions.                                  |
-| `hooks/useOrionplaceApi.ts`             | Browser API client with discovery, CSRF renewal and session refresh.             |
-| `interfaces/orionplace/`                | The Application Load response envelope and every nested model.                   |
-| `orionplace/runtime/marketplace.mjs`    | Commented domain lookup and HTTP transport.                                      |
-| `orionplace/runtime/app.mjs`            | `androidAppConfig`: the Android app build switch for `next.config.ts`.           |
-| `orionplace/README.md`                  | Your settings, API examples, file explanations, verification and VPS deployment. |
-| `orionplace/settings.json`              | Domain values selected by the CLI.                                               |
-| `orionplace/.generated.json`            | File hashes used to preserve your edits on subsequent setup.                     |
-| `sitemaps/shop.example.com.cfg`         | One line: `https://your-project.orionplace.app/api`.                             |
-| `.env`                                  | `MIMIC_FRONT_DOMAIN="shop.example.com"` for localhost.                           |
-
-Projects that use `src/` receive the application source under `src/` instead.
-All generated source is yours to read and customize. Later setup runs preserve
-edited files and report which ones were preserved. Unchanged generated files can
-be refreshed with `npx orionplace-react update`. A manually edited domain file is
-never silently overwritten. Keep the hash manifest in version control.
-
-## Multiple frontend domains
-
-Each frontend gets its own `sitemaps/<domain>.cfg`. `add frontend` preserves other
-domains and can be repeated safely. `set backend` updates every CLI-managed mapping
-to the new personal API; it refuses to overwrite a manually edited mapping.
-
-A new project starts with `MIMIC_FRONT_DOMAIN=""` in `.env`. Setting a backend
-alone leaves it empty. The first added frontend becomes MIMIC; further additions
-preserve that choice. `set mimic <domain>` selects an already-added frontend and
-updates MIMIC without changing any domain mappings. Unknown domains are rejected;
-add them with `add frontend` first.
-
-`help`, `--help`, and `-h` display commands without writing files. The legacy
-`set frontend <domain>` shortcut remains supported: it adds and selects a domain.
-
-`remove frontend <domain>` removes that domain from the list and deletes only its
-unchanged generated `.cfg`. Removing the MIMIC domain selects the first remaining
-domain. Removing the last one clears MIMIC. Unknown or edited mappings cause a
-clear error without changing files. Unrelated configurations remain untouched.
-
-Restart development after domain changes so Next.js reloads `.env`. Production
-reloads mapping files on each API request; reload the process environment when
-changing MIMIC. Configure DNS, TLS, and the hosting proxy for each frontend
-separately.
-
-## Runtime behavior
-
-The hosting proxy must overwrite `X-Front-Domain`, `X-Forwarded-Host`, and `Host`.
-The gateway selects the first valid public domain in that order, with the request
-URL hostname as another fallback. On localhost it uses `MIMIC_FRONT_DOMAIN`.
-An unknown public domain returns `503`; it never uses another domain's mapping.
-
-The corresponding `.cfg` is read on every request. Backend URLs must use HTTPS,
-end in `/api`, and belong to `*.orionplace.app`. API methods, query strings, bodies,
-authorization and cookies are forwarded. Backend statuses are retained and cookie
-Domain attributes are removed to bind cookies to the storefront. Gateway responses
-use `Cache-Control: no-store`, except public blog images and videos: they keep the
-backend's `private, max-age` rule, so the browser does not download them again on
-every page. When the network drops the connection before the backend answers, GET,
-HEAD and Application Load requests are sent once more on a new connection; other
-requests are never repeated. Network failures return `502`.
-
-A changing request (POST, PUT, PATCH, DELETE) from another site is rejected with
-`403`. A request from the page's own host or the storefront domain passes, and the
-backend receives it with the storefront domain's origin
-(`https://shop.example.com`), the one it accepts forms from. So a host that shows
-the storefront through `X-Front-Domain`, such as a preview host or a local port,
-can sign in too.
-
-Browser requests use `/api/...`. Server components call the same gateway in process
-through `lib/orionplace/appLoadServer.ts`, which forwards the current request's
-domain, cookies and language.
-
-Deploy `sitemaps` with the production server, or set an absolute `SITEMAPS_DIR`.
-The production process reads `MIMIC_FRONT_DOMAIN` without rebuilding. Run the
-server from the project root or explicitly point it at the configuration directory.
-
-## Application Load starter
-
-The root layout awaits `POST /api/appload` before the page renders,
-then hands the snapshot to the client provider. `getOrionplaceAppLoad()` is cached
-per render, so a layout and a server component share one request. Client components
-read the same snapshot through the provider's main and domain-store hooks. The
-provider initializes and synchronizes those stores before child components render;
-hydration does not repeat the request. `useOrionplaceAppLoad()` provides explicit
-`initialize`, `refresh` and `reset` actions. Reading a store or hook never starts a
-request, and initialization never opens an authentication prompt.
-
-The requested `?locale` is validated against Application Load before the
-server render. Public product, article and tariff details load through the
-maintained API client. Page metadata uses those returned records and follows
-client navigation and language selection. Home-page event clicks open enrollment
-for the returned event, preserving its return path through sign-in.
-Pages with a canonical address also link the same page in the other storefront languages (`hreflang`) and set `og:type` and `og:locale`; a journal article adds its publication date (`article:published_time`) and schema.org `BlogPosting` data. The store icon (`logos.ico`) is the page's `<link rel="icon">`. An unknown `?locale` opens the default language.
-
-List pages (journal, categories, stores) link their previous and next pages as real links (`?page=2`). Each later page has its own canonical address and a title with its page number; a journal page past the last one answers 404.
-
-`StorefrontShell` mounts the header, route content and footer after Application
-Load succeeds. If initialization fails, it shows `StorefrontErrorPage`; Retry
-runs an explicit refresh and remains disabled while that request is pending.
-
-`app/not-found.tsx` shows the native missing-page view for unknown addresses
-and missing records. `app/error.tsx` and `app/global-error.tsx` show the native
-failure view for unhandled errors. Error metadata is localized and excludes the
-page from indexing. Home and Catalog preserve the selected locale; Retry reloads
-the current address. The server snapshot contains the requested locale and its
-currency and unit selections before components render.
-
-Live discovery from `page_data.unauth.paths` and, for a signed-in session,
-`page_data.auth.paths`, is merged into one lookup without mutating the response.
-Discovery describes availability; the backend still checks permissions on each call.
-
-### Session and CSRF cookies
-
-Application Load establishes the guest/customer session and CSRF cookie through HTTP
-`Set-Cookie` headers, not through `page_data.init`. The browser handles the signed
-HttpOnly `sessionid` cookie; never parse, rewrite, log or store its value in the
-store or localStorage. The readable `csrftoken` supplies `X-CSRFToken` for later
-protected requests through the same-origin `/api/` gateway with credentials enabled.
-Read the CSRF cookie again for every action because login can rotate it.
-
-The server render forwards the incoming cookies to the gateway. React Server
-Components cannot write response cookies, so a backend cookie created during that
-render is not relayed to the browser; the browser establishes and updates its own
-session through `/api/...` requests. `requestAppLoad()` returns the raw `Set-Cookie`
-values if you relay them from your own route handler or server action.
-
-Use `POST /api/csrf_renew` with `{}` to renew CSRF, then re-read the cookie.
-The backend signals CSRF rejection with HTTP `419`, or HTTP `403` with
-`page_data.csrf: false`. A `403` without that flag may mean permissions or
-origin rejection. The shared API client renews the token for the next action
-and returns the failed request; the customer retries explicitly. After
-confirmed login/logout, reset and refresh Application Load.
-Those store actions update data; they do not authenticate or delete cookies.
-
-
-When a request returns HTTP `401` while the store is signed in, the shared API
-client clears profile, wallet, authenticated discovery, cart and wishlist counters
-and account fields of cached products, then reloads Application Load as a guest.
-Public data and the current selections remain available during that refresh.
-The failed request is not repeated and no sign-in dialog opens automatically.
-
-## Update an existing project
-
-After the initial setup, use one command to get the latest package and components:
-
-```bash
-npx orionplace-react update
-```
-
-It runs the latest CLI, adds new template files, refreshes unchanged generated
-files, updates the package dependency and runs `npm install` to synchronize the
-lockfile and installed dependencies. Edited files are preserved and listed in the
-output. Review their new versions under `node_modules/orionplace-react/templates`
-or `runtime` and merge your changes manually when needed. Removed upstream files
-are retained locally; the updater does not delete customer source.
-
-Domain mappings, domain settings and `.env` remain unchanged. The command does
-not deploy your application: restart development, or rebuild and redeploy the
-production frontend after updating.
-
-```bash
-npx orionplace-react update --dry-run
-npm run orionplace:update
-```
-
-Dry-run downloads the latest CLI into npm's cache to inspect its templates but
-leaves project files and dependencies unchanged. `update --local` applies the
-version of the CLI being executed instead of fetching the latest CLI; it still
-installs project dependencies. Use this only when intentionally selecting a version.
-
-Updates require the existing `orionplace/settings.json` and `.generated.json`.
-Conflicting untracked files stop the source update before any writes. If dependency
-installation fails after source generation, run `npm install` and retry `update`.
-
-## Documentation
-
-- [Create a Next.js frontend](https://orionmarket.place/en/sandbox/new-project/react)
-- [Marketplace API documentation](https://orionmarket.place/en/sandbox/)
-
-## Development
-
-In this repository checkout, the package demo uses its own
-`packages/orionplace-react/.env` and
-`packages/orionplace-react/sitemaps/<storefront-domain>.cfg`.
-Set the storefront's `MIMIC_FRONT_DOMAIN` and personal backend mapping there.
-See [local demo configuration](DEVELOPMENT.md#local-demo-configuration).
+In a project made with orionplace-react:
 
 ```bash
-npm install
-npm test
-npm pack --dry-run
+npx basklee-react update
 ```
 
-The published tarball includes only the CLI, runtime source, README, license,
-starter templates, and package metadata.
+The update renames the project to the new names first (a backup of every changed file goes to
+`.basklee-backup-<date>/`; `--dry-run` lists the changes). New projects: `npx basklee-react init`.