@rocket.chat/desktop-api 1.0.0-rc.0

package/.eslintrc.json

@@ -0,0 +1,4 @@
+{
+	"extends": ["@rocket.chat/eslint-config"],
+	"ignorePatterns": ["**/dist"]
+}

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @rocket.chat/desktop-api
+
+## 1.0.0-rc.0
+
+### Major Changes
+
+- ([#36770](https://github.com/RocketChat/Rocket.Chat/pull/36770)) Adds a new package (`@rocket.chat/desktop-api`) to interface the desktop app's injected context

package/dist/index.d.ts

@@ -0,0 +1,47 @@
+export type ServerInfo = {
+    version: string;
+};
+export type Badge = '•' | number;
+export type ThemeAppearance = 'dark' | 'light' | 'auto' | 'high-contrast' | undefined;
+export type VideoChatWindowOptions = {
+    providerName?: string | undefined;
+};
+export type OutlookEventsResponse = {
+    status: 'success' | 'canceled';
+};
+export interface IRocketChatDesktop {
+    onReady: (cb: (serverInfo: ServerInfo) => void) => void;
+    setServerInfo: (serverInfo: ServerInfo) => void;
+    setUrlResolver: (getAbsoluteUrl: (relativePath?: string) => string) => void;
+    setBadge: (badge: Badge) => void;
+    setFavicon: (faviconUrl: string) => void;
+    setBackground: (imageUrl: string) => void;
+    setSidebarCustomTheme: (customTheme: string) => void;
+    setTitle: (title: string) => void;
+    setUserLoggedIn: (userLoggedIn: boolean) => void;
+    setUserPresenceDetection: (options: {
+        isAutoAwayEnabled: boolean;
+        idleThreshold: number | null;
+        setUserOnline: (online: boolean) => void;
+    }) => void;
+    setUserThemeAppearance: (themeAppearance: ThemeAppearance) => void;
+    createNotification: (options: NotificationOptions & {
+        canReply?: boolean;
+        title: string;
+        onEvent: (eventDescriptor: {
+            type: string;
+            detail: unknown;
+        }) => void;
+    }) => Promise<unknown>;
+    destroyNotification: (id: unknown) => void;
+    getInternalVideoChatWindowEnabled: () => boolean;
+    openInternalVideoChatWindow: (url: string, options: VideoChatWindowOptions) => void;
+    setGitCommitHash: (gitCommitHash: string) => void;
+    writeTextToClipboard: (text: string) => void;
+    getOutlookEvents: (date: Date) => Promise<OutlookEventsResponse>;
+    setOutlookExchangeUrl: (url: string, userId: string) => void;
+    hasOutlookCredentials: () => Promise<boolean>;
+    clearOutlookCredentials: () => void;
+    setUserToken: (token: string, userId: string) => void;
+    openDocumentViewer: (url: string, format: string, options: any) => void;
+}

package/dist/index.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://www.schemastore.org/package",
+  "name": "@rocket.chat/desktop-api",
+  "version": "1.0.0-rc.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "default": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "rimraf dist && tsc -p tsconfig.json",
+    "lint": "eslint",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "devDependencies": {
+    "@rocket.chat/eslint-config": "~0.7.0",
+    "eslint": "~8.45.0",
+    "rimraf": "~6.0.1",
+    "typescript": "~5.9.2"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  }
+}

package/src/index.ts

@@ -0,0 +1,51 @@
+export type ServerInfo = {
+	version: string;
+};
+
+export type Badge = '•' | number;
+
+export type ThemeAppearance = 'dark' | 'light' | 'auto' | 'high-contrast' | undefined;
+
+export type VideoChatWindowOptions = {
+	providerName?: string | undefined;
+};
+
+export type OutlookEventsResponse = {
+	status: 'success' | 'canceled';
+};
+
+export interface IRocketChatDesktop {
+	onReady: (cb: (serverInfo: ServerInfo) => void) => void;
+	setServerInfo: (serverInfo: ServerInfo) => void;
+	setUrlResolver: (getAbsoluteUrl: (relativePath?: string) => string) => void;
+	setBadge: (badge: Badge) => void;
+	setFavicon: (faviconUrl: string) => void;
+	setBackground: (imageUrl: string) => void;
+	setSidebarCustomTheme: (customTheme: string) => void;
+	setTitle: (title: string) => void;
+	setUserLoggedIn: (userLoggedIn: boolean) => void;
+	setUserPresenceDetection: (options: {
+		isAutoAwayEnabled: boolean;
+		idleThreshold: number | null;
+		setUserOnline: (online: boolean) => void;
+	}) => void;
+	setUserThemeAppearance: (themeAppearance: ThemeAppearance) => void;
+	createNotification: (
+		options: NotificationOptions & {
+			canReply?: boolean;
+			title: string;
+			onEvent: (eventDescriptor: { type: string; detail: unknown }) => void;
+		},
+	) => Promise<unknown>;
+	destroyNotification: (id: unknown) => void;
+	getInternalVideoChatWindowEnabled: () => boolean;
+	openInternalVideoChatWindow: (url: string, options: VideoChatWindowOptions) => void;
+	setGitCommitHash: (gitCommitHash: string) => void;
+	writeTextToClipboard: (text: string) => void;
+	getOutlookEvents: (date: Date) => Promise<OutlookEventsResponse>;
+	setOutlookExchangeUrl: (url: string, userId: string) => void;
+	hasOutlookCredentials: () => Promise<boolean>;
+	clearOutlookCredentials: () => void;
+	setUserToken: (token: string, userId: string) => void;
+	openDocumentViewer: (url: string, format: string, options: any) => void;
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+	"extends": "@rocket.chat/tsconfig/client.json",
+	"compilerOptions": {
+		"target": "es2024",
+		"module": "node20",
+		"moduleResolution": "node16",
+		"rootDir": "./src",
+		"outDir": "./dist",
+		"declarationMap": false,
+		"sourceMap": false
+	},
+	"include": ["src"]
+}