@webx-ui/module-admin 0.16.1 → 0.18.0

package/dist/RenameButton.d.ts

@@ -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;
-    }>, "disabled" | "type" | "id" | "size" | "clearable" | "placeholder" | "status" | "ariaLabel" | "input" | "select" | "readonly" | "maxlength" | "showCount" | "autocomplete" | "localized" | "focus" | "blur"> & {
+    }>, "disabled" | "type" | "id" | "size" | "clearable" | "placeholder" | "status" | "ariaLabel" | "input" | "select" | "readonly" | "focus" | "blur" | "maxlength" | "showCount" | "autocomplete" | "localized"> & {
         focus: () => void | undefined;
         blur: () => void | undefined;
         select: () => void | undefined;

package/dist/collections/CollectionField.d.ts

@@ -0,0 +1,17 @@
+import { CollectionValue } from './api';
+type __VLS_Props = {
+    /** The source's key, as the server registered it: `faq`. */
+    source: string;
+    disabled?: boolean;
+};
+type __VLS_PublicProps = {
+    modelValue?: CollectionValue | null;
+} & __VLS_Props;
+declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:modelValue": (value: CollectionValue | null) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    "onUpdate:modelValue"?: ((value: CollectionValue | null) => any) | undefined;
+}>, {
+    disabled: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/collections/api.d.ts

@@ -0,0 +1,59 @@
+import { AdminContext } from '../admin';
+/**
+ * One section a block can show records from, as `GET /api/cms/collections` describes it
+ * (`WebxUi\Admin\Collections\CollectionSource` on the server).
+ */
+export interface CollectionSourceInfo {
+    /** What a block schema writes in `props.source`: `faq`. */
+    key: string;
+    /** Already in the panel's language. */
+    title: string;
+    /** The path its categories answer at (`faq/categories`); `null` — a source without them. */
+    categories: string | null;
+    /** Whether it can mark its records up for search engines. */
+    markup: boolean;
+    /**
+     * The targets its records can be related to (`CollectionSource::relations()`, §3.6 of the
+     * recipes spec) — empty for a source without relations, which has no "only related to".
+     */
+    relations: CollectionRelationTarget[];
+}
+/** A target a source's records point at, named for the choice "only related to …". */
+export interface CollectionRelationTarget {
+    /** Its key in the server's registry of targets: `service`. */
+    key: string;
+    /** Already in the panel's language. */
+    title: string;
+}
+/** "Only the records related to these": one target, and the ones of it that were chosen. */
+export interface CollectionRelated {
+    type: string;
+    ids: number[];
+    /**
+     * "Related to the record of the page the block stands on" — written only when on, and then
+     * `ids` is always empty: the record is the page's, not a choice.
+     */
+    current?: true;
+}
+/** What a `wx-collection` field keeps: the choice, never the records. */
+export interface CollectionValue {
+    /** Empty — all of them. */
+    categories: number[];
+    /** `null` — not narrowed by relations. */
+    related: CollectionRelated | null;
+    /** `null` — all of them. */
+    limit: number | null;
+    filter: boolean;
+    /** `null` — the default: on when no category is chosen (decision 8 of the FAQ spec). */
+    markup: boolean | null;
+}
+/** The server's ceiling for `limit` (`Selection::MAX_LIMIT`). */
+export declare const COLLECTION_MAX_LIMIT = 100;
+export declare function collectionSources(admin: AdminContext): Promise<CollectionSourceInfo[]>;
+/** Whatever arrived, as the five keys the server writes — the same `Selection::normalise()` does. */
+export declare function normaliseCollection(value: unknown): CollectionValue;
+/**
+ * What `markup: null` means for this choice: on for the whole collection, off for a part of it —
+ * and "the recipes of this service" is a part as much as a category is.
+ */
+export declare function defaultMarkup(value: CollectionValue): boolean;

package/dist/index.d.ts

@@ -11,6 +11,8 @@ export { createLinksApi, emptyLink, type LinkCandidate, type LinkRel, type 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 { COLLECTION_MAX_LIMIT, collectionSources, defaultMarkup, normaliseCollection, type CollectionRelated, type CollectionRelationTarget, type CollectionSourceInfo, type CollectionValue, } from './collections/api';
+export { createRelationsApi, normaliseRelations, provideRelationOwner, relationOwnerKey, useRelationOwner, type RelationCandidate, type RelationOwner, type RelationsApi, } from './relations/api';
 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';
@@ -35,6 +37,8 @@ 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 WxCollectionField } from './collections/CollectionField';
+export { default as WxRelationsField } from './relations/RelationsField';
 export { default as WxSlugField } from './SlugField';
 /** The shared address field under the name it was released with. */
 export { default as WxCategorySlug } from './SlugField';