guratan 0.5.2 → 0.7.0

package/dist/cli.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
-import { Writable } from 'stream';
+import { Readable, Writable } from 'stream';
 declare type Opts = {
+    stdin: Readable;
     stdout: Writable;
     stderr: Writable;
 };
@@ -11,6 +12,7 @@ declare type OptsSend = Opts & {
     srcFileName: string;
     destMimeType: string;
     srcMimeType: string;
+    pipe: boolean;
     printId: boolean;
 };
 declare type OptsRecv = Opts & {
@@ -19,6 +21,8 @@ declare type OptsRecv = Opts & {
     srcFileName: string;
     destFileName: string;
     destMimeType: string;
+    pipe: boolean;
+    removeBom: boolean;
     printId: boolean;
 };
 declare type OptsShare = Opts & {
@@ -37,7 +41,7 @@ declare type OptsShare = Opts & {
     emailMessage: string;
     printId: boolean;
 };
-export declare const cliSend: ({ fileId, parentId, destFileName, srcFileName, destMimeType, srcMimeType, printId, stdout, stderr }: OptsSend) => Promise<number>;
-export declare const cliRecv: ({ fileId, parentId, srcFileName, destFileName, destMimeType, printId, stdout, stderr }: OptsRecv) => Promise<number>;
+export declare const cliSend: ({ fileId, parentId, destFileName, srcFileName, destMimeType, srcMimeType, pipe, printId, stdin, stdout, stderr }: OptsSend) => Promise<number>;
+export declare const cliRecv: ({ fileId, parentId, srcFileName, destFileName, destMimeType, printId, pipe, removeBom, stdout, stderr }: OptsRecv) => Promise<number>;
 export declare const cliShare: ({ fileId, parentId, destFileName, type, role, emailAddress, domain, allowFileDiscovery, view, moveToNewOwnersRoot, transferOwnership, sendNotificationEmail, emailMessage, printId, stdout, stderr }: OptsShare) => Promise<number>;
 export {};

package/dist/cli.js

@@ -1,5 +1,5 @@
 import { driveClient } from './tdrive.js';
-export const cliSend = async ({ fileId, parentId, destFileName, srcFileName, destMimeType, srcMimeType, printId, stdout, stderr }) => {
+export const cliSend = async ({ fileId, parentId, destFileName, srcFileName, destMimeType, srcMimeType, pipe, printId, stdin, stdout, stderr }) => {
     try {
         const { sendFile } = await import('./tsend.js');
         const id = await sendFile(driveClient(), {
@@ -8,7 +8,8 @@ export const cliSend = async ({ fileId, parentId, destFileName, srcFileName, des
             destFileName,
             srcFileName,
             destMimeType,
-            srcMimeType
+            srcMimeType,
+            srcStream: pipe ? stdin : undefined
         });
         if (printId) {
             stdout.write(id);
@@ -21,7 +22,7 @@ export const cliSend = async ({ fileId, parentId, destFileName, srcFileName, des
     }
     return 0;
 };
-export const cliRecv = async ({ fileId, parentId, srcFileName, destFileName, destMimeType, printId, stdout, stderr }) => {
+export const cliRecv = async ({ fileId, parentId, srcFileName, destFileName, destMimeType, printId, pipe, removeBom, stdout, stderr }) => {
     try {
         const { recvFile } = await import('./trecv.js');
         const id = await recvFile(driveClient(), {
@@ -29,9 +30,11 @@ export const cliRecv = async ({ fileId, parentId, srcFileName, destFileName, des
             parentId,
             srcFileName,
             destFileName,
-            destMimeType
+            destMimeType,
+            removeBom,
+            destStream: pipe ? stdout : undefined
         });
-        if (printId) {
+        if (printId && !pipe) {
             stdout.write(id);
         }
     }

package/dist/main.js

@@ -28,7 +28,8 @@ const argv = await yargs(hideBin(process.argv))
         },
         'src-file-name': {
             type: 'string',
-            required: true,
+            default: '',
+            required: false,
             description: 'The name(path) of the file in local filesystem'
         },
         'dest-mime-type': {
@@ -43,6 +44,12 @@ const argv = await yargs(hideBin(process.argv))
             default: '',
             description: 'Media mime-type'
         },
+        pipe: {
+            type: 'boolean',
+            required: false,
+            default: false,
+            description: 'Use stdin instead of the source file'
+        },
         'print-id': {
             type: 'boolean',
             required: false,
@@ -82,6 +89,18 @@ const argv = await yargs(hideBin(process.argv))
             default: '',
             description: 'Media mime-type'
         },
+        pipe: {
+            type: 'boolean',
+            required: false,
+            default: false,
+            description: 'Use stdout instead of the dest file'
+        },
+        'remove-bom': {
+            type: 'boolean',
+            required: false,
+            default: false,
+            description: 'Remove BOM chars in receiving content'
+        },
         'print-id': {
             type: 'boolean',
             required: false,
@@ -186,7 +205,9 @@ switch (`${argv._[0]}`) {
             srcFileName: argv['src-file-name'] || '',
             destMimeType: argv['dest-mime-type'] || '',
             srcMimeType: argv['src-mime-type'] || '',
+            pipe: argv['pipe'] || false,
             printId: argv['print-id'] || false,
+            stdin: process.stdin,
             stdout: process.stdout,
             stderr: process.stderr
         }));
@@ -198,7 +219,10 @@ switch (`${argv._[0]}`) {
             srcFileName: argv['src-file-name'] || '',
             destFileName: argv['dest-file-name'] || '',
             destMimeType: argv['dest-mime-type'] || '',
+            pipe: argv['pipe'] || false,
+            removeBom: argv['remove-bom'] || false,
             printId: argv['print-id'] || false,
+            stdin: process.stdin,
             stdout: process.stdout,
             stderr: process.stderr
         }));
@@ -219,6 +243,7 @@ switch (`${argv._[0]}`) {
             sendNotificationEmail: argv['send-notification-email'],
             printId: argv['print-id'] || false,
             emailMessage: argv['email-message'],
+            stdin: process.stdin,
             stdout: process.stdout,
             stderr: process.stderr
         }));

package/dist/tdrive.js

@@ -56,7 +56,7 @@ export function validateQueryValue(s) {
  * @returns instance of drive.
  */
 export function driveClient() {
-    const SCOPES = ['https://www.googleapis.com/auth/drive.file'];
+    const SCOPES = ['https://www.googleapis.com/auth/drive'];
     const auth = new GoogleAuth({
         scopes: SCOPES
     });

package/dist/trecv.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+import { Writable } from 'stream';
 import { drive_v3 } from '@googleapis/drive';
 export declare class DownloadFileError extends Error {
     constructor(message: string);
@@ -27,6 +29,14 @@ export declare type RecvFileOpts = {
      * @type Media mime-type.
      */
     destMimeType: string;
+    /**
+     * @type Remove BOM chars in receiving content.
+     */
+    removeBom?: boolean;
+    /**
+     * @type The dest content from stream. It passed by pipe option.
+     */
+    destStream?: Writable;
 };
 /**
  * Download the file from Google Drive to the locale file
@@ -34,7 +44,7 @@ export declare type RecvFileOpts = {
  * @param opts - options.
  * @returns
  */
-export declare function downloadFile(drive: drive_v3.Drive, opts: Pick<RecvFileOpts, 'fileId' | 'destFileName' | 'destMimeType'>): Promise<void>;
+export declare function downloadFile(drive: drive_v3.Drive, opts: Pick<RecvFileOpts, 'fileId' | 'destFileName' | 'destMimeType' | 'removeBom' | 'destStream'>): Promise<void>;
 /**
  * Receive the file from Google Drive to the locale file
  * @param drive - drive instance.

package/dist/trecv.js

@@ -1,6 +1,9 @@
 import * as fs from 'fs';
+import { pipeline } from 'stream';
 import { promisify } from 'util';
+import stripBomStream from 'strip-bom-stream';
 import { getFileId, GetFileIdError } from './tdrive.js';
+const promisePipeline = promisify(pipeline);
 export class DownloadFileError extends Error {
     constructor(message) {
         //https://stackoverflow.com/questions/41102060/typescript-extending-error-class
@@ -15,10 +18,10 @@ export class DownloadFileError extends Error {
  * @returns
  */
 export async function downloadFile(drive, opts) {
-    let ret;
+    let ret = undefined;
     try {
-        const { fileId, destFileName, destMimeType } = opts;
-        const dest = fs.createWriteStream(destFileName);
+        const { fileId, destFileName, destMimeType, destStream, removeBom } = opts;
+        let dest = destStream ? destStream : fs.createWriteStream(destFileName);
         try {
             if (destMimeType) {
                 const params = {
@@ -26,8 +29,11 @@ export async function downloadFile(drive, opts) {
                     mimeType: destMimeType
                 };
                 const res = await drive.files.export(params, { responseType: 'stream' });
-                for await (const c of res.data) {
-                    dest.write(c);
+                if (removeBom) {
+                    await promisePipeline(res.data, stripBomStream(), dest);
+                }
+                else {
+                    await promisePipeline(res.data, dest);
                 }
             }
             else {
@@ -36,9 +42,7 @@ export async function downloadFile(drive, opts) {
                     alt: 'media'
                 };
                 const res = await drive.files.get(params, { responseType: 'stream' });
-                for await (const c of res.data) {
-                    dest.write(c);
-                }
+                await promisePipeline(res.data, dest);
             }
         }
         catch (err) {
@@ -52,7 +56,9 @@ export async function downloadFile(drive, opts) {
         }
         finally {
             // return promisify(dest.close.bind(dest))()  ここで return すると常に undfeind になる
-            ret = promisify(dest.close.bind(dest))();
+            if (dest.close) {
+                ret = promisify(dest.close.bind(dest))();
+            }
         }
     }
     catch (err) {
@@ -67,13 +73,22 @@ export async function downloadFile(drive, opts) {
  * @returns id of file in Google Drive
  */
 export async function recvFile(drive, opts) {
-    const { fileId: inFileId, parentId, srcFileName, destFileName, destMimeType } = opts;
+    const { fileId: inFileId, parentId, srcFileName, destFileName, destMimeType, removeBom, destStream } = opts;
+    if (destFileName === '' && destStream === undefined) {
+        throw new Error('The destination is not specified');
+    }
     let fileId = inFileId !== '' ? inFileId : await getFileId(drive, parentId, srcFileName);
     if (fileId === '') {
         throw new GetFileIdError(
         // `The srouce file not found in paretnt id : ${srcFileName}, ${parentId}`
         `The srouce file not found`);
     }
-    await downloadFile(drive, { fileId, destFileName, destMimeType });
+    await downloadFile(drive, {
+        fileId,
+        destFileName,
+        destMimeType,
+        removeBom,
+        destStream
+    });
     return fileId;
 }

package/dist/tsend.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+import { Readable } from 'stream';
 import { drive_v3 } from '@googleapis/drive';
 export declare class UploadFileError extends Error {
     constructor(message: string);
@@ -34,6 +36,10 @@ export declare type SendFileOpts = {
      * @type Media mime-type.
      */
     srcMimeType: string;
+    /**
+     * @type The srouce content from stream. It passed by pipe option.
+     */
+    srcStream?: Readable;
 };
 /**
  * Create file using by source file into Google Drive.
@@ -41,7 +47,7 @@ export declare type SendFileOpts = {
  * @param opts - options.
  * @returns Print the id of the file that is sended into remote
  */
-export declare function uploadFile(drive: drive_v3.Drive, opts: Pick<SendFileOpts, 'parentId' | 'destFileName' | 'srcFileName' | 'destMimeType' | 'srcMimeType'>): Promise<string>;
+export declare function uploadFile(drive: drive_v3.Drive, opts: Pick<SendFileOpts, 'parentId' | 'destFileName' | 'srcFileName' | 'destMimeType' | 'srcMimeType' | 'srcStream'>): Promise<string>;
 /**
  * Update file using by source file into Google Drive.
  * @param drive - drive instance.
@@ -50,7 +56,7 @@ export declare function uploadFile(drive: drive_v3.Drive, opts: Pick<SendFileOpt
  */
 export declare function updateFile(drive: drive_v3.Drive, opts: {
     fileId: string;
-} & Pick<SendFileOpts, 'srcFileName' | 'destMimeType' | 'srcMimeType'>): Promise<string>;
+} & Pick<SendFileOpts, 'srcFileName' | 'destMimeType' | 'srcMimeType' | 'srcStream'>): Promise<string>;
 /**
  * Send file using by source file into Google Drive.
  * @param drive - drive instance.

package/dist/tsend.js

@@ -1,6 +1,5 @@
 import * as path from 'path';
 import * as fs from 'fs';
-import { promisify } from 'util';
 import { getFileId } from './tdrive.js';
 export class UploadFileError extends Error {
     constructor(message) {
@@ -23,41 +22,30 @@ export class UpdateFileError extends Error {
  * @returns Print the id of the file that is sended into remote
  */
 export async function uploadFile(drive, opts) {
-    let ret = '';
     try {
-        const { parentId, destFileName, srcFileName, destMimeType, srcMimeType } = opts;
-        const srcStream = fs.createReadStream(srcFileName);
-        try {
-            const params = {
-                requestBody: {
-                    name: path.basename(destFileName),
-                    parents: [parentId]
-                },
-                media: {
-                    body: srcStream
-                },
-                fields: 'id'
-            };
-            if (destMimeType) {
-                params.requestBody.mimeType = destMimeType;
-            }
-            if (srcMimeType) {
-                params.media.mimeType = srcMimeType;
-            }
-            const res = await drive.files.create(params);
-            ret = res.data.id || '';
+        const { parentId, destFileName, srcFileName, destMimeType, srcMimeType, srcStream } = opts;
+        const params = {
+            requestBody: {
+                name: path.basename(destFileName),
+                parents: [parentId]
+            },
+            media: {
+                body: srcStream ? srcStream : fs.createReadStream(srcFileName)
+            },
+            fields: 'id'
+        };
+        if (destMimeType) {
+            params.requestBody.mimeType = destMimeType;
         }
-        catch (err) {
-            throw new UploadFileError(JSON.stringify(err.errors));
-        }
-        finally {
-            await promisify(srcStream.close.bind(srcStream))();
+        if (srcMimeType) {
+            params.media.mimeType = srcMimeType;
         }
+        const res = await drive.files.create(params);
+        return res.data.id || '';
     }
     catch (err) {
-        throw err;
+        throw new UploadFileError(JSON.stringify(err.errors));
     }
-    return ret;
 }
 /**
  * Update file using by source file into Google Drive.
@@ -66,39 +54,28 @@ export async function uploadFile(drive, opts) {
  * @returns id of file in Google Drive
  */
 export async function updateFile(drive, opts) {
-    let ret = '';
     try {
-        const { fileId, srcFileName, destMimeType, srcMimeType } = opts;
-        const srcStream = fs.createReadStream(srcFileName);
-        try {
-            const params = {
-                fileId,
-                requestBody: {},
-                media: {
-                    body: srcStream
-                },
-                fields: 'id'
-            };
-            if (destMimeType) {
-                params.requestBody.mimeType = destMimeType;
-            }
-            if (srcMimeType) {
-                params.media.mimeType = srcMimeType;
-            }
-            const res = await drive.files.update(params);
-            ret = res.data.id || '';
-        }
-        catch (err) {
-            throw new UpdateFileError(JSON.stringify(err.errors));
+        const { fileId, srcFileName, destMimeType, srcMimeType, srcStream } = opts;
+        const params = {
+            fileId,
+            requestBody: {},
+            media: {
+                body: srcStream ? srcStream : fs.createReadStream(srcFileName)
+            },
+            fields: 'id'
+        };
+        if (destMimeType) {
+            params.requestBody.mimeType = destMimeType;
         }
-        finally {
-            await promisify(srcStream.close.bind(srcStream))();
+        if (srcMimeType) {
+            params.media.mimeType = srcMimeType;
         }
+        const res = await drive.files.update(params);
+        return res.data.id || '';
     }
     catch (err) {
-        throw err;
+        throw new UpdateFileError(JSON.stringify(err.errors));
     }
-    return ret;
 }
 /**
  * Send file using by source file into Google Drive.
@@ -107,7 +84,10 @@ export async function updateFile(drive, opts) {
  * @returns id of file in Google Drive
  */
 export async function sendFile(drive, opts) {
-    const { fileId: inFileId, parentId, destFileName, srcFileName, destMimeType, srcMimeType } = opts;
+    const { fileId: inFileId, parentId, destFileName, srcFileName, destMimeType, srcMimeType, srcStream } = opts;
+    if (srcFileName === '' && srcStream === undefined) {
+        throw new Error('The source content is not specified');
+    }
     let fileId = inFileId !== '' ? inFileId : await getFileId(drive, parentId, destFileName);
     if (fileId === '') {
         return uploadFile(drive, {
@@ -115,8 +95,15 @@ export async function sendFile(drive, opts) {
             destFileName,
             srcFileName,
             destMimeType,
-            srcMimeType
+            srcMimeType,
+            srcStream
         });
     }
-    return updateFile(drive, { fileId, srcFileName, destMimeType, srcMimeType });
+    return updateFile(drive, {
+        fileId,
+        srcFileName,
+        destMimeType,
+        srcMimeType,
+        srcStream
+    });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "guratan",
-  "version": "0.5.2",
+  "version": "0.7.0",
   "description": "Tiny send tool for Google Drive",
   "author": "hankei6km <hankei6km@gmail.com> (https://github.com/hankei6km)",
   "license": "MIT",
@@ -35,6 +35,7 @@
   },
   "dependencies": {
     "@googleapis/drive": "^2.3.0",
+    "strip-bom-stream": "^5.0.0",
     "yargs": "^17.3.1"
   },
   "devDependencies": {