@webx-ui/module-catalog 0.2.0 → 0.4.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/GalleryField.d.ts

@@ -1,2 +1,16 @@
-declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+type __VLS_Props = {
+    /** Videos on this site (`webx-catalog.fields.video`); the server's screen patch says. */
+    video?: boolean;
+    /** What a video file may be, checked before a byte of it is sent. */
+    videoTypes?: string[];
+    /** How large, in bytes. */
+    videoMaxBytes?: number;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    video: boolean;
+    videoTypes: string[];
+    videoMaxBytes: number;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    picker: HTMLInputElement;
+}, HTMLDivElement>;
 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/VideoLinkDialog.d.ts

@@ -0,0 +1,12 @@
+/**
+ * A video by its address, onto a picture of the gallery: a YouTube link, or a direct link to an
+ * MP4 or WebM file the server then downloads in its queue (§5 of the video spec).
+ */
+type __VLS_Props = {
+    product: number;
+    image: number;
+};
+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, {
+    field: HTMLDivElement;
+}, any>;
+export default _default;

package/dist/VideoProgress.d.ts

@@ -0,0 +1,11 @@
+import { GalleryVideo, VideoJob } from './galleryVideo';
+/**
+ * One video on its way into the gallery: what it is doing, and the bar while the file goes up —
+ * the share, the speed and the time left, with pause and cancel beside it.
+ */
+type __VLS_Props = {
+    job: VideoJob;
+    video: GalleryVideo;
+};
+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, {}, HTMLDivElement>;
+export default _default;

package/dist/api.d.ts

@@ -1,7 +1,7 @@
 import { AdminContext } from '@webx-ui/module-admin';
 import { Paginated } from '@webx-ui/core';
 import { ScreenModel } from '@webx-ui/schema';
-import { BulkActionInfo, BulkRun, BulkSelection, CategoryDetail, CategoryNode, CategoryRow, DeletedCategory, DeletedKind, DeletedProduct, FacetRegistryAnswer, ProductDetail, ProductImage, ProductQuery, ProductRow, ProductsPage } from './types';
+import { BulkActionInfo, BulkRun, BulkSelection, CategoryDetail, CategoryNode, CategoryRow, DeletedCategory, DeletedKind, DeletedProduct, FacetRegistryAnswer, ProductDetail, ProductImage, ProductQuery, QueuedVideo, ProductRow, ProductsPage } from './types';
 export interface CatalogApi {
     products(query?: ProductQuery): Promise<ProductsPage>;
     product(id: number): Promise<ProductDetail>;
@@ -15,6 +15,20 @@ export interface CatalogApi {
     /** The whole gallery in its order, with every picture's words (§11.2). */
     saveImages(id: number, images: Pick<ProductImage, 'id' | 'alt' | 'title'>[]): Promise<ProductImage[]>;
     removeImage(id: number, image: number): Promise<void>;
+    /**
+     * An address the server fetches: a picture or a YouTube video comes back as the new row, a
+     * direct link to a video file as `QueuedVideo` — the row appears once the queue has it.
+     */
+    fetchImage(id: number, url: string): Promise<ProductImage | QueuedVideo>;
+    /** A finished chunked upload (`upload` is its id) or an address, onto a picture of the gallery. */
+    attachVideo(id: number, image: number, source: {
+        upload: string;
+        duration?: number | null;
+    } | {
+        url: string;
+    }): Promise<ProductImage | QueuedVideo>;
+    /** The file, if it is one, is deleted at once. */
+    detachVideo(id: number, image: number): Promise<ProductImage>;
     categories(): Promise<CategoryNode[]>;
     category(id: number): Promise<CategoryDetail>;
     createCategory(values: ScreenModel, parent: number | null): Promise<CategoryDetail>;

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 { GalleryVideo } from './galleryVideo';
 import { CategoryRow, ProductImage, ProductRow } from './types';
 /**
  * What the product editor knows and the nodes of `catalog.product-form` do not.
@@ -14,6 +15,12 @@ export interface ProductEditorContext {
     images: Ref<ProductImage[]>;
     /** Closed for writing: no permission, or a save in flight. */
     locked: Ref<boolean>;
+    /**
+     * 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
+     * when an editor leaves it out.
+     */
+    video?: GalleryVideo;
 }
 export declare const productEditorKey: InjectionKey<ProductEditorContext>;
 export declare function provideProductEditor(editor: ProductEditorContext): void;

package/dist/galleryVideo.d.ts

@@ -0,0 +1,67 @@
+import { ComputedRef, Ref } from 'vue';
+import { AdminContext, ChunkedUpload, UnfinishedUpload } from '@webx-ui/module-admin';
+import { ProductImage } from './types';
+import { ProbeOptions } from './video';
+/**
+ * Video files going into the gallery (§7 of the video spec): the frame, the picture, the file a
+ * piece at a time, and the request that puts the two together.
+ *
+ * Kept by the product editor rather than by the gallery field. The field lives on a tab, and a tab
+ * nobody is looking at is taken down — with the chunked upload inside it, which pauses when its
+ * scope dies. Up here the upload carries on while the rest of the form is being filled in.
+ *
+ * One file at a time, as there is one chunked upload: several at once share one connection
+ * anyway, and one bar that moves says more than three that crawl.
+ */
+export declare const VIDEO_PURPOSE = "catalog.video";
+export type VideoJobStage = 'waiting' | 'poster' | 'uploading' | 'attaching' | 'failed';
+export interface VideoJob {
+    key: number;
+    file: File;
+    /** The product it goes to, as it was when the file was chosen. */
+    product: number;
+    /** The picture it goes onto; `null` until the frame has been uploaded as one. */
+    image: number | null;
+    /** The job made that picture itself — a cancel takes it away again. */
+    created: boolean;
+    /** The frame, until the picture is on the server and the row shows its own. */
+    poster: string | null;
+    duration: number | null;
+    stage: VideoJobStage;
+    /** Why it stopped, in words; only in `failed`. */
+    error: string | null;
+    /** The browser could not open the file, so there is no frame to make a picture of. */
+    unreadable: boolean;
+}
+/** An upload this browser left unfinished for this product, with the picture it was for. */
+export interface UnfinishedVideo extends UnfinishedUpload {
+    image: number | null;
+}
+export interface GalleryVideo {
+    readonly jobs: Readonly<Ref<readonly VideoJob[]>>;
+    /** The one upload that moves — its state, progress, speed and time left. */
+    readonly upload: ChunkedUpload;
+    /** Something is on its way to the server; leaving now loses the rest of it. */
+    readonly busy: ComputedRef<boolean>;
+    /** What a reload interrupted on this product, to be continued by choosing the file again. */
+    readonly unfinished: ComputedRef<UnfinishedVideo[]>;
+    /** Onto `image`, or a new row made of its own frame when there is none. */
+    add(file: File, image?: number | null): void;
+    pause(): void;
+    resume(): void;
+    /** Try a failed one again: a file the server has part of continues from there. */
+    retry(job: VideoJob): void;
+    cancel(job: VideoJob): Promise<void>;
+    /** Take a failed one off the list. */
+    dismiss(job: VideoJob): void;
+    /** Stop offering to continue an upload. */
+    forget(entry: UnfinishedVideo): void;
+}
+export interface GalleryVideoOptions {
+    product: Ref<number | null>;
+    images: Ref<ProductImage[]>;
+    admin?: AdminContext;
+    storage?: Storage | null;
+    probe?: ProbeOptions;
+}
+export declare function createGalleryVideo(options: GalleryVideoOptions): GalleryVideo;

package/dist/index.d.ts

@@ -1,7 +1,11 @@
 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';
 export { default as WxCatalogProductsPage } from './ProductsPage';
 export { default as WxCatalogProductEditor } from './ProductEditorPage';
@@ -13,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, 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';