An angular (13+) SDK for secure access to the LUSID® by FINBOURNE web API
npm install @finbourne/lusid-sdk-angular13lusid.json file
curl --output lusid.json -X GET https://www.lusid.com/api/swagger/v0/swagger.json
`
- Generate the files and build the project
`
docker compose -f docker-compose.yml up
`
- the built code will be in dist/lusid-sdk-angular13
- the generated files will be in projects\lusid-sdk-angular13\src\lib\.generated
- these files are not checked in to git.
- this can take a couple of minutes!
- if you get an error like generate.sh: line 2: $'\r': command not found you need to
- make sure your generate.sh file is in unix format: unix2dos generate.sh
- force a rebuild of the container docker compose -f docker-compose.yml up --build
Notes
1. FINBOURNE has a process that automatically builds and deploys this each time the LUSID API changes
- the resultant npm package will be available at https://www.npmjs.com/package/@finbourne/lusid-sdk-angular13
- if you want to publish manually then
- go to dist/lusid-sdk-angular13
- npm publish . --access public
1. LUSID API "dates" are now mapped to TypeScript/JavaScript string rather than Date.
- This is so that the value can be round-tripped correctly.
- The issue with using a JavaScript Date is that this only has millisecond accuracy, so you can loose information by converting a valid value returned from LUSID into a Date. e.g. If you receive 2022-02-20T12:13:14.1234567+00:00 and convert this to a Date when you send this back to LUSID you would get 2022-02-20T12:13:14.123Z - which isn't the same as the value received.
- This is for all properties in the LUSID API specification that have "type": "string". "format": "date-time"
Further help
To get more help on the Angular CLI use ng help` or go check out the Angular CLI Overview and Command Reference page.