@genoacms/adapter-gcp 0.1.1 → 0.3.8

package/dist/config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: Config<object, object, object>;
+export default _default;

package/dist/config.js

@@ -0,0 +1,2 @@
+import { config } from '@genoacms/cloudabstraction';
+export default config;

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

@@ -0,0 +1,7 @@
+import type { database as databaseT } from '@genoacms/cloudabstraction';
+declare const createDocument: databaseT.createDocument;
+declare const getCollection: databaseT.getCollection;
+declare const getDocument: databaseT.getDocument;
+declare const updateDocument: databaseT.updateDocument;
+declare const deleteDocument: databaseT.deleteDocument;
+export { createDocument, getDocument, getCollection, updateDocument, deleteDocument };

package/dist/services/database/index.js

@@ -0,0 +1,61 @@
+import { Firestore } from '@google-cloud/firestore';
+import config from '../../config.js';
+const firestore = new Firestore({
+    credentials: config.database.credentials,
+    databaseId: config.database.databaseId,
+    projectId: config.database.projectId
+});
+const createDocument = async (reference, data) => {
+    const document = await firestore.collection(reference.name).add(data);
+    const documentReference = {
+        collection: reference,
+        id: document.id
+    };
+    return {
+        reference: documentReference,
+        data
+    };
+};
+const getCollection = async (reference) => {
+    const collection = await firestore.collection(reference.name).get();
+    const documents = [];
+    collection.forEach(document => {
+        const documentData = {};
+        Object.keys(reference.schema.properties).forEach(key => {
+            documentData[key] = document.get(key);
+        });
+        documents.push({
+            reference: {
+                collection: reference,
+                id: document.id
+            },
+            data: document.data()
+        });
+    });
+    return documents;
+};
+const getDocument = async ({ collection, id }) => {
+    const document = await firestore.collection(collection.name).doc(id).get();
+    if (!document.exists)
+        return undefined;
+    const documentReference = {
+        collection,
+        id
+    };
+    const documentSnapshot = {
+        reference: documentReference,
+        data: document.data()
+    };
+    return documentSnapshot;
+};
+const updateDocument = async (reference, document) => {
+    await firestore.collection(reference.collection.name).doc(reference.id).update(document);
+    return {
+        reference,
+        data: document
+    };
+};
+const deleteDocument = async (reference) => {
+    await firestore.collection(reference.collection.name).doc(reference.id).delete();
+};
+export { createDocument, getDocument, getCollection, updateDocument, deleteDocument };

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

@@ -0,0 +1,7 @@
+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 };

package/dist/services/storage/index.js

@@ -0,0 +1,49 @@
+import { Storage } from '@google-cloud/storage';
+import config from '../../config.js';
+const storage = new Storage({
+    credentials: config.storage.credentials
+});
+const getBucket = (name) => {
+    if (!config.storage.buckets.includes(name))
+        throw new Error('bucket-unregistered');
+    const bucket = storage.bucket(name);
+    return bucket;
+};
+const getObject = async ({ bucket, name }) => {
+    const bucketInstance = getBucket(bucket);
+    const file = bucketInstance.file(name);
+    return {
+        data: file.createReadStream()
+    };
+};
+const uploadObject = async ({ bucket, name }, stream) => {
+    const bucketInstance = getBucket(bucket);
+    const file = bucketInstance.file(name);
+    await file.save(stream);
+};
+const deleteObject = async ({ bucket, name }) => {
+    const bucketInstance = getBucket(bucket);
+    const file = bucketInstance.file(name);
+    await file.delete();
+};
+const listDirectory = async ({ bucket, name }, listingParams = {}) => {
+    const bucketInstance = getBucket(bucket);
+    const [files] = await bucketInstance.getFiles({
+        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)
+        };
+    });
+};
+const createDirectory = async ({ bucket, name }) => {
+    const bucketInstance = getBucket(bucket);
+    const file = bucketInstance.file(`${name}/.folderPlaceholder`);
+    await file.save('');
+};
+export { getObject, uploadObject, deleteObject, listDirectory, createDirectory };

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@genoacms/adapter-gcp",
-  "version": "0.1.1",
+  "version": "0.3.8",
   "description": "Implementation of abstraction layer of GenoaCMS for GCP",
-  "main": "index.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/GenoaCMS/adapter-gcp.git"
@@ -18,7 +17,7 @@
   "homepage": "https://github.com/GenoaCMS/adapter-gcp#readme",
   "type": "module",
   "dependencies": {
-    "@genoacms/cloudabstraction": "^0.1.7",
+    "@genoacms/cloudabstraction": "^0.3.8",
     "@google-cloud/firestore": "^7.1.0",
     "@google-cloud/storage": "^7.4.0"
   },
@@ -30,7 +29,8 @@
     "eslint-plugin-n": "^16.2.0",
     "eslint-plugin-promise": "^6.1.1",
     "rimraf": "^5.0.5",
-    "typescript": "^5.2.2"
+    "typescript": "^5.2.2",
+    "vitest": "^1.0.4"
   },
   "files": [
     "src",
@@ -51,6 +51,9 @@
     }
   },
   "scripts": {
-    "build": "rimraf dist && tsc"
+    "build": "rimraf dist && tsc",
+    "test:all": "npm run build && vitest --silent=false --config node_modules/@genoacms/cloudabstraction/test/vitest.config.js --run node_modules/@genoacms/cloudabstraction/test/all.test.js",
+    "test:database": "npm run build && vitest --silent=false --config node_modules/@genoacms/cloudabstraction/test/vitest.config.js --run node_modules/@genoacms/cloudabstraction/test/database.test.js",
+    "test:storage": "npm run build && vitest --silent=false --config node_modules/@genoacms/cloudabstraction/test/vitest.config.js --run node_modules/@genoacms/cloudabstraction/test/storage.test.js"
   }
 }

package/src/config.ts

@@ -0,0 +1,4 @@
+import type Config from './genoa.config.js'
+import { config } from '@genoacms/cloudabstraction'
+
+export default config satisfies Config

package/src/genoa.config.d.ts

@@ -0,0 +1,30 @@
+import type Config from '@genoacms/cloudabstraction/src/genoa.config.js'
+
+interface Credentials {
+  type: string
+  'project_id': string
+  'private_key_id': string
+  'private_key': string
+  'client_email': string
+  'client_id': string
+  'auth_uri': string
+  'token_uri': string
+  'auth_provider_x509_cert_url': string
+  'client_x509_cert_url': string
+  'universe_domain': string
+}
+
+interface DatabaseConfig {
+  credentials: Credentials
+  databaseId: string
+  region: string
+}
+
+interface StorageConfig {
+  credentials: Credentials
+  buckets: string[]
+}
+
+interface ConfigGCP extends Config<object, DatabaseConfig, StorageConfig> {}
+
+export default ConfigGCP

package/src/services/database/index.ts

@@ -0,0 +1,76 @@
+import { Firestore } from '@google-cloud/firestore'
+import config from '../../config.js'
+import type { database as databaseT } from '@genoacms/cloudabstraction'
+
+const firestore = new Firestore({
+  credentials: config.database.credentials,
+  databaseId: config.database.databaseId,
+  projectId: config.database.projectId
+})
+
+const createDocument: databaseT.createDocument = async (reference, data) => {
+  const document = await firestore.collection(reference.name).add(data)
+  const documentReference: databaseT.DocumentReference<typeof reference> = {
+    collection: reference,
+    id: document.id
+  }
+  return {
+    reference: documentReference,
+    data
+  } satisfies databaseT.DocumentSnapshot<typeof reference>
+}
+
+const getCollection: databaseT.getCollection = async (reference) => {
+  const collection = await firestore.collection(reference.name).get()
+  const documents: databaseT.CollectionSnapshot<typeof reference> = []
+
+  collection.forEach(document => {
+    const documentData: databaseT.Document<typeof reference.schema> = {}
+    Object.keys(reference.schema.properties).forEach(key => {
+      documentData[key] = document.get(key)
+    })
+
+    documents.push({
+      reference: {
+        collection: reference,
+        id: document.id
+      },
+      data: document.data() as databaseT.Document<typeof reference.schema>
+    })
+  })
+  return documents
+}
+
+const getDocument: databaseT.getDocument = async ({ collection, id }) => {
+  const document = await firestore.collection(collection.name).doc(id).get()
+  if (!document.exists) return undefined
+  const documentReference: databaseT.DocumentReference<typeof collection> = {
+    collection,
+    id
+  }
+  const documentSnapshot: databaseT.DocumentSnapshot<typeof collection> = {
+    reference: documentReference,
+    data: document.data() as databaseT.Document<typeof collection>
+  }
+  return documentSnapshot
+}
+
+const updateDocument: databaseT.updateDocument = async (reference, document) => {
+  await firestore.collection(reference.collection.name).doc(reference.id).update(document)
+  return {
+    reference,
+    data: document
+  } satisfies databaseT.UpdateSnapshot<typeof reference.collection>
+}
+
+const deleteDocument: databaseT.deleteDocument = async (reference) => {
+  await firestore.collection(reference.collection.name).doc(reference.id).delete()
+}
+
+export {
+  createDocument,
+  getDocument,
+  getCollection,
+  updateDocument,
+  deleteDocument
+}

package/src/services/storage/index.ts

@@ -1,31 +1,66 @@
 import type {
   storage as storageT
 } from '@genoacms/cloudabstraction'
-import { Storage } from '@google-cloud/storage'
-import { config } from '@genoacms/cloudabstraction'
+import { type Bucket, Storage } from '@google-cloud/storage'
+import config from '../../config.js'
 
 const storage = new Storage({
-  // @ts-expect-error: TODO: type this adapter
-  credentials: config.adapter.gcp.credentials
+  credentials: config.storage.credentials
 })
-// @ts-expect-error: TODO: type this adapter
-const bucket = storage.bucket(config.adapter.gcp.storage.bucket)
 
-const listDirectory: storageT.listDirectory = async ({ limit, prefix }) => {
-  const [files] = await bucket.getFiles({
-    prefix,
-    maxResults: limit
+const getBucket = (name: string): Bucket => {
+  if (!config.storage.buckets.includes(name)) throw new Error('bucket-unregistered')
+  const bucket = storage.bucket(name)
+  return bucket
+}
+
+const getObject: storageT.getObject = async ({ bucket, name }) => {
+  const bucketInstance = getBucket(bucket)
+  const file = bucketInstance.file(name)
+
+  return {
+    data: file.createReadStream()
+  }
+}
+
+const uploadObject: storageT.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 bucketInstance = getBucket(bucket)
+  const file = bucketInstance.file(name)
+  await file.delete()
+}
+
+const listDirectory: storageT.listDirectory = async ({ bucket, name }, listingParams = {}) => {
+  const bucketInstance = getBucket(bucket)
+  const [files] = await bucketInstance.getFiles({
+    prefix: name,
+    maxResults: listingParams?.limit,
+    startOffset: listingParams?.startAfter
   })
   return files.map((file) => {
     return {
       name: file.name,
-      size: file.metadata.size,
-      // @ts-expect-error: Handle this
-      lastModified: new Date(file.metadata.updated)
-    } as storageT.StorageObject
+      size: file.metadata.size ? parseInt(file.metadata.size as string) : 0,
+      lastModified: new Date(file.metadata.updated as string)
+    } satisfies storageT.StorageObject
   })
 }
 
+const createDirectory: storageT.createDirectory = async ({ bucket, name }) => {
+  const bucketInstance = getBucket(bucket)
+  const file = bucketInstance.file(`${name}/.folderPlaceholder`)
+  await file.save('')
+}
+
 export {
-  listDirectory
+  getObject,
+  uploadObject,
+  deleteObject,
+  listDirectory,
+  createDirectory
 }

package/dist/database/index.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/database/index.js

@@ -1 +0,0 @@
-export {};

package/dist/storage/index.d.ts

@@ -1,3 +0,0 @@
-import type { storage as storageT } from '@genoacms/cloudabstraction';
-declare const listDirectory: storageT.listDirectory;
-export { listDirectory };

package/dist/storage/index.js

@@ -1,23 +0,0 @@
-import { Storage } from '@google-cloud/storage';
-import { config } from '@genoacms/cloudabstraction';
-const storage = new Storage({
-    // @ts-expect-error: TODO: type this adapter
-    credentials: config.adapter.gcp.credentials
-});
-// @ts-expect-error: TODO: type this adapter
-const bucket = storage.bucket(config.adapter.gcp.storage.bucket);
-const listDirectory = async ({ limit, prefix }) => {
-    const [files] = await bucket.getFiles({
-        prefix,
-        maxResults: limit
-    });
-    return files.map((file) => {
-        return {
-            name: file.name,
-            size: file.metadata.size,
-            // @ts-expect-error: Handle this
-            lastModified: new Date(file.metadata.updated)
-        };
-    });
-};
-export { listDirectory };