@kaiban/sdk 0.1.1 → 0.1.2

package/dist/types/entities/activities.d.ts

@@ -1,15 +1,53 @@
 import { ISODate } from './shared';
-export interface CardActivity {
-    id: string;
-    card_id: string;
-    type: string;
-    content?: string;
-    created_at?: ISODate;
-}
-export interface CreateCardActivityInput {
-    type: string;
-    content?: string;
-}
+export declare const ActivityType: {
+    readonly CARD_STATUS_CHANGED: "card_status_changed";
+    readonly CARD_RESULT_PREVIEW: "card_result_preview";
+    readonly CARD_TASK_COMPLETED: "card_task_completed";
+    readonly CARD_TASK_BLOCKED: "card_task_blocked";
+    readonly CARD_TASK_STARTED: "card_task_started";
+    readonly CARD_AGENT_ADDED: "card_agent_added";
+    readonly CARD_AGENT_REMOVED: "card_agent_removed";
+    readonly CARD_TITLE_CHANGED: "card_title_changed";
+    readonly CARD_DESCRIPTION_CHANGED: "card_description_changed";
+    readonly CARD_RESULT_CHANGED: "card_result_changed";
+    readonly CARD_PRIORITY_CHANGED: "card_priority_changed";
+    readonly CARD_MEMBER_ADDED: "card_member_added";
+    readonly CARD_MEMBER_REMOVED: "card_member_removed";
+    readonly CARD_COMMENT_ADDED: "card_comment_added";
+    readonly CARD_DELETED: "card_deleted";
+    readonly CARD_CREATED: "card_created";
+    readonly CARD_CLONED: "card_cloned";
+    readonly CARD_COLUMN_CHANGED: "card_column_changed";
+    readonly THREAD_USER_MESSAGE: "thread_user_message";
+    readonly THREAD_AGENT_MESSAGE: "thread_agent_message";
+    readonly THREAD_AGENT_MESSAGE_EVALUATION: "thread_agent_message_evaluation";
+    readonly THREAD_FEEDBACK: "thread_feedback";
+    readonly THREAD_STEP_COSTS: "thread_step_costs";
+    readonly AGENT_TASK_DOING: "agent_task_doing";
+    readonly AGENT_TASK_COMPLETED: "agent_task_completed";
+    readonly AGENT_TASK_DONE: "agent_task_done";
+    readonly AGENT_TASK_BLOCKED: "agent_task_blocked";
+    readonly AGENT_TASK_WAITING: "agent_task_waiting";
+    readonly AGENT_TASK_CANCELLED: "agent_task_cancelled";
+    readonly AGENT_TASK_FAILED: "agent_task_failed";
+    readonly AGENT_STATUS_OBSERVATION: "agent_status_observation";
+    readonly AGENT_STATUS_THINKING_END: "agent_status_thinking_end";
+    readonly AGENT_STATUS_UPDATED: "agent_status_updated";
+    readonly AGENT_REGISTER_APPROVAL: "agent_register_approval";
+    readonly AGENT_REGISTER_REJECTED: "agent_register_rejected";
+    readonly AGENT_RESPOND_FEEDBACK: "agent_respond_feedback";
+    readonly RESULT_APPROVED: "result_approved";
+    readonly RESULT_REJECTED: "result_rejected";
+    readonly RESULT_FEEDBACK: "result_feedback";
+    readonly EMAIL_RECEIVED: "email_received";
+    readonly EMAIL_SENT: "email_sent";
+    readonly EMAIL_OPENED: "email_opened";
+    readonly EMAIL_CLICKED: "email_clicked";
+    readonly EMAIL_BOUNCED: "email_bounced";
+    readonly EMAIL_SPAM: "email_spam";
+    readonly SYSTEM_TRACE: "system_trace";
+    readonly RESOURCE_PUBLISHED: "resource_published";
+};
 export interface ActivityActor {
     id: string;
     type: 'user' | 'agent' | 'system';
@@ -20,13 +58,17 @@ export interface ActivityChange {
     old_value: unknown;
     new_value: unknown;
 }
-export interface ActivityCreate {
+export interface Activity {
+    id: string;
     board_id: string;
-    card_id: string;
     team_id: string;
-    type: 'card_created' | 'card_column_changed' | string;
+    card_id: string;
+    type: (typeof ActivityType)[keyof typeof ActivityType];
     description: string;
     actor: ActivityActor;
     changes?: ActivityChange[];
     metadata?: Record<string, unknown>;
+    user_id?: string;
+    created_at: ISODate;
 }
+export type ActivityCreate = Omit<Activity, 'id' | 'created_at'>;

package/dist/types/entities/activities.js

@@ -1 +1,73 @@
-export {};
+export const ActivityType = {
+    // Card status activities
+    CARD_STATUS_CHANGED: 'card_status_changed',
+    CARD_RESULT_PREVIEW: 'card_result_preview',
+    // Card task activities
+    CARD_TASK_COMPLETED: 'card_task_completed',
+    CARD_TASK_BLOCKED: 'card_task_blocked',
+    CARD_TASK_STARTED: 'card_task_started',
+    // Card modification activities
+    CARD_AGENT_ADDED: 'card_agent_added',
+    CARD_AGENT_REMOVED: 'card_agent_removed',
+    CARD_TITLE_CHANGED: 'card_title_changed',
+    CARD_DESCRIPTION_CHANGED: 'card_description_changed',
+    CARD_RESULT_CHANGED: 'card_result_changed',
+    CARD_PRIORITY_CHANGED: 'card_priority_changed',
+    CARD_MEMBER_ADDED: 'card_member_added',
+    CARD_MEMBER_REMOVED: 'card_member_removed',
+    CARD_COMMENT_ADDED: 'card_comment_added',
+    CARD_DELETED: 'card_deleted',
+    CARD_CREATED: 'card_created',
+    CARD_CLONED: 'card_cloned',
+    CARD_COLUMN_CHANGED: 'card_column_changed',
+    // A2A task status activities
+    // "submitted" | "working" | "input-required" | "completed" | "canceled" | "failed" | "rejected"
+    // | "auth-required" | "unknown"
+    // Types for A2A task status activities
+    // TODO: Understand how to mix with the existing agent task status activities
+    // A2A_TASK_STATUS_SUBMITTED: 'submitted',
+    // A2A_TASK_STATUS_WORKING: 'working',
+    // A2A_TASK_STATUS_INPUT_REQUIRED: 'required',
+    // A2A_TASK_STATUS_COMPLETED: 'completed',
+    // A2A_TASK_STATUS_CANCELED: 'canceled',
+    // A2A_TASK_STATUS_FAILED: 'failed',
+    // A2A_TASK_STATUS_REJECTED: 'rejected',
+    // A2A_TASK_STATUS_AUTH_REQUIRED: 'auth-required',
+    // A2A_TASK_STATUS_UNKNOWN: 'unknown',
+    // Thread activities
+    THREAD_USER_MESSAGE: 'thread_user_message',
+    THREAD_AGENT_MESSAGE: 'thread_agent_message',
+    THREAD_AGENT_MESSAGE_EVALUATION: 'thread_agent_message_evaluation',
+    THREAD_FEEDBACK: 'thread_feedback',
+    THREAD_STEP_COSTS: 'thread_step_costs',
+    // Agent task status activities
+    AGENT_TASK_DOING: 'agent_task_doing',
+    AGENT_TASK_COMPLETED: 'agent_task_completed',
+    AGENT_TASK_DONE: 'agent_task_done',
+    AGENT_TASK_BLOCKED: 'agent_task_blocked',
+    AGENT_TASK_WAITING: 'agent_task_waiting',
+    AGENT_TASK_CANCELLED: 'agent_task_cancelled',
+    AGENT_TASK_FAILED: 'agent_task_failed',
+    // Agent action activities
+    AGENT_STATUS_OBSERVATION: 'agent_status_observation',
+    AGENT_STATUS_THINKING_END: 'agent_status_thinking_end',
+    AGENT_STATUS_UPDATED: 'agent_status_updated',
+    AGENT_REGISTER_APPROVAL: 'agent_register_approval',
+    AGENT_REGISTER_REJECTED: 'agent_register_rejected',
+    AGENT_RESPOND_FEEDBACK: 'agent_respond_feedback',
+    // Result feedback activities
+    RESULT_APPROVED: 'result_approved',
+    RESULT_REJECTED: 'result_rejected',
+    RESULT_FEEDBACK: 'result_feedback',
+    // Email activities
+    EMAIL_RECEIVED: 'email_received',
+    EMAIL_SENT: 'email_sent',
+    EMAIL_OPENED: 'email_opened',
+    EMAIL_CLICKED: 'email_clicked',
+    EMAIL_BOUNCED: 'email_bounced',
+    EMAIL_SPAM: 'email_spam',
+    // System tracing activities
+    SYSTEM_TRACE: 'system_trace',
+    // Resource activities
+    RESOURCE_PUBLISHED: 'resource_published',
+};

package/dist/types/entities/agent.d.ts

@@ -1,16 +1,58 @@
 import { ISODate } from './shared';
+export declare const AgentType: {
+    readonly KAIBANJS: "kaibanjs";
+    readonly CREWAI: "crewai";
+    readonly EXTERNAL: "external";
+    readonly A2A: "a2a";
+};
+export declare const AgentStatus: {
+    readonly ACTIVE: "active";
+    readonly DRAFT: "draft";
+    readonly INACTIVE: "inactive";
+};
 export interface Agent {
     id: string;
     name: string;
     description: string;
     team_id: string;
-    status: 'active' | 'draft' | 'inactive';
-    type: 'kaibanjs' | 'crewai' | 'external' | 'a2a';
+    status: (typeof AgentStatus)[keyof typeof AgentStatus];
+    type: (typeof AgentType)[keyof typeof AgentType];
     created_at?: ISODate;
     updated_at?: ISODate;
 }
+export declare const AgentFeedbackStatus: {
+    readonly UNPROCESSED: "unprocessed";
+    readonly REVIEWED: "reviewed";
+    readonly ANNOTATED: "annotated";
+};
+export declare const AgentFeedbackType: {
+    readonly OPERATOR_EVALUATION_ADDED: "operator_evaluation_added";
+    readonly USER_CONVERSATION_FEEDBACK: "user_conversation_feedback";
+    readonly USER_MESSAGE_EVALUATION: "user_message_evaluation";
+};
+export declare const AgentFeedbackEvaluation: {
+    readonly POSITIVE: "positive";
+    readonly NEGATIVE: "negative";
+};
 export interface AgentFeedback {
-    rating?: number;
-    comment?: string;
-    metadata?: Record<string, unknown>;
+    id: string;
+    agent_id: string;
+    team_id: string;
+    activity_id: string;
+    status: (typeof AgentFeedbackStatus)[keyof typeof AgentFeedbackStatus];
+    type: (typeof AgentFeedbackType)[keyof typeof AgentFeedbackType];
+    evaluation: (typeof AgentFeedbackEvaluation)[keyof typeof AgentFeedbackEvaluation];
+    comment: string;
+    created_by: string;
+    created_at: ISODate;
+}
+export interface AgentSupervisorFeedback {
+    id: string;
+    agent_id: string;
+    team_id: string;
+    activity_id: string;
+    board_id: string;
+    feedback: string;
+    created_by: string;
+    created_at: ISODate;
 }

package/dist/types/entities/agent.js

@@ -1 +1,25 @@
-export {};
+export const AgentType = {
+    KAIBANJS: 'kaibanjs',
+    CREWAI: 'crewai',
+    EXTERNAL: 'external',
+    A2A: 'a2a',
+};
+export const AgentStatus = {
+    ACTIVE: 'active',
+    DRAFT: 'draft',
+    INACTIVE: 'inactive',
+};
+export const AgentFeedbackStatus = {
+    UNPROCESSED: 'unprocessed',
+    REVIEWED: 'reviewed',
+    ANNOTATED: 'annotated',
+};
+export const AgentFeedbackType = {
+    OPERATOR_EVALUATION_ADDED: 'operator_evaluation_added',
+    USER_CONVERSATION_FEEDBACK: 'user_conversation_feedback',
+    USER_MESSAGE_EVALUATION: 'user_message_evaluation',
+};
+export const AgentFeedbackEvaluation = {
+    POSITIVE: 'positive',
+    NEGATIVE: 'negative',
+};

package/dist/types/entities/card.d.ts

@@ -1,24 +1,12 @@
 import { ISODate } from './shared';
-export interface Card {
-    id: string;
-    team_id: string;
-    board_id: string;
-    owner_id: string;
-    agent_id: string;
-    title: string;
-    description?: string;
-    status: 'backlog' | 'todo' | 'doing' | 'blocked' | 'done';
-    column_key: string;
-    created_at?: ISODate;
-    updated_at?: ISODate;
-    priority: string;
-    result?: string;
-    member_ids: string[];
-    metadata?: Record<string, unknown>;
-    enabled?: boolean;
-    parts?: Part[];
-}
-export type Part = {
+export declare const CardStatus: {
+    readonly BACKLOG: "backlog";
+    readonly TODO: "todo";
+    readonly DOING: "doing";
+    readonly BLOCKED: "blocked";
+    readonly DONE: "done";
+};
+export type CardPart = {
     type: 'text';
     text: {
         content: string;
@@ -31,20 +19,22 @@ export type Part = {
         uri: string;
     };
 };
-export interface CreateCardInput {
+export interface Card {
+    id: string;
     team_id: string;
     board_id: string;
     owner_id: string;
     agent_id: string;
     title: string;
     description?: string;
-    status: Card['status'];
+    status: (typeof CardStatus)[keyof typeof CardStatus];
     column_key: string;
     priority: string;
+    result?: string;
     member_ids: string[];
-    parts?: Part[];
     metadata?: Record<string, unknown>;
+    enabled?: boolean;
+    parts?: CardPart[];
+    created_at: ISODate;
+    updated_at?: ISODate;
 }
-export type UpdateCardInput = Partial<Omit<CreateCardInput, 'team_id' | 'board_id' | 'owner_id'>> & {
-    status?: Card['status'];
-};

package/dist/types/entities/card.js

@@ -1 +1,26 @@
-export {};
+export const CardStatus = {
+    BACKLOG: 'backlog',
+    TODO: 'todo',
+    DOING: 'doing',
+    BLOCKED: 'blocked',
+    DONE: 'done',
+};
+// export interface CreateCardInput {
+//   team_id: string;
+//   board_id: string;
+//   owner_id: string;
+//   agent_id: string;
+//   title: string;
+//   description?: string;
+//   status: Card['status'];
+//   column_key: string;
+//   priority: string;
+//   member_ids: string[];
+//   parts?: CardPart[];
+//   metadata?: Record<string, unknown>;
+// }
+// export type UpdateCardInput = Partial<
+//   Omit<CreateCardInput, 'team_id' | 'board_id' | 'owner_id'>
+// > & {
+//   status?: Card['status'];
+// };

package/dist/types/entities/external-channel.d.ts

@@ -1,12 +1,32 @@
 import { ISODate } from './shared';
+export declare const ExternalChannelType: {
+    readonly EMAIL: "email";
+    readonly FORM: "form";
+    readonly CALL: "call";
+    readonly SMS: "sms";
+    readonly CHATBOT: "chatbot";
+};
+export declare const ExternalChannelStatus: {
+    readonly ACTIVE: "active";
+    readonly INACTIVE: "inactive";
+};
+export declare const ExternalChannelPriority: {
+    readonly LOW: "low";
+    readonly MEDIUM: "medium";
+    readonly HIGH: "high";
+};
 export interface ExternalChannel {
     id: string;
+    type: (typeof ExternalChannelType)[keyof typeof ExternalChannelType];
     name: string;
-    type: string;
-    team_id: string;
-    board_id: string;
+    description?: string;
     agent_id: string;
-    initial_column_key?: string;
-    created_at?: ISODate;
+    board_id: string;
+    team_id: string;
+    initial_column_key: string;
+    status: (typeof ExternalChannelStatus)[keyof typeof ExternalChannelStatus];
+    priority: (typeof ExternalChannelPriority)[keyof typeof ExternalChannelPriority];
+    metadata?: Record<string, unknown>;
+    created_at: ISODate;
     updated_at?: ISODate;
 }

package/dist/types/entities/external-channel.js

@@ -1 +1,16 @@
-export {};
+export const ExternalChannelType = {
+    EMAIL: 'email',
+    FORM: 'form',
+    CALL: 'call',
+    SMS: 'sms',
+    CHATBOT: 'chatbot',
+};
+export const ExternalChannelStatus = {
+    ACTIVE: 'active',
+    INACTIVE: 'inactive',
+};
+export const ExternalChannelPriority = {
+    LOW: 'low',
+    MEDIUM: 'medium',
+    HIGH: 'high',
+};

package/dist/types/entities/index.d.ts

@@ -1,9 +1,8 @@
-export * from './shared';
-export * from './card';
 export * from './activities';
 export * from './agent';
-export * from './team';
 export * from './board';
-export * from './resource';
-export * from './benchmark';
+export * from './card';
 export * from './external-channel';
+export * from './resource';
+export * from './shared';
+export * from './team';

package/dist/types/entities/index.js

@@ -1,9 +1,8 @@
-export * from './shared';
-export * from './card';
 export * from './activities';
 export * from './agent';
-export * from './team';
 export * from './board';
-export * from './resource';
-export * from './benchmark';
+export * from './card';
 export * from './external-channel';
+export * from './resource';
+export * from './shared';
+export * from './team';

package/dist/types/entities/resource.d.ts

@@ -1,16 +1,25 @@
 import { ISODate } from './shared';
+export declare const ResourceStatus: {
+    readonly DRAFT: "draft";
+    readonly INDEXING: "indexing";
+    readonly INDEXING_ERROR: "indexing_error";
+    readonly PUBLISHED: "published";
+    readonly ARCHIVED: "archived";
+};
 export interface Resource {
     id: string;
-    name: string;
-    description?: string;
-    version?: number;
-    content?: string;
-    status?: string;
-    team_id?: string;
-    created_by?: string;
-    last_edited_by?: string;
-    published_at?: ISODate | null;
-    last_edited_at?: ISODate;
-    created_at?: ISODate;
-    updated_at?: ISODate;
+    title: string;
+    description: string;
+    version: number;
+    status: (typeof ResourceStatus)[keyof typeof ResourceStatus];
+    team_id: string;
+    created_by: string;
+    last_edited_by: string;
+    published_at: ISODate;
+    last_edited_at: ISODate;
+    draft_content: string;
+    published_content: string;
+    vector_db_index_name?: string;
+    created_at: ISODate;
+    updated_at: ISODate;
 }

package/dist/types/entities/resource.js

@@ -1 +1,7 @@
-export {};
+export const ResourceStatus = {
+    DRAFT: 'draft',
+    INDEXING: 'indexing',
+    INDEXING_ERROR: 'indexing_error',
+    PUBLISHED: 'published',
+    ARCHIVED: 'archived',
+};

package/dist/types/responses.d.ts

@@ -4,12 +4,10 @@
 export interface PaginationMeta {
     /** Number of items per page */
     limit: number;
-    /** Whether there are more results available */
-    has_more: boolean;
-    /** Cursor for the next page */
-    next_cursor?: string;
-    /** Cursor for the previous page */
-    previous_cursor?: string;
+    /** Cursor for previous page, null if no previous page */
+    prev_cursor: string | null;
+    /** Cursor for next page, null if no next page */
+    next_cursor: string | null;
 }
 /**
  * API meta information returned with each response
@@ -43,22 +41,24 @@ export interface ErrorEnvelope {
     meta: ResponseMeta;
 }
 /**
- * Generic paginated response format (Option A)
+ * Generic paginated response format
  */
 export interface Paginated<T> {
     /** Array of items in the current page */
     data: T[];
     /** Pagination metadata */
-    meta: PaginationMeta;
+    pagination: PaginationMeta;
 }
 /**
  * Parameters for list operations
  */
 export interface ListParams {
-    /** Cursor for pagination (from previous/next response) */
-    cursor?: string;
     /** Number of items per page (default: 50, max: 100) */
     limit?: number;
+    /** Cursor to navigate backwards (get items before this cursor) */
+    before?: string;
+    /** Cursor to navigate forwards (get items after this cursor) */
+    after?: string;
     /**
      * Fields to sort by. Use - prefix for descending order.
      * Example: ['-created_at', 'name'] sorts by created_at desc, then name asc

package/package.json

@@ -1,7 +1,28 @@
 {
   "name": "@kaiban/sdk",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Official TypeScript SDK for the Kaiban API",
+  "keywords": [
+    "kaiban",
+    "sdk",
+    "api",
+    "client",
+    "typescript",
+    "agents",
+    "ai",
+    "workflow",
+    "cards",
+    "boards"
+  ],
+  "author": "Kaiban",
+  "homepage": "https://github.com/kaiban-ai/kaiban-sdk#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kaiban-ai/kaiban-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/kaiban-ai/kaiban-sdk/issues"
+  },
   "license": "MIT",
   "type": "module",
   "main": "dist/index.js",
@@ -27,17 +48,22 @@
     "clean": "rimraf dist",
     "prepare": "npm run build",
     "dev": "npm run lint && npm run format && tsc -w -p tsconfig.json",
-    "lint": "node_modules/.bin/eslint .",
-    "lint:fix": "node_modules/.bin/eslint . --fix",
-    "format": "node_modules/.bin/prettier --write .",
-    "format:check": "node_modules/.bin/prettier --check .",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
     "refresh": "rm -rf node_modules package-lock.json && npm install",
     "test": "vitest run",
     "test:watch": "vitest",
     "docs:generate": "typedoc",
     "docs:clean": "rimraf docs",
     "docs:build": "npm run docs:clean && npm run docs:generate",
-    "docs:serve": "npm run docs:generate && npx serve docs"
+    "docs:serve": "npm run docs:generate && npx serve docs",
+    "prepublishOnly": "npm run clean && npm run build && npm test",
+    "publish:dry": "npm publish --dry-run",
+    "version:patch": "npm version patch",
+    "version:minor": "npm version minor",
+    "version:major": "npm version major"
   },
   "devDependencies": {
     "@eslint/js": "^9.12.0",
@@ -46,6 +72,7 @@
     "eslint-config-prettier": "^9.1.0",
     "prettier": "^3.3.3",
     "rimraf": "^6.0.1",
+    "tsx": "^4.20.6",
     "typedoc": "^0.28.14",
     "typescript": "^5.4.0",
     "typescript-eslint": "^8.8.0",