@cubist-labs/cubesigner-sdk 0.2.28 → 0.3.1

package/README.md

@@ -21,10 +21,11 @@ is in the works!
 
 ## Installing the SDK
 
-You can install the SDK from npm, or from GitHub:
+You can install the SDK from npm:
 
 ```bash
-npm install --save "@cubist-labs/cubesigner-sdk" "github:cubist-labs/CubeSigner-TypeScript-SDK"
+npm install --save "@cubist-labs/cubesigner-sdk"
+npm install --save "@cubist-labs/cubesigner-sdk-fs-storage" # support for filesystem-backed sessions
 ```
 
 ## Logging into CubeSigner
@@ -43,7 +44,7 @@ setup. We'll create a signing key, then sign some EVM
 transactions, and then add a security policy to restrict the kinds of
 transactions that CubeSigner is allowed to sign.
 
-To start, we'll instantiate the top-level `CubeSigner` class from an
+To start, we'll instantiate the top-level `CubeSignerClient` class from an
 existing CubeSigner management session already stored on disk
 (remember, you must already be logged in).
 
@@ -52,33 +53,32 @@ examples below.
 
 ```typescript
 import * as cs from "@cubist-labs/cubesigner-sdk";
+import { JsonFileSessionStorage, loadManagementSession } from "@cubist-labs/cubesigner-sdk-fs-storage";
 import assert from "assert";
 ```
 
-### Instantiate `CubeSigner`
+### Instantiate `CubeSignerClient`
 
-The first order of business is to create an instance of `CubeSigner`.
+The first order of business is to create an instance of `CubeSignerClient`.
 We can do that by simply loading the management session token from the
 default location on disk (which is where the `cs login` command saves
 it):
 
 ```typescript
-const cubesigner = await cs.CubeSigner.loadManagementSession();
+const cubesigner = await loadManagementSession();
 ```
 
-Alternatively, a `CubeSigner` instance can be created by explicitly providing a
-session manager:
+Alternatively, a `CubeSignerClient` instance can be created by explicitly
+providing a session manager:
 
 ```typescript
 // Load session from a JSON file
-const fileStorage = new cs.JsonFileSessionStorage<cs.CognitoSessionInfo>(
+const fileStorage = new JsonFileSessionStorage<cs.SignerSessionData>(
   `${process.env.HOME}/.config/cubesigner/management-session.json`,
 );
 // Create a session manager for a management token
-const sessionMgr = await cs.CognitoSessionManager.loadFromStorage(fileStorage);
-new cs.CubeSigner({
-  sessionMgr,
-});
+const sessionMgr = await cs.SignerSessionManager.loadFromStorage(fileStorage);
+new cs.CubeSignerClient(sessionMgr);
 ```
 
 ### Get `User` and `Org` info
@@ -91,9 +91,9 @@ const me = await cubesigner.aboutMe();
 console.log(me);
 assert(me.user_id); // each user has a globally unique ID
 assert(me.org_ids); // IDs of all organizations this user is a member of
-assert(me.org_ids.length > 0); // assume that the user is a member of at least one org
+assert(me.org_ids.length === 1); // assume that the user is a member of exactly one org
 
-const org = await cubesigner.getOrg(me.org_ids[0]);
+const org = new cs.Org(cubesigner);
 assert(await org.enabled()); // assume that the org is enabled
 ```
 
@@ -149,7 +149,7 @@ in-memory storage suffices; otherwise, opting for
 ```typescript
 // this storage persists the signer session token to a file
 // named 'session.json' in the current working directory
-new cs.JsonFileSessionStorage("session.json");
+new JsonFileSessionStorage("session.json");
 ```
 
 ### Sign an Ethereum transaction
@@ -200,9 +200,11 @@ assert(sig.data().rlp_signed_tx);
 ### Using ethers.js instead of the SDK directly
 
 ```typescript
-const { ethers } = require("ethers");
+import { Signer } from "@cubist-labs/cubesigner-sdk-ethers-v6";
+import { ethers } from "ethers";
+
 // Create new Signer
-const ethersSigner = new cs.ethers.Signer(secpKey.materialId, session);
+const ethersSigner = new Signer(secpKey.materialId, session);
 assert((await ethersSigner.getAddress()) === secpKey.materialId);
 // sign transaction as usual:
 console.log(
@@ -320,7 +322,7 @@ Next, create a `MemorySessionStorage` containing the previously
 exported signer token, and just load the session from it.
 
 ```typescript
-const signerSession = await cs.CubeSigner.loadSignerSession(
+const signerSession = await cs.SignerSession.loadSignerSession(
   // alternatively, load 'token' from file or environment variable
   new cs.MemorySessionStorage(token),
 );
@@ -343,13 +345,15 @@ CubeSigner supports the [OIDC](https://openid.net/developers/how-connect-works/)
 standard for authenticating third-party users.
 
 First, we need an OIDC token. We can get one from Google or any other
-supported OIDC issuer, including CubeSigner! Remember that we had to
-[log in](#logging-into-cubesigner) before we could instantiate
-`CubeSigner`; now we can simply ask that instance of `CubeSigner` to
-export the underlying token:
+supported OIDC issuer! For the purpose of this example, we'll assume
+the OIDC token is stored in the `OIDC_TOKEN` environment variable
 
 ```typescript
-const oidcToken = await cubesigner.sessionMgr!.token();
+import * as dotenv from "dotenv"; // npm install dotenv@16.3.1
+dotenv.config();
+
+const oidcToken = process.env["OIDC_TOKEN"];
+assert(oidcToken);
 ```
 
 Before we can use the OIDC token for authentication, we must add an org policy
@@ -373,7 +377,7 @@ of `SignerSession`, required by all signing endpoints, e.g., `signEvm`)
 ```typescript
 const oidcSession = new cs.SignerSession(
   // we'll use this session for both signing and approving MFA request, hence the following scopes
-  await cubesigner.oidcAuth(oidcToken, org.id, ["manage:mfa", "sign:*"]),
+  await cubesigner.oidcAuth(oidcToken, ["manage:mfa", "sign:*"]),
 );
 ```
 
@@ -382,9 +386,7 @@ required by all management endpoints, e.g., retrieving user
 information, configuring user MFA methods, etc.).
 
 ```typescript
-const oidcCubeSigner = new cs.CubeSigner({
-  sessionMgr: await cubesigner.oidcAuth(oidcToken, org.id, ["manage:*"]),
-});
+const oidcCubeSigner = new cs.CubeSignerClient(await cubesigner.oidcAuth(oidcToken, ["manage:*"]));
 ```
 
 > **Info**

package/dist/cjs/package.json

@@ -0,0 +1,41 @@
+{
+    "name": "@cubist-labs/cubesigner-sdk",
+    "version": "0.3.1",
+    "description": "CubeSigner TypeScript SDK",
+    "license": "MIT OR Apache-2.0",
+    "author": "Cubist, Inc.",
+    "main": "dist/cjs/src/index.js",
+    "files": [
+        "tsconfig.json",
+        "src/**",
+        "dist/**",
+        "../..NOTICE",
+        "../..LICENSE-APACHE",
+        "../..LICENSE-MIT"
+    ],
+    "exports": {
+        "require": "./dist/cjs/src/index.js",
+        "import": "./dist/esm/src/index.js"
+    },
+    "scripts": {
+        "build": "npm run build:cjs && npm run build:mjs",
+        "prepack": "npm run build",
+        "build:cjs": "tsc -p . --outDir dist/cjs --module commonjs --moduleResolution node",
+        "build:mjs": "tsc -p . --outDir dist/esm --module es2022",
+        "gen-schema": "openapi-typescript ./spec/openapi.json --output ./src/schema.ts",
+        "test": "jest --maxWorkers=1",
+        "typedoc": "typedoc"
+    },
+    "dependencies": {
+        "openapi-fetch": "0.6.1"
+    },
+    "optionalDependencies": {
+        "@hpke/core": "^1.2.5"
+    },
+    "engines": {
+        "node": ">=18.0.0"
+    },
+    "directories": {
+        "test": "test"
+    }
+}

package/dist/cjs/spec/env/beta.json

@@ -0,0 +1,9 @@
+{
+    "Dev-CubeSignerStack": {
+        "ClientId": "405mhvv13llufju1ruvnq42rdc",
+        "LongLivedClientId": "6he1bnm17s0dv8bb4hjim6fs6i",
+        "Region": "us-east-1",
+        "UserPoolId": "us-east-1_79ljlRRfX",
+        "SignerApiRoot": "https://beta.signer.cubist.dev"
+    }
+}

package/dist/cjs/spec/env/gamma.json

@@ -0,0 +1,9 @@
+{
+    "Dev-CubeSignerStack": {
+        "ClientId": "1tiou9ecj058khiidmhj4ds4rj",
+        "LongLivedClientId": "4jiuai7mtl5164of3drmvej234",
+        "Region": "us-east-1",
+        "UserPoolId": "us-east-1_RU7HEslOW",
+        "SignerApiRoot": "https://gamma.signer.cubist.dev"
+    }
+}

package/dist/cjs/spec/env/prod.json

@@ -0,0 +1,9 @@
+{
+    "Dev-CubeSignerStack": {
+        "ClientId": "2saesgbmeu8p981sk33sr6nq1j",
+        "LongLivedClientId": "79qoe43lbiphd7jv0emqadtoia",
+        "Region": "us-east-1",
+        "UserPoolId": "us-east-1_lLLal8vGd",
+        "SignerApiRoot": "https://prod.signer.cubist.dev"
+    }
+}