graphile-presigned-url-plugin 0.9.0 → 0.11.0

package/esm/s3-signer.d.ts

@@ -28,9 +28,16 @@ export declare function generatePresignedPutUrl(s3Config: S3Config, key: string,
  */
 export declare function generatePresignedGetUrl(s3Config: S3Config, key: string, expiresIn?: number, filename?: string): Promise<string>;
 /**
- * Check if an object exists in S3 and optionally verify its content-type.
+ * Delete an object from S3.
+ *
+ * Idempotent — deleting a non-existent key is a no-op (S3 returns 204).
  *
- * Checks whether an object exists in S3 and retrieves its content-type.
+ * @param s3Config - S3 client and bucket configuration
+ * @param key - S3 object key to delete
+ */
+export declare function deleteS3Object(s3Config: S3Config, key: string): Promise<void>;
+/**
+ * Check if an object exists in S3 and optionally verify its content-type.
  *
  * @param s3Config - S3 client and bucket configuration
  * @param key - S3 object key

package/esm/s3-signer.js

@@ -1,4 +1,4 @@
-import { PutObjectCommand, GetObjectCommand, HeadObjectCommand, } from '@aws-sdk/client-s3';
+import { PutObjectCommand, GetObjectCommand, HeadObjectCommand, DeleteObjectCommand, } from '@aws-sdk/client-s3';
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
 import { Logger } from '@pgpmjs/logger';
 const log = new Logger('graphile-presigned-url:s3');
@@ -54,9 +54,22 @@ export async function generatePresignedGetUrl(s3Config, key, expiresIn = 3600, f
     return url;
 }
 /**
- * Check if an object exists in S3 and optionally verify its content-type.
+ * Delete an object from S3.
+ *
+ * Idempotent — deleting a non-existent key is a no-op (S3 returns 204).
  *
- * Checks whether an object exists in S3 and retrieves its content-type.
+ * @param s3Config - S3 client and bucket configuration
+ * @param key - S3 object key to delete
+ */
+export async function deleteS3Object(s3Config, key) {
+    await s3Config.client.send(new DeleteObjectCommand({
+        Bucket: s3Config.bucket,
+        Key: key,
+    }));
+    log.debug(`Deleted S3 object: bucket=${s3Config.bucket}, key=${key}`);
+}
+/**
+ * Check if an object exists in S3 and optionally verify its content-type.
  *
  * @param s3Config - S3 client and bucket configuration
  * @param key - S3 object key

package/esm/storage-module-cache.d.ts

@@ -66,6 +66,39 @@ export declare function resolveStorageModuleByFileId(pgClient: {
         bucket_id: string;
     };
 } | null>;
+/**
+ * Load all storage modules for a database, using the LRU cache.
+ *
+ * Returns an array of all StorageModuleConfig entries (app-level + entity-scoped).
+ * The result is cached per-database so subsequent calls avoid the DB query.
+ */
+export declare function loadAllStorageModules(pgClient: {
+    query: (opts: {
+        text: string;
+        values?: unknown[];
+    }) => Promise<{
+        rows: unknown[];
+    }>;
+}, databaseId: string): Promise<StorageModuleConfig[]>;
+/**
+ * Resolve the storage module config from a PostGraphile pgCodec.
+ *
+ * Matches the codec's schema + table name against cached storage modules.
+ * Works for both files codecs (@storageFiles) and buckets codecs (@storageBuckets).
+ *
+ * @param pgCodec - The PostGraphile codec (has extensions.pg.schemaName, name)
+ * @param allConfigs - All storage module configs for this database
+ * @returns The matching StorageModuleConfig or null
+ */
+export declare function resolveStorageConfigFromCodec(pgCodec: {
+    name: string;
+    extensions?: {
+        pg?: {
+            schemaName?: string;
+        };
+    };
+    sqlType?: string;
+}, allConfigs: StorageModuleConfig[]): StorageModuleConfig | null;
 /**
  * Resolve bucket metadata for a given database + bucket key, using the LRU cache.
  *

package/esm/storage-module-cache.js

@@ -257,6 +257,51 @@ export async function resolveStorageModuleByFileId(pgClient, databaseId, fileId)
     }
     return null;
 }
+/**
+ * Load all storage modules for a database, using the LRU cache.
+ *
+ * Returns an array of all StorageModuleConfig entries (app-level + entity-scoped).
+ * The result is cached per-database so subsequent calls avoid the DB query.
+ */
+export async function loadAllStorageModules(pgClient, databaseId) {
+    const cacheKey = `storage:${databaseId}:all-list`;
+    const cached = storageModuleCache.get(cacheKey);
+    if (cached) {
+        return cached._allConfigs;
+    }
+    log.debug(`Loading all storage modules for database ${databaseId}`);
+    const result = await pgClient.query({ text: ALL_STORAGE_MODULES_QUERY, values: [databaseId] });
+    const configs = result.rows.map(buildConfig);
+    // Cache each individual config by its membership type
+    for (const config of configs) {
+        const key = config.membershipType === null
+            ? `storage:${databaseId}:app`
+            : `storage:${databaseId}:mt:${config.membershipType}`;
+        storageModuleCache.set(key, config);
+    }
+    // Store the full list under a sentinel key
+    const sentinel = { ...configs[0] || {}, _allConfigs: configs };
+    storageModuleCache.set(cacheKey, sentinel);
+    return configs;
+}
+/**
+ * Resolve the storage module config from a PostGraphile pgCodec.
+ *
+ * Matches the codec's schema + table name against cached storage modules.
+ * Works for both files codecs (@storageFiles) and buckets codecs (@storageBuckets).
+ *
+ * @param pgCodec - The PostGraphile codec (has extensions.pg.schemaName, name)
+ * @param allConfigs - All storage module configs for this database
+ * @returns The matching StorageModuleConfig or null
+ */
+export function resolveStorageConfigFromCodec(pgCodec, allConfigs) {
+    const schemaName = pgCodec.extensions?.pg?.schemaName;
+    const tableName = pgCodec.name;
+    if (!schemaName || !tableName)
+        return null;
+    return allConfigs.find((c) => (c.filesTableName === tableName && c.schemaName === schemaName) ||
+        (c.bucketsTableName === tableName && c.schemaName === schemaName)) || null;
+}
 // --- Bucket metadata cache ---
 /**
  * LRU cache for per-database bucket metadata.

package/index.d.ts

@@ -1,9 +1,10 @@
 /**
  * Presigned URL Plugin for PostGraphile v5
  *
- * Provides presigned URL upload capabilities for PostGraphile v5:
- * - requestUploadUrl mutation (presigned PUT URL generation + dedup)
- * - downloadUrl computed field (presigned GET URL / public URL)
+ * Provides per-table S3 storage middleware for PostGraphile v5:
+ * - Upload fields on @storageBuckets types (requestUploadUrl, requestBulkUploadUrls)
+ * - Delete middleware on @storageFiles tables (S3 cleanup on delete)
+ * - downloadUrl computed field on @storageFiles types
  *
  * @example
  * ```typescript
@@ -28,6 +29,6 @@
 export { PresignedUrlPlugin, createPresignedUrlPlugin } from './plugin';
 export { createDownloadUrlPlugin } from './download-url-field';
 export { PresignedUrlPreset } from './preset';
-export { getStorageModuleConfig, getStorageModuleConfigForOwner, getBucketConfig, resolveStorageModuleByFileId, clearStorageModuleCache, clearBucketCache, isS3BucketProvisioned, markS3BucketProvisioned } from './storage-module-cache';
-export { generatePresignedPutUrl, generatePresignedGetUrl, headObject } from './s3-signer';
+export { getStorageModuleConfig, getStorageModuleConfigForOwner, getBucketConfig, resolveStorageModuleByFileId, loadAllStorageModules, resolveStorageConfigFromCodec, clearStorageModuleCache, clearBucketCache, isS3BucketProvisioned, markS3BucketProvisioned } from './storage-module-cache';
+export { generatePresignedPutUrl, generatePresignedGetUrl, deleteS3Object, headObject } from './s3-signer';
 export type { BucketConfig, StorageModuleConfig, RequestUploadUrlInput, RequestUploadUrlPayload, S3Config, S3ConfigOrGetter, PresignedUrlPluginOptions, BucketNameResolver, EnsureBucketProvisioned, } from './types';

package/index.js

@@ -2,9 +2,10 @@
 /**
  * Presigned URL Plugin for PostGraphile v5
  *
- * Provides presigned URL upload capabilities for PostGraphile v5:
- * - requestUploadUrl mutation (presigned PUT URL generation + dedup)
- * - downloadUrl computed field (presigned GET URL / public URL)
+ * Provides per-table S3 storage middleware for PostGraphile v5:
+ * - Upload fields on @storageBuckets types (requestUploadUrl, requestBulkUploadUrls)
+ * - Delete middleware on @storageFiles tables (S3 cleanup on delete)
+ * - downloadUrl computed field on @storageFiles types
  *
  * @example
  * ```typescript
@@ -27,7 +28,7 @@
  * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.headObject = exports.generatePresignedGetUrl = exports.generatePresignedPutUrl = exports.markS3BucketProvisioned = exports.isS3BucketProvisioned = exports.clearBucketCache = exports.clearStorageModuleCache = exports.resolveStorageModuleByFileId = exports.getBucketConfig = exports.getStorageModuleConfigForOwner = exports.getStorageModuleConfig = exports.PresignedUrlPreset = exports.createDownloadUrlPlugin = exports.createPresignedUrlPlugin = exports.PresignedUrlPlugin = void 0;
+exports.headObject = exports.deleteS3Object = exports.generatePresignedGetUrl = exports.generatePresignedPutUrl = exports.markS3BucketProvisioned = exports.isS3BucketProvisioned = exports.clearBucketCache = exports.clearStorageModuleCache = exports.resolveStorageConfigFromCodec = exports.loadAllStorageModules = exports.resolveStorageModuleByFileId = exports.getBucketConfig = exports.getStorageModuleConfigForOwner = exports.getStorageModuleConfig = exports.PresignedUrlPreset = exports.createDownloadUrlPlugin = exports.createPresignedUrlPlugin = exports.PresignedUrlPlugin = void 0;
 var plugin_1 = require("./plugin");
 Object.defineProperty(exports, "PresignedUrlPlugin", { enumerable: true, get: function () { return plugin_1.PresignedUrlPlugin; } });
 Object.defineProperty(exports, "createPresignedUrlPlugin", { enumerable: true, get: function () { return plugin_1.createPresignedUrlPlugin; } });
@@ -40,6 +41,8 @@ Object.defineProperty(exports, "getStorageModuleConfig", { enumerable: true, get
 Object.defineProperty(exports, "getStorageModuleConfigForOwner", { enumerable: true, get: function () { return storage_module_cache_1.getStorageModuleConfigForOwner; } });
 Object.defineProperty(exports, "getBucketConfig", { enumerable: true, get: function () { return storage_module_cache_1.getBucketConfig; } });
 Object.defineProperty(exports, "resolveStorageModuleByFileId", { enumerable: true, get: function () { return storage_module_cache_1.resolveStorageModuleByFileId; } });
+Object.defineProperty(exports, "loadAllStorageModules", { enumerable: true, get: function () { return storage_module_cache_1.loadAllStorageModules; } });
+Object.defineProperty(exports, "resolveStorageConfigFromCodec", { enumerable: true, get: function () { return storage_module_cache_1.resolveStorageConfigFromCodec; } });
 Object.defineProperty(exports, "clearStorageModuleCache", { enumerable: true, get: function () { return storage_module_cache_1.clearStorageModuleCache; } });
 Object.defineProperty(exports, "clearBucketCache", { enumerable: true, get: function () { return storage_module_cache_1.clearBucketCache; } });
 Object.defineProperty(exports, "isS3BucketProvisioned", { enumerable: true, get: function () { return storage_module_cache_1.isS3BucketProvisioned; } });
@@ -47,4 +50,5 @@ Object.defineProperty(exports, "markS3BucketProvisioned", { enumerable: true, ge
 var s3_signer_1 = require("./s3-signer");
 Object.defineProperty(exports, "generatePresignedPutUrl", { enumerable: true, get: function () { return s3_signer_1.generatePresignedPutUrl; } });
 Object.defineProperty(exports, "generatePresignedGetUrl", { enumerable: true, get: function () { return s3_signer_1.generatePresignedGetUrl; } });
+Object.defineProperty(exports, "deleteS3Object", { enumerable: true, get: function () { return s3_signer_1.deleteS3Object; } });
 Object.defineProperty(exports, "headObject", { enumerable: true, get: function () { return s3_signer_1.headObject; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphile-presigned-url-plugin",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "Presigned URL upload plugin for PostGraphile v5 — requestUploadUrl mutation and downloadUrl computed field",
   "author": "Constructive <developers@constructive.io>",
   "homepage": "https://github.com/constructive-io/constructive",
@@ -42,7 +42,7 @@
   "dependencies": {
     "@aws-sdk/client-s3": "^3.1009.0",
     "@aws-sdk/s3-request-presigner": "^3.1009.0",
-    "@pgpmjs/logger": "^2.6.0",
+    "@pgpmjs/logger": "^2.7.0",
     "@pgsql/quotes": "^17.1.0",
     "lru-cache": "^11.2.7"
   },
@@ -56,9 +56,9 @@
     "postgraphile": "5.0.0"
   },
   "devDependencies": {
-    "@constructive-io/s3-utils": "^2.12.1",
+    "@constructive-io/s3-utils": "^2.13.0",
     "@types/node": "^22.19.11",
     "makage": "^0.1.10"
   },
-  "gitHead": "caf38236170287e2ad06d5c47482ce246fb3233e"
+  "gitHead": "7409479a981ff63a0937b5406a1c206a07b264ad"
 }

package/plugin.d.ts

@@ -1,18 +1,22 @@
 /**
- * Presigned URL Plugin for PostGraphile v5
+ * Per-Table Storage Middleware Plugin for PostGraphile v5
  *
- * Adds presigned URL upload support to PostGraphile v5:
+ * Hooks into PostGraphile's auto-generated CRUD mutations to add S3 operations:
  *
- * 1. `requestUploadUrl` mutation — generates a presigned PUT URL for direct
- *    client-to-S3 upload. Checks bucket access via RLS, deduplicates by
- *    content hash via UNIQUE(bucket_id, key) constraint.
+ * 1. Delete middleware — wraps `delete*` mutations on `@storageFiles`-tagged tables
+ *    with S3 object cleanup (sync + async GC fallback via AFTER DELETE trigger).
  *
- * 2. `downloadUrl` computed field on File types — generates presigned GET URLs
- *    for private files, returns public URL prefix + key for public files.
+ * 2. Upload fields — adds `requestUploadUrl` and `requestBulkUploadUrls` fields
+ *    on `@storageBuckets`-tagged types, so clients upload via the typed bucket API.
  *
- * Uses the extendSchema + grafast plan pattern (same as PublicKeySignature).
+ * 3. downloadUrl — handled by download-url-field.ts (separate plugin).
+ *
+ * No global mutations — all S3 operations are scoped to the per-table types that
+ * PostGraphile already generates. Scope resolution uses the codec's schema/table
+ * name matched against cached storage module configs.
  */
 import type { GraphileConfig } from 'graphile-config';
+import 'graphile-build';
 import type { PresignedUrlPluginOptions } from './types';
 export declare function createPresignedUrlPlugin(options: PresignedUrlPluginOptions): GraphileConfig.Plugin;
 export declare const PresignedUrlPlugin: typeof createPresignedUrlPlugin;