@supernova-studio/model 0.54.35 → 0.55.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supernova-studio/model",
-  "version": "0.54.35",
+  "version": "0.55.1",
   "description": "Supernova Data Models",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/emails/index.ts

@@ -1 +1,2 @@
 export * from "./design-system-invite";
+export * from "./workspace-invite";

package/src/emails/workspace-invite.ts

@@ -0,0 +1,29 @@
+import { z } from "zod";
+import { User } from "../users/user";
+import { Workspace } from "../workspace/workspace";
+import { WorkspaceRoleSchema } from "../workspace/workspace-role";
+
+/**
+ * Object describing who is going to receive the email.
+ *
+ * Normally recepient is just an email, however in some cases email can be tailored
+ * for who receives it. In this case the email has cutomization based on the role of the
+ * recepient in the workspace.
+ */
+export const WorkspaceInviteEmailRecipient = z.object({
+  email: z.string(),
+  role: WorkspaceRoleSchema,
+});
+
+/**
+ * Object describing the necessary data to send an email notifying a user that
+ * they've been added to a workspace.
+ */
+export const WorkspaceInviteEmailData = z.object({
+  workspace: Workspace,
+  invitedBy: User,
+  documentationDomain: z.string().optional(),
+});
+
+export type WorkspaceInviteEmailRecipient = z.infer<typeof WorkspaceInviteEmailRecipient>;
+export type WorkspaceInviteEmailData = z.infer<typeof WorkspaceInviteEmailData>;

package/src/workspace/workspace-invitations.ts

@@ -1,5 +1,7 @@
-import { WorkspaceRole } from "./workspace-role";
 import { z } from "zod";
+import { DbCreateInputOmit, DbUpdate } from "../helpers";
+import { OmitStrict } from "../utils";
+import { WorkspaceRole } from "./workspace-role";
 
 export const WorkspaceInvitation = z.object({
   id: z.string(),
@@ -12,3 +14,9 @@ export const WorkspaceInvitation = z.object({
 });
 
 export type WorkspaceInvitation = z.infer<typeof WorkspaceInvitation>;
+
+export type CreateWorkspaceInvitation = DbCreateInputOmit<WorkspaceInvitation>;
+export type UpdateWorkspaceInvitation = OmitStrict<
+  DbUpdate<WorkspaceInvitation>,
+  "email" | "invitedBy" | "workspaceId"
+>;

package/src/workspace/workspace-membership.ts

@@ -1,6 +1,8 @@
+import { z } from "zod";
+import { DbCreateInputOmit, DbUpdate } from "../helpers";
 import { UserNotificationSettings } from "../users";
+import { OmitStrict } from "../utils";
 import { WorkspaceRole } from "./workspace-role";
-import { z } from "zod";
 
 export const WorkspaceMembership = z.object({
   id: z.string(),
@@ -12,6 +14,9 @@ export const WorkspaceMembership = z.object({
 
 export type WorkspaceMembership = z.infer<typeof WorkspaceMembership>;
 
+export type CreateWorkspaceMembership = DbCreateInputOmit<WorkspaceMembership>;
+export type UpdateWorkspaceMembership = OmitStrict<DbUpdate<WorkspaceMembership>, "userId" | "workspaceId">;
+
 export const UpdateMembershipRolesInput = z.object({
   members: z.array(
     z.object({
@@ -20,4 +25,5 @@ export const UpdateMembershipRolesInput = z.object({
     })
   ),
 });
+
 export type UpdateMembershipRolesInput = z.infer<typeof UpdateMembershipRolesInput>;