firstly 0.0.5 → 0.0.6

package/esm/mail/index.d.ts

@@ -1,11 +1,30 @@
 import type * as typeNodemailer from 'nodemailer';
+import type JSONTransport from 'nodemailer/lib/json-transport';
 import type Mail from 'nodemailer/lib/mailer';
-export type MailOptions = {
+import type SendmailTransport from 'nodemailer/lib/sendmail-transport';
+import type SESTransport from 'nodemailer/lib/ses-transport';
+import type SMTPPool from 'nodemailer/lib/smtp-pool';
+import type SMTPTransport from 'nodemailer/lib/smtp-transport';
+import type StreamTransport from 'nodemailer/lib/stream-transport';
+import type { ComponentProps, ComponentType, SvelteComponent } from 'svelte';
+import { DefaultMail } from '../';
+export type TransportTypes = SMTPTransport | SMTPTransport.Options | string | SMTPPool | SMTPPool.Options | SendmailTransport | SendmailTransport.Options | StreamTransport | StreamTransport.Options | JSONTransport | JSONTransport.Options | SESTransport | SESTransport.Options | typeNodemailer.Transport<any> | typeNodemailer.TransportOptions;
+export type DefaultOptions = SMTPTransport.Options | SMTPPool.Options | SendmailTransport.Options | StreamTransport.Options | JSONTransport.Options | SESTransport.Options | typeNodemailer.TransportOptions;
+export type MailOptions<ComponentTemplateDefault extends SvelteComponent> = {
     from?: Mail.Options['from'];
-    transport?: Parameters<typeof typeNodemailer.createTransport>[0];
+    template?: {
+        component?: ComponentType<ComponentTemplateDefault>;
+        brandColor?: string;
+    };
+    transport?: TransportTypes;
+    defaults?: DefaultOptions;
     apiUrl?: Parameters<typeof typeNodemailer.createTestAccount>[0];
 };
 declare let transporter: ReturnType<typeof typeNodemailer.createTransport>;
-export declare const mailInit: (nodemailer: typeof typeNodemailer, o?: MailOptions) => void;
-export declare const sendMail: (topic: string, mailOptions: Parameters<typeof transporter.sendMail>[0]) => ReturnType<typeof transporter.sendMail>;
+export declare const mailInit: (nodemailer: typeof typeNodemailer, o?: MailOptions<SvelteComponent>) => void;
+export declare const sendMail: <ComponentTemplateDefault extends SvelteComponent = DefaultMail>(
+/** usefull for logs, it has NO impact on the mail itself */
+topic: string, mailOptions: Parameters<typeof transporter.sendMail>[0] & {
+    templateProps?: ComponentProps<ComponentTemplateDefault> | undefined;
+}) => ReturnType<typeof transporter.sendMail>;
 export {};

package/esm/mail/index.js

@@ -1,16 +1,20 @@
-import { Log, magenta } from '@kitql/helpers';
+import { render } from 'svelte-email';
+import { cyan, green, Log, magenta, red, sleep, white } from '@kitql/helpers';
+import { DefaultMail } from '../';
+const log = new Log('firstly | mail');
+let nodemailerHolder;
 let transporter;
-let options;
-export const mailInit = (nodemailer, o) => {
-    options = o;
+let globalOptions;
+export const mailInit = async (nodemailer, o) => {
+    nodemailerHolder = nodemailer;
+    globalOptions = o;
     if (o?.transport) {
-        transporter = nodemailer.createTransport(o?.transport);
+        transporter = nodemailerHolder.createTransport(o?.transport, o?.defaults);
     }
     else {
-        nodemailerHolder = nodemailer;
         try {
-            nodemailer.createTestAccount(options?.apiUrl ?? '', (err, account) => {
-                options = { ...options, from: account.user };
+            nodemailer.createTestAccount(globalOptions?.apiUrl ?? '', (err, account) => {
+                globalOptions = { ...globalOptions, from: account.user };
                 transporter = nodemailer.createTransport({
                     host: account.smtp.host,
                     port: account.smtp.port,
@@ -27,21 +31,40 @@ export const mailInit = (nodemailer, o) => {
         }
     }
 };
-const log = new Log('firstly | mail');
-let nodemailerHolder;
 export const sendMail = async (topic, mailOptions) => {
+    // if the transporter is not ready, wait for it! (it can happen only if nothing is set...)
+    for (let i = 0; i < 30; i++) {
+        if (transporter !== undefined) {
+            break;
+        }
+        await sleep(100);
+    }
     try {
+        if (!mailOptions.html) {
+            const template = globalOptions?.template?.component ?? DefaultMail;
+            const props = {
+                brandColor: globalOptions?.template?.brandColor ?? '#5B68DF',
+                ...mailOptions.templateProps,
+            };
+            mailOptions.text = render({ template, props, options: { plainText: true, pretty: true } });
+            mailOptions.html = render({ template, props, options: { plainText: false, pretty: true } });
+        }
         const info = await transporter.sendMail({
             ...mailOptions,
-            ...{ from: mailOptions.from ?? options?.from },
+            ...{ from: mailOptions.from ?? globalOptions?.from },
         });
-        if (!options?.transport) {
-            log.info(
+        if (!globalOptions?.transport) {
+            log.error(`${magenta(`[${topic}]`)} - ⚠️  ${red(`mail not configured`)} ⚠️ 
+                 We are still nice and generated you an email preview link: 
+                 👉 ${cyan(String(nodemailerHolder.getTestMessageUrl(
             // @ts-ignore
-            `${magenta(`[${topic}]`)} - Preview URL: ${nodemailerHolder.getTestMessageUrl(info)}`);
+            info)))}
+
+                 To really send mails, check out the doc ${white(`https://firstly.fun/modules/mail`)}. 
+      `);
         }
         else {
-            log.success(`${magenta(`[${topic}]`)} - Sent to ${mailOptions.to}`);
+            log.success(`${magenta(`[${topic}]`)} - Sent to ${typeof mailOptions.to === 'string' ? green(mailOptions.to) : mailOptions.to}`);
         }
         return info;
     }

package/esm/mail/templates/DefaultMail.svelte

@@ -0,0 +1,66 @@
+<script>import { Button, Container, Head, Heading, Html, Preview, Section, Text } from "svelte-email";
+export let previewText;
+export let title;
+export let sections = [];
+export let brandColor = "#5B68DF";
+const fontFamily = '-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,Oxygen-Sans,Ubuntu,Cantarell,"Helvetica Neue",sans-serif';
+const main = {
+  backgroundColor: "#ffffff"
+};
+const container = {
+  margin: "0 auto",
+  padding: "20px 0 48px",
+  width: "580px"
+};
+const heading = {
+  fontFamily,
+  fontSize: "32px",
+  lineHeight: "1.3",
+  fontWeight: "700",
+  color: "#484848"
+};
+const paragraph = {
+  fontFamily,
+  fontSize: "18px",
+  lineHeight: "1.4",
+  color: "#484848"
+};
+const highlighted = {
+  ...paragraph,
+  padding: "24px",
+  backgroundColor: "#f2f3f3",
+  borderRadius: "4px"
+};
+const button = {
+  fontFamily,
+  backgroundColor: brandColor,
+  borderRadius: "5px",
+  color: "#fff",
+  fontSize: "18px",
+  textDecoration: "none",
+  textAlign: "center",
+  display: "block",
+  width: "100%"
+};
+</script>
+
+<Html>
+  <Head />
+  <Preview preview={previewText ?? title + '...'} />
+  <Section style={main}>
+    <Container style={container}>
+      {#if title}
+        <Heading style={heading}>{title}</Heading>
+      {/if}
+
+      {#each sections as s}
+        <Text style={s.highlighted ? highlighted : paragraph}>
+          {s.text}
+        </Text>
+        {#if s.cta}
+          <Button pY={19} style={button} href={s.cta.link}>{s.cta.text}</Button>
+        {/if}
+      {/each}
+    </Container>
+  </Section>
+</Html>

package/esm/mail/templates/DefaultMail.svelte.d.ts

@@ -0,0 +1,28 @@
+import { SvelteComponent } from "svelte";
+declare const __propDef: {
+    props: {
+        previewText: string | undefined;
+        title: string | undefined;
+        sections?: {
+            text: string;
+            highlighted?: boolean | undefined;
+            cta?: {
+                text: string;
+                link: string;
+            } | undefined;
+        }[] | undefined;
+        brandColor?: string | undefined;
+    };
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {};
+    exports?: {} | undefined;
+    bindings?: string | undefined;
+};
+export type DefaultMailProps = typeof __propDef.props;
+export type DefaultMailEvents = typeof __propDef.events;
+export type DefaultMailSlots = typeof __propDef.slots;
+export default class DefaultMail extends SvelteComponent<DefaultMailProps, DefaultMailEvents, DefaultMailSlots> {
+}
+export {};

package/esm/utils/types.d.ts

@@ -1,2 +1,5 @@
 export type ResolvedType<T> = T extends Promise<infer R> ? R : T;
 export type UnArray<T extends any[]> = T extends (infer U)[] ? U : never;
+export type RecursivePartial<T> = {
+    [P in keyof T]?: RecursivePartial<T[P]>;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firstly",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "type": "module",
   "description": "Firstly, an opinionated Remult setup!",
   "repository": {
@@ -31,6 +31,7 @@
     "lucia": "^3.2.0",
     "nodemailer": "^6.9.13",
     "oslo": "^1.2.0",
+    "svelte-email": "^0.0.4",
     "tailwind-merge": "^2.3.0",
     "tailwindcss": "^3.4.3",
     "vite": "^5.4.1",

package/esm/auth/static/assets/Page-BYzkK4q3.d.ts

@@ -1,5 +0,0 @@
-export { d as default };
-declare class d extends o {
-    constructor(t: any);
-}
-import { S as o } from "./index-czJ1PA1n.js";

package/esm/auth/static/assets/Page-BYzkK4q3.js

@@ -1 +0,0 @@
-import{S as o,b as r,a as i,H as l,d as c,n as a,k as f}from"./index-czJ1PA1n.js";function m(s){let t;return{c(){t=l("Hello from admin")},m(e,n){c(e,t,n)},p:a,i:a,o:a,d(e){e&&f(t)}}}class d extends o{constructor(t){super(),r(this,t,null,m,i,{})}}export{d as default};

package/esm/auth/static/assets/Page-ByIhtXVt.d.ts

@@ -1,5 +0,0 @@
-export { oo as default };
-declare class oo extends Je {
-    constructor(e: any);
-}
-import { S as Je } from './index-czJ1PA1n.js';