@webx-ui/module-admin 0.14.4 → 0.16.0

package/dist/BackButton.d.ts

@@ -19,7 +19,7 @@ type __VLS_Props = {
     size?: ActionSize;
 };
 declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
-    size: ActionSize;
     label: string;
+    size: ActionSize;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
 export default _default;

package/dist/DateText.d.ts

@@ -22,8 +22,8 @@ type __VLS_Props = {
     tone?: TextTone;
 };
 declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
-    size: TextSize;
     tone: TextTone;
+    size: TextSize;
     compact: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
 export default _default;

package/dist/HelpButton.d.ts

@@ -24,8 +24,8 @@ type __VLS_Props = {
 };
 declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
     title: string;
-    size: ActionSize;
     label: string;
+    size: ActionSize;
     width: number | string;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
 export default _default;

package/dist/LinkField.d.ts

@@ -14,8 +14,8 @@ declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {},
 }, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
     "onUpdate:modelValue"?: ((value: LinkValue | null) => any) | undefined;
 }>, {
+    disabled: boolean;
     allowNone: boolean;
     attributes: boolean;
-    disabled: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
 export default _default;

package/dist/LinkPicker.d.ts

@@ -14,8 +14,8 @@ declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {},
 }, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
     "onUpdate:modelValue"?: ((value: LinkValue | null) => any) | undefined;
 }>, {
+    disabled: boolean;
     allowNone: boolean;
     attributes: boolean;
-    disabled: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
 export default _default;

package/dist/RenameButton.d.ts

@@ -27,9 +27,9 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
 }>, {
     name: string;
     disabled: boolean;
-    placeholder: string;
-    size: ActionSize;
     label: string;
+    size: ActionSize;
+    placeholder: string;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
     field: ({
         $: import('vue').ComponentInternalInstance;
@@ -68,7 +68,7 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
         $root: import('vue').ComponentPublicInstance | null;
         $parent: import('vue').ComponentPublicInstance | null;
         $host: Element | null;
-        $emit: ((event: "update:modelValue", value: import('@webx-ui/core').InputModelValue) => void) & ((event: "focus", event: FocusEvent) => void) & ((event: "blur", event: FocusEvent) => void) & ((event: "input", value: string) => void) & ((event: "change", value: string) => void) & ((event: "clear") => void);
+        $emit: ((event: "update:modelValue", value: import('@webx-ui/core').InputModelValue) => void) & ((event: "input", value: string) => void) & ((event: "change", value: string) => void) & ((event: "clear") => void) & ((event: "focus", event: FocusEvent) => void) & ((event: "blur", event: FocusEvent) => void);
         $el: any;
         $options: import('vue').ComponentOptionsBase<Readonly<{
             modelValue?: import('@webx-ui/core').InputModelValue;
@@ -148,7 +148,7 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
         onClear?: (() => any) | undefined;
         onBlur?: ((event: FocusEvent) => any) | undefined;
         onFocus?: ((event: FocusEvent) => any) | undefined;
-    }>, "type" | "disabled" | "id" | "placeholder" | "clearable" | "size" | "status" | "ariaLabel" | "readonly" | "maxlength" | "showCount" | "autocomplete" | "localized" | "focus" | "blur" | "select" | "input"> & {
+    }>, "disabled" | "type" | "id" | "size" | "clearable" | "placeholder" | "status" | "ariaLabel" | "input" | "select" | "readonly" | "maxlength" | "showCount" | "autocomplete" | "localized" | "focus" | "blur"> & {
         focus: () => void | undefined;
         blur: () => void | undefined;
         select: () => void | undefined;

package/dist/RowMenu.d.ts

@@ -8,7 +8,7 @@ type __VLS_Props = {
     size?: ActionSize;
 };
 declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
-    size: ActionSize;
     label: string;
+    size: ActionSize;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
 export default _default;

package/dist/Screen.d.ts

@@ -33,7 +33,7 @@ declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {
     disabled: boolean;
     size: "sm" | "md" | "lg";
     errors: Record<string, string[]>;
-    labelPosition: "top" | "left";
     labelWidth: string;
+    labelPosition: "top" | "left";
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
 export default _default;

package/dist/SlugField.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/address.d.ts

@@ -0,0 +1,25 @@
+import { InjectionKey, Ref } from 'vue';
+import { ScreenModel } from '@webx-ui/schema';
+/**
+ * What a record's editor knows about its address and a described screen cannot carry.
+ *
+ * The address of a service, a category, an article is the module's prefix and the record's slug.
+ * The slug is a field of the screen; the prefix is configuration the editor was handed with the
+ * record, and the address the site answers at right now is the registry's. `wx-slug` needs all
+ * three to print the whole address and to warn before it moves — so the page that hosts the
+ * screen provides them, the same way it provides the preview to `wx-blocks`.
+ */
+export interface RecordAddress {
+    /** The values of the screen as they are right now, edits included. */
+    values: Ref<ScreenModel>;
+    /** Where the module's addresses start: `services`, `''` for the root, `null` for none at all. */
+    prefix: Ref<string | null>;
+    /** The address the registry holds for the record in this language, without a leading slash. */
+    path: Ref<string | null | undefined>;
+    /** "The address is changing" — in the module's words. */
+    moving: () => string;
+}
+export declare const recordAddressKey: InjectionKey<RecordAddress>;
+export declare function provideRecordAddress(address: RecordAddress): void;
+/** The editor above this field, or `null` outside one — a demo, a test, a stray screen. */
+export declare function useRecordAddress(): RecordAddress | null;

package/dist/categories/CategoriesField.d.ts

@@ -0,0 +1,29 @@
+type __VLS_Props = {
+    /** The API the categories answer at, under the panel's: `blog/rubrics`. */
+    source: string;
+    /** Whether the first one is the main one, and wears the badge that says so. */
+    main?: boolean;
+    disabled?: boolean;
+    mainText?: string;
+    addText?: string;
+    removeText?: string;
+    emptyText?: string;
+    noneLeftText?: string;
+};
+type __VLS_PublicProps = {
+    modelValue?: number[] | null;
+} & __VLS_Props;
+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;
+}>, {
+    main: boolean;
+    disabled: boolean;
+    mainText: string;
+    addText: string;
+    removeText: string;
+    emptyText: string;
+    noneLeftText: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/categories/CategoriesPage.d.ts

@@ -0,0 +1,6 @@
+import { CategoriesOptions } from './types';
+type __VLS_Props = {
+    options: CategoriesOptions;
+};
+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/categories/CategoryCreateDialog.d.ts

@@ -0,0 +1,8 @@
+import { CategoriesOptions } from './types';
+type __VLS_Props = {
+    options: CategoriesOptions;
+};
+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/categories/CategoryEditorPage.d.ts

@@ -0,0 +1,6 @@
+import { CategoriesOptions } from './types';
+type __VLS_Props = {
+    options: CategoriesOptions;
+};
+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/categories/api.d.ts

@@ -0,0 +1,38 @@
+import { ScreenModel } from '@webx-ui/schema';
+import { AdminContext } from '../admin';
+import { CategoriesPayload, CategoryDetail, CategoryRow } from './types';
+/**
+ * The categories of one module, behind the routes `CategoryRoutes::register()` gives it.
+ *
+ * The path is the module's (`blog/rubrics`), the answers are everybody's: one controller serves
+ * every module, so one client does too.
+ */
+export interface CategoriesApi {
+    /** Every category, in the order of the site's menu. `q` narrows by name or address. */
+    list(query?: {
+        q?: string;
+        visible?: boolean;
+    }): Promise<CategoriesPayload>;
+    /** A name, and an address made of it unless one is given. */
+    create(input: {
+        title: string;
+        slug?: string;
+    }): Promise<CategoryRow>;
+    get(id: number): Promise<CategoryDetail>;
+    /** The values of the screen. A refused field comes back as a 422 under its name. */
+    save(id: number, values: ScreenModel): Promise<CategoryDetail>;
+    /** Into the bin — a 422 naming the number of items while it still holds any. */
+    remove(id: number): Promise<void>;
+    restore(id: number): Promise<CategoryRow>;
+    /** The whole order, as it is on screen. */
+    reorder(ids: number[]): Promise<void>;
+}
+export declare function createCategoriesApi(admin: AdminContext, path: string): CategoriesApi;
+/**
+ * The order of a module's records, written the way it is dragged (§2.5 of the services spec):
+ * without `category` the whole list, with it the order inside that one category.
+ *
+ * `path` is the module's list of records (`services/items`); the server half is
+ * `CategoryRoutes::items()`. A module that orders by date — the blog — never calls it.
+ */
+export declare function reorderItems(admin: AdminContext, path: string, ids: number[], category?: number | null): Promise<void>;

package/dist/categories/editor.d.ts

@@ -0,0 +1,22 @@
+import { InjectionKey, Ref } from 'vue';
+import { ScreenModel } from '@webx-ui/schema';
+import { CategoryRow } from './types';
+/**
+ * What the category editor knows and the nodes of its screen do not — the same seam the article
+ * editor has. `wx-category-slug` (`wx-slug`) prints the whole address, and the prefix of the module is
+ * configuration the editor was handed with the record, not something a description can carry.
+ */
+export interface CategoryEditorContext {
+    /** The category as the server last answered it, or `null` while the first request is out. */
+    category: Ref<CategoryRow | null>;
+    /** The values of the screen as they are right now, edits included. */
+    values: Ref<ScreenModel>;
+    /** Where the module's addresses start; `null` for categories without an address. */
+    prefix: Ref<string | null>;
+    /** "The address is changing" — in the module's words. */
+    moving: () => string;
+}
+export declare const categoryEditorKey: InjectionKey<CategoryEditorContext>;
+export declare function provideCategoryEditor(editor: CategoryEditorContext): void;
+/** The editor above this node, or `null` outside one — a demo, a test, a stray screen. */
+export declare function useCategoryEditor(): CategoryEditorContext | null;

package/dist/categories/index.d.ts

@@ -0,0 +1,6 @@
+export { createCategoriesApi, reorderItems, type CategoriesApi } from './api';
+export { useCategoryEditor, type CategoryEditorContext } from './editor';
+export { itemOrderMode, useItemOrder, type ItemOrder, type ItemOrderMode, type ItemOrderState, } from './ordering';
+export { categoryRoutes } from './routes';
+export { useCategoryWords } from './words';
+export type { CategoriesOptions, CategoriesPayload, CategoryDetail, CategoryRow, CategoryWord, } from './types';

package/dist/categories/ordering.d.ts

@@ -0,0 +1,41 @@
+import { ComputedRef } from 'vue';
+/**
+ * What the list of a module's records looks like right now, as far as its order is concerned.
+ */
+export interface ItemOrderState {
+    /** What is typed in the search box. */
+    q?: string | null;
+    /** The one category the list is narrowed to, if it is. */
+    category?: number | null;
+    /** Whether any filter other than the category is on — status, author, the bin. */
+    filtered?: boolean;
+}
+/**
+ * Which order a drag would write (decision 5 of the services spec).
+ *
+ * - `all` — the whole list is on screen, and dragging moves the common order;
+ * - `category` — one category and nothing else, and dragging moves that category's own order;
+ * - `locked` — a search or another filter is on, and the rows on screen are a selection: the
+ *   gaps between them are records nobody can see, so a drag here would move them blind.
+ */
+export type ItemOrderMode = 'all' | 'category' | 'locked';
+export declare function itemOrderMode(state: ItemOrderState): ItemOrderMode;
+export interface ItemOrder {
+    mode: ComputedRef<ItemOrderMode>;
+    /** Whether the handles are drawn at all. */
+    sortable: ComputedRef<boolean>;
+    /** One line under the list: what a drag does here, or why there is nothing to drag. */
+    hint: ComputedRef<string>;
+    /** Write the order the rows are in on screen — the whole list, or the category's. */
+    move(ids: number[]): Promise<void>;
+}
+/**
+ * The order of a module's records, dragged in the list the editor is looking at.
+ *
+ * A composable rather than a component, because the list it belongs to is the module's own —
+ * a table, a sortable list, cards — and what is shared is the rule about which order a drag
+ * writes and the sentence that says so. `path` is the list's API (`services/items`), served by
+ * `CategoryRoutes::items()`. A module whose records are ordered by something else (the blog, by
+ * date) does not call it, and its list has no handles.
+ */
+export declare function useItemOrder(path: string, state: () => ItemOrderState): ItemOrder;

package/dist/categories/routes.d.ts

@@ -0,0 +1,12 @@
+import { RouteRecordRaw } from 'vue-router';
+import { CategoriesOptions } from './types';
+/**
+ * The two screens of a module's categories — the list and the page of one — as routes to put
+ * into the module's section:
+ *
+ *     { id: 'rubrics', path: '/blog/rubrics', routes: categoryRoutes({ api: 'blog/rubrics', … }) }
+ *
+ * One description for both, so the list links to the editor and the editor back to the list
+ * without either being told the other's address.
+ */
+export declare function categoryRoutes(options: CategoriesOptions): RouteRecordRaw[];

package/dist/categories/types.d.ts

@@ -0,0 +1,68 @@
+import { LocalizedValue } from '@webx-ui/core';
+import { ScreenModel } from '@webx-ui/schema';
+import { RouteLocationRaw } from 'vue-router';
+/**
+ * One category as its list draws it — the same row for every module, because the server half is
+ * one controller (`WebxUi\Admin\Categories\Http\CategoryResource`).
+ *
+ * How many items are in it travels under the module's own word (`articles_count`), so it is not
+ * a field here: read it with {@link CategoriesOptions.count}.
+ */
+export interface CategoryRow {
+    id: number;
+    /** What to show: the title of this language, its address, or its number — in that order. */
+    name: string;
+    title: LocalizedValue | null;
+    slug: LocalizedValue | null;
+    /** `null` — no address in the language the panel is open in, or categories without addresses. */
+    path: string | null;
+    url: string | null;
+    is_visible: boolean;
+    position: number;
+    deleted_at: string | null;
+}
+export interface CategoriesPayload {
+    data: CategoryRow[];
+    /** Where the module's addresses start; `null` for categories without an address. */
+    prefix: string | null;
+}
+/** One category as its editor opens it: the row, the values of its screen and the prefix. */
+export interface CategoryDetail {
+    category: CategoryRow;
+    values: ScreenModel;
+    prefix: string | null;
+}
+/**
+ * The words the shared screens say, by what they are for.
+ *
+ * Each is a full key — `webx-blog::rubric.new` — and every one has a default under
+ * `webx-admin::categories.*` that calls the thing a category. A module overrides the ones that
+ * name it: the blog says "rubric" and "articles", and keeps the panel's "Edit" and "Cancel".
+ */
+export type CategoryWord = 'new' | 'empty' | 'empty-help' | 'order' | 'hidden' | 'no-address' | 'count' | 'show-items' | 'edit' | 'open-on-site' | 'delete' | 'delete-blocked' | 'delete-title' | 'delete-text' | 'deleted' | 'cancel' | 'create' | 'save' | 'saved' | 'save-failed' | 'reorder-failed' | 'field-title' | 'field-slug' | 'address-moving' | 'untitled' | 'trail' | 'leave-title' | 'leave-text' | 'leave';
+/**
+ * What a module says about its categories, once, for the list, the dialog and the editor.
+ *
+ * The server half reads the same things off `CategoryKind`; this is its front-end twin, and
+ * {@link categoryRoutes} is how a module mounts both screens from one description.
+ */
+export interface CategoriesOptions {
+    /** Under the panel's API path: `blog/rubrics`. */
+    api: string;
+    /** The list in the panel: `/blog/rubrics`. One category is edited at `{path}/{id}`. */
+    path: string;
+    /** The route names: `{name}` for the list, `{name}.edit` for the editor. */
+    name: string;
+    /** The module the list is — its title in the manifest is the heading of both screens. */
+    module: string;
+    /** The described screen of one category: `blog.category-form`. */
+    screen: string;
+    /** The permission everything that writes asks for. */
+    manage: string;
+    /** The key the number of items travels under: `articles_count`. */
+    count: string;
+    /** Where the items of one category are listed, for the row's menu. Left out, no such item. */
+    items?: (id: number) => RouteLocationRaw;
+    /** The module's own words over the panel's — see {@link CategoryWord}. */
+    words?: Partial<Record<CategoryWord, string>>;
+}

package/dist/categories/words.d.ts

@@ -0,0 +1,9 @@
+import { CategoryWord } from './types';
+/**
+ * The shared screens' words, the module's where it has them and the panel's where it does not.
+ *
+ * The panel's say "category"; a module that calls them something else hands its own keys in,
+ * because a blog that says "rubric" on its list and "category" in the dialog over it has two
+ * words for one thing (CLAUDE.md §4 — the words of a shared component are the caller's).
+ */
+export declare function useCategoryWords(words?: Partial<Record<CategoryWord, string>>): (word: CategoryWord, params?: Record<string, string | number>) => string;

package/dist/index.d.ts

@@ -10,6 +10,7 @@ export { createNotesApi, type EntityNote, type NoteAuthor, type NotesApi } from
 export { createLinksApi, emptyLink, type LinkCandidate, type LinkRel, type LinkSourceInfo, type LinkTarget, type LinkValue, type LinksApi, type ResolvedLink, } from './links';
 export { createHttp, readCookie, HttpError, type Http, type HttpOptions, type RequestOptions, } from './http';
 export { adminTypes } from './screenTypes';
+export { categoryRoutes, createCategoriesApi, itemOrderMode, reorderItems, useCategoryEditor, useCategoryWords, useItemOrder, type CategoriesApi, type CategoriesOptions, type CategoriesPayload, type CategoryDetail, type CategoryEditorContext, type CategoryRow, type CategoryWord, type ItemOrder, type ItemOrderMode, type ItemOrderState, } from './categories';
 export type { AdminModule, AdminStatus, AdminUser, Manifest, ManifestModule, NavEntry, PickedImage, RowAction, ScreenAction, AppliedFilter, } from './types';
 export { default as AdminShell } from './AdminShell';
 export { default as AdminNav } from './AdminNav';
@@ -30,3 +31,11 @@ export { default as WxBackupNote } from './BackupNote';
 export { default as WxRichTextField } from './RichTextField';
 export { default as WxLinkPicker } from './LinkPicker';
 export { default as WxLinkField } from './LinkField';
+export { default as WxCategoriesPage } from './categories/CategoriesPage';
+export { default as WxCategoryCreateDialog } from './categories/CategoryCreateDialog';
+export { default as WxCategoryEditorPage } from './categories/CategoryEditorPage';
+export { default as WxCategoriesField } from './categories/CategoriesField';
+export { default as WxSlugField } from './SlugField';
+/** The shared address field under the name it was released with. */
+export { default as WxCategorySlug } from './SlugField';
+export { provideRecordAddress, recordAddressKey, useRecordAddress, type RecordAddress, } from './address';