jimdaly/crmjswebapiserviceutil

A WPF application which generates a custom JavaScript library and companion TypeScript definition file to provide a robust design-time experience with Visual Studio 2015 when writing client-side JavaScript to perform operations using the Microsoft Dynamics CRM Web API.

crmjswebapiserviceutil's Issues

Add Documentation generator

When generating the library, generate a page of documentation that includes reference documentation which includes the selected items and the core

Implement helpers for query functions

Include helper functions for the various Web API Query Functions .
Probably within a container, as to not clutter up the main namespace.

TODO: Manage recursion of dependencies when the QueryExpression Complex type is required

Application throws StackOverflowException when the BulkDelete Action is selected. It will probably do the same for the FetchXmlToQueryExpression Function because it also uses the QueryExpression ComplexType.

There is something about the recursive checking for dependent types which is causing this to fail.
The QueryExpression ComplexType was added with Dynamics 365 version 8.2.

Unhandled Exception when utility is run from Release directory

The following error occurs
CRMJSWebAPIServiceUtil has stopped working...
A problem caused the program to stop working correctly. Please close the program.

Steps to recreate:

1. Download the utility from github
2. Unblock the zip file via properties menu
3. Extract all zip file contents
4. Run the the utility from the resulting 'Release' directory (run as Administrator)
5. Hit the 'Login to CRM' button on the utility
6. Entering the following into the dialog

Table

Error

Environment Details

Add a release of the built tool

With it registered in Azure AD so that people can just run it without having to build it.

!! READ ME

You are welcome to add issues and comment on existing issues.
Currently, I'm using issues to track ideas I have to improve the library.

Add comments for crmbaseentity interface read-only properties on all entity instances

For example, the comments for the entitySetName property below. Also add for type and primarykey

    class account implements crmbaseentity {
        /**
         * A GUID, a URI, or a JSON object to set retrieved values.
         * @param accountReference
         */
        constructor(accountReference?: string | Object)
        isEntityClass: boolean;
        // crmbaseentity implementation START
        type: string;
        primaryKey: string;
        /**
        Web API entity set name for the account entity: 'accounts'
        */
        entitySetName: string;

Remove readonly property modifier so that TypeScript 2.0 is not required.

The TypeScript generated uses the readonly property modifyer, which was introduced in TypeScript 2.0

TODO: Fix InvokeFunction to deal with parameters that are collections of Enums

When trying to use a function with a parameter of type enum I'm really having a hard time trying to use it. Looking at the code generated it doesn't seem as the invokefunction method is ready to handle an incoming parameter of enum type. Actually "isEnum" is always undefined. But even if it wasn't it doesn't look like it would handle it correctly anyway. Have you tested it? Am i missing something? Can you provide an example?

Thank you

Update to support TLS 1.2 requirement

Updated the project and the release build to use .NET Framework 4.6.2 so that TLS 1.2 is used by default.
This is a requirement for v9 online releases.

Simplify generated code

Rather than generate anonymous functions for getters and setters, add an internal function that matches the pattern so the generated code can simply apply the named internal function. This should reduce the size the library grows per added entity.

Cannot authenticate on an AD FS + IFD environment

Took it for a spin on an IFD-enabled environment with claims-based authentication (AD FS).

The WhoAmI() request returns a html document containing a generic error message, and the event viewer had the following logs, seems like it fails to authenticate.

Also, i needed to provide my username in a domain\username format, otherwise it keeps giving 401: Unauthorized.. Although I know this is something to do with Windows Server 2012 R2, this doesn't happen on Windows Server 2012.

Fault bucket , type 0
Event Name: CRMmanaged2
Response: Not available
Cab Id: 0

Problem signature:
P1: 8.1.0.359
P2: w3wp
P3: Microsoft.Crm.Application.Pages
P4: UriFormatException
P5: UpdateRedirectingEventArgsNonPathBasedUrlWithoutLiveId
P6: 1D
P7: 
P8: 
P9: 
P10: 

Exception information: 
    Exception type: UriFormatException 
    Exception message: Invalid URI: The hostname could not be parsed.
   at System.Uri.CreateThis(String uri, Boolean dontEscape, UriKind uriKind)
   at System.UriBuilder..ctor(String uri)
   at Microsoft.Crm.Authentication.Claims.CrmFederatedAuthenticationModule.UpdateRedirectingEventArgsNonPathBasedUrlWithoutLiveId(RedirectLocation redirectLocation, RedirectingToIdentityProviderEventArgs e)
   at Microsoft.Crm.Authentication.Claims.CrmFederatedAuthenticationModule.SendToIdentityProvider(RedirectLocation redirectLocation)
   at Microsoft.Crm.Authentication.Claims.CrmFederatedAuthenticationModule.RedirectToIdentityProvider(String uniqueId, String returnUrl, Boolean persist)
   at System.Web.HttpApplication.SyncEventExecutionStep.System.Web.HttpApplication.IExecutionStep.Execute()
   at System.Web.HttpApplication.ExecuteStep(IExecutionStep step, Boolean& completedSynchronously)



Request information: 
    Request URL: https://orgname.domain.com:444/api/data/v8.1/WhoAmI() 
    Request path: /api/data/v8.1/WhoAmI() 
    User host address: xxx.xxx.xxx.xxx 
    User:  
    Is authenticated: False 
    Authentication Type:  
    Thread account name: DOMAIN\CRMSERVICE 

Thread information: 
    Thread ID: 229 
    Thread account name: DOMAIN\CRMSERVICE 
    Is impersonating: True 

Fix the following Descriptions

These descriptions still have "TODO" in them
RetrieveRecordWall.entityset
StateOptionMetadata.Color
CompoundUpdateDuplicateDetectionRule.Entity
CreateException.entityset
ExportSolution.ExportExternalApplications
GetInvoiceProductsFromOpportunity.Opportunity
ImportSolution.HoldingSolution
PublishTheme.entity
QualifyMemberList return type
CompoundUpdateDuplicateDetectionRule.Entity

fix invokeFunction in CoreLibrary.js

Has a reference to TS.TEST and doesn't have the ADALSupport placeholders

Provide option for query method to return typed values

Currently only returns JSON, but could apply the same logic as RetrieveTyped entity to call the constructor on the returned values.
Concerns: Performance impact and whether people want this.

Improve how to access formatted values

Currently to access a formatted value you must pass the name to the entity.getFormattedValues function:

account.getFormattedValue("customertypecode")

But instead (or in addition) there could be an entity.formatted read-only property (or method) to get this value with IntelliSense guidance:

account.formatted.customertypecode

or

account.getFormattedcustomertypecode()

Only those properties which return formatted values would be included: option set, money, etc.

Unhandled Exception when utility solution file is run from within Visual Studio 2015

This post should be considered a virtual duplicate of issue #21 with the only difference being that the method used to run the utility in this case is opening the solution file within Visual Studio 2015 and the level of detail surrounding the exception itself.

Steps to recreate

1. Download the utility from github
2. Unblock the zip file contents using the properties menu
3. Open the resulting solution file path = CRMJSWebAPIServiceUtil-master\CRMJSWebAPIServiceUtil-master\CRMJSWebAPIServiceUtil.sln
4. Hit the 'Login to CRM' button on the utility screen
5. Hit F5 from inside of Visual Studio 2015 to run the solution
6. Enter connection information into the resulting dialog window
   

Results in

System.Exception was unhandled by user code
HResult=-2146233088
Message=Error retrieving solutions: NotImplemented
Source=CRMJSWebAPIServiceUtil
StackTrace:
at CRMJSWebAPIServiceUtil.MainWindow.d__31.MoveNext() in G:\CRM\CRMJSWebAPIServiceUtil-master\CRMJSWebAPIServiceUtil-master\CRMJSWebAPIServiceUtil\CRMJSWebAPIServiceUtil\MainWindow.xaml.cs:line 282
--- End of stack trace from previous location where exception was thrown ---
at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(Task task)
at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
at System.Runtime.CompilerServices.TaskAwaiter.GetResult()
at CRMJSWebAPIServiceUtil.MainWindow.<LoginButton_Click>d__30.MoveNext() in G:\CRM\CRMJSWebAPIServiceUtil-master\CRMJSWebAPIServiceUtil-master\CRMJSWebAPIServiceUtil\CRMJSWebAPIServiceUtil\MainWindow.xaml.cs:line 197
InnerException:

NuGet Package Information
AjaxMin - installed version 5.14.5506.26202
Newtonsoft.Json - installed version 9.0.1
Microsoft.IdentityModel.Clients.ActiveDirectory - 2.28.1

Packages.config screenshot

Modify the implementation of the includeFormattedValues parameter

Change it to includeNotifications and modify the implementation from this:

if (includeFormattedValues) {
                    req.setRequestHeader("Prefer", "odata.include-annotations=\"OData.Community.Display.V1.FormattedValue\"");
                }

to this:

if (includeFormattedValues) {
                    req.setRequestHeader("Prefer", "odata.include-annotations=\"*\"");
                }

Then include entity functions similar to getFormattedValues except
getLookupAttributeName and getLookupAttributeType so that people can put lookup property
names in their $select options and use these annotations:
Microsoft.Dynamics.CRM.lookuplogicalname
Microsoft.Dynamics.CRM.associatednavigationproperty

To determine the type and the correct navigation property.
More info:
See https://msdn.microsoft.com/en-us/library/gg334767.aspx#bkmk_lookupProperty

Test queryTypedEntity and compare to SDK.REST.retrieveMultiple

Generate 5000 entities with a combination of related entities.
Run the same query with both libraries. Measure the time and browser memory usage. Look at server resources used as well.