Deep link: add prompt (#1669)
Example: open "dyad://add-prompt?data=eyJ0aXRsZSI6IlRlc3QgUHJvbXB0IiwiZGVzY3JpcHRpb24iOiJBIHRlc3QgcHJvbXB0IGZyb20gZGVlcCBsaW5rIiwiY29udGVudCI6IlRoaXMgaXMgdGhlIGNvbnRlbnQgb2YgdGhlIHByb21wdC4ifQ%3D%3D" <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Adds dyad://add-prompt deep link that navigates to Library and opens a prefilled Create Prompt dialog from base64 JSON. > > - **Deep Link Handling** > - Parse `dyad://add-prompt?data=<base64-json>` in `src/main.ts`; validate with `AddPromptDataSchema` and send `deep-link-received` with payload. > - Extend `DeepLinkContext` to navigate to `/library` on `add-prompt`. > - **Library/Dialogs** > - Add controlled open state and `prefillData` support to `CreateOrEditPromptDialog` and `CreatePromptDialog` (`src/components/CreatePromptDialog.tsx`). > - In `src/pages/library.tsx`, listen for `add-prompt` deep link, prefill form, open dialog, and clear deep-link state. > - **Schemas** > - Define `AddPromptDataSchema`, `AddPromptPayload`, and `AddPromptDeepLinkData` in `src/ipc/deep_link_data.ts` and include in `DeepLinkData` union. > - **E2E Tests** > - Add Playwright test `e2e-tests/add_prompt_deep_link.spec.ts` and ARIA snapshot to verify deep link opens prefilled dialog and saves prompt. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 1ddb12306cfca195682c8a1b719f60093b858d54. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
This commit is contained in:
52
e2e-tests/add_prompt_deep_link.spec.ts
Normal file
52
e2e-tests/add_prompt_deep_link.spec.ts
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
import { test } from "./helpers/test_helper";
|
||||||
|
import { expect } from "@playwright/test";
|
||||||
|
|
||||||
|
test("add prompt via deep link with base64-encoded data", async ({
|
||||||
|
po,
|
||||||
|
electronApp,
|
||||||
|
}) => {
|
||||||
|
await po.setUp();
|
||||||
|
await po.goToLibraryTab();
|
||||||
|
|
||||||
|
// Verify library is empty initially
|
||||||
|
await expect(po.page.getByTestId("prompt-card")).not.toBeVisible();
|
||||||
|
|
||||||
|
// Create the prompt data to be encoded
|
||||||
|
const promptData = {
|
||||||
|
title: "Deep Link Test Prompt",
|
||||||
|
description: "A prompt created via deep link",
|
||||||
|
content: "You are a helpful assistant. Please help with:\n\n[task here]",
|
||||||
|
};
|
||||||
|
|
||||||
|
// Encode the data as base64 (matching the pattern in main.ts)
|
||||||
|
const base64Data = Buffer.from(JSON.stringify(promptData)).toString("base64");
|
||||||
|
const deepLinkUrl = `dyad://add-prompt?data=${encodeURIComponent(base64Data)}`;
|
||||||
|
|
||||||
|
console.log("Triggering deep link:", deepLinkUrl);
|
||||||
|
|
||||||
|
// Trigger the deep link by emitting the 'open-url' event in the main process
|
||||||
|
await electronApp.evaluate(({ app }, url) => {
|
||||||
|
app.emit("open-url", { preventDefault: () => {} }, url);
|
||||||
|
}, deepLinkUrl);
|
||||||
|
|
||||||
|
// Wait for the dialog to open and verify prefilled data
|
||||||
|
await expect(
|
||||||
|
po.page.getByRole("dialog").getByText("Create New Prompt"),
|
||||||
|
).toBeVisible();
|
||||||
|
|
||||||
|
// Verify the form is prefilled with the correct data
|
||||||
|
await expect(po.page.getByRole("textbox", { name: "Title" })).toHaveValue(
|
||||||
|
promptData.title,
|
||||||
|
);
|
||||||
|
await expect(
|
||||||
|
po.page.getByRole("textbox", { name: "Description (optional)" }),
|
||||||
|
).toHaveValue(promptData.description);
|
||||||
|
await expect(po.page.getByRole("textbox", { name: "Content" })).toHaveValue(
|
||||||
|
promptData.content,
|
||||||
|
);
|
||||||
|
|
||||||
|
// Save the prompt
|
||||||
|
await po.page.getByRole("button", { name: "Save" }).click();
|
||||||
|
|
||||||
|
await expect(po.page.getByTestId("prompt-card")).toMatchAriaSnapshot();
|
||||||
|
});
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
- heading "Deep Link Test Prompt" [level=3]
|
||||||
|
- paragraph: A prompt created via deep link
|
||||||
|
- button:
|
||||||
|
- img
|
||||||
|
- button:
|
||||||
|
- img
|
||||||
|
- text: "You are a helpful assistant. Please help with: [task here]"
|
||||||
@@ -38,6 +38,13 @@ interface CreateOrEditPromptDialogProps {
|
|||||||
content: string;
|
content: string;
|
||||||
}) => Promise<any>;
|
}) => Promise<any>;
|
||||||
trigger?: React.ReactNode;
|
trigger?: React.ReactNode;
|
||||||
|
prefillData?: {
|
||||||
|
title: string;
|
||||||
|
description: string;
|
||||||
|
content: string;
|
||||||
|
};
|
||||||
|
isOpen?: boolean;
|
||||||
|
onOpenChange?: (open: boolean) => void;
|
||||||
}
|
}
|
||||||
|
|
||||||
export function CreateOrEditPromptDialog({
|
export function CreateOrEditPromptDialog({
|
||||||
@@ -46,8 +53,14 @@ export function CreateOrEditPromptDialog({
|
|||||||
onCreatePrompt,
|
onCreatePrompt,
|
||||||
onUpdatePrompt,
|
onUpdatePrompt,
|
||||||
trigger,
|
trigger,
|
||||||
|
prefillData,
|
||||||
|
isOpen,
|
||||||
|
onOpenChange,
|
||||||
}: CreateOrEditPromptDialogProps) {
|
}: CreateOrEditPromptDialogProps) {
|
||||||
const [open, setOpen] = useState(false);
|
const [internalOpen, setInternalOpen] = useState(false);
|
||||||
|
const open = isOpen !== undefined ? isOpen : internalOpen;
|
||||||
|
const setOpen = onOpenChange || setInternalOpen;
|
||||||
|
|
||||||
const [draft, setDraft] = useState({
|
const [draft, setDraft] = useState({
|
||||||
title: "",
|
title: "",
|
||||||
description: "",
|
description: "",
|
||||||
@@ -74,7 +87,7 @@ export function CreateOrEditPromptDialog({
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
// Initialize draft with prompt data when editing
|
// Initialize draft with prompt data when editing or prefill data
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
if (mode === "edit" && prompt) {
|
if (mode === "edit" && prompt) {
|
||||||
setDraft({
|
setDraft({
|
||||||
@@ -82,10 +95,16 @@ export function CreateOrEditPromptDialog({
|
|||||||
description: prompt.description || "",
|
description: prompt.description || "",
|
||||||
content: prompt.content,
|
content: prompt.content,
|
||||||
});
|
});
|
||||||
|
} else if (prefillData) {
|
||||||
|
setDraft({
|
||||||
|
title: prefillData.title,
|
||||||
|
description: prefillData.description,
|
||||||
|
content: prefillData.content,
|
||||||
|
});
|
||||||
} else {
|
} else {
|
||||||
setDraft({ title: "", description: "", content: "" });
|
setDraft({ title: "", description: "", content: "" });
|
||||||
}
|
}
|
||||||
}, [mode, prompt, open]);
|
}, [mode, prompt, prefillData, open]);
|
||||||
|
|
||||||
// Auto-resize textarea when content changes
|
// Auto-resize textarea when content changes
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
@@ -107,6 +126,12 @@ export function CreateOrEditPromptDialog({
|
|||||||
description: prompt.description || "",
|
description: prompt.description || "",
|
||||||
content: prompt.content,
|
content: prompt.content,
|
||||||
});
|
});
|
||||||
|
} else if (prefillData) {
|
||||||
|
setDraft({
|
||||||
|
title: prefillData.title,
|
||||||
|
description: prefillData.description,
|
||||||
|
content: prefillData.content,
|
||||||
|
});
|
||||||
} else {
|
} else {
|
||||||
setDraft({ title: "", description: "", content: "" });
|
setDraft({ title: "", description: "", content: "" });
|
||||||
}
|
}
|
||||||
@@ -222,14 +247,30 @@ export function CreateOrEditPromptDialog({
|
|||||||
// Backward compatibility wrapper for create mode
|
// Backward compatibility wrapper for create mode
|
||||||
export function CreatePromptDialog({
|
export function CreatePromptDialog({
|
||||||
onCreatePrompt,
|
onCreatePrompt,
|
||||||
|
prefillData,
|
||||||
|
isOpen,
|
||||||
|
onOpenChange,
|
||||||
}: {
|
}: {
|
||||||
onCreatePrompt: (prompt: {
|
onCreatePrompt: (prompt: {
|
||||||
title: string;
|
title: string;
|
||||||
description?: string;
|
description?: string;
|
||||||
content: string;
|
content: string;
|
||||||
}) => Promise<any>;
|
}) => Promise<any>;
|
||||||
|
prefillData?: {
|
||||||
|
title: string;
|
||||||
|
description: string;
|
||||||
|
content: string;
|
||||||
|
};
|
||||||
|
isOpen?: boolean;
|
||||||
|
onOpenChange?: (open: boolean) => void;
|
||||||
}) {
|
}) {
|
||||||
return (
|
return (
|
||||||
<CreateOrEditPromptDialog mode="create" onCreatePrompt={onCreatePrompt} />
|
<CreateOrEditPromptDialog
|
||||||
|
mode="create"
|
||||||
|
onCreatePrompt={onCreatePrompt}
|
||||||
|
prefillData={prefillData}
|
||||||
|
isOpen={isOpen}
|
||||||
|
onOpenChange={onOpenChange}
|
||||||
|
/>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +1,5 @@
|
|||||||
import React, { createContext, useContext, useEffect, useState } from "react";
|
import React, { createContext, useContext, useEffect, useState } from "react";
|
||||||
|
import { useNavigate } from "@tanstack/react-router";
|
||||||
import { IpcClient } from "../ipc/ipc_client";
|
import { IpcClient } from "../ipc/ipc_client";
|
||||||
import { DeepLinkData } from "../ipc/deep_link_data";
|
import { DeepLinkData } from "../ipc/deep_link_data";
|
||||||
import { useScrollAndNavigateTo } from "@/hooks/useScrollAndNavigateTo";
|
import { useScrollAndNavigateTo } from "@/hooks/useScrollAndNavigateTo";
|
||||||
@@ -17,6 +18,7 @@ export function DeepLinkProvider({ children }: { children: React.ReactNode }) {
|
|||||||
const [lastDeepLink, setLastDeepLink] = useState<
|
const [lastDeepLink, setLastDeepLink] = useState<
|
||||||
(DeepLinkData & { timestamp: number }) | null
|
(DeepLinkData & { timestamp: number }) | null
|
||||||
>(null);
|
>(null);
|
||||||
|
const navigate = useNavigate();
|
||||||
const scrollAndNavigateTo = useScrollAndNavigateTo("/settings", {
|
const scrollAndNavigateTo = useScrollAndNavigateTo("/settings", {
|
||||||
behavior: "smooth",
|
behavior: "smooth",
|
||||||
block: "start",
|
block: "start",
|
||||||
@@ -29,11 +31,14 @@ export function DeepLinkProvider({ children }: { children: React.ReactNode }) {
|
|||||||
if (data.type === "add-mcp-server") {
|
if (data.type === "add-mcp-server") {
|
||||||
// Navigate to tools-mcp section
|
// Navigate to tools-mcp section
|
||||||
scrollAndNavigateTo("tools-mcp");
|
scrollAndNavigateTo("tools-mcp");
|
||||||
|
} else if (data.type === "add-prompt") {
|
||||||
|
// Navigate to library page
|
||||||
|
navigate({ to: "/library" });
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
return unsubscribe;
|
return unsubscribe;
|
||||||
}, []);
|
}, [navigate, scrollAndNavigateTo]);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<DeepLinkContext.Provider
|
<DeepLinkContext.Provider
|
||||||
|
|||||||
@@ -20,8 +20,23 @@ export type AddMcpServerDeepLinkData = {
|
|||||||
type: "add-mcp-server";
|
type: "add-mcp-server";
|
||||||
payload: AddMcpServerPayload;
|
payload: AddMcpServerPayload;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export const AddPromptDataSchema = z.object({
|
||||||
|
title: z.string(),
|
||||||
|
description: z.string(),
|
||||||
|
content: z.string(),
|
||||||
|
});
|
||||||
|
|
||||||
|
export type AddPromptPayload = z.infer<typeof AddPromptDataSchema>;
|
||||||
|
|
||||||
|
export type AddPromptDeepLinkData = {
|
||||||
|
type: "add-prompt";
|
||||||
|
payload: AddPromptPayload;
|
||||||
|
};
|
||||||
|
|
||||||
export type DeepLinkData =
|
export type DeepLinkData =
|
||||||
| AddMcpServerDeepLinkData
|
| AddMcpServerDeepLinkData
|
||||||
|
| AddPromptDeepLinkData
|
||||||
| {
|
| {
|
||||||
type: string;
|
type: string;
|
||||||
};
|
};
|
||||||
|
|||||||
28
src/main.ts
28
src/main.ts
@@ -21,6 +21,8 @@ import { handleNeonOAuthReturn } from "./neon_admin/neon_return_handler";
|
|||||||
import {
|
import {
|
||||||
AddMcpServerConfigSchema,
|
AddMcpServerConfigSchema,
|
||||||
AddMcpServerPayload,
|
AddMcpServerPayload,
|
||||||
|
AddPromptDataSchema,
|
||||||
|
AddPromptPayload,
|
||||||
} from "./ipc/deep_link_data";
|
} from "./ipc/deep_link_data";
|
||||||
|
|
||||||
log.errorHandler.startCatching();
|
log.errorHandler.startCatching();
|
||||||
@@ -357,6 +359,32 @@ function handleDeepLinkReturn(url: string) {
|
|||||||
}
|
}
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
// dyad://add-prompt?data=<base64-encoded-json>
|
||||||
|
if (parsed.hostname === "add-prompt") {
|
||||||
|
const data = parsed.searchParams.get("data");
|
||||||
|
if (!data) {
|
||||||
|
dialog.showErrorBox("Invalid URL", "Expected data parameter");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
const decodedJson = atob(data);
|
||||||
|
const decoded = JSON.parse(decodedJson);
|
||||||
|
const parsedData = AddPromptDataSchema.parse(decoded);
|
||||||
|
|
||||||
|
mainWindow?.webContents.send("deep-link-received", {
|
||||||
|
type: parsed.hostname,
|
||||||
|
payload: parsedData as AddPromptPayload,
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
logger.error("Failed to parse add-prompt deep link:", error);
|
||||||
|
dialog.showErrorBox(
|
||||||
|
"Invalid Prompt Data",
|
||||||
|
"The deep link contains malformed data. Please check the URL and try again.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
dialog.showErrorBox("Invalid deep link URL", url);
|
dialog.showErrorBox("Invalid deep link URL", url);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,21 +1,65 @@
|
|||||||
import React from "react";
|
import React, { useState, useEffect } from "react";
|
||||||
import { usePrompts } from "@/hooks/usePrompts";
|
import { usePrompts } from "@/hooks/usePrompts";
|
||||||
import {
|
import {
|
||||||
CreatePromptDialog,
|
CreatePromptDialog,
|
||||||
CreateOrEditPromptDialog,
|
CreateOrEditPromptDialog,
|
||||||
} from "@/components/CreatePromptDialog";
|
} from "@/components/CreatePromptDialog";
|
||||||
import { DeleteConfirmationDialog } from "@/components/DeleteConfirmationDialog";
|
import { DeleteConfirmationDialog } from "@/components/DeleteConfirmationDialog";
|
||||||
|
import { useDeepLink } from "@/contexts/DeepLinkContext";
|
||||||
|
import { AddPromptDeepLinkData } from "@/ipc/deep_link_data";
|
||||||
|
import { showInfo } from "@/lib/toast";
|
||||||
|
|
||||||
export default function LibraryPage() {
|
export default function LibraryPage() {
|
||||||
const { prompts, isLoading, createPrompt, updatePrompt, deletePrompt } =
|
const { prompts, isLoading, createPrompt, updatePrompt, deletePrompt } =
|
||||||
usePrompts();
|
usePrompts();
|
||||||
|
const { lastDeepLink, clearLastDeepLink } = useDeepLink();
|
||||||
|
const [dialogOpen, setDialogOpen] = useState(false);
|
||||||
|
const [prefillData, setPrefillData] = useState<
|
||||||
|
| {
|
||||||
|
title: string;
|
||||||
|
description: string;
|
||||||
|
content: string;
|
||||||
|
}
|
||||||
|
| undefined
|
||||||
|
>(undefined);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
const handleDeepLink = async () => {
|
||||||
|
if (lastDeepLink?.type === "add-prompt") {
|
||||||
|
const deepLink = lastDeepLink as AddPromptDeepLinkData;
|
||||||
|
const payload = deepLink.payload;
|
||||||
|
showInfo(`Prefilled prompt: ${payload.title}`);
|
||||||
|
setPrefillData({
|
||||||
|
title: payload.title,
|
||||||
|
description: payload.description,
|
||||||
|
content: payload.content,
|
||||||
|
});
|
||||||
|
setDialogOpen(true);
|
||||||
|
clearLastDeepLink();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
handleDeepLink();
|
||||||
|
}, [lastDeepLink?.timestamp, clearLastDeepLink]);
|
||||||
|
|
||||||
|
const handleDialogClose = (open: boolean) => {
|
||||||
|
setDialogOpen(open);
|
||||||
|
if (!open) {
|
||||||
|
// Clear prefill data when dialog closes
|
||||||
|
setPrefillData(undefined);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className="min-h-screen px-8 py-6">
|
<div className="min-h-screen px-8 py-6">
|
||||||
<div className="max-w-6xl mx-auto">
|
<div className="max-w-6xl mx-auto">
|
||||||
<div className="flex items-center justify-between mb-6">
|
<div className="flex items-center justify-between mb-6">
|
||||||
<h1 className="text-3xl font-bold mr-4">Library: Prompts</h1>
|
<h1 className="text-3xl font-bold mr-4">Library: Prompts</h1>
|
||||||
<CreatePromptDialog onCreatePrompt={createPrompt} />
|
<CreatePromptDialog
|
||||||
|
onCreatePrompt={createPrompt}
|
||||||
|
prefillData={prefillData}
|
||||||
|
isOpen={dialogOpen}
|
||||||
|
onOpenChange={handleDialogClose}
|
||||||
|
/>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
{isLoading ? (
|
{isLoading ? (
|
||||||
|
|||||||
Reference in New Issue
Block a user