@plitzi/sdk-shared 0.35.4 → 0.35.5

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @plitzi/sdk-shared
 
+## 0.35.5
+
+### Patch Changes
+
+- v0.35.5
+
 ## 0.35.4
 
 ### Patch Changes

package/dist/actions/index.d.ts

@@ -2,5 +2,7 @@ export { cronMatches, isKnownTimeZone, parseCron, zonedClock } from './cron';
 export { triggerAccess, triggerCacheMs, triggerHasStaleVerify, triggerInput, triggerVerify } from './triggerParams';
 export { actionName, actionTriggers, isActionEnabled } from './triggers';
 export { validateActionDocument } from './validateDocument';
+export { isSingleEmailAddress, readSmtpCredential, SMTP_CREDENTIAL_KEYS } from './smtp';
 export type { CronExpression } from './cron';
+export type { SmtpCredentialProblem, SmtpCredentialReading, SmtpSecurity, SmtpSettings } from './smtp';
 export type { ActionDocumentIssue, ActionDocumentReport } from './validateDocument';

package/dist/actions/index.mjs

@@ -2,4 +2,5 @@ import { cronMatches as e, isKnownTimeZone as t, parseCron as n, zonedClock as r
 import { triggerAccess as i, triggerCacheMs as a, triggerHasStaleVerify as o, triggerInput as s, triggerVerify as c } from "./triggerParams.mjs";
 import { actionName as l, actionTriggers as u, isActionEnabled as d } from "./triggers.mjs";
 import { validateActionDocument as f } from "./validateDocument.mjs";
-export { l as actionName, u as actionTriggers, e as cronMatches, d as isActionEnabled, t as isKnownTimeZone, n as parseCron, i as triggerAccess, a as triggerCacheMs, o as triggerHasStaleVerify, s as triggerInput, c as triggerVerify, f as validateActionDocument, r as zonedClock };
+import { SMTP_CREDENTIAL_KEYS as p, isSingleEmailAddress as m, readSmtpCredential as h } from "./smtp.mjs";
+export { p as SMTP_CREDENTIAL_KEYS, l as actionName, u as actionTriggers, e as cronMatches, d as isActionEnabled, t as isKnownTimeZone, m as isSingleEmailAddress, n as parseCron, h as readSmtpCredential, i as triggerAccess, a as triggerCacheMs, o as triggerHasStaleVerify, s as triggerInput, c as triggerVerify, f as validateActionDocument, r as zonedClock };

package/dist/actions/smtp.d.ts

@@ -0,0 +1,34 @@
+/**
+ * The SMTP server a space sends its flows' mail through, as its credential stores it — one rule for everybody who
+ * reads one: the editor saving it, the API accepting it, the check reporting on it and the `email.send` task using it.
+ *
+ * A credential is a bag of strings, so every value arrives as text and is judged here: a port that is not a port, a
+ * sender that is not one address, a password with no user to go with it. Each problem names the key it is about, so a
+ * form can put the sentence under the field.
+ */
+export type SmtpSecurity = 'tls' | 'starttls' | 'none';
+export type SmtpSettings = {
+    host: string;
+    port: number;
+    /** `tls` connects encrypted (usually 465); `starttls` upgrades a plain connection (usually 587); `none` never does. */
+    security: SmtpSecurity;
+    /** Empty with an empty password: a relay that authenticates by where the connection comes from. */
+    username: string;
+    password: string;
+    fromEmail: string;
+    fromName: string;
+};
+export type SmtpCredentialProblem = {
+    key: keyof SmtpSettings;
+    message: string;
+};
+export type SmtpCredentialReading = {
+    settings: SmtpSettings;
+    problems: [];
+} | {
+    problems: SmtpCredentialProblem[];
+};
+/** The keys an SMTP credential holds, in the order an editor asks for them. */
+export declare const SMTP_CREDENTIAL_KEYS: readonly (keyof SmtpSettings)[];
+export declare const isSingleEmailAddress: (value: string) => boolean;
+export declare const readSmtpCredential: (data: Record<string, unknown>) => SmtpCredentialReading;

package/dist/actions/smtp.mjs

@@ -0,0 +1,51 @@
+//#region src/actions/smtp.ts
+var e = [
+	"host",
+	"port",
+	"security",
+	"username",
+	"password",
+	"fromEmail",
+	"fromName"
+], t = [
+	"tls",
+	"starttls",
+	"none"
+], n = /^[A-Za-z0-9](?:[A-Za-z0-9.-]{0,251}[A-Za-z0-9])?$/, r = /^[^\s@,;<>"]+@[^\s@,;<>"]+\.[^\s@,;<>"]+$/, i = (e) => r.test(e), a = (e) => t.some((t) => t === e), o = (e, t) => {
+	let n = e[t];
+	return typeof n == "number" ? String(n) : typeof n == "string" ? n.trim() : "";
+}, s = (e) => {
+	let t = o(e, "host"), r = Number(o(e, "port")), s = o(e, "security"), c = o(e, "username"), l = typeof e.password == "string" ? e.password : "", u = o(e, "fromEmail"), d = o(e, "fromName"), f = [];
+	return n.test(t) || f.push({
+		key: "host",
+		message: "A host name like smtp.example.com, with no scheme and no port"
+	}), (!Number.isInteger(r) || r < 1 || r > 65535) && f.push({
+		key: "port",
+		message: "A port number, usually 587 or 465"
+	}), a(s) || f.push({
+		key: "security",
+		message: "One of tls, starttls or none"
+	}), l !== "" && c === "" && f.push({
+		key: "username",
+		message: "A password needs the user it belongs to"
+	}), i(u) || f.push({
+		key: "fromEmail",
+		message: "The one address this server sends as"
+	}), (/[\r\n]/.test(d) || d.length > 100) && f.push({
+		key: "fromName",
+		message: "One line of at most 100 characters"
+	}), f.length > 0 || !a(s) ? { problems: f } : {
+		settings: {
+			host: t,
+			port: r,
+			security: s,
+			username: c,
+			password: l,
+			fromEmail: u,
+			fromName: d
+		},
+		problems: []
+	};
+};
+//#endregion
+export { e as SMTP_CREDENTIAL_KEYS, i as isSingleEmailAddress, s as readSmtpCredential };

package/dist/network/spaceEvents.d.ts

@@ -93,19 +93,19 @@ export declare const spaceEventSchemas: {
         selector: z.ZodString;
         path: z.ZodOptional<z.ZodCustom<StyleCategory, StyleCategory>>;
         type: z.ZodEnum<{
+            id: "id";
             class: "class";
             element: "element";
-            id: "id";
         }>;
         style: z.ZodOptional<z.ZodCustom<import('..').StyleAttributes, import('..').StyleAttributes>>;
         params: z.ZodObject<{
             componentType: z.ZodOptional<z.ZodString>;
             styleSelector: z.ZodOptional<z.ZodString>;
             styleState: z.ZodOptional<z.ZodEnum<{
-                disabled: "disabled";
                 hover: "hover";
                 active: "active";
                 focus: "focus";
+                disabled: "disabled";
                 checked: "checked";
                 visited: "visited";
             }>>;
@@ -124,10 +124,10 @@ export declare const spaceEventSchemas: {
         params: z.ZodObject<{
             componentType: z.ZodOptional<z.ZodString>;
             styleState: z.ZodOptional<z.ZodEnum<{
-                disabled: "disabled";
                 hover: "hover";
                 active: "active";
                 focus: "focus";
+                disabled: "disabled";
                 checked: "checked";
                 visited: "visited";
             }>>;
@@ -281,9 +281,9 @@ export declare const spaceEventSchemas: {
         }>;
         selector: z.ZodString;
         type: z.ZodEnum<{
+            id: "id";
             class: "class";
             element: "element";
-            id: "id";
         }>;
         path: z.ZodOptional<z.ZodCustom<StyleCategory, StyleCategory>>;
         style: z.ZodOptional<z.ZodCustom<import('..').StyleAttributes, import('..').StyleAttributes>>;
@@ -291,10 +291,10 @@ export declare const spaceEventSchemas: {
             componentType: z.ZodOptional<z.ZodString>;
             styleSelector: z.ZodOptional<z.ZodString>;
             styleState: z.ZodOptional<z.ZodEnum<{
-                disabled: "disabled";
                 hover: "hover";
                 active: "active";
                 focus: "focus";
+                disabled: "disabled";
                 checked: "checked";
                 visited: "visited";
             }>>;
@@ -314,10 +314,10 @@ export declare const spaceEventSchemas: {
         params: z.ZodObject<{
             componentType: z.ZodOptional<z.ZodString>;
             styleState: z.ZodOptional<z.ZodEnum<{
-                disabled: "disabled";
                 hover: "hover";
                 active: "active";
                 focus: "focus";
+                disabled: "disabled";
                 checked: "checked";
                 visited: "visited";
             }>>;