apostrophe 4.28.0 → 4.28.1

package/.claude/settings.local.json

@@ -0,0 +1,15 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(timeout 180 npx mocha:*)",
+      "Bash(timeout 600 npx mocha:*)",
+      "Bash(npm ls:*)",
+      "Bash(timeout 540 npx mocha:*)",
+      "Bash(echo:*)",
+      "Bash(timeout 10 node:*)",
+      "Bash(timeout 300 npx mocha:*)",
+      "Bash(timeout 60 npx mocha:*)",
+      "Bash(timeout 120 npx mocha:*)"
+    ]
+  }
+}

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 4.28.1
+
+### Patch Changes
+
+- f8d1952: Bug fix: the "pretty URLs" feature of @apostrophecms/file is now compatible with locale prefixes.
+
 ## 4.28.0
 
 ### Adds
@@ -8,7 +14,6 @@
 - Adds widget graph store, accessible in Admin UI.
 - Support for the new `prettyUrls: true` option for @apostrophecms/file, which enables "pretty URLs" for PDFs and other items in the file library, in exchange for a small performance impact. Edit the slug field to adjust the pretty URL
 
-
 ### Fixes
 
 - Fix a bug when rich text link open in new tab checkbox can't be cleared
@@ -27,7 +32,7 @@
 - Improve re-rendering UX while keeping the performance optimization
 - raise the user's widget z-index context only when focused
 - Hide add content buttons on rich text editing, like widget controls
--  Refine in-context focus states for calmer UX
+- Refine in-context focus states for calmer UX
 - Simplifies some in-context UI rendering checks
 - Updated dependencies
 

package/README.md

@@ -0,0 +1,142 @@
+<div align="center">
+  <a href="https://github.com/apostrophecms/apostrophe">
+    <img src="logo.svg" alt="ApostropheCMS logo" width="80" height="80">
+  </a>
+
+  <h1>ApostropheCMS</h1>
+
+  <p>
+    <a aria-label="Join the community on Discord" href="http://chat.apostrophecms.org">
+      <img alt="" src="https://img.shields.io/discord/517772094482677790?color=5865f2&label=Join%20the%20Discord&logo=discord&logoColor=fff&labelColor=000&style=for-the-badge&logoWidth=20" />
+    </a>
+    <a aria-label="License" href="https://github.com/apostrophecms/apostrophe/blob/main/LICENSE.md">
+      <img alt="" src="https://img.shields.io/static/v1?style=for-the-badge&labelColor=000000&label=License&message=MIT&color=3DA639" />
+    </a>
+  </p>
+
+  <p>
+    <strong>Full-stack CMS for developers and content teams</strong><br />
+    Build websites with in-context editing and headless flexibility using Node.js and MongoDB.
+    <br />
+    <a href="https://docs.apostrophecms.org/"><strong>Documentation »</strong></a>
+    <br />
+    <br />
+    <a href="http://demo.apostrophecms.com">Demo</a>
+    ·
+    <a href="https://roadmap.apostrophecms.com/roadmap">Roadmap</a>
+    ·
+    <a href="https://github.com/apostrophecms/apostrophe/issues/new?assignees=&labels=bug,3.0&template=bug_report.md&title=">Report Bug</a>
+  </p>
+</div>
+
+## About
+
+ApostropheCMS is a full-stack content management system built with Node.js and MongoDB. Content creators can edit directly on live pages without switching between admin interfaces, while developers can build with modern JavaScript or use it headlessly with any frontend framework.
+
+### Key Features
+
+- **🎯 In-Context Editing** - Content creators edit directly on the live page, seeing changes instantly
+- **⚡ Headless-Ready** - Use any frontend framework while keeping the powerful admin experience
+- **🛠️ Developer-First** - Built with Node.js and MongoDB for full-stack JavaScript development
+- **📈 Scales Beautifully** - From small sites to enterprise applications handling millions of pages
+- **🔐 Enterprise Features** - Advanced permissions, workflow management, automated translations, and more
+
+## System Requirements
+
+| Requirement | Version | Installation Notes |
+|-------------|---------|-------------------|
+| **Node.js** | 20.x+ | Use [NVM](https://github.com/nvm-sh/nvm) for version management |
+| **MongoDB** | 6.0+ | [MongoDB Atlas](https://www.mongodb.com/atlas) (cloud) or local install |
+| **npm** | 10.x+ | Included with Node.js |
+
+See our [setup guides](https://docs.apostrophecms.org/guide/development-setup.html) for installation instructions.
+
+## Quick Start
+
+Get ApostropheCMS running locally in minutes:
+
+```bash
+# Option 1: Install CLI globally (recommended for multiple projects)
+npm install -g @apostrophecms/cli
+apos create my-website
+cd my-website
+npm run dev
+
+# Option 2: Use npx for one-time project creation
+npx @apostrophecms/cli create my-website
+cd my-website
+npm run dev
+```
+
+Your new ApostropheCMS site will be available at `http://localhost:3000` with a powerful admin interface at `/login`.
+
+### Prefer to Go Headless?
+
+**Get started with Astro integration** - the easiest way to build headless sites while keeping visual editing:
+
+- **[Apollo Starter Kit (Astro)](https://apostrophecms.com/starter-kits/apollo-starter-kit-for-astro-cms)** - Production-ready foundation with beautiful design system and rich content features
+- **[Essentials Starter Kit (Astro)](git clone https://github.com/apostrophecms/starter-kit-astro-essentials)** - Minimal, clean foundation for building custom designs from scratch
+
+Both starter kits provide headless CMS power with in-context editing, letting content creators edit directly on the live site while you build with modern frontend tools. Our Astro integration handles all the content fetching automatically—no REST API calls to write.
+
+**Desire a different frontend framework?** Use our REST APIs with React, Vue, Svelte, or any other framework:
+
+- **[REST API Documentation](https://docs.apostrophecms.org/reference/api/pieces.html)** - Complete API reference
+- **[Headless CMS Guide](https://docs.apostrophecms.org/guide/headless-cms.html)** - Integration walkthrough for any framework
+
+### Hosting & Deployment
+
+Choose [ApostropheCMS hosting](https://apostrophecms.com/hosting) for turnkey solutions with optimized performance and dedicated support, or deploy to [any platform where Node.js runs](https://docs.apostrophecms.org/guide/hosting.html).
+
+## Built With Modern Tech
+
+- **[Node.js](https://nodejs.org/)** - JavaScript runtime for server-side development
+- **[MongoDB](https://www.mongodb.com/)** - Flexible document database for content storage
+- **ESM Modules** - Native ES6 module support for modern JavaScript
+- **Vite** - Lightning-fast build tool and development server
+- **Modern JavaScript** - ES6+, async/await, and contemporary development patterns
+
+## Community & Support
+
+**Join other developers and content creators using ApostropheCMS:**
+
+- **[Discord](https://discord.com/invite/XkbRNq7)** - Get help, share projects, and connect with other users
+- **[GitHub Discussions](https://github.com/apostrophecms/apostrophe/discussions)** - Feature requests, technical discussions, and community support
+- **[Documentation](https://docs.apostrophecms.org/)** - Comprehensive guides, tutorials, and API references
+
+## Contributing
+
+We welcome contributions from the community! Whether you're fixing bugs, adding features, or improving documentation, your help makes ApostropheCMS better for everyone.
+
+- **[Contribution Guide](https://github.com/apostrophecms/apostrophe/blob/main/CONTRIBUTING.md)** - How to contribute code, documentation, and feedback
+- **[Good First Issues](https://github.com/apostrophecms/apostrophe/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)** - Perfect starting points for new contributors
+
+
+## Pro Features
+
+**For teams and organizations requiring additional features:**
+
+- **🔐 Advanced User Management** - Granular permissions, user groups, and access controls
+- **🌍 Automated Translation** - AI-powered translation with DeepL, Google Translate, and Azure
+- **📊 Analytics & SEO** - Built-in SEO optimization and content analytics
+- **⚡ Performance Optimization** - Advanced caching, CDN integration, and performance monitoring
+- **🏢 Multisite Management** - Manage multiple sites from a single dashboard with shared resources
+- **💼 Professional Support** - Dedicated support, training, and consultation services
+
+[Explore all the pro extensions](https://apostrophecms.com/extensions?autocomplete=&license=assembly&license=pro) and [sign up](https://app.apostrophecms.com/login) for a Pro license in our self-service Apostrophe Workspaces, or [contact us](https://apostrophecms.com/contact-us) to learn about licensing and support options.
+
+## License
+
+ApostropheCMS is open source software licensed under the [MIT License](https://github.com/apostrophecms/apostrophe/blob/main/LICENSE.md). This means you're free to use, modify, and distribute it for both personal and commercial projects.
+
+---
+
+<div align="center">
+  <p>
+    <strong>Ready to build something amazing?</strong><br>
+    <a href="https://docs.apostrophecms.org/">Get started with our documentation</a> or <a href="https://apostrophecms.com/contact-us">talk to our team</a>
+  </p>
+  <p>
+    <em>Built with ❤️ by the <a href="https://apostrophecms.com">ApostropheCMS team</a></em>
+  </p>
+</div>

package/modules/@apostrophecms/file/index.js

@@ -111,8 +111,7 @@ module.exports = {
           // (the slug-taken route does that)
           if (self.options.prettyUrls && file.attachment) {
             const { extension } = file.attachment;
-            const baseUrl = self.apos.url.getBaseUrl(req, { prefix: true });
-            file._url = `${baseUrl}${self.options.prettyUrlDir}/${file.slug.replace(self.options.slugPrefix || '', '')}.${extension}`;
+            file._url = `${req.prefix}${self.options.prettyUrlDir}/${file.slug.replace(self.options.slugPrefix || '', '')}.${extension}`;
             file.attachment._prettyUrl = file._url;
           } else {
             file._url = self.apos.attachment.url(file.attachment);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apostrophe",
-  "version": "4.28.0",
+  "version": "4.28.1",
   "description": "The Apostrophe Content Management System.",
   "main": "index.js",
   "repository": {
@@ -119,12 +119,12 @@
     "webpack": "^5.72.0",
     "webpack-merge": "^5.7.3",
     "xregexp": "^2.0.0",
-    "boring": "^1.1.1",
-    "postcss-viewport-to-container-toggle": "^2.3.0",
-    "sanitize-html": "^2.17.2",
     "@apostrophecms/emulate-mongo-3-driver": "^1.0.6",
+    "express-cache-on-demand": "^1.0.4",
     "broadband": "^1.1.0",
-    "express-cache-on-demand": "^1.0.4"
+    "sanitize-html": "^2.17.2",
+    "postcss-viewport-to-container-toggle": "^2.3.0",
+    "boring": "^1.1.1"
   },
   "devDependencies": {
     "eslint": "^9.39.1",

package/test/add-missing-schema-fields-project/node_modules/.package-lock.json

@@ -5,7 +5,7 @@
   "requires": true,
   "packages": {
     "../..": {
-      "version": "4.27.0",
+      "version": "4.28.0",
       "license": "MIT",
       "dependencies": {
         "@apostrophecms/emulate-mongo-3-driver": "workspace:^",
@@ -100,7 +100,7 @@
         "tiny-emitter": "^2.1.0",
         "tough-cookie": "^4.0.0",
         "underscore.string": "^3.3.4",
-        "uploadfs": "^1.25.1",
+        "uploadfs": "workspace:^",
         "void-elements": "^3.1.0",
         "vue": "^3.5.20",
         "vue-advanced-cropper": "^2.8.8",

package/test/files.js

@@ -133,3 +133,132 @@ describe('Files', function() {
   });
 
 });
+
+describe('Files with i18n locale prefixes', function() {
+
+  let apos;
+
+  const mockFiles = [
+    {
+      type: '@apostrophecms/file',
+      slug: 'file-locale-test',
+      visibility: 'public',
+      attachment: {
+        type: 'attachment',
+        _id: 'testid-locale',
+        name: 'localename',
+        extension: 'pdf',
+        data: 'I am a fake localized PDF'
+      }
+    }
+  ];
+
+  this.timeout(t.timeout);
+
+  after(async function() {
+    return t.destroy(apos);
+  });
+
+  before(async function() {
+    this.timeout(t.timeout);
+    this.slow(2000);
+
+    apos = await t.create({
+      root: module,
+      modules: {
+        '@apostrophecms/file': {
+          options: {
+            prettyUrls: true
+          }
+        },
+        '@apostrophecms/i18n': {
+          options: {
+            locales: {
+              en: {},
+              fr: {
+                prefix: '/fr'
+              }
+            }
+          }
+        }
+      }
+    });
+
+    apos.baseUrl = apos.http.getBase();
+
+    try {
+      await apos.doc.db.deleteMany({ type: '@apostrophecms/file' });
+      try {
+        fs.mkdirSync(`${__dirname}/public/uploads/attachments`);
+      } catch (e) {
+        // May already exist
+      }
+    } catch (e) {
+      assert(false);
+    }
+
+    // Insert the file doc in the default (en) locale
+    const req = apos.task.getReq();
+    for (const file of mockFiles) {
+      await apos.file.insert(req, file);
+      const {
+        _id, name, extension, data
+      } = file.attachment;
+      fs.writeFileSync(
+        `${__dirname}/public/uploads/attachments/${_id}-${name}.${extension}`,
+        data
+      );
+    }
+
+    // Localize the file to FR and give it a distinct French slug
+    const enFile = await apos.file.find(req, {}).toObject();
+    await apos.file.localize(req, enFile, 'fr');
+    const frReq = apos.task.getReq({ locale: 'fr' });
+    const frDraft = await apos.file.find(frReq.clone({ mode: 'draft' }), {}).toObject();
+    frDraft.slug = 'file-test-locale-fr';
+    frDraft.title = 'Test Locale FR';
+    await apos.file.update(frReq, frDraft);
+  });
+
+  it('should include locale prefix and FR slug in pretty URL for FR locale', async function() {
+    const frReq = apos.task.getAnonReq({ locale: 'fr' });
+    const files = await apos.file.find(frReq).toArray();
+    assert.strictEqual(files.length, 1);
+    const file = files[0];
+    const attachment = apos.attachment.first(file);
+    const url = apos.attachment.url(attachment);
+    assert(url);
+    // Must use the FR slug (test-locale-fr) and include /fr/ prefix
+    assert.strictEqual(
+      url,
+      `${apos.http.getBase()}/fr/files/test-locale-fr.${attachment.extension}`
+    );
+  });
+
+  it('should serve the file at the locale-prefixed pretty URL with FR slug', async function() {
+    const frReq = apos.task.getAnonReq({ locale: 'fr' });
+    const files = await apos.file.find(frReq).toArray();
+    assert.strictEqual(files.length, 1);
+    const file = files[0];
+    const attachment = apos.attachment.first(file);
+    const url = apos.attachment.url(attachment);
+    // Verify the locale-prefixed, FR-slug URL actually serves the content
+    const body = await apos.http.get(url);
+    assert.strictEqual(body, attachment.data);
+  });
+
+  it('should use EN slug without locale prefix for default EN locale', async function() {
+    const enReq = apos.task.getAnonReq({ locale: 'en' });
+    const files = await apos.file.find(enReq).toArray();
+    assert.strictEqual(files.length, 1);
+    const file = files[0];
+    const attachment = apos.attachment.first(file);
+    const url = apos.attachment.url(attachment);
+    assert(url);
+    // EN keeps its original slug (locale-test) with no locale prefix
+    assert.strictEqual(
+      url,
+      `${apos.http.getBase()}/files/locale-test.${attachment.extension}`
+    );
+  });
+});