chore: added stricter types

Author: aryanjassal

src/client/handlers/AuthIdentityToken.ts

@@ -1,8 +1,9 @@
 import type {
   ClientRPCRequestParams,
   ClientRPCResponseResult,
+  IdentityResponseData,
+  TokenIdentityResponse,
 } from '../types.js';
-import type { SignedTokenEncoded, TokenPayload } from '../../tokens/types.js';
 import type KeyRing from '../../keys/KeyRing.js';
 import { IdSortable } from '@matrixai/id';
 import { UnaryHandler } from '@matrixai/rpc';
@@ -15,16 +16,16 @@ class AuthIdentityToken extends UnaryHandler<
     keyRing: KeyRing;
   },
   ClientRPCRequestParams,
-  ClientRPCResponseResult<SignedTokenEncoded>
+  ClientRPCResponseResult<TokenIdentityResponse>
 > {
-  public handle = async (): Promise<SignedTokenEncoded> => {
+  public handle = async (): Promise<TokenIdentityResponse> => {
     const { keyRing }: { keyRing: KeyRing } = this.container;
     const idGen = new IdSortable();
     const jti = idGen.next().value;
     if (jti == null) {
       throw new clientErrors.ErrorClientAuthenticationInvalidJTI();
     }
-    const outgoingToken = Token.fromPayload<TokenPayload>({
+    const outgoingToken = Token.fromPayload<IdentityResponseData>({
       jti: jti.toMultibase('base64'),
       exp: Math.floor(Date.now() / 1000) + 60, // 60 seconds after issuing
       iss: nodesUtils.encodeNodeId(keyRing.getNodeId()),

src/client/types.ts

@@ -21,6 +21,7 @@ import type {
 } from '../keys/types.js';
 import type { Notification } from '../notifications/types.js';
 import type { ProviderToken } from '../identities/types.js';
+import type { TokenPayload, SignedTokenEncoded } from '../tokens/types.js';
 import type { AuditMetricGetTypeOverride } from './callers/auditMetricGet.js';
 import type {
   NodeContact,
@@ -107,6 +108,14 @@ type TokenMessage = {
   token: ProviderToken;
 };
 
+type IdentityResponseData = TokenPayload & {
+  jti: string;
+  exp: number;
+  iss: NodeIdEncoded;
+};
+
+type TokenIdentityResponse = SignedTokenEncoded;
+
 // Nodes messages
 
 type NodeIdMessage = {
@@ -405,6 +414,8 @@ export type {
   ClaimIdMessage,
   ClaimNodeMessage,
   TokenMessage,
+  IdentityResponseData,
+  TokenIdentityResponse,
   NodeIdMessage,
   AddressMessage,
   NodeAddressMessage,

tests/client/handlers/auth.test.ts

@@ -1,3 +1,4 @@
+import type { IdentityResponseData } from '#src/client/types.js';
 import type { TLSConfig } from '#network/types.js';
 import fs from 'node:fs';
 import path from 'node:path';
@@ -89,7 +90,7 @@ describe('authIdentityToken', () => {
 
   test('should return a signed token', async () => {
     const identityToken = await rpcClient.methods.authIdentityToken({});
-    const decodedToken = Token.fromEncoded(identityToken);
+    const decodedToken = Token.fromEncoded<IdentityResponseData>(identityToken);
     const decodedPublicKey = keysUtils.publicKeyFromNodeId(keyRing.getNodeId());
     expect(decodedToken.verifyWithPublicKey(decodedPublicKey)).toBeTrue();
     const encodedNodeId = nodesUtils.encodeNodeId(keyRing.getNodeId());