@veltdev/sdk-dev 5.0.2-beta.43 → 5.0.2-beta.44

package/app/models/data/rewriter-events.data.model.d.ts

@@ -0,0 +1,40 @@
+import { TargetTextRange } from './target-text-range.data.model';
+import { RewriterEventTypes } from '../../utils/enums';
+export interface TextSelectedEvent {
+    selectionId: string;
+    text: string;
+    targetTextRange: TargetTextRange;
+}
+export interface RewriterAskAiRequest {
+    model: string;
+    prompt: string;
+    selectedText: string;
+}
+export interface RewriterReplaceTextRequest {
+    text: string;
+    event: TextSelectedEvent;
+}
+export interface RewriterAddCommentRequest {
+    text: string;
+    event: TextSelectedEvent;
+}
+export interface RewriterAskAiResponse {
+    text: string;
+    success: boolean;
+    error?: string;
+}
+export interface RewriterReplaceTextResponse {
+    success: boolean;
+    originalText: string;
+    replacedText: string;
+    error?: string;
+}
+export interface RewriterAddCommentResponse {
+    success: boolean;
+    annotationId?: string;
+    commentText?: string;
+    error?: string;
+}
+export type RewriterEventTypesMap = {
+    [RewriterEventTypes.TEXT_SELECTED]: TextSelectedEvent;
+};

package/app/models/element/rewriter-element.model.d.ts

@@ -1,23 +1,55 @@
 // @ts-nocheck
+import { Observable } from "rxjs";
+import { RewriterAskAiRequest, RewriterAskAiResponse, RewriterReplaceTextRequest, RewriterReplaceTextResponse, RewriterAddCommentRequest, RewriterAddCommentResponse, RewriterEventTypesMap } from "../data/rewriter-events.data.model";
 export declare class RewriterElement {
-  /**
-   * To enable rewriter feature
-   */
-  enableRewriter: () => void;
-
-  /**
-   * To disable rewriter feature
-   */
-  disableRewriter: () => void;
-  constructor();
-
-  /**
-   * To enable rewriter feature
-   */
-  private _enableRewriter;
-
-  /**
-   * To disable rewriter feature
-   */
-  private _disableRewriter;
+    /**
+     * To enable rewriter feature
+     */
+    enableRewriter: () => void;
+    /**
+     * To disable rewriter feature
+     */
+    disableRewriter: () => void;
+    /**
+     * Subscribe to rewriter events
+     */
+    on: <T extends keyof RewriterEventTypesMap>(action: T) => Observable<RewriterEventTypesMap[T]>;
+    /**
+     * Call AI with the currently selected text
+     */
+    askAi: (request: RewriterAskAiRequest) => Promise<RewriterAskAiResponse>;
+    /**
+     * Replace the selected text in the DOM with the given text
+     */
+    replaceText: (request: RewriterReplaceTextRequest) => Promise<RewriterReplaceTextResponse>;
+    /**
+     * Add a comment annotation on the selected text with the given text as comment body
+     */
+    addComment: (request: RewriterAddCommentRequest) => Promise<RewriterAddCommentResponse>;
+    constructor();
+    /**
+     * To enable rewriter feature
+     */
+    private _enableRewriter;
+    /**
+     * To disable rewriter feature
+     */
+    private _disableRewriter;
+    /**
+     * Subscribe to rewriter events
+     */
+    private _on;
+    /**
+     * Call AI with the selected text
+     */
+    private _askAi;
+    /**
+     * Replace the selected text in the DOM with the given text
+     */
+    private _replaceText;
+    /**
+     * Add a comment annotation on the selected text with the given text as comment body
+     */
+    private _addComment;
 }
+

package/app/utils/enums.d.ts

@@ -88,6 +88,9 @@ export declare const RecorderEventTypes: {
     readonly RECORDING_STOPPED: "recordingStopped";
     readonly RECORDING_DONE_LOCAL: "recordingDoneLocal";
 };
+export declare const RewriterEventTypes: {
+    readonly TEXT_SELECTED: "textSelected";
+};
 export declare const CoreEventTypes: {
     readonly PERMISSION_PROVIDER: "permissionProvider";
     readonly USER_RESOLVER: "userResolver";
@@ -128,6 +131,7 @@ export type CoreEventType = typeof CoreEventTypes[keyof typeof CoreEventTypes];
 export type LiveStateSyncEventType = typeof LiveStateSyncEventTypes[keyof typeof LiveStateSyncEventTypes];
 export type PresenceEventType = typeof PresenceEventTypes[keyof typeof PresenceEventTypes];
 export type NotificationEventType = typeof NotificationEventTypes[keyof typeof NotificationEventTypes];
+export type RewriterEventType = typeof RewriterEventTypes[keyof typeof RewriterEventTypes];
 export type CrdtEventType = typeof CrdtEventTypes[keyof typeof CrdtEventTypes];
 export declare enum TagStatus {
     ADDED = "added",

package/models.d.ts

@@ -49,6 +49,7 @@ export * from './app/models/data/recorder.model';
 export * from './app/models/data/recorder-annotation.data.model';
 export * from './app/models/data/recorder-events.data.model';
 export * from './app/models/data/rewriter-annotation.data.model';
+export * from './app/models/data/rewriter-events.data.model';
 export * from './app/models/data/screen-size.data.model';
 export * from './app/models/data/screenshot.data.model';
 export * from './app/models/data/selection.model';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk-dev",
-    "version": "5.0.2-beta.43",
+    "version": "5.0.2-beta.44",
     "description": "Velt is an SDK to add collaborative features to your product within minutes. Example: Comments like Figma, Frame.io, Google docs or sheets, Recording like Loom, Huddles like Slack and much more.",
     "homepage": "https://velt.dev",
     "keywords": [