@hollware/client 0.4.0 → 0.5.0

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { WebhookCheck, describeSite, getEntry, getTranslations, listEntries, signWebhook, verifyWebhook } from "@hollware/core";
+import { WebhookCheck, describeSite, getEntry, getTranslations, listEntries, search, signWebhook, verifyWebhook } from "@hollware/core";
 import * as z from "zod";
 //#region src/index.d.ts
 export declare const name = "@hollware/client";
@@ -6,6 +6,8 @@ type Output<Spec extends {
   output: z.ZodType;
 }> = z.output<Spec['output']>;
 export type Format = 'markdown' | 'document' | 'html';
+/** How a search is made: by its words, by meaning, or both merged. */
+export type SearchMode = 'fulltext' | 'semantic' | 'hybrid';
 /**
  * What a site reads from Hollware: the published content, through the four read methods. A
  * service binding to a Hollware Worker already has this shape; `createClient` gives the same over
@@ -14,6 +16,7 @@ export type Format = 'markdown' | 'document' | 'html';
 export interface HollwareReader {
   getEntry(site: string, collection: string, slug: string, locale: string, options?: {
     readonly formats?: readonly Format[];
+    readonly related?: boolean;
   }): Promise<Output<typeof getEntry>>;
   listEntries(site: string, collection: string, options?: {
     readonly locale?: string;
@@ -23,6 +26,13 @@ export interface HollwareReader {
   }): Promise<Output<typeof listEntries>>;
   getTranslations(site: string, collection: string, translationGroup: string): Promise<Output<typeof getTranslations>>;
   describeSite(site: string): Promise<Output<typeof describeSite>>;
+  /** The published entries that match `query`, best first: by its words, by meaning, or both. */
+  search(site: string, query: string, options?: {
+    readonly collection?: string;
+    readonly locale?: string;
+    readonly limit?: number;
+    readonly mode?: SearchMode;
+  }): Promise<Output<typeof search>>;
 }
 export type ClientOptions =
 /** A service binding to the `Hollware` entrypoint of a Hollware Worker. */

package/dist/index.mjs

@@ -36,7 +36,10 @@ function httpReader(url, token, send) {
 	}
 	const segment = encodeURIComponent;
 	return {
-		getEntry: (_site, collection, slug, locale, options) => get(`${segment(collection)}/${segment(locale)}/${segment(slug)}`, { formats: options?.formats?.join(",") }),
+		getEntry: (_site, collection, slug, locale, options) => get(`${segment(collection)}/${segment(locale)}/${segment(slug)}`, {
+			formats: options?.formats?.join(","),
+			related: options?.related === true ? "true" : void 0
+		}),
 		listEntries: (_site, collection, options = {}) => get(segment(collection), {
 			locale: options.locale,
 			tag: options.tag,
@@ -44,7 +47,14 @@ function httpReader(url, token, send) {
 			cursor: options.cursor
 		}),
 		getTranslations: (_site, collection, group) => get(`${segment(collection)}/translations/${segment(group)}`),
-		describeSite: (_site) => get("site")
+		describeSite: (_site) => get("site"),
+		search: (_site, query, options = {}) => get("search", {
+			q: query,
+			collection: options.collection,
+			locale: options.locale,
+			limit: options.limit === void 0 ? void 0 : String(options.limit),
+			mode: options.mode
+		})
 	};
 }
 /**
@@ -60,7 +70,8 @@ function createClient(options) {
 		getEntry: async (...args) => narrow(await reader.getEntry(...args)),
 		listEntries: async (...args) => narrow(await reader.listEntries(...args)),
 		getTranslations: async (...args) => narrow(await reader.getTranslations(...args)),
-		describeSite: async (...args) => narrow(await reader.describeSite(...args))
+		describeSite: async (...args) => narrow(await reader.describeSite(...args)),
+		search: async (...args) => narrow(await reader.search(...args))
 	};
 }
 /** The body of an answer, which the read API builds from the output schema of its operation. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hollware/client",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Typed Hollware client over a service binding or HTTP.",
   "homepage": "https://hollware.com",
   "bugs": {
@@ -28,7 +28,7 @@
     "provenance": true
   },
   "dependencies": {
-    "@hollware/core": "0.4.0"
+    "@hollware/core": "0.5.0"
   },
   "devDependencies": {
     "@types/node": "24.19.2",