@raketa-cloud/admin 1.7.4 → 1.7.6

package/src/tests/handlers/pages/ExportsHandler.test/index.test.js

@@ -0,0 +1,212 @@
+import ExportsHandler from "../../../../handlers/pages/ExportsHandler";
+import Pages from "../../../../cloud/Pages";
+
+describe("Pages ExportsHandler", () => {
+  function buildCtx(query = {}) {
+    return {
+      params: {},
+      query: query,
+      client: {
+        pages: new Pages(() => ({}), "token"),
+      },
+      resourceConfig: {
+        pageType: "page",
+      },
+      remoteConfig: {
+        resourceUrl: (item) => item.slug,
+      },
+    };
+  }
+
+  describe("index (exportCSV)", () => {
+    test("exports pages to CSV with default locale", async () => {
+      const mockPages = [
+        {
+          id: 1,
+          title: "Page 1",
+          slug: "/page-1",
+          visibility: "public",
+          insertedAt: "2024-01-01",
+          updatedAt: "2024-01-02",
+        },
+        {
+          id: 2,
+          title: "Page 2",
+          slug: "/page-2",
+          visibility: "private",
+          insertedAt: "2024-01-03",
+          updatedAt: "2024-01-04",
+        },
+      ];
+
+      const ctx = buildCtx({});
+
+      const mockedlistAll = jest
+        .spyOn(ctx.client.pages, "listAll")
+        .mockImplementation(() => ({ list: mockPages }));
+
+      const mockDate = new Date("2024-08-30T10:30:00");
+      jest.spyOn(global, "Date").mockImplementation(() => mockDate);
+
+      const result = await ExportsHandler.index(ctx);
+
+      expect(mockedlistAll).toHaveBeenCalledWith({}, "en", "page");
+
+      expect(result.text).toContain(
+        "id,type,locale,title,URL,visibility,created_at,updated_at",
+      );
+      expect(result.text).toContain(
+        "1,page,en,Page 1,/page-1,public,2024-01-01,2024-01-02",
+      );
+      expect(result.text).toContain(
+        "2,page,en,Page 2,/page-2,private,2024-01-03,2024-01-04",
+      );
+
+      expect(result.headers).toEqual({
+        "Content-Type": "text/csv",
+        "Content-Disposition": 'attachment; filename="300824_page_export.csv"',
+      });
+
+      global.Date.mockRestore();
+    });
+
+    test("exports pages to CSV with specified locale", async () => {
+      const mockPages = [
+        {
+          id: 1,
+          title: "Página 1",
+          slug: "/pagina-1",
+          visibility: "public",
+          insertedAt: "2024-01-01",
+          updatedAt: "2024-01-02",
+        },
+      ];
+
+      const ctx = buildCtx({ locale: "es" });
+
+      const mockedlistAll = jest
+        .spyOn(ctx.client.pages, "listAll")
+        .mockImplementation(() => ({ list: mockPages }));
+
+      const result = await ExportsHandler.index(ctx);
+
+      expect(mockedlistAll).toHaveBeenCalledWith(
+        { locale: "es" },
+        "es",
+        "page",
+      );
+
+      expect(result.text).toContain(
+        "1,page,es,Página 1,/pagina-1,public,2024-01-01,2024-01-02",
+      );
+    });
+
+    test("exports pages with CSV special characters properly escaped", async () => {
+      const mockPages = [
+        {
+          id: 1,
+          title: 'Page with, comma and "quotes"',
+          slug: "/page-1",
+          visibility: "public",
+          insertedAt: "2024-01-01",
+          updatedAt: "2024-01-02",
+        },
+        {
+          id: 2,
+          title: "Page with\nnewline",
+          slug: "/page-2",
+          visibility: "private",
+          insertedAt: "2024-01-03",
+          updatedAt: "2024-01-04",
+        },
+      ];
+
+      const ctx = buildCtx({});
+
+      jest
+        .spyOn(ctx.client.pages, "listAll")
+        .mockImplementation(() => ({ list: mockPages }));
+
+      const result = await ExportsHandler.index(ctx);
+
+      expect(result.text).toContain('"Page with, comma and ""quotes"""');
+      expect(result.text).toContain('"Page with\nnewline"');
+    });
+
+    test("exports empty list when no pages found", async () => {
+      const ctx = buildCtx({});
+
+      jest
+        .spyOn(ctx.client.pages, "listAll")
+        .mockImplementation(() => ({ list: [] }));
+
+      const result = await ExportsHandler.index(ctx);
+
+      expect(result.text).toBe(
+        "id,type,locale,title,URL,visibility,created_at,updated_at",
+      );
+    });
+
+    test("passes query parameters to listAll", async () => {
+      const query = {
+        search: "test",
+        visibility: "public",
+        locale: "en",
+      };
+
+      const ctx = buildCtx(query);
+
+      const mockedlistAll = jest
+        .spyOn(ctx.client.pages, "listAll")
+        .mockImplementation(() => ({ list: [] }));
+
+      await ExportsHandler.index(ctx);
+
+      expect(mockedlistAll).toHaveBeenCalledWith(query, "en", "page");
+    });
+
+    test("uses pageType from resourceConfig", async () => {
+      const ctx = buildCtx({});
+      ctx.resourceConfig.pageType = "custom-page-type";
+
+      const mockedlistAll = jest
+        .spyOn(ctx.client.pages, "listAll")
+        .mockImplementation(() => ({ list: [] }));
+
+      const mockDate = new Date("2024-08-30T10:30:00");
+      jest.spyOn(global, "Date").mockImplementation(() => mockDate);
+
+      const result = await ExportsHandler.index(ctx);
+
+      expect(mockedlistAll).toHaveBeenCalledWith({}, "en", "custom-page-type");
+
+      expect(result.headers["Content-Disposition"]).toContain(
+        "custom-page-type_export.csv",
+      );
+
+      global.Date.mockRestore();
+    });
+
+    test("exports all results without pagination", async () => {
+      const mockPages = Array.from({ length: 150 }, (_, i) => ({
+        id: i + 1,
+        title: `Page ${i + 1}`,
+        slug: `/page-${i + 1}`,
+        visibility: "public",
+        insertedAt: "2024-01-01",
+        updatedAt: "2024-01-02",
+      }));
+
+      const ctx = buildCtx({});
+
+      jest
+        .spyOn(ctx.client.pages, "listAll")
+        .mockImplementation(() => ({ list: mockPages }));
+
+      const result = await ExportsHandler.index(ctx);
+
+      const lines = result.text.split("\r\n");
+      expect(lines.length).toBe(151);
+    });
+  });
+});

package/src/tests/handlers/pages/PagesHandler.test/index.test.js

@@ -6,9 +6,20 @@ import Factory from "../../../support/factory";
 
 describe("Pages Handler", () => {
   function buildCtx() {
+    const mockPages = new Pages(() => ({}), "token");
+    mockPages.getConfig = jest.fn().mockReturnValue({
+      i18n: {
+        locales: {
+          en: { name: "English", code: "en-gb" },
+          es: { name: "Spanish", code: "es" },
+          fr: { name: "French", code: "fr" },
+        },
+      },
+    });
+
     return {
       client: {
-        pages: new Pages(() => ({}), "token"),
+        pages: mockPages,
         tags: new Tags(() => ({}), "token"),
       },
       query: { foo: "bar" },
@@ -45,6 +56,11 @@ describe("Pages Handler", () => {
           list: [page],
           pagination: pagination,
         },
+        translations: [
+          { name: "English", code: "en" },
+          { name: "Spanish", code: "es" },
+          { name: "French", code: "fr" },
+        ],
         tags: tags,
         visibilityOptions: ctx.client.pages.visibilityOptions(),
       },

package/src/tests/helpers/CSVExportHelper.test.js

@@ -0,0 +1,364 @@
+import CSVExportHelper from "../../helpers/CSVExportHelper";
+
+describe("CSVExportHelper", () => {
+  describe("escapeCSVValue", () => {
+    test("returns empty string for null", () => {
+      const result = CSVExportHelper.escapeCSVValue(null);
+      expect(result).toBe("");
+    });
+
+    test("returns empty string for undefined", () => {
+      const result = CSVExportHelper.escapeCSVValue(undefined);
+      expect(result).toBe("");
+    });
+
+    test("returns string as-is for simple values", () => {
+      const result = CSVExportHelper.escapeCSVValue("simple text");
+      expect(result).toBe("simple text");
+    });
+
+    test("wraps value in quotes and escapes internal quotes when value contains comma", () => {
+      const result = CSVExportHelper.escapeCSVValue("text, with comma");
+      expect(result).toBe('"text, with comma"');
+    });
+
+    test("wraps value in quotes and escapes internal quotes when value contains quotes", () => {
+      const result = CSVExportHelper.escapeCSVValue('text "with" quotes');
+      expect(result).toBe('"text ""with"" quotes"');
+    });
+
+    test("wraps value in quotes when value contains newline", () => {
+      const result = CSVExportHelper.escapeCSVValue("text\nwith\nnewlines");
+      expect(result).toBe('"text\nwith\nnewlines"');
+    });
+
+    test("wraps value in quotes when value contains carriage return", () => {
+      const result = CSVExportHelper.escapeCSVValue("text\rwith\rreturns");
+      expect(result).toBe('"text\rwith\rreturns"');
+    });
+
+    test("handles values with multiple special characters", () => {
+      const result = CSVExportHelper.escapeCSVValue(
+        'text, "with" special\nchars',
+      );
+      expect(result).toBe('"text, ""with"" special\nchars"');
+    });
+
+    test("converts numbers to strings", () => {
+      const result = CSVExportHelper.escapeCSVValue(42);
+      expect(result).toBe("42");
+    });
+
+    test("converts booleans to strings", () => {
+      const result = CSVExportHelper.escapeCSVValue(true);
+      expect(result).toBe("true");
+    });
+  });
+
+  describe("formatDataAsCSV", () => {
+    test("formats simple data with direct field mapping", () => {
+      const data = [
+        { id: 1, name: "Item 1" },
+        { id: 2, name: "Item 2" },
+      ];
+      const headers = ["id", "name"];
+      const fieldMapping = {
+        id: "id",
+        name: "name",
+      };
+
+      const result = CSVExportHelper.formatDataAsCSV(
+        data,
+        headers,
+        fieldMapping,
+      );
+
+      expect(result).toBe("id,name\r\n1,Item 1\r\n2,Item 2");
+    });
+
+    test("formats data with function field mapping", () => {
+      const data = [
+        { id: 1, firstName: "John", lastName: "Doe" },
+        { id: 2, firstName: "Jane", lastName: "Smith" },
+      ];
+      const headers = ["id", "fullName"];
+      const fieldMapping = {
+        id: "id",
+        fullName: (item) => `${item.firstName} ${item.lastName}`,
+      };
+
+      const result = CSVExportHelper.formatDataAsCSV(
+        data,
+        headers,
+        fieldMapping,
+      );
+
+      expect(result).toBe("id,fullName\r\n1,John Doe\r\n2,Jane Smith");
+    });
+
+    test("formats data with nested field mapping", () => {
+      const data = [
+        { id: 1, author: { name: "John Doe" } },
+        { id: 2, author: { name: "Jane Smith" } },
+      ];
+      const headers = ["id", "author"];
+      const fieldMapping = {
+        id: "id",
+        author: "author.name",
+      };
+
+      const result = CSVExportHelper.formatDataAsCSV(
+        data,
+        headers,
+        fieldMapping,
+      );
+
+      expect(result).toBe("id,author\r\n1,John Doe\r\n2,Jane Smith");
+    });
+
+    test("handles missing nested properties", () => {
+      const data = [
+        { id: 1, author: { name: "John Doe" } },
+        { id: 2, author: {} },
+        { id: 3 },
+      ];
+      const headers = ["id", "author"];
+      const fieldMapping = {
+        id: "id",
+        author: "author.name",
+      };
+
+      const result = CSVExportHelper.formatDataAsCSV(
+        data,
+        headers,
+        fieldMapping,
+      );
+
+      expect(result).toBe("id,author\r\n1,John Doe\r\n2,\r\n3,");
+    });
+
+    test("handles missing direct properties", () => {
+      const data = [{ id: 1, title: "Title 1" }, { id: 2 }];
+      const headers = ["id", "title"];
+      const fieldMapping = {
+        id: "id",
+        title: "title",
+      };
+
+      const result = CSVExportHelper.formatDataAsCSV(
+        data,
+        headers,
+        fieldMapping,
+      );
+
+      expect(result).toBe("id,title\r\n1,Title 1\r\n2,");
+    });
+
+    test("properly escapes CSV special characters in data", () => {
+      const data = [
+        { id: 1, title: 'Title with, comma and "quotes"' },
+        { id: 2, title: "Title with\nnewline" },
+      ];
+      const headers = ["id", "title"];
+      const fieldMapping = {
+        id: "id",
+        title: "title",
+      };
+
+      const result = CSVExportHelper.formatDataAsCSV(
+        data,
+        headers,
+        fieldMapping,
+      );
+
+      expect(result).toBe(
+        'id,title\r\n1,"Title with, comma and ""quotes"""\r\n2,"Title with\nnewline"',
+      );
+    });
+
+    test("formats empty data array", () => {
+      const data = [];
+      const headers = ["id", "name"];
+      const fieldMapping = {
+        id: "id",
+        name: "name",
+      };
+
+      const result = CSVExportHelper.formatDataAsCSV(
+        data,
+        headers,
+        fieldMapping,
+      );
+
+      expect(result).toBe("id,name");
+    });
+
+    test("formats data with standard field mapping", () => {
+      const mockRemoteConfig = {
+        resourceUrl: (item, type, locale) => `/${locale}/${type}/${item.id}`,
+      };
+
+      const data = [
+        {
+          id: 1,
+          title: "Test Article",
+          slug: "/test-article",
+          visibility: "public",
+          insertedAt: "2024-01-01",
+          updatedAt: "2024-01-02",
+        },
+      ];
+      const headers = [...CSVExportHelper.standardHeaders];
+      const fieldMapping = CSVExportHelper.standardFieldMapping(
+        mockRemoteConfig,
+        "en",
+        "article",
+      );
+
+      const result = CSVExportHelper.formatDataAsCSV(
+        data,
+        headers,
+        fieldMapping,
+      );
+
+      expect(result).toBe(
+        "id,type,locale,title,URL,visibility,created_at,updated_at\r\n" +
+          "1,article,en,Test Article,/en/article/1,public,2024-01-01,2024-01-02",
+      );
+    });
+  });
+
+  describe("generateExportFilename", () => {
+    test("generates filename with correct format", () => {
+      const mockDate = new Date("2024-08-30T10:30:00");
+      jest.spyOn(global, "Date").mockImplementation(() => mockDate);
+
+      const result = CSVExportHelper.generateExportFilename("articles");
+
+      expect(result).toBe("300824_articles_export.csv");
+
+      global.Date.mockRestore();
+    });
+
+    test("pads single digit day and month with zeros", () => {
+      const mockDate = new Date("2024-01-05T10:30:00");
+      jest.spyOn(global, "Date").mockImplementation(() => mockDate);
+
+      const result = CSVExportHelper.generateExportFilename("pages");
+
+      expect(result).toBe("050124_pages_export.csv");
+
+      global.Date.mockRestore();
+    });
+
+    test("uses two-digit year format", () => {
+      const mockDate = new Date("2025-12-25T10:30:00");
+      jest.spyOn(global, "Date").mockImplementation(() => mockDate);
+
+      const result = CSVExportHelper.generateExportFilename("events");
+
+      expect(result).toBe("251225_events_export.csv");
+
+      global.Date.mockRestore();
+    });
+
+    test("includes content type in filename", () => {
+      const mockDate = new Date("2024-06-15T10:30:00");
+      jest.spyOn(global, "Date").mockImplementation(() => mockDate);
+
+      const result = CSVExportHelper.generateExportFilename("custom-type");
+
+      expect(result).toBe("150624_custom-type_export.csv");
+
+      global.Date.mockRestore();
+    });
+  });
+
+  describe("standardFieldMapping", () => {
+    test("is a function that returns correct field mappings", () => {
+      const mockRemoteConfig = {
+        resourceUrl: jest.fn(),
+      };
+      const locale = "en";
+      const type = "article";
+
+      const mapping = CSVExportHelper.standardFieldMapping(
+        mockRemoteConfig,
+        locale,
+        type,
+      );
+
+      expect(mapping).toEqual({
+        id: "id",
+        type: expect.any(Function),
+        locale: expect.any(Function),
+        title: "title",
+        URL: expect.any(Function),
+        visibility: "visibility",
+        created_at: "insertedAt",
+        updated_at: "updatedAt",
+      });
+    });
+
+    test("locale field mapping returns item locale if present, otherwise uses provided locale", () => {
+      const mockRemoteConfig = {
+        resourceUrl: jest.fn(),
+      };
+      const defaultLocale = "en";
+      const type = "article";
+
+      const mapping = CSVExportHelper.standardFieldMapping(
+        mockRemoteConfig,
+        defaultLocale,
+        type,
+      );
+
+      const itemWithLocale = { locale: "fr" };
+      const itemWithoutLocale = {};
+
+      expect(mapping.locale(itemWithLocale)).toBe("fr");
+      expect(mapping.locale(itemWithoutLocale)).toBe("en");
+    });
+
+    test("URL field mapping calls remoteConfig.resourceUrl with correct parameters", () => {
+      const mockRemoteConfig = {
+        resourceUrl: jest.fn(
+          (item, type, locale) => `testweb.com/${locale}/${type}/${item.id}`,
+        ),
+      };
+      const locale = "en";
+      const type = "article";
+
+      const mapping = CSVExportHelper.standardFieldMapping(
+        mockRemoteConfig,
+        locale,
+        type,
+      );
+
+      const item = { id: 123 };
+      const result = mapping.URL(item);
+
+      expect(mockRemoteConfig.resourceUrl).toHaveBeenCalledWith(
+        item,
+        type,
+        locale,
+      );
+      expect(result).toBe(`testweb.com/${locale}/${type}/${item.id}`);
+    });
+  });
+
+  describe("standardHeaders", () => {
+    test("has correct standard headers", () => {
+      expect(CSVExportHelper.standardHeaders).toEqual([
+        "id",
+        "type",
+        "locale",
+        "title",
+        "URL",
+        "visibility",
+        "created_at",
+        "updated_at",
+      ]);
+    });
+  });
+});

package/src/views/articles/_shared/_export_button.ejs

@@ -0,0 +1,9 @@
+<% if (Object.keys(_context.query).some(k => k.startsWith('f:')) && items.list.length > 0) { %>
+<%
+  const queryString = Object.entries(_context.query)
+    .filter(([key, value]) => value !== undefined && value !== null && value !== '')
+    .map(([key, value]) => Array.isArray(value) ? value.map(v => `${key}=${encodeURIComponent(v)}`).join('&') : `${key}=${encodeURIComponent(value)}`)
+    .join('&');
+%>
+<a href="<%= `/${_context.locale}/${_context.resourceConfig.articleTypePlural}/exports${queryString ? '?' + queryString : ''}` %>" class="btn-secondary">Export</a>
+<% } %>

package/src/views/articles/index.ejs

@@ -139,6 +139,42 @@
       <input type="text" name="f:keyword" value="<%= _context.query["f:keyword"] %>" />
     </div>
 
+    <div class="mb-4">
+      <label for="widget" class="font-semibold hover:cursor-pointer body-3">Widget</label>
+      <input type="text" name="f:widget" value="<%= _context.query["f:widget"] %>" />
+    </div>
+
+    <div class="mb-4">
+      <label for="widget_keyword" class="font-semibold hover:cursor-pointer body-3">Widget text keyword</label>
+      <input type="text" name="f:widget_keyword" value="<%= _context.query["f:widget_keyword"] %>" />
+    </div>
+
+    <div class="mb-4">
+        <label for="last_updated_from" class="font-semibold hover:cursor-pointer body-3">Last Updated from</label>
+        <input type="datetime-local" name="f:last_updated_from" value="<%= _context.query["f:last_updated_from"] %>" data-no-hints="true" />
+    </div>
+
+    <div class="mb-4">
+        <label for="last_updated_to" class="font-semibold hover:cursor-pointer body-3">Last Updated to</label>
+        <input type="datetime-local" name="f:last_updated_to" value="<%= _context.query["f:last_updated_to"] %>" data-no-hints="true" />
+    </div>
+
+    <div class="mb-4">
+      <label for="" class="font-semibold hover:cursor-pointer body-3">Translations</label>
+      <div class="checkbox-group mb-4">
+        <% translations.filter(item => item.code !== _context.locale).forEach((item,idx)=> { %>
+        <div class="flex items-center gap-1">
+          <% if (utils.includedInCollection(item.code, _context.query["f:translations"])) { %>
+              <input type="checkbox" name="f:translations" id='locale-<%= item.code %>' checked value="<%= item.code %>" class="hover:cursor-pointer">
+          <% } else { %>
+          <input type="checkbox" name="f:translations" id='locale-<%= item.code %>' value="<%= item.code %>" class="hover:cursor-pointer">
+          <% } %>
+          <label for='locale-<%= item.code %>' class="body-2 hover:cursor-pointer"><%= item.name %></label>
+        </div>
+        <% }); %>
+      </div>
+    </div>
+
     <div class="mb-4">
       <label for="" class="font-semibold hover:cursor-pointer body-3">Tags</label>
       <div class="checkbox-group mb-4">
@@ -157,8 +193,8 @@
 
     <div class="btn-toolbar">
       <button type="submit" class="btn-primary">Search</button>
+      <%- include('./_shared/_export_button.ejs') %>
       <a href="<%= `/${_context.locale}/${_context.resourceConfig.articleTypePlural}` %>" class="btn-text">Clear search</a>
     </div>
   </form>
 </div>
-

package/src/views/events/_shared/_export_button.ejs

@@ -0,0 +1,9 @@
+<% if (Object.keys(_context.query).some(k => k.startsWith('f:')) && items.list.length > 0) { %>
+<%
+  const queryString = Object.entries(_context.query)
+    .filter(([key, value]) => value !== undefined && value !== null && value !== '')
+    .map(([key, value]) => Array.isArray(value) ? value.map(v => `${key}=${encodeURIComponent(v)}`).join('&') : `${key}=${encodeURIComponent(value)}`)
+    .join('&');
+%>
+<a href="<%= `/${_context.locale}/${_context.resourceConfig.eventTypePlural}/exports${queryString ? '?' + queryString : ''}` %>" class="btn-secondary">Export</a>
+<% } %>