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

package/src/modules/KnowledgeApi.ts

@@ -0,0 +1,82 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import { idwScopedRoute } from '../resolveIdwId';
+import type {
+  KnowledgeCreateDto,
+  KnowledgeDto,
+  KnowledgeUpdateDto,
+  ListKnowledgeQuery,
+  ListKnowledgeResponse,
+} from '../types/knowledge';
+
+export class KnowledgeApi {
+  constructor(
+    private readonly client: IdwHttpClient,
+    private readonly idwIdOverride?: string,
+  ) {}
+
+  private base(): string {
+    return idwScopedRoute(this.client, this.idwIdOverride, 'knowledge');
+  }
+
+  listKnowledge(params?: ListKnowledgeQuery): Promise<ListKnowledgeResponse> {
+    return this.client.makeRequest<ListKnowledgeResponse>({
+      route: this.base(),
+      method: 'GET',
+      params,
+    });
+  }
+
+  listKnowledgeAuthors(params?: { domainId?: string }): Promise<ListKnowledgeResponse> {
+    return this.client.makeRequest<ListKnowledgeResponse>({
+      route: `${this.base()}/authors`,
+      method: 'GET',
+      params,
+    });
+  }
+
+  getKnowledge(knowledgeId: string): Promise<KnowledgeDto> {
+    return this.client.makeRequest<KnowledgeDto>({
+      route: `${this.base()}/${encodeURIComponent(knowledgeId)}`,
+      method: 'GET',
+    });
+  }
+
+  createKnowledge(data: KnowledgeCreateDto): Promise<KnowledgeDto> {
+    return this.client.makeRequest<KnowledgeDto>({
+      route: this.base(),
+      method: 'POST',
+      data,
+    });
+  }
+
+  enhanceTitle(content: string): Promise<KnowledgeDto> {
+    return this.client.makeRequest<KnowledgeDto>({
+      route: `${this.base()}/enhance-title`,
+      method: 'POST',
+      data: { content },
+    });
+  }
+
+  enhanceContent(content: string): Promise<KnowledgeDto> {
+    return this.client.makeRequest<KnowledgeDto>({
+      route: `${this.base()}/enhance-content`,
+      method: 'POST',
+      data: { content },
+    });
+  }
+
+  updateKnowledge(knowledgeId: string, data: KnowledgeUpdateDto): Promise<KnowledgeDto> {
+    return this.client.makeRequest<KnowledgeDto>({
+      route: `${this.base()}/${encodeURIComponent(knowledgeId)}`,
+      method: 'PUT',
+      data,
+    });
+  }
+
+  deleteKnowledge(knowledgeId: string): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: `${this.base()}/${encodeURIComponent(knowledgeId)}`,
+      method: 'DELETE',
+    });
+  }
+}

package/src/modules/LookupApi.ts

@@ -0,0 +1,47 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import { idwScopedRoute } from '../resolveIdwId';
+import type {
+  JsonValue,
+  KnowledgeDocumentDto,
+  LookupProxyParams,
+  LookupPublishedDocument,
+  QueryAccountId,
+} from '../types';
+
+export class LookupApi {
+  constructor(
+    private readonly client: IdwHttpClient,
+    private readonly idwIdOverride?: string,
+  ) {}
+
+  private base(): string {
+    return idwScopedRoute(this.client, this.idwIdOverride, 'lookup');
+  }
+
+  publish(data: KnowledgeDocumentDto): Promise<LookupPublishedDocument> {
+    return this.client.makeRequest<LookupPublishedDocument>({
+      route: this.base(),
+      method: 'POST',
+      data,
+    });
+  }
+
+  unpublish(documentId: string): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: `${this.base()}/${encodeURIComponent(documentId)}`,
+      method: 'DELETE',
+    });
+  }
+
+  proxy<TResult extends JsonValue = JsonValue>(
+    data: LookupProxyParams,
+    params?: QueryAccountId,
+  ): Promise<TResult> {
+    return this.client.makeRequest<TResult>({
+      route: `${this.base()}/proxy`,
+      method: 'POST',
+      data,
+      params,
+    });
+  }
+}

package/src/modules/ReportingApi.ts

@@ -0,0 +1,135 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import { idwScopedRoute } from '../resolveIdwId';
+import type {
+  DatasourceInvocationsVsResponsesResponse,
+  FiltersGranularityQueryDto,
+  FiltersPaginationQueryDto,
+  FiltersQueryDto,
+  HeadlineMetricsResponse,
+  ListDatasourceUsagePerSessionResponse,
+  ListMembersOverTimeResponse,
+  ListMessagesOverTimeResponse,
+  ListSessionsOverTimeResponse,
+  ListSkillInvocationsOverTimeResponse,
+  ListSkillInvPerSessionsResponse,
+  SkillPerformanceResponse,
+  SkillUsageOverTimeResponse,
+  SkillUserStatsResponse,
+  UserSessionStatsResponse,
+} from '../types/reporting';
+
+export class ReportingApi {
+  constructor(
+    private readonly client: IdwHttpClient,
+    private readonly idwIdOverride?: string,
+  ) {}
+
+  private base(): string {
+    return idwScopedRoute(this.client, this.idwIdOverride, 'reporting');
+  }
+
+  getHeadlineMetrics(params: FiltersQueryDto): Promise<HeadlineMetricsResponse> {
+    return this.client.makeRequest<HeadlineMetricsResponse>({
+      route: `${this.base()}/headline-metrics`,
+      method: 'GET',
+      params,
+    });
+  }
+
+  getSessionsOverTime(params: FiltersGranularityQueryDto): Promise<ListSessionsOverTimeResponse[]> {
+    return this.client.makeRequest<ListSessionsOverTimeResponse[]>({
+      route: `${this.base()}/sessions-over-time`,
+      method: 'GET',
+      params,
+    });
+  }
+
+  getMessagesOverTime(params: FiltersGranularityQueryDto): Promise<ListMessagesOverTimeResponse[]> {
+    return this.client.makeRequest<ListMessagesOverTimeResponse[]>({
+      route: `${this.base()}/messages-over-time`,
+      method: 'GET',
+      params,
+    });
+  }
+
+  getSkillInvocPerSession(params: FiltersQueryDto): Promise<ListSkillInvPerSessionsResponse[]> {
+    return this.client.makeRequest<ListSkillInvPerSessionsResponse[]>({
+      route: `${this.base()}/skill-invoc-per-session`,
+      method: 'GET',
+      params,
+    });
+  }
+
+  getSkillInvocationsOverTime(
+    params: FiltersGranularityQueryDto,
+  ): Promise<ListSkillInvocationsOverTimeResponse[]> {
+    return this.client.makeRequest<ListSkillInvocationsOverTimeResponse[]>({
+      route: `${this.base()}/skill-invocations-over-time`,
+      method: 'GET',
+      params,
+    });
+  }
+
+  getDatasourceUsagePerSession(
+    params: FiltersGranularityQueryDto,
+  ): Promise<ListDatasourceUsagePerSessionResponse[]> {
+    return this.client.makeRequest<ListDatasourceUsagePerSessionResponse[]>({
+      route: `${this.base()}/datasource-usage-per-session`,
+      method: 'GET',
+      params,
+    });
+  }
+
+  getDatasourceInvocationsVsResponses(
+    params: FiltersGranularityQueryDto,
+  ): Promise<DatasourceInvocationsVsResponsesResponse[]> {
+    return this.client.makeRequest<DatasourceInvocationsVsResponsesResponse[]>({
+      route: `${this.base()}/datasource-invocations-vs-responses`,
+      method: 'GET',
+      params,
+    });
+  }
+
+  getMembersOverTime(params: FiltersGranularityQueryDto): Promise<ListMembersOverTimeResponse[]> {
+    return this.client.makeRequest<ListMembersOverTimeResponse[]>({
+      route: `${this.base()}/members-over-time`,
+      method: 'GET',
+      params,
+    });
+  }
+
+  getUserSessionStats(params: FiltersPaginationQueryDto): Promise<UserSessionStatsResponse> {
+    return this.client.makeRequest<UserSessionStatsResponse>({
+      route: `${this.base()}/user-session-stats`,
+      method: 'GET',
+      params,
+    });
+  }
+
+  getSkillPerformance(skillId: string, params: FiltersQueryDto): Promise<SkillPerformanceResponse> {
+    return this.client.makeRequest<SkillPerformanceResponse>({
+      route: `${this.base()}/skill-performance/${encodeURIComponent(skillId)}`,
+      method: 'GET',
+      params,
+    });
+  }
+
+  getSkillUsageTrend(
+    skillId: string,
+    params: FiltersGranularityQueryDto,
+  ): Promise<SkillUsageOverTimeResponse[]> {
+    return this.client.makeRequest<SkillUsageOverTimeResponse[]>({
+      route: `${this.base()}/skill-usage-trend/${encodeURIComponent(skillId)}`,
+      method: 'GET',
+      params,
+    });
+  }
+
+  getSkillUserStats(skillId: string, params: FiltersPaginationQueryDto): Promise<SkillUserStatsResponse> {
+    return this.client.makeRequest<SkillUserStatsResponse>({
+      route: `${this.base()}/skill-user-stats/${encodeURIComponent(skillId)}`,
+      method: 'GET',
+      params,
+    });
+  }
+}

package/src/modules/SkillsApi.ts

@@ -0,0 +1,71 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import { idwScopedRoute, resolveIdwId } from '../resolveIdwId';
+import type {
+  CheckSkillAccessParams,
+  CheckSkillAccessResponse,
+  CreateSkillParams,
+  CreateSkillResponse,
+  EditSkillParams,
+  ListSkillsResponse,
+} from '../types/skills';
+
+export class SkillsApi {
+  constructor(
+    private readonly client: IdwHttpClient,
+    private readonly idwIdOverride?: string,
+  ) {}
+
+  private base(): string {
+    return idwScopedRoute(this.client, this.idwIdOverride, 'skills');
+  }
+
+  listSkills(): Promise<ListSkillsResponse[]> {
+    return this.client.makeRequest<ListSkillsResponse[]>({
+      route: this.base(),
+      method: 'GET',
+    });
+  }
+
+  listSkillsForAdmin(): Promise<ListSkillsResponse[]> {
+    const id = resolveIdwId(this.client, this.idwIdOverride);
+    return this.client.makeRequest<ListSkillsResponse[]>({
+      route: `idw/${encodeURIComponent(id)}/admin/skills`,
+      method: 'GET',
+    });
+  }
+
+  createSkill(data: CreateSkillParams): Promise<CreateSkillResponse> {
+    return this.client.makeRequest<CreateSkillResponse>({
+      route: this.base(),
+      method: 'POST',
+      data,
+    });
+  }
+
+  editSkill(skillId: string, data: EditSkillParams): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: `${this.base()}/${encodeURIComponent(skillId)}`,
+      method: 'PATCH',
+      data,
+    });
+  }
+
+  deleteSkill(skillId: string): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: `${this.base()}/${encodeURIComponent(skillId)}`,
+      method: 'DELETE',
+    });
+  }
+
+  checkSkillAccess(
+    data: CheckSkillAccessParams,
+    customHeaders?: Record<string, string>,
+  ): Promise<CheckSkillAccessResponse> {
+    return this.client.makeRequest<CheckSkillAccessResponse>({
+      route: `${this.base()}/access`,
+      method: 'POST',
+      data,
+      customHeaders,
+    });
+  }
+}

package/src/modules/SystemApi.ts

@@ -0,0 +1,28 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import type { ApiVersionDto, CheckProgressDto, SystemProgressResult } from '../types/system';
+
+export class SystemApi {
+  constructor(private readonly client: IdwHttpClient) {}
+
+  getVersion(): Promise<ApiVersionDto> {
+    return this.client.makeRequest<ApiVersionDto>({
+      route: 'system/version',
+      method: 'GET',
+    });
+  }
+
+  syncGraph(idwId: string): Promise<void> {
+    return this.client.makeRequest<void>({
+      route: `system/sync-graph/${encodeURIComponent(idwId)}`,
+      method: 'POST',
+    });
+  }
+
+  checkProgress(params: CheckProgressDto): Promise<SystemProgressResult> {
+    return this.client.makeRequest<SystemProgressResult>({
+      route: 'system/progress',
+      method: 'GET',
+      params,
+    });
+  }
+}

package/src/modules/UserInfoApi.ts

@@ -0,0 +1,13 @@
+import type { IdwHttpClient } from '../IdwHttpClient';
+import type { UserInfoDto } from '../types/user';
+
+export class UserInfoApi {
+  constructor(private readonly client: IdwHttpClient) {}
+
+  getUserInfo(): Promise<UserInfoDto> {
+    return this.client.makeRequest<UserInfoDto>({
+      route: 'user/info',
+      method: 'GET',
+    });
+  }
+}

package/src/resolveIdwId.ts

@@ -0,0 +1,16 @@
+import type { IdwHttpClient } from './IdwHttpClient';
+
+export function resolveIdwId(client: IdwHttpClient, idwIdOverride?: string): string {
+  const id = idwIdOverride ?? client.idwId;
+  if (id == null || id === '') {
+    throw new Error(
+      'idwId is required for this request. Set `idwId` on IdwClient config or pass it as the second argument when constructing the API class.',
+    );
+  }
+  return id;
+}
+
+export function idwScopedRoute(client: IdwHttpClient, idwIdOverride: string | undefined, suffix: string): string {
+  const id = resolveIdwId(client, idwIdOverride);
+  return `idw/${encodeURIComponent(id)}/${suffix}`;
+}

package/src/schemas/constructor.ts

@@ -0,0 +1,25 @@
+import type { Token } from '@or-sdk/base';
+import { z } from 'zod';
+
+const authTokenSchema = z.string().min(1, { message: 'Token is required' });
+
+export const idwConfigSchema = z
+  .object({
+    token: z.union([
+      authTokenSchema,
+      z.function().args().returns(authTokenSchema),
+    ]) satisfies z.ZodType<Token>,
+    discoveryUrl: z.string().url().optional(),
+    accountId: z.string().uuid().optional(),
+    idwApiUrl: z.string().url().optional(),
+    /** Optional OR identity token (sent as `ortoken` header when set). */
+    ortoken: z.string().optional(),
+    /** ID or slug for routes under `idw/:idwId/...`. Optional if you only call global routes. */
+    idwId: z.string().min(1).optional(),
+  })
+  .strict()
+  .refine((data) => data.discoveryUrl || data.idwApiUrl, {
+    message: 'Either "discoveryUrl" or "idwApiUrl" is required.',
+  });
+
+export type IdwConfig = z.infer<typeof idwConfigSchema>;

package/src/schemas/index.ts

@@ -0,0 +1 @@
+export { idwConfigSchema, type IdwConfig } from './constructor';

package/src/types/chat.ts

@@ -0,0 +1,122 @@
+/** Mirrors [idw-api chat.dto.ts](idw-api). */
+
+export interface ChatMetaDto {
+  models: {
+    isMultiModel?: boolean;
+    models: string[];
+  };
+}
+
+export interface ChatSkillDto {
+  id: string;
+  hitl_id: string;
+  skill_id: string;
+  title: string;
+  created_at: string;
+  updated_at?: string;
+}
+
+export interface CreateChatSkillDto {
+  hitl_id: string;
+  skill_id: string;
+  title: string;
+  created_at?: string;
+  updated_at?: string;
+}
+
+export interface ChatCreateDto {
+  id?: string;
+  title: string;
+  hitl_id?: string;
+  metadata: ChatMetaDto;
+  created_at?: string;
+}
+
+export type ChatStatus = 'active' | 'archived';
+
+export interface ChatDto {
+  id: string;
+  idw_id: string;
+  user_id: string;
+  hitl_id?: string;
+  created_at: string;
+  updated_at?: string | null;
+  title: string;
+  status: ChatStatus;
+  metadata: ChatMetaDto;
+  skills?: ChatSkillDto[];
+}
+
+export interface ChatPatchDto {
+  title?: string;
+  hitl_id?: string;
+  updated_at?: string;
+  status?: ChatStatus;
+}
+
+export interface ChatModelsPatchDto {
+  isMultiModel?: boolean;
+  models: string[];
+}
+
+export interface ChatFileDto {
+  chat_id: string;
+  message_id: string;
+  filename: string;
+  mime_type: string;
+  size_bytes: number;
+  url: string;
+  created_at: string;
+}
+
+export interface ChatMessageFunctionCall {
+  id: string;
+  call_id: string;
+  name: string;
+  arguments: string;
+}
+
+export interface ChatMessageMetadata {
+  response_id?: string;
+  functionCalls?: ChatMessageFunctionCall[];
+  sourceResults?: Record<
+    string,
+    {
+      content?: string;
+      data?: unknown[];
+    }
+  >;
+  is_llm_only?: boolean;
+  aborted?: boolean;
+  skill_name?: string;
+  skill_params?: Record<string, unknown>;
+  skill_result?: Record<string, unknown>;
+  message_type?: 'skill-start' | 'skill-result';
+}
+
+export interface ChatMessageDto {
+  id: string;
+  chat_id: string;
+  role: 'user' | 'assistant' | 'system';
+  content: string;
+  files?: ChatFileDto[];
+  metadata?: ChatMessageMetadata;
+  parent_message_id?: string;
+  created_at: string;
+  updated_at?: string | null;
+}
+
+export interface ChatsListQueryDto {
+  limit?: number;
+  offset?: number;
+  search?: string | null;
+}
+
+export interface ChatsListPaginationDto {
+  limit: number;
+  offset: number;
+  page: number;
+  total_count: number;
+  total_pages: number;
+  has_more: boolean;
+}

package/src/types/datasource-selections.ts

@@ -0,0 +1,11 @@
+/** Mirrors [idw-api datasource-selection.dto.ts](idw-api). */
+
+export interface DatasourceSelectionResponse {
+  isMultiModel: boolean;
+  models: string[];
+}
+
+export interface DatasourceSelectionDto {
+  isMultiModel?: boolean;
+  models: string[];
+}

package/src/types/datasources.ts

@@ -0,0 +1,54 @@
+/** Mirrors [idw-api datasource.dto.ts](idw-api). */
+
+import type { SkillUserRole } from './skills';
+
+export interface DatasourceDto {
+  id: string;
+  name: string;
+  slug: string;
+  description?: string | null;
+  mcp_url?: string | '' | null;
+  icon: string;
+  config?: Record<string, unknown> | null;
+  is_default?: boolean | null;
+  enabled: boolean;
+  for_user_roles?: SkillUserRole[] | null;
+  for_user_emails?: string[] | null;
+  is_llm?: boolean | null;
+  search_order?: number | null;
+  display_order?: number | null;
+  created_by?: string | null;
+  updated_by?: string | null;
+  created_at?: string | null;
+  updated_at?: string | null;
+}
+
+export type CreateDatasourceDto = Pick<
+  DatasourceDto,
+  | 'name'
+  | 'description'
+  | 'mcp_url'
+  | 'config'
+  | 'is_default'
+  | 'for_user_roles'
+  | 'for_user_emails'
+  | 'search_order'
+  | 'display_order'
+  | 'is_llm'
+  | 'icon'
+> & { slug?: string };
+
+export type UpdateDatasourceDto = Partial<
+  Omit<DatasourceDto, 'id' | 'created_by' | 'updated_by' | 'created_at' | 'updated_at'>
+>;
+
+export interface UpdateDatasourceStatusDto {
+  enabled?: boolean;
+}
+
+/** Query filters for listing datasources (sent as query params). */
+export interface FilterDatasourcesDto {
+  enabled?: boolean;
+  is_llm?: boolean;
+  is_default?: boolean;
+}

package/src/types/domains.ts

@@ -0,0 +1,49 @@
+/** Mirrors [idw-api domains.dto.ts](idw-api). */
+
+export interface DomainResponse {
+  id: string;
+  createdAt: string;
+  updatedAt: string;
+  name: string;
+  slug: string;
+  abbreviation: string;
+  image: string;
+}
+
+export interface DomainListResponse {
+  data: DomainResponse[];
+}
+
+export interface DomainWithCountDto extends DomainResponse {
+  items_count: number;
+}
+
+export interface DomainWithCountListResponse {
+  data: DomainWithCountDto[];
+}
+
+export interface CreateDomainParams {
+  domain: { name: string; image: string };
+  skills?: string[];
+}
+
+export interface CreateDomainResponse {
+  id: string;
+  created_at: string;
+  updated_at: string;
+  name: string;
+  slug: string;
+  abbreviation: string;
+  image: string;
+}
+
+/** Single domain as returned by `GET :id` (legacy shape). */
+export interface DomainDto {
+  id: string;
+  created_at: string;
+  updated_at: string;
+  name: string;
+  slug: string;
+  abbreviation: string;
+  image?: string | null;
+}