refactor: rename to support attachments

Author: ClayChipps

src/commands/chipps/data/file/upload.ts

@@ -7,8 +7,8 @@
 
 import { Messages } from '@salesforce/core';
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
-import { uploadContentVersion } from '../../../../common/fileUtils.js';
-import { ContentVersion } from '../../../../common/typeDefs.js';
+import { uploadContentVersion } from '../../../../common/contentVersionUtils.js';
+import { ContentVersion } from '../../../../common/contentVersionTypes.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('sf-chipps-data', 'chipps.data.file.upload');

src/commands/chipps/data/files/upload.ts

@@ -11,8 +11,8 @@ import { createObjectCsvWriter } from 'csv-writer';
 import PQueue from 'p-queue';
 import { Messages } from '@salesforce/core';
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
-import { uploadContentVersion } from '../../../../common/fileUtils.js';
-import { FileToUpload } from '../../../../common/typeDefs.js';
+import { uploadContentVersion } from '../../../../common/contentVersionUtils.js';
+import { ContentVersionToUpload } from '../../../../common/contentVersionTypes.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('sf-chipps-data', 'chipps.data.files.upload');
@@ -89,19 +89,19 @@ export default class DataFilesUpload extends SfCommand<void> {
 
     for await (const record of parser) {
       void fileQueue.add(async () => {
-        const fileToUpload = record as FileToUpload;
+        const contentVersionToUpload = record as ContentVersionToUpload;
         try {
           const contentVersion = await uploadContentVersion(
             targetOrgConnection,
-            fileToUpload.PathOnClient,
-            fileToUpload.Title,
-            fileToUpload.FirstPublishLocationId
+            contentVersionToUpload.PathOnClient,
+            contentVersionToUpload.Title,
+            contentVersionToUpload.FirstPublishLocationId
           );
-          fileToUpload.ContentDocumentId = contentVersion.ContentDocumentId;
-          await successWriter.writeRecords([fileToUpload]);
+          contentVersionToUpload.ContentDocumentId = contentVersion.ContentDocumentId;
+          await successWriter.writeRecords([contentVersionToUpload]);
         } catch (error) {
-          fileToUpload.Error = error as string;
-          await errorWriter.writeRecords([fileToUpload]);
+          contentVersionToUpload.Error = error as string;
+          await errorWriter.writeRecords([contentVersionToUpload]);
         }
       });
     }

src/common/typeDefs.ts src/common/contentVersionTypes.tssrc/common/typeDefs.ts renamed to src/common/contentVersionTypes.ts

@@ -18,15 +18,15 @@ export interface ContentVersionCreateRequest {
   Title?: string;
 }
 
-export interface CreateResult {
+export interface ContentVersionCreateResult {
   id: string;
   success: boolean;
   errors: string[];
   name: string;
   message: string;
 }
 
-export type FileToUpload = {
+export type ContentVersionToUpload = {
   ContentDocumentId?: string;
   Error?: string;
   FirstPublishLocationId?: string;

src/common/fileUtils.ts src/common/contentVersionUtils.tssrc/common/fileUtils.ts renamed to src/common/contentVersionUtils.ts

@@ -10,7 +10,7 @@ import path from 'node:path';
 import FormData from 'form-data';
 import got from 'got';
 import { Connection } from '@salesforce/core';
-import { ContentVersionCreateRequest, ContentVersion, CreateResult } from './typeDefs.js';
+import { ContentVersionCreateRequest, ContentVersion, ContentVersionCreateResult } from './contentVersionTypes.js';
 
 export async function uploadContentVersion(
   targetOrgConnection: Connection,
@@ -31,7 +31,7 @@ export async function uploadContentVersion(
   form.append('entity_content', JSON.stringify(contentVersionCreateRequest), { contentType: 'application/json' });
   form.append('VersionData', fs.createReadStream(pathOnClient), { filename: path.basename(pathOnClient) });
 
-  const data: CreateResult = await got.post(`${targetOrgConnection.baseUrl()}/sobjects/ContentVersion`, {
+  const data: ContentVersionCreateResult = await got.post(`${targetOrgConnection.baseUrl()}/sobjects/ContentVersion`, {
     body: form,
     headers: {
       Authorization: `Bearer ${targetOrgConnection.accessToken}`,

test/commands/chipps/data/file/upload.nut.ts

@@ -9,7 +9,7 @@ import path from 'node:path';
 import { expect } from 'chai';
 import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
 import { Duration } from '@salesforce/kit';
-import { ContentVersion } from './../../../../../src/common/typeDefs.js';
+import { ContentVersion } from './../../../../../src/common/contentVersionTypes.js';
 
 describe('chipps data files upload', () => {
   let session: TestSession;

test/commands/chipps/data/files/upload.test.ts

@@ -12,7 +12,7 @@ import got from 'got';
 import { Connection, SfError } from '@salesforce/core';
 import { MockTestOrgData, TestContext } from '@salesforce/core/lib/testSetup.js';
 import DataFilesUpload from '../../../../../src/commands/chipps/data/files/upload.js';
-import { FileToUpload } from '../../../../../src/common/typeDefs.js';
+import { ContentVersionToUpload } from '../../../../../src/common/contentVersionTypes.js';
 
 describe('chipps data files upload', () => {
   const $$ = new TestContext();
@@ -54,8 +54,11 @@ describe('chipps data files upload', () => {
       testOrg.username,
     ]);
 
-    const errorResults = parse(fs.readFileSync('error.csv'), { bom: true, columns: true }) as FileToUpload[];
-    const successResults = parse(fs.readFileSync('success.csv'), { bom: true, columns: true }) as FileToUpload[];
+    const errorResults = parse(fs.readFileSync('error.csv'), { bom: true, columns: true }) as ContentVersionToUpload[];
+    const successResults = parse(fs.readFileSync('success.csv'), {
+      bom: true,
+      columns: true,
+    }) as ContentVersionToUpload[];
 
     expect(errorResults[0].Error).to.contain('Error: ENOENT: no such file or directory');
     expect(successResults).to.deep.equal([