@genoacms/adapter-gcp 0.3.8 → 0.3.13

package/dist/services/storage/index.d.ts

@@ -1,7 +1,9 @@
-import type { storage as storageT } from '@genoacms/cloudabstraction';
-declare const getObject: storageT.getObject;
-declare const uploadObject: storageT.uploadObject;
-declare const deleteObject: storageT.deleteObject;
-declare const listDirectory: storageT.listDirectory;
-declare const createDirectory: storageT.createDirectory;
-export { getObject, uploadObject, deleteObject, listDirectory, createDirectory };
+import type { Adapter } from '@genoacms/cloudabstraction/storage';
+declare const getObject: Adapter['getObject'];
+declare const getPublicURL: Adapter['getPublicURL'];
+declare const getSignedURL: Adapter['getSignedURL'];
+declare const uploadObject: Adapter['uploadObject'];
+declare const deleteObject: Adapter['deleteObject'];
+declare const listDirectory: Adapter['listDirectory'];
+declare const createDirectory: Adapter['createDirectory'];
+export { getObject, getPublicURL, getSignedURL, uploadObject, deleteObject, listDirectory, createDirectory };

package/dist/services/storage/index.js

@@ -16,6 +16,22 @@ const getObject = async ({ bucket, name }) => {
         data: file.createReadStream()
     };
 };
+const getPublicURL = async ({ bucket, name }) => {
+    const bucketInstance = getBucket(bucket);
+    const file = bucketInstance.file(name);
+    return file.publicUrl();
+};
+const getSignedURL = async ({ bucket, name }) => {
+    const bucketInstance = getBucket(bucket);
+    const file = bucketInstance.file(name);
+    const expires = new Date();
+    expires.setTime(expires.getTime() + 60 * 60);
+    const [url] = await file.getSignedUrl({
+        action: 'read',
+        expires
+    });
+    return url;
+};
 const uploadObject = async ({ bucket, name }, stream) => {
     const bucketInstance = getBucket(bucket);
     const file = bucketInstance.file(name);
@@ -28,22 +44,30 @@ const deleteObject = async ({ bucket, name }) => {
 };
 const listDirectory = async ({ bucket, name }, listingParams = {}) => {
     const bucketInstance = getBucket(bucket);
-    const [files] = await bucketInstance.getFiles({
+    const options = {
+        autoPaginate: false,
         prefix: name,
         maxResults: listingParams?.limit,
-        startOffset: listingParams?.startAfter
-    });
-    return files.map((file) => {
-        return {
-            name: file.name,
-            size: file.metadata.size ? parseInt(file.metadata.size) : 0,
-            lastModified: new Date(file.metadata.updated)
-        };
-    });
+        startOffset: listingParams?.startAfter,
+        delimiter: '/'
+    };
+    let [files, , apiResponse] = (await bucketInstance.getFiles(options));
+    files = files.filter((file) => !file.name.endsWith('.folderPlaceholder'));
+    return {
+        files: files.map((file) => {
+            return {
+                name: file.name,
+                // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+                size: file.metadata.size ? parseInt(file.metadata.size) : 0,
+                lastModified: new Date(file.metadata.updated)
+            };
+        }),
+        directories: apiResponse?.prefixes ?? []
+    };
 };
 const createDirectory = async ({ bucket, name }) => {
     const bucketInstance = getBucket(bucket);
     const file = bucketInstance.file(`${name}/.folderPlaceholder`);
     await file.save('');
 };
-export { getObject, uploadObject, deleteObject, listDirectory, createDirectory };
+export { getObject, getPublicURL, getSignedURL, uploadObject, deleteObject, listDirectory, createDirectory };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@genoacms/adapter-gcp",
-  "version": "0.3.8",
+  "version": "0.3.13",
   "description": "Implementation of abstraction layer of GenoaCMS for GCP",
   "repository": {
     "type": "git",
@@ -17,9 +17,9 @@
   "homepage": "https://github.com/GenoaCMS/adapter-gcp#readme",
   "type": "module",
   "dependencies": {
-    "@genoacms/cloudabstraction": "^0.3.8",
+    "@genoacms/cloudabstraction": "^0.3.13",
     "@google-cloud/firestore": "^7.1.0",
-    "@google-cloud/storage": "^7.4.0"
+    "@google-cloud/storage": "^7.7.0"
   },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^6.9.0",
@@ -38,16 +38,16 @@
   ],
   "exports": {
     "./auth": {
-      "import": "./dist/auth/index.js",
-      "types": "./dist/auth/index.d.ts"
+      "import": "./dist/services/auth/index.js",
+      "types": "./dist/services/auth/index.d.ts"
     },
     "./database": {
-      "import": "./dist/database/index.js",
-      "types": "./dist/database/index.d.ts"
+      "import": "./dist/services/database/index.js",
+      "types": "./dist/services/database/index.d.ts"
     },
     "./storage": {
-      "import": "./dist/storage/index.js",
-      "types": "./dist/storage/index.d.ts"
+      "import": "./dist/services/storage/index.js",
+      "types": "./dist/services/storage/index.d.ts"
     }
   },
   "scripts": {

package/src/services/storage/index.ts

@@ -1,7 +1,8 @@
 import type {
-  storage as storageT
-} from '@genoacms/cloudabstraction'
-import { type Bucket, Storage } from '@google-cloud/storage'
+  StorageObject,
+  Adapter
+} from '@genoacms/cloudabstraction/storage'
+import { type Bucket, Storage, type File } from '@google-cloud/storage'
 import config from '../../config.js'
 
 const storage = new Storage({
@@ -14,7 +15,7 @@ const getBucket = (name: string): Bucket => {
   return bucket
 }
 
-const getObject: storageT.getObject = async ({ bucket, name }) => {
+const getObject: Adapter['getObject'] = async ({ bucket, name }) => {
   const bucketInstance = getBucket(bucket)
   const file = bucketInstance.file(name)
 
@@ -23,35 +24,64 @@ const getObject: storageT.getObject = async ({ bucket, name }) => {
   }
 }
 
-const uploadObject: storageT.uploadObject = async ({ bucket, name }, stream) => {
+const getPublicURL: Adapter['getPublicURL'] = async ({ bucket, name }) => {
+  const bucketInstance = getBucket(bucket)
+  const file = bucketInstance.file(name)
+  return file.publicUrl()
+}
+
+const getSignedURL: Adapter['getSignedURL'] = async ({ bucket, name }) => {
+  const bucketInstance = getBucket(bucket)
+  const file = bucketInstance.file(name)
+  const expires = new Date()
+  expires.setTime(expires.getTime() + 60 * 60)
+  const [url] = await file.getSignedUrl({
+    action: 'read',
+    expires
+  })
+  return url
+}
+
+const uploadObject: Adapter['uploadObject'] = async ({ bucket, name }, stream) => {
   const bucketInstance = getBucket(bucket)
   const file = bucketInstance.file(name)
   await file.save(stream)
 }
 
-const deleteObject: storageT.deleteObject = async ({ bucket, name }) => {
+const deleteObject: Adapter['deleteObject'] = async ({ bucket, name }) => {
   const bucketInstance = getBucket(bucket)
   const file = bucketInstance.file(name)
   await file.delete()
 }
 
-const listDirectory: storageT.listDirectory = async ({ bucket, name }, listingParams = {}) => {
+const listDirectory: Adapter['listDirectory'] = async ({ bucket, name }, listingParams = {}) => {
   const bucketInstance = getBucket(bucket)
-  const [files] = await bucketInstance.getFiles({
+  const options = {
+    autoPaginate: false,
     prefix: name,
     maxResults: listingParams?.limit,
-    startOffset: listingParams?.startAfter
-  })
-  return files.map((file) => {
-    return {
-      name: file.name,
-      size: file.metadata.size ? parseInt(file.metadata.size as string) : 0,
-      lastModified: new Date(file.metadata.updated as string)
-    } satisfies storageT.StorageObject
-  })
+    startOffset: listingParams?.startAfter,
+    delimiter: '/'
+
+  }
+  let [files, , apiResponse] =
+    (await bucketInstance.getFiles(options)) as [File[], object, { prefixes: string[] } | undefined]
+  files = files.filter((file) => !file.name.endsWith('.folderPlaceholder'))
+
+  return {
+    files: files.map((file) => {
+      return {
+        name: file.name,
+        // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+        size: file.metadata.size ? parseInt(file.metadata.size as string) : 0,
+        lastModified: new Date(file.metadata.updated as string)
+      } satisfies StorageObject
+    }),
+    directories: apiResponse?.prefixes ?? []
+  }
 }
 
-const createDirectory: storageT.createDirectory = async ({ bucket, name }) => {
+const createDirectory: Adapter['createDirectory'] = async ({ bucket, name }) => {
   const bucketInstance = getBucket(bucket)
   const file = bucketInstance.file(`${name}/.folderPlaceholder`)
   await file.save('')
@@ -59,6 +89,8 @@ const createDirectory: storageT.createDirectory = async ({ bucket, name }) => {
 
 export {
   getObject,
+  getPublicURL,
+  getSignedURL,
   uploadObject,
   deleteObject,
   listDirectory,