fixes #45; added TypeScript declaration files

Author: AleksandrRogov

.npmignore

@@ -5,4 +5,7 @@ obj
 
 *.njsproj
 *.sln
-.ntvs_analysis.dat
+.ntvs_analysis.dat
+
+# Exclude type definitions for callbacks version
+/types/dynamics-web-api-callbacks.d.ts

DynamicsWebApi.njsproj

@@ -27,7 +27,7 @@
     <OutputPath>.</OutputPath>
     <TargetFrameworkVersion>v4.0</TargetFrameworkVersion>
     <ProjectTypeGuids>{3AF33F2E-1136-4D97-BBB7-1795711AC8B8};{349c5851-65df-11da-9384-00065b846f21};{9092AA53-FB77-4645-B42D-1CCCA6BD08BD}</ProjectTypeGuids>
-    <ProjectView>ProjectFiles</ProjectView>
+    <ProjectView>ShowAllFiles</ProjectView>
     <NodejsPort>1337</NodejsPort>
     <StartWebBrowser>True</StartWebBrowser>
   </PropertyGroup>
@@ -51,7 +51,6 @@
     <DebugSymbols>true</DebugSymbols>
   </PropertyGroup>
   <ItemGroup>
-    <Compile Include="gulpfile.js" />
     <Compile Include="lib\dwa.js" />
     <Compile Include="lib\dynamics-web-api-callbacks.js" />
     <Compile Include="lib\dynamics-web-api.js" />
@@ -134,22 +133,12 @@
     <Folder Include="types\" />
     <Folder Include="tests\" />
     <Folder Include="tests\browser\" />
-    <Folder Include="typings\" />
-    <Folder Include="typings\globals\" />
-    <Folder Include="typings\globals\chai\" />
-    <Folder Include="typings\globals\mocha\" />
-    <Folder Include="typings\globals\node\" />
-    <Folder Include="typings\globals\sinon\" />
   </ItemGroup>
   <ItemGroup>
+    <TypeScriptCompile Include="types\dynamics-web-api.d.ts" />
     <TypeScriptCompile Include="types\dynamics-web-api-callbacks.d.ts">
       <SubType>Code</SubType>
     </TypeScriptCompile>
-    <TypeScriptCompile Include="typings\globals\chai\index.d.ts" />
-    <TypeScriptCompile Include="typings\globals\mocha\index.d.ts" />
-    <TypeScriptCompile Include="typings\globals\node\index.d.ts" />
-    <TypeScriptCompile Include="typings\globals\sinon\index.d.ts" />
-    <TypeScriptCompile Include="typings\index.d.ts" />
   </ItemGroup>
   <!-- Do not delete the following Import Project.  While this appears to do nothing it is a marker for setting TypeScript properties before our import that depends on them. -->
   <Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\TypeScript\Microsoft.TypeScript.targets" Condition="False" />

README.md

@@ -68,6 +68,7 @@ please go to `node_modules\dynamics-web-api` of your application and remove `.gi
 * [Formatted Values and Lookup Properties](#formatted-values-and-lookup-properties)
 * [Using Alternate Keys](#using-alternate-keys)
 * [Making requests using Entity Logical Names](#making-requests-using-entity-logical-names)
+* [Using TypeScript Declaration Files](#using-typescript-declaration-files)
 * [JavaScript Promises](#javascript-promises)
 * [JavaScript Callbacks](#javascript-callbacks)
 * [Contributions](#contributions)
@@ -1852,6 +1853,49 @@ var collectionName = dynamicsWebApi.utility.getCollectionName('account');
 
 Please note, everything said above will happen only if you set `useEntityNames: true` in the DynamicsWebApi config.
 
+## Using TypeScript Declaration Files
+
+TypeScript declaration files `d.ts` added with v.1.5.3. 
+If you are not familiar with declaration files, these files are used to provide TypeScript type information about an API that's written in JavaScript.
+You want to consume those from your TypeScript code. [Quote](https://stackoverflow.com/a/21247316/2042071)
+
+At this moment, DynamicsWebApi declaration files do not exist in a [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped) repository but it is in my plans to upload them there.
+
+### Node.Js
+
+If you are using Node.Js with TypeScript, declarations will be fetched with an NPM package during an installation or an update process.
+At the top of a necessary `.ts` file add the following:
+
+```ts
+import * as DynamicsWebApi from "dynamics-web-api";
+//for CommonJS:
+//import DynamicsWebApi = require("dynamics-web-api");
+```
+
+### Dynamics 365 web resource
+If you are developing CRM Web Resources with TypeScript, you will need to download a necessary `d.ts` file manually from the following folder: [types](/types/).
+As you may have noticed `types` folder contains two declaration files: `dynamics-web-api.d.ts` (Promises) and `dynamics-web-api-callbacks.d.ts` (Callbacks) - download the one that you need.
+**Do not download both files! Otherwise you will have type declaration conflicts.**
+In my web resources project I usually put a declaration file under "./types/" folder. For example:
+
+```
+[project root]/
+-- src/
+  -- form_web_resource.ts
+-- types/
+  -- dynamics-web-api/
+    -- dynamics-web-api-callbacks.d.ts
+-- tsconfig.json
+```
+
+**Important!** Make sure that you include `types` folder in your `tsconfig.json`:
+```
+"include": [
+	"./src/**/*",
+	"./types/**/*"
+]
+```
+
 ### In Progress
 
 - [X] Overloaded functions with rich request options for all Web API operations.
@@ -1866,9 +1910,10 @@ the config option "formatted" will enable developers to retrieve all information
 - [X] Ability to use entity names instead of collection names. `Implemented in v.1.4.0`
 - [X] Entity and Attribute Metadata helpers. `Implemented in v.1.4.3`
 - [X] Entity Relationships and Global Option Sets helpers. `Implemented in v.1.4.6`
-- [X] Batch requests.
+- [X] Batch requests. `Implemented in v.1.5.0`
+- [X] TypeScript declaration files `d.ts` `Added in v.1.5.3`.
+- [ ] Upload DynamicsWebApi declaration files to DefinitelyTyped repository.
 - [ ] Implement `Content-ID` header to reference a created entity in a batch operation.
-- [ ] Intellisense for request objects.
 
 Many more features to come!
 

dist/dwa.js

@@ -1130,7 +1130,7 @@ function DynamicsWebApi(config) {
     }
 
     /**
-     * Sets the configuration parameters for DynamicsWebApi helper.
+     * Sets DynamicsWebApi configuration parameters.
      *
      * @param {DWAConfig} config - configuration object
      * @example
@@ -3061,7 +3061,7 @@ module.exports = BatchConverter;
  * Builds parametes for a funciton. Returns '()' (if no parameters) or '([params])?[query]'
  *
  * @param {Object} [parameters] - Function's input parameters. Example: { param1: "test", param2: 3 }.
- * @returns {string}
+ * @returns {string} - Function parameter result
  */
 module.exports = function buildFunctionParameters(parameters) {
     if (parameters) {
@@ -3073,13 +3073,24 @@ module.exports = function buildFunctionParameters(parameters) {
             var parameterName = parameterNames[i - 1];
             var value = parameters[parameterName];
 
+            if (value === null)
+                continue;
+
+            if (typeof value === "string") {
+                value = "'" + value + "'";
+            }
+            //fix #45
+            else if (typeof value === "object") {
+                value = JSON.stringify(value);
+            }
+
             if (i > 1) {
                 functionParameters += ",";
                 urlQuery += "&";
             }
 
             functionParameters += parameterName + "=@p" + i;
-            urlQuery += "@p" + i + "=" + ((typeof value == "string") ? "'" + value + "'" : value);
+            urlQuery += "@p" + i + "=" + value;
         }
 
         return "(" + functionParameters + ")?" + urlQuery;

dist/dynamics-web-api-callbacks.js

@@ -2876,7 +2876,7 @@ module.exports = RequestConverter;
  * Builds parametes for a funciton. Returns '()' (if no parameters) or '([params])?[query]'
  *
  * @param {Object} [parameters] - Function's input parameters. Example: { param1: "test", param2: 3 }.
- * @returns {string}
+ * @returns {string} - Function parameter result
  */
 module.exports = function buildFunctionParameters(parameters) {
     if (parameters) {
@@ -2888,13 +2888,24 @@ module.exports = function buildFunctionParameters(parameters) {
             var parameterName = parameterNames[i - 1];
             var value = parameters[parameterName];
 
+            if (value === null)
+                continue;
+
+            if (typeof value === "string") {
+                value = "'" + value + "'";
+            }
+            //fix #45
+            else if (typeof value === "object") {
+                value = JSON.stringify(value);
+            }
+
             if (i > 1) {
                 functionParameters += ",";
                 urlQuery += "&";
             }
 
             functionParameters += parameterName + "=@p" + i;
-            urlQuery += "@p" + i + "=" + ((typeof value == "string") ? "'" + value + "'" : value);
+            urlQuery += "@p" + i + "=" + value;
         }
 
         return "(" + functionParameters + ")?" + urlQuery;