250 lines
8.5 KiB
TypeScript
250 lines
8.5 KiB
TypeScript
"use client";
|
|
|
|
import type { FC } from "react";
|
|
import { useState } from "react";
|
|
import { isEmpty } from "lodash-es";
|
|
import Link from "next/link";
|
|
import { useForm } from "react-hook-form";
|
|
import { Monitor } from "lucide-react";
|
|
// plane internal packages
|
|
import { API_BASE_URL } from "@plane/constants";
|
|
import { Button, getButtonStyling } from "@plane/propel/button";
|
|
import { TOAST_TYPE, setToast } from "@plane/propel/toast";
|
|
import type { IFormattedInstanceConfiguration, TInstanceGithubAuthenticationConfigurationKeys } from "@plane/types";
|
|
|
|
import { cn } from "@plane/utils";
|
|
// components
|
|
import { CodeBlock } from "@/components/common/code-block";
|
|
import { ConfirmDiscardModal } from "@/components/common/confirm-discard-modal";
|
|
import type { TControllerInputFormField } from "@/components/common/controller-input";
|
|
import { ControllerInput } from "@/components/common/controller-input";
|
|
import type { TCopyField } from "@/components/common/copy-field";
|
|
import { CopyField } from "@/components/common/copy-field";
|
|
// hooks
|
|
import { useInstance } from "@/hooks/store";
|
|
|
|
type Props = {
|
|
config: IFormattedInstanceConfiguration;
|
|
};
|
|
|
|
type GithubConfigFormValues = Record<TInstanceGithubAuthenticationConfigurationKeys, string>;
|
|
|
|
export const InstanceGithubConfigForm: FC<Props> = (props) => {
|
|
const { config } = props;
|
|
// states
|
|
const [isDiscardChangesModalOpen, setIsDiscardChangesModalOpen] = useState(false);
|
|
// store hooks
|
|
const { updateInstanceConfigurations } = useInstance();
|
|
// form data
|
|
const {
|
|
handleSubmit,
|
|
control,
|
|
reset,
|
|
formState: { errors, isDirty, isSubmitting },
|
|
} = useForm<GithubConfigFormValues>({
|
|
defaultValues: {
|
|
GITHUB_CLIENT_ID: config["GITHUB_CLIENT_ID"],
|
|
GITHUB_CLIENT_SECRET: config["GITHUB_CLIENT_SECRET"],
|
|
GITHUB_ORGANIZATION_ID: config["GITHUB_ORGANIZATION_ID"],
|
|
},
|
|
});
|
|
|
|
const originURL = !isEmpty(API_BASE_URL) ? API_BASE_URL : typeof window !== "undefined" ? window.location.origin : "";
|
|
|
|
const GITHUB_FORM_FIELDS: TControllerInputFormField[] = [
|
|
{
|
|
key: "GITHUB_CLIENT_ID",
|
|
type: "text",
|
|
label: "Client ID",
|
|
description: (
|
|
<>
|
|
You will get this from your{" "}
|
|
<a
|
|
tabIndex={-1}
|
|
href="https://github.com/settings/applications/new"
|
|
target="_blank"
|
|
className="text-custom-primary-100 hover:underline"
|
|
rel="noreferrer"
|
|
>
|
|
GitHub OAuth application settings.
|
|
</a>
|
|
</>
|
|
),
|
|
placeholder: "70a44354520df8bd9bcd",
|
|
error: Boolean(errors.GITHUB_CLIENT_ID),
|
|
required: true,
|
|
},
|
|
{
|
|
key: "GITHUB_CLIENT_SECRET",
|
|
type: "password",
|
|
label: "Client secret",
|
|
description: (
|
|
<>
|
|
Your client secret is also found in your{" "}
|
|
<a
|
|
tabIndex={-1}
|
|
href="https://github.com/settings/applications/new"
|
|
target="_blank"
|
|
className="text-custom-primary-100 hover:underline"
|
|
rel="noreferrer"
|
|
>
|
|
GitHub OAuth application settings.
|
|
</a>
|
|
</>
|
|
),
|
|
placeholder: "9b0050f94ec1b744e32ce79ea4ffacd40d4119cb",
|
|
error: Boolean(errors.GITHUB_CLIENT_SECRET),
|
|
required: true,
|
|
},
|
|
{
|
|
key: "GITHUB_ORGANIZATION_ID",
|
|
type: "text",
|
|
label: "Organization ID",
|
|
description: <>The organization github ID.</>,
|
|
placeholder: "123456789",
|
|
error: Boolean(errors.GITHUB_ORGANIZATION_ID),
|
|
required: false,
|
|
},
|
|
];
|
|
|
|
const GITHUB_COMMON_SERVICE_DETAILS: TCopyField[] = [
|
|
{
|
|
key: "Origin_URL",
|
|
label: "Origin URL",
|
|
url: originURL,
|
|
description: (
|
|
<>
|
|
We will auto-generate this. Paste this into the <CodeBlock darkerShade>Authorized origin URL</CodeBlock> field{" "}
|
|
<a
|
|
tabIndex={-1}
|
|
href="https://github.com/settings/applications/new"
|
|
target="_blank"
|
|
className="text-custom-primary-100 hover:underline"
|
|
rel="noreferrer"
|
|
>
|
|
here.
|
|
</a>
|
|
</>
|
|
),
|
|
},
|
|
];
|
|
|
|
const GITHUB_SERVICE_DETAILS: TCopyField[] = [
|
|
{
|
|
key: "Callback_URI",
|
|
label: "Callback URI",
|
|
url: `${originURL}/auth/github/callback/`,
|
|
description: (
|
|
<>
|
|
We will auto-generate this. Paste this into your <CodeBlock darkerShade>Authorized Callback URI</CodeBlock>{" "}
|
|
field{" "}
|
|
<a
|
|
tabIndex={-1}
|
|
href="https://github.com/settings/applications/new"
|
|
target="_blank"
|
|
className="text-custom-primary-100 hover:underline"
|
|
rel="noreferrer"
|
|
>
|
|
here.
|
|
</a>
|
|
</>
|
|
),
|
|
},
|
|
];
|
|
|
|
const onSubmit = async (formData: GithubConfigFormValues) => {
|
|
const payload: Partial<GithubConfigFormValues> = { ...formData };
|
|
|
|
await updateInstanceConfigurations(payload)
|
|
.then((response = []) => {
|
|
setToast({
|
|
type: TOAST_TYPE.SUCCESS,
|
|
title: "Done!",
|
|
message: "Your GitHub authentication is configured. You should test it now.",
|
|
});
|
|
reset({
|
|
GITHUB_CLIENT_ID: response.find((item) => item.key === "GITHUB_CLIENT_ID")?.value,
|
|
GITHUB_CLIENT_SECRET: response.find((item) => item.key === "GITHUB_CLIENT_SECRET")?.value,
|
|
GITHUB_ORGANIZATION_ID: response.find((item) => item.key === "GITHUB_ORGANIZATION_ID")?.value,
|
|
});
|
|
})
|
|
.catch((err) => console.error(err));
|
|
};
|
|
|
|
const handleGoBack = (e: React.MouseEvent<HTMLAnchorElement, MouseEvent>) => {
|
|
if (isDirty) {
|
|
e.preventDefault();
|
|
setIsDiscardChangesModalOpen(true);
|
|
}
|
|
};
|
|
|
|
return (
|
|
<>
|
|
<ConfirmDiscardModal
|
|
isOpen={isDiscardChangesModalOpen}
|
|
onDiscardHref="/authentication"
|
|
handleClose={() => setIsDiscardChangesModalOpen(false)}
|
|
/>
|
|
<div className="flex flex-col gap-8">
|
|
<div className="grid grid-cols-2 gap-x-12 gap-y-8 w-full">
|
|
<div className="flex flex-col gap-y-4 col-span-2 md:col-span-1 pt-1">
|
|
<div className="pt-2.5 text-xl font-medium">GitHub-provided details for Plane</div>
|
|
{GITHUB_FORM_FIELDS.map((field) => (
|
|
<ControllerInput
|
|
key={field.key}
|
|
control={control}
|
|
type={field.type}
|
|
name={field.key}
|
|
label={field.label}
|
|
description={field.description}
|
|
placeholder={field.placeholder}
|
|
error={field.error}
|
|
required={field.required}
|
|
/>
|
|
))}
|
|
<div className="flex flex-col gap-1 pt-4">
|
|
<div className="flex items-center gap-4">
|
|
<Button variant="primary" onClick={handleSubmit(onSubmit)} loading={isSubmitting} disabled={!isDirty}>
|
|
{isSubmitting ? "Saving..." : "Save changes"}
|
|
</Button>
|
|
<Link
|
|
href="/authentication"
|
|
className={cn(getButtonStyling("neutral-primary", "md"), "font-medium")}
|
|
onClick={handleGoBack}
|
|
>
|
|
Go back
|
|
</Link>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div className="col-span-2 md:col-span-1 flex flex-col gap-y-6">
|
|
<div className="pt-2 text-xl font-medium">Plane-provided details for GitHub</div>
|
|
|
|
<div className="flex flex-col gap-y-4">
|
|
{/* common service details */}
|
|
<div className="flex flex-col gap-y-4 px-6 py-4 bg-custom-background-80 rounded-lg">
|
|
{GITHUB_COMMON_SERVICE_DETAILS.map((field) => (
|
|
<CopyField key={field.key} label={field.label} url={field.url} description={field.description} />
|
|
))}
|
|
</div>
|
|
|
|
{/* web service details */}
|
|
<div className="flex flex-col rounded-lg overflow-hidden">
|
|
<div className="px-6 py-3 bg-custom-background-80/60 font-medium text-xs uppercase flex items-center gap-x-3 text-custom-text-200">
|
|
<Monitor className="w-3 h-3" />
|
|
Web
|
|
</div>
|
|
<div className="px-6 py-4 flex flex-col gap-y-4 bg-custom-background-80">
|
|
{GITHUB_SERVICE_DETAILS.map((field) => (
|
|
<CopyField key={field.key} label={field.label} url={field.url} description={field.description} />
|
|
))}
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</>
|
|
);
|
|
};
|