@liveblocks/node 3.4.2 → 3.5.1

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { BaseUserMeta, DU, LiveObject, Awaitable, DS, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, UserSubscriptionData, CommentData, CommentBody, SubscriptionData, Patchable, CommentUserReaction, InboxNotificationData, UserRoomSubscriptionSettings, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DM, NotificationChannel } from '@liveblocks/core';
+import { BaseUserMeta, DU, LiveObject, Awaitable, DS, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, UserSubscriptionData, CommentData, CommentBody, SubscriptionData, Patchable, CommentUserReaction, InboxNotificationData, UserRoomSubscriptionSettings, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, LsonObject, ToImmutable, PartialUnless, BaseMetadata, Json, DE, DM, NotificationChannel } from '@liveblocks/core';
 export { CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, LiveList, LiveMap, LiveObject, LiveStructure, Lson, LsonObject, PlainLsonObject, ResolveUsersArgs, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionsFromCommentBody, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
@@ -120,6 +120,36 @@ type RoomData = {
     groupsAccesses: RoomAccesses;
     metadata: RoomMetadata;
 };
+type AiCopilot = {
+    type: "copilot";
+    id: string;
+    name: string;
+    systemPrompt: string;
+    knowledgePrompt?: string;
+    description?: string;
+    createdAt: Date;
+    updatedAt: Date;
+    lastUsedAt?: Date;
+    providerModel: string;
+    providerOptions?: Record<string, Record<string, string | Json>>;
+    settings?: {
+        maxTokens?: number;
+        temperature?: number;
+        topP?: number;
+        topK?: number;
+        frequencyPenalty?: number;
+        presencePenalty?: number;
+        stopSequences?: string[];
+        seed?: number;
+        maxRetries?: number;
+    };
+} & ({
+    provider: "openai" | "anthropic" | "google";
+} | {
+    provider: "openai-compatible";
+    compatibleProviderName: string;
+    providerBaseUrl: string;
+});
 type RoomUser<U extends BaseUserMeta = DU> = {
     type: "user";
     id: string | null;
@@ -237,6 +267,97 @@ type UpsertRoomOptions = {
     update: UpdateRoomOptions;
     create?: CreateRoomOptions;
 };
+type ProviderSettings = {
+    maxTokens?: number;
+    temperature?: number;
+    topP?: number;
+    topK?: number;
+    frequencyPenalty?: number;
+    presencePenalty?: number;
+    stopSequences?: string[];
+    seed?: number;
+    maxRetries?: number;
+};
+type CreateAiCopilotOptions = {
+    name: string;
+    providerApiKey: string;
+    providerModel: string;
+    description?: string;
+    systemPrompt: string;
+    knowledgePrompt?: string;
+    providerOptions?: Record<string, Record<string, string | Json>>;
+    settings?: ProviderSettings;
+} & ({
+    provider: "openai" | "anthropic" | "google";
+} | {
+    provider: "openai-compatible";
+    compatibleProviderName: string;
+    providerBaseUrl: string;
+});
+type UpdateAiCopilotOptions = {
+    name?: string;
+    providerApiKey?: string;
+    providerModel?: string;
+    description?: string | null;
+    systemPrompt?: string;
+    knowledgePrompt?: string | null;
+    providerOptions?: Record<string, Record<string, string | Json>> | null;
+    settings?: ProviderSettings | null;
+} & ({
+    provider?: "openai" | "anthropic" | "google";
+    compatibleProviderName?: null;
+    providerBaseUrl?: null;
+} | {
+    provider?: "openai-compatible";
+    compatibleProviderName?: string;
+    providerBaseUrl?: string;
+});
+type CreateWebKnowledgeSourceOptions = {
+    copilotId: string;
+    url: string;
+    type: "individual_link" | "crawl" | "sitemap";
+};
+type CreateFileKnowledgeSourceOptions = {
+    copilotId: string;
+    file: File;
+};
+type GetKnowledgeSourcesOptions = {
+    copilotId: string;
+} & PaginationOptions;
+type GetWebKnowledgeSourceLinksOptions = {
+    copilotId: string;
+    knowledgeSourceId: string;
+} & PaginationOptions;
+type KnowledgeSource = ({
+    type: "ai-knowledge-web-source";
+    link: {
+        url: string;
+        type: "individual_link" | "crawl" | "sitemap";
+    };
+} | {
+    type: "ai-knowledge-file-source";
+    file: {
+        name: string;
+        mimeType: string;
+    };
+}) & {
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    lastIndexedAt: Date;
+} & ({
+    status: "ingesting" | "ready";
+} | {
+    status: "error";
+    errorMessage: string;
+});
+type WebKnowledgeSourceLink = {
+    id: string;
+    url: string;
+    status: "ingesting" | "ready" | "error";
+    createdAt: Date;
+    lastIndexedAt: Date;
+};
 type RequestOptions = {
     signal?: AbortSignal;
 };
@@ -982,6 +1103,122 @@ declare class Liveblocks {
      * `concurrency` to 1.
      */
     massMutateStorage(criteria: RoomsQueryCriteria, callback: MassMutateStorageCallback, massOptions?: MassMutateStorageOptions): Promise<void>;
+    /**
+     * Returns a paginated list of AI copilots. The copilots are returned sorted by creation date, from newest to oldest.
+     * @param params.limit (optional) A limit on the number of copilots to return. The limit can range between 1 and 100, and defaults to 20.
+     * @param params.startingAfter (optional) A cursor used for pagination. You get the value from the response of the previous page.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns A paginated list of AI copilots.
+     */
+    getAiCopilots(params?: PaginationOptions, options?: RequestOptions): Promise<Page<AiCopilot>>;
+    /**
+     * Creates an AI copilot.
+     * @param params The parameters to create the copilot with.
+     * @returns The created copilot.
+     */
+    createAiCopilot(params: CreateAiCopilotOptions, options?: RequestOptions): Promise<AiCopilot>;
+    /**
+     * Returns an AI copilot with the given id.
+     * @param copilotId The id of the copilot to return.
+     * @returns The copilot with the given id.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    getAiCopilot(copilotId: string, options?: RequestOptions): Promise<AiCopilot>;
+    /**
+     * Updates an AI copilot with the given id.
+     * @param copilotId The id of the copilot to update.
+     * @param params The parameters to update the copilot with.
+     * @returns The updated copilot.
+     */
+    updateAiCopilot(copilotId: string, params: UpdateAiCopilotOptions, options?: RequestOptions): Promise<AiCopilot>;
+    /**
+     * Deletes an AI copilot with the given id. A deleted copilot is no longer accessible from the API or the dashboard and it cannot be restored.
+     * @param copilotId The id of the copilot to delete.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    deleteAiCopilot(copilotId: string, options?: RequestOptions): Promise<void>;
+    /**
+     * Creates a web knowledge source.
+     * @param params.url The URL of the web knowledge source.
+     * @param params.type The type of the web knowledge source: "individual_link", "crawl" or "sitemap".
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns The id of the created web knowledge source.
+     */
+    createWebKnowledgeSource(params: CreateWebKnowledgeSourceOptions, options?: RequestOptions): Promise<{
+        id: string;
+    }>;
+    /**
+     * Creates a file knowledge source.
+     * @param params.copilotId The id of the copilot.
+     * @param params.name The name of the file knowledge source.
+     * @param params.file The file to create the knowledge source from.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns The id of the created file knowledge source.
+     */
+    createFileKnowledgeSource(params: CreateFileKnowledgeSourceOptions, options?: RequestOptions): Promise<{
+        id: string;
+    }>;
+    /**
+     * Deletes a file knowledge source.
+     * @param params.copilotId The id of the copilot.
+     * @param params.knowledgeSourceId The id of the knowledge source to delete.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    deleteFileKnowledgeSource(params: {
+        copilotId: string;
+        knowledgeSourceId: string;
+    }, options?: RequestOptions): Promise<void>;
+    /**
+     * Deletes a web knowledge source.
+     * @param params.copilotId The id of the copilot.
+     * @param params.knowledgeSourceId The id of the knowledge source to delete.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    deleteWebKnowledgeSource(params: {
+        copilotId: string;
+        knowledgeSourceId: string;
+    }, options?: RequestOptions): Promise<void>;
+    /**
+     * Returns a paginated list of knowledge sources.
+     * @param params.copilotId The id of the copilot.
+     * @param params.limit (optional) A limit on the number of knowledge sources to return. The limit can range between 1 and 100, and defaults to 20.
+     * @param params.startingAfter (optional) A cursor used for pagination. You get the value from the response of the previous page.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns A paginated list of knowledge sources.
+     */
+    getKnowledgeSources(params: GetKnowledgeSourcesOptions, options?: RequestOptions): Promise<Page<KnowledgeSource>>;
+    /**
+     * Returns a knowledge source with the given id.
+     * @param params.copilotId The id of the copilot.
+     * @param params.knowledgeSourceId The id of the knowledge source to return.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns The knowledge source.
+     */
+    getKnowledgeSource(params: {
+        copilotId: string;
+        knowledgeSourceId: string;
+    }, options?: RequestOptions): Promise<KnowledgeSource>;
+    /**
+     * Returns the content of a file knowledge source.
+     * @param params.copilotId The id of the copilot.
+     * @param params.knowledgeSourceId The id of the knowledge source.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns The content of the file knowledge source.
+     */
+    getFileKnowledgeSourceMarkdown(params: {
+        copilotId: string;
+        knowledgeSourceId: string;
+    }, options?: RequestOptions): Promise<string>;
+    /**
+     * Returns a paginated list of web knowledge source links.
+     * @param params.copilotId The id of the copilot.
+     * @param params.knowledgeSourceId The id of the knowledge source.
+     * @param params.limit (optional) A limit on the number of links to return. The limit can range between 1 and 100, and defaults to 20.
+     * @param params.startingAfter (optional) A cursor used for pagination. You get the value from the response of the previous page.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns A paginated list of web knowledge source links.
+     */
+    getWebKnowledgeSourceLinks(params: GetWebKnowledgeSourceLinksOptions, options?: RequestOptions): Promise<Page<WebKnowledgeSourceLink>>;
 }
 declare class LiveblocksError extends Error {
     readonly status: number;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { BaseUserMeta, DU, LiveObject, Awaitable, DS, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, UserSubscriptionData, CommentData, CommentBody, SubscriptionData, Patchable, CommentUserReaction, InboxNotificationData, UserRoomSubscriptionSettings, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DM, NotificationChannel } from '@liveblocks/core';
+import { BaseUserMeta, DU, LiveObject, Awaitable, DS, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, UserSubscriptionData, CommentData, CommentBody, SubscriptionData, Patchable, CommentUserReaction, InboxNotificationData, UserRoomSubscriptionSettings, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, LsonObject, ToImmutable, PartialUnless, BaseMetadata, Json, DE, DM, NotificationChannel } from '@liveblocks/core';
 export { CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, LiveList, LiveMap, LiveObject, LiveStructure, Lson, LsonObject, PlainLsonObject, ResolveUsersArgs, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionsFromCommentBody, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
@@ -120,6 +120,36 @@ type RoomData = {
     groupsAccesses: RoomAccesses;
     metadata: RoomMetadata;
 };
+type AiCopilot = {
+    type: "copilot";
+    id: string;
+    name: string;
+    systemPrompt: string;
+    knowledgePrompt?: string;
+    description?: string;
+    createdAt: Date;
+    updatedAt: Date;
+    lastUsedAt?: Date;
+    providerModel: string;
+    providerOptions?: Record<string, Record<string, string | Json>>;
+    settings?: {
+        maxTokens?: number;
+        temperature?: number;
+        topP?: number;
+        topK?: number;
+        frequencyPenalty?: number;
+        presencePenalty?: number;
+        stopSequences?: string[];
+        seed?: number;
+        maxRetries?: number;
+    };
+} & ({
+    provider: "openai" | "anthropic" | "google";
+} | {
+    provider: "openai-compatible";
+    compatibleProviderName: string;
+    providerBaseUrl: string;
+});
 type RoomUser<U extends BaseUserMeta = DU> = {
     type: "user";
     id: string | null;
@@ -237,6 +267,97 @@ type UpsertRoomOptions = {
     update: UpdateRoomOptions;
     create?: CreateRoomOptions;
 };
+type ProviderSettings = {
+    maxTokens?: number;
+    temperature?: number;
+    topP?: number;
+    topK?: number;
+    frequencyPenalty?: number;
+    presencePenalty?: number;
+    stopSequences?: string[];
+    seed?: number;
+    maxRetries?: number;
+};
+type CreateAiCopilotOptions = {
+    name: string;
+    providerApiKey: string;
+    providerModel: string;
+    description?: string;
+    systemPrompt: string;
+    knowledgePrompt?: string;
+    providerOptions?: Record<string, Record<string, string | Json>>;
+    settings?: ProviderSettings;
+} & ({
+    provider: "openai" | "anthropic" | "google";
+} | {
+    provider: "openai-compatible";
+    compatibleProviderName: string;
+    providerBaseUrl: string;
+});
+type UpdateAiCopilotOptions = {
+    name?: string;
+    providerApiKey?: string;
+    providerModel?: string;
+    description?: string | null;
+    systemPrompt?: string;
+    knowledgePrompt?: string | null;
+    providerOptions?: Record<string, Record<string, string | Json>> | null;
+    settings?: ProviderSettings | null;
+} & ({
+    provider?: "openai" | "anthropic" | "google";
+    compatibleProviderName?: null;
+    providerBaseUrl?: null;
+} | {
+    provider?: "openai-compatible";
+    compatibleProviderName?: string;
+    providerBaseUrl?: string;
+});
+type CreateWebKnowledgeSourceOptions = {
+    copilotId: string;
+    url: string;
+    type: "individual_link" | "crawl" | "sitemap";
+};
+type CreateFileKnowledgeSourceOptions = {
+    copilotId: string;
+    file: File;
+};
+type GetKnowledgeSourcesOptions = {
+    copilotId: string;
+} & PaginationOptions;
+type GetWebKnowledgeSourceLinksOptions = {
+    copilotId: string;
+    knowledgeSourceId: string;
+} & PaginationOptions;
+type KnowledgeSource = ({
+    type: "ai-knowledge-web-source";
+    link: {
+        url: string;
+        type: "individual_link" | "crawl" | "sitemap";
+    };
+} | {
+    type: "ai-knowledge-file-source";
+    file: {
+        name: string;
+        mimeType: string;
+    };
+}) & {
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    lastIndexedAt: Date;
+} & ({
+    status: "ingesting" | "ready";
+} | {
+    status: "error";
+    errorMessage: string;
+});
+type WebKnowledgeSourceLink = {
+    id: string;
+    url: string;
+    status: "ingesting" | "ready" | "error";
+    createdAt: Date;
+    lastIndexedAt: Date;
+};
 type RequestOptions = {
     signal?: AbortSignal;
 };
@@ -982,6 +1103,122 @@ declare class Liveblocks {
      * `concurrency` to 1.
      */
     massMutateStorage(criteria: RoomsQueryCriteria, callback: MassMutateStorageCallback, massOptions?: MassMutateStorageOptions): Promise<void>;
+    /**
+     * Returns a paginated list of AI copilots. The copilots are returned sorted by creation date, from newest to oldest.
+     * @param params.limit (optional) A limit on the number of copilots to return. The limit can range between 1 and 100, and defaults to 20.
+     * @param params.startingAfter (optional) A cursor used for pagination. You get the value from the response of the previous page.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns A paginated list of AI copilots.
+     */
+    getAiCopilots(params?: PaginationOptions, options?: RequestOptions): Promise<Page<AiCopilot>>;
+    /**
+     * Creates an AI copilot.
+     * @param params The parameters to create the copilot with.
+     * @returns The created copilot.
+     */
+    createAiCopilot(params: CreateAiCopilotOptions, options?: RequestOptions): Promise<AiCopilot>;
+    /**
+     * Returns an AI copilot with the given id.
+     * @param copilotId The id of the copilot to return.
+     * @returns The copilot with the given id.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    getAiCopilot(copilotId: string, options?: RequestOptions): Promise<AiCopilot>;
+    /**
+     * Updates an AI copilot with the given id.
+     * @param copilotId The id of the copilot to update.
+     * @param params The parameters to update the copilot with.
+     * @returns The updated copilot.
+     */
+    updateAiCopilot(copilotId: string, params: UpdateAiCopilotOptions, options?: RequestOptions): Promise<AiCopilot>;
+    /**
+     * Deletes an AI copilot with the given id. A deleted copilot is no longer accessible from the API or the dashboard and it cannot be restored.
+     * @param copilotId The id of the copilot to delete.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    deleteAiCopilot(copilotId: string, options?: RequestOptions): Promise<void>;
+    /**
+     * Creates a web knowledge source.
+     * @param params.url The URL of the web knowledge source.
+     * @param params.type The type of the web knowledge source: "individual_link", "crawl" or "sitemap".
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns The id of the created web knowledge source.
+     */
+    createWebKnowledgeSource(params: CreateWebKnowledgeSourceOptions, options?: RequestOptions): Promise<{
+        id: string;
+    }>;
+    /**
+     * Creates a file knowledge source.
+     * @param params.copilotId The id of the copilot.
+     * @param params.name The name of the file knowledge source.
+     * @param params.file The file to create the knowledge source from.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns The id of the created file knowledge source.
+     */
+    createFileKnowledgeSource(params: CreateFileKnowledgeSourceOptions, options?: RequestOptions): Promise<{
+        id: string;
+    }>;
+    /**
+     * Deletes a file knowledge source.
+     * @param params.copilotId The id of the copilot.
+     * @param params.knowledgeSourceId The id of the knowledge source to delete.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    deleteFileKnowledgeSource(params: {
+        copilotId: string;
+        knowledgeSourceId: string;
+    }, options?: RequestOptions): Promise<void>;
+    /**
+     * Deletes a web knowledge source.
+     * @param params.copilotId The id of the copilot.
+     * @param params.knowledgeSourceId The id of the knowledge source to delete.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    deleteWebKnowledgeSource(params: {
+        copilotId: string;
+        knowledgeSourceId: string;
+    }, options?: RequestOptions): Promise<void>;
+    /**
+     * Returns a paginated list of knowledge sources.
+     * @param params.copilotId The id of the copilot.
+     * @param params.limit (optional) A limit on the number of knowledge sources to return. The limit can range between 1 and 100, and defaults to 20.
+     * @param params.startingAfter (optional) A cursor used for pagination. You get the value from the response of the previous page.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns A paginated list of knowledge sources.
+     */
+    getKnowledgeSources(params: GetKnowledgeSourcesOptions, options?: RequestOptions): Promise<Page<KnowledgeSource>>;
+    /**
+     * Returns a knowledge source with the given id.
+     * @param params.copilotId The id of the copilot.
+     * @param params.knowledgeSourceId The id of the knowledge source to return.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns The knowledge source.
+     */
+    getKnowledgeSource(params: {
+        copilotId: string;
+        knowledgeSourceId: string;
+    }, options?: RequestOptions): Promise<KnowledgeSource>;
+    /**
+     * Returns the content of a file knowledge source.
+     * @param params.copilotId The id of the copilot.
+     * @param params.knowledgeSourceId The id of the knowledge source.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns The content of the file knowledge source.
+     */
+    getFileKnowledgeSourceMarkdown(params: {
+        copilotId: string;
+        knowledgeSourceId: string;
+    }, options?: RequestOptions): Promise<string>;
+    /**
+     * Returns a paginated list of web knowledge source links.
+     * @param params.copilotId The id of the copilot.
+     * @param params.knowledgeSourceId The id of the knowledge source.
+     * @param params.limit (optional) A limit on the number of links to return. The limit can range between 1 and 100, and defaults to 20.
+     * @param params.startingAfter (optional) A cursor used for pagination. You get the value from the response of the previous page.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns A paginated list of web knowledge source links.
+     */
+    getWebKnowledgeSourceLinks(params: GetWebKnowledgeSourceLinksOptions, options?: RequestOptions): Promise<Page<WebKnowledgeSourceLink>>;
 }
 declare class LiveblocksError extends Error {
     readonly status: number;