0.1.3 • Published 5 months ago

aqopi-summary-to-omniplan v0.1.3

Weekly downloads
-
License
SEE LICENSE IN LI...
Repository
-
Last release
5 months ago

Testing

The project is tested using unit tests. These tests are automatically executed before increasing the package version (using npm version) and before publishing, to ensure that things don't unexpectedly break between releases. The unit tests can be found in the test folder. Every .spec.ts file in the test folder is executed during a test.
To manually execute the tests run npm test.

Running a single test

You can run a single test by replacing: it('Should...' ()=>true) with: it.only('Should...' ()=>true)

Build

Builds are automatically executed before publishing and should not need to be done manually. If for whatever reason a manual build is required, a build can be executed by running npm run build.

Publishing

To publish a new version use: npm publish. This will build and publish the package to the npm repository and also deploy a new version to S3 (production). It is also possible to only deploy to S3, however this is to be avoided for production.
To only deploy to S3 use: npm run publish-s3 -- [--env <env>] [--profile <profile>]. Env is the target environment, acct for acceptance and prod for production, will default to acct.

Known issue, deploy script naar prod lijkt niet te werken.

using the library in the browser

<script src="https://parser-prod.aqopi.com/omniplan/aqopi-summary-to-omniplan.min.js"></script>

or

<script src="https://parser-acct.aqopi.com/omniplan/aqopi-summary-to-omniplan.min.js"></script>

...

// Get util
const AqopiSummaryToOmniplan = window.aqopi.omniplan;

// Generate Omniplan dossier
const dossier = await AqopiSummaryToOmniplan.transform(summary, partnerSummary);