bkper 3.0.0 → 3.1.0

package/README.md

@@ -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,6 +1,6 @@
 {
   "name": "bkper",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Node.js command line client for Bkper",
   "bin": {
     "bkper": "./lib/cli.js"
@@ -10,13 +10,17 @@
   "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": {
     "clean": "rm -rf ./lib & rm -rf ./node_modules & wait",
+    "prebuild": "bun install",
     "build": "run-s build:*",
     "build:clean": "gts clean",
     "build:compile": "tsc",
-    "build:cleanup": "rimraf lib/**/*.map lib/*.map lib/**/*.d.ts lib/*.d.ts",
-    "build:clean-dist": "rimraf dist",
+    "prewatch": "bun run build",
     "watch": "tsc -w",
     "patch": "yarn version --patch",
     "minor": "yarn version --minor",
@@ -26,7 +30,7 @@
   },
   "dependencies": {
     "@google-cloud/local-auth": "^3.0.1",
-    "bkper-js": "^1.0.0",
+    "bkper-js": "^1.1.0",
     "commander": "^6.2.1",
     "dotenv": "^8.2.0",
     "google-auth-library": "^9.14.0"

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

@@ -2,6 +2,13 @@ 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`);
 
@@ -56,14 +63,13 @@ export async function getOAuthToken(): Promise<string> {
     localAuth.on('tokens', (tokens) => {
       if (tokens.refresh_token) {
         // store the refresh_token in my database!
-        console.log(tokens.refresh_token);
         storeCredentials(tokens)
       }
     });
     
     let token = await localAuth.getAccessToken();
 
-    return token.token;
+    return token.token || '';
     
   }
 

package/src/cli.ts

@@ -1,11 +1,10 @@
 #!/usr/bin/env node
 
-import program from 'commander';
-import { getOAuthToken, login, logout } from './auth/local-auth-service';
 import { App, Bkper } from 'bkper-js';
-var fs = require('fs');
-require('dotenv').config();
-
+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')
@@ -29,10 +28,7 @@ program
   .action(async (options) => {
 
     try {
-       Bkper.setConfig({
-        apiKeyProvider: async () => process.env.BKPER_API_KEY,
-        oauthTokenProvider: () => getOAuthToken()
-      })
+       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'))

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

@@ -3,11 +3,13 @@
   "compilerOptions": {
     "rootDir": "src",
     "outDir": "lib",
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "resolveJsonModule": true,
     "typeRoots" : ["node_modules/@bkper", "node_modules/@types" ],
-    "strict": false,
+    "strict": true,
     "esModuleInterop": true,
     "target": "es2015",
-    "resolveJsonModule": true,
     "declaration": true,
     "sourceMap": true,
     "declarationMap": true