@oneblink/storage 2.1.2 → 2.2.0-beta.1

package/dist/types.d.ts

@@ -35,7 +35,7 @@ export type UploadFormSubmissionOptions = UploadOptions & {
     /** The device the form is being submitted */
     device?: SubmissionTypes.NewS3SubmissionData['device'];
     /** The identifier for the forms app that is being submitted from */
-    formsAppId: number;
+    formsAppId?: number;
     /** An encrypted token that represents the user */
     userToken?: string;
     /** The external identifier that represents the submission */

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import { PutObjectCommandInput } from '@aws-sdk/client-s3'\nimport { 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 a Bearer token. If the\n   * promise resolves to a truthy value, the `authorization` header will be set\n   * with the value.\n   */\n  getBearerToken: () => Promise<string | undefined>\n}\n\nexport type DownloadOptions = {\n  /** An optional AbortSignal that can be used to abort the upload */\n  abortSignal?: AbortSignal\n}\n\nexport type UploadOptions = DownloadOptions & {\n  /** An optional progress listener for tracking the progress of the upload */\n  onProgress?: ProgressListener\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 represents 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  /** 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}\n\nexport type UploadAssetOptions = UploadOptions & {\n  /** The file data to upload */\n  data: AttachmentUploadData\n  /** A standard MIME type describing the format of the contents */\n  contentType: string\n  /** The name of the file being uploaded */\n  fileName: string\n}\n\nexport type UploadPDFConversionOptions = UploadOptions & {\n  /** The PDF File to upload */\n  data: AttachmentUploadData\n  /** The id of the Form that the PDF Conversion is occurring on */\n  formId: number\n}\n\nexport type UploadEmailAttachmentOptions = UploadAssetOptions\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import { PutObjectCommandInput } from '@aws-sdk/client-s3'\nimport { 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 a Bearer token. If the\n   * promise resolves to a truthy value, the `authorization` header will be set\n   * with the value.\n   */\n  getBearerToken: () => Promise<string | undefined>\n}\n\nexport type DownloadOptions = {\n  /** An optional AbortSignal that can be used to abort the upload */\n  abortSignal?: AbortSignal\n}\n\nexport type UploadOptions = DownloadOptions & {\n  /** An optional progress listener for tracking the progress of the upload */\n  onProgress?: ProgressListener\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 represents 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  /** 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}\n\nexport type UploadAssetOptions = UploadOptions & {\n  /** The file data to upload */\n  data: AttachmentUploadData\n  /** A standard MIME type describing the format of the contents */\n  contentType: string\n  /** The name of the file being uploaded */\n  fileName: string\n}\n\nexport type UploadPDFConversionOptions = UploadOptions & {\n  /** The PDF File to upload */\n  data: AttachmentUploadData\n  /** The id of the Form that the PDF Conversion is occurring on */\n  formId: number\n}\n\nexport type UploadEmailAttachmentOptions = UploadAssetOptions\n"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oneblink/storage",
   "description": "SDK for managing storage files in the OneBlink ecosystem",
-  "version": "2.1.2",
+  "version": "2.2.0-beta.1",
   "author": "OneBlink <developers@oneblink.io> (https://oneblink.io)",
   "bugs": {
     "url": "https://github.com/oneblink/storage/issues"