📝 docs(database-links): complete the docs

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dashpress",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "license": "GPL-3.0-or-later",
   "scripts": {
     "dev": "next dev",
@@ -23,7 +23,13 @@
     "build-storybook": "build-storybook",
     "prepare": "husky install"
   },
-  "files": [".next", "dist", "bin", "public", ".env.example"],
+  "files": [
+    ".next",
+    "dist",
+    "bin",
+    "public",
+    ".env.example"
+  ],
   "bin": "./bin/dashpress",
   "dependencies": {
     "@dashpress/bacteria": "^0.0.11",

src/__tests__/account/logout.spec.tsx

@@ -19,15 +19,6 @@ setupApiHandlers();
 jest.mock("next/router", () => require("next-router-mock"));
 
 describe("pages/account/logout", () => {
-  const useRouter = jest.spyOn(require("next/router"), "useRouter");
-  const replaceMock = jest.fn();
-
-  useRouter.mockImplementation(() => ({
-    push: replaceMock,
-    asPath: "/",
-    isReady: true,
-  }));
-
   it("should log user out", async () => {
     render(
       <ApplicationRoot>

src/frontend/docs/form-integrations.tsx

@@ -2,8 +2,6 @@ import { INTEGRATIONS_GROUP_CONFIG } from "shared/config-bag/integrations";
 import { FORM_ACTION_CRUD_CONFIG } from "frontend/views/entity/Actions/constants";
 import { ErrorAlert, InfoAlert } from "frontend/design-system/components/Alert";
 import { RenderCode } from "frontend/design-system/components/RenderCode";
-import { TextButton } from "frontend/design-system/components/Button/TextButton";
-import { NAVIGATION_LINKS } from "frontend/lib/routing/links";
 import { DocumentationRoot } from "./_base";
 
 export function FormIntegrationsDocumentation() {
@@ -79,17 +77,10 @@ export function FormIntegrationsDocumentation() {
             </code>
           </li>
           <li>
-            Current User - through the auth object - if you have{" "}
-            <TextButton
-              onClick={() => {
-                window.open(NAVIGATION_LINKS.USERS.LINK_DATABASE, "_blank");
-              }}
-            >
-              linked your database users.
-            </TextButton>
+            Current User -
             <code>
               {" "}
-              {"{{"} auth. {"}}"}{" "}
+              {"{{"} auth.field {"}}"}{" "}
             </code>
           </li>
         </ol>

src/frontend/docs/scripts/form-scripts.tsx

@@ -1,7 +1,5 @@
 import { RenderCode } from "frontend/design-system/components/RenderCode";
 import { Spacer } from "frontend/design-system/primitives/Spacer";
-import { TextButton } from "frontend/design-system/components/Button/TextButton";
-import { NAVIGATION_LINKS } from "frontend/lib/routing/links";
 import { DocumentationRoot } from "../_base";
 
 export function FormScriptDocumentation() {
@@ -33,14 +31,7 @@ export function FormScriptDocumentation() {
             <b>
               <code>$.auth</code>
             </b>
-            : The current user information from your database if you have{" "}
-            <TextButton
-              onClick={() => {
-                window.open(NAVIGATION_LINKS.USERS.LINK_DATABASE, "_blank");
-              }}
-            >
-              linked your database users.
-            </TextButton>
+            : The current user details
           </li>
         </ul>
       </p>

src/frontend/docs/users-link-to-database.tsx

@@ -44,6 +44,13 @@ export function UsersLinkToDatabaseDocumentation() {
         operations on your user table. All our operations are read-only. All we
         need to link the users are saved on our configuration.
       </p>
+      <p>
+        Linking also doesn&apos;t make any changes to the UI, it doesn&apos;t
+        add any new column to the DashPress users table or the user details
+        page. It only affects the scripts in the application. So you will still
+        manage your users details from your users&apos; entity page like the
+        other entities.
+      </p>
       <p>
         After you link your users, all scripts in the application will be
         injected the <code>$.auth</code> variable will have the user details

src/frontend/views/data/evaluatePresentationScript.ts

@@ -1,11 +1,12 @@
 import { evalJavascriptStringSafely } from "shared/lib/script-runner";
+import { IEvaluateScriptContext } from "shared/types/forms";
 
 export type IPresentationScriptParams = {
   row: Record<string, unknown>;
   value: unknown;
   field: string;
   from: "details" | "table";
-};
+} & IEvaluateScriptContext;
 
 export const evalutePresentationScript = (
   script: string,

src/frontend/views/entity/Form/ScriptForm.tsx

@@ -9,6 +9,7 @@ import { MAKE_APP_CONFIGURATION_CRUD_CONFIG } from "frontend/hooks/configuration
 import { AppConfigurationKeys } from "shared/configurations";
 import { evalJavascriptString } from "shared/lib/script-runner";
 import { useEvaluateScriptContext } from "frontend/hooks/scripts";
+import { ISchemaFormScriptProps } from "shared/form-schemas/types";
 
 interface IProps {
   value: string;
@@ -51,11 +52,12 @@ export function ScriptForm({
         onSubmit={async (data) => {
           try {
             const jsString = data[`${BASE_SUFFIX}${field}`] as string;
-            evalJavascriptString(jsString, {
+            const context: ISchemaFormScriptProps<{}> = {
               ...evaluateScriptContext,
               action: "test",
               formValues: {},
-            });
+            };
+            evalJavascriptString(jsString, context);
             await onSubmit(jsString);
           } catch (e) {
             ToastService.error(`•Expression: \n•JS-Error: ${e}`);

src/frontend/views/entity/PersistentQuery/Form.tsx

@@ -107,6 +107,7 @@ export function EntityPersistentQueryForm({
   const columns = tableColumns.filter(
     ({ accessor, filter }) => ACTIONS_ACCESSOR !== accessor && filter
   );
+
   return (
     <Form
       onSubmit={onSubmit}

src/frontend/views/entity/PersistentQuery/constants.ts

@@ -47,7 +47,6 @@ export const FILTER_OPERATOR_CONFIG: Record<
     numberOfInput: 1,
     placeholder: "Comma seperated values",
   },
-  //
   [FilterOperators.BETWEEN]: {
     label: "N/A",
     numberOfInput: 2,

src/frontend/views/entity/PersistentQuery/index.tsx

@@ -63,7 +63,7 @@ export function EntityPersistentQuerySettings() {
           }
         >
           <EntityPersistentQueryForm
-            initialValues={upsertPeristentQueryMutation.data}
+            initialValues={peristentQuery.data}
             onSubmit={upsertPeristentQueryMutation.mutateAsync}
             tableColumns={tableColumns.data || []}
           />

src/frontend/views/entity/Presentation/index.tsx

@@ -83,14 +83,15 @@ if($.field === "commentsCount"){
               },
             }}
             onSubmit={async (data) => {
+              const context: IPresentationScriptParams = {
+                field: "test",
+                from: "details",
+                row: {},
+                value: "",
+                ...evaluateScriptContext,
+              };
               try {
-                evalJavascriptString(data.script, {
-                  field: "test",
-                  from: "details",
-                  row: {},
-                  value: "",
-                  ...evaluateScriptContext,
-                } as IPresentationScriptParams);
+                evalJavascriptString(data.script, context);
 
                 await upsertConfigurationMutation.mutateAsync(data);
               } catch (e) {

src/frontend/views/users/DatabaseLink/index.tsx

@@ -58,7 +58,7 @@ export function UsersLinkToDatabase() {
     {
       table: {
         type: "selection",
-        label: "Table containing your user's data",
+        label: "Your Users Table",
         apiSelections: {
           listUrl: ACTIVE_ENTITIES_ENDPOINT,
         },
@@ -71,7 +71,7 @@ export function UsersLinkToDatabase() {
       },
       field: {
         type: "selection",
-        label: "The field that holds the user's email/username",
+        label: "Field Corresponding To Dashpress Usernames",
         selections: entityFields.data.map((field) => ({
           label: field,
           value: field,

src/shared/form-schemas/types.ts

@@ -4,10 +4,10 @@ import { GridSpanSizes, IColorableSelection } from "shared/types/ui";
 import { FIELD_TYPES_CONFIG_MAP } from "shared/validations";
 import { IFieldValidationItem } from "shared/validations/types";
 
-export interface ISchemaFormScriptProps<T> extends IEvaluateScriptContext {
+export type ISchemaFormScriptProps<T> = IEvaluateScriptContext & {
   formValues: T;
   action: string;
-}
+};
 
 export interface IFormInputRightAction {
   label: string;