Add syncSupport function option

Author: hermanwenhe

packages/custom-functions-metadata/src/parseTree.ts

@@ -30,6 +30,7 @@ export interface IFunctionOptions {
   excludeFromAutoComplete?: boolean;
   linkedEntityLoadService?: boolean;
   capturesCallingObject?: boolean;
+  syncSupport?: boolean
 }
 
 export interface IFunctionParameter {
@@ -132,6 +133,7 @@ const REQUIRESADDRESS = "requiresaddress";
 const REQUIRESPARAMETERADDRESSES = "requiresparameteraddresses";
 const STREAMING = "streaming";
 const VOLATILE = "volatile";
+const SYNCSUPPORT = "syncsupport";
 
 const TYPE_MAPPINGS = {
   [ts.SyntaxKind.NumberKeyword]: "number",
@@ -462,7 +464,8 @@ export function parseTree(sourceCode: string, sourceFileName: string): IParseTre
             !options.requiresStreamParameterAddresses &&
             !options.excludeFromAutoComplete &&
             !options.linkedEntityLoadService &&
-            !options.capturesCallingObject
+            !options.capturesCallingObject &&
+            !options.syncSupport
           ) {
             delete functionMetadata.options;
           } else {
@@ -505,6 +508,10 @@ export function parseTree(sourceCode: string, sourceFileName: string): IParseTre
             if (!options.capturesCallingObject) {
               delete options.capturesCallingObject;
             }
+
+            if (!options.syncSupport) {
+              delete options.syncSupport;
+            }
           }
 
           if (!functionMetadata.helpUrl) {
@@ -667,6 +674,7 @@ function getOptions(
     excludeFromAutoComplete: isExcludedFromAutoComplete(func),
     linkedEntityLoadService: isLinkedEntityLoadService(func),
     capturesCallingObject: capturesCallingObject(func),
+    syncSupport: isSyncSupport(func),
   };
 
   if (isAddressRequired(func) || isRequiresParameterAddresses(func)) {
@@ -1062,6 +1070,14 @@ function capturesCallingObject(node: ts.Node): boolean {
   return hasTag(node, CAPTURESCALLINGOBJECT);
 }
 
+/**
+ * Returns true if syncSupport tag found in comments
+ * @param node jsDocs node
+ */
+function isSyncSupport(node: ts.Node): boolean {
+  return hasTag(node, SYNCSUPPORT);
+}
+
 function containsTag(tag: ts.JSDocTag, tagName: string): boolean {
   return (tag.tagName.escapedText as string).toLowerCase() === tagName;
 }

packages/custom-functions-metadata/test/cases/error-syncsupport-missing-invocation-parameter/expected.js.errors.txt

@@ -0,0 +1 @@
+Since @syncSupport is present, the last function parameter should be of type CustomFunctions.Invocation : (10,40)

packages/custom-functions-metadata/test/cases/error-syncsupport-missing-invocation-parameter/expected.ts.errors.txt

@@ -0,0 +1 @@
+Since @syncSupport is present, the last function parameter should be of type CustomFunctions.Invocation : (10,48)

packages/custom-functions-metadata/test/cases/error-syncsupport-missing-invocation-parameter/functions.js

@@ -0,0 +1,12 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+/**
+ * Test missing invocation parameter type
+ * @param x {string} string
+ * @customfunction
+ * @syncSupport
+ */
+function customFunctionInvocationTest(x) {
+    // Empty
+}

packages/custom-functions-metadata/test/cases/error-syncsupport-missing-invocation-parameter/functions.ts

@@ -0,0 +1,12 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+/**
+ * Test missing invocation parameter type
+ * @param x string
+ * @customfunction
+ * @syncSupport
+ */
+function customFunctionInvocationTest(x: string) {
+    // Empty
+}