@constructive-io/graphql-realtime-test 0.2.0

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,86 @@
+# @constructive-io/graphql-realtime-test
+
+Constructive-level wrapper around `graphile-realtime-test` that pre-loads the
+full `ConstructivePreset` (auth, RLS, storage, search, realtime subscriptions,
+etc.) into the GraphQL schema used for subscription testing.
+
+This mirrors the relationship between `graphile-test` and
+`@constructive-io/graphql-test`: a thin layer that swaps `MinimalPreset` for
+`ConstructivePreset` so tests run against the real Constructive plugin stack.
+
+## Usage
+
+```typescript
+import { getConnections } from '@constructive-io/graphql-realtime-test';
+
+const conn = await getConnections({
+  schemas: ['app_public'],
+  seed: 'path/to/seed.sql',
+  realtimeTables: ['items'],
+  buildPgSettings: (params) => ({
+    role: 'authenticated',
+    'jwt.claims.user_id': params.user_id,
+  }),
+});
+
+// conn.ws.createClient(), conn.notifyChange(), etc.
+await conn.teardown();
+```
+
+---
+
+## 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
+
+### 📦 Package Management
+
+* [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.
+
+### 🧪 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.
+* [pgsql-seed](https://github.com/constructive-io/constructive/tree/main/postgres/pgsql-seed): **🌱 PostgreSQL seeding utilities** for CSV, JSON, SQL data loading, and pgpm deployment.
+* [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.
+
+## 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/get-connections.js

@@ -0,0 +1,29 @@
+import { getConnections as getLowLevelConnections } from 'graphile-realtime-test';
+import { ConstructivePreset } from 'graphile-settings';
+/**
+ * Creates realtime test connections using the full ConstructivePreset.
+ *
+ * This wraps `graphile-realtime-test`'s `getConnections` by injecting the
+ * ConstructivePreset into the schema build. The returned `GetConnectionsResult`
+ * includes a fully wired WebSocket server, notify helpers, and all Constructive
+ * plugins (auth, RLS, storage, search, realtime subscriptions, etc.).
+ *
+ * Mirrors the pattern of `@constructive-io/graphql-test`'s `getConnections`
+ * wrapping `graphile-test`.
+ */
+export async function getConnections(input, seedAdapters) {
+    const mergedInput = {
+        ...input,
+        preset: {
+            extends: [
+                ConstructivePreset,
+                ...(input.preset?.extends ?? []),
+            ],
+            ...(input.preset?.disablePlugins && { disablePlugins: input.preset.disablePlugins }),
+            ...(input.preset?.plugins && { plugins: input.preset.plugins }),
+            ...(input.preset?.schema && { schema: input.preset.schema }),
+            ...(input.preset?.grafast && { grafast: input.preset.grafast }),
+        },
+    };
+    return getLowLevelConnections(mergedInput, seedAdapters);
+}

package/esm/graphile-test.js

@@ -0,0 +1,29 @@
+import { createRealtimeTestContext } from 'graphile-realtime-test';
+import { ConstructivePreset } from 'graphile-settings';
+/**
+ * Creates a realtime test context using the full ConstructivePreset.
+ *
+ * This is the Constructive-specific wrapper that pre-loads all plugins
+ * from graphile-settings (auth, RLS, storage, search, etc.) into the
+ * realtime subscription schema. For generic realtime testing without
+ * the Constructive preset, use graphile-realtime-test directly.
+ *
+ * Mirrors the pattern of `@constructive-io/graphql-test`'s `GraphQLTest`
+ * wrapping `graphile-test`.
+ */
+export async function createConstructiveRealtimeTestContext(input, seedAdapters) {
+    const mergedInput = {
+        ...input,
+        preset: {
+            extends: [
+                ConstructivePreset,
+                ...(input.preset?.extends ?? []),
+            ],
+            ...(input.preset?.disablePlugins && { disablePlugins: input.preset.disablePlugins }),
+            ...(input.preset?.plugins && { plugins: input.preset.plugins }),
+            ...(input.preset?.schema && { schema: input.preset.schema }),
+            ...(input.preset?.grafast && { grafast: input.preset.grafast }),
+        },
+    };
+    return createRealtimeTestContext(mergedInput, seedAdapters);
+}

package/esm/index.js

@@ -0,0 +1,12 @@
+// Re-export low-level utilities that don't need Constructive wrapping
+export { subscribe, waitForEvent, collectEvents, } from 'graphile-realtime-test';
+export { notify, notifyChange, notifyInvalidate, buildPayload, buildInvalidatePayload, } from 'graphile-realtime-test';
+export { nextEvent, collectWsEvents, delay, } from 'graphile-realtime-test';
+export { createWsTestServer } from 'graphile-realtime-test';
+export { makeRealtimeSmartTagsPlugin } from 'graphile-realtime-test';
+// Re-export low-level DB connection utilities for advanced two-phase patterns
+export { getConnections as getDbConnections } from 'pgsql-test';
+export { seed, snapshot } from 'pgsql-test';
+// Override with our Constructive-specific implementations
+export { createConstructiveRealtimeTestContext } from './graphile-test';
+export { getConnections } from './get-connections';

package/get-connections.d.ts

@@ -0,0 +1,14 @@
+import type { GetConnectionsInput, GetConnectionsResult } from 'graphile-realtime-test';
+import type { SeedAdapter } from 'pgsql-test/seed/types';
+/**
+ * Creates realtime test connections using the full ConstructivePreset.
+ *
+ * This wraps `graphile-realtime-test`'s `getConnections` by injecting the
+ * ConstructivePreset into the schema build. The returned `GetConnectionsResult`
+ * includes a fully wired WebSocket server, notify helpers, and all Constructive
+ * plugins (auth, RLS, storage, search, realtime subscriptions, etc.).
+ *
+ * Mirrors the pattern of `@constructive-io/graphql-test`'s `getConnections`
+ * wrapping `graphile-test`.
+ */
+export declare function getConnections(input: GetConnectionsInput, seedAdapters?: SeedAdapter[]): Promise<GetConnectionsResult>;

package/get-connections.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConnections = getConnections;
+const graphile_realtime_test_1 = require("graphile-realtime-test");
+const graphile_settings_1 = require("graphile-settings");
+/**
+ * Creates realtime test connections using the full ConstructivePreset.
+ *
+ * This wraps `graphile-realtime-test`'s `getConnections` by injecting the
+ * ConstructivePreset into the schema build. The returned `GetConnectionsResult`
+ * includes a fully wired WebSocket server, notify helpers, and all Constructive
+ * plugins (auth, RLS, storage, search, realtime subscriptions, etc.).
+ *
+ * Mirrors the pattern of `@constructive-io/graphql-test`'s `getConnections`
+ * wrapping `graphile-test`.
+ */
+async function getConnections(input, seedAdapters) {
+    const mergedInput = {
+        ...input,
+        preset: {
+            extends: [
+                graphile_settings_1.ConstructivePreset,
+                ...(input.preset?.extends ?? []),
+            ],
+            ...(input.preset?.disablePlugins && { disablePlugins: input.preset.disablePlugins }),
+            ...(input.preset?.plugins && { plugins: input.preset.plugins }),
+            ...(input.preset?.schema && { schema: input.preset.schema }),
+            ...(input.preset?.grafast && { grafast: input.preset.grafast }),
+        },
+    };
+    return (0, graphile_realtime_test_1.getConnections)(mergedInput, seedAdapters);
+}

package/graphile-test.d.ts

@@ -0,0 +1,14 @@
+import type { RealtimeTestInput, RealtimeTestContext } from 'graphile-realtime-test';
+import type { SeedAdapter } from 'pgsql-test/seed/types';
+/**
+ * Creates a realtime test context using the full ConstructivePreset.
+ *
+ * This is the Constructive-specific wrapper that pre-loads all plugins
+ * from graphile-settings (auth, RLS, storage, search, etc.) into the
+ * realtime subscription schema. For generic realtime testing without
+ * the Constructive preset, use graphile-realtime-test directly.
+ *
+ * Mirrors the pattern of `@constructive-io/graphql-test`'s `GraphQLTest`
+ * wrapping `graphile-test`.
+ */
+export declare function createConstructiveRealtimeTestContext(input: RealtimeTestInput, seedAdapters?: SeedAdapter[]): Promise<RealtimeTestContext>;

package/graphile-test.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createConstructiveRealtimeTestContext = createConstructiveRealtimeTestContext;
+const graphile_realtime_test_1 = require("graphile-realtime-test");
+const graphile_settings_1 = require("graphile-settings");
+/**
+ * Creates a realtime test context using the full ConstructivePreset.
+ *
+ * This is the Constructive-specific wrapper that pre-loads all plugins
+ * from graphile-settings (auth, RLS, storage, search, etc.) into the
+ * realtime subscription schema. For generic realtime testing without
+ * the Constructive preset, use graphile-realtime-test directly.
+ *
+ * Mirrors the pattern of `@constructive-io/graphql-test`'s `GraphQLTest`
+ * wrapping `graphile-test`.
+ */
+async function createConstructiveRealtimeTestContext(input, seedAdapters) {
+    const mergedInput = {
+        ...input,
+        preset: {
+            extends: [
+                graphile_settings_1.ConstructivePreset,
+                ...(input.preset?.extends ?? []),
+            ],
+            ...(input.preset?.disablePlugins && { disablePlugins: input.preset.disablePlugins }),
+            ...(input.preset?.plugins && { plugins: input.preset.plugins }),
+            ...(input.preset?.schema && { schema: input.preset.schema }),
+            ...(input.preset?.grafast && { grafast: input.preset.grafast }),
+        },
+    };
+    return (0, graphile_realtime_test_1.createRealtimeTestContext)(mergedInput, seedAdapters);
+}

package/index.d.ts

@@ -0,0 +1,15 @@
+export type { RealtimeTestInput, RealtimeTestContext, } from 'graphile-realtime-test';
+export type { GetConnectionsInput, GetConnectionsResult, WsHandle, } from 'graphile-realtime-test';
+export type { SubscriptionEvent, SubscribeOptions, } from 'graphile-realtime-test';
+export type { WsTestServerInput, WsTestServer, } from 'graphile-realtime-test';
+export { subscribe, waitForEvent, collectEvents, } from 'graphile-realtime-test';
+export { notify, notifyChange, notifyInvalidate, buildPayload, buildInvalidatePayload, } from 'graphile-realtime-test';
+export { nextEvent, collectWsEvents, delay, } from 'graphile-realtime-test';
+export { createWsTestServer } from 'graphile-realtime-test';
+export { makeRealtimeSmartTagsPlugin } from 'graphile-realtime-test';
+export { getConnections as getDbConnections } from 'pgsql-test';
+export type { GetConnectionResult, GetConnectionOpts } from 'pgsql-test';
+export type { PgTestClient } from 'pgsql-test/test-client';
+export { seed, snapshot } from 'pgsql-test';
+export { createConstructiveRealtimeTestContext } from './graphile-test';
+export { getConnections } from './get-connections';

package/index.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConnections = exports.createConstructiveRealtimeTestContext = exports.snapshot = exports.seed = exports.getDbConnections = exports.makeRealtimeSmartTagsPlugin = exports.createWsTestServer = exports.delay = exports.collectWsEvents = exports.nextEvent = exports.buildInvalidatePayload = exports.buildPayload = exports.notifyInvalidate = exports.notifyChange = exports.notify = exports.collectEvents = exports.waitForEvent = exports.subscribe = void 0;
+// Re-export low-level utilities that don't need Constructive wrapping
+var graphile_realtime_test_1 = require("graphile-realtime-test");
+Object.defineProperty(exports, "subscribe", { enumerable: true, get: function () { return graphile_realtime_test_1.subscribe; } });
+Object.defineProperty(exports, "waitForEvent", { enumerable: true, get: function () { return graphile_realtime_test_1.waitForEvent; } });
+Object.defineProperty(exports, "collectEvents", { enumerable: true, get: function () { return graphile_realtime_test_1.collectEvents; } });
+var graphile_realtime_test_2 = require("graphile-realtime-test");
+Object.defineProperty(exports, "notify", { enumerable: true, get: function () { return graphile_realtime_test_2.notify; } });
+Object.defineProperty(exports, "notifyChange", { enumerable: true, get: function () { return graphile_realtime_test_2.notifyChange; } });
+Object.defineProperty(exports, "notifyInvalidate", { enumerable: true, get: function () { return graphile_realtime_test_2.notifyInvalidate; } });
+Object.defineProperty(exports, "buildPayload", { enumerable: true, get: function () { return graphile_realtime_test_2.buildPayload; } });
+Object.defineProperty(exports, "buildInvalidatePayload", { enumerable: true, get: function () { return graphile_realtime_test_2.buildInvalidatePayload; } });
+var graphile_realtime_test_3 = require("graphile-realtime-test");
+Object.defineProperty(exports, "nextEvent", { enumerable: true, get: function () { return graphile_realtime_test_3.nextEvent; } });
+Object.defineProperty(exports, "collectWsEvents", { enumerable: true, get: function () { return graphile_realtime_test_3.collectWsEvents; } });
+Object.defineProperty(exports, "delay", { enumerable: true, get: function () { return graphile_realtime_test_3.delay; } });
+var graphile_realtime_test_4 = require("graphile-realtime-test");
+Object.defineProperty(exports, "createWsTestServer", { enumerable: true, get: function () { return graphile_realtime_test_4.createWsTestServer; } });
+var graphile_realtime_test_5 = require("graphile-realtime-test");
+Object.defineProperty(exports, "makeRealtimeSmartTagsPlugin", { enumerable: true, get: function () { return graphile_realtime_test_5.makeRealtimeSmartTagsPlugin; } });
+// Re-export low-level DB connection utilities for advanced two-phase patterns
+var pgsql_test_1 = require("pgsql-test");
+Object.defineProperty(exports, "getDbConnections", { enumerable: true, get: function () { return pgsql_test_1.getConnections; } });
+var pgsql_test_2 = require("pgsql-test");
+Object.defineProperty(exports, "seed", { enumerable: true, get: function () { return pgsql_test_2.seed; } });
+Object.defineProperty(exports, "snapshot", { enumerable: true, get: function () { return pgsql_test_2.snapshot; } });
+// Override with our Constructive-specific implementations
+var graphile_test_1 = require("./graphile-test");
+Object.defineProperty(exports, "createConstructiveRealtimeTestContext", { enumerable: true, get: function () { return graphile_test_1.createConstructiveRealtimeTestContext; } });
+var get_connections_1 = require("./get-connections");
+Object.defineProperty(exports, "getConnections", { enumerable: true, get: function () { return get_connections_1.getConnections; } });

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@constructive-io/graphql-realtime-test",
+  "version": "0.2.0",
+  "author": "Constructive <developers@constructive.io>",
+  "description": "Constructive Realtime GraphQL Testing with all plugins loaded",
+  "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"
+  },
+  "scripts": {
+    "clean": "makage clean",
+    "prepack": "npm run build",
+    "build": "makage build",
+    "build:dev": "makage build --dev",
+    "lint": "eslint . --fix",
+    "test": "jest --passWithNoTests",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@constructive-io/graphql-test": "^4.19.2",
+    "graphile-realtime-test": "^0.6.0",
+    "graphile-settings": "^5.2.0",
+    "graphile-test": "^4.15.0"
+  },
+  "peerDependencies": {
+    "grafast": "1.0.0",
+    "graphile-build": "5.0.0",
+    "graphile-build-pg": "5.0.0",
+    "graphile-config": "1.0.0",
+    "graphql": "16.13.0",
+    "graphql-ws": "^6.0.8",
+    "pg": "^8.20.0",
+    "postgraphile": "5.0.0",
+    "ws": "^8.20.0"
+  },
+  "devDependencies": {
+    "@types/pg": "^8.18.0",
+    "@types/ws": "^8.18.1",
+    "makage": "^0.3.0",
+    "pgsql-test": "^4.14.0"
+  },
+  "keywords": [
+    "testing",
+    "graphql",
+    "graphile",
+    "constructive",
+    "subscriptions",
+    "realtime",
+    "test"
+  ],
+  "gitHead": "4265b835743ff8e0240dc1fcbcceec85a9846ff7"
+}