@raketa-cloud/admin 0.0.97 → 0.0.99

package/src/routeEventsModule.js

@@ -1,23 +1,24 @@
-import routeCollection from "./routeCollection";
-import routeNestedCollection from "./routeNestedCollection";
-import routeNestedMember from "./routeNestedMember";
-import TranslationsHandler from "./handlers/events/TranslationsHandler";
+import CancelSchedulesHandler from "./handlers/event_revisions/CancelSchedulesHandler";
+import CodeHandler from "./handlers/event_revisions/CodeHandler";
 import EventRevisionsHandler from "./handlers/event_revisions/EventRevisionsHandler";
 import GeneralHandler from "./handlers/event_revisions/GeneralHandler";
-import VisualHandler from "./handlers/event_revisions/VisualHandler";
-import CodeHandler from "./handlers/event_revisions/CodeHandler";
+import LocksHandler from "./handlers/event_revisions/LocksHandler";
 import MetaHandler from "./handlers/event_revisions/MetaHandler";
+import PublishesHandler from "./handlers/event_revisions/PublishesHandler";
+import RevertsHandler from "./handlers/event_revisions/RevertsHandler";
 import TagHandler from "./handlers/event_revisions/TagHandler";
-import LocksHandler from "./handlers/event_revisions/LocksHandler";
 import UnlocksHandler from "./handlers/event_revisions/UnlocksHandler";
+import VisualHandler from "./handlers/event_revisions/VisualHandler";
+import WidgetHandler from "./handlers/event_revisions/WidgetHandler";
 import ClonesHandler from "./handlers/events/ClonesHandler";
-import URLsHandler from "./handlers/events/URLsHandler";
 import DeletesHandler from "./handlers/events/DeletesHandler";
-import RevertsHandler from "./handlers/event_revisions/RevertsHandler";
-import PublishesHandler from "./handlers/event_revisions/PublishesHandler";
-import WidgetHandler from "./handlers/event_revisions/WidgetHandler";
 import EventsHandler from "./handlers/events/EventsHandler";
-import CancelSchedulesHandler from "./handlers/event_revisions/CancelSchedulesHandler";
+import HistoryHandler from "./handlers/events/HistoryHandler";
+import TranslationsHandler from "./handlers/events/TranslationsHandler";
+import URLsHandler from "./handlers/events/URLsHandler";
+import routeCollection from "./routeCollection";
+import routeNestedCollection from "./routeNestedCollection";
+import routeNestedMember from "./routeNestedMember";
 
 function routeEventsModule(
   adapter,
@@ -48,6 +49,11 @@ function routeEventsModule(
     }
   );
 
+  routeNestedCollection(adapter, baseResource, "history", HistoryHandler, {
+    ...resourceConfig,
+    viewsFallback: "events/history",
+  });
+
   routeNestedCollection(
     adapter,
     baseResource,

package/src/routePagesModule.js

@@ -1,3 +1,4 @@
+import CancelSchedulesHandler from "./handlers/page_revisions/CancelSchedulesHandler";
 import CodeHandler from "./handlers/page_revisions/CodeHandler";
 import GeneralHandler from "./handlers/page_revisions/GeneralHandler";
 import LocksHandler from "./handlers/page_revisions/LocksHandler";
@@ -11,13 +12,13 @@ import VisualHandler from "./handlers/page_revisions/VisualHandler";
 import WidgetHandler from "./handlers/page_revisions/WidgetHandler";
 import ClonesHandler from "./handlers/pages/ClonesHandler";
 import DeletesHandler from "./handlers/pages/DeletesHandler";
+import HistoryHandler from "./handlers/pages/HistoryHandler";
 import PagesHandler from "./handlers/pages/PagesHandler";
 import TranslationsHandler from "./handlers/pages/TranslationsHandler";
 import URLsHandler from "./handlers/pages/URLsHandler";
 import routeCollection from "./routeCollection";
 import routeNestedCollection from "./routeNestedCollection";
 import routeNestedMember from "./routeNestedMember";
-import CancelSchedulesHandler from "./handlers/page_revisions/CancelSchedulesHandler";
 
 function routePagesModule(
   adapter,
@@ -45,6 +46,11 @@ function routePagesModule(
     { ...resourceConfig, viewsFallback: "pages/translations" }
   );
 
+  routeNestedCollection(adapter, baseResource, "history", HistoryHandler, {
+    ...resourceConfig,
+    viewsFallback: "pages/history",
+  });
+
   routeNestedCollection(
     adapter,
     baseResource,

package/src/tests/handlers/articles/ArticlesHandler.test/show.test.js

@@ -1,7 +1,7 @@
-import ArticlesHandler from "../../../../handlers/articles/ArticlesHandler";
-import Articles from "../../../../cloud/Articles";
 import ArticleChanges from "../../../../cloud/ArticleChanges";
 import ArticleRevisions from "../../../../cloud/ArticleRevisions";
+import Articles from "../../../../cloud/Articles";
+import ArticlesHandler from "../../../../handlers/articles/ArticlesHandler";
 
 import Factory from "../../../support/factory";
 
@@ -65,20 +65,20 @@ describe("Articles Handler", () => {
       .mockImplementation(() => ({ list: [revision] }));
 
     const mockedArticleChanges = jest
-      .spyOn(ctx.client.articleChanges, "all")
+      .spyOn(ctx.client.articleChanges, "list")
       .mockImplementation(() => ({ list: [change] }));
 
     const result = await ArticlesHandler.show(ctx);
 
     expect(mockedArticleFind).toHaveBeenCalledWith(article.id, "en");
     expect(mockedArticleRevisions).toHaveBeenCalledWith(article.id, "en");
-    expect(mockedArticleChanges).toHaveBeenCalledWith(article.id, "en");
+    expect(mockedArticleChanges).toHaveBeenCalledWith({}, article.id, "en");
 
     expect(result).toEqual({
       assigns: {
         resource: article,
         revisions: [revision],
-        changes: [change],
+        changes: { list: [change] },
         _translations: [
           {
             locale: "bg",

package/src/tests/handlers/articles/ArticlesHistoryHandler.test/index.test.js

@@ -0,0 +1,87 @@
+import ArticleChanges from "../../../../cloud/ArticleChanges";
+import Articles from "../../../../cloud/Articles";
+import ArticlesHandler from "../../../../handlers/articles/ArticlesHandler";
+import HistoryHandler from "../../../../handlers/articles/HistoryHandler";
+import Factory from "../../../support/factory";
+
+describe("Articles History Handler", () => {
+  function buildHistoryCtx() {
+    return {
+      client: {
+        articles: new Articles(() => ({}), "token"),
+        articleChanges: new ArticleChanges(() => ({}), "token"),
+      },
+      query: { foo: "bar" },
+      locale: "en",
+      params: {
+        parent_id: "123",
+      },
+      resourceConfig: {
+        articleType: "article",
+      },
+    };
+  }
+
+  test("successfully returns history data", async () => {
+    const ctx = buildHistoryCtx();
+    const article = Factory.build("article");
+    const changes = {
+      list: [
+        { operatorMeta: { name: "John Travolta" } },
+        { operatorMeta: { name: "Generic Jane Smith" } },
+      ],
+      pagination: Factory.build("pagination"),
+    };
+
+    jest.spyOn(ctx.client.articles, "find").mockImplementation(() => article);
+    jest
+      .spyOn(ctx.client.articleChanges, "list")
+      .mockImplementation(() => changes);
+    jest
+      .spyOn(ctx.client.articleChanges, "all_editors")
+      .mockImplementation(() => ["John Travolta", "Generic Jane Smith"]);
+
+    const result = await HistoryHandler.index(ctx);
+
+    expect(result).toEqual({
+      assigns: {
+        resource: article,
+        changes: changes,
+        editors: ["John Travolta", "Generic Jane Smith"],
+      },
+    });
+  });
+
+  test("throws error when article is not found", async () => {
+    const ctx = buildHistoryCtx();
+    jest.spyOn(ctx.client.articles, "find").mockImplementation(() => null);
+
+    await expect(HistoryHandler.index(ctx)).rejects.toThrow(
+      "Missing article #123"
+    );
+  });
+
+  test("returns unique editors list", async () => {
+    const ctx = buildHistoryCtx();
+    const article = Factory.build("article");
+    const changes = {
+      list: [
+        { operatorMeta: { name: "John Travolta" } },
+        { operatorMeta: { name: "John Travolta" } },
+      ],
+      pagination: Factory.build("pagination"),
+    };
+
+    jest.spyOn(ctx.client.articles, "find").mockImplementation(() => article);
+    jest
+      .spyOn(ctx.client.articleChanges, "list")
+      .mockImplementation(() => changes);
+    jest
+      .spyOn(ctx.client.articleChanges, "all_editors")
+      .mockImplementation(() => ["John Travolta"]);
+
+    const result = await HistoryHandler.index(ctx);
+
+    expect(result.assigns.editors).toEqual(["John Travolta"]);
+  });
+});

package/src/tests/handlers/events/EventsHandler.test/show.test.js

@@ -1,7 +1,7 @@
-import EventsHandler from "../../../../handlers/events/EventsHandler";
-import Events from "../../../../cloud/Events";
 import EventChanges from "../../../../cloud/EventChanges";
 import EventRevisions from "../../../../cloud/EventRevisions";
+import Events from "../../../../cloud/Events";
+import EventsHandler from "../../../../handlers/events/EventsHandler";
 
 import Factory from "../../../support/factory";
 
@@ -65,20 +65,20 @@ describe("Events Handler", () => {
       .mockImplementation(() => ({ list: [revision] }));
 
     const mockedEventChanges = jest
-      .spyOn(ctx.client.eventChanges, "all")
+      .spyOn(ctx.client.eventChanges, "list")
       .mockImplementation(() => ({ list: [change] }));
 
     const result = await EventsHandler.show(ctx);
 
     expect(mockedeventFind).toHaveBeenCalledWith(event.id, "en");
     expect(mockedEventRevisions).toHaveBeenCalledWith(event.id, "en");
-    expect(mockedEventChanges).toHaveBeenCalledWith(event.id, "en");
+    expect(mockedEventChanges).toHaveBeenCalledWith({}, event.id, "en");
 
     expect(result).toEqual({
       assigns: {
         resource: event,
         revisions: [revision],
-        changes: [change],
+        changes: { list: [change] },
         _translations: [
           {
             locale: "bg",

package/src/tests/handlers/events/EventsHistoryHandler.test/index.test.js

@@ -0,0 +1,87 @@
+import EventChanges from "../../../../cloud/EventChanges";
+import Events from "../../../../cloud/Events";
+import EventsHandler from "../../../../handlers/events/EventsHandler";
+import HistoryHandler from "../../../../handlers/events/HistoryHandler";
+import Factory from "../../../support/factory";
+
+describe("Events History Handler", () => {
+  function buildHistoryCtx() {
+    return {
+      client: {
+        events: new Events(() => ({}), "token"),
+        eventChanges: new EventChanges(() => ({}), "token"),
+      },
+      query: { foo: "bar" },
+      locale: "en",
+      params: {
+        parent_id: "123",
+      },
+      resourceConfig: {
+        eventType: "event",
+      },
+    };
+  }
+
+  test("successfully returns history data", async () => {
+    const ctx = buildHistoryCtx();
+    const event = Factory.build("event");
+    const changes = {
+      list: [
+        { operatorMeta: { name: "Generic John Doe" } },
+        { operatorMeta: { name: "Generic Jane Smith" } },
+      ],
+      pagination: Factory.build("pagination"),
+    };
+
+    jest.spyOn(ctx.client.events, "find").mockImplementation(() => event);
+    jest
+      .spyOn(ctx.client.eventChanges, "list")
+      .mockImplementation(() => changes);
+    jest
+      .spyOn(ctx.client.eventChanges, "all_editors")
+      .mockImplementation(() => ["Generic John Doe", "Generic Jane Smith"]);
+
+    const result = await HistoryHandler.index(ctx);
+
+    expect(result).toEqual({
+      assigns: {
+        resource: event,
+        changes: changes,
+        editors: ["Generic John Doe", "Generic Jane Smith"],
+      },
+    });
+  });
+
+  test("throws error when event is not found", async () => {
+    const ctx = buildHistoryCtx();
+    jest.spyOn(ctx.client.events, "find").mockImplementation(() => null);
+
+    await expect(HistoryHandler.index(ctx)).rejects.toThrow(
+      "Missing event #123"
+    );
+  });
+
+  test("returns unique editors list", async () => {
+    const ctx = buildHistoryCtx();
+    const event = Factory.build("event");
+    const changes = {
+      list: [
+        { operatorMeta: { name: "Generic John Doe" } },
+        { operatorMeta: { name: "Generic John Doe" } },
+      ],
+      pagination: Factory.build("pagination"),
+    };
+
+    jest.spyOn(ctx.client.events, "find").mockImplementation(() => event);
+    jest
+      .spyOn(ctx.client.eventChanges, "list")
+      .mockImplementation(() => changes);
+    jest
+      .spyOn(ctx.client.eventChanges, "all_editors")
+      .mockImplementation(() => ["Generic John Doe"]);
+
+    const result = await HistoryHandler.index(ctx);
+
+    expect(result.assigns.editors).toEqual(["Generic John Doe"]);
+  });
+});

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

@@ -1,7 +1,7 @@
-import PagesHandler from "../../../../handlers/pages/PagesHandler";
-import Pages from "../../../../cloud/Pages";
 import PageChanges from "../../../../cloud/PageChanges";
 import PageRevisions from "../../../../cloud/PageRevisions";
+import Pages from "../../../../cloud/Pages";
+import PagesHandler from "../../../../handlers/pages/PagesHandler";
 
 import Factory from "../../../support/factory";
 
@@ -63,20 +63,20 @@ describe("Pages Handler", () => {
       .mockImplementation(() => ({ list: [revision] }));
 
     const mockedPageChanges = jest
-      .spyOn(ctx.client.pageChanges, "all")
+      .spyOn(ctx.client.pageChanges, "list")
       .mockImplementation(() => ({ list: [change] }));
 
     const result = await PagesHandler.show(ctx);
 
     expect(mockedPageFind).toHaveBeenCalledWith(page.id, "en");
     expect(mockedPageRevisions).toHaveBeenCalledWith(page.id, "en");
-    expect(mockedPageChanges).toHaveBeenCalledWith(page.id, "en");
+    expect(mockedPageChanges).toHaveBeenCalledWith({}, page.id, "en");
 
     expect(result).toEqual({
       assigns: {
         resource: page,
         revisions: [revision],
-        changes: [change],
+        changes: { list: [change] },
         _translations: [
           {
             locale: "bg",

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

@@ -0,0 +1,87 @@
+import PageChanges from "../../../../cloud/PageChanges";
+import Pages from "../../../../cloud/Pages";
+import HistoryHandler from "../../../../handlers/pages/HistoryHandler";
+import PagesHandler from "../../../../handlers/pages/PagesHandler";
+import Factory from "../../../support/factory";
+
+describe("history", () => {
+  function buildHistoryCtx() {
+    return {
+      client: {
+        pages: new Pages(() => ({}), "token"),
+        pageChanges: new PageChanges(() => ({}), "token"),
+      },
+      query: { foo: "bar" },
+      locale: "en",
+      params: {
+        parent_id: "123",
+      },
+      resourceConfig: {
+        pageType: "page",
+      },
+    };
+  }
+
+  test("successfully returns history data", async () => {
+    const ctx = buildHistoryCtx();
+    const page = Factory.build("page");
+    const changes = {
+      list: [
+        { operatorMeta: { name: "Generic John Doe" } },
+        { operatorMeta: { name: "Generic Jane Smith" } },
+      ],
+      pagination: Factory.build("pagination"),
+    };
+
+    jest.spyOn(ctx.client.pages, "find").mockImplementation(() => page);
+    jest
+      .spyOn(ctx.client.pageChanges, "list")
+      .mockImplementation(() => changes);
+    jest
+      .spyOn(ctx.client.pageChanges, "all_editors")
+      .mockImplementation(() => ["Generic John Doe", "Generic Jane Smith"]);
+
+    const result = await HistoryHandler.index(ctx);
+
+    expect(result).toEqual({
+      assigns: {
+        resource: page,
+        changes: changes,
+        editors: ["Generic John Doe", "Generic Jane Smith"],
+      },
+    });
+  });
+
+  test("throws error when page is not found", async () => {
+    const ctx = buildHistoryCtx();
+    jest.spyOn(ctx.client.pages, "find").mockImplementation(() => null);
+
+    await expect(HistoryHandler.index(ctx)).rejects.toThrow(
+      "Missing page #123"
+    );
+  });
+
+  test("returns unique editors list", async () => {
+    const ctx = buildHistoryCtx();
+    const page = Factory.build("page");
+    const changes = {
+      list: [
+        { operatorMeta: { name: "Generic John Doe" } },
+        { operatorMeta: { name: "Generic John Doe" } },
+      ],
+      pagination: Factory.build("pagination"),
+    };
+
+    jest.spyOn(ctx.client.pages, "find").mockImplementation(() => page);
+    jest
+      .spyOn(ctx.client.pageChanges, "list")
+      .mockImplementation(() => changes);
+    jest
+      .spyOn(ctx.client.pageChanges, "all_editors")
+      .mockImplementation(() => ["Generic John Doe"]);
+
+    const result = await HistoryHandler.index(ctx);
+
+    expect(result.assigns.editors).toEqual(["Generic John Doe"]);
+  });
+});

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

@@ -0,0 +1,107 @@
+import history from "../../helpers/historyUtils";
+
+describe("changeTypes", () => {
+  it("replaces #RESOURCE_TYPE# with provided resource type", () => {
+    const result = history.changeTypes("article");
+
+    expect(result.create.label).toEqual("Article created");
+    expect(result.create.displayAction).toEqual("Article created");
+  });
+
+  it("uses default Page type if none provided", () => {
+    const result = history.changeTypes();
+
+    expect(result.create.label).toEqual("Page created");
+  });
+});
+
+describe("changeAction", () => {
+  it("formats action with revision ID", () => {
+    const change = { changeType: "revision_publish", revisionId: "123" };
+    const result = history.changeAction(change, "page");
+
+    expect(result).toEqual("Page updated by revision #123");
+  });
+
+  it("handles revert source", () => {
+    const change = {
+      changeType: "revision_publish",
+      revisionId: "123",
+      source: "revert",
+    };
+    const result = history.changeAction(change, "page");
+
+    expect(result).toEqual("Page updated by revision #123 by revert");
+  });
+
+  it("handles unknown change type", () => {
+    const change = { changeType: "unknown_type" };
+    const result = history.changeAction(change, "page");
+
+    expect(result).toBe("unknown_type");
+  });
+});
+
+describe("changeReason", () => {
+  function testChangeReasonFor(changeType, title, expectedResult) {
+    const change = { changeType, title };
+    const result = history.changeReason(change);
+
+    expect(result).toEqual(expectedResult);
+  }
+
+  it("Returns the hange reason for each change type correctly", () => {
+    testChangeReasonFor("revision_publish", "Title", "Title");
+    testChangeReasonFor("revision_create", "Title", "");
+    testChangeReasonFor("create", "Title", "");
+    testChangeReasonFor("revision_lock", "Title", "Title");
+    testChangeReasonFor("revision_unlock", "Title", "");
+    testChangeReasonFor("revision_delete", "Title", "");
+    testChangeReasonFor("update", "Title", "Title");
+  });
+});
+
+describe("getMaxVersion", () => {
+  it("uses the pagination information for maxVersion calculation", () => {
+    const changes = {
+      list: [{ version: 1 }, { version: 5 }, { version: 3 }],
+      pagination: { entriesCount: 3 },
+    };
+
+    expect(history.getMaxVersion(changes)).toEqual(3);
+  });
+});
+
+describe("isChangeRevertable", () => {
+  function testReversableNotForMaxVersion(changeType, expectedResult) {
+    const change = { changeType, version: 1 };
+
+    expect(history.isChangeRevertable(change, 2)).toEqual(expectedResult);
+  }
+
+  it("returns true for revertable change types when not the for the max version", () => {
+    testReversableNotForMaxVersion("revision_publish", true);
+    testReversableNotForMaxVersion("revision_create", false);
+    testReversableNotForMaxVersion("create", true);
+    testReversableNotForMaxVersion("revision_lock", false);
+    testReversableNotForMaxVersion("revision_unlock", false);
+    testReversableNotForMaxVersion("revision_delete", true);
+    testReversableNotForMaxVersion("update", true);
+  });
+
+  function testReversableForMaxVersion(changeType, expectedResult) {
+    const change = { changeType, version: 1 };
+
+    expect(history.isChangeRevertable(change, 1)).toEqual(expectedResult);
+  }
+
+  it("returns true for revertable change types when for the max version", () => {
+    testReversableForMaxVersion("revision_publish", false);
+    testReversableForMaxVersion("revision_create", false);
+    testReversableForMaxVersion("create", false);
+    testReversableForMaxVersion("revision_lock", false);
+    testReversableForMaxVersion("revision_unlock", false);
+    testReversableForMaxVersion("revision_delete", true);
+    testReversableForMaxVersion("update", false);
+  });
+});

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

@@ -0,0 +1,27 @@
+import utils from "../../helpers/utils";
+
+describe("includedInCollection", () => {
+  it("returns true when the given collection is a string equal to the given value", () => {
+    expect(utils.includedInCollection("key", "key")).toEqual(true);
+  });
+
+  it("returns false when the given collection is a string not equal to the given value", () => {
+    expect(utils.includedInCollection("key", "key-2")).toEqual(false);
+  });
+
+  it("returns true when the given collection is an array including the given value", () => {
+    expect(utils.includedInCollection("key", ["key"])).toEqual(true);
+  });
+
+  it("returns false when the given collection is an array not including the given value", () => {
+    expect(utils.includedInCollection("key", ["key-2"])).toEqual(false);
+  });
+
+  it("returns false when the given collection null", () => {
+    expect(utils.includedInCollection("key", null)).toEqual(false);
+  });
+
+  it("returns false when the given collection undefined", () => {
+    expect(utils.includedInCollection("key", undefined)).toEqual(false);
+  });
+});

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

@@ -1,16 +1,17 @@
 <div class="actions-toolbar justify-end">
-  <% if (maxVersion !== change.version) { %>
-  <form method="POST" action="<%= `/${_context.locale}/${_context.resourceConfig.articleTypePlural}/${resource.id}/article_changes/reverts` %>" class="inline-block">
-    <input type="hidden" name="version" value=<%= change.version %>>
-    <button type="submit" class="btn-text has-icon">
-      <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="size-4">
-        <path stroke-linecap="round" stroke-linejoin="round" d="M9 15 3 9m0 0 6-6M3 9h12a6 6 0 0 1 0 12h-3" />
-      </svg>
+  <form method="POST" action="<%= `/${_context.locale}/${_context.resourceConfig.pageTypePlural}/${resource.id}/${_context.resourceConfig.pageType}_changes/reverts` %>" class="inline-block">
+    <input type="hidden" name="version" value="<%= change.version %>">
 
+    <% if (history.isChangeRevertable(change, maxVersion)) { %>
+    <button type="submit" class="btn-text">
       Revert
     </button>
+    <% } else { %>
+    <button type="submit" disabled class="btn-text opacity-50 cursor-not-allowed">
+      Revert
+    </button>
+    <% } %>
   </form>
-  <% } %>
 
   <a href="/remote/login?redirect_to=/<%= _context.locale %>/admin/<%= _context.resourceConfig.articleTypePlural %>/<%= resource.id %>/changes/<%= change.version %>" class="btn-text has-icon">
     <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="size-4">