@or-sdk/idw 8.2.2 → 8.3.0-beta.4080.0

package/src/types/feed.ts

@@ -0,0 +1,142 @@
+/** Mirrors [idw-api feed.dto.ts](idw-api). */
+
+export type FeedType = 'markdown' | 'skill' | 'html' | 'file';
+
+export interface CreateFeedParams {
+  content?: string | null;
+  file_url?: string | null;
+  for_user_roles?: string[] | null;
+  short_content: string;
+  title: string;
+  image_url?: string | null;
+  for_user_emails?: string[] | null;
+  skill_id?: string | null;
+  type?: FeedType;
+  video_url?: string | null;
+  video_source?: string | null;
+}
+
+export interface ListFeedQuery {
+  column?: 'created_at' | 'updated_at' | 'title' | 'read';
+  direction?: 'asc' | 'desc';
+  limit?: string;
+  page?: string;
+  accountId?: string;
+}
+
+export interface CommentResponse {
+  id: string;
+  feed_id: string;
+  parent_id?: string;
+  value: string;
+  author: string;
+  created_at: string;
+  updated_at: string;
+  created_by: string;
+}
+
+export interface ReactionProfile {
+  id: string;
+  icon: string;
+  email: string;
+  lastName: string;
+  firstName: string;
+  phoneNumber: string;
+}
+
+export interface ReactionResponse {
+  id: string;
+  feed_id: string;
+  value: string;
+  created_at: string;
+  created_by: string;
+  profile?: ReactionProfile;
+}
+
+export interface FeedItem {
+  id: string;
+  label?: string | null;
+  title: string;
+  content?: string | null;
+  short_content: string;
+  file_url?: string | null;
+  video_url?: string | null;
+  image_url?: string | null;
+  video_source?: string | null;
+  created_at?: string | null;
+  updated_at?: string | null;
+  created_by?: string | null;
+  for_user_roles?: string[] | null;
+  for_user_emails?: string[] | null;
+  author?: string | null;
+  skill_id?: string | null;
+  type?: FeedType | null;
+  comments?: CommentResponse[] | null;
+  reactions?: ReactionResponse[] | null;
+}
+
+export interface FeedUpdateDto {
+  id: string;
+  title?: string;
+  content?: string;
+  short_content?: string;
+  file_url?: string;
+  video_url?: string;
+  image_url?: string;
+  video_source?: string;
+  for_user_roles?: string[];
+  for_user_emails?: string[];
+  skill_id?: string;
+  type?: FeedType;
+}
+
+export interface ListFeedResponse {
+  data: FeedItem[];
+  meta: {
+    limit: number;
+    page: number;
+    totalItems: number;
+    totalPages: number;
+  };
+}
+
+export interface AddCommentParams {
+  value: string;
+  feed_id: string;
+  parent_id?: string | null;
+}
+
+export interface UpdateCommentParams {
+  value: string;
+  id: string;
+}
+
+export interface ListCommentsParams {
+  feed_id: string;
+  parent_id?: string;
+  limit?: string;
+  page?: string;
+  column?: 'created_at' | 'updated_at';
+  direction?: 'asc' | 'desc';
+}
+
+export interface FeedUnreadStatus {
+  read: number;
+  total: number;
+  hasUnread: boolean;
+}
+
+export interface FeedMarkReadResponse {
+  message: string;
+}
+
+export interface FeedReadHistoryRecord {
+  id?: string;
+  feed_id?: string;
+  user_id?: string;
+  idw_id?: string;
+}
+
+export interface CreateFeedResult {
+  id: string;
+}

package/src/types/files.ts

@@ -0,0 +1,9 @@
+/** Mirrors [idw-api files.dto.ts](idw-api). */
+
+export interface ParseDocumentBody {
+  url: string;
+}
+
+export interface ParseFileResponse {
+  text: string;
+}

package/src/types/idw.ts

@@ -0,0 +1,70 @@
+/** Mirrors [idw-api idw.dto.ts](idw-api) JSON shapes. */
+
+export interface IdwDto {
+  id: string;
+  accountId: string;
+  name: string;
+  slug: string;
+  isPrivate: boolean;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export interface IdwInfoDto extends IdwDto {
+  instruction?: string | null;
+  avatar?: string | null;
+  allowSignup?: boolean | null;
+  signup?: Record<string, unknown> | null;
+  welcomeScreen?: Record<string, unknown> | null;
+}
+
+export interface CreateIdwDto {
+  name: string;
+  slug?: string;
+  isPrivate?: boolean;
+  emails?: string[];
+  bots?: string[];
+  /** Template account id (env-specific in API). */
+  sourceId?: string;
+  version: string;
+  waitForActivate?: boolean;
+}
+
+export interface UpdateIdwDto {
+  name?: string;
+  slug?: string;
+  isPrivate?: boolean;
+  bots?: string[];
+  sourceId?: string;
+  udateIdwResourses?: boolean;
+  version?: string;
+  activateFlows?: boolean;
+  waitForActivate?: boolean;
+}
+
+export interface SetCoreSettingsDto {
+  name?: string;
+  instruction?: string;
+  avatar?: string | null;
+}
+
+export interface SetAccessSettingsDto {
+  isPrivate: boolean;
+}
+
+export interface SetSignUpSettingsDto {
+  allowSignup: boolean;
+  header: string;
+  description: string;
+}
+
+export interface WelcomeScreenSuggestion {
+  text: string;
+}
+
+export interface SetWelcomeScreenSettingsDto {
+  title: string;
+  description: string;
+  placeholder: string;
+  suggestions: WelcomeScreenSuggestion[];
+}

package/src/types/index.ts

@@ -1,13 +1,14 @@
-export * from './skill';
-export * from './channel';
-export * from './domain';
-export * from './config';
-export * from './common';
-export * from './flow';
-export * from './memory';
-export * from './idwInfo';
-export * from './idwRwc';
-export * from './tag';
-export * from './rwcPayload';
-export * from './idwV2';
+export * from './chat';
+export * from './datasource-selections';
+export * from './datasources';
+export * from './domains';
+export * from './feed';
+export * from './files';
+export * from './idw';
+export * from './installer';
 export * from './knowledge';
+export * from './lookup';
+export * from './reporting';
+export * from './skills';
+export * from './system';
+export * from './user';

package/src/types/installer.ts

@@ -0,0 +1,11 @@
+/** Mirrors [idw-api installer.dto.ts](idw-api). */
+
+export interface InstallSpaceDto {
+  id: string;
+  activateFlows?: boolean;
+  userRole?: string[];
+  forUsers?: string[];
+  sourceId?: string;
+  templateConfig?: Record<string, unknown>;
+  waitForActivate?: boolean;
+}

package/src/types/knowledge.ts

@@ -1,53 +1,72 @@
-// NOTE: IDW V2 functional
-export const enum KnowledgeStatusEnum {
-  NEW = 'new',
-  InReview = 'in_review',
+/** Mirrors [idw-api knowledge.dto.ts](idw-api). */
 
-  Approved = 'approved',
-  Expired = 'expired',
+export type KnowledgeStatus =
+  | 'new'
+  | 'in_review'
+  | 'approved'
+  | 'expired'
+  | 'published'
+  | 'trained';
 
-  Published = 'published',
-}
-
-type KnowledgeBase = {
+export interface KnowledgeDto {
   type: 'text' | 'doc';
   knowledge_id: string;
-
-  question_text: string; // title
-
+  question_text: string;
+  answer_text: string;
+  file_url: string;
   created_by: string;
   date_created: string;
-
-  modified_by: string | null;
-  date_modified: string | null;
-
+  modified_by: string;
+  date_modified: string;
   expired_at: string | null;
-
-  status: KnowledgeStatusEnum;
+  status: KnowledgeStatus;
   domain: string;
-};
+  author?: string | null;
+}
 
-type KnowledgeText = KnowledgeBase & {
-  type: 'text';
-  answer_text: string;
-  file_url?: null;
-};
+export type KnowledgeCreateDto = Pick<
+  KnowledgeDto,
+  'type' | 'question_text' | 'domain' | 'status' | 'expired_at'
+> &
+  Partial<Pick<KnowledgeDto, 'answer_text' | 'file_url'>>;
 
-type KnowledgeDoc = KnowledgeBase & {
-  type: 'doc';
-  answer_text?: null;
-  file_url: string;
-};
+export interface KnowledgeUpdateDto {
+  knowledge_id: string;
+  question_text?: string;
+  answer_text?: string;
+  file_url?: string;
+  domain?: string;
+  status?: KnowledgeStatus;
+  type?: 'text' | 'doc';
+  expired_at?: string | null;
+}
 
-export type Knowledge = KnowledgeText | KnowledgeDoc;
+export interface KnowledgePaginationMeta {
+  limit: number;
+  page: number;
+  totalItems: number;
+  totalPages: number;
+}
 
-export type KnowledgeCreateData = Pick<Knowledge,
-'type' |
-'file_url' |
-'question_text' |
-'answer_text' |
-'expired_at' |
-'status' |
-'domain'>;
+export interface ListKnowledgeOrder {
+  column: string;
+  direction: string;
+}
+
+/** Query params for listing knowledge (client may send strings for limit/page). */
+export interface ListKnowledgeQuery {
+  domainId?: string | null;
+  status?: KnowledgeStatus | string | null;
+  search?: string | null;
+  created_by?: string | null;
+  created_at_range?: string | null;
+  expires_in?: number | null;
+  order?: string | ListKnowledgeOrder | null;
+  limit?: number | null;
+  page?: number | null;
+}
 
-export type KnowledgeUpdateData = KnowledgeCreateData & Pick<Knowledge, 'knowledge_id'>;
+export interface ListKnowledgeResponse {
+  data: KnowledgeDto[];
+  meta: KnowledgePaginationMeta;
+}

package/src/types/lookup.ts

@@ -0,0 +1,26 @@
+/** Mirrors [idw-api lookup.dto.ts](idw-api). */
+
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonValue = JsonPrimitive | JsonValue[] | { [key: string]: JsonValue };
+
+export interface LookupPublishedDocument {
+  id: string;
+  name?: string;
+  description?: string;
+}
+
+export interface KnowledgeDocumentDto {
+  title: string;
+  content?: string;
+  fileUrl?: string;
+  id: string;
+  domain: string;
+  created_by: string;
+}
+
+export type LookupProxyMethod = 'listPassagesInDocument' | 'getDocument';
+
+export interface LookupProxyParams {
+  method: LookupProxyMethod;
+  args: JsonValue[];
+}

package/src/types/reporting.ts

@@ -0,0 +1,124 @@
+/** Mirrors [idw-api reporting.dto.ts](idw-api). */
+
+export type ReportingGranularity = 'day' | 'week' | 'month' | 'quarter';
+
+export interface FiltersQueryDto {
+  startDate: string;
+  endDate: string;
+}
+
+export interface FiltersGranularityQueryDto extends FiltersQueryDto {
+  granularity?: ReportingGranularity;
+  datasources?: string[];
+}
+
+export interface FiltersPaginationQueryDto extends FiltersQueryDto {
+  limit?: number;
+  offset?: number;
+  userIds?: string[];
+}
+
+export interface HeadlineMetricItem {
+  slug?: string | null;
+  label: string;
+  value: number;
+  domain_name?: string | null;
+  icon?: string | null;
+}
+
+export interface HeadlineMetricsResponse {
+  total_active_users: number;
+  total_sessions_created: number;
+  most_used_skills: HeadlineMetricItem[];
+  most_used_datasources: HeadlineMetricItem[];
+}
+
+export interface ListSessionsOverTimeResponse {
+  period: string;
+  sessions_count: number;
+}
+
+export interface ListMessagesOverTimeResponse {
+  period: string;
+  messages_count: number;
+}
+
+export interface ListSkillInvPerSessionsResponse {
+  bucket: string;
+  sessions_in_bucket: number;
+}
+
+export interface ListDatasourceUsagePerSessionResponse {
+  period: string;
+  datasource_slug: string;
+  datasource_name: string;
+  calls: number;
+}
+
+export interface ListSkillInvocationsOverTimeResponse {
+  period: string;
+  invocations_count: number;
+}
+
+export interface DatasourceBreakdown {
+  slug: string;
+  name: string;
+  invocations: number;
+  responses: number;
+}
+
+export interface DatasourceInvocationsVsResponsesResponse {
+  period: string;
+  invocations: number;
+  responses: number;
+  breakdown: DatasourceBreakdown[];
+}
+
+export interface ListMembersOverTimeResponse {
+  period: string;
+  members_count: number;
+}
+
+export interface UserSessionStatsItem {
+  user_id: string;
+  session_count: number;
+}
+
+export interface UserSessionStatsResponse {
+  items: UserSessionStatsItem[];
+  total: number;
+  meta: {
+    limit: number;
+    page: number;
+    totalPages: number;
+  };
+}
+
+export interface SkillPerformanceResponse {
+  shown_count: number;
+  opened_count: number;
+  unique_users: number;
+}
+
+export interface SkillUsageOverTimeResponse {
+  period: string;
+  shown_count: number;
+  opened_count: number;
+}
+
+export interface SkillUserStatsItem {
+  user_id: string;
+  opened_count: number;
+  /** ISO datetime string from JSON. */
+  last_used_at: string;
+}
+
+export interface SkillUserStatsResponse {
+  items: SkillUserStatsItem[];
+  total: number;
+  meta: {
+    limit: number;
+    page: number;
+    totalPages: number;
+  };
+}

package/src/types/skills.ts

@@ -0,0 +1,123 @@
+/** Mirrors [idw-api skills.dto.ts](idw-api). */
+
+export type SkillUserRole = 'admin' | 'user' | 'anonymous' | 'private' | 'invited';
+
+export interface SkillMetaSkill {
+  advanced?: boolean;
+  disabled?: boolean;
+  editable?: boolean;
+  action?: string;
+  prompt?: string;
+  promptParams?: string;
+  docUrl?: string;
+}
+
+export interface SkillMeta {
+  chat: { id?: string; url?: string };
+  skill: SkillMetaSkill;
+}
+
+export interface SkillTag {
+  id: string;
+  uid: string;
+  name: string;
+  description: string | null;
+  created_at?: number;
+}
+
+export interface SkillDomain {
+  id: string;
+  name: string;
+  created_at?: string;
+  abbreviation: string;
+}
+
+export interface ListSkillsResponse {
+  id: string;
+  created_at: string;
+  updated_at?: string | null;
+  slug: string;
+  name: string;
+  description: string | null;
+  url?: string;
+  domain?: string;
+  domains?: SkillDomain[];
+  image?: string;
+  tags?: SkillTag[];
+  meta: SkillMeta;
+  forRoles?: SkillUserRole[];
+  forUsers?: string[];
+}
+
+export interface SkillDependencyFile {
+  key: string;
+  isPublic: boolean;
+}
+
+export interface SkillDependencies {
+  botId: string;
+  flows: string[];
+  lookups?: string[];
+  agents?: string[];
+  files?: SkillDependencyFile[];
+}
+
+export interface CreateSkillMeta {
+  chat?: { id?: string; url?: string; web?: boolean };
+  skill?: {
+    docUrl?: string;
+    editable?: boolean;
+    inputSchema?: string;
+    outputSchema?: string;
+  };
+  dependencies?: SkillDependencies;
+  isLibrary?: boolean;
+  sourceId?: string;
+}
+
+export interface CreateSkillParams {
+  skill: {
+    name: string;
+    description: string;
+    slug?: string;
+    url?: string;
+    created_by: string;
+    forRoles?: SkillUserRole[];
+    forUsers?: string[];
+    meta?: CreateSkillMeta;
+  };
+  domain: { name: string };
+}
+
+export interface EditSkillParams {
+  skill: {
+    id: string;
+    name: string;
+    description: string;
+    url?: string;
+    forRoles?: SkillUserRole[];
+    forUsers?: string[];
+    meta?: {
+      chat?: { url?: string; web?: boolean; id?: string };
+      skill?: { docUrl?: string; inputSchema?: string; outputSchema?: string };
+    };
+  };
+  domain: { name: string };
+}
+
+export type CreateSkillResponse = CreateSkillParams['skill'] & { id: string };
+
+export interface CheckSkillAccessParams {
+  url: string;
+}
+
+export interface CheckSkillAccessUser {
+  role: string;
+  email?: string | null;
+  accountId?: string | null;
+}
+
+export interface CheckSkillAccessResponse {
+  skill: Omit<ListSkillsResponse, 'forRoles' | 'forUsers'> | null;
+  user?: CheckSkillAccessUser | null;
+}

package/src/types/system.ts

@@ -0,0 +1,17 @@
+/** Mirrors [idw-api system.dto.ts](idw-api). */
+
+export interface ApiVersionDto {
+  service: string;
+  version: string;
+  idwVersion: string;
+  deploymentTime: string;
+  git: { branch: string; commitHash: string };
+  packages: Record<string, unknown>;
+}
+
+export interface CheckProgressDto {
+  requestId: string;
+}
+
+/** Progress payload from `system/progress` (storage-backed; shape is extensible). */
+export type SystemProgressResult = Record<string, string | number | boolean | null | undefined | string[]>;