@constructive-io/graphql-explorer 2.10.5

package/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Dan Lynch <pyramation@gmail.com>
+Copyright (c) 2025 Constructive <developers@constructive.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,89 @@
+# @constructive-io/graphql-explorer
+
+<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/@constructive-io/graphql-explorer"><img height="20" src="https://img.shields.io/github/package-json/v/constructive-io/constructive?filename=packages%2Fexplorer%2Fpackage.json"/></a>
+</p>
+
+---
+
+## Education and Tutorials
+
+ 1. 🚀 [Quickstart: Getting Up and Running](https://constructive.io/learn/quickstart)
+Get started with modular databases in minutes. Install prerequisites and deploy your first module.
+
+ 2. 📦 [Modular PostgreSQL Development with Database Packages](https://constructive.io/learn/modular-postgres)
+Learn to organize PostgreSQL projects with pgpm workspaces and reusable database modules.
+
+ 3. ✏️ [Authoring Database Changes](https://constructive.io/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://constructive.io/learn/e2e-postgres-testing)
+Master end-to-end PostgreSQL testing with ephemeral databases, RLS testing, and CI/CD automation.
+
+ 5. ⚡ [Supabase Testing](https://constructive.io/learn/supabase)
+Use TypeScript-first tools to test Supabase projects with realistic RLS, policies, and auth contexts.
+
+ 6. 💧 [Drizzle ORM Testing](https://constructive.io/learn/drizzle-testing)
+Run full-stack tests with Drizzle ORM, including database setup, teardown, and RLS enforcement.
+
+ 7. 🔧 [Troubleshooting](https://constructive.io/learn/troubleshooting)
+Common issues and solutions for pgpm, PostgreSQL, and testing.
+
+## Related Constructive Tooling
+
+### 🧪 Testing
+
+* [pgsql-test](https://github.com/constructive-io/constructive/tree/main/postgres/pgsql-test): **📊 Isolated testing environments** with per-test transaction rollbacks—ideal for integration tests, complex migrations, and RLS simulation.
+* [supabase-test](https://github.com/constructive-io/constructive/tree/main/postgres/supabase-test): **🧪 Supabase-native test harness** preconfigured for the local Supabase stack—per-test rollbacks, JWT/role context helpers, and CI/GitHub Actions ready.
+* [graphile-test](https://github.com/constructive-io/constructive/tree/main/graphile/graphile-test): **🔐 Authentication mocking** for Graphile-focused test helpers and emulating row-level security contexts.
+* [pg-query-context](https://github.com/constructive-io/constructive/tree/main/postgres/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
+
+* [pgsql-parser](https://www.npmjs.com/package/pgsql-parser): **🔄 SQL conversion engine** that interprets and converts PostgreSQL syntax.
+* [libpg-query-node](https://www.npmjs.com/package/libpg-query): **🌉 Node.js bindings** for `libpg_query`, converting SQL into parse trees.
+* [pg-proto-parser](https://www.npmjs.com/package/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://www.npmjs.com/package/@pgsql/enums): **🏷️ TypeScript enums** for PostgreSQL AST for safe and ergonomic parsing logic.
+* [@pgsql/types](https://www.npmjs.com/package/@pgsql/types): **📝 Type definitions** for PostgreSQL AST nodes in TypeScript.
+* [@pgsql/utils](https://www.npmjs.com/package/@pgsql/utils): **🛠️ AST utilities** for constructing and transforming PostgreSQL syntax trees.
+* [pg-ast](https://www.npmjs.com/package/pg-ast): **🔍 Low-level AST tools** and transformations for Postgres query structures.
+
+### 🚀 API & Dev Tools
+
+* [@constructive-io/graphql-server](https://github.com/constructive-io/constructive/tree/main/graphql/server): **⚡ Express-based API server** powered by PostGraphile to expose a secure, scalable GraphQL API over your Postgres database.
+* [@constructive-io/graphql-explorer](https://github.com/constructive-io/constructive/tree/main/graphql/explorer): **🔎 Visual API explorer** with GraphiQL for browsing across all databases and schemas—useful for debugging, documentation, and API prototyping.
+
+### 🔁 Streaming & Uploads
+
+* [etag-hash](https://github.com/constructive-io/constructive/tree/main/streaming/etag-hash): **🏷️ S3-compatible ETags** created by streaming and hashing file uploads in chunks.
+* [etag-stream](https://github.com/constructive-io/constructive/tree/main/streaming/etag-stream): **🔄 ETag computation** via Node stream transformer during upload or transfer.
+* [uuid-hash](https://github.com/constructive-io/constructive/tree/main/streaming/uuid-hash): **🆔 Deterministic UUIDs** generated from hashed content, great for deduplication and asset referencing.
+* [uuid-stream](https://github.com/constructive-io/constructive/tree/main/streaming/uuid-stream): **🌊 Streaming UUID generation** based on piped file content—ideal for upload pipelines.
+* [@constructive-io/s3-streamer](https://github.com/constructive-io/constructive/tree/main/streaming/s3-streamer): **📤 Direct S3 streaming** for large files with support for metadata injection and content validation.
+* [@constructive-io/upload-names](https://github.com/constructive-io/constructive/tree/main/streaming/upload-names): **📂 Collision-resistant filenames** utility for structured and unique file names for uploads.
+
+### 🧰 CLI & Codegen
+
+* [pgpm](https://github.com/constructive-io/constructive/tree/main/pgpm/pgpm): **🖥️ PostgreSQL Package Manager** for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.
+* [@constructive-io/cli](https://github.com/constructive-io/constructive/tree/main/packages/cli): **🖥️ Command-line toolkit** for managing Constructive projects—supports database scaffolding, migrations, seeding, code generation, and automation.
+* [@constructive-io/graphql-codegen](https://github.com/constructive-io/constructive/tree/main/graphql/codegen): **✨ GraphQL code generation** (types, operations, SDK) from schema/endpoint introspection.
+* [@constructive-io/query-builder](https://github.com/constructive-io/constructive/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.
+* [@constructive-io/graphql-query](https://github.com/constructive-io/constructive/tree/main/graphql/query): **🧩 Fluent GraphQL builder** for PostGraphile schemas. ⚡ Schema-aware via introspection, 🧩 composable and ergonomic for building deeply nested queries.
+
+## Credits
+
+**🛠 Built by the [Constructive](https://constructive.io) team — creators of modular Postgres tooling for secure, composable backends. If you like our work, contribute on [GitHub](https://github.com/constructive-io).**
+
+## 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 @@
+export * from './server';

package/esm/render.js

@@ -0,0 +1,73 @@
+export const printHtml = ({ title, children, rootUrl }) => {
+    return `
+    <!DOCTYPE html>
+    <html lang="en">
+      <head>
+        <meta charset="UTF-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <title>${title}</title>
+        <script src="https://cdn.tailwindcss.com"></script>
+        <style>
+          .text-brand {
+            color: #01a1ff;
+          }
+          .text-brand:hover {
+            text-decoration: underline;
+          }
+          h1.text-brand:hover {
+            text-decoration: none;
+          }
+        </style>
+      </head>
+      <body class="bg-gray-50 text-gray-900 font-sans p-6 text-sm leading-tight">
+        <div class="max-w-4xl mx-auto space-y-4">
+          <header class="flex items-center space-x-2">
+            <a href="${rootUrl}" class="shrink-0 w-6 h-6 sm:w-8 sm:h-8" aria-label="Home">
+              <svg data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64.95 61.24">
+                <path d="M16.36 43.47a14.56 14.56 0 01-8.79 0A11.16 11.16 0 011 38.34a8.83 8.83 0 01-.45-1A8.09 8.09 0 01.76 31a10.08 10.08 0 013.68-4.17 6.23 6.23 0 01-.24-.65A8.17 8.17 0 014.68 20a10.47 10.47 0 014.53-4.53 13.25 13.25 0 012.12-.9 12.35 12.35 0 012.5-7.45A17.35 17.35 0 0122.7 1a22.38 22.38 0 0113.48 0 17.07 17.07 0 019.42 6.9 18.75 18.75 0 019.8.4 14 14 0 018.29 6.46 10.17 10.17 0 01.78 1.83 10 10 0 01-.59 7.56 13.05 13.05 0 01-5.64 5.64A17.05 17.05 0 0155.4 31l-39 12.45zM64.92 36q-1.05 4.48-10.54 7.63l-.36.12L15 56.22a9.87 9.87 0 01-1.91.41C6.88 57.55 2.16 54.78 0 51.24a8.2 8.2 0 00.56 3.2 7.45 7.45 0 00.45 1 11.09 11.09 0 006.56 5.13 14.64 14.64 0 008.79 0l39-12.45a17.07 17.07 0 002.84-1.2 13 13 0 005.64-5.63 10.19 10.19 0 001-5.27zm0-8.59q-1.05 4.49-10.54 7.64l-.36.12L15 47.64a9.84 9.84 0 01-1.91.4C6.88 49 2.16 46.19 0 42.65a8.28 8.28 0 00.56 3.21 8.83 8.83 0 00.45 1A11.16 11.16 0 007.57 52a14.64 14.64 0 008.79 0l39-12.45a17.05 17.05 0 002.84-1.19 13.05 13.05 0 005.64-5.64 10.17 10.17 0 001-5.27zM9 39.13a10.11 10.11 0 006 0l39-12.45a12.25 12.25 0 002.06-.87 8.52 8.52 0 003.7-3.62 5.52 5.52 0 00.37-4.19 6.6 6.6 0 00-.46-1A9.57 9.57 0 0054 12.68a14.17 14.17 0 00-8.48 0l-.16.05-.2.07-2 .69-.84-2c-.07-.16-.12-.27-.14-.33l-.18-.27a12.26 12.26 0 00-7.2-5.51 17.85 17.85 0 00-10.73 0 12.81 12.81 0 00-6.56 4.44 7.58 7.58 0 00-1.47 6l.45 2.29-2.31.4c-.27 0-.5.09-.68.13s-.46.12-.66.19a8.31 8.31 0 00-1.47.62A5.88 5.88 0 008.78 22a3.71 3.71 0 00-.24 2.79 3.77 3.77 0 00.31.7c.07.13.15.26.24.4.1.14.19.27.29.39l2 2.44-3 1.13a9.92 9.92 0 00-.94.44 5.79 5.79 0 00-2.59 2.57 3.57 3.57 0 00-.1 2.83 4.9 4.9 0 00.22.48 6.69 6.69 0 003.92 3z" fill="#01a1ff"/></svg>
+            </a>
+            <h1 class="text-xl font-semibold text-brand">${title}</h1>
+          </header>
+          <main class="overflow-auto max-h-[90vh]">
+            ${children}
+          </main>
+        </div>
+      </body>
+    </html>
+  `.trim();
+};
+export const printDatabases = ({ databases, req, port }) => {
+    const rootUrl = `${req.protocol}://${req.hostname}:${port}`;
+    const links = databases
+        .map((d) => {
+        const url = `${req.protocol}://${d.datname}.${req.hostname}:${port}`;
+        return `<a href="${url}" class="text-brand hover:underline block">${d.datname}</a>`;
+    })
+        .join('');
+    return printHtml({
+        title: 'Databases',
+        rootUrl,
+        children: `
+      <hr class="border-gray-300 mb-2" />
+      ${links}
+    `
+    });
+};
+export const printSchemas = ({ dbName, schemas, req, hostname, port }) => {
+    const rootUrl = `${req.protocol}://${hostname}:${port}`;
+    const links = schemas
+        .map((d) => {
+        const url = `${req.protocol}://${d.table_schema}.${req.hostname}:${port}/graphiql`;
+        return `<a href="${url}" class="text-brand hover:underline block">${d.table_schema}</a>`;
+    })
+        .join('');
+    return printHtml({
+        title: `Schemas in ${dbName}`,
+        rootUrl,
+        children: `
+      <a href="${rootUrl}" class="text-xs text-brand hover:underline mb-2 inline-block">&larr; Back to root</a>
+      <hr class="border-gray-300 mb-2" />
+      ${links}
+    `
+    });
+};

package/esm/resolvers/uploads.js

@@ -0,0 +1,53 @@
+import Streamer from '@constructive-io/s3-streamer';
+import uploadNames from '@constructive-io/upload-names';
+export class UploadHandler {
+    options;
+    streamer;
+    constructor(options) {
+        this.options = options;
+        this.streamer = new Streamer({
+            defaultBucket: options.bucketName,
+            awsRegion: options.awsRegion,
+            awsSecretKey: options.awsSecretKey,
+            awsAccessKey: options.awsAccessKey,
+            minioEndpoint: options.minioEndpoint
+        });
+    }
+    async handleUpload(upload, _args, _context, info) {
+        const { uploadPlugin: { tags, type } } = info;
+        const readStream = upload.createReadStream();
+        const { filename, mimetype } = 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.streamer.upload({
+            readStream,
+            filename,
+            key,
+            bucket: this.options.bucketName
+        });
+        const url = result.upload.Location;
+        const { contentType, magic: { charset } } = result;
+        const typ = type || tags.type;
+        const mim = tags.mime
+            ? tags.mime.trim().split(',').map((a) => a.trim())
+            : typ === 'image'
+                ? ['image/jpg', 'image/jpeg', 'image/png', 'image/svg+xml']
+                : [];
+        if (mim.length && !mim.includes(contentType)) {
+            throw new Error(`UPLOAD_MIMETYPE ${mim.join(',')}`);
+        }
+        switch (typ) {
+            case 'image':
+            case 'upload':
+                return {
+                    filename,
+                    mime: contentType,
+                    url
+                };
+            case 'attachment':
+            default:
+                return url;
+        }
+    }
+}

package/esm/run.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { getEnvOptions } from '@constructive-io/graphql-env';
+import { GraphQLExplorer as server } from './server';
+server(getEnvOptions());

package/esm/server.js

@@ -0,0 +1,159 @@
+import { getEnvOptions } from '@constructive-io/graphql-env';
+import { cors, healthz, poweredBy } from '@pgpmjs/server-utils';
+import { middleware as parseDomains } from '@constructive-io/url-domains';
+import express from 'express';
+import { graphileCache } from 'graphile-cache';
+import graphqlUpload from 'graphql-upload';
+// Scalar
+import { getPgPool } from 'pg-cache';
+import { getPgEnvOptions } from 'pg-env';
+import { postgraphile } from 'postgraphile';
+import { printDatabases, printSchemas } from './render';
+import { getGraphileSettings } from './settings';
+export const GraphQLExplorer = (rawOpts = {}) => {
+    const opts = getEnvOptions(rawOpts);
+    const { pg, server } = opts;
+    const getGraphileInstanceObj = (dbname, schemaname) => {
+        const key = `${dbname}.${schemaname}`;
+        if (graphileCache.has(key)) {
+            return graphileCache.get(key);
+        }
+        const settings = {
+            ...getGraphileSettings({
+                ...opts,
+                graphile: { schema: schemaname },
+            }),
+            graphqlRoute: '/graphql',
+            graphiqlRoute: '/graphiql',
+        };
+        const pgPool = getPgPool(getPgEnvOptions({
+            ...opts.pg,
+            database: dbname,
+        }));
+        const handler = postgraphile(pgPool, schemaname, settings);
+        const obj = {
+            pgPool,
+            pgPoolKey: dbname,
+            handler,
+        };
+        graphileCache.set(key, obj);
+        return obj;
+    };
+    const app = express();
+    healthz(app);
+    cors(app, server.origin);
+    app.use(parseDomains());
+    app.use(poweredBy('constructive'));
+    app.use(graphqlUpload.graphqlUploadExpress());
+    app.use(async (req, res, next) => {
+        if (req.urlDomains?.subdomains.length === 1) {
+            const [dbName] = req.urlDomains.subdomains;
+            try {
+                const pgPool = getPgPool(getPgEnvOptions({
+                    ...opts.pg,
+                    database: dbName,
+                }));
+                const results = await pgPool.query(`
+          SELECT s.nspname AS table_schema
+          FROM pg_catalog.pg_namespace s
+          WHERE s.nspname !~ '^pg_' AND s.nspname NOT IN ('information_schema');
+        `);
+                res.send(printSchemas({
+                    dbName,
+                    schemas: results.rows,
+                    req,
+                    hostname: server.host,
+                    port: server.port,
+                }));
+                return;
+            }
+            catch (e) {
+                if (e.message?.match(/does not exist/)) {
+                    res.status(404).send('DB Not found');
+                    return;
+                }
+                console.error(e);
+                res.status(500).send('Something happened...');
+                return;
+            }
+        }
+        return next();
+    });
+    app.use(async (req, res, next) => {
+        if (req.urlDomains?.subdomains.length === 2) {
+            const [, dbName] = req.urlDomains.subdomains;
+            try {
+                const pgPool = getPgPool(getPgEnvOptions({
+                    ...opts.pg,
+                    database: dbName,
+                }));
+                await pgPool.query('SELECT 1;');
+            }
+            catch (e) {
+                if (e.message?.match(/does not exist/)) {
+                    res.status(404).send('DB Not found');
+                    return;
+                }
+                console.error(e);
+                res.status(500).send('Something happened...');
+                return;
+            }
+        }
+        return next();
+    });
+    app.use(async (req, res, next) => {
+        if (req.urlDomains?.subdomains.length === 2) {
+            const [schemaName, dbName] = req.urlDomains.subdomains;
+            try {
+                const { handler } = getGraphileInstanceObj(dbName, schemaName);
+                handler(req, res, next);
+                return;
+            }
+            catch (e) {
+                res.status(500).send(e.message);
+                return;
+            }
+        }
+        return next();
+    });
+    app.use(async (req, res, next) => {
+        if (req.urlDomains?.subdomains.length === 2 && req.url === '/flush') {
+            const [schemaName, dbName] = req.urlDomains.subdomains;
+            const key = `${dbName}.${schemaName}`;
+            graphileCache.delete(key);
+            res.status(200).send('OK');
+            return;
+        }
+        return next();
+    });
+    app.use(async (req, res, next) => {
+        if (req.urlDomains?.subdomains.length === 0) {
+            try {
+                const rootPgPool = getPgPool(getPgEnvOptions({
+                    ...opts.pg,
+                    database: opts.pg.user, // is this to get postgres?
+                }));
+                const results = await rootPgPool.query(`
+          SELECT * FROM pg_catalog.pg_database
+          WHERE datistemplate = FALSE AND datname != 'postgres' AND datname !~ '^pg_'
+        `);
+                res.send(printDatabases({ databases: results.rows, req, port: server.port }));
+                return;
+            }
+            catch (e) {
+                if (e.message?.match(/does not exist/)) {
+                    res.status(404).send('DB Not found');
+                    return;
+                }
+                console.error(e);
+                res.status(500).send('Something happened...');
+                return;
+            }
+        }
+        return next();
+    });
+    app.listen(server.port, server.host, () => {
+        console.log(`app listening at http://${server.host}:${server.port}`);
+    });
+    return app;
+};

package/esm/settings.js

@@ -0,0 +1,10 @@
+import { getEnvOptions } from '@constructive-io/graphql-env';
+import { getGraphileSettings as getSettings } from 'graphile-settings';
+export const getGraphileSettings = (rawOpts) => {
+    const opts = getEnvOptions(rawOpts);
+    const baseOptions = getSettings(opts);
+    baseOptions.pgSettings = async function pgSettings(_req) {
+        return { role: opts.pg?.user ?? 'postgres' };
+    };
+    return baseOptions;
+};

package/index.d.ts

@@ -0,0 +1 @@
+export * from './server';

package/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./server"), exports);

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@constructive-io/graphql-explorer",
+  "version": "2.10.5",
+  "author": "Constructive <developers@constructive.io>",
+  "description": "Constructive GraphQL Explorer",
+  "main": "index.js",
+  "module": "esm/index.js",
+  "types": "index.d.ts",
+  "homepage": "https://github.com/constructive-io/constructive",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/constructive-io/constructive"
+  },
+  "bugs": {
+    "url": "https://github.com/constructive-io/constructive/issues"
+  },
+  "bin": {
+    "explorer": "./run.js"
+  },
+  "scripts": {
+    "clean": "makage clean",
+    "prepack": "npm run build",
+    "build": "makage build",
+    "build:dev": "makage build --dev",
+    "dev": "ts-node src/run.ts",
+    "dev:watch": "nodemon --watch src --ext ts --exec ts-node src/run.ts",
+    "lint": "eslint . --fix",
+    "test": "jest --passWithNoTests",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@constructive-io/graphql-env": "^2.8.4",
+    "@constructive-io/graphql-types": "^2.12.4",
+    "@constructive-io/s3-streamer": "^2.8.5",
+    "@constructive-io/upload-names": "^2.3.3",
+    "@constructive-io/url-domains": "^2.3.4",
+    "@pgpmjs/server-utils": "^2.8.6",
+    "@pgpmjs/types": "^2.12.4",
+    "express": "^5.1.0",
+    "graphile-build": "^4.14.1",
+    "graphile-cache": "^1.6.6",
+    "graphile-settings": "^2.9.5",
+    "graphql": "15.10.1",
+    "graphql-upload": "^13.0.0",
+    "pg-cache": "^1.6.6",
+    "pg-env": "^1.2.3",
+    "postgraphile": "^4.14.1"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.6",
+    "@types/graphql-upload": "^8.0.12",
+    "makage": "^0.1.8",
+    "nodemon": "^3.1.10",
+    "ts-node": "^10.9.2"
+  },
+  "keywords": [
+    "graphql",
+    "explorer",
+    "ui",
+    "constructive",
+    "interface"
+  ],
+  "gitHead": "22cfe32e994e26a6490e04e28bab26d1e7e6345c"
+}

package/render.d.ts

@@ -0,0 +1,28 @@
+import { Request } from 'express';
+interface Database {
+    datname: string;
+}
+interface Schema {
+    table_schema: string;
+}
+interface PrintDatabasesParams {
+    databases: Database[];
+    req: Request;
+    port: number;
+}
+interface PrintSchemasParams {
+    dbName: string;
+    schemas: Schema[];
+    req: Request;
+    hostname: string;
+    port: number;
+}
+interface PrintHtmlParams {
+    title: string;
+    children: string;
+    rootUrl: string;
+}
+export declare const printHtml: ({ title, children, rootUrl }: PrintHtmlParams) => string;
+export declare const printDatabases: ({ databases, req, port }: PrintDatabasesParams) => string;
+export declare const printSchemas: ({ dbName, schemas, req, hostname, port }: PrintSchemasParams) => string;
+export {};

package/render.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printSchemas = exports.printDatabases = exports.printHtml = void 0;
+const printHtml = ({ title, children, rootUrl }) => {
+    return `
+    <!DOCTYPE html>
+    <html lang="en">
+      <head>
+        <meta charset="UTF-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <title>${title}</title>
+        <script src="https://cdn.tailwindcss.com"></script>
+        <style>
+          .text-brand {
+            color: #01a1ff;
+          }
+          .text-brand:hover {
+            text-decoration: underline;
+          }
+          h1.text-brand:hover {
+            text-decoration: none;
+          }
+        </style>
+      </head>
+      <body class="bg-gray-50 text-gray-900 font-sans p-6 text-sm leading-tight">
+        <div class="max-w-4xl mx-auto space-y-4">
+          <header class="flex items-center space-x-2">
+            <a href="${rootUrl}" class="shrink-0 w-6 h-6 sm:w-8 sm:h-8" aria-label="Home">
+              <svg data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64.95 61.24">
+                <path d="M16.36 43.47a14.56 14.56 0 01-8.79 0A11.16 11.16 0 011 38.34a8.83 8.83 0 01-.45-1A8.09 8.09 0 01.76 31a10.08 10.08 0 013.68-4.17 6.23 6.23 0 01-.24-.65A8.17 8.17 0 014.68 20a10.47 10.47 0 014.53-4.53 13.25 13.25 0 012.12-.9 12.35 12.35 0 012.5-7.45A17.35 17.35 0 0122.7 1a22.38 22.38 0 0113.48 0 17.07 17.07 0 019.42 6.9 18.75 18.75 0 019.8.4 14 14 0 018.29 6.46 10.17 10.17 0 01.78 1.83 10 10 0 01-.59 7.56 13.05 13.05 0 01-5.64 5.64A17.05 17.05 0 0155.4 31l-39 12.45zM64.92 36q-1.05 4.48-10.54 7.63l-.36.12L15 56.22a9.87 9.87 0 01-1.91.41C6.88 57.55 2.16 54.78 0 51.24a8.2 8.2 0 00.56 3.2 7.45 7.45 0 00.45 1 11.09 11.09 0 006.56 5.13 14.64 14.64 0 008.79 0l39-12.45a17.07 17.07 0 002.84-1.2 13 13 0 005.64-5.63 10.19 10.19 0 001-5.27zm0-8.59q-1.05 4.49-10.54 7.64l-.36.12L15 47.64a9.84 9.84 0 01-1.91.4C6.88 49 2.16 46.19 0 42.65a8.28 8.28 0 00.56 3.21 8.83 8.83 0 00.45 1A11.16 11.16 0 007.57 52a14.64 14.64 0 008.79 0l39-12.45a17.05 17.05 0 002.84-1.19 13.05 13.05 0 005.64-5.64 10.17 10.17 0 001-5.27zM9 39.13a10.11 10.11 0 006 0l39-12.45a12.25 12.25 0 002.06-.87 8.52 8.52 0 003.7-3.62 5.52 5.52 0 00.37-4.19 6.6 6.6 0 00-.46-1A9.57 9.57 0 0054 12.68a14.17 14.17 0 00-8.48 0l-.16.05-.2.07-2 .69-.84-2c-.07-.16-.12-.27-.14-.33l-.18-.27a12.26 12.26 0 00-7.2-5.51 17.85 17.85 0 00-10.73 0 12.81 12.81 0 00-6.56 4.44 7.58 7.58 0 00-1.47 6l.45 2.29-2.31.4c-.27 0-.5.09-.68.13s-.46.12-.66.19a8.31 8.31 0 00-1.47.62A5.88 5.88 0 008.78 22a3.71 3.71 0 00-.24 2.79 3.77 3.77 0 00.31.7c.07.13.15.26.24.4.1.14.19.27.29.39l2 2.44-3 1.13a9.92 9.92 0 00-.94.44 5.79 5.79 0 00-2.59 2.57 3.57 3.57 0 00-.1 2.83 4.9 4.9 0 00.22.48 6.69 6.69 0 003.92 3z" fill="#01a1ff"/></svg>
+            </a>
+            <h1 class="text-xl font-semibold text-brand">${title}</h1>
+          </header>
+          <main class="overflow-auto max-h-[90vh]">
+            ${children}
+          </main>
+        </div>
+      </body>
+    </html>
+  `.trim();
+};
+exports.printHtml = printHtml;
+const printDatabases = ({ databases, req, port }) => {
+    const rootUrl = `${req.protocol}://${req.hostname}:${port}`;
+    const links = databases
+        .map((d) => {
+        const url = `${req.protocol}://${d.datname}.${req.hostname}:${port}`;
+        return `<a href="${url}" class="text-brand hover:underline block">${d.datname}</a>`;
+    })
+        .join('');
+    return (0, exports.printHtml)({
+        title: 'Databases',
+        rootUrl,
+        children: `
+      <hr class="border-gray-300 mb-2" />
+      ${links}
+    `
+    });
+};
+exports.printDatabases = printDatabases;
+const printSchemas = ({ dbName, schemas, req, hostname, port }) => {
+    const rootUrl = `${req.protocol}://${hostname}:${port}`;
+    const links = schemas
+        .map((d) => {
+        const url = `${req.protocol}://${d.table_schema}.${req.hostname}:${port}/graphiql`;
+        return `<a href="${url}" class="text-brand hover:underline block">${d.table_schema}</a>`;
+    })
+        .join('');
+    return (0, exports.printHtml)({
+        title: `Schemas in ${dbName}`,
+        rootUrl,
+        children: `
+      <a href="${rootUrl}" class="text-xs text-brand hover:underline mb-2 inline-block">&larr; Back to root</a>
+      <hr class="border-gray-300 mb-2" />
+      ${links}
+    `
+    });
+};
+exports.printSchemas = printSchemas;

package/resolvers/uploads.d.ts

@@ -0,0 +1,29 @@
+import type { GraphQLResolveInfo } from 'graphql';
+interface UploaderOptions {
+    bucketName: string;
+    awsRegion: string;
+    awsSecretKey: string;
+    awsAccessKey: string;
+    minioEndpoint?: string;
+}
+interface Upload {
+    createReadStream: () => NodeJS.ReadableStream;
+    filename: string;
+    mimetype: string;
+    encoding: string;
+}
+interface UploadPluginInfo {
+    tags: {
+        [key: string]: any;
+    };
+    type: string;
+}
+export declare class UploadHandler {
+    private options;
+    private streamer;
+    constructor(options: UploaderOptions);
+    handleUpload(upload: Upload, _args: any, _context: any, info: GraphQLResolveInfo & {
+        uploadPlugin: UploadPluginInfo;
+    }): Promise<any>;
+}
+export {};

package/resolvers/uploads.js

@@ -0,0 +1,60 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UploadHandler = void 0;
+const s3_streamer_1 = __importDefault(require("@constructive-io/s3-streamer"));
+const upload_names_1 = __importDefault(require("@constructive-io/upload-names"));
+class UploadHandler {
+    options;
+    streamer;
+    constructor(options) {
+        this.options = options;
+        this.streamer = new s3_streamer_1.default({
+            defaultBucket: options.bucketName,
+            awsRegion: options.awsRegion,
+            awsSecretKey: options.awsSecretKey,
+            awsAccessKey: options.awsAccessKey,
+            minioEndpoint: options.minioEndpoint
+        });
+    }
+    async handleUpload(upload, _args, _context, info) {
+        const { uploadPlugin: { tags, type } } = info;
+        const readStream = upload.createReadStream();
+        const { filename, mimetype } = 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.streamer.upload({
+            readStream,
+            filename,
+            key,
+            bucket: this.options.bucketName
+        });
+        const url = result.upload.Location;
+        const { contentType, magic: { charset } } = result;
+        const typ = type || tags.type;
+        const mim = tags.mime
+            ? tags.mime.trim().split(',').map((a) => a.trim())
+            : typ === 'image'
+                ? ['image/jpg', 'image/jpeg', 'image/png', 'image/svg+xml']
+                : [];
+        if (mim.length && !mim.includes(contentType)) {
+            throw new Error(`UPLOAD_MIMETYPE ${mim.join(',')}`);
+        }
+        switch (typ) {
+            case 'image':
+            case 'upload':
+                return {
+                    filename,
+                    mime: contentType,
+                    url
+                };
+            case 'attachment':
+            default:
+                return url;
+        }
+    }
+}
+exports.UploadHandler = UploadHandler;

package/run.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/run.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const graphql_env_1 = require("@constructive-io/graphql-env");
+const server_1 = require("./server");
+(0, server_1.GraphQLExplorer)((0, graphql_env_1.getEnvOptions)());

package/server.d.ts

@@ -0,0 +1,3 @@
+import { PgpmOptions } from '@pgpmjs/types';
+import { Express } from 'express';
+export declare const GraphQLExplorer: (rawOpts?: PgpmOptions) => Express;

package/server.js

@@ -0,0 +1,166 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GraphQLExplorer = void 0;
+const graphql_env_1 = require("@constructive-io/graphql-env");
+const server_utils_1 = require("@pgpmjs/server-utils");
+const url_domains_1 = require("@constructive-io/url-domains");
+const express_1 = __importDefault(require("express"));
+const graphile_cache_1 = require("graphile-cache");
+const graphql_upload_1 = __importDefault(require("graphql-upload"));
+// Scalar
+const pg_cache_1 = require("pg-cache");
+const pg_env_1 = require("pg-env");
+const postgraphile_1 = require("postgraphile");
+const render_1 = require("./render");
+const settings_1 = require("./settings");
+const GraphQLExplorer = (rawOpts = {}) => {
+    const opts = (0, graphql_env_1.getEnvOptions)(rawOpts);
+    const { pg, server } = opts;
+    const getGraphileInstanceObj = (dbname, schemaname) => {
+        const key = `${dbname}.${schemaname}`;
+        if (graphile_cache_1.graphileCache.has(key)) {
+            return graphile_cache_1.graphileCache.get(key);
+        }
+        const settings = {
+            ...(0, settings_1.getGraphileSettings)({
+                ...opts,
+                graphile: { schema: schemaname },
+            }),
+            graphqlRoute: '/graphql',
+            graphiqlRoute: '/graphiql',
+        };
+        const pgPool = (0, pg_cache_1.getPgPool)((0, pg_env_1.getPgEnvOptions)({
+            ...opts.pg,
+            database: dbname,
+        }));
+        const handler = (0, postgraphile_1.postgraphile)(pgPool, schemaname, settings);
+        const obj = {
+            pgPool,
+            pgPoolKey: dbname,
+            handler,
+        };
+        graphile_cache_1.graphileCache.set(key, obj);
+        return obj;
+    };
+    const app = (0, express_1.default)();
+    (0, server_utils_1.healthz)(app);
+    (0, server_utils_1.cors)(app, server.origin);
+    app.use((0, url_domains_1.middleware)());
+    app.use((0, server_utils_1.poweredBy)('constructive'));
+    app.use(graphql_upload_1.default.graphqlUploadExpress());
+    app.use(async (req, res, next) => {
+        if (req.urlDomains?.subdomains.length === 1) {
+            const [dbName] = req.urlDomains.subdomains;
+            try {
+                const pgPool = (0, pg_cache_1.getPgPool)((0, pg_env_1.getPgEnvOptions)({
+                    ...opts.pg,
+                    database: dbName,
+                }));
+                const results = await pgPool.query(`
+          SELECT s.nspname AS table_schema
+          FROM pg_catalog.pg_namespace s
+          WHERE s.nspname !~ '^pg_' AND s.nspname NOT IN ('information_schema');
+        `);
+                res.send((0, render_1.printSchemas)({
+                    dbName,
+                    schemas: results.rows,
+                    req,
+                    hostname: server.host,
+                    port: server.port,
+                }));
+                return;
+            }
+            catch (e) {
+                if (e.message?.match(/does not exist/)) {
+                    res.status(404).send('DB Not found');
+                    return;
+                }
+                console.error(e);
+                res.status(500).send('Something happened...');
+                return;
+            }
+        }
+        return next();
+    });
+    app.use(async (req, res, next) => {
+        if (req.urlDomains?.subdomains.length === 2) {
+            const [, dbName] = req.urlDomains.subdomains;
+            try {
+                const pgPool = (0, pg_cache_1.getPgPool)((0, pg_env_1.getPgEnvOptions)({
+                    ...opts.pg,
+                    database: dbName,
+                }));
+                await pgPool.query('SELECT 1;');
+            }
+            catch (e) {
+                if (e.message?.match(/does not exist/)) {
+                    res.status(404).send('DB Not found');
+                    return;
+                }
+                console.error(e);
+                res.status(500).send('Something happened...');
+                return;
+            }
+        }
+        return next();
+    });
+    app.use(async (req, res, next) => {
+        if (req.urlDomains?.subdomains.length === 2) {
+            const [schemaName, dbName] = req.urlDomains.subdomains;
+            try {
+                const { handler } = getGraphileInstanceObj(dbName, schemaName);
+                handler(req, res, next);
+                return;
+            }
+            catch (e) {
+                res.status(500).send(e.message);
+                return;
+            }
+        }
+        return next();
+    });
+    app.use(async (req, res, next) => {
+        if (req.urlDomains?.subdomains.length === 2 && req.url === '/flush') {
+            const [schemaName, dbName] = req.urlDomains.subdomains;
+            const key = `${dbName}.${schemaName}`;
+            graphile_cache_1.graphileCache.delete(key);
+            res.status(200).send('OK');
+            return;
+        }
+        return next();
+    });
+    app.use(async (req, res, next) => {
+        if (req.urlDomains?.subdomains.length === 0) {
+            try {
+                const rootPgPool = (0, pg_cache_1.getPgPool)((0, pg_env_1.getPgEnvOptions)({
+                    ...opts.pg,
+                    database: opts.pg.user, // is this to get postgres?
+                }));
+                const results = await rootPgPool.query(`
+          SELECT * FROM pg_catalog.pg_database
+          WHERE datistemplate = FALSE AND datname != 'postgres' AND datname !~ '^pg_'
+        `);
+                res.send((0, render_1.printDatabases)({ databases: results.rows, req, port: server.port }));
+                return;
+            }
+            catch (e) {
+                if (e.message?.match(/does not exist/)) {
+                    res.status(404).send('DB Not found');
+                    return;
+                }
+                console.error(e);
+                res.status(500).send('Something happened...');
+                return;
+            }
+        }
+        return next();
+    });
+    app.listen(server.port, server.host, () => {
+        console.log(`app listening at http://${server.host}:${server.port}`);
+    });
+    return app;
+};
+exports.GraphQLExplorer = GraphQLExplorer;

package/settings.d.ts

@@ -0,0 +1,3 @@
+import { ConstructiveOptions } from '@constructive-io/graphql-types';
+import { PostGraphileOptions } from 'postgraphile';
+export declare const getGraphileSettings: (rawOpts: ConstructiveOptions) => PostGraphileOptions;

package/settings.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGraphileSettings = void 0;
+const graphql_env_1 = require("@constructive-io/graphql-env");
+const graphile_settings_1 = require("graphile-settings");
+const getGraphileSettings = (rawOpts) => {
+    const opts = (0, graphql_env_1.getEnvOptions)(rawOpts);
+    const baseOptions = (0, graphile_settings_1.getGraphileSettings)(opts);
+    baseOptions.pgSettings = async function pgSettings(_req) {
+        return { role: opts.pg?.user ?? 'postgres' };
+    };
+    return baseOptions;
+};
+exports.getGraphileSettings = getGraphileSettings;