Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use type guards for better type refinement in examples/usecase-blog-moderated #8796

Merged
merged 2 commits into from
Aug 31, 2023
Merged

Use type guards for better type refinement in examples/usecase-blog-moderated #8796

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b75ddd
use type guards for better type refinement
dcousens Aug 31, 2023
2e11f5b
add missing Session type for examples/auth
dcousens Aug 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/auth/schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ function isAdmin({ session }: { session?: Session }) {
return false;
}

export const lists: Lists = {
export const lists: Lists<Session> = {
User: list({
access: {
operation: {
Expand Down
46 changes: 30 additions & 16 deletions examples/usecase-blog-moderated/schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,40 @@ import type { Lists } from '.keystone/types';
export type Session = {
id: string;
admin: boolean;
contributor: null | { id: string };
moderator: null | { id: string };
contributor: null | { id: string };
};

type Has<T, K extends keyof T> = {
[key in keyof T]: key extends K ? Exclude<T[key], null | undefined> : T[key];
};

function isAdmin<T extends Session>(session?: T): session is T & { admin: true } {
return session?.admin === true;
}
function isModerator<T extends Session>(session?: T): session is Has<T, 'moderator'> {
return session?.moderator !== null;
}
function isContributor<T extends Session>(session?: T): session is Has<T, 'contributor'> {
return session?.contributor !== null;
}

function forUsers<T>({
admin,
moderator,
contributor,
default: _default,
}: {
admin?: ({ session }: { session: Session }) => T;
moderator?: ({ session }: { session: Session }) => T;
contributor?: ({ session }: { session: Session }) => T;
admin?: ({ session }: { session: Session & { admin: true } }) => T;
moderator?: ({ session }: { session: Has<Session, 'moderator'> }) => T;
contributor?: ({ session }: { session: Has<Session, 'contributor'> }) => T;
default: () => T;
}) {
return ({ session }: { session?: Session }): T => {
if (!session) return _default();
if (admin && session.admin) return admin({ session });
if (moderator && session.moderator) return moderator({ session });
if (contributor && session.contributor) return contributor({ session });
if (admin && isAdmin(session)) return admin({ session });
if (moderator && isModerator(session)) return moderator({ session });
if (contributor && isContributor(session)) return contributor({ session });
return _default();
};
}
Expand Down Expand Up @@ -109,7 +123,7 @@ export const lists: Lists<Session> = {
update: forUsers({
// contributors can only update their own posts
contributor: ({ session }) => ({
createdBy: { id: { equals: session.contributor?.id } },
createdBy: { id: { equals: session.contributor.id } },
hiddenBy: null,
}),
// otherwise, no filter
Expand Down Expand Up @@ -163,27 +177,27 @@ export const lists: Lists<Session> = {
},
hooks: {
resolveInput: {
create: ({ context, resolvedData }) => {
create: ({ context: { session }, resolvedData }) => {
resolvedData.createdAt = new Date();
if (context.session?.contributor) {
if (isContributor(session)) {
return {
...resolvedData,
createdBy: {
connect: {
id: context.session?.contributor?.id,
id: session.contributor.id,
},
},
};
}
return resolvedData;
},
update: ({ context, resolvedData }) => {
update: ({ context: { session }, resolvedData }) => {
resolvedData.updatedAt = new Date();
if ('hidden' in resolvedData && context.session?.moderator) {
if ('hidden' in resolvedData && isModerator(session)) {
resolvedData.hiddenBy = resolvedData.hidden
? {
connect: {
id: context.session?.moderator?.id,
id: session.moderator.id,
},
// TODO: should support : null
}
Expand Down Expand Up @@ -211,7 +225,7 @@ export const lists: Lists<Session> = {
filter: {
// contributors can only update themselves
update: forUsers({
contributor: ({ session }) => ({ id: { equals: session.contributor?.id } }),
contributor: ({ session }) => ({ id: { equals: session.contributor.id } }),
default: unfiltered,
}),
},
Expand All @@ -237,7 +251,7 @@ export const lists: Lists<Session> = {
filter: {
// moderators can only update themselves
update: forUsers({
moderator: ({ session }) => ({ id: { equals: session.moderator?.id } }),
moderator: ({ session }) => ({ id: { equals: session.moderator.id } }),
// otherwise, no filter
default: unfiltered,
}),
Expand Down