@tollwyn/baukasten 0.0.2 → 1.2.2

package/dist/ui/data.d.ts

@@ -0,0 +1,167 @@
+import type { Language, NavigationLink } from '../product.js';
+export interface FrameData {
+    language: Language;
+    /** The name of the product: MAIL_FROM_NAME. */
+    name: string;
+    navigation: readonly NavigationLink[];
+    /** The referral tag of the link this page was opened with; its links carry it on. */
+    via: string | null;
+    account: {
+        email: string;
+        emailVerified: boolean;
+    } | null;
+    /** The marks of the product, the picture of a shared link at its whole address; null without. */
+    brand: {
+        logo: {
+            src: string;
+            width: number;
+            height: number;
+        };
+        icon: {
+            href: string;
+            type: 'image/svg+xml' | 'image/png';
+        };
+        image: string;
+    } | null;
+}
+export interface SignupData {
+    heading: string;
+    lead: string;
+    /** The referral tag the sign-up records; null without one. */
+    via: string | null;
+}
+export interface SignupForm {
+    email: string;
+    error: string;
+    taken?: boolean;
+}
+export interface LoginData {
+    notice: 'verified' | 'emailChanged' | null;
+}
+export interface LoginForm {
+    email: string;
+    error: string;
+}
+export interface LogoutData {
+    loggedIn: boolean;
+    deleted: boolean;
+}
+export interface ForgotForm {
+    email: string;
+    error?: string;
+    sent?: boolean;
+}
+export interface ResetData {
+    token: string;
+    valid: boolean;
+}
+export interface ResetForm {
+    error: string;
+}
+export type VerifyData = 
+/** Opened from the mail. */
+{
+    kind: 'link';
+    token: string;
+    valid: boolean;
+    needsPassword: boolean;
+}
+/** Logged in and not confirmed yet; `unsent` when the mail of the sign-up failed. */
+ | {
+    kind: 'pending';
+    email: string;
+    unsent: boolean;
+}
+/** Logged in and confirmed. */
+ | {
+    kind: 'confirmed';
+}
+/** Neither a link nor a login. */
+ | {
+    kind: 'none';
+};
+export interface VerifyForm {
+    error?: string;
+    /** The address a new link went to. */
+    resent?: string;
+}
+export interface ConfirmData {
+    token: string;
+    /** The address the link makes the login address; null for a link that is not usable. */
+    newEmail: string | null;
+}
+export interface ConfirmForm {
+    error: string;
+}
+export interface AccountData {
+    email: string;
+    emailVerified: boolean;
+    hasPassword: boolean;
+    /** How a key of the product looks, for the explanation. */
+    keyExample: string;
+    /** Whether the account is a customer at Stripe, with something to see in the customer portal. */
+    customer: boolean;
+    keys: {
+        id: string;
+        name: string;
+        prefix: string;
+        created: string;
+    }[];
+    notice: 'verified' | 'emailChanged' | null;
+}
+export type AccountForm = {
+    action: 'createKey';
+    key?: string;
+    error?: string;
+} | {
+    action: 'revokeKey';
+} | {
+    action: 'changePassword';
+    error?: string;
+    done?: boolean;
+} | {
+    action: 'changeEmail';
+    email: string;
+    error?: string;
+    sentTo?: string;
+} | {
+    action: 'delete';
+    error: string;
+};
+/** A piece of a sentence on a legal page. */
+export type LegalInline = string | {
+    kind: 'strong';
+    text: string;
+} | {
+    kind: 'code';
+    text: string;
+} | {
+    kind: 'link';
+    text: string;
+    href: string;
+};
+export type LegalBlock = {
+    kind: 'heading';
+    text: string;
+} | {
+    kind: 'paragraph';
+    parts: LegalInline[];
+}
+/** A paragraph set apart, like the version of a text. */
+ | {
+    kind: 'note';
+    parts: LegalInline[];
+} | {
+    kind: 'list';
+    items: LegalInline[][];
+}
+/** A list counted a, b, c. */
+ | {
+    kind: 'lettered';
+    items: LegalInline[][];
+};
+/** An imprint, a privacy policy or terms, as the server writes them for the product. */
+export interface LegalData {
+    title: string;
+    blocks: LegalBlock[];
+}

package/dist/ui/data.js

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

package/dist/ui/frame.d.ts

@@ -0,0 +1,17 @@
+import type { Texts } from '../texts.js';
+export interface FrameContext {
+    t: Texts;
+    /** The name of the product, for the titles of the pages. */
+    name: string;
+    /** A path of the product with the referral tag of this page, if it has one. */
+    link: (path: string) => string;
+}
+export declare function provideFrame(context: FrameContext): void;
+/**
+ * `path` with the referral tag `via`: the page opened with `?via=` hands it to every link, until the
+ * sign-up; nothing keeps it in the browser.
+ */
+export declare function withVia(path: string, via: string | null): string;
+/** For the pages of the product: its links carry the referral tag like those of the baukasten. */
+export declare function useLink(): (path: string) => string;
+export declare function useFrame(): FrameContext;

package/dist/ui/frame.js

@@ -0,0 +1,27 @@
+import { getContext, setContext } from 'svelte';
+const KEY = Symbol('baukasten frame');
+export function provideFrame(context) {
+    setContext(KEY, context);
+}
+/**
+ * `path` with the referral tag `via`: the page opened with `?via=` hands it to every link, until the
+ * sign-up; nothing keeps it in the browser.
+ */
+export function withVia(path, via) {
+    if (via === null)
+        return path;
+    const at = path.indexOf('#');
+    const [base, fragment] = at < 0 ? [path, ''] : [path.slice(0, at), path.slice(at)];
+    return `${base}${base.includes('?') ? '&' : '?'}via=${via}${fragment}`;
+}
+/** For the pages of the product: its links carry the referral tag like those of the baukasten. */
+export function useLink() {
+    return useFrame().link;
+}
+export function useFrame() {
+    const context = getContext(KEY);
+    if (context === undefined) {
+        throw new Error('a page of the baukasten outside its frame: the root layout is the Frame');
+    }
+    return context;
+}

package/dist/ui/index.d.ts

@@ -0,0 +1,15 @@
+export { default as AccountPage } from './AccountPage.svelte';
+export { default as ConfirmEmailPage } from './ConfirmEmailPage.svelte';
+export { default as ErrorPage } from './ErrorPage.svelte';
+export { default as Field } from './Field.svelte';
+export { default as ForgotPasswordPage } from './ForgotPasswordPage.svelte';
+export { default as Form } from './Form.svelte';
+export { default as Frame } from './Frame.svelte';
+export { default as LegalPage } from './LegalPage.svelte';
+export { useLink } from './frame.js';
+export { default as LoginPage } from './LoginPage.svelte';
+export { default as LogoutPage } from './LogoutPage.svelte';
+export { default as ResetPasswordPage } from './ResetPasswordPage.svelte';
+export { default as SignupPage } from './SignupPage.svelte';
+export { default as VerifyEmailPage } from './VerifyEmailPage.svelte';
+export type * from './data.js';

package/dist/ui/index.js

@@ -0,0 +1,15 @@
+// Everything here runs in the browser too, and lives inside the Frame, the root layout.
+export { default as AccountPage } from './AccountPage.svelte';
+export { default as ConfirmEmailPage } from './ConfirmEmailPage.svelte';
+export { default as ErrorPage } from './ErrorPage.svelte';
+export { default as Field } from './Field.svelte';
+export { default as ForgotPasswordPage } from './ForgotPasswordPage.svelte';
+export { default as Form } from './Form.svelte';
+export { default as Frame } from './Frame.svelte';
+export { default as LegalPage } from './LegalPage.svelte';
+export { useLink } from './frame.js';
+export { default as LoginPage } from './LoginPage.svelte';
+export { default as LogoutPage } from './LogoutPage.svelte';
+export { default as ResetPasswordPage } from './ResetPasswordPage.svelte';
+export { default as SignupPage } from './SignupPage.svelte';
+export { default as VerifyEmailPage } from './VerifyEmailPage.svelte';

package/dist/variables.d.ts

@@ -0,0 +1,20 @@
+/**
+ * The variables the delivery service sets for every web app, in its order
+ * (`standard-variables.test.ts` holds them against the delivery service).
+ */
+export declare const STANDARD_VARIABLES: readonly ["PUBLIC_ORIGIN", "PORT", "DATABASE_URL", "SMTP_HOST", "SMTP_PORT", "MAIL_FROM", "MAIL_FROM_NAME", "OPERATOR_NAME", "OPERATOR_ADDRESS", "OPERATOR_REGISTER", "OPERATOR_VAT", "OPERATOR_JURISDICTION", "HOSTING_LOCATION", "STRIPE_SECRET_KEY", "STRIPE_WEBHOOK_SECRET", "VERTRIEB_TOKEN"];
+export type StandardVariable = (typeof STANDARD_VARIABLES)[number];
+/**
+ * The variables the delivery service sets for every Shopify app, in its order; the Partner API alone
+ * says the plan of a shop.
+ */
+export declare const SHOPIFY_STANDARD_VARIABLES: readonly ["PUBLIC_ORIGIN", "PORT", "DATABASE_URL", "SMTP_HOST", "SMTP_PORT", "MAIL_FROM", "MAIL_FROM_NAME", "OPERATOR_NAME", "OPERATOR_ADDRESS", "HOSTING_LOCATION", "VERTRIEB_TOKEN", "SHOPIFY_API_SECRET", "SHOPIFY_TOKEN_KEY", "SHOPIFY_PARTNER_TOKEN", "SHOPIFY_PARTNER_ORG"];
+export type ShopifyStandardVariable = (typeof SHOPIFY_STANDARD_VARIABLES)[number];
+/**
+ * Every variable the baukasten reads in a web app. NODE_ENV comes from the image, and the server sets
+ * ORIGIN from PUBLIC_ORIGIN.
+ */
+export declare const WEBAPP_VARIABLES: readonly ["PUBLIC_ORIGIN", "PORT", "DATABASE_URL", "SMTP_HOST", "SMTP_PORT", "MAIL_FROM", "MAIL_FROM_NAME", "OPERATOR_NAME", "OPERATOR_ADDRESS", "OPERATOR_REGISTER", "OPERATOR_VAT", "OPERATOR_JURISDICTION", "HOSTING_LOCATION", "STRIPE_SECRET_KEY", "STRIPE_WEBHOOK_SECRET", "VERTRIEB_TOKEN", "LOG_LEVEL", "TEST_DATABASE_URL", "STRIPE_API_BASE"];
+export declare const SHOPIFY_VARIABLES: readonly ["PUBLIC_ORIGIN", "PORT", "DATABASE_URL", "SMTP_HOST", "SMTP_PORT", "MAIL_FROM", "MAIL_FROM_NAME", "OPERATOR_NAME", "OPERATOR_ADDRESS", "HOSTING_LOCATION", "VERTRIEB_TOKEN", "SHOPIFY_API_SECRET", "SHOPIFY_TOKEN_KEY", "SHOPIFY_PARTNER_TOKEN", "SHOPIFY_PARTNER_ORG", "LOG_LEVEL", "TEST_DATABASE_URL", "SHOPIFY_API_BASE", "SHOPIFY_CLIENT_ID"];
+/** Every variable the baukasten reads in a product of either art: no product takes one for its own. */
+export declare const BAUKASTEN_VARIABLES: ("PUBLIC_ORIGIN" | "PORT" | "DATABASE_URL" | "SMTP_HOST" | "SMTP_PORT" | "MAIL_FROM" | "MAIL_FROM_NAME" | "OPERATOR_NAME" | "OPERATOR_ADDRESS" | "OPERATOR_REGISTER" | "OPERATOR_VAT" | "OPERATOR_JURISDICTION" | "HOSTING_LOCATION" | "STRIPE_SECRET_KEY" | "STRIPE_WEBHOOK_SECRET" | "VERTRIEB_TOKEN" | "SHOPIFY_API_SECRET" | "SHOPIFY_TOKEN_KEY" | "SHOPIFY_PARTNER_TOKEN" | "SHOPIFY_PARTNER_ORG" | "LOG_LEVEL" | "TEST_DATABASE_URL" | "STRIPE_API_BASE" | "SHOPIFY_API_BASE" | "SHOPIFY_CLIENT_ID")[];

package/dist/variables.js

@@ -0,0 +1,62 @@
+/**
+ * The variables the delivery service sets for every web app, in its order
+ * (`standard-variables.test.ts` holds them against the delivery service).
+ */
+export const STANDARD_VARIABLES = [
+    'PUBLIC_ORIGIN',
+    'PORT',
+    'DATABASE_URL',
+    'SMTP_HOST',
+    'SMTP_PORT',
+    'MAIL_FROM',
+    'MAIL_FROM_NAME',
+    'OPERATOR_NAME',
+    'OPERATOR_ADDRESS',
+    'OPERATOR_REGISTER',
+    'OPERATOR_VAT',
+    'OPERATOR_JURISDICTION',
+    'HOSTING_LOCATION',
+    'STRIPE_SECRET_KEY',
+    'STRIPE_WEBHOOK_SECRET',
+    'VERTRIEB_TOKEN'
+];
+/**
+ * The variables the delivery service sets for every Shopify app, in its order; the Partner API alone
+ * says the plan of a shop.
+ */
+export const SHOPIFY_STANDARD_VARIABLES = [
+    'PUBLIC_ORIGIN',
+    'PORT',
+    'DATABASE_URL',
+    'SMTP_HOST',
+    'SMTP_PORT',
+    'MAIL_FROM',
+    'MAIL_FROM_NAME',
+    'OPERATOR_NAME',
+    'OPERATOR_ADDRESS',
+    'HOSTING_LOCATION',
+    'VERTRIEB_TOKEN',
+    'SHOPIFY_API_SECRET',
+    'SHOPIFY_TOKEN_KEY',
+    'SHOPIFY_PARTNER_TOKEN',
+    'SHOPIFY_PARTNER_ORG'
+];
+/**
+ * Every variable the baukasten reads in a web app. NODE_ENV comes from the image, and the server sets
+ * ORIGIN from PUBLIC_ORIGIN.
+ */
+export const WEBAPP_VARIABLES = [
+    ...STANDARD_VARIABLES,
+    'LOG_LEVEL',
+    'TEST_DATABASE_URL',
+    'STRIPE_API_BASE'
+];
+export const SHOPIFY_VARIABLES = [
+    ...SHOPIFY_STANDARD_VARIABLES,
+    'LOG_LEVEL',
+    'TEST_DATABASE_URL',
+    'SHOPIFY_API_BASE',
+    'SHOPIFY_CLIENT_ID'
+];
+/** Every variable the baukasten reads in a product of either art: no product takes one for its own. */
+export const BAUKASTEN_VARIABLES = [...new Set([...WEBAPP_VARIABLES, ...SHOPIFY_VARIABLES])];

package/package.json

@@ -1,9 +1,93 @@
 {
 	"name": "@tollwyn/baukasten",
-	"version": "0.0.2",
-	"description": "Placeholder. Use a 1.x version of @tollwyn/baukasten.",
+	"version": "1.2.2",
+	"description": "What every product built on this kit shares: configuration, log and server, database with two-layer migrations, health, accounts with sessions and API keys, limits, mail, payment through Stripe, the numbers for sales, the frame and pages, the stubs that hang them into a product and the check of a product, and the tools to test one, its connection test among them; and for a Shopify app its installation with tokens, the frame of the admin, its webhooks, its plan through the Partner API and its privacy text.",
 	"license": "UNLICENSED",
+	"type": "module",
+	"engines": {
+		"node": ">=24"
+	},
 	"files": [
-		"README.md"
-	]
+		"dist",
+		"!dist/**/*.test.*"
+	],
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"default": "./dist/index.js"
+		},
+		"./server": {
+			"types": "./dist/server/index.d.ts",
+			"browser": "./server-code-is-not-for-the-browser",
+			"default": "./dist/server/index.js"
+		},
+		"./shopify": {
+			"types": "./dist/shopify/index.d.ts",
+			"browser": "./server-code-is-not-for-the-browser",
+			"default": "./dist/shopify/index.js"
+		},
+		"./testing": {
+			"types": "./dist/testing/index.d.ts",
+			"browser": "./server-code-is-not-for-the-browser",
+			"default": "./dist/testing/index.js"
+		},
+		"./ui": {
+			"types": "./dist/ui/index.d.ts",
+			"svelte": "./dist/ui/index.js",
+			"default": "./dist/ui/index.js"
+		}
+	},
+	"bin": {
+		"baukasten-check": "dist/bin/check.js",
+		"baukasten-migrate": "dist/bin/migrate.js",
+		"baukasten-stubs": "dist/bin/stubs.js",
+		"baukasten-test-accounts": "dist/bin/test-accounts.js"
+	},
+	"scripts": {
+		"build": "svelte-package --input src/lib --output dist",
+		"prepack": "npm run build",
+		"muster": "npm run build && npm --prefix muster ci --no-audit --no-fund && npm --prefix muster-shopify ci --no-audit --no-fund",
+		"test": "vitest run && npm --prefix muster test && npm --prefix muster-shopify test",
+		"test:watch": "vitest",
+		"test:db": "node ../scripts/test-db.mjs mit vitest run --config vitest.db.config.ts",
+		"test:e2e": "npm run muster && npm --prefix muster run test:e2e && npm --prefix muster-shopify run test:e2e",
+		"typecheck": "svelte-check --tsconfig ./tsconfig.json --fail-on-warnings && npm --prefix muster run check && npm --prefix muster-shopify run check",
+		"lint": "eslint . --max-warnings 0 && prettier --check . && npm --prefix muster run lint && npm --prefix muster-shopify run lint",
+		"check:version": "node scripts/npm-version.ts"
+	},
+	"peerDependencies": {
+		"@sveltejs/kit": "^2.70.0",
+		"svelte": "^5.57.0"
+	},
+	"dependencies": {
+		"nodemailer": "10.0.16",
+		"pg": "8.23.1",
+		"smol-toml": "1.9.0",
+		"stripe": "22.6.2",
+		"zod": "4.6.5"
+	},
+	"devDependencies": {
+		"@eslint-community/eslint-plugin-eslint-comments": "4.7.2",
+		"@eslint/js": "10.0.1",
+		"@playwright/test": "1.62.1",
+		"@sveltejs/kit": "2.70.3",
+		"@sveltejs/package": "2.5.8",
+		"@sveltejs/vite-plugin-svelte": "7.3.0",
+		"@types/node": "24.19.1",
+		"@types/pg": "8.23.1",
+		"@types/smtp-server": "3.5.13",
+		"eslint": "10.9.1",
+		"eslint-config-prettier": "10.1.8",
+		"eslint-plugin-svelte": "3.23.0",
+		"globals": "17.12.0",
+		"prettier": "3.9.6",
+		"prettier-plugin-svelte": "4.1.1",
+		"smtp-server": "3.19.17",
+		"svelte": "5.57.2",
+		"svelte-check": "4.7.6",
+		"typescript": "6.0.3",
+		"typescript-eslint": "8.69.0",
+		"vite": "8.2.2",
+		"vitest": "5.0.3"
+	}
 }