[FS-280]: Cycle 39 Maintenance

.eslintrc.js

@@ -5,12 +5,12 @@ module.exports = init({
   modules: {
     auto: true,
     esm: true,
+    disableExpensiveRules: !process.env.CI && !process.env.HUSKY,
     typescript: {
       parserProject: ['./tsconfig.eslint.json'],
       resolverProject: ['./tsconfig.json'],
     },
   },
-  extends: ['plugin:@cspell/recommended'],
   rules: {
     // NOTE: https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/no-unused-prop-types.md#known-issueslimitations
     'react/no-unused-prop-types': 'off',
@@ -25,14 +25,5 @@ module.exports = init({
         'node/prefer-global/buffer': 'off',
       },
     },
-    {
-      files: ['./**/*.stories.tsx', './**/*.cy.tsx'],
-      rules: {
-        '@typescript-eslint/no-confusing-void-expression': 'off',
-        'react/jsx-no-useless-fragment': 'off',
-        'react-hooks/rules-of-hooks': 'off',
-        'storybook/no-title-property-in-meta': 'off',
-      },
-    },
   ],
 });

app/main.tsx

@@ -1,5 +1,5 @@
 import 'dayjs/locale/fa';
-import '@camp/zod-addons';
+import '@camp/zod-addons/monkey-patch';
 
 import { ApolloProvider } from '@camp/api-client';
 import { AuthProvider } from '@camp/auth';

configs/husky/pre-commit

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-pnpm exec lint-staged
+HUSKEY=1 pnpm exec lint-staged

configs/husky/pre-push

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-pnpm run verify
+HUSKEY=1 pnpm run verify

cypress.config.ts

@@ -1,26 +1,58 @@
-import { getBooleanEnv, getEnv, toInteger } from '@fullstacksjs/toolbox';
+import { Config } from '@fullstacksjs/config';
 import { defineConfig } from 'cypress';
 import viteProcessor from 'cypress-vite';
 
 import { config } from './vite.config';
 
-const port = toInteger(getEnv('PORT', ''), 3000);
-const host = getEnv('HOST', 'localhost');
+const envs = new Config({
+  retries: Config.number({ default: 1 }),
+  cypress: Config.object({
+    port: Config.number({ default: 3000 }),
+    host: Config.string({ default: 'localhost' }),
+    retries: Config.number({ default: 1 }),
+    video: Config.boolean({ default: true }),
+  }),
+  auth0: Config.object({
+    audience: Config.string().required(),
+    domain: Config.string().required(),
+    clientId: Config.string().required(),
+  }),
+  api: Config.object({
+    endpoint: Config.string().required(),
+    secret: Config.string().required(),
+  }),
+}).parse({
+  cypress: {
+    port: process.env.PORT,
+    host: process.env.HOST,
+    retries: process.env.CYPRESS_RETRIES,
+    video: process.env.CYPRESS_RECORD_VIDEO,
+  },
+  auth0: {
+    audience: process.env.APP_AUTH0_AUDIENCE,
+    domain: process.env.APP_AUTH0_DOMAIN,
+    clientId: process.env.APP_AUTH0_CLIENT_ID,
+  },
+  api: {
+    endpoint: process.env.APP_API_ENDPOINT,
+    secret: process.env.APP_HASURA_ADMIN_SECRET,
+  },
+});
 
 export default defineConfig({
   e2e: {
-    retries: toInteger(getEnv('CYPRESS_RETRIES', '1')),
-    baseUrl: `https://${host}:${port}`,
+    retries: envs.get('cypress.retries'),
+    baseUrl: `https://${envs.get('cypress.host')}:${envs.get('cypress.port')}`,
     projectId: '8jt3ix',
-    video: getBooleanEnv('CYPRESS_RECORD_VIDEO', true),
+    video: envs.get('cypress.video'),
     defaultCommandTimeout: 10000,
     experimentalMemoryManagement: true,
     env: {
-      APP_AUTH0_AUDIENCE: getEnv('APP_AUTH0_AUDIENCE'),
-      APP_AUTH0_DOMAIN: getEnv('APP_AUTH0_DOMAIN'),
-      APP_AUTH0_CLIENT_ID: getEnv('APP_AUTH0_CLIENT_ID'),
-      APP_API_ENDPOINT: getEnv('APP_API_ENDPOINT'),
-      APP_HASURA_ADMIN_SECRET: getEnv('APP_HASURA_ADMIN_SECRET'),
+      APP_AUTH0_AUDIENCE: envs.get('auth0.audience'),
+      APP_AUTH0_DOMAIN: envs.get('auth0.domain'),
+      APP_AUTH0_CLIENT_ID: envs.get('auth0.clientId'),
+      APP_API_ENDPOINT: envs.get(`api.endpoint`),
+      APP_HASURA_ADMIN_SECRET: envs.get('api.secret'),
     },
     setupNodeEvents(on) {
       on('file:preprocessor', viteProcessor());

cypress/e2e/draftHouseholder.cy.ts

@@ -1,4 +1,4 @@
-import { pruneUndefinedOrEmpty } from '@fullstacksjs/toolbox';
+import { isNull, pruneValueWhen } from '@fullstacksjs/toolbox';
 
 import { householderFormIds as ids } from '../../app/Dashboard/Households/HouseholdDetail/_components/HouseholderForm/HouseholderForm.ids';
 import { householdDetailIds as tabIds } from '../../app/Dashboard/Households/HouseholdDetail/HouseholdDetail.ids';
@@ -66,7 +66,7 @@ describe('Householder', () => {
   });
 
   it('[OK]: Admin wants to add householder information', () => {
-    const mock = pruneUndefinedOrEmpty(householderFixture());
+    const mock = pruneValueWhen(householderFixture(), isNull);
     addHouseholder(mock);
   });
 
@@ -77,7 +77,7 @@ describe('Householder', () => {
   });
 
   it('[OK]: Admin wants to undo changes after editing form', () => {
-    const mock = pruneUndefinedOrEmpty(householderFixture());
+    const mock = pruneValueWhen(householderFixture(), isNull);
 
     addHouseholder(mock);
     cy.findByTestId(ids.editBtn, { timeout: 1e4 }).click();
@@ -87,7 +87,7 @@ describe('Householder', () => {
   });
 
   it('[OK]: Admin wants to revisit householder information', () => {
-    const mock = pruneUndefinedOrEmpty(householderFixture());
+    const mock = pruneValueWhen(householderFixture(), isNull);
     addHouseholder(mock);
     cy.reload();
     compareHouseholderForm(mock);

docs/Glossary.md

@@ -11,16 +11,18 @@ The project glossary is a collection of terms captured from models and shapes th
 
 ## Terms
 
-| Term             | Definition                                                                                                 |
-| ---------------- | ---------------------------------------------------------------------------------------------------------- |
+| Term                | Definition                                                                                                    |
+| ------------------- | ------------------------------------------------------------------------------------------------------------- |
 | Household           | a term used for a group of Members under support. a Household must have a Householder.                        |
-| Dependent        | a Member who falls under the support of a Householder.                                                     |
-| Householder      | a Member who provides emotional and financial support to a Household.                                         |
-| Need             | Cash or non-cash support that a Household or Group of Families needs.                                         |
-| Caseworker       | a person involved in directly considering the individual case's problems, needs, and adjustments.          |
-| Project          | the predefined program of aiding a Household or group of Families with money, properties, or material goods.  |
-| Loan             | a loan is money given to a Household in exchange for future repayment of the loan value amount with interest. |
-| Member           | a Householder or a Dependent                                                                               |
-| Project Gallery  | a gallery of the pictures of a Project                                                                     |
+| Dependent           | a Member who falls under the support of a Householder.                                                        |
+| Householder         | a Member who provides emotional and financial support to a Household.                                         |
+| Need                | Cash or non-cash support that a Household or Group of Families needs.                                         |
+| Caseworker          | a person involved in directly considering the individual case's problems, needs, and adjustments.             |
+| Project             | the predefined program of aiding a Household or group of Families with money, properties, or material goods.  |
+| Loan                | a loan is money given to a Household in exchange for future repayment of the loan value amount with interest. |
+| Member              | a Householder or a Dependent which belongs to a Household                                                     |
+| Project Gallery     | a gallery of the pictures and documents of a Project                                                          |
 | Draft Household     | A saved Household which is not completed yet.                                                                 |
 | Completed Household | A Household in which all information is provided and submitted.                                               |
+| Visit               | An assessment by a caseworker at a beneficiary's household to evaluate their living conditions and needs.     |
+| Accommodation Type  | A classification indicating whether a household owns or rents their dwelling                                  |

libs/data-layer/operations/fragments/scalar.mapper.ts

@@ -1,4 +1,4 @@
-import type { Nullish } from '@fullstacksjs/toolbox';
+import type { Nullable } from '@fullstacksjs/toolbox';
 
-export const toDate = (d: Nullish | string) => (d ? new Date(d) : undefined);
+export const toDate = (d: Nullable<string>) => (d ? new Date(d) : undefined);
 export const toApiDate = (d: Date): string => d.toISOString().split('T')[0]!;

libs/data-layer/operations/queries/useHouseholdListQuery.ts

@@ -3,7 +3,7 @@ import type { QueryHookOptions } from '@camp/api-client';
 import { useQuery } from '@camp/api-client';
 import type { HouseholdKeys, HouseholdListItem } from '@camp/domain';
 import { ApiOrderBy } from '@camp/domain';
-import type { Nullish } from '@fullstacksjs/toolbox';
+import type { Nullable } from '@fullstacksjs/toolbox';
 import { isEmpty, isNotNull } from '@fullstacksjs/toolbox';
 import type { PaginationState, SortingState } from '@tanstack/react-table';
 
@@ -40,7 +40,7 @@ export const HouseholdListDocument = gql`
 
 export interface HouseholdListDto {
   household: (HouseholdKeys & HouseholdListItem)[];
-  totalCount: Nullish | number;
+  totalCount: Nullable<number>;
 }
 
 const toClient = (data: ApiHouseholdListQuery | null): HouseholdListDto => {

libs/data-layer/operations/queries/useHouseholdQuery.ts

@@ -6,7 +6,7 @@ import type {
   ApiHouseholdQueryVariables,
 } from '@camp/data-layer';
 import type { HouseholdDetail, HouseholdKeys } from '@camp/domain';
-import type { Nullish } from '@fullstacksjs/toolbox';
+import type { Nullable } from '@fullstacksjs/toolbox';
 
 import {
   getHouseholdDetail,
@@ -27,14 +27,14 @@ export const HouseholdDocument = gql`
 `;
 
 export interface HouseholdDto {
-  household: Nullish | (HouseholdDetail & HouseholdKeys);
+  household: Nullable<HouseholdDetail & HouseholdKeys>;
 }
 
 interface Variables {
   id: string;
 }
 
-const toClient = (data: ApiHouseholdQuery | Nullish): HouseholdDto => {
+const toClient = (data: Nullable<ApiHouseholdQuery>): HouseholdDto => {
   return {
     household: data?.household_by_pk
       ? {

libs/data-layer/operations/queries/useHouseholderQuery.ts

@@ -6,7 +6,7 @@ import type {
   ApiHouseholderQueryVariables,
 } from '@camp/data-layer';
 import type { HouseholderIdentity, HouseholderKeys } from '@camp/domain';
-import type { Nullish } from '@fullstacksjs/toolbox';
+import type { Nullable } from '@fullstacksjs/toolbox';
 
 import {
   getHouseholderIdentity,
@@ -34,7 +34,7 @@ interface Variables {
   id: string;
 }
 
-const toClient = (data: ApiHouseholderQuery | Nullish): HouseholderDto => {
+const toClient = (data: Nullable<ApiHouseholderQuery>): HouseholderDto => {
   return {
     householder: data?.householder_by_pk
       ? {

libs/data-layer/operations/queries/useMemberListQuery.ts

@@ -2,7 +2,7 @@ import { gql } from '@apollo/client';
 import type { QueryHookOptions } from '@camp/api-client';
 import { useQuery } from '@camp/api-client';
 import type { Member } from '@camp/domain';
-import type { Nullish } from '@fullstacksjs/toolbox';
+import type { Nullable } from '@fullstacksjs/toolbox';
 
 import type {
   ApiMemberListQuery,
@@ -41,7 +41,7 @@ export interface MemberList {
   members: Member[];
 }
 
-const toClient = (data: ApiMemberListQuery | Nullish) => {
+const toClient = (data: Nullable<ApiMemberListQuery>) => {
   const members = data?.member;
   if (members == null) return null;
   return {

libs/data-layer/operations/queries/useProjectListQuery.ts

@@ -6,7 +6,7 @@ import type {
   ApiProjectListQueryVariables,
 } from '@camp/data-layer';
 import type { ProjectKeys, ProjectListItem } from '@camp/domain';
-import type { Nullish } from '@fullstacksjs/toolbox';
+import type { Nullable } from '@fullstacksjs/toolbox';
 
 import {
   getProjectKeys,
@@ -37,7 +37,7 @@ export interface ProjectList {
   projects: (ProjectKeys & ProjectListItem)[];
 }
 
-const toClient = (data: ApiProjectListQuery | Nullish): ProjectList => {
+const toClient = (data: Nullable<ApiProjectListQuery>): ProjectList => {
   const projects = data?.project_aggregate.nodes;
 
   return {

libs/data-layer/operations/queries/useProjectQuery.ts

@@ -11,7 +11,7 @@ import type {
   ProjectDetail,
   ProjectKeys,
 } from '@camp/domain';
-import type { Nullish } from '@fullstacksjs/toolbox';
+import type { Nullable } from '@fullstacksjs/toolbox';
 
 import {
   getHouseholdDetail,
@@ -52,7 +52,7 @@ export interface Variables {
   id: string;
 }
 
-const toClient = (data: ApiProjectQuery | Nullish): ProjectDto => {
+const toClient = (data: Nullable<ApiProjectQuery>): ProjectDto => {
   const project = data?.project_by_pk;
 
   return {

libs/debug/Debug.ts

@@ -1,6 +1,5 @@
 import type { Tuple } from '@fullstacksjs/toolbox';
 
-/* eslint-disable @typescript-eslint/no-empty-function */
 export type LogLevel = 'error' | 'info' | 'silent' | 'trace' | 'warn';
 
 export interface Logger {

libs/design/FileUpload/FileList.tsx

@@ -1,4 +1,4 @@
-import { isNullOrEmpty } from '@fullstacksjs/toolbox';
+import { isNullOrEmptyArray } from '@fullstacksjs/toolbox';
 import { Box } from '@mantine/core';
 
 import { File } from './File';
@@ -10,7 +10,7 @@ interface Props {
 }
 
 export const FileList = ({ files, onRemove }: Props) => {
-  if (isNullOrEmpty(files)) return null;
+  if (isNullOrEmptyArray(files)) return null;
 
   return (
     <Box>

libs/design/FileUpload/FileSelect.tsx

@@ -1,7 +1,7 @@
+import { UploadIcon } from '@camp/icons';
 import { messages } from '@camp/messages';
 import { Button, Group, Text } from '@mantine/core';
 import { forwardRef } from 'react';
-import { Upload } from 'react-feather';
 
 interface Props extends Omit<React.HTMLProps<HTMLInputElement>, 'onClick'> {
   onClick?: React.MouseEventHandler<HTMLButtonElement>;
@@ -23,7 +23,7 @@ export const FileSelect = forwardRef<HTMLInputElement, Props>(
             color: props.disabled ? theme.colors.fg[4] : theme.colors.fg[5],
           })}
         >
-          <Upload />
+          <UploadIcon />
           <Text size="sm">{t.note}</Text>
         </Group>
       </Group>

libs/design/Select/ControlledSelect.tsx

@@ -1,4 +1,4 @@
-import type { Nullish } from '@fullstacksjs/toolbox';
+import type { Nullable } from '@fullstacksjs/toolbox';
 import type { Control, FieldValues, Path, PathValue } from 'react-hook-form';
 import { Controller } from 'react-hook-form';
 
@@ -8,7 +8,7 @@ import { Select } from './Select';
 interface Props<T extends FieldValues> extends SelectProps {
   name: Path<T>;
   control: Control<T>;
-  presentation?: (value: Nullish | PathValue<T, Path<T>>) => JSX.Element;
+  presentation?: (value: Nullable<PathValue<T, Path<T>>>) => JSX.Element;
 }
 
 export const ControlledSelect = <T extends FieldValues>({

libs/design/theme/theme.ts

@@ -36,8 +36,6 @@ export const theme: MantineThemeOverride = {
       backgroundColor: palette.secondary.default,
       borderRadius: '4px',
     },
-
-    /* eslint-enable @typescript-eslint/naming-convention */
   }),
   dir: 'rtl',
   fontFamily: 'IRANSansFaNum, IRANSans',

libs/domain/Household.ts

@@ -1,8 +1,8 @@
 import { messages } from '@camp/messages';
+import { toZodLiteralList } from '@camp/zod-addons';
 import { createColumnHelper } from '@tanstack/react-table';
 import { z } from 'zod';
 
-import { toZodLiteralList } from '../zod-addons';
 import type { HouseholdStatusEnum } from './ApiSchema';
 import { HouseholdSeverityEnum } from './ApiSchema';
 

libs/domain/Schema.ts

@@ -1,7 +1,7 @@
 import { messages } from '@camp/messages';
+import { toZodLiteralList } from '@camp/zod-addons';
 import { z } from 'zod';
 
-import { toZodLiteralList } from '../zod-addons';
 import { cities } from './City';
 import { genders } from './Gender';
 import { nationalities } from './Nationality';

libs/icons/index.ts

@@ -17,5 +17,6 @@ export {
   Users as PeopleIcon,
   Plus as PlusIcon,
   Trash2 as TrashIcon,
+  Upload as UploadIcon,
   User as UserIcon,
 } from 'react-feather';