@geekity/cms 0.3.0 → 0.4.0

package/dist/admin/users.d.ts

@@ -1,22 +1,90 @@
 import type { Hono } from 'hono';
 import type { GeekityEnv } from '../env.ts';
+import type { ProfileLink, User } from './accounts.ts';
 import type { AdminRender } from './documents.ts';
-import type { User } from './store.ts';
-/** Where the users screen lives. The add form posts here too. */
+/** Where the list of users lives. */
 export declare const USERS_PATH = "/admin/users";
+/**
+ * Where the add form lives, and where it posts.
+ *
+ * A screen of its own rather than a panel under the table, because the menu
+ * says Users > Add new and a menu entry has to be somewhere to go. It is also
+ * what keeps a refused add on a page about adding somebody instead of at the
+ * top of a list of everybody.
+ */
+export declare const ADD_USER_PATH = "/admin/users/new";
+/**
+ * Where one user is edited.
+ *
+ * The split documents.ts already makes between a listing and `basePath/:slug`
+ * (TASK-97): the table says who there is, and one screen per person holds
+ * every field that person has, each with a label beside it. A row of
+ * unlabelled boxes in a table cell could not.
+ */
+export declare function editUserPath(id: number): string;
 /** Where the signed-in admin's change-password form posts. */
 export declare const CHANGE_PASSWORD_PATH = "/admin/users/password";
-/** Where a row's delete button posts. */
+/** Where a delete button posts, on the list or on the user's own screen. */
 export declare const DELETE_USER_PATH = "/admin/users/delete";
-/** The fields the three forms on the screen submit. */
+/** Where the email address on the Account panel posts. */
+export declare const USER_EMAIL_PATH = "/admin/users/email";
+/**
+ * Where the Profile panel posts.
+ *
+ * A path of its own rather than a second half of the email form, because the
+ * two are about different audiences: an email address is private to the site
+ * and a profile is the public face decision-14 puts at the author URL. One
+ * form that saved both would mean an admin correcting a colleague's address
+ * also republishing their bio.
+ */
+export declare const USER_PROFILE_PATH = "/admin/users/profile";
+/** Where the notice switches post. */
+export declare const USER_NOTIFICATIONS_PATH = "/admin/users/notifications";
+/**
+ * Where the how-often selects post.
+ *
+ * A path of its own rather than a second field on the switch, because the two
+ * forms answer different questions and a switch is a button while a mode is a
+ * select and a Save: one handler that had to work out which of the two it had
+ * been given would be guessing at something the URL can simply say.
+ */
+export declare const USER_NOTIFICATION_MODE_PATH = "/admin/users/notifications/mode";
+/** The fields the forms on these screens submit. */
 export declare const USER_FIELDS: {
     readonly username: 'username';
     readonly password: 'password';
+    readonly email: 'email';
     readonly generate: 'generate';
     readonly currentPassword: 'current_password';
     readonly newPassword: 'new_password';
     readonly newPasswordConfirmation: 'new_password_confirmation';
     readonly userId: 'user_id';
+    /** Which notice a switch is about, by its name in the registry. */
+    readonly event: 'event';
+    /**
+     * Whether that notice is wanted.
+     *
+     * A checkbox, so a form that turns one off submits nothing at all under this
+     * name — which is why the switch is a form of its own per event rather than
+     * one form with a checkbox per event: a browser sends no field for an
+     * unticked box, and one form could not tell "turned this off" from "did not
+     * mention it".
+     */
+    readonly on: 'on';
+    /** How often that notice should arrive, for an event that offers a choice. */
+    readonly mode: 'mode';
+    /** The name to print instead of the login (TASK-67). */
+    readonly displayName: 'display_name';
+    /** A few sentences about this person. */
+    readonly bio: 'bio';
+    /** Their picture, as a path or a URL. */
+    readonly avatar: 'avatar';
+    /** What they do, printed beside the name in a bio (TASK-79). */
+    readonly jobTitle: 'job_title';
+    /** Where they are, as they write it. */
+    readonly location: 'location';
+    /** Somewhere else they are: one `Label | URL` per line. */
+    readonly links: 'links';
 };
 /** What {@link mountUsers} needs from the admin around it. */
 export interface MountUsersOptions {
@@ -24,14 +92,18 @@ export interface MountUsersOptions {
     render: AdminRender;
 }
 /**
- * Register the users screen: the list, the add form, and the change-password
- * form for whoever is signed in.
+ * Register the users screens: the list, the add form, and one screen per user
+ * where everything about that person is edited.
  *
- * There is one role, so there is nothing to edit about somebody else: an admin
- * can add a user, delete one, and change their own password. Changing
- * somebody else's is deliberately not offered — resetting a colleague's
- * password from under them is what `geekity user add` and a fresh account are
- * for, and it keeps the current-password check honest.
+ * The same split documents.ts makes (TASK-97). The table says who there is;
+ * a person's own screen holds their email address, their public profile, what
+ * they are emailed about, and — where the account can go — the delete. Every
+ * save lands back on that screen, so it shows its own result.
+ *
+ * One thing is still only ever your own: the password. Changing somebody
+ * else's is deliberately not offered — resetting a colleague's password from
+ * under them is what `geekity user add` and a fresh account are for, and it
+ * keeps the current-password check honest.
  */
 export declare function mountUsers(app: Hono<GeekityEnv>, options: MountUsersOptions): void;
 /**
@@ -72,6 +144,7 @@ export declare function changePasswordProblems(input: {
 export type AddUserProblems = {
     username?: string;
     password?: string;
+    email?: string;
 };
 /**
  * What is wrong with a proposed user, one message per field.
@@ -80,9 +153,10 @@ export type AddUserProblems = {
  * `/admin/setup` and `geekity user add` would both have accepted. A generated
  * password is not checked against them — it is made to satisfy them — and the
  * password field is not read at all when the box is ticked, so a stale value
- * left in it cannot be what is refused.
+ * left in it cannot be what is refused. An empty email is not a problem: it is
+ * an optional field, and most users will never have one.
  */
-export declare function addUserProblems(username: string, password: string, generate?: boolean): AddUserProblems;
+export declare function addUserProblems(username: string, password: string, generate?: boolean, email?: string): AddUserProblems;
 /**
  * The alphabet a generated password is drawn from: no `0`/`O` and no `1`/`l`,
  * because a generated password is read off a screen and typed somewhere else.
@@ -92,4 +166,17 @@ export declare const GENERATED_PASSWORD_ALPHABET = "ABCDEFGHJKLMNPQRSTUVWXYZabcd
 export declare const GENERATED_PASSWORD_LENGTH = 20;
 /** A password nobody chose, from `randomInt` rather than `Math.random`. */
 export declare function generatePassword(): string;
+/**
+ * A textarea of links as the list a profile stores: one per line, `Label |
+ * URL`, or a bare URL that labels itself.
+ *
+ * A textarea rather than a repeating fieldset because a profile has two or
+ * three links and a table row has no space for a widget; the separator is a
+ * pipe because it is the one character nobody puts in a link label by
+ * accident. Blank lines are skipped and the empties are dropped inside
+ * `setUserProfile`, so a list somebody emptied leaves no key behind.
+ */
+export declare function parseProfileLinks(value: string): ProfileLink[];
+/** A stored list of links back as the textarea shows it. */
+export declare function formatProfileLinks(links: readonly ProfileLink[] | undefined): string;
 //# sourceMappingURL=users.d.ts.map

package/dist/admin/users.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../src/admin/users.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAEjC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAE5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAIlD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAGvC,iEAAiE;AACjE,eAAO,MAAM,UAAU,iBAA0B,CAAC;AAElD,8DAA8D;AAC9D,eAAO,MAAM,oBAAoB,0BAA2B,CAAC;AAE7D,yCAAyC;AACzC,eAAO,MAAM,gBAAgB,wBAAyB,CAAC;AAEvD,uDAAuD;AACvD,eAAO,MAAM,WAAW;aACtB,QAAQ,EAAE,UAAU;aACpB,QAAQ,EAAE,UAAU;aACpB,QAAQ,EAAE,UAAU;aACpB,eAAe,EAAE,kBAAkB;aACnC,WAAW,EAAE,cAAc;aAC3B,uBAAuB,EAAE,2BAA2B;aACpD,MAAM,EAAE,SAAS;CACT,CAAC;AAEX,8DAA8D;AAC9D,MAAM,WAAW,iBAAiB;IAChC,oFAAoF;IACpF,MAAM,EAAE,WAAW,CAAC;CACrB;AAED;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAiHlF;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE;IACvC,yEAAyE;IACzE,MAAM,EAAE,IAAI,GAAG,SAAS,CAAC;IACzB,qBAAqB;IACrB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;CACf,GAAG,MAAM,GAAG,SAAS,CASrB;AAED,uEAAuE;AACvE,MAAM,MAAM,sBAAsB,GAAG;IAAE,eAAe,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAExF;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE;IAC5C,oEAAoE;IACpE,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;CACtB,GAAG,sBAAsB,CAYzB;AAOD,2DAA2D;AAC3D,MAAM,MAAM,eAAe,GAAG;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvE;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,QAAQ,UAAQ,GACf,eAAe,CAYjB;AAED;;;GAGG;AACH,eAAO,MAAM,2BAA2B,8DACqB,CAAC;AAE9D,+EAA+E;AAC/E,eAAO,MAAM,yBAAyB,KAAK,CAAC;AAE5C,2EAA2E;AAC3E,wBAAgB,gBAAgB,IAAI,MAAM,CAMzC"}
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../src/admin/users.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAEjC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAsB5C,OAAO,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAEvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAMlD,qCAAqC;AACrC,eAAO,MAAM,UAAU,iBAA0B,CAAC;AAElD;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,qBAAsB,CAAC;AAEjD;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAE/C;AAcD,8DAA8D;AAC9D,eAAO,MAAM,oBAAoB,0BAA2B,CAAC;AAE7D,4EAA4E;AAC5E,eAAO,MAAM,gBAAgB,wBAAyB,CAAC;AAEvD,0DAA0D;AAC1D,eAAO,MAAM,eAAe,uBAAwB,CAAC;AAErD;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,yBAA0B,CAAC;AAEzD,sCAAsC;AACtC,eAAO,MAAM,uBAAuB,+BAAgC,CAAC;AAErE;;;;;;;GAOG;AACH,eAAO,MAAM,2BAA2B,oCAAoC,CAAC;AAE7E,oDAAoD;AACpD,eAAO,MAAM,WAAW;aACtB,QAAQ,EAAE,UAAU;aACpB,QAAQ,EAAE,UAAU;aACpB,KAAK,EAAE,OAAO;aACd,QAAQ,EAAE,UAAU;aACpB,eAAe,EAAE,kBAAkB;aACnC,WAAW,EAAE,cAAc;aAC3B,uBAAuB,EAAE,2BAA2B;aACpD,MAAM,EAAE,SAAS;IACjB,mEAAmE;aACnE,KAAK,EAAE,OAAO;IACd;;;;;;;;OAQG;aACH,EAAE,EAAE,IAAI;IACR,8EAA8E;aAC9E,IAAI,EAAE,MAAM;IACZ,wDAAwD;aACxD,WAAW,EAAE,cAAc;IAC3B,yCAAyC;aACzC,GAAG,EAAE,KAAK;IACV,yCAAyC;aACzC,MAAM,EAAE,QAAQ;IAChB,gEAAgE;aAChE,QAAQ,EAAE,WAAW;IACrB,wCAAwC;aACxC,QAAQ,EAAE,UAAU;IACpB,2DAA2D;aAC3D,KAAK,EAAE,OAAO;CACN,CAAC;AAEX,8DAA8D;AAC9D,MAAM,WAAW,iBAAiB;IAChC,oFAAoF;IACpF,MAAM,EAAE,WAAW,CAAC;CACrB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,iBAAiB,GAAG,IAAI,CA+TlF;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE;IACvC,yEAAyE;IACzE,MAAM,EAAE,IAAI,GAAG,SAAS,CAAC;IACzB,qBAAqB;IACrB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;CACf,GAAG,MAAM,GAAG,SAAS,CASrB;AAED,uEAAuE;AACvE,MAAM,MAAM,sBAAsB,GAAG;IAAE,eAAe,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAExF;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE;IAC5C,oEAAoE;IACpE,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;CACtB,GAAG,sBAAsB,CAYzB;AAOD,2DAA2D;AAC3D,MAAM,MAAM,eAAe,GAAG;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvF;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,QAAQ,UAAQ,EAChB,KAAK,SAAK,GACT,eAAe,CAejB;AAED;;;GAGG;AACH,eAAO,MAAM,2BAA2B,8DACqB,CAAC;AAE9D,+EAA+E;AAC/E,eAAO,MAAM,yBAAyB,KAAK,CAAC;AAE5C,2EAA2E;AAC3E,wBAAgB,gBAAgB,IAAI,MAAM,CAMzC;AA2FD;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,EAAE,CAmB9D;AAED,4DAA4D;AAC5D,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,SAAS,WAAW,EAAE,GAAG,SAAS,GAAG,MAAM,CAIpF"}