@raketa-cloud/admin 0.0.102 → 1.0.0

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/helpers/pagination_helper.js

@@ -0,0 +1,5 @@
+import Pagination from "./Pagination";
+
+export default function pagination(pagination, router) {
+  return new Pagination(pagination, router).build();
+}

package/src/helpers/sort_button.js

@@ -0,0 +1,5 @@
+import SortButton from "./SortButton";
+
+export default function sort_button(label, name, router) {
+  return new SortButton(label, name, router).build();
+}

package/src/helpers/utils.js

@@ -0,0 +1,21 @@
+function includedInCollection(value, collection) {
+  if (!collection) {
+    return false;
+  }
+
+  if (typeof collection === "string") {
+    return value === collection;
+  }
+
+  if (Array.isArray(collection)) {
+    return collection.includes(value);
+  }
+
+  throw new Error(
+    "Invalid input for collection. Expected a string or an array."
+  );
+}
+
+export default {
+  includedInCollection,
+};

package/src/routeArticlesModule.js

@@ -0,0 +1,151 @@
+import ArticleRevisionsHandler from "./handlers/article_revisions/ArticleRevisionsHandler";
+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 UnlocksHandler from "./handlers/article_revisions/UnlocksHandler";
+import VisualHandler from "./handlers/article_revisions/VisualHandler";
+import WidgetHandler from "./handlers/article_revisions/WidgetHandler";
+import ArticlesHandler from "./handlers/articles/ArticlesHandler";
+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,
+  articleType = "article",
+  articleTypePlural = "articles"
+) {
+  const baseResource = articleTypePlural;
+  const revisionsBaseResource = `${articleType}_revisions`;
+
+  const resourceConfig = {
+    articleType,
+    articleTypePlural,
+  };
+
+  routeCollection(adapter, baseResource, ArticlesHandler, {
+    ...resourceConfig,
+    viewsFallback: "articles",
+  });
+
+  routeNestedCollection(
+    adapter,
+    baseResource,
+    "translations",
+    TranslationsHandler,
+    { ...resourceConfig, viewsFallback: "articles/translations" }
+  );
+
+  routeNestedCollection(adapter, baseResource, "history", HistoryHandler, {
+    ...resourceConfig,
+    viewsFallback: "articles/history",
+  });
+
+  routeNestedCollection(
+    adapter,
+    baseResource,
+    revisionsBaseResource,
+    ArticleRevisionsHandler,
+    { ...resourceConfig, viewsFallback: "articles/article_revisions" }
+  );
+
+  routeNestedMember(adapter, revisionsBaseResource, "general", GeneralHandler, {
+    ...resourceConfig,
+    viewsFallback: "article_revisions/general",
+  });
+
+  routeNestedMember(adapter, revisionsBaseResource, "visuals", VisualHandler, {
+    ...resourceConfig,
+    viewsFallback: "article_revisions/visuals",
+  });
+
+  routeNestedMember(adapter, revisionsBaseResource, "codes", CodeHandler, {
+    ...resourceConfig,
+    viewsFallback: "article_revisions/codes",
+  });
+
+  routeNestedMember(adapter, revisionsBaseResource, "meta", MetaHandler, {
+    ...resourceConfig,
+    viewsFallback: "article_revisions/meta",
+  });
+
+  routeNestedMember(adapter, revisionsBaseResource, "tags", TagHandler, {
+    ...resourceConfig,
+    viewsFallback: "article_revisions/tags",
+  });
+
+  routeNestedCollection(adapter, revisionsBaseResource, "locks", LocksHandler, {
+    ...resourceConfig,
+    viewsFallback: "article_revisions/locks",
+  });
+
+  routeNestedCollection(
+    adapter,
+    revisionsBaseResource,
+    "unlocks",
+    UnlocksHandler,
+    { ...resourceConfig, viewsFallback: "article_revisions/unlocks" }
+  );
+
+  routeNestedCollection(adapter, baseResource, "clones", ClonesHandler, {
+    ...resourceConfig,
+    viewsFallback: "articles/clones",
+  });
+
+  routeNestedCollection(adapter, baseResource, "urls", URLsHandler, {
+    ...resourceConfig,
+    viewsFallback: "articles/urls",
+  });
+
+  routeNestedCollection(adapter, baseResource, "deletes", DeletesHandler, {
+    ...resourceConfig,
+    viewsFallback: "articles/deletes",
+  });
+
+  routeNestedCollection(
+    adapter,
+    baseResource,
+    `${articleType}_changes/reverts`,
+    RevertsHandler,
+    { ...resourceConfig, viewsFallback: "article_changes/reverts" }
+  );
+
+  routeNestedCollection(
+    adapter,
+    revisionsBaseResource,
+    "publishes",
+    PublishesHandler,
+    { ...resourceConfig, viewsFallback: "article_revisions/publishes" }
+  );
+
+  routeNestedCollection(
+    adapter,
+    revisionsBaseResource,
+    "cancel_schedules",
+    CancelSchedulesHandler,
+    {
+      ...resourceConfig,
+      viewsFallback: "article_revisions/cancel_schedules",
+    }
+  );
+
+  routeNestedMember(
+    adapter,
+    `api/${revisionsBaseResource}`,
+    "widgets",
+    WidgetHandler,
+    resourceConfig
+  );
+}
+
+export default routeArticlesModule;

package/src/routeCategoriesModule.js

@@ -0,0 +1,16 @@
+import routeCollection from "./routeCollection";
+import CategoriesHandler from "./handlers/categories";
+
+function routeCategoriesModule(adapter, categoryType, categoryTypePlural) {
+  const resourceConfig = {
+    categoryType,
+    categoryTypePlural,
+  };
+
+  routeCollection(adapter, categoryTypePlural, CategoriesHandler, {
+    ...resourceConfig,
+    viewsFallback: "categories",
+  });
+}
+
+export default routeCategoriesModule;

package/src/routeCollection.js

@@ -0,0 +1,90 @@
+const routeCollection = (adapter, resource, handler, resourceConfig = {}) => {
+  const {
+    before_filter,
+    after_filter,
+    index,
+    show,
+    create_form,
+    edit_form,
+    create,
+    update,
+    destroy,
+  } = handler;
+
+  const mapping = [
+    [
+      "GET",
+      `/${resource}`,
+      resource,
+      resource,
+      "index",
+      index,
+      before_filter,
+      after_filter,
+    ],
+    [
+      "GET",
+      `/${resource}/new`,
+      resource,
+      resource,
+      "create_form",
+      create_form,
+      before_filter,
+      after_filter,
+    ],
+    [
+      "GET",
+      `/${resource}/:id`,
+      resource,
+      resource,
+      "show",
+      show,
+      before_filter,
+      after_filter,
+    ],
+    [
+      "GET",
+      `/${resource}/:id/edit`,
+      resource,
+      resource,
+      "edit_form",
+      edit_form,
+      before_filter,
+      after_filter,
+    ],
+    [
+      "POST",
+      `/${resource}`,
+      resource,
+      resource,
+      "create_form",
+      create,
+      before_filter,
+      after_filter,
+    ],
+    [
+      "POST",
+      `/${resource}/:id`,
+      resource,
+      resource,
+      "edit_form",
+      update,
+      before_filter,
+      after_filter,
+    ],
+    [
+      "DELETE",
+      `/${resource}/:id`,
+      resource,
+      resource,
+      "destroy",
+      destroy,
+      before_filter,
+      after_filter,
+    ],
+  ];
+
+  adapter.routeCollection(mapping, resourceConfig);
+};
+
+export default routeCollection;

package/src/routeEventsModule.js

@@ -0,0 +1,166 @@
+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 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 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 DeletesHandler from "./handlers/events/DeletesHandler";
+import EventsHandler from "./handlers/events/EventsHandler";
+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,
+  eventType = "event",
+  eventTypePlural = "events"
+) {
+  const baseResource = eventTypePlural;
+  const revisionsBaseResource = `${eventType}_revisions`;
+
+  const resourceConfig = {
+    eventType,
+    eventTypePlural,
+  };
+
+  routeCollection(adapter, baseResource, EventsHandler, {
+    ...resourceConfig,
+    viewsFallback: "events",
+  });
+
+  routeNestedCollection(
+    adapter,
+    baseResource,
+    "translations",
+    TranslationsHandler,
+    {
+      ...resourceConfig,
+      viewsFallback: "events/translations",
+    }
+  );
+
+  routeNestedCollection(adapter, baseResource, "history", HistoryHandler, {
+    ...resourceConfig,
+    viewsFallback: "events/history",
+  });
+
+  routeNestedCollection(
+    adapter,
+    baseResource,
+    revisionsBaseResource,
+    EventRevisionsHandler,
+    {
+      ...resourceConfig,
+      viewsFallback: "events/event_revisions",
+    }
+  );
+
+  routeNestedMember(adapter, revisionsBaseResource, "general", GeneralHandler, {
+    ...resourceConfig,
+    viewsFallback: "event_revisions/general",
+  });
+
+  routeNestedMember(adapter, revisionsBaseResource, "visuals", VisualHandler, {
+    ...resourceConfig,
+    viewsFallback: "event_revisions/visuals",
+  });
+
+  routeNestedMember(adapter, revisionsBaseResource, "codes", CodeHandler, {
+    ...resourceConfig,
+    viewsFallback: "event_revisions/codes",
+  });
+
+  routeNestedMember(adapter, revisionsBaseResource, "meta", MetaHandler, {
+    ...resourceConfig,
+    viewsFallback: "event_revisions/meta",
+  });
+
+  routeNestedMember(adapter, revisionsBaseResource, "tags", TagHandler, {
+    ...resourceConfig,
+    viewsFallback: "event_revisions/tags",
+  });
+
+  routeNestedCollection(adapter, revisionsBaseResource, "locks", LocksHandler, {
+    ...resourceConfig,
+    viewsFallback: "event_revisions/locks",
+  });
+
+  routeNestedCollection(
+    adapter,
+    revisionsBaseResource,
+    "unlocks",
+    UnlocksHandler,
+    {
+      ...resourceConfig,
+      viewsFallback: "event_revisions/unlocks",
+    }
+  );
+
+  routeNestedCollection(adapter, baseResource, "clones", ClonesHandler, {
+    ...resourceConfig,
+    viewsFallback: "events/clones",
+  });
+
+  routeNestedCollection(adapter, baseResource, "urls", URLsHandler, {
+    ...resourceConfig,
+    viewsFallback: "events/urls",
+  });
+
+  routeNestedCollection(adapter, baseResource, "deletes", DeletesHandler, {
+    ...resourceConfig,
+    viewsFallback: "events/deletes",
+  });
+
+  routeNestedCollection(
+    adapter,
+    baseResource,
+    `${eventType}_changes/reverts`,
+    RevertsHandler,
+    {
+      ...resourceConfig,
+      viewsFallback: "event_changes/reverts",
+    }
+  );
+
+  routeNestedCollection(
+    adapter,
+    revisionsBaseResource,
+    "publishes",
+    PublishesHandler,
+    {
+      ...resourceConfig,
+      viewsFallback: "event_revisions/publishes",
+    }
+  );
+
+  routeNestedCollection(
+    adapter,
+    revisionsBaseResource,
+    "cancel_schedules",
+    CancelSchedulesHandler,
+    {
+      ...resourceConfig,
+      viewsFallback: "event_revisions/cancel_schedules",
+    }
+  );
+
+  routeNestedMember(
+    adapter,
+    `api/${revisionsBaseResource}`,
+    "widgets",
+    WidgetHandler,
+    resourceConfig
+  );
+}
+
+export default routeEventsModule;

package/src/routeMember.js

@@ -0,0 +1,40 @@
+const routeMember = (adapter, resource, handler, resourceConfig = {}) => {
+  const { before_filter, after_filter, show, edit_form, update } = handler;
+
+  const mapping = [
+    [
+      "GET",
+      `/${resource}`,
+      resource,
+      resource,
+      "show",
+      show,
+      before_filter,
+      after_filter,
+    ],
+    [
+      "GET",
+      `/${resource}/edit`,
+      resource,
+      resource,
+      "edit_form",
+      edit_form,
+      before_filter,
+      after_filter,
+    ],
+    [
+      "POST",
+      `/${resource}`,
+      resource,
+      resource,
+      "edit_form",
+      update,
+      before_filter,
+      after_filter,
+    ],
+  ];
+
+  adapter.routeMember(mapping, resourceConfig);
+};
+
+export default routeMember;