1.8.0-rc.d7208b1 • Published 1 year ago

@opencrvs/toolkit v1.8.0-rc.d7208b1

Weekly downloads
-
License
MPL-2.0
Repository
-
Last release
1 year ago

OpenCRVS toolkit

OpenCRVS toolkit for building country configurations.

File structure

src/
  events/ # re-exports events module from commons package
  scopes/ # re-exports scopes module from commons package
  conditionals/ # provides tools for easily formulating complex conditionals and deduplication rules
  api/ # provides an API wrapper for OpenCRVS APIs with strict typing and validation

Getting started

Development using yarn link

# tsconfig.json references commons. when `tsc --build` is run, both are built.
> yarn build:all
# If you miss this part you might face issues with types.
> cd dist
> yarn link

Internal dependencies

When adding internal package as dependency, understand that:

  • Internal packages cannot be direct dependencies. Toolkit is published through npm, and dependency cannot be resolved.
  • Packages may have dependencies that require strict order of installation. Ensure installations are run in proper order in pipeline and scripts.

@opencrvs/events

Toolkit "re-exports" TRPC router to allow for easy client interaction.

@opencrvs/commons

Toolkit "re-exports" common definitions (e.g. events, conditionals) and make them available through npm.

Releasing and buiding

While developing

  1. Update version number in package.json
  2. yarn build:all
  3. npm publish

Through version control

  1. Update version number in package.json
  2. Create a pull request
  3. Once merged, github action will get triggered.

Gotchas, good to know

  • All dependencies of the functions and moduless used from packages/commons must be also defined in the package.json of the toolkit. Otherwise someone installing the package will get errors.
  • Package is published and should be used without knowledge of rest of the monorepo
  • Package exposes /events, /scopes directory, with types, from packages/commons through the library, others are excluded.
1.8.0-rc.805760

1 year ago

1.8.0-rc.267496

1 year ago

1.8.0-rc.64365

1 year ago

1.8.0-rc.726418

1 year ago

1.8.0-rc.647183

1 year ago

1.7.2

1 year ago

1.8.0-rc.112462

1 year ago

1.8.0-rc.934601

1 year ago

1.8.0-rc.340510

1 year ago

1.8.0-rc.246415

1 year ago

1.8.0-rc.291226

1 year ago

1.7.0-rc.285223

1 year ago

0.0.49-ml

1 year ago

1.7.0-rc.766554

1 year ago

0.0.47-jr

1 year ago

0.0.46-ml

1 year ago

0.0.45-ml

1 year ago

0.0.44-ml

1 year ago

0.0.43-ml

1 year ago

0.0.43-cb

1 year ago

0.0.42-ml

1 year ago

0.0.41-ml

1 year ago

0.0.40-ml

1 year ago

0.0.39-ml

1 year ago

0.0.38-jr

1 year ago

0.0.37-ml

1 year ago

0.0.36-ml

1 year ago

0.0.35-ml

1 year ago

0.0.34-rr

1 year ago

0.0.33-rr

1 year ago

0.0.33

1 year ago

0.0.32-jr

1 year ago

0.0.31-rr

1 year ago

0.0.30

1 year ago

0.0.30-rr

1 year ago

0.0.29-rr

1 year ago

0.0.28

1 year ago

0.0.22-scopes

1 year ago

0.0.18-events

1 year ago

0.0.17-events

1 year ago

0.0.16-events

1 year ago

0.0.14-events

1 year ago

0.0.13-events

1 year ago

0.0.12-events

1 year ago

0.0.11-events

1 year ago

0.0.10-events

1 year ago

0.0.9-events

1 year ago

0.0.8-events

1 year ago

0.0.8-scopes

2 years ago

0.0.7-scopes

2 years ago

0.0.7-events

2 years ago

0.0.6-events

2 years ago

0.0.5

2 years ago

0.0.4

2 years ago

0.0.3-alpha

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago

0.0.0

2 years ago