NPM TypeScript type definitions (Azure#155)

* Adding README and package.json to public types

* add title

* modify versions bit, make it open to node worker and latest published type being out of sync

* addressing cr readme comments

Author: mhoeger

.gitignore

@@ -53,4 +53,6 @@ types/*
 
 !types/public
 types/public/*
-!types/public/Interfaces.d.ts
+!types/public/Interfaces.d.ts
+!types/public/package.json
+!types/public/README.md

.vscode/launch.json

@@ -14,6 +14,12 @@
                 "${workspaceRoot}/dist/src/*.js"
             ],
             "args": ["--host", "127.0.0.1", "--port", "50051", "--requestId", "100a", "--workerId", "worker1"]
+        },
+        {
+            "type": "node",
+            "request": "attach",
+            "name": "Attach by Process ID",
+            "processId": "${command:PickProcess}"
         }
     ]
 }

Worker.nuspec

@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
   <metadata>
     <id>Microsoft.Azure.Functions.NodeJsWorker</id>
-    <version>1.0.0-beta7$version$</version>
+    <version>1.0.1$version$</version>
     <authors>Microsoft</authors>
     <owners>Microsoft</owners>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "azure-functions-nodejs-worker",
   "author": "Microsoft Corporation",
-  "version": "1.0.0-beta7",
+  "version": "1.0.1",
   "description": "Microsoft Azure Functions NodeJS Worker",
   "license": "(MIT OR Apache-2.0)",
   "dependencies": {

package.json

@@ -1,7 +1,7 @@
 // Test typescript interfaces for ts compliation errors
-import * as azf from "../types/public/Interfaces";
+import { IFunction, IContext, IRequest} from "../types/public/Interfaces";
 
-let runHttp: azf.IFunction = async function (context: azf.IContext, req: azf.IRequest) {
+let runHttp: IFunction = async function (context: IContext, req: IRequest) {
     context.log('JavaScript HTTP trigger function processed a request.');
     if (req.query.name || (req.body && req.body.name)) {
         context.res = {
@@ -16,8 +16,16 @@ let runHttp: azf.IFunction = async function (context: azf.IContext, req: azf.IRe
     }
 }
 
+let runServiceBus: IFunction = function (context: IContext, myQueueItem: string) { 
+    context.log('Node.js ServiceBus queue trigger function processed message', myQueueItem); 
+    context.log.verbose('EnqueuedTimeUtc =', context.bindingData.enqueuedTimeUtc); 
+    context.log.verbose('DeliveryCount =', context.bindingData.deliveryCount); 
+    context.log.verbose('MessageId =', context.bindingData.messageId);
+    context.done();
+};
+
 // Assumes output binding is named '$return'
-let runHttpReturn: azf.IFunction = async function (context: azf.IContext, req: azf.IRequest) {
+let runHttpReturn: IFunction = async function (context: IContext, req: IRequest) {
     context.log('JavaScript HTTP trigger function processed a request.');
     if (req.query.name || (req.body && req.body.name)) {
         return {
@@ -32,12 +40,4 @@ let runHttpReturn: azf.IFunction = async function (context: azf.IContext, req: a
     }
 }
 
-let runServiceBus: azf.IFunction = function (context: azf.IContext, myQueueItem: string) { 
-    context.log('Node.js ServiceBus queue trigger function processed message', myQueueItem); 
-    context.log.verbose('EnqueuedTimeUtc =', context.bindingData.enqueuedTimeUtc); 
-    context.log.verbose('DeliveryCount =', context.bindingData.deliveryCount); 
-    context.log.verbose('MessageId =', context.bindingData.messageId);
-    context.done();
-};
-
 export { runHttp, runHttpReturn, runServiceBus };

test/InterfacesTest.ts

@@ -0,0 +1,43 @@
+# Type definitions for Azure Functions
+This package contains type definitions for using TypeScript with Azure Functions.
+
+These typings are for common objects that will be passed to your Azure Functions function code. Azure Functions supports TypeScript development, but does not support directly running TypeScript code without transpilation.
+
+Read more on [configuring entry points](https://docs.microsoft.com/azure/azure-functions/functions-reference-node#configure-function-entry-point) in your Azure Functions function app.
+
+# Install
+Because this package only contains TypeScript type definitions, it should be saved under `devDependencies`.
+
+`npm install @azure/functions --save-dev`
+
+# Usage
+```javascript
+import { IFunction, IContext, IRequest} from "@azure/functions";
+
+const index: IFunction = async function (context: IContext, req: IRequest) {
+    context.log('JavaScript HTTP trigger function processed a request.');
+    if (req.query.name || (req.body && req.body.name)) {
+        context.res = {
+            status: "200",
+            body: "Hello " + (req.query.name || req.body.name)
+        };
+    } else {
+        context.res = {
+            status: 400,
+            body: "Please pass a name on the query string or in the request body"
+        };
+    }
+}
+
+export { index };
+```
+
+# Versions
+Versioning of @azure/functions is tied to the version of the [Azure Functions Node.js Worker](https://github.com/Azure/azure-functions-nodejs-worker/releases) the types were generated from. You can find the Azure Functions Node.js Worker version of a given Function Runtime Version [here](https://github.com/Azure/azure-functions-host/releases). It is recommended that you take the latest version available.
+
+# Getting Started with Azure Functions
+If you are getting started with Azure Functions, you can follow this tutorial to [create and deploy your first JavaScript function](https://docs.microsoft.com/azure/azure-functions/functions-create-first-function-vs-code). We recommend that you use Visual Studio Code and the [Azure Functions extension](https://code.visualstudio.com/tutorials/functions-extension/getting-started).
+
+The [Azure Functions developer guide](https://docs.microsoft.com/azure/azure-functions/functions-reference) and the [JavaScript-specific developer guide](https://docs.microsoft.com/azure/azure-functions/functions-reference-node) are good resources to gain an understanding of more Azure Functions concepts.
+
+

types/public/README.md

@@ -0,0 +1,16 @@
+{
+  "name": "@azure/functions",
+  "version": "1.0.1",
+  "description": "Azure Functions types for Typescript",
+  "main": "Interfaces.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Azure/azure-functions-nodejs-worker/tree/master/types/public"
+  },
+  "keywords": [
+    "azure-functions",
+    "typescript"
+  ],
+  "author": "Microsoft",
+  "license": "MIT"
+}