@sudobility/shapeshyft_types 1.0.44 → 1.0.46

package/README.md

@@ -0,0 +1,51 @@
+# @sudobility/shapeshyft_types
+
+Shared TypeScript type definitions for the ShapeShyft LLM structured output platform.
+
+## Installation
+
+```bash
+bun add @sudobility/shapeshyft_types
+```
+
+## Usage
+
+```typescript
+import type {
+  User, Project, Endpoint, LlmProvider,
+  AiExecutionRequest, AiExecutionResponse,
+} from '@sudobility/shapeshyft_types';
+
+import { successResponse, errorResponse } from '@sudobility/shapeshyft_types';
+```
+
+## Types
+
+- **Enums**: `LlmProvider` (openai, gemini, anthropic, lm_studio), `HttpMethod`
+- **Entities**: `User`, `LlmApiKey` / `LlmApiKeySafe`, `Project`, `Endpoint`, `UsageAnalytics`, `UserSettings`
+- **Requests**: Create/Update types for users, keys, projects, endpoints, plus `AiExecutionRequest`
+- **Responses**: `AiExecutionResponse`, `AiPromptResponse`, `AnalyticsResponse`, `HealthCheckData`
+- **Query Params**: `ProjectQueryParams`, `EndpointQueryParams`, `UsageAnalyticsQueryParams`
+- **Utilities**: `JsonSchema`, `ApiResponse<T>`, `PaginatedResponse<T>` (re-exported from `@sudobility/types`)
+- **Helpers**: `successResponse()`, `errorResponse()` (runtime functions)
+
+## Development
+
+```bash
+bun run build        # Build ESM + CJS
+bun run test         # Run Vitest
+bun run typecheck    # TypeScript check
+bun run lint         # ESLint
+bun run verify       # Typecheck + lint + build
+```
+
+## Related Packages
+
+- `@sudobility/shapeshyft_client` -- React hooks for ShapeShyft API
+- `@sudobility/shapeshyft_lib` -- Business logic with Zustand stores
+- `shapeshyft_api` -- Backend API server
+- `shapeshyft_app` -- Frontend web application
+
+## License
+
+BUSL-1.1

package/package.json

@@ -1,22 +1,18 @@
 {
   "name": "@sudobility/shapeshyft_types",
-  "version": "1.0.44",
+  "version": "1.0.46",
   "description": "TypeScript types for ShapeShyft API - LLM structured output platform",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
+  "type": "module",
+  "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "import": "./dist/index.js",
-      "require": "./dist/index.cjs",
       "types": "./dist/index.d.ts"
     }
   },
   "scripts": {
-    "build": "bun run build:esm && bun run build:cjs",
-    "build:esm": "bunx tsc -p tsconfig.esm.json",
-    "build:cjs": "bunx tsc -p tsconfig.cjs.json && bun run build:cjs-rename && rm -rf dist-cjs",
-    "build:cjs-rename": "find dist-cjs -name '*.js' -exec sh -c 'cp \"$1\" \"dist/$(basename \"${1%.js}.cjs\")\"' _ {} \\;",
+    "build": "tsc -p tsconfig.esm.json",
     "clean": "rm -rf dist",
     "dev": "bunx tsc --watch",
     "typecheck": "bunx tsc --noEmit",
@@ -43,11 +39,11 @@
   "author": "Sudobility",
   "license": "BUSL-1.1",
   "peerDependencies": {
-    "@sudobility/types": "^1.9.54"
+    "@sudobility/types": "^1.9.57"
   },
   "devDependencies": {
     "@eslint/js": "^9.39.2",
-    "@sudobility/types": "^1.9.54",
+    "@sudobility/types": "^1.9.57",
     "@typescript-eslint/eslint-plugin": "^8.50.0",
     "@typescript-eslint/parser": "^8.50.0",
     "eslint": "^9.39.2",

package/dist/index.cjs

@@ -1,333 +0,0 @@
-"use strict";
-/**
- * @sudobility/shapeshyft_types
- * TypeScript types for ShapeShyft API - LLM structured output platform
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PROVIDER_MODELS = exports.LLM_PROVIDERS = void 0;
-exports.isValidModelForProvider = isValidModelForProvider;
-exports.detectRequiredCapabilities = detectRequiredCapabilities;
-exports.estimateCost = estimateCost;
-exports.estimateMultimodalCost = estimateMultimodalCost;
-exports.formatCost = formatCost;
-exports.formatCostPerMillion = formatCostPerMillion;
-exports.successResponse = successResponse;
-exports.errorResponse = errorResponse;
-/** List of available providers */
-exports.LLM_PROVIDERS = [
-    'openai',
-    'anthropic',
-    'gemini',
-    'mistral',
-    'cohere',
-    'groq',
-    'xai',
-    'deepseek',
-    'perplexity',
-    'lm_studio',
-];
-/**
- * Mapping of each LLM provider to its known valid model IDs.
- * Useful for both server-side validation and client-side form validation.
- *
- * Note: `lm_studio` has an empty list because it accepts arbitrary
- * user-supplied model names (any string is valid).
- */
-exports.PROVIDER_MODELS = {
-    openai: [
-        'gpt-4.1',
-        'gpt-4.1-mini',
-        'gpt-4.1-nano',
-        'gpt-4o',
-        'gpt-4o-mini',
-        'o3',
-        'o3-pro',
-        'o4-mini',
-        'gpt-4-turbo',
-        'o1',
-    ],
-    anthropic: [
-        'claude-opus-4-5-20251124',
-        'claude-sonnet-4-5-20251124',
-        'claude-opus-4-1-20250805',
-        'claude-sonnet-4-20250514',
-        'claude-opus-4-20250514',
-        'claude-3-5-haiku-20241022',
-    ],
-    gemini: [
-        'gemini-3-pro-preview',
-        'gemini-3-flash-preview',
-        'gemini-3-pro-image-preview',
-        'gemini-2.5-pro',
-        'gemini-2.5-flash',
-        'gemini-2.5-flash-lite',
-        'gemini-2.5-flash-image',
-        'gemini-2.5-flash-native-audio-preview',
-        'gemini-2.0-flash',
-        'gemini-2.0-flash-lite',
-    ],
-    mistral: [
-        'mistral-large-2512',
-        'mistral-large-latest',
-        'mistral-medium-3.1',
-        'mistral-medium-latest',
-        'mistral-small-3.2',
-        'mistral-small-latest',
-        'ministral-3b-2512',
-        'ministral-8b-2512',
-        'ministral-14b-2512',
-        'codestral-2501',
-        'codestral-latest',
-        'pixtral-large-2411',
-        'pixtral-large-latest',
-        'voxtral-small',
-        'voxtral-mini',
-        'mistral-ocr-2512',
-    ],
-    cohere: [
-        'command-a-03-2025',
-        'command-a-reasoning',
-        'command-a-vision',
-        'command-r-plus-08-2024',
-        'command-r-08-2024',
-        'command-r-plus',
-        'command-r',
-    ],
-    groq: [
-        'llama-3.3-70b-versatile',
-        'llama-3.1-8b-instant',
-        'openai/gpt-oss-120b',
-        'openai/gpt-oss-20b',
-        'groq/compound',
-        'groq/compound-mini',
-        'meta-llama/llama-guard-4-12b',
-        'whisper-large-v3',
-        'whisper-large-v3-turbo',
-    ],
-    xai: [
-        'grok-4',
-        'grok-4.1-fast',
-        'grok-3',
-        'grok-3-mini',
-        'grok-3-vision',
-        'grok-2',
-        'grok-2-vision',
-    ],
-    deepseek: [
-        'deepseek-chat',
-        'deepseek-reasoner',
-    ],
-    perplexity: [
-        'sonar',
-        'sonar-pro',
-        'sonar-reasoning',
-        'sonar-reasoning-pro',
-        'sonar-deep-research',
-    ],
-    lm_studio: [],
-};
-/**
- * Check whether a model ID is valid for the given provider.
- * For `lm_studio`, any string is valid (returns true) since users
- * can run arbitrary models on their local server.
- *
- * @param provider - The LLM provider to validate against
- * @param model - The model ID string to check
- * @returns true if the model is a known valid model for the provider
- */
-function isValidModelForProvider(provider, model) {
-    const models = exports.PROVIDER_MODELS[provider];
-    // lm_studio accepts any model string
-    if (provider === 'lm_studio')
-        return true;
-    return models.includes(model);
-}
-/**
- * Detect media type from contentMediaType string
- */
-function detectMediaType(contentMediaType) {
-    if (contentMediaType.startsWith('image/'))
-        return 'image';
-    if (contentMediaType.startsWith('audio/'))
-        return 'audio';
-    if (contentMediaType.startsWith('video/'))
-        return 'video';
-    return null;
-}
-/**
- * Recursively scan a JSON schema for media type properties.
- * Returns detected media types.
- */
-function scanSchemaForMediaTypes(schema, result) {
-    if (!schema || typeof schema !== 'object')
-        return;
-    // Check if this property has contentMediaType
-    const contentMediaType = schema['contentMediaType'];
-    if (typeof contentMediaType === 'string') {
-        const mediaType = detectMediaType(contentMediaType);
-        if (mediaType) {
-            result.add(mediaType);
-        }
-    }
-    // Recurse into properties
-    const properties = schema['properties'];
-    if (properties && typeof properties === 'object') {
-        for (const prop of Object.values(properties)) {
-            if (prop && typeof prop === 'object') {
-                scanSchemaForMediaTypes(prop, result);
-            }
-        }
-    }
-    // Recurse into array items
-    const items = schema['items'];
-    if (items && typeof items === 'object') {
-        scanSchemaForMediaTypes(items, result);
-    }
-}
-/**
- * Detect required capabilities from input and output schemas.
- * Returns which media capabilities are required.
- */
-function detectRequiredCapabilities(inputSchema, outputSchema) {
-    const result = {};
-    // Scan input schema for required input capabilities
-    if (inputSchema) {
-        const inputMediaTypes = new Set();
-        scanSchemaForMediaTypes(inputSchema, inputMediaTypes);
-        if (inputMediaTypes.has('image'))
-            result.visionInput = true;
-        if (inputMediaTypes.has('audio'))
-            result.audioInput = true;
-        if (inputMediaTypes.has('video'))
-            result.videoInput = true;
-    }
-    // Scan output schema for required output capabilities
-    if (outputSchema) {
-        const outputMediaTypes = new Set();
-        scanSchemaForMediaTypes(outputSchema, outputMediaTypes);
-        if (outputMediaTypes.has('image'))
-            result.imageOutput = true;
-        if (outputMediaTypes.has('audio'))
-            result.audioOutput = true;
-        if (outputMediaTypes.has('video'))
-            result.videoOutput = true;
-    }
-    return result;
-}
-/**
- * Estimate cost in cents for token usage (text only)
- * @param pricing - Model pricing configuration
- * @param inputTokens - Number of input tokens
- * @param outputTokens - Number of output tokens
- */
-function estimateCost(pricing, inputTokens, outputTokens) {
-    const inputCost = (inputTokens / 1000000) * pricing.input;
-    const outputCost = (outputTokens / 1000000) * pricing.output;
-    return Math.round((inputCost + outputCost) * 100) / 100; // Round to 2 decimal places
-}
-/**
- * Estimate cost in cents for multimodal usage
- * @param pricing - Model pricing configuration
- * @param usage - Multimodal usage details
- */
-function estimateMultimodalCost(pricing, usage) {
-    let totalCost = 0;
-    // Text token costs
-    if (usage.inputTokens) {
-        totalCost += (usage.inputTokens / 1000000) * pricing.input;
-    }
-    if (usage.outputTokens) {
-        totalCost += (usage.outputTokens / 1000000) * pricing.output;
-    }
-    // Image costs
-    if (usage.imagesInput && pricing.imageInput) {
-        totalCost += usage.imagesInput * pricing.imageInput;
-    }
-    if (usage.imagesOutput && pricing.imageOutput) {
-        totalCost += usage.imagesOutput * pricing.imageOutput;
-    }
-    // Audio costs
-    if (usage.audioInputMinutes && pricing.audioInput) {
-        totalCost += usage.audioInputMinutes * pricing.audioInput;
-    }
-    if (usage.audioOutputMinutes && pricing.audioOutput) {
-        totalCost += usage.audioOutputMinutes * pricing.audioOutput;
-    }
-    // Video costs
-    if (usage.videoInputMinutes && pricing.videoInput) {
-        totalCost += usage.videoInputMinutes * pricing.videoInput;
-    }
-    if (usage.videoOutputMinutes && pricing.videoOutput) {
-        totalCost += usage.videoOutputMinutes * pricing.videoOutput;
-    }
-    return Math.round(totalCost * 100) / 100; // Round to 2 decimal places
-}
-/**
- * Format cost in cents to a readable string (e.g., "$0.0015" or "$1.50")
- */
-function formatCost(costCents) {
-    const dollars = costCents / 100;
-    if (dollars < 0.01) {
-        return `$${dollars.toFixed(4)}`;
-    }
-    else if (dollars < 1) {
-        return `$${dollars.toFixed(3)}`;
-    }
-    else {
-        return `$${dollars.toFixed(2)}`;
-    }
-}
-/**
- * Format cost per million tokens for display
- */
-function formatCostPerMillion(pricing) {
-    const inputDollars = pricing.input / 100;
-    const outputDollars = pricing.output / 100;
-    return `$${inputDollars.toFixed(2)} / $${outputDollars.toFixed(2)} per 1M tokens`;
-}
-// =============================================================================
-// Response Helper Functions
-// =============================================================================
-/**
- * Create a typed success response wrapping the given data.
- *
- * @example
- * ```typescript
- * import { successResponse, type Project } from '@sudobility/shapeshyft_types';
- *
- * const project: Project = { uuid: '...', entity_id: '...', project_name: 'my-project', display_name: 'My Project', description: null, is_active: true, api_key_prefix: null, api_key_created_at: null, created_at: new Date(), updated_at: new Date() };
- * const response = successResponse<Project>(project);
- * // { success: true, data: { uuid: '...', project_name: 'my-project', ... }, timestamp: '2026-01-15T...' }
- * ```
- */
-function successResponse(data) {
-    return {
-        success: true,
-        data,
-        timestamp: new Date().toISOString(),
-    };
-}
-/**
- * Create a typed error response with the given error message.
- *
- * @example
- * ```typescript
- * import { errorResponse } from '@sudobility/shapeshyft_types';
- *
- * const response = errorResponse('Project not found');
- * // { success: false, error: 'Project not found', timestamp: '2026-01-15T...' }
- *
- * // In an API handler:
- * if (!project) {
- *   return c.json(errorResponse('Project not found'), 404);
- * }
- * ```
- */
-function errorResponse(error) {
-    return {
-        success: false,
-        error,
-        timestamp: new Date().toISOString(),
-    };
-}
-//# sourceMappingURL=index.js.map