@dbos-inc/aws-s3-workflows 3.0.29-preview → 3.0.38-preview

package/knexfile.ts

@@ -1,17 +1,16 @@
 import { Knex } from 'knex';
 import { parseConfigFile } from '@dbos-inc/dbos-sdk';
-import { DBOSConfig } from '@dbos-inc/dbos-sdk';
 
-const [dbosConfig]: [DBOSConfig, unknown] = parseConfigFile();
+const [dbosConfig] = parseConfigFile();
 
 const config: Knex.Config = {
   client: 'pg',
   connection: {
-    host: dbosConfig.poolConfig!.host,
-    user: dbosConfig.poolConfig!.user,
-    password: dbosConfig.poolConfig!.password,
-    database: dbosConfig.poolConfig!.database,
-    ssl: dbosConfig.poolConfig!.ssl,
+    host: dbosConfig.poolConfig.host,
+    user: dbosConfig.poolConfig.user,
+    password: dbosConfig.poolConfig.password,
+    database: dbosConfig.poolConfig.database,
+    ssl: dbosConfig.poolConfig.ssl,
   },
   migrations: {
     directory: './migrations',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbos-inc/aws-s3-workflows",
-  "version": "3.0.29-preview",
+  "version": "3.0.38-preview",
   "description": "Component library - DBOS S3 steps and workflows",
   "license": "MIT",
   "repository": {

package/src/s3_utils.test.ts

@@ -196,9 +196,9 @@ const s3callback: S3WorkflowCallbacks<UserFile, Opts> = {
   },
 };
 
-export const uploadWF = registerS3UploadWorkflow({ className: 'UserFile', name: 'uploadWF' }, s3callback);
-export const uploadPWF = registerS3PresignedUploadWorkflow({ className: 'UserFile', name: 'uploadPWF' }, s3callback);
-export const deleteWF = registerS3DeleteWorkflow({ className: 'UserFile', name: 'deleteWF' }, s3callback);
+export const uploadWF = registerS3UploadWorkflow(s3callback, { className: 'UserFile', name: 'uploadWF' });
+export const uploadPWF = registerS3PresignedUploadWorkflow(s3callback, { className: 'UserFile', name: 'uploadPWF' });
+export const deleteWF = registerS3DeleteWorkflow(s3callback, { className: 'UserFile', name: 'deleteWF' });
 
 describe('ses-tests', () => {
   let s3IsAvailable = true;

package/src/s3_utils.ts

@@ -1,6 +1,6 @@
 import { type PresignedPost } from '@aws-sdk/s3-presigned-post';
 
-import { DBOS, WorkflowConfig } from '@dbos-inc/dbos-sdk';
+import { DBOS, FunctionName, WorkflowConfig } from '@dbos-inc/dbos-sdk';
 
 export interface FileRecord {
   key: string;
@@ -30,17 +30,12 @@ export interface S3WorkflowCallbacks<R extends FileRecord, Options = unknown> {
 
 /**
  * Create a workflow function for deleting S3 objects and removing the DB entry
- * @param options - Registration options for the workflow
  * @param callbacks - S3 operation implementation and database recordkeeping transactions
+ * @param config - Workflow configuration and target function name for registration
  */
 export function registerS3DeleteWorkflow<R extends FileRecord, Options = unknown>(
-  options: {
-    name?: string;
-    ctorOrProto?: object;
-    className?: string;
-    config?: WorkflowConfig;
-  },
   callbacks: S3WorkflowCallbacks<R, Options>,
+  config?: WorkflowConfig & FunctionName,
 ) {
   return DBOS.registerWorkflow(async (fileDetails: R) => {
     await callbacks.fileDeleted(fileDetails);
@@ -50,22 +45,17 @@ export function registerS3DeleteWorkflow<R extends FileRecord, Options = unknown
       },
       { name: 'deleteS3Object' },
     );
-  }, options);
+  }, config);
 }
 
 /**
  * Create a workflow function for uploading S3 contents from DBOS
- * @param options - Registration options for the workflow
  * @param callbacks - S3 operation implementation and database recordkeeping transactions
+ * @param config - Workflow configuration and target function name for registration
  */
 export function registerS3UploadWorkflow<R extends FileRecord, Options = unknown>(
-  options: {
-    name?: string;
-    ctorOrProto?: object;
-    className?: string;
-    config?: WorkflowConfig;
-  },
   callbacks: S3WorkflowCallbacks<R, Options>,
+  config?: WorkflowConfig & FunctionName,
 ) {
   return DBOS.registerWorkflow(async (fileDetails: R, content: string, objOptions?: Options) => {
     try {
@@ -91,22 +81,17 @@ export function registerS3UploadWorkflow<R extends FileRecord, Options = unknown
 
     await callbacks.newActiveFile(fileDetails);
     return fileDetails;
-  }, options);
+  }, config);
 }
 
 /**
  * Create a workflow function for uploading S3 contents externally, via a presigned URL
- * @param options - Registration options for the workflow
  * @param callbacks - S3 operation implementation and database recordkeeping transactions
+ * @param config - Workflow configuration and target function name for registration
  */
 export function registerS3PresignedUploadWorkflow<R extends FileRecord, Options = unknown>(
-  options: {
-    name?: string;
-    ctorOrProto?: object;
-    className?: string;
-    config?: WorkflowConfig;
-  },
   callbacks: S3WorkflowCallbacks<R, Options>,
+  config?: WorkflowConfig & FunctionName,
 ) {
   return DBOS.registerWorkflow(async (fileDetails: R, timeoutSeconds: number, objOptions?: Options) => {
     await callbacks.newPendingFile(fileDetails);
@@ -153,5 +138,5 @@ export function registerS3PresignedUploadWorkflow<R extends FileRecord, Options
     }
 
     return fileDetails;
-  }, options);
+  }, config);
 }