@dynamic-labs/client 2.0.0-alpha.26

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Dynamic Labs, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# Dynamic Client
+
+Welcome to Dynamic's client!

package/_virtual/_tslib.cjs

@@ -0,0 +1,35 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+exports.__awaiter = __awaiter;

package/_virtual/_tslib.js

@@ -0,0 +1,31 @@
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+export { __awaiter };

package/package.cjs

@@ -0,0 +1,7 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var version = "2.0.0-alpha.26";
+
+exports.version = version;

package/package.js

@@ -0,0 +1,3 @@
+var version = "2.0.0-alpha.26";
+
+export { version };

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@dynamic-labs/client",
+  "version": "2.0.0-alpha.26",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dynamic-labs/DynamicAuth.git",
+    "directory": "packages/client"
+  },
+  "description": "Core package for utilizing Dynamic's sdk",
+  "bugs": {
+    "url": "https://github.com/dynamic-labs/DynamicAuth/issues"
+  },
+  "homepage": "https://github.com/dynamic-labs/DynamicAuth/main/packages/client#readme",
+  "author": "Dynamic Labs, Inc.",
+  "license": "MIT",
+  "main": "./src/index.cjs",
+  "module": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.js",
+      "require": "./src/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "peerDependencies": {
+    "@dynamic-labs/message-transport": "2.0.0-alpha.26"
+  }
+}

package/src/client/client.cjs

@@ -0,0 +1,25 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var sdkModule = require('../modules/sdkModule/sdkModule.cjs');
+var Extendable = require('../utils/Extendable/Extendable.cjs');
+var core = require('./core/core.cjs');
+
+/**
+ * Generates a basic client that allows interacting with Dynamic's SDK, which
+ * will be rendered inside a webview.
+ *
+ * It must be extended with the necessary Extensions that implement the services
+ * it will be used for.
+ */
+const createClient = (props) => {
+    const core$1 = core.createCore();
+    const baseExtendable = new Extendable.Extendable(core$1);
+    return baseExtendable.extend(() => ({
+        /** Module that gives insight over the state of the SDK */
+        sdk: sdkModule.createSdkModule(core$1, props),
+    }));
+};
+
+exports.createClient = createClient;

package/src/client/client.d.ts

@@ -0,0 +1,22 @@
+import { Extendable } from '../utils/Extendable';
+export type BaseClient = ReturnType<typeof createClient>;
+export type ClientProps = {
+    environmentId: string;
+    apiBaseUrl?: string;
+    appName?: string;
+    appLogoUrl?: string;
+    cssOverrides?: string;
+};
+/**
+ * Generates a basic client that allows interacting with Dynamic's SDK, which
+ * will be rendered inside a webview.
+ *
+ * It must be extended with the necessary Extensions that implement the services
+ * it will be used for.
+ */
+export declare const createClient: (props: ClientProps) => {
+    /** Module that gives insight over the state of the SDK */
+    sdk: {
+        readonly loaded: boolean;
+    };
+} & Extendable;

package/src/client/client.js

@@ -0,0 +1,21 @@
+import { createSdkModule } from '../modules/sdkModule/sdkModule.js';
+import { Extendable } from '../utils/Extendable/Extendable.js';
+import { createCore } from './core/core.js';
+
+/**
+ * Generates a basic client that allows interacting with Dynamic's SDK, which
+ * will be rendered inside a webview.
+ *
+ * It must be extended with the necessary Extensions that implement the services
+ * it will be used for.
+ */
+const createClient = (props) => {
+    const core = createCore();
+    const baseExtendable = new Extendable(core);
+    return baseExtendable.extend(() => ({
+        /** Module that gives insight over the state of the SDK */
+        sdk: createSdkModule(core, props),
+    }));
+};
+
+export { createClient };

package/src/client/core/core.cjs

@@ -0,0 +1,33 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var messageTransport = require('@dynamic-labs/message-transport');
+
+const createCore = () => ({
+    /**
+     * Allows an extension to add its name to the list, such that
+     * other extensions are able to detect if it is present.
+     *
+     * Ex: ViemExtension adds "viem" to the list, and WagmiExtension later
+     * checks this list and throws an error if it doesn't find "viem" there.
+     */
+    declaredExtensionNames: [],
+    /**
+     * Message transport that will be used to send and receive messages to the webview.
+     * Should preferably be used with createRequestChannel, rather than used directly.
+     *
+     * Note: Doesn't implement forwarding messages to/from webview yet.
+     * The user is expected to extend the client with an Extension that implements that.
+     */
+    messageTransport: messageTransport.applyDefaultMessageOrigin({
+        defaultOrigin: 'host',
+        messageTransport: messageTransport.makeWaitForInitEvent({
+            bypassBlockIf: (message) => message.origin === 'webview',
+            initializeMessageType: messageTransport.sdkHasLoadedEventName,
+            messageTransport: messageTransport.createMessageTransport(),
+        }),
+    }),
+});
+
+exports.createCore = createCore;

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

@@ -0,0 +1,31 @@
+/**
+ * Holds properties and methods used by client extensions, but that we don't
+ * want users to have access to.
+ */
+export type Core = ReturnType<typeof createCore>;
+export declare const createCore: () => {
+    /**
+     * Allows an extension to add its name to the list, such that
+     * other extensions are able to detect if it is present.
+     *
+     * Ex: ViemExtension adds "viem" to the list, and WagmiExtension later
+     * checks this list and throws an error if it doesn't find "viem" there.
+     */
+    declaredExtensionNames: string[];
+    /**
+     * Message transport that will be used to send and receive messages to the webview.
+     * Should preferably be used with createRequestChannel, rather than used directly.
+     *
+     * Note: Doesn't implement forwarding messages to/from webview yet.
+     * The user is expected to extend the client with an Extension that implements that.
+     */
+    messageTransport: {
+        unblock: () => void;
+        emit: (message: import("@dynamic-labs/message-transport").MessageTransportData) => void;
+        off: (callback: import("@dynamic-labs/message-transport").MessageTransportCallback) => void;
+        on: (callback: import("@dynamic-labs/message-transport").MessageTransportCallback) => void;
+    } & {
+        defaultOrigin: "host" | "webview";
+        emit: (message: import("@dynamic-labs/message-transport").MessageTransportDataOptionalOrigin) => void;
+    };
+};

package/src/client/core/core.js

@@ -0,0 +1,29 @@
+import { applyDefaultMessageOrigin, makeWaitForInitEvent, sdkHasLoadedEventName, createMessageTransport } from '@dynamic-labs/message-transport';
+
+const createCore = () => ({
+    /**
+     * Allows an extension to add its name to the list, such that
+     * other extensions are able to detect if it is present.
+     *
+     * Ex: ViemExtension adds "viem" to the list, and WagmiExtension later
+     * checks this list and throws an error if it doesn't find "viem" there.
+     */
+    declaredExtensionNames: [],
+    /**
+     * Message transport that will be used to send and receive messages to the webview.
+     * Should preferably be used with createRequestChannel, rather than used directly.
+     *
+     * Note: Doesn't implement forwarding messages to/from webview yet.
+     * The user is expected to extend the client with an Extension that implements that.
+     */
+    messageTransport: applyDefaultMessageOrigin({
+        defaultOrigin: 'host',
+        messageTransport: makeWaitForInitEvent({
+            bypassBlockIf: (message) => message.origin === 'webview',
+            initializeMessageType: sdkHasLoadedEventName,
+            messageTransport: createMessageTransport(),
+        }),
+    }),
+});
+
+export { createCore };

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

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

package/src/client/index.d.ts

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

package/src/index.cjs

@@ -0,0 +1,11 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var Extendable = require('./utils/Extendable/Extendable.cjs');
+var client = require('./client/client.cjs');
+
+
+
+exports.Extendable = Extendable.Extendable;
+exports.createClient = client.createClient;

package/src/index.d.ts

@@ -0,0 +1,3 @@
+export { type Core } from './client/core';
+export { Extendable, type Extension } from './utils/Extendable';
+export { createClient, type BaseClient, type ClientProps } from './client';

package/src/index.js

@@ -0,0 +1,2 @@
+export { Extendable } from './utils/Extendable/Extendable.js';
+export { createClient } from './client/client.js';

package/src/modules/sdkModule/index.d.ts

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

package/src/modules/sdkModule/manifest/index.d.ts

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

package/src/modules/sdkModule/manifest/manifest.cjs

@@ -0,0 +1,16 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _package = require('../../../../package.cjs');
+
+const createManifest = ({ apiBaseUrl, environmentId, appLogoUrl, appName, cssOverrides, }) => ({
+    apiBaseUrl,
+    appLogoUrl,
+    appName,
+    clientVersion: _package.version,
+    cssOverrides,
+    environmentId,
+});
+
+exports.createManifest = createManifest;

package/src/modules/sdkModule/manifest/manifest.d.ts

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

package/src/modules/sdkModule/manifest/manifest.js

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

package/src/modules/sdkModule/sdkModule.cjs

@@ -0,0 +1,25 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _tslib = require('../../../_virtual/_tslib.cjs');
+var messageTransport = require('@dynamic-labs/message-transport');
+var manifest = require('./manifest/manifest.cjs');
+
+const createSdkModule = (core, props) => {
+    const requestChannel = messageTransport.createRequestChannel(core.messageTransport);
+    const state = {
+        loaded: false,
+    };
+    requestChannel.handle('manifest', () => _tslib.__awaiter(void 0, void 0, void 0, function* () { return manifest.createManifest(props); }));
+    // This will soon have to change. After we implement th store abstraction
+    // in the message transport package, we should use it here.
+    requestChannel.handle('loaded', () => (state.loaded = true));
+    return {
+        get loaded() {
+            return state.loaded;
+        },
+    };
+};
+
+exports.createSdkModule = createSdkModule;

package/src/modules/sdkModule/sdkModule.d.ts

@@ -0,0 +1,5 @@
+import type { ClientProps } from '../../client';
+import { Core } from '../../client/core';
+export declare const createSdkModule: (core: Core, props: ClientProps) => {
+    readonly loaded: boolean;
+};

package/src/modules/sdkModule/sdkModule.js

@@ -0,0 +1,21 @@
+import { __awaiter } from '../../../_virtual/_tslib.js';
+import { createRequestChannel } from '@dynamic-labs/message-transport';
+import { createManifest } from './manifest/manifest.js';
+
+const createSdkModule = (core, props) => {
+    const requestChannel = createRequestChannel(core.messageTransport);
+    const state = {
+        loaded: false,
+    };
+    requestChannel.handle('manifest', () => __awaiter(void 0, void 0, void 0, function* () { return createManifest(props); }));
+    // This will soon have to change. After we implement th store abstraction
+    // in the message transport package, we should use it here.
+    requestChannel.handle('loaded', () => (state.loaded = true));
+    return {
+        get loaded() {
+            return state.loaded;
+        },
+    };
+};
+
+export { createSdkModule };

package/src/utils/Extendable/Extendable.cjs

@@ -0,0 +1,26 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+// Class here is necessary to have access to "this" keyword
+/**
+ * An object that can be extended.
+ *
+ * To extend here means to add or replace the existing properties of this object,
+ * as well as kicking off any related procedures. Like a structure on which you can
+ * attach lego bricks.
+ *
+ * Ex: a { movie: "Up" } object can be extended by adding an audienceScore
+ * property to it, and kicking off an api call that will constantly update this property from
+ * an IMDb api.
+ */
+class Extendable {
+    constructor(core) {
+        this.core = core;
+    }
+    extend(extension) {
+        return Object.assign(this, extension(this, this.core));
+    }
+}
+
+exports.Extendable = Extendable;

package/src/utils/Extendable/Extendable.d.ts

@@ -0,0 +1,25 @@
+import { Core } from '../../client/core';
+/**
+ * Allows extending properties and methods of an Extendable
+ */
+export type Extension<T extends Record<string, unknown>> = (
+/** The extendable object to which this extension will be applied */
+extendable: Extendable, 
+/** An object with internal properties and methods not publicly accessible */
+core: Core) => T;
+/**
+ * An object that can be extended.
+ *
+ * To extend here means to add or replace the existing properties of this object,
+ * as well as kicking off any related procedures. Like a structure on which you can
+ * attach lego bricks.
+ *
+ * Ex: a { movie: "Up" } object can be extended by adding an audienceScore
+ * property to it, and kicking off an api call that will constantly update this property from
+ * an IMDb api.
+ */
+export declare class Extendable {
+    private readonly core;
+    constructor(core: Core);
+    extend<T extends Record<string, unknown>>(extension: Extension<T>): T & typeof this;
+}

package/src/utils/Extendable/Extendable.js

@@ -0,0 +1,22 @@
+// Class here is necessary to have access to "this" keyword
+/**
+ * An object that can be extended.
+ *
+ * To extend here means to add or replace the existing properties of this object,
+ * as well as kicking off any related procedures. Like a structure on which you can
+ * attach lego bricks.
+ *
+ * Ex: a { movie: "Up" } object can be extended by adding an audienceScore
+ * property to it, and kicking off an api call that will constantly update this property from
+ * an IMDb api.
+ */
+class Extendable {
+    constructor(core) {
+        this.core = core;
+    }
+    extend(extension) {
+        return Object.assign(this, extension(this, this.core));
+    }
+}
+
+export { Extendable };

package/src/utils/Extendable/hasExtension/hasExtension.d.ts

@@ -0,0 +1,9 @@
+import { Extendable } from '..';
+import { Core } from '../../..';
+/**
+ * This method allows safely type casting an Extendable object to include an extension type.
+ *
+ * It assumes you are checking if the target extension has declared its name to the core,
+ * and if that name is found in core's declaredExtensionNames, it will complete the type cast.
+ */
+export declare const hasExtension: <T>(extendable: Extendable, core: Core, extensionName: string) => extendable is Extendable & T;

package/src/utils/Extendable/index.d.ts

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