@webx-ui/module-admin 0.3.0 → 0.4.0

package/dist/AdminNav.d.ts

@@ -2,6 +2,9 @@
  * The menu, built from the manifest rather than written out. What the panel offers is what the
  * installation actually has — adding a module on the server and installing its front end is
  * the whole of "adding a section".
+ *
+ * Sections come first, then the groups the server declared — "System" for what keeps the
+ * panel running — each as a branch that opens on its own when a section under it is current.
  */
 type __VLS_Props = {
     collapsed?: boolean;

package/dist/Screen.d.ts

@@ -0,0 +1,39 @@
+import { ScreenModel, ScreenNode } from '@webx-ui/schema';
+/**
+ * A screen of the panel, by name.
+ *
+ * Fetches the tree the server hands out — patched, permission-filtered, translated — lays the
+ * project's own patch over it, and draws it with the renderer against the panel's registry,
+ * dictionary and permissions. It does not load values and does not save: that is the page's
+ * business, the way it is for any form.
+ */
+type __VLS_Props = {
+    /** `<module>.<screen>`, e.g. `settings.index`. */
+    name: string;
+    /** Server validation errors by field name, shown under the fields. */
+    errors?: Record<string, string[]>;
+    disabled?: boolean;
+    labelPosition?: 'top' | 'left';
+    labelWidth?: string;
+    size?: 'sm' | 'md' | 'lg';
+};
+declare function load(): Promise<void>;
+type __VLS_PublicProps = {
+    modelValue?: ScreenModel;
+} & __VLS_Props;
+declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {
+    reload: typeof load;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    loaded: (root: ScreenNode[]) => any;
+    "update:modelValue": (value: ScreenModel) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    onLoaded?: ((root: ScreenNode[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: ScreenModel) => any) | undefined;
+}>, {
+    size: "sm" | "md" | "lg";
+    errors: Record<string, string[]>;
+    disabled: boolean;
+    labelPosition: "top" | "left";
+    labelWidth: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/admin.d.ts

@@ -1,7 +1,8 @@
 import { App, ComputedRef, InjectionKey } from 'vue';
+import { Patch, ScreenNode, TypeRegistry } from '@webx-ui/schema';
 import { Http } from './http';
 import { I18n } from './i18n';
-import { AdminModule, AdminStatus, AdminUser, Manifest, NavEntry } from './types';
+import { AdminModule, AdminStatus, AdminUser, Manifest, NavEntry, NavGroup } from './types';
 export interface AdminContext {
     /** The panel's own backend. */
     readonly http: Http;
@@ -16,6 +17,13 @@ export interface AdminContext {
     readonly modules: readonly AdminModule[];
     /** Navigation, in the order the server gave, for the modules that exist on both sides. */
     readonly nav: ComputedRef<NavEntry[]>;
+    /** The same navigation, with the top-level entries first and then each group's. */
+    readonly groups: ComputedRef<{
+        top: NavEntry[];
+        groups: NavGroup[];
+    }>;
+    /** Node types every screen is drawn with: the modules' and the project's, over the core. */
+    readonly types: TypeRegistry;
     /** Ask the server what the panel is and who is signed in again. */
     reload(): Promise<void>;
     /**
@@ -32,6 +40,13 @@ export interface AdminContext {
      */
     useSessionLoader(loader: () => Promise<AdminUser | null>): void;
     can(permission: string): boolean;
+    /**
+     * A screen by name, as the server hands it out — patched, cut to this administrator's
+     * permissions, translated. Fetched once per name and language for the session.
+     */
+    loadScreen(name: string): Promise<ScreenNode[]>;
+    /** The project's own operations over a screen, from `createAdmin({ screens })`. */
+    screenPatch(name: string): Patch;
 }
 export interface AdminState {
     status: AdminStatus;
@@ -54,5 +69,7 @@ export declare function createAdminContext(options: {
     i18n: I18n;
     loadManifest: () => Promise<Manifest>;
     loadDictionary?: (locale: string) => Promise<void>;
+    types?: TypeRegistry;
+    screens?: Record<string, Patch>;
 }): AdminContext;
 export declare function provideAdmin(app: App, admin: AdminContext): void;

package/dist/createAdmin.d.ts

@@ -3,6 +3,7 @@ import { Router, RouteRecordRaw } from 'vue-router';
 import { AdminContext } from './admin';
 import { Http } from './http';
 import { I18n } from './i18n';
+import { Patch, TypeRegistry } from '@webx-ui/schema';
 import { AdminModule } from './types';
 export interface CreateAdminOptions {
     /** Where to mount. Defaults to `#webx-app`, which is what the Blade shell renders. */
@@ -39,6 +40,17 @@ export interface CreateAdminOptions {
      * narrows it to a language the panel actually has.
      */
     locale?: string;
+    /**
+     * Screen node types the project adds — `{ map: { component: WxMapField, kind: 'field' } }` —
+     * over the core's and the modules'.
+     */
+    types?: TypeRegistry;
+    /**
+     * The project's patches over the screens modules ship, by screen name, applied on the
+     * client on top of what the server hands out. What a patch cannot do from here is open a
+     * key for writing: the server decides what is saved.
+     */
+    screens?: Record<string, Patch>;
     /** Swappable for tests. */
     http?: Http;
 }

package/dist/index.d.ts

@@ -6,3 +6,4 @@ export { createHttp, readCookie, HttpError, type Http, type HttpOptions, type Re
 export type { AdminModule, AdminStatus, AdminUser, Manifest, ManifestModule, NavEntry, } from './types';
 export { default as AdminShell } from './AdminShell';
 export { default as AdminNav } from './AdminNav';
+export { default as WxScreen } from './Screen';