firstly 0.4.0 → 0.4.2

package/esm/mail/server/index.d.ts

@@ -6,6 +6,7 @@ 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 { Module } from 'remult/server';
+import type { MailSection } from '../types';
 import { type MailStyle } from './formatMailHelper';
 declare module 'remult' {
     interface RemultContext {
@@ -28,6 +29,14 @@ export type MailOptions = GlobalEasyOptions & {
         transport?: TransportTypes;
         defaults?: DefaultOptions;
     };
+    /**
+     * Register `MailController.sendTest` (the BackendMethod that drives the
+     * bundled `<WriteMail />` component). Off by default - exposing a
+     * "send any mail to anyone" endpoint should be an explicit opt-in.
+     *
+     * Gated by `Roles_Mail.Mail_Admin` regardless.
+     */
+    enableTest?: boolean;
 };
 export type SendMail = typeof sendMail;
 export type SendMailResult = {
@@ -41,15 +50,11 @@ export declare const sendMail: (
 /** usefull for logs, it has NO impact on the mail itself */
 topic: string, easyOptions: GlobalEasyOptions & {
     to: Required<DefaultOptions>['to'];
+    cc?: DefaultOptions['cc'];
+    bcc?: DefaultOptions['bcc'];
     subject: Required<DefaultOptions>['subject'];
     title?: string;
-    sections: {
-        html: string;
-        cta?: {
-            html: string;
-            link: string;
-        } | undefined;
-    }[];
+    sections: MailSection[];
 }, options?: {
     nodemailer?: MailOptions['nodemailer'];
 }) => Promise<SendMailResult>;

package/esm/mail/server/index.js

@@ -3,6 +3,7 @@ import { remult, repo } from 'remult';
 import { Module } from 'remult/server';
 import { cyan, green, magenta, red, sleep, white } from '@kitql/helpers';
 import { log, mailEntities } from '../index';
+import { MailController } from '../MailController';
 import { toHtml } from './formatMailHelper';
 let transporter;
 let globalOptions;
@@ -64,7 +65,7 @@ export const sendMail = async (topic, easyOptions, options) => {
         from: easyOptions.from ?? globalOptions?.from,
     };
     let { primaryColor, secondaryColor, title, footer, service } = easyOptionsToUse;
-    const { subject, sections, to } = easyOptionsToUse;
+    const { subject, sections, to, cc, bcc } = easyOptionsToUse;
     service = service ?? 'service';
     primaryColor = primaryColor ?? '#0d0f70';
     secondaryColor = secondaryColor ?? '#653eae';
@@ -78,12 +79,16 @@ export const sendMail = async (topic, easyOptions, options) => {
         title,
         footer,
         sections,
+        cc,
+        bcc,
     };
     const html = easyOptionsToUse.toHtml ? easyOptionsToUse.toHtml(metadata) : toHtml(metadata);
     nodemailerOptions = {
         defaults: {
             ...globalOptions?.nodemailer?.defaults,
             to,
+            cc,
+            bcc,
             subject,
             html,
             ...nodemailerOptions?.defaults,
@@ -100,18 +105,19 @@ export const sendMail = async (topic, easyOptions, options) => {
     try {
         if (!globalOptions?.nodemailer?.transport) {
             const data = await transporter.sendMail({ ...nodemailerOptions.defaults });
-            log.error(`${magenta(`[${topic}]`)} - ⚠️  ${red(`mail not configured`)} ⚠️ 
-		We are still nice and generated you an email preview link (the mail we not really sent): 
-		👉 ${cyan(String(nodemailer.getTestMessageUrl(data)))}
-			
-		To really send mails, check out the doc ${white(`https://firstly.fun/modules/mail`)}. 
+            const previewUrl = nodemailer.getTestMessageUrl(data) || undefined;
+            log.error(`${magenta(`[${topic}]`)} - ⚠️  ${red(`mail not configured`)} ⚠️
+		We are still nice and generated you an email preview link (the mail was NOT really sent):
+		👉 ${cyan(String(previewUrl))}
+
+		To really send mails (likely a missing provider API key), see ${white(`https://firstly.fun/docs/modules/mail`)}.
       `);
             await repo(mailEntities.Mail).insert({
                 status: 'transport_not_configured',
                 to: JSON.stringify(to),
                 html: easyOptionsToUse.saveHtml ? html : '',
                 topic,
-                metadata,
+                metadata: { ...metadata, transport: extractTransportInfo(data, previewUrl) },
             });
             return { data };
         }
@@ -123,16 +129,18 @@ export const sendMail = async (topic, easyOptions, options) => {
                 to: JSON.stringify(to),
                 html: easyOptionsToUse.saveHtml ? html : '',
                 topic,
-                metadata,
+                metadata: { ...metadata, transport: extractTransportInfo(data) },
             });
             return { data };
         }
     }
     catch (error) {
         if (error instanceof Error && error.message.includes('Missing credentials for "PLAIN"')) {
-            log.error(`${magenta(`[${topic}]`)} - ⚠️  ${red(`mail not well configured`)} ⚠️ 
+            log.error(`${magenta(`[${topic}]`)} - ⚠️  ${red(`mail not well configured`)} ⚠️
 👉 transport used:
 ${cyan(JSON.stringify(globalOptions?.nodemailer?.transport, null, 2))}
+
+Auth was refused - check your provider's API key. Docs: ${white(`https://firstly.fun/docs/modules/mail`)}.
 			`);
         }
         else {
@@ -177,20 +185,34 @@ ${cyan(JSON.stringify(globalOptions?.nodemailer?.transport, null, 2))}
         return { error };
     }
 };
-const mailModule = new Module({
+/**
+ * Captured nodemailer-side metadata persisted on every send. This makes
+ * provider-side IDs (e.g. Resend's `re_...` returned via SMTP `messageId`)
+ * recoverable from the DB without an extra round-trip to the provider.
+ */
+function extractTransportInfo(data, preview) {
+    return {
+        messageId: data.messageId,
+        response: data.response,
+        accepted: data.accepted,
+        rejected: data.rejected,
+        envelope: data.envelope,
+        preview,
+    };
+}
+export const mail = (o) => new Module({
     key: 'mail',
     priority: -888,
     entities: Object.values(mailEntities),
-});
-export const mail = (o) => {
-    mailModule.initApi = () => {
+    // Opt-in: only register the test endpoint when the consumer asks for it.
+    controllers: o?.enableTest ? [MailController] : [],
+    initApi: () => {
         initMail(o);
         // Need to init in the 2 places!
         remult.context.sendMail = sendMail;
-    };
-    mailModule.initRequest = async () => {
+    },
+    initRequest: async () => {
         // Need to init in the 2 places!
         remult.context.sendMail = sendMail;
-    };
-    return mailModule;
-};
+    },
+});

package/esm/mail/types.d.ts

@@ -0,0 +1,11 @@
+/**
+ * One section in a mail body. Pure structural type, safe to import on the
+ * client when building sections from a UI.
+ */
+export type MailSection = {
+    html: string;
+    cta?: {
+        html: string;
+        link: string;
+    };
+};

package/esm/mail/types.js

@@ -0,0 +1 @@
+export {};

package/esm/mail/ui/LastMails.svelte

@@ -0,0 +1,184 @@
+<script lang="ts">
+	import { onDestroy, onMount } from 'svelte'
+
+	import { remult, repo } from 'remult'
+
+	import { Mail } from '../Mail'
+	import { Roles_Mail } from '../Roles_Mail'
+
+	const hasAccess = $derived(remult.user?.roles?.includes(Roles_Mail.Mail_Admin) ?? false)
+
+	type Props = {
+		limit?: number
+		/** Subscribe to a remult `liveQuery` so the list updates over SSE.
+		 * Default `true`. Set to `false` to fall back to a one-shot fetch on
+		 * mount (the Refresh button still works either way). */
+		live?: boolean
+	}
+	let { limit = 30, live = true }: Props = $props()
+
+	let mails: Mail[] = $state([])
+	let isLoading = $state(false)
+	let error = $state('')
+	let unsubscribe: (() => void) | null = null
+
+	export async function refresh() {
+		isLoading = true
+		error = ''
+		try {
+			mails = await repo(Mail).find({ limit })
+		} catch (e) {
+			error = e instanceof Error ? e.message : String(e)
+		} finally {
+			isLoading = false
+		}
+	}
+
+	onMount(() => {
+		if (live) {
+			// Pass `orderBy` explicitly: remult keeps the live state sorted on
+			// incremental adds/replaces only when `query.options.orderBy` is
+			// set (the entity's `defaultOrderBy` only applies to the initial
+			// fetch). Without this, new SSE rows would land at the bottom.
+			unsubscribe = repo(Mail)
+				.liveQuery({ limit, orderBy: { createdAt: 'desc' } })
+				.subscribe((res) => {
+					mails = res.items
+					error = ''
+				})
+		} else {
+			refresh()
+		}
+	})
+
+	onDestroy(() => unsubscribe?.())
+
+	function formatList(v: unknown): string {
+		if (v == null) return ''
+		if (Array.isArray(v)) return v.join(', ')
+		return String(v)
+	}
+
+	function parseTo(raw: string): string {
+		try {
+			return formatList(JSON.parse(raw))
+		} catch {
+			return raw
+		}
+	}
+
+	function formatDate(d: unknown): string {
+		if (!d) return ''
+		const date = d instanceof Date ? d : new Date(d as string)
+		if (isNaN(date.getTime())) return String(d)
+		return date.toLocaleString()
+	}
+
+	function badgeClass(status: Mail['status']): string {
+		if (status === 'sent') return 'bg-emerald-500/10 border-emerald-500/40 text-emerald-300'
+		if (status === 'transport_not_configured')
+			return 'bg-amber-500/10 border-amber-500/40 text-amber-300'
+		return 'bg-red-500/10 border-red-500/40 text-red-300'
+	}
+</script>
+
+<div class="border border-slate-700 bg-slate-800 text-slate-200">
+	<header class="flex flex-wrap items-center gap-3 border-b border-slate-700 px-5 py-4">
+		<div class="flex flex-col">
+			<h2 class="text-lg font-semibold text-slate-100">Last mails</h2>
+			<p class="text-sm text-slate-400">Recent mails sent through this app.</p>
+		</div>
+		{#if hasAccess}
+			<button
+				type="button"
+				onclick={refresh}
+				disabled={isLoading}
+				class="ml-auto inline-flex items-center gap-2 border border-slate-600 bg-slate-700 px-3 py-1.5 text-sm font-medium text-slate-100 hover:bg-slate-600 disabled:opacity-50"
+			>
+				{#if isLoading}
+					<svg
+						class="h-4 w-4 animate-spin"
+						viewBox="0 0 24 24"
+						fill="none"
+						xmlns="http://www.w3.org/2000/svg"
+						aria-hidden="true"
+					>
+						<circle cx="12" cy="12" r="10" stroke="currentColor" stroke-opacity="0.25" stroke-width="4"
+						></circle>
+						<path d="M4 12a8 8 0 0 1 8-8" stroke="currentColor" stroke-width="4" stroke-linecap="round"
+						></path>
+					</svg>
+				{/if}
+				Refresh
+			</button>
+			<span class="text-xs text-slate-500">
+				{mails.length} mail{mails.length === 1 ? '' : 's'}
+				{#if live}<span class="text-indigo-400">· live</span>{/if}
+			</span>
+		{/if}
+	</header>
+
+	<div class="p-5">
+		{#if !hasAccess}
+			<div class="border border-amber-500/40 bg-amber-500/10 p-3 text-sm text-amber-200">
+				You need the
+				<code class="bg-amber-500/20 px-1 py-0.5 text-xs text-amber-100">Mail.Admin</code>
+				role to use this.
+			</div>
+		{:else if error}
+			<div class="border border-red-500/40 bg-red-500/10 p-3 text-sm text-red-200">{error}</div>
+		{:else if mails.length === 0}
+			<div class="border border-slate-700 bg-slate-900 p-3 text-sm text-slate-400">No mails yet.</div>
+		{:else}
+			<div class="flex flex-col gap-3">
+				{#each mails as m (m.id)}
+					{@const subject = m.metadata?.subject as string | undefined}
+					{@const cc = formatList(m.metadata?.cc)}
+					{@const bcc = formatList(m.metadata?.bcc)}
+					{@const messageId = m.metadata?.transport?.messageId as string | undefined}
+					{@const preview = m.metadata?.transport?.preview as string | undefined}
+					<article class="flex flex-col gap-2 border border-slate-700 bg-slate-900 p-4">
+						<div class="flex flex-wrap items-center gap-2">
+							<span class="border px-2 py-0.5 text-xs font-medium {badgeClass(m.status)}">{m.status}</span>
+							<span
+								class="border border-slate-600 bg-slate-700/50 px-2 py-0.5 text-xs font-medium text-slate-200"
+								>{m.topic}</span
+							>
+							<span class="text-xs text-slate-400">{parseTo(m.to)}</span>
+							<span class="ml-auto text-xs text-slate-500">{formatDate(m.createdAt)}</span>
+						</div>
+
+						<div class="text-base font-medium text-slate-100">{subject || '(no subject)'}</div>
+
+						{#if cc}
+							<div class="text-xs text-slate-500">cc: {cc}</div>
+						{/if}
+						{#if bcc}
+							<div class="text-xs text-slate-500">bcc: {bcc}</div>
+						{/if}
+
+						{#if preview}
+							<div class="text-xs">
+								<a
+									href={preview}
+									target="_blank"
+									rel="noopener noreferrer"
+									class="text-indigo-400 underline hover:text-indigo-300">preview (mail not really sent)</a
+								>
+							</div>
+						{/if}
+
+						{#if messageId}
+							<div class="text-xs break-all text-slate-500">id: <code>{messageId}</code></div>
+						{/if}
+
+						{#if m.status === 'error' && m.errorInfo}
+							<pre
+								class="border border-red-500/40 bg-red-500/10 p-2 text-xs whitespace-pre-wrap text-red-200">{m.errorInfo}</pre>
+						{/if}
+					</article>
+				{/each}
+			</div>
+		{/if}
+	</div>
+</div>

package/esm/mail/ui/LastMails.svelte.d.ts

@@ -0,0 +1,12 @@
+type Props = {
+    limit?: number;
+    /** Subscribe to a remult `liveQuery` so the list updates over SSE.
+     * Default `true`. Set to `false` to fall back to a one-shot fetch on
+     * mount (the Refresh button still works either way). */
+    live?: boolean;
+};
+declare const LastMails: import("svelte").Component<Props, {
+    refresh: () => Promise<void>;
+}, "">;
+type LastMails = ReturnType<typeof LastMails>;
+export default LastMails;

package/esm/mail/ui/WriteMail.svelte

@@ -0,0 +1,183 @@
+<script lang="ts">
+	import { remult } from 'remult'
+	import { errorMessage } from '../..'
+
+	import { MailController } from '../MailController'
+	import { Roles_Mail } from '../Roles_Mail'
+
+	const hasAccess = $derived(remult.user?.roles?.includes(Roles_Mail.Mail_Admin) ?? false)
+
+	let to = $state('')
+	let cc = $state('')
+	let bcc = $state('')
+	let subject = $state('')
+	let body = $state('')
+	let isLoading = $state(false)
+
+	let result: { ok: boolean; messageId: string | null } | null = $state(null)
+	let error = $state('')
+
+	// Bare-minimum client gate: subject + at least one recipient slot has
+	// content. Server splits, trims, lowercases, and validates each entry.
+	const canSend = $derived(
+		subject.trim().length > 0 && (to.trim() || cc.trim() || bcc.trim()).length > 0,
+	)
+
+	async function handleSubmit(e: Event) {
+		e.preventDefault()
+		if (!canSend) return
+		result = null
+		error = ''
+		isLoading = true
+		// We don't gate the request on `hasAccess` (it's a client-only signal):
+		// the server cookie-auths via the BackendMethod's `allowed`. The amber
+		// notice in the template is for UX only.
+		try {
+			const r = await MailController.sendTest({ to, cc, bcc, subject, body })
+			if (r.ok) {
+				result = { ok: true, messageId: r.messageId }
+			} else {
+				error = r.error ?? 'Unknown error'
+			}
+		} catch (e) {
+			error = errorMessage(e)
+		} finally {
+			isLoading = false
+		}
+	}
+</script>
+
+<div class="border border-slate-700 bg-slate-800 text-slate-200">
+	<header class="border-b border-slate-700 px-5 py-4">
+		<h2 class="text-lg font-semibold text-slate-100">Write mail</h2>
+		<p class="mt-1 text-sm text-slate-400">Send a test mail through the configured transport.</p>
+	</header>
+
+	<div class="p-5">
+		{#if !hasAccess}
+			<div class="border border-amber-500/40 bg-amber-500/10 p-3 text-sm text-amber-200">
+				You need the
+				<code class="bg-amber-500/20 px-1 py-0.5 text-xs text-amber-100">Mail.Admin</code>
+				role to use this.
+			</div>
+		{:else}
+			<form onsubmit={handleSubmit} class="flex flex-col gap-4">
+				<div class="flex flex-col gap-1">
+					<label for="write-mail-to" class="text-xs font-medium tracking-wide text-slate-400 uppercase"
+						>To</label
+					>
+					<input
+						id="write-mail-to"
+						type="text"
+						bind:value={to}
+						disabled={isLoading}
+						placeholder="someone@example.com, other@example.com"
+						class="border border-slate-700 bg-slate-900 px-3 py-2 text-sm text-slate-100 placeholder-slate-500 focus:border-indigo-400 focus:outline-none disabled:opacity-50"
+					/>
+				</div>
+
+				<div class="grid grid-cols-2 gap-4 max-md:grid-cols-1">
+					<div class="flex flex-col gap-1">
+						<label for="write-mail-cc" class="text-xs font-medium tracking-wide text-slate-400 uppercase"
+							>Cc</label
+						>
+						<input
+							id="write-mail-cc"
+							type="text"
+							bind:value={cc}
+							disabled={isLoading}
+							placeholder="optional, comma-separated"
+							class="border border-slate-700 bg-slate-900 px-3 py-2 text-sm text-slate-100 placeholder-slate-500 focus:border-indigo-400 focus:outline-none disabled:opacity-50"
+						/>
+					</div>
+					<div class="flex flex-col gap-1">
+						<label for="write-mail-bcc" class="text-xs font-medium tracking-wide text-slate-400 uppercase"
+							>Bcc</label
+						>
+						<input
+							id="write-mail-bcc"
+							type="text"
+							bind:value={bcc}
+							disabled={isLoading}
+							placeholder="optional, comma-separated"
+							class="border border-slate-700 bg-slate-900 px-3 py-2 text-sm text-slate-100 placeholder-slate-500 focus:border-indigo-400 focus:outline-none disabled:opacity-50"
+						/>
+					</div>
+				</div>
+
+				<div class="flex flex-col gap-1">
+					<label
+						for="write-mail-subject"
+						class="text-xs font-medium tracking-wide text-slate-400 uppercase">Subject</label
+					>
+					<input
+						id="write-mail-subject"
+						type="text"
+						bind:value={subject}
+						disabled={isLoading}
+						required
+						placeholder="Subject"
+						class="border border-slate-700 bg-slate-900 px-3 py-2 text-sm text-slate-100 placeholder-slate-500 focus:border-indigo-400 focus:outline-none disabled:opacity-50"
+					/>
+				</div>
+
+				<div class="flex flex-col gap-1">
+					<label for="write-mail-body" class="text-xs font-medium tracking-wide text-slate-400 uppercase"
+						>Body</label
+					>
+					<textarea
+						id="write-mail-body"
+						bind:value={body}
+						disabled={isLoading}
+						placeholder="Write your message..."
+						class="h-40 w-full border border-slate-700 bg-slate-900 px-3 py-2 text-sm text-slate-100 placeholder-slate-500 focus:border-indigo-400 focus:outline-none disabled:opacity-50"
+					></textarea>
+				</div>
+
+				<div class="flex items-center gap-4 border-t border-slate-700 pt-4">
+					<button
+						type="submit"
+						disabled={isLoading || !canSend}
+						class="inline-flex items-center gap-2 bg-indigo-500 px-4 py-2 text-sm font-medium text-white hover:bg-indigo-400 disabled:opacity-50"
+					>
+						{#if isLoading}
+							<svg
+								class="h-4 w-4 animate-spin"
+								viewBox="0 0 24 24"
+								fill="none"
+								xmlns="http://www.w3.org/2000/svg"
+								aria-hidden="true"
+							>
+								<circle cx="12" cy="12" r="10" stroke="currentColor" stroke-opacity="0.25" stroke-width="4"
+								></circle>
+								<path d="M4 12a8 8 0 0 1 8-8" stroke="currentColor" stroke-width="4" stroke-linecap="round"
+								></path>
+							</svg>
+						{/if}
+						Send
+					</button>
+
+					{#if !canSend && !result && !error}
+						<span class="text-xs text-slate-500"> Add a subject and at least one recipient. </span>
+					{/if}
+
+					{#if result}
+						<div
+							class="flex flex-1 items-center gap-2 border border-emerald-500/40 bg-emerald-500/10 px-3 py-1.5 text-sm text-emerald-200"
+						>
+							<span class="font-medium">Sent</span>
+							{#if result.messageId}
+								<code class="ml-auto text-xs break-all">{result.messageId}</code>
+							{/if}
+						</div>
+					{/if}
+
+					{#if error}
+						<pre
+							class="flex-1 overflow-auto border border-red-500/40 bg-red-500/10 px-3 py-1.5 text-xs whitespace-pre-wrap text-red-200">{error}</pre>
+					{/if}
+				</div>
+			</form>
+		{/if}
+	</div>
+</div>

package/esm/mail/ui/WriteMail.svelte.d.ts

@@ -0,0 +1,3 @@
+declare const WriteMail: import("svelte").Component<Record<string, never>, {}, "">;
+type WriteMail = ReturnType<typeof WriteMail>;
+export default WriteMail;

package/esm/sqlAdmin/Roles_SqlAdmin.d.ts

@@ -0,0 +1,3 @@
+export declare const Roles_SqlAdmin: {
+    readonly SqlAdmin_Admin: "SqlAdmin.Admin";
+};

package/esm/sqlAdmin/Roles_SqlAdmin.js

@@ -0,0 +1,3 @@
+export const Roles_SqlAdmin = {
+    SqlAdmin_Admin: 'SqlAdmin.Admin',
+};

package/esm/sqlAdmin/SqlAdminController.d.ts

@@ -0,0 +1,9 @@
+import { SqlDatabase } from 'remult';
+export declare class SqlAdminController {
+    /** Optional override set by the `sqlAdmin()` module's `initApi`. Falls back to `SqlDatabase.getDb()`. */
+    static dp?: SqlDatabase;
+    static exec(cmd: string): Promise<{
+        r: import("remult").SqlResult;
+        took: number;
+    }>;
+}

package/esm/sqlAdmin/SqlAdminController.js

@@ -0,0 +1,23 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { BackendMethod, SqlDatabase } from 'remult';
+import { FF_Role } from '../core/common';
+import { Roles_SqlAdmin } from './Roles_SqlAdmin';
+export class SqlAdminController {
+    /** Optional override set by the `sqlAdmin()` module's `initApi`. Falls back to `SqlDatabase.getDb()`. */
+    static dp;
+    static async exec(cmd) {
+        const db = SqlAdminController.dp ?? SqlDatabase.getDb();
+        const start = performance.now();
+        const r = await db.execute(cmd);
+        const took = performance.now() - start;
+        return { r, took };
+    }
+}
+__decorate([
+    BackendMethod({ allowed: [Roles_SqlAdmin.SqlAdmin_Admin, FF_Role.FF_Role_Admin] })
+], SqlAdminController, "exec", null);

package/esm/sqlAdmin/index.d.ts

@@ -0,0 +1,6 @@
+import { Log } from '@kitql/helpers';
+export { Roles_SqlAdmin } from './Roles_SqlAdmin';
+export { SqlAdminController } from './SqlAdminController';
+export { default as SqlAdmin } from './ui/SqlAdmin.svelte';
+export declare const key = "sqlAdmin";
+export declare const log: Log;

package/esm/sqlAdmin/index.js

@@ -0,0 +1,6 @@
+import { Log } from '@kitql/helpers';
+export { Roles_SqlAdmin } from './Roles_SqlAdmin';
+export { SqlAdminController } from './SqlAdminController';
+export { default as SqlAdmin } from './ui/SqlAdmin.svelte';
+export const key = 'sqlAdmin';
+export const log = new Log(key);

package/esm/sqlAdmin/server/index.d.ts

@@ -0,0 +1,40 @@
+import type { SqlDatabase } from 'remult';
+import { Module } from 'remult/server';
+export type SqlAdminOptions = {
+    /**
+     * Override the SqlDatabase used to execute queries.
+     * Defaults to `SqlDatabase.getDb()` (the active Remult data provider).
+     */
+    dp?: () => SqlDatabase | Promise<SqlDatabase>;
+    /**
+     * The route where you mounted the `<SqlAdmin />` component.
+     * Used only for the AI hint logged on server start.
+     *
+     * @default '/sql/admin'
+     */
+    path?: string;
+};
+/**
+ * Drop-in SQL admin endpoint + companion `<SqlAdmin />` component (`firstly/sqlAdmin`).
+ *
+ * Gated by `Roles_SqlAdmin.SqlAdmin_Admin` (or the global `FF_Role.FF_Role_Admin`).
+ *
+ * @example
+ * ```ts
+ * import { remultApi } from 'remult/remult-sveltekit'
+ * import { sqlAdmin } from './'
+ *
+ * export const api = remultApi({
+ *   modules: [sqlAdmin()],
+ * })
+ * ```
+ *
+ * Then on any admin route:
+ * ```svelte
+ * <script>
+ *   import { SqlAdmin } from '..'
+ * </script>
+ * <SqlAdmin />
+ * ```
+ */
+export declare const sqlAdmin: (opts?: SqlAdminOptions) => Module<unknown>;