guratan 0.4.0 → 0.5.2

package/README.md

@@ -1,6 +1,6 @@
 # guratan
 
-Google Drive へファイルを送信する簡易ツール。
+Google Drive を操作する簡易ツール。
 
 ## Usage
 
@@ -17,6 +17,18 @@ $ GOOGLE_APPLICATION_CREDENTIALS=./gha-creds-temp.json npx guratan send --parent
 - 各オプションは環境変数での指定も可能(例. `--parent-id` = `GURATAN_PARENT_ID`)
 - `guratan` からは upload と update のみ可能
 
+### recv
+
+```
+$ GOOGLE_APPLICATION_CREDENTIALS=./gha-creds-temp.json npx guratan recv --parent-id 12345ABC --src-file-name test.txt --dest-file-name path/to/test.txt
+```
+
+- `GOOGLE_APPLICATION_CREDENTIALS` にはサービスアカウントの鍵ファイルを指定
+- 受信元フォルダー(`--parent-id`) のファイル(`--dest-file-name`)を受信する
+- 同名ファイルが複数ある場合は最初にヒットしたものを受信する
+- `--parent-id` `--src-file-name` の代わりに `--file-id` で受信ファイルを指定できる
+- 各オプションは環境変数での指定も可能(例. `--parent-id` = `GURATAN_PARENT_ID`)
+
 ### share
 
 ```

package/dist/cli.d.ts

@@ -13,6 +13,14 @@ declare type OptsSend = Opts & {
     srcMimeType: string;
     printId: boolean;
 };
+declare type OptsRecv = Opts & {
+    fileId: string;
+    parentId: string;
+    srcFileName: string;
+    destFileName: string;
+    destMimeType: string;
+    printId: boolean;
+};
 declare type OptsShare = Opts & {
     fileId: string;
     parentId: string;
@@ -30,5 +38,6 @@ declare type OptsShare = Opts & {
     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 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,8 +1,7 @@
 import { driveClient } from './tdrive.js';
-import { sendFile } from './tsend.js';
-import { createPermisson } from './tshare.js';
 export const cliSend = async ({ fileId, parentId, destFileName, srcFileName, destMimeType, srcMimeType, printId, stdout, stderr }) => {
     try {
+        const { sendFile } = await import('./tsend.js');
         const id = await sendFile(driveClient(), {
             fileId,
             parentId,
@@ -22,8 +21,30 @@ export const cliSend = async ({ fileId, parentId, destFileName, srcFileName, des
     }
     return 0;
 };
+export const cliRecv = async ({ fileId, parentId, srcFileName, destFileName, destMimeType, printId, stdout, stderr }) => {
+    try {
+        const { recvFile } = await import('./trecv.js');
+        const id = await recvFile(driveClient(), {
+            fileId,
+            parentId,
+            srcFileName,
+            destFileName,
+            destMimeType
+        });
+        if (printId) {
+            stdout.write(id);
+        }
+    }
+    catch (err) {
+        stderr.write(err.toString());
+        stderr.write('\n');
+        return 1;
+    }
+    return 0;
+};
 export const cliShare = async ({ fileId, parentId, destFileName, type, role, emailAddress, domain, allowFileDiscovery, view, moveToNewOwnersRoot, transferOwnership, sendNotificationEmail, emailMessage, printId, stdout, stderr }) => {
     try {
+        const { createPermisson } = await import('./tshare.js');
         const id = await createPermisson(driveClient(), {
             fileId,
             parentId,

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export { driveClient } from './tdrive.js';
 export { sendFile } from './tsend.js';
+export { recvFile } from './trecv.js';
 export { createPermisson } from './tshare.js';

package/dist/index.js

@@ -1,3 +1,4 @@
 export { driveClient } from './tdrive.js';
 export { sendFile } from './tsend.js';
+export { recvFile } from './trecv.js';
 export { createPermisson } from './tshare.js';

package/dist/main.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
-import { cliSend, cliShare } from './cli.js';
+import { cliRecv, cliSend, cliShare } from './cli.js';
 const envVarsPrefix = process.env['GURATAN_ENV_VARS_PREFIX'] || 'GURATAN';
 const argv = await yargs(hideBin(process.argv))
     .scriptName('guratan')
@@ -50,6 +50,45 @@ const argv = await yargs(hideBin(process.argv))
             description: 'Print the id of the file that is sended into remote'
         }
     });
+})
+    .command('recv [OPTIONS]', 'receive file from Google Drive to local file', (yargs) => {
+    return yargs.options({
+        'file-id': {
+            type: 'string',
+            default: '',
+            required: false,
+            description: 'The ID of the file or shared drive.'
+        },
+        'parent-id': {
+            type: 'string',
+            default: '',
+            required: false,
+            description: 'The IDs of the parent folders which contain the file.'
+        },
+        'src-file-name': {
+            type: 'string',
+            required: false,
+            description: 'The name of the file in remote'
+        },
+        'dest-file-name': {
+            type: 'string',
+            default: '',
+            required: true,
+            description: 'The name(path) of the file in local filesystem'
+        },
+        'dest-mime-type': {
+            type: 'string',
+            required: false,
+            default: '',
+            description: 'Media mime-type'
+        },
+        'print-id': {
+            type: 'boolean',
+            required: false,
+            default: false,
+            description: 'Print the id of the file that is received from remote'
+        }
+    });
 })
     .command('share [OPTIONS]', 'share file in Google Drive', (yargs) => {
     return yargs.options({
@@ -152,6 +191,18 @@ switch (`${argv._[0]}`) {
             stderr: process.stderr
         }));
         break;
+    case 'recv':
+        process.exit(await cliRecv({
+            fileId: argv['file-id'],
+            parentId: argv['parent-id'] || '',
+            srcFileName: argv['src-file-name'] || '',
+            destFileName: argv['dest-file-name'] || '',
+            destMimeType: argv['dest-mime-type'] || '',
+            printId: argv['print-id'] || false,
+            stdout: process.stdout,
+            stderr: process.stderr
+        }));
+        break;
     case 'share':
         process.exit(await cliShare({
             fileId: argv['file-id'],

package/dist/tdrive.d.ts

@@ -1,3 +1,15 @@
+import { drive_v3 } from '@googleapis/drive';
+export declare class GetFileIdError extends Error {
+    constructor(message: string);
+}
+/**
+ * Get file id in spesiced parent.
+ * @param drive - drive instance.
+ * @param parentId  - id of folder in Google Deive.
+ * @param fileName  - file name.
+ * @returns id of file or blank(when file is not found)
+ */
+export declare function getFileId(drive: drive_v3.Drive, parentId: string, fileName: string): Promise<string>;
 /**
  * Validate value that is used in query parameter.
  * return false if value has included "'">
@@ -9,4 +21,4 @@ export declare function validateQueryValue(s: string): boolean;
  * Make instacen of drive that is authenticated.
  * @returns instance of drive.
  */
-export declare function driveClient(): import("@googleapis/drive").drive_v3.Drive;
+export declare function driveClient(): drive_v3.Drive;

package/dist/tdrive.js

@@ -1,5 +1,44 @@
 import { GoogleAuth } from 'google-auth-library';
 import { drive as gdrive } from '@googleapis/drive';
+export class GetFileIdError extends Error {
+    constructor(message) {
+        //https://stackoverflow.com/questions/41102060/typescript-extending-error-class
+        super(message);
+        Object.setPrototypeOf(this, GetFileIdError.prototype);
+    }
+}
+/**
+ * Get file id in spesiced parent.
+ * @param drive - drive instance.
+ * @param parentId  - id of folder in Google Deive.
+ * @param fileName  - file name.
+ * @returns id of file or blank(when file is not found)
+ */
+export async function getFileId(drive, parentId, fileName) {
+    try {
+        if (validateQueryValue(parentId) === false) {
+            throw new GetFileIdError(`Invalid paretnt id : ${parentId}`);
+        }
+        if (validateQueryValue(fileName) === false) {
+            throw new GetFileIdError(`Invalid file name : ${fileName}`);
+        }
+        const list = await drive.files.list({
+            pageSize: 10,
+            q: `'${parentId}' in parents and name = '${fileName}'`,
+            fields: 'files(id, name)'
+        });
+        if (list.data.files && list.data.files.length > 0) {
+            return list.data.files[0].id || '';
+        }
+        return '';
+    }
+    catch (err) {
+        if (err.errors) {
+            throw new GetFileIdError(JSON.stringify(err.errors));
+        }
+        throw err;
+    }
+}
 /**
  * Validate value that is used in query parameter.
  * return false if value has included "'">

package/dist/trecv.d.ts

@@ -0,0 +1,44 @@
+import { drive_v3 } from '@googleapis/drive';
+export declare class DownloadFileError extends Error {
+    constructor(message: string);
+}
+/**
+ * Options for recvFile().
+ */
+export declare type RecvFileOpts = {
+    /**
+     * @type The ID of the file or shared drive.
+     */
+    fileId: string;
+    /**
+    /**
+     * @type The IDs of the parent folders which contain the file.
+     */
+    parentId: string;
+    /**
+     * @type The name of the file in remote
+     */
+    srcFileName: string;
+    /**
+     @type The name(path) of the file in local filesystem
+     */
+    destFileName: string;
+    /**
+     * @type Media mime-type.
+     */
+    destMimeType: string;
+};
+/**
+ * Download the file from Google Drive to the locale file
+ * @param drive - drive instance.
+ * @param opts - options.
+ * @returns
+ */
+export declare function downloadFile(drive: drive_v3.Drive, opts: Pick<RecvFileOpts, 'fileId' | 'destFileName' | 'destMimeType'>): Promise<void>;
+/**
+ * Receive the file from Google Drive to the locale file
+ * @param drive - drive instance.
+ * @param opts - options.
+ * @returns id of file in Google Drive
+ */
+export declare function recvFile(drive: drive_v3.Drive, opts: RecvFileOpts): Promise<string>;

package/dist/trecv.js

@@ -0,0 +1,79 @@
+import * as fs from 'fs';
+import { promisify } from 'util';
+import { getFileId, GetFileIdError } from './tdrive.js';
+export class DownloadFileError extends Error {
+    constructor(message) {
+        //https://stackoverflow.com/questions/41102060/typescript-extending-error-class
+        super(message);
+        Object.setPrototypeOf(this, DownloadFileError.prototype);
+    }
+}
+/**
+ * Download the file from Google Drive to the locale file
+ * @param drive - drive instance.
+ * @param opts - options.
+ * @returns
+ */
+export async function downloadFile(drive, opts) {
+    let ret;
+    try {
+        const { fileId, destFileName, destMimeType } = opts;
+        const dest = fs.createWriteStream(destFileName);
+        try {
+            if (destMimeType) {
+                const params = {
+                    fileId,
+                    mimeType: destMimeType
+                };
+                const res = await drive.files.export(params, { responseType: 'stream' });
+                for await (const c of res.data) {
+                    dest.write(c);
+                }
+            }
+            else {
+                const params = {
+                    fileId,
+                    alt: 'media'
+                };
+                const res = await drive.files.get(params, { responseType: 'stream' });
+                for await (const c of res.data) {
+                    dest.write(c);
+                }
+            }
+        }
+        catch (err) {
+            if (err.errors) {
+                throw new DownloadFileError(JSON.stringify(err.errors));
+            }
+            if (err.response?.status) {
+                throw new DownloadFileError(`status:${err.response.status}\nstatusText:${err.response.statusText}`);
+            }
+            throw new DownloadFileError(err);
+        }
+        finally {
+            // return promisify(dest.close.bind(dest))()  ここで return すると常に undfeind になる
+            ret = promisify(dest.close.bind(dest))();
+        }
+    }
+    catch (err) {
+        throw err;
+    }
+    return ret;
+}
+/**
+ * Receive the file from Google Drive to the locale file
+ * @param drive - drive instance.
+ * @param opts - options.
+ * @returns id of file in Google Drive
+ */
+export async function recvFile(drive, opts) {
+    const { fileId: inFileId, parentId, srcFileName, destFileName, destMimeType } = opts;
+    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 });
+    return fileId;
+}

package/dist/tsend.d.ts

@@ -1,7 +1,4 @@
 import { drive_v3 } from '@googleapis/drive';
-export declare class GetFileIdError extends Error {
-    constructor(message: string);
-}
 export declare class UploadFileError extends Error {
     constructor(message: string);
 }
@@ -38,14 +35,6 @@ export declare type SendFileOpts = {
      */
     srcMimeType: string;
 };
-/**
- * Get file id in spesiced parent.
- * @param drive - drive instance.
- * @param parentId  - id of folder in Google Deive.
- * @param fileName  - file name.
- * @returns id of file or blank(when file is not found)
- */
-export declare function getFileId(drive: drive_v3.Drive, parentId: string, fileName: string): Promise<string>;
 /**
  * Create file using by source file into Google Drive.
  * @param drive - drive instance.

package/dist/tsend.js

@@ -1,13 +1,7 @@
 import * as path from 'path';
 import * as fs from 'fs';
-import { validateQueryValue } from './tdrive.js';
-export class GetFileIdError extends Error {
-    constructor(message) {
-        //https://stackoverflow.com/questions/41102060/typescript-extending-error-class
-        super(message);
-        Object.setPrototypeOf(this, GetFileIdError.prototype);
-    }
-}
+import { promisify } from 'util';
+import { getFileId } from './tdrive.js';
 export class UploadFileError extends Error {
     constructor(message) {
         //https://stackoverflow.com/questions/41102060/typescript-extending-error-class
@@ -22,38 +16,6 @@ export class UpdateFileError extends Error {
         Object.setPrototypeOf(this, UpdateFileError.prototype);
     }
 }
-/**
- * Get file id in spesiced parent.
- * @param drive - drive instance.
- * @param parentId  - id of folder in Google Deive.
- * @param fileName  - file name.
- * @returns id of file or blank(when file is not found)
- */
-export async function getFileId(drive, parentId, fileName) {
-    try {
-        if (validateQueryValue(parentId) === false) {
-            throw new GetFileIdError(`Invalid paretnt id : ${parentId}`);
-        }
-        if (validateQueryValue(fileName) === false) {
-            throw new GetFileIdError(`Invalid file name : ${fileName}`);
-        }
-        const list = await drive.files.list({
-            pageSize: 10,
-            q: `'${parentId}' in parents and name = '${fileName}'`,
-            fields: 'files(id, name)'
-        });
-        if (list.data.files && list.data.files.length > 0) {
-            return list.data.files[0].id || '';
-        }
-        return '';
-    }
-    catch (err) {
-        if (err.errors) {
-            throw new GetFileIdError(JSON.stringify(err.errors));
-        }
-        throw err;
-    }
-}
 /**
  * Create file using by source file into Google Drive.
  * @param drive - drive instance.
@@ -61,30 +23,41 @@ export async function getFileId(drive, parentId, fileName) {
  * @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 params = {
-            requestBody: {
-                name: path.basename(destFileName),
-                parents: [parentId]
-            },
-            media: {
-                body: fs.createReadStream(srcFileName)
-            },
-            fields: 'id'
-        };
-        if (destMimeType) {
-            params.requestBody.mimeType = destMimeType;
+        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 || '';
+        }
+        catch (err) {
+            throw new UploadFileError(JSON.stringify(err.errors));
         }
-        if (srcMimeType) {
-            params.media.mimeType = srcMimeType;
+        finally {
+            await promisify(srcStream.close.bind(srcStream))();
         }
-        const res = await drive.files.create(params);
-        return res.data.id || '';
     }
     catch (err) {
-        throw new UploadFileError(JSON.stringify(err.errors));
+        throw err;
     }
+    return ret;
 }
 /**
  * Update file using by source file into Google Drive.
@@ -93,28 +66,39 @@ 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 params = {
-            fileId,
-            requestBody: {},
-            media: {
-                body: fs.createReadStream(srcFileName)
-            },
-            fields: 'id'
-        };
-        if (destMimeType) {
-            params.requestBody.mimeType = destMimeType;
+        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 || '';
         }
-        if (srcMimeType) {
-            params.media.mimeType = srcMimeType;
+        catch (err) {
+            throw new UpdateFileError(JSON.stringify(err.errors));
+        }
+        finally {
+            await promisify(srcStream.close.bind(srcStream))();
         }
-        const res = await drive.files.update(params);
-        return res.data.id || '';
     }
     catch (err) {
-        throw new UpdateFileError(JSON.stringify(err.errors));
+        throw err;
     }
+    return ret;
 }
 /**
  * Send file using by source file into Google Drive.

package/dist/tshare.js

@@ -1,4 +1,4 @@
-import { getFileId } from './tsend.js';
+import { getFileId } from './tdrive.js';
 export class CreatePermissonError extends Error {
     constructor(message) {
         //https://stackoverflow.com/questions/41102060/typescript-extending-error-class

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "guratan",
-  "version": "0.4.0",
+  "version": "0.5.2",
   "description": "Tiny send tool for Google Drive",
   "author": "hankei6km <hankei6km@gmail.com> (https://github.com/hankei6km)",
   "license": "MIT",
@@ -39,7 +39,7 @@
   },
   "devDependencies": {
     "@types/jest": "^27.4.1",
-    "@types/node": "^17.0.21",
+    "@types/node": "^16.11.26",
     "@types/yargs": "^17.0.9",
     "jest": "^27.5.1",
     "rimraf": "^3.0.2",