@webx-ui/module-auth 0.2.1 → 0.4.0

package/dist/AdminDialog.d.ts

@@ -0,0 +1,24 @@
+import { Component } from 'vue';
+import { Admin } from './types';
+/**
+ * Creating an administrator and editing one — the same form, because they differ in one field.
+ *
+ * The password is required the first time and optional afterwards, and a blank one on an edit
+ * means "leave it alone" rather than "set it to nothing". That is the only conditional here.
+ */
+type __VLS_Props = {
+    /** Absent creates somebody; present edits them. */
+    admin?: Admin | null;
+    /**
+     * The field to pick the photograph with — `WxMediaField` in a panel that has the library.
+     *
+     * Handed in rather than imported: this package does not depend on the media one, and a
+     * panel without a library still edits everything else about a person.
+     */
+    avatarField?: Component;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    admin: Admin | null;
+    avatarField: Component;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/AdminList.d.ts

@@ -0,0 +1,62 @@
+import { Admin } from './types';
+/**
+ * The list of administrators — the screen, and the inside of the picker.
+ *
+ * One component for both so that searching, filtering and paging behave the same wherever
+ * somebody is looking at these people. What changes is only what a row is for: opening it, or
+ * choosing it.
+ */
+type __VLS_Props = {
+    /** Rows are chosen rather than opened. */
+    picking?: boolean;
+    /** More than one may be chosen at a time. */
+    multiple?: boolean;
+    /** Adds the column that removes somebody. */
+    removable?: boolean;
+    /**
+     * Offers the role and state filters.
+     *
+     * Off by default: a panel has half a dozen administrators, and a filter over six rows is a
+     * control to read and decide about where a glance would have done.
+     */
+    filters?: boolean;
+    /** Turns an avatar key into an address. The panel wires this; this package cannot. */
+    resolveAvatar?: (key: string) => Promise<string | null>;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {
+    reload: () => Promise<void>;
+    chosen: () => {
+        [x: string]: unknown;
+        id: number;
+        name: string;
+        email: string;
+        avatar: string | null;
+        is_super: boolean;
+        is_active: boolean;
+        locale: string | null;
+        last_login_at: string | null;
+        created_at: string | null;
+        roles: {
+            id: number;
+            slug: string;
+            name: string;
+        }[];
+    }[];
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    chosen: (admins: Admin[]) => any;
+    open: (admin: Admin) => any;
+    selection: (admins: Admin[]) => any;
+    remove: (admin: Admin) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onChosen?: ((admins: Admin[]) => any) | undefined;
+    onOpen?: ((admin: Admin) => any) | undefined;
+    onSelection?: ((admins: Admin[]) => any) | undefined;
+    onRemove?: ((admin: Admin) => any) | undefined;
+}>, {
+    multiple: boolean;
+    picking: boolean;
+    removable: boolean;
+    filters: boolean;
+    resolveAvatar: (key: string) => Promise<string | null>;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/AdminPicker.d.ts

@@ -0,0 +1,104 @@
+import { Admin } from './types';
+/**
+ * The list of administrators as a dialog, resolving with whoever was chosen.
+ *
+ * The same list as the screen — one component, so that searching and filtering behave the same
+ * wherever these people are being looked at.
+ */
+type __VLS_Props = {
+    multiple?: boolean;
+    title?: string;
+    resolveAvatar?: (key: string) => Promise<string | null>;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    title: string;
+    multiple: boolean;
+    resolveAvatar: (key: string) => Promise<string | null>;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    list: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{
+        picking?: boolean;
+        multiple?: boolean;
+        removable?: boolean;
+        filters?: boolean;
+        resolveAvatar?: (key: string) => Promise<string | null>;
+    }> & Readonly<{
+        onChosen?: ((admins: Admin[]) => any) | undefined;
+        onOpen?: ((admin: Admin) => any) | undefined;
+        onSelection?: ((admins: Admin[]) => any) | undefined;
+        onRemove?: ((admin: Admin) => any) | undefined;
+    }>, {
+        reload: () => Promise<void>;
+        chosen: () => {
+            [x: string]: unknown;
+            id: number;
+            name: string;
+            email: string;
+            avatar: string | null;
+            is_super: boolean;
+            is_active: boolean;
+            locale: string | null;
+            last_login_at: string | null;
+            created_at: string | null;
+            roles: {
+                id: number;
+                slug: string;
+                name: string;
+            }[];
+        }[];
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+        chosen: (admins: Admin[]) => any;
+        open: (admin: Admin) => any;
+        selection: (admins: Admin[]) => any;
+        remove: (admin: Admin) => any;
+    }, import('vue').PublicProps, {
+        multiple: boolean;
+        picking: boolean;
+        removable: boolean;
+        filters: boolean;
+        resolveAvatar: (key: string) => Promise<string | null>;
+    }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, HTMLDivElement, import('vue').ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<{
+        picking?: boolean;
+        multiple?: boolean;
+        removable?: boolean;
+        filters?: boolean;
+        resolveAvatar?: (key: string) => Promise<string | null>;
+    }> & Readonly<{
+        onChosen?: ((admins: Admin[]) => any) | undefined;
+        onOpen?: ((admin: Admin) => any) | undefined;
+        onSelection?: ((admins: Admin[]) => any) | undefined;
+        onRemove?: ((admin: Admin) => any) | undefined;
+    }>, {
+        reload: () => Promise<void>;
+        chosen: () => {
+            [x: string]: unknown;
+            id: number;
+            name: string;
+            email: string;
+            avatar: string | null;
+            is_super: boolean;
+            is_active: boolean;
+            locale: string | null;
+            last_login_at: string | null;
+            created_at: string | null;
+            roles: {
+                id: number;
+                slug: string;
+                name: string;
+            }[];
+        }[];
+    }, {}, {}, {}, {
+        multiple: boolean;
+        picking: boolean;
+        removable: boolean;
+        filters: boolean;
+        resolveAvatar: (key: string) => Promise<string | null>;
+    }> | null;
+}, any>;
+export default _default;

package/dist/AdminsPage.d.ts

@@ -0,0 +1,104 @@
+import { Component } from 'vue';
+import { Admin } from './types';
+/**
+ * The administrators section: the list, and the form over it.
+ *
+ * A dialog rather than a second route. Editing somebody is half a dozen fields, and a screen
+ * that takes over the page for that loses the list you were reading — which is where you
+ * decide who to open next.
+ */
+type __VLS_Props = {
+    avatarField?: Component;
+    resolveAvatar?: (key: string) => Promise<string | null>;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    avatarField: Component;
+    resolveAvatar: (key: string) => Promise<string | null>;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    list: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{
+        picking?: boolean;
+        multiple?: boolean;
+        removable?: boolean;
+        filters?: boolean;
+        resolveAvatar?: (key: string) => Promise<string | null>;
+    }> & Readonly<{
+        onChosen?: ((admins: Admin[]) => any) | undefined;
+        onOpen?: ((admin: Admin) => any) | undefined;
+        onSelection?: ((admins: Admin[]) => any) | undefined;
+        onRemove?: ((admin: Admin) => any) | undefined;
+    }>, {
+        reload: () => Promise<void>;
+        chosen: () => {
+            [x: string]: unknown;
+            id: number;
+            name: string;
+            email: string;
+            avatar: string | null;
+            is_super: boolean;
+            is_active: boolean;
+            locale: string | null;
+            last_login_at: string | null;
+            created_at: string | null;
+            roles: {
+                id: number;
+                slug: string;
+                name: string;
+            }[];
+        }[];
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+        chosen: (admins: Admin[]) => any;
+        open: (admin: Admin) => any;
+        selection: (admins: Admin[]) => any;
+        remove: (admin: Admin) => any;
+    }, import('vue').PublicProps, {
+        multiple: boolean;
+        picking: boolean;
+        removable: boolean;
+        filters: boolean;
+        resolveAvatar: (key: string) => Promise<string | null>;
+    }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, HTMLDivElement, import('vue').ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<{
+        picking?: boolean;
+        multiple?: boolean;
+        removable?: boolean;
+        filters?: boolean;
+        resolveAvatar?: (key: string) => Promise<string | null>;
+    }> & Readonly<{
+        onChosen?: ((admins: Admin[]) => any) | undefined;
+        onOpen?: ((admin: Admin) => any) | undefined;
+        onSelection?: ((admins: Admin[]) => any) | undefined;
+        onRemove?: ((admin: Admin) => any) | undefined;
+    }>, {
+        reload: () => Promise<void>;
+        chosen: () => {
+            [x: string]: unknown;
+            id: number;
+            name: string;
+            email: string;
+            avatar: string | null;
+            is_super: boolean;
+            is_active: boolean;
+            locale: string | null;
+            last_login_at: string | null;
+            created_at: string | null;
+            roles: {
+                id: number;
+                slug: string;
+                name: string;
+            }[];
+        }[];
+    }, {}, {}, {}, {
+        multiple: boolean;
+        picking: boolean;
+        removable: boolean;
+        filters: boolean;
+        resolveAvatar: (key: string) => Promise<string | null>;
+    }> | null;
+}, HTMLElement>;
+export default _default;

package/dist/admins.d.ts

@@ -0,0 +1,18 @@
+import { AdminContext } from '@webx-ui/admin';
+import { Admin, AdminInput, AdminPage, AdminQuery, Role } from './types';
+export interface AdminsApi {
+    list(query?: AdminQuery): Promise<AdminPage>;
+    get(id: number): Promise<Admin>;
+    create(input: AdminInput): Promise<Admin>;
+    update(id: number, input: AdminInput): Promise<Admin>;
+    remove(id: number): Promise<void>;
+    roles(): Promise<Role[]>;
+}
+/**
+ * The calls behind the administrators screen, and behind the picker that opens from code.
+ *
+ * Reading is separate from managing on the server, so a module that only wants to say who
+ * wrote something — or offer a list of people to assign work to — can use `list` and `roles`
+ * without being allowed anywhere near the rest.
+ */
+export declare function createAdminsApi(admin: AdminContext): AdminsApi;

package/dist/i18n.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Put this package's English under the panel's dictionary, once per panel.
+ *
+ * The plugin does this too, but a panel can use the administrators screen — or just the picker
+ * — without installing the sign-in plugin at all, and a screen showing `admins.title` instead
+ * of a word is not a thing to leave to chance.
+ */
+export declare function useAuthMessages(): void;

package/dist/index.d.ts

@@ -13,6 +13,12 @@ export interface AuthOptions {
  * itself knows nothing about authentication — it holds the answer, not the question.
  */
 export declare function auth(options?: AuthOptions): AdminPlugin;
+export { admins, type AdminsOptions } from './module';
+export { createAdminsApi, type AdminsApi } from './admins';
+export { selectAdmin, selectAdmins, type AdminPickerOptions } from './selectAdmin';
+export { default as WxAdminsPage } from './AdminsPage';
+export { default as WxAdminList } from './AdminList';
+export type { Admin, AdminInput, AdminPage, AdminQuery, AdminRole, Role } from './types';
 export { createAuthSession, provideAuth, useAuth, authKey } from './session';
 export type { AuthSession, Credentials } from './session';
 export { default as WxLoginCard } from './LoginCard';