Files
calendar/packages/features/ee/api-keys/components/ApiKeyDialogForm.tsx
T
sean-brydonGitHubDevin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
19563aa697 feat: Self hosted onboarding (#22102)
* intro work

* update wixard form to have content callback to remove preset navigation

* more fixes to deployment

* fix calling static service

* fix save license key text

* ensure default steps work as expected

* fix conditional for rendering step

* skip step

* add on next step for free license

* refactor wizard form to use nuqs

* fix styles

* merge base param with step config

* fix next stepo text

* use deployment Signature token

* decrypt signature token

* fix: resolve type errors and test failures from wizard form refactor

- Fix signatureToken field name to signatureTokenEncrypted in deployment repository
- Add missing getSignatureToken method to verifyApiKey test mock
- Fix WizardForm import from default to named export in test file
- Add missing nextStep prop to Steps component in WizardForm

Resolves TypeScript type check errors and unit test failures without changing functionality.

Co-Authored-By: sean@cal.com <Sean@brydon.io>

* fix: add missing getDeploymentSignatureToken mock in LicenseKeyService test

Co-Authored-By: sean@cal.com <Sean@brydon.io>

* fix: add nuqs library mock for WizardForm test

Co-Authored-By: sean@cal.com <Sean@brydon.io>

* fix: add missing nav prop to AdminAppsList component with eslint disable

Co-Authored-By: sean@cal.com <Sean@brydon.io>

* Apply suggestions from code review

Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>

* Update apps/web/modules/auth/setup-view.tsx

Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>

* fix license schema changes

* revret schema generation

* fix eslint errors

* remove required nav type + add use client

* fix types

* Update packages/ui/components/form/wizard/useWizardState.ts

Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>

* fix controller issue

* add checks for deployment key being null - add more tests

* fix tests

* add deployment key tests

* fix: resolve crypto mock to handle empty encryption keys gracefully

- Updated symmetricDecrypt mock to return null instead of throwing 'Invalid key' error when encryption key is empty
- All getDeploymentKey tests now pass including the previously failing 'should return null when decryption fails due to missing encryption key' test
- Fixes mocking issues in PR 22102 self-hosted onboarding wizard form refactor

Co-Authored-By: sean@cal.com <Sean@brydon.io>

* fix label

* add i18n to error

* use enum for steps

* add as const

* fix test env issues

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
2025-07-09 09:26:01 +01:00

254 lines
9.2 KiB
TypeScript

import Link from "next/link";
import { useState } from "react";
import { Controller, useForm } from "react-hook-form";
import dayjs from "@calcom/dayjs";
import type { TApiKeys } from "@calcom/ee/api-keys/components/ApiKeyListItem";
import LicenseRequired from "@calcom/ee/common/components/LicenseRequired";
import { IS_CALCOM } from "@calcom/lib/constants";
import { useLocale } from "@calcom/lib/hooks/useLocale";
import { trpc } from "@calcom/trpc/react";
import { Button } from "@calcom/ui/components/button";
import { DialogFooter } from "@calcom/ui/components/dialog";
import { Form } from "@calcom/ui/components/form";
import { TextField } from "@calcom/ui/components/form";
import { SelectField } from "@calcom/ui/components/form";
import { Switch } from "@calcom/ui/components/form";
import { showToast } from "@calcom/ui/components/toast";
import { Tooltip } from "@calcom/ui/components/tooltip";
import { revalidateApiKeysList } from "@calcom/web/app/(use-page-wrapper)/settings/(settings-layout)/developer/api-keys/actions";
export default function ApiKeyDialogForm({
defaultValues,
handleClose,
}: {
defaultValues?: Omit<TApiKeys, "userId" | "createdAt" | "lastUsedAt"> & { neverExpires?: boolean };
handleClose: () => void;
}) {
const { t } = useLocale();
const utils = trpc.useUtils();
const updateApiKeyMutation = trpc.viewer.apiKeys.edit.useMutation({
onSuccess() {
utils.viewer.apiKeys.list.invalidate();
revalidateApiKeysList();
showToast(t("api_key_updated"), "success");
handleClose();
},
onError() {
showToast(t("api_key_update_failed"), "error");
},
});
type Option = { value: Date | null | undefined; label: string };
const [apiKey, setApiKey] = useState("");
const [expiryDate, setExpiryDate] = useState<Date | null | undefined>(
() => defaultValues?.expiresAt || dayjs().add(30, "day").toDate()
);
const [successfulNewApiKeyModal, setSuccessfulNewApiKeyModal] = useState(false);
const [apiKeyDetails, setApiKeyDetails] = useState({
expiresAt: null as Date | null,
note: "" as string | null,
neverExpires: false,
});
const form = useForm({
defaultValues: {
note: defaultValues?.note || "",
neverExpires: defaultValues?.neverExpires || false,
expiresAt: defaultValues?.expiresAt || dayjs().add(30, "day").toDate(),
},
});
const watchNeverExpires = form.watch("neverExpires");
const expiresAtOptions: Option[] = [
{
label: t("seven_days"),
value: dayjs().add(7, "day").toDate(),
},
{
label: t("thirty_days"),
value: dayjs().add(30, "day").toDate(),
},
{
label: t("three_months"),
value: dayjs().add(3, "month").toDate(),
},
{
label: t("one_year"),
value: dayjs().add(1, "year").toDate(),
},
];
return (
<LicenseRequired>
{successfulNewApiKeyModal ? (
<>
<div className="mb-6">
<h2 className="font-semi-bold font-cal text-emphasis mb-2 text-xl tracking-wide">
{t("success_api_key_created")}
</h2>
<div className="text-emphasis text-sm">
<span className="font-semibold">{t("success_api_key_created_bold_tagline")}</span>{" "}
{t("you_will_only_view_it_once")}
</div>
</div>
<div>
<div className="flex">
<code className="bg-subtle text-default w-full truncate rounded-md rounded-r-none py-[6px] pl-2 pr-2 align-middle font-mono">
{" "}
{apiKey}
</code>
<Tooltip side="top" content={t("copy_to_clipboard")}>
<Button
onClick={() => {
navigator.clipboard.writeText(apiKey);
showToast(t("api_key_copied"), "success");
}}
type="button"
className="rounded-l-none text-base"
StartIcon="clipboard">
{t("copy")}
</Button>
</Tooltip>
</div>
<span className="text-muted text-sm">
{apiKeyDetails.neverExpires
? t("never_expires")
: `${t("expires")} ${apiKeyDetails?.expiresAt?.toLocaleDateString()}`}
</span>
</div>
<DialogFooter showDivider className="relative">
<Button type="button" color="secondary" onClick={handleClose} tabIndex={-1}>
{t("done")}
</Button>
</DialogFooter>
</>
) : (
<Form
form={form}
handleSubmit={async (event) => {
if (defaultValues) {
console.log("Name changed");
await updateApiKeyMutation.mutate({ id: defaultValues.id, note: event.note });
} else {
const apiKey = await utils.client.viewer.apiKeys.create.mutate(event);
setApiKey(apiKey);
setApiKeyDetails({ ...event });
await utils.viewer.apiKeys.list.invalidate();
revalidateApiKeysList();
setSuccessfulNewApiKeyModal(true);
}
}}
className="space-y-4">
<div className="mb-4 mt-1">
<h2 className="font-semi-bold font-cal text-emphasis text-xl tracking-wide">
{defaultValues ? t("edit_api_key") : t("create_api_key")}
</h2>
{IS_CALCOM ? (
<div className="mt-4 block gap-2 sm:flex">
<div className="border-emphasis relative flex w-full items-start rounded-[10px] border p-4 text-sm">
{t("api_key_modal_subtitle")}
</div>
<Link
target="_blank"
rel="noopener noreferrer"
href="https://cal.com/platform"
className="border-subtle relative flex w-full items-start rounded-[10px] border p-4 text-sm">
{t("api_key_modal_subtitle_platform")}
</Link>
</div>
) : (
<p className="text-subtle mb-5 mt-1 text-sm">{t("api_key_modal_subtitle")}</p>
)}
</div>
<div>
<Controller
name="note"
control={form.control}
render={({ field: { onChange, value } }) => (
<TextField
name="note"
label={t("personal_note")}
placeholder={t("personal_note_placeholder")}
value={value}
onChange={(e) => {
form.setValue("note", e?.target.value);
}}
type="text"
/>
)}
/>
</div>
{!defaultValues && (
<div className="flex flex-col">
<div className="flex justify-between py-2">
<span className="text-default block text-sm font-medium">{t("expire_date")}</span>
<Controller
name="neverExpires"
control={form.control}
render={({ field: { onChange, value } }) => (
<Switch
label={t("never_expires")}
onCheckedChange={onChange}
checked={value}
disabled={!!defaultValues}
/>
)}
/>
</div>
<Controller
name="expiresAt"
render={({ field: { onChange, value } }) => {
const defaultValue = expiresAtOptions[1];
return (
<SelectField
styles={{
singleValue: (baseStyles) => ({
...baseStyles,
fontSize: "14px",
}),
option: (baseStyles) => ({
...baseStyles,
fontSize: "14px",
}),
}}
isDisabled={watchNeverExpires || !!defaultValues}
containerClassName="data-testid-field-type"
options={expiresAtOptions}
onChange={(option) => {
if (!option) {
return;
}
onChange(option.value);
setExpiryDate(option.value);
}}
defaultValue={defaultValue}
/>
);
}}
/>
{!watchNeverExpires && (
<span className="text-subtle mt-2 text-xs">
{t("api_key_expires_on")}
<span className="font-bold"> {dayjs(expiryDate).format("DD-MM-YYYY")}</span>
</span>
)}
</div>
)}
<DialogFooter showDivider className="relative">
<Button type="button" color="secondary" onClick={handleClose} tabIndex={-1}>
{t("cancel")}
</Button>
<Button type="submit" loading={form.formState.isSubmitting}>
{apiKeyDetails ? t("save") : t("create")}
</Button>
</DialogFooter>
</Form>
)}
</LicenseRequired>
);
}