@oneblink/storage 2.1.0-beta.1 → 2.1.0-beta.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.
|
@@ -60,11 +60,9 @@ export default class OneBlinkDownloader {
|
|
|
60
60
|
* @param data The submission upload data and options
|
|
61
61
|
* @returns The submission
|
|
62
62
|
*/
|
|
63
|
-
downloadDraftSubmission({ formSubmissionDraftVersionId,
|
|
63
|
+
downloadDraftSubmission({ formSubmissionDraftVersionId, abortSignal, }: DownloadOptions & {
|
|
64
64
|
/** The identifier of the draft form submission version. */
|
|
65
65
|
formSubmissionDraftVersionId: string;
|
|
66
|
-
/** The identifier of the form associated with the draft submission. */
|
|
67
|
-
formId: number;
|
|
68
66
|
}): Promise<SubmissionTypes.S3SubmissionData | undefined>;
|
|
69
67
|
/**
|
|
70
68
|
* Download pre-fill form submission data.
|
|
@@ -66,10 +66,10 @@ class OneBlinkDownloader {
|
|
|
66
66
|
* @param data The submission upload data and options
|
|
67
67
|
* @returns The submission
|
|
68
68
|
*/
|
|
69
|
-
async downloadDraftSubmission({ formSubmissionDraftVersionId,
|
|
69
|
+
async downloadDraftSubmission({ formSubmissionDraftVersionId, abortSignal, }) {
|
|
70
70
|
return await (0, downloadJsonFromS3_1.default)({
|
|
71
71
|
...this,
|
|
72
|
-
key: `
|
|
72
|
+
key: `form-submission-draft-versions/${formSubmissionDraftVersionId}`,
|
|
73
73
|
abortSignal,
|
|
74
74
|
});
|
|
75
75
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OneBlinkDownloader.js","sourceRoot":"","sources":["../src/OneBlinkDownloader.ts"],"names":[],"mappings":";;;;;AACA,8EAAqD;AAErD;;;GAGG;AACH,MAAqB,kBAAkB;IAKrC;;;;;;;;;;;;OAYG;IACH,YAAY,KAAgC;QAC1C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAA;QAChC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAA;QAC1B,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAA;IAC5C,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,kBAAkB,CAAC,EACvB,YAAY,EACZ,MAAM,EACN,WAAW,GAMZ;QACC,OAAO,MAAM,IAAA,4BAAkB,EAAmC;YAChE,GAAG,IAAI;YACP,GAAG,EAAE,SAAS,MAAM,gBAAgB,YAAY,EAAE;YAClD,WAAW;SACZ,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,uBAAuB,CAAC,EAC5B,4BAA4B,EAC5B,
|
|
1
|
+
{"version":3,"file":"OneBlinkDownloader.js","sourceRoot":"","sources":["../src/OneBlinkDownloader.ts"],"names":[],"mappings":";;;;;AACA,8EAAqD;AAErD;;;GAGG;AACH,MAAqB,kBAAkB;IAKrC;;;;;;;;;;;;OAYG;IACH,YAAY,KAAgC;QAC1C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAA;QAChC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAA;QAC1B,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAA;IAC5C,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,kBAAkB,CAAC,EACvB,YAAY,EACZ,MAAM,EACN,WAAW,GAMZ;QACC,OAAO,MAAM,IAAA,4BAAkB,EAAmC;YAChE,GAAG,IAAI;YACP,GAAG,EAAE,SAAS,MAAM,gBAAgB,YAAY,EAAE;YAClD,WAAW;SACZ,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,uBAAuB,CAAC,EAC5B,4BAA4B,EAC5B,WAAW,GAIZ;QACC,OAAO,MAAM,IAAA,4BAAkB,EAAmC;YAChE,GAAG,IAAI;YACP,GAAG,EAAE,kCAAkC,4BAA4B,EAAE;YACrE,WAAW;SACZ,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,mBAAmB,CAAoC,EAC3D,iBAAiB,EACjB,MAAM,EACN,WAAW,GAMZ;QACC,OAAO,MAAM,IAAA,4BAAkB,EAAI;YACjC,GAAG,IAAI;YACP,GAAG,EAAE,SAAS,MAAM,aAAa,iBAAiB,EAAE;YACpD,WAAW;SACZ,CAAC,CAAA;IACJ,CAAC;CACF;AAvHD,qCAuHC","sourcesContent":["import { DownloadOptions, StorageConstructorOptions } from './types'\nimport downloadJsonFromS3 from './downloadJsonFromS3'\nimport { SubmissionTypes } from '@oneblink/types'\n/**\n * Used to create an instance of the OneBlinkDownloader, exposing methods to\n * download submissions and other types of files\n */\nexport default class OneBlinkDownloader {\n apiOrigin: StorageConstructorOptions['apiOrigin']\n region: StorageConstructorOptions['region']\n getBearerToken: StorageConstructorOptions['getBearerToken']\n\n /**\n * #### Example\n *\n * ```typescript\n * import { OneBlinkDownloader } from '@oneblink/storage'\n *\n * const downloader = new OneBlinkDownloader({\n * apiOrigin: 'https://auth-api.blinkm.io',\n * region: 'ap-southeast-2',\n * getBearerToken: () => getAccessToken(),\n * })\n * ```\n */\n constructor(props: StorageConstructorOptions) {\n this.apiOrigin = props.apiOrigin\n this.region = props.region\n this.getBearerToken = props.getBearerToken\n }\n\n /**\n * Download a form submission.\n *\n * #### Example\n *\n * ```ts\n * const result = await downloader.downloadSubmission({\n * submissionId: '5ad46e62-f466-451c-8cd6-29ba23ac50b7',\n * formId: 1,\n * abortSignal: new AbortController().signal,\n * })\n * ```\n *\n * @param data The submission upload data and options\n * @returns The submission\n */\n async downloadSubmission({\n submissionId,\n formId,\n abortSignal,\n }: DownloadOptions & {\n /** The identifier of the submission. */\n submissionId: string\n /** The identifier of the form associated with the submission. */\n formId: number\n }) {\n return await downloadJsonFromS3<SubmissionTypes.S3SubmissionData>({\n ...this,\n key: `forms/${formId}/submissions/${submissionId}`,\n abortSignal,\n })\n }\n\n /**\n * Download a draft form submission.\n *\n * #### Example\n *\n * ```ts\n * const result = await downloader.downloadDraftSubmission({\n * formSubmissionDraftVersionId: '5ad46e62-f466-451c-8cd6-29ba23ac50b7',\n * formId: 1,\n * abortSignal: new AbortController().signal,\n * })\n * ```\n *\n * @param data The submission upload data and options\n * @returns The submission\n */\n async downloadDraftSubmission({\n formSubmissionDraftVersionId,\n abortSignal,\n }: DownloadOptions & {\n /** The identifier of the draft form submission version. */\n formSubmissionDraftVersionId: string\n }) {\n return await downloadJsonFromS3<SubmissionTypes.S3SubmissionData>({\n ...this,\n key: `form-submission-draft-versions/${formSubmissionDraftVersionId}`,\n abortSignal,\n })\n }\n\n /**\n * Download pre-fill form submission data.\n *\n * #### Example\n *\n * ```ts\n * const result = await downloader.downloadPrefillData({\n * preFillFormDataId: '5ad46e62-f466-451c-8cd6-29ba23ac50b7',\n * formId: 1,\n * abortSignal: new AbortController().signal,\n * })\n * ```\n *\n * @param data The submission upload data and options\n * @returns The submission\n */\n async downloadPrefillData<T extends Record<string, unknown>>({\n preFillFormDataId,\n formId,\n abortSignal,\n }: DownloadOptions & {\n /** The identifier of the pre-fill data. */\n preFillFormDataId: string\n /** The identifier of the form associated with the pre-fill data. */\n formId: number\n }) {\n return await downloadJsonFromS3<T>({\n ...this,\n key: `forms/${formId}/pre-fill/${preFillFormDataId}`,\n abortSignal,\n })\n }\n}\n"]}
|
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -17,10 +17,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
17
17
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
18
18
|
};
|
|
19
19
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
20
|
-
exports.OneBlinkUploader = exports.OneBlinkStorageError = void 0;
|
|
20
|
+
exports.OneBlinkDownloader = exports.OneBlinkUploader = exports.OneBlinkStorageError = void 0;
|
|
21
21
|
var OneBlinkStorageError_1 = require("./OneBlinkStorageError");
|
|
22
22
|
Object.defineProperty(exports, "OneBlinkStorageError", { enumerable: true, get: function () { return __importDefault(OneBlinkStorageError_1).default; } });
|
|
23
23
|
var OneBlinkUploader_1 = require("./OneBlinkUploader");
|
|
24
24
|
Object.defineProperty(exports, "OneBlinkUploader", { enumerable: true, get: function () { return __importDefault(OneBlinkUploader_1).default; } });
|
|
25
|
+
var OneBlinkDownloader_1 = require("./OneBlinkDownloader");
|
|
26
|
+
Object.defineProperty(exports, "OneBlinkDownloader", { enumerable: true, get: function () { return __importDefault(OneBlinkDownloader_1).default; } });
|
|
25
27
|
__exportStar(require("./types"), exports);
|
|
26
28
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,+DAAwE;AAA/D,6IAAA,OAAO,OAAwB;AACxC,uDAAgE;AAAvD,qIAAA,OAAO,OAAoB;AACpC,0CAAuB","sourcesContent":["export { default as OneBlinkStorageError } from './OneBlinkStorageError'\nexport { default as OneBlinkUploader } from './OneBlinkUploader'\nexport * from './types'\n"]}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,+DAAwE;AAA/D,6IAAA,OAAO,OAAwB;AACxC,uDAAgE;AAAvD,qIAAA,OAAO,OAAoB;AACpC,2DAAoE;AAA3D,yIAAA,OAAO,OAAsB;AACtC,0CAAuB","sourcesContent":["export { default as OneBlinkStorageError } from './OneBlinkStorageError'\nexport { default as OneBlinkUploader } from './OneBlinkUploader'\nexport { default as OneBlinkDownloader } from './OneBlinkDownloader'\nexport * from './types'\n"]}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@oneblink/storage",
|
|
3
3
|
"description": "SDK for managing storage files in the OneBlink ecosystem",
|
|
4
|
-
"version": "2.1.0-beta.
|
|
4
|
+
"version": "2.1.0-beta.3",
|
|
5
5
|
"author": "OneBlink <developers@oneblink.io> (https://oneblink.io)",
|
|
6
6
|
"bugs": {
|
|
7
7
|
"url": "https://github.com/oneblink/storage/issues"
|