Merge pull request #171 from microsoftgraph/dev

Merge dev into master

Author: MIchaelMainer

Generate.ps1

@@ -0,0 +1,32 @@
+param([String]$metadata='https://graph.microsoft.com/v1.0/$metadata')
+
+$ErrorActionPreference = "Stop"
+
+# pull docs 
+git clone --depth 1 https://github.com/microsoftgraph/microsoft-graph-docs.git docs
+
+# Get metadata
+Invoke-WebRequest $metadata -outfile metadata.xml
+
+# apidoctor the $metadata
+apidoc publish-edmx --path 'docs\api-reference\v1.0' --source metadata.xml --output finalmetadata --skip-generation
+
+# Generate new Types from metadata
+typewriter -v Info -l CSharp -m 'finalmetadata/metadata.xml' -o generated
+
+# Based on Language pull repo 
+git clone --depth 1 https://github.com/microsoftgraph/msgraph-sdk-dotnet.git source
+
+# Create branch
+set-location source
+git checkout -b metadata-2018-09-14
+
+# delete generated files
+remove-item -Recurse .\source\src\Microsoft.Graph\Models\Generated\
+remove-item -Recurse .\source\src\Microsoft.Graph\Requests\Generated\
+
+# copy generated files
+move-item .\generated\com\microsoft\graph\model .\source\src\Microsoft.Graph\Models\Generated\
+move-item .\generated\com\microsoft\graph\requests .\source\src\Microsoft.Graph\Requests\Generated\
+
+# commit and push branch

GraphODataTemplateWriter.Test/GraphODataTemplateWriter.Test.csproj

@@ -38,12 +38,6 @@
     </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core" />
-    <Reference Include="Vipr.Core">
-      <HintPath>..\submodules\vipr\src\Core\Vipr.Core\bin\Debug\Vipr.Core.dll</HintPath>
-    </Reference>
-    <Reference Include="Vipr.Reader.OData.v4">
-      <HintPath>..\submodules\vipr\src\Readers\Vipr.Reader.OData.v4\bin\Debug\Vipr.Reader.OData.v4.dll</HintPath>
-    </Reference>
   </ItemGroup>
   <ItemGroup>
     <Compile Include="*.cs" />
@@ -57,6 +51,14 @@
       <Project>{e6b5202f-4f66-428a-ab92-0aaa11ba81de}</Project>
       <Name>GraphODataTemplateWriter</Name>
     </ProjectReference>
+    <ProjectReference Include="..\submodules\vipr\src\Core\Vipr.Core\Vipr.Core.csproj">
+      <Project>{04c24936-006a-4fd8-a872-ee55588c1cbe}</Project>
+      <Name>Vipr.Core</Name>
+    </ProjectReference>
+    <ProjectReference Include="..\submodules\vipr\src\Readers\Vipr.Reader.OData.v4\Vipr.Reader.OData.v4.csproj">
+      <Project>{6d8d8008-0a34-490f-8b38-21d9c8bf25c0}</Project>
+      <Name>Vipr.Reader.OData.v4</Name>
+    </ProjectReference>
   </ItemGroup>
   <ItemGroup>
     <Content Include="Edmx\Containment.xml" />

GraphODataTemplateWriter.sln

@@ -34,8 +34,8 @@ Global
 		{5F526973-F69E-4C26-B8AD-612590A17A9E}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{2256EC8D-FD7E-4A49-B616-70755AFC9F6C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{2256EC8D-FD7E-4A49-B616-70755AFC9F6C}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{2256EC8D-FD7E-4A49-B616-70755AFC9F6C}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{2256EC8D-FD7E-4A49-B616-70755AFC9F6C}.Release|Any CPU.Build.0 = Release|Any CPU
+		{2256EC8D-FD7E-4A49-B616-70755AFC9F6C}.Release|Any CPU.ActiveCfg = Debug|Any CPU
+		{2256EC8D-FD7E-4A49-B616-70755AFC9F6C}.Release|Any CPU.Build.0 = Debug|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

Package.cmd

@@ -0,0 +1,3 @@
+msbuild Typewriter.sln /p:Configuration=Release /m
+choco pack Typewriter.nuspec -version %1
+choco upgrade Typewriter -s .

README.md

@@ -1,12 +1,15 @@
 [vipr-source-repo]: https://github.com/microsoft/vipr
 
+[![Build status](https://o365exchange.visualstudio.com/O365%20Sandbox/_apis/build/status/Microsoft%20Graph/msgraph-package-typewriter)](https://o365exchange.visualstudio.com/O365%20Sandbox/_build/latest?definitionId=1728)
+
 # Microsoft Graph SDK Code Generator
 
 Source code writers for [VIPR][vipr-source-repo] utilizing T4 templates. The GraphODataTemplateWriter receives an OdcmModel from VIPR and uses it to fill in a T4 template located within this repository.
 
 Currently the following target languages are supported by this writer:
 - Android
 - CSharp
+- Java
 - Objective-C
 - Python
 - TypeScript
@@ -33,6 +36,42 @@ Once setup is complete, you can work with the GraphODataTemplateWriter solution
 
 For more information on submodules read [this chapter](http://git-scm.com/book/en/v2/Git-Tools-Submodules) from the Git book and search the Web.
 
+## Using Typewriter
+
+Typewriter is a new solution for generating code files using the GraphODataTemplateWriter and VIPR. It is an executable that is intended to simplify the generation of code files. Build the solution to find the typewriter executable in `\MSGraph-SDK-Code-Generator\src\Typewriter\bin\Release`. The typewriter run options are:
+
+* **-l**, **-language**:  The target language for the generated code files. The values can be: `Android`, `Java`, `ObjC`, `CSharp`, `PHP`, `Python`, `TypeScript`, or `GraphEndpointList`. The default value is `CSharp`. This is not applicable when only generating clean and annotated metadata as specified by the `-generationmode Metadata` option.
+* **-m**, **-metadata**: The local file path or URL to the target input metadata. The default value is `https://graph.microsoft.com/v1.0/$metadata`. This value is required.
+* **-v**, **-verbosity**: The log verbosity level. The values can be: `Minimal`, `Info`, `Debug`, or `Trace`. The default value is `Minimal`.
+* **-o**, **-output**: Specifies the path to the output folder. The default value is the directory that contains typewriter.exe. The structure and contents of the output directory will be different based on the `-generationmode` and `-language` options.
+* **-d**, **-docs**: Specifies the path to the local root of the [microsoft-graph-docs](https://github.com/microsoftgraph/microsoft-graph-docs) repo. The default value is the directory that contains typewriter.exe. The documentation is parsed to provide documentation annotations to the metadata which is then used to add doc comments in the generated code files. This option is required when using `-generationmode` values of `Metadata` or `Full`.
+* **-g**, **-generationmode**: Specifies the generation mode. The values can be: `Full`, `Metadata`, or `Files`. `Full` (default) generation mode produces the output code files by cleaning the input metadata, parsing the documentation, and adding annotations before generating the output files. `Metadata` generation mode produces an output metadata file by cleaning metadata, documentation parsing, and adding documentation annotations. `Files` generation mode produces code files from an input metadata and bypasses the cleaning, documentation parsing, and adding documentation annotations.
+* **-f**, **-outputMetadataFileName**: The base output metadata filename. Only applicable for `-generationmode Metadata`. The default value is `cleanMetadataWithDescriptions` which is used with the value of the `-endpointVersion` to generate a metadata file named `cleanMetadataWithDescriptionsv1.0.xml`.
+* **-e**, **-endpointVersion**: The endpoint version used when naming a metadata file. Expected values are `v1.0` and `beta`. Only applicable for `-generationmode Metadata`.
+* **-p**, **-properties**: Specify properties to support generation logic in the T4 templates. Properties must take the form of *key-string:value-string*. Multiple properties can be specified by setting a space in between property. The only property currently supported is the *php.namespace* property to specify the generated model file namespace. This property is optional.
+
+### Example typewriter usage
+
+#### Generate TypeScript typings from a CSDL (metadata) file without cleaning or annotating the CSDL.
+
+The output will go in to the `outputTypeScript` directory.
+
+`.\typewriter.exe -v Info -m D:\cleanMetadataWithDescriptions_v10.xml -o outputTypeScript -l TypeScript -g Files`
+
+#### Clean and annotate a metadata file with documentation annotations sourced from the documentation repo
+
+The output metadata file will go in to the `output2` directory. The output metadata file will be named `cleanMetadataWithDescriptionsv1.0.xml` based on the default values.
+
+`.\typewriter.exe -v Info -m D:\v1.0_2018_10_23_source.xml -o output2 -d D:\repos\microsoft-graph-docs -g Metadata`
+
+#### Generate C# code files from the metadata that will be cleaned and annotated with documentation annotations sourced from the documentation repo
+
+The output C# code files will go in to the `output` directory.
+
+`.\typewriter.exe -v Info -m D:\v1.0_2018_10_23_source.xml -o output -l CSharp -d D:\repos\microsoft-graph-docs -g Full`
+
+
+
 ## Using Vipr with this Writer
 
 1. Build the solution in Visual Studio.
@@ -106,7 +145,7 @@ The type of template.
 
 #### Template Name
 
-To set the name of the template using the `Name` format string. You can insert `<Class>`, `<Property>`, `<Method>`, and `<Container>` the values will be replaced by the names of the corresponding object.  If you insert an item that doesn't exist it will be replaced with an empty string.  
+To set the name of the template using the `Name` format string. You can insert `<Class>`, `<Property>`, `<Method>`, and `<Container>` the values will be replaced by the names of the corresponding object.  If you insert an item that doesn't exist it will be replaced with an empty string.
 Note: You can also set the template name from inside the template by : `host.SetTemplateName("foo");`
 
 #### Template Editing
@@ -134,11 +173,11 @@ There are currently several steps we take to form the metadata into one that wil
      <Annotation String="navigable" Term="Org.OData.Core.V1.LongDescription"/>
      ```
   - Remove HasStream properties from ```onenotePage``` and ```onenoteEntityBaseModel```
-  - Add ```ContainsTarget="true"``` to navigation properties that do not have a corresponding EntitySet
+  - Add ```ContainsTarget="true"``` to navigation properties that do not have a corresponding EntitySet. This currently applies to navigation properties that contain plannerBucket, plannerTask, plannerPlan, and plannerDelta.
   - Add long descriptions to types and properties from [docs](https://developer.microsoft.com/en-us/graph/docs/concepts/overview)
-  
+
 In order to build against metadata other than that stored in the [metadata](https://github.com/microsoftgraph/MSGraph-SDK-Code-Generator/tree/master/metadata) directory, you will need to perform the first four on this list.
-  
+
 ## Contributing
 
 Before we can accept your pull request, you'll need to electronically complete Microsoft's [Contributor License Agreement](https://cla.microsoft.com/). If you've done this for other Microsoft projects, then you're already covered.

Templates/Android/generated/BaseEntityWithReferenceRequest.java.tt

@@ -39,6 +39,22 @@
        return send(HttpMethod.GET, null);
     }
 
+	public void delete(final ICallback<<#=TypeName(c)#>> callback) {
+		send(HttpMethod.DELETE, callback, null);
+	}
+
+	public void delete() throws ClientException {
+		send(HttpMethod.DELETE, null);
+	}
+
+	public void patch(final <#=TypeName(c)#> source<#=TypeName(c)#>, final ICallback<<#=TypeName(c)#>> callback) {
+		send(HttpMethod.PATCH, callback, source<#=TypeName(c)#>);
+	}
+
+	public <#=TypeName(c)#> patch(final <#=TypeName(c)#> source<#=TypeName(c)#>) throws ClientException {
+		return send(HttpMethod.PATCH, source<#=TypeName(c)#>);
+	}
+
 <# if (c.GetFeatures().CanSelect) { #>
     /**
      * Sets the select clause for the request

Templates/Android/generated/IBaseEntityWithReferenceRequest.java.tt

@@ -16,6 +16,14 @@
 
     <#=TypeName(c)#> get() throws ClientException;
 
+	void delete(final ICallback<<#=TypeName(c)#>> callback);
+
+	void delete() throws ClientException;
+
+	void patch(final <#=TypeName(c)#> source<#=TypeName(c)#>, final ICallback<<#=TypeName(c)#>> callback);
+
+	<#=TypeName(c)#> patch(final <#=TypeName(c)#> source<#=TypeName(c)#>) throws ClientException;
+
 <# if (c.GetFeatures().CanSelect) { #>
     <#=IBaseTypeWithReferencesRequest(c)#> select(final String value);
 

Templates/CSharp/Base/CollectionRequest.Base.template.tt

@@ -143,10 +143,13 @@ public string GetPostAsyncMethodForReferencesRequest(OdcmProperty odcmProperty)
 	if (serviceNavigationProperty == null)
 		return string.Empty;
 
-	//Append the singleton's navigation type to the @odata.id if relevant
 	var implicitNavigationProperty = string.Empty;
+	
+	// If the odcmProperty is a part of Singleton, then we need to determine whether there is a  
+	// NavigationPropertyBinding generation hint. If there is, then we need to use it for 
+	// creating the URL of a reference entity in a POST body. 
 	if (serviceNavigationProperty.GetType() == typeof(OdcmSingleton)) 
-		implicitNavigationProperty = "/" + odcmProperty.Name;
+	    implicitNavigationProperty = "/" + odcmProperty.GetImplicitPropertyName((OdcmSingleton)serviceNavigationProperty);
 
     var stringBuilder = new StringBuilder();
 

Templates/CSharp/Base/EntityRequest.Base.template.tt

@@ -196,7 +196,7 @@ public void AppendCreateAsyncHeader(string entityName, string lowerCaseEntityNam
     stringBuilder.AppendFormat("        /// <returns>The created {0}.</returns>", entityName);
 }
 
-public string GetEntityCreateAsyncMethod(OdcmClass odcmClass)
+public string GetEntityCreateAsyncMethod(OdcmClass odcmClass, bool initializeCollectionProperties = true)
 {
     var stringBuilder = new StringBuilder();
 
@@ -238,10 +238,14 @@ public string GetEntityCreateAsyncMethod(OdcmClass odcmClass)
     stringBuilder.Append(Environment.NewLine);
     stringBuilder.AppendFormat("            var newEntity = await this.SendAsync<{0}>({1}ToCreate, cancellationToken).ConfigureAwait(false);", entityName, lowerCaseEntityName);
     stringBuilder.Append(Environment.NewLine);
-    stringBuilder.Append(
-@"            this.InitializeCollectionProperties(newEntity);
-            return newEntity;
+	if (initializeCollectionProperties) {
+		stringBuilder.Append(
+	@"            this.InitializeCollectionProperties(newEntity);");
+		stringBuilder.Append(Environment.NewLine);
+	}
+	stringBuilder.Append(@"            return newEntity;
         }");
+	
 
     return stringBuilder.ToString();
 }
@@ -352,7 +356,7 @@ public void AppendUpdateAsyncHeader(string entityName, string lowerCaseEntityNam
     stringBuilder.AppendFormat("        /// <returns>The updated {0}.</returns>", entityName);
 }
 
-public string GetEntityUpdateAsyncMethod(OdcmClass odcmClass)
+public string GetEntityUpdateAsyncMethod(OdcmClass odcmClass, bool initializeCollectionProperties = true)
 {
     var stringBuilder = new StringBuilder();
 
@@ -393,9 +397,12 @@ public string GetEntityUpdateAsyncMethod(OdcmClass odcmClass)
     stringBuilder.Append(Environment.NewLine);
     stringBuilder.AppendFormat("            var updatedEntity = await this.SendAsync<{0}>({1}ToUpdate, cancellationToken).ConfigureAwait(false);", entityName, lowerCaseEntityName);
     stringBuilder.Append(Environment.NewLine);
-    stringBuilder.Append(
-@"            this.InitializeCollectionProperties(updatedEntity);
-            return updatedEntity;
+	if (initializeCollectionProperties) {
+		stringBuilder.Append(
+	@"            this.InitializeCollectionProperties(updatedEntity);");
+	stringBuilder.Append(Environment.NewLine);
+	}
+	stringBuilder.Append(@"            return updatedEntity;
         }");
 
     return stringBuilder.ToString();

Templates/CSharp/Base/EntityRequestBuilder.Base.template.tt

@@ -142,7 +142,8 @@ public string GetRequestBuilderProperty(string propertyName, string urlValue, st
 
 public string GetCollectionPropertyRequestBuilderProperty(string entityName, OdcmProperty odcmProperty)
 {
-    var propertyName = this.GetPropertyName(odcmProperty).GetSanitizedPropertyName();
+    var propertyName = this.GetPropertyName(odcmProperty);
+    propertyName = propertyName.GetSanitizedPropertyName(suffix: propertyName == "Request" ? "_" : null);
     var propertyPrefix = string.Concat(entityName, this.GetPropertyName(odcmProperty));
     var collectionRequestBuilder = odcmProperty.IsReference()
         ? this.GetCollectionWithReferencesRequestBuilderString(propertyPrefix)
@@ -153,7 +154,8 @@ public string GetCollectionPropertyRequestBuilderProperty(string entityName, Odc
 
 public string GetNonCollectionRequestBuilderProperty(OdcmProperty odcmProperty)
 {
-    var propertyName = this.GetPropertyName(odcmProperty).GetSanitizedPropertyName();
+    var propertyName = this.GetPropertyName(odcmProperty);
+    propertyName = propertyName.GetSanitizedPropertyName(suffix: propertyName == "Request" ? "_" : null);
     var propertyPrefix = this.GetPropertyTypeName(odcmProperty);
     var propertyRequestBuilder = odcmProperty.IsReference()
         ? this.GetWithReferenceRequestBuilderString(propertyPrefix)