@trypattern/sdk 0.1.5 → 0.1.6

package/dist/cli/app.js

@@ -74,7 +74,13 @@ const CONTACT_SHEET = join(SCREENSHOTS_DIR, 'contact-sheet.png');
 const SCREENSHOT_WORKER = join(SDK_SOURCE, 'cli', `screenshot${SDK_EXTENSION}`);
 const VISUAL_URL_ENV = 'PATTERN_VISUAL_URL';
 const GLOBAL_FLAGS = ['--json', '--help', '-h'];
-const VALUE_FLAGS = new Set(['--commands', '--name', '--as', '--code']);
+const VALUE_FLAGS = new Set([
+    '--commands',
+    '--name',
+    '--as',
+    '--code',
+    '--message'
+]);
 const SHIM_SOURCE = `#!/bin/sh
 ${SHIM_MARKER_LINE}
 dir=$PWD
@@ -284,9 +290,14 @@ git would keep, never .dev.vars, .env, node_modules, dist or .dev) to onpattern.
 until the new version answers at https://<name>.onpattern.app, printing each step. The database
 moves forward with any new migrations; nothing is ever deleted from it. If a step fails, the site
 keeps running the previous version and the error says why. Run app check first.
+--message '…' says what changed in a few plain words for the owner ("Pink brand colour and a welcome
+line"); onpattern.app and app versions show it beside the version.
 --starter (Pattern's admins only) publishes this project as the starter every new site begins from.`,
-        run: (_argument, options) => publish(publishingIo(), ROOT, options.has('--starter')),
-        flags: ['--starter']
+        run: (_argument, options) => {
+            const message = options.get('--message');
+            return publish(publishingIo(), ROOT, options.has('--starter'), typeof message === 'string' ? message : undefined);
+        },
+        flags: ['--starter', '--message']
     },
     versions: {
         summary: 'List the versions that went live, newest first',
@@ -1311,7 +1322,7 @@ async function setup() {
 function help() {
     const width = Math.max(...Object.keys(COMMANDS).map((n) => n.length));
     const lines = Object.entries(COMMANDS).map(([name, cmd]) => `app ${name.padEnd(width)}  ${cmd.summary}`);
-    lines.push('Flags: --json (machine-readable stdout), <command> --help (details and its own flags: start --no-open, test --visual, screenshot --commands --name --as --signed-out, pull --code)');
+    lines.push('Flags: --json (machine-readable stdout), <command> --help (details and its own flags: start --no-open, test --visual, screenshot --commands --name --as --signed-out, pull --code, publish --message)');
     return {
         code: 0,
         data: {

package/dist/cli/publishing.d.ts

@@ -15,7 +15,7 @@ export type PublishingIo = {
 };
 export declare function login(io: PublishingIo): Promise<Outcome>;
 export declare function pull(io: PublishingIo, name: string | undefined, cwd: string, setupCode: string | undefined): Promise<Outcome>;
-export declare function publish(io: PublishingIo, root: string, isStarter: boolean): Promise<Outcome>;
+export declare function publish(io: PublishingIo, root: string, isStarter: boolean, message: string | undefined): Promise<Outcome>;
 export declare function versions(io: PublishingIo, root: string): Promise<Outcome>;
 export declare function restore(io: PublishingIo, root: string, number: string | undefined): Promise<Outcome>;
 export {};

package/dist/cli/publishing.js

@@ -3,7 +3,7 @@ import { chmodSync, existsSync, mkdirSync, readdirSync, readFileSync, rmSync, st
 import { homedir, hostname, userInfo } from 'node:os';
 import { basename, dirname, extname, join, matchesGlob, relative } from 'node:path';
 import { z } from 'zod';
-import { DASHBOARD_URL, UPLOAD, appSummary, isPrivatePath, loginPoll, loginStarted, nameProblem, publishSummary, setupCodeExchanged, sourcePathProblem } from "../publishWire.js";
+import { DASHBOARD_URL, UPLOAD, appSummary, isPrivatePath, loginPoll, loginStarted, nameProblem, publishMessage, publishSummary, setupCodeExchanged, sourcePathProblem } from "../publishWire.js";
 import { appInfo } from "../appTitle.js";
 import { PROJECT_FILE, readProjectFile } from "../vite/projectFile.js";
 const CONFIG_DIR = join(homedir(), '.config', 'pattern');
@@ -424,11 +424,13 @@ async function followPublish(io, name, started) {
     }
     const data = { name, version: publish.number, status: publish.status };
     if (publish.status === 'live') {
-        return {
-            code: 0,
-            data,
-            text: `✓ Version ${publish.number} is live at https://${name}.onpattern.app`
-        };
+        const lines = [
+            `✓ Version ${publish.number} is live at https://${name}.onpattern.app${publish.message === null ? '' : ` · ${publish.message}`}`
+        ];
+        if (publish.message === null && publish.restoredFrom === null) {
+            lines.push("  tip  add --message '…' so the owner sees what changed, in plain words");
+        }
+        return { code: 0, data, text: lines.join('\n') };
     }
     if (publish.status === 'failed') {
         return {
@@ -443,7 +445,7 @@ async function followPublish(io, name, started) {
         text: `✗ Version ${publish.number} is still publishing after ${PUBLISH_WAIT_MS / 60_000} minutes\n  next  app versions shows how it ends`
     };
 }
-export async function publish(io, root, isStarter) {
+export async function publish(io, root, isStarter, message) {
     try {
         const { name } = readProjectFile(root);
         const built = await io.build();
@@ -451,6 +453,9 @@ export async function publish(io, root, isStarter) {
             return built;
         io.say('✓ Built');
         const { form, sources } = uploadForm(root, io, isStarter);
+        const said = publishMessage(message ?? '');
+        if (said !== null)
+            form.append(UPLOAD.message, said);
         io.say(`✓ Packed the build and ${sources} source files`);
         const again = isStarter ? 'app publish --starter' : 'app publish';
         const result = await signedIn(io, again, async () => {
@@ -492,7 +497,7 @@ export async function versions(io, root) {
                 ? `restored version ${item.restoredFrom}`
                 : item.isStarter
                     ? 'starter site'
-                    : `published by ${item.byEmail}`;
+                    : (item.message ?? `published by ${item.byEmail}`);
             return `  ${String(item.number).padStart(3)}  ${item.status.padEnd(7)}  ${item.startedAt.slice(0, 16).replace('T', ' ')}  ${what}`;
         });
         return {

package/dist/publishWire.d.ts

@@ -17,7 +17,10 @@ export declare const UPLOAD: {
     readonly source: "source/";
     readonly compatibilityDate: "compatibilityDate";
     readonly sdkVersion: "sdkVersion";
+    readonly message: "message";
 };
+export declare const PUBLISH_MESSAGE_LIMIT = 100;
+export declare function publishMessage(text: string): string | null;
 export declare const publishStep: z.ZodEnum<{
     publish: "publish";
     reserve: "reserve";
@@ -47,6 +50,7 @@ export declare const publishSummary: z.ZodObject<{
     byEmail: z.ZodString;
     restoredFrom: z.ZodNullable<z.ZodNumber>;
     isStarter: z.ZodBoolean;
+    message: z.ZodNullable<z.ZodString>;
     startedAt: z.ZodString;
     finishedAt: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>;
@@ -73,6 +77,7 @@ export declare const appSummary: z.ZodObject<{
         byEmail: z.ZodString;
         restoredFrom: z.ZodNullable<z.ZodNumber>;
         isStarter: z.ZodBoolean;
+        message: z.ZodNullable<z.ZodString>;
         startedAt: z.ZodString;
         finishedAt: z.ZodNullable<z.ZodString>;
     }, z.core.$strip>>;
@@ -135,6 +140,7 @@ export declare const publishServices: {
                 byEmail: z.ZodString;
                 restoredFrom: z.ZodNullable<z.ZodNumber>;
                 isStarter: z.ZodBoolean;
+                message: z.ZodNullable<z.ZodString>;
                 startedAt: z.ZodString;
                 finishedAt: z.ZodNullable<z.ZodString>;
             }, z.core.$strip>>;
@@ -161,6 +167,7 @@ export declare const publishServices: {
                 byEmail: z.ZodString;
                 restoredFrom: z.ZodNullable<z.ZodNumber>;
                 isStarter: z.ZodBoolean;
+                message: z.ZodNullable<z.ZodString>;
                 startedAt: z.ZodString;
                 finishedAt: z.ZodNullable<z.ZodString>;
             }, z.core.$strip>>;
@@ -190,6 +197,7 @@ export declare const publishServices: {
                 byEmail: z.ZodString;
                 restoredFrom: z.ZodNullable<z.ZodNumber>;
                 isStarter: z.ZodBoolean;
+                message: z.ZodNullable<z.ZodString>;
                 startedAt: z.ZodString;
                 finishedAt: z.ZodNullable<z.ZodString>;
             }, z.core.$strip>>;
@@ -227,6 +235,7 @@ export declare const publishServices: {
             byEmail: z.ZodString;
             restoredFrom: z.ZodNullable<z.ZodNumber>;
             isStarter: z.ZodBoolean;
+            message: z.ZodNullable<z.ZodString>;
             startedAt: z.ZodString;
             finishedAt: z.ZodNullable<z.ZodString>;
         }, z.core.$strip>>>>;
@@ -247,6 +256,7 @@ export declare const publishServices: {
             byEmail: z.ZodString;
             restoredFrom: z.ZodNullable<z.ZodNumber>;
             isStarter: z.ZodBoolean;
+            message: z.ZodNullable<z.ZodString>;
             startedAt: z.ZodString;
             finishedAt: z.ZodNullable<z.ZodString>;
         }, z.core.$strip>>>;
@@ -267,6 +277,7 @@ export declare const publishServices: {
             byEmail: z.ZodString;
             restoredFrom: z.ZodNullable<z.ZodNumber>;
             isStarter: z.ZodBoolean;
+            message: z.ZodNullable<z.ZodString>;
             startedAt: z.ZodString;
             finishedAt: z.ZodNullable<z.ZodString>;
         }, z.core.$strip>>>;

package/dist/publishWire.js

@@ -89,8 +89,14 @@ export const UPLOAD = {
     migrations: 'migrations/',
     source: 'source/',
     compatibilityDate: 'compatibilityDate',
-    sdkVersion: 'sdkVersion'
+    sdkVersion: 'sdkVersion',
+    message: 'message'
 };
+export const PUBLISH_MESSAGE_LIMIT = 100;
+export function publishMessage(text) {
+    const firstLine = (text.split('\n')[0] ?? '').replaceAll(/\s+/g, ' ').trim();
+    return firstLine === '' ? null : firstLine.slice(0, PUBLISH_MESSAGE_LIMIT);
+}
 export const publishStep = z.enum(['reserve', 'database', 'sign-in', 'publish']);
 export const publishStatus = z.enum(['running', 'live', 'failed']);
 export const publishSummary = z.object({
@@ -101,6 +107,7 @@ export const publishSummary = z.object({
     byEmail: z.string(),
     restoredFrom: z.number().nullable(),
     isStarter: z.boolean(),
+    message: z.string().nullable(),
     startedAt: z.string(),
     finishedAt: z.string().nullable()
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trypattern/sdk",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "type": "module",
   "files": [
     "dist",