@prosopo/types 2.1.4 → 2.1.6

package/dist/cjs/provider/api.cjs

@@ -0,0 +1,183 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const z = require("zod");
+const params = require("../api/params.cjs");
+const timeouts = require("../config/timeouts.cjs");
+require("../datasets/index.cjs");
+require("../procaptcha/index.cjs");
+const captcha = require("../datasets/captcha.cjs");
+const token = require("../procaptcha/token.cjs");
+const ApiPrefix = "/v1/prosopo";
+var ApiPaths = /* @__PURE__ */ ((ApiPaths2) => {
+  ApiPaths2["GetImageCaptchaChallenge"] = "/v1/prosopo/provider/captcha/image";
+  ApiPaths2["GetPowCaptchaChallenge"] = "/v1/prosopo/provider/captcha/pow";
+  ApiPaths2["GetFrictionlessCaptchaChallenge"] = "/v1/prosopo/provider/captcha/frictionless";
+  ApiPaths2["SubmitImageCaptchaSolution"] = "/v1/prosopo/provider/solution";
+  ApiPaths2["SubmitPowCaptchaSolution"] = "/v1/prosopo/provider/pow/solution";
+  ApiPaths2["VerifyPowCaptchaSolution"] = "/v1/prosopo/provider/pow/verify";
+  ApiPaths2["VerifyImageCaptchaSolutionDapp"] = "/v1/prosopo/provider/image/dapp/verify";
+  ApiPaths2["GetProviderStatus"] = "/v1/prosopo/provider/status";
+  ApiPaths2["GetProviderDetails"] = "/v1/prosopo/provider/details";
+  ApiPaths2["UpdateProviderClients"] = "/v1/prosopo/provider/clients";
+  ApiPaths2["SubmitUserEvents"] = "/v1/prosopo/provider/events";
+  return ApiPaths2;
+})(ApiPaths || {});
+var AdminApiPaths = /* @__PURE__ */ ((AdminApiPaths2) => {
+  AdminApiPaths2["UpdateDataset"] = "/v1/prosopo/provider/admin/dataset";
+  AdminApiPaths2["ProviderDeregister"] = "/v1/prosopo/provider/admin/deregister";
+  AdminApiPaths2["ProviderUpdate"] = "/v1/prosopo/provider/admin/update";
+  AdminApiPaths2["SiteKeyRegister"] = "/v1/prosopo/provider/admin/sitekey/register";
+  return AdminApiPaths2;
+})(AdminApiPaths || {});
+const ProviderDefaultRateLimits = {
+  [
+    "/v1/prosopo/provider/captcha/image"
+    /* GetImageCaptchaChallenge */
+  ]: { windowMs: 6e4, limit: 30 },
+  [
+    "/v1/prosopo/provider/captcha/pow"
+    /* GetPowCaptchaChallenge */
+  ]: { windowMs: 6e4, limit: 60 },
+  [
+    "/v1/prosopo/provider/solution"
+    /* SubmitImageCaptchaSolution */
+  ]: { windowMs: 6e4, limit: 60 },
+  [
+    "/v1/prosopo/provider/captcha/frictionless"
+    /* GetFrictionlessCaptchaChallenge */
+  ]: { windowMs: 6e4, limit: 60 },
+  [
+    "/v1/prosopo/provider/pow/solution"
+    /* SubmitPowCaptchaSolution */
+  ]: { windowMs: 6e4, limit: 60 },
+  [
+    "/v1/prosopo/provider/pow/verify"
+    /* VerifyPowCaptchaSolution */
+  ]: { windowMs: 6e4, limit: 60 },
+  [
+    "/v1/prosopo/provider/image/dapp/verify"
+    /* VerifyImageCaptchaSolutionDapp */
+  ]: { windowMs: 6e4, limit: 60 },
+  [
+    "/v1/prosopo/provider/status"
+    /* GetProviderStatus */
+  ]: { windowMs: 6e4, limit: 60 },
+  [
+    "/v1/prosopo/provider/details"
+    /* GetProviderDetails */
+  ]: { windowMs: 6e4, limit: 60 },
+  [
+    "/v1/prosopo/provider/events"
+    /* SubmitUserEvents */
+  ]: { windowMs: 6e4, limit: 60 },
+  [
+    "/v1/prosopo/provider/clients"
+    /* UpdateProviderClients */
+  ]: { windowMs: 6e4, limit: 5 },
+  [
+    "/v1/prosopo/provider/admin/dataset"
+    /* UpdateDataset */
+  ]: { windowMs: 6e4, limit: 5 },
+  [
+    "/v1/prosopo/provider/admin/sitekey/register"
+    /* SiteKeyRegister */
+  ]: { windowMs: 6e4, limit: 5 },
+  [
+    "/v1/prosopo/provider/admin/deregister"
+    /* ProviderDeregister */
+  ]: { windowMs: 6e4, limit: 1 },
+  [
+    "/v1/prosopo/provider/admin/update"
+    /* ProviderUpdate */
+  ]: { windowMs: 6e4, limit: 5 }
+};
+const createRateLimitSchemaWithDefaults = (paths) => z.object(
+  Object.entries(paths).reduce(
+    (schemas, [path, defaults]) => {
+      const enumPath = path;
+      schemas[enumPath] = z.object({
+        windowMs: z.number().optional().default(defaults.windowMs),
+        limit: z.number().optional().default(defaults.limit)
+      });
+      return schemas;
+    },
+    {}
+  )
+);
+const ApiPathRateLimits = createRateLimitSchemaWithDefaults(
+  ProviderDefaultRateLimits
+);
+const CaptchaRequestBody = z.object({
+  [params.ApiParams.user]: z.string(),
+  [params.ApiParams.dapp]: z.string(),
+  [params.ApiParams.datasetId]: z.string()
+});
+const CaptchaSolutionBody = z.object({
+  [params.ApiParams.user]: z.string(),
+  [params.ApiParams.dapp]: z.string(),
+  [params.ApiParams.captchas]: z.array(captcha.CaptchaSolutionSchema),
+  [params.ApiParams.requestHash]: z.string(),
+  [params.ApiParams.timestamp]: z.string(),
+  [params.ApiParams.signature]: z.object({
+    [params.ApiParams.user]: token.TimestampSignatureSchema,
+    [params.ApiParams.provider]: token.RequestHashSignatureSchema
+  })
+});
+const VerifySolutionBody = z.object({
+  [params.ApiParams.token]: token.ProcaptchaTokenSpec,
+  [params.ApiParams.dappSignature]: z.string(),
+  [params.ApiParams.maxVerifiedTime]: z.number().optional().default(timeouts.DEFAULT_IMAGE_MAX_VERIFIED_TIME_CACHED)
+});
+const ServerPowCaptchaVerifyRequestBody = z.object({
+  [params.ApiParams.token]: token.ProcaptchaTokenSpec,
+  [params.ApiParams.dappSignature]: z.string(),
+  [params.ApiParams.verifiedTimeout]: z.number().optional().default(timeouts.DEFAULT_POW_CAPTCHA_VERIFIED_TIMEOUT)
+});
+const GetPowCaptchaChallengeRequestBody = z.object({
+  [params.ApiParams.user]: z.string(),
+  [params.ApiParams.dapp]: z.string(),
+  [params.ApiParams.sessionId]: z.string().optional()
+});
+const SubmitPowCaptchaSolutionBody = z.object({
+  [params.ApiParams.challenge]: captcha.PowChallengeIdSchema,
+  [params.ApiParams.difficulty]: z.number(),
+  [params.ApiParams.signature]: z.object({
+    [params.ApiParams.user]: z.object({
+      [params.ApiParams.timestamp]: z.string()
+    }),
+    [params.ApiParams.provider]: z.object({
+      [params.ApiParams.challenge]: z.string()
+    })
+  }),
+  [params.ApiParams.user]: z.string(),
+  [params.ApiParams.dapp]: z.string(),
+  [params.ApiParams.nonce]: z.number(),
+  [params.ApiParams.verifiedTimeout]: z.number().optional().default(timeouts.DEFAULT_POW_CAPTCHA_VERIFIED_TIMEOUT)
+});
+const GetFrictionlessCaptchaChallengeRequestBody = z.object({
+  [params.ApiParams.dapp]: z.string(),
+  [params.ApiParams.token]: z.string()
+});
+const VerifyPowCaptchaSolutionBody = z.object({
+  [params.ApiParams.siteKey]: z.string()
+});
+const RegisterSitekeyBody = z.object({
+  [params.ApiParams.siteKey]: z.string(),
+  [params.ApiParams.settings]: z.object({
+    [params.ApiParams.captchaType]: z.string()
+  }).optional()
+});
+exports.AdminApiPaths = AdminApiPaths;
+exports.ApiPathRateLimits = ApiPathRateLimits;
+exports.ApiPaths = ApiPaths;
+exports.ApiPrefix = ApiPrefix;
+exports.CaptchaRequestBody = CaptchaRequestBody;
+exports.CaptchaSolutionBody = CaptchaSolutionBody;
+exports.GetFrictionlessCaptchaChallengeRequestBody = GetFrictionlessCaptchaChallengeRequestBody;
+exports.GetPowCaptchaChallengeRequestBody = GetPowCaptchaChallengeRequestBody;
+exports.ProviderDefaultRateLimits = ProviderDefaultRateLimits;
+exports.RegisterSitekeyBody = RegisterSitekeyBody;
+exports.ServerPowCaptchaVerifyRequestBody = ServerPowCaptchaVerifyRequestBody;
+exports.SubmitPowCaptchaSolutionBody = SubmitPowCaptchaSolutionBody;
+exports.VerifyPowCaptchaSolutionBody = VerifyPowCaptchaSolutionBody;
+exports.VerifySolutionBody = VerifySolutionBody;

package/dist/cjs/provider/argv.cjs

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const z = require("zod");
+const accounts = require("./accounts.cjs");
+const PayeeSchema = z.nativeEnum(accounts.Payee);
+exports.PayeeSchema = PayeeSchema;

package/dist/cjs/provider/index.cjs

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const accounts = require("./accounts.cjs");
+const api = require("./api.cjs");
+const scheduler = require("./scheduler.cjs");
+const argv = require("./argv.cjs");
+exports.Payee = accounts.Payee;
+exports.AdminApiPaths = api.AdminApiPaths;
+exports.ApiPathRateLimits = api.ApiPathRateLimits;
+exports.ApiPaths = api.ApiPaths;
+exports.ApiPrefix = api.ApiPrefix;
+exports.CaptchaRequestBody = api.CaptchaRequestBody;
+exports.CaptchaSolutionBody = api.CaptchaSolutionBody;
+exports.GetFrictionlessCaptchaChallengeRequestBody = api.GetFrictionlessCaptchaChallengeRequestBody;
+exports.GetPowCaptchaChallengeRequestBody = api.GetPowCaptchaChallengeRequestBody;
+exports.ProviderDefaultRateLimits = api.ProviderDefaultRateLimits;
+exports.RegisterSitekeyBody = api.RegisterSitekeyBody;
+exports.ServerPowCaptchaVerifyRequestBody = api.ServerPowCaptchaVerifyRequestBody;
+exports.SubmitPowCaptchaSolutionBody = api.SubmitPowCaptchaSolutionBody;
+exports.VerifyPowCaptchaSolutionBody = api.VerifyPowCaptchaSolutionBody;
+exports.VerifySolutionBody = api.VerifySolutionBody;
+exports.ScheduledTaskNames = scheduler.ScheduledTaskNames;
+exports.ScheduledTaskStatus = scheduler.ScheduledTaskStatus;
+exports.PayeeSchema = argv.PayeeSchema;

package/dist/cjs/provider/scheduler.cjs

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+var ScheduledTaskNames = /* @__PURE__ */ ((ScheduledTaskNames2) => {
+  ScheduledTaskNames2["BatchCommitment"] = "BatchCommitment";
+  ScheduledTaskNames2["CalculateSolution"] = "CalculateSolution";
+  ScheduledTaskNames2["StoreCommitmentsExternal"] = "StoreCommitmentsExternal";
+  ScheduledTaskNames2["GetClientList"] = "GetClientList";
+  return ScheduledTaskNames2;
+})(ScheduledTaskNames || {});
+var ScheduledTaskStatus = /* @__PURE__ */ ((ScheduledTaskStatus2) => {
+  ScheduledTaskStatus2["Pending"] = "Pending";
+  ScheduledTaskStatus2["Running"] = "Running";
+  ScheduledTaskStatus2["Completed"] = "Completed";
+  ScheduledTaskStatus2["Failed"] = "Failed";
+  return ScheduledTaskStatus2;
+})(ScheduledTaskStatus || {});
+exports.ScheduledTaskNames = ScheduledTaskNames;
+exports.ScheduledTaskStatus = ScheduledTaskStatus;

package/dist/client/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./user.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAaA,cAAc,WAAW,CAAC"}

package/dist/client/index.js

@@ -0,0 +1,2 @@
+export * from "./user.js";
+//# sourceMappingURL=index.js.map

package/dist/client/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAaA,cAAc,WAAW,CAAC"}

package/dist/client/user.d.ts

@@ -0,0 +1,38 @@
+import type { Timestamp } from "../datasets/index.js";
+export declare enum Tier {
+    Free = "free",
+    Professional = "professional",
+    Enterprise = "enterprise"
+}
+export declare const TierMonthlyLimits: {
+    free: {
+        verificationRequests: number;
+    };
+    professional: {
+        verificationRequests: number;
+    };
+    enterprise: {
+        verificationRequests: string;
+    };
+};
+export interface IUserData {
+    email: string;
+    name: string;
+    account: string;
+    url: string;
+    mnemonic: string;
+    createdAt: Timestamp;
+    activated: boolean;
+    tier: Tier;
+    marketingPreferences: boolean;
+    originUrl: string;
+    settings?: IUserSettings;
+    updatedAtTimestamp?: Timestamp;
+}
+export interface IUserSettings {
+    frictionlessThreshold?: number;
+    powDifficulty?: number;
+    domains?: string[];
+    captchaType?: "image" | "pow" | "frictionless";
+}
+//# sourceMappingURL=user.d.ts.map

package/dist/client/user.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/client/user.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEtD,oBAAY,IAAI;IACf,IAAI,SAAS;IACb,YAAY,iBAAiB;IAC7B,UAAU,eAAe;CACzB;AAED,eAAO,MAAM,iBAAiB;;;;;;;;;;CAU7B,CAAC;AAEF,MAAM,WAAW,SAAS;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,EAAE,IAAI,CAAC;IACX,oBAAoB,EAAE,OAAO,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,kBAAkB,CAAC,EAAE,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,aAAa;IAC7B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,cAAc,CAAC;CAC/C"}

package/dist/client/user.js

@@ -0,0 +1,18 @@
+export var Tier;
+(function (Tier) {
+    Tier["Free"] = "free";
+    Tier["Professional"] = "professional";
+    Tier["Enterprise"] = "enterprise";
+})(Tier || (Tier = {}));
+export const TierMonthlyLimits = {
+    [Tier.Free]: {
+        verificationRequests: 100000,
+    },
+    [Tier.Professional]: {
+        verificationRequests: 1000000,
+    },
+    [Tier.Enterprise]: {
+        verificationRequests: "Unlimited",
+    },
+};
+//# sourceMappingURL=user.js.map

package/dist/client/user.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.js","sourceRoot":"","sources":["../../src/client/user.ts"],"names":[],"mappings":"AAeA,MAAM,CAAN,IAAY,IAIX;AAJD,WAAY,IAAI;IACf,qBAAa,CAAA;IACb,qCAA6B,CAAA;IAC7B,iCAAyB,CAAA;AAC1B,CAAC,EAJW,IAAI,KAAJ,IAAI,QAIf;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAChC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACZ,oBAAoB,EAAE,MAAM;KAC5B;IACD,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;QACpB,oBAAoB,EAAE,OAAO;KAC7B;IACD,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;QAClB,oBAAoB,EAAE,WAAW;KACjC;CACD,CAAC"}