yuuza/outline
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: Add setting to allow users to send invites (#6488)

Browse Source
This commit is contained in:
Tom Moor
2024-02-03 17:37:39 -08:00
committed by GitHub
parent 9046892864
commit c2b7d01c7d
14 changed files with 121 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
app/components/InputSelectRole.tsx
View File

@@ -1,39 +0,0 @@
import * as React from "react";
import { useTranslation } from "react-i18next";
import { $Diff } from "utility-types";
import InputSelect, { Props, Option } from "~/components/InputSelect";
const InputSelectRole = (
props: $Diff<
Props,
{
options: Array<Option>;
ariaLabel: string;
}
>
) => {
const { t } = useTranslation();
return (
<InputSelect
label={t("Role")}
options={[
{
label: t("Editor"),
value: "member",
},
{
label: t("Viewer"),
value: "viewer",
},
{
label: t("Admin"),
value: "admin",
},
]}
ariaLabel={t("Role")}
{...props}
/>
);
};
export default InputSelectRole;

29
app/scenes/Invite.tsx
View File

@@ -12,7 +12,7 @@ import Button from "~/components/Button";
import CopyToClipboard from "~/components/CopyToClipboard";
import Flex from "~/components/Flex";
import Input from "~/components/Input";
import InputSelectRole from "~/components/InputSelectRole";
import InputSelect from "~/components/InputSelect";
import NudeButton from "~/components/NudeButton";
import { ResizingHeightContainer } from "~/components/ResizingHeightContainer";
import Text from "~/components/Text";
@@ -157,6 +157,28 @@ function Invite({ onSubmit }: Props) {
</span>
);
const options = React.useMemo(() => {
const options = [
{
label: t("Editor"),
value: "member",
},
{
label: t("Viewer"),
value: "viewer",
},
];
if (user.isAdmin) {
options.push({
label: t("Admin"),
value: "admin",
});
}
return options;
}, [t, user]);
return (
<form onSubmit={handleSubmit}>
{team.guestSignin ? (
@@ -236,7 +258,10 @@ function Invite({ onSubmit }: Props) {
required={!!invite.email}
flex
/>
<InputSelectRole
<InputSelect
label={t("Role")}
ariaLabel={t("Role")}
options={options}
onChange={(role: UserRole) => handleRoleChange(role, index)}
value={invite.role}
labelHidden={index !== 0}

23
app/scenes/Settings/Security.tsx
View File

@@ -60,7 +60,7 @@ function Security() {
const saveData = React.useCallback(
async (newData) => {
try {
setData(newData);
setData((prev) => ({ ...prev, ...newData }));
await team.save(newData);
showSuccessMessage();
} catch (err) {
@@ -72,16 +72,16 @@ function Security() {
const handleChange = React.useCallback(
async (ev: React.ChangeEvent<HTMLInputElement>) => {
await saveData({ ...data, [ev.target.id]: ev.target.checked });
await saveData({ [ev.target.id]: ev.target.checked });
},
[data, saveData]
[saveData]
);
const handleDefaultRoleChange = React.useCallback(
async (newDefaultRole: string) => {
await saveData({ ...data, defaultUserRole: newDefaultRole });
await saveData({ defaultUserRole: newDefaultRole });
},
[data, saveData]
[saveData]
);
const handlePreferenceChange = React.useCallback(
@@ -192,6 +192,17 @@ function Security() {
</SettingRow>
<h2>{t("Access")}</h2>
<SettingRow
label={t("Allow users to send invites")}
name={TeamPreference.MembersCanInvite}
description={t("Allow editors to invite other people to the workspace")}
>
<Switch
id={TeamPreference.MembersCanInvite}
checked={team.getPreference(TeamPreference.MembersCanInvite)}
onChange={handlePreferenceChange}
/>
</SettingRow>
{isCloudHosted && (
<SettingRow
label={t("Require invites")}
@@ -280,7 +291,7 @@ function Security() {
label={t("Collection creation")}
name="memberCollectionCreate"
description={t(
"Allow members to create new collections within the workspace"
"Allow editors to create new collections within the workspace"
)}
>
<Switch

4
server/commands/userInviter.ts
View File

@@ -58,8 +58,8 @@ export default async function userInviter({
teamId: user.teamId,
name: invite.name,
email: invite.email,
isAdmin: invite.role === UserRole.Admin,
isViewer: invite.role === UserRole.Viewer,
isAdmin: user.isAdmin && invite.role === UserRole.Admin,
isViewer: user.isViewer || invite.role === UserRole.Viewer,
invitedById: user.id,
flags: {
[UserFlag.InviteSent]: 1,

4
server/middlewares/authentication.test.ts
View File

@@ -1,7 +1,7 @@
import { DefaultState } from "koa";
import randomstring from "randomstring";
import ApiKey from "@server/models/ApiKey";
import { buildUser, buildTeam } from "@server/test/factories";
import { buildUser, buildTeam, buildAdmin } from "@server/test/factories";
import auth from "./authentication";
describe("Authentication middleware", () => {
@@ -156,7 +156,7 @@ describe("Authentication middleware", () => {
it("should return an error for suspended users", async () => {
const state = {} as DefaultState;
const admin = await buildUser();
const admin = await buildAdmin();
const user = await buildUser({
suspendedAt: new Date(),
suspendedById: admin.id,

9
server/models/Team.ts
View File

@@ -26,6 +26,7 @@ import {
AllowNull,
AfterUpdate,
BeforeUpdate,
BeforeCreate,
} from "sequelize-typescript";
import { TeamPreferenceDefaults } from "@shared/constants";
import {
@@ -347,6 +348,14 @@ class Team extends ParanoidModel<
// hooks
@BeforeCreate
static async setPreferences(model: Team) {
// Set here rather than in TeamPreferenceDefaults as we only want to enable by default for new
// workspaces.
model.setPreference(TeamPreference.MembersCanInvite, true);
return model;
}
@BeforeUpdate
static async checkDomain(model: Team, options: SaveOptions) {
if (!model.domain) {

2
server/policies/index.test.ts
View File

@@ -15,5 +15,5 @@ it("should serialize domain policies on Team", async () => {
});
const response = serialize(user, team);
expect(response.createDocument).toEqual(true);
expect(response.inviteUser).toEqual(false);
expect(response.inviteUser).toEqual(true);
});

5
server/policies/user.ts
View File

@@ -1,3 +1,4 @@
import { TeamPreference } from "@shared/types";
import { User, Team } from "@server/models";
import { AdminRequiredError } from "../errors";
import { allow } from "./cancan";
@@ -10,10 +11,10 @@ allow(
);
allow(User, "inviteUser", Team, (actor, team) => {
if (!team || actor.teamId !== team.id) {
if (!team || actor.teamId !== team.id || actor.isViewer) {
return false;
}
if (actor.isAdmin) {
if (actor.isAdmin || team.getPreference(TeamPreference.MembersCanInvite)) {
return true;
}

2
server/routes/api/teams/schema.ts
View File

@@ -35,6 +35,8 @@ export const TeamsUpdateSchema = BaseSchema.extend({
publicBranding: z.boolean().optional(),
/** Whether viewers should see download options. */
viewersCanExport: z.boolean().optional(),
/** Whether members can invite new people to the team. */
membersCanInvite: z.boolean().optional(),
/** Whether commenting is enabled */
commenting: z.boolean().optional(),
/** The custom theme for the team. */

4
server/routes/api/teams/teams.ts
View File

@@ -47,7 +47,7 @@ const handleTeamUpdate = async (ctx: APIContext<T.TeamsUpdateSchemaReq>) => {
router.post(
"team.update",
rateLimiter(RateLimiterStrategy.TenPerHour),
rateLimiter(RateLimiterStrategy.TenPerMinute),
auth(),
validate(T.TeamsUpdateSchema),
transaction(),
@@ -56,7 +56,7 @@ router.post(
router.post(
"teams.update",
rateLimiter(RateLimiterStrategy.TenPerHour),
rateLimiter(RateLimiterStrategy.TenPerMinute),
auth(),
validate(T.TeamsUpdateSchema),
transaction(),

48
server/routes/api/users/users.test.ts
View File

@@ -1,8 +1,10 @@
import { TeamPreference } from "@shared/types";
import {
buildTeam,
buildAdmin,
buildUser,
buildInvite,
buildViewer,
} from "@server/test/factories";
import { getTestServer } from "@server/test/support";
@@ -271,11 +273,51 @@ describe("#users.invite", () => {
expect(res.status).toEqual(400);
});
it("should require admin", async () => {
const admin = await buildUser();
it("should allow members to invite members", async () => {
const user = await buildUser();
const res = await server.post("/api/users.invite", {
body: {
token: admin.getJwtToken(),
token: user.getJwtToken(),
invites: [
{
email: "test@example.com",
name: "Test",
role: "member",
},
],
},
});
const body = await res.json();
expect(res.status).toEqual(200);
expect(body.data.sent.length).toEqual(1);
});
it("should now allow viewers to invite", async () => {
const user = await buildViewer();
const res = await server.post("/api/users.invite", {
body: {
token: user.getJwtToken(),
invites: [
{
email: "test@example.com",
name: "Test",
role: "member",
},
],
},
});
expect(res.status).toEqual(403);
});
it("should allow restricting invites to admin", async () => {
const team = await buildTeam();
team.setPreference(TeamPreference.MembersCanInvite, false);
await team.save();
const user = await buildUser({ teamId: team.id });
const res = await server.post("/api/users.invite", {
body: {
token: user.getJwtToken(),
invites: [
{
email: "test@example.com",

1
shared/constants.ts
View File

@@ -17,6 +17,7 @@ export const Pagination = {
export const TeamPreferenceDefaults: TeamPreferences = {
[TeamPreference.SeamlessEdit]: true,
[TeamPreference.ViewersCanExport]: true,
[TeamPreference.MembersCanInvite]: false,
[TeamPreference.PublicBranding]: false,
[TeamPreference.Commenting]: true,
[TeamPreference.CustomTheme]: undefined,

12
shared/i18n/locales/en_US/translation.json
View File

@@ -232,10 +232,6 @@
"View only": "View only",
"No access": "No access",
"Default access": "Default access",
"Role": "Role",
"Editor": "Editor",
"Viewer": "Viewer",
"Admin": "Admin",
"{{appName}} is available in your language {{optionLabel}}, would you like to change?": "{{appName}} is available in your language {{optionLabel}}, would you like to change?",
"Change Language": "Change Language",
"Dismiss": "Dismiss",
@@ -256,6 +252,8 @@
"Has access through <2>parent</2>": "Has access through <2>parent</2>",
"Suspended": "Suspended",
"Invited": "Invited",
"Viewer": "Viewer",
"Editor": "Editor",
"Leave": "Leave",
"All members": "All members",
"Everyone in the workspace": "Everyone in the workspace",
@@ -509,6 +507,7 @@
"Search people": "Search people",
"No people matching your search": "No people matching your search",
"No people left to add": "No people left to add",
"Admin": "Admin",
"Active <1></1> ago": "Active <1></1> ago",
"Never signed in": "Never signed in",
"{{ userName }} was removed from the collection": "{{ userName }} was removed from the collection",
@@ -659,6 +658,7 @@
"As an admin you can also <2>enable email sign-in</2>.": "As an admin you can also <2>enable email sign-in</2>.",
"Want a link to share directly with your team?": "Want a link to share directly with your team?",
"Email": "Email",
"Role": "Role",
"Remove invite": "Remove invite",
"Add another": "Add another",
"Inviting": "Inviting",
@@ -903,6 +903,8 @@
"Allow members to sign-in using their email address": "Allow members to sign-in using their email address",
"The server must have SMTP configured to enable this setting": "The server must have SMTP configured to enable this setting",
"Access": "Access",
"Allow users to send invites": "Allow users to send invites",
"Allow editors to invite other people to the workspace": "Allow editors to invite other people to the workspace",
"Require invites": "Require invites",
"Require members to be invited to the workspace before they can create an account using SSO.": "Require members to be invited to the workspace before they can create an account using SSO.",
"Default role": "Default role",
@@ -913,7 +915,7 @@
"Rich service embeds": "Rich service embeds",
"Links to supported services are shown as rich embeds within your documents": "Links to supported services are shown as rich embeds within your documents",
"Collection creation": "Collection creation",
"Allow members to create new collections within the workspace": "Allow members to create new collections within the workspace",
"Allow editors to create new collections within the workspace": "Allow editors to create new collections within the workspace",
"Draw.io deployment": "Draw.io deployment",
"Add your self-hosted draw.io installation url here to enable automatic embedding of diagrams within documents.": "Add your self-hosted draw.io installation url here to enable automatic embedding of diagrams within documents.",
"Grist deployment": "Grist deployment",

3
shared/types.ts
View File

@@ -163,6 +163,8 @@ export enum TeamPreference {
PublicBranding = "publicBranding",
/** Whether viewers should see download options. */
ViewersCanExport = "viewersCanExport",
/** Whether members can invite new users. */
MembersCanInvite = "membersCanInvite",
/** Whether users can comment on documents. */
Commenting = "commenting",
/** The custom theme for the team. */
@@ -173,6 +175,7 @@ export type TeamPreferences = {
[TeamPreference.SeamlessEdit]?: boolean;
[TeamPreference.PublicBranding]?: boolean;
[TeamPreference.ViewersCanExport]?: boolean;
[TeamPreference.MembersCanInvite]?: boolean;
[TeamPreference.Commenting]?: boolean;
[TeamPreference.CustomTheme]?: Partial<CustomTheme>;
};