@strapi/plugin-documentation 4.0.0-next.9 → 4.0.0

package/admin/src/pages/SettingsPage/tests/index.test.js

@@ -0,0 +1,612 @@
+import React from 'react';
+import { render, waitFor, screen } from '@testing-library/react';
+import { IntlProvider } from 'react-intl';
+import { QueryClient, QueryClientProvider } from 'react-query';
+import { ThemeProvider, lightTheme } from '@strapi/design-system';
+import { Router } from 'react-router-dom';
+import { createMemoryHistory } from 'history';
+
+import SettingsPage from '../index';
+import server from './server';
+
+jest.mock('@strapi/helper-plugin', () => ({
+  ...jest.requireActual('@strapi/helper-plugin'),
+  useNotification: jest.fn(),
+  CheckPermissions: jest.fn(({ children }) => children),
+}));
+
+const client = new QueryClient({
+  defaultOptions: {
+    queries: {
+      retry: false,
+    },
+  },
+});
+
+const makeApp = history => (
+  <Router history={history}>
+    <ThemeProvider theme={lightTheme}>
+      <QueryClientProvider client={client}>
+        <IntlProvider locale="en" messages={{}} textComponent="span">
+          <SettingsPage />
+        </IntlProvider>
+      </QueryClientProvider>
+    </ThemeProvider>
+  </Router>
+);
+
+describe('Plugin | Documentation | SettingsPage', () => {
+  beforeAll(() => server.listen());
+
+  beforeEach(() => jest.clearAllMocks());
+
+  afterEach(() => server.resetHandlers());
+
+  afterAll(() => server.close());
+
+  it('renders and matches the snapshot', async () => {
+    const history = createMemoryHistory();
+    const App = makeApp(history);
+    const {
+      container: { firstChild },
+    } = render(App);
+
+    await waitFor(() => {
+      expect(screen.getByText('Make the documentation endpoint private')).toBeInTheDocument();
+    });
+
+    expect(firstChild).toMatchInlineSnapshot(`
+      .c14 {
+        background: #ffffff;
+        padding-top: 24px;
+        padding-right: 32px;
+        padding-bottom: 24px;
+        padding-left: 32px;
+        border-radius: 4px;
+        box-shadow: 0px 1px 4px rgba(33,33,52,0.1);
+      }
+
+      .c11 {
+        font-weight: 600;
+        color: #32324d;
+        font-size: 0.75rem;
+        line-height: 1.33;
+      }
+
+      .c8 {
+        padding-right: 8px;
+      }
+
+      .c5 {
+        display: -webkit-box;
+        display: -webkit-flex;
+        display: -ms-flexbox;
+        display: flex;
+        cursor: pointer;
+        padding: 8px;
+        border-radius: 4px;
+        background: #ffffff;
+        border: 1px solid #dcdce4;
+        position: relative;
+        outline: none;
+      }
+
+      .c5 svg {
+        height: 12px;
+        width: 12px;
+      }
+
+      .c5 svg > g,
+      .c5 svg path {
+        fill: #ffffff;
+      }
+
+      .c5[aria-disabled='true'] {
+        pointer-events: none;
+      }
+
+      .c5:after {
+        -webkit-transition-property: all;
+        transition-property: all;
+        -webkit-transition-duration: 0.2s;
+        transition-duration: 0.2s;
+        border-radius: 8px;
+        content: '';
+        position: absolute;
+        top: -4px;
+        bottom: -4px;
+        left: -4px;
+        right: -4px;
+        border: 2px solid transparent;
+      }
+
+      .c5:focus-visible {
+        outline: none;
+      }
+
+      .c5:focus-visible:after {
+        border-radius: 8px;
+        content: '';
+        position: absolute;
+        top: -5px;
+        bottom: -5px;
+        left: -5px;
+        right: -5px;
+        border: 2px solid #4945ff;
+      }
+
+      .c9 {
+        height: 100%;
+      }
+
+      .c6 {
+        -webkit-align-items: center;
+        -webkit-box-align: center;
+        -ms-flex-align: center;
+        align-items: center;
+        padding: 8px 16px;
+        background: #4945ff;
+        border: none;
+        border: 1px solid #4945ff;
+        background: #4945ff;
+      }
+
+      .c6 .c7 {
+        display: -webkit-box;
+        display: -webkit-flex;
+        display: -ms-flexbox;
+        display: flex;
+        -webkit-align-items: center;
+        -webkit-box-align: center;
+        -ms-flex-align: center;
+        align-items: center;
+      }
+
+      .c6 .c10 {
+        color: #ffffff;
+      }
+
+      .c6[aria-disabled='true'] {
+        border: 1px solid #dcdce4;
+        background: #eaeaef;
+      }
+
+      .c6[aria-disabled='true'] .c10 {
+        color: #666687;
+      }
+
+      .c6[aria-disabled='true'] svg > g,
+      .c6[aria-disabled='true'] svg path {
+        fill: #666687;
+      }
+
+      .c6[aria-disabled='true']:active {
+        border: 1px solid #dcdce4;
+        background: #eaeaef;
+      }
+
+      .c6[aria-disabled='true']:active .c10 {
+        color: #666687;
+      }
+
+      .c6[aria-disabled='true']:active svg > g,
+      .c6[aria-disabled='true']:active svg path {
+        fill: #666687;
+      }
+
+      .c6:hover {
+        border: 1px solid #7b79ff;
+        background: #7b79ff;
+      }
+
+      .c6:active {
+        border: 1px solid #4945ff;
+        background: #4945ff;
+      }
+
+      .c15 {
+        display: -webkit-box;
+        display: -webkit-flex;
+        display: -ms-flexbox;
+        display: flex;
+        -webkit-flex-direction: column;
+        -ms-flex-direction: column;
+        flex-direction: column;
+      }
+
+      .c15 > * {
+        margin-top: 0;
+        margin-bottom: 0;
+      }
+
+      .c15 > * + * {
+        margin-top: 16px;
+      }
+
+      .c22 {
+        font-weight: 600;
+        color: #32324d;
+        font-size: 0.75rem;
+        line-height: 1.33;
+      }
+
+      .c29 {
+        font-weight: 600;
+        color: #b72b1a;
+        font-size: 0.75rem;
+        line-height: 1.33;
+      }
+
+      .c33 {
+        color: #666687;
+        font-size: 0.75rem;
+        line-height: 1.33;
+      }
+
+      .c25 {
+        background: #ffffff;
+        border-radius: 4px;
+      }
+
+      .c27 {
+        background: #fcecea;
+        padding-right: 32px;
+        padding-left: 32px;
+      }
+
+      .c30 {
+        background: #ffffff;
+        padding-right: 32px;
+        padding-left: 32px;
+      }
+
+      .c21 {
+        display: -webkit-box;
+        display: -webkit-flex;
+        display: -ms-flexbox;
+        display: flex;
+        -webkit-flex-direction: row;
+        -ms-flex-direction: row;
+        flex-direction: row;
+        -webkit-align-items: center;
+        -webkit-box-align: center;
+        -ms-flex-align: center;
+        align-items: center;
+      }
+
+      .c20 {
+        display: -webkit-box;
+        display: -webkit-flex;
+        display: -ms-flexbox;
+        display: flex;
+        -webkit-flex-direction: column;
+        -ms-flex-direction: column;
+        flex-direction: column;
+      }
+
+      .c20 > * {
+        margin-top: 0;
+        margin-bottom: 0;
+      }
+
+      .c20 > * + * {
+        margin-top: 4px;
+      }
+
+      .c24 {
+        border: 0;
+        -webkit-clip: rect(0 0 0 0);
+        clip: rect(0 0 0 0);
+        height: 1px;
+        margin: -1px;
+        overflow: hidden;
+        padding: 0;
+        position: absolute;
+        width: 1px;
+      }
+
+      .c23 {
+        position: relative;
+        display: inline-block;
+      }
+
+      .c26 {
+        height: 2.5rem;
+        border: 1px solid #dcdce4;
+        display: -webkit-inline-box;
+        display: -webkit-inline-flex;
+        display: -ms-inline-flexbox;
+        display: inline-flex;
+        overflow: hidden;
+        outline: none;
+        box-shadow: 0;
+        -webkit-transition-property: border-color,box-shadow,fill;
+        transition-property: border-color,box-shadow,fill;
+        -webkit-transition-duration: 0.2s;
+        transition-duration: 0.2s;
+      }
+
+      .c26:focus-within {
+        border: 1px solid #4945ff;
+        box-shadow: #4945ff 0px 0px 0px 2px;
+      }
+
+      .c31 {
+        text-transform: uppercase;
+        position: relative;
+        z-index: 2;
+      }
+
+      .c28 {
+        text-transform: uppercase;
+        border-right: 1px solid #dcdce4;
+        position: relative;
+        z-index: 2;
+      }
+
+      .c32 {
+        position: absolute;
+        z-index: 1;
+        left: 4px;
+        top: 4px;
+      }
+
+      .c19 {
+        width: -webkit-fit-content;
+        width: -moz-fit-content;
+        width: fit-content;
+      }
+
+      .c16 {
+        color: #32324d;
+        font-weight: 500;
+        font-size: 1rem;
+        line-height: 1.25;
+      }
+
+      .c1 {
+        background: #f6f6f9;
+        padding-top: 40px;
+        padding-right: 56px;
+        padding-bottom: 40px;
+        padding-left: 56px;
+      }
+
+      .c13 {
+        padding-right: 56px;
+        padding-left: 56px;
+      }
+
+      .c2 {
+        display: -webkit-box;
+        display: -webkit-flex;
+        display: -ms-flexbox;
+        display: flex;
+        -webkit-flex-direction: row;
+        -ms-flex-direction: row;
+        flex-direction: row;
+        -webkit-box-pack: justify;
+        -webkit-justify-content: space-between;
+        -ms-flex-pack: justify;
+        justify-content: space-between;
+        -webkit-align-items: center;
+        -webkit-box-align: center;
+        -ms-flex-align: center;
+        align-items: center;
+      }
+
+      .c3 {
+        display: -webkit-box;
+        display: -webkit-flex;
+        display: -ms-flexbox;
+        display: flex;
+        -webkit-flex-direction: row;
+        -ms-flex-direction: row;
+        flex-direction: row;
+        -webkit-align-items: center;
+        -webkit-box-align: center;
+        -ms-flex-align: center;
+        align-items: center;
+      }
+
+      .c4 {
+        color: #32324d;
+        font-weight: 600;
+        font-size: 2rem;
+        line-height: 1.25;
+      }
+
+      .c12 {
+        color: #666687;
+        font-size: 1rem;
+        line-height: 1.5;
+      }
+
+      .c0:focus-visible {
+        outline: none;
+      }
+
+      .c17 {
+        display: grid;
+        grid-template-columns: repeat(12,1fr);
+        gap: 16px;
+      }
+
+      .c18 {
+        grid-column: span 6;
+      }
+
+      @media (max-width:68.75rem) {
+        .c18 {
+          grid-column: span 12;
+        }
+      }
+
+      @media (max-width:34.375rem) {
+        .c18 {
+          grid-column: span;
+        }
+      }
+
+      <main
+        aria-labelledby="main-content-title"
+        class="c0"
+        id="main-content"
+        tabindex="-1"
+      >
+        <form
+          action="#"
+          novalidate=""
+        >
+          <div
+            style="height: 0px;"
+          >
+            <div
+              class="c1"
+              data-strapi-header="true"
+            >
+              <div
+                class="c2"
+              >
+                <div
+                  class="c3"
+                >
+                  <h1
+                    class="c4"
+                  >
+                    Documentation
+                  </h1>
+                </div>
+                <button
+                  aria-disabled="false"
+                  class="c5 c6"
+                  type="submit"
+                >
+                  <div
+                    aria-hidden="true"
+                    class="c7 c8 c9"
+                  >
+                    <svg
+                      fill="none"
+                      height="1em"
+                      viewBox="0 0 24 24"
+                      width="1em"
+                      xmlns="http://www.w3.org/2000/svg"
+                    >
+                      <path
+                        d="M20.727 2.97a.2.2 0 01.286 0l2.85 2.89a.2.2 0 010 .28L9.554 20.854a.2.2 0 01-.285 0l-9.13-9.243a.2.2 0 010-.281l2.85-2.892a.2.2 0 01.284 0l6.14 6.209L20.726 2.97z"
+                        fill="#212134"
+                      />
+                    </svg>
+                  </div>
+                  <span
+                    class="c10 c11"
+                  >
+                    Save
+                  </span>
+                </button>
+              </div>
+              <p
+                class="c12"
+              >
+                Configure the documentation plugin
+              </p>
+            </div>
+          </div>
+          <div
+            class="c13"
+          >
+            <div
+              class="c14"
+            >
+              <div
+                class="c15"
+              >
+                <h2
+                  class="c16"
+                >
+                  Settings
+                </h2>
+                <div
+                  class="c17"
+                >
+                  <div
+                    class="c18"
+                  >
+                    <div
+                      class=""
+                    >
+                      <div
+                        class="c19"
+                      >
+                        <div
+                          class="c20"
+                        >
+                          <div
+                            class="c21"
+                          >
+                            <label
+                              class="c22"
+                              for="field-1"
+                            >
+                              Restricted Access
+                            </label>
+                          </div>
+                          <label
+                            class="c23"
+                          >
+                            <div
+                              class="c24"
+                            >
+                              Restricted Access
+                            </div>
+                            <div
+                              class="c25 c26"
+                            >
+                              <div
+                                aria-hidden="true"
+                                class="c27 c21 c28"
+                              >
+                                <span
+                                  class="c29"
+                                >
+                                  Off
+                                </span>
+                              </div>
+                              <div
+                                aria-hidden="true"
+                                class="c30 c21 c31"
+                              >
+                                <span
+                                  class="c22"
+                                >
+                                  On
+                                </span>
+                              </div>
+                              <input
+                                aria-disabled="false"
+                                class="c32"
+                                name="restrictedAccess"
+                                type="checkbox"
+                              />
+                            </div>
+                          </label>
+                          <p
+                            class="c33"
+                            id="field-1-hint"
+                          >
+                            Make the documentation endpoint private
+                          </p>
+                        </div>
+                      </div>
+                    </div>
+                  </div>
+                </div>
+              </div>
+            </div>
+          </div>
+        </form>
+      </main>
+    `);
+  });
+});

package/admin/src/pages/SettingsPage/tests/server.js

@@ -0,0 +1,18 @@
+import { setupServer } from 'msw/node';
+import { rest } from 'msw';
+
+const handlers = [
+  rest.get('*/getInfos', (req, res, ctx) => {
+    return res(
+      ctx.delay(100),
+      ctx.status(200),
+      ctx.json({
+        documentationAccess: { restrictedAccess: false },
+      })
+    );
+  }),
+];
+
+const server = setupServer(...handlers);
+
+export default server;

package/admin/src/pages/{HomePage/utils → utils}/api.js

@@ -1,11 +1,11 @@
 import { request } from '@strapi/helper-plugin';
-import pluginId from '../../../pluginId';
+import pluginId from '../../pluginId';
 
 const deleteDoc = ({ prefix, version }) => {
   return request(`${prefix}/deleteDoc/${version}`, { method: 'DELETE' });
 };
 
-const fetchData = async toggleNotification => {
+const fetchDocumentationVersions = async toggleNotification => {
   try {
     const data = await request(`/${pluginId}/getInfos`, { method: 'GET' });
 
@@ -25,6 +25,7 @@ const regenerateDoc = ({ prefix, version }) => {
   return request(`${prefix}/regenerateDoc`, { method: 'POST', body: { version } });
 };
 
-const submit = ({ prefix, body }) => request(`${prefix}/updateSettings`, { method: 'PUT', body });
+const updateSettings = ({ prefix, body }) =>
+  request(`${prefix}/updateSettings`, { method: 'PUT', body });
 
-export { deleteDoc, fetchData, regenerateDoc, submit };
+export { deleteDoc, fetchDocumentationVersions, regenerateDoc, updateSettings };

package/admin/src/pages/utils/useReactQuery.js

@@ -0,0 +1,46 @@
+import { useQuery, useMutation, useQueryClient } from 'react-query';
+import { useNotification } from '@strapi/helper-plugin';
+import { fetchDocumentationVersions, deleteDoc, regenerateDoc, updateSettings } from './api';
+import getTrad from '../../utils/getTrad';
+
+const useReactQuery = () => {
+  const queryClient = useQueryClient();
+  const toggleNotification = useNotification();
+  const { isLoading, data } = useQuery('get-documentation', () =>
+    fetchDocumentationVersions(toggleNotification)
+  );
+
+  const handleError = err => {
+    toggleNotification({
+      type: 'warning',
+      message: err.response.payload.message,
+    });
+  };
+
+  const handleSuccess = (type, tradId) => {
+    queryClient.invalidateQueries('get-documentation');
+    toggleNotification({
+      type,
+      message: { id: getTrad(tradId) },
+    });
+  };
+
+  const deleteMutation = useMutation(deleteDoc, {
+    onSuccess: () => handleSuccess('info', 'notification.delete.success'),
+    onError: error => handleError(error),
+  });
+
+  const submitMutation = useMutation(updateSettings, {
+    onSuccess: () => handleSuccess('success', 'notification.update.success'),
+    onError: handleError,
+  });
+
+  const regenerateDocMutation = useMutation(regenerateDoc, {
+    onSuccess: () => handleSuccess('info', 'notification.generate.success'),
+    onError: error => handleError(error),
+  });
+
+  return { data, isLoading, deleteMutation, submitMutation, regenerateDocMutation };
+};
+
+export default useReactQuery;

package/admin/src/translations/ar.json

@@ -1,11 +1,8 @@
 {
-  "components.Row.generatedDate": "Last generation",
   "components.Row.open": "Open",
   "components.Row.regenerate": "Regenerate",
   "containers.HomePage.Block.title": "Versions",
-  "containers.HomePage.Button.open": "Open the documentation",
   "containers.HomePage.Button.update": "Update",
-  "containers.HomePage.PluginHeader.description": "Configure the documentation plugin",
   "containers.HomePage.PluginHeader.title": "Documentation - Settings",
   "containers.HomePage.PopUpWarning.confirm": "I understand",
   "containers.HomePage.PopUpWarning.message": "Are you sure you want to delete this version?",