sammy-sdk-shared 0.1.0

package/README.md

@@ -0,0 +1,20 @@
+# sammy-sdk-shared
+
+Shared types and constants used by [`sammy-sdk`](https://www.npmjs.com/package/sammy-sdk) and the Sammy Cloud API.
+
+You don't usually install this directly. It's a transitive dependency of `sammy-sdk`.
+
+## Install
+
+```bash
+npm install sammy-sdk-shared
+```
+
+## What's in here
+
+- TypeScript types shared between the SDK, the API, and any first-party tooling (completions, key validation, streaming, etc.)
+- Constants such as `SDK_VERSION`, `API_BASE_URL`, default token limits, and per-plan limit tables.
+
+## License
+
+MIT

package/dist/constants.d.ts

@@ -0,0 +1,9 @@
+import type { PlanLimits } from "./types.js";
+export declare const SDK_VERSION = "0.1.0";
+export declare const API_BASE_URL = "https://sammyapi-production.up.railway.app";
+export declare const DEFAULT_MAX_TOKENS = 4096;
+export declare const DEFAULT_TEMPERATURE = 0.7;
+export declare const DEFAULT_TOOL_TIMEOUT = 30000;
+export declare const MAX_CONVERSATION_TURNS = 50;
+export declare const PLAN_LIMITS: Record<string, PlanLimits>;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,eAAO,MAAM,WAAW,UAAU,CAAC;AACnC,eAAO,MAAM,YAAY,+CAA+C,CAAC;AACzE,eAAO,MAAM,kBAAkB,OAAO,CAAC;AACvC,eAAO,MAAM,mBAAmB,MAAM,CAAC;AACvC,eAAO,MAAM,oBAAoB,QAAQ,CAAC;AAC1C,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAyBlD,CAAC"}

package/dist/constants.js

@@ -0,0 +1,33 @@
+export const SDK_VERSION = "0.1.0";
+export const API_BASE_URL = "https://sammyapi-production.up.railway.app";
+export const DEFAULT_MAX_TOKENS = 4096;
+export const DEFAULT_TEMPERATURE = 0.7;
+export const DEFAULT_TOOL_TIMEOUT = 30000;
+export const MAX_CONVERSATION_TURNS = 50;
+export const PLAN_LIMITS = {
+    free: {
+        discoveryScansPerMonth: 3,
+        evalRunsPerMonth: 5,
+        runtimeMessagesPerMonth: 1000,
+        byokEnabled: false,
+    },
+    pro: {
+        discoveryScansPerMonth: -1,
+        evalRunsPerMonth: -1,
+        runtimeMessagesPerMonth: 25000,
+        byokEnabled: true,
+    },
+    scale: {
+        discoveryScansPerMonth: -1,
+        evalRunsPerMonth: -1,
+        runtimeMessagesPerMonth: 200000,
+        byokEnabled: true,
+    },
+    enterprise: {
+        discoveryScansPerMonth: -1,
+        evalRunsPerMonth: -1,
+        runtimeMessagesPerMonth: -1,
+        byokEnabled: true,
+    },
+};
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC;AACnC,MAAM,CAAC,MAAM,YAAY,GAAG,4CAA4C,CAAC;AACzE,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAC;AACvC,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,CAAC;AACvC,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,CAAC;AAC1C,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAEzC,MAAM,CAAC,MAAM,WAAW,GAA+B;IACrD,IAAI,EAAE;QACJ,sBAAsB,EAAE,CAAC;QACzB,gBAAgB,EAAE,CAAC;QACnB,uBAAuB,EAAE,IAAI;QAC7B,WAAW,EAAE,KAAK;KACnB;IACD,GAAG,EAAE;QACH,sBAAsB,EAAE,CAAC,CAAC;QAC1B,gBAAgB,EAAE,CAAC,CAAC;QACpB,uBAAuB,EAAE,KAAK;QAC9B,WAAW,EAAE,IAAI;KAClB;IACD,KAAK,EAAE;QACL,sBAAsB,EAAE,CAAC,CAAC;QAC1B,gBAAgB,EAAE,CAAC,CAAC;QACpB,uBAAuB,EAAE,MAAM;QAC/B,WAAW,EAAE,IAAI;KAClB;IACD,UAAU,EAAE;QACV,sBAAsB,EAAE,CAAC,CAAC;QAC1B,gBAAgB,EAAE,CAAC,CAAC;QACpB,uBAAuB,EAAE,CAAC,CAAC;QAC3B,WAAW,EAAE,IAAI;KAClB;CACF,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,21 @@
+export declare const ErrorCodes: {
+    readonly INVALID_KEY: "INVALID_KEY";
+    readonly RATE_LIMITED: "RATE_LIMITED";
+    readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
+    readonly PLAN_LIMIT: "PLAN_LIMIT";
+    readonly INVALID_REQUEST: "INVALID_REQUEST";
+    readonly PROVIDER_ERROR: "PROVIDER_ERROR";
+    readonly INTERNAL_ERROR: "INTERNAL_ERROR";
+    readonly UNAUTHORIZED: "UNAUTHORIZED";
+    readonly FORBIDDEN: "FORBIDDEN";
+    readonly NOT_FOUND: "NOT_FOUND";
+    readonly CONFLICT: "CONFLICT";
+    readonly VALIDATION_ERROR: "VALIDATION_ERROR";
+};
+export type ErrorCode = (typeof ErrorCodes)[keyof typeof ErrorCodes];
+export declare class SammyError extends Error {
+    code: ErrorCode;
+    statusCode: number;
+    constructor(code: ErrorCode, message: string, statusCode?: number);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU;;;;;;;;;;;;;CAab,CAAC;AAEX,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAC;AAErE,qBAAa,UAAW,SAAQ,KAAK;IAE1B,IAAI,EAAE,SAAS;IAEf,UAAU,EAAE,MAAM;gBAFlB,IAAI,EAAE,SAAS,EACtB,OAAO,EAAE,MAAM,EACR,UAAU,GAAE,MAAY;CAKlC"}

package/dist/errors.js

@@ -0,0 +1,25 @@
+export const ErrorCodes = {
+    INVALID_KEY: "INVALID_KEY",
+    RATE_LIMITED: "RATE_LIMITED",
+    QUOTA_EXCEEDED: "QUOTA_EXCEEDED",
+    PLAN_LIMIT: "PLAN_LIMIT",
+    INVALID_REQUEST: "INVALID_REQUEST",
+    PROVIDER_ERROR: "PROVIDER_ERROR",
+    INTERNAL_ERROR: "INTERNAL_ERROR",
+    UNAUTHORIZED: "UNAUTHORIZED",
+    FORBIDDEN: "FORBIDDEN",
+    NOT_FOUND: "NOT_FOUND",
+    CONFLICT: "CONFLICT",
+    VALIDATION_ERROR: "VALIDATION_ERROR",
+};
+export class SammyError extends Error {
+    code;
+    statusCode;
+    constructor(code, message, statusCode = 500) {
+        super(message);
+        this.code = code;
+        this.statusCode = statusCode;
+        this.name = "SammyError";
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,WAAW,EAAE,aAAa;IAC1B,YAAY,EAAE,cAAc;IAC5B,cAAc,EAAE,gBAAgB;IAChC,UAAU,EAAE,YAAY;IACxB,eAAe,EAAE,iBAAiB;IAClC,cAAc,EAAE,gBAAgB;IAChC,cAAc,EAAE,gBAAgB;IAChC,YAAY,EAAE,cAAc;IAC5B,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;IACpB,gBAAgB,EAAE,kBAAkB;CAC5B,CAAC;AAIX,MAAM,OAAO,UAAW,SAAQ,KAAK;IAE1B;IAEA;IAHT,YACS,IAAe,EACtB,OAAe,EACR,aAAqB,GAAG;QAE/B,KAAK,CAAC,OAAO,CAAC,CAAC;QAJR,SAAI,GAAJ,IAAI,CAAW;QAEf,eAAU,GAAV,UAAU,CAAc;QAG/B,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;IAC3B,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./types.js";
+export * from "./errors.js";
+export * from "./constants.js";
+//# 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,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from "./types.js";
+export * from "./errors.js";
+export * from "./constants.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,110 @@
+export type ModelTier = "fast" | "balanced" | "powerful";
+export type RequestPurpose = "discovery" | "runtime" | "eval" | "judge";
+export type ToolPermission = "read" | "write" | "admin";
+export type ToolType = "query" | "mutation";
+export type ArchitectureType = "single-agent" | "multi-agent" | "hierarchical";
+export type PlanTier = "free" | "pro" | "scale" | "enterprise";
+export interface TextBlock {
+    type: "text";
+    text: string;
+}
+export interface ToolUseBlock {
+    type: "tool_use";
+    id: string;
+    name: string;
+    input: Record<string, unknown>;
+}
+export interface ToolResultBlock {
+    type: "tool_result";
+    tool_use_id: string;
+    content: string;
+    is_error?: boolean;
+}
+export type ContentBlock = TextBlock | ToolUseBlock | ToolResultBlock;
+export interface ToolDefinition {
+    name: string;
+    description: string;
+    inputSchema: Record<string, unknown>;
+}
+export interface CompletionRequest {
+    tier: ModelTier;
+    purpose: RequestPurpose;
+    messages: ChatMessage[];
+    maxTokens?: number;
+    temperature?: number;
+    responseFormat?: "text" | "json";
+    stream?: boolean;
+    tools?: ToolDefinition[];
+    toolChoice?: "auto" | "any" | "none";
+}
+export interface ChatMessage {
+    role: "system" | "user" | "assistant";
+    content: string | ContentBlock[];
+}
+export interface CompletionResponse {
+    id: string;
+    content: string;
+    contentBlocks?: ContentBlock[];
+    model: string;
+    usage: TokenUsage;
+    finishReason: "stop" | "max_tokens" | "tool_use";
+}
+export interface TokenUsage {
+    inputTokens: number;
+    outputTokens: number;
+    totalTokens: number;
+}
+export interface StreamChunk {
+    type: "text" | "tool_call" | "tool_input_delta" | "agent_handoff" | "done" | "error" | "usage";
+    data: string;
+}
+export interface KeyValidationResponse {
+    valid: boolean;
+    plan: PlanTier;
+    org?: string;
+    limits: PlanLimits;
+}
+export interface PlanLimits {
+    discoveryScansPerMonth: number;
+    evalRunsPerMonth: number;
+    runtimeMessagesPerMonth: number;
+    byokEnabled: boolean;
+}
+export interface UserProfile {
+    id: string;
+    email: string;
+    name: string | null;
+    plan: PlanTier;
+    role: string;
+    createdAt: string;
+}
+export interface ApiKeyInfo {
+    id: string;
+    prefix: string;
+    name: string;
+    lastUsedAt: string | null;
+    createdAt: string;
+    revokedAt: string | null;
+}
+export interface UsageSummary {
+    totalRequests: number;
+    totalTokens: number;
+    totalCostUsd: number;
+    byTier: Record<string, {
+        requests: number;
+        tokens: number;
+        cost: number;
+    }>;
+    byPurpose: Record<string, {
+        requests: number;
+        tokens: number;
+        cost: number;
+    }>;
+}
+export interface SubscriptionInfo {
+    plan: PlanTier;
+    status: string;
+    currentPeriodEnd: string;
+    cancelAtPeriodEnd: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,CAAC;AAGzD,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC;AAGxE,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;AAGxD,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;AAG5C,MAAM,MAAM,gBAAgB,GAAG,cAAc,GAAG,aAAa,GAAG,cAAc,CAAC;AAG/E,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,YAAY,CAAC;AAI/D,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,UAAU,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,aAAa,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,YAAY,GAAG,eAAe,CAAC;AAItE,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAID,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,cAAc,CAAC;IACxB,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACjC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;CACtC;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAC;IACtC,OAAO,EAAE,MAAM,GAAG,YAAY,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,UAAU,CAAC;IAClB,YAAY,EAAE,MAAM,GAAG,YAAY,GAAG,UAAU,CAAC;CAClD;AAED,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,kBAAkB,GAAG,eAAe,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;IAC/F,IAAI,EAAE,MAAM,CAAC;CACd;AAID,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,QAAQ,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,UAAU,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,gBAAgB,EAAE,MAAM,CAAC;IACzB,uBAAuB,EAAE,MAAM,CAAC;IAChC,WAAW,EAAE,OAAO,CAAC;CACtB;AAID,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY;IAC3B,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC3E,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC/E;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,OAAO,CAAC;CAC5B"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "sammy-sdk-shared",
+  "version": "0.1.0",
+  "description": "Shared types and constants used by the sammy-sdk and Sammy Cloud API",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "sammy",
+    "sammy-sdk",
+    "types",
+    "shared"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sammymitch0071/sammy.git",
+    "directory": "packages/shared"
+  },
+  "bugs": {
+    "url": "https://github.com/sammymitch0071/sammy/issues"
+  },
+  "homepage": "https://sammy.dev",
+  "devDependencies": {
+    "rimraf": "^6.0.1",
+    "typescript": "^5.7.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "clean": "rimraf dist tsconfig.tsbuildinfo"
+  }
+}