@raketa-cloud/admin 0.0.33 → 0.0.36

package/package.json

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

package/src/handlers/article_revisions/LocksHandler.js

@@ -6,6 +6,10 @@ const create_form = async (ctx) => {
     ctx.locale
   );
 
+  if (!revision) {
+    throw new Error(`Missing revision #${parent_id}`);
+  }
+
   const resource = {
     id: revision.id,
     originalId: revision.originalId,
@@ -25,8 +29,20 @@ const create = async (ctx) => {
   const { parent_id } = ctx.params;
   const { message } = ctx.resourceParams.resource;
 
-  const { revision, errors, articleErrors } =
-    await ctx.client.articleRevisions.lock(parent_id, ctx.locale, message);
+  const revision = await ctx.client.articleRevisions.find(
+    parent_id,
+    ctx.locale
+  );
+
+  if (!revision) {
+    throw new Error(`Missing revision #${parent_id}`);
+  }
+
+  const { errors, articleErrors } = await ctx.client.articleRevisions.lock(
+    parent_id,
+    ctx.locale,
+    message
+  );
 
   if (errors) {
     return {
@@ -37,7 +53,7 @@ const create = async (ctx) => {
           message,
         },
         errors: {
-          resource: ctx.client.articles.formatErrors(errors, "message"),
+          resource: ctx.client.articleRevisions.formatErrors(errors, "message"),
         },
         _translations: [],
       },
@@ -45,7 +61,9 @@ const create = async (ctx) => {
   }
 
   if (articleErrors) {
-    throw `Failed to lock revisions: ${JSON.stringify(articleErrors)}`;
+    throw new Error(
+      `Failed to lock revision: ${JSON.stringify(articleErrors)}`
+    );
   }
 
   return {

package/src/handlers/article_revisions/UnlocksHandler.js

@@ -9,7 +9,9 @@ const create = async (ctx) => {
   }
 
   if (articleErrors) {
-    throw `Failed to start revision: ${JSON.stringify(articleErrors)}`;
+    throw new Error(
+      `Failed to start revision: ${JSON.stringify(articleErrors)}`
+    );
   }
 
   return {

package/src/handlers/event_revisions/LocksHandler.js

@@ -3,6 +3,10 @@ const create_form = async (ctx) => {
 
   const revision = await ctx.client.eventRevisions.find(parent_id, ctx.locale);
 
+  if (!revision) {
+    throw new Error(`Missing revision #${parent_id}`);
+  }
+
   const resource = {
     id: revision.id,
     originalId: revision.originalId,
@@ -22,15 +26,24 @@ const create = async (ctx) => {
   const { parent_id } = ctx.params;
   const { message } = ctx.resourceParams.resource;
 
-  const { revision, errors, eventErrors } =
-    await ctx.client.eventRevisions.lock(parent_id, ctx.locale, message);
+  const revision = await ctx.client.eventRevisions.find(parent_id, ctx.locale);
+
+  if (!revision) {
+    throw new Error(`Missing revision #${parent_id}`);
+  }
+
+  const { errors, eventErrors } = await ctx.client.eventRevisions.lock(
+    parent_id,
+    ctx.locale,
+    message
+  );
 
   if (errors) {
     return {
       assigns: {
         resource: { id: revision.id, originalId: revision.originalId, message },
         errors: {
-          resource: ctx.client.events.formatErrors(errors, "message"),
+          resource: ctx.client.eventRevisions.formatErrors(errors, "message"),
         },
         _translations: [],
       },
@@ -38,7 +51,7 @@ const create = async (ctx) => {
   }
 
   if (eventErrors) {
-    throw `Failed to lock revisions: ${JSON.stringify(eventErrors)}`;
+    throw new Error(`Failed to lock revision: ${JSON.stringify(eventErrors)}`);
   }
 
   return {

package/src/handlers/event_revisions/UnlocksHandler.js

@@ -9,7 +9,7 @@ const create = async (ctx) => {
   }
 
   if (eventErrors) {
-    throw `Failed to start revision: ${JSON.stringify(eventErrors)}`;
+    throw new Error(`Failed to start revision: ${JSON.stringify(eventErrors)}`);
   }
 
   return {

package/src/handlers/page_revisions/LocksHandler.js

@@ -3,6 +3,10 @@ const create_form = async (ctx) => {
 
   const revision = await ctx.client.pageRevisions.find(parent_id, ctx.locale);
 
+  if (!revision) {
+    throw new Error(`Missing revision #${parent_id}`);
+  }
+
   const resource = {
     id: revision.id,
     originalId: revision.originalId,
@@ -22,7 +26,13 @@ const create = async (ctx) => {
   const { parent_id } = ctx.params;
   const { message } = ctx.resourceParams.resource;
 
-  const { revision, errors, pageErrors } = await ctx.client.pageRevisions.lock(
+  const revision = await ctx.client.pageRevisions.find(parent_id, ctx.locale);
+
+  if (!revision) {
+    throw new Error(`Missing revision #${parent_id}`);
+  }
+
+  const { errors, pageErrors } = await ctx.client.pageRevisions.lock(
     parent_id,
     ctx.locale,
     message
@@ -37,7 +47,7 @@ const create = async (ctx) => {
           message,
         },
         errors: {
-          resource: ctx.client.pages.formatErrors(errors, "message"),
+          resource: ctx.client.pageRevisions.formatErrors(errors, "message"),
         },
         _translations: [],
       },
@@ -45,7 +55,7 @@ const create = async (ctx) => {
   }
 
   if (pageErrors) {
-    throw `Failed to lock revisions: ${JSON.stringify(pageErrors)}`;
+    throw new Error(`Failed to lock revision: ${JSON.stringify(pageErrors)}`);
   }
 
   return {

package/src/handlers/page_revisions/UnlocksHandler.js

@@ -9,7 +9,7 @@ const create = async (ctx) => {
   }
 
   if (pageErrors) {
-    throw `Failed to start revision: ${JSON.stringify(pageErrors)}`;
+    throw new Error(`Failed to start revision: ${JSON.stringify(pageErrors)}`);
   }
 
   return {

package/src/helpers/FormBuilder.js

@@ -117,27 +117,45 @@ export default class FormBuilder extends HTMLBuilder {
     return humanize(field);
   }
 
+  withHint(markup, hint) {
+    return [markup, hint ? this.hint(hint) : ""].join("");
+  }
+
   input(name, opts = {}) {
+    const { hint = "", ...rest } = opts;
     const value = this.__getValue(name);
-    return this.tag("input", null, { type: "text", name, value, ...opts });
+
+    return this.withHint(
+      this.tag("input", null, { type: "text", name, value, ...rest }),
+      hint
+    );
   }
 
   textarea(name, opts = {}) {
-    const { value, ...rest } = opts;
-
-    return this.tag(
-      "textarea",
-      value || this.__getValue(name),
-      {
-        name,
-        ...rest,
-      },
-      { nonVoid: true }
+    const { value, hint = "", ...rest } = opts;
+
+    return this.withHint(
+      this.tag(
+        "textarea",
+        value || this.__getValue(name),
+        {
+          name,
+          ...rest,
+        },
+        { nonVoid: true }
+      ),
+      hint
     );
   }
 
   select(name, opts = {}) {
-    const { value, options = [], prompt = "Please select...", ...rest } = opts;
+    const {
+      value,
+      options = [],
+      prompt = "Please select...",
+      hint = "",
+      ...rest
+    } = opts;
     const selected = value || this.__getValue(name);
 
     const renderedOpts = [];
@@ -154,11 +172,14 @@ export default class FormBuilder extends HTMLBuilder {
       );
     }
 
-    return this.tag("select", renderedOpts.join(""), { name, ...rest });
+    return this.withHint(
+      this.tag("select", renderedOpts.join(""), { name, ...rest }),
+      hint
+    );
   }
 
   radio_group(name, opts = {}) {
-    const { value, options = [], ...rest } = opts;
+    const { value, options = [], hint = "", ...rest } = opts;
     const selected = value || this.__getValue(name);
 
     const renderedOpts = [];
@@ -176,11 +197,17 @@ export default class FormBuilder extends HTMLBuilder {
       renderedOpts.push(this.tag("label", `${radio} ${o[1]}`));
     }
 
-    return this.tag("div", renderedOpts.join(""), { ...rest });
+    return this.withHint(
+      this.tag("div", renderedOpts.join(""), {
+        ...rest,
+        class: ["radio-group", rest.class].filter(Boolean).join(" "),
+      }),
+      hint
+    );
   }
 
   checkbox_group(name, opts = {}) {
-    const { value, options = [], ...rest } = opts;
+    const { value, options = [], hint = "", ...rest } = opts;
     const selected = value || this.__getValue(name);
 
     const renderedOpts = [];
@@ -200,33 +227,49 @@ export default class FormBuilder extends HTMLBuilder {
       renderedOpts.push(this.tag("label", `${checkbox} ${o[1]}`));
     }
 
-    return this.tag(
-      "div",
-      renderedOpts.length
-        ? renderedOpts.join("")
-        : this.tag("div", "No items available.", {
-            class: "italic opacity-50",
-          }),
-      {
-        ...rest,
-        class: ["checkbox-group", rest.class].filter(Boolean).join(" "),
-      }
+    return this.withHint(
+      this.tag(
+        "div",
+
+        renderedOpts.length
+          ? renderedOpts.join("")
+          : this.tag("div", "No items available.", {
+              class: "italic opacity-50",
+            }),
+
+        {
+          ...rest,
+          class: ["checkbox-group", rest.class].filter(Boolean).join(" "),
+        }
+      ),
+      hint
     );
   }
 
   checkbox(name, opts = {}) {
-    const { value: desiredValue } = opts;
-
+    const { value: desiredValue, default_value: defaultValue, ...rest } = opts;
     const value = this.__getValue(name);
     const selected = value === desiredValue ? { checked: "checked" } : {};
 
-    return this.tag("input", null, {
+    const checkboxItem = this.tag("input", null, {
       type: "checkbox",
-      name,
       value,
-      ...opts,
+      ...rest,
       ...selected,
     });
+
+    if (defaultValue === undefined) {
+      return checkboxItem;
+    }
+
+    // Make sure to submit the negative value if unchecked
+    const hiddenComplementaryItem = this.tag("input", null, {
+      type: "hidden",
+      name: toFormName(name),
+      value: defaultValue,
+    });
+
+    return [hiddenComplementaryItem, checkboxItem].join("");
   }
 
   label(name, children, opts = {}) {
@@ -238,6 +281,10 @@ export default class FormBuilder extends HTMLBuilder {
     return this.tag("span", children, { class: "text-red-600" });
   }
 
+  hint(children) {
+    return this.tag("span", children, { class: "help-block" });
+  }
+
   group(children, opts = {}) {
     return this.tag("div", children, {
       class: ["mb-4", opts.class].filter(Boolean).join(" "),
@@ -249,8 +296,8 @@ export default class FormBuilder extends HTMLBuilder {
   }
 
   button(name, opts) {
-    const { label, ...rest } = opts;
-    const defaultLabel = opts?.label || this.__getDefaultLabel(name);
+    const { label, hint = "" } = opts;
+    const defaultLabel = label || this.__getDefaultLabel(name);
     const fields = Object.keys(BUTTON_FIELDS_MAP).map((key) => {
       const innerOpts = BUTTON_FIELDS_MAP[key];
 
@@ -261,17 +308,20 @@ export default class FormBuilder extends HTMLBuilder {
           label: innerOpts.label,
           class: "no-margin",
         });
-      } else {
-        return this.field(`${name}.${key}`, {
-          label: innerOpts.label,
-          class: "no-margin",
-        });
       }
+      return this.field(`${name}.${key}`, {
+        label: innerOpts.label,
+        class: "no-margin",
+      });
     });
 
     return this.tag(
       "fieldset",
-      [this.tag("legend", defaultLabel, {}), ...fields].join(""),
+      [
+        this.tag("legend", defaultLabel, {}),
+        ...fields,
+        hint ? this.hint(hint) : "",
+      ].join(""),
       {
         class: "button-group",
       }
@@ -279,8 +329,8 @@ export default class FormBuilder extends HTMLBuilder {
   }
 
   link(name, opts) {
-    const { label, ...rest } = opts;
-    const defaultLabel = opts?.label || this.__getDefaultLabel(name);
+    const { label, hint = "" } = opts;
+    const defaultLabel = label || this.__getDefaultLabel(name);
     const fields = Object.keys(LINK_FIELDS_MAP).map((key) => {
       const innerOpts = LINK_FIELDS_MAP[key];
 
@@ -291,17 +341,20 @@ export default class FormBuilder extends HTMLBuilder {
           label: innerOpts.label,
           class: "no-margin",
         });
-      } else {
-        return this.field(`${name}.${key}`, {
-          label: innerOpts.label,
-          class: "no-margin",
-        });
       }
+      return this.field(`${name}.${key}`, {
+        label: innerOpts.label,
+        class: "no-margin",
+      });
     });
 
     return this.tag(
       "fieldset",
-      [this.tag("legend", defaultLabel, {}), ...fields].join(""),
+      [
+        this.tag("legend", defaultLabel, {}),
+        ...fields,
+        hint ? this.hint(hint) : "",
+      ].join(""),
       {
         class: "link-group",
       }
@@ -320,12 +373,17 @@ export default class FormBuilder extends HTMLBuilder {
     const error = this.__getError(name);
 
     if (as === "checkbox") {
+      const { hint = "", cbOptsRest } = rest;
       return this.group(
         [
           this.tag(
             "div",
             [
-              this[as](name, { id: htmlID, name: toFormName(name), ...rest }),
+              this[as](name, {
+                id: htmlID,
+                name: toFormName(name),
+                ...cbOptsRest,
+              }),
               this.label(name, `${label || defaultLabel}`),
             ]
               .filter(Boolean)
@@ -334,6 +392,7 @@ export default class FormBuilder extends HTMLBuilder {
               class: "checkbox-wrapper",
             }
           ),
+          hint ? this.hint(hint) : "",
           error ? this.error(error) : "",
         ]
           .filter(Boolean)

package/src/helpers/Inflector.js

@@ -1,6 +1,6 @@
 const Inflector = {
   capitalize: (str) => str[0].toUpperCase() + str.slice(1),
+  downcase: (str) => str.toLowerCase(),
 };
 
 export default Inflector;
-

package/src/styles/application.css

@@ -26,7 +26,6 @@ body {
 }
 
 @layer components {
-
   /* Utils */
   .dbg {
     @apply outline-1 outline-dashed outline-red-500;
@@ -144,10 +143,16 @@ body {
       @apply border-red-600;
     }
 
+    .help-block {
+      @apply opacity-50 text-sm;
+    }
+
+    .radio-group,
     .checkbox-group {
       @apply max-h-[200px] overflow-y-auto py-1 px-2 mt-1 rounded shadow-inner border border-neutral-300 bg-raketa-background dark:border-neutral-700;
     }
 
+    .radio-group label,
     .checkbox-group label {
       @apply flex gap-2 text-nowrap items-center py-2;
     }
@@ -156,6 +161,10 @@ body {
       @apply size-4 px-0;
     }
 
+    .radio-group input[type="radio"] {
+      @apply size-4 px-0 rounded-full;
+    }
+
     .checkbox-wrapper {
       @apply flex gap-2 text-nowrap;
     }
@@ -275,7 +284,7 @@ body {
   .pagination {
     @apply text-center py-8 text-raketa-foreground/50;
 
-    &>div {
+    & > div {
       @apply inline-flex items-center gap-4;
     }
 

package/src/tests/handlers/article_revisions/CodesHandler.test/update.test.js

@@ -30,7 +30,7 @@ describe("Article revision code settings", () => {
       settings: {
         codes: {
           scripts: JSON.stringify([{ type: "bla" }]),
-          structured_data: JSON.stringify({ type: "article" }),
+          structured_json: JSON.stringify({ type: "article" }),
         },
       },
     };
@@ -63,7 +63,7 @@ describe("Article revision code settings", () => {
         ...revision.settings,
         codes: {
           scripts: [{ type: "bla" }],
-          structured_data: { type: "article" },
+          structured_json: { type: "article" },
         },
       },
     });
@@ -82,7 +82,7 @@ describe("Article revision code settings", () => {
       settings: {
         codes: {
           scripts: JSON.stringify([{ type: "bla" }]),
-          structured_data: JSON.stringify({ type: "article" }),
+          structured_json: JSON.stringify({ type: "article" }),
         },
       },
     };
@@ -115,7 +115,7 @@ describe("Article revision code settings", () => {
         ...revision.settings,
         codes: {
           scripts: [{ type: "bla" }],
-          structured_data: { type: "article" },
+          structured_json: { type: "article" },
         },
       },
     });
@@ -129,7 +129,7 @@ describe("Article revision code settings", () => {
             ...revision.settings,
             codes: {
               scripts: [{ type: "bla" }],
-              structured_data: { type: "article" },
+              structured_json: { type: "article" },
             },
           },
         },

package/src/tests/handlers/article_revisions/LocksHandler.test/create.test.js

@@ -0,0 +1,142 @@
+import Factory from "../../../support/factory";
+import ArticleRevisions from "../../../../cloud/ArticleRevisions";
+import LocksHandler from "../../../../handlers/article_revisions/LocksHandler";
+
+function buildCtx(revision, lockSettings) {
+  return {
+    client: {
+      articleRevisions: new ArticleRevisions(() => ({}), "token"),
+    },
+    params: { parent_id: revision.id },
+    resourceParams: {
+      resource: lockSettings,
+    },
+    locale: "en",
+    resourceConfig: {
+      articleType: "article",
+      articleTypePlural: "articles",
+    },
+  };
+}
+
+describe("Article revision lock ", () => {
+  test("lock successful", async () => {
+    const revision = Factory.build("article_revision");
+    const lockSettings = { message: "Some lock message" };
+    const ctx = buildCtx(revision, lockSettings);
+
+    const mockFind = jest
+      .spyOn(ctx.client.articleRevisions, "find")
+      .mockImplementation(() => revision);
+
+    const mockLock = jest
+      .spyOn(ctx.client.articleRevisions, "lock")
+      .mockImplementation(() => ({
+        revision,
+        errors: null,
+        articleErrors: null,
+      }));
+
+    const result = await LocksHandler.create(ctx);
+
+    expect(mockFind).toHaveBeenCalledWith(revision.id, "en");
+    expect(mockLock).toHaveBeenCalledWith(
+      revision.id,
+      "en",
+      lockSettings.message
+    );
+
+    expect(result).toEqual({
+      redirect: `/en/articles/${revision.originalId}`,
+    });
+  });
+
+  test("lock failed with errors", async () => {
+    const revision = Factory.build("article_revision");
+    const lockSettings = { message: "" };
+    const ctx = buildCtx(revision, lockSettings);
+    const errors = [{ key: "message", message: "Cannot be blank" }];
+
+    const mockFind = jest
+      .spyOn(ctx.client.articleRevisions, "find")
+      .mockImplementation(() => revision);
+
+    const mockLock = jest
+      .spyOn(ctx.client.articleRevisions, "lock")
+      .mockImplementation(() => ({
+        revision: null,
+        errors,
+        articleErrors: null,
+      }));
+
+    const result = await LocksHandler.create(ctx);
+
+    expect(mockFind).toHaveBeenCalledWith(revision.id, "en");
+    expect(mockLock).toHaveBeenCalledWith(
+      revision.id,
+      "en",
+      lockSettings.message
+    );
+
+    expect(result).toEqual({
+      assigns: {
+        resource: {
+          id: revision.id,
+          originalId: revision.originalId,
+          message: lockSettings.message,
+        },
+        errors: {
+          resource: { message: "Cannot be blank" },
+        },
+        _translations: [],
+      },
+    });
+  });
+
+  test("lock failed with article errors", async () => {
+    const revision = Factory.build("article_revision");
+    const lockSettings = { message: "Some lock message" };
+    const ctx = buildCtx(revision, lockSettings);
+    const articleErrors = [
+      { key: "generalError", message: "Failed to lock revision" },
+    ];
+
+    const mockFind = jest
+      .spyOn(ctx.client.articleRevisions, "find")
+      .mockImplementation(() => revision);
+
+    const mockLock = jest
+      .spyOn(ctx.client.articleRevisions, "lock")
+      .mockImplementation(() => ({
+        revision: null,
+        errors: null,
+        articleErrors,
+      }));
+
+    await expect(LocksHandler.create(ctx)).rejects.toThrow(
+      `Failed to lock revision: ${JSON.stringify(articleErrors)}`
+    );
+
+    expect(mockFind).toHaveBeenCalledWith(revision.id, "en");
+    expect(mockLock).toHaveBeenCalledWith(
+      revision.id,
+      "en",
+      lockSettings.message
+    );
+  });
+
+  test("create for non existing article revision", async () => {
+    const lockSettings = { message: "Some lock message" };
+    const ctx = buildCtx({ id: 42 }, lockSettings);
+
+    const mockFind = jest
+      .spyOn(ctx.client.articleRevisions, "find")
+      .mockImplementation(() => null);
+
+    await expect(LocksHandler.create(ctx)).rejects.toThrow(
+      `Missing revision #42`
+    );
+
+    expect(mockFind).toHaveBeenCalledWith(42, "en");
+  });
+});