worxid / worx Goto Github PK

Description

Add from and to parameters to enable the filter function in the search API.

To-do list

• Form Template Search API. The "from" and "to" parameters will be compared to the created date field.
• Submission Search API. The "from" and "to" parameters will be compared to the submitted date field.
• Disable the date filter.

Description

Convert this template class as an HTML file to read from resources/templates.

Convert to HTML file

Please also implement this form share template

Related Issue(s)

Reference

Blocker

• (Maybe) #83

Description

Duplicate implementation with EmailService.java. Please remove one and refactor the entire class.

Related Issue(s)

Reference

Blocker

• (Maybe) #82

Description

Form Builder module.

To-do List

• #21
• Implement Form Builder CRUD API (web)

Description

Separate all APIs for guest users, including the file and share API.

Description

Update Form Submission Search API request body to provide filter feature by source parameter.

Current Request Body

{
  "label": "string",
  "description": "string",
  "createdOn": "2022-11-21T02:27:06.089Z",
  "modifiedOn": "2022-11-21T02:27:06.089Z",
  "submitDate": "2022-11-21T02:27:06.089Z",
  "from": "2022-11-21T02:27:06.089Z",
  "to": "2022-11-21T02:27:06.089Z",
  "template_id": 0,
  "submit_address": "string",
  "respondent_label": "string",
  "global_search": "string"
}

Expected Request Body

{
  "label": "string",
  "description": "string",
  "from": "2022-11-21T02:27:06.089Z",
  "to": "2022-11-21T02:27:06.089Z",
  "template_id": 0,
  "submit_address": "string",
  "source": {
      "type": "MOBILE_APP",
      "label": "string"
  },
  "global_search": "string"
}

• Omit unused date fields (created_on, modified_on, and submit_date).
• Global search also takes effect on source_type and source_label fields.

Description

Implement messaging technology to provide notification features and realtime updates.

Description

Add User relation to FormTemplate entity. (ManyToOne)

• On create, assigne user to formtemplate.
• On fetch/get/search, check userId. -> need AuthContext.getUser()

Description

Remove the @NotEmpty annotation on the fields field to accommodate empty form creation.

Expectation

The API should accept this request body example.

{
  "label": "My New Empty Form",
  "description": "New Form with empty fields",
  "fields": [ ],
  "submit_in_zone": true,
  "default": false
}

Description

Create GET API for a single file or multiple files. It returns a File response, including the URL (presigned URL) and the File stats.

Specification

• Web, Authenticated by Token
  GET /media/files

Request body

{
    "file_ids": [ 1, 2, 3]
}

Response, UrlPresignedResponse

{
    "status": true
    "list": [
        {
            "
        }
    ]
}

• Mobile

Related File(s)

• FileStorageService

  worx/application/src/main/java/id/worx/worx/service/storage/FileStorageService.java

  Lines 1 to 28 in b6cf9fa

  	package id.worx.worx.service.storage;
  	import java.text.DateFormat;
  	import java.text.SimpleDateFormat;
  	import java.util.Date;
  	import id.worx.worx.common.model.response.UrlPresignedResponse;
  	public interface FileStorageService {
  	void store();
  	UrlPresignedResponse getUploadUrl(String filename);
  	UrlPresignedResponse getUploadUrl(Long fileId);
  	UrlPresignedResponse getDownloadUrl(Long fileId);
  	boolean isObjectExist(String path);
  	long getObjectSize(String path);
  	default String generateUniquePath(String filename, String foldername) {
  	DateFormat writeFormat = new SimpleDateFormat("yyyy/MM/dd/HH/mm/ss");
  	return String.format("%s/%s/%s", foldername.toLowerCase(), writeFormat.format(new Date()), filename);
  	}
  	}

This issue is just documentation.

Deployed app: https://dev.worx.id/sign-in

List of licenses:

• base component: MUI
• base Data Grid component: MUI Data Grid
• country list: DannMolina's country list JSON object

JSON object form:

Component Design: https://whimsical.com/sketch-3aN9P3fud7mpb1hWt4A4w3

{
  label: 'Eksplor - 2',
  description: 'Contoh Deskripsi',
  submit_in_zone: true,
  default: true
  fields: [
    {...},
    {...},
    ...
  ],
}

JSON object form fields sample:

1. Text Field

{
  id: '7231942686725',
  label: 'Text field 1',
  description: 'description',
  required: true,
  type: 'text',
  minLength: 0,
  maxLength: 24,
}

2. Checkbox

{
  id: '23565229205',
  label: 'Checkboxes',
  description: 'description',
  required: false,
  minChecked: 1,
  maxChecked: 3,
  group: [
    {
      label: 'Option #1'
    },
    {
      label: 'Option #2'
    },
    {
      label: 'Option #3'
    }
  ],
  type: 'checkbox_group'
}

3. Radio Button

{
  id: '2356760777462',
  label: 'Radiobuttons',
  description: 'description',
  required: true,
  options: [
    {
      label: 'Option #1'
    },
    {
      label: 'Option #2'
    },
    {
      label: 'Option #3'
    }
  ],
  type: 'radio_group'
}

4. Dropdown

{
  id: '2357109577409',
  label: 'Dropdown',
  description: 'description',
  required: false,
  options: [
    {
      label: 'Option #1'
    },
    {
      label: 'Option #2'
    },
    {
      label: 'Option #3'
    }
  ],
  type: 'dropdown'
}

5. Date

{
  id: '2357265606749',
  label: 'Date',
  description: 'description',
  required: false,
  disableFuture: false,
  disablePast: true,
  type: 'date'
}

6. Separator

{
  id: '23575153539',
  label: 'Separator',
  description: 'description',
  type: 'separator'
}

7. Rating

{
  id: '2357523970968',
  label: 'Rating',
  description: 'description',
  required: false,
  maxStars: 5,
  type: 'rating'
}

8. File

{
  id: '2357526469860',
  label: File',
  description: 'description',
  required: true,
  maxFiles: 6,
  maxFileSize: 10485760,
  minFileSize: 128,
  fileMinSizeType: 'MB',
  fileMaxSizeType: 'MB',
  allowedExtensions: [
    'csv',
    'doc',
    'docx'
  ],
  type: 'file'
}

9. Image

{
  id: '2357527652279',
  label: 'Image',
  description: 'description',
  required: false,
  maxFiles: 6,
  allowGalleryUpload: true,
  type: 'photo'
}

10. Signature

{
  id: '2357528685219',
  label: 'Signature',
  description: 'description',
  required: false,
  type: 'signature'
}

11. Time

12. Barcode

13. Sketch

14. Yes/No

15. Integer

Description

Device Module

To-do List

• #57
• #58
• #59
• #60
• #61

Description

Error Handling Module

To-do List

• Create error handling classes, including Worx error code enum definition, error handler class, and error response class.
• List current available error code enum.
• Create error response builder.
• Create validation error class for Form validation.

Description

Export API on the submission page. Download the last 1000 entries with all pre-signed URLs for each file—download option as CSV or Xls.

source;submission date;submission address;form label;form description;field 1;field 2;....
web browser;20-09-2022 15:06:75;rumah sana;my form;my form description;isian 1;isian 2;...

Description

User Module

To-do List

• Create User table definition, entity class, and repository class
• Implement CRUD API on User entity
• Implement Auth API (sign up, sign in, logout)

Error 500, Karena nama attribute tidak sama dengan input yang dimasukan pada param sort.

Contoh:
https://api.dev.worx.id/groups/search?page=0&size=100&sort=name,desc

Description

File Module

To-do List

• Create file storage interface
• Create S3 compatible implementation (minio, etc)

User relation to Device entity, either with userId or by organization code.

• On create, assign user to device
• On fetch/get/search, check userId/organization code -> need authContext

Description

Implement Group Search API with Pagination. Please use the POST method and path groups/search.

Reference

• Form Template Search API

  worx/application/src/main/java/id/worx/worx/web/controller/FormTemplateController.java

  Lines 44 to 57 in ec53059

  	@PostMapping("search")
  	public ResponseEntity<Page<FormTemplateDTO>> search(
  	@RequestBody @Valid FormTemplateSearchRequest request,
  	@ParameterObject Pageable pageable) {
  	Page<FormTemplate> templates = templateService.search(request, pageable);
  	List<FormTemplateDTO> dtos = templates.stream()
  	.map(templateService::toDTO)
  	.collect(Collectors.toList());
  	Page<FormTemplateDTO> page = new BasePageResponse<>(dtos, templates.getPageable(), templates.getTotalElements());
  	return ResponseEntity.status(HttpStatus.OK)
  	.body(page);
  	}

• Form Template Submission Count Specification

  worx/application/src/main/java/id/worx/worx/service/specification/FormTemplateSpecification.java

  Lines 41 to 62 in 6d23779

  	public Specification<FormTemplate> submissionCountEqualTo(Integer submissionCount) {
  	return (root, query, cb) -> {
  	Root<FormTemplate> template = root;
  	Subquery<FormTemplate> subquery = query.subquery(FormTemplate.class);
  	Root<FormTemplate> subroot = subquery.from(FormTemplate.class);
  	Join<Form, FormTemplate> formSubmission = subroot.join(FormTemplate_.FORMS);
  	subquery.select(formSubmission.get(Form_.TEMPLATE).get(FormTemplate_.ID))
  	.groupBy(formSubmission.get(Form_.TEMPLATE).get(FormTemplate_.ID));
  	if (submissionCount.equals(0)) {
  	return cb.in(template.get(FormTemplate_.ID)).value(subquery).not();
  	}
  	subquery.having(
  	cb.equal(
  	cb.count(formSubmission.get(Form_.TEMPLATE).get(FormTemplate_.ID)),
  	submissionCount));
  	return cb.in(template.get(FormTemplate_.ID)).value(subquery);
  	};
  	}

• Having MySQL https://www.w3schools.com/sql/sql_having.asp

Description

Rework File API, use nanoid instead of file id on every transaction.

To-do List

• Add name, media_id, and original_name columns to File table. The original_name indicates its original filename, which will be submitted when the client asks for a pre-signed URL. The media_id is the generated id from the server. And the name column is the generated name from the server.
• Generate media_id and name with the nanoid library. The media_id format is {16 characters nanoid}. Then, the filename format is {media_id}.{file extension}

  worx/application/src/main/java/id/worx/worx/util/UrlUtils.java

  Lines 4 to 20 in 468b133

  	public class UrlUtils {
  	private static final char[] DEFAULT_ALPHABET = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
  	.toCharArray();
  	private UrlUtils() {
  	throw new IllegalStateException("Utility class");
  	}
  	public static String generateUrlCode() {
  	return NanoIdUtils.randomNanoId(
  	NanoIdUtils.DEFAULT_NUMBER_GENERATOR,
  	DEFAULT_ALPHABET,
  	NanoIdUtils.DEFAULT_SIZE);
  	}

• Change get (upload) pre-signed URL API for web (GET /media/presigned-url) and mobile (GET /mobile/media/presigned-url) flow to generate the media_id and the name value. Then, return FileResponse which contains all properties of File entity.

  {
    "id": 1,
    "media_id": "abcdefghijklmnop"
    "name": "abcdefghijklmnop.xls"
    "url": "{upload pre-signed url}",
    "path": "{media path}",
    "mime_type": "{mime_type}",
    "size": "{size}"
  }

• Change download pre-signed URL API for web (GET /media/files) and mobile (GET /mobile/media/download-presigned-url) parameter to use media_id instead of fileId. Then, return FileResponse which contains all properties of File entity.

This issue is just documentation for the code, format, folder, and file conventions.

1. Components:

• please use Material UI components as the core components
• please use Material UI Typography component to replace any HTML text elements such as h1, h2, h3, h4, h5, h6, and p
• please use Material UI Box component to replace any HTML container elements such as div and img

2. Styles:

• please use useStyles from makeStyles for static styles instead of plain CSS
• please only use sx prop for dynamic styles

3. File extension:

• please use .jsx for component files
• please use .js for style files

4. Global state management tool:

• please use React Context API instead of using Redux or React Redux

5. Branch:

• "develop" branch is the main branch for developing the app
• "master" is the branch for deploying the app into the development environment
• creating a new branch (your own working branch) must come from the "develop" branch
• every morning or every time before creating a pull request from your branch you should merge the main branch ("develop" branch) into your branch

6. Pull request:

• make sure there is no error/crash and fewer warning messages before you create a new pull request
• before the reviewers and assignees merge a pull request, make sure to test the pull request on their own local computer
• don't merge a pull request that contains errors/crashes
• please write every detail you made in each pull request

7. Environment keys:

• please copy and paste everything inside your .env into .env.example
• don't push the .env file into Git

8. Code writing:

• every variable, function, and file must be written in English
• give a brief comment for every function and component
• every color/background color style must be taken from theme, please don't write the hex code manually, and please don't access the color constant manually
• the components folder is only dedicated for the general components (components used by multiple pages)
• please sort by alphabet the "import statements" and don't forget to group them
• every spacing (padding or margin) and size (height or width) must be multiple of 4px
• don't write import React from 'react' because it's not needed
• styles inside useStyles from makeStyles are written top to bottom by the implementation order
• please write Icon first followed by the name for importing the icon from the MUI
• every asset from the Figma is exported using the same file format as the original asset

Resources:

1. Figma files: https://www.figma.com/file/ohODkjvYtsC2G4mwlwaC5k/Worx.id

form/{id}

refresh_tokens
email_tokens

Description

Implement User relations on Group entity. (Many to One)

• On create, assign user to group.
• On fetch/get/search, check userId. -> need AuthContext.getUser()

Description

Implement User Detail API to expose Organization Code.
API path user-details.

Expectation

Return request body

{
    "email": "[email protected]",
    "organization_name": "My Organization",
    "organization_code": "AFDA389",
    "country": "My country",
    "phone": "+26818283"
}

Description

Implement API to provide data to the Dashboard page.

API Specification

POST /dashboard-stats

Request parameter

Request Body

Structure

{
    "template_id": 2,
    "device_id": 2
}

{
    "template_id": 2
}

{
    "device_id": 2
}

Response

Structure

{
    "success": true,
    "list": [
        chartEntry1,
        chartEntry2
    ]
}

Chart Entry Structure

{
    "date": "yyyy-MM-dd",
    "count": 2
}

Description

Update deprecated SecurityConfiguration implementation.

Reference(s)

• https://spring.io/blog/2022/02/21/spring-security-without-the-websecurityconfigureradapter
• https://www.baeldung.com/spring-deprecated-websecurityconfigureradapter

Description

Merge the DeviceService.java and DeviceWebService.java classes. Keep the merged class with the name DeviceService.java.

Description

Implement Geocoder API. Use Google API provider.

geocoding.
reverse-geocoding.

Description

Implement Create New Team Mobile API.
This API is the mobile counterpart of this user register API /api/users/register.

Please also change all the deviceCode headers on all mobile controllers to use camel case (deviceCode instead of device_code).

Specification

POST /mobile/create-new-team (Separate controller)
Request body

{
  "fullname": "string",
  "password": "string",
  "email": "string",
  "phoneNo": "string",
  "country": "string",
  "organization_name": "string"
}

Description

Group Module

To-do List

• Create Group table definition, entity class, and repository class
• Implement CRUD API on Group entity