0.0.4 • Published 4 years ago
@opensrp/plan-form-core v0.0.4
PlanForm Core
Core functions and utilities that support the plan creation and editing activities. The main pieces exposed from here are:
- types: types defining the supported plan structure, supported form fields structure
- utility functions: Utilities that help parse form data and plan definition payloads to and fro, pieces not covered include any Form-implementation specific stuff e.g validating form fields, or utilities such as reading errors from a form
- constants: The plan structure defines a few constants that we re-expose for use in your projects, just to avoid duplication and trivial syntax errors
The intention for this package, is to serve as a common building block for several different user-facing form components that can create or edit opensrp plans.
Installation
yarn add @opensrp/planform-core
Usage
The 2 major helpers provided are:
generatePlanDefinition
getPlanFormValues(planObject: PlanDefinition,envConfigs?: Partial<EnvConfig>)
creates a plan defintion object from form values
getPlanFormValues
generatePlanDefinition(
formValue: PlanFormFields,
planObj: PlanDefinition | null = null,
isEditMode = false,
envConfigs?: Partial<EnvConfig>
): PlanDefinition
transform a planDefinition to form values object
Props/ Configuration
Some of the util functions exposed can optionally take a config object shaped as follows:
/** describes all possible configuration options */
export interface EnvConfig {
dateFormat: string;
defaultPlanDurationDays: number;
defaultPlanVersion: string;
enabledFiReasons: FIReasonType[];
planTypesAllowedToCreate: InterventionType[];
planTypesWithMultiJurisdictions: InterventionType[];
actionUuidNamespace: string;
planUuidNamespace: string;
defaultTime: string;
defaultActivityDurationDays: number;
displayedPlanTypes: InterventionType[];
taskGenerationStatus: taskGenerationStatusType;
}
Read the code
For more, and for specific details on what parameters all the above take, we encourage you to read the code. It is also just good practice.