@openbeam/sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,720 @@
+//#region src/types.d.ts
+interface OpenBeamConfig {
+  apiKey: string;
+  baseUrl?: string;
+  timeout?: number;
+  maxRetries?: number;
+}
+interface RequestOptions {
+  signal?: AbortSignal;
+  timeout?: number;
+}
+interface SearchResult {
+  id: string;
+  title: string | null;
+  snippet: string | null;
+  source: string | null;
+  connectorType: string | null;
+  documentType: string | null;
+  sourceName: string | null;
+  sourceType: string | null;
+  authorName: string | null;
+  authorEmail: string | null;
+  authorAvatarUrl: string | null;
+  url: string | null;
+  score: number | null;
+  createdAt: string | null;
+  updatedAt: string | null;
+}
+interface SearchDocumentsOptions extends RequestOptions {
+  limit?: number;
+  cursor?: string;
+  connectorTypes?: string[];
+  documentTypes?: string[];
+  authorIds?: string[];
+  ranking?: "hybrid" | "semantic" | "bm25" | "recency";
+  dateFrom?: string;
+  dateTo?: string;
+}
+interface SearchDocumentsResponse {
+  meta: {
+    query: string;
+    totalResults: number;
+    returned: number;
+    hasNextPage: boolean;
+    nextCursor: string | null;
+    ranking: string;
+    queryTimeMs?: number;
+    embeddingTimeMs?: number;
+    connectorFacets?: Record<string, number>;
+  };
+  data: SearchResult[];
+}
+interface PersonResult {
+  id: string;
+  name: string | null;
+  email: string | null;
+  title: string | null;
+  department: string | null;
+  avatarUrl: string | null;
+  connectorType: string | null;
+  documentCount?: number;
+}
+interface SearchPeopleOptions extends RequestOptions {
+  limit?: number;
+  connectorTypes?: string[];
+}
+interface SearchPeopleResponse {
+  data: PersonResult[];
+}
+interface RecentResult {
+  id: string;
+  title: string | null;
+  connectorType: string | null;
+  documentType: string | null;
+  authorName: string | null;
+  url: string | null;
+  createdAt: string | null;
+}
+interface SearchRecentOptions extends RequestOptions {
+  hours?: number;
+  connectorTypes?: string[];
+  limit?: number;
+}
+interface SearchRecentResponse {
+  meta: {
+    hours: number;
+    totalResults: number;
+    hasNextPage: boolean;
+  };
+  data: RecentResult[];
+}
+interface SearchSemanticOptions extends RequestOptions {
+  limit?: number;
+  connectorTypes?: string[];
+}
+interface SearchSemanticResponse {
+  meta: {
+    query: string;
+    totalResults: number;
+    ranking: "semantic";
+    hasNextPage: boolean;
+  };
+  data: SearchResult[];
+}
+interface SearchSimilarOptions extends RequestOptions {
+  limit?: number;
+}
+interface SearchSimilarResponse {
+  meta: {
+    sourceDocumentId: string;
+    totalResults: number;
+    hasNextPage: boolean;
+  };
+  data: SearchResult[];
+}
+interface SearchByAuthorOptions extends RequestOptions {
+  query?: string;
+  limit?: number;
+}
+interface SearchByAuthorResponse {
+  meta: {
+    authorId: string;
+    query: string | null;
+    totalResults: number;
+    hasNextPage: boolean;
+  };
+  data: SearchResult[];
+}
+interface Connector {
+  id: string;
+  name: string | null;
+  type: string | null;
+  status: string | null;
+  lastSyncAt: string | null;
+  createdAt?: string | null;
+  documentCount: number | null;
+}
+interface ConnectorDetail extends Connector {
+  config?: Record<string, unknown> | null;
+  syncSchedule?: string | null;
+  errorMessage?: string | null;
+  health?: {
+    score: number | null;
+    status: string | null;
+    lastCheckedAt: string | null;
+  } | null;
+}
+interface ConnectorHealth {
+  connectorId: string;
+  status: string;
+  score: number | null;
+  lastSyncAt: string | null;
+  lastSyncDuration?: number | null;
+  documentCount: number | null;
+  errorCount?: number | null;
+  lastError: string | null;
+}
+interface ConnectorListOptions extends RequestOptions {
+  status?: "active" | "error" | "pending" | "disabled";
+  type?: string;
+  cursor?: string;
+  pageSize?: number;
+}
+interface ConnectorListResponse {
+  meta: {
+    cursor: string | null;
+    hasNextPage: boolean;
+  };
+  data: Connector[];
+}
+interface AvailableConnector {
+  app: string;
+  name: string;
+  description: string | null;
+  category: string | null;
+  authType: string;
+  logoUrl: string | null;
+  requiredFields?: Array<{
+    id: string;
+    label: string;
+    type: string;
+    required: boolean;
+    placeholder?: string;
+  }>;
+}
+interface ConnectorAvailableOptions extends RequestOptions {
+  authType?: "OAUTH" | "API_KEY";
+  category?: string;
+}
+interface ConnectorAvailableResponse {
+  data: AvailableConnector[];
+}
+interface SyncJob {
+  id: string;
+  connectorId: string;
+  connectorType?: string | null;
+  status: string;
+  type?: string | null;
+  startedAt?: string | null;
+  completedAt?: string | null;
+  documentsProcessed?: number | null;
+  documentsErrored?: number | null;
+  errorMessage?: string | null;
+}
+interface SyncTriggerResponse {
+  syncJobId: string;
+  workflowId: string;
+  connectorId: string;
+  type: string;
+}
+interface SyncStatusResponse {
+  connector: Record<string, unknown>;
+  latestSync: {
+    id: string;
+    status: string;
+    startedAt: string | null;
+    finishedAt: string | null;
+    durationMs: number | null;
+    dataAdded: number | null;
+    dataUpdated: number | null;
+    dataDeleted: number | null;
+    errorMessage: string | null;
+  } | null;
+  stats: Record<string, unknown>;
+  processing: Record<string, unknown>;
+  syncJobs: unknown[];
+  webhookStatus: unknown;
+}
+interface SyncHistoryOptions extends RequestOptions {
+  limit?: number;
+  offset?: number;
+}
+interface SyncHistoryResponse {
+  meta: {
+    cursor: string | null;
+    hasNextPage: boolean;
+    total: number;
+  };
+  data: SyncJob[];
+}
+interface SyncTriggerAllResponse {
+  type: string;
+  triggered: number;
+  alreadyRunning: number;
+  failed: number;
+  total: number;
+  connectors: Array<{
+    connectorId: string;
+    connectorName: string;
+    connectorType: string;
+    status: string;
+    syncJobId?: string;
+    workflowId?: string;
+    error?: string;
+  }>;
+}
+interface SyncProgressEntry {
+  workflowId: string;
+  stage: string;
+  processed: number;
+  indexed: number;
+  errors: number;
+  dataAdded: number;
+  dataUpdated: number;
+  dataDeleted: number;
+  batchNumber?: number;
+  progressMessage?: string;
+  isPaused?: boolean;
+}
+interface SyncProgressResponse {
+  connectorId: string;
+  activeSyncs: SyncProgressEntry[];
+}
+interface SyncHealthEntry {
+  connectorId: string;
+  connectorName: string;
+  connectorType: string;
+  status: string;
+  documentCount: number;
+  lastSyncStatus: string | null;
+  lastSyncAt: string | null;
+}
+interface SyncHealthResponse {
+  healthy: number;
+  warning: number;
+  error: number;
+  total: number;
+  connectors: SyncHealthEntry[];
+}
+interface SyncControlResponse {
+  connectorId: string;
+  action: string;
+  affected: number;
+}
+interface SyncErrorEntry {
+  connectorId: string;
+  connectorType: string | null;
+  status: string;
+  type: string | null;
+  startedAt: string | null;
+  errorMessage: string | null;
+  documentsProcessed: number | null;
+}
+interface SyncErrorsResponse {
+  errors: SyncErrorEntry[];
+  total: number;
+}
+interface ConnectorAction {
+  id: string;
+  name: string;
+  description: string;
+  connectorType: string;
+  category: string;
+  stakes: string;
+  reversible: boolean;
+  inputs: Array<{
+    id: string;
+    name: string;
+    type: string;
+    required: boolean;
+    description: string | null;
+  }>;
+}
+interface ActionsListOptions extends RequestOptions {
+  connectorType?: string;
+  category?: "create" | "read" | "update" | "delete" | "search" | "list" | "notify";
+}
+interface ActionsListResponse {
+  meta: {
+    totalActions: number;
+    connectorTypes: string[];
+    hasNextPage: boolean;
+  };
+  data: ConnectorAction[];
+}
+interface ActionExecuteResponse {
+  success: boolean;
+  data: unknown;
+  error?: string;
+}
+interface Team {
+  id: string;
+  name: string | null;
+  slug: string | null;
+  plan: string | null;
+  connectorCount: number | null;
+  memberCount: number | null;
+  documentCount: number | null;
+  createdAt: string | null;
+}
+interface TeamMember {
+  id: string;
+  name: string | null;
+  email: string | null;
+  role: string | null;
+  avatarUrl: string | null;
+  joinedAt: string | null;
+}
+interface KnowledgeEntity {
+  id: string;
+  name: string | null;
+  type: string | null;
+  aliases?: string[] | null;
+  expertiseScore?: number | null;
+  mentionCount?: number | null;
+}
+interface KnowledgeRelation {
+  id: string;
+  relationType: string;
+  weight?: number | null;
+  fromEntity?: KnowledgeEntity | null;
+  toEntity?: KnowledgeEntity | null;
+}
+interface EntitySearchOptions extends RequestOptions {
+  type?: string;
+  limit?: number;
+}
+interface EntitySearchResponse {
+  data: KnowledgeEntity[];
+}
+interface EntityPanelResponse {
+  data: {
+    entity: KnowledgeEntity;
+    relations: {
+      outgoing: KnowledgeRelation[];
+      incoming: KnowledgeRelation[];
+    };
+    expertise: Array<{
+      topic: KnowledgeEntity;
+      score: number | null;
+    }>;
+    recentMentions: Array<{
+      id: string;
+      documentId: string | null;
+      createdAt: string | null;
+    }>;
+  };
+}
+interface TopicExpertsResponse {
+  data: Array<{
+    person: KnowledgeEntity;
+    score: number | null;
+  }>;
+}
+interface AgentTemplate {
+  name: string;
+  description: string;
+  category: string;
+  estimatedDuration: string;
+}
+interface AgentRunOptions extends RequestOptions {
+  maxSources?: number;
+}
+interface AgentRunResponse {
+  data: {
+    agentName: string;
+    output: string;
+    stepsUsed: number;
+    durationMs: number;
+    citations: Array<{
+      title: string | null;
+      source: string | null;
+    }> | null;
+  };
+}
+interface ContextEntry {
+  uri: string;
+  title?: string | null;
+  abstract: string | null;
+  overview?: string | null;
+  contextType: string | null;
+  category: string | null;
+  score?: number | null;
+  updatedAt: string | null;
+}
+interface ContextDetail extends ContextEntry {
+  content?: string | null;
+  parentUri?: string | null;
+  ownerType?: string | null;
+  activeCount?: number | null;
+  relations?: Array<{
+    targetUri: string;
+    reason: string | null;
+  }> | null;
+}
+interface ContextSearchOptions extends RequestOptions {
+  contextType?: "resource" | "memory" | "skill" | "tool";
+  category?: string;
+  limit?: number;
+}
+interface ContextSearchResponse {
+  meta: {
+    query: string;
+    totalResults: number;
+    hasNextPage: boolean;
+  };
+  data: ContextEntry[];
+}
+interface ContextReadOptions extends RequestOptions {
+  level?: "0" | "1" | "2";
+}
+interface AskQuestionOptions extends RequestOptions {
+  connectorTypes?: string[];
+  maxSources?: number;
+}
+interface AnswerResponse {
+  data: {
+    answer: string;
+    confidence: number | null;
+    citations: Array<{
+      uri: string | null;
+      title: string | null;
+      snippet: string | null;
+      source: string | null;
+    }> | null;
+  };
+}
+//#endregion
+//#region src/client.d.ts
+declare class HttpClient {
+  private readonly apiKey;
+  private readonly baseUrl;
+  private readonly timeout;
+  private readonly maxRetries;
+  private requestId;
+  constructor(config: OpenBeamConfig);
+  callTool<T>(toolName: string, args: Record<string, unknown>, options?: RequestOptions): Promise<T>;
+  private nextId;
+  private buildSignal;
+  private fetchWithRetry;
+  private retryDelay;
+  private handleHttpError;
+}
+//#endregion
+//#region src/resources/actions.d.ts
+declare class ActionsResource {
+  private readonly client;
+  constructor(client: HttpClient);
+  list(options?: ActionsListOptions): Promise<ActionsListResponse>;
+  execute(connectorId: string, actionId: string, params: Record<string, unknown>, options?: RequestOptions): Promise<ActionExecuteResponse>;
+}
+//#endregion
+//#region src/resources/agents.d.ts
+declare class AgentsResource {
+  private readonly client;
+  constructor(client: HttpClient);
+  list(options?: RequestOptions & {
+    category?: "analysis" | "content";
+  }): Promise<{
+    data: AgentTemplate[];
+  }>;
+  run(agentName: string, input: string, options?: AgentRunOptions): Promise<AgentRunResponse>;
+  ask(question: string, options?: AskQuestionOptions): Promise<AnswerResponse>;
+  contextSearch(query: string, options?: ContextSearchOptions): Promise<ContextSearchResponse>;
+  contextRead(uri: string, options?: ContextReadOptions): Promise<{
+    data: ContextDetail;
+  }>;
+}
+//#endregion
+//#region src/resources/apikeys.d.ts
+interface ApiKey {
+  id: string;
+  name: string;
+  prefix: string;
+  scopes: string[];
+  createdAt: string;
+  lastUsedAt: string | null;
+  revoked: boolean;
+}
+interface ApiKeyCreated {
+  id: string;
+  key: string;
+  name: string;
+  prefix: string;
+  scopes: string[];
+}
+interface ApiKeyRevoked {
+  id: string;
+  revoked: boolean;
+}
+declare class ApiKeysResource {
+  private readonly client;
+  constructor(client: HttpClient);
+  list(options?: RequestOptions): Promise<ApiKey[]>;
+  create(name: string, scopes?: string[], options?: RequestOptions): Promise<ApiKeyCreated>;
+  revoke(apiKeyId: string, options?: RequestOptions): Promise<ApiKeyRevoked>;
+}
+//#endregion
+//#region src/resources/connectors.d.ts
+declare class ConnectorsResource {
+  private readonly client;
+  constructor(client: HttpClient);
+  list(options?: ConnectorListOptions): Promise<ConnectorListResponse>;
+  get(id: string, options?: RequestOptions): Promise<{
+    data: ConnectorDetail;
+  }>;
+  health(id: string, options?: RequestOptions): Promise<{
+    data: ConnectorHealth;
+  }>;
+  available(options?: ConnectorAvailableOptions): Promise<ConnectorAvailableResponse>;
+  disconnect(connectorId: string, options?: RequestOptions): Promise<{
+    connectorId: string;
+    name: string;
+    status: string;
+  }>;
+}
+//#endregion
+//#region src/resources/knowledge.d.ts
+declare class KnowledgeResource {
+  private readonly client;
+  constructor(client: HttpClient);
+  searchEntities(query: string, options?: EntitySearchOptions): Promise<EntitySearchResponse>;
+  getEntity(entityId: string, options?: RequestOptions): Promise<EntityPanelResponse>;
+  getRelations(entityId: string, opts?: RequestOptions & {
+    direction?: "incoming" | "outgoing" | "both";
+    relationType?: string;
+    limit?: number;
+  }): Promise<{
+    data: {
+      outgoing: KnowledgeRelation[];
+      incoming: KnowledgeRelation[];
+    };
+  }>;
+  topicExperts(topicId: string, options?: RequestOptions & {
+    limit?: number;
+  }): Promise<TopicExpertsResponse>;
+  personExpertise(personId: string, options?: RequestOptions & {
+    limit?: number;
+  }): Promise<{
+    data: Array<{
+      topic: {
+        id: string;
+        name: string | null;
+      };
+      score: number | null;
+    }>;
+  }>;
+  topics(options?: RequestOptions & {
+    parentId?: string;
+    limit?: number;
+  }): Promise<{
+    data: Array<{
+      id: string;
+      name: string;
+      documentCount: number | null;
+      children?: unknown[];
+    }>;
+  }>;
+}
+//#endregion
+//#region src/resources/search.d.ts
+declare class SearchResource {
+  private readonly client;
+  constructor(client: HttpClient);
+  documents(query: string, options?: SearchDocumentsOptions): Promise<SearchDocumentsResponse>;
+  people(query: string, options?: SearchPeopleOptions): Promise<SearchPeopleResponse>;
+  recent(options?: SearchRecentOptions): Promise<SearchRecentResponse>;
+  semantic(query: string, options?: SearchSemanticOptions): Promise<SearchSemanticResponse>;
+  similar(documentId: string, options?: SearchSimilarOptions): Promise<SearchSimilarResponse>;
+  byAuthor(authorId: string, options?: SearchByAuthorOptions): Promise<SearchByAuthorResponse>;
+}
+//#endregion
+//#region src/resources/sync.d.ts
+declare class SyncResource {
+  private readonly client;
+  constructor(client: HttpClient);
+  trigger(connectorId: string, type?: "full" | "incremental", options?: RequestOptions): Promise<SyncTriggerResponse>;
+  triggerAll(options?: RequestOptions & {
+    type?: "full" | "incremental";
+    connectorTypes?: string[];
+  }): Promise<SyncTriggerAllResponse>;
+  status(connectorId: string, options?: RequestOptions): Promise<SyncStatusResponse>;
+  history(connectorId: string, options?: SyncHistoryOptions): Promise<SyncHistoryResponse>;
+  progress(connectorId: string, options?: RequestOptions): Promise<SyncProgressResponse>;
+  health(options?: RequestOptions): Promise<SyncHealthResponse>;
+  errors(options?: RequestOptions & {
+    connectorId?: string;
+    limit?: number;
+  }): Promise<SyncErrorsResponse>;
+  cancel(connectorId: string, options?: RequestOptions): Promise<SyncControlResponse>;
+  pause(connectorId: string, options?: RequestOptions): Promise<SyncControlResponse>;
+  resume(connectorId: string, options?: RequestOptions): Promise<SyncControlResponse>;
+}
+//#endregion
+//#region src/resources/team.d.ts
+interface InviteResult {
+  id: string;
+  email: string;
+  role: string;
+  code: string;
+  createdAt: string | null;
+}
+interface RoleUpdateResult {
+  userId: string;
+  role: string;
+}
+interface MemberRemovedResult {
+  userId: string;
+  removed: boolean;
+}
+declare class TeamResource {
+  private readonly client;
+  constructor(client: HttpClient);
+  info(options?: RequestOptions): Promise<{
+    data: Team;
+  }>;
+  members(options?: RequestOptions): Promise<{
+    data: TeamMember[];
+  }>;
+  inviteMember(email: string, role?: "ADMIN" | "MEMBER", options?: RequestOptions): Promise<{
+    data: InviteResult;
+  }>;
+  removeMember(userId: string, options?: RequestOptions): Promise<{
+    data: MemberRemovedResult;
+  }>;
+  updateRole(userId: string, role: "OWNER" | "ADMIN" | "MEMBER", options?: RequestOptions): Promise<{
+    data: RoleUpdateResult;
+  }>;
+}
+//#endregion
+//#region src/errors.d.ts
+declare class OpenBeamError extends Error {
+  readonly status: number;
+  readonly code: string;
+  constructor(message: string, status: number, code: string);
+}
+declare class AuthenticationError extends OpenBeamError {
+  constructor(message?: string);
+}
+declare class PermissionError extends OpenBeamError {
+  constructor(message?: string);
+}
+declare class NotFoundError extends OpenBeamError {
+  constructor(message?: string);
+}
+declare class RateLimitError extends OpenBeamError {
+  readonly retryAfter: number | null;
+  constructor(message?: string, retryAfter?: number | null);
+}
+declare class ServerError extends OpenBeamError {
+  constructor(message?: string);
+}
+declare class ToolError extends OpenBeamError {
+  constructor(message: string);
+}
+//#endregion
+//#region src/index.d.ts
+declare class OpenBeam {
+  readonly search: SearchResource;
+  readonly connectors: ConnectorsResource;
+  readonly sync: SyncResource;
+  readonly actions: ActionsResource;
+  readonly team: TeamResource;
+  readonly knowledge: KnowledgeResource;
+  readonly agents: AgentsResource;
+  readonly apiKeys: ApiKeysResource;
+  constructor(config: OpenBeamConfig);
+}
+//#endregion
+export { type ActionExecuteResponse, type ActionsListOptions, type ActionsListResponse, type AgentRunOptions, type AgentRunResponse, type AgentTemplate, type AnswerResponse, type AskQuestionOptions, AuthenticationError, type AvailableConnector, type Connector, type ConnectorAction, type ConnectorAvailableOptions, type ConnectorAvailableResponse, type ConnectorDetail, type ConnectorHealth, type ConnectorListOptions, type ConnectorListResponse, type ContextDetail, type ContextEntry, type ContextReadOptions, type ContextSearchOptions, type ContextSearchResponse, type EntityPanelResponse, type EntitySearchOptions, type EntitySearchResponse, type KnowledgeEntity, type KnowledgeRelation, NotFoundError, OpenBeam, OpenBeam as default, type OpenBeamConfig, OpenBeamError, PermissionError, type PersonResult, RateLimitError, type RecentResult, type RequestOptions, type SearchByAuthorOptions, type SearchByAuthorResponse, type SearchDocumentsOptions, type SearchDocumentsResponse, type SearchPeopleOptions, type SearchPeopleResponse, type SearchRecentOptions, type SearchRecentResponse, type SearchResult, type SearchSemanticOptions, type SearchSemanticResponse, type SearchSimilarOptions, type SearchSimilarResponse, ServerError, type SyncControlResponse, type SyncErrorEntry, type SyncErrorsResponse, type SyncHealthEntry, type SyncHealthResponse, type SyncHistoryOptions, type SyncHistoryResponse, type SyncJob, type SyncProgressEntry, type SyncProgressResponse, type SyncStatusResponse, type SyncTriggerAllResponse, type SyncTriggerResponse, type Team, type TeamMember, ToolError, type TopicExpertsResponse };