@usepanacea/sdk 0.1.0

package/dist/types.d.cts

@@ -0,0 +1,170 @@
+/**
+ * @module @usepanacea/sdk/types
+ * Public request/response DTOs for the Panacea REST API.
+ * These mirror the server-side schemas exactly — no Zod dependency here.
+ */
+interface PaginationMeta {
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    pagination: PaginationMeta;
+}
+interface ApiErrorBody {
+    error: {
+        code: string;
+        message: string;
+        retriable: boolean;
+        traceId?: string;
+        details?: Record<string, unknown>;
+    };
+}
+interface QueryOptions {
+    /** The user's question */
+    question: string;
+    /** Optional session ID for multi-turn conversations */
+    sessionId?: string;
+    /** Optional additional context to inject */
+    context?: string;
+}
+interface QuerySource {
+    path: string;
+    title: string;
+    confidence: number;
+}
+interface QueryResult {
+    answer: string;
+    sources: QuerySource[];
+    confidence: number;
+    flaggedForReview: boolean;
+    sessionId: string;
+}
+interface IngestUrlOptions {
+    type: "url";
+    url: string;
+    slug?: string;
+    category?: string;
+}
+interface IngestTextOptions {
+    type: "text";
+    content: string;
+    filename?: string;
+    slug?: string;
+    category?: string;
+}
+type IngestOptions = IngestUrlOptions | IngestTextOptions;
+interface IngestResult {
+    rawPath: string;
+    confidence: number;
+    hadPii: boolean;
+    title: string;
+}
+type WikiEntryStatus = "draft" | "active" | "archived";
+interface WikiEntry {
+    id: string;
+    tenantId: string;
+    path: string;
+    title: string;
+    content: string;
+    confidence: number;
+    version: number;
+    status: WikiEntryStatus;
+    tags?: string[];
+    sourceUrl?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ListWikiOptions {
+    page?: number;
+    limit?: number;
+    status?: WikiEntryStatus;
+}
+interface CreateWikiEntryOptions {
+    path: string;
+    title: string;
+    content: string;
+    tags?: string[];
+    category?: string;
+}
+interface UpdateWikiEntryOptions {
+    title?: string;
+    content?: string;
+    tags?: string[];
+}
+type ReviewStatus = "pending" | "approved" | "rejected" | "modified";
+interface ReviewQueueItem {
+    id: string;
+    tenantId: string;
+    entryPath: string;
+    proposedContent: string;
+    currentContent?: string;
+    confidence: number;
+    reviewStatus: ReviewStatus;
+    reviewerId?: string;
+    reviewedAt?: string;
+    createdAt: string;
+}
+interface ListReviewOptions {
+    page?: number;
+    limit?: number;
+    status?: ReviewStatus;
+}
+interface ActOnReviewOptions {
+    status: "approved" | "rejected" | "modified";
+    modifiedContent?: string;
+}
+type ReactionType = "thumbs_up" | "thumbs_down" | "flag" | "copy";
+type WebhookEvent = "wiki.updated" | "review.approved" | "review.rejected" | "ingest.complete";
+interface WebhookRegistration {
+    id: string;
+    tenantId: string;
+    url: string;
+    events: WebhookEvent[];
+    isActive?: boolean;
+    createdAt: string;
+}
+interface CreateWebhookOptions {
+    url: string;
+    events: WebhookEvent[];
+    description?: string;
+}
+type SystemStatus = "healthy" | "degraded" | "unhealthy" | "unknown";
+type AgentStatus = "idle" | "running" | "error" | "disabled";
+interface AgentHealth {
+    name: string;
+    status: AgentStatus;
+    lastRunAt?: string;
+    message?: string;
+}
+interface HealthReport {
+    status: SystemStatus;
+    timestamp: string;
+    agents: AgentHealth[];
+    wikiEntryCount: number;
+    pendingReviewCount: number;
+    dbConnected: boolean;
+}
+type ApiKeyPrefix = "pk_live" | "pk_test";
+interface ApiKey {
+    id: string;
+    tenantId: string;
+    prefix: ApiKeyPrefix;
+    name?: string;
+    lastUsedAt?: string;
+    createdAt: string;
+}
+interface CreateApiKeyOptions {
+    name?: string;
+    prefix?: ApiKeyPrefix;
+    expiresAt?: string;
+}
+interface CreateApiKeyResult {
+    key: ApiKey;
+    /** Raw key value — only returned once, on creation */
+    rawKey: string;
+}
+
+export type { ActOnReviewOptions, AgentHealth, AgentStatus, ApiErrorBody, ApiKey, ApiKeyPrefix, CreateApiKeyOptions, CreateApiKeyResult, CreateWebhookOptions, CreateWikiEntryOptions, HealthReport, IngestOptions, IngestResult, IngestTextOptions, IngestUrlOptions, ListReviewOptions, ListWikiOptions, PaginatedResponse, PaginationMeta, QueryOptions, QueryResult, QuerySource, ReactionType, ReviewQueueItem, ReviewStatus, SystemStatus, UpdateWikiEntryOptions, WebhookEvent, WebhookRegistration, WikiEntry, WikiEntryStatus };

package/dist/types.d.ts

@@ -0,0 +1,170 @@
+/**
+ * @module @usepanacea/sdk/types
+ * Public request/response DTOs for the Panacea REST API.
+ * These mirror the server-side schemas exactly — no Zod dependency here.
+ */
+interface PaginationMeta {
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    pagination: PaginationMeta;
+}
+interface ApiErrorBody {
+    error: {
+        code: string;
+        message: string;
+        retriable: boolean;
+        traceId?: string;
+        details?: Record<string, unknown>;
+    };
+}
+interface QueryOptions {
+    /** The user's question */
+    question: string;
+    /** Optional session ID for multi-turn conversations */
+    sessionId?: string;
+    /** Optional additional context to inject */
+    context?: string;
+}
+interface QuerySource {
+    path: string;
+    title: string;
+    confidence: number;
+}
+interface QueryResult {
+    answer: string;
+    sources: QuerySource[];
+    confidence: number;
+    flaggedForReview: boolean;
+    sessionId: string;
+}
+interface IngestUrlOptions {
+    type: "url";
+    url: string;
+    slug?: string;
+    category?: string;
+}
+interface IngestTextOptions {
+    type: "text";
+    content: string;
+    filename?: string;
+    slug?: string;
+    category?: string;
+}
+type IngestOptions = IngestUrlOptions | IngestTextOptions;
+interface IngestResult {
+    rawPath: string;
+    confidence: number;
+    hadPii: boolean;
+    title: string;
+}
+type WikiEntryStatus = "draft" | "active" | "archived";
+interface WikiEntry {
+    id: string;
+    tenantId: string;
+    path: string;
+    title: string;
+    content: string;
+    confidence: number;
+    version: number;
+    status: WikiEntryStatus;
+    tags?: string[];
+    sourceUrl?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ListWikiOptions {
+    page?: number;
+    limit?: number;
+    status?: WikiEntryStatus;
+}
+interface CreateWikiEntryOptions {
+    path: string;
+    title: string;
+    content: string;
+    tags?: string[];
+    category?: string;
+}
+interface UpdateWikiEntryOptions {
+    title?: string;
+    content?: string;
+    tags?: string[];
+}
+type ReviewStatus = "pending" | "approved" | "rejected" | "modified";
+interface ReviewQueueItem {
+    id: string;
+    tenantId: string;
+    entryPath: string;
+    proposedContent: string;
+    currentContent?: string;
+    confidence: number;
+    reviewStatus: ReviewStatus;
+    reviewerId?: string;
+    reviewedAt?: string;
+    createdAt: string;
+}
+interface ListReviewOptions {
+    page?: number;
+    limit?: number;
+    status?: ReviewStatus;
+}
+interface ActOnReviewOptions {
+    status: "approved" | "rejected" | "modified";
+    modifiedContent?: string;
+}
+type ReactionType = "thumbs_up" | "thumbs_down" | "flag" | "copy";
+type WebhookEvent = "wiki.updated" | "review.approved" | "review.rejected" | "ingest.complete";
+interface WebhookRegistration {
+    id: string;
+    tenantId: string;
+    url: string;
+    events: WebhookEvent[];
+    isActive?: boolean;
+    createdAt: string;
+}
+interface CreateWebhookOptions {
+    url: string;
+    events: WebhookEvent[];
+    description?: string;
+}
+type SystemStatus = "healthy" | "degraded" | "unhealthy" | "unknown";
+type AgentStatus = "idle" | "running" | "error" | "disabled";
+interface AgentHealth {
+    name: string;
+    status: AgentStatus;
+    lastRunAt?: string;
+    message?: string;
+}
+interface HealthReport {
+    status: SystemStatus;
+    timestamp: string;
+    agents: AgentHealth[];
+    wikiEntryCount: number;
+    pendingReviewCount: number;
+    dbConnected: boolean;
+}
+type ApiKeyPrefix = "pk_live" | "pk_test";
+interface ApiKey {
+    id: string;
+    tenantId: string;
+    prefix: ApiKeyPrefix;
+    name?: string;
+    lastUsedAt?: string;
+    createdAt: string;
+}
+interface CreateApiKeyOptions {
+    name?: string;
+    prefix?: ApiKeyPrefix;
+    expiresAt?: string;
+}
+interface CreateApiKeyResult {
+    key: ApiKey;
+    /** Raw key value — only returned once, on creation */
+    rawKey: string;
+}
+
+export type { ActOnReviewOptions, AgentHealth, AgentStatus, ApiErrorBody, ApiKey, ApiKeyPrefix, CreateApiKeyOptions, CreateApiKeyResult, CreateWebhookOptions, CreateWikiEntryOptions, HealthReport, IngestOptions, IngestResult, IngestTextOptions, IngestUrlOptions, ListReviewOptions, ListWikiOptions, PaginatedResponse, PaginationMeta, QueryOptions, QueryResult, QuerySource, ReactionType, ReviewQueueItem, ReviewStatus, SystemStatus, UpdateWikiEntryOptions, WebhookEvent, WebhookRegistration, WikiEntry, WikiEntryStatus };

package/dist/types.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

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

package/dist/webhooks.cjs

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=webhooks.cjs.map
+//# sourceMappingURL=webhooks.cjs.map

package/dist/webhooks.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"webhooks.cjs"}

package/dist/webhooks.d.cts

@@ -0,0 +1,59 @@
+/**
+ * @module @usepanacea/sdk/webhooks
+ * Typed webhook payload definitions for all Panacea webhook events.
+ * Use these to type-check your webhook handler.
+ *
+ * @example
+ * ```typescript
+ * import type { PanaceaWebhookPayload } from "@usepanacea/sdk/webhooks"
+ *
+ * app.post("/webhooks/panacea", (req, res) => {
+ *   const payload = req.body as PanaceaWebhookPayload
+ *   if (payload.event === "ingest.complete") {
+ *     console.log(payload.data.rawPath)
+ *   }
+ * })
+ * ```
+ */
+interface WebhookBase {
+    /** ISO-8601 timestamp */
+    timestamp: string;
+    /** Tenant that triggered the event */
+    tenantId: string;
+}
+interface WikiUpdatedPayload extends WebhookBase {
+    event: "wiki.updated";
+    data: {
+        entryPath: string;
+        version: number;
+        title: string;
+    };
+}
+interface ReviewApprovedPayload extends WebhookBase {
+    event: "review.approved";
+    data: {
+        reviewId: string;
+        entryPath: string;
+        reviewerId: string;
+    };
+}
+interface ReviewRejectedPayload extends WebhookBase {
+    event: "review.rejected";
+    data: {
+        reviewId: string;
+        entryPath: string;
+        reviewerId: string;
+    };
+}
+interface IngestCompletePayload extends WebhookBase {
+    event: "ingest.complete";
+    data: {
+        rawPath: string;
+        title: string;
+        confidence: number;
+    };
+}
+type PanaceaWebhookPayload = WikiUpdatedPayload | ReviewApprovedPayload | ReviewRejectedPayload | IngestCompletePayload;
+type WebhookEventName = PanaceaWebhookPayload["event"];
+
+export type { IngestCompletePayload, PanaceaWebhookPayload, ReviewApprovedPayload, ReviewRejectedPayload, WebhookEventName, WikiUpdatedPayload };

package/dist/webhooks.d.ts

@@ -0,0 +1,59 @@
+/**
+ * @module @usepanacea/sdk/webhooks
+ * Typed webhook payload definitions for all Panacea webhook events.
+ * Use these to type-check your webhook handler.
+ *
+ * @example
+ * ```typescript
+ * import type { PanaceaWebhookPayload } from "@usepanacea/sdk/webhooks"
+ *
+ * app.post("/webhooks/panacea", (req, res) => {
+ *   const payload = req.body as PanaceaWebhookPayload
+ *   if (payload.event === "ingest.complete") {
+ *     console.log(payload.data.rawPath)
+ *   }
+ * })
+ * ```
+ */
+interface WebhookBase {
+    /** ISO-8601 timestamp */
+    timestamp: string;
+    /** Tenant that triggered the event */
+    tenantId: string;
+}
+interface WikiUpdatedPayload extends WebhookBase {
+    event: "wiki.updated";
+    data: {
+        entryPath: string;
+        version: number;
+        title: string;
+    };
+}
+interface ReviewApprovedPayload extends WebhookBase {
+    event: "review.approved";
+    data: {
+        reviewId: string;
+        entryPath: string;
+        reviewerId: string;
+    };
+}
+interface ReviewRejectedPayload extends WebhookBase {
+    event: "review.rejected";
+    data: {
+        reviewId: string;
+        entryPath: string;
+        reviewerId: string;
+    };
+}
+interface IngestCompletePayload extends WebhookBase {
+    event: "ingest.complete";
+    data: {
+        rawPath: string;
+        title: string;
+        confidence: number;
+    };
+}
+type PanaceaWebhookPayload = WikiUpdatedPayload | ReviewApprovedPayload | ReviewRejectedPayload | IngestCompletePayload;
+type WebhookEventName = PanaceaWebhookPayload["event"];
+
+export type { IngestCompletePayload, PanaceaWebhookPayload, ReviewApprovedPayload, ReviewRejectedPayload, WebhookEventName, WikiUpdatedPayload };

package/dist/webhooks.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=webhooks.js.map
+//# sourceMappingURL=webhooks.js.map

package/dist/webhooks.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"webhooks.js"}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@usepanacea/sdk",
+  "version": "0.1.0",
+  "private": false,
+  "type": "module",
+  "description": "Official Panacea TypeScript SDK — HTTP client for Node.js and browser",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aevrHQ/panacea.git",
+    "directory": "packages/sdk"
+  },
+  "homepage": "https://github.com/aevrHQ/panacea/tree/main/packages/sdk#readme",
+  "keywords": [
+    "panacea",
+    "knowledge-base",
+    "ai",
+    "sdk",
+    "rag",
+    "typescript"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "browser": {
+        "import": "./dist/browser.js",
+        "types": "./dist/browser.d.ts"
+      },
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    },
+    "./types": {
+      "import": "./dist/types.js",
+      "require": "./dist/types.cjs",
+      "types": "./dist/types.d.ts"
+    },
+    "./webhooks": {
+      "import": "./dist/webhooks.js",
+      "require": "./dist/webhooks.cjs",
+      "types": "./dist/webhooks.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.0",
+    "typescript": "^5.8.3",
+    "@types/node": "^20",
+    "@panacea/shared": "0.0.1"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "clean": "rm -rf dist"
+  }
+}