@raketa-cloud/admin 0.0.96 → 0.0.98

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raketa-cloud/admin",
-  "version": "0.0.96",
+  "version": "0.0.98",
   "main": "src/index.js",
   "scripts": {
     "dev": "npx tailwindcss -i ./src/styles/application.css -o ../../apps/admin/static/application.css --watch",

package/src/Adapter.js

@@ -5,10 +5,11 @@ import Logger from "./Logger";
 import currentPath from "./currentPath.cjs";
 import FormBuilder from "./helpers/FormBuilder";
 import HTMLBuilder from "./helpers/HTMLBuilder";
+import Inflector from "./helpers/Inflector";
 import form_for from "./helpers/form_for";
+import history from "./helpers/historyUtils";
 import pagination from "./helpers/pagination_helper";
 import sort_button from "./helpers/sort_button";
-import Inflector from "./helpers/Inflector";
 
 function escapeHtml(string) {
   var matchHtmlRegExp = /["'&<>]/;
@@ -170,6 +171,7 @@ export default class Adapter {
       t,
       f,
       form_for: form_for(viewHelpersConfig),
+      history,
       sort_button,
       pagination,
       Inflector,

package/src/cloud/ArticleChanges.js

@@ -1,15 +1,36 @@
 import RaketaClient from "./RaketaClient";
-import { ArticleChangesDocument } from "./documents/articlesDocuments";
+
+import {
+  ArticleHistoryDocument,
+  ArticleEditorsDocument,
+} from "./documents/articlesDocuments";
 
 export default class ArticleChanges extends RaketaClient {
-  async all(articleId, locale) {
-    const { articleChanges: items } = await this.query(ArticleChangesDocument, {
+  async list(query, articleId, locale) {
+    const vars = this.buildListInput(query, locale);
+
+    const { articleHistory: items } = await this.query(ArticleHistoryDocument, {
       input: {
+        ...vars.input,
         id: articleId,
         locale,
+        pagination: {
+          ...(vars.input.pagination || {}),
+        },
       },
     });
 
     return items;
   }
+
+  async all_editors(articleId, locale) {
+    const { articleEditors } = await this.query(ArticleEditorsDocument, {
+      input: {
+        id: articleId,
+        locale,
+      },
+    });
+
+    return articleEditors?.list;
+  }
 }

package/src/cloud/EventChanges.js

@@ -1,15 +1,36 @@
 import RaketaClient from "./RaketaClient";
-import { EventChangesDocument } from "./documents/eventsDocuments";
+import {
+  EventHistoryDocument,
+  EventEditorsDocument,
+} from "./documents/eventsDocuments";
 
 export default class EventChanges extends RaketaClient {
-  async all(eventId, locale) {
-    const { eventChanges: items } = await this.query(EventChangesDocument, {
+  async list(query, eventId, locale) {
+    const vars = this.buildListInput(query, locale);
+
+    const { eventHistory: items } = await this.query(EventHistoryDocument, {
       input: {
+        ...vars.input,
         id: eventId,
         locale,
+        pagination: {
+          ...(vars.input.pagination || {}),
+          page_size: 50,
+        },
       },
     });
 
     return items;
   }
+
+  async all_editors(eventId, locale) {
+    const { eventEditors } = await this.query(EventEditorsDocument, {
+      input: {
+        id: eventId,
+        locale,
+      },
+    });
+
+    return eventEditors?.list;
+  }
 }

package/src/cloud/PageChanges.js

@@ -1,15 +1,36 @@
 import RaketaClient from "./RaketaClient";
-import { PageChangesDocument } from "./documents/pagesDocuments";
+import {
+  PageHistoryDocument,
+  PageEditorsDocument,
+} from "./documents/pagesDocuments";
 
 export default class PageChanges extends RaketaClient {
-  async all(pageId, locale) {
-    const { pageChanges: items } = await this.query(PageChangesDocument, {
+  async list(query, pageId, locale) {
+    const vars = this.buildListInput(query, locale);
+
+    const { pageHistory: items } = await this.query(PageHistoryDocument, {
       input: {
+        ...vars.input,
         id: pageId,
         locale,
+        pagination: {
+          ...(vars.input.pagination || {}),
+          page_size: 50,
+        },
       },
     });
 
     return items;
   }
+
+  async all_editors(pageId, locale) {
+    const { pageEditors } = await this.query(PageEditorsDocument, {
+      input: {
+        id: pageId,
+        locale,
+      },
+    });
+
+    return pageEditors?.list;
+  }
 }

package/src/cloud/Pages.js

@@ -1,6 +1,5 @@
 import RaketaClient from "./RaketaClient";
 import {
-  buildBatchTranslatePageDocument,
   ChangePageSlugDocument,
   ClonePageDocument,
   CreatePageDocument,
@@ -9,6 +8,7 @@ import {
   PageByIdDocument,
   PagesDocument,
   TranslatePageDocument,
+  buildBatchTranslatePageDocument,
 } from "./documents/pagesDocuments";
 
 export default class Pages extends RaketaClient {

package/src/cloud/documents/articlesDocuments.js

@@ -72,10 +72,22 @@ const ArticleByIdDocument = gql`
   }
 `;
 
-const ArticleChangesDocument = gql`
-  query ArticleChanges($input: IdInput!) {
-    articleChanges(input: $input) {
+const ArticleHistoryDocument = gql`
+  query ArticleHistory($input: HistoryInput!) {
+    articleHistory(input: $input) {
       list ${summaryChangeFragment()}
+      pagination ${paginationFragment()}
+    }
+  }
+`;
+
+const ArticleEditorsDocument = gql`
+  query ArticleEditors($input: EditorsInput!) {
+    articleEditors(input: $input) {
+      list {
+        id
+        name
+      }
     }
   }
 `;
@@ -278,7 +290,7 @@ const ReopenArticleChangeDocument = gql`
       reopenArticleChange(input: $input) {
         revision ${articleRevisionFragment()}
         errors ${errorsFragment()}
-        aticleErrors ${errorsFragment()}
+        articleErrors ${errorsFragment()}
       }
     }
 `;
@@ -320,11 +332,12 @@ export {
   MergeArticleRevisionDocument,
   ScheduleArticleRevisionDocument,
   CancelArticleRevisionScheduleDocument,
-  ArticleChangesDocument,
   ChangeArticleSlugDocument,
   ReopenArticleChangeDocument,
   LockArticleRevisionDocument,
   UnlockArticleRevisionDocument,
+  ArticleHistoryDocument,
   buildBatchTranslateArticleDocument,
   buildBatchStartArticleRevisionDocument,
+  ArticleEditorsDocument,
 };

package/src/cloud/documents/common.js

@@ -126,6 +126,8 @@ export function summaryChangeFragment() {
       operatorMeta
       source
       insertedAt
+      changeType
+      revisionId
     }
   `;
 }

package/src/cloud/documents/eventsDocuments.js

@@ -78,10 +78,22 @@ const EventByIdDocument = gql`
   }
 `;
 
-const EventChangesDocument = gql`
-  query EventChanges($input: IdInput!) {
-    eventChanges(input: $input) {
+const EventHistoryDocument = gql`
+  query EventHistory($input: HistoryInput!) {
+    eventHistory(input: $input) {
       list ${summaryChangeFragment()}
+      pagination ${paginationFragment()}
+    }
+  }
+`;
+
+const EventEditorsDocument = gql`
+  query EventEditors($input: EditorsInput!) {
+    eventEditors(input: $input) {
+      list {
+        id
+        name
+      }
     }
   }
 `;
@@ -328,11 +340,12 @@ export {
   MergeEventRevisionDocument,
   ScheduleEventRevisionDocument,
   CancelEventRevisionScheduleDocument,
-  EventChangesDocument,
   ChangeEventSlugDocument,
   ReopenEventChangeDocument,
   LockEventRevisionDocument,
   UnlockEventRevisionDocument,
   buildBatchStartEventRevisionDocument,
   buildBatchTranslateEventDocument,
+  EventHistoryDocument,
+  EventEditorsDocument,
 };

package/src/cloud/documents/pagesDocuments.js

@@ -69,10 +69,22 @@ const PageByIdDocument = gql`
   }
 `;
 
-const PageChangesDocument = gql`
-  query PageChanges($input: IdInput!) {
-    pageChanges(input: $input) {
+const PageHistoryDocument = gql`
+  query PageHistory($input: HistoryInput!) {
+    pageHistory(input: $input) {
       list ${summaryChangeFragment()}
+      pagination ${paginationFragment()}
+    }
+  }
+`;
+
+const PageEditorsDocument = gql`
+  query PageEditors($input: EditorsInput!) {
+    pageEditors(input: $input) {
+      list {
+        id
+        name
+      }
     }
   }
 `;
@@ -316,11 +328,12 @@ export {
   MergePageRevisionDocument,
   SchedulePageRevisionDocument,
   CancelPageRevisionScheduleDocument,
-  PageChangesDocument,
   ChangePageSlugDocument,
   ReopenPageChangeDocument,
   LockPageRevisionDocument,
   UnlockPageRevisionDocument,
   buildBatchTranslatePageDocument,
+  PageHistoryDocument,
   buildBatchStartPageRevisionDocument,
+  PageEditorsDocument,
 };

package/src/handlers/articles/ArticlesHandler.js

@@ -26,13 +26,13 @@ const show = async (ctx) => {
   }
 
   const revisions = await ctx.client.articleRevisions.all(id, ctx.locale);
-  const changes = await ctx.client.articleChanges.all(id, ctx.locale);
+  const changes = await ctx.client.articleChanges.list({}, id, ctx.locale);
 
   return {
     assigns: {
       resource,
       revisions: revisions.list,
-      changes: changes.list,
+      changes: changes,
       _translations: Object.keys(ctx.locales)
         .map((locale) => {
           const translation = resource.translations[locale];

package/src/handlers/articles/HistoryHandler.js

@@ -0,0 +1,31 @@
+const index = async (ctx) => {
+  const { parent_id } = ctx.params;
+  const resource = await ctx.client.articles.find(parent_id, ctx.locale);
+
+  if (!resource) {
+    throw new Error(`Missing ${ctx.resourceConfig.articleType} #${parent_id}`);
+  }
+
+  const changes = await ctx.client.articleChanges.list(
+    ctx.query,
+    parent_id,
+    ctx.locale
+  );
+
+  const editors = await ctx.client.articleChanges.all_editors(
+    parent_id,
+    ctx.locale
+  );
+
+  return {
+    assigns: {
+      resource,
+      changes: changes,
+      editors,
+    },
+  };
+};
+
+export default {
+  index,
+};

package/src/handlers/events/EventsHandler.js

@@ -26,13 +26,13 @@ const show = async (ctx) => {
   }
 
   const revisions = await ctx.client.eventRevisions.all(id, ctx.locale);
-  const changes = await ctx.client.eventChanges.all(id, ctx.locale);
+  const changes = await ctx.client.eventChanges.list({}, id, ctx.locale);
 
   return {
     assigns: {
       resource,
       revisions: revisions.list,
-      changes: changes.list,
+      changes: changes,
       _translations: Object.keys(ctx.locales)
         .map((locale) => {
           const translation = resource.translations[locale];

package/src/handlers/events/HistoryHandler.js

@@ -0,0 +1,31 @@
+const index = async (ctx) => {
+  const { parent_id } = ctx.params;
+  const resource = await ctx.client.events.find(parent_id, ctx.locale);
+
+  if (!resource) {
+    throw new Error(`Missing ${ctx.resourceConfig.eventType} #${parent_id}`);
+  }
+
+  const changes = await ctx.client.eventChanges.list(
+    ctx.query,
+    parent_id,
+    ctx.locale
+  );
+
+  const editors = await ctx.client.eventChanges.all_editors(
+    parent_id,
+    ctx.locale
+  );
+
+  return {
+    assigns: {
+      resource,
+      changes: changes,
+      editors,
+    },
+  };
+};
+
+export default {
+  index,
+};

package/src/handlers/pages/HistoryHandler.js

@@ -0,0 +1,31 @@
+const index = async (ctx) => {
+  const { parent_id } = ctx.params;
+  const resource = await ctx.client.pages.find(parent_id, ctx.locale);
+
+  if (!resource) {
+    throw new Error(`Missing ${ctx.resourceConfig.pageType} #${parent_id}`);
+  }
+
+  const changes = await ctx.client.pageChanges.list(
+    ctx.query,
+    parent_id,
+    ctx.locale
+  );
+
+  const editors = await ctx.client.pageChanges.all_editors(
+    parent_id,
+    ctx.locale
+  );
+
+  return {
+    assigns: {
+      resource,
+      changes: changes,
+      editors,
+    },
+  };
+};
+
+export default {
+  index,
+};

package/src/handlers/pages/PagesHandler.js

@@ -25,13 +25,13 @@ const show = async (ctx) => {
   }
 
   const revisions = await ctx.client.pageRevisions.all(id, ctx.locale);
-  const changes = await ctx.client.pageChanges.all(id, ctx.locale);
+  const changes = await ctx.client.pageChanges.list({}, id, ctx.locale);
 
   return {
     assigns: {
       resource,
       revisions: revisions.list,
-      changes: changes.list,
+      changes: changes,
       _translations: Object.keys(ctx.locales)
         .map((locale) => {
           const translation = resource.translations[locale];

package/src/helpers/historyUtils.js

@@ -0,0 +1,133 @@
+import Inflector from "./Inflector";
+
+const CHANGE_TYEPS = {
+  revision_publish: {
+    label: "Revision published",
+    displayAction: "#RESOURCE_TYPE# updated by revision #{rev}",
+    canRevert: true,
+    canRevertAsLast: false,
+    requiresReason: true,
+  },
+  revision_create: {
+    label: "Revision created",
+    displayAction: "Revision #{rev} created",
+    canRevert: false,
+    canRevertAsLast: false,
+    requiresReason: false,
+  },
+  create: {
+    label: "#RESOURCE_TYPE# created",
+    displayAction: "#RESOURCE_TYPE# created",
+    canRevert: true,
+    canRevertAsLast: false,
+    requiresReason: false,
+  },
+  revision_lock: {
+    label: "Revision locked",
+    displayAction: "Revision #{rev} locked",
+    canRevert: false,
+    canRevertAsLast: false,
+    requiresReason: true,
+  },
+  revision_unlock: {
+    label: "Revision unlocked",
+    displayAction: "Revision #{rev} unlocked",
+    canRevert: false,
+    canRevertAsLast: false,
+    requiresReason: false,
+  },
+  revision_delete: {
+    label: "Revision deleted",
+    displayAction: "Revision #{rev} deleted",
+    canRevert: true,
+    canRevertAsLast: true,
+    requiresReason: false,
+  },
+  update: {
+    label: "Updated by script",
+    displayAction: "#RESOURCE_TYPE# updated",
+    canRevert: true,
+    canRevertAsLast: false,
+    requiresReason: true,
+  },
+};
+
+function changeTypes(resourceType = "page") {
+  return Object.entries(CHANGE_TYEPS).reduce((acc, [key, value]) => {
+    acc[key] = {
+      ...value,
+      label: value.label.replace(
+        "#RESOURCE_TYPE#",
+        Inflector.capitalize(resourceType)
+      ),
+      displayAction: value.displayAction.replace(
+        "#RESOURCE_TYPE#",
+        Inflector.capitalize(resourceType)
+      ),
+    };
+    return acc;
+  }, {});
+}
+
+function changeAction(change, resourceType) {
+  const changeType = CHANGE_TYEPS[change.changeType];
+
+  const displayAction = changeType?.displayAction;
+
+  if (!displayAction) {
+    return change.changeType;
+  }
+
+  const formattedAction = displayAction
+    .replace("#RESOURCE_TYPE#", Inflector.capitalize(resourceType))
+    .replace(
+      "#{rev}",
+      (function () {
+        if (change.revisionId) {
+          return `#${change.revisionId}`;
+        } else {
+          return "";
+        }
+      })()
+    );
+
+  return change.source === "revert"
+    ? `${formattedAction} by revert`
+    : formattedAction;
+}
+
+// Since we are not deleting anything from the history and the version numbers are
+// a sequence with increments of 1 this means that the max version is the number of history entries
+function getMaxVersion(changes) {
+  const { pagination } = changes;
+
+  return pagination.entriesCount;
+}
+
+function changeReason(change) {
+  const changeType = CHANGE_TYEPS[change.changeType];
+
+  if (changeType.requiresReason) {
+    return change.title;
+  }
+
+  return "";
+}
+
+function isChangeRevertable(change, maxVersion) {
+  const changeType = CHANGE_TYEPS[change.changeType];
+
+  return (
+    changeType.canRevert &&
+    ((changeType.canRevertAsLast && maxVersion === change.version) ||
+      maxVersion !== change.version)
+  );
+}
+
+export default {
+  changeTypes,
+  getMaxVersion,
+  changeAction,
+  isChangeRevertable,
+  changeReason,
+};

package/src/routeArticlesModule.js

@@ -1,23 +1,24 @@
-import routeCollection from "./routeCollection";
-import routeNestedCollection from "./routeNestedCollection";
-import routeNestedMember from "./routeNestedMember";
-import TranslationsHandler from "./handlers/articles/TranslationsHandler";
 import ArticleRevisionsHandler from "./handlers/article_revisions/ArticleRevisionsHandler";
-import GeneralHandler from "./handlers/article_revisions/GeneralHandler";
-import VisualHandler from "./handlers/article_revisions/VisualHandler";
+import CancelSchedulesHandler from "./handlers/article_revisions/CancelSchedulesHandler";
 import CodeHandler from "./handlers/article_revisions/CodeHandler";
+import GeneralHandler from "./handlers/article_revisions/GeneralHandler";
+import LocksHandler from "./handlers/article_revisions/LocksHandler";
 import MetaHandler from "./handlers/article_revisions/MetaHandler";
+import PublishesHandler from "./handlers/article_revisions/PublishesHandler";
+import RevertsHandler from "./handlers/article_revisions/RevertsHandler";
 import TagHandler from "./handlers/article_revisions/TagHandler";
-import LocksHandler from "./handlers/article_revisions/LocksHandler";
 import UnlocksHandler from "./handlers/article_revisions/UnlocksHandler";
-import ClonesHandler from "./handlers/articles/ClonesHandler";
-import URLsHandler from "./handlers/articles/URLsHandler";
-import DeletesHandler from "./handlers/articles/DeletesHandler";
-import RevertsHandler from "./handlers/article_revisions/RevertsHandler";
-import PublishesHandler from "./handlers/article_revisions/PublishesHandler";
+import VisualHandler from "./handlers/article_revisions/VisualHandler";
 import WidgetHandler from "./handlers/article_revisions/WidgetHandler";
 import ArticlesHandler from "./handlers/articles/ArticlesHandler";
-import CancelSchedulesHandler from "./handlers/article_revisions/CancelSchedulesHandler";
+import ClonesHandler from "./handlers/articles/ClonesHandler";
+import DeletesHandler from "./handlers/articles/DeletesHandler";
+import HistoryHandler from "./handlers/articles/HistoryHandler";
+import TranslationsHandler from "./handlers/articles/TranslationsHandler";
+import URLsHandler from "./handlers/articles/URLsHandler";
+import routeCollection from "./routeCollection";
+import routeNestedCollection from "./routeNestedCollection";
+import routeNestedMember from "./routeNestedMember";
 
 function routeArticlesModule(
   adapter,
@@ -45,6 +46,11 @@ function routeArticlesModule(
     { ...resourceConfig, viewsFallback: "articles/translations" }
   );
 
+  routeNestedCollection(adapter, baseResource, "history", HistoryHandler, {
+    ...resourceConfig,
+    viewsFallback: "articles/history",
+  });
+
   routeNestedCollection(
     adapter,
     baseResource,

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,