sandcms 0.7.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. package/README.md +4 -4
  2. package/dist/admin/Admin.svelte +7 -5
  3. package/dist/admin/AssetAttachment.svelte +8 -3
  4. package/dist/admin/AssetAttachment.svelte.d.ts +3 -0
  5. package/dist/admin/Editor.svelte +5 -9
  6. package/dist/admin/Fields.svelte +2 -1
  7. package/dist/admin/Gallery.svelte +221 -76
  8. package/dist/admin/Inbox.svelte +3 -2
  9. package/dist/admin/MediaPicker.svelte +36 -20
  10. package/dist/admin/Navigation.svelte +13 -2
  11. package/dist/admin/Pages.svelte +195 -0
  12. package/dist/admin/Pages.svelte.d.ts +7 -0
  13. package/dist/admin/Shell.svelte +27 -5
  14. package/dist/admin/SortableList.svelte +82 -61
  15. package/dist/admin/SortableList.svelte.d.ts +3 -1
  16. package/dist/admin/Users.svelte +8 -3
  17. package/dist/admin/generated/admin.css +300 -20
  18. package/dist/admin/navigation.d.ts +9 -0
  19. package/dist/admin/navigation.js +20 -1
  20. package/dist/admin/types.d.ts +1 -0
  21. package/dist/blueprints/labels.d.ts +6 -0
  22. package/dist/blueprints/labels.js +14 -0
  23. package/dist/blueprints/load.js +11 -2
  24. package/dist/blueprints/types.d.ts +2 -2
  25. package/dist/cli/admin.d.ts +39 -0
  26. package/dist/cli/admin.js +95 -0
  27. package/dist/cli/backup.js +4 -4
  28. package/dist/cli/doctor.d.ts +8 -1
  29. package/dist/cli/doctor.js +19 -9
  30. package/dist/cli/email-test.d.ts +3 -0
  31. package/dist/cli/email-test.js +20 -0
  32. package/dist/cli/files.js +2 -1
  33. package/dist/cli/index.js +373 -135
  34. package/dist/cli/rebaseline.d.ts +10 -0
  35. package/dist/cli/rebaseline.js +117 -0
  36. package/dist/cli/upgrade.js +17 -9
  37. package/dist/env.d.ts +0 -8
  38. package/dist/env.js +0 -8
  39. package/dist/notification-fields.js +2 -1
  40. package/dist/server/admin-load.d.ts +72 -0
  41. package/dist/server/admin-load.js +20 -0
  42. package/dist/server/api-keys.d.ts +96 -0
  43. package/dist/server/api-keys.js +115 -0
  44. package/dist/server/api.js +16 -61
  45. package/dist/server/cms.d.ts +0 -5
  46. package/dist/server/cms.js +4 -3
  47. package/dist/server/db/auto-migrate.d.ts +0 -4
  48. package/dist/server/db/auto-migrate.js +12 -3
  49. package/dist/server/db/legacy.d.ts +13 -0
  50. package/dist/server/db/legacy.js +60 -0
  51. package/dist/server/db/migration-data.js +2 -38
  52. package/dist/server/db/migrations/{0000_foundation.sql → 0000_baseline.sql} +120 -4
  53. package/dist/server/db/migrations/meta/0000_snapshot.json +578 -3
  54. package/dist/server/db/migrations/meta/_journal.json +2 -65
  55. package/dist/server/db/schema.js +8 -6
  56. package/dist/server/db/store.d.ts +25 -2
  57. package/dist/server/db/store.js +90 -26
  58. package/dist/server/forms.js +2 -1
  59. package/dist/server/media/runner.d.ts +1 -1
  60. package/dist/server/media/runner.js +1 -1
  61. package/dist/server/media/service.d.ts +0 -4
  62. package/dist/server/media/service.js +0 -2
  63. package/dist/server/media/verify.d.ts +28 -0
  64. package/dist/server/media/verify.js +94 -2
  65. package/dist/server/platform/snapshots.js +3 -3
  66. package/docs/acceptance.md +2 -2
  67. package/docs/api.md +15 -1
  68. package/docs/cloudflare.md +9 -41
  69. package/docs/content.md +18 -3
  70. package/docs/deployment.md +97 -34
  71. package/docs/email.md +6 -0
  72. package/docs/forms.md +1 -1
  73. package/docs/media.md +10 -1
  74. package/docs/package.md +4 -4
  75. package/docs/releases.md +21 -1
  76. package/docs/upgrades.md +41 -7
  77. package/package.json +4 -10
  78. package/templates/Dockerfile +6 -2
  79. package/templates/integration.ts +10 -5
  80. package/templates/openship.json +9 -0
  81. package/templates/sandcms/config.yaml +1 -0
  82. package/dist/server/db/migrations/0001_independent_password_resets.sql +0 -3
  83. package/dist/server/db/migrations/0002_email_failure_reason.sql +0 -1
  84. package/dist/server/db/migrations/0003_direct_r2_uploads.sql +0 -10
  85. package/dist/server/db/migrations/0004_agent_api_keys.sql +0 -38
  86. package/dist/server/db/migrations/0005_api_retention_and_pagination.sql +0 -3
  87. package/dist/server/db/migrations/0006_durable_media_deletion.sql +0 -7
  88. package/dist/server/db/migrations/0007_content_and_job_indexes.sql +0 -2
  89. package/dist/server/db/migrations/0008_search_text_cache.sql +0 -45
  90. package/dist/server/db/migrations/0009_local_media.sql +0 -9
  91. package/dist/server/db/migrations/meta/0001_snapshot.json +0 -1197
  92. package/dist/server/db/migrations/meta/0002_snapshot.json +0 -1204
  93. package/dist/server/db/migrations/meta/0003_snapshot.json +0 -1281
  94. package/dist/server/db/migrations/meta/0004_snapshot.json +0 -1546
  95. package/dist/server/db/migrations/meta/0005_snapshot.json +0 -1572
  96. package/dist/server/db/migrations/meta/0006_snapshot.json +0 -1627
  97. package/dist/server/db/migrations/meta/0007_snapshot.json +0 -1643
  98. package/dist/server/db/migrations/meta/0008_snapshot.json +0 -1711
  99. package/dist/server/db/migrations/meta/0009_snapshot.json +0 -1763
  100. package/dist/server/media/import-r2.d.ts +0 -56
  101. package/dist/server/media/import-r2.js +0 -342
  102. package/dist/worker/index.d.ts +0 -10
  103. package/dist/worker/index.js +0 -460
  104. package/dist/worker/local.d.ts +0 -5
  105. package/dist/worker/local.js +0 -57
  106. package/dist/worker/source.d.ts +0 -2
  107. package/dist/worker/source.js +0 -31
  108. package/dist/worker/svg.d.ts +0 -1
  109. package/dist/worker/svg.js +0 -2
  110. package/dist/worker/uploads.d.ts +0 -22
  111. package/dist/worker/uploads.js +0 -48
@@ -1,3 +1,10 @@
1
1
  /** The Bun adapter's BODY_SIZE_LIMIT format: bytes with an optional K/M/G suffix (default 512K). */
2
2
  export declare function parseBodySizeLimit(value?: string): number;
3
- export declare function doctor(root: string, database: string, env?: NodeJS.ProcessEnv): Promise<void>;
3
+ export interface DoctorCheck {
4
+ status: 'ok' | 'fail' | 'warn' | 'info';
5
+ message: string;
6
+ }
7
+ /** With `json`, prints one `{ ok, checks }` object instead of lines. Throws when any check fails. */
8
+ export declare function doctor(root: string, database: string, env?: NodeJS.ProcessEnv, { json }?: {
9
+ json?: boolean | undefined;
10
+ }): Promise<DoctorCheck[]>;
@@ -23,14 +23,21 @@ const writable = (path) => {
23
23
  return false;
24
24
  }
25
25
  };
26
- export async function doctor(root, database, env = process.env) {
27
- const issues = [];
26
+ /** With `json`, prints one `{ ok, checks }` object instead of lines. Throws when any check fails. */
27
+ export async function doctor(root, database, env = process.env, { json = false } = {}) {
28
+ const issues = [], checks = [];
29
+ const report = (status, message) => {
30
+ checks.push({ status, message });
31
+ if (!json)
32
+ (status === 'warn' ? console.warn : console.log)(`${status.toUpperCase()}: ${message}`);
33
+ };
34
+ const info = (message) => report('info', message);
28
35
  const check = (ok, message) => {
29
- console.log(`${ok ? 'OK' : 'FAIL'}: ${message}`);
36
+ report(ok ? 'ok' : 'fail', message);
30
37
  if (!ok)
31
38
  issues.push(message);
32
39
  };
33
- const warn = (message) => console.warn(`WARN: ${message}`);
40
+ const warn = (message) => report('warn', message);
34
41
  const source = (file) => existsSync(join(root, file)) ? readFileSync(join(root, file), 'utf8') : '';
35
42
  const pkg = JSON.parse(source('package.json') || '{}');
36
43
  check(pkg.packageManager === `bun@${Bun.version}`, 'packageManager pins the running Bun version');
@@ -59,7 +66,7 @@ export async function doctor(root, database, env = process.env) {
59
66
  if (prerendered.length)
60
67
  warn(`Prerendered routes bypass server hooks (no host redirect or noindex header): ${prerendered.map((f) => f.slice(root.length + 1)).join(', ')}`);
61
68
  const definition = loadDefinition(join(root, 'sandcms'));
62
- console.log(`Blueprints: ${definition.blueprints.length} valid; project: ${definition.config.name}`);
69
+ info(`Blueprints: ${definition.blueprints.length} valid; project: ${definition.config.name}`);
63
70
  check((env.SANDCMS_SECRET?.length ?? 0) >= 32, 'SANDCMS_SECRET contains at least 32 characters');
64
71
  check(Boolean(env.SANDCMS_ORIGIN), 'SANDCMS_ORIGIN is configured');
65
72
  const minimumBody = UPLOAD_CHUNK_SIZE + 1024 ** 2;
@@ -78,7 +85,7 @@ export async function doctor(root, database, env = process.env) {
78
85
  const dataDir = dirname(resolve(database));
79
86
  if (existsSync(dataDir)) {
80
87
  if (onMountedVolume(dataDir))
81
- console.log(`OK: Data directory ${dataDir} is on a mounted volume`);
88
+ report('ok', `Data directory ${dataDir} is on a mounted volume`);
82
89
  else
83
90
  warn(`Data directory ${dataDir} is not a mount point. In a container, mount one persistent volume there.`);
84
91
  const siteFile = join(dataDir, 'site-id');
@@ -87,14 +94,14 @@ export async function doctor(root, database, env = process.env) {
87
94
  check(site.project === definition.config.name, `site-id ${site.id} belongs to this project (${site.project})`);
88
95
  }
89
96
  else
90
- console.log('INFO: site-id is written on the first website start');
97
+ info('site-id is written on the first website start');
91
98
  const last = lastSnapshot(dataDir);
92
99
  if (!last)
93
100
  warn('No database snapshot yet: the running website writes backups/latest.sqlite hourly.');
94
101
  else if (Date.now() - last.getTime() > 2 * SNAPSHOT_INTERVAL)
95
102
  warn(`Latest snapshot is from ${last.toISOString()}; the running website writes one hourly.`);
96
103
  else
97
- console.log(`OK: Latest snapshot ${last.toISOString()}`);
104
+ report('ok', `Latest snapshot ${last.toISOString()}`);
98
105
  }
99
106
  const mediaDir = resolve(env.SANDCMS_MEDIA_DIR?.trim() || join(dataDir, 'media'));
100
107
  const existing = existsSync(mediaDir) ? mediaDir : dirname(mediaDir);
@@ -103,12 +110,15 @@ export async function doctor(root, database, env = process.env) {
103
110
  const fs = statfsSync(existing), free = fs.bavail * fs.bsize;
104
111
  const used = walk(mediaDir).reduce((total, file) => total + statSync(file).size, 0);
105
112
  const quota = definition.config.media.maxStorage;
106
- console.log(`Media: ${size(used)} used${quota ? ` of a ${size(quota)} quota` : ''}; ${size(free)} free on the volume`);
113
+ info(`Media: ${size(used)} used${quota ? ` of a ${size(quota)} quota` : ''}; ${size(free)} free on the volume`);
107
114
  if (free < 5 * GB)
108
115
  warn('Less than 5 GB free: uploads are refused when free space runs low.');
109
116
  if (quota && used > quota * 0.9)
110
117
  warn('Media uses more than 90% of media.maxStorage.');
111
118
  }
119
+ if (json)
120
+ console.log(JSON.stringify({ ok: !issues.length, checks }, null, 2));
112
121
  if (issues.length)
113
122
  throw new Error(`Doctor found ${issues.length} issue(s). Resolve the FAIL items above.`);
123
+ return checks;
114
124
  }
@@ -0,0 +1,3 @@
1
+ import { type EmailOptions } from '../server/email/index.js';
2
+ /** Send one message with the configured SMTP settings and explain a failure without provider text. */
3
+ export declare function sendTestEmail(to: string, options?: EmailOptions | undefined, origin?: string | undefined): Promise<import("../server/email/index.js").EmailResult>;
@@ -0,0 +1,20 @@
1
+ import { createEmail, emailOptionsFromEnv, emailFailureMessage, EmailError } from '../server/email/index.js';
2
+ /** Send one message with the configured SMTP settings and explain a failure without provider text. */
3
+ export async function sendTestEmail(to, options = emailOptionsFromEnv(process.env), origin = process.env.SANDCMS_ORIGIN) {
4
+ try {
5
+ if (!options)
6
+ throw new Error('Email is not configured. Set SANDCMS_EMAIL_FROM and SANDCMS_SMTP_HOST; see docs/email.md.');
7
+ return await createEmail(options).send({
8
+ to,
9
+ subject: 'SandCMS test email',
10
+ text: `This test message was sent by sandcms email test${origin ? ` for ${origin}` : ''}.\n\n` +
11
+ 'Invitations, password resets and form notifications use the same settings.'
12
+ });
13
+ }
14
+ catch (error) {
15
+ if (!(error instanceof EmailError))
16
+ throw error;
17
+ // Reasons are safe categories; provider text is never shown or stored.
18
+ throw new Error(error.reason ? emailFailureMessage(error.reason) : error.message);
19
+ }
20
+ }
package/dist/cli/files.js CHANGED
@@ -29,6 +29,7 @@ export function planFiles(root, name = 'My website') {
29
29
  const templates = {
30
30
  Dockerfile: 'Dockerfile',
31
31
  '.dockerignore': 'dockerignore',
32
+ 'openship.json': 'openship.json',
32
33
  'src/routes/(sandcms)/admin/[...path]/+page.server.ts': 'routes/admin/+page.server.ts',
33
34
  'src/routes/(sandcms)/admin/[...path]/+page.svelte': 'routes/admin/+page.svelte',
34
35
  'src/routes/(sandcms)/api/cms/[...path]/+server.ts': 'routes/api/+server.ts',
@@ -51,7 +52,7 @@ export function planFiles(root, name = 'My website') {
51
52
  templates[file + '.js'] = templates[file + '.ts'];
52
53
  delete templates[file + '.ts'];
53
54
  }
54
- // From 0.7.0 there are no sandcms/worker/* templates; existing project copies are left alone.
55
+ // There are no sandcms/worker/* templates since 0.7.0; existing project copies are left alone.
55
56
  for (const file of walk(join(templateRoot, 'sandcms')))
56
57
  templates['sandcms/' + relative(join(templateRoot, 'sandcms'), file)] =
57
58
  'sandcms/' + relative(join(templateRoot, 'sandcms'), file);