@supernova-studio/model 0.54.34 → 0.55.0

package/package.json

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

package/src/emails/design-system-invite.ts

@@ -0,0 +1,29 @@
+import { z } from "zod";
+import { DesignSystem } from "../dsm/design-system";
+import { User } from "../users/user";
+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 (or design design system).
+ */
+export const DesignSystemInviteEmailRecipient = 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 design system.
+ */
+export const DesignSystemInviteEmailData = z.object({
+  designSystem: DesignSystem,
+  invitedBy: User,
+  documentationDomain: z.string().optional(),
+});
+
+export type DesignSystemInviteEmailRecipient = z.infer<typeof DesignSystemInviteEmailRecipient>;
+export type DesignSystemInviteEmailData = z.infer<typeof DesignSystemInviteEmailData>;

package/src/emails/index.ts

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

package/src/index.ts

@@ -6,6 +6,7 @@ export * from "./custom-domains";
 export * from "./data-dumps";
 export * from "./docs-server";
 export * from "./dsm";
+export * from "./emails";
 export * from "./events";
 export * from "./export";
 export * from "./feature-flags";

package/src/workspace/workspace-invitations.ts

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