@genoacms/adapter-gcp 0.9.0 → 0.10.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-2026 Filip Holčík
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/storage/runtime.js

@@ -1,18 +1,35 @@
 import { defineRuntime } from '@genoacms/contracts';
-import { PreconditionFailedError } from '@genoacms/contracts/storage';
+import { PreconditionFailedError, ObjectNotFoundError, NotADirectoryError, isDirectoryName } from '@genoacms/contracts/storage';
 import { Storage } from '@google-cloud/storage';
 const HTTP_PRECONDITION_FAILED = 412;
+const HTTP_NOT_FOUND = 404;
 const DELETE_CONCURRENCY = 10;
-// STO-9, GF21
-function requestedResults(limit, startAfter) {
-    return limit !== undefined && startAfter !== undefined ? limit + 1 : limit;
+const hasStatus = (error, status) => error?.code === status;
+// STO-4, STO-7, STOR-16
+async function rejectingMissing(reference, call) {
+    try {
+        return await call();
+    }
+    catch (error) {
+        if (hasStatus(error, HTTP_NOT_FOUND))
+            throw new ObjectNotFoundError(reference);
+        throw error;
+    }
 }
 // STO-9
-const byUtf8Bytes = (a, b) => Buffer.compare(Buffer.from(a), Buffer.from(b));
-// STO-9
-function firstByName(names, limit) {
-    const sorted = [...names].sort(byUtf8Bytes);
-    return new Set(limit === undefined ? sorted : sorted.slice(0, limit));
+function listingQuery(name, { limit, startAfter, pageToken }) {
+    return {
+        prefix: name,
+        delimiter: '/',
+        autoPaginate: false,
+        ...(limit === undefined ? {} : { maxResults: limit }),
+        ...(startAfter === undefined ? {} : { startOffset: startAfter }),
+        ...(pageToken === undefined ? {} : { pageToken })
+    };
+}
+// STO-11, GF38
+function everyDepthPage(prefix, pageToken) {
+    return pageToken === undefined ? { prefix, autoPaginate: false } : { prefix, autoPaginate: false, pageToken };
 }
 // STO-11, GF29
 async function deleteAtMost(concurrency, files) {
@@ -46,6 +63,16 @@ export default defineRuntime({
                 throw new Error('bucket-unregistered');
             return storage.bucket(name);
         };
+        // STO-3, STOR-3
+        const requireDirectoryName = (reference, { allowRoot }) => {
+            if (!isDirectoryName(reference.name) || (!allowRoot && reference.name === ''))
+                throw new NotADirectoryError(reference);
+        };
+        const getDirectoryBucket = (reference, options) => {
+            const bucketInstance = getBucket(reference.bucket);
+            requireDirectoryName(reference, options);
+            return bucketInstance;
+        };
         // STO-4
         const getObject = async ({ bucket, name }) => {
             const bucketInstance = getBucket(bucket);
@@ -55,7 +82,9 @@ export default defineRuntime({
                 const [metadata] = await file.getMetadata();
                 version = metadata.generation === undefined ? undefined : String(metadata.generation);
             }
-            catch {
+            catch (error) {
+                if (hasStatus(error, HTTP_NOT_FOUND))
+                    throw new ObjectNotFoundError({ bucket, name });
                 version = undefined;
             }
             return {
@@ -80,16 +109,16 @@ export default defineRuntime({
         const uploadObject = async ({ bucket, name }, stream, options) => {
             const bucketInstance = getBucket(bucket);
             const file = bucketInstance.file(name);
-            const { ifVersion, ifAbsent, ...saveOptions } = options ?? {};
+            const { ifVersion, ifAbsent } = options ?? {};
             // STO-6
             const generation = ifAbsent === true ? 0 : ifVersion === undefined ? undefined : Number(ifVersion);
             try {
                 await file.save(stream, generation === undefined
-                    ? saveOptions
-                    : { ...saveOptions, preconditionOpts: { ifGenerationMatch: generation } });
+                    ? {}
+                    : { preconditionOpts: { ifGenerationMatch: generation } });
             }
             catch (error) {
-                if (error.code === HTTP_PRECONDITION_FAILED) {
+                if (hasStatus(error, HTTP_PRECONDITION_FAILED)) {
                     throw new PreconditionFailedError({ bucket, name }, ifAbsent === true
                         ? 'object already exists'
                         : 'object changed since it was read');
@@ -105,26 +134,22 @@ export default defineRuntime({
         const deleteObject = async ({ bucket, name }) => {
             const bucketInstance = getBucket(bucket);
             const file = bucketInstance.file(name);
-            await file.delete();
+            await rejectingMissing({ bucket, name }, async () => await file.delete());
         };
-        const listDirectory = async ({ bucket, name }, listingParams = {}) => {
-            const bucketInstance = getBucket(bucket);
-            const options = {
-                autoPaginate: false,
-                prefix: name,
-                maxResults: requestedResults(listingParams?.limit, listingParams?.startAfter),
-                startOffset: listingParams?.startAfter,
-                delimiter: '/'
-            };
-            let [files, , apiResponse] = (await bucketInstance.getFiles(options));
-            files = files.filter((file) => !file.name.endsWith('.folderPlaceholder'));
-            // STO-9, GF21
-            const skipped = (itemName) => itemName === name || itemName === listingParams?.startAfter;
-            files = files.filter(f => !skipped(f.name));
-            const prefixes = (apiResponse?.prefixes ?? []).filter((item) => !skipped(item));
-            const kept = firstByName([...files.map(f => f.name), ...prefixes], listingParams?.limit);
+        // STO-9, GF21
+        const listDirectory = async (reference, listingParams = {}) => {
+            const bucketInstance = getDirectoryBucket(reference, { allowRoot: true });
+            const { bucket, name } = reference;
+            if (listingParams.limit === 0)
+                return { files: [], directories: [] };
+            const [listed, nextQuery, apiResponse] = (await bucketInstance.getFiles(listingQuery(name, listingParams)));
+            const skipped = (itemName) => itemName === name || itemName === listingParams.startAfter;
+            const files = listed.filter(file => !file.name.endsWith('.folderPlaceholder') && !skipped(file.name));
+            const prefixes = (apiResponse?.prefixes ?? []).filter(item => !skipped(item));
+            const next = nextQuery?.pageToken;
             return {
-                files: files.filter(f => kept.has(f.name)).map((file) => {
+                ...(next === undefined ? {} : { next }),
+                files: files.map((file) => {
                     return {
                         name: file.name,
                         // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
@@ -132,7 +157,7 @@ export default defineRuntime({
                         lastModified: new Date(file.metadata.updated)
                     };
                 }),
-                directories: prefixes.filter((item) => kept.has(item)).map(i => {
+                directories: prefixes.map(i => {
                     const object = {
                         bucket,
                         name: i
@@ -141,24 +166,28 @@ export default defineRuntime({
                 })
             };
         };
-        const createDirectory = async ({ bucket, name }) => {
-            const bucketInstance = getBucket(bucket);
-            const file = bucketInstance.file(`${name}/.folderPlaceholder`);
+        // STO-10, CD10
+        const createDirectory = async (reference) => {
+            const bucketInstance = getDirectoryBucket(reference, { allowRoot: false });
+            const file = bucketInstance.file(`${reference.name}.folderPlaceholder`);
             await file.save('');
         };
         // STO-11, GD7, GF29
-        const deleteDirectory = async ({ bucket, name }) => {
-            const bucketInstance = getBucket(bucket);
-            let query = { prefix: name, autoPaginate: false };
-            while (query !== undefined) {
-                const [files, nextQuery] = await bucketInstance.getFiles(query);
+        const deleteDirectory = async (reference) => {
+            const bucketInstance = getDirectoryBucket(reference, { allowRoot: false });
+            let pageToken;
+            do {
+                const [files, nextQuery] = await bucketInstance.getFiles(everyDepthPage(reference.name, pageToken));
                 await deleteAtMost(DELETE_CONCURRENCY, files);
-                query = nextQuery ?? undefined;
-            }
+                pageToken = nextQuery?.pageToken;
+            } while (pageToken !== undefined);
         };
         // STO-12, GD7, GF22
-        const moveDirectory = async ({ bucket, name }, newName) => {
-            const [files] = await getBucket(bucket).getFiles({ prefix: name });
+        const moveDirectory = async (reference, newName) => {
+            const bucketInstance = getDirectoryBucket(reference, { allowRoot: false });
+            requireDirectoryName({ bucket: reference.bucket, name: newName }, { allowRoot: false });
+            const { name } = reference;
+            const [files] = await bucketInstance.getFiles({ prefix: name });
             for (const file of files)
                 await file.move(newName + file.name.slice(name.length));
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@genoacms/adapter-gcp",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "type": "module",
   "description": "Implementation of abstraction layer of GenoaCMS for GCP",
   "repository": {
@@ -12,7 +12,7 @@
     "name": "Filip Holčík",
     "email": "filip.holcik.official@gmail.com"
   },
-  "license": "ISC",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/GenoaCMS/genoacms/issues"
   },
@@ -27,7 +27,7 @@
     "@google-cloud/storage": "^7.7.0",
     "archiver": "^7.0.0",
     "google-auth-library": "^9.15.1",
-    "@genoacms/contracts": "^0.0.2",
+    "@genoacms/contracts": "^0.0.3",
     "@genoacms/sveltekit-adapter-cloud-run-functions": "^1.0.1"
   },
   "devDependencies": {
@@ -41,7 +41,7 @@
     "rimraf": "^5.0.5",
     "typescript": "^5.2.2",
     "vitest": "^3.2.7",
-    "@genoacms/conformance": "^0.0.2"
+    "@genoacms/conformance": "^0.0.3"
   },
   "files": [
     "dist"