@proteos/sdk 0.18.1

package/src/index.ts

@@ -0,0 +1,598 @@
+/**
+ * Proteos SDK for TypeScript/JavaScript
+ *
+ * A type-safe client library for the Proteos platform API.
+ *
+ * @example
+ * ```ts
+ * import { ProteosClient, MetaClient, isNotFound } from 'proteos-sdk';
+ *
+ * // Create client
+ * const client = new ProteosClient({
+ *   baseUrl: 'https://api.proteos.ai',
+ *   token: 'your-api-token',
+ * });
+ *
+ * // Create meta client
+ * const meta = new MetaClient(client);
+ *
+ * // List entities
+ * for await (const entity of meta.entities.list()) {
+ *   console.log(entity.slug);
+ * }
+ *
+ * // Handle errors
+ * try {
+ *   const entity = await meta.entities.get('not-found');
+ * } catch (error) {
+ *   if (isNotFound(error)) {
+ *     console.log('Entity not found');
+ *   }
+ * }
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+// Agent client (agent-service: agents, prompts, skills, tools, mcp-servers, sessions)
+export type {
+  ActionBinding,
+  Agent,
+  AgentArtifactsPayload,
+  AgentMessagePayload,
+  AgentResourceListOptions,
+  AgentService,
+  AppendEventRequest,
+  ClientEventType,
+  ClientToolSchema,
+  ContentBlock,
+  ContextCompactedPayload,
+  CreateAgentRequest,
+  CreateMcpServerRequest,
+  CreatePromptRequest,
+  CreateSessionRequest,
+  CreateToolRequest,
+  EmptyPayload,
+  ErrorPayload,
+  EventType,
+  FileBlock,
+  ListAgentsOptions,
+  ListMcpServersOptions,
+  ListPromptsOptions,
+  ListSessionsOptions,
+  ListSkillsOptions,
+  ListToolsOptions,
+  McpBinding,
+  McpConnectionState,
+  McpConnectionStatus,
+  McpServer,
+  McpServerAuth,
+  McpServerOAuth,
+  McpServerService,
+  McpToolSummary,
+  ModelConfig,
+  ModelRequestEndPayload,
+  ModelRequestStartPayload,
+  ModelUsage,
+  Prompt,
+  PromptService,
+  PromptVersion,
+  ReasoningPayload,
+  ResultBlock,
+  Session,
+  SessionEvent,
+  SessionEventEnvelope,
+  SessionEventsOptions,
+  SessionIdlePayload,
+  SessionService,
+  SessionStatus,
+  SessionStreamOptions,
+  SessionUpdatedPayload,
+  Skill,
+  SkillBundle,
+  SkillService,
+  SkillVersion,
+  StartMcpOAuthResponse,
+  StopReason,
+  TextBlock,
+  Tool,
+  ToolBinding,
+  ToolConfirmationPayload,
+  ToolKind,
+  ToolResultPayload,
+  ToolService,
+  ToolUsePayload,
+  Turn,
+  UpdateAgentRequest,
+  UpdateMcpServerRequest,
+  UpdatePromptRequest,
+  UpdateToolRequest,
+  UserMessagePayload,
+} from './agent/index.js'
+export { AgentClient } from './agent/index.js'
+// Auth types (re-exported from auth/index.ts for convenience)
+export type {
+  AssignPermissionRequest,
+  AssignRoleRequest,
+  // Shared auth types
+  AuthListOptions,
+  CreateOrganizationRequest,
+  CreateRoleRequest,
+  CreateUserRequest,
+  ListOrganizationsOptions,
+  ListRolePermissionsOptions,
+  ListRolesOptions,
+  ListUserRoleAssignmentsOptions,
+  ListUsersOptions,
+  // Me (caller-scoped) service
+  MeService,
+  // Organization types
+  Organization,
+  OrganizationService,
+  // Permission types
+  Permission,
+  // Platform entities
+  PlatformEntity,
+  // Role types
+  Role,
+  RoleEntityPermission,
+  RoleService,
+  UpdateOrganizationRequest,
+  UpdateRoleRequest,
+  UpdateUserRequest,
+  // User types
+  User,
+  // User role assignment types
+  UserRoleAssignment,
+  UserService,
+} from './auth/index.js'
+// Auth client and services
+// Auth Zod schemas
+export {
+  AccountClient,
+  isPlatformEntity,
+  OrganizationSchema,
+  PLATFORM_ENTITIES,
+  PLATFORM_ENTITY_SLUGS,
+  RoleEntityPermissionSchema,
+  RoleSchema,
+  UserRoleAssignmentSchema,
+  UserSchema,
+} from './auth/index.js'
+// Main client
+export { ProteosClient } from './client.js'
+// Conversation types (conversation-service: connections, conversations, messages, listeners)
+export type {
+  AgentListener,
+  AgentListenerService,
+  AgentListenerTriggerType,
+  Attachment,
+  Channel,
+  Connection,
+  ConnectionCredentials,
+  ConnectionScope,
+  ConnectionService,
+  ConnectionStatus,
+  ConnectorKey,
+  ConnectorProvider,
+  // Aliased: the agent module already exports its own ContentBlock.
+  ContentBlock as MessageContentBlock,
+  Conversation,
+  ConversationParticipant,
+  ConversationService,
+  ConversationStatus,
+  CreateAgentListenerRequest,
+  CreateConnectionRequest,
+  InstallConnectionResponse,
+  ListAgentListenersQuery,
+  ListConnectionsQuery,
+  ListConversationsQuery,
+  ListMessagesQuery,
+  ListParticipantsQuery,
+  // Conversation-local page envelope ({meta, data}) — distinct from the
+  // PageIterator-based ListResult used by the other modules.
+  ListResponse,
+  ListRoomsQuery,
+  Message,
+  MessageDirection,
+  MessagePreview,
+  MessageRecipient,
+  MessageService,
+  MessageStatus,
+  Participant,
+  ParticipantRef,
+  ParticipantSource,
+  Reaction,
+  ReactionCapability,
+  ReactionOption,
+  ReactionSetKind,
+  RecipientKind,
+  RecipientRole,
+  Room,
+  SendMessageRequest,
+  SendRecipient,
+  TranscribeStreamOptions,
+  TranscriptResult,
+  UnreadCounts,
+  UpdateAgentListenerRequest,
+  UpdateConnectionRequest,
+  VoiceService,
+  VoiceTranscriptionStream,
+} from './conversation/index.js'
+// Conversation client (conversation-service)
+export { ConversationClient } from './conversation/index.js'
+// Connector client (connector-service)
+export { ConnectorClient } from './connector/index.js'
+export type {
+  Connector,
+  ConnectorConnection,
+  ConnectorMethod,
+  ConnectionScope as ConnectorConnectionScope,
+  ConnectionStatus as ConnectorConnectionStatus,
+  ConnectionTokenResponse as ConnectorConnectionTokenResponse,
+  CreateConnectorConnectionRequest,
+  CredentialKind as ConnectorCredentialKind,
+  InstallConnectorConnectionResponse,
+  ListConnectorConnectionsQuery,
+  ListConnectorsQuery,
+  UpdateConnectorConnectionRequest,
+  WriteCredentialsRequest,
+} from './connector/index.js'
+export type {
+  BatchTransactionError,
+  BatchTransactionStatus,
+  BatchUpsertRecordsResponse,
+  BatchUpsertTransaction,
+  BatchUpsertTransactionResult,
+  ListRecordsOptions,
+  QueryExecuteMeta,
+  QueryExecuteResponse,
+  QueryRow,
+  QueryService,
+  QueryValidateMeta,
+  QueryValidateResponse,
+  RecordData,
+  RecordService,
+} from './data/index.js'
+// Data client (data-service)
+export {
+  BatchTransactionErrorSchema,
+  BatchUpsertRecordsResponseSchema,
+  BatchUpsertTransactionResultSchema,
+  BatchUpsertTransactionSchema,
+  DataClient,
+} from './data/index.js'
+export type { ApiErrorResponse, ErrorCodeType } from './errors.js'
+// Error handling
+export {
+  ErrorCode,
+  getDefaultErrorCode,
+  isBadRequest,
+  isConflict,
+  isForbidden,
+  isNotFound,
+  isProteosError,
+  isUnauthorized,
+  ProteosError,
+  parseErrorResponse,
+} from './errors.js'
+export type {
+  ConsumerGroup,
+  ListEventsOptions,
+  PlatformEvent,
+  PublishEventRequest,
+  RedriveResult,
+  TailOptions,
+  Topic,
+  TopicKind,
+  TopicService,
+} from './events/index.js'
+// Events client (event-service: read/admin view over the Redis bus)
+export { EventsClient } from './events/index.js'
+// Functions client (function-service: deployed actions + hooks)
+export type {
+  Action,
+  ActionScope,
+  ActionService,
+  InvokeActionResponse,
+  ListActionsOptions,
+} from './functions/index.js'
+export { ActionSchema, ActionScopeSchema, FunctionsClient } from './functions/index.js'
+// HTTP utilities
+export type { QueryObject, QueryValue } from './http/index.js'
+export { buildUrl, toQueryParams, toQueryString } from './http/index.js'
+export type { Done, ListFn } from './iterator.js'
+// Iterator
+export { createIterator, DEFAULT_PAGE_SIZE, DONE, PageIterator } from './iterator.js'
+// Knowledge types (re-exported from knowledge/index.ts for convenience)
+export type {
+  ContentMatch,
+  ContentResponse,
+  CreateLabelRequest,
+  CreateLinkRequest,
+  CreateNodeRequest,
+  CreateRecordLinkRequest,
+  EditContentRequest,
+  EditContentResponse,
+  GetGraphOptions,
+  GraphService,
+  InlineLinkRequest,
+  KnowledgeGraph,
+  KnowledgeGraphLink,
+  KnowledgeGraphNode,
+  KnowledgeLabel,
+  KnowledgeLink,
+  KnowledgeNode,
+  KnowledgeNodeLabel,
+  KnowledgeNodeMetadata,
+  KnowledgeNodeSearchResult,
+  KnowledgeRecordLink,
+  LabelService,
+  LinkService,
+  LinkType,
+  ListLabelsOptions,
+  ListLinksOptions,
+  ListNodesOptions,
+  ListRecordLinksOptions,
+  MatchMode,
+  NeighborDirection,
+  NeighborEdge,
+  NeighborNode,
+  NeighborsOptions,
+  NodeContentMatches,
+  NodeNeighborhood,
+  NodeOutline,
+  NodeService,
+  NodeStatus,
+  NodeType,
+  OutlineHeading,
+  OutlineRequest,
+  OutlineResponse,
+  RecordLinkService,
+  SearchContentRequest,
+  SearchContentResponse,
+  SearchNodesRequest,
+  UpdateLabelRequest,
+  UpdateLinkRequest,
+  UpdateNodeRequest,
+  WriteContentResponse,
+} from './knowledge/index.js'
+// Knowledge client (knowledge-service: graph-native knowledge base)
+export {
+  KnowledgeClient,
+  KnowledgeLabelSchema,
+  KnowledgeLinkSchema,
+  KnowledgeNodeLabelSchema,
+  KnowledgeNodeMetadataSchema,
+  KnowledgeNodeSchema,
+  KnowledgeNodeSearchResultSchema,
+  KnowledgeRecordLinkSchema,
+  NodeNeighborhoodSchema,
+} from './knowledge/index.js'
+// Meta types (re-exported from meta/index.ts for convenience)
+export type {
+  // App types
+  App,
+  AppService,
+  Attribute,
+  AttributeType,
+  Column,
+  ComparisonOperator,
+  // Component types
+  Component,
+  ComponentService,
+  CreateAppRequest,
+  CreateComponentRequest,
+  CreateEntityRequest,
+  CreateListRequest,
+  CreateListViewRequest,
+  CreateMenuConfigurationRequest,
+  CreatePageRequest,
+  CreateVariableRequest,
+  // Currency attribute meta + value
+  CurrencyAttributeMeta,
+  CurrencySymbolSide,
+  CurrencyValue,
+  DeployModuleRequest,
+  // Entity types
+  Entity,
+  EntityService,
+  EntityWithSchema,
+  // File attribute meta
+  FileAttributeMeta,
+  FilterElement,
+  FilterGroup,
+  // List types
+  List,
+  ListAppsOptions,
+  ListComponentsOptions,
+  ListEntitiesOptions,
+  ListListsOptions,
+  ListListViewsOptions,
+  ListMenuConfigurationsOptions,
+  ListModulesOptions,
+  ListPagesOptions,
+  ListService,
+  ListVariablesOptions,
+  // ListView types
+  ListView,
+  ListViewService,
+  LogicalOperator,
+  // MenuConfiguration types
+  MenuConfiguration,
+  MenuConfigurationService,
+  MenuItem,
+  // Shared meta types
+  MetaListOptions,
+  // Module types
+  Module,
+  ModuleService,
+  ModuleStatus,
+  OnDeleteAction,
+  // Page types
+  Page,
+  PageAction,
+  PageLayout,
+  PageService,
+  // Relation attribute meta
+  RelationAttributeMeta,
+  SortConfig,
+  SortDirection,
+  UpdateAppRequest,
+  UpdateComponentRequest,
+  UpdateEntityRequest,
+  UpdateListRequest,
+  UpdateListViewRequest,
+  UpdateMenuConfigurationRequest,
+  UpdatePageRequest,
+  UpdateVariableRequest,
+  // Variable types
+  Variable,
+  VariableService,
+} from './meta/index.js'
+// Meta client and services
+// Value-level constants from meta
+// Meta Zod schemas
+export {
+  AppSchema,
+  AttributeSchema,
+  allCurrencyCodes,
+  ColumnSchema,
+  ComponentSchema,
+  CurrencyAttributeMetaSchema,
+  currencyLabel,
+  currencySymbol,
+  currencySymbolSide,
+  EntitySchema,
+  EntityWithSchemaSchema,
+  FilterElementSchema,
+  FilterGroupSchema,
+  formatAmount,
+  formatMoney,
+  isPlatformAttributeName,
+  ListSchema,
+  ListViewSchema,
+  localeNumberSeparators,
+  MenuConfigurationSchema,
+  MenuItemSchema,
+  MenuItemType,
+  MetaClient,
+  ModuleSchema,
+  OnDeleteActionSchema,
+  PageActionSchema,
+  PageLayoutSchema,
+  PageSchema,
+  PLATFORM_ATTRIBUTE_NAMES,
+  parseAmount,
+  parseCurrencyMeta,
+  parseFileMeta,
+  parseRelationMeta,
+  platformAttributes,
+  RelationAttributeMetaSchema,
+  SortConfigSchema,
+  VariableSchema,
+} from './meta/index.js'
+export type {
+  CreateFileMetadata,
+  FileService,
+  FileVersionContent,
+  ParseStatus,
+  StorageFile,
+  StorageFileVersion,
+} from './storage/index.js'
+// Storage client (storage-service: file upload / download / metadata)
+export { StorageClient } from './storage/index.js'
+// Common types
+export type {
+  AuditFields,
+  ClientOptions,
+  FileRef,
+  ListOptions,
+  ListResult,
+  RequestOptions,
+  ResolvedClientOptions,
+  ResponseMeta,
+  Timestamps,
+  TokenProvider,
+  UserRef,
+  UserType,
+} from './types/index.js'
+export {
+  AuditFieldsSchema,
+  createListResultSchema,
+  DEFAULT_OPTIONS,
+  FileRefSchema,
+  PLATFORM_USER_ID,
+  ResponseMetaSchema,
+  resolveOptions,
+  UserRefSchema,
+} from './types/index.js'
+export type {
+  AgentActionParams,
+  AgentKickoff,
+  BinaryRef,
+  ConnectionEndpoint,
+  CreateWorkflowRequest,
+  CredentialSpec,
+  CronTriggerParams,
+  DisplayOptions,
+  EventTriggerParams,
+  EventVerb,
+  ExecutionError,
+  ExecutionStatus,
+  ExecutionTriggerContext,
+  GetExecutionDetailResponse,
+  GetNodeExecutionItemsOptions,
+  GetNodeExecutionItemsResponse,
+  GetNodeTypesResponse,
+  InvokeNodeMethodRequest,
+  InvokeNodeMethodResponse,
+  Item,
+  KickoffSource,
+  KickoffType,
+  ListExecutionsOptions,
+  ListWorkflowsOptions,
+  ManualTriggerParams,
+  MessageKickoff,
+  MessageTriggerParams,
+  NodeDescriptor,
+  NodeExecution,
+  NodeGroup,
+  NodeMethodOption,
+  NodePosition,
+  NodeProperty,
+  NodeRetryPolicy,
+  NodeRuntime,
+  NodeTypeKey,
+  NodeTypeService,
+  NodeTypeStatus,
+  OnErrorPolicy,
+  OutcomeKickoff,
+  OutcomeRubric,
+  PairedItem,
+  PortSpec,
+  PropertyOption,
+  PropertyType,
+  RunWorkflowRequest,
+  TestNodeCandidate,
+  TestNodeInputSource,
+  TestNodeRequest,
+  TestNodeResponse,
+  TriggerKind,
+  UpdateWorkflowRequest,
+  WebhookTriggerParams,
+  Workflow,
+  WorkflowConnection,
+  WorkflowContentBlock,
+  WorkflowExecution,
+  WorkflowGraph,
+  WorkflowNode,
+  WorkflowNodeType,
+  WorkflowStatus,
+  WorkflowVersion,
+  WorkflowVersionAuthor,
+  WorkflowVersionSummary,
+} from './workflow/index.js'
+// Workflow client (workflow-service: n8n-shaped workflows + executions +
+// node-type catalog)
+export { DEFAULT_PORT, ERROR_PORT, WorkflowClient } from './workflow/index.js'