mirror of
https://github.com/outline/outline.git
synced 2026-11-22 05:51:43 +03:00
* chore: Prune redundant comments and normalize lint directives Removes comments that restate the following line and stale TODOs, drops the passive event listener feature check now that all supported browsers support it, and renames eslint directives to oxlint. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BehTjuZwKbN5csMCp3H4QH * fix: Evaluate restricted team domains at validation time The restricted email provider list was captured when the model loaded, so it could not follow the hosting environment and the tests that covered it never reached the model. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BehTjuZwKbN5csMCp3H4QH * chore: Replace type suppressions with accurate types Adds a Concrete helper type for registries of abstract classes, declares missing Sequelize and refractor typings, uses public ProseMirror APIs, a typed mock context helper in middleware tests, and a StaticLink component for sidebar rows being edited. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BehTjuZwKbN5csMCp3H4QH --------- Co-authored-by: Claude <noreply@anthropic.com>
316 lines
8.9 KiB
TypeScript
316 lines
8.9 KiB
TypeScript
import { uniq } from "es-toolkit/compat";
|
|
import { observer } from "mobx-react";
|
|
import { useMemo, useEffect, useCallback, Suspense } from "react";
|
|
import { Controller, useForm } from "react-hook-form";
|
|
import { Trans, useTranslation } from "react-i18next";
|
|
import styled from "styled-components";
|
|
import Icon from "@shared/components/Icon";
|
|
import { randomElement } from "@shared/random";
|
|
import { CollectionPermission } from "@shared/types";
|
|
import type { Option } from "~/components/InputSelect";
|
|
import { IconLibrary } from "@shared/utils/IconLibrary";
|
|
import { colorPalette } from "@shared/constants";
|
|
import { CollectionValidation } from "@shared/validations";
|
|
import type Collection from "~/models/Collection";
|
|
import Button from "~/components/Button";
|
|
import { Collapsible } from "~/components/Collapsible";
|
|
import Input from "~/components/Input";
|
|
import { InputSelect } from "~/components/InputSelect";
|
|
import { InputSelectPermission } from "~/components/InputSelectPermission";
|
|
import { createLazyComponent } from "~/components/LazyLoad";
|
|
import Switch from "~/components/Switch";
|
|
import Text from "~/components/Text";
|
|
import useBoolean from "~/hooks/useBoolean";
|
|
import useCurrentTeam from "~/hooks/useCurrentTeam";
|
|
import useStores from "~/hooks/useStores";
|
|
import { EmptySelectValue } from "~/types";
|
|
import { HStack } from "../primitives/HStack";
|
|
import { useDialogContext } from "~/components/DialogContext";
|
|
|
|
const IconPicker = createLazyComponent(() => import("~/components/IconPicker"));
|
|
|
|
export type FormData = {
|
|
name: string;
|
|
icon: string;
|
|
color: string | null;
|
|
sharing: boolean;
|
|
permission: CollectionPermission | undefined;
|
|
commenting?: boolean | null;
|
|
templateManagement: CollectionPermission;
|
|
};
|
|
|
|
const useIconColor = (collection?: Collection) => {
|
|
const { collections } = useStores();
|
|
const hasMultipleCollections = collections.orderedData.length > 1;
|
|
const collectionColors = uniq(
|
|
collections.orderedData.map((c) => c.color).filter(Boolean)
|
|
) as string[];
|
|
|
|
const iconColor = useMemo(
|
|
() =>
|
|
collection?.color ??
|
|
// If all the existing collections have the same color, use that color,
|
|
// otherwise pick a random color from the palette
|
|
(hasMultipleCollections && collectionColors.length === 1
|
|
? collectionColors[0]
|
|
: randomElement(colorPalette)),
|
|
// Deliberately only keyed on the collection color so the randomly picked
|
|
// fallback stays stable while the form is open.
|
|
// oxlint-disable-next-line react-hooks/exhaustive-deps
|
|
[collection?.color]
|
|
);
|
|
return iconColor;
|
|
};
|
|
|
|
export const CollectionForm = observer(function CollectionForm_({
|
|
handleSubmit,
|
|
collection,
|
|
}: {
|
|
handleSubmit: (data: FormData) => void;
|
|
collection?: Collection;
|
|
}) {
|
|
const team = useCurrentTeam();
|
|
const { t } = useTranslation();
|
|
const dialog = useDialogContext();
|
|
|
|
const [hasOpenedIconPicker, setHasOpenedIconPicker] = useBoolean(false);
|
|
|
|
const templateManagementOptions = useMemo<Option[]>(
|
|
() => [
|
|
{
|
|
type: "item",
|
|
label: t("Managers"),
|
|
value: CollectionPermission.Admin,
|
|
},
|
|
{
|
|
type: "item",
|
|
label: t("Members"),
|
|
value: CollectionPermission.ReadWrite,
|
|
},
|
|
],
|
|
[t]
|
|
);
|
|
|
|
const iconColor = useIconColor(collection);
|
|
const fallbackIcon = (
|
|
<Icon
|
|
value="collection"
|
|
initial={collection?.initial ?? "?"}
|
|
color={iconColor}
|
|
/>
|
|
);
|
|
|
|
const {
|
|
register,
|
|
handleSubmit: formHandleSubmit,
|
|
formState,
|
|
watch,
|
|
control,
|
|
setValue,
|
|
setFocus,
|
|
} = useForm<FormData>({
|
|
mode: "all",
|
|
defaultValues: {
|
|
name: collection?.name ?? "",
|
|
icon: collection?.icon,
|
|
sharing: collection?.sharing ?? true,
|
|
permission: collection?.permission,
|
|
commenting: collection?.commenting ?? true,
|
|
templateManagement:
|
|
collection?.templateManagement ?? CollectionPermission.Admin,
|
|
color: iconColor,
|
|
},
|
|
});
|
|
|
|
const values = watch();
|
|
|
|
// Preload the IconPicker component on mount
|
|
useEffect(() => {
|
|
void IconPicker.preload();
|
|
}, []);
|
|
|
|
useEffect(() => {
|
|
// If the user hasn't picked an icon yet, go ahead and suggest one based on
|
|
// the name of the collection. It's the little things sometimes.
|
|
if (!hasOpenedIconPicker && !collection) {
|
|
setValue(
|
|
"icon",
|
|
IconLibrary.findIconByKeyword(values.name) ??
|
|
values.icon ??
|
|
"collection"
|
|
);
|
|
}
|
|
}, [collection, hasOpenedIconPicker, setValue, values.name, values.icon]);
|
|
|
|
useEffect(() => {
|
|
setTimeout(() => setFocus("name", { shouldSelect: true }), 100);
|
|
}, [setFocus]);
|
|
|
|
const handleIconChange = useCallback(
|
|
(icon: string, color: string) => {
|
|
if (icon !== values.icon) {
|
|
setFocus("name");
|
|
}
|
|
|
|
setValue("icon", icon);
|
|
setValue("color", color);
|
|
},
|
|
[setFocus, setValue, values.icon]
|
|
);
|
|
|
|
const initial = values.name.charAt(0).toUpperCase();
|
|
|
|
const options = (
|
|
<>
|
|
<Controller
|
|
control={control}
|
|
name="templateManagement"
|
|
render={({ field }) => (
|
|
<>
|
|
<InputSelect
|
|
value={field.value}
|
|
onChange={(value: string) => {
|
|
field.onChange(value as CollectionPermission);
|
|
}}
|
|
options={templateManagementOptions}
|
|
label={t("Manage templates")}
|
|
/>
|
|
<Text
|
|
type="secondary"
|
|
size="small"
|
|
as="p"
|
|
style={{ paddingTop: 4 }}
|
|
>
|
|
{t(
|
|
"Choose who can create and edit templates in this collection."
|
|
)}
|
|
</Text>
|
|
</>
|
|
)}
|
|
/>
|
|
|
|
{team.sharing && (
|
|
<Controller
|
|
control={control}
|
|
name="sharing"
|
|
render={({ field }) => (
|
|
<Switch
|
|
id="sharing"
|
|
label={t("Public document sharing")}
|
|
note={t(
|
|
"Allow documents within this collection to be shared publicly on the internet."
|
|
)}
|
|
checked={field.value}
|
|
onChange={field.onChange}
|
|
/>
|
|
)}
|
|
/>
|
|
)}
|
|
|
|
{team.commentingEnabled && (
|
|
<Controller
|
|
control={control}
|
|
name="commenting"
|
|
render={({ field }) => (
|
|
<Switch
|
|
id="commenting"
|
|
label={t("Commenting")}
|
|
note={t("Allow commenting on documents within this collection.")}
|
|
checked={!!field.value}
|
|
onChange={field.onChange}
|
|
/>
|
|
)}
|
|
/>
|
|
)}
|
|
</>
|
|
);
|
|
|
|
return (
|
|
<form onSubmit={formHandleSubmit(handleSubmit)}>
|
|
<Text as="p">
|
|
<Trans>
|
|
Collections are used to group documents and choose permissions
|
|
</Trans>
|
|
</Text>
|
|
<HStack>
|
|
<Input
|
|
type="text"
|
|
label={t("Name")}
|
|
{...register("name", {
|
|
required: true,
|
|
maxLength: CollectionValidation.maxNameLength,
|
|
})}
|
|
prefix={
|
|
<Suspense fallback={fallbackIcon}>
|
|
<StyledIconPicker
|
|
icon={values.icon}
|
|
color={values.color ?? iconColor}
|
|
initial={initial}
|
|
popoverPosition="right"
|
|
onOpen={setHasOpenedIconPicker}
|
|
onChange={handleIconChange}
|
|
/>
|
|
</Suspense>
|
|
}
|
|
autoComplete="off"
|
|
autoFocus
|
|
flex
|
|
/>
|
|
</HStack>
|
|
|
|
{/* Following controls are available in create flow, but moved elsewhere for edit */}
|
|
{!collection && (
|
|
<Controller
|
|
control={control}
|
|
name="permission"
|
|
render={({ field }) => (
|
|
<InputSelectPermission
|
|
ref={field.ref}
|
|
value={field.value}
|
|
onChange={(
|
|
value: CollectionPermission | typeof EmptySelectValue
|
|
) => {
|
|
field.onChange(value === EmptySelectValue ? null : value);
|
|
}}
|
|
help={t(
|
|
"The default access for workspace members, you can share with more users or groups later."
|
|
)}
|
|
/>
|
|
)}
|
|
/>
|
|
)}
|
|
|
|
{collection ? (
|
|
options
|
|
) : (
|
|
<Collapsible
|
|
label={t("Advanced options")}
|
|
onOpenChange={() => dialog.setAnimating(true)}
|
|
>
|
|
{options}
|
|
</Collapsible>
|
|
)}
|
|
|
|
<HStack justify="flex-end">
|
|
<Button
|
|
type="submit"
|
|
disabled={formState.isSubmitting || !formState.isValid}
|
|
>
|
|
{collection
|
|
? formState.isSubmitting
|
|
? `${t("Saving")}…`
|
|
: t("Save")
|
|
: formState.isSubmitting
|
|
? `${t("Creating")}…`
|
|
: t("Create")}
|
|
</Button>
|
|
</HStack>
|
|
</form>
|
|
);
|
|
});
|
|
|
|
const StyledIconPicker = styled(IconPicker.Component)`
|
|
margin-left: 4px;
|
|
margin-right: 4px;
|
|
`;
|