@oneblink/storage 1.0.0-beta.1

package/LICENSE

@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

package/README.md

@@ -0,0 +1,7 @@
+# OneBlink - Storage [![npm module](https://img.shields.io/npm/v/@oneblink/storage.svg)](https://www.npmjs.com/package/@oneblink/storage) [![tests](https://github.com/oneblink/storage/actions/workflows/test.yml/badge.svg)](https://github.com/oneblink/apstorageps/actions)
+
+SDK for managing storage files in the OneBlink ecosystem.
+
+## Documentation
+
+See the [Documentation](https://oneblink.github.io/storage/) for more details.

package/dist/OneBlinkUploader.d.ts

@@ -0,0 +1,139 @@
+import { AttachmentUploadData, StorageConstructorOptions, UploadFormSubmissionOptions, UploadOptions } from './types';
+import { SubmissionTypes } from '@oneblink/types';
+/**
+ * Used to create an instance of the OneBlinkUploader, exposing methods to
+ * upload submissions and other types of files
+ */
+export declare class OneBlinkUploader {
+    apiOrigin: StorageConstructorOptions['apiOrigin'];
+    region: StorageConstructorOptions['region'];
+    getIdToken: StorageConstructorOptions['getIdToken'];
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * import { OneBlinkUploader } from '@oneblink/uploads'
+     *
+     * const uploader = new OneBlinkUploader({
+     *   apiOrigin: 'https://auth-api.blinkm.io',
+     *   region: 'ap-southeast-2',
+     *   getIdToken: () => getAccessToken(),
+     * })
+     * ```
+     */
+    constructor(props: StorageConstructorOptions);
+    /**
+     * Upload a submission.
+     *
+     * #### Example
+     *
+     * ```ts
+     * const result = await uploader.uploadSubmission({
+     *   submission: {
+     *     // ...
+     *   },
+     *   definition: {
+     *     // ...
+     *   },
+     *   formsAppId: 1,
+     *   onProgress: (progress) => {
+     *     // ...
+     *   },
+     * })
+     * ```
+     *
+     * @param data The submission upload data and options
+     * @returns The upload result
+     */
+    uploadSubmission({ submission, definition, device, userToken, previousFormSubmissionApprovalId, jobId, formsAppId, externalId, taskId, taskActionId, taskGroupInstanceId, recaptchas, onProgress, abortSignal, }: UploadFormSubmissionOptions & {
+        /** The identifier of the task that will be marked as completed */
+        taskId?: string;
+        /** The identifier of the task action that was used to complete the task */
+        taskActionId?: string;
+        /**
+         * The identifier of the task group instance that the completed task is
+         * associated with
+         */
+        taskGroupInstanceId?: string;
+        /** The reCAPTCHA tokens to validate the submission */
+        recaptchas?: {
+            /** A reCAPTCHA token */
+            token: string;
+        }[];
+    }): Promise<{
+        submissionTimestamp: string;
+        submissionId: string;
+        pdfAccessToken?: string | undefined;
+        preventPayment: boolean;
+    } & import("./types").BaseResponse>;
+    /**
+     * Upload an form submission attachment.
+     *
+     * #### Example
+     *
+     * ```ts
+     * const abortController = new AbortController()
+     * const result = await uploader.uploadAttachment({
+     *   formId: 1,
+     *   data: new Blob(['a string of data'], {
+     *     type: 'text/plain',
+     *   }),
+     *   fileName: 'file.txt',
+     *   contentType: 'text/plain',
+     *   isPrivate: true,
+     *   abortSignal: abortController.signal,
+     * })
+     * ```
+     *
+     * @param data The attachment upload data and options
+     * @returns The upload result
+     */
+    uploadAttachment({ formId, fileName, contentType, isPrivate, data, username, onProgress, abortSignal, }: UploadOptions & {
+        /** The identifier for the form that is being completed */
+        formId: number;
+        /** The name of the file being uploaded */
+        fileName: string;
+        /** A standard MIME type describing the format of the contents */
+        contentType: string;
+        /** Set to `true` to prevent the file from being downloaded publicly */
+        isPrivate: boolean;
+        /** The file data to upload */
+        data: AttachmentUploadData;
+        /** A username to allow a single user to download the attachment file */
+        username?: string;
+    }): Promise<{
+        url: string;
+        attachmentDataId: string;
+        uploadedAt: string;
+    } & import("./types").BaseResponse>;
+    /**
+     * Upload a draft submission.
+     *
+     * #### Example
+     *
+     * ```ts
+     * const result = await uploader.uploadDraftSubmission({
+     *   submission: {
+     *     // ...
+     *   },
+     *   definition: {
+     *     // ...
+     *   },
+     *   formsAppId: 1,
+     *   onProgress: (progress) => {
+     *     // ...
+     *   },
+     * })
+     * ```
+     *
+     * @param data The submission upload data and options
+     * @returns The upload result
+     */
+    uploadDraftSubmission({ submission, definition, device, userToken, previousFormSubmissionApprovalId, jobId, formsAppId, externalId, lastElementUpdated, onProgress, abortSignal, }: UploadFormSubmissionOptions & {
+        /** The identifier for the last element that was used before saving draft */
+        lastElementUpdated?: SubmissionTypes.NewS3SubmissionData['lastElementUpdated'];
+    }): Promise<{
+        submissionTimestamp: string;
+        draftDataId: string;
+    } & import("./types").BaseResponse>;
+}

package/dist/OneBlinkUploader.js

@@ -0,0 +1,171 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OneBlinkUploader = void 0;
+const uploadToS3_1 = __importDefault(require("./uploadToS3"));
+const generateFormSubmissionTags_1 = __importDefault(require("./generateFormSubmissionTags"));
+/**
+ * Used to create an instance of the OneBlinkUploader, exposing methods to
+ * upload submissions and other types of files
+ */
+class OneBlinkUploader {
+    /**
+     * #### Example
+     *
+     * ```typescript
+     * import { OneBlinkUploader } from '@oneblink/uploads'
+     *
+     * const uploader = new OneBlinkUploader({
+     *   apiOrigin: 'https://auth-api.blinkm.io',
+     *   region: 'ap-southeast-2',
+     *   getIdToken: () => getAccessToken(),
+     * })
+     * ```
+     */
+    constructor(props) {
+        this.apiOrigin = props.apiOrigin;
+        this.region = props.region;
+        this.getIdToken = props.getIdToken;
+    }
+    /**
+     * Upload a submission.
+     *
+     * #### Example
+     *
+     * ```ts
+     * const result = await uploader.uploadSubmission({
+     *   submission: {
+     *     // ...
+     *   },
+     *   definition: {
+     *     // ...
+     *   },
+     *   formsAppId: 1,
+     *   onProgress: (progress) => {
+     *     // ...
+     *   },
+     * })
+     * ```
+     *
+     * @param data The submission upload data and options
+     * @returns The upload result
+     */
+    async uploadSubmission({ submission, definition, device, userToken, previousFormSubmissionApprovalId, jobId, formsAppId, externalId, taskId, taskActionId, taskGroupInstanceId, recaptchas, onProgress, abortSignal, }) {
+        const newS3SubmissionData = {
+            submission,
+            definition,
+            device,
+        };
+        const tags = (0, generateFormSubmissionTags_1.default)({
+            userToken,
+            previousFormSubmissionApprovalId,
+            jobId,
+        });
+        return await (0, uploadToS3_1.default)({
+            ...this,
+            contentType: 'application/json',
+            body: JSON.stringify(newS3SubmissionData),
+            key: `forms/${definition.id}/submission`,
+            tags,
+            abortSignal,
+            onProgress,
+            requestBodyHeader: {
+                formsAppId,
+                externalId,
+                taskId,
+                taskActionId,
+                taskGroupInstanceId,
+                recaptchas: recaptchas || {},
+                jobId,
+                previousFormSubmissionApprovalId,
+            },
+        });
+    }
+    /**
+     * Upload an form submission attachment.
+     *
+     * #### Example
+     *
+     * ```ts
+     * const abortController = new AbortController()
+     * const result = await uploader.uploadAttachment({
+     *   formId: 1,
+     *   data: new Blob(['a string of data'], {
+     *     type: 'text/plain',
+     *   }),
+     *   fileName: 'file.txt',
+     *   contentType: 'text/plain',
+     *   isPrivate: true,
+     *   abortSignal: abortController.signal,
+     * })
+     * ```
+     *
+     * @param data The attachment upload data and options
+     * @returns The upload result
+     */
+    async uploadAttachment({ formId, fileName, contentType, isPrivate, data, username, onProgress, abortSignal, }) {
+        return await (0, uploadToS3_1.default)({
+            ...this,
+            contentType,
+            body: data,
+            key: `forms/${formId}/attachments`,
+            abortSignal,
+            onProgress,
+            isPublic: !isPrivate,
+            contentDisposition: `attachment; filename*=UTF-8''${encodeURIComponent(fileName)}`,
+            requestBodyHeader: {
+                username,
+                fileName,
+            },
+        });
+    }
+    /**
+     * Upload a draft submission.
+     *
+     * #### Example
+     *
+     * ```ts
+     * const result = await uploader.uploadDraftSubmission({
+     *   submission: {
+     *     // ...
+     *   },
+     *   definition: {
+     *     // ...
+     *   },
+     *   formsAppId: 1,
+     *   onProgress: (progress) => {
+     *     // ...
+     *   },
+     * })
+     * ```
+     *
+     * @param data The submission upload data and options
+     * @returns The upload result
+     */
+    async uploadDraftSubmission({ submission, definition, device, userToken, previousFormSubmissionApprovalId, jobId, formsAppId, externalId, lastElementUpdated, onProgress, abortSignal, }) {
+        return await (0, uploadToS3_1.default)({
+            ...this,
+            contentType: 'application/json',
+            body: JSON.stringify({
+                definition,
+                submission,
+                formsAppId,
+                lastElementUpdated,
+                externalId,
+                device,
+            }),
+            key: `forms/${definition.id}/drafts`,
+            tags: (0, generateFormSubmissionTags_1.default)({
+                userToken,
+                jobId,
+                previousFormSubmissionApprovalId,
+            }),
+            abortSignal,
+            onProgress,
+        });
+    }
+}
+exports.OneBlinkUploader = OneBlinkUploader;
+//# sourceMappingURL=OneBlinkUploader.js.map

package/dist/OneBlinkUploader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OneBlinkUploader.js","sourceRoot":"","sources":["../src/OneBlinkUploader.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAqC;AAQrC,8FAAqE;AAErE;;;GAGG;AACH,MAAa,gBAAgB;IAK3B;;;;;;;;;;;;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,UAAU,GAAG,KAAK,CAAC,UAAU,CAAA;IACpC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,gBAAgB,CAAC,EACrB,UAAU,EACV,UAAU,EACV,MAAM,EACN,SAAS,EACT,gCAAgC,EAChC,KAAK,EACL,UAAU,EACV,UAAU,EACV,MAAM,EACN,YAAY,EACZ,mBAAmB,EACnB,UAAU,EACV,UAAU,EACV,WAAW,GAgBZ;QACC,MAAM,mBAAmB,GAAwC;YAC/D,UAAU;YACV,UAAU;YACV,MAAM;SACP,CAAA;QACD,MAAM,IAAI,GAAG,IAAA,oCAA0B,EAAC;YACtC,SAAS;YACT,gCAAgC;YAChC,KAAK;SACN,CAAC,CAAA;QAEF,OAAO,MAAM,IAAA,oBAAU,EAKpB;YACD,GAAG,IAAI;YACP,WAAW,EAAE,kBAAkB;YAC/B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC;YACzC,GAAG,EAAE,SAAS,UAAU,CAAC,EAAE,aAAa;YACxC,IAAI;YACJ,WAAW;YACX,UAAU;YACV,iBAAiB,EAAE;gBACjB,UAAU;gBACV,UAAU;gBACV,MAAM;gBACN,YAAY;gBACZ,mBAAmB;gBACnB,UAAU,EAAE,UAAU,IAAI,EAAE;gBAC5B,KAAK;gBACL,gCAAgC;aACjC;SACF,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,gBAAgB,CAAC,EACrB,MAAM,EACN,QAAQ,EACR,WAAW,EACX,SAAS,EACT,IAAI,EACJ,QAAQ,EACR,UAAU,EACV,WAAW,GAcZ;QACC,OAAO,MAAM,IAAA,oBAAU,EAIpB;YACD,GAAG,IAAI;YACP,WAAW;YACX,IAAI,EAAE,IAAI;YACV,GAAG,EAAE,SAAS,MAAM,cAAc;YAClC,WAAW;YACX,UAAU;YACV,QAAQ,EAAE,CAAC,SAAS;YACpB,kBAAkB,EAAE,gCAAgC,kBAAkB,CAAC,QAAQ,CAAC,EAAE;YAClF,iBAAiB,EAAE;gBACjB,QAAQ;gBACR,QAAQ;aACT;SACF,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,qBAAqB,CAAC,EAC1B,UAAU,EACV,UAAU,EACV,MAAM,EACN,SAAS,EACT,gCAAgC,EAChC,KAAK,EACL,UAAU,EACV,UAAU,EACV,kBAAkB,EAClB,UAAU,EACV,WAAW,GAIZ;QACC,OAAO,MAAM,IAAA,oBAAU,EAGpB;YACD,GAAG,IAAI;YACP,WAAW,EAAE,kBAAkB;YAC/B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,UAAU;gBACV,UAAU;gBACV,UAAU;gBACV,kBAAkB;gBAClB,UAAU;gBACV,MAAM;aACP,CAAC;YACF,GAAG,EAAE,SAAS,UAAU,CAAC,EAAE,SAAS;YACpC,IAAI,EAAE,IAAA,oCAA0B,EAAC;gBAC/B,SAAS;gBACT,KAAK;gBACL,gCAAgC;aACjC,CAAC;YACF,WAAW;YACX,UAAU;SACX,CAAC,CAAA;IACJ,CAAC;CACF;AAnPD,4CAmPC","sourcesContent":["import uploadToS3 from './uploadToS3'\nimport {\n  AttachmentUploadData,\n  StorageConstructorOptions,\n  UploadFormSubmissionOptions,\n  UploadOptions,\n} from './types'\nimport { SubmissionTypes } from '@oneblink/types'\nimport generateFormSubmissionTags from './generateFormSubmissionTags'\n\n/**\n * Used to create an instance of the OneBlinkUploader, exposing methods to\n * upload submissions and other types of files\n */\nexport class OneBlinkUploader {\n  apiOrigin: StorageConstructorOptions['apiOrigin']\n  region: StorageConstructorOptions['region']\n  getIdToken: StorageConstructorOptions['getIdToken']\n\n  /**\n   * #### Example\n   *\n   * ```typescript\n   * import { OneBlinkUploader } from '@oneblink/uploads'\n   *\n   * const uploader = new OneBlinkUploader({\n   *   apiOrigin: 'https://auth-api.blinkm.io',\n   *   region: 'ap-southeast-2',\n   *   getIdToken: () => getAccessToken(),\n   * })\n   * ```\n   */\n  constructor(props: StorageConstructorOptions) {\n    this.apiOrigin = props.apiOrigin\n    this.region = props.region\n    this.getIdToken = props.getIdToken\n  }\n\n  /**\n   * Upload a submission.\n   *\n   * #### Example\n   *\n   * ```ts\n   * const result = await uploader.uploadSubmission({\n   *   submission: {\n   *     // ...\n   *   },\n   *   definition: {\n   *     // ...\n   *   },\n   *   formsAppId: 1,\n   *   onProgress: (progress) => {\n   *     // ...\n   *   },\n   * })\n   * ```\n   *\n   * @param data The submission upload data and options\n   * @returns The upload result\n   */\n  async uploadSubmission({\n    submission,\n    definition,\n    device,\n    userToken,\n    previousFormSubmissionApprovalId,\n    jobId,\n    formsAppId,\n    externalId,\n    taskId,\n    taskActionId,\n    taskGroupInstanceId,\n    recaptchas,\n    onProgress,\n    abortSignal,\n  }: UploadFormSubmissionOptions & {\n    /** The identifier of the task that will be marked as completed */\n    taskId?: string\n    /** The identifier of the task action that was used to complete the task */\n    taskActionId?: string\n    /**\n     * The identifier of the task group instance that the completed task is\n     * associated with\n     */\n    taskGroupInstanceId?: string\n    /** The reCAPTCHA tokens to validate the submission */\n    recaptchas?: {\n      /** A reCAPTCHA token */\n      token: string\n    }[]\n  }) {\n    const newS3SubmissionData: SubmissionTypes.NewS3SubmissionData = {\n      submission,\n      definition,\n      device,\n    }\n    const tags = generateFormSubmissionTags({\n      userToken,\n      previousFormSubmissionApprovalId,\n      jobId,\n    })\n\n    return await uploadToS3<{\n      submissionTimestamp: string\n      submissionId: string\n      pdfAccessToken?: string\n      preventPayment: boolean\n    }>({\n      ...this,\n      contentType: 'application/json',\n      body: JSON.stringify(newS3SubmissionData),\n      key: `forms/${definition.id}/submission`,\n      tags,\n      abortSignal,\n      onProgress,\n      requestBodyHeader: {\n        formsAppId,\n        externalId,\n        taskId,\n        taskActionId,\n        taskGroupInstanceId,\n        recaptchas: recaptchas || {},\n        jobId,\n        previousFormSubmissionApprovalId,\n      },\n    })\n  }\n\n  /**\n   * Upload an form submission attachment.\n   *\n   * #### Example\n   *\n   * ```ts\n   * const abortController = new AbortController()\n   * const result = await uploader.uploadAttachment({\n   *   formId: 1,\n   *   data: new Blob(['a string of data'], {\n   *     type: 'text/plain',\n   *   }),\n   *   fileName: 'file.txt',\n   *   contentType: 'text/plain',\n   *   isPrivate: true,\n   *   abortSignal: abortController.signal,\n   * })\n   * ```\n   *\n   * @param data The attachment upload data and options\n   * @returns The upload result\n   */\n  async uploadAttachment({\n    formId,\n    fileName,\n    contentType,\n    isPrivate,\n    data,\n    username,\n    onProgress,\n    abortSignal,\n  }: UploadOptions & {\n    /** The identifier for the form that is being completed */\n    formId: number\n    /** The name of the file being uploaded */\n    fileName: string\n    /** A standard MIME type describing the format of the contents */\n    contentType: string\n    /** Set to `true` to prevent the file from being downloaded publicly */\n    isPrivate: boolean\n    /** The file data to upload */\n    data: AttachmentUploadData\n    /** A username to allow a single user to download the attachment file */\n    username?: string\n  }) {\n    return await uploadToS3<{\n      url: string\n      attachmentDataId: string\n      uploadedAt: string\n    }>({\n      ...this,\n      contentType,\n      body: data,\n      key: `forms/${formId}/attachments`,\n      abortSignal,\n      onProgress,\n      isPublic: !isPrivate,\n      contentDisposition: `attachment; filename*=UTF-8''${encodeURIComponent(fileName)}`,\n      requestBodyHeader: {\n        username,\n        fileName,\n      },\n    })\n  }\n\n  /**\n   * Upload a draft submission.\n   *\n   * #### Example\n   *\n   * ```ts\n   * const result = await uploader.uploadDraftSubmission({\n   *   submission: {\n   *     // ...\n   *   },\n   *   definition: {\n   *     // ...\n   *   },\n   *   formsAppId: 1,\n   *   onProgress: (progress) => {\n   *     // ...\n   *   },\n   * })\n   * ```\n   *\n   * @param data The submission upload data and options\n   * @returns The upload result\n   */\n  async uploadDraftSubmission({\n    submission,\n    definition,\n    device,\n    userToken,\n    previousFormSubmissionApprovalId,\n    jobId,\n    formsAppId,\n    externalId,\n    lastElementUpdated,\n    onProgress,\n    abortSignal,\n  }: UploadFormSubmissionOptions & {\n    /** The identifier for the last element that was used before saving draft */\n    lastElementUpdated?: SubmissionTypes.NewS3SubmissionData['lastElementUpdated']\n  }) {\n    return await uploadToS3<{\n      submissionTimestamp: string\n      draftDataId: string\n    }>({\n      ...this,\n      contentType: 'application/json',\n      body: JSON.stringify({\n        definition,\n        submission,\n        formsAppId,\n        lastElementUpdated,\n        externalId,\n        device,\n      }),\n      key: `forms/${definition.id}/drafts`,\n      tags: generateFormSubmissionTags({\n        userToken,\n        jobId,\n        previousFormSubmissionApprovalId,\n      }),\n      abortSignal,\n      onProgress,\n    })\n  }\n}\n"]}

package/dist/generateFormSubmissionTags.d.ts

@@ -0,0 +1,5 @@
+export default function generateFormSubmissionTags({ userToken, previousFormSubmissionApprovalId, jobId, }: {
+    userToken: string | undefined;
+    previousFormSubmissionApprovalId: string | undefined;
+    jobId: string | undefined;
+}): URLSearchParams;

package/dist/generateFormSubmissionTags.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function generateFormSubmissionTags({ userToken, previousFormSubmissionApprovalId, jobId, }) {
+    const tags = new URLSearchParams();
+    if (userToken) {
+        tags.append('userToken', userToken);
+    }
+    if (previousFormSubmissionApprovalId) {
+        tags.append('previousFormSubmissionApprovalId', previousFormSubmissionApprovalId);
+    }
+    if (jobId) {
+        tags.append('jobId', jobId);
+    }
+    return tags;
+}
+exports.default = generateFormSubmissionTags;
+//# sourceMappingURL=generateFormSubmissionTags.js.map

package/dist/generateFormSubmissionTags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateFormSubmissionTags.js","sourceRoot":"","sources":["../src/generateFormSubmissionTags.ts"],"names":[],"mappings":";;AAAA,SAAwB,0BAA0B,CAAC,EACjD,SAAS,EACT,gCAAgC,EAChC,KAAK,GAKN;IACC,MAAM,IAAI,GAAG,IAAI,eAAe,EAAE,CAAA;IAClC,IAAI,SAAS,EAAE,CAAC;QACd,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,CAAA;IACrC,CAAC;IACD,IAAI,gCAAgC,EAAE,CAAC;QACrC,IAAI,CAAC,MAAM,CACT,kCAAkC,EAClC,gCAAgC,CACjC,CAAA;IACH,CAAC;IACD,IAAI,KAAK,EAAE,CAAC;QACV,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;IAC7B,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAvBD,6CAuBC","sourcesContent":["export default function generateFormSubmissionTags({\n  userToken,\n  previousFormSubmissionApprovalId,\n  jobId,\n}: {\n  userToken: string | undefined\n  previousFormSubmissionApprovalId: string | undefined\n  jobId: string | undefined\n}) {\n  const tags = new URLSearchParams()\n  if (userToken) {\n    tags.append('userToken', userToken)\n  }\n  if (previousFormSubmissionApprovalId) {\n    tags.append(\n      'previousFormSubmissionApprovalId',\n      previousFormSubmissionApprovalId,\n    )\n  }\n  if (jobId) {\n    tags.append('jobId', jobId)\n  }\n  return tags\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { OneBlinkUploader } from './OneBlinkUploader';
+export * from './types';

package/dist/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OneBlinkUploader = void 0;
+var OneBlinkUploader_1 = require("./OneBlinkUploader");
+Object.defineProperty(exports, "OneBlinkUploader", { enumerable: true, get: function () { return OneBlinkUploader_1.OneBlinkUploader; } });
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,uDAAqD;AAA5C,oHAAA,gBAAgB,OAAA;AACzB,0CAAuB","sourcesContent":["export { OneBlinkUploader } from './OneBlinkUploader'\nexport * from './types'\n"]}

package/dist/typedoc.d.ts

@@ -0,0 +1,2 @@
+export * from './index';
+export * from '@oneblink/types';

package/dist/typedoc.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./index"), exports);
+__exportStar(require("@oneblink/types"), exports);
+//# sourceMappingURL=typedoc.js.map

package/dist/typedoc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typedoc.js","sourceRoot":"","sources":["../src/typedoc.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,kDAA+B","sourcesContent":["export * from './index'\nexport * from '@oneblink/types'\n"]}

package/dist/types.d.ts

@@ -0,0 +1,51 @@
+import { PutObjectCommandInput } from '@aws-sdk/client-s3';
+import { AWSTypes, SubmissionTypes } from '@oneblink/types';
+export type ProgressListenerEvent = {
+    progress: number;
+    total: number;
+};
+export type ProgressListener = (progress: ProgressListenerEvent) => void;
+/** The properties to be passed to the Storage class constructors */
+export type StorageConstructorOptions = {
+    /** The API origin URL used to communicate with the OneBlink API */
+    apiOrigin: string;
+    /** The AWS region to upload the submission to */
+    region: string;
+    /**
+     * A function that returns a promise resolving to an access token. If the
+     * promise resolves to a truthy value, the `x-oneblink-authorization` header
+     * will be set with the value.
+     */
+    getIdToken: () => Promise<string | undefined>;
+};
+export type BaseResponse = {
+    s3: AWSTypes.S3Configuration;
+};
+export type UploadOptions = {
+    /** An optional progress listener for tracking the progress of the upload */
+    onProgress?: ProgressListener;
+    /** An optional AbortSignal that can be used to abort the upload */
+    abortSignal?: AbortSignal;
+};
+export type AttachmentUploadData = NonNullable<PutObjectCommandInput['Body']>;
+export type UploadFormSubmissionOptions = UploadOptions & {
+    /** The submission data */
+    submission: SubmissionTypes.NewS3SubmissionData['submission'];
+    /** The form that is being submitted */
+    definition: SubmissionTypes.NewS3SubmissionData['definition'];
+    /** The device the form is being submitted */
+    device?: SubmissionTypes.NewS3SubmissionData['device'];
+    /** The identifier for the forms app that is being submitted from */
+    formsAppId: number;
+    /** An encrypted token that repraesents the user */
+    userToken?: string;
+    /** The external identifier that represents the submission */
+    externalId?: string;
+    /**
+     * The identifier for the previous FormSubmissionApproval that lead to a
+     * clarification request
+     */
+    previousFormSubmissionApprovalId?: string;
+    /** The identifier of the job that will be marked as submitted */
+    jobId?: string;
+};

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import { PutObjectCommandInput } from '@aws-sdk/client-s3'\nimport { AWSTypes, SubmissionTypes } from '@oneblink/types'\n\nexport type ProgressListenerEvent = { progress: number; total: number }\nexport type ProgressListener = (progress: ProgressListenerEvent) => void\n\n/** The properties to be passed to the Storage class constructors */\nexport type StorageConstructorOptions = {\n  /** The API origin URL used to communicate with the OneBlink API */\n  apiOrigin: string\n  /** The AWS region to upload the submission to */\n  region: string\n  /**\n   * A function that returns a promise resolving to an access token. If the\n   * promise resolves to a truthy value, the `x-oneblink-authorization` header\n   * will be set with the value.\n   */\n  getIdToken: () => Promise<string | undefined>\n}\n\nexport type BaseResponse = {\n  s3: AWSTypes.S3Configuration\n}\n\nexport type UploadOptions = {\n  /** An optional progress listener for tracking the progress of the upload */\n  onProgress?: ProgressListener\n  /** An optional AbortSignal that can be used to abort the upload */\n  abortSignal?: AbortSignal\n}\n\nexport type AttachmentUploadData = NonNullable<PutObjectCommandInput['Body']>\n\nexport type UploadFormSubmissionOptions = UploadOptions & {\n  /** The submission data */\n  submission: SubmissionTypes.NewS3SubmissionData['submission']\n  /** The form that is being submitted */\n  definition: SubmissionTypes.NewS3SubmissionData['definition']\n  /** The device the form is being submitted */\n  device?: SubmissionTypes.NewS3SubmissionData['device']\n  /** The identifier for the forms app that is being submitted from */\n  formsAppId: number\n  /** An encrypted token that repraesents the user */\n  userToken?: string\n  /** The external identifier that represents the submission */\n  externalId?: string\n  /**\n   * The identifier for the previous FormSubmissionApproval that lead to a\n   * clarification request\n   */\n  previousFormSubmissionApprovalId?: string\n  /** The identifier of the job that will be marked as submitted */\n  jobId?: string\n}\n"]}

package/dist/uploadToS3.d.ts

@@ -0,0 +1,26 @@
+import { PutObjectCommandInput } from '@aws-sdk/client-s3';
+import { Progress } from '@aws-sdk/lib-storage';
+import { StorageConstructorOptions, BaseResponse, UploadOptions } from './types';
+type RequestBodyHeader = Record<string, unknown>;
+/** The properties to be passed to the uploadToS3 function */
+interface UploadToS3Props extends UploadOptions, StorageConstructorOptions {
+    /** The key of the file that is being uploaded. */
+    key: string;
+    /**
+     * The body of the request. This can be a string, a Buffer, a Blob, a
+     * ReadableStream, or a Readable.
+     */
+    body: PutObjectCommandInput['Body'];
+    /** Optional header to be included in the request to the OneBlink API */
+    requestBodyHeader?: RequestBodyHeader;
+    /** An optional set of tags that will be applied to the uploaded file */
+    tags?: URLSearchParams;
+    /** A standard MIME type describing the format of the contents */
+    contentType: PutObjectCommandInput['ContentType'];
+    /** Set to `true` to make the upload available to download publicly */
+    isPublic?: boolean;
+}
+declare function uploadToS3<T>({ region, apiOrigin, key, body, requestBodyHeader, tags, getIdToken, onProgress, abortSignal, contentType, isPublic, }: UploadToS3Props): Promise<T & BaseResponse>;
+export default uploadToS3;
+export declare const determineQueueSize: () => number;
+export declare const determineUploadProgressAsPercentage: (progress: Required<Pick<Progress, 'total'>> & Omit<Progress, 'total'>) => number;

package/dist/uploadToS3.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.determineUploadProgressAsPercentage = exports.determineQueueSize = void 0;
+const client_s3_1 = require("@aws-sdk/client-s3");
+const lib_storage_1 = require("@aws-sdk/lib-storage");
+const fetch_http_handler_1 = require("@smithy/fetch-http-handler");
+const RETRY_ATTEMPTS = 3;
+// Our own custom request handler to allow setting customer headers for
+// authentication. Also allow the response header which includes dynamic
+// data from the lambda at edge to be retrieved and held for later when
+// the upload has completed.
+class OBRequestHandler extends fetch_http_handler_1.FetchHttpHandler {
+    constructor({ getIdToken, requestBodyHeader, }) {
+        super();
+        this.getIdToken = getIdToken;
+        this.requestBodyHeader = requestBodyHeader;
+    }
+    async handle(request, options) {
+        const token = await this.getIdToken();
+        if (token) {
+            request.headers['x-oneblink-authorization'] = 'Bearer ' + token;
+        }
+        if (this.requestBodyHeader) {
+            request.headers['x-oneblink-request-body'] = JSON.stringify(this.requestBodyHeader);
+        }
+        if (this.response) {
+            request.query['key'] = this.response.s3.key;
+        }
+        const result = await super.handle(request, options);
+        console.log('result', result);
+        const response = result.response.headers['x-oneblink-response'];
+        if (response) {
+            this.response = JSON.parse(response);
+        }
+        return result;
+    }
+}
+const endpointSuffix = '/storage';
+async function uploadToS3({ region, apiOrigin, key, body, requestBodyHeader, tags, getIdToken, onProgress, abortSignal, contentType, isPublic, }) {
+    const requestHandler = new OBRequestHandler({
+        getIdToken,
+        requestBodyHeader,
+    });
+    const s3Client = new client_s3_1.S3Client({
+        // The suffix on the end is important as it will allow us to route
+        // traffic to S3 via lambda at edge instead of going to our API
+        endpoint: `${apiOrigin}${endpointSuffix}`,
+        region: region,
+        requestHandler,
+        // Have to put something here otherwise the SDK throws errors.
+        // Might be able to remove the validation from the middleware somehow?
+        credentials: {
+            accessKeyId: 'AWS_ACCESS_KEY_ID',
+            secretAccessKey: 'AWS_SECRET_ACCESS_KEY',
+        },
+        maxAttempts: RETRY_ATTEMPTS,
+    });
+    const managedUpload = new lib_storage_1.Upload({
+        client: s3Client,
+        partSize: 5 * 1024 * 1024,
+        queueSize: (0, exports.determineQueueSize)(),
+        //Related github issue: https://github.com/aws/aws-sdk-js-v3/issues/2311
+        //This is a variable that is set to false by default, setting it to true
+        //means that it will force the upload to fail when one part fails on
+        //an upload. The S3 client has built in retry logic to retry uploads by default
+        leavePartsOnError: true,
+        params: {
+            // Bucket needs to have something to avoid client side errors
+            // Also needs to have a `.` in it to prevent SDK from using the
+            // new S3 bucket domain concept with includes the bucket in the
+            // domain instead of the path. We need it in the path to use the
+            // API as the domain.
+            Bucket: 'storage.oneblink.io',
+            Key: key,
+            Body: body,
+            ContentType: contentType,
+            ServerSideEncryption: 'AES256',
+            Expires: new Date(new Date().setFullYear(new Date().getFullYear() + 1)), // Max 1 year
+            CacheControl: 'max-age=31536000', // Max 1 year(365 days),
+            ACL: isPublic ? 'public-read' : 'private',
+            Tagging: tags === null || tags === void 0 ? void 0 : tags.toString(),
+        },
+    });
+    managedUpload.on('httpUploadProgress', (progress) => {
+        console.log('Progress', progress);
+        if (onProgress && progress.total) {
+            const percent = (0, exports.determineUploadProgressAsPercentage)({
+                ...progress,
+                total: progress.total,
+            });
+            onProgress({ progress: percent, total: 100 });
+        }
+    });
+    abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.addEventListener('abort', () => {
+        managedUpload.abort();
+    });
+    await managedUpload.done();
+    if (!requestHandler.response) {
+        throw new Error('No response from server. Something went wrong in the OneBlink/uploads SDK.');
+    }
+    return requestHandler.response;
+}
+exports.default = uploadToS3;
+const determineQueueSize = () => {
+    let queueSize = 1; // default to 1 as the lowest common denominator
+    // Return as though using highest speed for Node environments
+    if (!window)
+        return 10;
+    if (window.navigator &&
+        'connection' in window.navigator &&
+        !!window.navigator.connection &&
+        // @ts-expect-error effectiveType prop is still in draft
+        window.navigator.connection.effectiveType) {
+        // @ts-expect-error effectiveType prop is still in draft
+        switch (window.navigator.connection.effectiveType) {
+            case 'slow-2g':
+            case '2g':
+                queueSize = 1;
+                break;
+            case '3g':
+                queueSize = 2;
+                break;
+            case '4g':
+                queueSize = 10;
+                break;
+        }
+    }
+    return queueSize;
+};
+exports.determineQueueSize = determineQueueSize;
+const determineUploadProgressAsPercentage = (progress) => {
+    const percent = ((progress.loaded || 0) / progress.total) * 100;
+    return Math.floor(percent);
+};
+exports.determineUploadProgressAsPercentage = determineUploadProgressAsPercentage;
+//# sourceMappingURL=uploadToS3.js.map

package/dist/uploadToS3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploadToS3.js","sourceRoot":"","sources":["../src/uploadToS3.ts"],"names":[],"mappings":";;;AAAA,kDAAoE;AACpE,sDAAuD;AAGvD,mEAA6D;AAG7D,MAAM,cAAc,GAAG,CAAC,CAAA;AAGxB,uEAAuE;AACvE,wEAAwE;AACxE,uEAAuE;AACvE,4BAA4B;AAC5B,MAAM,gBAAoB,SAAQ,qCAAgB;IAChD,YAAY,EACV,UAAU,EACV,iBAAiB,GAIlB;QACC,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAA;IAC5C,CAAC;IAMD,KAAK,CAAC,MAAM,CAAC,OAAoB,EAAE,OAA4B;QAC7D,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACrC,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,CAAC,OAAO,CAAC,0BAA0B,CAAC,GAAG,SAAS,GAAG,KAAK,CAAA;QACjE,CAAC;QACD,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3B,OAAO,CAAC,OAAO,CAAC,yBAAyB,CAAC,GAAG,IAAI,CAAC,SAAS,CACzD,IAAI,CAAC,iBAAiB,CACvB,CAAA;QACH,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAA;QAC7C,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACnD,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;QAC7B,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,qBAAqB,CAEjD,CAAA;QACb,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;QACtC,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAED,MAAM,cAAc,GAAG,UAAU,CAAA;AAqBjC,KAAK,UAAU,UAAU,CAAI,EAC3B,MAAM,EACN,SAAS,EACT,GAAG,EACH,IAAI,EACJ,iBAAiB,EACjB,IAAI,EACJ,UAAU,EACV,UAAU,EACV,WAAW,EACX,WAAW,EACX,QAAQ,GACQ;IAChB,MAAM,cAAc,GAAG,IAAI,gBAAgB,CAAI;QAC7C,UAAU;QACV,iBAAiB;KAClB,CAAC,CAAA;IAEF,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAAC;QAC5B,kEAAkE;QAClE,+DAA+D;QAC/D,QAAQ,EAAE,GAAG,SAAS,GAAG,cAAc,EAAE;QACzC,MAAM,EAAE,MAAM;QACd,cAAc;QACd,8DAA8D;QAC9D,sEAAsE;QACtE,WAAW,EAAE;YACX,WAAW,EAAE,mBAAmB;YAChC,eAAe,EAAE,uBAAuB;SACzC;QACD,WAAW,EAAE,cAAc;KAC5B,CAAC,CAAA;IAEF,MAAM,aAAa,GAAG,IAAI,oBAAM,CAAC;QAC/B,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,GAAG,IAAI,GAAG,IAAI;QACzB,SAAS,EAAE,IAAA,0BAAkB,GAAE;QAC/B,wEAAwE;QACxE,wEAAwE;QACxE,oEAAoE;QACpE,+EAA+E;QAC/E,iBAAiB,EAAE,IAAI;QACvB,MAAM,EAAE;YACN,6DAA6D;YAC7D,+DAA+D;YAC/D,+DAA+D;YAC/D,gEAAgE;YAChE,qBAAqB;YACrB,MAAM,EAAE,qBAAqB;YAC7B,GAAG,EAAE,GAAG;YACR,IAAI,EAAE,IAAI;YACV,WAAW,EAAE,WAAW;YACxB,oBAAoB,EAAE,QAAQ;YAC9B,OAAO,EAAE,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,aAAa;YACtF,YAAY,EAAE,kBAAkB,EAAE,wBAAwB;YAC1D,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS;YACzC,OAAO,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,EAAE;SAC1B;KACF,CAAC,CAAA;IAEF,aAAa,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,QAAQ,EAAE,EAAE;QAClD,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;QACjC,IAAI,UAAU,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;YACjC,MAAM,OAAO,GAAG,IAAA,2CAAmC,EAAC;gBAClD,GAAG,QAAQ;gBACX,KAAK,EAAE,QAAQ,CAAC,KAAK;aACtB,CAAC,CAAA;YACF,UAAU,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;QAC/C,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;QAC1C,aAAa,CAAC,KAAK,EAAE,CAAA;IACvB,CAAC,CAAC,CAAA;IAEF,MAAM,aAAa,CAAC,IAAI,EAAE,CAAA;IAE1B,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CACb,4EAA4E,CAC7E,CAAA;IACH,CAAC;IACD,OAAO,cAAc,CAAC,QAAQ,CAAA;AAChC,CAAC;AAED,kBAAe,UAAU,CAAA;AAElB,MAAM,kBAAkB,GAAG,GAAG,EAAE;IACrC,IAAI,SAAS,GAAG,CAAC,CAAA,CAAC,gDAAgD;IAClE,6DAA6D;IAC7D,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAA;IACtB,IACE,MAAM,CAAC,SAAS;QAChB,YAAY,IAAI,MAAM,CAAC,SAAS;QAChC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU;QAC7B,wDAAwD;QACxD,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,aAAa,EACzC,CAAC;QACD,wDAAwD;QACxD,QAAQ,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC;YAClD,KAAK,SAAS,CAAC;YACf,KAAK,IAAI;gBACP,SAAS,GAAG,CAAC,CAAA;gBACb,MAAK;YACP,KAAK,IAAI;gBACP,SAAS,GAAG,CAAC,CAAA;gBACb,MAAK;YACP,KAAK,IAAI;gBACP,SAAS,GAAG,EAAE,CAAA;gBACd,MAAK;QACT,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAA;AAClB,CAAC,CAAA;AA3BY,QAAA,kBAAkB,sBA2B9B;AAEM,MAAM,mCAAmC,GAAG,CACjD,QAAqE,EACrE,EAAE;IACF,MAAM,OAAO,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,GAAG,CAAA;IAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;AAC5B,CAAC,CAAA;AALY,QAAA,mCAAmC,uCAK/C","sourcesContent":["import { PutObjectCommandInput, S3Client } from '@aws-sdk/client-s3'\nimport { Upload, Progress } from '@aws-sdk/lib-storage'\nimport { HttpHandlerOptions } from '@smithy/types'\nimport { HttpRequest } from '@smithy/protocol-http'\nimport { FetchHttpHandler } from '@smithy/fetch-http-handler'\nimport { StorageConstructorOptions, BaseResponse, UploadOptions } from './types'\n\nconst RETRY_ATTEMPTS = 3\n\ntype RequestBodyHeader = Record<string, unknown>\n// Our own custom request handler to allow setting customer headers for\n// authentication. Also allow the response header which includes dynamic\n// data from the lambda at edge to be retrieved and held for later when\n// the upload has completed.\nclass OBRequestHandler<T> extends FetchHttpHandler {\n  constructor({\n    getIdToken,\n    requestBodyHeader,\n  }: {\n    getIdToken: StorageConstructorOptions['getIdToken']\n    requestBodyHeader?: RequestBodyHeader\n  }) {\n    super()\n    this.getIdToken = getIdToken\n    this.requestBodyHeader = requestBodyHeader\n  }\n\n  getIdToken: StorageConstructorOptions['getIdToken']\n  requestBodyHeader?: RequestBodyHeader\n  response?: T & BaseResponse\n\n  async handle(request: HttpRequest, options?: HttpHandlerOptions) {\n    const token = await this.getIdToken()\n    if (token) {\n      request.headers['x-oneblink-authorization'] = 'Bearer ' + token\n    }\n    if (this.requestBodyHeader) {\n      request.headers['x-oneblink-request-body'] = JSON.stringify(\n        this.requestBodyHeader,\n      )\n    }\n    if (this.response) {\n      request.query['key'] = this.response.s3.key\n    }\n    const result = await super.handle(request, options)\n    console.log('result', result)\n    const response = result.response.headers['x-oneblink-response'] as\n      | string\n      | undefined\n    if (response) {\n      this.response = JSON.parse(response)\n    }\n    return result\n  }\n}\n\nconst endpointSuffix = '/storage'\n\n/** The properties to be passed to the uploadToS3 function */\ninterface UploadToS3Props extends UploadOptions, StorageConstructorOptions {\n  /** The key of the file that is being uploaded. */\n  key: string\n  /**\n   * The body of the request. This can be a string, a Buffer, a Blob, a\n   * ReadableStream, or a Readable.\n   */\n  body: PutObjectCommandInput['Body']\n  /** Optional header to be included in the request to the OneBlink API */\n  requestBodyHeader?: RequestBodyHeader\n  /** An optional set of tags that will be applied to the uploaded file */\n  tags?: URLSearchParams\n  /** A standard MIME type describing the format of the contents */\n  contentType: PutObjectCommandInput['ContentType']\n  /** Set to `true` to make the upload available to download publicly */\n  isPublic?: boolean\n}\n\nasync function uploadToS3<T>({\n  region,\n  apiOrigin,\n  key,\n  body,\n  requestBodyHeader,\n  tags,\n  getIdToken,\n  onProgress,\n  abortSignal,\n  contentType,\n  isPublic,\n}: UploadToS3Props) {\n  const requestHandler = new OBRequestHandler<T>({\n    getIdToken,\n    requestBodyHeader,\n  })\n\n  const s3Client = new S3Client({\n    // The suffix on the end is important as it will allow us to route\n    // traffic to S3 via lambda at edge instead of going to our API\n    endpoint: `${apiOrigin}${endpointSuffix}`,\n    region: region,\n    requestHandler,\n    // Have to put something here otherwise the SDK throws errors.\n    // Might be able to remove the validation from the middleware somehow?\n    credentials: {\n      accessKeyId: 'AWS_ACCESS_KEY_ID',\n      secretAccessKey: 'AWS_SECRET_ACCESS_KEY',\n    },\n    maxAttempts: RETRY_ATTEMPTS,\n  })\n\n  const managedUpload = new Upload({\n    client: s3Client,\n    partSize: 5 * 1024 * 1024,\n    queueSize: determineQueueSize(),\n    //Related github issue: https://github.com/aws/aws-sdk-js-v3/issues/2311\n    //This is a variable that is set to false by default, setting it to true\n    //means that it will force the upload to fail when one part fails on\n    //an upload. The S3 client has built in retry logic to retry uploads by default\n    leavePartsOnError: true,\n    params: {\n      // Bucket needs to have something to avoid client side errors\n      // Also needs to have a `.` in it to prevent SDK from using the\n      // new S3 bucket domain concept with includes the bucket in the\n      // domain instead of the path. We need it in the path to use the\n      // API as the domain.\n      Bucket: 'storage.oneblink.io',\n      Key: key,\n      Body: body,\n      ContentType: contentType,\n      ServerSideEncryption: 'AES256',\n      Expires: new Date(new Date().setFullYear(new Date().getFullYear() + 1)), // Max 1 year\n      CacheControl: 'max-age=31536000', // Max 1 year(365 days),\n      ACL: isPublic ? 'public-read' : 'private',\n      Tagging: tags?.toString(),\n    },\n  })\n\n  managedUpload.on('httpUploadProgress', (progress) => {\n    console.log('Progress', progress)\n    if (onProgress && progress.total) {\n      const percent = determineUploadProgressAsPercentage({\n        ...progress,\n        total: progress.total,\n      })\n      onProgress({ progress: percent, total: 100 })\n    }\n  })\n\n  abortSignal?.addEventListener('abort', () => {\n    managedUpload.abort()\n  })\n\n  await managedUpload.done()\n\n  if (!requestHandler.response) {\n    throw new Error(\n      'No response from server. Something went wrong in the OneBlink/uploads SDK.',\n    )\n  }\n  return requestHandler.response\n}\n\nexport default uploadToS3\n\nexport const determineQueueSize = () => {\n  let queueSize = 1 // default to 1 as the lowest common denominator\n  // Return as though using highest speed for Node environments\n  if (!window) return 10\n  if (\n    window.navigator &&\n    'connection' in window.navigator &&\n    !!window.navigator.connection &&\n    // @ts-expect-error effectiveType prop is still in draft\n    window.navigator.connection.effectiveType\n  ) {\n    // @ts-expect-error effectiveType prop is still in draft\n    switch (window.navigator.connection.effectiveType) {\n      case 'slow-2g':\n      case '2g':\n        queueSize = 1\n        break\n      case '3g':\n        queueSize = 2\n        break\n      case '4g':\n        queueSize = 10\n        break\n    }\n  }\n\n  return queueSize\n}\n\nexport const determineUploadProgressAsPercentage = (\n  progress: Required<Pick<Progress, 'total'>> & Omit<Progress, 'total'>,\n) => {\n  const percent = ((progress.loaded || 0) / progress.total) * 100\n  return Math.floor(percent)\n}\n"]}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@oneblink/storage",
+  "description": "SDK for managing storage files in the OneBlink ecosystem",
+  "version": "1.0.0-beta.1",
+  "author": "OneBlink <developers@oneblink.io> (https://oneblink.io)",
+  "bugs": {
+    "url": "https://github.com/oneblink/storage/issues"
+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.554.0",
+    "@aws-sdk/lib-storage": "^3.554.0"
+  },
+  "devDependencies": {
+    "@microsoft/eslint-plugin-sdl": "^0.2.2",
+    "@oneblink/types": "github:oneblink/types",
+    "@types/jest": "^29.5.12",
+    "@typescript-eslint/eslint-plugin": "^7.6.0",
+    "@typescript-eslint/parser": "^7.6.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "fixpack": "^4.0.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "prettier": "^3.2.5",
+    "prettier-plugin-jsdoc": "^1.3.0",
+    "ts-jest": "^29.1.2",
+    "typedoc": "^0.25.13",
+    "typescript": "^5.4.4"
+  },
+  "directories": {
+    "doc": "docs"
+  },
+  "engines": {
+    "node": ">=20",
+    "npm": ">=10"
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://github.com/oneblink/storage",
+  "license": "ISC",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/oneblink/storage.git"
+  },
+  "scripts": {
+    "build": "tsc",
+    "docs": "typedoc",
+    "eslint": "eslint src/**/*.ts --fix --cache",
+    "fixpack": "fixpack",
+    "format": "prettier --write .",
+    "prepare": "npm run build",
+    "pretest": "npm run fixpack && npm run eslint && npm run typescript",
+    "release": "oneblink-release repository --no-name",
+    "start": "tsc-watch",
+    "test": "jest",
+    "types": "npm i -D github:oneblink/types",
+    "typescript": "tsc --noEmit"
+  }
+}