@8ms/helpers 3.0.24 → 3.0.26

package/dist/googleCloud/drive/server/GoogleCloudDrive.cjs

@@ -0,0 +1,139 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require__class_BaseNamespace = require("../../../_class/BaseNamespace.cjs");
+const require_util_server_getGzipCompressed = require("../../../util/server/getGzipCompressed.cjs");
+const require_util_server_getGzipDecompressed = require("../../../util/server/getGzipDecompressed.cjs");
+//#region src/googleCloud/drive/server/GoogleCloudDrive.ts
+var GoogleCloudDrive = class extends require__class_BaseNamespace.BaseNamespace {
+	/**
+	* Either a Google Cloud JSON Config or V10 Auth helper.
+	*/
+	init = async (isOidc, config, projectId, region) => {
+		if (!this.client) try {
+			const googleApisDrive = await import("@googleapis/drive");
+			this.client = new googleApisDrive.auth.GoogleAuth({
+				authClient: isOidc ? config : void 0,
+				credentials: isOidc ? void 0 : config,
+				projectId,
+				scopes: ["https://www.googleapis.com/auth/drive"]
+			});
+		} catch (e) {
+			throw new Error("Google Drive Client not installed");
+		}
+		return this;
+	};
+	/**
+	* List the files within the given (optional) parent folder.
+	*/
+	listFiles = async (parentFolderId) => {
+		const googleApisDrive = await import("@googleapis/drive");
+		const parentClause = parentFolderId ? `'${parentFolderId}' in parents and ` : "";
+		const apiResponse = await googleApisDrive.drive("v3").files.list({
+			auth: this.client,
+			fields: "files(id, name, mimeType, modifiedTime)",
+			q: `${parentClause}mimeType != 'application/vnd.google-apps.folder' and trashed = false`
+		});
+		if (!apiResponse?.data?.files) return [];
+		return apiResponse.data.files.filter((file) => !!file?.id).map((file) => ({
+			id: file.id,
+			name: file.name ?? "",
+			mimeType: file.mimeType ?? "",
+			modifiedTime: file.modifiedTime ?? ""
+		}));
+	};
+	/**
+	* List the folders within the given (optional) parent folder.
+	*/
+	listFolders = async (parentFolderId) => {
+		const googleApisDrive = await import("@googleapis/drive");
+		const parentClause = parentFolderId ? `'${parentFolderId}' in parents and ` : "";
+		const apiResponse = await googleApisDrive.drive("v3").files.list({
+			auth: this.client,
+			fields: "files(id, name, mimeType, modifiedTime)",
+			q: `${parentClause}mimeType = 'application/vnd.google-apps.folder' and trashed = false`
+		});
+		if (!apiResponse?.data?.files) return [];
+		return apiResponse.data.files.filter((file) => !!file?.id).map((file) => ({
+			id: file.id,
+			name: file.name ?? "",
+			mimeType: file.mimeType ?? "",
+			modifiedTime: file.modifiedTime ?? ""
+		}));
+	};
+	/**
+	* Check to see if a file with the given name exists in the given parent folder.
+	*/
+	fileExists = async (parentFolderId, fileName) => {
+		let response = false;
+		try {
+			response = 0 < ((await (await import("@googleapis/drive")).drive("v3").files.list({
+				auth: this.client,
+				fields: "files(id)",
+				q: `name = '${fileName}' and '${parentFolderId}' in parents and trashed = false`
+			}))?.data?.files?.length ?? 0);
+		} catch (exception) {
+			response = false;
+		}
+		return response;
+	};
+	/**
+	* Move a file to the Google Drive trash.
+	*/
+	deleteFile = async (fileId) => {
+		await (await import("@googleapis/drive")).drive("v3").files.update({
+			auth: this.client,
+			fileId,
+			requestBody: { trashed: true }
+		});
+	};
+	/**
+	* Write a file to Google Drive within the given parent folder.
+	*/
+	writeFile = async (parentFolderId, fileName, data, options = {}) => {
+		return (await (await import("@googleapis/drive")).drive("v3").files.create({
+			auth: this.client,
+			fields: "id, name",
+			media: {
+				body: data,
+				mimeType: options.mimeType ?? "text/plain"
+			},
+			requestBody: {
+				name: fileName,
+				parents: [parentFolderId]
+			}
+		})).data;
+	};
+	writeJson = async (parentFolderId, fileName, data, options = {}) => {
+		return await this.writeFile(parentFolderId, fileName, JSON.stringify(data), options);
+	};
+	writeJsonGzip = async (parentFolderId, fileName, data, gzipOptions = {}, driveOptions = {}) => {
+		let finalData = JSON.stringify(data);
+		finalData = await require_util_server_getGzipCompressed.getGzipCompressed(finalData, gzipOptions);
+		return await this.writeFile(parentFolderId, fileName, finalData, driveOptions);
+	};
+	/**
+	* Read a file's contents from Google Drive.
+	*/
+	readFile = async (fileId, options = {}) => {
+		return { body: (await (await import("@googleapis/drive")).drive("v3").files.get({
+			auth: this.client,
+			fileId,
+			alt: "media",
+			...options
+		}, { responseType: "text" })).data };
+	};
+	readJson = async (fileId) => {
+		const apiResponse = await this.readFile(fileId);
+		apiResponse.body = JSON.parse(apiResponse.body) || null;
+		return apiResponse;
+	};
+	readJsonGzip = async (fileId, gzipOptions = {}, driveOptions = {}) => {
+		const apiResponse = await this.readFile(fileId, driveOptions);
+		if (void 0 !== apiResponse.body) {
+			apiResponse.body = await require_util_server_getGzipDecompressed.getGzipDecompressed(apiResponse.body, gzipOptions);
+			apiResponse.body = JSON.parse(apiResponse.body) || null;
+		}
+		return apiResponse;
+	};
+};
+//#endregion
+exports.GoogleCloudDrive = GoogleCloudDrive;

package/dist/googleCloud/drive/server/GoogleCloudDrive.d.cts

@@ -0,0 +1,53 @@
+import { BaseNamespace } from "../../../_class/BaseNamespace.cjs";
+//#region src/googleCloud/drive/server/GoogleCloudDrive.d.ts
+type Options = {
+  [key: string]: any;
+};
+type DriveFile = {
+  id: string;
+  name: string;
+  mimeType: string;
+  modifiedTime: string;
+};
+declare class GoogleCloudDrive extends BaseNamespace {
+  client: any;
+  config: any;
+  /**
+   * Either a Google Cloud JSON Config or V10 Auth helper.
+   */
+  init: (isOidc: boolean, config: any, projectId: string, region?: string) => Promise<this>;
+  /**
+   * List the files within the given (optional) parent folder.
+   */
+  listFiles: (parentFolderId?: string) => Promise<DriveFile[]>;
+  /**
+   * List the folders within the given (optional) parent folder.
+   */
+  listFolders: (parentFolderId?: string) => Promise<DriveFile[]>;
+  /**
+   * Check to see if a file with the given name exists in the given parent folder.
+   */
+  fileExists: (parentFolderId: string, fileName: string) => Promise<boolean>;
+  /**
+   * Move a file to the Google Drive trash.
+   */
+  deleteFile: (fileId: string) => Promise<void>;
+  /**
+   * Write a file to Google Drive within the given parent folder.
+   */
+  writeFile: (parentFolderId: string, fileName: string, data: any, options?: Options) => Promise<import("@googleapis/drive").drive_v3.Schema$File>;
+  writeJson: (parentFolderId: string, fileName: string, data: any, options?: Options) => Promise<import("@googleapis/drive").drive_v3.Schema$File>;
+  writeJsonGzip: (parentFolderId: string, fileName: string, data: any, gzipOptions?: object, driveOptions?: Options) => Promise<import("@googleapis/drive").drive_v3.Schema$File>;
+  /**
+   * Read a file's contents from Google Drive.
+   */
+  readFile: (fileId: string, options?: Options) => Promise<{
+    body: string;
+  }>;
+  readJson: (fileId: string) => Promise<{
+    body: string;
+  }>;
+  readJsonGzip: (fileId: string, gzipOptions?: object, driveOptions?: Options) => Promise<any>;
+}
+//#endregion
+export { GoogleCloudDrive };

package/dist/googleCloud/drive/server/GoogleCloudDrive.d.mts

@@ -0,0 +1,53 @@
+import { BaseNamespace } from "../../../_class/BaseNamespace.mjs";
+//#region src/googleCloud/drive/server/GoogleCloudDrive.d.ts
+type Options = {
+  [key: string]: any;
+};
+type DriveFile = {
+  id: string;
+  name: string;
+  mimeType: string;
+  modifiedTime: string;
+};
+declare class GoogleCloudDrive extends BaseNamespace {
+  client: any;
+  config: any;
+  /**
+   * Either a Google Cloud JSON Config or V10 Auth helper.
+   */
+  init: (isOidc: boolean, config: any, projectId: string, region?: string) => Promise<this>;
+  /**
+   * List the files within the given (optional) parent folder.
+   */
+  listFiles: (parentFolderId?: string) => Promise<DriveFile[]>;
+  /**
+   * List the folders within the given (optional) parent folder.
+   */
+  listFolders: (parentFolderId?: string) => Promise<DriveFile[]>;
+  /**
+   * Check to see if a file with the given name exists in the given parent folder.
+   */
+  fileExists: (parentFolderId: string, fileName: string) => Promise<boolean>;
+  /**
+   * Move a file to the Google Drive trash.
+   */
+  deleteFile: (fileId: string) => Promise<void>;
+  /**
+   * Write a file to Google Drive within the given parent folder.
+   */
+  writeFile: (parentFolderId: string, fileName: string, data: any, options?: Options) => Promise<import("@googleapis/drive").drive_v3.Schema$File>;
+  writeJson: (parentFolderId: string, fileName: string, data: any, options?: Options) => Promise<import("@googleapis/drive").drive_v3.Schema$File>;
+  writeJsonGzip: (parentFolderId: string, fileName: string, data: any, gzipOptions?: object, driveOptions?: Options) => Promise<import("@googleapis/drive").drive_v3.Schema$File>;
+  /**
+   * Read a file's contents from Google Drive.
+   */
+  readFile: (fileId: string, options?: Options) => Promise<{
+    body: string;
+  }>;
+  readJson: (fileId: string) => Promise<{
+    body: string;
+  }>;
+  readJsonGzip: (fileId: string, gzipOptions?: object, driveOptions?: Options) => Promise<any>;
+}
+//#endregion
+export { GoogleCloudDrive };

package/dist/googleCloud/drive/server/GoogleCloudDrive.mjs

@@ -0,0 +1,138 @@
+import { BaseNamespace } from "../../../_class/BaseNamespace.mjs";
+import { getGzipCompressed } from "../../../util/server/getGzipCompressed.mjs";
+import { getGzipDecompressed } from "../../../util/server/getGzipDecompressed.mjs";
+//#region src/googleCloud/drive/server/GoogleCloudDrive.ts
+var GoogleCloudDrive = class extends BaseNamespace {
+	/**
+	* Either a Google Cloud JSON Config or V10 Auth helper.
+	*/
+	init = async (isOidc, config, projectId, region) => {
+		if (!this.client) try {
+			const googleApisDrive = await import("@googleapis/drive");
+			this.client = new googleApisDrive.auth.GoogleAuth({
+				authClient: isOidc ? config : void 0,
+				credentials: isOidc ? void 0 : config,
+				projectId,
+				scopes: ["https://www.googleapis.com/auth/drive"]
+			});
+		} catch (e) {
+			throw new Error("Google Drive Client not installed");
+		}
+		return this;
+	};
+	/**
+	* List the files within the given (optional) parent folder.
+	*/
+	listFiles = async (parentFolderId) => {
+		const googleApisDrive = await import("@googleapis/drive");
+		const parentClause = parentFolderId ? `'${parentFolderId}' in parents and ` : "";
+		const apiResponse = await googleApisDrive.drive("v3").files.list({
+			auth: this.client,
+			fields: "files(id, name, mimeType, modifiedTime)",
+			q: `${parentClause}mimeType != 'application/vnd.google-apps.folder' and trashed = false`
+		});
+		if (!apiResponse?.data?.files) return [];
+		return apiResponse.data.files.filter((file) => !!file?.id).map((file) => ({
+			id: file.id,
+			name: file.name ?? "",
+			mimeType: file.mimeType ?? "",
+			modifiedTime: file.modifiedTime ?? ""
+		}));
+	};
+	/**
+	* List the folders within the given (optional) parent folder.
+	*/
+	listFolders = async (parentFolderId) => {
+		const googleApisDrive = await import("@googleapis/drive");
+		const parentClause = parentFolderId ? `'${parentFolderId}' in parents and ` : "";
+		const apiResponse = await googleApisDrive.drive("v3").files.list({
+			auth: this.client,
+			fields: "files(id, name, mimeType, modifiedTime)",
+			q: `${parentClause}mimeType = 'application/vnd.google-apps.folder' and trashed = false`
+		});
+		if (!apiResponse?.data?.files) return [];
+		return apiResponse.data.files.filter((file) => !!file?.id).map((file) => ({
+			id: file.id,
+			name: file.name ?? "",
+			mimeType: file.mimeType ?? "",
+			modifiedTime: file.modifiedTime ?? ""
+		}));
+	};
+	/**
+	* Check to see if a file with the given name exists in the given parent folder.
+	*/
+	fileExists = async (parentFolderId, fileName) => {
+		let response = false;
+		try {
+			response = 0 < ((await (await import("@googleapis/drive")).drive("v3").files.list({
+				auth: this.client,
+				fields: "files(id)",
+				q: `name = '${fileName}' and '${parentFolderId}' in parents and trashed = false`
+			}))?.data?.files?.length ?? 0);
+		} catch (exception) {
+			response = false;
+		}
+		return response;
+	};
+	/**
+	* Move a file to the Google Drive trash.
+	*/
+	deleteFile = async (fileId) => {
+		await (await import("@googleapis/drive")).drive("v3").files.update({
+			auth: this.client,
+			fileId,
+			requestBody: { trashed: true }
+		});
+	};
+	/**
+	* Write a file to Google Drive within the given parent folder.
+	*/
+	writeFile = async (parentFolderId, fileName, data, options = {}) => {
+		return (await (await import("@googleapis/drive")).drive("v3").files.create({
+			auth: this.client,
+			fields: "id, name",
+			media: {
+				body: data,
+				mimeType: options.mimeType ?? "text/plain"
+			},
+			requestBody: {
+				name: fileName,
+				parents: [parentFolderId]
+			}
+		})).data;
+	};
+	writeJson = async (parentFolderId, fileName, data, options = {}) => {
+		return await this.writeFile(parentFolderId, fileName, JSON.stringify(data), options);
+	};
+	writeJsonGzip = async (parentFolderId, fileName, data, gzipOptions = {}, driveOptions = {}) => {
+		let finalData = JSON.stringify(data);
+		finalData = await getGzipCompressed(finalData, gzipOptions);
+		return await this.writeFile(parentFolderId, fileName, finalData, driveOptions);
+	};
+	/**
+	* Read a file's contents from Google Drive.
+	*/
+	readFile = async (fileId, options = {}) => {
+		return { body: (await (await import("@googleapis/drive")).drive("v3").files.get({
+			auth: this.client,
+			fileId,
+			alt: "media",
+			...options
+		}, { responseType: "text" })).data };
+	};
+	readJson = async (fileId) => {
+		const apiResponse = await this.readFile(fileId);
+		apiResponse.body = JSON.parse(apiResponse.body) || null;
+		return apiResponse;
+	};
+	readJsonGzip = async (fileId, gzipOptions = {}, driveOptions = {}) => {
+		const apiResponse = await this.readFile(fileId, driveOptions);
+		if (void 0 !== apiResponse.body) {
+			apiResponse.body = await getGzipDecompressed(apiResponse.body, gzipOptions);
+			apiResponse.body = JSON.parse(apiResponse.body) || null;
+		}
+		return apiResponse;
+	};
+};
+//#endregion
+export { GoogleCloudDrive };

package/dist/googleCloud/drive/server/index.cjs

@@ -0,0 +1,3 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_googleCloud_drive_server_GoogleCloudDrive = require("./GoogleCloudDrive.cjs");
+exports.GoogleCloudDrive = require_googleCloud_drive_server_GoogleCloudDrive.GoogleCloudDrive;

package/dist/googleCloud/drive/server/index.d.cts

@@ -0,0 +1,2 @@
+import { GoogleCloudDrive } from "./GoogleCloudDrive.cjs";
+export { GoogleCloudDrive };

package/dist/googleCloud/drive/server/index.d.mts

@@ -0,0 +1,2 @@
+import { GoogleCloudDrive } from "./GoogleCloudDrive.mjs";
+export { GoogleCloudDrive };

package/dist/googleCloud/drive/server/index.mjs

@@ -0,0 +1,2 @@
+import { GoogleCloudDrive } from "./GoogleCloudDrive.mjs";
+export { GoogleCloudDrive };

package/dist/googleCloud/sheets/server/GoogleCloudSheets.d.cts

@@ -1,5 +1,4 @@
 import { BaseNamespace } from "../../../_class/BaseNamespace.cjs";
-import { GoogleAuth } from "googleapis-common";
 //#region src/googleCloud/sheets/server/GoogleCloudSheets.d.ts
 type GetBatchDataProps = {
   spreadsheetId: string;
@@ -8,13 +7,13 @@ type GetBatchDataProps = {
   valueRender?: string;
 };
 declare class GoogleCloudSheets extends BaseNamespace {
-  client: GoogleAuth;
+  client: any;
   config: any;
   /**
    * Either a Google Cloud JSON Config or V10 Auth helper.
    */
   init: (isOidc: boolean, config: any, projectId: string, region?: string) => Promise<this>;
-  getBatchData: (props: GetBatchDataProps) => Promise<any>;
+  getBatchData: (props: GetBatchDataProps) => Promise<import("@googleapis/sheets").sheets_v4.Schema$BatchGetValuesResponse>;
 }
 //#endregion
 export { GoogleCloudSheets };

package/dist/googleCloud/sheets/server/GoogleCloudSheets.d.mts

@@ -1,5 +1,4 @@
 import { BaseNamespace } from "../../../_class/BaseNamespace.mjs";
-import { GoogleAuth } from "googleapis-common";
 //#region src/googleCloud/sheets/server/GoogleCloudSheets.d.ts
 type GetBatchDataProps = {
   spreadsheetId: string;
@@ -8,13 +7,13 @@ type GetBatchDataProps = {
   valueRender?: string;
 };
 declare class GoogleCloudSheets extends BaseNamespace {
-  client: GoogleAuth;
+  client: any;
   config: any;
   /**
    * Either a Google Cloud JSON Config or V10 Auth helper.
    */
   init: (isOidc: boolean, config: any, projectId: string, region?: string) => Promise<this>;
-  getBatchData: (props: GetBatchDataProps) => Promise<any>;
+  getBatchData: (props: GetBatchDataProps) => Promise<import("@googleapis/sheets").sheets_v4.Schema$BatchGetValuesResponse>;
 }
 //#endregion
 export { GoogleCloudSheets };

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@8ms/helpers",
 	"license": "UNLICENSED",
-	"version": "3.0.24",
+	"version": "3.0.26",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"
@@ -56,6 +56,7 @@
 		"@google-cloud/bigquery": "^9.0.0",
 		"@google-cloud/common": "^8.0.0",
 		"@google-cloud/storage": "^8.0.0",
+		"@googleapis/drive": "^21.0.0",
 		"@googleapis/sheets": "^14.0.0",
 		"@planetscale/database": "^1.0.0",
 		"@prisma/adapter-mariadb": "^7.0.0",
@@ -128,6 +129,9 @@
 		"@google-cloud/storage": {
 			"optional": true
 		},
+		"@googleapis/drive": {
+			"optional": true
+		},
 		"@googleapis/sheets": {
 			"optional": true
 		},
@@ -205,6 +209,7 @@
 		"@google-cloud/bigquery": "^9.0.2",
 		"@google-cloud/common": "^8.0.1",
 		"@google-cloud/storage": "^8.0.1",
+		"@googleapis/drive": "^21.0.0",
 		"@googleapis/sheets": "^14.0.0",
 		"@planetscale/database": "^1.20.1",
 		"@prisma/adapter-mariadb": "^7.9.1",
@@ -674,6 +679,14 @@
 			"import": "./dist/googleCloud/bigquery/server/loadData.mjs",
 			"require": "./dist/googleCloud/bigquery/server/loadData.cjs"
 		},
+		"./googleCloud/drive/server": {
+			"import": "./dist/googleCloud/drive/server/index.mjs",
+			"require": "./dist/googleCloud/drive/server/index.cjs"
+		},
+		"./googleCloud/drive/server/GoogleCloudDrive": {
+			"import": "./dist/googleCloud/drive/server/GoogleCloudDrive.mjs",
+			"require": "./dist/googleCloud/drive/server/GoogleCloudDrive.cjs"
+		},
 		"./googleCloud/server": {
 			"import": "./dist/googleCloud/server/index.mjs",
 			"require": "./dist/googleCloud/server/index.cjs"