bkper 3.3.2 → 3.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +41 -16
  2. package/package.json +6 -5
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  A **command line** utility to create and update [Bkper Apps and Bots](https://bkper.com/docs/)
4
4
 
5
- ## Instalation
5
+ ## Installation
6
6
 
7
7
  ### Add the package:
8
8
 
@@ -67,18 +67,46 @@ Follow [these](https://bkper.com/docs/#rest-api-enabling) steps in order to conf
67
67
  ### ```./bkperapp.yaml``` Reference
68
68
 
69
69
  ```yaml
70
- id: "The App agent id. It can NOT be changed after the App created."
71
- name: "The name of the App or Bot."
72
- logoUrl: "Set your logo url from public host. Best fit 200x200 px. Use https://"
73
-
74
- # Context menu configuration
75
- menuUrl: "The menu url to open in the popup window. See reference bellow."
76
- menuUrlDev: "The menu url to open in the popup window, when opened by the developer user."
77
- menuText: "The context menu call to action."
70
+
71
+ # BASIC APP CONFIGURATION
72
+
73
+ # The agent id of the App or Bot. It can NOT be changed after the App or Bot is created.
74
+ id: my-custom-app
75
+
76
+ # The readable name of the App or Bot.
77
+ name: My Custom App
78
+
79
+ # Set your logo url from public host. Best fit 200x200 px. Use https://
80
+ logoUrl: https://static.thenounproject.com/png/2318500-200.png
81
+
82
+
83
+ # CONTEXT MENU CONFIGURATION
84
+
85
+ # The menu production url to open in the popup window. See accepted expressions bellow.
86
+ menuUrl: https://script.google.com/macros/s/AKfycbxz1Fl1A_KpvAtWLSXtGh1oRaFdWibPweoJfa3yYrFRAAC6gRM/exec?bookId=${book.id}
87
+
88
+ # The menu development url that will be used while developing.
89
+ menuUrlDev: https://script.google.com/a/bkper.com/macros/s/AKfycbwg42np5A-niYBI7Qq2yxOguhcoNgEkqqe0aRLw628/dev?bookId=${book.id}
90
+
91
+ # The context menu call to action.
92
+ menuText: Open My Custom App
93
+
78
94
  menuPopupWidth: 500 # width in pixels. Default to 80% of screen width.
79
95
  menuPopupHeight: 300 # height in pixels. Default to 90% of screen height.
80
96
 
81
- # Bot events configuration
97
+
98
+ # BOT EVENTS CONFIGURATION
99
+
100
+ # The production webhook url to be called by Bkper when an event occurs.
101
+ webhookUrl: https://us-central1-bkper-tax-trigger.cloudfunctions.net/prod
102
+
103
+ # The development webhook url to be called while developing.
104
+ # It will be prioritized over webhookUrl when the bot is running by the app owner or developer.
105
+ # Unset it when done developing.
106
+ webhookUrlDev: https://9850-2804-1b2-1003-88ab-bca4-9ed8-d199-bb7f.ngrok-free.app
107
+
108
+ # The events the Bot is capable of processing by the webhook.
109
+ # This is optional and, if not specified, no events will be processed.
82
110
  events:
83
111
  - "TRANSACTION_POSTED"
84
112
  - "TRANSACTION_CHECKED"
@@ -95,17 +123,14 @@ events:
95
123
  - "FILE_CREATED"
96
124
  - "BOOK_UPDATED"
97
125
 
126
+ # The file patterns the Bot is capable of processing. It accepts wildcards. E.g.
98
127
  filePatterns:
99
- - "The file patterns the Bot is capable of process. It accepts wildcard. E.g."
100
128
  - "radiusbank*.ofx"
101
129
  - "-*.qif"
130
+ - "*.csv"
102
131
 
103
132
 
104
- # Webhook bot configuration
105
- webhookUrl: "The production webhook url"
106
- webhookUrlDev: "The development webhook url"
107
-
108
- # Schema to provide autocompletion
133
+ # Schema to provide autocompletion on properties editor.
109
134
  propertiesSchema:
110
135
  book:
111
136
  keys:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bkper",
3
- "version": "3.3.2",
3
+ "version": "3.3.3",
4
4
  "description": "Node.js command line client for Bkper",
5
5
  "bin": {
6
6
  "bkper": "./lib/cli.js"
@@ -23,8 +23,9 @@
23
23
  "build": "run-s build:*",
24
24
  "build:clean": "gts clean",
25
25
  "build:compile": "tsc",
26
- "prewatch": "bun run build",
27
- "watch": "tsc -w",
26
+ "predev": "bun run build",
27
+ "dev": "tsc -w",
28
+ "upgrade:api": "bun update @bkper/bkper-api-types --latest && bun update bkper-js --latest",
28
29
  "patch": "yarn version --patch",
29
30
  "minor": "yarn version --minor",
30
31
  "major": "yarn version --major",
@@ -33,14 +34,14 @@
33
34
  },
34
35
  "dependencies": {
35
36
  "@google-cloud/local-auth": "^3.0.1",
36
- "bkper-js": "^1.1.0",
37
+ "bkper-js": "^1.30.0",
37
38
  "commander": "^6.2.1",
38
39
  "dotenv": "^8.2.0",
39
40
  "google-auth-library": "^9.14.0",
40
41
  "yaml": "^2.5.1"
41
42
  },
42
43
  "devDependencies": {
43
- "@bkper/bkper-api-types": "^5.9.0",
44
+ "@bkper/bkper-api-types": "^5.15.1",
44
45
  "@types/commander": "^2.12.2",
45
46
  "@types/node": "^22.5.1",
46
47
  "gts": "^3.0.3",