storymaps 1.3.3 → 1.3.4

package/README.md

@@ -180,7 +180,9 @@ storymaps backup -m "Before the workshop"    # with a note
 storymaps backup storymaps.io/abc123         # back up a map you haven't pulled
 ```
 
-The backup shows in the map's activity log, and in **Menu → Backups** in the app.
+The backup shows in the map's activity log, and in **Menu → Backups** in the app. If the map hasn't changed since one of its backups, no new backup is made, and the CLI says which backup matches.
+
+**Locked maps** use the password saved by `storymaps unlock`, or ask for it.
 
 ### `backups`
 
@@ -209,7 +211,8 @@ storymaps restore 6e40f124ae7e --force       # restores without asking
 ### About backups
 
 - The CLI and the app share the same backups. A backup made in the app shows in `storymaps backups`, and one made with the CLI shows in the app.
-- The server keeps the newest 8 backups of each map.
+- The server keeps the newest 8 backups of each map. Backups are protected from deletion, but can be removed if needed by contacting us.
+- Making a backup of a locked map needs its password, so nobody else can push its backups out.
 - A self-hosted server needs updating before the CLI can make backups on it. An older one turns the request away, and the CLI says so.
 
 ### `validate`

package/lib/commands/backup.js

@@ -14,7 +14,12 @@ const cards = (n) => `${n} card${n === 1 ? '' : 's'}`;
 
 export async function backupCommand(target, opts) {
     const { id, baseUrl } = await resolveTarget(target, resolve(opts.file || 'storymap.yml'));
-    const backup = await createBackup(baseUrl, id, opts.message || '');
+    const lockPasswordHash = await lockPassword(baseUrl, id);
+    const backup = await createBackup(baseUrl, id, opts.message || '', { lockPasswordHash });
+    if (backup.unchanged) {
+        console.log(`No changes since backup ${chalk.cyan(backup.id)} from ${formatTime(backup.timestamp)}, so no new backup was made.`);
+        return;
+    }
     console.log(chalk.green(`Backed up map ${id} as ${backup.id} (${cards(backup.cardCount)})`));
 }
 
@@ -82,7 +87,7 @@ export async function restoreCommand(backupId, target, opts) {
     const lockPasswordHash = await lockPassword(baseUrl, id);
 
     // Like the app: a backup of the map as it is now, so the restore can be undone
-    const safety = await createBackup(baseUrl, id, 'Auto: before restore');
+    const safety = await createBackup(baseUrl, id, 'Auto: before restore', { lockPasswordHash });
     await putMap(baseUrl, id, backup.data, { contentType: 'application/json', lockPasswordHash, restoredBackup: backup.id });
 
     console.log(chalk.green(`Restored map ${id} from backup ${backup.id}`));

package/lib/util/api.js

@@ -135,10 +135,13 @@ export async function getBackup(baseUrl, id, backupId) {
     return res.json();
 }
 
-export async function createBackup(baseUrl, id, note = '') {
+// Answers with the new backup, or with a kept backup marked unchanged when the map matches it
+export async function createBackup(baseUrl, id, note = '', { lockPasswordHash } = {}) {
+    const headers = { 'Content-Type': 'application/json' };
+    if (lockPasswordHash) headers['X-Lock-Password'] = lockPasswordHash;
     const res = await request(`${baseUrl}/api/backups/${id}`, {
         method: 'POST',
-        headers: { 'Content-Type': 'application/json' },
+        headers,
         body: JSON.stringify({ note }),
     });
     // Servers from before the CLI could make backups turn the request away

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "storymaps",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "description": "CLI tool for storymaps.io - import, export, validate, and manage user story maps from the terminal",
   "type": "module",
   "bin": {