@webx-ui/module-auth 0.12.0 → 0.14.0

package/dist/ProfileDialog.d.ts

@@ -1,14 +1,18 @@
 import { Component } from 'vue';
 /**
- * Somebody editing themselves.
+ * Somebody editing themselves (WEBX_UI_PERMISSIONS.md §8).
  *
  * Not `AdminDialog` with the fields taken away. What a person may change about themselves and
  * what an administrator may change about them are different lists, and the difference is the
- * whole point: roles, super, active and the sign-in address are not here, which is what makes
- * this reachable by everybody rather than by whoever holds `admins.manage`.
+ * whole point: roles, super and active are not here, which is what makes this reachable by
+ * everybody rather than by whoever holds `admins.manage`.
  *
- * The address is shown and not editable: changing where somebody signs in has to be proved at
- * the new address first, and nothing here can do that yet.
+ * Four sections, each answering one question. The profile and the password are saved together
+ * by the button at the foot, as they always were. The interface takes effect as it is touched —
+ * the same switches as the corner menu, and a theme that waits for a button is a theme nobody
+ * can preview. The address is its own errand: a letter to the new one, and nothing changes
+ * until its link is followed — so it has its own button, and where the site sends no mail it
+ * says who changes the address instead.
  */
 type __VLS_Props = {
     /** The field to pick the photograph with — `WxMediaField` in a panel with the library. */

package/dist/RoleDialog.d.ts

@@ -0,0 +1,21 @@
+import { Role } from './types';
+/**
+ * A role: its name, its code, and the permissions it opens, as a matrix — one row per module in
+ * the order of the menu, a box per permission, and a box on the row that ticks the whole module
+ * (WEBX_UI_PERMISSIONS.md §11).
+ *
+ * The server's rules are drawn here so they do not have to be learned from a refusal: a
+ * permission the editor does not hold is shown and cannot be ticked (rule 2), and a role the
+ * editor holds opens read-only (rule 5). They are only drawn — the server asks again.
+ */
+type __VLS_Props = {
+    /** Absent creates a role; present edits it. */
+    role?: Role | null;
+    /** Whoever may not edit roles reads them. */
+    readOnly?: boolean;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    role: Role | null;
+    readOnly: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/RoleList.d.ts

@@ -0,0 +1,26 @@
+import { Role } from './types';
+/**
+ * The roles: what each is called, how much it opens and how many people hold it.
+ *
+ * Not paged and not searched. A site has a handful of roles, and the whole list is the thing a
+ * person compares when deciding which one to give somebody.
+ */
+type __VLS_Props = {
+    /** Adds the menu that deletes a role — for whoever may edit roles. */
+    removable?: boolean;
+};
+declare function load(): Promise<void>;
+declare const _default: import('vue').DefineComponent<__VLS_Props, {
+    reload: typeof load;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    open: (role: Role) => any;
+    remove: (role: Role) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onOpen?: ((role: Role) => any) | undefined;
+    onRemove?: ((role: Role) => any) | undefined;
+}>, {
+    removable: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    root: HTMLDivElement;
+}, HTMLDivElement>;
+export default _default;

package/dist/admins.d.ts

@@ -1,5 +1,5 @@
 import { AdminContext } from '@webx-ui/module-admin';
-import { Admin, AdminInput, AdminPage, AdminQuery, AgentCallPage, AgentCallQuery, Role } from './types';
+import { Admin, AdminInput, AdminPage, AdminQuery, AgentCallPage, AgentCallQuery, PermissionRow, Role, RoleDetails, RoleInput } from './types';
 export interface AdminsApi {
     list(query?: AdminQuery): Promise<AdminPage>;
     get(id: number): Promise<Admin>;
@@ -7,6 +7,14 @@ export interface AdminsApi {
     update(id: number, input: AdminInput): Promise<Admin>;
     remove(id: number): Promise<void>;
     roles(): Promise<Role[]>;
+    /** One role with the people who hold it. */
+    role(id: number): Promise<RoleDetails>;
+    /** Every permission a role may list, by module. */
+    permissions(): Promise<PermissionRow[]>;
+    /** Behind `roles.manage`, like the two below. */
+    createRole(input: RoleInput): Promise<Role>;
+    updateRole(id: number, input: RoleInput): Promise<Role>;
+    removeRole(id: number): Promise<void>;
     /** What agents did, newest first. Behind `admins.audit`. */
     calls(query?: AgentCallQuery): Promise<AgentCallPage>;
 }