@adobe/helix-google-support 1.4.19 → 1.5.2

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [1.5.2](https://github.com/adobe/helix-google-support/compare/v1.5.1...v1.5.2) (2022-07-16)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-onedrive-support to v8.1.2 ([ad929d0](https://github.com/adobe/helix-google-support/commit/ad929d093788b4bb0ef241717e21a2b980ab90b9))
+
+## [1.5.1](https://github.com/adobe/helix-google-support/compare/v1.5.0...v1.5.1) (2022-07-16)
+
+
+### Bug Fixes
+
+* **deps:** update dependency lru-cache to v7.13.1 ([e01766b](https://github.com/adobe/helix-google-support/commit/e01766b4d9db6a409aa8de680d7eabeee234309d))
+
+# [1.5.0](https://github.com/adobe/helix-google-support/compare/v1.4.19...v1.5.0) (2022-07-12)
+
+
+### Features
+
+* allow to specify mimetype ([cb5059d](https://github.com/adobe/helix-google-support/commit/cb5059d9dc575b3f26b73191f4a4bb8bd8b02fce)), closes [#47](https://github.com/adobe/helix-google-support/issues/47)
+
 ## [1.4.19](https://github.com/adobe/helix-google-support/compare/v1.4.18...v1.4.19) (2022-07-09)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-google-support",
-  "version": "1.4.19",
+  "version": "1.5.2",
   "description": "Helix Google Support",
   "main": "src/index.js",
   "type": "module",
@@ -31,9 +31,9 @@
     "reporter-options": "configFile=.mocha-multi.json"
   },
   "dependencies": {
-    "@adobe/helix-onedrive-support": "8.1.1",
+    "@adobe/helix-onedrive-support": "8.1.2",
     "googleapis": "105.0.0",
-    "lru-cache": "7.12.0"
+    "lru-cache": "7.13.1"
   },
   "devDependencies": {
     "@adobe/eslint-config-helix": "1.3.2",

package/src/GoogleClient.d.ts

@@ -25,6 +25,18 @@ declare interface GoogleClientOptions {
  * Google client
  */
 declare class GoogleClient {
+  /**
+   * Mimetype for documents
+   * @value 'application/vnd.google-apps.document'
+   */
+  static TYPE_DOCUMENT:string;
+
+  /**
+   * Mimetype for spreadsheet
+   * @value 'application/vnd.google-apps.spreadsheet'
+   */
+  static TYPE_SPREADSHEET:string;
+
   /**
    * Sets the global item cache options. It internally creates a new LRU
    * with the given options
@@ -64,25 +76,28 @@ declare class GoogleClient {
    * @param {string} parentId
    * @param {string[]} pathSegments
    * @param {string} parentPath
+   * @param {string} [type] optional file mimetype filter.
    * @returns {Promise<DriveItemInfo[]>|null}
    */
-  getUncachedItemsFromSegments(parentId:string, pathSegments:string[], parentPath:string):Promise<DriveItemInfo[]>;
+  getUncachedItemsFromSegments(parentId:string, pathSegments:string[], parentPath:string, type?:string):Promise<DriveItemInfo[]>;
 
   /**
    * @param {string} parentId
    * @param {string} pathSegments
    * @param {string} parentPath
+   * @param {string} [type] optional file mimetype filter.
    * @returns {Promise<DriveItemInfo[]>|null}
    */
-  getDriveItemsFromSegments(parentId:string, pathSegments:string[], parentPath:string):Promise<DriveItemInfo[]>;
+  getDriveItemsFromSegments(parentId:string, pathSegments:string[], parentPath:string, type?:string):Promise<DriveItemInfo[]>;
 
   /**
    * returns the items hierarchy for the given path and root id, starting with the given path.
    * @param {string} parentId
    * @param {string} path
-   * @return {DriveItemInfo[]}
+   * @param {string} [type] optional file mimetype filter.
+   * @return {Promise<DriveItemInfo[]>}
    */
-  getDriveItemsFromSegments(parentId:string, path:string):Promise<DriveItemInfo[]>;
+  getDriveItemsFromSegments(parentId:string, path:string, type?:string):Promise<DriveItemInfo[]>;
 
   /**
    * returns the items hierarchy for the given item, starting with the given id
@@ -98,14 +113,15 @@ declare class GoogleClient {
    *
    * @param {string} parentId
    * @param {string} path
+   * @param {string} [type] optional file mimetype filter.
    * @returns {Promise<DriveItemInfo>}
    */
-  getItemFromPath(parentId:string, path:string):Promise<DriveItemInfo>;
+  getItemFromPath(parentId:string, path:string, type?:string):Promise<DriveItemInfo>;
 
   /**
    * Returns an (uncached) file directly via the google api
    * @param {string} fileId
-   * @returns {string} file data
+   * @returns {Promise<string>} file data
    */
   getFile(fileId:string):Promise<string>;
 
@@ -116,14 +132,15 @@ declare class GoogleClient {
    * @param {string} parentId
    * @param {string} path
    * @param {boolean} noRetry {@code true} to avoid retry
+   * @param {string} [type] optional file mimetype filter.
    * @returns {Promise<string>|null} The data of the file or {@code null} if the file does not exist
    */
-  getFileFromPath(parentId:string, path:string, noRetry:boolean):Promise<string>;
+  getFileFromPath(parentId:string, path:string, noRetry:boolean, type?:string):Promise<string>;
 
   /**
-   * Returns an (uncached) document directly via the google api
+   * Returns an (uncached) document directly via the google docs api
    * @param {string} documentId
-   * @returns {object} document
+   * @returns {Promise<object>} document
    */
   getDocument(documentId:string):Promise<object>;
 

package/src/GoogleClient.js

@@ -56,8 +56,8 @@ function createPathSegments(path) {
   return pathSegments;
 }
 
-function getCacheKey(parentId, pathSegments) {
-  return `${parentId}:${pathSegments.join('/')}`;
+function getCacheKey(parentId, pathSegments, type = 'file') {
+  return `${parentId}:${pathSegments.join('/')}:${type}`;
 }
 
 /**
@@ -162,21 +162,31 @@ export class GoogleClient {
    * @param {string} parentId
    * @param {string[]} pathSegments
    * @param {string} parentPath
+   * @param {string} [type] optional file mimetype
    * @returns {Promise<DriveItemInfo[]>|null}
    */
-  async getUncachedItemsFromSegments(parentId, pathSegments, parentPath) {
+  async getUncachedItemsFromSegments(parentId, pathSegments, parentPath, type) {
     const { log, drive } = this;
     const name = pathSegments.shift();
     const [baseName, ext] = splitByExtension(name);
     const sanitizedName = sanitizeName(baseName);
 
     const items = [];
+    let mimeTypeFilter;
+    // filter for folder if path continues
+    if (pathSegments.length) {
+      mimeTypeFilter = 'and mimeType = \'application/vnd.google-apps.folder\'';
+    } else {
+      mimeTypeFilter = type
+        ? `and mimeType = '${type}'`
+        : 'and mimeType != \'application/vnd.google-apps.folder\'';
+    }
+
     const opts = {
       q: [
         `'${parentId}' in parents`,
         'and trashed=false',
-        // folder if path continues, sheet otherwise
-        `and mimeType ${pathSegments.length ? '=' : '!='} 'application/vnd.google-apps.folder'`,
+        mimeTypeFilter,
       ].join(' '),
       fields: 'nextPageToken, files(id, name, mimeType, modifiedTime)',
       includeItemsFromAllDrives: true,
@@ -235,7 +245,7 @@ export class GoogleClient {
     const itemPath = `${parentPath}/${sanitizedName}`;
     const children = pathSegments.length
       // eslint-disable-next-line no-use-before-define
-      ? await this.getDriveItemsFromSegments(item.id, pathSegments, itemPath)
+      ? await this.getDriveItemsFromSegments(item.id, pathSegments, itemPath, type)
       : [];
 
     if (!children) {
@@ -262,15 +272,16 @@ export class GoogleClient {
    * @param {string} parentId
    * @param {string} pathSegments
    * @param {string} parentPath
+   * @param {string} [type] optional file mimetype
    * @returns {Promise<DriveItemInfo[]>|null}
    */
-  async getDriveItemsFromSegments(parentId, pathSegments, parentPath) {
-    const key = getCacheKey(parentId, pathSegments);
+  async getDriveItemsFromSegments(parentId, pathSegments, parentPath, type) {
+    const key = getCacheKey(parentId, pathSegments, type);
     let items = lru.get(key);
     if (items) {
       return items;
     }
-    items = await this.getUncachedItemsFromSegments(parentId, pathSegments, parentPath);
+    items = await this.getUncachedItemsFromSegments(parentId, pathSegments, parentPath, type);
     if (items) {
       lru.set(key, items);
       // add invalidation function as not-enumerable to keep compatible objects
@@ -289,11 +300,12 @@ export class GoogleClient {
    * returns the items hierarchy for the given path and root id, starting with the given path.
    * @param {string} parentId
    * @param {string} path
-   * @return {DriveItemInfo[]}
+   * @param {string} [type] optional file mimetype
+   * @return {Promise<DriveItemInfo[]>}
    */
-  async getItemsFromPath(parentId, path) {
+  async getItemsFromPath(parentId, path, type) {
     const segs = createPathSegments(path);
-    const result = await this.getDriveItemsFromSegments(parentId, segs, '');
+    const result = await this.getDriveItemsFromSegments(parentId, segs, '', type);
     if (!result) {
       return [];
     }
@@ -380,9 +392,10 @@ export class GoogleClient {
    *
    * @param {string} parentId the parent id or the id of the item itself, if the path is missing
    * @param {string} [path]
+   * @param {string} [type] optional file mimetype
    * @returns {Promise<DriveItemInfo>}
    */
-  async getItemFromPath(parentId, path) {
+  async getItemFromPath(parentId, path, type) {
     if (!path) {
       try {
         let item = lru.get(parentId);
@@ -419,7 +432,7 @@ export class GoogleClient {
     }
 
     const segs = createPathSegments(path);
-    const items = await this.getDriveItemsFromSegments(parentId, segs, '');
+    const items = await this.getDriveItemsFromSegments(parentId, segs, '', type);
     const item = items?.[0];
     if (!item) {
       return null;
@@ -430,7 +443,7 @@ export class GoogleClient {
   /**
    * Returns an (uncached) file directly via the google api
    * @param {string} fileId
-   * @returns {string} file data
+   * @returns {Promise<string>} file data
    */
   async getFile(fileId) {
     try {
@@ -454,10 +467,11 @@ export class GoogleClient {
    * @param {string} parentId
    * @param {string} path
    * @param {boolean} noRetry {@code true} to avoid retry
+   * @param {string} [type] optional file mimetype
    * @returns {Promise<string>|null} The data of the file or {@code null} if the file does not exist
    */
-  async getFileFromPath(parentId, path, noRetry) {
-    const item = await this.getItemFromPath(parentId, path);
+  async getFileFromPath(parentId, path, noRetry, type) {
+    const item = await this.getItemFromPath(parentId, path, type);
     if (!item) {
       return null;
     }
@@ -479,9 +493,9 @@ export class GoogleClient {
   }
 
   /**
-   * Returns an (uncached) document directly via the google api
+   * Returns an (uncached) document directly via the google docs api
    * @param {string} documentId
-   * @returns {object} document
+   * @returns {Promise<object>} document
    */
   async getDocument(documentId) {
     const docs = google.docs({
@@ -509,7 +523,7 @@ export class GoogleClient {
    * @returns {Promise<object>|null} The document or {@code null} if the document does not exist
    */
   async getDocumentFromPath(parentId, path, noRetry) {
-    const item = await this.getItemFromPath(parentId, path);
+    const item = await this.getItemFromPath(parentId, path, GoogleClient.TYPE_DOCUMENT);
     if (!item) {
       return null;
     }
@@ -530,3 +544,8 @@ export class GoogleClient {
     }
   }
 }
+
+Object.assign(GoogleClient, {
+  TYPE_DOCUMENT: 'application/vnd.google-apps.document',
+  TYPE_SPREADSHEET: 'application/vnd.google-apps.spreadsheet',
+});