@claritylabs/cl-sdk 1.0.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Clarity Labs Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,196 @@
+[Clarity Labs](https://claritylabs.inc) is an applied AI research lab building the infrastructure for AI to work safely with insurance.
+
+AI agents are already executing complex tasks autonomously across industries, but insurance requires context, safeguards, and systems that don't exist yet. CL-0 SDK fills that gap: a shared intelligence layer that any product or agent can import to understand, reason about, and act on insurance.
+
+## Installation
+
+```bash
+npm install @claritylabs/cl-sdk
+```
+
+### Peer Dependencies
+
+CL-0 SDK requires the [Vercel AI SDK](https://sdk.vercel.ai) and pdf-lib:
+
+```bash
+npm install ai pdf-lib
+```
+
+Then install a provider package for your model of choice:
+
+```bash
+# Anthropic (default)
+npm install @ai-sdk/anthropic
+
+# OpenAI
+npm install @ai-sdk/openai
+
+# Google
+npm install @ai-sdk/google
+```
+
+## Quick Start
+
+### Default (Anthropic)
+
+```typescript
+import { classifyDocumentType, extractFromPdf, applyExtracted } from "@claritylabs/cl-sdk";
+
+const pdfBase64 = "..."; // base64-encoded PDF
+
+// Classify + extract with default Anthropic models
+const { documentType } = await classifyDocumentType(pdfBase64);
+const { extracted } = await extractFromPdf(pdfBase64);
+const fields = applyExtracted(extracted);
+```
+
+No model configuration needed — `createDefaultModelConfig()` is called automatically, using `@ai-sdk/anthropic` under the hood.
+
+### Custom Models
+
+```typescript
+import { createAnthropic } from "@ai-sdk/anthropic";
+import { extractFromPdf, createUniformModelConfig } from "@claritylabs/cl-sdk";
+
+const anthropic = createAnthropic();
+
+// Use the same model for every pipeline pass
+const { extracted } = await extractFromPdf(pdfBase64, {
+  models: createUniformModelConfig(anthropic("claude-sonnet-4-6")),
+});
+```
+
+### Any Provider
+
+```typescript
+import { createOpenAI } from "@ai-sdk/openai";
+import { extractFromPdf, createUniformModelConfig } from "@claritylabs/cl-sdk";
+
+const openai = createOpenAI();
+const { extracted } = await extractFromPdf(pdfBase64, {
+  models: createUniformModelConfig(openai("gpt-4o")),
+  metadataProviderOptions: {},  // disable Anthropic-specific thinking
+});
+```
+
+### Fine-Grained Model Config
+
+```typescript
+import { createAnthropic } from "@ai-sdk/anthropic";
+import { extractFromPdf, type ModelConfig } from "@claritylabs/cl-sdk";
+
+const anthropic = createAnthropic();
+const models: ModelConfig = {
+  classification: anthropic("claude-haiku-4-5-20251001"),
+  metadata: anthropic("claude-sonnet-4-6"),
+  sections: anthropic("claude-haiku-4-5-20251001"),
+  sectionsFallback: anthropic("claude-sonnet-4-6"),
+  enrichment: anthropic("claude-haiku-4-5-20251001"),
+};
+
+const { extracted } = await extractFromPdf(pdfBase64, { models });
+```
+
+## What's Inside
+
+### Document Extraction Pipeline
+
+A multi-pass system that turns insurance PDFs into structured, queryable data:
+
+- **Pass 0 — Classification**: Determines whether a document is a policy or a quote. Returns document type, confidence score, and supporting signals.
+- **Pass 1 — Metadata Extraction**: Extracts high-level metadata — carrier, policy/quote number, dates, premium, insured name, coverage table with limits and deductibles. Includes an early persistence callback (`onMetadata`) so metadata is saved immediately, surviving downstream failures.
+- **Pass 2 — Section Extraction**: Splits the document into page chunks (starting at 15 pages) and extracts structured sections. Adaptive fallback: if a chunk's output is truncated (JSON parse failure), it re-splits into smaller chunks (10, then 5 pages), and escalates to the fallback model. Results are merged across chunks.
+- **Pass 3 — Enrichment**: A non-fatal pass that parses raw text into structured supplementary fields — regulatory context, complaint contacts, costs and fees, claims contacts.
+
+For quotes specifically, the pipeline also extracts premium breakdowns, subjectivities (conditions that must be met before binding), and underwriting conditions.
+
+### Application Processing
+
+End-to-end insurance application handling — from blank PDF to filled form:
+
+- **Application detection** — classifies whether a PDF is an insurance application form
+- **Field extraction** — reads every fillable field as structured data (text, numeric, currency, date, yes/no, table, and declaration fields)
+- **Auto-fill** — matches extracted fields against known business context to pre-populate answers
+- **Question batching** — organizes unfilled fields into topic-based batches for emailing the insured
+- **Answer parsing** — parses free-text replies back into structured field values
+- **PDF filling** — maps answers back onto the original PDF, supporting both AcroForm and flat PDF overlay
+
+### Agent System
+
+A composable prompt system that powers conversational AI across platforms:
+
+- **Multi-platform support** — email, chat, SMS, Slack, Discord with platform-aware formatting
+- **Communication intents** — direct (user-facing), mediated (forwarded), observed (CC'd)
+- **Composable modules** — identity, safety, formatting, coverage gaps, COI routing, quotes-vs-policies, conversation memory, and intent-specific instructions
+- **`buildAgentSystemPrompt(ctx)`** — composes all modules into a complete system prompt
+- **Document context builder** — scores and ranks policies/quotes by relevance to a query
+- **Tool definitions** — `tool_use`-compatible schemas for document lookup, COI generation, and coverage comparison
+
+### Intent Classification
+
+Platform-agnostic message classification with `buildClassifyMessagePrompt(platform)` — determines whether an incoming message is insurance-related and suggests an intent.
+
+### Insurance Domain Types
+
+Comprehensive TypeScript type system for the insurance domain:
+
+- **Document types** — `PolicyDocument`, `QuoteDocument`, and `InsuranceDocument` discriminated union
+- **Platform types** — `Platform`, `CommunicationIntent`, `PlatformConfig`, `AgentContext`
+- **Model types** — `ModelConfig`, `createUniformModelConfig`, `createDefaultModelConfig`
+
+## API Reference
+
+### Extraction
+
+| Function | Description |
+|----------|-------------|
+| `classifyDocumentType(pdf, options?)` | Classify document as policy or quote |
+| `extractFromPdf(pdf, options?)` | Full policy extraction (passes 1-3) |
+| `extractQuoteFromPdf(pdf, options?)` | Full quote extraction (passes 1-2) |
+| `extractSectionsOnly(pdf, metadata, options?)` | Retry pass 2 using saved metadata |
+| `applyExtracted(extracted)` | Map extraction JSON to persistence fields |
+| `applyExtractedQuote(extracted)` | Map quote extraction JSON to persistence fields |
+
+### Options
+
+```typescript
+interface ExtractOptions {
+  log?: LogFn;
+  onMetadata?: (raw: string) => Promise<void>;
+  models?: ModelConfig;
+  metadataProviderOptions?: ProviderOptions;
+  fallbackProviderOptions?: ProviderOptions;
+}
+
+interface ClassifyOptions {
+  log?: LogFn;
+  models?: ModelConfig;
+}
+```
+
+### Agent
+
+| Function | Description |
+|----------|-------------|
+| `buildAgentSystemPrompt(ctx)` | Full system prompt from `AgentContext` |
+| `buildDocumentContext(docs, query)` | Ranked document context for a query |
+| `buildClassifyMessagePrompt(platform)` | Intent classification prompt |
+
+### PDF Operations
+
+| Function | Description |
+|----------|-------------|
+| `getAcroFormFields(pdfBytes)` | Detect fillable form fields |
+| `fillAcroForm(pdfBytes, mappings)` | Fill and flatten form fields |
+| `overlayTextOnPdf(pdfBytes, overlays)` | Position text on flat PDFs |
+
+## Development
+
+```bash
+npm install
+npm run build      # Build ESM + CJS + types via tsup
+npm run dev        # Watch mode
+npm run typecheck  # Type check (tsc --noEmit)
+```
+
+Pure TypeScript — no framework dependencies. Peer dependencies on `ai` (Vercel AI SDK) and `pdf-lib`. The `@ai-sdk/anthropic` provider is optional (needed only for `createDefaultModelConfig()`).