@ryangarber/prisma-orm-extension-pgvector 8.0.0-rc.8 → 8.0.0-rc.8a

package/README.md

@@ -1,11 +1,29 @@
-# @prisma/orm-extension-pgvector
+# @ryangarber/prisma-orm-extension-pgvector
 
 Embedding columns and vector similarity search for Prisma Next on PostgreSQL, powered by [pgvector](https://github.com/pgvector/pgvector).
 
 ```bash
-pnpm add @prisma/orm-extension-pgvector
+pnpm add @prisma/orm-extension-pgvector@npm:@ryangarber/prisma-orm-extension-pgvector@8.0.0-rc.8a
 ```
 
+Keep `@prisma/orm-extension-pgvector` as the dependency key and use the `npm:` target to select this fork. Prisma's contract emitter intentionally generates imports from the canonical package name, so the alias makes those imports resolve to this package without rewriting generated files. Application imports should use the canonical name for the same reason:
+
+```ts
+import pgvector from '@prisma/orm-extension-pgvector/control';
+```
+
+## About this fork
+
+The original extension doesn't support embeddings with variable dimensions. This package adds support for a plain `Vector()` type on top of the original `Vector(N)`.
+
+It is intended for this fork to stay as close as possible to the original until the Prisma team (hopefully) introduces this support officially.
+
+Versions are matched to the latest official version, plus a letter to signify patches specific to the fork:
+
+| Official Version |  Fork (Patch 1) |
+| ---------------- | --------------- |
+|    8.0.0-rc.8    | 8.0.0-rc.8**a** |
+
 ## Entrypoints
 
 | Namespace | Surface |

package/dist/column-types.d.mts

@@ -1,9 +1,31 @@
 import { ColumnTypeDescriptor } from "@prisma/orm-framework/components/codec";
 //#region ../../../3-extensions/pgvector/dist/column-types.d.mts
 //#region src/exports/column-types.d.ts
+/**
+ * Factory for creating non-dimensioned vector column descriptors.
+ *
+ * @example
+ * ```typescript
+ * .column('embedding', { type: vector(), nullable: false })
+ * // Produces: nativeType: 'vector', typeParams: {}
+ * ```
+ * @returns A column type descriptor without `typeParams.length` set
+ */
 declare function vector(): ColumnTypeDescriptor & {
   readonly typeParams: Record<string, never>;
 };
+/**
+ * Factory for creating dimensioned vector column descriptors.
+ *
+ * @example
+ * ```typescript
+ * .column('embedding', { type: vector(1536), nullable: false })
+ * // Produces: nativeType: 'vector', typeParams: { length: 1536 }
+ * ```
+ * @param length - The dimension of the vector (e.g., 1536 for OpenAI embeddings)
+ * @returns A column type descriptor with `typeParams.length` set
+ * @throws `CONTRACT.ARGUMENT_INVALID` if length is not an integer in the range [1, VECTOR_MAX_DIM]
+ */
 declare function vector<N extends number>(length: N): ColumnTypeDescriptor & {
   readonly typeParams: {
     readonly length: N;

package/dist/column-types.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"column-types.d.mts","names":[],"sources":["../../../../3-extensions/pgvector/dist/column-types.d.mts"],"mappings":";;;iBAEiB,UAAU;WAChB,YAAY;;iBAEN,OAAO,kBAAkB,QAAQ,IAAI;WAC3C;aACE,QAAQ"}
+{"version":3,"file":"column-types.d.mts","names":[],"sources":["../../../../3-extensions/pgvector/dist/column-types.d.mts"],"mappings":";;;;;;;;;;;;;iBAYiB,UAAU;WAChB,YAAY;;;;;;;;;;;;;;iBAcN,OAAO,kBAAkB,QAAQ,IAAI;WAC3C;aACE,QAAQ"}

package/package.json

@@ -1,6 +1,9 @@
 {
   "name": "@ryangarber/prisma-orm-extension-pgvector",
-  "version": "8.0.0-rc.8",
+  "version": "8.0.0-rc.8a",
+  "publishConfig": {
+    "access": "public"
+  },
   "license": "Apache-2.0",
   "type": "module",
   "sideEffects": false,