@nickchristensen/ppls 1.0.1 → 1.0.2
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.
- package/README.md +32 -32
- package/dist/base-command.d.ts +3 -0
- package/dist/base-command.js +26 -0
- package/dist/paginated-command.d.ts +1 -0
- package/dist/paginated-command.js +17 -4
- package/oclif.manifest.json +205 -205
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -108,7 +108,7 @@ EXAMPLES
|
|
|
108
108
|
$ ppls config get hostname
|
|
109
109
|
```
|
|
110
110
|
|
|
111
|
-
_See code: [src/commands/config/get.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
111
|
+
_See code: [src/commands/config/get.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/config/get.ts)_
|
|
112
112
|
|
|
113
113
|
## `ppls config init`
|
|
114
114
|
|
|
@@ -131,7 +131,7 @@ EXAMPLES
|
|
|
131
131
|
$ ppls config init
|
|
132
132
|
```
|
|
133
133
|
|
|
134
|
-
_See code: [src/commands/config/init.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
134
|
+
_See code: [src/commands/config/init.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/config/init.ts)_
|
|
135
135
|
|
|
136
136
|
## `ppls config list`
|
|
137
137
|
|
|
@@ -155,7 +155,7 @@ EXAMPLES
|
|
|
155
155
|
$ ppls config list
|
|
156
156
|
```
|
|
157
157
|
|
|
158
|
-
_See code: [src/commands/config/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
158
|
+
_See code: [src/commands/config/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/config/list.ts)_
|
|
159
159
|
|
|
160
160
|
## `ppls config remove KEY`
|
|
161
161
|
|
|
@@ -178,7 +178,7 @@ EXAMPLES
|
|
|
178
178
|
$ ppls config remove token
|
|
179
179
|
```
|
|
180
180
|
|
|
181
|
-
_See code: [src/commands/config/remove.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
181
|
+
_See code: [src/commands/config/remove.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/config/remove.ts)_
|
|
182
182
|
|
|
183
183
|
## `ppls config set KEY VALUE`
|
|
184
184
|
|
|
@@ -204,7 +204,7 @@ EXAMPLES
|
|
|
204
204
|
$ ppls config set headers '{"X-Api-Key":"token"}'
|
|
205
205
|
```
|
|
206
206
|
|
|
207
|
-
_See code: [src/commands/config/set.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
207
|
+
_See code: [src/commands/config/set.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/config/set.ts)_
|
|
208
208
|
|
|
209
209
|
## `ppls correspondents add NAME`
|
|
210
210
|
|
|
@@ -236,7 +236,7 @@ EXAMPLES
|
|
|
236
236
|
$ ppls correspondents add "Acme Corp"
|
|
237
237
|
```
|
|
238
238
|
|
|
239
|
-
_See code: [src/commands/correspondents/add.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
239
|
+
_See code: [src/commands/correspondents/add.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/correspondents/add.ts)_
|
|
240
240
|
|
|
241
241
|
## `ppls correspondents delete ID`
|
|
242
242
|
|
|
@@ -271,7 +271,7 @@ EXAMPLES
|
|
|
271
271
|
$ ppls correspondents delete 123
|
|
272
272
|
```
|
|
273
273
|
|
|
274
|
-
_See code: [src/commands/correspondents/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
274
|
+
_See code: [src/commands/correspondents/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/correspondents/delete.ts)_
|
|
275
275
|
|
|
276
276
|
## `ppls correspondents list`
|
|
277
277
|
|
|
@@ -308,7 +308,7 @@ EXAMPLES
|
|
|
308
308
|
$ ppls correspondents list
|
|
309
309
|
```
|
|
310
310
|
|
|
311
|
-
_See code: [src/commands/correspondents/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
311
|
+
_See code: [src/commands/correspondents/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/correspondents/list.ts)_
|
|
312
312
|
|
|
313
313
|
## `ppls correspondents show ID`
|
|
314
314
|
|
|
@@ -340,7 +340,7 @@ EXAMPLES
|
|
|
340
340
|
$ ppls correspondents show 123
|
|
341
341
|
```
|
|
342
342
|
|
|
343
|
-
_See code: [src/commands/correspondents/show.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
343
|
+
_See code: [src/commands/correspondents/show.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/correspondents/show.ts)_
|
|
344
344
|
|
|
345
345
|
## `ppls correspondents update ID`
|
|
346
346
|
|
|
@@ -375,7 +375,7 @@ EXAMPLES
|
|
|
375
375
|
$ ppls correspondents update 123 --name "Acme Corp"
|
|
376
376
|
```
|
|
377
377
|
|
|
378
|
-
_See code: [src/commands/correspondents/update.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
378
|
+
_See code: [src/commands/correspondents/update.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/correspondents/update.ts)_
|
|
379
379
|
|
|
380
380
|
## `ppls custom-fields add NAME`
|
|
381
381
|
|
|
@@ -413,7 +413,7 @@ EXAMPLES
|
|
|
413
413
|
$ ppls custom-fields add "Due Date" --data-type date
|
|
414
414
|
```
|
|
415
415
|
|
|
416
|
-
_See code: [src/commands/custom-fields/add.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
416
|
+
_See code: [src/commands/custom-fields/add.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/custom-fields/add.ts)_
|
|
417
417
|
|
|
418
418
|
## `ppls custom-fields delete ID`
|
|
419
419
|
|
|
@@ -448,7 +448,7 @@ EXAMPLES
|
|
|
448
448
|
$ ppls custom-fields delete 123
|
|
449
449
|
```
|
|
450
450
|
|
|
451
|
-
_See code: [src/commands/custom-fields/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
451
|
+
_See code: [src/commands/custom-fields/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/custom-fields/delete.ts)_
|
|
452
452
|
|
|
453
453
|
## `ppls custom-fields list`
|
|
454
454
|
|
|
@@ -485,7 +485,7 @@ EXAMPLES
|
|
|
485
485
|
$ ppls custom-fields list
|
|
486
486
|
```
|
|
487
487
|
|
|
488
|
-
_See code: [src/commands/custom-fields/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
488
|
+
_See code: [src/commands/custom-fields/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/custom-fields/list.ts)_
|
|
489
489
|
|
|
490
490
|
## `ppls custom-fields show ID`
|
|
491
491
|
|
|
@@ -517,7 +517,7 @@ EXAMPLES
|
|
|
517
517
|
$ ppls custom-fields show 123
|
|
518
518
|
```
|
|
519
519
|
|
|
520
|
-
_See code: [src/commands/custom-fields/show.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
520
|
+
_See code: [src/commands/custom-fields/show.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/custom-fields/show.ts)_
|
|
521
521
|
|
|
522
522
|
## `ppls custom-fields update ID`
|
|
523
523
|
|
|
@@ -556,7 +556,7 @@ EXAMPLES
|
|
|
556
556
|
$ ppls custom-fields update 123 --name "Due Date"
|
|
557
557
|
```
|
|
558
558
|
|
|
559
|
-
_See code: [src/commands/custom-fields/update.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
559
|
+
_See code: [src/commands/custom-fields/update.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/custom-fields/update.ts)_
|
|
560
560
|
|
|
561
561
|
## `ppls document-types add NAME`
|
|
562
562
|
|
|
@@ -588,7 +588,7 @@ EXAMPLES
|
|
|
588
588
|
$ ppls document-types add "Invoice"
|
|
589
589
|
```
|
|
590
590
|
|
|
591
|
-
_See code: [src/commands/document-types/add.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
591
|
+
_See code: [src/commands/document-types/add.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/document-types/add.ts)_
|
|
592
592
|
|
|
593
593
|
## `ppls document-types delete ID`
|
|
594
594
|
|
|
@@ -623,7 +623,7 @@ EXAMPLES
|
|
|
623
623
|
$ ppls document-types delete 123
|
|
624
624
|
```
|
|
625
625
|
|
|
626
|
-
_See code: [src/commands/document-types/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
626
|
+
_See code: [src/commands/document-types/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/document-types/delete.ts)_
|
|
627
627
|
|
|
628
628
|
## `ppls document-types list`
|
|
629
629
|
|
|
@@ -660,7 +660,7 @@ EXAMPLES
|
|
|
660
660
|
$ ppls document-types list
|
|
661
661
|
```
|
|
662
662
|
|
|
663
|
-
_See code: [src/commands/document-types/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
663
|
+
_See code: [src/commands/document-types/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/document-types/list.ts)_
|
|
664
664
|
|
|
665
665
|
## `ppls document-types show ID`
|
|
666
666
|
|
|
@@ -692,7 +692,7 @@ EXAMPLES
|
|
|
692
692
|
$ ppls document-types show 123
|
|
693
693
|
```
|
|
694
694
|
|
|
695
|
-
_See code: [src/commands/document-types/show.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
695
|
+
_See code: [src/commands/document-types/show.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/document-types/show.ts)_
|
|
696
696
|
|
|
697
697
|
## `ppls document-types update ID`
|
|
698
698
|
|
|
@@ -727,7 +727,7 @@ EXAMPLES
|
|
|
727
727
|
$ ppls document-types update 123 --name "Invoice"
|
|
728
728
|
```
|
|
729
729
|
|
|
730
|
-
_See code: [src/commands/document-types/update.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
730
|
+
_See code: [src/commands/document-types/update.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/document-types/update.ts)_
|
|
731
731
|
|
|
732
732
|
## `ppls documents add [PATH]`
|
|
733
733
|
|
|
@@ -769,7 +769,7 @@ EXAMPLES
|
|
|
769
769
|
$ ppls documents add ./receipt.pdf --title "Receipt"
|
|
770
770
|
```
|
|
771
771
|
|
|
772
|
-
_See code: [src/commands/documents/add.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
772
|
+
_See code: [src/commands/documents/add.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/documents/add.ts)_
|
|
773
773
|
|
|
774
774
|
## `ppls documents delete ID`
|
|
775
775
|
|
|
@@ -804,7 +804,7 @@ EXAMPLES
|
|
|
804
804
|
$ ppls documents delete 123
|
|
805
805
|
```
|
|
806
806
|
|
|
807
|
-
_See code: [src/commands/documents/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
807
|
+
_See code: [src/commands/documents/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/documents/delete.ts)_
|
|
808
808
|
|
|
809
809
|
## `ppls documents download ID`
|
|
810
810
|
|
|
@@ -843,7 +843,7 @@ EXAMPLES
|
|
|
843
843
|
$ ppls documents download 123,124 --output-dir ./downloads
|
|
844
844
|
```
|
|
845
845
|
|
|
846
|
-
_See code: [src/commands/documents/download.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
846
|
+
_See code: [src/commands/documents/download.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/documents/download.ts)_
|
|
847
847
|
|
|
848
848
|
## `ppls documents list`
|
|
849
849
|
|
|
@@ -880,7 +880,7 @@ EXAMPLES
|
|
|
880
880
|
$ ppls documents list
|
|
881
881
|
```
|
|
882
882
|
|
|
883
|
-
_See code: [src/commands/documents/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
883
|
+
_See code: [src/commands/documents/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/documents/list.ts)_
|
|
884
884
|
|
|
885
885
|
## `ppls documents show ID`
|
|
886
886
|
|
|
@@ -912,7 +912,7 @@ EXAMPLES
|
|
|
912
912
|
$ ppls documents show 123
|
|
913
913
|
```
|
|
914
914
|
|
|
915
|
-
_See code: [src/commands/documents/show.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
915
|
+
_See code: [src/commands/documents/show.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/documents/show.ts)_
|
|
916
916
|
|
|
917
917
|
## `ppls documents update ID`
|
|
918
918
|
|
|
@@ -955,7 +955,7 @@ EXAMPLES
|
|
|
955
955
|
$ ppls documents update 123 --title "Receipt"
|
|
956
956
|
```
|
|
957
957
|
|
|
958
|
-
_See code: [src/commands/documents/update.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
958
|
+
_See code: [src/commands/documents/update.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/documents/update.ts)_
|
|
959
959
|
|
|
960
960
|
## `ppls help [COMMAND]`
|
|
961
961
|
|
|
@@ -1007,7 +1007,7 @@ EXAMPLES
|
|
|
1007
1007
|
$ ppls profile
|
|
1008
1008
|
```
|
|
1009
1009
|
|
|
1010
|
-
_See code: [src/commands/profile.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
1010
|
+
_See code: [src/commands/profile.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/profile.ts)_
|
|
1011
1011
|
|
|
1012
1012
|
## `ppls tags add NAME`
|
|
1013
1013
|
|
|
@@ -1044,7 +1044,7 @@ EXAMPLES
|
|
|
1044
1044
|
$ ppls tags add Inbox
|
|
1045
1045
|
```
|
|
1046
1046
|
|
|
1047
|
-
_See code: [src/commands/tags/add.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
1047
|
+
_See code: [src/commands/tags/add.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/tags/add.ts)_
|
|
1048
1048
|
|
|
1049
1049
|
## `ppls tags delete ID`
|
|
1050
1050
|
|
|
@@ -1079,7 +1079,7 @@ EXAMPLES
|
|
|
1079
1079
|
$ ppls tags delete 123
|
|
1080
1080
|
```
|
|
1081
1081
|
|
|
1082
|
-
_See code: [src/commands/tags/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
1082
|
+
_See code: [src/commands/tags/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/tags/delete.ts)_
|
|
1083
1083
|
|
|
1084
1084
|
## `ppls tags list`
|
|
1085
1085
|
|
|
@@ -1116,7 +1116,7 @@ EXAMPLES
|
|
|
1116
1116
|
$ ppls tags list
|
|
1117
1117
|
```
|
|
1118
1118
|
|
|
1119
|
-
_See code: [src/commands/tags/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
1119
|
+
_See code: [src/commands/tags/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/tags/list.ts)_
|
|
1120
1120
|
|
|
1121
1121
|
## `ppls tags show ID`
|
|
1122
1122
|
|
|
@@ -1148,7 +1148,7 @@ EXAMPLES
|
|
|
1148
1148
|
$ ppls tags show 123
|
|
1149
1149
|
```
|
|
1150
1150
|
|
|
1151
|
-
_See code: [src/commands/tags/show.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
1151
|
+
_See code: [src/commands/tags/show.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/tags/show.ts)_
|
|
1152
1152
|
|
|
1153
1153
|
## `ppls tags update ID`
|
|
1154
1154
|
|
|
@@ -1186,5 +1186,5 @@ EXAMPLES
|
|
|
1186
1186
|
$ ppls tags update 123 --name Inbox
|
|
1187
1187
|
```
|
|
1188
1188
|
|
|
1189
|
-
_See code: [src/commands/tags/update.ts](https://github.com/nickchristensen/ppls/blob/v1.0.
|
|
1189
|
+
_See code: [src/commands/tags/update.ts](https://github.com/nickchristensen/ppls/blob/v1.0.2/src/commands/tags/update.ts)_
|
|
1190
1190
|
<!-- commandsstop -->
|
package/dist/base-command.d.ts
CHANGED
|
@@ -40,6 +40,7 @@ export declare abstract class BaseCommand extends Command {
|
|
|
40
40
|
protected fetchJson<T>(url: URL, tokenValue: string, headers?: Record<string, string>): Promise<T>;
|
|
41
41
|
protected formatErrorMessage(response: Response): Promise<string>;
|
|
42
42
|
protected loadUserConfig(): Promise<UserConfig>;
|
|
43
|
+
protected logRequestHeaders(label: string, headers: Record<string, string>): void;
|
|
43
44
|
protected logTable(headers: TableColumn[], rows: TableRow[], options?: TableOptions): void;
|
|
44
45
|
protected parseHeaderEntries(entries: string[], source: string): Record<string, string>;
|
|
45
46
|
protected parseHeadersConfig(input: unknown, source: string): Record<string, string>;
|
|
@@ -47,6 +48,7 @@ export declare abstract class BaseCommand extends Command {
|
|
|
47
48
|
protected patchApiJson<T>(flags: ApiFlags, path: string, body: unknown): Promise<T>;
|
|
48
49
|
protected postApiFormData<T>(flags: ApiFlags, path: string, body: FormData): Promise<T>;
|
|
49
50
|
protected postApiJson<T>(flags: ApiFlags, path: string, body: unknown): Promise<T>;
|
|
51
|
+
protected redactHeaderValue(key: string, value: string): string;
|
|
50
52
|
protected requestJson<T>(options: {
|
|
51
53
|
body?: unknown;
|
|
52
54
|
headers: Record<string, string>;
|
|
@@ -57,6 +59,7 @@ export declare abstract class BaseCommand extends Command {
|
|
|
57
59
|
protected resolveDateFormat(flags: Record<string, unknown>, metadata: CommandMetadata | undefined, userConfig: UserConfig): string;
|
|
58
60
|
protected resolveGlobalFlags(flags: Record<string, unknown>, metadata?: CommandMetadata): Promise<ResolvedGlobalFlags>;
|
|
59
61
|
protected resolveHeaders(flags: Record<string, unknown>, userConfig: UserConfig): Record<string, string>;
|
|
62
|
+
protected shouldLogHeaders(): boolean;
|
|
60
63
|
protected shouldShowSpinner(): boolean;
|
|
61
64
|
protected startSpinner(text: string): null | ReturnType<typeof yoctoSpinner>;
|
|
62
65
|
}
|
package/dist/base-command.js
CHANGED
|
@@ -64,6 +64,7 @@ export class BaseCommand extends Command {
|
|
|
64
64
|
Authorization: `Token ${flags.token}`,
|
|
65
65
|
...flags.headers,
|
|
66
66
|
};
|
|
67
|
+
this.logRequestHeaders(`DELETE ${url.toString()}`, requestHeaders);
|
|
67
68
|
const response = await fetch(url, {
|
|
68
69
|
headers: requestHeaders,
|
|
69
70
|
method: 'DELETE',
|
|
@@ -88,6 +89,7 @@ export class BaseCommand extends Command {
|
|
|
88
89
|
Authorization: `Token ${flags.token}`,
|
|
89
90
|
...flags.headers,
|
|
90
91
|
};
|
|
92
|
+
this.logRequestHeaders(`GET ${url.toString()}`, requestHeaders);
|
|
91
93
|
const response = await fetch(url, {
|
|
92
94
|
headers: requestHeaders,
|
|
93
95
|
});
|
|
@@ -144,6 +146,13 @@ export class BaseCommand extends Command {
|
|
|
144
146
|
})();
|
|
145
147
|
return this.userConfigPromise;
|
|
146
148
|
}
|
|
149
|
+
logRequestHeaders(label, headers) {
|
|
150
|
+
if (!this.shouldLogHeaders()) {
|
|
151
|
+
return;
|
|
152
|
+
}
|
|
153
|
+
const maskedHeaders = Object.fromEntries(Object.entries(headers).map(([key, value]) => [key, this.redactHeaderValue(key, value)]));
|
|
154
|
+
this.logToStderr(`${label} headers: ${JSON.stringify(maskedHeaders)}`);
|
|
155
|
+
}
|
|
147
156
|
logTable(headers, rows, options) {
|
|
148
157
|
this.log(renderTable(headers, rows, options));
|
|
149
158
|
}
|
|
@@ -221,6 +230,7 @@ export class BaseCommand extends Command {
|
|
|
221
230
|
Authorization: `Token ${flags.token}`,
|
|
222
231
|
...flags.headers,
|
|
223
232
|
};
|
|
233
|
+
this.logRequestHeaders(`POST ${url.toString()}`, requestHeaders);
|
|
224
234
|
const response = await fetch(url, {
|
|
225
235
|
body,
|
|
226
236
|
headers: requestHeaders,
|
|
@@ -245,6 +255,17 @@ export class BaseCommand extends Command {
|
|
|
245
255
|
url,
|
|
246
256
|
});
|
|
247
257
|
}
|
|
258
|
+
redactHeaderValue(key, value) {
|
|
259
|
+
const normalized = key.toLowerCase();
|
|
260
|
+
if (normalized === 'authorization') {
|
|
261
|
+
const [scheme] = value.split(' ');
|
|
262
|
+
return scheme ? `${scheme} [REDACTED]` : '[REDACTED]';
|
|
263
|
+
}
|
|
264
|
+
if (normalized.includes('token') || normalized.includes('secret') || normalized.includes('api-key')) {
|
|
265
|
+
return '[REDACTED]';
|
|
266
|
+
}
|
|
267
|
+
return value;
|
|
268
|
+
}
|
|
248
269
|
async requestJson(options) {
|
|
249
270
|
const { body, headers, method, token, url } = options;
|
|
250
271
|
const requestHeaders = {
|
|
@@ -253,6 +274,7 @@ export class BaseCommand extends Command {
|
|
|
253
274
|
...(body === undefined ? {} : { 'Content-Type': 'application/json' }),
|
|
254
275
|
...headers,
|
|
255
276
|
};
|
|
277
|
+
this.logRequestHeaders(`${method} ${url.toString()}`, requestHeaders);
|
|
256
278
|
const response = await fetch(url, {
|
|
257
279
|
body: body === undefined ? undefined : JSON.stringify(body),
|
|
258
280
|
headers: requestHeaders,
|
|
@@ -297,6 +319,10 @@ export class BaseCommand extends Command {
|
|
|
297
319
|
...flagHeaders,
|
|
298
320
|
};
|
|
299
321
|
}
|
|
322
|
+
shouldLogHeaders() {
|
|
323
|
+
const value = process.env.PPLS_DEBUG_HEADERS?.toLowerCase();
|
|
324
|
+
return value === '1' || value === 'true' || value === 'yes';
|
|
325
|
+
}
|
|
300
326
|
shouldShowSpinner() {
|
|
301
327
|
return Boolean(process.stderr.isTTY);
|
|
302
328
|
}
|
|
@@ -44,5 +44,6 @@ export declare abstract class PaginatedCommand extends BaseCommand {
|
|
|
44
44
|
url: URL;
|
|
45
45
|
}): Promise<T[]>;
|
|
46
46
|
protected paginate<T>(url: URL, tokenValue: string, headers: Record<string, string>, autoPaginate: boolean): AsyncGenerator<T>;
|
|
47
|
+
protected normalizeNextUrl(nextUrl: URL, currentUrl: URL): URL;
|
|
47
48
|
}
|
|
48
49
|
export {};
|
|
@@ -37,14 +37,16 @@ export class PaginatedCommand extends BaseCommand {
|
|
|
37
37
|
try {
|
|
38
38
|
let nextUrl = url;
|
|
39
39
|
while (nextUrl) {
|
|
40
|
+
const currentUrl = nextUrl;
|
|
40
41
|
// eslint-disable-next-line no-await-in-loop -- pagination is sequential and depends on the next page URL.
|
|
41
|
-
const payload = await this.fetchJson(
|
|
42
|
+
const payload = await this.fetchJson(currentUrl, token, headers);
|
|
42
43
|
results.push(...(payload.results ?? []));
|
|
43
44
|
if (!autoPaginate || !payload.next) {
|
|
44
45
|
break;
|
|
45
46
|
}
|
|
46
47
|
try {
|
|
47
|
-
|
|
48
|
+
const parsedNext = new URL(payload.next, currentUrl);
|
|
49
|
+
nextUrl = this.normalizeNextUrl(parsedNext, currentUrl);
|
|
48
50
|
}
|
|
49
51
|
catch {
|
|
50
52
|
this.error('API returned an invalid next URL for pagination.');
|
|
@@ -69,8 +71,9 @@ export class PaginatedCommand extends BaseCommand {
|
|
|
69
71
|
async *paginate(url, tokenValue, headers, autoPaginate) {
|
|
70
72
|
let nextUrl = url;
|
|
71
73
|
while (nextUrl) {
|
|
74
|
+
const currentUrl = nextUrl;
|
|
72
75
|
// eslint-disable-next-line no-await-in-loop -- pagination is sequential and depends on the next page URL.
|
|
73
|
-
const payload = await this.fetchJson(
|
|
76
|
+
const payload = await this.fetchJson(currentUrl, tokenValue, headers);
|
|
74
77
|
const results = payload.results ?? [];
|
|
75
78
|
for (const result of results) {
|
|
76
79
|
yield result;
|
|
@@ -79,11 +82,21 @@ export class PaginatedCommand extends BaseCommand {
|
|
|
79
82
|
break;
|
|
80
83
|
}
|
|
81
84
|
try {
|
|
82
|
-
|
|
85
|
+
const parsedNext = new URL(payload.next, currentUrl);
|
|
86
|
+
nextUrl = this.normalizeNextUrl(parsedNext, currentUrl);
|
|
83
87
|
}
|
|
84
88
|
catch {
|
|
85
89
|
this.error('API returned an invalid next URL for pagination.');
|
|
86
90
|
}
|
|
87
91
|
}
|
|
88
92
|
}
|
|
93
|
+
normalizeNextUrl(nextUrl, currentUrl) {
|
|
94
|
+
if (currentUrl.protocol === 'https:' && nextUrl.protocol === 'http:' && nextUrl.hostname === currentUrl.hostname) {
|
|
95
|
+
nextUrl.protocol = currentUrl.protocol;
|
|
96
|
+
if (currentUrl.port) {
|
|
97
|
+
nextUrl.port = currentUrl.port;
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
return nextUrl;
|
|
101
|
+
}
|
|
89
102
|
}
|
package/oclif.manifest.json
CHANGED
|
@@ -1455,17 +1455,18 @@
|
|
|
1455
1455
|
"update.js"
|
|
1456
1456
|
]
|
|
1457
1457
|
},
|
|
1458
|
-
"
|
|
1458
|
+
"document-types:add": {
|
|
1459
1459
|
"aliases": [],
|
|
1460
1460
|
"args": {
|
|
1461
|
-
"
|
|
1462
|
-
"description": "Document
|
|
1463
|
-
"name": "
|
|
1461
|
+
"name": {
|
|
1462
|
+
"description": "Document type name",
|
|
1463
|
+
"name": "name",
|
|
1464
|
+
"required": true
|
|
1464
1465
|
}
|
|
1465
1466
|
},
|
|
1466
|
-
"description": "
|
|
1467
|
+
"description": "Create a document type",
|
|
1467
1468
|
"examples": [
|
|
1468
|
-
"<%= config.bin %> <%= command.id %>
|
|
1469
|
+
"<%= config.bin %> <%= command.id %> \"Invoice\""
|
|
1469
1470
|
],
|
|
1470
1471
|
"flags": {
|
|
1471
1472
|
"json": {
|
|
@@ -1533,83 +1534,33 @@
|
|
|
1533
1534
|
"hasDynamicHelp": false,
|
|
1534
1535
|
"multiple": false,
|
|
1535
1536
|
"type": "option"
|
|
1536
|
-
},
|
|
1537
|
-
"archive-serial-number": {
|
|
1538
|
-
"description": "Archive serial number",
|
|
1539
|
-
"name": "archive-serial-number",
|
|
1540
|
-
"hasDynamicHelp": false,
|
|
1541
|
-
"multiple": false,
|
|
1542
|
-
"type": "option"
|
|
1543
|
-
},
|
|
1544
|
-
"correspondent": {
|
|
1545
|
-
"description": "Correspondent id",
|
|
1546
|
-
"name": "correspondent",
|
|
1547
|
-
"hasDynamicHelp": false,
|
|
1548
|
-
"multiple": false,
|
|
1549
|
-
"type": "option"
|
|
1550
|
-
},
|
|
1551
|
-
"created": {
|
|
1552
|
-
"description": "Document created date-time",
|
|
1553
|
-
"name": "created",
|
|
1554
|
-
"hasDynamicHelp": false,
|
|
1555
|
-
"multiple": false,
|
|
1556
|
-
"type": "option"
|
|
1557
|
-
},
|
|
1558
|
-
"document-type": {
|
|
1559
|
-
"description": "Document type id",
|
|
1560
|
-
"name": "document-type",
|
|
1561
|
-
"hasDynamicHelp": false,
|
|
1562
|
-
"multiple": false,
|
|
1563
|
-
"type": "option"
|
|
1564
|
-
},
|
|
1565
|
-
"storage-path": {
|
|
1566
|
-
"description": "Storage path id",
|
|
1567
|
-
"name": "storage-path",
|
|
1568
|
-
"hasDynamicHelp": false,
|
|
1569
|
-
"multiple": false,
|
|
1570
|
-
"type": "option"
|
|
1571
|
-
},
|
|
1572
|
-
"tag": {
|
|
1573
|
-
"description": "Tag id (repeatable)",
|
|
1574
|
-
"name": "tag",
|
|
1575
|
-
"hasDynamicHelp": false,
|
|
1576
|
-
"multiple": true,
|
|
1577
|
-
"type": "option"
|
|
1578
|
-
},
|
|
1579
|
-
"title": {
|
|
1580
|
-
"description": "Document title",
|
|
1581
|
-
"name": "title",
|
|
1582
|
-
"hasDynamicHelp": false,
|
|
1583
|
-
"multiple": false,
|
|
1584
|
-
"type": "option"
|
|
1585
1537
|
}
|
|
1586
1538
|
},
|
|
1587
1539
|
"hasDynamicHelp": false,
|
|
1588
1540
|
"hiddenAliases": [],
|
|
1589
|
-
"id": "
|
|
1541
|
+
"id": "document-types:add",
|
|
1590
1542
|
"pluginAlias": "@nickchristensen/ppls",
|
|
1591
1543
|
"pluginName": "@nickchristensen/ppls",
|
|
1592
1544
|
"pluginType": "core",
|
|
1593
|
-
"strict":
|
|
1594
|
-
"enableJsonFlag": true,
|
|
1545
|
+
"strict": true,
|
|
1595
1546
|
"isESM": true,
|
|
1596
1547
|
"relativePath": [
|
|
1597
1548
|
"dist",
|
|
1598
1549
|
"commands",
|
|
1599
|
-
"
|
|
1550
|
+
"document-types",
|
|
1600
1551
|
"add.js"
|
|
1601
1552
|
]
|
|
1602
1553
|
},
|
|
1603
|
-
"
|
|
1554
|
+
"document-types:delete": {
|
|
1604
1555
|
"aliases": [],
|
|
1605
1556
|
"args": {
|
|
1606
1557
|
"id": {
|
|
1607
|
-
"description": "Document id",
|
|
1558
|
+
"description": "Document type id",
|
|
1608
1559
|
"name": "id",
|
|
1609
1560
|
"required": true
|
|
1610
1561
|
}
|
|
1611
1562
|
},
|
|
1612
|
-
"description": "Delete a document",
|
|
1563
|
+
"description": "Delete a document type",
|
|
1613
1564
|
"examples": [
|
|
1614
1565
|
"<%= config.bin %> <%= command.id %> 123"
|
|
1615
1566
|
],
|
|
@@ -1690,7 +1641,7 @@
|
|
|
1690
1641
|
},
|
|
1691
1642
|
"hasDynamicHelp": false,
|
|
1692
1643
|
"hiddenAliases": [],
|
|
1693
|
-
"id": "
|
|
1644
|
+
"id": "document-types:delete",
|
|
1694
1645
|
"pluginAlias": "@nickchristensen/ppls",
|
|
1695
1646
|
"pluginName": "@nickchristensen/ppls",
|
|
1696
1647
|
"pluginType": "core",
|
|
@@ -1699,23 +1650,16 @@
|
|
|
1699
1650
|
"relativePath": [
|
|
1700
1651
|
"dist",
|
|
1701
1652
|
"commands",
|
|
1702
|
-
"
|
|
1653
|
+
"document-types",
|
|
1703
1654
|
"delete.js"
|
|
1704
1655
|
]
|
|
1705
1656
|
},
|
|
1706
|
-
"
|
|
1657
|
+
"document-types:list": {
|
|
1707
1658
|
"aliases": [],
|
|
1708
|
-
"args": {
|
|
1709
|
-
|
|
1710
|
-
"description": "Document id or comma-separated list of ids",
|
|
1711
|
-
"name": "id",
|
|
1712
|
-
"required": true
|
|
1713
|
-
}
|
|
1714
|
-
},
|
|
1715
|
-
"description": "Download one or more documents",
|
|
1659
|
+
"args": {},
|
|
1660
|
+
"description": "List document types",
|
|
1716
1661
|
"examples": [
|
|
1717
|
-
"<%= config.bin %> <%= command.id %>
|
|
1718
|
-
"<%= config.bin %> <%= command.id %> 123,124 --output-dir ./downloads"
|
|
1662
|
+
"<%= config.bin %> <%= command.id %>"
|
|
1719
1663
|
],
|
|
1720
1664
|
"flags": {
|
|
1721
1665
|
"json": {
|
|
@@ -1784,29 +1728,43 @@
|
|
|
1784
1728
|
"multiple": false,
|
|
1785
1729
|
"type": "option"
|
|
1786
1730
|
},
|
|
1787
|
-
"
|
|
1788
|
-
"description": "
|
|
1789
|
-
"name": "
|
|
1790
|
-
"
|
|
1791
|
-
"
|
|
1731
|
+
"page": {
|
|
1732
|
+
"description": "Page number to fetch",
|
|
1733
|
+
"name": "page",
|
|
1734
|
+
"hasDynamicHelp": false,
|
|
1735
|
+
"multiple": false,
|
|
1736
|
+
"type": "option"
|
|
1792
1737
|
},
|
|
1793
|
-
"
|
|
1794
|
-
"
|
|
1795
|
-
"
|
|
1738
|
+
"page-size": {
|
|
1739
|
+
"description": "Number of results per page",
|
|
1740
|
+
"name": "page-size",
|
|
1741
|
+
"hasDynamicHelp": false,
|
|
1742
|
+
"multiple": false,
|
|
1743
|
+
"type": "option"
|
|
1744
|
+
},
|
|
1745
|
+
"id-in": {
|
|
1746
|
+
"description": "Filter by id list (comma-separated)",
|
|
1796
1747
|
"exclusive": [
|
|
1797
|
-
"
|
|
1748
|
+
"name-contains"
|
|
1798
1749
|
],
|
|
1799
|
-
"name": "
|
|
1750
|
+
"name": "id-in",
|
|
1800
1751
|
"hasDynamicHelp": false,
|
|
1801
1752
|
"multiple": false,
|
|
1802
1753
|
"type": "option"
|
|
1803
1754
|
},
|
|
1804
|
-
"
|
|
1805
|
-
"description": "
|
|
1755
|
+
"name-contains": {
|
|
1756
|
+
"description": "Filter by name substring",
|
|
1806
1757
|
"exclusive": [
|
|
1807
|
-
"
|
|
1758
|
+
"id-in"
|
|
1808
1759
|
],
|
|
1809
|
-
"name": "
|
|
1760
|
+
"name": "name-contains",
|
|
1761
|
+
"hasDynamicHelp": false,
|
|
1762
|
+
"multiple": false,
|
|
1763
|
+
"type": "option"
|
|
1764
|
+
},
|
|
1765
|
+
"sort": {
|
|
1766
|
+
"description": "Sort results by the provided field",
|
|
1767
|
+
"name": "sort",
|
|
1810
1768
|
"hasDynamicHelp": false,
|
|
1811
1769
|
"multiple": false,
|
|
1812
1770
|
"type": "option"
|
|
@@ -1814,7 +1772,7 @@
|
|
|
1814
1772
|
},
|
|
1815
1773
|
"hasDynamicHelp": false,
|
|
1816
1774
|
"hiddenAliases": [],
|
|
1817
|
-
"id": "
|
|
1775
|
+
"id": "document-types:list",
|
|
1818
1776
|
"pluginAlias": "@nickchristensen/ppls",
|
|
1819
1777
|
"pluginName": "@nickchristensen/ppls",
|
|
1820
1778
|
"pluginType": "core",
|
|
@@ -1824,16 +1782,22 @@
|
|
|
1824
1782
|
"relativePath": [
|
|
1825
1783
|
"dist",
|
|
1826
1784
|
"commands",
|
|
1827
|
-
"
|
|
1828
|
-
"
|
|
1785
|
+
"document-types",
|
|
1786
|
+
"list.js"
|
|
1829
1787
|
]
|
|
1830
1788
|
},
|
|
1831
|
-
"
|
|
1789
|
+
"document-types:show": {
|
|
1832
1790
|
"aliases": [],
|
|
1833
|
-
"args": {
|
|
1834
|
-
|
|
1791
|
+
"args": {
|
|
1792
|
+
"id": {
|
|
1793
|
+
"description": "Document type id",
|
|
1794
|
+
"name": "id",
|
|
1795
|
+
"required": true
|
|
1796
|
+
}
|
|
1797
|
+
},
|
|
1798
|
+
"description": "Show document type details",
|
|
1835
1799
|
"examples": [
|
|
1836
|
-
"<%= config.bin %> <%= command.id %>"
|
|
1800
|
+
"<%= config.bin %> <%= command.id %> 123"
|
|
1837
1801
|
],
|
|
1838
1802
|
"flags": {
|
|
1839
1803
|
"json": {
|
|
@@ -1901,77 +1865,35 @@
|
|
|
1901
1865
|
"hasDynamicHelp": false,
|
|
1902
1866
|
"multiple": false,
|
|
1903
1867
|
"type": "option"
|
|
1904
|
-
},
|
|
1905
|
-
"page": {
|
|
1906
|
-
"description": "Page number to fetch",
|
|
1907
|
-
"name": "page",
|
|
1908
|
-
"hasDynamicHelp": false,
|
|
1909
|
-
"multiple": false,
|
|
1910
|
-
"type": "option"
|
|
1911
|
-
},
|
|
1912
|
-
"page-size": {
|
|
1913
|
-
"description": "Number of results per page",
|
|
1914
|
-
"name": "page-size",
|
|
1915
|
-
"hasDynamicHelp": false,
|
|
1916
|
-
"multiple": false,
|
|
1917
|
-
"type": "option"
|
|
1918
|
-
},
|
|
1919
|
-
"id-in": {
|
|
1920
|
-
"description": "Filter by id list (comma-separated)",
|
|
1921
|
-
"exclusive": [
|
|
1922
|
-
"name-contains"
|
|
1923
|
-
],
|
|
1924
|
-
"name": "id-in",
|
|
1925
|
-
"hasDynamicHelp": false,
|
|
1926
|
-
"multiple": false,
|
|
1927
|
-
"type": "option"
|
|
1928
|
-
},
|
|
1929
|
-
"name-contains": {
|
|
1930
|
-
"description": "Filter by name substring",
|
|
1931
|
-
"exclusive": [
|
|
1932
|
-
"id-in"
|
|
1933
|
-
],
|
|
1934
|
-
"name": "name-contains",
|
|
1935
|
-
"hasDynamicHelp": false,
|
|
1936
|
-
"multiple": false,
|
|
1937
|
-
"type": "option"
|
|
1938
|
-
},
|
|
1939
|
-
"sort": {
|
|
1940
|
-
"description": "Sort results by the provided field",
|
|
1941
|
-
"name": "sort",
|
|
1942
|
-
"hasDynamicHelp": false,
|
|
1943
|
-
"multiple": false,
|
|
1944
|
-
"type": "option"
|
|
1945
1868
|
}
|
|
1946
1869
|
},
|
|
1947
1870
|
"hasDynamicHelp": false,
|
|
1948
1871
|
"hiddenAliases": [],
|
|
1949
|
-
"id": "
|
|
1872
|
+
"id": "document-types:show",
|
|
1950
1873
|
"pluginAlias": "@nickchristensen/ppls",
|
|
1951
1874
|
"pluginName": "@nickchristensen/ppls",
|
|
1952
1875
|
"pluginType": "core",
|
|
1953
1876
|
"strict": true,
|
|
1954
|
-
"enableJsonFlag": true,
|
|
1955
1877
|
"isESM": true,
|
|
1956
1878
|
"relativePath": [
|
|
1957
1879
|
"dist",
|
|
1958
1880
|
"commands",
|
|
1959
|
-
"
|
|
1960
|
-
"
|
|
1881
|
+
"document-types",
|
|
1882
|
+
"show.js"
|
|
1961
1883
|
]
|
|
1962
1884
|
},
|
|
1963
|
-
"
|
|
1885
|
+
"document-types:update": {
|
|
1964
1886
|
"aliases": [],
|
|
1965
1887
|
"args": {
|
|
1966
1888
|
"id": {
|
|
1967
|
-
"description": "Document id",
|
|
1889
|
+
"description": "Document type id",
|
|
1968
1890
|
"name": "id",
|
|
1969
1891
|
"required": true
|
|
1970
1892
|
}
|
|
1971
1893
|
},
|
|
1972
|
-
"description": "
|
|
1894
|
+
"description": "Update a document type",
|
|
1973
1895
|
"examples": [
|
|
1974
|
-
"<%= config.bin %> <%= command.id %> 123"
|
|
1896
|
+
"<%= config.bin %> <%= command.id %> 123 --name \"Invoice\""
|
|
1975
1897
|
],
|
|
1976
1898
|
"flags": {
|
|
1977
1899
|
"json": {
|
|
@@ -2039,11 +1961,18 @@
|
|
|
2039
1961
|
"hasDynamicHelp": false,
|
|
2040
1962
|
"multiple": false,
|
|
2041
1963
|
"type": "option"
|
|
1964
|
+
},
|
|
1965
|
+
"name": {
|
|
1966
|
+
"description": "Document type name",
|
|
1967
|
+
"name": "name",
|
|
1968
|
+
"hasDynamicHelp": false,
|
|
1969
|
+
"multiple": false,
|
|
1970
|
+
"type": "option"
|
|
2042
1971
|
}
|
|
2043
1972
|
},
|
|
2044
1973
|
"hasDynamicHelp": false,
|
|
2045
1974
|
"hiddenAliases": [],
|
|
2046
|
-
"id": "
|
|
1975
|
+
"id": "document-types:update",
|
|
2047
1976
|
"pluginAlias": "@nickchristensen/ppls",
|
|
2048
1977
|
"pluginName": "@nickchristensen/ppls",
|
|
2049
1978
|
"pluginType": "core",
|
|
@@ -2052,22 +1981,21 @@
|
|
|
2052
1981
|
"relativePath": [
|
|
2053
1982
|
"dist",
|
|
2054
1983
|
"commands",
|
|
2055
|
-
"
|
|
2056
|
-
"
|
|
1984
|
+
"document-types",
|
|
1985
|
+
"update.js"
|
|
2057
1986
|
]
|
|
2058
1987
|
},
|
|
2059
|
-
"documents:
|
|
1988
|
+
"documents:add": {
|
|
2060
1989
|
"aliases": [],
|
|
2061
1990
|
"args": {
|
|
2062
|
-
"
|
|
2063
|
-
"description": "Document
|
|
2064
|
-
"name": "
|
|
2065
|
-
"required": true
|
|
1991
|
+
"path": {
|
|
1992
|
+
"description": "Document file path(s)",
|
|
1993
|
+
"name": "path"
|
|
2066
1994
|
}
|
|
2067
1995
|
},
|
|
2068
|
-
"description": "
|
|
1996
|
+
"description": "Upload one or more documents. Supports multiple arguments or a glob.",
|
|
2069
1997
|
"examples": [
|
|
2070
|
-
"<%= config.bin %> <%= command.id %>
|
|
1998
|
+
"<%= config.bin %> <%= command.id %> ./receipt.pdf --title \"Receipt\""
|
|
2071
1999
|
],
|
|
2072
2000
|
"flags": {
|
|
2073
2001
|
"json": {
|
|
@@ -2143,13 +2071,6 @@
|
|
|
2143
2071
|
"multiple": false,
|
|
2144
2072
|
"type": "option"
|
|
2145
2073
|
},
|
|
2146
|
-
"content": {
|
|
2147
|
-
"description": "Document content",
|
|
2148
|
-
"name": "content",
|
|
2149
|
-
"hasDynamicHelp": false,
|
|
2150
|
-
"multiple": false,
|
|
2151
|
-
"type": "option"
|
|
2152
|
-
},
|
|
2153
2074
|
"correspondent": {
|
|
2154
2075
|
"description": "Correspondent id",
|
|
2155
2076
|
"name": "correspondent",
|
|
@@ -2158,7 +2079,7 @@
|
|
|
2158
2079
|
"type": "option"
|
|
2159
2080
|
},
|
|
2160
2081
|
"created": {
|
|
2161
|
-
"description": "Document created date",
|
|
2082
|
+
"description": "Document created date-time",
|
|
2162
2083
|
"name": "created",
|
|
2163
2084
|
"hasDynamicHelp": false,
|
|
2164
2085
|
"multiple": false,
|
|
@@ -2195,31 +2116,32 @@
|
|
|
2195
2116
|
},
|
|
2196
2117
|
"hasDynamicHelp": false,
|
|
2197
2118
|
"hiddenAliases": [],
|
|
2198
|
-
"id": "documents:
|
|
2119
|
+
"id": "documents:add",
|
|
2199
2120
|
"pluginAlias": "@nickchristensen/ppls",
|
|
2200
2121
|
"pluginName": "@nickchristensen/ppls",
|
|
2201
2122
|
"pluginType": "core",
|
|
2202
|
-
"strict":
|
|
2123
|
+
"strict": false,
|
|
2124
|
+
"enableJsonFlag": true,
|
|
2203
2125
|
"isESM": true,
|
|
2204
2126
|
"relativePath": [
|
|
2205
2127
|
"dist",
|
|
2206
2128
|
"commands",
|
|
2207
2129
|
"documents",
|
|
2208
|
-
"
|
|
2130
|
+
"add.js"
|
|
2209
2131
|
]
|
|
2210
2132
|
},
|
|
2211
|
-
"
|
|
2133
|
+
"documents:delete": {
|
|
2212
2134
|
"aliases": [],
|
|
2213
2135
|
"args": {
|
|
2214
|
-
"
|
|
2215
|
-
"description": "Document
|
|
2216
|
-
"name": "
|
|
2136
|
+
"id": {
|
|
2137
|
+
"description": "Document id",
|
|
2138
|
+
"name": "id",
|
|
2217
2139
|
"required": true
|
|
2218
2140
|
}
|
|
2219
2141
|
},
|
|
2220
|
-
"description": "
|
|
2142
|
+
"description": "Delete a document",
|
|
2221
2143
|
"examples": [
|
|
2222
|
-
"<%= config.bin %> <%= command.id %>
|
|
2144
|
+
"<%= config.bin %> <%= command.id %> 123"
|
|
2223
2145
|
],
|
|
2224
2146
|
"flags": {
|
|
2225
2147
|
"json": {
|
|
@@ -2287,11 +2209,18 @@
|
|
|
2287
2209
|
"hasDynamicHelp": false,
|
|
2288
2210
|
"multiple": false,
|
|
2289
2211
|
"type": "option"
|
|
2212
|
+
},
|
|
2213
|
+
"yes": {
|
|
2214
|
+
"char": "y",
|
|
2215
|
+
"description": "Skip confirmation prompt",
|
|
2216
|
+
"name": "yes",
|
|
2217
|
+
"allowNo": false,
|
|
2218
|
+
"type": "boolean"
|
|
2290
2219
|
}
|
|
2291
2220
|
},
|
|
2292
2221
|
"hasDynamicHelp": false,
|
|
2293
2222
|
"hiddenAliases": [],
|
|
2294
|
-
"id": "
|
|
2223
|
+
"id": "documents:delete",
|
|
2295
2224
|
"pluginAlias": "@nickchristensen/ppls",
|
|
2296
2225
|
"pluginName": "@nickchristensen/ppls",
|
|
2297
2226
|
"pluginType": "core",
|
|
@@ -2300,22 +2229,23 @@
|
|
|
2300
2229
|
"relativePath": [
|
|
2301
2230
|
"dist",
|
|
2302
2231
|
"commands",
|
|
2303
|
-
"
|
|
2304
|
-
"
|
|
2232
|
+
"documents",
|
|
2233
|
+
"delete.js"
|
|
2305
2234
|
]
|
|
2306
2235
|
},
|
|
2307
|
-
"
|
|
2236
|
+
"documents:download": {
|
|
2308
2237
|
"aliases": [],
|
|
2309
2238
|
"args": {
|
|
2310
2239
|
"id": {
|
|
2311
|
-
"description": "Document
|
|
2240
|
+
"description": "Document id or comma-separated list of ids",
|
|
2312
2241
|
"name": "id",
|
|
2313
2242
|
"required": true
|
|
2314
2243
|
}
|
|
2315
2244
|
},
|
|
2316
|
-
"description": "
|
|
2245
|
+
"description": "Download one or more documents",
|
|
2317
2246
|
"examples": [
|
|
2318
|
-
"<%= config.bin %> <%= command.id %> 123"
|
|
2247
|
+
"<%= config.bin %> <%= command.id %> 123 --output document.pdf",
|
|
2248
|
+
"<%= config.bin %> <%= command.id %> 123,124 --output-dir ./downloads"
|
|
2319
2249
|
],
|
|
2320
2250
|
"flags": {
|
|
2321
2251
|
"json": {
|
|
@@ -2384,33 +2314,54 @@
|
|
|
2384
2314
|
"multiple": false,
|
|
2385
2315
|
"type": "option"
|
|
2386
2316
|
},
|
|
2387
|
-
"
|
|
2388
|
-
"
|
|
2389
|
-
"
|
|
2390
|
-
"name": "yes",
|
|
2317
|
+
"original": {
|
|
2318
|
+
"description": "Download original file",
|
|
2319
|
+
"name": "original",
|
|
2391
2320
|
"allowNo": false,
|
|
2392
2321
|
"type": "boolean"
|
|
2322
|
+
},
|
|
2323
|
+
"output": {
|
|
2324
|
+
"char": "o",
|
|
2325
|
+
"description": "Output file path (single document)",
|
|
2326
|
+
"exclusive": [
|
|
2327
|
+
"output-dir"
|
|
2328
|
+
],
|
|
2329
|
+
"name": "output",
|
|
2330
|
+
"hasDynamicHelp": false,
|
|
2331
|
+
"multiple": false,
|
|
2332
|
+
"type": "option"
|
|
2333
|
+
},
|
|
2334
|
+
"output-dir": {
|
|
2335
|
+
"description": "Output directory (multiple documents)",
|
|
2336
|
+
"exclusive": [
|
|
2337
|
+
"output"
|
|
2338
|
+
],
|
|
2339
|
+
"name": "output-dir",
|
|
2340
|
+
"hasDynamicHelp": false,
|
|
2341
|
+
"multiple": false,
|
|
2342
|
+
"type": "option"
|
|
2393
2343
|
}
|
|
2394
2344
|
},
|
|
2395
2345
|
"hasDynamicHelp": false,
|
|
2396
2346
|
"hiddenAliases": [],
|
|
2397
|
-
"id": "
|
|
2347
|
+
"id": "documents:download",
|
|
2398
2348
|
"pluginAlias": "@nickchristensen/ppls",
|
|
2399
2349
|
"pluginName": "@nickchristensen/ppls",
|
|
2400
2350
|
"pluginType": "core",
|
|
2401
2351
|
"strict": true,
|
|
2352
|
+
"enableJsonFlag": true,
|
|
2402
2353
|
"isESM": true,
|
|
2403
2354
|
"relativePath": [
|
|
2404
2355
|
"dist",
|
|
2405
2356
|
"commands",
|
|
2406
|
-
"
|
|
2407
|
-
"
|
|
2357
|
+
"documents",
|
|
2358
|
+
"download.js"
|
|
2408
2359
|
]
|
|
2409
2360
|
},
|
|
2410
|
-
"
|
|
2361
|
+
"documents:list": {
|
|
2411
2362
|
"aliases": [],
|
|
2412
2363
|
"args": {},
|
|
2413
|
-
"description": "List
|
|
2364
|
+
"description": "List documents",
|
|
2414
2365
|
"examples": [
|
|
2415
2366
|
"<%= config.bin %> <%= command.id %>"
|
|
2416
2367
|
],
|
|
@@ -2525,7 +2476,7 @@
|
|
|
2525
2476
|
},
|
|
2526
2477
|
"hasDynamicHelp": false,
|
|
2527
2478
|
"hiddenAliases": [],
|
|
2528
|
-
"id": "
|
|
2479
|
+
"id": "documents:list",
|
|
2529
2480
|
"pluginAlias": "@nickchristensen/ppls",
|
|
2530
2481
|
"pluginName": "@nickchristensen/ppls",
|
|
2531
2482
|
"pluginType": "core",
|
|
@@ -2535,20 +2486,20 @@
|
|
|
2535
2486
|
"relativePath": [
|
|
2536
2487
|
"dist",
|
|
2537
2488
|
"commands",
|
|
2538
|
-
"
|
|
2489
|
+
"documents",
|
|
2539
2490
|
"list.js"
|
|
2540
2491
|
]
|
|
2541
2492
|
},
|
|
2542
|
-
"
|
|
2493
|
+
"documents:show": {
|
|
2543
2494
|
"aliases": [],
|
|
2544
2495
|
"args": {
|
|
2545
2496
|
"id": {
|
|
2546
|
-
"description": "Document
|
|
2497
|
+
"description": "Document id",
|
|
2547
2498
|
"name": "id",
|
|
2548
2499
|
"required": true
|
|
2549
2500
|
}
|
|
2550
2501
|
},
|
|
2551
|
-
"description": "Show document
|
|
2502
|
+
"description": "Show document details",
|
|
2552
2503
|
"examples": [
|
|
2553
2504
|
"<%= config.bin %> <%= command.id %> 123"
|
|
2554
2505
|
],
|
|
@@ -2622,7 +2573,7 @@
|
|
|
2622
2573
|
},
|
|
2623
2574
|
"hasDynamicHelp": false,
|
|
2624
2575
|
"hiddenAliases": [],
|
|
2625
|
-
"id": "
|
|
2576
|
+
"id": "documents:show",
|
|
2626
2577
|
"pluginAlias": "@nickchristensen/ppls",
|
|
2627
2578
|
"pluginName": "@nickchristensen/ppls",
|
|
2628
2579
|
"pluginType": "core",
|
|
@@ -2631,22 +2582,22 @@
|
|
|
2631
2582
|
"relativePath": [
|
|
2632
2583
|
"dist",
|
|
2633
2584
|
"commands",
|
|
2634
|
-
"
|
|
2585
|
+
"documents",
|
|
2635
2586
|
"show.js"
|
|
2636
2587
|
]
|
|
2637
2588
|
},
|
|
2638
|
-
"
|
|
2589
|
+
"documents:update": {
|
|
2639
2590
|
"aliases": [],
|
|
2640
2591
|
"args": {
|
|
2641
2592
|
"id": {
|
|
2642
|
-
"description": "Document
|
|
2593
|
+
"description": "Document id",
|
|
2643
2594
|
"name": "id",
|
|
2644
2595
|
"required": true
|
|
2645
2596
|
}
|
|
2646
2597
|
},
|
|
2647
|
-
"description": "Update a document
|
|
2598
|
+
"description": "Update a document",
|
|
2648
2599
|
"examples": [
|
|
2649
|
-
"<%= config.bin %> <%= command.id %> 123 --
|
|
2600
|
+
"<%= config.bin %> <%= command.id %> 123 --title \"Receipt\""
|
|
2650
2601
|
],
|
|
2651
2602
|
"flags": {
|
|
2652
2603
|
"json": {
|
|
@@ -2715,9 +2666,58 @@
|
|
|
2715
2666
|
"multiple": false,
|
|
2716
2667
|
"type": "option"
|
|
2717
2668
|
},
|
|
2718
|
-
"
|
|
2719
|
-
"description": "
|
|
2720
|
-
"name": "
|
|
2669
|
+
"archive-serial-number": {
|
|
2670
|
+
"description": "Archive serial number",
|
|
2671
|
+
"name": "archive-serial-number",
|
|
2672
|
+
"hasDynamicHelp": false,
|
|
2673
|
+
"multiple": false,
|
|
2674
|
+
"type": "option"
|
|
2675
|
+
},
|
|
2676
|
+
"content": {
|
|
2677
|
+
"description": "Document content",
|
|
2678
|
+
"name": "content",
|
|
2679
|
+
"hasDynamicHelp": false,
|
|
2680
|
+
"multiple": false,
|
|
2681
|
+
"type": "option"
|
|
2682
|
+
},
|
|
2683
|
+
"correspondent": {
|
|
2684
|
+
"description": "Correspondent id",
|
|
2685
|
+
"name": "correspondent",
|
|
2686
|
+
"hasDynamicHelp": false,
|
|
2687
|
+
"multiple": false,
|
|
2688
|
+
"type": "option"
|
|
2689
|
+
},
|
|
2690
|
+
"created": {
|
|
2691
|
+
"description": "Document created date",
|
|
2692
|
+
"name": "created",
|
|
2693
|
+
"hasDynamicHelp": false,
|
|
2694
|
+
"multiple": false,
|
|
2695
|
+
"type": "option"
|
|
2696
|
+
},
|
|
2697
|
+
"document-type": {
|
|
2698
|
+
"description": "Document type id",
|
|
2699
|
+
"name": "document-type",
|
|
2700
|
+
"hasDynamicHelp": false,
|
|
2701
|
+
"multiple": false,
|
|
2702
|
+
"type": "option"
|
|
2703
|
+
},
|
|
2704
|
+
"storage-path": {
|
|
2705
|
+
"description": "Storage path id",
|
|
2706
|
+
"name": "storage-path",
|
|
2707
|
+
"hasDynamicHelp": false,
|
|
2708
|
+
"multiple": false,
|
|
2709
|
+
"type": "option"
|
|
2710
|
+
},
|
|
2711
|
+
"tag": {
|
|
2712
|
+
"description": "Tag id (repeatable)",
|
|
2713
|
+
"name": "tag",
|
|
2714
|
+
"hasDynamicHelp": false,
|
|
2715
|
+
"multiple": true,
|
|
2716
|
+
"type": "option"
|
|
2717
|
+
},
|
|
2718
|
+
"title": {
|
|
2719
|
+
"description": "Document title",
|
|
2720
|
+
"name": "title",
|
|
2721
2721
|
"hasDynamicHelp": false,
|
|
2722
2722
|
"multiple": false,
|
|
2723
2723
|
"type": "option"
|
|
@@ -2725,7 +2725,7 @@
|
|
|
2725
2725
|
},
|
|
2726
2726
|
"hasDynamicHelp": false,
|
|
2727
2727
|
"hiddenAliases": [],
|
|
2728
|
-
"id": "
|
|
2728
|
+
"id": "documents:update",
|
|
2729
2729
|
"pluginAlias": "@nickchristensen/ppls",
|
|
2730
2730
|
"pluginName": "@nickchristensen/ppls",
|
|
2731
2731
|
"pluginType": "core",
|
|
@@ -2734,7 +2734,7 @@
|
|
|
2734
2734
|
"relativePath": [
|
|
2735
2735
|
"dist",
|
|
2736
2736
|
"commands",
|
|
2737
|
-
"
|
|
2737
|
+
"documents",
|
|
2738
2738
|
"update.js"
|
|
2739
2739
|
]
|
|
2740
2740
|
},
|
|
@@ -3309,5 +3309,5 @@
|
|
|
3309
3309
|
]
|
|
3310
3310
|
}
|
|
3311
3311
|
},
|
|
3312
|
-
"version": "1.0.
|
|
3312
|
+
"version": "1.0.2"
|
|
3313
3313
|
}
|