@ringg/core 0.0.1-alpha.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ringg AI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,93 @@
+# @ringg/core
+
+Shared core for [Ringg AI](https://ringg.ai) SDKs. This package is installed automatically as a dependency of platform SDKs like `@ringg/react-native` — you don't need to install it directly.
+
+## When would I use this?
+
+If you're building a custom Ringg integration outside of our official SDKs, `@ringg/core` gives you:
+
+- **TypeScript types** for config, themes, messages, events, and interactive components
+- **API client** to start agent calls and submit feedback
+- **Theme engine** with preset themes and gradient support
+- **State management** for widget lifecycle
+- **Utility functions** for formatting, identity checks, and more
+
+## Installation
+
+```bash
+npm install @ringg/core
+```
+
+## Quick example
+
+```ts
+import { type RinggWidgetConfig, type ChatMessage, ApiClient, mergeWidgetTheme, DEFAULT_WIDGET_THEME, WIDGET_PRESET_THEMES } from "@ringg/core";
+
+// Create an API client
+const api = new ApiClient({
+  baseUrl: "https://api.ringg.ai/ca/api/v0",
+  apiKey: "your-api-key",
+});
+
+// Start a voice call
+const { call_id, user_token } = await api.startWebcall({
+  agentId: "your-agent-id",
+  variables: { callee_name: "Jane" },
+  mediaType: "audio",
+});
+
+// Submit post-call feedback
+await api.submitFeedback(call_id, {
+  rating: 5,
+  comment: "Great experience!",
+});
+```
+
+## Available exports
+
+### Types
+
+```ts
+import type {
+  RinggWidgetConfig, // Main config object
+  MediaType, // "audio" | "text"
+  ChatMessage, // { message, isSelf, name, timestamp }
+  WidgetTheme, // Theme customization
+  ResolvedWidgetTheme, // Theme with all defaults filled
+  ConnectionState, // "connected" | "disconnected" | "reconnecting"
+  WidgetEventName, // Event name union
+  WidgetEventMap, // Type-safe event → payload mapping
+  SlashCommand, // Agent slash command definition
+  ComponentPayload, // Interactive component data
+} from "@ringg/core";
+```
+
+### Utilities
+
+```ts
+import {
+  DEFAULT_CONFIG, // Default widget config values
+  DEFAULT_WIDGET_THEME, // Default theme
+  WIDGET_PRESET_THEMES, // Built-in theme presets
+  mergeWidgetTheme, // Merge partial theme with defaults
+  colorToSolid, // Extract solid color from gradient string
+  isGradient, // Check if a color string is a gradient
+  getButtonRadius, // Get button border radius from theme
+  formatTimestamp, // Format Unix timestamp to readable time
+  isAgentIdentity, // Check if a participant identity belongs to an agent
+  groupSlotsByDate, // Group calendar slots by date
+  formatSlotTime, // Format slot time for display
+  formatSlotDate, // Format slot date for display
+  filterSlashCommands, // Filter slash commands by text input
+} from "@ringg/core";
+```
+
+## Platform SDKs
+
+For building apps, use the platform-specific SDK instead:
+
+- **React Native** — [`@ringg/react-native`](https://www.npmjs.com/package/@ringg/react-native)
+
+## License
+
+[MIT](./LICENSE)