@dynamic-labs/client 2.1.0-alpha.25 → 2.1.0-alpha.26

package/CHANGELOG.md

@@ -1,4 +1,17 @@
 
+## [2.1.0-alpha.26](https://github.com/dynamic-labs/DynamicAuth/compare/v2.1.0-alpha.25...v2.1.0-alpha.26) (2024-05-29)
+
+
+### Features
+
+* add farcaster login to react native ([#5713](https://github.com/dynamic-labs/DynamicAuth/issues/5713)) ([08f4473](https://github.com/dynamic-labs/DynamicAuth/commit/08f4473eec9b32b82b6f703fa4d5136514a61b25))
+
+
+### Bug Fixes
+
+* better error handling of invalid mfa otp ([#5759](https://github.com/dynamic-labs/DynamicAuth/issues/5759)) ([72ab01f](https://github.com/dynamic-labs/DynamicAuth/commit/72ab01f8f919f147eeedfabf8b4838802abf308a))
+* show correct status for magic eden btc wallets after ([#5748](https://github.com/dynamic-labs/DynamicAuth/issues/5748)) ([b8f20bb](https://github.com/dynamic-labs/DynamicAuth/commit/b8f20bb796b9a2e88817ef3b0da6ac32e9012b18))
+
 ## [2.1.0-alpha.25](https://github.com/dynamic-labs/DynamicAuth/compare/v2.1.0-alpha.24...v2.1.0-alpha.25) (2024-05-27)
 
 

package/package.cjs

@@ -3,6 +3,6 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var version = "2.1.0-alpha.25";
+var version = "2.1.0-alpha.26";
 
 exports.version = version;

package/package.js

@@ -1,4 +1,4 @@
 'use client'
-var version = "2.1.0-alpha.25";
+var version = "2.1.0-alpha.26";
 
 export { version };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamic-labs/client",
-  "version": "2.1.0-alpha.25",
+  "version": "2.1.0-alpha.26",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/dynamic-labs/dynamic-auth.git",
@@ -26,12 +26,12 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@dynamic-labs/message-transport": "2.1.0-alpha.25",
+    "@dynamic-labs/message-transport": "2.1.0-alpha.26",
     "@vue/reactivity": "3.4.21"
   },
   "peerDependencies": {
-    "@dynamic-labs/logger": "2.1.0-alpha.25",
-    "@dynamic-labs/types": "2.1.0-alpha.25",
+    "@dynamic-labs/logger": "2.1.0-alpha.26",
+    "@dynamic-labs/types": "2.1.0-alpha.26",
     "eventemitter3": "5.0.1"
   }
 }

package/src/client/core/core.cjs

@@ -19,6 +19,7 @@ const messageTransport = messageTransport$1.applyDefaultMessageOrigin({
 // messageTransport.on((message) =>
 //   console.log('message', JSON.stringify(message, null, 2)),
 // );
+const initialization = initializationModule.createInitializationModule(messageTransport);
 const createCore = (props) => ({
     /**
      * Allows an extension to add its name to the list, such that
@@ -31,11 +32,11 @@ const createCore = (props) => ({
     /**
      * SDK initialization module handles the initialization error
      */
-    initialization: initializationModule.createInitializationModule(messageTransport),
+    initialization,
     /**
      * Manages the manifest of the host
      */
-    manifest: manifestModule.createManifestModule(props, messageTransport),
+    manifest: manifestModule.createManifestModule(props, messageTransport, initialization),
     /**
      * Message transport that will be used to send and receive messages to the webview.
      * Should preferably be used with createRequestChannel, rather than used directly.

package/src/client/core/core.d.ts

@@ -16,15 +16,13 @@ export declare const createCore: (props: ClientProps) => {
     /**
      * SDK initialization module handles the initialization error
      */
-    initialization: {
-        get error(): Error | null;
-        set error(error: Error);
-    };
+    initialization: import("./modules/initializationModule/initializationModule").InitializationModule;
     /**
      * Manages the manifest of the host
      */
     manifest: {
         setAppOrigin: (appOrigin: string) => string;
+        setPlatform: (platform: "browser" | "react-native") => "browser" | "react-native";
     };
     /**
      * Message transport that will be used to send and receive messages to the webview.

package/src/client/core/core.js

@@ -15,6 +15,7 @@ const messageTransport = applyDefaultMessageOrigin({
 // messageTransport.on((message) =>
 //   console.log('message', JSON.stringify(message, null, 2)),
 // );
+const initialization = createInitializationModule(messageTransport);
 const createCore = (props) => ({
     /**
      * Allows an extension to add its name to the list, such that
@@ -27,11 +28,11 @@ const createCore = (props) => ({
     /**
      * SDK initialization module handles the initialization error
      */
-    initialization: createInitializationModule(messageTransport),
+    initialization,
     /**
      * Manages the manifest of the host
      */
-    manifest: createManifestModule(props, messageTransport),
+    manifest: createManifestModule(props, messageTransport, initialization),
     /**
      * Message transport that will be used to send and receive messages to the webview.
      * Should preferably be used with createRequestChannel, rather than used directly.

package/src/client/core/modules/initializationModule/initializationModule.d.ts

@@ -1,5 +1,6 @@
 import { MessageTransportWithDefaultOrigin } from '@dynamic-labs/message-transport';
-export declare const createInitializationModule: (messageTransport: MessageTransportWithDefaultOrigin) => {
+export type InitializationModule = {
     get error(): Error | null;
     set error(error: Error);
 };
+export declare const createInitializationModule: (messageTransport: MessageTransportWithDefaultOrigin) => InitializationModule;

package/src/client/core/modules/manifestModule/{utils/manifest/manifest.cjs → createPartialManifest/createPartialManifest.cjs}

@@ -3,9 +3,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var _package = require('../../../../../../../package.cjs');
+var _package = require('../../../../../../package.cjs');
 
-const createManifest = ({ apiBaseUrl, environmentId, appLogoUrl, appName, cssOverrides, }) => ({
+const createPartialManifest = ({ apiBaseUrl, environmentId, appLogoUrl, appName, cssOverrides, }) => ({
     apiBaseUrl,
     appLogoUrl,
     appName,
@@ -14,4 +14,4 @@ const createManifest = ({ apiBaseUrl, environmentId, appLogoUrl, appName, cssOve
     environmentId,
 });
 
-exports.createManifest = createManifest;
+exports.createPartialManifest = createPartialManifest;

package/src/client/core/modules/manifestModule/createPartialManifest/createPartialManifest.d.ts

@@ -0,0 +1,3 @@
+import type { ClientManifest } from '@dynamic-labs/message-transport';
+import { ClientProps } from '../../../../client';
+export declare const createPartialManifest: ({ apiBaseUrl, environmentId, appLogoUrl, appName, cssOverrides, }: ClientProps) => Partial<ClientManifest>;

package/src/client/core/modules/manifestModule/createPartialManifest/createPartialManifest.js

@@ -0,0 +1,13 @@
+'use client'
+import { version } from '../../../../../../package.js';
+
+const createPartialManifest = ({ apiBaseUrl, environmentId, appLogoUrl, appName, cssOverrides, }) => ({
+    apiBaseUrl,
+    appLogoUrl,
+    appName,
+    clientVersion: version,
+    cssOverrides,
+    environmentId,
+});
+
+export { createPartialManifest };

package/src/client/core/modules/manifestModule/createPartialManifest/index.d.ts

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

package/src/client/core/modules/manifestModule/manifestModule.cjs

@@ -5,17 +5,30 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var _tslib = require('../../../../../_virtual/_tslib.cjs');
 var messageTransport = require('@dynamic-labs/message-transport');
-var manifest = require('./utils/manifest/manifest.cjs');
+var logger = require('../../../../utils/logger/logger.cjs');
+var createPartialManifest = require('./createPartialManifest/createPartialManifest.cjs');
+var validateManifest = require('./validateManifest/validateManifest.cjs');
 
 /**
  * Manifest module handles the client manifest that will be requested by the webview
  */
-const createManifestModule = (props, messageTransport$1) => {
+const createManifestModule = (props, messageTransport$1, initializationModule) => {
     const requestChannel = messageTransport.createRequestChannel(messageTransport$1);
-    const manifest$1 = manifest.createManifest(props);
-    requestChannel.handle('manifest', () => _tslib.__awaiter(void 0, void 0, void 0, function* () { return manifest$1; }));
+    const manifest = createPartialManifest.createPartialManifest(props);
+    requestChannel.handle('manifest', () => _tslib.__awaiter(void 0, void 0, void 0, function* () {
+        try {
+            return validateManifest.validateManifest(manifest);
+        }
+        catch (error) {
+            logger.logger.error(error);
+            if (error instanceof Error)
+                initializationModule.error = error;
+            throw error;
+        }
+    }));
     return {
-        setAppOrigin: (appOrigin) => (manifest$1.appOrigin = appOrigin),
+        setAppOrigin: (appOrigin) => (manifest.appOrigin = appOrigin),
+        setPlatform: (platform) => (manifest.platform = platform),
     };
 };
 

package/src/client/core/modules/manifestModule/manifestModule.d.ts

@@ -1,8 +1,10 @@
-import { MessageTransportWithDefaultOrigin } from '@dynamic-labs/message-transport';
+import { ClientManifest, MessageTransportWithDefaultOrigin } from '@dynamic-labs/message-transport';
 import { ClientProps } from '../../../client';
+import { InitializationModule } from '../initializationModule/initializationModule';
 /**
  * Manifest module handles the client manifest that will be requested by the webview
  */
-export declare const createManifestModule: (props: ClientProps, messageTransport: MessageTransportWithDefaultOrigin) => {
+export declare const createManifestModule: (props: ClientProps, messageTransport: MessageTransportWithDefaultOrigin, initializationModule: InitializationModule) => {
     setAppOrigin: (appOrigin: string) => string;
+    setPlatform: (platform: ClientManifest['platform']) => "browser" | "react-native";
 };

package/src/client/core/modules/manifestModule/manifestModule.js

@@ -1,17 +1,30 @@
 'use client'
 import { __awaiter } from '../../../../../_virtual/_tslib.js';
 import { createRequestChannel } from '@dynamic-labs/message-transport';
-import { createManifest } from './utils/manifest/manifest.js';
+import { logger } from '../../../../utils/logger/logger.js';
+import { createPartialManifest } from './createPartialManifest/createPartialManifest.js';
+import { validateManifest } from './validateManifest/validateManifest.js';
 
 /**
  * Manifest module handles the client manifest that will be requested by the webview
  */
-const createManifestModule = (props, messageTransport) => {
+const createManifestModule = (props, messageTransport, initializationModule) => {
     const requestChannel = createRequestChannel(messageTransport);
-    const manifest = createManifest(props);
-    requestChannel.handle('manifest', () => __awaiter(void 0, void 0, void 0, function* () { return manifest; }));
+    const manifest = createPartialManifest(props);
+    requestChannel.handle('manifest', () => __awaiter(void 0, void 0, void 0, function* () {
+        try {
+            return validateManifest(manifest);
+        }
+        catch (error) {
+            logger.error(error);
+            if (error instanceof Error)
+                initializationModule.error = error;
+            throw error;
+        }
+    }));
     return {
         setAppOrigin: (appOrigin) => (manifest.appOrigin = appOrigin),
+        setPlatform: (platform) => (manifest.platform = platform),
     };
 };
 

package/src/client/core/modules/manifestModule/validateManifest/index.d.ts

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

package/src/client/core/modules/manifestModule/validateManifest/validateManifest.cjs

@@ -0,0 +1,30 @@
+'use client'
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * Maps each required field of the client manifest to an error message that explains
+ * what the customer can do if his app runs into the issue where this field is missing from his manifest.
+ */
+const mandatoryFields = {
+    clientVersion: "We were unable to retrieve the Dynamic Client's version from your app. Please contact us about this.",
+    environmentId: 'You must provide an environment id to the Dynamic Client.',
+    platform: 'Missing platform specific extension, like BrowserExtension or ReactNativeExtension. See how to setup Dynamic Client in our docs for help.',
+};
+const validateManifest = (partialManifest) => {
+    /**
+     * If any of these fields are missing, we show the user an error message.
+     * You should map to each required field a description of what the user can do to fix this issue.
+     *
+     * And if you add a new required field to DynamicClient, TS will automatically force you to
+     * also include a description here :)
+     */
+    for (const [field, description] of Object.entries(mandatoryFields))
+        if (partialManifest[field] === undefined)
+            throw new Error(`Missing client manifest field "${field}": ${description}`);
+    return partialManifest;
+};
+
+exports.mandatoryFields = mandatoryFields;
+exports.validateManifest = validateManifest;

package/src/client/core/modules/manifestModule/validateManifest/validateManifest.d.ts

@@ -0,0 +1,14 @@
+import type { ClientManifest } from '@dynamic-labs/message-transport';
+/**
+ * Union of fields from ClientManifest which must be defined
+ */
+type MandatoryClientManifestField = {
+    [K in keyof ClientManifest]-?: NonNullable<unknown> extends Pick<ClientManifest, K> ? never : K;
+}[keyof ClientManifest];
+/**
+ * Maps each required field of the client manifest to an error message that explains
+ * what the customer can do if his app runs into the issue where this field is missing from his manifest.
+ */
+export declare const mandatoryFields: Record<MandatoryClientManifestField, string>;
+export declare const validateManifest: (partialManifest: Partial<ClientManifest>) => ClientManifest;
+export {};

package/src/client/core/modules/manifestModule/validateManifest/validateManifest.js

@@ -0,0 +1,25 @@
+'use client'
+/**
+ * Maps each required field of the client manifest to an error message that explains
+ * what the customer can do if his app runs into the issue where this field is missing from his manifest.
+ */
+const mandatoryFields = {
+    clientVersion: "We were unable to retrieve the Dynamic Client's version from your app. Please contact us about this.",
+    environmentId: 'You must provide an environment id to the Dynamic Client.',
+    platform: 'Missing platform specific extension, like BrowserExtension or ReactNativeExtension. See how to setup Dynamic Client in our docs for help.',
+};
+const validateManifest = (partialManifest) => {
+    /**
+     * If any of these fields are missing, we show the user an error message.
+     * You should map to each required field a description of what the user can do to fix this issue.
+     *
+     * And if you add a new required field to DynamicClient, TS will automatically force you to
+     * also include a description here :)
+     */
+    for (const [field, description] of Object.entries(mandatoryFields))
+        if (partialManifest[field] === undefined)
+            throw new Error(`Missing client manifest field "${field}": ${description}`);
+    return partialManifest;
+};
+
+export { mandatoryFields, validateManifest };

package/src/client/core/modules/manifestModule/utils/manifest/index.d.ts

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

package/src/client/core/modules/manifestModule/utils/manifest/manifest.d.ts

@@ -1,3 +0,0 @@
-import type { ClientManifest } from '@dynamic-labs/message-transport';
-import type { ClientProps } from '../../../../..';
-export declare const createManifest: ({ apiBaseUrl, environmentId, appLogoUrl, appName, cssOverrides, }: ClientProps) => ClientManifest;

package/src/client/core/modules/manifestModule/utils/manifest/manifest.js

@@ -1,13 +0,0 @@
-'use client'
-import { version } from '../../../../../../../package.js';
-
-const createManifest = ({ apiBaseUrl, environmentId, appLogoUrl, appName, cssOverrides, }) => ({
-    apiBaseUrl,
-    appLogoUrl,
-    appName,
-    clientVersion: version,
-    cssOverrides,
-    environmentId,
-});
-
-export { createManifest };