Make types and enums more generic (#1)

* make types and enums more generic and fix login response for dapp provider base type

* 0.1.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@multiversx/sdk-dapp-utils",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "SDK for DApp utilities",
   "main": "out/index.js",
   "types": "out/index.d.js",

src/constants/browserConstants.ts

@@ -0,0 +1,6 @@
+type SafeWindowType<T extends Window = Window> = {
+  [K in keyof T]?: T[K];
+};
+
+export const safeWindow: SafeWindowType =
+  typeof window !== "undefined" ? window : ({} as SafeWindowType);

src/constants/index.ts

@@ -1 +1,2 @@
-export * from "./crossWindowProviderConstants";
+export * from "./windowProviderConstants";
+export * from "./browserConstants";

src/constants/windowProviderConstants.ts

@@ -0,0 +1,24 @@
+import { ResponseTypeMap } from "../types";
+import {
+  WindowProviderRequestEnums,
+  WindowProviderResponseEnums,
+} from "../enums";
+
+export const responseTypeMap: ResponseTypeMap = {
+  [WindowProviderRequestEnums.signTransactionsRequest]:
+    WindowProviderResponseEnums.signTransactionsResponse,
+  [WindowProviderRequestEnums.guardTransactionsRequest]:
+    WindowProviderResponseEnums.guardTransactionsResponse,
+  [WindowProviderRequestEnums.signMessageRequest]:
+    WindowProviderResponseEnums.signMessageResponse,
+  [WindowProviderRequestEnums.loginRequest]:
+    WindowProviderResponseEnums.loginResponse,
+  [WindowProviderRequestEnums.logoutRequest]:
+    WindowProviderResponseEnums.disconnectResponse,
+  [WindowProviderRequestEnums.cancelAction]:
+    WindowProviderResponseEnums.cancelResponse,
+  [WindowProviderRequestEnums.finalizeHandshakeRequest]:
+    WindowProviderResponseEnums.noneResponse,
+  [WindowProviderRequestEnums.finalizeResetStateRequest]:
+    WindowProviderResponseEnums.resetStateResponse,
+};

src/enums/index.ts

@@ -1 +1,2 @@
-export * from "./crossWindowProviderEnums";
+export * from "./windowProviderEnums";
+export * from "./signMessageStatusEnum";

src/enums/signMessageStatusEnum.ts

@@ -0,0 +1,6 @@
+export enum SignMessageStatusEnum {
+    pending = "pending",
+    failed = "failed",
+    signed = "signed",
+    cancelled = "cancelled",
+}

src/enums/crossWindowProviderEnums.ts → src/enums/windowProviderEnums.ts

@@ -1,4 +1,4 @@
-export enum CrossWindowProviderRequestEnums {
+export enum WindowProviderRequestEnums {
   signTransactionsRequest = "SIGN_TRANSACTIONS_REQUEST",
   guardTransactionsRequest = "GUARD_TRANSACTIONS_REQUEST",
   signMessageRequest = "SIGN_MESSAGE_REQUEST",
@@ -9,7 +9,7 @@ export enum CrossWindowProviderRequestEnums {
   finalizeResetStateRequest = "FINALIZE_RESET_STATE_REQUEST",
 }
 
-export enum CrossWindowProviderResponseEnums {
+export enum WindowProviderResponseEnums {
   handshakeResponse = "HANDSHAKE_RESPONSE",
   guardTransactionsResponse = "GUARD_TRANSACTIONS_RESPONSE",
   loginResponse = "LOGIN_RESPONSE",
@@ -19,11 +19,4 @@ export enum CrossWindowProviderResponseEnums {
   signMessageResponse = "SIGN_MESSAGE_RESPONSE",
   noneResponse = "NONE_RESPONSE",
   resetStateResponse = "RESET_STATE_RESPONSE",
-}
-
-export enum SignMessageStatusEnum {
-  pending = "pending",
-  failed = "failed",
-  signed = "signed",
-  cancelled = "cancelled",
-}
+}

src/models/dappProviderBase.ts

@@ -1,13 +1,19 @@
 import type { Transaction, SignableMessage } from "@multiversx/sdk-core";
-import { Nullable } from "../types/nullable";
+import { Nullable } from "../types";
 
 export interface IDAppProviderOptions {
   callbackUrl?: string;
   [key: string]: any;
 }
 
 export interface IDAppProviderBase {
-  login?(options?: IDAppProviderOptions): Promise<string | boolean>;
+  login?(options?: IDAppProviderOptions): Promise<string | boolean | {
+    address: string;
+    signature: string;
+    multisig?: string;
+    impersonate?: string;
+    [key: string]: unknown;
+  }>;
   logout(options?: IDAppProviderOptions): Promise<boolean>;
   signTransaction(
     transaction: Transaction,

src/types/index.ts

@@ -1,2 +1,2 @@
-export * from "./crossWindowProviderTypes";
+export * from "./windowProviderTypes";
 export * from "./nullable";

src/types/windowProviderTypes.ts

@@ -0,0 +1,107 @@
+import {
+  WindowProviderRequestEnums,
+  WindowProviderResponseEnums,
+  SignMessageStatusEnum,
+} from "../enums";
+import type { IPlainTransactionObject } from "@multiversx/sdk-core";
+
+export type ReplyWithPostMessageObjectType = {
+  [WindowProviderResponseEnums.handshakeResponse]: boolean;
+  [WindowProviderResponseEnums.loginResponse]: {
+    address: string;
+    accessToken?: string;
+    /**
+     * used in De-Fi wallet extension as wallet name
+     * */
+    name?: string;
+    signature?: string;
+    /**
+     * contract address for alternate multisig login
+     * */
+    multisig?: string;
+    /**
+     * custom address for alternate login
+     * */
+    impersonate?: string;
+  };
+  [WindowProviderResponseEnums.disconnectResponse]: boolean;
+  [WindowProviderResponseEnums.cancelResponse]: {
+    address: string;
+  };
+  [WindowProviderResponseEnums.signTransactionsResponse]: IPlainTransactionObject[];
+  [WindowProviderResponseEnums.guardTransactionsResponse]: IPlainTransactionObject[];
+  [WindowProviderResponseEnums.signMessageResponse]: {
+    signature?: string;
+    status: SignMessageStatusEnum;
+  };
+  [WindowProviderResponseEnums.noneResponse]: null;
+  [WindowProviderResponseEnums.resetStateResponse]: boolean;
+};
+
+export type ReplyWithPostMessagePayloadType<
+  K extends keyof ReplyWithPostMessageObjectType
+> = {
+  data?: ReplyWithPostMessageObjectType[K];
+  error?: string;
+};
+
+export type ReplyWithPostMessageType = {
+  [K in keyof ReplyWithPostMessageObjectType]: {
+    type: K;
+    payload: ReplyWithPostMessagePayloadType<K>;
+  };
+}[keyof ReplyWithPostMessageObjectType];
+
+export type ResponseTypeMap = {
+  [WindowProviderRequestEnums.signTransactionsRequest]: WindowProviderResponseEnums.signTransactionsResponse;
+  [WindowProviderRequestEnums.signMessageRequest]: WindowProviderResponseEnums.signMessageResponse;
+  [WindowProviderRequestEnums.loginRequest]: WindowProviderResponseEnums.loginResponse;
+  [WindowProviderRequestEnums.logoutRequest]: WindowProviderResponseEnums.disconnectResponse;
+  [WindowProviderRequestEnums.guardTransactionsRequest]: WindowProviderResponseEnums.guardTransactionsResponse;
+  [WindowProviderRequestEnums.cancelAction]: WindowProviderResponseEnums.cancelResponse;
+  [WindowProviderRequestEnums.finalizeHandshakeRequest]: WindowProviderResponseEnums.noneResponse;
+  [WindowProviderRequestEnums.finalizeResetStateRequest]: WindowProviderResponseEnums.resetStateResponse;
+};
+
+export type RequestPayloadType = {
+  [WindowProviderRequestEnums.loginRequest]: {
+    token: string | undefined;
+  };
+  [WindowProviderRequestEnums.logoutRequest]: undefined;
+  [WindowProviderRequestEnums.signTransactionsRequest]: IPlainTransactionObject[];
+  [WindowProviderRequestEnums.guardTransactionsRequest]: IPlainTransactionObject[];
+  [WindowProviderRequestEnums.signMessageRequest]: {
+    message: string;
+  };
+  [WindowProviderRequestEnums.cancelAction]: undefined;
+  [WindowProviderRequestEnums.finalizeHandshakeRequest]: undefined;
+  [WindowProviderRequestEnums.finalizeResetStateRequest]: undefined;
+};
+
+export type RequestMessageType = {
+  [K in keyof RequestPayloadType]: {
+    type: K;
+    payload: RequestPayloadType[K];
+  };
+}[keyof RequestPayloadType];
+
+export type ReplyWithPostMessageEventType = {
+  [K in keyof ReplyWithPostMessageObjectType]: {
+    type: WindowProviderResponseEnums;
+    payload: ReplyWithPostMessageObjectType[K];
+  };
+}[keyof ReplyWithPostMessageObjectType];
+
+export interface PostMessageParamsType<
+  T extends WindowProviderRequestEnums
+> {
+  type: T;
+  payload: RequestPayloadType[keyof RequestPayloadType];
+}
+
+export interface PostMessageReturnType<
+  T extends WindowProviderRequestEnums
+> {
+  type: ResponseTypeMap[T] | WindowProviderResponseEnums.cancelResponse;
+  payload: ReplyWithPostMessagePayloadType<ResponseTypeMap[T]>;
+}