@compilot/js-sdk 2.0.41-dev → 2.0.43-dev

package/dist/compilot-js-sdk.cjs.dev.js

@@ -357,11 +357,11 @@ zod.z.object({
  * @example
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * await apiClient.attachCustomerInformation({
+ * await compilotSdk.attachCustomerInformation({
  *  externalCustomerId: "123",
  *  information: {
  *    email: "test@test.com",
@@ -549,11 +549,11 @@ var attachCustomerInformationFactory = function attachCustomerInformationFactory
  * Basic usage:
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const sessionContent = await apiClient.createSession({
+ * const sessionContent = await compilotSdk.createSession({
  *   workflowId: "4f7b537f-0ae0-429c-98c8-3f6555ef23d6",
  *   externalCustomerId: "123",
  *   additionalInformation: {
@@ -571,9 +571,9 @@ var attachCustomerInformationFactory = function attachCustomerInformationFactory
  * Please find below an example of how to use the createSession function in Next.js:
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
  *
  * export default async function handler(req: NextApiRequest, res: NextApiResponse ) {
@@ -583,7 +583,7 @@ var attachCustomerInformationFactory = function attachCustomerInformationFactory
  *     return;
  *   }
  *
- *   const sessionRes = await apiClient.createSession({
+ *   const sessionRes = await compilotSdk.createSession({
  *     workflowId: "4f7b537f-0ae0-429c-98c8-3f6555ef23d6",
  *     externalCustomerId: req.session.externalCustomerId,
  *   });
@@ -633,11 +633,11 @@ var createWeb2SessionFactory = function createWeb2SessionFactory(deps) {
  * Basic usage:
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const challengeContent = await apiClient.createWeb3Challenge({
+ * const challengeContent = await compilotSdk.createWeb3Challenge({
  *  address: "0xabc",
  *  namespace: "eip155",
  *  blockchainId: "1",
@@ -651,9 +651,9 @@ var createWeb2SessionFactory = function createWeb2SessionFactory(deps) {
  * Please find below an example of how to use the createWeb3Challenge function in Next.js:
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
  * export default async function handler(req: NextApiRequest, res: NextApiResponse ) {
  *  if (req.method !== "POST") {
@@ -662,7 +662,7 @@ var createWeb2SessionFactory = function createWeb2SessionFactory(deps) {
  *   return;
  *  }
  *
- *  const challengeContent = await apiClient.createWeb3Challenge({
+ *  const challengeContent = await compilotSdk.createWeb3Challenge({
  *   address: "0xabc",
  *   namespace: "eip155",
  *   blockchainId: "1",
@@ -714,11 +714,11 @@ var createWeb3ChallengeFactory = function createWeb3ChallengeFactory(deps) {
  * @example
  * ```typescript
  *
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const customerStatus = await apiClient.getCustomerStatusByCustomerId({
+ * const customerStatus = await compilotSdk.getCustomerStatusByCustomerId({
  *  customerId: "123",
  * });
  * ```
@@ -761,11 +761,11 @@ var getCustomerStatusByCustomerIdFactory = function getCustomerStatusByCustomerI
  * @example
  * ```typescript
  *
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const customerStatus = await apiClient.getCustomerStatusByExternalCustomerId({
+ * const customerStatus = await compilotSdk.getCustomerStatusByExternalCustomerId({
  *  externalCustomerId: "123",
  * });
  * ```
@@ -805,11 +805,11 @@ var getCustomerStatusByExternalCustomerIdFactory = function getCustomerStatusByE
  *
  * @example
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const customerStatus = await apiClient.getCustomerStatusByWallet({
+ * const customerStatus = await compilotSdk.getCustomerStatusByWallet({
  *  walletAddress: "tz1abc",
  *  workspaceId: "123",
  * });
@@ -852,11 +852,11 @@ var getCustomerStatusByWalletFactory = function getCustomerStatusByWalletFactory
  *
  * @example
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const wallets = await apiClient.getCustomerWallets({
+ * const wallets = await compilotSdk.getCustomerWallets({
  *  customerId: "123",
  * });
  * ```
@@ -953,11 +953,11 @@ function _objectSpread2(e) {
  *
  * Eip155:
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const txAuthDataSignature = await apiClient.getTxAuthDataSignature({
+ * const txAuthDataSignature = await compilotSdk.getTxAuthDataSignature({
  *  namespace: "eip155",
  *  contractAbi: ExampleGatedNFTMinterABI,
  *  contractAddress: "0x123",
@@ -1262,6 +1262,90 @@ var validateWebhookEventFactory = function validateWebhookEventFactory(_ref) {
   };
 };
 
+/**
+ * Verify a challenge for a wallet. The web-sdk can use this to verify a signed message and prove ownership of a wallet.
+ *
+ * @param params The parameters to verify
+ * @returns A promise that resolves to the auth session
+ *
+ * @category Actions
+ *
+ * @example
+ *
+ * Basic usage:
+ *
+ * ```typescript
+ * import { createSdk } from "@compilot/js-sdk";
+ *
+ * const compilotSdk = createSdk({ apiKey });
+ *
+ * const challengeContent = await compilotSdk.verifyWeb3Challenge({
+ *  address: "0xabc",
+ *  namespace: "eip155",
+ *  blockchainId: "1",
+ *  message: ".....", // the challenge message
+ *  signedMessage: ".....", // the signed message, some wallets need to process the message before signing
+ *  signature: ".....", // the wallet signature of the signed message
+ *  signerPublicKey: "0x...",
+ * });
+ * ```
+ *
+ * More often used as part of an api to protect the api key.
+ * Please find below an example of how to use the verifyWeb3Challenge function in Next.js:
+ *
+ * ```typescript
+ * import { createSdk } from "@compilot/js-sdk";
+ *
+ * const compilotSdk = createSdk({ apiKey });
+ *
+ * export default async function handler(req: NextApiRequest, res: NextApiResponse ) {
+ *  if (req.method !== "POST") {
+ *   res.setHeader("Allow", ["POST"]);
+ *   res.status(405).end(`Method ${req.method} Not Allowed`);
+ *   return;
+ *  }
+ *
+ *  const authSession = await compilotSdk.verifyWeb3Challenge({
+ *   ...req.body
+ *  });
+ *
+ *  // now we know this user is authenticated, save the user address to the local database for future reference
+ *  db.update(authSession.externalCustomerId, {
+ *   address: req.body.address,
+ *  });
+ *
+ *  // Return the challenge to the client
+ *  res.status(200).json(authSession);
+ * }
+ * ```
+ */
+
+var verifyWeb3ChallengeFactory = function verifyWeb3ChallengeFactory(deps) {
+  return /*#__PURE__*/function () {
+    var _ref = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(params) {
+      var res;
+      return _regeneratorRuntime().wrap(function _callee$(_context) {
+        while (1) switch (_context.prev = _context.next) {
+          case 0:
+            _context.next = 2;
+            return deps.identityApiClient.auth.verifyWalletChallenge({
+              requestBody: params
+            });
+          case 2:
+            res = _context.sent;
+            return _context.abrupt("return", res);
+          case 4:
+          case "end":
+            return _context.stop();
+        }
+      }, _callee);
+    }));
+    return function (_x) {
+      return _ref.apply(this, arguments);
+    };
+  }();
+};
+
 /**
  * Error thrown when API key is not provided.
  */
@@ -1332,6 +1416,9 @@ var createSdk = function createSdk(_ref) {
     createWeb3Challenge: createWeb3ChallengeFactory({
       identityApiClient: identityApiClient$1
     }),
+    verifyWeb3Challenge: verifyWeb3ChallengeFactory({
+      identityApiClient: identityApiClient$1
+    }),
     createSession: createWeb2SessionFactory({
       identityApiClient: identityApiClient$1
     }),

package/dist/compilot-js-sdk.cjs.prod.js

@@ -357,11 +357,11 @@ zod.z.object({
  * @example
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * await apiClient.attachCustomerInformation({
+ * await compilotSdk.attachCustomerInformation({
  *  externalCustomerId: "123",
  *  information: {
  *    email: "test@test.com",
@@ -549,11 +549,11 @@ var attachCustomerInformationFactory = function attachCustomerInformationFactory
  * Basic usage:
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const sessionContent = await apiClient.createSession({
+ * const sessionContent = await compilotSdk.createSession({
  *   workflowId: "4f7b537f-0ae0-429c-98c8-3f6555ef23d6",
  *   externalCustomerId: "123",
  *   additionalInformation: {
@@ -571,9 +571,9 @@ var attachCustomerInformationFactory = function attachCustomerInformationFactory
  * Please find below an example of how to use the createSession function in Next.js:
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
  *
  * export default async function handler(req: NextApiRequest, res: NextApiResponse ) {
@@ -583,7 +583,7 @@ var attachCustomerInformationFactory = function attachCustomerInformationFactory
  *     return;
  *   }
  *
- *   const sessionRes = await apiClient.createSession({
+ *   const sessionRes = await compilotSdk.createSession({
  *     workflowId: "4f7b537f-0ae0-429c-98c8-3f6555ef23d6",
  *     externalCustomerId: req.session.externalCustomerId,
  *   });
@@ -633,11 +633,11 @@ var createWeb2SessionFactory = function createWeb2SessionFactory(deps) {
  * Basic usage:
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const challengeContent = await apiClient.createWeb3Challenge({
+ * const challengeContent = await compilotSdk.createWeb3Challenge({
  *  address: "0xabc",
  *  namespace: "eip155",
  *  blockchainId: "1",
@@ -651,9 +651,9 @@ var createWeb2SessionFactory = function createWeb2SessionFactory(deps) {
  * Please find below an example of how to use the createWeb3Challenge function in Next.js:
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
  * export default async function handler(req: NextApiRequest, res: NextApiResponse ) {
  *  if (req.method !== "POST") {
@@ -662,7 +662,7 @@ var createWeb2SessionFactory = function createWeb2SessionFactory(deps) {
  *   return;
  *  }
  *
- *  const challengeContent = await apiClient.createWeb3Challenge({
+ *  const challengeContent = await compilotSdk.createWeb3Challenge({
  *   address: "0xabc",
  *   namespace: "eip155",
  *   blockchainId: "1",
@@ -714,11 +714,11 @@ var createWeb3ChallengeFactory = function createWeb3ChallengeFactory(deps) {
  * @example
  * ```typescript
  *
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const customerStatus = await apiClient.getCustomerStatusByCustomerId({
+ * const customerStatus = await compilotSdk.getCustomerStatusByCustomerId({
  *  customerId: "123",
  * });
  * ```
@@ -761,11 +761,11 @@ var getCustomerStatusByCustomerIdFactory = function getCustomerStatusByCustomerI
  * @example
  * ```typescript
  *
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const customerStatus = await apiClient.getCustomerStatusByExternalCustomerId({
+ * const customerStatus = await compilotSdk.getCustomerStatusByExternalCustomerId({
  *  externalCustomerId: "123",
  * });
  * ```
@@ -805,11 +805,11 @@ var getCustomerStatusByExternalCustomerIdFactory = function getCustomerStatusByE
  *
  * @example
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const customerStatus = await apiClient.getCustomerStatusByWallet({
+ * const customerStatus = await compilotSdk.getCustomerStatusByWallet({
  *  walletAddress: "tz1abc",
  *  workspaceId: "123",
  * });
@@ -852,11 +852,11 @@ var getCustomerStatusByWalletFactory = function getCustomerStatusByWalletFactory
  *
  * @example
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const wallets = await apiClient.getCustomerWallets({
+ * const wallets = await compilotSdk.getCustomerWallets({
  *  customerId: "123",
  * });
  * ```
@@ -953,11 +953,11 @@ function _objectSpread2(e) {
  *
  * Eip155:
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const txAuthDataSignature = await apiClient.getTxAuthDataSignature({
+ * const txAuthDataSignature = await compilotSdk.getTxAuthDataSignature({
  *  namespace: "eip155",
  *  contractAbi: ExampleGatedNFTMinterABI,
  *  contractAddress: "0x123",
@@ -1262,6 +1262,90 @@ var validateWebhookEventFactory = function validateWebhookEventFactory(_ref) {
   };
 };
 
+/**
+ * Verify a challenge for a wallet. The web-sdk can use this to verify a signed message and prove ownership of a wallet.
+ *
+ * @param params The parameters to verify
+ * @returns A promise that resolves to the auth session
+ *
+ * @category Actions
+ *
+ * @example
+ *
+ * Basic usage:
+ *
+ * ```typescript
+ * import { createSdk } from "@compilot/js-sdk";
+ *
+ * const compilotSdk = createSdk({ apiKey });
+ *
+ * const challengeContent = await compilotSdk.verifyWeb3Challenge({
+ *  address: "0xabc",
+ *  namespace: "eip155",
+ *  blockchainId: "1",
+ *  message: ".....", // the challenge message
+ *  signedMessage: ".....", // the signed message, some wallets need to process the message before signing
+ *  signature: ".....", // the wallet signature of the signed message
+ *  signerPublicKey: "0x...",
+ * });
+ * ```
+ *
+ * More often used as part of an api to protect the api key.
+ * Please find below an example of how to use the verifyWeb3Challenge function in Next.js:
+ *
+ * ```typescript
+ * import { createSdk } from "@compilot/js-sdk";
+ *
+ * const compilotSdk = createSdk({ apiKey });
+ *
+ * export default async function handler(req: NextApiRequest, res: NextApiResponse ) {
+ *  if (req.method !== "POST") {
+ *   res.setHeader("Allow", ["POST"]);
+ *   res.status(405).end(`Method ${req.method} Not Allowed`);
+ *   return;
+ *  }
+ *
+ *  const authSession = await compilotSdk.verifyWeb3Challenge({
+ *   ...req.body
+ *  });
+ *
+ *  // now we know this user is authenticated, save the user address to the local database for future reference
+ *  db.update(authSession.externalCustomerId, {
+ *   address: req.body.address,
+ *  });
+ *
+ *  // Return the challenge to the client
+ *  res.status(200).json(authSession);
+ * }
+ * ```
+ */
+
+var verifyWeb3ChallengeFactory = function verifyWeb3ChallengeFactory(deps) {
+  return /*#__PURE__*/function () {
+    var _ref = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(params) {
+      var res;
+      return _regeneratorRuntime().wrap(function _callee$(_context) {
+        while (1) switch (_context.prev = _context.next) {
+          case 0:
+            _context.next = 2;
+            return deps.identityApiClient.auth.verifyWalletChallenge({
+              requestBody: params
+            });
+          case 2:
+            res = _context.sent;
+            return _context.abrupt("return", res);
+          case 4:
+          case "end":
+            return _context.stop();
+        }
+      }, _callee);
+    }));
+    return function (_x) {
+      return _ref.apply(this, arguments);
+    };
+  }();
+};
+
 /**
  * Error thrown when API key is not provided.
  */
@@ -1332,6 +1416,9 @@ var createSdk = function createSdk(_ref) {
     createWeb3Challenge: createWeb3ChallengeFactory({
       identityApiClient: identityApiClient$1
     }),
+    verifyWeb3Challenge: verifyWeb3ChallengeFactory({
+      identityApiClient: identityApiClient$1
+    }),
     createSession: createWeb2SessionFactory({
       identityApiClient: identityApiClient$1
     }),

package/dist/compilot-js-sdk.esm.js

@@ -355,11 +355,11 @@ z.object({
  * @example
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * await apiClient.attachCustomerInformation({
+ * await compilotSdk.attachCustomerInformation({
  *  externalCustomerId: "123",
  *  information: {
  *    email: "test@test.com",
@@ -547,11 +547,11 @@ var attachCustomerInformationFactory = function attachCustomerInformationFactory
  * Basic usage:
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const sessionContent = await apiClient.createSession({
+ * const sessionContent = await compilotSdk.createSession({
  *   workflowId: "4f7b537f-0ae0-429c-98c8-3f6555ef23d6",
  *   externalCustomerId: "123",
  *   additionalInformation: {
@@ -569,9 +569,9 @@ var attachCustomerInformationFactory = function attachCustomerInformationFactory
  * Please find below an example of how to use the createSession function in Next.js:
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
  *
  * export default async function handler(req: NextApiRequest, res: NextApiResponse ) {
@@ -581,7 +581,7 @@ var attachCustomerInformationFactory = function attachCustomerInformationFactory
  *     return;
  *   }
  *
- *   const sessionRes = await apiClient.createSession({
+ *   const sessionRes = await compilotSdk.createSession({
  *     workflowId: "4f7b537f-0ae0-429c-98c8-3f6555ef23d6",
  *     externalCustomerId: req.session.externalCustomerId,
  *   });
@@ -631,11 +631,11 @@ var createWeb2SessionFactory = function createWeb2SessionFactory(deps) {
  * Basic usage:
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const challengeContent = await apiClient.createWeb3Challenge({
+ * const challengeContent = await compilotSdk.createWeb3Challenge({
  *  address: "0xabc",
  *  namespace: "eip155",
  *  blockchainId: "1",
@@ -649,9 +649,9 @@ var createWeb2SessionFactory = function createWeb2SessionFactory(deps) {
  * Please find below an example of how to use the createWeb3Challenge function in Next.js:
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
  * export default async function handler(req: NextApiRequest, res: NextApiResponse ) {
  *  if (req.method !== "POST") {
@@ -660,7 +660,7 @@ var createWeb2SessionFactory = function createWeb2SessionFactory(deps) {
  *   return;
  *  }
  *
- *  const challengeContent = await apiClient.createWeb3Challenge({
+ *  const challengeContent = await compilotSdk.createWeb3Challenge({
  *   address: "0xabc",
  *   namespace: "eip155",
  *   blockchainId: "1",
@@ -712,11 +712,11 @@ var createWeb3ChallengeFactory = function createWeb3ChallengeFactory(deps) {
  * @example
  * ```typescript
  *
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const customerStatus = await apiClient.getCustomerStatusByCustomerId({
+ * const customerStatus = await compilotSdk.getCustomerStatusByCustomerId({
  *  customerId: "123",
  * });
  * ```
@@ -759,11 +759,11 @@ var getCustomerStatusByCustomerIdFactory = function getCustomerStatusByCustomerI
  * @example
  * ```typescript
  *
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const customerStatus = await apiClient.getCustomerStatusByExternalCustomerId({
+ * const customerStatus = await compilotSdk.getCustomerStatusByExternalCustomerId({
  *  externalCustomerId: "123",
  * });
  * ```
@@ -803,11 +803,11 @@ var getCustomerStatusByExternalCustomerIdFactory = function getCustomerStatusByE
  *
  * @example
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const customerStatus = await apiClient.getCustomerStatusByWallet({
+ * const customerStatus = await compilotSdk.getCustomerStatusByWallet({
  *  walletAddress: "tz1abc",
  *  workspaceId: "123",
  * });
@@ -850,11 +850,11 @@ var getCustomerStatusByWalletFactory = function getCustomerStatusByWalletFactory
  *
  * @example
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const wallets = await apiClient.getCustomerWallets({
+ * const wallets = await compilotSdk.getCustomerWallets({
  *  customerId: "123",
  * });
  * ```
@@ -951,11 +951,11 @@ function _objectSpread2(e) {
  *
  * Eip155:
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const txAuthDataSignature = await apiClient.getTxAuthDataSignature({
+ * const txAuthDataSignature = await compilotSdk.getTxAuthDataSignature({
  *  namespace: "eip155",
  *  contractAbi: ExampleGatedNFTMinterABI,
  *  contractAddress: "0x123",
@@ -1260,6 +1260,90 @@ var validateWebhookEventFactory = function validateWebhookEventFactory(_ref) {
   };
 };
 
+/**
+ * Verify a challenge for a wallet. The web-sdk can use this to verify a signed message and prove ownership of a wallet.
+ *
+ * @param params The parameters to verify
+ * @returns A promise that resolves to the auth session
+ *
+ * @category Actions
+ *
+ * @example
+ *
+ * Basic usage:
+ *
+ * ```typescript
+ * import { createSdk } from "@compilot/js-sdk";
+ *
+ * const compilotSdk = createSdk({ apiKey });
+ *
+ * const challengeContent = await compilotSdk.verifyWeb3Challenge({
+ *  address: "0xabc",
+ *  namespace: "eip155",
+ *  blockchainId: "1",
+ *  message: ".....", // the challenge message
+ *  signedMessage: ".....", // the signed message, some wallets need to process the message before signing
+ *  signature: ".....", // the wallet signature of the signed message
+ *  signerPublicKey: "0x...",
+ * });
+ * ```
+ *
+ * More often used as part of an api to protect the api key.
+ * Please find below an example of how to use the verifyWeb3Challenge function in Next.js:
+ *
+ * ```typescript
+ * import { createSdk } from "@compilot/js-sdk";
+ *
+ * const compilotSdk = createSdk({ apiKey });
+ *
+ * export default async function handler(req: NextApiRequest, res: NextApiResponse ) {
+ *  if (req.method !== "POST") {
+ *   res.setHeader("Allow", ["POST"]);
+ *   res.status(405).end(`Method ${req.method} Not Allowed`);
+ *   return;
+ *  }
+ *
+ *  const authSession = await compilotSdk.verifyWeb3Challenge({
+ *   ...req.body
+ *  });
+ *
+ *  // now we know this user is authenticated, save the user address to the local database for future reference
+ *  db.update(authSession.externalCustomerId, {
+ *   address: req.body.address,
+ *  });
+ *
+ *  // Return the challenge to the client
+ *  res.status(200).json(authSession);
+ * }
+ * ```
+ */
+
+var verifyWeb3ChallengeFactory = function verifyWeb3ChallengeFactory(deps) {
+  return /*#__PURE__*/function () {
+    var _ref = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(params) {
+      var res;
+      return _regeneratorRuntime().wrap(function _callee$(_context) {
+        while (1) switch (_context.prev = _context.next) {
+          case 0:
+            _context.next = 2;
+            return deps.identityApiClient.auth.verifyWalletChallenge({
+              requestBody: params
+            });
+          case 2:
+            res = _context.sent;
+            return _context.abrupt("return", res);
+          case 4:
+          case "end":
+            return _context.stop();
+        }
+      }, _callee);
+    }));
+    return function (_x) {
+      return _ref.apply(this, arguments);
+    };
+  }();
+};
+
 /**
  * Error thrown when API key is not provided.
  */
@@ -1330,6 +1414,9 @@ var createSdk = function createSdk(_ref) {
     createWeb3Challenge: createWeb3ChallengeFactory({
       identityApiClient: identityApiClient
     }),
+    verifyWeb3Challenge: verifyWeb3ChallengeFactory({
+      identityApiClient: identityApiClient
+    }),
     createSession: createWeb2SessionFactory({
       identityApiClient: identityApiClient
     }),

package/dist/declarations/src/actions/attachCustomerInformation.d.ts

@@ -22,11 +22,11 @@ export declare const AttachCustomerInformationParams: z.ZodType<AttachCustomerIn
  * @example
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * await apiClient.attachCustomerInformation({
+ * await compilotSdk.attachCustomerInformation({
  *  externalCustomerId: "123",
  *  information: {
  *    email: "test@test.com",

package/dist/declarations/src/actions/createWeb2Session.d.ts

@@ -12,11 +12,11 @@ import type { AuthSession, Web2CreateSessionParams } from "@nexeraid/identity-sc
  * Basic usage:
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const sessionContent = await apiClient.createSession({
+ * const sessionContent = await compilotSdk.createSession({
  *   workflowId: "4f7b537f-0ae0-429c-98c8-3f6555ef23d6",
  *   externalCustomerId: "123",
  *   additionalInformation: {
@@ -34,9 +34,9 @@ import type { AuthSession, Web2CreateSessionParams } from "@nexeraid/identity-sc
  * Please find below an example of how to use the createSession function in Next.js:
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
  *
  * export default async function handler(req: NextApiRequest, res: NextApiResponse ) {
@@ -46,7 +46,7 @@ import type { AuthSession, Web2CreateSessionParams } from "@nexeraid/identity-sc
  *     return;
  *   }
  *
- *   const sessionRes = await apiClient.createSession({
+ *   const sessionRes = await compilotSdk.createSession({
  *     workflowId: "4f7b537f-0ae0-429c-98c8-3f6555ef23d6",
  *     externalCustomerId: req.session.externalCustomerId,
  *   });

package/dist/declarations/src/actions/createWeb3Challenge.d.ts

@@ -13,11 +13,11 @@ import type { ChallengeResponse, WalletChallengeRequest } from "@nexeraid/identi
  * Basic usage:
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const challengeContent = await apiClient.createWeb3Challenge({
+ * const challengeContent = await compilotSdk.createWeb3Challenge({
  *  address: "0xabc",
  *  namespace: "eip155",
  *  blockchainId: "1",
@@ -31,9 +31,9 @@ import type { ChallengeResponse, WalletChallengeRequest } from "@nexeraid/identi
  * Please find below an example of how to use the createWeb3Challenge function in Next.js:
  *
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
  * export default async function handler(req: NextApiRequest, res: NextApiResponse ) {
  *  if (req.method !== "POST") {
@@ -42,7 +42,7 @@ import type { ChallengeResponse, WalletChallengeRequest } from "@nexeraid/identi
  *   return;
  *  }
  *
- *  const challengeContent = await apiClient.createWeb3Challenge({
+ *  const challengeContent = await compilotSdk.createWeb3Challenge({
  *   address: "0xabc",
  *   namespace: "eip155",
  *   blockchainId: "1",

package/dist/declarations/src/actions/getCustomerStatusByCustomerId.d.ts

@@ -11,11 +11,11 @@ import type { CustomerStatus } from "@nexeraid/identity-schemas";
  * @example
  * ```typescript
  *
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const customerStatus = await apiClient.getCustomerStatusByCustomerId({
+ * const customerStatus = await compilotSdk.getCustomerStatusByCustomerId({
  *  customerId: "123",
  * });
  * ```

package/dist/declarations/src/actions/getCustomerStatusByExternalCustomerId.d.ts

@@ -11,11 +11,11 @@ import type { CustomerStatus, ExternalCustomerId } from "@nexeraid/identity-sche
  * @example
  * ```typescript
  *
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const customerStatus = await apiClient.getCustomerStatusByExternalCustomerId({
+ * const customerStatus = await compilotSdk.getCustomerStatusByExternalCustomerId({
  *  externalCustomerId: "123",
  * });
  * ```

package/dist/declarations/src/actions/getCustomerStatusByWallet.d.ts

@@ -10,11 +10,11 @@ import type { CustomerStatus } from "@nexeraid/identity-schemas";
  *
  * @example
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const customerStatus = await apiClient.getCustomerStatusByWallet({
+ * const customerStatus = await compilotSdk.getCustomerStatusByWallet({
  *  walletAddress: "tz1abc",
  *  workspaceId: "123",
  * });

package/dist/declarations/src/actions/getCustomerWallets.d.ts

@@ -9,11 +9,11 @@ import type { NexeraAPIClient } from "@nexeraid/api-client";
  *
  * @example
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const wallets = await apiClient.getCustomerWallets({
+ * const wallets = await compilotSdk.getCustomerWallets({
  *  customerId: "123",
  * });
  * ```

package/dist/declarations/src/actions/getTxAuthDataSignature.d.ts

@@ -13,11 +13,11 @@ import { ExtendedTezosTxAuthDataSignatureResponse } from "@nexeraid/identity-sch
  *
  * Eip155:
  * ```typescript
- * import { createApiClient } from "@compilot/js-sdk";
+ * import { createSdk } from "@compilot/js-sdk";
  *
- * const apiClient = createApiClient({ apiKey });
+ * const compilotSdk = createSdk({ apiKey });
  *
- * const txAuthDataSignature = await apiClient.getTxAuthDataSignature({
+ * const txAuthDataSignature = await compilotSdk.getTxAuthDataSignature({
  *  namespace: "eip155",
  *  contractAbi: ExampleGatedNFTMinterABI,
  *  contractAddress: "0x123",

package/dist/declarations/src/actions/verifyWeb3Challenge.d.ts

@@ -0,0 +1,64 @@
+import type { IdentityApiClient } from "@nexeraid/identity-api-client";
+import type { AuthSession, VerifyChallengeParams } from "@nexeraid/identity-schemas";
+/**
+ * Verify a challenge for a wallet. The web-sdk can use this to verify a signed message and prove ownership of a wallet.
+ *
+ * @param params The parameters to verify
+ * @returns A promise that resolves to the auth session
+ *
+ * @category Actions
+ *
+ * @example
+ *
+ * Basic usage:
+ *
+ * ```typescript
+ * import { createSdk } from "@compilot/js-sdk";
+ *
+ * const compilotSdk = createSdk({ apiKey });
+ *
+ * const challengeContent = await compilotSdk.verifyWeb3Challenge({
+ *  address: "0xabc",
+ *  namespace: "eip155",
+ *  blockchainId: "1",
+ *  message: ".....", // the challenge message
+ *  signedMessage: ".....", // the signed message, some wallets need to process the message before signing
+ *  signature: ".....", // the wallet signature of the signed message
+ *  signerPublicKey: "0x...",
+ * });
+ * ```
+ *
+ * More often used as part of an api to protect the api key.
+ * Please find below an example of how to use the verifyWeb3Challenge function in Next.js:
+ *
+ * ```typescript
+ * import { createSdk } from "@compilot/js-sdk";
+ *
+ * const compilotSdk = createSdk({ apiKey });
+ *
+ * export default async function handler(req: NextApiRequest, res: NextApiResponse ) {
+ *  if (req.method !== "POST") {
+ *   res.setHeader("Allow", ["POST"]);
+ *   res.status(405).end(`Method ${req.method} Not Allowed`);
+ *   return;
+ *  }
+ *
+ *  const authSession = await compilotSdk.verifyWeb3Challenge({
+ *   ...req.body
+ *  });
+ *
+ *  // now we know this user is authenticated, save the user address to the local database for future reference
+ *  db.update(authSession.externalCustomerId, {
+ *   address: req.body.address,
+ *  });
+ *
+ *  // Return the challenge to the client
+ *  res.status(200).json(authSession);
+ * }
+ * ```
+ */
+export type VerifyWeb3ChallengeFn = (params: VerifyChallengeParams) => Promise<AuthSession>;
+export declare const verifyWeb3ChallengeFactory: (deps: {
+    identityApiClient: IdentityApiClient;
+}) => VerifyWeb3ChallengeFn;
+//# sourceMappingURL=verifyWeb3Challenge.d.ts.map

package/dist/declarations/src/actions/verifyWeb3Challenge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"verifyWeb3Challenge.d.ts","sourceRoot":"../../../../src/actions","sources":["verifyWeb3Challenge.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,KAAK,EACV,WAAW,EACX,qBAAqB,EACtB,MAAM,4BAA4B,CAAC;AAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAClC,MAAM,EAAE,qBAAqB,KAC1B,OAAO,CAAC,WAAW,CAAC,CAAC;AAE1B,eAAO,MAAM,0BAA0B,SAC9B;IAAE,iBAAiB,EAAE,iBAAiB,CAAA;CAAE,KAAG,qBAMjD,CAAC"}

package/dist/declarations/src/configuration/createSdk.d.ts

@@ -11,6 +11,7 @@ export declare const createSdk: ({ apiKey, webhookSecret, }: {
     webhookSecret?: string;
 }) => {
     createWeb3Challenge: import("../actions/createWeb3Challenge.js").CreateWeb3ChallengeFn;
+    verifyWeb3Challenge: import("../actions/verifyWeb3Challenge.js").VerifyWeb3ChallengeFn;
     createSession: import("../actions/createWeb2Session.js").CreateWeb2SessionFn;
     getTxAuthDataSignature: import("../actions/getTxAuthDataSignature.js").GetTxAuthDataSignatureFn;
     attachCustomerInformation: import("../actions/attachCustomerInformation.js").AttachCustomerInformationFn;

package/dist/declarations/src/configuration/createSdk.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createSdk.d.ts","sourceRoot":"../../../../src/configuration","sources":["createSdk.ts"],"names":[],"mappings":"AAgBA;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,+BAGnB;IACD,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;;;;;;;;;;CA0CA,CAAC;AAEF,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC"}
+{"version":3,"file":"createSdk.d.ts","sourceRoot":"../../../../src/configuration","sources":["createSdk.ts"],"names":[],"mappings":"AAiBA;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,+BAGnB;IACD,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;;;;;;;;;;;CA2CA,CAAC;AAEF,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC"}

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compilot/js-sdk",
-  "version": "2.0.41",
+  "version": "2.0.43",
   "description": "ComPilot JS SDK",
   "keywords": [],
   "license": "ISC",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compilot/js-sdk",
-  "version": "2.0.41-dev",
+  "version": "2.0.43-dev",
   "description": "ComPilot JS SDK",
   "keywords": [],
   "license": "ISC",
@@ -28,9 +28,9 @@
     "svix": "1.21.0",
     "zod": "^3.23.8",
     "@nexeraid/api-client": "1.10.2-dev",
-    "@nexeraid/identity-api-client": "1.3.215-dev",
-    "@nexeraid/identity-schemas": "1.12.38-dev",
-    "@nexeraid/logger": "0.1.2-dev"
+    "@nexeraid/identity-schemas": "1.12.40-dev",
+    "@nexeraid/logger": "0.1.2-dev",
+    "@nexeraid/identity-api-client": "1.3.215-dev"
   },
   "devDependencies": {
     "prettier": "^3.3.3",

package/readme.md

@@ -18,7 +18,7 @@ npm install @compilot/js-sdk
 /**
  * Create an API client and authenticate with your API key
  */
-const apiClient = createApiClient({
+const compilotSdk = createSdk({
   apiKey: API_KEY,
 });
 ```
@@ -32,7 +32,7 @@ If you already have your own authentication system, you can create a user sessio
  * Get access token
  * This has to be done from secured server, to avoid leaking API_KEY
  */
-const sessionRes = await apiClient.createSession({
+const sessionRes = await compilotSdk.createSession({
   /**
    * The workflow id that this session will be bound to.
    * You can find this id in compilot's dashboard.
@@ -50,13 +50,13 @@ const sessionRes = await apiClient.createSession({
 Please find below an example endpoint using express:
 
 ```javascript
-const apiClient = createApiClient({
+const compilotSdk = createSdk({
   apiKey: API_KEY,
 });
 
 app.get('/my-compilot-auth', (req, res) => {
     const userId = req.userId;
-    const authSession = await apiClient.createSession({
+    const authSession = await compilotSdk.createSession({
         workflowId: WORKFLOW_ID,
         externalUserId: userId,
     });