@privy-io/js-sdk-core 0.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022-2023 Horkos, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,53 @@
+# @privy-io/js-sdk-core
+
+## Usage
+
+### Auth
+
+```tsx
+const privy = new Privy({appId: '<your-app-id-here>'});
+
+await privy.sms.sendCode('+1 555 555 5555');
+const {user} = await privy.sms.loginWithCode('+1 555 555 5555', '123123');
+```
+
+### Embedded Wallets
+
+```tsx
+// Or use the embedded wallet with viem
+import {createWalletClient, custom} from 'viem';
+
+// Initialize the client
+const privy = new Privy({appId: '<your-app-id-here>'});
+
+// Log in
+await privy.sms.sendCode('+1 555 555 5555');
+const {user} = await privy.sms.loginWithCode('+1 555 555 5555', '123123');
+
+// Create an embedded wallet
+const wallet = await privy.wallet.create();
+
+// Use the embedded wallet
+const accounts = await wallet.request({method: 'eth_requestAccounts'});
+const response = await wallet.request({
+  method: 'eth_sendTransaction',
+  params: [
+    {
+      from: accounts[0],
+      to: '0x0000000000000000000000000000000000000000',
+      value: '1',
+    },
+  ],
+});
+
+const viemWalletClient = createWalletClient({
+  chain: mainnet,
+  transport: custom(wallet),
+});
+
+// use viem to sign a message
+await viemWalletClient.signMessage({
+  message: 'Hello from Privy!',
+  account: wallet.address,
+});
+```

package/dist/esm/index.js

@@ -0,0 +1 @@
+var s=class{async syncWithToken(n){return null}};var i=class{async sendCode(n){return null}async loginWithCode(n,t){return null}async linkWithCode(n,t){return null}async unlink(n){return null}};var o=class{async sendCode(n){return null}async loginWithCode(n,t){return null}async linkWithCode(n,t){return null}async unlink(n){return null}};var l=class{constructor(){this.customProvider=new s,this.phone=new o,this.email=new i}async logout(){return null}};import c from"eventemitter3";var r=class extends c{constructor(){super(...arguments);this.request=async t=>t}};var a=class{async create(n){return new r}async getProvider(n){return new r}async getURL(){return null}async getMessageHandler(){return null}};var d=class{async get(){return null}};var u=class{constructor(){this.user=new d,this.auth=new l,this.embeddedWallet=new a}};var W=u;export{W as default};

package/dist/index.d.ts

@@ -0,0 +1,165 @@
+import EventEmitter from 'eventemitter3';
+
+declare class CustomProvider {
+    /**
+     * Logs a user in via a custom JWT from another (non-Privy) service
+     *
+     * @param token The JWT
+     */
+    syncWithToken(_: string): Promise<null>;
+}
+
+declare class Email {
+    /**
+     * Sends a one time login code to a user's email address
+     *
+     * @param email The email address to send the one time login code
+     */
+    sendCode(_: string): Promise<null>;
+    /**
+     * Logs a user in via an email and one time code
+     *
+     * @param phoneNumber The phone number that the one time code was sent to
+     * @param code The one time code
+     */
+    loginWithCode(_: string, __: string): Promise<null>;
+    /**
+     * Links an email address to an existing user
+     *
+     * @param phoneNumber The phone number that the one time code was sent to
+     * @param code The one time code
+     */
+    linkWithCode(_: string, __: string): Promise<null>;
+    unlink(_: string): Promise<null>;
+}
+
+declare class Phone {
+    /**
+     * Sends a one time login code to a user's phone number via sms
+     *
+     * @param phoneNumber The phone number to send the one time login code
+     */
+    sendCode(_: string): Promise<null>;
+    /**
+     * Logs a user in via a phone number and one time code
+     *
+     * @param phoneNumber The phone number that the one time code was sent to
+     * @param code The one time code
+     */
+    loginWithCode(_: string, __: string): Promise<null>;
+    /**
+     * Links a phone number to an existing user
+     *
+     * @param phoneNumber The phone number that the one time code was sent to
+     * @param code The one time code
+     */
+    linkWithCode(_: string, __: string): Promise<null>;
+    unlink(_: string): Promise<null>;
+}
+
+declare class Auth {
+    /**
+     * APIs for login with a custom JWT
+     */
+    readonly customProvider: CustomProvider;
+    /**
+     * APIs for passwordless login with sms
+     */
+    readonly phone: Phone;
+    /**
+     * APIs for passwordless login with email
+     */
+    readonly email: Email;
+    constructor();
+    /**
+     * Logs the current user out.
+     */
+    logout(): Promise<null>;
+}
+
+type ProviderConnectInfo = {
+    chainId: string;
+};
+type OnConnectEventHandler = (connectInfo: ProviderConnectInfo) => void;
+type OnDisconnectEventHandler = (error: Error) => void;
+type OnChainChangedEventHandler = (chainId: string | number) => void;
+type OnAccountsChangedEventHandler = (accounts: string[]) => void;
+type ProviderMessage = {
+    type: string;
+    data: unknown;
+};
+type OnMessageEventHandler = (message: ProviderMessage) => void;
+type EIP1193OnEventHandler = OnConnectEventHandler | OnDisconnectEventHandler | OnChainChangedEventHandler | OnAccountsChangedEventHandler | OnMessageEventHandler;
+interface EIP1193Provider {
+    request: (request: {
+        method: string;
+        params?: Array<unknown> | undefined;
+    }) => Promise<unknown>;
+    on: (eventName: string, listener: EIP1193OnEventHandler) => unknown;
+    removeListener: (eventName: string | symbol, listener: (...args: unknown[]) => void) => unknown;
+}
+declare class EmbeddedWalletProvider extends EventEmitter implements EIP1193Provider {
+    request: (request: {
+        method: string;
+        params?: Array<unknown> | undefined;
+    }) => Promise<{
+        method: string;
+        params?: Array<unknown> | undefined;
+    }>;
+}
+
+declare class EmbeddedWallet {
+    /**
+     * Creates an embedded wallet
+     *
+     * @param password Recovery password for the embedded wallet
+     * @returns EmbeddedWalletProvider implementing EIP1193Provider
+     */
+    create(_?: string): Promise<EmbeddedWalletProvider>;
+    /**
+     * Retrieve this users embedded wallet.
+     * If the wallet has never been used on this device recover.
+     *
+     * @param password Recovery password for the embedded wallet
+     * @returns EmbeddedWalletProvider implementing EIP1193Provider
+     */
+    getProvider(_?: string): Promise<EmbeddedWalletProvider>;
+    /**
+     * @returns URL to load in the embedded wallet iframe
+     */
+    getURL(): Promise<null>;
+    /**
+     * @returns Allows the user to subscribe
+     * to the response events from the embedded wallet iframe
+     *
+     * @example
+     * const handler = privy.wallet.getMessageHandler()
+     * window.addEventListener('message', handler)
+     */
+    getMessageHandler(): Promise<null>;
+}
+
+declare class User {
+    /**
+     * Get the logged in user.
+     */
+    get(): Promise<null>;
+}
+
+declare class Privy {
+    /**
+     * APIs for interacting with a user's embedded wallet
+     */
+    readonly auth: Auth;
+    /**
+     * APIs for fetching user data
+     */
+    readonly user: User;
+    /**
+     * APIs for interacting with a user's embedded wallet
+     */
+    readonly embeddedWallet: EmbeddedWallet;
+    constructor();
+}
+
+export { Privy as default };

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";var v=Object.create;var p=Object.defineProperty;var h=Object.getOwnPropertyDescriptor;var f=Object.getOwnPropertyNames;var E=Object.getPrototypeOf,b=Object.prototype.hasOwnProperty;var P=(e,n)=>{for(var r in n)p(e,r,{get:n[r],enumerable:!0})},g=(e,n,r,m)=>{if(n&&typeof n=="object"||typeof n=="function")for(let s of f(n))!b.call(e,s)&&s!==r&&p(e,s,{get:()=>n[s],enumerable:!(m=h(n,s))||m.enumerable});return e};var _=(e,n,r)=>(r=e!=null?v(E(e)):{},g(n||!e||!e.__esModule?p(r,"default",{value:e,enumerable:!0}):r,e)),C=e=>g(p({},"__esModule",{value:!0}),e);var H={};P(H,{default:()=>w});module.exports=C(H);var i=class{async syncWithToken(n){return null}};var o=class{async sendCode(n){return null}async loginWithCode(n,r){return null}async linkWithCode(n,r){return null}async unlink(n){return null}};var l=class{async sendCode(n){return null}async loginWithCode(n,r){return null}async linkWithCode(n,r){return null}async unlink(n){return null}};var a=class{constructor(){this.customProvider=new i,this.phone=new l,this.email=new o}async logout(){return null}};var y=_(require("eventemitter3")),t=class extends y.default{constructor(){super(...arguments);this.request=async r=>r}};var d=class{async create(n){return new t}async getProvider(n){return new t}async getURL(){return null}async getMessageHandler(){return null}};var u=class{async get(){return null}};var c=class{constructor(){this.user=new u,this.auth=new a,this.embeddedWallet=new d}};var w=c;

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@privy-io/js-sdk-core",
+  "version": "0.0.0",
+  "license": "Apache-2.0",
+  "main": "./dist/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/index.d.ts",
+  "typings": "./dist/index",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/esm/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist/**/*",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "npx tsup --clean --minify",
+    "generate-types": "npx tsup --dts-only",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run clean && npm run build",
+    "dev": "npx tsup --watch",
+    "test": "jest --testMatch \"**/test/unit/**/*.test.ts\"",
+    "test:ci": "npm run test",
+    "test-integration": "jest --testMatch \"**/test/integration/**/*.test.ts\"",
+    "lint": "eslint \"src/**/*.{ts,tsx,js,jsx}\" && npx tsc --noEmit",
+    "format": "eslint \"src/**/*.{ts,tsx,js,jsx}\" --fix"
+  },
+  "devDependencies": {
+    "@privy-io/tsconfig": "*",
+    "tsup": "^6.2.3"
+  },
+  "dependencies": {
+    "eventemitter3": "^5.0.1"
+  }
+}