@atlaskit/rovo-triggers 1.0.0

package/dist/types/main.d.ts

@@ -0,0 +1,15 @@
+import type { Callback, Payload, Topic } from './types';
+interface SubscribeOptions {
+    topic: Topic;
+    triggerLatest?: boolean;
+}
+export declare const useSubscribe: ({ topic, triggerLatest }: SubscribeOptions, callback: Callback) => void;
+export declare const useSubscribeAll: (callback: Callback) => void;
+export declare const usePublish: (topic: Topic) => (payload: Payload) => void;
+export declare const Subscriber: ({ topic, triggerLatest, onEvent, flushQueueOnUnmount, }: {
+    topic: Topic;
+    triggerLatest?: boolean | undefined;
+    onEvent: Callback;
+    flushQueueOnUnmount?: boolean | undefined;
+}) => null;
+export {};

package/dist/types/types.d.ts

@@ -0,0 +1,79 @@
+export declare const Topics: {
+    readonly AI_MATE: "ai-mate";
+};
+export type Topic = (typeof Topics)[keyof typeof Topics];
+export type PayloadCore<TKey extends string, TData = void> = {
+    type: TKey;
+    source: string;
+    openChat?: boolean;
+    product?: string;
+    interactionSource?: string;
+} & (TData extends void ? {} : {
+    data: TData;
+});
+export type MessageSendPayload = PayloadCore<'message-send', {
+    prompt: string;
+}>;
+export type ChatNewPayload = PayloadCore<'chat-new', {
+    name: string;
+    dialogues: Array<{
+        human_message: {
+            content: string;
+        };
+        agent_message: {
+            content: string;
+        };
+    }>;
+    prompt?: string;
+    sourceId?: string;
+    agentId?: string;
+}>;
+export type EditorContextPayloadData = {
+    document: {
+        type: 'text/markdown' | 'text/adf';
+        content: string;
+    };
+    selection: {
+        type: 'text/markdown' | 'text/plain';
+        content: string;
+    };
+} | undefined;
+export type BrowserContextPayloadData = {
+    context: {
+        browserUrl: string;
+        htmlBody?: string;
+        canvasText?: string;
+    } | undefined;
+};
+export type EditorContextPayload = PayloadCore<'editor-context-payload'> & {
+    data: EditorContextPayloadData;
+};
+export type BrowserContextPayload = PayloadCore<'browser-context-payload'> & {
+    data: BrowserContextPayloadData;
+};
+export type ChatDraftPayload = PayloadCore<'chat-draft'>;
+export type OpenBrowseAgentPayload = PayloadCore<'open-browse-agent-modal'>;
+export type EditorSuggestionPayload = PayloadCore<'editor-suggestion', {
+    mode: 'insert' | 'replace';
+    content: string;
+    agentId?: string;
+}>;
+export type ChatOpenPayload = PayloadCore<'chat-open', {
+    channelId: string;
+    agentId?: string;
+}>;
+export type ForgeAppAuthSuccess = PayloadCore<'forge-auth-success'>;
+export type ForgeAppAuthFailure = PayloadCore<'forge-auth-failure', {
+    errorMessage: string | undefined;
+}>;
+export type Payload = MessageSendPayload | ChatNewPayload | ChatDraftPayload | EditorContextPayload | ChatOpenPayload | OpenBrowseAgentPayload | EditorSuggestionPayload | BrowserContextPayload | ForgeAppAuthSuccess | ForgeAppAuthFailure;
+export type Callback = (payload: Payload) => void;
+export type TopicEvents = {
+    [key in Topic]?: Array<{
+        id: string;
+        callback: Callback;
+    }>;
+};
+export type TopicEventQueue = {
+    [key in Topic]?: Payload;
+};

package/dist/types-ts4.5/common/utils/params/constants.d.ts

@@ -0,0 +1,3 @@
+import { type ValidParam, type ValidPrefix } from './types';
+export declare const ROVO_PARAM_PREFIX: ValidPrefix;
+export declare const ROVO_VALID_PARAMS: ValidParam[];

package/dist/types-ts4.5/common/utils/params/index.d.ts

@@ -0,0 +1,15 @@
+import { type RovoChatParams, type ValidParam } from './types';
+export declare const firstCharUpper: (str: string) => string;
+export declare const firstCharLower: (str: string) => string;
+export declare const addPrefix: (param: ValidParam) => string;
+export declare const removePrefix: (param: string) => string;
+export declare const getRovoParams: (url?: string) => RovoChatParams;
+export declare const updatePageRovoParams: (params: RovoChatParams) => void;
+export declare const addRovoParamsToUrl: (url: string, params: RovoChatParams) => string;
+export declare const encodeRovoParams: (params: RovoChatParams, encodeAsObject?: boolean) => string | {
+    [key: string]: string;
+};
+export declare const assertOnlySpecificFieldsDefined: (params: RovoChatParams, fields: (keyof RovoChatParams)[]) => boolean;
+export declare const getListOfRovoParams: ({ resourceRouterQuery }?: {
+    resourceRouterQuery?: boolean | undefined;
+}) => string[];

package/dist/types-ts4.5/common/utils/params/types.d.ts

@@ -0,0 +1,20 @@
+export type RovoChatPathway = 'chat' | 'agents-browse' | 'agents-create';
+export interface BaseRovoChatParams {
+    pathway: RovoChatPathway;
+    agentId: string;
+    conversationId: string;
+    prompt: string;
+    cloudId: string;
+    triggerOpen: boolean;
+}
+export type ValidPrefix = 'rovoChat';
+export type ValidParam = keyof BaseRovoChatParams;
+export type ValidPrefixedParam = `${ValidPrefix}${ValidParam}`;
+type RovoParams<T extends RovoChatPathway, P = object> = BaseRovoChatParams & {
+    pathway: T;
+} & P;
+type ChatParams = RovoParams<'chat'>;
+type AgentBrowseParams = RovoParams<'agents-browse'>;
+type AgentCreateParams = RovoParams<'agents-create'>;
+export type RovoChatParams = Partial<ChatParams | AgentCreateParams | AgentBrowseParams>;
+export {};

package/dist/types-ts4.5/index.d.ts

@@ -0,0 +1,4 @@
+export { usePublish, useSubscribe, useSubscribeAll, Subscriber } from './main';
+export type { Payload, Callback, Topic, EditorContextPayloadData, BrowserContextPayloadData, } from './types';
+export { getRovoParams, updatePageRovoParams, addRovoParamsToUrl, assertOnlySpecificFieldsDefined, encodeRovoParams, getListOfRovoParams, } from './common/utils/params';
+export type { RovoChatParams, RovoChatPathway } from './common/utils/params/types';

package/dist/types-ts4.5/main.d.ts

@@ -0,0 +1,15 @@
+import type { Callback, Payload, Topic } from './types';
+interface SubscribeOptions {
+    topic: Topic;
+    triggerLatest?: boolean;
+}
+export declare const useSubscribe: ({ topic, triggerLatest }: SubscribeOptions, callback: Callback) => void;
+export declare const useSubscribeAll: (callback: Callback) => void;
+export declare const usePublish: (topic: Topic) => (payload: Payload) => void;
+export declare const Subscriber: ({ topic, triggerLatest, onEvent, flushQueueOnUnmount, }: {
+    topic: Topic;
+    triggerLatest?: boolean | undefined;
+    onEvent: Callback;
+    flushQueueOnUnmount?: boolean | undefined;
+}) => null;
+export {};

package/dist/types-ts4.5/types.d.ts

@@ -0,0 +1,79 @@
+export declare const Topics: {
+    readonly AI_MATE: "ai-mate";
+};
+export type Topic = (typeof Topics)[keyof typeof Topics];
+export type PayloadCore<TKey extends string, TData = void> = {
+    type: TKey;
+    source: string;
+    openChat?: boolean;
+    product?: string;
+    interactionSource?: string;
+} & (TData extends void ? {} : {
+    data: TData;
+});
+export type MessageSendPayload = PayloadCore<'message-send', {
+    prompt: string;
+}>;
+export type ChatNewPayload = PayloadCore<'chat-new', {
+    name: string;
+    dialogues: Array<{
+        human_message: {
+            content: string;
+        };
+        agent_message: {
+            content: string;
+        };
+    }>;
+    prompt?: string;
+    sourceId?: string;
+    agentId?: string;
+}>;
+export type EditorContextPayloadData = {
+    document: {
+        type: 'text/markdown' | 'text/adf';
+        content: string;
+    };
+    selection: {
+        type: 'text/markdown' | 'text/plain';
+        content: string;
+    };
+} | undefined;
+export type BrowserContextPayloadData = {
+    context: {
+        browserUrl: string;
+        htmlBody?: string;
+        canvasText?: string;
+    } | undefined;
+};
+export type EditorContextPayload = PayloadCore<'editor-context-payload'> & {
+    data: EditorContextPayloadData;
+};
+export type BrowserContextPayload = PayloadCore<'browser-context-payload'> & {
+    data: BrowserContextPayloadData;
+};
+export type ChatDraftPayload = PayloadCore<'chat-draft'>;
+export type OpenBrowseAgentPayload = PayloadCore<'open-browse-agent-modal'>;
+export type EditorSuggestionPayload = PayloadCore<'editor-suggestion', {
+    mode: 'insert' | 'replace';
+    content: string;
+    agentId?: string;
+}>;
+export type ChatOpenPayload = PayloadCore<'chat-open', {
+    channelId: string;
+    agentId?: string;
+}>;
+export type ForgeAppAuthSuccess = PayloadCore<'forge-auth-success'>;
+export type ForgeAppAuthFailure = PayloadCore<'forge-auth-failure', {
+    errorMessage: string | undefined;
+}>;
+export type Payload = MessageSendPayload | ChatNewPayload | ChatDraftPayload | EditorContextPayload | ChatOpenPayload | OpenBrowseAgentPayload | EditorSuggestionPayload | BrowserContextPayload | ForgeAppAuthSuccess | ForgeAppAuthFailure;
+export type Callback = (payload: Payload) => void;
+export type TopicEvents = {
+    [key in Topic]?: Array<{
+        id: string;
+        callback: Callback;
+    }>;
+};
+export type TopicEventQueue = {
+    [key in Topic]?: Payload;
+};

package/package.json

@@ -0,0 +1,90 @@
+{
+	"name": "@atlaskit/rovo-triggers",
+	"version": "1.0.0",
+	"description": "Provides various trigger events to drive Rovo Chat functionality, such as a publish-subscribe and URL parameter hooks",
+	"author": "Atlassian Pty Ltd",
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/"
+	},
+	"atlassian": {
+		"team": "AI Mate"
+	},
+	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
+	"license": "Apache-2.0",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"module:es2019": "dist/es2019/index.js",
+	"types": "dist/types/index.d.ts",
+	"typesVersions": {
+		">=4.5 <4.9": {
+			"*": [
+				"dist/types-ts4.5/*",
+				"dist/types-ts4.5/index.d.ts"
+			]
+		}
+	},
+	"sideEffects": [
+		"*.compiled.css"
+	],
+	"atlaskit:src": "src/index.ts",
+	"af:exports": {
+		".": "./src/index.ts"
+	},
+	"dependencies": {
+		"@babel/runtime": "^7.0.0"
+	},
+	"peerDependencies": {
+		"react": "^16.8.0"
+	},
+	"devDependencies": {
+		"@af/integration-testing": "*",
+		"@af/visual-regression": "*",
+		"@atlaskit/primitives": "*",
+		"@atlaskit/ssr": "*",
+		"@atlaskit/visual-regression": "*",
+		"@atlassian/feature-flags-test-utils": "0.2.3",
+		"@testing-library/react": "^12.1.5",
+		"@testing-library/react-hooks": "^8.0.1",
+		"react-dom": "^16.8.0",
+		"typescript": "~5.4.2",
+		"wait-for-expect": "^1.2.0"
+	},
+	"techstack": {
+		"@atlassian/frontend": {
+			"code-structure": [
+				"tangerine-next"
+			],
+			"import-structure": [
+				"atlassian-conventions"
+			],
+			"circular-dependencies": [
+				"file-and-folder-level"
+			]
+		},
+		"@repo/internal": {
+			"dom-events": "use-bind-event-listener",
+			"analytics": [
+				"analytics-next"
+			],
+			"design-tokens": [
+				"color"
+			],
+			"theming": [
+				"react-context"
+			],
+			"ui-components": [
+				"lite-mode"
+			],
+			"deprecation": [
+				"no-deprecated-imports"
+			],
+			"styling": [
+				"static",
+				"compiled"
+			],
+			"imports": [
+				"import-no-extraneous-disable-for-examples-and-docs"
+			]
+		}
+	}
+}