Add new copy/move options

FlowPluginsTs/CommunityFlowPlugins/file/copyToDirectory/1.0.0/index.ts

@@ -1,10 +1,11 @@
 import { promises as fs } from 'fs';
-import { getContainer, getFileName } from '../../../../FlowHelpers/1.0.0/fileUtils';
+import { getContainer, getFileName, getSubStem } from '../../../../FlowHelpers/1.0.0/fileUtils';
 import {
   IpluginDetails,
   IpluginInputArgs,
   IpluginOutputArgs,
 } from '../../../../FlowHelpers/1.0.0/interfaces/interfaces';
+import normJoinPath from '../../../../FlowHelpers/1.0.0/normJoinPath';
 
 /* eslint no-plusplus: ["error", { "allowForLoopAfterthoughts": true }] */
 const details = (): IpluginDetails => ({
@@ -24,16 +25,42 @@ const details = (): IpluginDetails => ({
       type: 'string',
       defaultValue: '',
       inputUI: {
-        type: 'text',
+        type: 'directory',
       },
       tooltip: 'Specify ouput directory',
     },
+    {
+      name: 'keepRelativePath',
+      type: 'boolean',
+      defaultValue: 'false',
+      inputUI: {
+        type: 'text',
+        options: [
+          'false',
+          'true',
+        ],
+      },
+      tooltip: 'Specify whether to keep the relative path',
+    },
+    {
+      name: 'copyToWorkDir',
+      type: 'boolean',
+      defaultValue: 'false',
+      inputUI: {
+        type: 'text',
+        options: [
+          'false',
+          'true',
+        ],
+      },
+      tooltip: 'Specify whether to copy to the working directory',
+    },
     {
       name: 'makeWorkingFile',
       type: 'boolean',
       defaultValue: 'false',
       inputUI: {
-        type: 'text',
+        type: 'dropdown',
         options: [
           'false',
           'true',
@@ -56,19 +83,57 @@ const plugin = async (args: IpluginInputArgs): Promise<IpluginOutputArgs> => {
   // eslint-disable-next-line @typescript-eslint/no-unused-vars,no-param-reassign
   args.inputs = lib.loadDefaultValues(args.inputs, details);
 
+  const {
+    copyToWorkDir, keepRelativePath, makeWorkingFile,
+  } = args.inputs;
+
+  const outputDirectory = String(args.inputs.outputDirectory);
+
   const originalFileName = getFileName(args.originalLibraryFile._id);
   const newContainer = getContainer(args.inputFileObj._id);
 
-  const outputPath = `${args.inputs.outputDirectory}/${originalFileName}.${newContainer}`;
+  let outputPath = '';
 
-  await fs.copyFile(args.inputFileObj._id, outputPath);
+  if (copyToWorkDir) {
+    outputPath = args.workDir;
+  } else if (keepRelativePath) {
+    const subStem = getSubStem({
+      inputPathStem: args.librarySettings.folder,
+      inputPath: args.originalLibraryFile._id,
+    });
+
+    outputPath = normJoinPath({
+      upath: args.deps.upath,
+      paths: [
+        outputDirectory,
+        subStem,
+      ],
+    });
+  } else {
+    outputPath = outputDirectory;
+  }
+
+  const ouputFilePath = normJoinPath({
+    upath: args.deps.upath,
+    paths: [
+      outputPath,
+      `${originalFileName}.${newContainer}`,
+    ],
+  });
 
   let workingFile = args.inputFileObj._id;
 
-  if (args.inputs.makeWorkingFile) {
-    workingFile = outputPath;
+  if (makeWorkingFile || copyToWorkDir) {
+    workingFile = ouputFilePath;
   }
 
+  args.jobLog(`Input path: ${args.inputFileObj._id}`);
+  args.jobLog(`Output path: ${outputPath}`);
+
+  args.deps.fsextra.ensureDirSync(outputPath);
+
+  await fs.copyFile(args.inputFileObj._id, ouputFilePath);
+
   return {
     outputFileObj: {
       _id: workingFile,

FlowPluginsTs/CommunityFlowPlugins/file/moveToDirectory/2.0.0/index.ts

@@ -1,10 +1,11 @@
 import { promises as fs } from 'fs';
-import { getContainer, getFileName } from '../../../../FlowHelpers/1.0.0/fileUtils';
+import { getContainer, getFileName, getSubStem } from '../../../../FlowHelpers/1.0.0/fileUtils';
 import {
   IpluginDetails,
   IpluginInputArgs,
   IpluginOutputArgs,
 } from '../../../../FlowHelpers/1.0.0/interfaces/interfaces';
+import normJoinPath from '../../../../FlowHelpers/1.0.0/normJoinPath';
 
 /* eslint no-plusplus: ["error", { "allowForLoopAfterthoughts": true }] */
 const details = ():IpluginDetails => ({
@@ -24,10 +25,23 @@ const details = ():IpluginDetails => ({
       type: 'string',
       defaultValue: '',
       inputUI: {
-        type: 'text',
+        type: 'directory',
       },
       tooltip: 'Specify ouput directory',
     },
+    {
+      name: 'keepRelativePath',
+      type: 'boolean',
+      defaultValue: 'false',
+      inputUI: {
+        type: 'text',
+        options: [
+          'false',
+          'true',
+        ],
+      },
+      tooltip: 'Specify whether to keep the relative path',
+    },
   ],
   outputs: [
     {
@@ -43,16 +57,51 @@ const plugin = async (args:IpluginInputArgs):Promise<IpluginOutputArgs> => {
   // eslint-disable-next-line @typescript-eslint/no-unused-vars,no-param-reassign
   args.inputs = lib.loadDefaultValues(args.inputs, details);
 
+  const {
+    keepRelativePath,
+  } = args.inputs;
+
+  const outputDirectory = String(args.inputs.outputDirectory);
+
   const originalFileName = getFileName(args.originalLibraryFile._id);
   const newContainer = getContainer(args.inputFileObj._id);
 
-  const outputPath = `${args.inputs.outputDirectory}/${originalFileName}.${newContainer}`;
+  let outputPath = '';
 
-  await fs.rename(args.inputFileObj._id, outputPath);
+  if (keepRelativePath) {
+    const subStem = getSubStem({
+      inputPathStem: args.librarySettings.folder,
+      inputPath: args.originalLibraryFile._id,
+    });
+
+    outputPath = normJoinPath({
+      upath: args.deps.upath,
+      paths: [
+        outputDirectory,
+        subStem,
+      ],
+    });
+  } else {
+    outputPath = outputDirectory;
+  }
+
+  const ouputFilePath = normJoinPath({
+    upath: args.deps.upath,
+    paths: [
+      outputPath,
+      `${originalFileName}.${newContainer}`,
+    ],
+  });
+
+  args.jobLog(`Input path: ${args.inputFileObj._id}`);
+  args.jobLog(`Output path: ${ouputFilePath}`);
+
+  args.deps.fsextra.ensureDirSync(outputPath);
+  await fs.rename(args.inputFileObj._id, ouputFilePath);
 
   return {
     outputFileObj: {
-      _id: outputPath,
+      _id: ouputFilePath,
     },
     outputNumber: 1,
     variables: args.variables,

FlowPluginsTs/FlowHelpers/1.0.0/fileUtils.ts

@@ -7,7 +7,22 @@ export const getFileName = (filePath: string):string => {
   const parts = filePath.split('/');
   const fileNameAndContainer = parts[parts.length - 1];
   const parts2 = fileNameAndContainer.split('.');
-  return parts2[0];
+  parts2.pop();
+  return parts2.join('.');
 };
 
 export const getFfType = (codecType:string):string => (codecType === 'video' ? 'v' : 'a');
+
+export const getSubStem = ({
+  inputPathStem,
+  inputPath,
+}: {
+  inputPathStem: string,
+  inputPath: string,
+}):string => {
+  const subStem = inputPath.substring(inputPathStem.length);
+  const parts = subStem.split('/');
+  parts.pop();
+
+  return parts.join('/');
+};

FlowPluginsTs/FlowHelpers/1.0.0/interfaces/interfaces.ts

@@ -2,7 +2,7 @@ import { IFileObject, Istreams } from './synced/IFileObject';
 import Ijob from './synced/jobInterface';
 
 export interface IpluginInputUi {
-    type: 'dropdown' | 'text' | 'textarea',
+    type: 'dropdown' | 'text' | 'textarea' | 'directory',
     options?: string[],
     style?:Record<string, unknown>,
     onSelect?: {
@@ -115,5 +115,7 @@ export interface IpluginInputArgs {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         axiosMiddleware: (endpoint: string, data: Record<string, unknown>) => Promise<any>,
         requireFromString: (pluginText: string, relativePath:string) => Record<string, unknown>,
+           // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        upath:any,
     },
 }

FlowPluginsTs/FlowHelpers/1.0.0/normJoinPath.ts

@@ -0,0 +1,28 @@
+const formatWindowsRootFolder = (path: string): string => {
+  // Remove '.' from end of Windows root folder mapping e.g. 'E:.'
+  if (
+    path.length === 3
+    && path.charAt(1) === ':'
+    && path.charAt(2) === '.'
+  ) {
+    // eslint-disable-next-line no-param-reassign
+    path = path.slice(0, -1);
+  }
+
+  return path;
+};
+
+const normJoinPath = ({
+  upath,
+  paths,
+}:{
+     // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  upath: any,
+  paths: string[]
+}):string => {
+  let path = upath.joinSafe(...paths);
+  path = formatWindowsRootFolder(path);
+  return path;
+};
+
+export default normJoinPath;