scottdurow / dataverse-ify

Easily call the Dataverse WebApi from TypeScript using SDK style types, with a NodeJS implementation for integration testing.
MIT License
58 stars 16 forks source link
codegen dataverse microsoft

Welcome to dataverse-ify

       __      __                                        _ ____     
  ____/ /___ _/ /_____ __   _____  _____________        (_) __/_  __
 / __  / __ `/ __/ __ `/ | / / _ \/ ___/ ___/ _ \______/ / /_/ / / /
/ /_/ / /_/ / /_/ /_/ /| |/ /  __/ /  (__  )  __/_____/ / __/ /_/ / 
\__,_/\__,_/\__/\__,_/ |___/\___/_/  /____/\___/     /_/_/  \__, /  
                                                           /____/   

The TypeScript library that allows you to use the Microsoft Dataverse Xrm.WebApi using IOrganizationService SDK like types. Works with dataverse-gen and dataverse-auth to create early bound classes.

NOTE: This is version 2. For upgrading from version 1, see the article on UPGRADING.

Contributing

To build dataverse-ify locally you can fork the repo and then use:

npm install
npm run build

There are both unit tests and integration tests. To run the unit tests:

npm test

to run the integration tests, you will need to install the test solution (that contains some custom attributes) that is found at integration-test-solution\cdsifyintegrationtests.zip

Update the config file config\test.yaml with the org url of your environment, then run:

npm run integration-test

You can then test the library in your projects by using:

npm link

In your project that uses dataverse-ify use:

npm link dataverse-ify

Finally, unlink on the dataverse-ify project using:

npm unlink dateverse-ify

Commit your changes to your fork and then submit a pull request for review.

Upgrading from version 1 to 2?

You will need to make some minor changes.