bkper 2.7.2 → 3.1.0

package/README.md

@@ -1,21 +1,21 @@
 [Bkper REST API]: https://bkper.com/docs/#rest-apis
 
-[![npm](https://img.shields.io/npm/v/bkper?color=%235889e4)](https://www.npmjs.com/package/bkper)
-
-Bkper Node.js client provides a simple and secure way to access the [Bkper REST API] on [Node.js](https://nodejs.dev/)
-
-It also provide a **command line** utility to create and update [Bkper Apps and Bots](https://bkper.com/docs/)
+A **command line** utility to create and update [Bkper Apps and Bots](https://bkper.com/docs/)
 
 ## Instalation
 
 ### Add the package:
 
 ```
-npm i -S bkper
+npm i bkper --save-dev
 ```
 or
 ```
-yarn add bkper
+yarn add bkper --dev
+```
+or
+```
+bun add bkper --dev
 ```
 
 ## Commands
@@ -34,7 +34,7 @@ yarn bkper login
 ```
 
 ### Environment Variables
-The following environment variable is necessary in order to communicate with the Bkper REST API:
+The following environment variable is necessary in order to communicate with the [Bkper REST API]:
 
 ```
 BKPER_API_KEY=XXXX
@@ -52,6 +52,130 @@ You can add a ```.env``` file at the root of your project with those variables a
 
 > WARNING: Never upload variables to the source code repository.
 
+
+### ```./bkperapp.json``` Reference
+
+```json
+{
+
+  /* App basic configuration */
+  "id": "The App agent id. It can NOT be changed after the App created.",
+  "name": "The name of the App or Bot.",
+  "logoUrl": "Set your logo url from public host. Best fit 200x200 px. Use https://",
+
+  /* Context menu configuration */
+  "menuUrl": "The menu url to open in the popup window. See reference bellow.",
+  "menuUrlDev": "The menu url to open in the popup window, when opened by the developer user.",
+  "menuText": "The context menu call to action.",
+  "menuPopupWidth": "500 //width in pixels. Default to 80% of screen width.",
+  "menuPopupHeight": "300 //height in pixels. Default to 90% of screen height.",
+
+  /* Bot events configuration */
+  "events": [
+    "TRANSACTION_POSTED",
+    "TRANSACTION_CHECKED",
+    "TRANSACTION_UNCHECKED",
+    "TRANSACTION_UPDATED",
+    "TRANSACTION_DELETED",
+    "TRANSACTION_RESTORED",
+    "ACCOUNT_CREATED",
+    "ACCOUNT_UPDATED",
+    "ACCOUNT_DELETED",
+    "GROUP_CREATED",
+    "GROUP_UPDATED",
+    "GROUP_DELETED",
+    "FILE_CREATED",
+    "BOOK_UPDATED"
+  ],
+
+  "filePatterns": [
+    "The file patterns the Bot is capable of process. It accepts wildcard. E.g.",
+    "radiusbank*.ofx",
+    "-*.qif"
+  ],
+
+
+  /* Bot configuration only when additional scopes, other than email, is needed */
+  /* If not specified, a default valid token with the email scope is sent in the http header */
+  "clientId": "The Client ID from GCP project Web Application OAuth Credential",
+  "scopes": [
+    "The Google OAuth scopes used. E.g.",
+    "https://www.googleapis.com/auth/userinfo.email",
+    "https://www.googleapis.com/auth/script.external_request"
+  ],
+
+  /* Google Apps Script bot configuration */
+  "scriptId": "The Google Apps Script ID",
+  "deploymentId": "The Google Apps Script API Deployment ID",
+
+  /* Webhook bot configuration */
+  "webhookUrl": "The production webhook url",
+  "webhookUrlDev": "The development webhook url",
+
+  /* Schema to provide autocompletion */
+  "propertiesSchema": {
+    "book": {
+      "keys": [
+        "key1",
+        "key2"
+      ],
+      "values": [
+        "value2",
+        "value2"
+      ]
+    },
+    "group": {
+      "keys": [
+        "key1",
+        "key2"
+      ],
+      "values": [
+        "value2",
+        "value2"
+      ]
+    },
+    "account": {
+      "keys": [
+        "key1",
+        "key2"
+      ],
+      "values": [
+        "value2",
+        "value2"
+      ]
+    },
+    "transaction": {
+      "keys": [
+        "key1",
+        "key2"
+      ],
+      "values": [
+        "value2",
+        "value2"
+      ]
+    }
+  }
+}
+
+```
+
+#### Accepted expressions in menuUrl property:
+  - ```${book.id}``` - the current book id
+  - ```${book.properties.xxxxx}``` - any property value from the current book
+  - ```${transactions.query}``` - the current query being executed on transactions list
+  - ```${transactions.ids}``` - the ids of selected transactions, splitted by comma
+  - ```${account.id}``` - the current account being filterd
+  - ```${account.properties.xxxxx}``` - any property value from the current account being filtered
+  - ```${group.id}``` - the current group being filterd
+  - ```${group.properties.xxxxx}``` - any property value from the current group being filtered
+
+#### Example:
+
+```json
+"menuUrl": "https://app.bkper.com/b/#transactions:bookId=${book.id}"
+```
+
+
 ## Documentation
 
 - [Developer Docs](https://bkper.com/docs)

package/package.json

@@ -1,12 +1,7 @@
 {
   "name": "bkper",
-  "version": "2.7.2",
-  "description": "Node.js client for Bkper REST API",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "files": [
-    "lib/**/*"
-  ],
+  "version": "3.1.0",
+  "description": "Node.js command line client for Bkper",
   "bin": {
     "bkper": "./lib/cli.js"
   },
@@ -15,19 +10,18 @@
   "author": "mael <mael@bkper.com>",
   "license": "Apache-2.0",
   "private": false,
+  "main": "./lib/index.js",
+  "module": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "type": "module",
   "scripts": {
-    "test": "env TS_NODE_COMPILER_OPTIONS='{\"rootDir\": \".\" }' mocha -r ts-node/register 'test/**/*.ts'",
-    "clean": "gts clean",
+    "clean": "rm -rf ./lib & rm -rf ./node_modules & wait",
+    "prebuild": "bun install",
     "build": "run-s build:*",
-    "build:clean": "bun clean",
-    "build:test": "bun run test",
+    "build:clean": "gts clean",
     "build:compile": "tsc",
-    "build:api": "api-extractor run --local",
-    "build:cleanup": "rimraf lib/**/*.map lib/*.map lib/**/*.d.ts lib/*.d.ts",
-    "build:dts": "cp dist/bkper-public.d.ts lib/index.d.ts",
-    "build:clean-dist": "rimraf dist",
+    "prewatch": "bun run build",
     "watch": "tsc -w",
-    "upgrade:api": "bun upgrade @bkper/bkper-api-types --latest",
     "patch": "yarn version --patch",
     "minor": "yarn version --minor",
     "major": "yarn version --major",
@@ -35,32 +29,19 @@
     "postversion": "git push --tags && yarn publish --new-version $npm_package_version && git push && echo \"Successfully released version $npm_package_version!\""
   },
   "dependencies": {
-    "@google-cloud/local-auth": "^1.0.0",
-    "big.js": "^6.0.3",
+    "@google-cloud/local-auth": "^3.0.1",
+    "bkper-js": "^1.1.0",
     "commander": "^6.2.1",
-    "dayjs": "^1.10.3",
     "dotenv": "^8.2.0",
-    "gaxios": "^4.3.0",
-    "google-auth-library": "^6.1.4",
-    "luxon": "^1.25.0",
-    "open": "^7.3.1"
+    "google-auth-library": "^9.14.0"
   },
   "devDependencies": {
     "@bkper/bkper-api-types": "^5.9.0",
-    "@microsoft/api-extractor": "^7.12.1",
-    "@types/big.js": "^6.0.2",
-    "@types/chai": "^4.2.14",
     "@types/commander": "^2.12.2",
-    "@types/luxon": "^1.25.1",
-    "@types/mocha": "^8.2.0",
-    "@types/node": "^14.14.20",
-    "@types/node-fetch": "^2.5.8",
-    "chai": "^4.2.0",
+    "@types/node": "^22.5.1",
     "gts": "^3.0.3",
-    "mocha": "^8.2.1",
     "npm-run-all": "^4.1.5",
     "rimraf": "^3.0.2",
-    "ts-node": "^9.1.1",
-    "typescript": "^4.1.3"
+    "typescript": "^5.5.4"
   }
 }

package/src/auth/keys.json

@@ -0,0 +1,12 @@
+{
+  "installed": {
+    "client_id": "360398463400-l3sfmb1tipagc7bfh4tf2eptu1b62g7c.apps.googleusercontent.com",
+    "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+    "token_uri": "https://oauth2.googleapis.com/token",
+    "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+    "client_secret": "iQ87o7Y9xks1T0tKC7qmhnPw",
+    "redirect_uris": [
+      "http://localhost:3000/oauth2callback"
+    ]
+  }
+}

package/src/auth/local-auth-service.ts

@@ -0,0 +1,79 @@
+import  {authenticate} from '@google-cloud/local-auth';
+import fs from 'fs';
+import { Credentials, OAuth2Client } from "google-auth-library";
+import os from 'os';
+import { createRequire } from "module";
+import { fileURLToPath } from 'url';
+import path from 'path';
+
+const require = createRequire(import.meta.url);
+const __filename = fileURLToPath(import.meta.url); // get the resolved path to the file
+const __dirname = path.dirname(__filename); // get the name of the directory
+
+const keys = require(`${__dirname}/keys.json`);
+
+let storedCredentials: Credentials;
+
+const storedCredentialsPath = `${os.homedir}/.bkper-credentials.json`;
+
+try {
+  let credentialsJson = fs.readFileSync(storedCredentialsPath, 'utf8');
+  storedCredentials = JSON.parse(credentialsJson);
+} catch (err) {
+  console.log('No local credentials found.');
+}
+
+export async function login() {
+  if (storedCredentials) {
+    console.log('Bkper already logged in.');
+  }
+  await getOAuthToken();
+}
+
+export function logout() {
+  if (fs.existsSync(storedCredentialsPath)) {
+    fs.rmSync(storedCredentialsPath);
+  }
+  console.log('Bkper logged out.');
+}
+
+export function isLoggedIn() {
+  return storedCredentials != null;
+}
+
+export async function getOAuthToken(): Promise<string> {
+
+    let localAuth: OAuth2Client
+
+    if (storedCredentials) {
+      localAuth = new OAuth2Client(
+        keys.installed.client_id,
+        keys.installed.client_secret,
+        keys.installed.redirect_uris[0]
+      );
+      localAuth.setCredentials(storedCredentials);
+    } else {
+      localAuth = await authenticate({
+        scopes: ['https://www.googleapis.com/auth/userinfo.email'],
+        keyfilePath: `${__dirname}/keys.json`,
+      });
+      storeCredentials(localAuth.credentials);
+    }
+
+    localAuth.on('tokens', (tokens) => {
+      if (tokens.refresh_token) {
+        // store the refresh_token in my database!
+        storeCredentials(tokens)
+      }
+    });
+    
+    let token = await localAuth.getAccessToken();
+
+    return token.token || '';
+    
+  }
+
+  function storeCredentials(credentials: Credentials) {
+    storedCredentials = credentials;
+    fs.writeFileSync(storedCredentialsPath, JSON.stringify(credentials, null, 4), 'utf8');
+  }

package/src/cli.ts

@@ -0,0 +1,53 @@
+#!/usr/bin/env node
+
+import { App, Bkper } from 'bkper-js';
+import program from 'commander';
+import fs from 'fs';
+import { login, logout } from './auth/local-auth-service.js';
+import { getBkperLocalConfig } from './index.js';
+
+program
+  .command('login')
+  .description('Login Bkper')
+  .action(async () => {
+    await login()
+  });
+
+program
+  .command('logout')
+  .description('Logout Bkper')
+  .action((todo) => {
+    logout()
+  });
+
+program
+  .command('app')
+  .description('Create/Update an App')
+  .option('-u, --update', 'Update the App')
+  .option('-c, --create', 'Create a new App')
+  .action(async (options) => {
+
+    try {
+       Bkper.setConfig(getBkperLocalConfig())
+       const json: bkper.App = JSON.parse(fs.readFileSync('./bkperapp.json', 'utf8'));
+       let app = new App(json)
+        .setReadme(fs.readFileSync('./README.md', 'utf8'))
+        .setClientSecret(process.env.BKPER_CLIENT_SECRET)
+        .setDeveloperEmail(process.env.BKPER_DEVELOPER_EMAIL)
+        .setUserEmails(process.env.BKPER_USER_EMAILS);
+      if (options.update) {
+        app = await app.update();
+        console.log(`Updated ${app.getId()} sucessfully.`)
+      } else if (options.create) {
+        app = await app.create();
+        console.log(`Created ${app.getId()} sucessfully.`)
+
+      }
+    } catch (err) {
+      console.log(err)
+    }
+
+  });
+
+
+program.parse(process.argv);

package/src/index.ts

@@ -0,0 +1,11 @@
+import { Config } from 'bkper-js';
+import { getOAuthToken } from './auth/local-auth-service.js';
+import dotenv from 'dotenv';
+dotenv.config()
+
+export function getBkperLocalConfig(): Config {
+  return {
+    apiKeyProvider: async () => process.env.BKPER_API_KEY || '',
+    oauthTokenProvider: () => getOAuthToken()
+  }
+}

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "extends": "./node_modules/gts/tsconfig-google.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "lib",
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "resolveJsonModule": true,
+    "typeRoots" : ["node_modules/@bkper", "node_modules/@types" ],
+    "strict": true,
+    "esModuleInterop": true,
+    "target": "es2015",
+    "declaration": true,
+    "sourceMap": true,
+    "declarationMap": true
+  },
+  "include": [
+    "src/**/*.json",
+    "src/**/*.ts",
+    "test/**/*.ts"
+  ],
+  "exclude": [
+    "./test/",
+    "./node_modules/",
+    "./lib/"
+  ]
+}

package/lib/auth/keys.json

@@ -1,12 +0,0 @@
-{
-    "installed": {
-        "client_id": "360398463400-l3sfmb1tipagc7bfh4tf2eptu1b62g7c.apps.googleusercontent.com",
-        "auth_uri": "https://accounts.google.com/o/oauth2/auth",
-        "token_uri": "https://oauth2.googleapis.com/token",
-        "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
-        "client_secret": "iQ87o7Y9xks1T0tKC7qmhnPw",
-        "redirect_uris": [
-            "http://localhost:3000/oauth2callback"
-        ]
-    }
-}

package/lib/auth/local-auth-service.js

@@ -1,80 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOAuthToken = exports.isLoggedIn = exports.logout = exports.login = void 0;
-const local_auth_1 = require("@google-cloud/local-auth");
-const fs_1 = __importDefault(require("fs"));
-const google_auth_library_1 = require("google-auth-library");
-const os_1 = __importDefault(require("os"));
-const keys = require(`${__dirname}/keys.json`);
-let storedCredentials;
-const storedCredentialsPath = `${os_1.default.homedir}/.bkper-credentials.json`;
-try {
-    let credentialsJson = fs_1.default.readFileSync(storedCredentialsPath, 'utf8');
-    storedCredentials = JSON.parse(credentialsJson);
-}
-catch (err) {
-    console.log('No local credentials found.');
-}
-function login() {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (storedCredentials) {
-            console.log('Bkper already logged in.');
-        }
-        yield getOAuthToken();
-    });
-}
-exports.login = login;
-function logout() {
-    if (fs_1.default.existsSync(storedCredentialsPath)) {
-        fs_1.default.unlinkSync(storedCredentialsPath);
-    }
-    console.log('Bkper logged out.');
-}
-exports.logout = logout;
-function isLoggedIn() {
-    return storedCredentials != null;
-}
-exports.isLoggedIn = isLoggedIn;
-function getOAuthToken() {
-    return __awaiter(this, void 0, void 0, function* () {
-        let localAuth;
-        if (storedCredentials) {
-            localAuth = new google_auth_library_1.OAuth2Client(keys.installed.client_id, keys.installed.client_secret, keys.installed.redirect_uris[0]);
-            localAuth.setCredentials(storedCredentials);
-        }
-        else {
-            localAuth = yield local_auth_1.authenticate({
-                scopes: ['https://www.googleapis.com/auth/userinfo.email'],
-                keyfilePath: `${__dirname}/keys.json`,
-            });
-            storeCredentials(localAuth.credentials);
-        }
-        localAuth.on('tokens', (tokens) => {
-            if (tokens.refresh_token) {
-                // store the refresh_token in my database!
-                console.log(tokens.refresh_token);
-                storeCredentials(tokens);
-            }
-        });
-        let token = yield localAuth.getAccessToken();
-        return token.token;
-    });
-}
-exports.getOAuthToken = getOAuthToken;
-function storeCredentials(credentials) {
-    storedCredentials = credentials;
-    fs_1.default.writeFileSync(storedCredentialsPath, JSON.stringify(credentials, null, 4), 'utf8');
-}
-//# sourceMappingURL=local-auth-service.js.map

package/lib/cli.js

@@ -1,64 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = __importDefault(require("commander"));
-const local_auth_service_1 = require("./auth/local-auth-service");
-const Bkper_1 = require("./model/Bkper");
-const utils_1 = require("./utils");
-const App_1 = require("./model/App");
-var fs = require('fs');
-require('dotenv').config();
-process.env.NODE_ENV = utils_1.NODE_ENV_DEV;
-commander_1.default
-    .command('login')
-    .description('Login Bkper')
-    .action(() => __awaiter(void 0, void 0, void 0, function* () {
-    yield local_auth_service_1.login();
-}));
-commander_1.default
-    .command('logout')
-    .description('Logout Bkper')
-    .action((todo) => {
-    local_auth_service_1.logout();
-});
-commander_1.default
-    .command('app')
-    .description('Create/Update an App')
-    .option('-u, --update', 'Update the App')
-    .option('-c, --create', 'Create a new App')
-    .action((options) => __awaiter(void 0, void 0, void 0, function* () {
-    try {
-        Bkper_1.Bkper.setConfig({ apiKeyProvider: () => __awaiter(void 0, void 0, void 0, function* () { return process.env.BKPER_API_KEY; }) });
-        let app = new App_1.App();
-        app.setJson(JSON.parse(fs.readFileSync('./bkperapp.json', 'utf8')))
-            .setReadme(fs.readFileSync('./README.md', 'utf8'))
-            .setClientSecret(process.env.BKPER_CLIENT_SECRET)
-            .setDeveloperEmail(process.env.BKPER_DEVELOPER_EMAIL)
-            .setUserEmails(process.env.BKPER_USER_EMAILS);
-        if (options.update) {
-            app = yield app.update();
-            console.log(`Updated ${app.getId()} sucessfully.`);
-        }
-        else if (options.create) {
-            app = yield app.create();
-            console.log(`Created ${app.getId()} sucessfully.`);
-        }
-    }
-    catch (err) {
-        console.log(err);
-    }
-}));
-commander_1.default.parse(process.argv);
-//# sourceMappingURL=cli.js.map