graphile-presigned-url-plugin 1.16.1 → 1.17.0

package/esm/managed-upload.js

@@ -24,6 +24,7 @@ import { getFileRefFieldBinding } from './file-ref-registry';
 import { provisionAndRecordPhysicalBucket, resolveS3ForDatabase } from './physical-bucket';
 import { withRequestPgClient } from './request-pg-client';
 import { copyS3Object, deleteS3Object } from './s3-signer';
+import { recordManagedFile } from './storage-file-recorder';
 import { getBucketConfig, loadAllStorageModules } from './storage-module-cache';
 const log = new Logger('graphile-presigned-url:managed-upload');
 /**
@@ -252,22 +253,14 @@ export async function finalizeStagedUpload(args) {
     let fileId;
     try {
         fileId = await withRequestPgClient(withPgClient, pgSettings, async (pgClient) => {
-            const result = await pgClient.query({
-                text: `INSERT INTO ${storageConfig.filesQualifiedName}
-             (bucket_id, key, content_hash, mime_type, size, filename, is_public)
-             VALUES ($1, $2, $3, $4, $5, $6, $7)
-             RETURNING id`,
-                values: [
-                    bucket.id,
-                    finalKey,
-                    staged.contentHash,
-                    staged.contentType,
-                    staged.size,
-                    staged.filename ?? null,
-                    bucket.is_public,
-                ],
+            return recordManagedFile(pgClient, storageConfig, {
+                bucketId: bucket.id,
+                key: finalKey,
+                contentHash: staged.contentHash,
+                mimeType: staged.contentType,
+                size: staged.size,
+                filename: staged.filename,
             });
-            return result.rows[0].id;
         });
     }
     catch (err) {

package/esm/plugin.js

@@ -30,6 +30,7 @@ import { buildFileProjection } from './managed-upload';
 import { provisionAndRecordPhysicalBucket, resolveS3ForDatabase } from './physical-bucket';
 import { withRequestPgClient } from './request-pg-client';
 import { deleteS3Object, generatePresignedPutUrl } from './s3-signer';
+import { recordManagedFile } from './storage-file-recorder';
 import { getBucketConfig, loadAllStorageModules, resolveStorageConfigFromCodec, storedPhysicalName } from './storage-module-cache';
 const log = new Logger('graphile-presigned-url:plugin');
 // --- Protocol-level constants (not configurable) ---
@@ -612,32 +613,16 @@ async function processSingleFile(options, txClient, storageConfig, databaseId, b
     }
     // Auto-derive ltree path from custom key directory (only when has_path_shares)
     const derivedPath = isCustomKey && storageConfig.hasPathShares ? derivePathFromKey(s3Key) : null;
-    // Create file record. An entity-keyed plane (the module records an entity
-    // table) carries owner_id on its rows; app- and database-scope planes do not.
-    const hasOwnerColumn = storageConfig.entityTableId !== null;
-    const columns = ['bucket_id', 'key', 'content_hash', 'mime_type', 'size', 'filename', 'is_public'];
-    const values = [bucket.id, s3Key, contentHash, contentType, size, filename || null, bucket.is_public];
-    if (hasOwnerColumn) {
-        columns.push('owner_id');
-        values.push(bucket.owner_id);
-    }
-    if (previousVersionId) {
-        columns.push('previous_version_id');
-        values.push(previousVersionId);
-    }
-    if (derivedPath) {
-        columns.push('path');
-        values.push(derivedPath);
-    }
-    const placeholders = values.map((_, i) => `$${i + 1}`).join(', ');
-    const fileResult = await txClient.query({
-        text: `INSERT INTO ${storageConfig.filesQualifiedName}
-           (${columns.join(', ')})
-           VALUES (${placeholders})
-           RETURNING id`,
-        values,
+    const fileId = await recordManagedFile(txClient, storageConfig, {
+        bucketId: bucket.id,
+        key: s3Key,
+        contentHash,
+        mimeType: contentType,
+        size,
+        filename: filename || null,
+        previousVersionId,
+        path: derivedPath,
     });
-    const fileId = fileResult.rows[0].id;
     // Generate presigned PUT URL
     const uploadUrl = await generatePresignedPutUrl(s3ForDb, s3Key, contentType, size, storageConfig.uploadUrlExpirySeconds);
     const expiresAt = new Date(Date.now() + storageConfig.uploadUrlExpirySeconds * 1000).toISOString();

package/esm/storage-file-recorder.d.ts

@@ -0,0 +1,27 @@
+import type { StorageModuleConfig } from './types';
+interface RecordManagedFileInput {
+    bucketId: string;
+    key: string;
+    contentHash: string;
+    mimeType: string;
+    size: number;
+    filename: string | null | undefined;
+    previousVersionId?: string | null;
+    path?: string | null;
+}
+/**
+ * Record a managed file through the storage plane's generated recorder.
+ *
+ * The recorder owns the files-table insert so bucket inheritance and claims
+ * attribution run at the database boundary. Optional arguments are only named
+ * when the generated function supports them and the caller has a value.
+ */
+export declare function recordManagedFile(pgClient: {
+    query: (opts: {
+        text: string;
+        values: unknown[];
+    }) => Promise<{
+        rows: unknown[];
+    }>;
+}, storageConfig: StorageModuleConfig, input: RecordManagedFileInput): Promise<string>;
+export {};

package/esm/storage-file-recorder.js

@@ -0,0 +1,52 @@
+/**
+ * Record a managed file through the storage plane's generated recorder.
+ *
+ * The recorder owns the files-table insert so bucket inheritance and claims
+ * attribution run at the database boundary. Optional arguments are only named
+ * when the generated function supports them and the caller has a value.
+ */
+export async function recordManagedFile(pgClient, storageConfig, input) {
+    if (!storageConfig.recorderQualifiedName) {
+        throw new Error(`STORAGE_RECORDER_MISSING: storage module ${storageConfig.id} (${storageConfig.filesTableName}) ` +
+            `must expose ${storageConfig.filesTableName}_record_file in its private schema`);
+    }
+    if (input.previousVersionId != null && !storageConfig.hasVersioning) {
+        throw new Error(`STORAGE_VERSIONING_UNSUPPORTED: storage module ${storageConfig.id} (${storageConfig.filesTableName}) ` +
+            'does not support previous_version_id');
+    }
+    if (input.path != null && !storageConfig.hasPathShares) {
+        throw new Error(`STORAGE_PATH_SHARES_UNSUPPORTED: storage module ${storageConfig.id} (${storageConfig.filesTableName}) ` +
+            'does not support path');
+    }
+    const args = [
+        'bucket_id := $1::uuid',
+        'key := $2::text',
+        'content_hash := $3::text',
+        'mime_type := $4::text',
+        'size := $5::bigint',
+        'filename := $6::text',
+        'upload := $7::jsonb',
+    ];
+    const values = [
+        input.bucketId,
+        input.key,
+        input.contentHash,
+        input.mimeType,
+        input.size,
+        input.filename ?? null,
+        null,
+    ];
+    if (storageConfig.hasVersioning && input.previousVersionId != null) {
+        args.push(`previous_version_id := $${values.length + 1}::uuid`);
+        values.push(input.previousVersionId);
+    }
+    if (storageConfig.hasPathShares && input.path != null) {
+        args.push(`path := $${values.length + 1}::text`);
+        values.push(input.path);
+    }
+    const result = await pgClient.query({
+        text: `SELECT id FROM ${storageConfig.recorderQualifiedName}(${args.join(', ')})`,
+        values,
+    });
+    return result.rows[0].id;
+}

package/esm/storage-module-cache.js

@@ -41,6 +41,7 @@ const ALL_STORAGE_MODULES_QUERY = `
     bt.name AS buckets_table,
     fs.schema_name AS files_schema,
     ft.name AS files_table,
+    ps.schema_name AS private_schema,
     sm.endpoint,
     sm.public_url_prefix,
     sm.provider,
@@ -53,6 +54,7 @@ const ALL_STORAGE_MODULES_QUERY = `
     sm.max_bulk_files,
     sm.max_bulk_total_size,
     sm.has_path_shares,
+    sm.has_versioning,
     sm.has_confirm_upload,
     es.schema_name AS entity_schema,
     et.name AS entity_table
@@ -61,6 +63,7 @@ const ALL_STORAGE_MODULES_QUERY = `
   JOIN metaschema_public.schema bs ON bs.id = bt.schema_id
   JOIN metaschema_public.table ft ON ft.id = sm.files_table_id
   JOIN metaschema_public.schema fs ON fs.id = ft.schema_id
+  LEFT JOIN metaschema_public.schema ps ON ps.id = sm.private_schema_id
   LEFT JOIN metaschema_public.table et ON et.id = sm.entity_table_id
   LEFT JOIN metaschema_public.schema es ON es.id = et.schema_id
   WHERE sm.database_id = $1
@@ -74,6 +77,9 @@ function buildConfig(row) {
         id: row.id,
         bucketsQualifiedName: QuoteUtils.quoteQualifiedIdentifier(row.buckets_schema, row.buckets_table),
         filesQualifiedName: QuoteUtils.quoteQualifiedIdentifier(row.files_schema, row.files_table),
+        recorderQualifiedName: row.private_schema
+            ? QuoteUtils.quoteQualifiedIdentifier(row.private_schema, `${row.files_table}_record_file`)
+            : null,
         schemaName: row.buckets_schema,
         bucketsTableName: row.buckets_table,
         filesTableName: row.files_table,
@@ -92,6 +98,7 @@ function buildConfig(row) {
         maxFilenameLength: row.max_filename_length ?? DEFAULT_MAX_FILENAME_LENGTH,
         cacheTtlSeconds,
         hasPathShares: row.has_path_shares ?? false,
+        hasVersioning: row.has_versioning ?? false,
         hasConfirmUpload: row.has_confirm_upload ?? false,
         maxBulkFiles: row.max_bulk_files ?? DEFAULT_MAX_BULK_FILES,
         maxBulkTotalSize: row.max_bulk_total_size ?? DEFAULT_MAX_BULK_TOTAL_SIZE,

package/esm/types.d.ts

@@ -35,6 +35,8 @@ export interface StorageModuleConfig {
     bucketsTableName: string;
     /** Files table name */
     filesTableName: string;
+    /** Qualified generated managed-file recorder, or null when unavailable */
+    recorderQualifiedName: string | null;
     /** Scope name (e.g., 'app', 'org', 'team') */
     scope: string;
     /** Entity table ID for entity-scoped storage (NULL for app-level) */
@@ -67,6 +69,8 @@ export interface StorageModuleConfig {
      * without it every row is treated as live, because there is nothing to read.
      */
     hasConfirmUpload: boolean;
+    /** Whether the files table carries the versioning chain. */
+    hasVersioning: boolean;
     /** Max files per requestBulkUploadUrls batch (default: 100) */
     maxBulkFiles: number;
     /** Max total size per bulk upload batch in bytes (default: 1GB) */

package/managed-upload.js

@@ -30,6 +30,7 @@ const file_ref_registry_1 = require("./file-ref-registry");
 const physical_bucket_1 = require("./physical-bucket");
 const request_pg_client_1 = require("./request-pg-client");
 const s3_signer_1 = require("./s3-signer");
+const storage_file_recorder_1 = require("./storage-file-recorder");
 const storage_module_cache_1 = require("./storage-module-cache");
 const log = new logger_1.Logger('graphile-presigned-url:managed-upload');
 /**
@@ -258,22 +259,14 @@ async function finalizeStagedUpload(args) {
     let fileId;
     try {
         fileId = await (0, request_pg_client_1.withRequestPgClient)(withPgClient, pgSettings, async (pgClient) => {
-            const result = await pgClient.query({
-                text: `INSERT INTO ${storageConfig.filesQualifiedName}
-             (bucket_id, key, content_hash, mime_type, size, filename, is_public)
-             VALUES ($1, $2, $3, $4, $5, $6, $7)
-             RETURNING id`,
-                values: [
-                    bucket.id,
-                    finalKey,
-                    staged.contentHash,
-                    staged.contentType,
-                    staged.size,
-                    staged.filename ?? null,
-                    bucket.is_public,
-                ],
+            return (0, storage_file_recorder_1.recordManagedFile)(pgClient, storageConfig, {
+                bucketId: bucket.id,
+                key: finalKey,
+                contentHash: staged.contentHash,
+                mimeType: staged.contentType,
+                size: staged.size,
+                filename: staged.filename,
             });
-            return result.rows[0].id;
         });
     }
     catch (err) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphile-presigned-url-plugin",
-  "version": "1.16.1",
+  "version": "1.17.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",
@@ -62,5 +62,5 @@
     "@types/node": "^22.19.11",
     "makage": "^0.3.0"
   },
-  "gitHead": "7e6cc68f5659d12ec852835a7d8fcca6b05a8f50"
+  "gitHead": "b91ecc6db944b29a29b5474268de54ddca5dc34a"
 }

package/plugin.js

@@ -34,6 +34,7 @@ const managed_upload_1 = require("./managed-upload");
 const physical_bucket_1 = require("./physical-bucket");
 const request_pg_client_1 = require("./request-pg-client");
 const s3_signer_1 = require("./s3-signer");
+const storage_file_recorder_1 = require("./storage-file-recorder");
 const storage_module_cache_1 = require("./storage-module-cache");
 const log = new logger_1.Logger('graphile-presigned-url:plugin');
 // --- Protocol-level constants (not configurable) ---
@@ -616,32 +617,16 @@ async function processSingleFile(options, txClient, storageConfig, databaseId, b
     }
     // Auto-derive ltree path from custom key directory (only when has_path_shares)
     const derivedPath = isCustomKey && storageConfig.hasPathShares ? derivePathFromKey(s3Key) : null;
-    // Create file record. An entity-keyed plane (the module records an entity
-    // table) carries owner_id on its rows; app- and database-scope planes do not.
-    const hasOwnerColumn = storageConfig.entityTableId !== null;
-    const columns = ['bucket_id', 'key', 'content_hash', 'mime_type', 'size', 'filename', 'is_public'];
-    const values = [bucket.id, s3Key, contentHash, contentType, size, filename || null, bucket.is_public];
-    if (hasOwnerColumn) {
-        columns.push('owner_id');
-        values.push(bucket.owner_id);
-    }
-    if (previousVersionId) {
-        columns.push('previous_version_id');
-        values.push(previousVersionId);
-    }
-    if (derivedPath) {
-        columns.push('path');
-        values.push(derivedPath);
-    }
-    const placeholders = values.map((_, i) => `$${i + 1}`).join(', ');
-    const fileResult = await txClient.query({
-        text: `INSERT INTO ${storageConfig.filesQualifiedName}
-           (${columns.join(', ')})
-           VALUES (${placeholders})
-           RETURNING id`,
-        values,
+    const fileId = await (0, storage_file_recorder_1.recordManagedFile)(txClient, storageConfig, {
+        bucketId: bucket.id,
+        key: s3Key,
+        contentHash,
+        mimeType: contentType,
+        size,
+        filename: filename || null,
+        previousVersionId,
+        path: derivedPath,
     });
-    const fileId = fileResult.rows[0].id;
     // Generate presigned PUT URL
     const uploadUrl = await (0, s3_signer_1.generatePresignedPutUrl)(s3ForDb, s3Key, contentType, size, storageConfig.uploadUrlExpirySeconds);
     const expiresAt = new Date(Date.now() + storageConfig.uploadUrlExpirySeconds * 1000).toISOString();

package/storage-file-recorder.d.ts

@@ -0,0 +1,27 @@
+import type { StorageModuleConfig } from './types';
+interface RecordManagedFileInput {
+    bucketId: string;
+    key: string;
+    contentHash: string;
+    mimeType: string;
+    size: number;
+    filename: string | null | undefined;
+    previousVersionId?: string | null;
+    path?: string | null;
+}
+/**
+ * Record a managed file through the storage plane's generated recorder.
+ *
+ * The recorder owns the files-table insert so bucket inheritance and claims
+ * attribution run at the database boundary. Optional arguments are only named
+ * when the generated function supports them and the caller has a value.
+ */
+export declare function recordManagedFile(pgClient: {
+    query: (opts: {
+        text: string;
+        values: unknown[];
+    }) => Promise<{
+        rows: unknown[];
+    }>;
+}, storageConfig: StorageModuleConfig, input: RecordManagedFileInput): Promise<string>;
+export {};

package/storage-file-recorder.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.recordManagedFile = recordManagedFile;
+/**
+ * Record a managed file through the storage plane's generated recorder.
+ *
+ * The recorder owns the files-table insert so bucket inheritance and claims
+ * attribution run at the database boundary. Optional arguments are only named
+ * when the generated function supports them and the caller has a value.
+ */
+async function recordManagedFile(pgClient, storageConfig, input) {
+    if (!storageConfig.recorderQualifiedName) {
+        throw new Error(`STORAGE_RECORDER_MISSING: storage module ${storageConfig.id} (${storageConfig.filesTableName}) ` +
+            `must expose ${storageConfig.filesTableName}_record_file in its private schema`);
+    }
+    if (input.previousVersionId != null && !storageConfig.hasVersioning) {
+        throw new Error(`STORAGE_VERSIONING_UNSUPPORTED: storage module ${storageConfig.id} (${storageConfig.filesTableName}) ` +
+            'does not support previous_version_id');
+    }
+    if (input.path != null && !storageConfig.hasPathShares) {
+        throw new Error(`STORAGE_PATH_SHARES_UNSUPPORTED: storage module ${storageConfig.id} (${storageConfig.filesTableName}) ` +
+            'does not support path');
+    }
+    const args = [
+        'bucket_id := $1::uuid',
+        'key := $2::text',
+        'content_hash := $3::text',
+        'mime_type := $4::text',
+        'size := $5::bigint',
+        'filename := $6::text',
+        'upload := $7::jsonb',
+    ];
+    const values = [
+        input.bucketId,
+        input.key,
+        input.contentHash,
+        input.mimeType,
+        input.size,
+        input.filename ?? null,
+        null,
+    ];
+    if (storageConfig.hasVersioning && input.previousVersionId != null) {
+        args.push(`previous_version_id := $${values.length + 1}::uuid`);
+        values.push(input.previousVersionId);
+    }
+    if (storageConfig.hasPathShares && input.path != null) {
+        args.push(`path := $${values.length + 1}::text`);
+        values.push(input.path);
+    }
+    const result = await pgClient.query({
+        text: `SELECT id FROM ${storageConfig.recorderQualifiedName}(${args.join(', ')})`,
+        values,
+    });
+    return result.rows[0].id;
+}

package/storage-module-cache.js

@@ -52,6 +52,7 @@ const ALL_STORAGE_MODULES_QUERY = `
     bt.name AS buckets_table,
     fs.schema_name AS files_schema,
     ft.name AS files_table,
+    ps.schema_name AS private_schema,
     sm.endpoint,
     sm.public_url_prefix,
     sm.provider,
@@ -64,6 +65,7 @@ const ALL_STORAGE_MODULES_QUERY = `
     sm.max_bulk_files,
     sm.max_bulk_total_size,
     sm.has_path_shares,
+    sm.has_versioning,
     sm.has_confirm_upload,
     es.schema_name AS entity_schema,
     et.name AS entity_table
@@ -72,6 +74,7 @@ const ALL_STORAGE_MODULES_QUERY = `
   JOIN metaschema_public.schema bs ON bs.id = bt.schema_id
   JOIN metaschema_public.table ft ON ft.id = sm.files_table_id
   JOIN metaschema_public.schema fs ON fs.id = ft.schema_id
+  LEFT JOIN metaschema_public.schema ps ON ps.id = sm.private_schema_id
   LEFT JOIN metaschema_public.table et ON et.id = sm.entity_table_id
   LEFT JOIN metaschema_public.schema es ON es.id = et.schema_id
   WHERE sm.database_id = $1
@@ -85,6 +88,9 @@ function buildConfig(row) {
         id: row.id,
         bucketsQualifiedName: quotes_1.QuoteUtils.quoteQualifiedIdentifier(row.buckets_schema, row.buckets_table),
         filesQualifiedName: quotes_1.QuoteUtils.quoteQualifiedIdentifier(row.files_schema, row.files_table),
+        recorderQualifiedName: row.private_schema
+            ? quotes_1.QuoteUtils.quoteQualifiedIdentifier(row.private_schema, `${row.files_table}_record_file`)
+            : null,
         schemaName: row.buckets_schema,
         bucketsTableName: row.buckets_table,
         filesTableName: row.files_table,
@@ -103,6 +109,7 @@ function buildConfig(row) {
         maxFilenameLength: row.max_filename_length ?? DEFAULT_MAX_FILENAME_LENGTH,
         cacheTtlSeconds,
         hasPathShares: row.has_path_shares ?? false,
+        hasVersioning: row.has_versioning ?? false,
         hasConfirmUpload: row.has_confirm_upload ?? false,
         maxBulkFiles: row.max_bulk_files ?? DEFAULT_MAX_BULK_FILES,
         maxBulkTotalSize: row.max_bulk_total_size ?? DEFAULT_MAX_BULK_TOTAL_SIZE,

package/types.d.ts

@@ -35,6 +35,8 @@ export interface StorageModuleConfig {
     bucketsTableName: string;
     /** Files table name */
     filesTableName: string;
+    /** Qualified generated managed-file recorder, or null when unavailable */
+    recorderQualifiedName: string | null;
     /** Scope name (e.g., 'app', 'org', 'team') */
     scope: string;
     /** Entity table ID for entity-scoped storage (NULL for app-level) */
@@ -67,6 +69,8 @@ export interface StorageModuleConfig {
      * without it every row is treated as live, because there is nothing to read.
      */
     hasConfirmUpload: boolean;
+    /** Whether the files table carries the versioning chain. */
+    hasVersioning: boolean;
     /** Max files per requestBulkUploadUrls batch (default: 100) */
     maxBulkFiles: number;
     /** Max total size per bulk upload batch in bytes (default: 1GB) */