@webx-ui/module-catalog 0.3.0 → 0.5.0

package/dist/BulkParamsDialog.d.ts

@@ -2,7 +2,9 @@ import { BulkActionInfo } from './types';
 /**
  * What a bulk action asks for before it runs — a category, a label — and the last word before it
  * does: how many products it is about to touch. The fields are drawn from what the server said
- * about the action, so a satellite's action gets its dialog without this file knowing it.
+ * about the action, so a satellite's action gets its dialog without this file knowing it: a
+ * param with a `source` is a choice out of that reference book (a label, a brand), and one that is
+ * not required says what choosing nothing does — for `set-brand`, take the brand off.
  */
 type __VLS_Props = {
     action: BulkActionInfo;

package/dist/ColumnValue.d.ts

@@ -0,0 +1,6 @@
+import { ColumnValue } from './types';
+type __VLS_Props = {
+    value: ColumnValue | undefined;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/ToneField.d.ts

@@ -0,0 +1,26 @@
+type __VLS_Props = {
+    options?: Array<{
+        label: string;
+        value: string;
+    }>;
+    disabled?: boolean;
+    ariaLabel?: string;
+};
+type __VLS_PublicProps = {
+    modelValue?: string | null;
+} & __VLS_Props;
+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;
+}>, {
+    disabled: boolean;
+    ariaLabel: string;
+    options: Array<{
+        label: string;
+        value: string;
+    }>;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    root: HTMLDivElement;
+}, HTMLDivElement>;
+export default _default;

package/dist/dictionaries.d.ts

@@ -0,0 +1,32 @@
+import { AdminModule, CategoriesOptions, Messages } from '@webx-ui/module-admin';
+/**
+ * A reference book of the catalogue — labels, stock statuses, brands — as the satellite that owns
+ * it describes it (§4 of the dictionaries spec). Everything else is the same for each.
+ */
+export interface DictionaryOptions {
+    /** The module the server registers: `catalog-labels`. */
+    id: string;
+    /** Its path under the catalogue's, and under the catalogue's API: `labels`. */
+    slug: string;
+    /** The described screen of one record: `catalog.label-form`. */
+    screen: string;
+    /** The facet of the products list that picks a record's products: `label`. */
+    facet: string;
+    /** The satellite's dictionary: `webx-catalog-labels`. */
+    namespace: string;
+    /** The group of it the list's words are in: `label`. */
+    group: string;
+    /** Its English, under the server's until the server's arrives. */
+    messages: Record<string, Messages>;
+    /** Where the catalogue lives in the panel — `catalog({ path })`'s. */
+    catalog?: string;
+}
+/**
+ * The panel's shared category screens for one reference book: the list with its order dragged
+ * and the number of products on each row, and the page of one record, which is the satellite's
+ * described screen. Rights are the catalogue's (decision 8), and "Show its products" is the list
+ * of products narrowed by the satellite's own facet.
+ */
+export declare function dictionaryOptions(options: DictionaryOptions): CategoriesOptions;
+/** A reference book as a section of the panel: one entry, two routes. */
+export declare function dictionarySection(options: DictionaryOptions): AdminModule;

package/dist/editor.d.ts

@@ -1,4 +1,5 @@
 import { InjectionKey, Ref } from 'vue';
+import { ScreenModel } from '@webx-ui/schema';
 import { GalleryVideo } from './galleryVideo';
 import { CategoryRow, ProductImage, ProductRow } from './types';
 /**
@@ -15,6 +16,12 @@ export interface ProductEditorContext {
     images: Ref<ProductImage[]>;
     /** Closed for writing: no permission, or a save in flight. */
     locked: Ref<boolean>;
+    /**
+     * The values of the form as they are right now, edits included — what a satellite's node reads
+     * when it depends on another field: the properties' tab redraws for a main category chosen and
+     * not yet saved. Left out by an editor that has no form around its nodes.
+     */
+    values?: Ref<ScreenModel>;
     /**
      * Video files on their way into the gallery. Kept up here rather than in the gallery field, whose
      * tab is taken down when another is opened — and an upload with it. The field makes its own

package/dist/index.d.ts

@@ -1,6 +1,9 @@
 export { catalog, type CatalogOptions } from './module';
 export { createCatalogApi, productSearch, CATALOG_API, type CatalogApi } from './api';
 export { catalogMessages } from './messages';
+export { dictionaryOptions, dictionarySection, type DictionaryOptions } from './dictionaries';
+export { FACET_PREFIX } from './filters';
+export { TONES, toneBadge, type Tone } from './tones';
 export { provideProductEditor, productEditorKey, useProductEditor, provideCatalogCategoryEditor, categoryEditorKey, useCatalogCategoryEditor, type ProductEditorContext, type CategoryEditorContext, } from './editor';
 export { createGalleryVideo, VIDEO_PURPOSE, type GalleryVideo, type GalleryVideoOptions, type UnfinishedVideo, type VideoJob, type VideoJobStage, } from './galleryVideo';
 export { useCategoryTree, useFacetRegistry, type CategoryTree, type FacetRegistry } from './store';
@@ -14,4 +17,6 @@ export { default as WxCatalogDeletedPage } from './DeletedPage';
 export { default as WxCatalogCategoryField } from './CategoryField';
 export { default as WxCatalogFacetsField } from './FacetsField';
 export { default as WxCatalogGallery } from './GalleryField';
-export type { CategoryDetail, CategoryNode, CategoryRef, CategoryRow, DeletedCategory, DeletedKind, DeletedProduct, FacetChoice, FacetInfo, FacetKind, FacetSetting, ProductColumnInfo, ProductDetail, ProductImage, ProductQuery, ProductVideo, QueuedVideo, ProductRow, ProductSort, ProductState, ProductsPage, SkuHolder, } from './types';
+export { default as WxCatalogToneField } from './ToneField';
+export { default as WxCatalogColumnValue } from './ColumnValue';
+export type { CategoryDetail, CategoryNode, CategoryRef, CategoryRow, ColumnRecord, ColumnValue, DeletedCategory, DeletedKind, DeletedProduct, FacetChoice, FacetInfo, FacetKind, FacetSetting, ProductColumnInfo, ProductDetail, ProductImage, ProductQuery, ProductVideo, QueuedVideo, ProductRow, ProductSort, ProductState, ProductsPage, SkuHolder, } from './types';