semantic-primitives 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 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 those 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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,449 @@
+# semantic-primitives
+
+TypeScript library providing LLM-enhanced primitive types. Smart versions of bools, strings, numbers, and arrays with built-in semantic understanding, fuzzy matching, natural language parsing, and AI-powered operations. Drop-in replacements for native types that understand context and meaning.
+
+## Installation
+
+```bash
+bun add semantic-primitives
+```
+
+Or with npm:
+
+```bash
+npm install semantic-primitives
+```
+
+## Quick Start
+
+```typescript
+import { complete, LLMClient } from 'semantic-primitives';
+
+// Simple completion using default provider
+const response = await complete('What is 2 + 2?');
+console.log(response.content); // "4"
+
+// Or use the client for more control
+const client = new LLMClient();
+const result = await client.complete({
+  prompt: 'Explain quantum computing in one sentence.',
+  maxTokens: 100,
+});
+```
+
+## Configuration
+
+### Environment Variables
+
+Create a `.env` file based on `.env.example`:
+
+```bash
+# LLM Provider Selection (openai, anthropic, or google)
+# Default: google
+LLM_PROVIDER=google
+
+# OpenAI Configuration
+OPENAI_API_KEY=your-openai-api-key
+OPENAI_MODEL=gpt-4o-mini
+
+# Anthropic Configuration
+ANTHROPIC_API_KEY=your-anthropic-api-key
+ANTHROPIC_MODEL=claude-sonnet-4-20250514
+
+# Google Configuration (default provider)
+GOOGLE_API_KEY=your-google-api-key
+GOOGLE_MODEL=gemini-2.0-flash-lite
+
+# Optional: Default settings
+LLM_MAX_TOKENS=1024
+LLM_TEMPERATURE=0.7
+```
+
+Bun automatically loads `.env` files, so no additional setup is required.
+
+### Provider Configuration
+
+#### Google (Default Provider)
+
+Google's Gemini models are the default. To configure:
+
+1. Get an API key from [Google AI Studio](https://aistudio.google.com/apikey)
+2. Set environment variables:
+
+```bash
+GOOGLE_API_KEY=your-google-api-key
+GOOGLE_MODEL=gemini-2.0-flash-lite  # Default model
+```
+
+Available models: `gemini-2.0-flash-lite`, `gemini-2.0-flash`, `gemini-1.5-pro`, `gemini-1.5-flash`
+
+#### OpenAI
+
+To use OpenAI models:
+
+1. Get an API key from [OpenAI Platform](https://platform.openai.com/api-keys)
+2. Set environment variables:
+
+```bash
+LLM_PROVIDER=openai
+OPENAI_API_KEY=your-openai-api-key
+OPENAI_MODEL=gpt-4o-mini  # Default model
+```
+
+Available models: `gpt-4o`, `gpt-4o-mini`, `gpt-4-turbo`, `gpt-4`, `gpt-3.5-turbo`
+
+#### Anthropic
+
+To use Anthropic's Claude models:
+
+1. Get an API key from [Anthropic Console](https://console.anthropic.com/)
+2. Set environment variables:
+
+```bash
+LLM_PROVIDER=anthropic
+ANTHROPIC_API_KEY=your-anthropic-api-key
+ANTHROPIC_MODEL=claude-sonnet-4-20250514  # Default model
+```
+
+Available models: `claude-opus-4-20250514`, `claude-sonnet-4-20250514`, `claude-3-5-sonnet-20241022`, `claude-3-haiku-20240307`
+
+### Programmatic Configuration
+
+You can also configure providers in code without using environment variables:
+
+```typescript
+import { LLMClient } from 'semantic-primitives';
+
+// Configure with explicit API keys
+const client = new LLMClient({
+  provider: 'anthropic',
+  apiKeys: {
+    openai: 'sk-...',
+    anthropic: 'sk-ant-...',
+    google: 'AIza...',
+  },
+});
+
+// Override provider and model per-request
+const response = await client.complete({
+  prompt: 'Hello!',
+  provider: 'openai',      // Use OpenAI for this request
+  model: 'gpt-4o',         // Use specific model
+  maxTokens: 500,
+  temperature: 0.5,
+});
+```
+
+### Configuration Priority
+
+Settings are resolved in the following order (highest to lowest priority):
+
+1. **Per-request options** - `provider`, `model`, etc. passed to `complete()` or `chat()`
+2. **Client constructor** - Options passed when creating `LLMClient`
+3. **Environment variables** - `LLM_PROVIDER`, `OPENAI_MODEL`, etc.
+4. **Built-in defaults** - Google with `gemini-2.0-flash-lite`
+
+## API Reference
+
+### LLMClient
+
+The main client class for interacting with LLM providers.
+
+```typescript
+import { LLMClient } from 'semantic-primitives';
+
+const client = new LLMClient({
+  provider: 'openai', // Optional: override LLM_PROVIDER env var
+  apiKeys: {
+    openai: 'sk-...',
+    anthropic: 'sk-ant-...',
+    google: 'AIza...',
+  },
+});
+```
+
+#### `client.complete(options)`
+
+Generate a completion from a prompt.
+
+```typescript
+const response = await client.complete({
+  prompt: 'Write a haiku about programming',
+  systemPrompt: 'You are a creative poet.',
+  maxTokens: 100,
+  temperature: 0.8,
+});
+
+console.log(response.content);
+console.log(response.usage); // { promptTokens, completionTokens, totalTokens }
+```
+
+**Options:**
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `prompt` | `string` | The prompt to send to the model (required) |
+| `systemPrompt` | `string` | System message to set context |
+| `provider` | `'openai' \| 'anthropic' \| 'google'` | Override the default provider |
+| `model` | `string` | Override the default model |
+| `maxTokens` | `number` | Maximum tokens to generate |
+| `temperature` | `number` | Response randomness (0-2) |
+| `topP` | `number` | Top-p sampling parameter |
+| `stopSequences` | `string[]` | Stop sequences to end generation |
+
+#### `client.chat(options)`
+
+Generate a response in a multi-turn conversation.
+
+```typescript
+const response = await client.chat({
+  messages: [
+    { role: 'user', content: 'Hello!' },
+    { role: 'assistant', content: 'Hi there! How can I help you today?' },
+    { role: 'user', content: 'What is the capital of France?' },
+  ],
+  systemPrompt: 'You are a helpful geography assistant.',
+});
+
+console.log(response.content); // "The capital of France is Paris."
+```
+
+**Options:**
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `messages` | `Message[]` | Array of conversation messages (required) |
+| `systemPrompt` | `string` | System message (prepended to messages) |
+| `provider` | `'openai' \| 'anthropic' \| 'google'` | Override the default provider |
+| `model` | `string` | Override the default model |
+| `maxTokens` | `number` | Maximum tokens to generate |
+| `temperature` | `number` | Response randomness (0-2) |
+
+#### `client.withProvider(provider)`
+
+Create a new client instance with a different provider.
+
+```typescript
+const openaiClient = new LLMClient({ provider: 'openai' });
+const anthropicClient = openaiClient.withProvider('anthropic');
+```
+
+### Convenience Functions
+
+#### `complete(prompt, options?)`
+
+Shorthand for simple completions using the default client.
+
+```typescript
+import { complete } from 'semantic-primitives';
+
+const response = await complete('What is the meaning of life?');
+```
+
+#### `chat(options)`
+
+Shorthand for chat completions using the default client.
+
+```typescript
+import { chat } from 'semantic-primitives';
+
+const response = await chat({
+  messages: [{ role: 'user', content: 'Hello!' }],
+});
+```
+
+#### `getClient()`
+
+Get the singleton default client instance.
+
+```typescript
+import { getClient } from 'semantic-primitives';
+
+const client = getClient();
+```
+
+### Direct Provider Access
+
+For advanced use cases, you can instantiate providers directly:
+
+```typescript
+import { OpenAIProvider, AnthropicProvider, GoogleProvider } from 'semantic-primitives';
+
+const openai = new OpenAIProvider('sk-...', 'gpt-4o');
+const anthropic = new AnthropicProvider('sk-ant-...', 'claude-opus-4-20250514');
+const google = new GoogleProvider('AIza...', 'gemini-2.0-flash-lite');
+```
+
+### Types
+
+```typescript
+import type {
+  LLMProvider,        // 'openai' | 'anthropic' | 'google'
+  Message,            // { role: MessageRole; content: string }
+  MessageRole,        // 'system' | 'user' | 'assistant'
+  LLMConfig,          // Base configuration options
+  CompletionOptions,  // Options for complete()
+  ChatOptions,        // Options for chat()
+  LLMResponse,        // Response from LLM calls
+} from 'semantic-primitives';
+```
+
+### Response Format
+
+All LLM methods return an `LLMResponse`:
+
+```typescript
+interface LLMResponse {
+  content: string;           // Generated text
+  provider: LLMProvider;     // Provider that generated response
+  model: string;             // Model that was used
+  usage?: {
+    promptTokens: number;
+    completionTokens: number;
+    totalTokens: number;
+  };
+  raw?: unknown;             // Raw provider response
+}
+```
+
+## Examples
+
+### Switching Providers at Runtime
+
+```typescript
+import { LLMClient } from 'semantic-primitives';
+
+const client = new LLMClient();
+
+// Use OpenAI for creative tasks
+const poem = await client.complete({
+  prompt: 'Write a poem about the ocean',
+  provider: 'openai',
+  temperature: 0.9,
+});
+
+// Use Anthropic for analysis
+const analysis = await client.complete({
+  prompt: 'Analyze this poem: ' + poem.content,
+  provider: 'anthropic',
+  temperature: 0.3,
+});
+```
+
+### Building a Chatbot
+
+```typescript
+import { LLMClient, type Message } from 'semantic-primitives';
+
+const client = new LLMClient();
+const conversationHistory: Message[] = [];
+
+async function sendMessage(userMessage: string): Promise<string> {
+  conversationHistory.push({ role: 'user', content: userMessage });
+
+  const response = await client.chat({
+    messages: conversationHistory,
+    systemPrompt: 'You are a helpful assistant.',
+  });
+
+  conversationHistory.push({ role: 'assistant', content: response.content });
+  return response.content;
+}
+
+// Usage
+await sendMessage('Hello!');
+await sendMessage('What can you help me with?');
+```
+
+### Error Handling
+
+```typescript
+import { LLMClient } from 'semantic-primitives';
+
+const client = new LLMClient();
+
+try {
+  const response = await client.complete({
+    prompt: 'Hello, world!',
+  });
+  console.log(response.content);
+} catch (error) {
+  if (error instanceof Error) {
+    console.error('LLM Error:', error.message);
+  }
+}
+```
+
+## Development
+
+### Prerequisites
+
+- [Bun](https://bun.sh/) v1.0 or later
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/elicollinson/semantic-primitives.git
+cd semantic-primitives
+
+# Install dependencies
+bun install
+
+# Copy environment template
+cp .env.example .env
+# Edit .env with your API keys
+```
+
+### Scripts
+
+```bash
+# Run tests
+bun test
+
+# Type check
+bun run typecheck
+
+# Build library
+bun run build
+
+# Development mode with watch
+bun run dev
+```
+
+### Project Structure
+
+```
+semantic-primitives/
+├── src/
+│   ├── index.ts              # Main library exports
+│   └── llm/
+│       ├── index.ts          # LLM module exports
+│       ├── types.ts          # Type definitions
+│       ├── client.ts         # Unified LLMClient
+│       ├── providers/
+│       │   ├── index.ts      # Provider exports
+│       │   ├── openai.ts     # OpenAI implementation
+│       │   ├── anthropic.ts  # Anthropic implementation
+│       │   └── google.ts     # Google implementation
+│       └── __tests__/
+│           ├── types.test.ts
+│           ├── providers.test.ts
+│           └── client.test.ts
+├── .env.example              # Environment template
+├── package.json
+├── tsconfig.json
+└── README.md
+```
+
+## Supported Providers
+
+| Provider | Default Model | Other Models | Status |
+|----------|---------------|--------------|--------|
+| Google (default) | gemini-2.0-flash-lite | Gemini 2.0 Flash, Gemini 1.5 Pro, etc. | Supported |
+| OpenAI | gpt-4o-mini | GPT-4o, GPT-4, etc. | Supported |
+| Anthropic | claude-sonnet-4-20250514 | Claude Opus 4, etc. | Supported |
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Semantic Primitives
+ * TypeScript library providing LLM-enhanced primitive types
+ */
+export * from './llm/index.ts';
+export * from './primitives/index.ts';
+export * from './types/index.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,cAAc,gBAAgB,CAAC;AAG/B,cAAc,uBAAuB,CAAC;AAGtC,cAAc,kBAAkB,CAAC"}