feat(PMP-PK): added more options (removing shorthand,...) and documentation

Author: dozro

.changeset/add_limited_pk_command_support.md

@@ -0,0 +1,5 @@
+---
+default: minor
+---
+
+added a limited compatibility with `pk;member` commands

.changeset/add_pmp_shorthands.md

@@ -0,0 +1,5 @@
+---
+default: minor
+---
+
+added option to use shorthands to send a message with a Persona, for example `✨:test`

.changeset/fix_command_handling_for_usepmp.md

@@ -0,0 +1,5 @@
+---
+default: patch
+---
+
+rephrased the command describtion for `/usepmp` and made `/usepmp reset` actually reset the room association of the pmp

src/app/features/room/RoomInput.tsx

@@ -274,7 +274,8 @@ export const RoomInput = forwardRef<HTMLDivElement, RoomInputProps>(
       pluralkitProxyMessageHandler.init();
     }, [pluralkitProxyMessageHandler]);
 
-    const pkCompatEnable = useSetting(settingsAtom, 'pkCompat');
+    const [pkCompatEnable] = useSetting(settingsAtom, 'pkCompat');
+    const [pmpProxyingEnable] = useSetting(settingsAtom, 'pmpProxying');
     const emojiBtnRef = useRef<HTMLButtonElement>(null);
     const micBtnRef = useRef<HTMLButtonElement>(null);
     const roomToParents = useAtomValue(roomToParentsAtom);
@@ -789,11 +790,11 @@ export const RoomInput = forwardRef<HTMLDivElement, RoomInputProps>(
        * and also allows clients to display an accurate preview of how the message will look with the profile applied while it's being composed.
        */
       const perMessageProfile =
-        pkCompatEnable && pluralkitProxyMessageHandler.isAProxiedMessage(plainText)
+        pmpProxyingEnable && pluralkitProxyMessageHandler.isAProxiedMessage(plainText)
           ? await pluralkitProxyMessageHandler.getPmpBasedOnMessage(plainText)
           : await getCurrentlyUsedPerMessageProfileForRoom(mx, roomId);
 
-      if (pkCompatEnable && pluralkitProxyMessageHandler.isAProxiedMessage(plainText))
+      if (pmpProxyingEnable && pluralkitProxyMessageHandler.isAProxiedMessage(plainText))
         plainText = pluralkitProxyMessageHandler.stripProxyFromMessage(plainText) ?? plainText;
       if (perMessageProfile) {
         content['com.beeper.per_message_profile'] =
@@ -925,9 +926,10 @@ export const RoomInput = forwardRef<HTMLDivElement, RoomInputProps>(
       isMarkdown,
       canSendReaction,
       pkCompatEnable,
-      pluralkitProxyMessageHandler,
       replyDraft,
       silentReply,
+      pmpProxyingEnable,
+      pluralkitProxyMessageHandler,
       scheduledTime,
       editingScheduledDelayId,
       nicknames,

src/app/features/settings/Persona/PKCompat.tsx

@@ -0,0 +1,52 @@
+import { SequenceCard } from '$components/sequence-card';
+import { SettingTile } from '$components/setting-tile';
+import { useSetting } from '$state/hooks/settings';
+import { settingsAtom } from '$state/settings';
+import { Box, Switch, Text } from 'folds';
+import { SequenceCardStyle } from '../styles.css';
+
+export function PKCompatSettings() {
+  const [usePKCompat, setUsePKCompat] = useSetting(settingsAtom, 'pkCompat');
+  const [usePmpProxying, setUsePmpProxying] = useSetting(settingsAtom, 'pmpProxying');
+
+  return (
+    <Box direction="Column" gap="100">
+      <Text size="L400">Limited Compatibility with PluralKit-like functions</Text>
+      <SequenceCard
+        className={SequenceCardStyle}
+        variant="SurfaceVariant"
+        direction="Column"
+        gap="100"
+      >
+        <SettingTile
+          title="Enable PK commands"
+          description="If enabled, it will enable a few pk style commands, currently verry limited"
+          after={
+            <Switch
+              variant="Primary"
+              value={usePKCompat}
+              onChange={setUsePKCompat}
+              title={usePKCompat ? 'disable pk; commands' : 'enable pk; commands'}
+            />
+          }
+        />
+        <SettingTile
+          title="Enable Shorthands"
+          description="If enabled, you can use shorthands to use a Persona for one message only (eg. '✨:test')"
+          after={
+            <Switch
+              variant="Primary"
+              value={usePmpProxying}
+              onChange={setUsePmpProxying}
+              title={
+                usePmpProxying
+                  ? 'disable checking typed messages for shorthands'
+                  : 'enable checking typed messages for shorthands'
+              }
+            />
+          }
+        />
+      </SequenceCard>
+    </Box>
+  );
+}

src/app/features/settings/Persona/ProfilesPage.tsx

@@ -1,6 +1,7 @@
 import { Page, PageHeader, PageNavContent } from '$components/page';
 import { Box, IconButton, Icon, Icons, Text } from 'folds';
 import { PerMessageProfileOverview } from './PerMessageProfileOverview';
+import { PKCompatSettings } from './PKCompat';
 
 type PerMessageProfilePageProps = {
   requestClose: () => void;
@@ -37,6 +38,7 @@ export function PerMessageProfilePage({ requestClose }: PerMessageProfilePagePro
           direction="Column"
           shrink="No"
         >
+          <PKCompatSettings />
           <PerMessageProfileOverview />
         </Box>
       </PageNavContent>

src/app/hooks/useCommands.ts

@@ -32,6 +32,7 @@ import { useOpenBugReportModal } from '$state/hooks/bugReportModal';
 import { createRoomEncryptionState } from '$components/create-room';
 import { parsePronounsInput } from '$utils/pronouns';
 import { sendFeedback } from '$utils/sendFeedbackToUser';
+import { PKitCommandMessageHandler } from '$plugins/pluralkit-handler/PKitCommandMessageHandler';
 import { useRoomNavigate } from './useRoomNavigate';
 import { enrichWidgetUrl } from './useRoomWidgets';
 import { useUserProfile } from './useUserProfile';
@@ -241,6 +242,7 @@ export enum Command {
   AddPerMessageProfileToAccount = 'addpmp',
   DeletePerMessageProfileFromAccount = 'delpmp',
   UsePerMessageProfile = 'usepmp',
+  AssociateProxyPerMessageProfile = 'pmpproxy',
   Pronoun = 'pronoun',
   SPronoun = 'spronoun',
   Rainbow = 'rainbow',
@@ -276,6 +278,8 @@ export const useCommands = (mx: MatrixClient, room: Room): CommandRecord => {
   const { navigateRoom } = useRoomNavigate();
   const [developerTools] = useSetting(settingsAtom, 'developerTools');
   const [enableMSC4268CMD] = useSetting(settingsAtom, 'enableMSC4268CMD');
+  // helper for pkit commands
+  const pkitcmdHandler = useMemo(() => new PKitCommandMessageHandler(mx, room), [mx, room]);
   const profile = useUserProfile(mx.getSafeUserId());
   const openBugReport = useOpenBugReportModal();
 
@@ -601,6 +605,15 @@ export const useCommands = (mx: MatrixClient, room: Room): CommandRecord => {
             });
         },
       },
+      [Command.AssociateProxyPerMessageProfile]: {
+        name: Command.AssociateProxyPerMessageProfile,
+        description: 'Associate proxy with a profile. Example /pmpproxy id ✨:text',
+        exe: async (payload) => {
+          const pid: string = splitWithSpace(payload)[0];
+          const proxy: string = splitWithSpace(payload)[1];
+          pkitcmdHandler.handleMessage(`pk;member "${pid}" proxy ${proxy}`, true);
+        },
+      },
       [Command.MyRoomAvatar]: {
         name: Command.MyRoomAvatar,
         description: 'Change profile picture in current room. Example /myroomavatar mxc://xyzabc',
@@ -1437,6 +1450,7 @@ export const useCommands = (mx: MatrixClient, room: Room): CommandRecord => {
       room,
       profile.displayName,
       profile.avatarUrl,
+      pkitcmdHandler,
       developerTools,
       enableMSC4268CMD,
       openBugReport,

src/app/hooks/usePerMessageProfile.ts

@@ -420,6 +420,18 @@ export async function getAllPerMessageProfileProxies(
   return parr;
 }
 
+export async function dropProxyAssociationForPMP(mx: MatrixClient, proxy: string) {
+  const associations = getProxyAssociationMap(
+    mx.getAccountData(`${ACCOUNT_DATA_PREFIX}.proxyassociation` as any)?.getContent()
+  );
+  if (!associations) return;
+  associations.delete(proxy);
+  mx.setAccountData(
+    `${ACCOUNT_DATA_PREFIX}.proxyassociation` as any,
+    { associations: proxyAssociationsMapToObject(associations) } as any
+  );
+}
+
 /**
  *
  * drops all room associations for a profile, used when deleting a profile to make sure there are no dangling associations left that point to a non existing profile, which could cause issues when trying to apply the profile to a message in a room that still has an association for the deleted profile.

src/app/plugins/pluralkit-handler/PKitCommandMessageHandler.ts

@@ -1,6 +1,7 @@
 import {
   addOrUpdatePerMessageProfile,
   associateProxyWithProfile,
+  dropProxyAssociationForPMP,
   getAllPerMessageProfiles,
   getPerMessageProfileById,
   PerMessageProfile,
@@ -10,11 +11,15 @@ import { MatrixClient, Room } from 'matrix-js-sdk';
 
 const pkMemberRenameRegex = /^(pk;member)\s+"?([\w\s]+)"?\s*rename\s+"?([\w\s]+)"?$/;
 const pkMemberNewRegex = /^(pk;member)\s+new\s+"?([\w\s]+)"?$/;
-const pkMemberNewProxy = /^(pk;member)\s+"?([\w\s]+)"?\s+proxy\s+(.*text.*)$/;
+const pkMemberNewProxy = /^(pk;member)\s+"?([\w\s]+)"?\s+proxy(\s+add)?\s+(.*text.*)$/;
+const pkMemberRemoveProxy = /^(pk;member)\s+"?([\w\s]+)"?\s+proxy\s+remove\s+(.*text.*)$/;
 
 const helpTextPkMemberNew = 'To create a new persona: pk;member new Yumi';
 const helpTextPkMemberRename = 'To rename a persona: pk;member "Rain Deer" rename "Micky Mouse"';
-const helpTextPkMemberNewProxy = 'To create a persona: pk;member Yumi proxy [text]';
+const helpTextPkMemberNewProxy = 'To add a shorthand to a persona: pk;member Yumi proxy [text]';
+const helpTextPkMemberRemoveProxy =
+  'To remove a shorthand from a persona: pk;member Yumi proxy remove [text]';
+const helpTextPkMember = `Available 'pk;member' commands:\n${helpTextPkMemberNew}\n${helpTextPkMemberRename}\n${helpTextPkMemberNewProxy}\n${helpTextPkMemberRemoveProxy}`;
 
 /**
  * build a regex to recognize proxies
@@ -37,15 +42,32 @@ function buildRegex(template: string): RegExp {
  * @author Rye
  */
 export class PKitCommandMessageHandler {
+  /**
+   * the matrix client we use, is set in the constructor
+   *
+   * @private
+   * @type {MatrixClient}
+   * @memberof PKitCommandMessageHandler
+   */
   private readonly mx: MatrixClient;
 
   private message = '';
 
   private readonly room: Room;
 
+  /**
+   * flag to interpret the name given as id
+   *
+   * @private
+   * @type {boolean}
+   * @memberof PKitCommandMessageHandler
+   */
+  private useIdInsteadOfNameWherePossible: boolean;
+
   public constructor(mx: MatrixClient, room: Room) {
     this.mx = mx;
     this.room = room;
+    this.useIdInsteadOfNameWherePossible = false;
   }
 
   /**
@@ -127,15 +149,41 @@ export class PKitCommandMessageHandler {
         this.mx.getSafeUserId()
       );
       addOrUpdatePerMessageProfile(this.mx, pmp);
+    } else if (pkMemberRemoveProxy.test(this.message)) {
+      const cmdParts = pkMemberRemoveProxy.exec(this.message);
+      if (!cmdParts) return;
+      const name = cmdParts[2];
+      const matchAgainst = cmdParts[3];
+      const pmpId = this.useIdInsteadOfNameWherePossible
+        ? name
+        : (await getAllPerMessageProfiles(this.mx)).find((pmp) => pmp.name === name)?.id;
+      if (!pmpId) {
+        sendFeedback(
+          `Persona with ${this.useIdInsteadOfNameWherePossible ? 'id' : 'name'} "${name}" doesn't exist in your records, ${helpTextPkMemberNew}`,
+          this.room,
+          this.mx.getSafeUserId()
+        );
+        return;
+      }
+
+      dropProxyAssociationForPMP(this.mx, matchAgainst);
+
+      sendFeedback(
+        `Persona with ${this.useIdInsteadOfNameWherePossible ? 'id' : 'name'} "${name}" (${pmpId}) is now no longer associated with ${matchAgainst}`,
+        this.room,
+        this.mx.getSafeUserId()
+      );
     } else if (pkMemberNewProxy.test(this.message)) {
       const cmdParts = pkMemberNewProxy.exec(this.message);
       if (!cmdParts) return;
       const name = cmdParts[2];
-      const matchAgainst = cmdParts[3];
-      const pmpId = (await getAllPerMessageProfiles(this.mx)).find((pmp) => pmp.name === name)?.id;
+      const matchAgainst = cmdParts[4];
+      const pmpId = this.useIdInsteadOfNameWherePossible
+        ? name
+        : (await getAllPerMessageProfiles(this.mx)).find((pmp) => pmp.name === name)?.id;
       if (!pmpId) {
         sendFeedback(
-          `Persona with name "${name}" doesn't exist in your records, ${helpTextPkMemberNew}`,
+          `Persona with ${this.useIdInsteadOfNameWherePossible ? 'id' : 'name'} "${name}" doesn't exist in your records, ${helpTextPkMemberNew}`,
           this.room,
           this.mx.getSafeUserId()
         );
@@ -144,7 +192,7 @@ export class PKitCommandMessageHandler {
       const matchAgainstRegExp = buildRegex(matchAgainst);
       associateProxyWithProfile(this.mx, pmpId, matchAgainst, matchAgainstRegExp, false);
       sendFeedback(
-        `Persona with name "${name}" (${pmpId}) is now associated with ${matchAgainst}`,
+        `Persona with ${this.useIdInsteadOfNameWherePossible ? 'id' : 'name'} "${name}" (${pmpId}) is now associated with ${matchAgainst}`,
         this.room,
         this.mx.getSafeUserId()
       );
@@ -155,7 +203,7 @@ export class PKitCommandMessageHandler {
         .map((pmp: PerMessageProfile) => `${pmp.id}: ${pmp.name ? pmp.name : '(empty name)'}`)
         .join('\n');
       sendFeedback(
-        `You currently have the following persona set up:\n${stringListOfProfiles}\n\n${helpTextPkMemberNew}\n${helpTextPkMemberRename}\n${helpTextPkMemberNewProxy}`,
+        `If you see this, you have messed up a command\n\nYou currently have the following persona set up:\n${stringListOfProfiles}\n\n${helpTextPkMember}`,
         this.room,
         this.mx.getSafeUserId()
       );
@@ -176,9 +224,18 @@ export class PKitCommandMessageHandler {
    * @param message the message we want to handle
    * @returns void
    */
-  public async handleMessage(message: string): Promise<void> {
+  public async handleMessage(message: string, useId?: boolean): Promise<void> {
     this.message = message;
-    if (!this.message.startsWith('pk')) return;
-    if (this.message.startsWith('pk;member')) await this.memberHandler();
+    this.useIdInsteadOfNameWherePossible = useId ?? false;
+    if (!this.message.startsWith('pk;')) return;
+    if (this.message.startsWith('pk;member')) {
+      await this.memberHandler();
+      return;
+    }
+    sendFeedback(
+      `Command currently not supported, right now compatibility is limited and only a subset of pk;member is supported\n\n${helpTextPkMember}`,
+      this.room,
+      this.mx.getSafeUserId()
+    );
   }
 }

src/app/state/settings.ts

@@ -103,6 +103,7 @@ export interface Settings {
    * whether to enable pk compat
    */
   pkCompat: boolean;
+  pmpProxying: boolean;
 
   // furry stuff
   renderAnimals: boolean;
@@ -187,6 +188,7 @@ const defaultSettings: Settings = {
   faviconForMentionsOnly: false,
   highlightMentions: true,
   pkCompat: false,
+  pmpProxying: false,
 
   // furry stuff
   renderAnimals: true,