graphile-presigned-url-plugin 0.10.0 → 0.12.0

package/download-url-field.d.ts

@@ -19,6 +19,7 @@
  * the plan() function is required for Grafast to execute the S3 signing.
  */
 import type { GraphileConfig } from 'graphile-config';
+import 'graphile-build';
 import type { PresignedUrlPluginOptions } from './types';
 export declare function createDownloadUrlPlugin(options: PresignedUrlPluginOptions): GraphileConfig.Plugin;
 export default createDownloadUrlPlugin;

package/download-url-field.js

@@ -21,6 +21,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createDownloadUrlPlugin = createDownloadUrlPlugin;
+require("graphile-build");
 const grafast_1 = require("grafast");
 const logger_1 = require("@pgpmjs/logger");
 const s3_signer_1 = require("./s3-signer");
@@ -86,17 +87,16 @@ function createDownloadUrlPlugin(options) {
                     }
                     log.debug(`Adding downloadUrl field to type: ${pgCodec.name} (has @storageFiles tag)`);
                     const { graphql: { GraphQLString }, } = build;
+                    const capturedCodec = pgCodec;
                     return build.extend(fields, {
                         downloadUrl: context.fieldWithHooks({ fieldName: 'downloadUrl' }, {
                             description: 'URL to download this file. For public files, returns the public URL. ' +
                                 'For private files, returns a time-limited presigned URL.',
                             type: GraphQLString,
                             plan($parent) {
-                                // Access file attributes from the parent PgSelectSingleStep
                                 const $key = $parent.get('key');
                                 const $isPublic = $parent.get('is_public');
                                 const $filename = $parent.get('filename');
-                                // Access GraphQL context for per-database config resolution
                                 const $withPgClient = (0, grafast_1.context)().get('withPgClient');
                                 const $pgSettings = (0, grafast_1.context)().get('pgSettings');
                                 const $combined = (0, grafast_1.object)({
@@ -109,9 +109,8 @@ function createDownloadUrlPlugin(options) {
                                 return (0, grafast_1.lambda)($combined, async ({ key, isPublic, filename, withPgClient, pgSettings }) => {
                                     if (!key)
                                         return null;
-                                    // Resolve per-database config (bucket, publicUrlPrefix, expiry)
-                                    let s3ForDb = resolveS3(options); // fallback to global
-                                    let downloadUrlExpirySeconds = 3600; // fallback default
+                                    let s3ForDb = resolveS3(options);
+                                    let downloadUrlExpirySeconds = 3600;
                                     try {
                                         if (withPgClient && pgSettings) {
                                             const resolved = await withPgClient(null, async (pgClient) => {
@@ -121,7 +120,8 @@ function createDownloadUrlPlugin(options) {
                                                 const databaseId = dbResult.rows[0]?.id;
                                                 if (!databaseId)
                                                     return null;
-                                                const config = await (0, storage_module_cache_1.getStorageModuleConfig)(pgClient, databaseId);
+                                                const allConfigs = await (0, storage_module_cache_1.loadAllStorageModules)(pgClient, databaseId);
+                                                const config = (0, storage_module_cache_1.resolveStorageConfigFromCodec)(capturedCodec, allConfigs);
                                                 if (!config)
                                                     return null;
                                                 return { config, databaseId };
@@ -136,10 +136,8 @@ function createDownloadUrlPlugin(options) {
                                         // Fall back to global config if lookup fails
                                     }
                                     if (isPublic && s3ForDb.publicUrlPrefix) {
-                                        // Public file: return direct CDN URL (per-database prefix)
                                         return `${s3ForDb.publicUrlPrefix}/${key}`;
                                     }
-                                    // Private file: generate presigned GET URL (per-database bucket)
                                     return (0, s3_signer_1.generatePresignedGetUrl)(s3ForDb, key, downloadUrlExpirySeconds, filename || undefined);
                                 });
                             },

package/esm/download-url-field.d.ts

@@ -19,6 +19,7 @@
  * the plan() function is required for Grafast to execute the S3 signing.
  */
 import type { GraphileConfig } from 'graphile-config';
+import 'graphile-build';
 import type { PresignedUrlPluginOptions } from './types';
 export declare function createDownloadUrlPlugin(options: PresignedUrlPluginOptions): GraphileConfig.Plugin;
 export default createDownloadUrlPlugin;

package/esm/download-url-field.js

@@ -18,10 +18,11 @@
  * lookups. Since downloadUrl is a computed field (not a real column),
  * the plan() function is required for Grafast to execute the S3 signing.
  */
+import 'graphile-build';
 import { context as grafastContext, lambda, object } from 'grafast';
 import { Logger } from '@pgpmjs/logger';
 import { generatePresignedGetUrl } from './s3-signer';
-import { getStorageModuleConfig } from './storage-module-cache';
+import { loadAllStorageModules, resolveStorageConfigFromCodec } from './storage-module-cache';
 const log = new Logger('graphile-presigned-url:download-url');
 /**
  * Creates the downloadUrl computed field plugin.
@@ -83,17 +84,16 @@ export function createDownloadUrlPlugin(options) {
                     }
                     log.debug(`Adding downloadUrl field to type: ${pgCodec.name} (has @storageFiles tag)`);
                     const { graphql: { GraphQLString }, } = build;
+                    const capturedCodec = pgCodec;
                     return build.extend(fields, {
                         downloadUrl: context.fieldWithHooks({ fieldName: 'downloadUrl' }, {
                             description: 'URL to download this file. For public files, returns the public URL. ' +
                                 'For private files, returns a time-limited presigned URL.',
                             type: GraphQLString,
                             plan($parent) {
-                                // Access file attributes from the parent PgSelectSingleStep
                                 const $key = $parent.get('key');
                                 const $isPublic = $parent.get('is_public');
                                 const $filename = $parent.get('filename');
-                                // Access GraphQL context for per-database config resolution
                                 const $withPgClient = grafastContext().get('withPgClient');
                                 const $pgSettings = grafastContext().get('pgSettings');
                                 const $combined = object({
@@ -106,9 +106,8 @@ export function createDownloadUrlPlugin(options) {
                                 return lambda($combined, async ({ key, isPublic, filename, withPgClient, pgSettings }) => {
                                     if (!key)
                                         return null;
-                                    // Resolve per-database config (bucket, publicUrlPrefix, expiry)
-                                    let s3ForDb = resolveS3(options); // fallback to global
-                                    let downloadUrlExpirySeconds = 3600; // fallback default
+                                    let s3ForDb = resolveS3(options);
+                                    let downloadUrlExpirySeconds = 3600;
                                     try {
                                         if (withPgClient && pgSettings) {
                                             const resolved = await withPgClient(null, async (pgClient) => {
@@ -118,7 +117,8 @@ export function createDownloadUrlPlugin(options) {
                                                 const databaseId = dbResult.rows[0]?.id;
                                                 if (!databaseId)
                                                     return null;
-                                                const config = await getStorageModuleConfig(pgClient, databaseId);
+                                                const allConfigs = await loadAllStorageModules(pgClient, databaseId);
+                                                const config = resolveStorageConfigFromCodec(capturedCodec, allConfigs);
                                                 if (!config)
                                                     return null;
                                                 return { config, databaseId };
@@ -133,10 +133,8 @@ export function createDownloadUrlPlugin(options) {
                                         // Fall back to global config if lookup fails
                                     }
                                     if (isPublic && s3ForDb.publicUrlPrefix) {
-                                        // Public file: return direct CDN URL (per-database prefix)
                                         return `${s3ForDb.publicUrlPrefix}/${key}`;
                                     }
-                                    // Private file: generate presigned GET URL (per-database bucket)
                                     return generatePresignedGetUrl(s3ForDb, key, downloadUrlExpirySeconds, filename || undefined);
                                 });
                             },

package/esm/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/esm/index.js

@@ -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,5 +29,5 @@
 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';

package/esm/plugin.d.ts

@@ -1,18 +1,25 @@
 /**
- * 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. Mutation entry points — adds per-bucket mutation fields on the root Mutation
+ *    type (e.g., `appBucket(key: "public"): AppBucket`), so upload operations
+ *    can be accessed as proper GraphQL mutations instead of queries.
+ *
+ * 4. downloadUrl — handled by download-url-field.ts (separate plugin).
+ *
+ * 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;