Merge pull request #760 from constructive-io/devin/1772321033-graphile-pgvector-plugin

feat: add graphile-pgvector-plugin, switch graphile-settings to use it

Author: pyramation

.github/workflows/run-tests.yaml

@@ -75,6 +75,8 @@ jobs:
             env: {}
           - package: graphile/graphile-authz
             env: {}
+          - package: graphile/graphile-pgvector-plugin
+            env: {}
           - package: graphile/postgraphile-plugin-pgvector
             env: {}
           - package: graphql/server-test

graphile/graphile-pgvector-plugin/README.md

@@ -0,0 +1,79 @@
+# graphile-pgvector-plugin
+
+PostGraphile v5 codec plugin for [pgvector](https://github.com/pgvector/pgvector) — makes `vector` columns, mutations, and SQL functions work automatically.
+
+## How it works
+
+This plugin registers a **codec** for the pgvector `vector` type. Without it, PostGraphile silently ignores `vector(n)` columns and skips SQL functions that accept `vector` arguments.
+
+Once installed:
+
+- `vector(n)` columns appear on GraphQL output types
+- `vector(n)` columns appear in `create` / `update` mutation inputs
+- SQL functions with `vector` arguments are exposed as query/mutation fields
+- A `Vector` GraphQL scalar handles serialization (`[Float]`)
+
+## Installation
+
+```bash
+pnpm add graphile-pgvector-plugin
+```
+
+## Prerequisites
+
+- PostgreSQL with pgvector extension installed
+- PostGraphile v5
+
+## Usage
+
+```typescript
+import { VectorCodecPreset } from 'graphile-pgvector-plugin';
+
+const preset = {
+  extends: [
+    // ...other presets
+    VectorCodecPreset,
+  ],
+};
+```
+
+Zero configuration required. Any table with a `vector` column just works.
+
+## GraphQL Examples
+
+```graphql
+# Vector columns appear on types automatically
+query {
+  contacts {
+    nodes {
+      id
+      name
+      embedding
+    }
+  }
+}
+
+# SQL functions with vector args are auto-exposed
+query {
+  searchContacts(queryEmbedding: [0.1, 0.2, 0.3]) {
+    nodes {
+      id
+      name
+    }
+  }
+}
+
+# Mutations include vector columns
+mutation {
+  createContact(input: { name: "Test", embedding: [0.1, 0.2, 0.3] }) {
+    contact {
+      id
+      embedding
+    }
+  }
+}
+```
+
+## License
+
+MIT

graphile/graphile-pgvector-plugin/jest.config.js

@@ -0,0 +1,18 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        babelConfig: false,
+        tsconfig: 'tsconfig.json'
+      }
+    ]
+  },
+  transformIgnorePatterns: [`/node_modules/*`],
+  testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$',
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+  modulePathIgnorePatterns: ['dist/*']
+};

graphile/graphile-pgvector-plugin/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "graphile-pgvector-plugin",
+  "version": "1.0.0",
+  "description": "PostGraphile v5 codec plugin for pgvector — makes vector columns, mutations, and functions work automatically",
+  "author": "Constructive <developers@constructive.io>",
+  "homepage": "https://github.com/constructive-io/constructive",
+  "license": "MIT",
+  "main": "index.js",
+  "module": "esm/index.js",
+  "types": "index.d.ts",
+  "scripts": {
+    "clean": "makage clean",
+    "prepack": "npm 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/constructive-io/constructive"
+  },
+  "bugs": {
+    "url": "https://github.com/constructive-io/constructive/issues"
+  },
+  "devDependencies": {
+    "@types/node": "^22.19.1",
+    "@types/pg": "^8.16.0",
+    "graphile-test": "workspace:^",
+    "makage": "^0.1.10",
+    "pg": "^8.17.1",
+    "pgsql-test": "workspace:^"
+  },
+  "peerDependencies": {
+    "graphile-build": "5.0.0-rc.4",
+    "graphile-build-pg": "5.0.0-rc.5",
+    "graphile-config": "1.0.0-rc.5",
+    "graphql": "^16.9.0",
+    "pg-sql2": "5.0.0-rc.4",
+    "postgraphile": "5.0.0-rc.7"
+  },
+  "keywords": [
+    "postgraphile",
+    "graphile",
+    "constructive",
+    "plugin",
+    "postgres",
+    "graphql",
+    "pgvector",
+    "vector",
+    "embeddings",
+    "ai"
+  ]
+}