@yak-io/prismic 0.1.1 → 0.1.2

package/README.md

@@ -1,14 +1,10 @@
 # @yak-io/prismic
 
-Adapters that turn Prismic CMS documents into Yak routes, tools, and schema sources. This package plugs directly into `@yak-io/javascript` and works seamlessly with the Next.js and Nuxt helpers.
+> 📚 **Full documentation:** https://docs.yak.io/docs/cms/prismic
+>
+> 🤖 **For LLMs / AI agents:** https://docs.yak.io/llms.txt
 
-## What you get
-
-- `createPrismicRouteAdapter` – produces a `RouteSource` from Prismic documents. Use it when your routes live in Prismic instead of (or alongside) the filesystem.
-- `createPrismicToolAdapter` – produces a `ToolSource` exposing `prismic.getByUID`, `prismic.getAllByType`, and `prismic.search` as tools the LLM can invoke.
-- `createPrismicSchemaSource` – produces a `SchemaSource` describing the Prismic content model so the LLM understands document types and fields.
-
-## Installation
+Prismic CMS adapter for [Yak](https://docs.yak.io). It turns Prismic documents into Yak **routes** (so the assistant knows your pages), **tools** (so it can fetch content), and a **schema source** (so it understands your content model). Plugs into `@yak-io/javascript`'s `createYakHandler` or `@yak-io/nextjs`'s `createNextYakHandler`.
 
 ```bash
 pnpm add @yak-io/prismic @yak-io/javascript @prismicio/client
@@ -16,6 +12,14 @@ pnpm add @yak-io/prismic @yak-io/javascript @prismicio/client
 
 `@prismicio/client` is a peer dependency (v7+).
 
+## Exports
+
+| Export | Returns | Purpose |
+| --- | --- | --- |
+| `createPrismicRouteAdapter(config)` | `RouteSource` | Routes from Prismic documents — when pages live in Prismic. |
+| `createPrismicToolAdapter(config)` | `ToolSource` | Exposes `prismic.getByUID`, `prismic.getAllByType`, `prismic.search` as tools. |
+| `createPrismicSchemaSource(config)` | `SchemaSource` | Describes your content model so the assistant understands document types + fields. |
+
 ## Usage
 
 ### 1. Create a Prismic client
@@ -28,14 +32,11 @@ const client = prismic.createClient("your-repo-name", {
 });
 ```
 
-### 2. Use it with a Yak handler
+### 2. Wire adapters into a Yak handler (server)
 
 ```ts
 import { createNextYakHandler } from "@yak-io/nextjs/server";
-import {
-  createPrismicRouteAdapter,
-  createPrismicToolAdapter,
-} from "@yak-io/prismic";
+import { createPrismicRouteAdapter, createPrismicToolAdapter } from "@yak-io/prismic";
 
 const prismicRoutes = createPrismicRouteAdapter({
   client,
@@ -58,11 +59,9 @@ export const { GET, POST } = createNextYakHandler({
 });
 ```
 
-The adapters return standard `RouteSource` / `ToolSource` shapes, so you can compose them with filesystem routes, tRPC tools, or any other source by passing arrays.
+Both return standard `RouteSource` / `ToolSource` shapes, so you can compose them with filesystem routes, tRPC tools, or any other source by passing arrays.
 
-### 3. Optionally expose the content model
-
-Inside your client-side `getConfig` provider:
+### 3. Optionally expose the content model (client `getConfig`)
 
 ```ts
 import { createPrismicSchemaSource } from "@yak-io/prismic";
@@ -70,27 +69,59 @@ import { createPrismicSchemaSource } from "@yak-io/prismic";
 const getConfig = async () => {
   const res = await fetch("/api/yak");
   const config = await res.json();
-  const schemaSource = await createPrismicSchemaSource({
-    client,
-    mode: "graphql",
-  });
+  const schemaSource = await createPrismicSchemaSource({ client, mode: "graphql" });
   return { ...config, schemaSources: [schemaSource] };
 };
 ```
 
+## API reference
+
+### `createPrismicRouteAdapter(config)`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `client` | `Client` | — | Prismic client (required). |
+| `documentTypes` | `string[]` | — | Document types to turn into routes (required). |
+| `resolveRoute` | `(doc) => RouteInfo \| null` | — | Map a document to a route; return `null` to skip it (e.g. drafts) (required). |
+| `filters` | `string[]` | — | Prismic query filters. |
+| `id` | `string` | `"prismic"` | Source id. |
+
+### `createPrismicToolAdapter(config)`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `client` | `Client` | — | Prismic client (required). |
+| `allowedTypes` | `string[]` | — | Document types the assistant may fetch (required). |
+| `fields` | `Record<string, string[]>` | — | Per-type field allowlist returned to the assistant. |
+| `id` | `string` | `"prismic"` | Source id. |
+
+### `createPrismicSchemaSource(config)`
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `client` | `Client` | — | Prismic client (required). |
+| `mode` | `"graphql"` | — | Schema introspection mode (required). |
+| `name` | `string` | — | Schema source name. |
+| `fetchFn` | `typeof fetch` | global `fetch` | Custom fetch implementation. |
+
+## Security
+
+- Always set `allowedTypes` on the tool adapter — without it the assistant could fetch any document type in your repository.
+- Return `null` from `resolveRoute` to keep drafts or hidden pages out of the route manifest.
+
 ## Types
 
-All route/tool/schema types are re-exported from `@yak-io/javascript/server`:
+Route/tool/schema types are re-exported from `@yak-io/javascript/server`:
 
 ```ts
 import type { RouteSource, ToolSource, SchemaSource } from "@yak-io/prismic";
+import type {
+  PrismicRouteAdapterConfig,
+  PrismicToolAdapterConfig,
+  PrismicSchemaSourceConfig,
+} from "@yak-io/prismic";
 ```
 
-## Security tips
-
-- Always set `allowedTypes` on the tool adapter — without it the LLM can fetch any document type in your repository.
-- `resolveRoute` returning `null` skips a document — use this to filter drafts or hidden pages out of the manifest.
-
 ## License
 
-Proprietary - see LICENSE file
+Proprietary — see [LICENSE](./LICENSE).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yak-io/prismic",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Prismic CMS adapter for yak chatbot - exposes Prismic documents as routes, tools, and schema sources",
   "type": "module",
   "license": "SEE LICENSE IN LICENSE",
@@ -24,6 +24,7 @@
     "node": ">=18"
   },
   "files": [
+    "README.md",
     "dist",
     "LICENSE"
   ],
@@ -40,7 +41,7 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@yak-io/javascript": "0.8.0"
+    "@yak-io/javascript": "0.9.0"
   },
   "peerDependencies": {
     "@prismicio/client": "^7.0.0",
@@ -58,6 +59,7 @@
     "typescript": "^5.3.0",
     "@repo/typescript-config": "0.0.0"
   },
+  "homepage": "https://docs.yak.io/docs/cms/prismic",
   "scripts": {
     "build": "tsc",
     "check-types": "tsc --noEmit",