@webx-ui/module-auth 0.4.0 → 0.5.0

package/README.md

@@ -9,11 +9,11 @@ closes the panel on the server. This is what lets somebody back in.
 ## Install
 
 ```bash
-pnpm add @webx-ui/module-auth @webx-ui/admin @webx-ui/core vue vue-router
+pnpm add @webx-ui/module-auth @webx-ui/module-admin @webx-ui/core vue vue-router
 ```
 
 ```ts
-import { createAdmin } from '@webx-ui/admin'
+import { createAdmin } from '@webx-ui/module-admin'
 import { auth, WxUserMenu } from '@webx-ui/module-auth'
 
 createAdmin({
@@ -23,7 +23,7 @@ createAdmin({
 ```
 
 That is the whole integration. Installing it also tells the panel how to find out who is signed
-in, which is why `@webx-ui/admin` knows nothing about authentication — it holds the answer, not
+in, which is why `@webx-ui/module-admin` knows nothing about authentication — it holds the answer, not
 the question.
 
 ## A plugin, not a section

package/dist/UserMenu.d.ts

@@ -1,3 +1,4 @@
+import { AvatarResolver } from './session';
 /**
  * The corner of the header: who this is, which language they read the panel in, and the way
  * out.
@@ -8,8 +9,11 @@
  */
 type __VLS_Props = {
     signOutLabel?: string;
+    /** Overrides the resolver `auth()` was given. Without either, initials. */
+    resolveAvatar?: AvatarResolver;
 };
 declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    resolveAvatar: AvatarResolver;
     signOutLabel: string;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
 export default _default;

package/dist/admins.d.ts

@@ -1,4 +1,4 @@
-import { AdminContext } from '@webx-ui/admin';
+import { AdminContext } from '@webx-ui/module-admin';
 import { Admin, AdminInput, AdminPage, AdminQuery, Role } from './types';
 export interface AdminsApi {
     list(query?: AdminQuery): Promise<AdminPage>;

package/dist/index.d.ts

@@ -1,9 +1,17 @@
-import { AdminPlugin } from '@webx-ui/admin';
+import { AdminPlugin } from '@webx-ui/module-admin';
+import { AvatarResolver } from './session';
 export interface AuthOptions {
     /** Where the sign-in screen lives, inside the panel. */
     path?: string;
     /** Props handed to the card — the labels, mostly. */
     card?: Record<string, unknown>;
+    /**
+     * Turns the key the signed-in person's photograph is stored under into an address, so the
+     * menu in the corner shows the picture rather than initials. The same function `admins()`
+     * takes: this package does not depend on the media one, and the panel is the only place
+     * that knows both are installed.
+     */
+    resolveAvatar?: AvatarResolver;
 }
 /**
  * Signing in, as a plugin rather than a section: it owns a route and a guard, and it has no
@@ -19,8 +27,8 @@ export { selectAdmin, selectAdmins, type AdminPickerOptions } from './selectAdmi
 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 { createAuthSession, provideAuth, useAuth, authKey, avatarResolverKey } from './session';
+export type { AuthSession, AvatarResolver, Credentials } from './session';
 export { default as WxLoginCard } from './LoginCard';
 export { default as WxUserMenu } from './UserMenu';
 export { authMessages } from './messages';