@foxy.io/sdk 1.10.0 → 1.11.1

package/dist/cjs/core/API/AuthError.js

@@ -26,11 +26,15 @@ AuthError.NEW_PASSWORD_REQUIRED = 'NEW_PASSWORD_REQUIRED';
 AuthError.INVALID_NEW_PASSWORD = 'INVALID_NEW_PASSWORD';
 /** Credentials are invalid. That could mean empty or invalid email or password or otherwise incorrect auth data. */
 AuthError.UNAUTHORIZED = 'UNAUTHORIZED';
+/** Provided form data is invalid, e.g. email is too long or captcha is expired. */
+AuthError.INVALID_FORM = 'INVALID_FORM';
+/** Provided email is already taken. Applies to customer registration only. */
+AuthError.UNAVAILABLE = 'UNAVAILABLE';
 /** Any other or internal error that interrupted authentication. */
 AuthError.UNKNOWN = 'UNKNOWN';
 /** Available class member validators. */
 AuthError.v8n = {
     constructor: v8n_1.default().schema({
-        code: v8n_1.default().passesAnyOf(v8n_1.default().exact(AuthError.NEW_PASSWORD_REQUIRED), v8n_1.default().exact(AuthError.INVALID_NEW_PASSWORD), v8n_1.default().exact(AuthError.UNAUTHORIZED), v8n_1.default().exact(AuthError.UNKNOWN)),
+        code: v8n_1.default().passesAnyOf(v8n_1.default().exact(AuthError.NEW_PASSWORD_REQUIRED), v8n_1.default().exact(AuthError.INVALID_NEW_PASSWORD), v8n_1.default().exact(AuthError.UNAUTHORIZED), v8n_1.default().exact(AuthError.INVALID_FORM), v8n_1.default().exact(AuthError.UNAVAILABLE), v8n_1.default().exact(AuthError.UNKNOWN)),
     }),
 };

package/dist/cjs/customer/API.js

@@ -29,9 +29,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.API = void 0;
-const Core = __importStar(require("../core/index.js"));
 const cross_fetch_1 = require("cross-fetch");
 const v8n_js_1 = require("../core/v8n.js");
+const Core = __importStar(require("../core/index.js"));
 /**
  * Customer API for adding custom functionality to websites and web apps with our Customer Portal.
  *
@@ -67,6 +67,33 @@ class API extends Core.API {
             }
         });
     }
+    /**
+     * Creates a new customer account with the given credentials.
+     * If the email is already taken, `Core.API.AuthError` with code `UNAVAILABLE` will be thrown.
+     * If customer registration is disabled, `Core.API.AuthError` with code `UNAUTHORIZED` will be thrown.
+     * If the provided form data is invalid (e.g. captcha is expired), `Core.API.AuthError` with code `INVALID_FORM` will be thrown.
+     *
+     * @param params Customer information.
+     */
+    signUp(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            API.v8n.signUpParams.check(params);
+            const url = new URL('./sign_up', this.base);
+            const response = yield this.fetch(url.toString(), {
+                method: 'POST',
+                body: JSON.stringify(params),
+            });
+            if (!response.ok) {
+                if (response.status === 400)
+                    throw new Core.API.AuthError({ code: 'INVALID_FORM' });
+                if (response.status === 401)
+                    throw new Core.API.AuthError({ code: 'UNAUTHORIZED' });
+                if (response.status === 403)
+                    throw new Core.API.AuthError({ code: 'UNAVAILABLE' });
+                throw new Core.API.AuthError({ code: 'UNKNOWN' });
+            }
+        });
+    }
     /**
      * Initiates password reset for a customer with the given email.
      * If such customer exists, they will receive an email from Foxy with further instructions.
@@ -130,6 +157,16 @@ exports.API = API;
 API.SESSION = 'session';
 /** Validators for the method arguments in this class (internal). */
 API.v8n = Object.assign({}, Core.API.v8n, {
+    signUpParams: v8n_js_1.v8n().schema({
+        verification: v8n_js_1.v8n().schema({
+            token: v8n_js_1.v8n().string(),
+            type: v8n_js_1.v8n().passesAnyOf(v8n_js_1.v8n().exact('hcaptcha')),
+        }),
+        first_name: v8n_js_1.v8n().optional(v8n_js_1.v8n().string().maxLength(50)),
+        last_name: v8n_js_1.v8n().optional(v8n_js_1.v8n().string().maxLength(50)),
+        password: v8n_js_1.v8n().string().maxLength(50),
+        email: v8n_js_1.v8n().string().maxLength(100),
+    }),
     credentials: v8n_js_1.v8n().schema({
         email: v8n_js_1.v8n().string(),
         newPassword: v8n_js_1.v8n().optional(v8n_js_1.v8n().string()),

package/dist/cjs/customer/getNextTransactionDateConstraints.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getNextTransactionDateConstraints = void 0;
-const getNextTransactionDateConstraints_1 = require("../backend/getNextTransactionDateConstraints");
+const getNextTransactionDateConstraints_js_1 = require("../backend/getNextTransactionDateConstraints.js");
 /**
  * Finds which next transaction date modification rules are applicable to
  * the given subscription and merges them together.
@@ -27,6 +27,6 @@ function getNextTransactionDateConstraints(data, rules) {
             min: rule.min,
         }));
     }
-    return getNextTransactionDateConstraints_1.getNextTransactionDateConstraints(data, backendRules);
+    return getNextTransactionDateConstraints_js_1.getNextTransactionDateConstraints(data, backendRules);
 }
 exports.getNextTransactionDateConstraints = getNextTransactionDateConstraints;

package/dist/esm/core/API/AuthError.js

@@ -19,11 +19,15 @@ AuthError.NEW_PASSWORD_REQUIRED = 'NEW_PASSWORD_REQUIRED';
 AuthError.INVALID_NEW_PASSWORD = 'INVALID_NEW_PASSWORD';
 /** Credentials are invalid. That could mean empty or invalid email or password or otherwise incorrect auth data. */
 AuthError.UNAUTHORIZED = 'UNAUTHORIZED';
+/** Provided form data is invalid, e.g. email is too long or captcha is expired. */
+AuthError.INVALID_FORM = 'INVALID_FORM';
+/** Provided email is already taken. Applies to customer registration only. */
+AuthError.UNAVAILABLE = 'UNAVAILABLE';
 /** Any other or internal error that interrupted authentication. */
 AuthError.UNKNOWN = 'UNKNOWN';
 /** Available class member validators. */
 AuthError.v8n = {
     constructor: v8n().schema({
-        code: v8n().passesAnyOf(v8n().exact(AuthError.NEW_PASSWORD_REQUIRED), v8n().exact(AuthError.INVALID_NEW_PASSWORD), v8n().exact(AuthError.UNAUTHORIZED), v8n().exact(AuthError.UNKNOWN)),
+        code: v8n().passesAnyOf(v8n().exact(AuthError.NEW_PASSWORD_REQUIRED), v8n().exact(AuthError.INVALID_NEW_PASSWORD), v8n().exact(AuthError.UNAUTHORIZED), v8n().exact(AuthError.INVALID_FORM), v8n().exact(AuthError.UNAVAILABLE), v8n().exact(AuthError.UNKNOWN)),
     }),
 };

package/dist/esm/customer/API.js

@@ -7,9 +7,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import * as Core from '../core/index.js';
 import { Request, fetch } from 'cross-fetch';
 import { v8n } from '../core/v8n.js';
+import * as Core from '../core/index.js';
 /**
  * Customer API for adding custom functionality to websites and web apps with our Customer Portal.
  *
@@ -45,6 +45,33 @@ export class API extends Core.API {
             }
         });
     }
+    /**
+     * Creates a new customer account with the given credentials.
+     * If the email is already taken, `Core.API.AuthError` with code `UNAVAILABLE` will be thrown.
+     * If customer registration is disabled, `Core.API.AuthError` with code `UNAUTHORIZED` will be thrown.
+     * If the provided form data is invalid (e.g. captcha is expired), `Core.API.AuthError` with code `INVALID_FORM` will be thrown.
+     *
+     * @param params Customer information.
+     */
+    signUp(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            API.v8n.signUpParams.check(params);
+            const url = new URL('./sign_up', this.base);
+            const response = yield this.fetch(url.toString(), {
+                method: 'POST',
+                body: JSON.stringify(params),
+            });
+            if (!response.ok) {
+                if (response.status === 400)
+                    throw new Core.API.AuthError({ code: 'INVALID_FORM' });
+                if (response.status === 401)
+                    throw new Core.API.AuthError({ code: 'UNAUTHORIZED' });
+                if (response.status === 403)
+                    throw new Core.API.AuthError({ code: 'UNAVAILABLE' });
+                throw new Core.API.AuthError({ code: 'UNKNOWN' });
+            }
+        });
+    }
     /**
      * Initiates password reset for a customer with the given email.
      * If such customer exists, they will receive an email from Foxy with further instructions.
@@ -107,6 +134,16 @@ export class API extends Core.API {
 API.SESSION = 'session';
 /** Validators for the method arguments in this class (internal). */
 API.v8n = Object.assign({}, Core.API.v8n, {
+    signUpParams: v8n().schema({
+        verification: v8n().schema({
+            token: v8n().string(),
+            type: v8n().passesAnyOf(v8n().exact('hcaptcha')),
+        }),
+        first_name: v8n().optional(v8n().string().maxLength(50)),
+        last_name: v8n().optional(v8n().string().maxLength(50)),
+        password: v8n().string().maxLength(50),
+        email: v8n().string().maxLength(100),
+    }),
     credentials: v8n().schema({
         email: v8n().string(),
         newPassword: v8n().optional(v8n().string()),

package/dist/esm/customer/getNextTransactionDateConstraints.js

@@ -1,4 +1,4 @@
-import { getNextTransactionDateConstraints as backendUtility } from '../backend/getNextTransactionDateConstraints';
+import { getNextTransactionDateConstraints as backendUtility } from '../backend/getNextTransactionDateConstraints.js';
 /**
  * Finds which next transaction date modification rules are applicable to
  * the given subscription and merges them together.

package/dist/types/backend/Graph/customer_portal_settings.d.ts

@@ -58,6 +58,20 @@ export interface CustomerPortalSettings extends Graph {
     ssoSecret?: string;
     /** Life span of session in minutes. Maximum 40320 (4 weeks). */
     sessionLifespanInMinutes: number;
+    /** Self-registration settings. Self-registration is disabled if this field is undefined. */
+    signUp?: {
+      /** If this field is true, then self-registration is enabled. */
+      enabled: boolean;
+      /** Client verification settings. */
+      verification: {
+        /** Verification type. Currently only hCaptcha is supported. */
+        type: 'hcaptcha';
+        /** hCaptcha site key. If empty, Foxy will use its own hCaptcha site key. */
+        siteKey: string;
+        /** hCaptcha secret key. If empty, Foxy will use its own hCaptcha secret key. */
+        secretKey: string;
+      };
+    };
     /** The date this resource was created. */
     date_created: string | null;
     /** The date this resource was last modified. */

package/dist/types/core/API/AuthError.d.ts

@@ -4,7 +4,7 @@ declare type AuthErrorParams = {
     originalError?: unknown;
 };
 /** Union of all possible auth error codes. */
-declare type UniversalAPIAuthErrorCode = typeof AuthError['NEW_PASSWORD_REQUIRED'] | typeof AuthError['INVALID_NEW_PASSWORD'] | typeof AuthError['UNAUTHORIZED'] | typeof AuthError['UNKNOWN'];
+declare type UniversalAPIAuthErrorCode = typeof AuthError['NEW_PASSWORD_REQUIRED'] | typeof AuthError['INVALID_NEW_PASSWORD'] | typeof AuthError['UNAUTHORIZED'] | typeof AuthError['INVALID_FORM'] | typeof AuthError['UNAVAILABLE'] | typeof AuthError['UNKNOWN'];
 /**
  * Base error class for all authentication-related errors in
  * the APIs that can be used both server and client-side. If you're
@@ -18,6 +18,10 @@ export declare class AuthError extends Error {
     static readonly INVALID_NEW_PASSWORD = "INVALID_NEW_PASSWORD";
     /** Credentials are invalid. That could mean empty or invalid email or password or otherwise incorrect auth data. */
     static readonly UNAUTHORIZED = "UNAUTHORIZED";
+    /** Provided form data is invalid, e.g. email is too long or captcha is expired. */
+    static readonly INVALID_FORM = "INVALID_FORM";
+    /** Provided email is already taken. Applies to customer registration only. */
+    static readonly UNAVAILABLE = "UNAVAILABLE";
     /** Any other or internal error that interrupted authentication. */
     static readonly UNKNOWN = "UNKNOWN";
     /** Available class member validators. */

package/dist/types/customer/API.d.ts

@@ -1,6 +1,6 @@
-import * as Core from '../core/index.js';
-import type { Credentials } from './types';
+import type { Credentials, SignUpParams } from './types';
 import type { Graph } from './Graph';
+import * as Core from '../core/index.js';
 /**
  * Customer API for adding custom functionality to websites and web apps with our Customer Portal.
  *
@@ -15,6 +15,7 @@ export declare class API extends Core.API<Graph> {
     static readonly v8n: {
         classConstructor: any;
     } & {
+        signUpParams: any;
         credentials: any;
         email: any;
     };
@@ -26,6 +27,15 @@ export declare class API extends Core.API<Graph> {
      * @param credentials Customer email and password (one-time code).
      */
     signIn(credentials: Credentials): Promise<void>;
+    /**
+     * Creates a new customer account with the given credentials.
+     * If the email is already taken, `Core.API.AuthError` with code `UNAVAILABLE` will be thrown.
+     * If customer registration is disabled, `Core.API.AuthError` with code `UNAUTHORIZED` will be thrown.
+     * If the provided form data is invalid (e.g. captcha is expired), `Core.API.AuthError` with code `INVALID_FORM` will be thrown.
+     *
+     * @param params Customer information.
+     */
+    signUp(params: SignUpParams): Promise<void>;
     /**
      * Initiates password reset for a customer with the given email.
      * If such customer exists, they will receive an email from Foxy with further instructions.

package/dist/types/customer/Graph/customer_portal_settings.d.ts

@@ -53,6 +53,29 @@ export interface CustomerPortalSettings extends Graph {
     sso: boolean;
     /** Life span of session in minutes. Maximum 40320 (4 weeks). */
     session_lifespan_in_minutes: number;
+    /** Determines if a terms of service checkbox is shown on the portal. This value comes from a template config linked to the default template set. */
+    tos_checkbox_settings: {
+      /** Initial state of the checkbox element. */
+      initial_state: 'unchecked' | 'checked';
+      /** Hides the checkbox if true. */
+      is_hidden: boolean;
+      /** Hides the checkbox if "none". Makes accepting ToS mandatory if "required", and optional otherwise. */
+      usage: 'none' | 'optional' | 'required';
+      /** Public URL of your terms of service agreement. */
+      url: string;
+    };
+    /** Self-registration settings. Self-registration is disabled if this field is undefined. */
+    sign_up?: {
+      /** Client verification settings. */
+      verification: {
+        /** hCaptcha site key. If empty, Foxy will use its own hCaptcha site key. */
+        site_key: string;
+        /** Verification type. Currently only hCaptcha is supported. */
+        type: 'hcaptcha';
+      };
+      /** If this field is true, then self-registration is enabled. */
+      enabled: boolean;
+    };
     /** The date this resource was created. */
     date_created: string | null;
     /** The date this resource was last modified. */

package/dist/types/customer/types.d.ts

@@ -6,6 +6,25 @@ export interface Credentials {
   password: string;
 }
 
+/** Account creation parameters. */
+export interface SignUpParams {
+  /** Signup verification (currently only hCaptcha is supported). */
+  verification: {
+    /** Verification type. Currently only hCaptcha is supported. */
+    type: 'hcaptcha';
+    /** hCaptcha verification token. */
+    token: string;
+  };
+  /** Customer's first name, optional, up to 50 characters. */
+  first_name?: string;
+  /** Customer's last name, optional, up to 50 characters. */
+  last_name?: string;
+  /** Customer's password (up to 50 characters). If not provided, Foxy will generate a random password for this account server-side. */
+  password?: string;
+  /** Customer's email address (up to 100 characters), required. */
+  email: string;
+}
+
 export interface Session {
   session_token: string;
   expires_in: number;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@foxy.io/sdk",
   "type": "commonjs",
-  "version": "1.10.0",
+  "version": "1.11.1",
   "description": "Universal SDK for a full server-side and a limited in-browser access to Foxy hAPI.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -89,6 +89,7 @@
     "ts-node": "^9.1.1",
     "ttypescript": "^1.5.15",
     "typedoc": "^0.22.18",
+    "typedoc-plugin-missing-exports": "^1.0.0",
     "typescript": "^4.0.3",
     "webpack": "^5.75.0",
     "webpack-cli": "^4.10.0",