@prisma-next/extension-paradedb 0.5.0-dev.9 → 0.6.0-dev.1

package/src/types/index-types.ts

@@ -1,179 +1,12 @@
-import type { IndexDef } from '@prisma-next/contract-authoring';
-import type { TokenizerId } from '../core/constants';
-
-/**
- * BM25 field config for a table column.
- */
-export type Bm25ColumnFieldConfig = {
-  readonly column: string;
-  readonly expression?: never;
-  readonly tokenizer?: string;
-  readonly tokenizerParams?: Record<string, unknown>;
-  readonly alias?: string;
-};
-
-/**
- * BM25 field config for a SQL expression.
- */
-export type Bm25ExpressionFieldConfig = {
-  readonly expression: string;
-  readonly column?: never;
-  readonly alias: string;
-  readonly tokenizer?: string;
-  readonly tokenizerParams?: Record<string, unknown>;
-};
-
-/**
- * BM25 field config union.
- */
-export type Bm25FieldConfig = Bm25ColumnFieldConfig | Bm25ExpressionFieldConfig;
-
-/**
- * BM25 index configuration payload stored in `IndexDef.config`.
- */
-export type Bm25IndexConfig = {
-  readonly keyField: string;
-  readonly fields: readonly Bm25FieldConfig[];
-};
-
-/**
- * Options for a BM25 text field (text, varchar columns).
- */
-export type Bm25TextFieldOptions = {
-  readonly tokenizer?: TokenizerId | (string & {});
-  readonly stemmer?: string;
-  readonly alias?: string;
-  readonly remove_emojis?: boolean;
-};
-
-/**
- * Options for a BM25 JSON field (json, jsonb columns).
- */
-export type Bm25JsonFieldOptions = {
-  readonly tokenizer?: TokenizerId | (string & {});
-  readonly alias?: string;
-  /** Ngram-specific params when tokenizer is 'ngram'. */
-  readonly min?: number;
-  readonly max?: number;
-};
-
-/**
- * Options for a BM25 expression-based field.
- */
-export type Bm25ExpressionFieldOptions = {
-  readonly alias: string;
-  readonly tokenizer?: TokenizerId | (string & {});
-  readonly min?: number;
-  readonly max?: number;
-  readonly stemmer?: string;
-  readonly pattern?: string;
-};
-
-type TokenizerConfig = {
-  readonly tokenizer?: string;
-  readonly tokenizerParams?: Record<string, unknown>;
-};
-
-/**
- * Options for constructing a BM25 index definition.
- */
-export type Bm25IndexOptions = {
-  readonly keyField: string;
-  readonly fields: readonly Bm25FieldConfig[];
-  readonly name?: string;
-};
-
-/**
- * Typed BM25 field builders.
- * These produce `Bm25FieldConfig` objects for use in `bm25Index()`.
- */
-export const bm25 = {
-  /** Text field with optional tokenizer config. */
-  text(column: string, opts?: Bm25TextFieldOptions): Bm25FieldConfig {
-    return {
-      column,
-      ...buildTokenizerConfig(opts?.tokenizer, {
-        stemmer: opts?.stemmer,
-        remove_emojis: opts?.remove_emojis,
-      }),
-      ...(opts?.alias !== undefined && { alias: opts.alias }),
-    };
-  },
-
-  /** Numeric field (filterable, sortable in BM25). */
-  numeric(column: string): Bm25FieldConfig {
-    return { column };
-  },
-
-  /** Boolean field. */
-  boolean(column: string): Bm25FieldConfig {
-    return { column };
-  },
-
-  /** JSON/JSONB field with optional tokenizer config. */
-  json(column: string, opts?: Bm25JsonFieldOptions): Bm25FieldConfig {
-    return {
-      column,
-      ...buildTokenizerConfig(opts?.tokenizer, { min: opts?.min, max: opts?.max }),
-      ...(opts?.alias !== undefined && { alias: opts.alias }),
-    };
-  },
-
-  /** Datetime (timestamp/date) field. */
-  datetime(column: string): Bm25FieldConfig {
-    return { column };
-  },
-
-  /** Range field. */
-  range(column: string): Bm25FieldConfig {
-    return { column };
-  },
-
-  /** Raw SQL expression field. `alias` is required. */
-  expression(sql: string, opts: Bm25ExpressionFieldOptions): Bm25FieldConfig {
-    return {
-      expression: sql,
-      alias: opts.alias,
-      ...buildTokenizerConfig(opts.tokenizer, {
-        min: opts.min,
-        max: opts.max,
-        stemmer: opts.stemmer,
-        pattern: opts.pattern,
-      }),
-    };
-  },
-} as const;
-
-/**
- * Creates a generic index definition with a ParadeDB BM25 payload.
- *
- * `columns` only includes real table columns so core index validation remains
- * target-agnostic. Expression fields stay in extension-owned `config.fields`.
- */
-export function bm25Index(opts: Bm25IndexOptions): IndexDef {
-  return {
-    columns: opts.fields.flatMap((field) => ('column' in field ? [field.column] : [])),
-    ...(opts.name !== undefined && { name: opts.name }),
-    using: 'bm25',
-    config: {
-      keyField: opts.keyField,
-      fields: opts.fields,
-    } satisfies Bm25IndexConfig,
-  };
-}
-
-/**
- * Builds `{ tokenizer, tokenizerParams? }` from a tokenizer ID and a bag of params.
- * Filters out undefined values and omits `tokenizerParams` when empty.
- */
-function buildTokenizerConfig(
-  tokenizer: string | undefined,
-  params: Record<string, unknown>,
-): TokenizerConfig {
-  if (!tokenizer) return {};
-  const filtered = Object.fromEntries(Object.entries(params).filter(([, v]) => v !== undefined));
-  return {
-    tokenizer,
-    ...(Object.keys(filtered).length > 0 && { tokenizerParams: filtered }),
-  };
-}
+import { defineIndexTypes } from '@prisma-next/sql-contract/index-types';
+import { type } from 'arktype';
+
+export const paradedbIndexTypes = defineIndexTypes().add('bm25', {
+  options: type({
+    '+': 'reject',
+    key_field: 'string',
+  }),
+});
+
+export type IndexTypes = typeof paradedbIndexTypes.IndexTypes;
+export type Bm25IndexOptions = IndexTypes['bm25']['options'];

package/src/types/operation-types.ts

@@ -0,0 +1,84 @@
+import type { SqlQueryOperationTypes } from '@prisma-next/sql-contract/types';
+import type { CodecExpression, Expression } from '@prisma-next/sql-relational-core/expression';
+import type { ParadeDbProximityChain } from '../core/proximity-chain';
+
+type CodecTypesBase = Record<string, { readonly input: unknown; readonly output: unknown }>;
+
+export type QueryOperationTypes<CT extends CodecTypesBase> = SqlQueryOperationTypes<
+  CT,
+  {
+    readonly paradeDbMatch: {
+      readonly self: { readonly codecId: 'pg/text@1' };
+      readonly impl: (
+        self: CodecExpression<'pg/text@1', boolean, CT>,
+        query: CodecExpression<'pg/text@1', boolean, CT>,
+      ) => Expression<{ codecId: 'pg/bool@1'; nullable: false }>;
+    };
+    readonly paradeDbMatchAny: {
+      readonly self: { readonly codecId: 'pg/text@1' };
+      readonly impl: (
+        self: CodecExpression<'pg/text@1', boolean, CT>,
+        query: CodecExpression<'pg/text@1', boolean, CT>,
+      ) => Expression<{ codecId: 'pg/bool@1'; nullable: false }>;
+    };
+    readonly paradeDbMatchAll: {
+      readonly self: { readonly codecId: 'pg/text@1' };
+      readonly impl: (
+        self: CodecExpression<'pg/text@1', boolean, CT>,
+        query: CodecExpression<'pg/text@1', boolean, CT>,
+      ) => Expression<{ codecId: 'pg/bool@1'; nullable: false }>;
+    };
+    readonly paradeDbTerm: {
+      readonly self: { readonly codecId: 'pg/text@1' };
+      readonly impl: (
+        self: CodecExpression<'pg/text@1', boolean, CT>,
+        query: CodecExpression<'pg/text@1', boolean, CT>,
+      ) => Expression<{ codecId: 'pg/bool@1'; nullable: false }>;
+    };
+    readonly paradeDbPhrase: {
+      readonly self: { readonly codecId: 'pg/text@1' };
+      readonly impl: (
+        self: CodecExpression<'pg/text@1', boolean, CT>,
+        query: CodecExpression<'pg/text@1', boolean, CT>,
+      ) => Expression<{ codecId: 'pg/bool@1'; nullable: false }>;
+    };
+    readonly paradeDbScore: {
+      readonly self: { readonly codecId: 'pg/int4@1' };
+      readonly impl: (
+        self: CodecExpression<'pg/int4@1', boolean, CT>,
+      ) => Expression<{ codecId: 'pg/float4@1'; nullable: false }>;
+    };
+    readonly paradeDbFuzzy: {
+      readonly self: { readonly codecId: 'pg/text@1' };
+      readonly impl: (
+        self: CodecExpression<'pg/text@1', boolean, CT>,
+        distance: number,
+      ) => Expression<{ codecId: 'pg/text@1'; nullable: false }>;
+    };
+    readonly paradeDbBoost: {
+      readonly self: { readonly codecId: 'pg/text@1' };
+      readonly impl: (
+        self: CodecExpression<'pg/text@1', boolean, CT>,
+        weight: number,
+      ) => Expression<{ codecId: 'pg/text@1'; nullable: false }>;
+    };
+    readonly paradeDbConst: {
+      readonly self: { readonly codecId: 'pg/text@1' };
+      readonly impl: (
+        self: CodecExpression<'pg/text@1', boolean, CT>,
+        value: number,
+      ) => Expression<{ codecId: 'pg/text@1'; nullable: false }>;
+    };
+    readonly paradeDbSlop: {
+      readonly self: { readonly codecId: 'pg/text@1' };
+      readonly impl: (
+        self: CodecExpression<'pg/text@1', boolean, CT>,
+        slop: number,
+      ) => Expression<{ codecId: 'pg/text@1'; nullable: false }>;
+    };
+    readonly paradeDbProximity: {
+      readonly self: { readonly codecId: 'pg/text@1' };
+      readonly impl: (start: CodecExpression<'pg/text@1', boolean, CT>) => ParadeDbProximityChain;
+    };
+  }
+>;

package/dist/descriptor-meta-BTFnIGJ6.mjs

@@ -1,20 +0,0 @@
-//#region src/core/constants.ts
-/**
-* Extension ID for ParadeDB pg_search.
-*/
-const PARADEDB_EXTENSION_ID = "paradedb";
-
-//#endregion
-//#region src/core/descriptor-meta.ts
-const paradedbPackMeta = {
-	kind: "extension",
-	id: PARADEDB_EXTENSION_ID,
-	familyId: "sql",
-	targetId: "postgres",
-	version: "0.0.1",
-	capabilities: { postgres: { "paradedb/bm25": true } }
-};
-
-//#endregion
-export { paradedbPackMeta as t };
-//# sourceMappingURL=descriptor-meta-BTFnIGJ6.mjs.map

package/dist/descriptor-meta-BTFnIGJ6.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"descriptor-meta-BTFnIGJ6.mjs","names":[],"sources":["../src/core/constants.ts","../src/core/descriptor-meta.ts"],"sourcesContent":["/**\n * Extension ID for ParadeDB pg_search.\n */\nexport const PARADEDB_EXTENSION_ID = 'paradedb' as const;\n\n/**\n * Built-in ParadeDB tokenizer IDs.\n * These correspond to the `pdb.*` casting syntax in `CREATE INDEX ... USING bm25`.\n */\nexport type TokenizerId =\n  | 'unicode_words'\n  | 'simple'\n  | 'ngram'\n  | 'icu'\n  | 'regex_pattern'\n  | 'source_code'\n  | 'literal'\n  | 'literal_normalized'\n  | 'whitespace'\n  | 'chinese_compatible'\n  | 'jieba'\n  | 'lindera';\n","import { PARADEDB_EXTENSION_ID } from './constants';\n\nexport const paradedbPackMeta = {\n  kind: 'extension',\n  id: PARADEDB_EXTENSION_ID,\n  familyId: 'sql',\n  targetId: 'postgres',\n  version: '0.0.1',\n  capabilities: {\n    postgres: {\n      'paradedb/bm25': true,\n    },\n  },\n} as const;\n"],"mappings":";;;;AAGA,MAAa,wBAAwB;;;;ACDrC,MAAa,mBAAmB;CAC9B,MAAM;CACN,IAAI;CACJ,UAAU;CACV,UAAU;CACV,SAAS;CACT,cAAc,EACZ,UAAU,EACR,iBAAiB,MAClB,EACF;CACF"}

package/dist/index-types.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index-types.mjs","names":[],"sources":["../src/types/index-types.ts"],"sourcesContent":["import type { IndexDef } from '@prisma-next/contract-authoring';\nimport type { TokenizerId } from '../core/constants';\n\n/**\n * BM25 field config for a table column.\n */\nexport type Bm25ColumnFieldConfig = {\n  readonly column: string;\n  readonly expression?: never;\n  readonly tokenizer?: string;\n  readonly tokenizerParams?: Record<string, unknown>;\n  readonly alias?: string;\n};\n\n/**\n * BM25 field config for a SQL expression.\n */\nexport type Bm25ExpressionFieldConfig = {\n  readonly expression: string;\n  readonly column?: never;\n  readonly alias: string;\n  readonly tokenizer?: string;\n  readonly tokenizerParams?: Record<string, unknown>;\n};\n\n/**\n * BM25 field config union.\n */\nexport type Bm25FieldConfig = Bm25ColumnFieldConfig | Bm25ExpressionFieldConfig;\n\n/**\n * BM25 index configuration payload stored in `IndexDef.config`.\n */\nexport type Bm25IndexConfig = {\n  readonly keyField: string;\n  readonly fields: readonly Bm25FieldConfig[];\n};\n\n/**\n * Options for a BM25 text field (text, varchar columns).\n */\nexport type Bm25TextFieldOptions = {\n  readonly tokenizer?: TokenizerId | (string & {});\n  readonly stemmer?: string;\n  readonly alias?: string;\n  readonly remove_emojis?: boolean;\n};\n\n/**\n * Options for a BM25 JSON field (json, jsonb columns).\n */\nexport type Bm25JsonFieldOptions = {\n  readonly tokenizer?: TokenizerId | (string & {});\n  readonly alias?: string;\n  /** Ngram-specific params when tokenizer is 'ngram'. */\n  readonly min?: number;\n  readonly max?: number;\n};\n\n/**\n * Options for a BM25 expression-based field.\n */\nexport type Bm25ExpressionFieldOptions = {\n  readonly alias: string;\n  readonly tokenizer?: TokenizerId | (string & {});\n  readonly min?: number;\n  readonly max?: number;\n  readonly stemmer?: string;\n  readonly pattern?: string;\n};\n\ntype TokenizerConfig = {\n  readonly tokenizer?: string;\n  readonly tokenizerParams?: Record<string, unknown>;\n};\n\n/**\n * Options for constructing a BM25 index definition.\n */\nexport type Bm25IndexOptions = {\n  readonly keyField: string;\n  readonly fields: readonly Bm25FieldConfig[];\n  readonly name?: string;\n};\n\n/**\n * Typed BM25 field builders.\n * These produce `Bm25FieldConfig` objects for use in `bm25Index()`.\n */\nexport const bm25 = {\n  /** Text field with optional tokenizer config. */\n  text(column: string, opts?: Bm25TextFieldOptions): Bm25FieldConfig {\n    return {\n      column,\n      ...buildTokenizerConfig(opts?.tokenizer, {\n        stemmer: opts?.stemmer,\n        remove_emojis: opts?.remove_emojis,\n      }),\n      ...(opts?.alias !== undefined && { alias: opts.alias }),\n    };\n  },\n\n  /** Numeric field (filterable, sortable in BM25). */\n  numeric(column: string): Bm25FieldConfig {\n    return { column };\n  },\n\n  /** Boolean field. */\n  boolean(column: string): Bm25FieldConfig {\n    return { column };\n  },\n\n  /** JSON/JSONB field with optional tokenizer config. */\n  json(column: string, opts?: Bm25JsonFieldOptions): Bm25FieldConfig {\n    return {\n      column,\n      ...buildTokenizerConfig(opts?.tokenizer, { min: opts?.min, max: opts?.max }),\n      ...(opts?.alias !== undefined && { alias: opts.alias }),\n    };\n  },\n\n  /** Datetime (timestamp/date) field. */\n  datetime(column: string): Bm25FieldConfig {\n    return { column };\n  },\n\n  /** Range field. */\n  range(column: string): Bm25FieldConfig {\n    return { column };\n  },\n\n  /** Raw SQL expression field. `alias` is required. */\n  expression(sql: string, opts: Bm25ExpressionFieldOptions): Bm25FieldConfig {\n    return {\n      expression: sql,\n      alias: opts.alias,\n      ...buildTokenizerConfig(opts.tokenizer, {\n        min: opts.min,\n        max: opts.max,\n        stemmer: opts.stemmer,\n        pattern: opts.pattern,\n      }),\n    };\n  },\n} as const;\n\n/**\n * Creates a generic index definition with a ParadeDB BM25 payload.\n *\n * `columns` only includes real table columns so core index validation remains\n * target-agnostic. Expression fields stay in extension-owned `config.fields`.\n */\nexport function bm25Index(opts: Bm25IndexOptions): IndexDef {\n  return {\n    columns: opts.fields.flatMap((field) => ('column' in field ? [field.column] : [])),\n    ...(opts.name !== undefined && { name: opts.name }),\n    using: 'bm25',\n    config: {\n      keyField: opts.keyField,\n      fields: opts.fields,\n    } satisfies Bm25IndexConfig,\n  };\n}\n\n/**\n * Builds `{ tokenizer, tokenizerParams? }` from a tokenizer ID and a bag of params.\n * Filters out undefined values and omits `tokenizerParams` when empty.\n */\nfunction buildTokenizerConfig(\n  tokenizer: string | undefined,\n  params: Record<string, unknown>,\n): TokenizerConfig {\n  if (!tokenizer) return {};\n  const filtered = Object.fromEntries(Object.entries(params).filter(([, v]) => v !== undefined));\n  return {\n    tokenizer,\n    ...(Object.keys(filtered).length > 0 && { tokenizerParams: filtered }),\n  };\n}\n"],"mappings":";;;;;AAyFA,MAAa,OAAO;CAElB,KAAK,QAAgB,MAA8C;AACjE,SAAO;GACL;GACA,GAAG,qBAAqB,MAAM,WAAW;IACvC,SAAS,MAAM;IACf,eAAe,MAAM;IACtB,CAAC;GACF,GAAI,MAAM,UAAU,UAAa,EAAE,OAAO,KAAK,OAAO;GACvD;;CAIH,QAAQ,QAAiC;AACvC,SAAO,EAAE,QAAQ;;CAInB,QAAQ,QAAiC;AACvC,SAAO,EAAE,QAAQ;;CAInB,KAAK,QAAgB,MAA8C;AACjE,SAAO;GACL;GACA,GAAG,qBAAqB,MAAM,WAAW;IAAE,KAAK,MAAM;IAAK,KAAK,MAAM;IAAK,CAAC;GAC5E,GAAI,MAAM,UAAU,UAAa,EAAE,OAAO,KAAK,OAAO;GACvD;;CAIH,SAAS,QAAiC;AACxC,SAAO,EAAE,QAAQ;;CAInB,MAAM,QAAiC;AACrC,SAAO,EAAE,QAAQ;;CAInB,WAAW,KAAa,MAAmD;AACzE,SAAO;GACL,YAAY;GACZ,OAAO,KAAK;GACZ,GAAG,qBAAqB,KAAK,WAAW;IACtC,KAAK,KAAK;IACV,KAAK,KAAK;IACV,SAAS,KAAK;IACd,SAAS,KAAK;IACf,CAAC;GACH;;CAEJ;;;;;;;AAQD,SAAgB,UAAU,MAAkC;AAC1D,QAAO;EACL,SAAS,KAAK,OAAO,SAAS,UAAW,YAAY,QAAQ,CAAC,MAAM,OAAO,GAAG,EAAE,CAAE;EAClF,GAAI,KAAK,SAAS,UAAa,EAAE,MAAM,KAAK,MAAM;EAClD,OAAO;EACP,QAAQ;GACN,UAAU,KAAK;GACf,QAAQ,KAAK;GACd;EACF;;;;;;AAOH,SAAS,qBACP,WACA,QACiB;AACjB,KAAI,CAAC,UAAW,QAAO,EAAE;CACzB,MAAM,WAAW,OAAO,YAAY,OAAO,QAAQ,OAAO,CAAC,QAAQ,GAAG,OAAO,MAAM,OAAU,CAAC;AAC9F,QAAO;EACL;EACA,GAAI,OAAO,KAAK,SAAS,CAAC,SAAS,KAAK,EAAE,iBAAiB,UAAU;EACtE"}