Skip to content

Commit

Permalink
fix(react-formio): changing naming convention for Type (prefix by Typ…
Browse files Browse the repository at this point in the history
…e instead Schema)
  • Loading branch information
Romakita committed Jan 4, 2025
1 parent 376eade commit 0380a06
Show file tree
Hide file tree
Showing 78 changed files with 299 additions and 275 deletions.
12 changes: 6 additions & 6 deletions packages/react-formio-container/src/hooks/useAction.hook.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import {
ActionInfoSchema,
ActionSchema,
ActionInfoType,
ActionType,
deleteAction,
getAction,
getActionInfo,
Expand All @@ -11,7 +11,7 @@ import {
selectAuth,
selectError,
selectForm,
Submission,
SubmissionType,
Utils
} from "@tsed/react-formio-stores";
import { push } from "connected-react-router";
Expand All @@ -35,7 +35,7 @@ export function useAction(props: UseActionProps) {
const form = useSelector((state) => selectForm(type, state));
const error = useSelector((state) => selectError("action", state));
const action = useSelector(selectAction);
const actionInfo: ActionInfoSchema | undefined = useSelector(selectActionInfo) as any;
const actionInfo: ActionInfoType | undefined = useSelector(selectActionInfo) as any;

const fetch = useCallback(() => {
if (form?._id) {
Expand All @@ -47,7 +47,7 @@ export function useAction(props: UseActionProps) {
}
}, [form?._id, actionId]);

Check warning on line 48 in packages/react-formio-container/src/hooks/useAction.hook.tsx

View workflow job for this annotation

GitHub Actions / lint

React Hook useCallback has a missing dependency: 'dispatch'. Either include it or remove the dependency array

const onSaveDone = (err: Error | null, actionInfo: ActionSchema) => {
const onSaveDone = (err: Error | null, actionInfo: ActionType) => {
if (!err) {
onSuccess({
name: `${actionAction}:action`,
Expand All @@ -68,7 +68,7 @@ export function useAction(props: UseActionProps) {
}
};

const saveAction = (actionInfo: Submission<ActionSchema>) => {
const saveAction = (actionInfo: SubmissionType<ActionType>) => {
dispatch(saveAct(form?._id!, actionInfo, onSaveDone));
};

Expand Down
8 changes: 4 additions & 4 deletions packages/react-formio-container/src/hooks/useActions.hook.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import {
ActionInfoSchema,
ActionSchema,
ActionInfoType,
ActionType,
Operation,
selectActions,
selectAuth,
Expand Down Expand Up @@ -37,13 +37,13 @@ export function useActions(props: UseActionsProps) {
});

const [operation, setOperation] = useState<Operation>();
const [currentAction, setCurrentAction] = useState<ActionInfoSchema>(availableActions[0]);
const [currentAction, setCurrentAction] = useState<ActionInfoType>(availableActions[0]);

const addAction = (actionName: string) => {
dispatch(push([basePath, actionName, "add"].join("/")));
};

const dispatchOperation = (actionInfo: ActionSchema, operation: Operation) => {
const dispatchOperation = (actionInfo: ActionType, operation: Operation) => {
setOperation(operation);

dispatch(push([basePath, (actionInfo as any)._id, operation.action].join("/")));
Expand Down
8 changes: 4 additions & 4 deletions packages/react-formio-container/src/hooks/useForm.hook.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import {
AuthState,
deleteForm,
FormSchema,
FormType,
getForm as getFormAction,
oneOfIsActive,
receiveForm,
Expand Down Expand Up @@ -99,7 +99,7 @@ export function useForm(props: UseFormProps) {
form._id && dispatch(deleteForm(formType, form._id, onRemoveDone));
};

const duplicateForm = (form: Partial<FormSchema>) => {
const duplicateForm = (form: Partial<FormType>) => {
dispatch(receiveForm(formType, { ...form, _id: undefined }));
dispatch(push(`${basePath}/create`));
onSuccess({
Expand All @@ -110,7 +110,7 @@ export function useForm(props: UseFormProps) {
});
};

const onSaveDone = async (err: Error | null, updatedForm: FormSchema) => {
const onSaveDone = async (err: Error | null, updatedForm: FormType) => {
if (!err) {
dispatch(refreshForms(formType));

Expand All @@ -133,7 +133,7 @@ export function useForm(props: UseFormProps) {
}
};

const saveForm = (form: Partial<FormSchema>) => {
const saveForm = (form: Partial<FormType>) => {
onSubmitForm(type, form);
dispatch(saveFormAction(type, form, onSaveDone));
};
Expand Down
6 changes: 3 additions & 3 deletions packages/react-formio-container/src/hooks/useForms.hook.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { FormSchema, FormsState, getForms, Operation, selectRoot } from "@tsed/react-formio-stores";
import { FormsState, FormType, getForms, Operation, selectRoot } from "@tsed/react-formio-stores";
import { push } from "connected-react-router";
import { useCallback, useEffect, useState } from "react";
import { useDispatch, useSelector } from "react-redux";
Expand All @@ -23,9 +23,9 @@ export function useForms(props: UseFormsProps) {
const { error, data, isActive, parameters } = useSelector((state) => selectRoot<FormsState>(formType, state));
const setParameters = useQuery(fetch, parameters);
const [operation, setOperation] = useState<Operation>();
const [currentData, setCurrentData] = useState<FormSchema>();
const [currentData, setCurrentData] = useState<FormType>();

const dispatchOperation = (data: FormSchema, operation: Operation) => {
const dispatchOperation = (data: FormType, operation: Operation) => {
setOperation(operation);
setCurrentData(currentData);
dispatch(push([basePath.replace(":formType", formType), data._id, operation.action].join("/")));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import {
selectIsActive,
selectRoot,
selectSubmission,
Submission
SubmissionType
} from "@tsed/react-formio-stores";
import { push } from "connected-react-router";
import noop from "lodash/noop";
Expand Down Expand Up @@ -82,7 +82,7 @@ export function useSubmission(props: UseSubmissionProps) {
submissionId && dispatch(deleteSubmission(submissionType, formId, submissionId, onRemoveDone));
};

const onSaveDone = async (err: Error | null, updatedSubmission: Submission) => {
const onSaveDone = async (err: Error | null, updatedSubmission: SubmissionType) => {
if (!err) {
onSuccess({
name: `${submissionAction}:${submissionType}`,
Expand All @@ -104,7 +104,7 @@ export function useSubmission(props: UseSubmissionProps) {
}
};

const saveSubmission = (submission: Submission) => {
const saveSubmission = (submission: SubmissionType) => {
onSubmitSubmission(submissionType, formId, submission);
dispatch(saveSubmissionAction(submissionType, formId, submission, onSaveDone));
};
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { getSubmissions, Operation, selectAuth, selectForm, selectRoot, Submission, SubmissionsState } from "@tsed/react-formio-stores";
import { getSubmissions, Operation, selectAuth, selectForm, selectRoot, SubmissionsState, SubmissionType } from "@tsed/react-formio-stores";
import { push } from "connected-react-router";
import { useCallback, useEffect, useState } from "react";
import { useDispatch, useSelector } from "react-redux";
Expand Down Expand Up @@ -28,9 +28,9 @@ export function useSubmissions(props: UseSubmissionsProps) {

const setParameters = useQuery(fetch, parameters);
const [operation, setOperation] = useState<Operation>();
const [currentData, setCurrentData] = useState<Submission>();
const [currentData, setCurrentData] = useState<SubmissionType>();

const dispatchOperation = (data: Submission, operation: Operation) => {
const dispatchOperation = (data: SubmissionType, operation: Operation) => {
setOperation(operation);
setCurrentData(currentData);
dispatch(push([basePath, data._id, operation.action].join("/")));
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { FormSchema, Submission } from "@tsed/react-formio";
import { FormType, SubmissionType } from "@tsed/react-formio";

import { FormRoute } from "../views/form.routes";

Expand Down Expand Up @@ -54,8 +54,8 @@ export interface FormioContainerOptions extends Record<string, unknown> {
* Handler called when an event is an error
*/
onError?: FormioErrorHandler;
onSubmitForm?: (type: string, form: FormSchema) => void;
onSubmitSubmission?: (submissionType: string, formId: string, submission: Submission) => void;
onSubmitForm?: (type: string, form: FormType) => void;
onSubmitSubmission?: (submissionType: string, formId: string, submission: SubmissionType) => void;
/**
* i18n function to translate sentences
*/
Expand Down
8 changes: 4 additions & 4 deletions packages/react-formio-container/src/utils/ExportClient.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { FormSchema } from "@tsed/react-formio";
import { FormType } from "@tsed/react-formio";
import FileSaver from "file-saver";
import moment from "moment";

Expand All @@ -8,12 +8,12 @@ async function getDatabase() {
return httpClient.get("/export");
}

async function exportForm(form: FormSchema) {
async function exportForm(form: FormType) {
const database = await getDatabase();
return database.forms[form.machineName!] || database.resources[form.machineName!];
}

async function exportActions(form: FormSchema) {
async function exportActions(form: FormType) {
const database = await getDatabase();

return Object.entries(database.actions).reduce((obj, [machineName, action]) => {
Expand All @@ -25,7 +25,7 @@ async function exportActions(form: FormSchema) {
}, {});
}

async function getContent(form: FormSchema, type: string, format = "json") {
async function getContent(form: FormType, type: string, format = "json") {
let result;
console.log(form, type, format);
switch (type) {
Expand Down
6 changes: 3 additions & 3 deletions packages/react-formio-container/src/views/form.routes.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { TabsItemProps } from "@tsed/react-formio";
import { AuthState, checkRoleFormAccess, FormSchema } from "@tsed/react-formio-stores";
import { AuthState, checkRoleFormAccess, FormType } from "@tsed/react-formio-stores";
import { ComponentType } from "react";

import { FormAccessView } from "./formAccess.view";
Expand All @@ -16,15 +16,15 @@ export interface FormRoute<User = any> extends TabsItemProps, Record<string, unk
component?: ComponentType<any>;
roles?: string[];

when?(ctx: { formAction: string; auth: AuthState<User>; form: Partial<FormSchema>; item: FormRoute }): boolean;
when?(ctx: { formAction: string; auth: AuthState<User>; form: Partial<FormType>; item: FormRoute }): boolean;
}

export interface FormRoutesOptions<User = any> {
formRoutes: FormRoute[];
operationsSettings: Record<string, boolean>;
formAction: string;
auth: AuthState<User>;
form: Partial<FormSchema>;
form: Partial<FormType>;
}

export const defaultFormRoutes: FormRoute[] = [
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import formSchema from "../__fixtures__/form-schema.json";
import FormType from "../__fixtures__/form-schema.json";
import formSubmissions from "../__fixtures__/form-submissions.json";
import { SubmissionsComponent } from "./submissions.view";

Expand All @@ -22,6 +22,6 @@ export const Sandbox = (args: any) => {
};

Sandbox.args = {
form: formSchema,
form: FormType,
data: formSubmissions
};
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import type { ActionSchema } from "@tsed/react-formio";
import type { ActionType } from "@tsed/react-formio";
import { createReducer, InitialStateCreator } from "@tsed/redux-utils";

import { failActionInfo, receiveActionInfo, requestActionInfo, resetActionInfo } from "./action-info.actions";
import { ACTION_INFO } from "./action-info.constant";

export interface ActionInfoState {
error: null | Error;
data?: Partial<ActionSchema>;
data?: Partial<ActionType>;
isActive: boolean;
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
import type { ActionSchema } from "@tsed/react-formio";
import type { ActionType } from "@tsed/react-formio";

import { selectRoot } from "../root";
import { ACTION_INFO } from "./action-info.constant";
import { ActionInfoState } from "./action-info.reducers";

export const selectActionInfo = (state: Record<string, any>): Partial<ActionSchema> =>
selectRoot<ActionInfoState>(ACTION_INFO, state).data!;
export const selectActionInfo = (state: Record<string, any>): Partial<ActionType> => selectRoot<ActionInfoState>(ACTION_INFO, state).data!;
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import type { ActionSchema } from "@tsed/react-formio";
import type { ActionType } from "@tsed/react-formio";
import { createReducer, InitialStateCreator } from "@tsed/redux-utils";

import { clearActionError, failAction, receiveAction, requestAction, resetAction, sendAction } from "./action.actions";
import { ACTION } from "./action.constant";

export interface ActionState {
error: null | Error;
data: ActionSchema;
data: ActionType;
isActive: boolean;
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type { ActionSchema } from "@tsed/react-formio";
import type { ActionType } from "@tsed/react-formio";

import { selectRoot } from "../root";
import { ACTION } from "./action.constant";
import { ActionState } from "./action.reducers";

export const selectAction = (state: Record<string, any>): ActionSchema => selectRoot<ActionState>(ACTION, state).data;
export const selectAction = (state: Record<string, any>): ActionType => selectRoot<ActionState>(ACTION, state).data;
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import type { ActionInfoSchema, ActionSchema } from "@tsed/react-formio";
import type { ActionInfoType, ActionType } from "@tsed/react-formio";
import { createReducer, InitialStateCreator } from "@tsed/redux-utils";

import { failActions, receiveActions, requestActions, resetActions } from "./actions.actions";
import { ACTIONS } from "./actions.constant";

export interface ActionsState {
error: null | Error;
data: ActionSchema[];
availableActions: ActionInfoSchema[];
data: ActionType[];
availableActions: ActionInfoType[];
isActive: boolean;
}

Expand Down
8 changes: 4 additions & 4 deletions packages/react-formio-stores/src/stores/auth/auth.actions.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import type { FormSchema, RoleSchema, Submission } from "@tsed/react-formio";
import type { FormType, RoleType, SubmissionType } from "@tsed/react-formio";
import { createAction } from "@tsed/redux-utils";

export const requestUser = createAction();
export const receiveUser = createAction<{ user: Submission }>();
export const receiveUser = createAction<{ user: SubmissionType }>();
export const failUser = createAction<{ error: Error }>();
export const logoutUser = createAction();
export const submissionAccessUser = createAction<{ submissionAccess: any }>();
export const formAccessUser = createAction<{ formAccess: any }>();
export const projectAccessUser = createAction<{ projectAccess: any }>();
export const userRoles = createAction<{ roles: Record<string, RoleSchema> }>();
export const userForms = createAction<{ forms: Record<string, FormSchema> }>();
export const userRoles = createAction<{ roles: Record<string, RoleType> }>();
export const userForms = createAction<{ forms: Record<string, FormType> }>();
10 changes: 5 additions & 5 deletions packages/react-formio-stores/src/stores/auth/auth.reducers.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { FormSchema, RoleSchema, Submission } from "@tsed/react-formio";
import type { FormType, RoleType, SubmissionType } from "@tsed/react-formio";
import { createReducer } from "@tsed/redux-utils";

import {
Expand All @@ -17,13 +17,13 @@ import { AUTH } from "./auth.constant";
export interface AuthState<User = any> {
init: boolean;
isActive: boolean;
user: null | Submission<User>;
user: null | SubmissionType<User>;
authenticated: boolean;
projectAccess: Record<string, string[]>;
formAccess: Record<string, string[]>;
submissionAccess: Record<string, string[]>;
roles: Record<string, RoleSchema>;
forms: Record<string, FormSchema>;
roles: Record<string, RoleType>;
forms: Record<string, FormType>;
is: Record<string, boolean>;
error: null | Error;
}
Expand Down Expand Up @@ -54,7 +54,7 @@ function mapProjectRolesToUserRoles(projectRoles: Record<string, any>, userRoles
);
}

function getUserRoles(projectRoles: Record<string, RoleSchema>) {
function getUserRoles(projectRoles: Record<string, RoleType>) {
return Object.keys(projectRoles).reduce(
(result, name) => ({
...result,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { RoleSchema, Submission } from "@tsed/react-formio";
import type { RoleType, SubmissionType } from "@tsed/react-formio";
import get from "lodash/get";

import { selectRoot } from "../root";
Expand All @@ -7,8 +7,8 @@ import { AuthState } from "./auth.reducers";

export const selectAuth = (state: any) => selectRoot<AuthState>(AUTH, state);

export const selectUser = <User = any>(state: any): null | Submission<User> => get(selectAuth(state), "user");
export const selectUser = <User = any>(state: any): null | SubmissionType<User> => get(selectAuth(state), "user");

export const selectRoles = (state: any): Record<string, RoleSchema> => get(selectAuth(state), "roles");
export const selectRoles = (state: any): Record<string, RoleType> => get(selectAuth(state), "roles");

export const selectIsAuthenticated = (state: any): boolean => get(selectAuth(state), "authenticated");
Loading

0 comments on commit 0380a06

Please sign in to comment.