Skip to content

Commit

Permalink
allow custom headers #151; adding power pages tests #156; improving c…
Browse files Browse the repository at this point in the history
…ode coverage
  • Loading branch information
AleksandrRogov committed Jul 29, 2023
1 parent c3988a6 commit c6d005e
Show file tree
Hide file tree
Showing 28 changed files with 857 additions and 370 deletions.
20 changes: 10 additions & 10 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ If you want to upgrade from v1 - v2 breaking changes are [here](/.github/BREAKIN

Please check [DynamicsWebApi Wiki](../../../wiki/) where you will find documentation to DynamicsWebApi API and more.

Browser-compiled script and type definitions can be found in a [dist](/dist/) folder.
Browser-compiled script and type definitions can be found in a v2 [dist](https://github.com/AleksandrRogov/DynamicsWebApi/tree/v2/dist) folder.

## Main Features

Expand All @@ -30,13 +30,6 @@ Browser-compiled script and type definitions can be found in a [dist](/dist/) fo
- **Node.js and a Browser** support.
- **Proxy Configuration** support.


## Terminology

Check out [Dataverse Terminology](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/understand-terminology). Microsoft has done some changes in the namings of the objects and components of D365 and since DynamicsWebApi has been developing for many years there may be _conflicting_ naming, such as: `createEntity` - which _right now_ means "Create a Table Definition". Dataverse SDK terminology is what the library has been based on. I have no plans on changing that (except in documentation), mainly because Microsoft may change the namings again in the future which will lead to naming issues ...again.

**Please note!** "Dynamics 365" in this readme refers to Microsoft Dataverse (formerly known as Microsoft Common Data Service) / Microsoft Dynamics 365 Customer Engagement / Micorosft Dynamics CRM. **NOT** Microsoft Dynamics 365 Finance and Operations.

***

I maintain this project in my free time and it takes a considerable amount of time to make sure that the library has all new features,
Expand All @@ -47,6 +40,12 @@ Also, please check [suggestions and contributions](#contributions) section to le

***

## Terminology

Check out [Dataverse Terminology](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/understand-terminology). Microsoft has done some changes in the namings of the objects and components of D365 and since DynamicsWebApi has been developing for many years there may be _conflicting_ naming, such as: `createEntity` - which _right now_ means "Create a Table Definition". Dataverse SDK terminology is what the library has been based on. I have no plans on changing that (except in documentation), mainly because Microsoft may change the namings again in the future which will lead to naming issues ...again.

**Please note!** "Dynamics 365" in this readme refers to Microsoft Dataverse (formerly known as Microsoft Common Data Service) / Microsoft Dynamics 365 Customer Engagement / Micorosft Dynamics CRM. **NOT** Microsoft Dynamics 365 Finance and Operations.

## Table of Contents

v2 breaking changes are [here](/.github/BREAKING_CHANGES_V2.md). List of new features in v2 is [here](/.github/NEW_IN_V2.md).
Expand Down Expand Up @@ -127,7 +126,7 @@ v2 breaking changes are [here](/.github/BREAKING_CHANGES_V2.md). List of new fea
## Getting Started

### Dynamics 365 Web Resource
To use DynamicsWebApi inside Dynamics 365 you need to download a browser version of the library, it can be found in [dist](/dist/) folder.
To use DynamicsWebApi inside Dynamics 365 you need to download a browser version of the library, it can be found in v2 [dist](https://github.com/AleksandrRogov/DynamicsWebApi/tree/v2/dist) folder.

Upload a script as a JavaScript Web Resource, add it to a table form or reference it in the HTML Web Resource and then initialize the main object:

Expand Down Expand Up @@ -2387,7 +2386,7 @@ import { DynamicsWebApi, Config } from "dynamics-web-api";
```
### Dynamics 365 web resource
If you are developing CRM Web Resources with TypeScript (and are not using NPM), you can download a TypeScript declaration file `dynamics-web-api.d.ts` manually from [dist](/dist/) folder. I usually put all declarations in the "./types/" folder of my web resources project. For example:
If you are developing CRM Web Resources with TypeScript (and are not using NPM), you can download a TypeScript declaration file `dynamics-web-api.d.ts` manually from v2 [dist](https://github.com/AleksandrRogov/DynamicsWebApi/tree/v2/dist) folder. I usually put all declarations in the "./types/" folder of my web resources project. For example:
```
[project root]/
Expand Down Expand Up @@ -2448,6 +2447,7 @@ the config option "formatted" will enable developers to retrieve all information
- [X] Refactoring and conversion to TypeScript. `Added in v.2.0`
- [X] Implement [Dataverse Search API](https://docs.microsoft.com/en-us/power-apps/developer/data-platform/webapi/relevance-search). `Added in v.2.0`
- [ ] Allow custom headers to be passed to the request. [#151](https://github.com/AleksandrRogov/DynamicsWebApi/issues/151)
- [ ] Support Microsoft Power Pages.
Many more features to come!
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ As well as Microsoft Dynamics 365 CE (online), Microsoft Dynamics 365 CE (on-pre
## Main Features

- **Microsoft Dataverse Search API**. Access the full power of its Search, Suggestion and Autocomplete capabilities.
- **Batch Requests**. Convert all requests into a Batch operation with a single line of code.
- **Batch Requests**. Convert all requests into a Batch operation with twi lines of code.
- **Simplicity and Automation**. Such as automated paging, big file downloading/uploading in chunks of data, automated conversion of requests with long URLs into a Batch Request in the background and more!
- **CRUD operations**. Including Fetch XML, Actions and Functions in Microsoft Dataverse Web API.
- **Table Definitions (Entity Metadata)**. Query and modify Table, Column, Choice (Option Set) and Relationship definitions.
Expand All @@ -22,7 +22,7 @@ As well as Microsoft Dynamics 365 CE (online), Microsoft Dynamics 365 CE (on-pre
- **Node.js and a Browser** support.
- **Proxy Configuration** support.

Browser-compiled script and type definitions can be found in a [dist](/dist/) folder.
Browser-compiled script and type definitions can be found in a v2 [dist](https://github.com/AleksandrRogov/DynamicsWebApi/tree/v2/dist) folder.

**Please note!** "Dynamics 365" in this readme refers to Microsoft Dataverse (formerly known as Microsoft Common Data Service) / Microsoft Dynamics 365 Customer Engagement / Micorosft Dynamics CRM. **NOT** Microsoft Dynamics 365 Finance and Operations.

Expand All @@ -31,7 +31,7 @@ Browser-compiled script and type definitions can be found in a [dist](/dist/) fo
### For a full documentation please check [DynamicsWebApi on GitHub](https://github.com/AleksandrRogov/DynamicsWebApi).

### Dynamics 365 Web Resource
To use DynamicsWebApi inside Dynamics 365 you need to download a browser version of the library, it can be found in [dist](/dist/) folder.
To use DynamicsWebApi inside Dynamics 365 you need to download a browser version of the library, it can be found in v2 [dist](https://github.com/AleksandrRogov/DynamicsWebApi/tree/v2/dist) folder.

Upload a script as a JavaScript Web Resource, add it to a table form or reference it in your HTML Web Resource and then initialize the main object:

Expand Down
94 changes: 49 additions & 45 deletions dist/browser/esm/dynamics-web-api.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions dist/browser/esm/dynamics-web-api.js.map

Large diffs are not rendered by default.

Loading

0 comments on commit c6d005e

Please sign in to comment.