Initial commit

README.md

@@ -0,0 +1,6 @@
+# Mail templates
+
+A simple utility to fill out templates. No templates are stored in source code.
+
+## Packages
+- [Frontend](./frontend/)

frontend/.env.example

@@ -0,0 +1 @@
+VITE_TEMPLATE_REPOSITORIES="some.tld/repo.txt"

frontend/.gitignore

@@ -0,0 +1,26 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+.env

frontend/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["svelte.svelte-vscode"]
+}

frontend/README.md

@@ -0,0 +1,47 @@
+# Svelte + TS + Vite
+
+This template should help get you started developing with Svelte and TypeScript in Vite.
+
+## Recommended IDE Setup
+
+[VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode).
+
+## Need an official Svelte framework?
+
+Check out [SvelteKit](https://github.com/sveltejs/kit#readme), which is also powered by Vite. Deploy anywhere with its serverless-first approach and adapt to various platforms, with out of the box support for TypeScript, SCSS, and Less, and easily-added support for mdsvex, GraphQL, PostCSS, Tailwind CSS, and more.
+
+## Technical considerations
+
+**Why use this over SvelteKit?**
+
+- It brings its own routing solution which might not be preferable for some users.
+- It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app.
+
+This template contains as little as possible to get started with Vite + TypeScript + Svelte, while taking into account the developer experience with regards to HMR and intellisense. It demonstrates capabilities on par with the other `create-vite` templates and is a good starting point for beginners dipping their toes into a Vite + Svelte project.
+
+Should you later need the extended capabilities and extensibility provided by SvelteKit, the template has been structured similarly to SvelteKit so that it is easy to migrate.
+
+**Why `global.d.ts` instead of `compilerOptions.types` inside `jsconfig.json` or `tsconfig.json`?**
+
+Setting `compilerOptions.types` shuts out all other types not explicitly listed in the configuration. Using triple-slash references keeps the default TypeScript setting of accepting type information from the entire workspace, while also adding `svelte` and `vite/client` type information.
+
+**Why include `.vscode/extensions.json`?**
+
+Other templates indirectly recommend extensions via the README, but this file allows VS Code to prompt the user to install the recommended extension upon opening the project.
+
+**Why enable `allowJs` in the TS template?**
+
+While `allowJs: false` would indeed prevent the use of `.js` files in the project, it does not prevent the use of JavaScript syntax in `.svelte` files. In addition, it would force `checkJs: false`, bringing the worst of both worlds: not being able to guarantee the entire codebase is TypeScript, and also having worse typechecking for the existing JavaScript. In addition, there are valid use cases in which a mixed codebase may be relevant.
+
+**Why is HMR not preserving my local component state?**
+
+HMR state preservation comes with a number of gotchas! It has been disabled by default in both `svelte-hmr` and `@sveltejs/vite-plugin-svelte` due to its often surprising behavior. You can read the details [here](https://github.com/rixo/svelte-hmr#svelte-hmr).
+
+If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR.
+
+```ts
+// store.ts
+// An extremely simple external store
+import { writable } from 'svelte/store'
+export default writable(0)
+```

frontend/docs/Repository.md

@@ -0,0 +1,20 @@
+# Repository
+
+A repository is a URL that serves a text file over HTTP. This file has the following structure:
+
+```
+TITLE: <Template title>
+
+Hi, {{Contact Person}}! I hope you are doing well.
+{{NOTE: Check something before sending}}
+(...)
+
+---
+
+TITLE: <Template title>
+
+(...)
+```
+
+You can set repositories using the `VITE_TEMPLATE_REPOSITORIES` environment variable at build.
+Example: `VITE_TEMPLATE_REPOSITORIES="some.tld/repo1.txt,some.tld/repo2.txt"`.

frontend/index.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>mail templates · asl</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>

frontend/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "frontend",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview",
+    "check": "svelte-check --tsconfig ./tsconfig.json && tsc -p tsconfig.node.json"
+  },
+  "devDependencies": {
+    "@sveltejs/vite-plugin-svelte": "^4.0.0",
+    "@tsconfig/svelte": "^5.0.4",
+    "autoprefixer": "^10.4.20",
+    "postcss": "^8.4.48",
+    "svelte": "^5.1.3",
+    "svelte-check": "^4.0.5",
+    "tailwindcss": "^3.4.14",
+    "tailwindcss-bg-patterns": "^0.3.0",
+    "tslib": "^2.8.0",
+    "typescript": "~5.6.2",
+    "vite": "^5.4.10"
+  }
+}

frontend/postcss.config.js

@@ -0,0 +1,6 @@
+export default {
+  plugins: {
+    tailwindcss: {},
+    autoprefixer: {},
+  },
+}

frontend/public/vite.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>

frontend/src/App.svelte

@@ -0,0 +1,40 @@
+<script lang="ts">
+    import { fetch_templates } from "./lib/api";
+    import Template from "./lib/Template.svelte";
+    import TemplateCard from "./lib/TemplateCard.svelte";
+
+    let templates = fetch_templates()
+
+    let template = $state<{ title: string, template: string } | undefined | null>();
+
+    function onPressTemplate(value: { title: string, template: string }) {
+      template = value
+    }
+</script>
+
+<header class="w-[100vw] py-2.5 flex justify-center">
+  <button onclick={() => template = undefined} class="text-4xl text-black decoration-emerald-600 underline font-bold">mail templates</button>
+</header>
+
+<div class="min-h-[100vh]">
+  {#if template == null}
+    {#await templates}
+      <span>Loading...</span>
+    {:then templates} 
+      <div class="p-5 grid gap-6 md:grid-cols-3">
+        {#each templates as { title, template }}
+          <TemplateCard onpress={onPressTemplate} template={template} title={title}/>
+        {/each}
+      </div>
+    {/await}
+  {:else}
+    <div class="p-5">
+      <button class="mb-3 text-xl" onclick={() => template = undefined}>&#x261C; Go back</button>
+      <Template title={template.title} template={template.template}/>
+    </div>
+  {/if}
+
+  <footer class="px-5 py-3">
+    <span>Creado por <a class="underline" href="https://sofiaritz.com">Sofía Aritz</a> para el <a class="underline" href="https://www.uco.es/aulasoftwarelibre/">Aula de Software Libre</a>. <a href="https://git.sofiaritz.com/sofia/mail-templates">Código fuente</a></span>
+  </footer>
+</div>

frontend/src/app.css

@@ -0,0 +1,7 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+:root {
+  @apply antialiased text-slate-700 bg-white;
+}

frontend/src/assets/svelte.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="26.6" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 308"><path fill="#FF3E00" d="M239.682 40.707C211.113-.182 154.69-12.301 113.895 13.69L42.247 59.356a82.198 82.198 0 0 0-37.135 55.056a86.566 86.566 0 0 0 8.536 55.576a82.425 82.425 0 0 0-12.296 30.719a87.596 87.596 0 0 0 14.964 66.244c28.574 40.893 84.997 53.007 125.787 27.016l71.648-45.664a82.182 82.182 0 0 0 37.135-55.057a86.601 86.601 0 0 0-8.53-55.577a82.409 82.409 0 0 0 12.29-30.718a87.573 87.573 0 0 0-14.963-66.244"></path><path fill="#FFF" d="M106.889 270.841c-23.102 6.007-47.497-3.036-61.103-22.648a52.685 52.685 0 0 1-9.003-39.85a49.978 49.978 0 0 1 1.713-6.693l1.35-4.115l3.671 2.697a92.447 92.447 0 0 0 28.036 14.007l2.663.808l-.245 2.659a16.067 16.067 0 0 0 2.89 10.656a17.143 17.143 0 0 0 18.397 6.828a15.786 15.786 0 0 0 4.403-1.935l71.67-45.672a14.922 14.922 0 0 0 6.734-9.977a15.923 15.923 0 0 0-2.713-12.011a17.156 17.156 0 0 0-18.404-6.832a15.78 15.78 0 0 0-4.396 1.933l-27.35 17.434a52.298 52.298 0 0 1-14.553 6.391c-23.101 6.007-47.497-3.036-61.101-22.649a52.681 52.681 0 0 1-9.004-39.849a49.428 49.428 0 0 1 22.34-33.114l71.664-45.677a52.218 52.218 0 0 1 14.563-6.398c23.101-6.007 47.497 3.036 61.101 22.648a52.685 52.685 0 0 1 9.004 39.85a50.559 50.559 0 0 1-1.713 6.692l-1.35 4.116l-3.67-2.693a92.373 92.373 0 0 0-28.037-14.013l-2.664-.809l.246-2.658a16.099 16.099 0 0 0-2.89-10.656a17.143 17.143 0 0 0-18.398-6.828a15.786 15.786 0 0 0-4.402 1.935l-71.67 45.674a14.898 14.898 0 0 0-6.73 9.975a15.9 15.9 0 0 0 2.709 12.012a17.156 17.156 0 0 0 18.404 6.832a15.841 15.841 0 0 0 4.402-1.935l27.345-17.427a52.147 52.147 0 0 1 14.552-6.397c23.101-6.006 47.497 3.037 61.102 22.65a52.681 52.681 0 0 1 9.003 39.848a49.453 49.453 0 0 1-22.34 33.12l-71.664 45.673a52.218 52.218 0 0 1-14.563 6.398"></path></svg>

frontend/src/lib/Template.svelte

@@ -0,0 +1,66 @@
+<script lang="ts">
+    let { title, template }: { title: string, template: string } = $props();
+
+    type ParsedElement = string | { name: string };
+
+    function parse(template: string): ParsedElement[] {
+        const result: ParsedElement[] = [];
+        const regex = /{{(.*?)}}/g;
+        let lastIndex = 0;
+        let match;
+
+        while ((match = regex.exec(template)) !== null) {
+            const [placeholder, name] = match;
+            const startIndex = match.index;
+
+            if (startIndex > lastIndex) {
+                result.push(template.slice(lastIndex, startIndex));
+            }
+
+            result.push({ name: name.trim() });
+
+            lastIndex = startIndex + placeholder.length;
+        }
+
+        if (lastIndex < template.length) {
+            result.push(template.slice(lastIndex));
+        }
+
+        return result;
+    }
+
+    let parsed = parse(template)
+    let values = $state([...parsed])
+
+    let is_completed = $derived(values.filter((v) => typeof v === "string").length === parsed.filter((v) => typeof v === "string" || !v.name.startsWith("NOTE: ")).length);
+    let compiled = $derived(is_completed ? values.filter((v) => typeof v === "string" || !v.name.startsWith("NOTE: ")).join("") : undefined)
+
+    let copied = $state(false)
+</script>
+
+<div class="text-left rounded border border-gray-300 text-black no-underline hover:text-black p-3">
+    <h1 class="text-xl font-bold py-2.5">{title}</h1>
+    <div class="font-mono pl-3">
+        {#each parsed as value, i}
+            {#if typeof value === "string"}
+                <pre class="inline whitespace-pre-wrap">{value}</pre>
+            {:else if value.name.startsWith("NOTE: ")}
+                <pre class="inline whitespace-pre-wrap underline decoration-blue-400"><span class="font-bold text-blue-400">&#9432;</span>&nbsp;{value.name.replace("NOTE: ", "")}</pre>
+            {:else}
+                <input size={Math.max(value.name.toString().length + 3, 15)} placeholder={value.name.toString()} oninput={(v) => values[i] = v.target!.value} class="border border-gray-700 rounded-sm" type="string">
+            {/if}
+        {/each}
+    </div>
+
+    {#if is_completed}
+        <hr class="my-3">
+        <button onclick={() => { navigator.clipboard.writeText(compiled!); copied = true; }} class="block underline mb-2">
+            Copy to clipboard
+            {#if copied}
+                <span class="ml-2">&check;</span>
+            {/if}
+        </button>
+        <pre class="font-mono whitespace-pre-wrap mt-3">{compiled}</pre>
+    {/if}
+</div>
+

frontend/src/lib/TemplateCard.svelte

@@ -0,0 +1,78 @@
+<script lang="ts">
+  let { title, template, onpress }: { title: string, template: string, onpress: ({ title, template }: { title: string, template: string }) => void } = $props();
+  let defaultPatternColorClass = "pattern-indigo-600"
+  let defaultPatternClass = "pattern-zigzag"
+  
+  const background = async (title: string) => {
+		const utf8 = new TextEncoder().encode(title)
+		let hash = await crypto.subtle.digest("SHA-256", utf8).then((hashBuffer) => {
+			const hashArray = Array.from(new Uint8Array(hashBuffer))
+			return hashArray.map((bytes) => bytes.toString(16).padStart(2, "0")).join("")
+		})
+
+		let hashCode = [...hash].reduce((acc, char) => char.charCodeAt(0) + ((acc << 5) - acc), 0)
+		let primaryColor = (() => {
+			let c = (hashCode & 0x00ffffff).toString(16).toUpperCase()
+
+			return "000000".substring(0, 6 - c.length) + c
+		})()
+
+		let patternClass = (() => {
+			let firstNum = parseInt(primaryColor[3], 16)
+			return [
+				"pattern-lines",
+				"pattern-vertical-lines",
+				"pattern-diagonal-lines",
+				"pattern-rectangles",
+				"pattern-rhombus",
+				"pattern-zigzag-3d",
+				"pattern-rectangles",
+				"pattern-rhombus",
+				"pattern-zigzag",
+				"pattern-dots",
+				"pattern-isometric",
+				"pattern-wavy",
+				"pattern-triangles",
+				"pattern-rhombus",
+				"pattern-zigzag",
+				"pattern-zigzag",
+			][firstNum]
+		})()
+
+    let color = (() => {
+      let secondNum = parseInt(primaryColor[5], 16)
+      return [
+				"pattern-indigo-600",
+				"pattern-blue-600",
+				"pattern-amber-600",
+				"pattern-emerald-600",
+				"pattern-lime-600",
+				"pattern-purple-600",
+				"pattern-pink-600",
+				"pattern-rose-600",
+				"pattern-sky-600",
+				"pattern-red-600",
+				"pattern-stone-600",
+				"pattern-slate-600",
+				"pattern-indigo-600",
+				"pattern-blue-600",
+				"pattern-amber-600",
+				"pattern-emerald-600",
+			][secondNum]
+    })()
+
+		return [patternClass, color]
+	}
+</script>
+
+<button onclick={() => onpress({ title, template })} class="text-left rounded border border-gray-300 text-black no-underline hover:text-black">
+  {#await background(title)}
+    <div class="h-24 {defaultPatternClass} {defaultPatternColorClass} pattern-bg-transparent pattern-opacity-60 pattern-size-8"></div>
+  {:then value} 
+    <div class={`h-24 ${value[0]} ${value[1]} pattern-bg-transparent pattern-opacity-60 pattern-size-8`}></div>
+  {/await}
+  <div class="p-2">
+		<span class="font-bold">{title}</span>
+	</div>
+  <p class="mb-2 block text-sm font-mono px-2">{template.slice(0, 50)} ...</p>
+</button>

frontend/src/lib/api.ts

@@ -0,0 +1,21 @@
+const TEMPLATES_REPO = import.meta.env.VITE_TEMPLATE_REPOSITORIES.split(",")
+
+export async function fetch_templates() {
+    let templates: {title: string, template: string}[] = [];
+
+    for (let repo of TEMPLATES_REPO) {
+        try {
+            let raw = await (await fetch(repo)).text()
+            let fetched = raw.split("---").map((v) => v.trim()).map((v) => {
+                let parts = v.split("\n\n")
+                return { title: parts.shift().replace("TITLE: ", ""), template: parts.join("\n\n") }
+            })
+
+            templates.push(...fetched)
+        } catch (e) {
+            alert(`Failed to load repo: '${repo}'`)
+        }
+    }
+
+    return templates
+}

frontend/src/main.ts

@@ -0,0 +1,9 @@
+import { mount } from 'svelte'
+import './app.css'
+import App from './App.svelte'
+
+const app = mount(App, {
+  target: document.getElementById('app')!,
+})
+
+export default app

frontend/src/vite-env.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="svelte" />
+/// <reference types="vite/client" />

frontend/svelte.config.js

@@ -0,0 +1,7 @@
+import { vitePreprocess } from '@sveltejs/vite-plugin-svelte'
+
+export default {
+  // Consult https://svelte.dev/docs#compile-time-svelte-preprocess
+  // for more information about preprocessors
+  preprocess: vitePreprocess(),
+}

frontend/tailwind.config.js

@@ -0,0 +1,14 @@
+/** @type {import('tailwindcss').Config} */
+export default {
+  content: [
+    "./index.html",
+    "./src/**/*.{svelte,js,ts,jsx,tsx}",
+  ],
+  theme: {
+    extend: {},
+  },
+  plugins: [
+    require("tailwindcss-bg-patterns")
+  ],
+}
+

frontend/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "extends": "@tsconfig/svelte/tsconfig.json",
+  "compilerOptions": {
+    "target": "ESNext",
+    "useDefineForClassFields": true,
+    "module": "ESNext",
+    "resolveJsonModule": true,
+    /**
+     * Typecheck JS in `.svelte` and `.js` files by default.
+     * Disable checkJs if you'd like to use dynamic types in JS.
+     * Note that setting allowJs false does not prevent the use
+     * of JS in `.svelte` files.
+     */
+    "allowJs": true,
+    "checkJs": true,
+    "isolatedModules": true,
+    "moduleDetection": "force"
+  },
+  "include": ["src/**/*.ts", "src/**/*.js", "src/**/*.svelte"],
+  "references": [{ "path": "./tsconfig.node.json" }]
+}

frontend/tsconfig.node.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
+    "skipLibCheck": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "strict": true,
+    "noEmit": true,
+    "noUncheckedSideEffectImports": true
+  },
+  "include": ["vite.config.ts"]
+}

frontend/vite.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'vite'
+import { svelte } from '@sveltejs/vite-plugin-svelte'
+
+// https://vite.dev/config/
+export default defineConfig({
+  plugins: [svelte()],
+})