@pgpmjs/migrate-client 0.1.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,112 @@
+# @pgpmjs/migrate-client
+
+<p align="center" width="100%">
+  <img height="120" 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/@pgpmjs/migrate-client"><img height="20" src="https://img.shields.io/github/package-json/v/constructive-io/constructive?filename=sdk%2Fmigrate-client%2Fpackage.json"/></a>
+</p>
+
+Typed GraphQL ORM client for the Constructive Migrate API (`db_migrate` schema).
+
+Generated from `migrate.graphql` via `@constructive-io/graphql-codegen`.
+
+## Usage
+
+```typescript
+import { createClient } from '@pgpmjs/migrate-client';
+
+const db = createClient({
+  endpoint: 'https://migrate.example.com/graphql',
+  headers: { Authorization: 'Bearer <token>' },
+});
+
+// Fetch all sql_actions for a database
+const result = await db.sqlAction.findMany({
+  select: { id: true, name: true, deploy: true, revert: true, verify: true, content: true },
+  where: { databaseId: { equalTo: '<database-uuid>' } },
+}).unwrap();
+
+console.log(result.sqlActions.nodes);
+```
+
+## Regeneration
+
+```bash
+pnpm generate
+```
+
+This runs codegen against `schemas/migrate.graphql` and outputs to `src/`.
+
+---
+
+Built by the [Constructive](https://constructive.io) team.
+
+## 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.
+
+---
+
+## 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/index.d.ts

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

package/esm/index.js

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

package/esm/migrate/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * GraphQL SDK - auto-generated, do not edit
+ * @generated by @constructive-io/graphql-codegen
+ */
+export * from './orm';

package/esm/migrate/index.js

@@ -0,0 +1,5 @@
+/**
+ * GraphQL SDK - auto-generated, do not edit
+ * @generated by @constructive-io/graphql-codegen
+ */
+export * from './orm';

package/esm/migrate/orm/client.d.ts

@@ -0,0 +1,55 @@
+/**
+ * ORM Client - Runtime GraphQL executor
+ * @generated by @constructive-io/graphql-codegen
+ * DO NOT EDIT - changes will be overwritten
+ */
+import type { GraphQLAdapter, GraphQLError, QueryResult } from '@constructive-io/graphql-types';
+export type { GraphQLAdapter, GraphQLError, QueryResult } from '@constructive-io/graphql-types';
+/**
+ * Default adapter that uses fetch for HTTP requests.
+ * This is used when no custom adapter is provided.
+ */
+export declare class FetchAdapter implements GraphQLAdapter {
+    private endpoint;
+    private headers;
+    constructor(endpoint: string, headers?: Record<string, string>);
+    execute<T>(document: string, variables?: Record<string, unknown>): Promise<QueryResult<T>>;
+    setHeaders(headers: Record<string, string>): void;
+    getEndpoint(): string;
+}
+/**
+ * Configuration for creating an ORM client.
+ * Either provide endpoint (and optional headers) for HTTP requests,
+ * or provide a custom adapter for alternative execution strategies.
+ */
+export interface OrmClientConfig {
+    /** GraphQL endpoint URL (required if adapter not provided) */
+    endpoint?: string;
+    /** Default headers for HTTP requests (only used with endpoint) */
+    headers?: Record<string, string>;
+    /** Custom adapter for GraphQL execution (overrides endpoint/headers) */
+    adapter?: GraphQLAdapter;
+}
+/**
+ * Error thrown when GraphQL request fails
+ */
+export declare class GraphQLRequestError extends Error {
+    readonly errors: GraphQLError[];
+    readonly data: unknown;
+    constructor(errors: GraphQLError[], data?: unknown);
+}
+export declare class OrmClient {
+    private adapter;
+    constructor(config: OrmClientConfig);
+    execute<T>(document: string, variables?: Record<string, unknown>): Promise<QueryResult<T>>;
+    /**
+     * Set headers for requests.
+     * Only works if the adapter supports headers.
+     */
+    setHeaders(headers: Record<string, string>): void;
+    /**
+     * Get the endpoint URL.
+     * Returns empty string if the adapter doesn't have an endpoint.
+     */
+    getEndpoint(): string;
+}

package/esm/migrate/orm/client.js

@@ -0,0 +1,99 @@
+/**
+ * Default adapter that uses fetch for HTTP requests.
+ * This is used when no custom adapter is provided.
+ */
+export class FetchAdapter {
+    endpoint;
+    headers;
+    constructor(endpoint, headers) {
+        this.endpoint = endpoint;
+        this.headers = headers ?? {};
+    }
+    async execute(document, variables) {
+        const response = await fetch(this.endpoint, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                Accept: 'application/json',
+                ...this.headers,
+            },
+            body: JSON.stringify({
+                query: document,
+                variables: variables ?? {},
+            }),
+        });
+        if (!response.ok) {
+            return {
+                ok: false,
+                data: null,
+                errors: [{ message: `HTTP ${response.status}: ${response.statusText}` }],
+            };
+        }
+        const json = (await response.json());
+        if (json.errors && json.errors.length > 0) {
+            return {
+                ok: false,
+                data: null,
+                errors: json.errors,
+            };
+        }
+        return {
+            ok: true,
+            data: json.data,
+            errors: undefined,
+        };
+    }
+    setHeaders(headers) {
+        this.headers = { ...this.headers, ...headers };
+    }
+    getEndpoint() {
+        return this.endpoint;
+    }
+}
+/**
+ * Error thrown when GraphQL request fails
+ */
+export class GraphQLRequestError extends Error {
+    errors;
+    data;
+    constructor(errors, data = null) {
+        const messages = errors.map((e) => e.message).join('; ');
+        super(`GraphQL Error: ${messages}`);
+        this.errors = errors;
+        this.data = data;
+        this.name = 'GraphQLRequestError';
+    }
+}
+export class OrmClient {
+    adapter;
+    constructor(config) {
+        if (config.adapter) {
+            this.adapter = config.adapter;
+        }
+        else if (config.endpoint) {
+            this.adapter = new FetchAdapter(config.endpoint, config.headers);
+        }
+        else {
+            throw new Error('OrmClientConfig requires either an endpoint or a custom adapter');
+        }
+    }
+    async execute(document, variables) {
+        return this.adapter.execute(document, variables);
+    }
+    /**
+     * Set headers for requests.
+     * Only works if the adapter supports headers.
+     */
+    setHeaders(headers) {
+        if (this.adapter.setHeaders) {
+            this.adapter.setHeaders(headers);
+        }
+    }
+    /**
+     * Get the endpoint URL.
+     * Returns empty string if the adapter doesn't have an endpoint.
+     */
+    getEndpoint() {
+        return this.adapter.getEndpoint?.() ?? '';
+    }
+}

package/esm/migrate/orm/index.d.ts

@@ -0,0 +1,48 @@
+import type { OrmClientConfig } from './client';
+import { MigrateFileModel } from './models/migrateFile';
+import { SqlActionModel } from './models/sqlAction';
+export type { OrmClientConfig, QueryResult, GraphQLError, GraphQLAdapter } from './client';
+export { GraphQLRequestError } from './client';
+export { QueryBuilder } from './query-builder';
+export * from './select-types';
+export * from './models';
+export { createMutationOperations } from './mutation';
+/**
+ * Create an ORM client instance
+ *
+ * @example
+ * ```typescript
+ * const db = createClient({
+ *   endpoint: 'https://api.example.com/graphql',
+ *   headers: { Authorization: 'Bearer token' },
+ * });
+ *
+ * // Query users
+ * const users = await db.user.findMany({
+ *   select: { id: true, name: true },
+ *   first: 10,
+ * }).execute();
+ *
+ * // Create a user
+ * const newUser = await db.user.create({
+ *   data: { name: 'John', email: 'john@example.com' },
+ *   select: { id: true },
+ * }).execute();
+ * ```
+ */
+export declare function createClient(config: OrmClientConfig): {
+    migrateFile: MigrateFileModel;
+    sqlAction: SqlActionModel;
+    mutation: {
+        executeSql: <S extends import("./input-types").ExecuteSqlPayloadSelect>(args: import("./mutation").ExecuteSqlVariables, options: {
+            select: S;
+        } & import("./select-types").StrictSelect<S, import("./input-types").ExecuteSqlPayloadSelect>) => import("./query-builder").QueryBuilder<{
+            executeSql: import("./select-types").InferSelectResult<import("./input-types").ExecuteSqlPayload, S> | null;
+        }>;
+        runMigration: <S extends import("./input-types").RunMigrationPayloadSelect>(args: import("./mutation").RunMigrationVariables, options: {
+            select: S;
+        } & import("./select-types").StrictSelect<S, import("./input-types").RunMigrationPayloadSelect>) => import("./query-builder").QueryBuilder<{
+            runMigration: import("./select-types").InferSelectResult<import("./input-types").RunMigrationPayload, S> | null;
+        }>;
+    };
+};

package/esm/migrate/orm/index.js

@@ -0,0 +1,45 @@
+/**
+ * ORM Client - createClient factory
+ * @generated by @constructive-io/graphql-codegen
+ * DO NOT EDIT - changes will be overwritten
+ */
+import { OrmClient } from './client';
+import { MigrateFileModel } from './models/migrateFile';
+import { SqlActionModel } from './models/sqlAction';
+import { createMutationOperations } from './mutation';
+export { GraphQLRequestError } from './client';
+export { QueryBuilder } from './query-builder';
+export * from './select-types';
+export * from './models';
+export { createMutationOperations } from './mutation';
+/**
+ * Create an ORM client instance
+ *
+ * @example
+ * ```typescript
+ * const db = createClient({
+ *   endpoint: 'https://api.example.com/graphql',
+ *   headers: { Authorization: 'Bearer token' },
+ * });
+ *
+ * // Query users
+ * const users = await db.user.findMany({
+ *   select: { id: true, name: true },
+ *   first: 10,
+ * }).execute();
+ *
+ * // Create a user
+ * const newUser = await db.user.create({
+ *   data: { name: 'John', email: 'john@example.com' },
+ *   select: { id: true },
+ * }).execute();
+ * ```
+ */
+export function createClient(config) {
+    const client = new OrmClient(config);
+    return {
+        migrateFile: new MigrateFileModel(client),
+        sqlAction: new SqlActionModel(client),
+        mutation: createMutationOperations(client),
+    };
+}