graphile-upload-plugin 0.2.0

package/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Dan Lynch <pyramation@gmail.com>
+Copyright (c) 2025 Hyperweb <developers@hyperweb.io>
+Copyright (c) 2020-present, Interweb, Inc.
+
+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/README.md

@@ -0,0 +1,142 @@
+# graphile-upload-plugin
+
+<p align="center" width="100%">
+  <img height="250" src="https://raw.githubusercontent.com/launchql/launchql/refs/heads/main/assets/outline-logo.svg" />
+</p>
+
+<p align="center" width="100%">
+  <a href="https://github.com/launchql/launchql/actions/workflows/run-tests.yaml">
+    <img height="20" src="https://github.com/launchql/launchql/actions/workflows/run-tests.yaml/badge.svg" />
+  </a>
+   <a href="https://github.com/launchql/launchql/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-upload-plugin"><img height="20" src="https://img.shields.io/github/package-json/v/launchql/launchql?filename=graphile%2Fgraphile-upload-plugin%2Fpackage.json"/></a>
+</p>
+
+PostGraphile plugin for handling file uploads via GraphQL. Adds `Upload` scalar type and upload field support for PostgreSQL columns.
+
+## Install
+
+```bash
+pnpm add graphile-upload-plugin
+```
+
+## Usage
+
+```ts
+import express from 'express';
+import { postgraphile } from 'postgraphile';
+import UploadPostGraphilePlugin from 'graphile-upload-plugin';
+
+const app = express();
+app.use(
+  postgraphile(process.env.DATABASE_URL, ['app_public'], {
+    appendPlugins: [UploadPostGraphilePlugin],
+    graphileBuildOptions: {
+      uploadFieldDefinitions: [
+        {
+          name: 'upload',
+          namespaceName: 'public',
+          type: 'JSON',
+          resolve: async (upload, args, context, info) => {
+            // Handle upload
+            return { url: '...', size: upload.size };
+          },
+        },
+        {
+          tag: 'upload',
+          resolve: async (upload, args, context, info) => {
+            // Handle upload by tag
+            return { url: '...' };
+          },
+        },
+      ],
+    },
+  })
+);
+```
+
+## Configuration
+
+The plugin accepts `uploadFieldDefinitions` in `graphileBuildOptions`:
+
+- **By type**: Match PostgreSQL types by `name` and `namespaceName`
+- **By tag**: Match columns via smart comments (e.g., `@upload`)
+
+Each definition requires a `resolve` function that processes the upload and returns the value to store in the database.
+
+---
+
+## Education and Tutorials
+
+ 1. 🚀 [Quickstart: Getting Up and Running](https://launchql.com/learn/quickstart)
+Get started with modular databases in minutes. Install prerequisites and deploy your first module.
+
+ 2. 📦 [Modular PostgreSQL Development with Database Packages](https://launchql.com/learn/modular-postgres)
+Learn to organize PostgreSQL projects with pgpm workspaces and reusable database modules.
+
+ 3. ✏️ [Authoring Database Changes](https://launchql.com/learn/authoring-database-changes)
+Master the workflow for adding, organizing, and managing database changes with pgpm.
+
+ 4. 🧪 [End-to-End PostgreSQL Testing with TypeScript](https://launchql.com/learn/e2e-postgres-testing)
+Master end-to-end PostgreSQL testing with ephemeral databases, RLS testing, and CI/CD automation.
+
+ 5. ⚡ [Supabase Testing](https://launchql.com/learn/supabase)
+Use TypeScript-first tools to test Supabase projects with realistic RLS, policies, and auth contexts.
+
+ 6. 💧 [Drizzle ORM Testing](https://launchql.com/learn/drizzle-testing)
+Run full-stack tests with Drizzle ORM, including database setup, teardown, and RLS enforcement.
+
+ 7. 🔧 [Troubleshooting](https://launchql.com/learn/troubleshooting)
+Common issues and solutions for pgpm, PostgreSQL, and testing.
+
+## Related LaunchQL Tooling
+
+### 🧪 Testing
+
+* [launchql/pgsql-test](https://github.com/launchql/launchql/tree/main/packages/pgsql-test): **📊 Isolated testing environments** with per-test transaction rollbacks—ideal for integration tests, complex migrations, and RLS simulation.
+* [launchql/supabase-test](https://github.com/launchql/launchql/tree/main/packages/supabase-test): **🧪 Supabase-native test harness** preconfigured for the local Supabase stack—per-test rollbacks, JWT/role context helpers, and CI/GitHub Actions ready.
+* [launchql/graphile-test](https://github.com/launchql/launchql/tree/main/packages/graphile-test): **🔐 Authentication mocking** for Graphile-focused test helpers and emulating row-level security contexts.
+* [launchql/pg-query-context](https://github.com/launchql/launchql/tree/main/packages/pg-query-context): **🔒 Session context injection** to add session-local context (e.g., `SET LOCAL`) into queries—ideal for setting `role`, `jwt.claims`, and other session settings.
+
+### 🧠 Parsing & AST
+
+* [launchql/pgsql-parser](https://github.com/launchql/pgsql-parser): **🔄 SQL conversion engine** that interprets and converts PostgreSQL syntax.
+* [launchql/libpg-query-node](https://github.com/launchql/libpg-query-node): **🌉 Node.js bindings** for `libpg_query`, converting SQL into parse trees.
+* [launchql/pg-proto-parser](https://github.com/launchql/pg-proto-parser): **📦 Protobuf parser** for parsing PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums.
+* [@pgsql/enums](https://github.com/launchql/pgsql-parser/tree/main/packages/enums): **🏷️ TypeScript enums** for PostgreSQL AST for safe and ergonomic parsing logic.
+* [@pgsql/types](https://github.com/launchql/pgsql-parser/tree/main/packages/types): **📝 Type definitions** for PostgreSQL AST nodes in TypeScript.
+* [@pgsql/utils](https://github.com/launchql/pgsql-parser/tree/main/packages/utils): **🛠️ AST utilities** for constructing and transforming PostgreSQL syntax trees.
+* [launchql/pg-ast](https://github.com/launchql/launchql/tree/main/packages/pg-ast): **🔍 Low-level AST tools** and transformations for Postgres query structures.
+
+### 🚀 API & Dev Tools
+
+* [launchql/server](https://github.com/launchql/launchql/tree/main/packages/server): **⚡ Express-based API server** powered by PostGraphile to expose a secure, scalable GraphQL API over your Postgres database.
+* [launchql/explorer](https://github.com/launchql/launchql/tree/main/packages/explorer): **🔎 Visual API explorer** with GraphiQL for browsing across all databases and schemas—useful for debugging, documentation, and API prototyping.
+
+### 🔁 Streaming & Uploads
+
+* [launchql/s3-streamer](https://github.com/launchql/launchql/tree/main/packages/s3-streamer): **📤 Direct S3 streaming** for large files with support for metadata injection and content validation.
+* [launchql/etag-hash](https://github.com/launchql/launchql/tree/main/packages/etag-hash): **🏷️ S3-compatible ETags** created by streaming and hashing file uploads in chunks.
+* [launchql/etag-stream](https://github.com/launchql/launchql/tree/main/packages/etag-stream): **🔄 ETag computation** via Node stream transformer during upload or transfer.
+* [launchql/uuid-hash](https://github.com/launchql/launchql/tree/main/packages/uuid-hash): **🆔 Deterministic UUIDs** generated from hashed content, great for deduplication and asset referencing.
+* [launchql/uuid-stream](https://github.com/launchql/launchql/tree/main/packages/uuid-stream): **🌊 Streaming UUID generation** based on piped file content—ideal for upload pipelines.
+* [launchql/upload-names](https://github.com/launchql/launchql/tree/main/packages/upload-names): **📂 Collision-resistant filenames** utility for structured and unique file names for uploads.
+
+### 🧰 CLI & Codegen
+
+* [pgpm](https://github.com/launchql/launchql/tree/main/packages/pgpm): **🖥️ PostgreSQL Package Manager** for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.
+* [@launchql/cli](https://github.com/launchql/launchql/tree/main/packages/cli): **🖥️ Command-line toolkit** for managing LaunchQL projects—supports database scaffolding, migrations, seeding, code generation, and automation.
+* [launchql/launchql-gen](https://github.com/launchql/launchql/tree/main/packages/launchql-gen): **✨ Auto-generated GraphQL** mutations and queries dynamically built from introspected schema data.
+* [@launchql/query-builder](https://github.com/launchql/launchql/tree/main/packages/query-builder): **🏗️ SQL constructor** providing a robust TypeScript-based query builder for dynamic generation of `SELECT`, `INSERT`, `UPDATE`, `DELETE`, and stored procedure calls—supports advanced SQL features like `JOIN`, `GROUP BY`, and schema-qualified queries.
+* [@launchql/query](https://github.com/launchql/launchql/tree/main/packages/query): **🧩 Fluent GraphQL builder** for PostGraphile schemas. ⚡ Schema-aware via introspection, 🧩 composable and ergonomic for building deeply nested queries.
+
+## Credits
+
+🛠 Built by LaunchQL — if you like our tools, please checkout and contribute to [our github ⚛️](https://github.com/launchql)
+
+
+## Disclaimer
+
+AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
+
+No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.

package/esm/index.js

@@ -0,0 +1,4 @@
+import UploadPostGraphilePlugin from './plugin';
+export { UploadPostGraphilePlugin, };
+export { Uploader } from './resolvers/upload';
+export default UploadPostGraphilePlugin;

package/esm/plugin.js

@@ -0,0 +1,158 @@
+// PostGraphile plugin
+const UploadPostGraphilePlugin = (builder, opts = {}) => {
+    const { uploadFieldDefinitions = [] } = opts;
+    // Determine whether a table attribute should be treated as an Upload according to configuration
+    const relevantUploadType = (attr) => {
+        const types = uploadFieldDefinitions.filter(({ name, namespaceName, tag }) => (name &&
+            namespaceName &&
+            attr.type?.name === name &&
+            attr.type?.namespaceName === namespaceName) ||
+            (tag && attr.tags?.[tag]));
+        if (types.length === 1) {
+            return types[0];
+        }
+        else if (types.length > 1) {
+            throw new Error('Upload field definitions are ambiguous');
+        }
+        return undefined;
+    };
+    builder.hook('build', (input, build) => {
+        const { addType, graphql: { GraphQLScalarType, GraphQLError }, } = build;
+        const GraphQLUpload = new GraphQLScalarType({
+            name: 'Upload',
+            description: 'The `Upload` scalar type represents a file upload.',
+            parseValue(value) {
+                // The value should be an object with a `.promise` that resolves to the file upload
+                const maybe = value;
+                if (maybe &&
+                    maybe.promise &&
+                    typeof maybe.promise.then === 'function') {
+                    return maybe.promise;
+                }
+                throw new GraphQLError('Upload value invalid.');
+            },
+            parseLiteral(ast) {
+                throw new GraphQLError('Upload literal unsupported.', ast);
+            },
+            serialize() {
+                throw new GraphQLError('Upload serialization unsupported.');
+            },
+        });
+        addType(GraphQLUpload);
+        // Override the internal types for configured upload-backed columns
+        uploadFieldDefinitions.forEach(({ name, namespaceName, type }) => {
+            if (!name || !type || !namespaceName)
+                return; // tag-based or incomplete definitions
+            const theType = build.pgIntrospectionResultsByKind.type.find((typ) => typ.name === name && typ.namespaceName === namespaceName);
+            if (theType) {
+                build.pgRegisterGqlTypeByTypeId(theType.id, () => build.getTypeByName(type));
+            }
+        });
+        return input;
+    });
+    builder.hook('inflection', (inflection, build) => {
+        return build.extend(inflection, {
+            // NO ARROW FUNCTIONS HERE (this)
+            uploadColumn(attr) {
+                return this.column(attr) + 'Upload';
+            },
+        });
+    });
+    // Add Upload input fields alongside matching columns
+    builder.hook('GraphQLInputObjectType:fields', (fields, build, context) => {
+        const { scope: { isPgRowType, pgIntrospection: table }, } = context;
+        if (!isPgRowType || !table || table.kind !== 'class') {
+            return fields;
+        }
+        return build.extend(fields, table.attributes.reduce((memo, attr) => {
+            if (!build.pgColumnFilter(attr, build, context))
+                return memo;
+            const action = context.scope.isPgBaseInput
+                ? 'base'
+                : context.scope.isPgPatch
+                    ? 'update'
+                    : 'create';
+            if (build.pgOmit(attr, action))
+                return memo;
+            if (attr.identity === 'a')
+                return memo;
+            if (!relevantUploadType(attr)) {
+                return memo;
+            }
+            const fieldName = build.inflection.uploadColumn(attr);
+            if (memo[fieldName]) {
+                throw new Error(`Two columns produce the same GraphQL field name '${fieldName}' on class '${table.namespaceName}.${table.name}'; one of them is '${attr.name}'`);
+            }
+            memo = build.extend(memo, {
+                [fieldName]: context.fieldWithHooks(fieldName, {
+                    description: attr.description,
+                    type: build.getTypeByName('Upload'),
+                }, { pgFieldIntrospection: attr, isPgUploadField: true }),
+            }, `Adding field for ${build.describePgEntity(attr)}. You can rename this field with a 'Smart Comment':\n\n  ${build.sqlCommentByAddingTags(attr, {
+                name: 'newNameHere',
+            })}`);
+            return memo;
+        }, {}), `Adding columns to '${build.describePgEntity(table)}'`);
+    });
+    builder.hook('GraphQLObjectType:fields:field', (field, build, context) => {
+        const { pgIntrospectionResultsByKind: introspectionResultsByKind, inflection, } = build;
+        const { scope: { isRootMutation, fieldName, pgFieldIntrospection: table }, } = context;
+        if (!isRootMutation || !table) {
+            return field;
+        }
+        // It's possible that `resolve` isn't specified on a field, so in that case
+        // we fall back to a default resolver.
+        const defaultResolver = (obj) => obj[fieldName];
+        // Extract the old resolver from `field`
+        const { resolve: oldResolve = defaultResolver, ...rest } = field; // GraphQLFieldConfig
+        const tags = {};
+        const types = {};
+        const originals = {};
+        const uploadResolversByFieldName = introspectionResultsByKind.attribute
+            .filter((attr) => attr.classId === table.id)
+            .reduce((memo, attr) => {
+            // first, try to directly match the types here
+            const typeMatched = relevantUploadType(attr);
+            if (typeMatched) {
+                const fieldName = inflection.column(attr);
+                const uploadFieldName = inflection.uploadColumn(attr);
+                memo[uploadFieldName] = typeMatched.resolve;
+                tags[uploadFieldName] = attr.tags;
+                types[uploadFieldName] = attr.type.name;
+                originals[uploadFieldName] = fieldName;
+            }
+            return memo;
+        }, {});
+        return {
+            // Copy over everything except 'resolve'
+            ...rest,
+            // Add our new resolver which wraps the old resolver
+            async resolve(source, args, context, info) {
+                // Recursively check for Upload promises to resolve
+                async function resolvePromises(obj) {
+                    for (const key of Object.keys(obj)) {
+                        if (obj[key] instanceof Promise) {
+                            if (uploadResolversByFieldName[key]) {
+                                const upload = await obj[key];
+                                // eslint-disable-next-line require-atomic-updates
+                                obj[originals[key]] = await uploadResolversByFieldName[key](upload, args, context, {
+                                    ...info,
+                                    uploadPlugin: { tags: tags[key], type: types[key] },
+                                });
+                            }
+                        }
+                        else if (obj[key] !== null && typeof obj[key] === 'object') {
+                            await resolvePromises(obj[key]);
+                        }
+                    }
+                }
+                await resolvePromises(args);
+                // Call the old resolver
+                const oldResolveResult = await oldResolve(source, args, context, info);
+                // Finally return the result.
+                return oldResolveResult;
+            },
+        };
+    });
+};
+export default UploadPostGraphilePlugin;

package/esm/resolvers/upload.js

@@ -0,0 +1,54 @@
+import streamer from '@launchql/s3-streamer';
+import uploadNames from '@launchql/upload-names';
+export class Uploader {
+    opts;
+    streamerInstance;
+    constructor(opts) {
+        this.opts = opts;
+        const { bucketName, awsRegion, awsSecretKey, awsAccessKey, minioEndpoint } = this.opts;
+        this.streamerInstance = new streamer({
+            defaultBucket: bucketName,
+            awsRegion,
+            awsSecretKey,
+            awsAccessKey,
+            minioEndpoint,
+        });
+    }
+    async resolveUpload(upload, _args, _context, info) {
+        const { uploadPlugin: { tags, type } } = info;
+        const readStream = upload.createReadStream();
+        const { filename } = upload;
+        const rand = Math.random().toString(36).substring(2, 7) +
+            Math.random().toString(36).substring(2, 7);
+        const key = `${rand}-${uploadNames(filename)}`;
+        const result = await this.streamerInstance.upload({
+            readStream,
+            filename,
+            key,
+            bucket: this.opts.bucketName
+        });
+        const url = result.upload.Location;
+        const { contentType, magic: { charset } } = result;
+        const typ = type || tags.type;
+        const allowedMimes = tags.mime
+            ? tags.mime.trim().split(',').map((a) => a.trim())
+            : typ === 'image'
+                ? ['image/jpg', 'image/jpeg', 'image/png', 'image/svg+xml']
+                : [];
+        if (allowedMimes.length && !allowedMimes.includes(contentType)) {
+            throw new Error(`UPLOAD_MIMETYPE ${allowedMimes.join(',')}`);
+        }
+        switch (typ) {
+            case 'image':
+            case 'upload':
+                return {
+                    filename,
+                    mime: contentType,
+                    url
+                };
+            case 'attachment':
+            default:
+                return url;
+        }
+    }
+}

package/index.d.ts

@@ -0,0 +1,4 @@
+import UploadPostGraphilePlugin, { type FileUpload, type UploadPluginInfo, type UploadResolver, type UploadFieldDefinition } from './plugin';
+export { UploadPostGraphilePlugin, type FileUpload, type UploadPluginInfo, type UploadResolver, type UploadFieldDefinition, };
+export { Uploader, type UploaderOptions } from './resolvers/upload';
+export default UploadPostGraphilePlugin;

package/index.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Uploader = exports.UploadPostGraphilePlugin = void 0;
+const plugin_1 = __importDefault(require("./plugin"));
+exports.UploadPostGraphilePlugin = plugin_1.default;
+var upload_1 = require("./resolvers/upload");
+Object.defineProperty(exports, "Uploader", { enumerable: true, get: function () { return upload_1.Uploader; } });
+exports.default = plugin_1.default;

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "graphile-upload-plugin",
+  "version": "0.2.0",
+  "description": "Graphile upload plugin for PostGraphile",
+  "author": "Dan Lynch <pyramation@gmail.com>",
+  "homepage": "https://github.com/launchql/launchql",
+  "license": "MIT",
+  "main": "index.js",
+  "module": "esm/index.js",
+  "types": "index.d.ts",
+  "scripts": {
+    "clean": "makage clean",
+    "prepack": "pnpm run build",
+    "build": "makage build",
+    "build:dev": "makage build --dev",
+    "lint": "eslint . --fix",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/launchql/launchql"
+  },
+  "keywords": [
+    "postgraphile",
+    "graphile",
+    "launchql",
+    "plugin",
+    "postgres",
+    "graphql",
+    "upload"
+  ],
+  "bugs": {
+    "url": "https://github.com/launchql/launchql/issues"
+  },
+  "devDependencies": {
+    "@aws-sdk/client-s3": "^3.0.0",
+    "@launchql/env": "^2.5.6",
+    "@launchql/s3-utils": "^2.2.10",
+    "@types/pg": "^8.15.2",
+    "graphile-test": "^2.8.9",
+    "graphql-tag": "^2.12.6",
+    "makage": "^0.1.6",
+    "pgsql-test": "^2.14.12",
+    "ts-jest": "^29.1.0"
+  },
+  "dependencies": {
+    "@launchql/s3-streamer": "^2.6.8",
+    "@launchql/upload-names": "^2.2.10",
+    "graphile-build": "^4.14.1",
+    "graphql": "15.10.1"
+  },
+  "gitHead": "3812f24a480b2035b3413ec7fecfe492f294e590"
+}

package/plugin.d.ts

@@ -0,0 +1,31 @@
+import type { ReadStream } from 'fs';
+import type { Plugin } from 'graphile-build';
+import type { GraphQLResolveInfo } from 'graphql';
+export interface FileUpload {
+    filename: string;
+    mimetype?: string;
+    encoding?: string;
+    createReadStream: () => ReadStream;
+}
+export interface UploadPluginInfo {
+    tags: Record<string, any>;
+    type?: string;
+}
+export type UploadResolver = (upload: FileUpload, args: any, context: any, info: GraphQLResolveInfo & {
+    uploadPlugin: UploadPluginInfo;
+}) => Promise<any>;
+export type UploadFieldDefinition = {
+    name: string;
+    namespaceName: string;
+    type: string;
+    resolve: UploadResolver;
+    tag?: never;
+} | {
+    tag: string;
+    resolve: UploadResolver;
+    name?: never;
+    namespaceName?: never;
+    type?: string;
+};
+declare const UploadPostGraphilePlugin: Plugin;
+export default UploadPostGraphilePlugin;

package/plugin.js

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// PostGraphile plugin
+const UploadPostGraphilePlugin = (builder, opts = {}) => {
+    const { uploadFieldDefinitions = [] } = opts;
+    // Determine whether a table attribute should be treated as an Upload according to configuration
+    const relevantUploadType = (attr) => {
+        const types = uploadFieldDefinitions.filter(({ name, namespaceName, tag }) => (name &&
+            namespaceName &&
+            attr.type?.name === name &&
+            attr.type?.namespaceName === namespaceName) ||
+            (tag && attr.tags?.[tag]));
+        if (types.length === 1) {
+            return types[0];
+        }
+        else if (types.length > 1) {
+            throw new Error('Upload field definitions are ambiguous');
+        }
+        return undefined;
+    };
+    builder.hook('build', (input, build) => {
+        const { addType, graphql: { GraphQLScalarType, GraphQLError }, } = build;
+        const GraphQLUpload = new GraphQLScalarType({
+            name: 'Upload',
+            description: 'The `Upload` scalar type represents a file upload.',
+            parseValue(value) {
+                // The value should be an object with a `.promise` that resolves to the file upload
+                const maybe = value;
+                if (maybe &&
+                    maybe.promise &&
+                    typeof maybe.promise.then === 'function') {
+                    return maybe.promise;
+                }
+                throw new GraphQLError('Upload value invalid.');
+            },
+            parseLiteral(ast) {
+                throw new GraphQLError('Upload literal unsupported.', ast);
+            },
+            serialize() {
+                throw new GraphQLError('Upload serialization unsupported.');
+            },
+        });
+        addType(GraphQLUpload);
+        // Override the internal types for configured upload-backed columns
+        uploadFieldDefinitions.forEach(({ name, namespaceName, type }) => {
+            if (!name || !type || !namespaceName)
+                return; // tag-based or incomplete definitions
+            const theType = build.pgIntrospectionResultsByKind.type.find((typ) => typ.name === name && typ.namespaceName === namespaceName);
+            if (theType) {
+                build.pgRegisterGqlTypeByTypeId(theType.id, () => build.getTypeByName(type));
+            }
+        });
+        return input;
+    });
+    builder.hook('inflection', (inflection, build) => {
+        return build.extend(inflection, {
+            // NO ARROW FUNCTIONS HERE (this)
+            uploadColumn(attr) {
+                return this.column(attr) + 'Upload';
+            },
+        });
+    });
+    // Add Upload input fields alongside matching columns
+    builder.hook('GraphQLInputObjectType:fields', (fields, build, context) => {
+        const { scope: { isPgRowType, pgIntrospection: table }, } = context;
+        if (!isPgRowType || !table || table.kind !== 'class') {
+            return fields;
+        }
+        return build.extend(fields, table.attributes.reduce((memo, attr) => {
+            if (!build.pgColumnFilter(attr, build, context))
+                return memo;
+            const action = context.scope.isPgBaseInput
+                ? 'base'
+                : context.scope.isPgPatch
+                    ? 'update'
+                    : 'create';
+            if (build.pgOmit(attr, action))
+                return memo;
+            if (attr.identity === 'a')
+                return memo;
+            if (!relevantUploadType(attr)) {
+                return memo;
+            }
+            const fieldName = build.inflection.uploadColumn(attr);
+            if (memo[fieldName]) {
+                throw new Error(`Two columns produce the same GraphQL field name '${fieldName}' on class '${table.namespaceName}.${table.name}'; one of them is '${attr.name}'`);
+            }
+            memo = build.extend(memo, {
+                [fieldName]: context.fieldWithHooks(fieldName, {
+                    description: attr.description,
+                    type: build.getTypeByName('Upload'),
+                }, { pgFieldIntrospection: attr, isPgUploadField: true }),
+            }, `Adding field for ${build.describePgEntity(attr)}. You can rename this field with a 'Smart Comment':\n\n  ${build.sqlCommentByAddingTags(attr, {
+                name: 'newNameHere',
+            })}`);
+            return memo;
+        }, {}), `Adding columns to '${build.describePgEntity(table)}'`);
+    });
+    builder.hook('GraphQLObjectType:fields:field', (field, build, context) => {
+        const { pgIntrospectionResultsByKind: introspectionResultsByKind, inflection, } = build;
+        const { scope: { isRootMutation, fieldName, pgFieldIntrospection: table }, } = context;
+        if (!isRootMutation || !table) {
+            return field;
+        }
+        // It's possible that `resolve` isn't specified on a field, so in that case
+        // we fall back to a default resolver.
+        const defaultResolver = (obj) => obj[fieldName];
+        // Extract the old resolver from `field`
+        const { resolve: oldResolve = defaultResolver, ...rest } = field; // GraphQLFieldConfig
+        const tags = {};
+        const types = {};
+        const originals = {};
+        const uploadResolversByFieldName = introspectionResultsByKind.attribute
+            .filter((attr) => attr.classId === table.id)
+            .reduce((memo, attr) => {
+            // first, try to directly match the types here
+            const typeMatched = relevantUploadType(attr);
+            if (typeMatched) {
+                const fieldName = inflection.column(attr);
+                const uploadFieldName = inflection.uploadColumn(attr);
+                memo[uploadFieldName] = typeMatched.resolve;
+                tags[uploadFieldName] = attr.tags;
+                types[uploadFieldName] = attr.type.name;
+                originals[uploadFieldName] = fieldName;
+            }
+            return memo;
+        }, {});
+        return {
+            // Copy over everything except 'resolve'
+            ...rest,
+            // Add our new resolver which wraps the old resolver
+            async resolve(source, args, context, info) {
+                // Recursively check for Upload promises to resolve
+                async function resolvePromises(obj) {
+                    for (const key of Object.keys(obj)) {
+                        if (obj[key] instanceof Promise) {
+                            if (uploadResolversByFieldName[key]) {
+                                const upload = await obj[key];
+                                // eslint-disable-next-line require-atomic-updates
+                                obj[originals[key]] = await uploadResolversByFieldName[key](upload, args, context, {
+                                    ...info,
+                                    uploadPlugin: { tags: tags[key], type: types[key] },
+                                });
+                            }
+                        }
+                        else if (obj[key] !== null && typeof obj[key] === 'object') {
+                            await resolvePromises(obj[key]);
+                        }
+                    }
+                }
+                await resolvePromises(args);
+                // Call the old resolver
+                const oldResolveResult = await oldResolve(source, args, context, info);
+                // Finally return the result.
+                return oldResolveResult;
+            },
+        };
+    });
+};
+exports.default = UploadPostGraphilePlugin;

package/resolvers/upload.d.ts

@@ -0,0 +1,13 @@
+export interface UploaderOptions {
+    bucketName: string;
+    awsRegion: string;
+    awsSecretKey: string;
+    awsAccessKey: string;
+    minioEndpoint?: string;
+}
+export declare class Uploader {
+    private opts;
+    private streamerInstance;
+    constructor(opts: UploaderOptions);
+    resolveUpload(upload: any, _args: any, _context: any, info: any): Promise<any>;
+}

package/resolvers/upload.js

@@ -0,0 +1,61 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Uploader = void 0;
+const s3_streamer_1 = __importDefault(require("@launchql/s3-streamer"));
+const upload_names_1 = __importDefault(require("@launchql/upload-names"));
+class Uploader {
+    opts;
+    streamerInstance;
+    constructor(opts) {
+        this.opts = opts;
+        const { bucketName, awsRegion, awsSecretKey, awsAccessKey, minioEndpoint } = this.opts;
+        this.streamerInstance = new s3_streamer_1.default({
+            defaultBucket: bucketName,
+            awsRegion,
+            awsSecretKey,
+            awsAccessKey,
+            minioEndpoint,
+        });
+    }
+    async resolveUpload(upload, _args, _context, info) {
+        const { uploadPlugin: { tags, type } } = info;
+        const readStream = upload.createReadStream();
+        const { filename } = upload;
+        const rand = Math.random().toString(36).substring(2, 7) +
+            Math.random().toString(36).substring(2, 7);
+        const key = `${rand}-${(0, upload_names_1.default)(filename)}`;
+        const result = await this.streamerInstance.upload({
+            readStream,
+            filename,
+            key,
+            bucket: this.opts.bucketName
+        });
+        const url = result.upload.Location;
+        const { contentType, magic: { charset } } = result;
+        const typ = type || tags.type;
+        const allowedMimes = tags.mime
+            ? tags.mime.trim().split(',').map((a) => a.trim())
+            : typ === 'image'
+                ? ['image/jpg', 'image/jpeg', 'image/png', 'image/svg+xml']
+                : [];
+        if (allowedMimes.length && !allowedMimes.includes(contentType)) {
+            throw new Error(`UPLOAD_MIMETYPE ${allowedMimes.join(',')}`);
+        }
+        switch (typ) {
+            case 'image':
+            case 'upload':
+                return {
+                    filename,
+                    mime: contentType,
+                    url
+                };
+            case 'attachment':
+            default:
+                return url;
+        }
+    }
+}
+exports.Uploader = Uploader;