@j2inn/fin5-ui-utils 2.0.6-beta.0 → 2.0.6

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 (7) hide show
  1. package/dist/fin5Top/fin5FileUpload.d.ts +14 -2
  2. package/dist/fin5Top/fin5FileUpload.js +15 -2
  3. package/dist/fin5Top/fin5FileUpload.js.map +1 -1
  4. package/dist_es/fin5Top/fin5FileUpload.d.ts +14 -2
  5. package/dist_es/fin5Top/fin5FileUpload.js +14 -1
  6. package/dist_es/fin5Top/fin5FileUpload.js.map +1 -1
  7. package/package.json +1 -1
package/dist/fin5Top/fin5FileUpload.d.ts CHANGED
@@ -1,6 +1,4 @@
1
- /// <reference types="node" />
2
1
  import { HDict } from 'haystack-core';
3
- import { URLSearchParams } from 'url';
4
2
  /**
5
3
  * Upload a File to FIN5, using the FINStack /fileUpload API. Files can then be viewed using Folio menu.
6
4
  * @param projectName The name of the project where the files will be uploaded
@@ -8,5 +6,19 @@ import { URLSearchParams } from 'url';
8
6
  * @param additionalTags Any additional tag that needs to be added to the file record. The tags should be
9
7
  * provided as URL search parameters. To add a marker tag, set the value of the param to `'true'`.
10
8
  * @returns the file record as an HDict
9
+ * @example
10
+ * <input type='file' onChange={async (e) => {
11
+ * const file = e.target.files?.[0]
12
+ * if (file) {
13
+ * const params = new URLSearchParams()
14
+ * params.set('myMarker', 'true')
15
+ * params.set('myStrTag', 'abc')
16
+ * const rec = await fin5FileUpload(
17
+ * 'myprojectname',
18
+ * file,
19
+ * params
20
+ * )
21
+ * }
22
+ * }} />
11
23
  */
12
24
  export declare const fin5FileUpload: (projectName: string, file: File, additionalTags?: URLSearchParams) => Promise<HDict>;
package/dist/fin5Top/fin5FileUpload.js CHANGED
@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.fin5FileUpload = void 0;
4
4
  const haystack_core_1 = require("haystack-core");
5
5
  const haystack_nclient_1 = require("haystack-nclient");
6
- const url_1 = require("url");
7
6
  /**
8
7
  * Upload a File to FIN5, using the FINStack /fileUpload API. Files can then be viewed using Folio menu.
9
8
  * @param projectName The name of the project where the files will be uploaded
@@ -11,8 +10,22 @@ const url_1 = require("url");
11
10
  * @param additionalTags Any additional tag that needs to be added to the file record. The tags should be
12
11
  * provided as URL search parameters. To add a marker tag, set the value of the param to `'true'`.
13
12
  * @returns the file record as an HDict
13
+ * @example
14
+ * <input type='file' onChange={async (e) => {
15
+ * const file = e.target.files?.[0]
16
+ * if (file) {
17
+ * const params = new URLSearchParams()
18
+ * params.set('myMarker', 'true')
19
+ * params.set('myStrTag', 'abc')
20
+ * const rec = await fin5FileUpload(
21
+ * 'myprojectname',
22
+ * file,
23
+ * params
24
+ * )
25
+ * }
26
+ * }} />
14
27
  */
15
- const fin5FileUpload = async (projectName, file, additionalTags = new url_1.URLSearchParams()) => {
28
+ const fin5FileUpload = async (projectName, file, additionalTags = new URLSearchParams()) => {
16
29
  if (!additionalTags.has('dis')) {
17
30
  additionalTags.set('dis', file.name);
18
31
  }
package/dist/fin5Top/fin5FileUpload.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"fin5FileUpload.js","sourceRoot":"","sources":["../../src/fin5Top/fin5FileUpload.ts"],"names":[],"mappings":";;;AAAA,iDAAwD;AACxD,uDAA+C;AAC/C,6BAAqC;AAErC;;;;;;;GAOG;AACI,MAAM,cAAc,GAAG,KAAK,EAClC,WAAmB,EACnB,IAAU,EACV,cAAc,GAAG,IAAI,qBAAe,EAAE,EACrB,EAAE;IACnB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QAC/B,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;KACpC;IAED,iFAAiF;IACjF,MAAM,GAAG,GAAG,IAAI,GAAG,CAClB,QAAQ,WAAW,0BAA0B,EAC7C,kBAAkB,CAClB,CAAA;IACD,cAAc,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,IAAY,EAAE,EAAE,CACtD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CACjC,CAAA;IAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;IACxC,MAAM,QAAQ,GAAG,MAAM,IAAA,+BAAY,EAAC,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE,EAAE;QACnE,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACR,cAAc,EAAE,0BAA0B;SAC1C;QACD,IAAI,EAAE,IAAI,UAAU,CAAC,OAAO,CAAC;KAC7B,CAAC,CAAA;IAEF,MAAM,UAAU,GAAG,IAAI,0BAAU,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;IACxD,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,EAAW,CAAA;IAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAA;IACvB,IAAI,CAAC,IAAI,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;KACvD;IACD,OAAO,IAAI,CAAA;AACZ,CAAC,CAAA;AAlCY,QAAA,cAAc,kBAkC1B"}
1
+ {"version":3,"file":"fin5FileUpload.js","sourceRoot":"","sources":["../../src/fin5Top/fin5FileUpload.ts"],"names":[],"mappings":";;;AAAA,iDAAwD;AACxD,uDAA+C;AAE/C;;;;;;;;;;;;;;;;;;;;;GAqBG;AACI,MAAM,cAAc,GAAG,KAAK,EAClC,WAAmB,EACnB,IAAU,EACV,cAAc,GAAG,IAAI,eAAe,EAAE,EACrB,EAAE;IACnB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QAC/B,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;KACpC;IAED,iFAAiF;IACjF,MAAM,GAAG,GAAG,IAAI,GAAG,CAClB,QAAQ,WAAW,0BAA0B,EAC7C,kBAAkB,CAClB,CAAA;IACD,cAAc,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,IAAY,EAAE,EAAE,CACtD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CACjC,CAAA;IAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;IACxC,MAAM,QAAQ,GAAG,MAAM,IAAA,+BAAY,EAAC,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE,EAAE;QACnE,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACR,cAAc,EAAE,0BAA0B;SAC1C;QACD,IAAI,EAAE,IAAI,UAAU,CAAC,OAAO,CAAC;KAC7B,CAAC,CAAA;IAEF,MAAM,UAAU,GAAG,IAAI,0BAAU,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;IACxD,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,EAAW,CAAA;IAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAA;IACvB,IAAI,CAAC,IAAI,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;KACvD;IACD,OAAO,IAAI,CAAA;AACZ,CAAC,CAAA;AAlCY,QAAA,cAAc,kBAkC1B"}
package/dist_es/fin5Top/fin5FileUpload.d.ts CHANGED
@@ -1,6 +1,4 @@
1
- /// <reference types="node" />
2
1
  import { HDict } from 'haystack-core';
3
- import { URLSearchParams } from 'url';
4
2
  /**
5
3
  * Upload a File to FIN5, using the FINStack /fileUpload API. Files can then be viewed using Folio menu.
6
4
  * @param projectName The name of the project where the files will be uploaded
@@ -8,5 +6,19 @@ import { URLSearchParams } from 'url';
8
6
  * @param additionalTags Any additional tag that needs to be added to the file record. The tags should be
9
7
  * provided as URL search parameters. To add a marker tag, set the value of the param to `'true'`.
10
8
  * @returns the file record as an HDict
9
+ * @example
10
+ * <input type='file' onChange={async (e) => {
11
+ * const file = e.target.files?.[0]
12
+ * if (file) {
13
+ * const params = new URLSearchParams()
14
+ * params.set('myMarker', 'true')
15
+ * params.set('myStrTag', 'abc')
16
+ * const rec = await fin5FileUpload(
17
+ * 'myprojectname',
18
+ * file,
19
+ * params
20
+ * )
21
+ * }
22
+ * }} />
11
23
  */
12
24
  export declare const fin5FileUpload: (projectName: string, file: File, additionalTags?: URLSearchParams) => Promise<HDict>;
package/dist_es/fin5Top/fin5FileUpload.js CHANGED
@@ -1,6 +1,5 @@
1
1
  import { ZincReader } from 'haystack-core';
2
2
  import { finCsrfFetch } from 'haystack-nclient';
3
- import { URLSearchParams } from 'url';
4
3
  /**
5
4
  * Upload a File to FIN5, using the FINStack /fileUpload API. Files can then be viewed using Folio menu.
6
5
  * @param projectName The name of the project where the files will be uploaded
@@ -8,6 +7,20 @@ import { URLSearchParams } from 'url';
8
7
  * @param additionalTags Any additional tag that needs to be added to the file record. The tags should be
9
8
  * provided as URL search parameters. To add a marker tag, set the value of the param to `'true'`.
10
9
  * @returns the file record as an HDict
10
+ * @example
11
+ * <input type='file' onChange={async (e) => {
12
+ * const file = e.target.files?.[0]
13
+ * if (file) {
14
+ * const params = new URLSearchParams()
15
+ * params.set('myMarker', 'true')
16
+ * params.set('myStrTag', 'abc')
17
+ * const rec = await fin5FileUpload(
18
+ * 'myprojectname',
19
+ * file,
20
+ * params
21
+ * )
22
+ * }
23
+ * }} />
11
24
  */
12
25
  export const fin5FileUpload = async (projectName, file, additionalTags = new URLSearchParams()) => {
13
26
  if (!additionalTags.has('dis')) {
package/dist_es/fin5Top/fin5FileUpload.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"fin5FileUpload.js","sourceRoot":"","sources":["../../src/fin5Top/fin5FileUpload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,UAAU,EAAE,MAAM,eAAe,CAAA;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,KAAK,CAAA;AAErC;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAClC,WAAmB,EACnB,IAAU,EACV,cAAc,GAAG,IAAI,eAAe,EAAE,EACrB,EAAE;IACnB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QAC/B,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;KACpC;IAED,iFAAiF;IACjF,MAAM,GAAG,GAAG,IAAI,GAAG,CAClB,QAAQ,WAAW,0BAA0B,EAC7C,kBAAkB,CAClB,CAAA;IACD,cAAc,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,IAAY,EAAE,EAAE,CACtD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CACjC,CAAA;IAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;IACxC,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE,EAAE;QACnE,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACR,cAAc,EAAE,0BAA0B;SAC1C;QACD,IAAI,EAAE,IAAI,UAAU,CAAC,OAAO,CAAC;KAC7B,CAAC,CAAA;IAEF,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;IACxD,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,EAAW,CAAA;IAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAA;IACvB,IAAI,CAAC,IAAI,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;KACvD;IACD,OAAO,IAAI,CAAA;AACZ,CAAC,CAAA"}
1
+ {"version":3,"file":"fin5FileUpload.js","sourceRoot":"","sources":["../../src/fin5Top/fin5FileUpload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,UAAU,EAAE,MAAM,eAAe,CAAA;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAClC,WAAmB,EACnB,IAAU,EACV,cAAc,GAAG,IAAI,eAAe,EAAE,EACrB,EAAE;IACnB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;QAC/B,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;KACpC;IAED,iFAAiF;IACjF,MAAM,GAAG,GAAG,IAAI,GAAG,CAClB,QAAQ,WAAW,0BAA0B,EAC7C,kBAAkB,CAClB,CAAA;IACD,cAAc,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,IAAY,EAAE,EAAE,CACtD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CACjC,CAAA;IAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;IACxC,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE,EAAE;QACnE,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACR,cAAc,EAAE,0BAA0B;SAC1C;QACD,IAAI,EAAE,IAAI,UAAU,CAAC,OAAO,CAAC;KAC7B,CAAC,CAAA;IAEF,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;IACxD,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,EAAW,CAAA;IAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAA;IACvB,IAAI,CAAC,IAAI,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;KACvD;IACD,OAAO,IAAI,CAAA;AACZ,CAAC,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@j2inn/fin5-ui-utils",
3
- "version": "2.0.6-beta.0",
3
+ "version": "2.0.6",
4
4
  "description": "A set of useful client-side utilities useful for creating UI applications on top of FIN 5",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",