graphile-presigned-url-plugin 0.2.0 → 0.3.0

package/README.md

@@ -1,5 +1,17 @@
 # graphile-presigned-url-plugin
 
+<p align="center" width="100%">
+  <img height="250" src="https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg" />
+</p>
+
+<p align="center" width="100%">
+  <a href="https://github.com/constructive-io/constructive/actions/workflows/run-tests.yaml">
+    <img height="20" src="https://github.com/constructive-io/constructive/actions/workflows/run-tests.yaml/badge.svg" />
+  </a>
+   <a href="https://github.com/constructive-io/constructive/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
+   <a href="https://www.npmjs.com/package/graphile-presigned-url-plugin"><img height="20" src="https://img.shields.io/github/package-json/v/constructive-io/constructive?filename=graphile%2Fgraphile-presigned-url-plugin%2Fpackage.json"/></a>
+</p>
+
 Presigned URL upload plugin for PostGraphile v5.
 
 ## Features

package/download-url-field.d.ts

@@ -14,14 +14,5 @@
  */
 import type { GraphileConfig } from 'graphile-config';
 import type { PresignedUrlPluginOptions } from './types';
-/**
- * Creates the downloadUrl computed field plugin.
- *
- * This is a separate plugin from the main presigned URL plugin because it
- * uses the GraphQLObjectType_fields hook (low-level) rather than extendSchema.
- * The downloadUrl field needs to be added dynamically to whatever table is
- * the storage module's files table, which we discover at schema-build time
- * via the `@storageFiles` smart tag.
- */
 export declare function createDownloadUrlPlugin(options: PresignedUrlPluginOptions): GraphileConfig.Plugin;
 export default createDownloadUrlPlugin;

package/download-url-field.js

@@ -28,8 +28,19 @@ const log = new logger_1.Logger('graphile-presigned-url:download-url');
  * the storage module's files table, which we discover at schema-build time
  * via the `@storageFiles` smart tag.
  */
+/**
+ * Resolve the S3 config from the options. If the option is a lazy getter
+ * function, call it (and cache the result).
+ */
+function resolveS3(options) {
+    if (typeof options.s3 === 'function') {
+        const resolved = options.s3();
+        options.s3 = resolved;
+        return resolved;
+    }
+    return options.s3;
+}
 function createDownloadUrlPlugin(options) {
-    const { s3 } = options;
     return {
         name: 'PresignedUrlDownloadPlugin',
         version: '0.1.0',
@@ -65,6 +76,7 @@ function createDownloadUrlPlugin(options) {
                                 if (status !== 'ready' && status !== 'processed') {
                                     return null;
                                 }
+                                const s3 = resolveS3(options);
                                 if (isPublic && s3.publicUrlPrefix) {
                                     // Public file: return direct URL
                                     return `${s3.publicUrlPrefix}/${key}`;
@@ -92,7 +104,7 @@ function createDownloadUrlPlugin(options) {
                                     // Fall back to default if config lookup fails
                                 }
                                 // Private file: generate presigned GET URL
-                                return (0, s3_signer_1.generatePresignedGetUrl)(s3, key, downloadUrlExpirySeconds, filename || undefined);
+                                return (0, s3_signer_1.generatePresignedGetUrl)(resolveS3(options), key, downloadUrlExpirySeconds, filename || undefined);
                             },
                         }),
                     }, 'PresignedUrlDownloadPlugin adding downloadUrl field');

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

@@ -14,14 +14,5 @@
  */
 import type { GraphileConfig } from 'graphile-config';
 import type { PresignedUrlPluginOptions } from './types';
-/**
- * Creates the downloadUrl computed field plugin.
- *
- * This is a separate plugin from the main presigned URL plugin because it
- * uses the GraphQLObjectType_fields hook (low-level) rather than extendSchema.
- * The downloadUrl field needs to be added dynamically to whatever table is
- * the storage module's files table, which we discover at schema-build time
- * via the `@storageFiles` smart tag.
- */
 export declare function createDownloadUrlPlugin(options: PresignedUrlPluginOptions): GraphileConfig.Plugin;
 export default createDownloadUrlPlugin;

package/esm/download-url-field.js

@@ -25,8 +25,19 @@ const log = new Logger('graphile-presigned-url:download-url');
  * the storage module's files table, which we discover at schema-build time
  * via the `@storageFiles` smart tag.
  */
+/**
+ * Resolve the S3 config from the options. If the option is a lazy getter
+ * function, call it (and cache the result).
+ */
+function resolveS3(options) {
+    if (typeof options.s3 === 'function') {
+        const resolved = options.s3();
+        options.s3 = resolved;
+        return resolved;
+    }
+    return options.s3;
+}
 export function createDownloadUrlPlugin(options) {
-    const { s3 } = options;
     return {
         name: 'PresignedUrlDownloadPlugin',
         version: '0.1.0',
@@ -62,6 +73,7 @@ export function createDownloadUrlPlugin(options) {
                                 if (status !== 'ready' && status !== 'processed') {
                                     return null;
                                 }
+                                const s3 = resolveS3(options);
                                 if (isPublic && s3.publicUrlPrefix) {
                                     // Public file: return direct URL
                                     return `${s3.publicUrlPrefix}/${key}`;
@@ -89,7 +101,7 @@ export function createDownloadUrlPlugin(options) {
                                     // Fall back to default if config lookup fails
                                 }
                                 // Private file: generate presigned GET URL
-                                return generatePresignedGetUrl(s3, key, downloadUrlExpirySeconds, filename || undefined);
+                                return generatePresignedGetUrl(resolveS3(options), key, downloadUrlExpirySeconds, filename || undefined);
                             },
                         }),
                     }, 'PresignedUrlDownloadPlugin adding downloadUrl field');

package/esm/index.d.ts

@@ -31,4 +31,4 @@ export { createDownloadUrlPlugin } from './download-url-field';
 export { PresignedUrlPreset } from './preset';
 export { getStorageModuleConfig, getBucketConfig, clearStorageModuleCache, clearBucketCache } from './storage-module-cache';
 export { generatePresignedPutUrl, generatePresignedGetUrl, headObject } from './s3-signer';
-export type { BucketConfig, StorageModuleConfig, RequestUploadUrlInput, RequestUploadUrlPayload, ConfirmUploadInput, ConfirmUploadPayload, S3Config, PresignedUrlPluginOptions, } from './types';
+export type { BucketConfig, StorageModuleConfig, RequestUploadUrlInput, RequestUploadUrlPayload, ConfirmUploadInput, ConfirmUploadPayload, S3Config, S3ConfigOrGetter, PresignedUrlPluginOptions, } from './types';

package/esm/plugin.js

@@ -52,8 +52,21 @@ async function resolveDatabaseId(pgClient) {
     return result.rows[0]?.id ?? null;
 }
 // --- Plugin factory ---
+/**
+ * Resolve the S3 config from the options. If the option is a lazy getter
+ * function, call it (and cache the result). This avoids reading env vars
+ * or constructing an S3Client at module-import time.
+ */
+function resolveS3(options) {
+    if (typeof options.s3 === 'function') {
+        const resolved = options.s3();
+        // Cache so subsequent calls don't re-evaluate
+        options.s3 = resolved;
+        return resolved;
+    }
+    return options.s3;
+}
 export function createPresignedUrlPlugin(options) {
-    const { s3 } = options;
     return extendSchema(() => ({
         typeDefs: gql `
       input RequestUploadUrlInput {
@@ -229,7 +242,7 @@ export function createPresignedUrlPlugin(options) {
                                 ]);
                                 const fileId = fileResult.rows[0].id;
                                 // --- Generate presigned PUT URL ---
-                                const uploadUrl = await generatePresignedPutUrl(s3, s3Key, contentType, size, storageConfig.uploadUrlExpirySeconds);
+                                const uploadUrl = await generatePresignedPutUrl(resolveS3(options), s3Key, contentType, size, storageConfig.uploadUrlExpirySeconds);
                                 const expiresAt = new Date(Date.now() + storageConfig.uploadUrlExpirySeconds * 1000).toISOString();
                                 // --- Track the upload request ---
                                 await pgClient.query(`INSERT INTO ${storageConfig.uploadRequestsQualifiedName}
@@ -296,7 +309,7 @@ export function createPresignedUrlPlugin(options) {
                                     };
                                 }
                                 // --- Verify file exists in S3 ---
-                                const s3Head = await headObject(s3, file.key, file.content_type);
+                                const s3Head = await headObject(resolveS3(options), file.key, file.content_type);
                                 if (!s3Head) {
                                     throw new Error('FILE_NOT_IN_S3: the file has not been uploaded yet');
                                 }

package/esm/storage-module-cache.js

@@ -38,6 +38,9 @@ const STORAGE_MODULE_QUERY = `
     ft.name AS files_table,
     urs.schema_name AS upload_requests_schema,
     urt.name AS upload_requests_table,
+    sm.endpoint,
+    sm.public_url_prefix,
+    sm.provider,
     sm.upload_url_expiry_seconds,
     sm.download_url_expiry_seconds,
     sm.default_max_file_size,
@@ -83,6 +86,9 @@ export async function getStorageModuleConfig(pgClient, databaseId) {
         bucketsTableName: row.buckets_table,
         filesTableName: row.files_table,
         uploadRequestsTableName: row.upload_requests_table,
+        endpoint: row.endpoint,
+        publicUrlPrefix: row.public_url_prefix,
+        provider: row.provider,
         uploadUrlExpirySeconds: row.upload_url_expiry_seconds ?? DEFAULT_UPLOAD_URL_EXPIRY_SECONDS,
         downloadUrlExpirySeconds: row.download_url_expiry_seconds ?? DEFAULT_DOWNLOAD_URL_EXPIRY_SECONDS,
         defaultMaxFileSize: row.default_max_file_size ?? DEFAULT_MAX_FILE_SIZE,

package/esm/types.d.ts

@@ -31,6 +31,12 @@ export interface StorageModuleConfig {
     filesTableName: string;
     /** Upload requests table name */
     uploadRequestsTableName: string;
+    /** S3-compatible API endpoint URL (per-database override) */
+    endpoint: string | null;
+    /** Public URL prefix for generating download URLs (per-database override) */
+    publicUrlPrefix: string | null;
+    /** Storage provider type: 'minio', 's3', 'gcs', etc. (per-database override) */
+    provider: string | null;
     /** Presigned PUT URL expiry in seconds (default: 900 = 15 min) */
     uploadUrlExpirySeconds: number;
     /** Presigned GET URL expiry in seconds (default: 3600 = 1 hour) */
@@ -107,10 +113,17 @@ export interface S3Config {
     /** Public URL prefix for generating download URLs */
     publicUrlPrefix?: string;
 }
+/**
+ * S3 configuration or a lazy getter that returns it on first use.
+ * When a function is provided, it will only be called when the first
+ * mutation or resolver actually needs the S3 client — avoiding eager
+ * env-var reads and S3Client creation at module import time.
+ */
+export type S3ConfigOrGetter = S3Config | (() => S3Config);
 /**
  * Plugin options for the presigned URL plugin.
  */
 export interface PresignedUrlPluginOptions {
-    /** S3 configuration */
-    s3: S3Config;
+    /** S3 configuration (concrete or lazy getter) */
+    s3: S3ConfigOrGetter;
 }

package/index.d.ts

@@ -31,4 +31,4 @@ export { createDownloadUrlPlugin } from './download-url-field';
 export { PresignedUrlPreset } from './preset';
 export { getStorageModuleConfig, getBucketConfig, clearStorageModuleCache, clearBucketCache } from './storage-module-cache';
 export { generatePresignedPutUrl, generatePresignedGetUrl, headObject } from './s3-signer';
-export type { BucketConfig, StorageModuleConfig, RequestUploadUrlInput, RequestUploadUrlPayload, ConfirmUploadInput, ConfirmUploadPayload, S3Config, PresignedUrlPluginOptions, } from './types';
+export type { BucketConfig, StorageModuleConfig, RequestUploadUrlInput, RequestUploadUrlPayload, ConfirmUploadInput, ConfirmUploadPayload, S3Config, S3ConfigOrGetter, PresignedUrlPluginOptions, } from './types';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphile-presigned-url-plugin",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Presigned URL upload plugin for PostGraphile v5 — requestUploadUrl, confirmUpload mutations and downloadUrl computed field",
   "author": "Constructive <developers@constructive.io>",
   "homepage": "https://github.com/constructive-io/constructive",
@@ -55,8 +55,9 @@
     "postgraphile": "5.0.0"
   },
   "devDependencies": {
+    "@constructive-io/s3-utils": "^2.10.2",
     "@types/node": "^22.19.11",
     "makage": "^0.1.10"
   },
-  "gitHead": "fc23b83307d007a14e54b1d0fc36614b9650a5dc"
+  "gitHead": "fe60f7b81252eea53dce227bb581d5ae2ef0ec36"
 }

package/plugin.js

@@ -56,8 +56,21 @@ async function resolveDatabaseId(pgClient) {
     return result.rows[0]?.id ?? null;
 }
 // --- Plugin factory ---
+/**
+ * Resolve the S3 config from the options. If the option is a lazy getter
+ * function, call it (and cache the result). This avoids reading env vars
+ * or constructing an S3Client at module-import time.
+ */
+function resolveS3(options) {
+    if (typeof options.s3 === 'function') {
+        const resolved = options.s3();
+        // Cache so subsequent calls don't re-evaluate
+        options.s3 = resolved;
+        return resolved;
+    }
+    return options.s3;
+}
 function createPresignedUrlPlugin(options) {
-    const { s3 } = options;
     return (0, graphile_utils_1.extendSchema)(() => ({
         typeDefs: (0, graphile_utils_1.gql) `
       input RequestUploadUrlInput {
@@ -233,7 +246,7 @@ function createPresignedUrlPlugin(options) {
                                 ]);
                                 const fileId = fileResult.rows[0].id;
                                 // --- Generate presigned PUT URL ---
-                                const uploadUrl = await (0, s3_signer_1.generatePresignedPutUrl)(s3, s3Key, contentType, size, storageConfig.uploadUrlExpirySeconds);
+                                const uploadUrl = await (0, s3_signer_1.generatePresignedPutUrl)(resolveS3(options), s3Key, contentType, size, storageConfig.uploadUrlExpirySeconds);
                                 const expiresAt = new Date(Date.now() + storageConfig.uploadUrlExpirySeconds * 1000).toISOString();
                                 // --- Track the upload request ---
                                 await pgClient.query(`INSERT INTO ${storageConfig.uploadRequestsQualifiedName}
@@ -300,7 +313,7 @@ function createPresignedUrlPlugin(options) {
                                     };
                                 }
                                 // --- Verify file exists in S3 ---
-                                const s3Head = await (0, s3_signer_1.headObject)(s3, file.key, file.content_type);
+                                const s3Head = await (0, s3_signer_1.headObject)(resolveS3(options), file.key, file.content_type);
                                 if (!s3Head) {
                                     throw new Error('FILE_NOT_IN_S3: the file has not been uploaded yet');
                                 }

package/storage-module-cache.js

@@ -44,6 +44,9 @@ const STORAGE_MODULE_QUERY = `
     ft.name AS files_table,
     urs.schema_name AS upload_requests_schema,
     urt.name AS upload_requests_table,
+    sm.endpoint,
+    sm.public_url_prefix,
+    sm.provider,
     sm.upload_url_expiry_seconds,
     sm.download_url_expiry_seconds,
     sm.default_max_file_size,
@@ -89,6 +92,9 @@ async function getStorageModuleConfig(pgClient, databaseId) {
         bucketsTableName: row.buckets_table,
         filesTableName: row.files_table,
         uploadRequestsTableName: row.upload_requests_table,
+        endpoint: row.endpoint,
+        publicUrlPrefix: row.public_url_prefix,
+        provider: row.provider,
         uploadUrlExpirySeconds: row.upload_url_expiry_seconds ?? DEFAULT_UPLOAD_URL_EXPIRY_SECONDS,
         downloadUrlExpirySeconds: row.download_url_expiry_seconds ?? DEFAULT_DOWNLOAD_URL_EXPIRY_SECONDS,
         defaultMaxFileSize: row.default_max_file_size ?? DEFAULT_MAX_FILE_SIZE,

package/types.d.ts

@@ -31,6 +31,12 @@ export interface StorageModuleConfig {
     filesTableName: string;
     /** Upload requests table name */
     uploadRequestsTableName: string;
+    /** S3-compatible API endpoint URL (per-database override) */
+    endpoint: string | null;
+    /** Public URL prefix for generating download URLs (per-database override) */
+    publicUrlPrefix: string | null;
+    /** Storage provider type: 'minio', 's3', 'gcs', etc. (per-database override) */
+    provider: string | null;
     /** Presigned PUT URL expiry in seconds (default: 900 = 15 min) */
     uploadUrlExpirySeconds: number;
     /** Presigned GET URL expiry in seconds (default: 3600 = 1 hour) */
@@ -107,10 +113,17 @@ export interface S3Config {
     /** Public URL prefix for generating download URLs */
     publicUrlPrefix?: string;
 }
+/**
+ * S3 configuration or a lazy getter that returns it on first use.
+ * When a function is provided, it will only be called when the first
+ * mutation or resolver actually needs the S3 client — avoiding eager
+ * env-var reads and S3Client creation at module import time.
+ */
+export type S3ConfigOrGetter = S3Config | (() => S3Config);
 /**
  * Plugin options for the presigned URL plugin.
  */
 export interface PresignedUrlPluginOptions {
-    /** S3 configuration */
-    s3: S3Config;
+    /** S3 configuration (concrete or lazy getter) */
+    s3: S3ConfigOrGetter;
 }