@prosopo/procaptcha 0.1.0

package/src/types/client.ts

@@ -0,0 +1,88 @@
+// Copyright (C) 2021-2022 Prosopo (UK) Ltd.
+// This file is part of procaptcha <https://github.com/prosopo-io/procaptcha>.
+//
+// procaptcha is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// procaptcha is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with procaptcha.  If not, see <http://www.gnu.org/licenses/>.
+import { InjectedAccountWithMeta, InjectedExtension } from "@polkadot/extension-inject/types";
+import { ProsopoCaptchaConfig, GetCaptchaResponse, CaptchaSolutionResponse } from "../types/api";
+import { TransactionResponse } from "../types/contract";
+import {CaptchaSolution, CaptchaSolutionCommitment} from "@prosopo/contract";
+import { Extension } from "../api/Extension";
+
+export type TExtensionAccount = InjectedAccountWithMeta;
+
+export type TCaptchaSubmitResult = [CaptchaSolutionResponse, TransactionResponse, CaptchaSolutionCommitment];
+
+export interface IExtensionInterface {
+    checkExtension(): void;
+    getExtension(): InjectedExtension;
+    getAccounts(): InjectedAccountWithMeta[];
+    getAccount(): InjectedAccountWithMeta | undefined;
+    setAccount(account: string): void;
+    unsetAccount(): void;
+    getDefaultAccount(): InjectedAccountWithMeta | undefined;
+    setDefaultAccount(): void;
+  }
+
+export interface ICaptchaClientEvents {
+    onLoad?: (extension: IExtensionInterface, contractAddress: string) => void;
+    onAccountChange?: (account?: TExtensionAccount) => void;
+}
+
+export interface ICaptchaStateClientEvents {
+    onLoadCaptcha?: (captchaChallenge: GetCaptchaResponse | Error) => void;
+    onSubmit?: (result: TCaptchaSubmitResult | Error, captchaState: ICaptchaState) => void;
+    onChange?: (captchaSolution: number[][], index: number) => void;
+    onCancel?: () => void;
+    onSolved?: (result: TCaptchaSubmitResult) => void;
+}
+
+export interface CaptchaEventCallbacks extends ICaptchaClientEvents, ICaptchaStateClientEvents { }
+
+export interface ICaptchaContextState {
+    config: ProsopoCaptchaConfig;
+    contractAddress?: string;
+    account?: InjectedAccountWithMeta;
+}
+
+export interface ICaptchaContextReducer {
+    state: ICaptchaContextState;
+    update: (value: Partial<ICaptchaContextState>) => void;
+}
+
+export interface ICaptchaState {
+    captchaChallenge?: GetCaptchaResponse;
+    captchaIndex: number;
+    captchaSolution: number[][];
+    // captchaSolutions: CaptchaSolution[];
+}
+
+export interface ICaptchaStateReducer {
+    state: ICaptchaState;
+    update: (value: Partial<ICaptchaState>) => void;
+}
+
+export interface ICaptchaStatusState {
+    info?: string;
+    error?: string;
+}
+
+export interface ICaptchaStatusReducerAction {
+    info?: [string, any] | string;
+    error?: [string, any] | string | Error;
+}
+
+export interface ICaptchaStatusReducer {
+    state: ICaptchaStatusState;
+    update: (value: Partial<ICaptchaStatusReducerAction>) => void;
+}

package/src/types/contract.ts

@@ -0,0 +1,21 @@
+// Copyright (C) 2021-2022 Prosopo (UK) Ltd.
+// This file is part of procaptcha <https://github.com/prosopo-io/procaptcha>.
+//
+// procaptcha is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// procaptcha is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with procaptcha.  If not, see <http://www.gnu.org/licenses/>.
+// import { SubmittableResult } from "@polkadot/api";
+import type { SubmittableResultValue } from '@polkadot/api/types';
+
+export type TransactionResponse = SubmittableResultValue & { 
+    blockHash?: string,
+};

package/src/types/index.ts

@@ -0,0 +1,18 @@
+// Copyright (C) 2021-2022 Prosopo (UK) Ltd.
+// This file is part of procaptcha <https://github.com/prosopo-io/procaptcha>.
+//
+// procaptcha is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// procaptcha is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with procaptcha.  If not, see <http://www.gnu.org/licenses/>.
+export * from './api';
+export * from './contract';
+export * from './client';

package/tests/mocks/browser.ts

@@ -0,0 +1,25 @@
+export class LocalStorageMock {
+
+    private store: {[key: string]: string};
+
+    constructor() {
+      this.store = {};
+    }
+  
+    clear() {
+      this.store = {};
+    }
+  
+    getItem(key: string) {
+      return this.store[key] || null;
+    }
+  
+    setItem(key: string, value: any) {
+      this.store[key] = String(value);
+    }
+  
+    removeItem(key: string) {
+      delete this.store[key];
+    }
+
+}

package/tests/modules/client.test.ts

@@ -0,0 +1,56 @@
+// import { LocalStorageMock } from "../mocks/browser";
+import { ProsopoCaptchaConfig } from "../../src/types/api";
+
+import { captchaContextReducer, captchaStateReducer, captchaStatusReducer } from "../../src/modules/client";
+import { ICaptchaContextState, ICaptchaState } from "../../src/types/client";
+
+import chai from "chai";
+
+const expect = chai.expect;
+
+describe("CLIENT UNIT TESTS", () => {
+
+    // var localStorage: LocalStorageMock;
+
+    const testConfig: ProsopoCaptchaConfig = { 
+      "providerApi.baseURL": "http://localhost:3000",
+      "providerApi.prefix": "/v1/prosopo",
+      "dappAccount": "",
+    }
+
+    before(async () => {
+        // localStorage = new LocalStorageMock();
+    });
+
+    it("client context reducer", async () => {
+
+        const testState: ICaptchaContextState = {
+            config: testConfig,
+            contractAddress: "test",
+        }
+
+        testConfig.dappAccount = "dapp";
+        const contextReducer = captchaContextReducer(testState, { config: testConfig });
+
+        expect(contextReducer.config.dappAccount).to.equal(testConfig.dappAccount);
+
+    });
+
+    it("client state reducer", async () => {
+
+        const testState: ICaptchaState = {
+            captchaIndex: 0,
+            captchaSolution: [[0, 1, 2, 3]],
+        }
+
+        const captchaSolution = testState.captchaSolution;
+        captchaSolution.push([4, 5]);
+
+        const stateReducer = captchaStateReducer(testState, { captchaSolution });
+
+        expect(stateReducer.captchaSolution.length).to.equal(2);
+        expect(stateReducer.captchaSolution[1]).to.include.members([4, 5]);
+
+    });
+
+});

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "extends": "../../tsconfig.build.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist",
+    "module": "commonjs",
+    "target": "esnext",
+    "lib": [
+      "esnext",
+      "dom"
+    ]
+  },
+  "include": [
+    "./src/**/*.ts"
+  ],
+  "references": [
+    {
+      "path": "../provider"
+    },
+    {
+      "path": "../contract"
+    }
+  ]
+}