guratan 0.2.1 → 0.3.0

package/dist/cli.d.ts

@@ -1,12 +1,31 @@
 /// <reference types="node" />
 import { Writable } from 'stream';
 declare type Opts = {
+    stdout: Writable;
+    stderr: Writable;
+};
+declare type OptsSend = Opts & {
     parentId: string;
     destFileName: string;
     srcFileName: string;
+    destMimeType: string;
+    srcMimeType: string;
+    printId: boolean;
+};
+declare type OptsShare = Opts & {
+    fileId: string;
+    type: string;
+    role: string;
+    emailAddress: string;
+    domain: string;
+    allowFileDiscovery?: boolean;
+    view: string;
+    moveToNewOwnersRoot?: boolean;
+    transferOwnership?: boolean;
+    sendNotificationEmail?: boolean;
+    emailMessage: string;
     printId: boolean;
-    stdout: Writable;
-    stderr: Writable;
 };
-export declare const cli: ({ parentId, destFileName, srcFileName, printId, stdout, stderr }: Opts) => Promise<number>;
+export declare const cliSend: ({ parentId, destFileName, srcFileName, destMimeType, srcMimeType, printId, stdout, stderr }: OptsSend) => Promise<number>;
+export declare const cliShare: ({ fileId, type, role, emailAddress, domain, allowFileDiscovery, view, moveToNewOwnersRoot, transferOwnership, sendNotificationEmail, emailMessage, printId, stdout, stderr }: OptsShare) => Promise<number>;
 export {};

package/dist/cli.js

@@ -1,7 +1,41 @@
-import { driveClient, sendFile } from './tsend.js';
-export const cli = async ({ parentId, destFileName, srcFileName, printId, stdout, stderr }) => {
+import { driveClient } from './tdrive.js';
+import { sendFile } from './tsend.js';
+import { createPermisson } from './tshare.js';
+export const cliSend = async ({ parentId, destFileName, srcFileName, destMimeType, srcMimeType, printId, stdout, stderr }) => {
     try {
-        const id = await sendFile(driveClient(), parentId, destFileName, srcFileName);
+        const id = await sendFile(driveClient(), {
+            parentId,
+            destFileName,
+            srcFileName,
+            destMimeType,
+            srcMimeType
+        });
+        if (printId) {
+            stdout.write(id);
+        }
+    }
+    catch (err) {
+        stderr.write(err.toString());
+        stderr.write('\n');
+        return 1;
+    }
+    return 0;
+};
+export const cliShare = async ({ fileId, type, role, emailAddress, domain, allowFileDiscovery, view, moveToNewOwnersRoot, transferOwnership, sendNotificationEmail, emailMessage, printId, stdout, stderr }) => {
+    try {
+        const id = await createPermisson(driveClient(), {
+            fileId,
+            type,
+            role,
+            emailAddress,
+            domain,
+            allowFileDiscovery,
+            view,
+            moveToNewOwnersRoot,
+            transferOwnership,
+            sendNotificationEmail,
+            emailMessage
+        });
         if (printId) {
             stdout.write(id);
         }

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/main.js

@@ -1,24 +1,110 @@
 #!/usr/bin/env node
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
-import { cli } from './cli.js';
+import { cliSend, cliShare } from './cli.js';
 const envVarsPrefix = process.env['GURATAN_ENV_VARS_PREFIX'] || 'GURATAN';
 const argv = await yargs(hideBin(process.argv))
     .scriptName('guratan')
     .env(envVarsPrefix)
-    .command('$0 send [OPTIONS]', 'send file to folder in Google Drive', (yargs) => {
+    .command('send [OPTIONS]', 'send file to folder in Google Drive', (yargs) => {
     return yargs.options({
         'parent-id': {
             type: 'string',
-            description: 'id of folder in Google Deive'
+            required: true,
+            description: 'The IDs of the parent folders which contain the file.'
         },
         'dest-file-name': {
             type: 'string',
-            description: 'file name in Google Drive'
+            required: true,
+            description: 'The name of the file in remote'
         },
         'src-file-name': {
             type: 'string',
-            description: 'file name in local filesystem'
+            required: true,
+            description: 'The name(path) of the file in local filesystem'
+        },
+        'dest-mime-type': {
+            type: 'string',
+            required: false,
+            default: '',
+            description: 'The MIME type of the file.'
+        },
+        'src-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 sended into remote'
+        }
+    });
+})
+    .command('share [OPTIONS]', 'share file in Google Drive', (yargs) => {
+    return yargs.options({
+        'file-id': {
+            type: 'string',
+            default: 'reader',
+            required: false,
+            description: 'The ID of the file or shared drive.'
+        },
+        type: {
+            choices: ['user', 'group', 'domain', 'anyone'],
+            required: false,
+            default: 'user',
+            description: 'The type of the grantee.'
+        },
+        role: {
+            choices: [
+                'owner',
+                'organizer',
+                'fileOrganizer',
+                'writer',
+                'commenter',
+                'reader'
+            ],
+            required: false,
+            default: 'reader',
+            description: 'The role granted by this permission'
+        },
+        'email-address': {
+            type: 'string',
+            default: '',
+            description: 'The email address of the user or group to which this permission refers.'
+        },
+        domain: {
+            type: 'string',
+            default: '',
+            description: 'The domain to which this permission refers.	'
+        },
+        'move-to-new-owners-root': {
+            type: 'boolean',
+            description: 'This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item.'
+        },
+        'allow-file-discovery': {
+            type: 'boolean',
+            description: 'Whether the permission allows the file to be discovered through search.'
+        },
+        view: {
+            type: 'string',
+            default: '',
+            description: 'Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.'
+        },
+        'transfer-ownership': {
+            type: 'boolean',
+            description: 'Whether to transfer ownership to the specified user and downgrade the current owner to a writer.'
+        },
+        'send-notification-email': {
+            type: 'boolean',
+            description: 'Whether to send a notification email when sharing to users or groups.'
+        },
+        'email-message': {
+            type: 'string',
+            default: '',
+            description: 'A plain text custom message to include in the notification email.'
         },
         'print-id': {
             type: 'boolean',
@@ -28,13 +114,43 @@ const argv = await yargs(hideBin(process.argv))
         }
     });
 })
+    .demandCommand()
     .demand(0)
+    .strictOptions(true)
     .help().argv;
-process.exit(await cli({
-    parentId: argv['parent-id'] || '',
-    destFileName: argv['dest-file-name'] || '',
-    srcFileName: argv['src-file-name'] || '',
-    printId: argv['print-id'] || false,
-    stdout: process.stdout,
-    stderr: process.stderr
-}));
+switch (`${argv._[0]}`) {
+    case 'send':
+        process.exit(await cliSend({
+            parentId: argv['parent-id'] || '',
+            destFileName: argv['dest-file-name'] || '',
+            srcFileName: argv['src-file-name'] || '',
+            destMimeType: argv['dest-mime-type'] || '',
+            srcMimeType: argv['src-mime-type'] || '',
+            printId: argv['print-id'] || false,
+            stdout: process.stdout,
+            stderr: process.stderr
+        }));
+        break;
+    case 'share':
+        process.exit(await cliShare({
+            fileId: argv['file-id'],
+            type: argv['type'],
+            role: argv['role'],
+            emailAddress: argv['email-address'],
+            domain: argv['domain'],
+            view: argv['view'],
+            allowFileDiscovery: argv['allow-file-discovery'],
+            moveToNewOwnersRoot: argv['move-to-new-owners-root'],
+            transferOwnership: argv['transfer-ownership'],
+            sendNotificationEmail: argv['send-notification-email'],
+            printId: argv['print-id'] || false,
+            emailMessage: argv['email-message'],
+            stdout: process.stdout,
+            stderr: process.stderr
+        }));
+        break;
+    default:
+        console.log(argv);
+        process.stderr.write(`unknown command: ${argv._[0]}\n`);
+        process.exit(1);
+}

package/dist/tdrive.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Validate value that is used in query parameter.
+ * return false if value has included "'">
+ * @param s - value string.
+ * @returns result of validation.
+ */
+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;

package/dist/tdrive.js

@@ -0,0 +1,25 @@
+import { GoogleAuth } from 'google-auth-library';
+import { drive as gdrive } from '@googleapis/drive';
+/**
+ * Validate value that is used in query parameter.
+ * return false if value has included "'">
+ * @param s - value string.
+ * @returns result of validation.
+ */
+export function validateQueryValue(s) {
+    if (s.indexOf("'") >= 0) {
+        return false;
+    }
+    return true;
+}
+/**
+ * Make instacen of drive that is authenticated.
+ * @returns instance of drive.
+ */
+export function driveClient() {
+    const SCOPES = ['https://www.googleapis.com/auth/drive.file'];
+    const auth = new GoogleAuth({
+        scopes: SCOPES
+    });
+    return gdrive({ version: 'v3', auth });
+}

package/dist/tsend.d.ts

@@ -9,17 +9,30 @@ export declare class UpdateFileError extends Error {
     constructor(message: string);
 }
 /**
- * Validate value that is used in query parameter.
- * return false if value has included "'">
- * @param s - value string.
- * @returns result of validation.
+ * Options for sendFile().
  */
-export declare function validateQueryValue(s: string): boolean;
-/**
- * Make instacen of drive that is authenticated.
- * @returns instance of drive.
- */
-export declare function driveClient(): drive_v3.Drive;
+export declare type SendFileOpts = {
+    /**
+     * @type The IDs of the parent folders which contain the file.
+     */
+    parentId: string;
+    /**
+     * @type The name of the file in remote
+     */
+    destFileName: string;
+    /**
+     @type The name(path) of the file in local filesystem
+     */
+    srcFileName: string;
+    /**
+     * @type The MIME type of the file.
+     */
+    destMimeType: string;
+    /**
+     * @type Media mime-type.
+     */
+    srcMimeType: string;
+};
 /**
  * Get file id in spesiced parent.
  * @param drive - drive instance.
@@ -31,18 +44,23 @@ export declare function getFileId(drive: drive_v3.Drive, parentId: string, fileN
 /**
  * Create file using by source file into Google Drive.
  * @param drive - drive instance.
- * @param parentId  - id of folder in Google Deive.
- * @param destFileName - file name in Google Drive.
- * @param srcFileName - file name in local filesystem.
- * @returns id of file in Google Drive
+ * @param opts - options.
+ * @returns Print the id of the file that is sended into remote
  */
-export declare function uploadFile(drive: drive_v3.Drive, parentId: string, destFileName: string, srcFileName: string): Promise<string>;
+export declare function uploadFile(drive: drive_v3.Drive, opts: Pick<SendFileOpts, 'parentId' | 'destFileName' | 'srcFileName' | 'destMimeType' | 'srcMimeType'>): Promise<string>;
 /**
  * Update file using by source file into Google Drive.
  * @param drive - drive instance.
- * @param fileId  - id of file in Google Deive.
- * @param srcFileName - file name in local filesystem.
+ * @param opts - options.
+ * @returns id of file in Google Drive
+ */
+export declare function updateFile(drive: drive_v3.Drive, opts: {
+    fileId: string;
+} & Pick<SendFileOpts, 'srcFileName' | 'destMimeType' | 'srcMimeType'>): Promise<string>;
+/**
+ * Send file using by source file into Google Drive.
+ * @param drive - drive instance.
+ * @param opts - options.
  * @returns id of file in Google Drive
  */
-export declare function updateFile(drive: drive_v3.Drive, fileId: string, srcFileName: string): Promise<string>;
-export declare function sendFile(drive: drive_v3.Drive, parentId: string, destFileName: string, srcFileName: string): Promise<string>;
+export declare function sendFile(drive: drive_v3.Drive, opts: SendFileOpts): Promise<string>;

package/dist/tsend.js

@@ -1,7 +1,6 @@
 import * as path from 'path';
 import * as fs from 'fs';
-import { drive as gdrive } from '@googleapis/drive';
-import { GoogleAuth } from 'google-auth-library';
+import { validateQueryValue } from './tdrive.js';
 export class GetFileIdError extends Error {
     constructor(message) {
         //https://stackoverflow.com/questions/41102060/typescript-extending-error-class
@@ -23,29 +22,6 @@ export class UpdateFileError extends Error {
         Object.setPrototypeOf(this, UpdateFileError.prototype);
     }
 }
-/**
- * Validate value that is used in query parameter.
- * return false if value has included "'">
- * @param s - value string.
- * @returns result of validation.
- */
-export function validateQueryValue(s) {
-    if (s.indexOf("'") >= 0) {
-        return false;
-    }
-    return true;
-}
-/**
- * Make instacen of drive that is authenticated.
- * @returns instance of drive.
- */
-export function driveClient() {
-    const SCOPES = ['https://www.googleapis.com/auth/drive.file'];
-    const auth = new GoogleAuth({
-        scopes: SCOPES
-    });
-    return gdrive({ version: 'v3', auth });
-}
 /**
  * Get file id in spesiced parent.
  * @param drive - drive instance.
@@ -81,24 +57,29 @@ export async function getFileId(drive, parentId, fileName) {
 /**
  * Create file using by source file into Google Drive.
  * @param drive - drive instance.
- * @param parentId  - id of folder in Google Deive.
- * @param destFileName - file name in Google Drive.
- * @param srcFileName - file name in local filesystem.
- * @returns id of file in Google Drive
+ * @param opts - options.
+ * @returns Print the id of the file that is sended into remote
  */
-export async function uploadFile(drive, parentId, destFileName, srcFileName) {
+export async function uploadFile(drive, opts) {
     try {
-        const res = await drive.files.create({
+        const { parentId, destFileName, srcFileName, destMimeType, srcMimeType } = opts;
+        const params = {
             requestBody: {
                 name: path.basename(destFileName),
                 parents: [parentId]
             },
             media: {
-                // mimeType: 'image/jpeg',
                 body: fs.createReadStream(srcFileName)
             },
             fields: 'id'
-        });
+        };
+        if (destMimeType) {
+            params.requestBody.mimeType = destMimeType;
+        }
+        if (srcMimeType) {
+            params.media.mimeType = srcMimeType;
+        }
+        const res = await drive.files.create(params);
         return res.data.id || '';
     }
     catch (err) {
@@ -108,43 +89,50 @@ export async function uploadFile(drive, parentId, destFileName, srcFileName) {
 /**
  * Update file using by source file into Google Drive.
  * @param drive - drive instance.
- * @param fileId  - id of file in Google Deive.
- * @param srcFileName - file name in local filesystem.
+ * @param opts - options.
  * @returns id of file in Google Drive
  */
-export async function updateFile(drive, fileId, srcFileName) {
+export async function updateFile(drive, opts) {
     try {
-        const res = await drive.files.update({
+        const { fileId, srcFileName, destMimeType, srcMimeType } = opts;
+        const params = {
             fileId,
             requestBody: {},
             media: {
-                // mimeType: 'image/jpeg',
                 body: fs.createReadStream(srcFileName)
             },
             fields: 'id'
-        });
+        };
+        if (destMimeType) {
+            params.requestBody.mimeType = destMimeType;
+        }
+        if (srcMimeType) {
+            params.media.mimeType = srcMimeType;
+        }
+        const res = await drive.files.update(params);
         return res.data.id || '';
     }
     catch (err) {
         throw new UpdateFileError(JSON.stringify(err.errors));
     }
 }
-export async function sendFile(drive, parentId, destFileName, srcFileName) {
+/**
+ * Send file using by source file into Google Drive.
+ * @param drive - drive instance.
+ * @param opts - options.
+ * @returns id of file in Google Drive
+ */
+export async function sendFile(drive, opts) {
+    const { parentId, destFileName, srcFileName, destMimeType, srcMimeType } = opts;
     const fileId = await getFileId(drive, parentId, destFileName);
     if (fileId === '') {
-        return uploadFile(drive, parentId, destFileName, srcFileName);
+        return uploadFile(drive, {
+            parentId,
+            destFileName,
+            srcFileName,
+            destMimeType,
+            srcMimeType
+        });
     }
-    return updateFile(drive, fileId, srcFileName);
+    return updateFile(drive, { fileId, srcFileName, destMimeType, srcMimeType });
 }
-// try {
-//   const parentId = process.env['PARENT_ID'] || ''
-//   const destFileName = process.env['DEST_FILE_NAME'] || ''
-//   const srcFileName = process.env['SRC_FILE_NAME'] || ''
-//   const drive = driveClient()
-//   const id = await getFileId(drive, parentId, destFileName)
-//   console.log(id)
-//   console.log(await updateFile(drive, id, srcFileName))
-// } catch (err) {
-//   console.error('--err--')
-//   console.error(err)
-// }

package/dist/tshare.d.ts

@@ -0,0 +1,63 @@
+import { drive_v3 } from '@googleapis/drive';
+export declare class CreatePermissonError extends Error {
+    constructor(message: string);
+}
+export declare class UpdatePermissonError extends Error {
+    constructor(message: string);
+}
+/**
+ * Options for createPermisson().
+ */
+export declare type CreatePermissonOpts = {
+    /**
+     * @type The ID of the file or shared drive.
+     */
+    fileId: string;
+    /**
+     * @type The type of the grantee.
+     */
+    type: string;
+    /**
+     * The role granted by this permission
+     */
+    role: string;
+    /**
+     * @type The email address of the user or group to which this permission refers.
+     */
+    emailAddress: string;
+    /**
+     * @type The domain to which this permission refers.
+     */
+    domain: string;
+    /**
+     * @type Whether the permission allows the file to be discovered through search.
+     */
+    allowFileDiscovery?: boolean;
+    /**
+     * @type Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value.
+     */
+    view: string;
+    /**
+     * @type This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item.
+     */
+    moveToNewOwnersRoot?: boolean;
+    /**
+     * @type Whether to transfer ownership to the specified user and downgrade the current owner to a writer.
+     */
+    transferOwnership?: boolean;
+    /**
+     * @type Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+     */
+    sendNotificationEmail?: boolean;
+    /**
+     * @type A plain text custom message to include in the notification email.
+     */
+    emailMessage: string;
+};
+/**
+ * Create permission
+ * @param drive - drive instance.
+ * @param opts
+ * @returns id of file in Google Drive
+ */
+export declare function createPermisson(drive: drive_v3.Drive, opts: CreatePermissonOpts): Promise<string>;

package/dist/tshare.js

@@ -0,0 +1,84 @@
+export class CreatePermissonError extends Error {
+    constructor(message) {
+        //https://stackoverflow.com/questions/41102060/typescript-extending-error-class
+        super(message);
+        Object.setPrototypeOf(this, CreatePermissonError.prototype);
+    }
+}
+export class UpdatePermissonError extends Error {
+    constructor(message) {
+        //https://stackoverflow.com/questions/41102060/typescript-extending-error-class
+        super(message);
+        Object.setPrototypeOf(this, UpdatePermissonError.prototype);
+    }
+}
+/**
+ * Create permission
+ * @param drive - drive instance.
+ * @param opts
+ * @returns id of file in Google Drive
+ */
+export async function createPermisson(drive, opts) {
+    let created = false;
+    try {
+        const { fileId, type, role, emailAddress, domain, view, allowFileDiscovery, moveToNewOwnersRoot, transferOwnership, sendNotificationEmail, emailMessage } = opts;
+        const createParams = {
+            requestBody: {
+                type,
+                role
+            },
+            fileId,
+            fields: 'id'
+        };
+        if (emailAddress) {
+            createParams.requestBody.emailAddress = emailAddress;
+        }
+        if (domain) {
+            createParams.requestBody.domain = domain;
+        }
+        if (view) {
+            createParams.requestBody.view = view;
+        }
+        if (allowFileDiscovery !== undefined) {
+            createParams.requestBody.allowFileDiscovery = allowFileDiscovery;
+        }
+        if (moveToNewOwnersRoot !== undefined) {
+            createParams.moveToNewOwnersRoot = moveToNewOwnersRoot;
+        }
+        if (transferOwnership !== undefined) {
+            createParams.transferOwnership = transferOwnership;
+        }
+        if (sendNotificationEmail !== undefined) {
+            createParams.sendNotificationEmail = sendNotificationEmail;
+        }
+        if (sendNotificationEmail && emailMessage) {
+            createParams.emailMessage = emailMessage;
+        }
+        const resCreate = await drive.permissions.create(createParams);
+        created = true;
+        const id = resCreate.data.id || '';
+        if (id === '') {
+            throw new CreatePermissonError('drive.permissions.create() return blank id ');
+        }
+        if (!transferOwnership) {
+            const resUpdate = await drive.permissions.update({
+                permissionId: id,
+                requestBody: {
+                    role
+                },
+                fileId,
+                fields: 'id'
+            });
+        }
+        return id;
+    }
+    catch (err) {
+        if (err.errors) {
+            if (!created) {
+                throw new CreatePermissonError(JSON.stringify(err.errors));
+            }
+            throw new UpdatePermissonError(JSON.stringify(err.errors));
+        }
+        throw err;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "guratan",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Tiny send tool for Google Drive",
   "author": "hankei6km <hankei6km@gmail.com> (https://github.com/hankei6km)",
   "license": "MIT",