@webx-ui/module-admin 0.18.2 → 0.20.0

package/dist/HistoryFeed.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Who changed a record, when, through which door, and what exactly (WEBX_UI_HISTORY.md §5).
+ *
+ * The frame's and not a section's, like the notes: the catalogue wants it first, and a copy per
+ * module is a copy of the rule about who may read it. On a screen it is the `wx-history` node —
+ * a tab of a form is one line of the description or one patch of a project — and the id comes
+ * from the editor hosting the screen (`provideHistorySubject`), since the same JSON describes
+ * every record.
+ *
+ * A row made inside an import or a bulk action links to the run: the run is where the journal
+ * says what was done to all of them at once, and the row only says what this record got.
+ */
+type __VLS_Props = {
+    /** The type the module registered: `catalog.product`. */
+    type: string;
+    /** The record; the hosting editor's when omitted. */
+    id?: number | string | null;
+    /** Heading above the feed; the panel's own word by default, none with `''`. */
+    title?: string;
+};
+declare function load(): Promise<void>;
+declare const _default: import('vue').DefineComponent<__VLS_Props, {
+    reload: typeof load;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    id: number | string | null;
+    title: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLElement>;
+export default _default;

package/dist/history.d.ts

@@ -0,0 +1,90 @@
+import { InjectionKey, Ref } from 'vue';
+import { AdminContext } from './admin';
+/** What happened to a record. `run` is the parent row of an import or a bulk action. */
+export type HistoryEvent = 'created' | 'updated' | 'deleted' | 'restored' | 'published' | 'unpublished' | 'run';
+/** Which door the change came through. */
+export type HistorySource = 'panel' | 'mcp' | 'import' | 'bulk' | 'api' | 'console';
+/**
+ * One field of one save. A long value (rich text, a repeater) comes without `from` and `to`:
+ * the journal keeps that it changed and how long it was, and the versions keep the text.
+ */
+export interface HistoryChange {
+    /** `price`, or `name.ru` for one language of a translated field. */
+    field: string;
+    /** The module's word for it, in the reader's language. */
+    label: string;
+    from: unknown;
+    to: unknown;
+    long?: boolean;
+    from_length?: number;
+    to_length?: number;
+}
+export interface HistoryEntry {
+    id: number;
+    event: HistoryEvent;
+    source: HistorySource;
+    subject: {
+        type: string;
+        id: number | null;
+    };
+    /** The name as it was signed; `null` when nobody was signed in (a console command). */
+    admin: {
+        id: number | null;
+        name: string | null;
+    } | null;
+    /** The agent's connection, when the source is `mcp`. */
+    grant_id: number | null;
+    changes: HistoryChange[];
+    /** The run this save was made in, with what the run was when the server had it at hand. */
+    run: {
+        id: number;
+        summary: Record<string, unknown> | null;
+    } | null;
+    created_at: string | null;
+    /** A run's own: what was done, with which profile, how many rows. */
+    summary?: Record<string, unknown>;
+    rows?: number;
+}
+/** A page as `->paginate()` has it. */
+export interface HistoryPage {
+    data: HistoryEntry[];
+    current_page: number;
+    last_page: number;
+    total: number;
+}
+export interface HistoryRun {
+    run: HistoryEntry;
+    rows: HistoryPage;
+}
+export interface HistoryApi {
+    list(page?: number): Promise<HistoryPage>;
+    /** A run and its rows, or only the rows about one record. */
+    run(id: number, page?: number, search?: number | null): Promise<HistoryRun>;
+}
+/**
+ * The journal of one record.
+ *
+ * `type` is what the module registered (`catalog.product`) — never a class name — and the
+ * address is the panel's own, like the notes': one feed for every section, and the server says
+ * which permission each type is behind.
+ */
+export declare function createHistoryApi(admin: AdminContext, type: string, id: number | string): HistoryApi;
+/**
+ * The id of the record an editor is showing, for a `wx-history` node on its screen.
+ *
+ * A described screen is the same JSON for every record, so the id cannot be written into it:
+ * the page that hosts the screen knows it, and provides it here — the way it provides the
+ * address to `wx-slug`. `null` is a record not saved yet, which has no history.
+ */
+export interface HistorySubject {
+    id: Ref<number | string | null | undefined>;
+}
+export declare const historySubjectKey: InjectionKey<HistorySubject>;
+export declare function provideHistorySubject(subject: HistorySubject): void;
+/** The editor above the node, or `null` outside one. */
+export declare function useHistorySubject(): HistorySubject | null;
+/**
+ * A value as a line of text. Words for "nothing" are the caller's; a list or an object is shown
+ * as JSON, cut, because a repeater row printed whole is a paragraph in a feed of one-liners.
+ */
+export declare function historyValue(value: unknown, empty: string, max?: number): string;

package/dist/http.d.ts

@@ -44,14 +44,26 @@ export declare class HttpError extends Error {
     get isUnauthenticated(): boolean;
     get isThrottled(): boolean;
 }
+export interface SendOptions extends RequestOptions {
+    /** Sent as it is — bytes, a `Blob`, a string — with no `Content-Type` added for it. */
+    body?: BodyInit | null;
+}
 export interface Http {
     get<T>(path: string, options?: RequestOptions): Promise<T>;
     post<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
     put<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
     patch<T>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
     delete<T>(path: string, options?: RequestOptions): Promise<T>;
+    /**
+     * A request with the panel's conventions (the CSRF cookie, the standing headers, 419 and 401)
+     * and nothing else: the body goes as it is and the response comes back whatever its status.
+     * For what JSON does not fit — the pieces of a chunked upload, a `HEAD` asked for a header.
+     * Optional so that a hand-made client in a test or a project does not have to grow one.
+     */
+    send?(method: string, path: string, options?: SendOptions): Promise<Response>;
 }
 export declare function createHttp(options?: HttpOptions): Http;
+export declare function toError(response: Response): Promise<HttpError>;
 /**
  * Laravel writes the token URL-encoded, and it is read back the same way it was written.
  */

package/dist/index.d.ts

@@ -8,8 +8,10 @@ export { createDates, useDates, type DateLike, type Dates } from './dates';
 export { errorText, useErrorText } from './errors';
 export { useBodyKeys } from './keys';
 export { createNotesApi, type EntityNote, type NoteAuthor, type NotesApi } from './notes';
+export { createHistoryApi, historySubjectKey, historyValue, provideHistorySubject, useHistorySubject, type HistoryApi, type HistoryChange, type HistoryEntry, type HistoryEvent, type HistoryPage, type HistoryRun, type HistorySource, type HistorySubject, } from './history';
 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 { createHttp, readCookie, HttpError, type Http, type HttpOptions, type RequestOptions, type SendOptions, } from './http';
+export { forgetUnfinishedUpload, MIN_CHUNK, unfinishedUploads, uploadFingerprint, useChunkedUpload, type ChunkedUpload, type ChunkedUploadOptions, type ChunkedUploadState, type UnfinishedUpload, } from './uploads';
 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';
@@ -30,6 +32,7 @@ export { default as WxRenameButton } from './RenameButton';
 export { default as WxHelpButton } from './HelpButton';
 export { default as WxDate } from './DateText';
 export { default as WxNotes } from './NotesFeed';
+export { default as WxHistory } from './HistoryFeed';
 export { default as WxBackupNote } from './BackupNote';
 export { default as WxRichTextField } from './RichTextField';
 export { default as WxLinkPicker } from './LinkPicker';