@webx-ui/module-catalog-landings 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 webx-ui
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,52 @@
+# @webx-ui/module-catalog-landings
+
+Landing pages for the catalogue of the [WebX UI](https://github.com/webx-ui/webx-ui) admin panel:
+a category's list — or the whole catalogue's — with a set of filters chosen in advance, under an
+address, texts and an SEO card of its own, with recommended products.
+
+The other half is the Composer package `webx-ui/module-catalog-landings`, which owns the landings,
+their addresses, the rewriting of the filter's links, the storefront's parts, the counts and the
+generation. The section appears in the panel when both halves are installed, beside
+`@webx-ui/module-catalog`.
+
+## Install
+
+```bash
+npm install @webx-ui/module-catalog-landings
+```
+
+```ts
+import { createAdmin } from '@webx-ui/module-admin'
+import { catalog } from '@webx-ui/module-catalog'
+import { catalogLandings } from '@webx-ui/module-catalog-landings'
+import { seo } from '@webx-ui/module-seo'
+import '@webx-ui/module-catalog/style.css'
+import '@webx-ui/module-catalog-landings/style.css'
+
+createAdmin({
+  basePath: '/cms',
+  modules: [...catalog(), ...catalogLandings(), seo()],
+}).mount()
+```
+
+`catalogLandings()` is one section, «Catalog» → «Landings»:
+
+- the list — name and address, the base, the set as chips («Brand: Apple, Dell», «Price: – 50000»),
+  the products, the state and the mark of attention — filtered by the base as a tree (the whole
+  catalogue is a choice of its own), «needs attention», published, empty and the bin;
+- the page of one landing, new at `…/landings/new`: the base, the set builder (a facet the base
+  offers, its values in the controls of the products' filter, the live number of products and a
+  warning when another landing holds the set), the address with the slug the set suggests, the
+  texts above and under the list, the default sort, the collections of the category, the
+  recommended products found by name or SKU and put in order by dragging, the SEO card and the
+  history;
+- «Create in bulk»: bases × the values of one facet, named by templates (`{category}-{value}`),
+  previewed as a table where the rows that would clash — the address or the set taken, no
+  products — are skipped, then made at once or by the queue with its progress.
+
+The SEO card is `@webx-ui/module-seo`'s `wx-seo`, which a panel with landings has. The catalogue's
+`path` moves this section with it: `catalogLandings({ path: '/shop' })`.
+
+## License
+
+MIT

package/dist/GenerateDialog.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/LandingEditorPage.d.ts

@@ -0,0 +1,7 @@
+type __VLS_Props = {
+    base?: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    base: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/LandingProductsField.d.ts

@@ -0,0 +1,9 @@
+type __VLS_PublicProps = {
+    modelValue?: number[] | null;
+};
+declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:modelValue": (value: number[] | null) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    "onUpdate:modelValue"?: ((value: number[] | null) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/LandingSetField.d.ts

@@ -0,0 +1,10 @@
+import { LandingFilters } from './types';
+type __VLS_PublicProps = {
+    modelValue?: LandingFilters | null;
+};
+declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:modelValue": (value: LandingFilters | null) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    "onUpdate:modelValue"?: ((value: LandingFilters | null) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/LandingSlugField.d.ts

@@ -0,0 +1,15 @@
+import { LocalizedValue } from '@webx-ui/core';
+type __VLS_Props = {
+    localized?: boolean;
+};
+type __VLS_PublicProps = {
+    modelValue?: LocalizedValue | string | null;
+} & __VLS_Props;
+declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:modelValue": (value: string | LocalizedValue | null) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    "onUpdate:modelValue"?: ((value: string | LocalizedValue | null) => any) | undefined;
+}>, {
+    localized: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/LandingSortField.d.ts

@@ -0,0 +1,9 @@
+type __VLS_PublicProps = {
+    modelValue?: string | null;
+};
+declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:modelValue": (value: string | null) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    "onUpdate:modelValue"?: ((value: string | null) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/LandingsPage.d.ts

@@ -0,0 +1,7 @@
+type __VLS_Props = {
+    base?: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    base: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/api.d.ts

@@ -0,0 +1,30 @@
+import { AdminContext } from '@webx-ui/module-admin';
+import { BaseFacet, GenerateParams, GeneratePreview, GenerateRun, LandingDetail, LandingFilters, LandingQuery, LandingsPage, SetCount } from './types';
+/** Where the landings answer under the panel's API (§8.4 of the landings spec). */
+export declare const LANDINGS_API = "catalog/landings";
+/** The list's question as a query string; a filter left unset is not sent at all. */
+export declare function landingSearch(query: LandingQuery): URLSearchParams;
+export interface CatalogLandingsApi {
+    list(query?: LandingQuery): Promise<LandingsPage>;
+    get(id: number): Promise<LandingDetail>;
+    create(values: Record<string, unknown>): Promise<LandingDetail>;
+    save(id: number, values: Record<string, unknown>): Promise<LandingDetail>;
+    remove(id: number): Promise<void>;
+    restore(id: number): Promise<LandingDetail>;
+    publish(id: number, on: boolean): Promise<LandingDetail>;
+    count(categoryId: number | null, filters: LandingFilters, except?: number | null): Promise<SetCount>;
+    facets(categoryId: number | null): Promise<BaseFacet[]>;
+    preview(params: GenerateParams): Promise<GeneratePreview>;
+    generate(params: GenerateParams): Promise<GenerateRun>;
+    run(id: number): Promise<GenerateRun>;
+}
+export declare function createLandingsApi(admin: AdminContext): CatalogLandingsApi;
+/** The fields of the form a save sends; what the list shows beside them is not the form's. */
+export declare const FORM_FIELDS: readonly ["category_id", "filters", "name", "slug", "h1", "text_above", "text_below", "sort", "on_category", "position", "recommended", "seo"];
+/** A landing's values as the form holds them. */
+export declare function formValues(detail: LandingDetail): Record<string, unknown>;
+/**
+ * A set without the facets that say nothing — a list with no value, a range with no end — so
+ * that a half-built facet neither counts nor fails a save.
+ */
+export declare function cleanSet(filters: LandingFilters | null | undefined): LandingFilters;

package/dist/editor.d.ts

@@ -0,0 +1,22 @@
+import { InjectionKey, Ref } from 'vue';
+import { ScreenModel } from '@webx-ui/schema';
+import { LandingDetail } from './types';
+/**
+ * What the landing's form shares with the fields of its screen: the set builder reads the base
+ * from the values, the address reads the set's suggestion, the recommended products read the
+ * names the server sent with the ids.
+ */
+export interface LandingEditorContext {
+    /** As the server last answered; `null` for a landing not created yet. */
+    landing: Ref<LandingDetail | null>;
+    values: Ref<ScreenModel>;
+    locked: Ref<boolean>;
+    /** The slugs the set suggests, per language — written by the set builder after each count. */
+    suggested: Ref<Record<string, string>>;
+    /** Where the landings' list is: `/catalog/landings`. */
+    list: string;
+}
+export declare const landingEditorKey: InjectionKey<LandingEditorContext>;
+export declare function provideLandingEditor(context: LandingEditorContext): void;
+/** `null` outside the landing's page — a field put on another screen keeps working on its own. */
+export declare function useLandingEditor(): LandingEditorContext | null;

package/dist/i18n.d.ts

@@ -0,0 +1,4 @@
+/** The server's dictionary for this package: `webx-catalog-landings::`. */
+export declare const NAMESPACE = "webx-catalog-landings";
+/** Puts this package's English under the panel's dictionary, once per panel. */
+export declare function useCatalogLandingsMessages(): void;

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+export { catalogLandings, type CatalogLandingsOptions } from './module';
+export { catalogLandingsMessages } from './messages';
+export { cleanSet, createLandingsApi, formValues, landingSearch, FORM_FIELDS, LANDINGS_API, type CatalogLandingsApi, } from './api';
+export { landingEditorKey, provideLandingEditor, useLandingEditor, type LandingEditorContext, } from './editor';
+export { default as WxCatalogLandingsPage } from './LandingsPage';
+export { default as WxCatalogLandingEditor } from './LandingEditorPage';
+export { default as WxCatalogLandingSet } from './LandingSetField';
+export { default as WxCatalogLandingSlug } from './LandingSlugField';
+export { default as WxCatalogLandingSort } from './LandingSortField';
+export { default as WxCatalogLandingProducts } from './LandingProductsField';
+export type { BaseFacet, GenerateConflict, GenerateParams, GeneratePreview, GenerateRow, GenerateRun, LandingAttention, LandingChip, LandingDetail, LandingFilters, LandingQuery, LandingRow, LandingsPage, RecommendedItem, SetChoice, SetCount, } from './types';