tsense 0.0.15 → 0.0.17

package/README.md

@@ -89,20 +89,20 @@ type("string").configure({
 
 ### Collection Methods
 
-| Method/Property | Description |
-| --------------- | ----------- |
-| `create()` | Creates the collection in Typesense |
-| `drop()` | Deletes the collection |
-| `get(id)` | Retrieves a document by ID |
-| `delete(id)` | Deletes a document by ID |
-| `deleteMany(filter)` | Deletes documents matching filter |
-| `update(id, data)` | Updates a document by ID |
-| `updateMany(filter, data)` | Updates documents matching filter |
-| `upsert(docs)` | Inserts or updates documents |
-| `search(options)` | Searches the collection |
-| `syncSchema()` | Syncs schema (creates/patches collection) |
-| `syncData(options)` | Syncs data from external source |
-| `fields` | Array of generated field schemas |
+| Method/Property            | Description                               |
+| -------------------------- | ----------------------------------------- |
+| `create()`                 | Creates the collection in Typesense       |
+| `drop()`                   | Deletes the collection                    |
+| `get(id)`                  | Retrieves a document by ID                |
+| `delete(id)`               | Deletes a document by ID                  |
+| `deleteMany(filter)`       | Deletes documents matching filter         |
+| `update(id, data)`         | Updates a document by ID                  |
+| `updateMany(filter, data)` | Updates documents matching filter         |
+| `upsert(docs)`             | Inserts or updates documents              |
+| `search(options)`          | Searches the collection                   |
+| `syncSchema()`             | Syncs schema (creates/patches collection) |
+| `syncData(options)`        | Syncs data from external source           |
+| `fields`                   | Array of generated field schemas          |
 
 ### Schema Sync
 
@@ -130,7 +130,11 @@ const Collection = new TSense({
   // ...
   dataSync: {
     getAllIds: async () => {
-      return db.selectFrom("users").select("id").execute().then(rows => rows.map(r => r.id));
+      return db
+        .selectFrom("users")
+        .select("id")
+        .execute()
+        .then((rows) => rows.map((r) => r.id));
     },
     getItems: async (ids) => {
       return db.selectFrom("users").where("id", "in", ids).execute();
@@ -161,4 +165,4 @@ filter: { age: [25, 30, 35] }               // IN
 filter: { age: { min: 20, max: 40 } }       // Range
 filter: { name: { not: "John" } }           // Not equal
 filter: { OR: [{ age: 25 }, { age: 30 }] }  // OR conditions
-```
+```

package/dist/index.d.ts

@@ -3,4 +3,4 @@ export { DateTransformer } from "./transformers/date.js";
 export { defaultTransformers } from "./transformers/defaults.js";
 export type { FieldTransformer } from "./transformers/types.js";
 export { TSense } from "./tsense.js";
-export type { ConnectionConfig, DeleteResult, FilterFor, HighlightOptions, SearchListOptions, SearchListResult, SearchOptions, SearchResult, SyncConfig, SyncOptions, SyncResult, TsenseOptions, UpdateResult, UpsertResult, } from "./types.js";
+export type { ConnectionConfig, DeleteResult, FilterFor, HighlightOptions, ProjectSearch, SearchListOptions, SearchListResult, SearchOptions, SearchOptionsPlain, SearchOptionsWithOmit, SearchOptionsWithPick, SearchResult, SyncConfig, SyncOptions, SyncResult, TsenseOptions, UpdateResult, UpsertResult, } from "./types.js";

package/dist/tsense.d.ts

@@ -1,6 +1,6 @@
 import type { Type } from "arktype";
 import redaxios from "redaxios";
-import type { DeleteResult, FieldSchema, FilterFor, SearchListOptions, SearchListResult, SearchOptions, SearchResult, SyncOptions, SyncResult, TsenseOptions, UpdateResult, UpsertResult } from "./types.js";
+import type { DeleteResult, FieldSchema, FilterFor, ProjectSearch, SearchListOptions, SearchListResult, SearchOptions, SearchOptionsPlain, SearchResult, SyncOptions, SyncResult, TsenseOptions, UpdateResult, UpsertResult } from "./types.js";
 declare const redaxiosInstance: {
     <T>(urlOrConfig: string | redaxios.Options, config?: redaxios.Options | undefined, _method?: any, data?: any, _undefined?: undefined): Promise<redaxios.Response<T>>;
     request: (<T_1 = any>(config?: redaxios.Options | undefined) => Promise<redaxios.Response<T_1>>) | (<T_2 = any>(url: string, config?: redaxios.Options | undefined) => Promise<redaxios.Response<T_2>>);
@@ -85,12 +85,12 @@ export declare class TSense<T extends Type> {
     deleteMany(filter: FilterFor<T["infer"]>): Promise<DeleteResult>;
     update(id: string, data: Partial<T["infer"]>): Promise<T["infer"]>;
     updateMany(filter: FilterFor<T["infer"]>, data: Partial<T["infer"]>): Promise<UpdateResult>;
-    search(options: SearchOptions<T["infer"]>): Promise<SearchResult<T["infer"]>>;
+    search<const O extends SearchOptions<T["infer"]> = SearchOptionsPlain<T["infer"]>>(options: O): Promise<SearchResult<ProjectSearch<T["infer"], O>>>;
     searchList(options: SearchListOptions<T["infer"]>): Promise<SearchListResult<T["infer"]>>;
     count(filter?: FilterFor<T["infer"]>): Promise<number>;
     upsert(docs: T["infer"] | T["infer"][]): Promise<UpsertResult[]>;
     syncData(options?: SyncOptions): Promise<SyncResult>;
     private purgeOrphans;
-    private exportIds;
+    exportIds(): Promise<string[]>;
 }
 export {};

package/dist/types.d.ts

@@ -63,7 +63,7 @@ export type HighlightOptions<T> = {
     endTag?: string;
 };
 type SortableField<T> = Extract<keyof T, string> | "score";
-type BaseSearchOptions<T> = {
+export type BaseSearchOptions<T> = {
     query?: string;
     queryBy?: (keyof T)[];
     filter?: FilterFor<T>;
@@ -73,16 +73,24 @@ type BaseSearchOptions<T> = {
     limit?: number;
     highlight?: boolean | HighlightOptions<T>;
 };
-export type SearchOptions<T> = BaseSearchOptions<T> & ({
-    pick?: (keyof T)[];
+export type SearchOptionsWithPick<T, K extends readonly (keyof T)[]> = BaseSearchOptions<T> & {
+    pick: K;
     omit?: never;
-} | {
-    omit?: (keyof T)[];
+};
+export type SearchOptionsWithOmit<T, K extends readonly (keyof T)[]> = BaseSearchOptions<T> & {
+    omit: K;
     pick?: never;
-} | {
+};
+export type SearchOptionsPlain<T> = BaseSearchOptions<T> & {
     pick?: never;
     omit?: never;
-});
+};
+export type SearchOptions<T> = SearchOptionsWithPick<T, readonly (keyof T)[]> | SearchOptionsWithOmit<T, readonly (keyof T)[]> | SearchOptionsPlain<T>;
+export type ProjectSearch<T, O> = O extends {
+    pick: readonly (infer K)[];
+} ? Pick<T, Extract<K, keyof T>> : O extends {
+    omit: readonly (infer K)[];
+} ? Omit<T, Extract<K, keyof T>> : T;
 export type SearchResult<T> = {
     count: number;
     data: T[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "tsense",
-	"version": "0.0.15",
+	"version": "0.0.17",
 	"private": false,
 	"description": "Opinionated, fully typed typesense client",
 	"keywords": [
@@ -28,7 +28,7 @@
 		"build": "tsc",
 		"ci": "bun run build && bun run format && bun run check-exports",
 		"test": "bun test",
-		"format": "biome check --write",
+		"format": "oxfmt check --write src tests",
 		"check-exports": "attw --pack . --ignore-rules=cjs-resolves-to-esm",
 		"local-release": "changeset version && changeset publish",
 		"prepublishOnly": "bun run ci"
@@ -49,4 +49,4 @@
 		"arktype": "^2.1.29",
 		"typescript": "^5"
 	}
-}
+}