@dynamic-labs/message-transport 2.0.0-alpha.29 → 2.0.0-alpha.30

package/CHANGELOG.md

@@ -1,4 +1,15 @@
 
+## [2.0.0-alpha.30](https://github.com/dynamic-labs/DynamicAuth/compare/v2.0.0-alpha.29...v2.0.0-alpha.30) (2024-04-11)
+
+
+### ⚠ BREAKING CHANGES
+
+* add headless sms sign-in (#5274)
+
+### Features
+
+* add headless sms sign-in ([#5274](https://github.com/dynamic-labs/DynamicAuth/issues/5274)) ([fffc293](https://github.com/dynamic-labs/DynamicAuth/commit/fffc293f85447a784e8c728d1586f3555ab1fbfa))
+
 ## [2.0.0-alpha.29](https://github.com/dynamic-labs/DynamicAuth/compare/v2.0.0-alpha.28...v2.0.0-alpha.29) (2024-04-10)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamic-labs/message-transport",
-  "version": "2.0.0-alpha.29",
+  "version": "2.0.0-alpha.30",
   "repository": {
     "type": "git",
     "url": "https://github.com/dynamic-labs/DynamicAuth.git",
@@ -26,6 +26,7 @@
     "./package.json": "./package.json"
   },
   "peerDependencies": {
+    "@dynamic-labs/types": "2.0.0-alpha.30",
     "eventemitter3": "5.0.1"
   }
 }

package/src/index.cjs

@@ -8,6 +8,9 @@ var makeWaitForInitEvent = require('./messageTransport/decorators/makeWaitForIni
 var makeWaitForUnblock = require('./messageTransport/decorators/makeWaitForUnblock/makeWaitForUnblock.cjs');
 var requestChannel = require('./requestChannel/requestChannel.cjs');
 var parseMessageTransportData = require('./utils/parseMessageTransportData/parseMessageTransportData.cjs');
+var createEventEmitterForMessages = require('./store/createEventEmitterForMessages/createEventEmitterForMessages.cjs');
+var store = require('./store/store.cjs');
+var storeSetter = require('./store/storeSetter/storeSetter.cjs');
 var SdkModuleMessages = require('./messageTypes/SdkModuleMessages.cjs');
 
 
@@ -18,4 +21,7 @@ exports.makeWaitForInitEvent = makeWaitForInitEvent.makeWaitForInitEvent;
 exports.makeWaitForUnblock = makeWaitForUnblock.makeWaitForUnblock;
 exports.createRequestChannel = requestChannel.createRequestChannel;
 exports.parseMessageTransportData = parseMessageTransportData.parseMessageTransportData;
+exports.createEventEmitterForMessages = createEventEmitterForMessages.createEventEmitterForMessages;
+exports.createStore = store.createStore;
+exports.createStoreSetter = storeSetter.createStoreSetter;
 exports.sdkHasLoadedEventName = SdkModuleMessages.sdkHasLoadedEventName;

package/src/index.d.ts

@@ -1,4 +1,6 @@
 export { applyDefaultMessageOrigin, createMessageTransport, makeWaitForInitEvent, makeWaitForUnblock, type BypassBlockCallback, type MessageTransport, type MessageTransportCallback, type MessageTransportData, type MessageTransportDataOptionalOrigin, type MessageTransportWithDefaultOrigin, } from './messageTransport';
-export { type RequestChannel, createRequestChannel } from './requestChannel';
+export { createRequestChannel, type RequestChannel } from './requestChannel';
 export { parseMessageTransportData } from './utils/parseMessageTransportData';
-export { type ClientManifest, type SdkModuleMessages, sdkHasLoadedEventName, } from './messageTypes';
+export { createEventEmitterForMessages, createStore, createStoreSetter, type MessagesForEventEmitter, } from './store';
+export type { Store, StoreKeys, StoreSetter, StoreStateEvents, StoreStateGetters, } from './store/types';
+export { sdkHasLoadedEventName, type ClientManifest, type SdkModuleMessages, type SdkModuleState, type WalletsModuleState, } from './messageTypes';

package/src/index.js

@@ -4,4 +4,7 @@ export { makeWaitForInitEvent } from './messageTransport/decorators/makeWaitForI
 export { makeWaitForUnblock } from './messageTransport/decorators/makeWaitForUnblock/makeWaitForUnblock.js';
 export { createRequestChannel } from './requestChannel/requestChannel.js';
 export { parseMessageTransportData } from './utils/parseMessageTransportData/parseMessageTransportData.js';
+export { createEventEmitterForMessages } from './store/createEventEmitterForMessages/createEventEmitterForMessages.js';
+export { createStore } from './store/store.js';
+export { createStoreSetter } from './store/storeSetter/storeSetter.js';
 export { sdkHasLoadedEventName } from './messageTypes/SdkModuleMessages.js';

package/src/messageTypes/SdkModuleMessages.cjs

@@ -3,6 +3,6 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 /** Easy access to the event name that indicates the SDK has loaded */
-const sdkHasLoadedEventName = 'loaded';
+const sdkHasLoadedEventName = 'sdk__loadedChanged';
 
 exports.sdkHasLoadedEventName = sdkHasLoadedEventName;

package/src/messageTypes/SdkModuleMessages.d.ts

@@ -10,11 +10,13 @@ export type ClientManifest = {
     appLogoUrl?: string;
     cssOverrides?: string;
 };
+export type SdkModuleState = {
+    /** Indicates the SDK is set up and ready for requests */
+    loaded: boolean;
+};
 export type SdkModuleMessages = {
-    /** Sent from webview app to indicate the SDK is set up and ready for requests */
-    loaded: () => void;
     /** Sent from the webview app to request the SDK settings */
     manifest: () => Promise<ClientManifest>;
 };
 /** Easy access to the event name that indicates the SDK has loaded */
-export declare const sdkHasLoadedEventName: keyof SdkModuleMessages;
+export declare const sdkHasLoadedEventName = "sdk__loadedChanged";

package/src/messageTypes/SdkModuleMessages.js

@@ -1,4 +1,4 @@
 /** Easy access to the event name that indicates the SDK has loaded */
-const sdkHasLoadedEventName = 'loaded';
+const sdkHasLoadedEventName = 'sdk__loadedChanged';
 
 export { sdkHasLoadedEventName };

package/src/messageTypes/WalletsModuleMessages.d.ts

@@ -0,0 +1,5 @@
+import { BaseWallet } from '@dynamic-labs/types';
+export type WalletsModuleState = {
+    userWallets: BaseWallet[];
+    primaryWallet: BaseWallet | undefined;
+};

package/src/messageTypes/index.d.ts

@@ -1 +1,2 @@
 export * from './SdkModuleMessages';
+export * from './WalletsModuleMessages';

package/src/store/createEventEmitterForMessages/createEventEmitterForMessages.cjs

@@ -0,0 +1,23 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var EventEmitter = require('eventemitter3');
+var requestChannel = require('../../requestChannel/requestChannel.cjs');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var EventEmitter__default = /*#__PURE__*/_interopDefaultLegacy(EventEmitter);
+
+// There are way too many "any"s in this file. They are necessary because otherwise the generics won't work
+function createEventEmitterForMessages({ messageTransport, initialEventEmitter, key, }) {
+    const events = initialEventEmitter !== null && initialEventEmitter !== void 0 ? initialEventEmitter : new EventEmitter__default["default"]();
+    const requestChannel$1 = requestChannel.createRequestChannel(messageTransport);
+    requestChannel$1.handle('eventEmitted', (eventKey, eventName, payload) => {
+        if (eventKey === key)
+            events.emit(eventName, ...payload);
+    });
+    return events;
+}
+
+exports.createEventEmitterForMessages = createEventEmitterForMessages;

package/src/store/createEventEmitterForMessages/createEventEmitterForMessages.d.ts

@@ -0,0 +1,22 @@
+import EventEmitter from 'eventemitter3';
+import { MessageTransportWithDefaultOrigin } from '../../messageTransport';
+export type MessagesForEventEmitter<T extends Record<string, (...args: any[]) => any>, U extends string> = {
+    eventEmitted: <E extends keyof T>(key: U, eventName: E, payload: Parameters<T[E]>) => void;
+};
+/**
+ * Use this function when you want to get an event emitter that will raise events for
+ * messages of type MessagesForEventEmitter
+ */
+export declare function createEventEmitterForMessages<T extends Record<string, (...args: any[]) => any> = never, U extends string = never>(params: {
+    messageTransport: MessageTransportWithDefaultOrigin;
+    key: U;
+}): EventEmitter<T>;
+/**
+ * Use this function when you want to get an event emitter that will raise events for
+ * messages of type MessagesForEventEmitter
+ */
+export declare function createEventEmitterForMessages<T extends Record<string, (...args: any[]) => any> = never, U extends string = never, E extends EventEmitter<any> = never>(params: {
+    messageTransport: MessageTransportWithDefaultOrigin;
+    initialEventEmitter: E;
+    key: U;
+}): E extends EventEmitter<infer V> ? EventEmitter<T & V> : never;

package/src/store/createEventEmitterForMessages/createEventEmitterForMessages.js

@@ -0,0 +1,15 @@
+import EventEmitter from 'eventemitter3';
+import { createRequestChannel } from '../../requestChannel/requestChannel.js';
+
+// There are way too many "any"s in this file. They are necessary because otherwise the generics won't work
+function createEventEmitterForMessages({ messageTransport, initialEventEmitter, key, }) {
+    const events = initialEventEmitter !== null && initialEventEmitter !== void 0 ? initialEventEmitter : new EventEmitter();
+    const requestChannel = createRequestChannel(messageTransport);
+    requestChannel.handle('eventEmitted', (eventKey, eventName, payload) => {
+        if (eventKey === key)
+            events.emit(eventName, ...payload);
+    });
+    return events;
+}
+
+export { createEventEmitterForMessages };

package/src/store/createEventEmitterForMessages/index.d.ts

@@ -0,0 +1 @@
+export * from './createEventEmitterForMessages';

package/src/store/index.d.ts

@@ -1 +1,3 @@
+export * from './createEventEmitterForMessages';
 export * from './store';
+export * from './storeSetter';

package/src/store/store.cjs

@@ -0,0 +1,57 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var EventEmitter = require('eventemitter3');
+var requestChannel = require('../requestChannel/requestChannel.cjs');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var EventEmitter__default = /*#__PURE__*/_interopDefaultLegacy(EventEmitter);
+
+const createStore = ({ initialState, key, messageTransport, }) => {
+    // We don't know what these types are yet, so any will do
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const requestChannel$1 = requestChannel.createRequestChannel(messageTransport);
+    /**
+     * The event emitter for this store getter.
+     *
+     * Not to be confused with the events that come from the messageTransport:
+     * - The messageTransport is a tool for sending/receiving messages to/from a webview.
+     * - This event emitter allows raising events exclusively for change events of this store's variables,
+     * and will only be used by the modules that are reading from the store, most likely to be forwarded
+     * for clients to have access to.
+     */
+    const eventEmitter = new EventEmitter__default["default"]();
+    const state = Object.assign({}, initialState);
+    const getters = {};
+    for (const variable in state) {
+        // Add the state getter
+        Object.defineProperty(getters, variable, {
+            get: () => state[variable],
+        });
+        // We need to add a listener for each of this store's variables.
+        // That listener will listen for messageTransport "value changed" events,
+        // which we will use to update the store's values and raise events.
+        const messageName = `${key}__${variable}Changed`;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        requestChannel$1.handle(messageName, (newValue) => {
+            const eventName = `${variable}Changed`;
+            // We emit with the same event name for simplicity, but keep in mind
+            // the eventEmitter events are different from the messageTransport message we are handling.
+            // Read above for elaboration.
+            //
+            // There are some limitation on what we can achieve with typescript in this file,
+            // but all this is encapsulated in this function and it works like a charm for whoever calls it.
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            eventEmitter.emit(eventName, newValue);
+            state[variable] = newValue;
+        });
+    }
+    return {
+        eventEmitter,
+        getters,
+    };
+};
+
+exports.createStore = createStore;

package/src/store/store.js

@@ -0,0 +1,49 @@
+import EventEmitter from 'eventemitter3';
+import { createRequestChannel } from '../requestChannel/requestChannel.js';
+
+const createStore = ({ initialState, key, messageTransport, }) => {
+    // We don't know what these types are yet, so any will do
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const requestChannel = createRequestChannel(messageTransport);
+    /**
+     * The event emitter for this store getter.
+     *
+     * Not to be confused with the events that come from the messageTransport:
+     * - The messageTransport is a tool for sending/receiving messages to/from a webview.
+     * - This event emitter allows raising events exclusively for change events of this store's variables,
+     * and will only be used by the modules that are reading from the store, most likely to be forwarded
+     * for clients to have access to.
+     */
+    const eventEmitter = new EventEmitter();
+    const state = Object.assign({}, initialState);
+    const getters = {};
+    for (const variable in state) {
+        // Add the state getter
+        Object.defineProperty(getters, variable, {
+            get: () => state[variable],
+        });
+        // We need to add a listener for each of this store's variables.
+        // That listener will listen for messageTransport "value changed" events,
+        // which we will use to update the store's values and raise events.
+        const messageName = `${key}__${variable}Changed`;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        requestChannel.handle(messageName, (newValue) => {
+            const eventName = `${variable}Changed`;
+            // We emit with the same event name for simplicity, but keep in mind
+            // the eventEmitter events are different from the messageTransport message we are handling.
+            // Read above for elaboration.
+            //
+            // There are some limitation on what we can achieve with typescript in this file,
+            // but all this is encapsulated in this function and it works like a charm for whoever calls it.
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            eventEmitter.emit(eventName, newValue);
+            state[variable] = newValue;
+        });
+    }
+    return {
+        eventEmitter,
+        getters,
+    };
+};
+
+export { createStore };

package/src/store/storeSetter/storeSetter.cjs

@@ -0,0 +1,22 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var requestChannel = require('../../requestChannel/requestChannel.cjs');
+
+const createStoreSetter = ({ key, messageTransport, }) => {
+    // We don't know what these types are yet, so any will do
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const requestChannel$1 = requestChannel.createRequestChannel(messageTransport);
+    return {
+        set: (newValues) => {
+            const entries = Object.entries(newValues);
+            for (const [variable, newValue] of entries) {
+                const messageName = `${key}__${variable}Changed`;
+                requestChannel$1.emit(messageName, newValue);
+            }
+        },
+    };
+};
+
+exports.createStoreSetter = createStoreSetter;

package/src/store/storeSetter/storeSetter.js

@@ -0,0 +1,18 @@
+import { createRequestChannel } from '../../requestChannel/requestChannel.js';
+
+const createStoreSetter = ({ key, messageTransport, }) => {
+    // We don't know what these types are yet, so any will do
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const requestChannel = createRequestChannel(messageTransport);
+    return {
+        set: (newValues) => {
+            const entries = Object.entries(newValues);
+            for (const [variable, newValue] of entries) {
+                const messageName = `${key}__${variable}Changed`;
+                requestChannel.emit(messageName, newValue);
+            }
+        },
+    };
+};
+
+export { createStoreSetter };

package/src/store/types.d.ts

@@ -1,4 +1,5 @@
 import EventEmitter from 'eventemitter3';
+export type StoreKeys = 'sdk' | 'wallets';
 /**
  * Readonly getters for the store values
  */
@@ -10,7 +11,7 @@ export type StoreStateGetters<T extends Record<string, unknown>> = {
  */
 export type Store<T extends Record<string, unknown>> = {
     getters: StoreStateGetters<T>;
-    emitters: Pick<EventEmitter<StoreStateEvents<T>>, 'on' | 'once' | 'off'>;
+    eventEmitter: EventEmitter<StoreStateEvents<T>>;
 };
 /**
  * The type of a setter that allows setting values of all stores connected to the same