@prosopo/api 2.5.5 → 2.6.1

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# @prosopo/api
+
+## 2.6.1
+
+### Patch Changes
+
+- Updated dependencies [52feffc]
+  - @prosopo/types@2.6.1
+
+## 2.6.0
+
+### Minor Changes
+
+- a0bfc8a: bump all pkg versions since independent versioning applied
+
+### Patch Changes
+
+- Updated dependencies [a0bfc8a]
+  - @prosopo/types@2.6.0

package/dist/cjs/api/HttpClientBase.cjs

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } });
+const HttpError = require("./HttpError.cjs");
+class HttpClientBase {
+  constructor(baseURL, prefix = "") {
+    this.baseURL = baseURL + prefix;
+  }
+  async fetch(input, init) {
+    try {
+      const response = await fetch(this.baseURL + input, init);
+      if (!response.ok && // Only throw an error if the response is not JSON and not a 400 error
+      response.status !== 400 && !response.headers.get("content-type")?.includes("application/json")) {
+        throw new HttpError.HttpError(response.status, response.statusText, response.url);
+      }
+      return this.responseHandler(response);
+    } catch (error) {
+      return this.errorHandler(error);
+    }
+  }
+  async post(input, body, init) {
+    const headers = {
+      "Content-Type": "application/json",
+      ...init?.headers || {}
+    };
+    try {
+      const response = await fetch(this.baseURL + input, {
+        method: "POST",
+        body: JSON.stringify(body),
+        ...init,
+        headers
+      });
+      if (!response.ok && // Only throw an error if the response is not JSON and not a 400 error
+      response.status !== 400 && !response.headers.get("content-type")?.includes("application/json")) {
+        throw new HttpError.HttpError(response.status, response.statusText, response.url);
+      }
+      return this.responseHandler(response);
+    } catch (error) {
+      return this.errorHandler(error);
+    }
+  }
+  async responseHandler(response) {
+    try {
+      return await response.json();
+    } catch (error) {
+      console.error("Error parsing JSON:", error);
+      throw error;
+    }
+  }
+  errorHandler(error) {
+    if (error instanceof HttpError.HttpError) {
+      console.error("HTTP error:", error);
+    } else {
+      console.error("API request error:", error);
+    }
+    return Promise.reject(error);
+  }
+}
+exports.HttpClientBase = HttpClientBase;
+exports.default = HttpClientBase;

package/dist/cjs/api/HttpError.cjs

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+class HttpError extends Error {
+  constructor(status, statusText, url) {
+    super(`HTTP error! status: ${status} (${statusText}) for URL: ${url}`);
+    this.status = status;
+    this.statusText = statusText;
+    this.url = url;
+    this.name = "HttpError";
+  }
+}
+exports.HttpError = HttpError;

package/dist/cjs/api/ProviderApi.cjs

@@ -0,0 +1,190 @@
+"use strict";
+const types = require("@prosopo/types");
+const HttpClientBase = require("./HttpClientBase.cjs");
+class ProviderApi extends HttpClientBase.HttpClientBase {
+  constructor(providerUrl, account) {
+    const providerUrlWithProtocol = !providerUrl.startsWith("http") ? `https://${providerUrl}` : providerUrl;
+    super(providerUrlWithProtocol);
+    this.account = account;
+  }
+  getCaptchaChallenge(userAccount, randomProvider, sessionId) {
+    const { provider } = randomProvider;
+    const dappAccount = this.account;
+    const body = {
+      [types.ApiParams.dapp]: dappAccount,
+      [types.ApiParams.user]: userAccount,
+      [types.ApiParams.datasetId]: provider.datasetId
+    };
+    if (sessionId) {
+      body[types.ApiParams.sessionId] = sessionId;
+    }
+    return this.post(types.ClientApiPaths.GetImageCaptchaChallenge, body, {
+      headers: {
+        "Prosopo-Site-Key": this.account,
+        "Prosopo-User": userAccount
+      }
+    });
+  }
+  submitCaptchaSolution(captchas, requestHash, userAccount, timestamp, providerRequestHashSignature, userTimestampSignature) {
+    const body = {
+      [types.ApiParams.user]: userAccount,
+      [types.ApiParams.dapp]: this.account,
+      [types.ApiParams.captchas]: captchas,
+      [types.ApiParams.requestHash]: requestHash,
+      [types.ApiParams.timestamp]: timestamp,
+      [types.ApiParams.signature]: {
+        [types.ApiParams.user]: {
+          [types.ApiParams.timestamp]: userTimestampSignature
+        },
+        [types.ApiParams.provider]: {
+          [types.ApiParams.requestHash]: providerRequestHashSignature
+        }
+      }
+    };
+    return this.post(types.ClientApiPaths.SubmitImageCaptchaSolution, body, {
+      headers: {
+        "Prosopo-Site-Key": this.account,
+        "Prosopo-User": userAccount
+      }
+    });
+  }
+  verifyDappUser(token, signature, userAccount, maxVerifiedTime) {
+    const payload = {
+      [types.ApiParams.token]: token,
+      [types.ApiParams.dappSignature]: signature
+    };
+    if (maxVerifiedTime) {
+      payload[types.ApiParams.maxVerifiedTime] = maxVerifiedTime;
+    }
+    return this.post(types.ClientApiPaths.VerifyImageCaptchaSolutionDapp, payload, {
+      headers: {
+        "Prosopo-Site-Key": this.account,
+        "Prosopo-User": userAccount
+      }
+    });
+  }
+  getPowCaptchaChallenge(user, dapp, sessionId) {
+    const body = {
+      [types.ApiParams.user]: user.toString(),
+      [types.ApiParams.dapp]: dapp.toString(),
+      ...sessionId && { [types.ApiParams.sessionId]: sessionId }
+    };
+    return this.post(types.ClientApiPaths.GetPowCaptchaChallenge, body, {
+      headers: {
+        "Prosopo-Site-Key": this.account,
+        "Prosopo-User": user
+      }
+    });
+  }
+  submitPowCaptchaSolution(challenge, userAccount, dappAccount, nonce, userTimestampSignature, timeout) {
+    const body = types.SubmitPowCaptchaSolutionBody.parse({
+      [types.ApiParams.challenge]: challenge.challenge,
+      [types.ApiParams.difficulty]: challenge.difficulty,
+      [types.ApiParams.timestamp]: challenge.timestamp,
+      [types.ApiParams.user]: userAccount.toString(),
+      [types.ApiParams.dapp]: dappAccount.toString(),
+      [types.ApiParams.nonce]: nonce,
+      [types.ApiParams.verifiedTimeout]: timeout,
+      [types.ApiParams.signature]: {
+        [types.ApiParams.provider]: challenge[types.ApiParams.signature][types.ApiParams.provider],
+        [types.ApiParams.user]: {
+          [types.ApiParams.timestamp]: userTimestampSignature
+        }
+      }
+    });
+    return this.post(types.ClientApiPaths.SubmitPowCaptchaSolution, body, {
+      headers: {
+        "Prosopo-Site-Key": this.account,
+        "Prosopo-User": userAccount
+      }
+    });
+  }
+  getFrictionlessCaptcha(token, dapp, user) {
+    const body = {
+      [types.ApiParams.token]: token,
+      [types.ApiParams.dapp]: dapp,
+      [types.ApiParams.user]: user
+    };
+    return this.post(types.ClientApiPaths.GetFrictionlessCaptchaChallenge, body, {
+      headers: {
+        "Prosopo-Site-Key": this.account,
+        "Prosopo-User": user
+      }
+    });
+  }
+  submitUserEvents(events, string) {
+    return this.post(
+      types.ClientApiPaths.SubmitUserEvents,
+      { events, string },
+      {
+        headers: {
+          "Prosopo-Site-Key": this.account
+        }
+      }
+    );
+  }
+  getProviderStatus() {
+    return this.fetch(types.ClientApiPaths.GetProviderStatus, {
+      headers: {
+        "Prosopo-Site-Key": this.account
+      }
+    });
+  }
+  getProviderDetails() {
+    return this.fetch(types.PublicApiPaths.GetProviderDetails, {
+      headers: {
+        "Prosopo-Site-Key": this.account
+      }
+    });
+  }
+  submitPowCaptchaVerify(token, signatureHex, recencyLimit, user) {
+    const body = {
+      [types.ApiParams.token]: token,
+      [types.ApiParams.dappSignature]: signatureHex,
+      [types.ApiParams.verifiedTimeout]: recencyLimit
+    };
+    return this.post(types.ClientApiPaths.VerifyPowCaptchaSolution, body, {
+      headers: {
+        "Prosopo-Site-Key": this.account,
+        "Prosopo-User": user
+      }
+    });
+  }
+  registerSiteKey(siteKey, tier, settings, timestamp, signature) {
+    const body = { siteKey, tier, settings };
+    return this.post(types.AdminApiPaths.SiteKeyRegister, body, {
+      headers: {
+        "Prosopo-Site-Key": this.account,
+        timestamp,
+        signature
+      }
+    });
+  }
+  updateDetectorKey(detectorKey, timestamp, signature) {
+    return this.post(
+      types.AdminApiPaths.UpdateDetectorKey,
+      types.UpdateDetectorKeyBody.parse({ detectorKey }),
+      {
+        headers: {
+          "Prosopo-Site-Key": this.account,
+          timestamp,
+          signature
+        }
+      }
+    );
+  }
+  removeDetectorKey(detectorKey, timestamp, signature) {
+    return this.post(
+      types.AdminApiPaths.RemoveDetectorKey,
+      types.UpdateDetectorKeyBody.parse({ detectorKey }),
+      {
+        headers: {
+          "Prosopo-Site-Key": this.account,
+          timestamp,
+          signature
+        }
+      }
+    );
+  }
+}
+module.exports = ProviderApi;

package/dist/cjs/api/index.cjs

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const HttpClientBase = require("./HttpClientBase.cjs");
+const ProviderApi = require("./ProviderApi.cjs");
+exports.HttpClientBase = HttpClientBase.HttpClientBase;
+exports.ProviderApi = ProviderApi;

package/dist/cjs/index.cjs

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+require("./api/index.cjs");
+const ProviderApi = require("./api/ProviderApi.cjs");
+const HttpClientBase = require("./api/HttpClientBase.cjs");
+exports.ProviderApi = ProviderApi;
+exports.HttpClientBase = HttpClientBase.HttpClientBase;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prosopo/api",
-	"version": "2.5.5",
+	"version": "2.6.1",
 	"description": "Wrapper for the provider API",
 	"main": "dist/index.js",
 	"type": "module",
@@ -22,7 +22,8 @@
 	},
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/prosopo/captcha.git"
+		"url": "git+https://github.com/prosopo/captcha.git",
+		"directory": "packages/api"
 	},
 	"author": "PROSOPO LIMITED <info@prosopo.io>",
 	"license": "Apache-2.0",
@@ -31,11 +32,11 @@
 	},
 	"homepage": "https://github.com/prosopo/captcha#readme",
 	"dependencies": {
-		"@prosopo/types": "2.5.5",
+		"@prosopo/types": "2.6.1",
 		"express": "4.21.2"
 	},
 	"devDependencies": {
-		"@prosopo/config": "2.5.5",
+		"@prosopo/config": "2.6.0",
 		"@vitest/coverage-v8": "3.0.9",
 		"concurrently": "9.0.1",
 		"del-cli": "6.0.0",