feat(permissions): expose txGroupToTxTags from utils

Also modified the PermissionsLike interface

BREAKING CHANGE:
- `PermissionsLike.transactions` no longer accepts `TxGroup` values, there is now a separate `transactionGroups?: TxGroup[]` property
- `Permissions.transactionGroups` can no longer be null

src/api/entities/CurrentAccount.ts

@@ -38,7 +38,7 @@ export class CurrentAccount extends Account {
       return {
         tokens: null,
         transactions: null,
-        transactionGroups: null,
+        transactionGroups: [],
         portfolios: null,
       };
     }

src/api/entities/__tests__/AuthorizationRequest.ts

@@ -110,7 +110,7 @@ describe('AuthorizationRequest class', () => {
             value: {
               tokens: null,
               transactions: null,
-              transactionGroups: null,
+              transactionGroups: [],
               portfolios: null,
             },
           },
@@ -182,7 +182,7 @@ describe('AuthorizationRequest class', () => {
             value: {
               tokens: null,
               transactions: null,
-              transactionGroups: null,
+              transactionGroups: [],
               portfolios: null,
             },
           },

src/api/entities/__tests__/CurrentAccount.ts

@@ -60,7 +60,7 @@ describe('CurrentAccount class', () => {
       expect(result).toEqual({
         tokens: null,
         transactions: null,
-        transactionGroups: null,
+        transactionGroups: [],
         portfolios: null,
       });
     });

src/api/entities/__tests__/CurrentIdentity.ts

@@ -54,7 +54,7 @@ describe('CurrentIdentity class', () => {
           permissions: {
             tokens: null,
             transactions: null,
-            transactionGroups: null,
+            transactionGroups: [],
             portfolios: null,
           },
         },

src/api/procedures/__tests__/consumeJoinIdentityAuthorization.ts

@@ -85,7 +85,7 @@ describe('consumeJoinIdentityAuthorization procedure', () => {
             value: {
               tokens: null,
               transactions: null,
-              transactionGroups: null,
+              transactionGroups: [],
               portfolios: null,
             },
           },
@@ -119,7 +119,7 @@ describe('consumeJoinIdentityAuthorization procedure', () => {
             value: {
               tokens: null,
               transactions: null,
-              transactionGroups: null,
+              transactionGroups: [],
               portfolios: null,
             },
           },
@@ -159,7 +159,7 @@ describe('consumeJoinIdentityAuthorization procedure', () => {
             value: {
               tokens: null,
               transactions: null,
-              transactionGroups: null,
+              transactionGroups: [],
               portfolios: null,
             },
           },
@@ -192,7 +192,7 @@ describe('consumeJoinIdentityAuthorization procedure', () => {
             value: {
               tokens: null,
               transactions: null,
-              transactionGroups: null,
+              transactionGroups: [],
               portfolios: null,
             },
           },

src/api/procedures/__tests__/inviteAccount.ts

@@ -94,7 +94,7 @@ describe('inviteAccount procedure', () => {
               value: {
                 tokens: null,
                 transactions: null,
-                transactionGroups: null,
+                transactionGroups: [],
                 portfolios: null,
               },
             },
@@ -236,7 +236,7 @@ describe('inviteAccount procedure', () => {
               value: {
                 tokens: null,
                 transactions: null,
-                transactionGroups: null,
+                transactionGroups: [],
                 portfolios: null,
               },
             },

src/api/procedures/__tests__/registerIdentity.ts

@@ -65,7 +65,7 @@ describe('registerIdentity procedure', () => {
           tokens: null,
           portfolios: null,
           transactions: null,
-          transactionGroups: null,
+          transactionGroups: [],
         },
       },
     ];

src/api/procedures/__tests__/utils.ts

@@ -275,7 +275,7 @@ describe('assertSecondaryKeys', () => {
         permissions: {
           tokens: null,
           transactions: null,
-          transactionGroups: null,
+          transactionGroups: [],
           portfolios: null,
         },
       },
@@ -296,7 +296,7 @@ describe('assertSecondaryKeys', () => {
         permissions: {
           tokens: null,
           transactions: null,
-          transactionGroups: null,
+          transactionGroups: [],
           portfolios: null,
         },
       },

src/base/__tests__/Context.ts

@@ -775,7 +775,7 @@ describe('Context class', () => {
             tokens: null,
             portfolios: null,
             transactions: null,
-            transactionGroups: null,
+            transactionGroups: [],
           },
         },
       ];

src/types/index.ts

@@ -1,7 +1,6 @@
 import { Keyring } from '@polkadot/api';
 import { IKeyringPair, TypeDef } from '@polkadot/types/types';
 import BigNumber from 'bignumber.js';
-import { some, values } from 'lodash';
 import { TxTag, TxTags } from 'polymesh-types/types';
 
 import { StoDetails } from '~/api/entities/types';
@@ -541,9 +540,10 @@ export interface Permissions {
   transactions: TxTag[] | null;
   /**
    * list of Transaction Groups this key can execute. Having permissions over a TxGroup
-   *   means having permissions over every TxTag in said group
+   *   means having permissions over every TxTag in said group. Transaction permissions are the result of
+   *   combining these with the `transactions` array. If `transactions` is null, then this value is redundant
    */
-  transactionGroups: TxGroup[] | null;
+  transactionGroups: TxGroup[];
   /* list of Portfolios over which this key has permissions */
   portfolios: (DefaultPortfolio | NumberedPortfolio)[] | null;
 }
@@ -683,15 +683,15 @@ export enum TxGroup {
 }
 
 /**
- * @hidden
+ * Permissions to grant to a Signer over an Identity
+ *
+ * @note TxGroups in the `transactionGroups` array will be transformed into their corresponding `TxTag`s
+ *   and appended to the `transactions` array. If `transactions` is null, then the value of `transactionGroups` is redundant
  */
-export function isTxGroup(group: string): group is TxGroup {
-  return some(values(TxGroup), value => value === group);
-}
-
 export interface PermissionsLike {
   tokens?: (string | SecurityToken)[] | null;
-  transactions?: (TxTag | TxGroup)[] | null;
+  transactions?: TxTag[] | null;
+  transactionGroups?: TxGroup[];
   portfolios?: PortfolioLike[] | null;
 }
 

src/utils/__tests__/conversion.ts

@@ -799,7 +799,7 @@ describe('authorizationToAuthorizationData and authorizationDataToAuthorization'
       value: {
         tokens: null,
         transactions: null,
-        transactionGroups: null,
+        transactionGroups: [],
         portfolios: null,
       },
     };
@@ -1020,7 +1020,7 @@ describe('permissionsToMeshPermissions and meshPermissionsToPermissions', () =>
     let value: Permissions = {
       tokens: null,
       transactions: null,
-      transactionGroups: null,
+      transactionGroups: [],
       portfolios: null,
     };
     const fakeResult = ('convertedPermission' as unknown) as MeshPermissions;
@@ -1120,7 +1120,7 @@ describe('permissionsToMeshPermissions and meshPermissionsToPermissions', () =>
     fakeResult = {
       tokens: null,
       transactions: null,
-      transactionGroups: null,
+      transactionGroups: [],
       portfolios: null,
     };
     permissions = dsMockUtils.createMockPermissions({
@@ -3682,7 +3682,7 @@ describe('secondaryKeyToMeshSecondaryKey', () => {
       permissions: {
         tokens: null,
         transactions: null,
-        transactionGroups: null,
+        transactionGroups: [],
         portfolios: null,
       },
     };
@@ -4203,7 +4203,7 @@ describe('permissionsLikeToPermissions', () => {
     expect(result).toEqual({
       tokens: null,
       transactions: null,
-      transactionGroups: null,
+      transactionGroups: [],
       portfolios: null,
     });
 
@@ -4214,7 +4214,8 @@ describe('permissionsLikeToPermissions', () => {
 
     args = {
       tokens: [firstToken, ticker],
-      transactions: [TxTags.asset.Transfer, TxGroup.TrustedClaimIssuersManagement],
+      transactions: [TxTags.asset.Transfer],
+      transactionGroups: [TxGroup.TrustedClaimIssuersManagement],
       portfolios: [portfolio],
     };
     result = await permissionsLikeToPermissions(args, context);

src/utils/conversion.ts

@@ -14,6 +14,7 @@ import BigNumber from 'bignumber.js';
 import { computeWithoutCheck } from 'iso-7064';
 import {
   camelCase,
+  flatten,
   isEqual,
   map,
   padEnd,
@@ -116,7 +117,6 @@ import {
   InstructionType,
   isMultiClaimCondition,
   isSingleClaimCondition,
-  isTxGroup,
   KnownTokenType,
   MultiClaimCondition,
   Permissions,
@@ -513,7 +513,7 @@ export function textToString(value: Text): string {
 }
 
 /**
- * @hidden
+ * Retrieve every Transaction Tag associated to a Transaction Group
  */
 export function txGroupToTxTags(group: TxGroup): TxTag[] {
   switch (group) {
@@ -689,7 +689,7 @@ export function meshPermissionsToPermissions(
   return {
     tokens,
     transactions,
-    transactionGroups: transactions && txTagsToTxGroups(transactions),
+    transactionGroups: transactions ? txTagsToTxGroups(transactions) : [],
     portfolios,
   };
 }
@@ -2330,10 +2330,10 @@ export function permissionsLikeToPermissions(
 ): Permissions {
   let tokenPermissions: SecurityToken[] | null = [];
   let transactionPermissions: TxTag[] | null = [];
-  let transactionGroupPermissions: TxGroup[] | null = [];
+  let transactionGroupPermissions: TxGroup[] = [];
   let portfolioPermissions: (DefaultPortfolio | NumberedPortfolio)[] | null = [];
 
-  const { tokens, transactions, portfolios } = permissionsLike;
+  const { tokens, transactions, transactionGroups, portfolios } = permissionsLike;
 
   if (tokens === null) {
     tokenPermissions = null;
@@ -2344,29 +2344,14 @@ export function permissionsLikeToPermissions(
   }
 
   if (transactions !== undefined) {
-    const separated =
-      transactions &&
-      transactions.reduce<{ tags: TxTag[]; groups: TxGroup[] }>(
-        (prev, curr): { tags: TxTag[]; groups: TxGroup[] } => {
-          const { tags: prevTags, groups: prevGroups } = prev;
-          if (isTxGroup(curr)) {
-            return { tags: [...prevTags, ...txGroupToTxTags(curr)], groups: [...prevGroups, curr] };
-          } else {
-            return { tags: [...prevTags, curr], groups: prevGroups };
-          }
-        },
-        { tags: [], groups: [] }
-      );
-
-    if (separated) {
-      const { tags, groups } = separated;
+    transactionPermissions = transactions;
+  }
 
-      transactionPermissions = tags;
-      transactionGroupPermissions = groups;
-    } else {
-      transactionPermissions = null;
-      transactionGroupPermissions = null;
-    }
+  if (transactionGroups !== undefined) {
+    transactionGroupPermissions = uniq(transactionGroups);
+    const groupTags = flatten(transactionGroups.map(txGroupToTxTags));
+    transactionPermissions =
+      transactionPermissions && uniq([...transactionPermissions, ...groupTags]);
   }
 
   if (portfolios === null) {

src/utils/index.ts

@@ -1,2 +1,2 @@
-export { tickerToDid, isCusipValid, isLeiValid, isIsinValid } from './conversion';
+export { tickerToDid, isCusipValid, isLeiValid, isIsinValid, txGroupToTxTags } from './conversion';
 export { cryptoWaitReady } from '@polkadot/util-crypto';