version 0.0.6 - usesable by pb project

Author: mhoeger

.npmignore

@@ -1,3 +1,4 @@
 out/
 samples/http
-src/
+bin
+.vscode

README.md

@@ -26,8 +26,11 @@ This is in a very early stage, the most helpful feedback will be on the intuitiv
 - Be able to init and create new functions
 - Be able to convert old functions to new format.
 
+### Extensibility
+- Change getRequiredProperties/getOptionalProperties => getConfig or something and include validation for required.
+- Make function name required??
+
 ## Challenges
 - Requires a "build step" which is not required for plain JavaScript. Luckily, converting JavaScript is fairly common practice.
     - Need to verify that integration with other build steps is ok. This should be fine though, as long as this is the last step in any generation pipeline. Thought should be put into making this an intuitive experience.
 - Templates. How to make them compatible with existing systems? We want to keep index.js but change function.json. Maybe this ties into work to convert old functions to new. 
-

bindings/core/blobBinding.ts

@@ -1,9 +1,9 @@
-import { BindingBase, Trigger, InputBinding, OutputBinding } from "../../src/types/bindings/bindings"
+import { AzFunctionBindingBase, Trigger, InputBinding, OutputBinding, Binding } from "../../src/types/bindings"
 
 /**
  * Blob Binding
  */
-class BlobBinding extends BindingBase {
+class BlobBinding extends AzFunctionBindingBase {
     /**
      * The path to the blob container
      */
@@ -13,10 +13,6 @@ class BlobBinding extends BindingBase {
      */
     public connection: string;
 
-    public getRequiredProperties() {
-        return [...super.getRequiredProperties(), "path", "connection"];
-    }
-
     constructor(parameters: {
         name: string,  
         path: string,
@@ -27,6 +23,18 @@ class BlobBinding extends BindingBase {
         this.path = parameters.path;
         this.connection = parameters.connection;
     }
+
+    public getProperties(): Binding {
+        const coreProperties = super.getProperties();
+        if (!this.path) throw new Error("Missing required property 'path'")
+        if (!this.connection) throw new Error("Missing required property 'connection'")
+
+        const blobProperties = {
+            path: this.path,
+            connection: this.connection
+        };
+        return Object.assign({}, coreProperties, blobProperties);
+    }
 }
 
 export class BlobTrigger extends BlobBinding implements Trigger {

bindings/core/cosmosDbBinding.ts

@@ -1,9 +1,9 @@
-import { BindingBase, Trigger, InputBinding, OutputBinding } from "../../src/types/bindings/bindings"
+import { AzFunctionBindingBase, Trigger, InputBinding, OutputBinding, Binding } from "../../src/types/bindings"
 
 /**
  * EventHub Binding
  */
-class CosmosDbBinding extends BindingBase {
+class CosmosDbBinding extends AzFunctionBindingBase {
     /**
      * 
      */
@@ -28,8 +28,17 @@ class CosmosDbBinding extends BindingBase {
         this.connectionStringSetting = parameters.connectionStringSetting;
     }
 
-    public getRequiredProperties() {
-        return [...super.getRequiredProperties(), "databaseName", "collectionName", "connectionStringSetting"];
+    public getProperties(): Binding {
+        if (!this.databaseName) throw new Error("Missing required property 'databaseName'")
+        if (!this.collectionName) throw new Error("Missing required property 'collectionName'")
+        if (!this.connectionStringSetting) throw new Error("Missing required property 'connectionStringSetting'")
+
+        const properties = {
+            path: this.databaseName,
+            collectionName: this.collectionName,
+            connectionStringSetting: this.connectionStringSetting
+        };
+        return Object.assign({}, super.getProperties(), properties);
     }
 }
 
@@ -96,12 +105,26 @@ export class CosmosDbTrigger extends CosmosDbBinding implements Trigger {
         this.preferredLocations = parameters.preferredLocations;
     }
 
-    public getOptionalProperties() {
-        return [...super.getOptionalProperties(), "leaseCollectionName", "createLeaseCollectionIfNotExists", 
-            "leaseConnectionStringSetting", "leaseDatabaseName", "leasesCollectionThroughput", 
-            "leaseCollectionPrefix", "feedPollDelay", "leaseAcquireInterval", "leaseExpirationInterval",
-            "leaseRenewInterval", "checkpointFrequency", "maxItemsPerInvocation", "startFromBeginning",
-            "preferredLocations"];
+    public getProperties(): Binding {
+        const coreProperties = super.getProperties();
+
+        const cosmosProperties = {
+            leaseCollectionName: this.leaseCollectionName,
+            createLeaseCollectionIfNotExists: this.createLeaseCollectionIfNotExists,
+            leaseConnectionStringSetting: this.leaseConnectionStringSetting,
+            leaseDatabaseName: this.leaseDatabaseName,
+            leasesCollectionThroughput: this.leasesCollectionThroughput,
+            leaseCollectionPrefix: this.leaseCollectionPrefix,
+            feedPollDelay: this.feedPollDelay,
+            leaseAcquireInterval: this.leaseAcquireInterval,
+            leaseExpirationInterval: this.leaseExpirationInterval,
+            leaseRenewInterval: this.leaseRenewInterval,
+            checkpointFrequency: this.checkpointFrequency,
+            maxItemsPerInvocation: this.maxItemsPerInvocation,
+            startFromBeginning: this.startFromBeginning,
+            preferredLocations: this.preferredLocations
+        };
+        return Object.assign({}, coreProperties, cosmosProperties);
     }
 }
 
@@ -131,12 +154,18 @@ export class CosmosDbInput extends CosmosDbBinding implements InputBinding {
         this.preferredLocations = parameters.preferredLocations;
     }
 
-    public getRequiredProperties() {
-        return [...super.getRequiredProperties(), "id", "partitionKey"];
-    }
-
-    public getOptionalProperties() {
-        return [...super.getOptionalProperties(), "sqlQuery", "preferredLocations"];
+    public getProperties(): Binding {
+        const coreProperties = super.getProperties();
+        if (!this.id) throw new Error("Missing required property 'id'")
+        if (!this.partitionKey) throw new Error("Missing required property 'partitionKey'")
+
+        const cosmosProperties = {
+            id: this.id,
+            partitionKey: this.partitionKey,
+            sqlQuery: this.sqlQuery,
+            preferredLocations: this.preferredLocations
+        };
+        return Object.assign({}, coreProperties, cosmosProperties);
     }
 }
 
@@ -169,11 +198,17 @@ export class CosmosDbOutput extends CosmosDbBinding implements OutputBinding {
         this.useMultipleWriteLocations = parameters.useMultipleWriteLocations;
     }
 
-    public getRequiredProperties() {
-        return [...super.getRequiredProperties(), "partitionKey"];
-    }
-
-    public getOptionalProperties() {
-        return [...super.getOptionalProperties(), "createIfNotExists", "collectionThroughput", "preferredLocations", "useMultipleWriteLocations"];
+    public getProperties(): Binding {
+        const coreProperties = super.getProperties();
+        if (!this.partitionKey) throw new Error("Missing required property 'partitionKey'")
+
+        const cosmosProperties = {
+            partitionKey: this.partitionKey,
+            createIfNotExists: this.createIfNotExists,
+            collectionThroughput: this.collectionThroughput,
+            preferredLocations: this.preferredLocations,
+            useMultipleWriteLocations: this.useMultipleWriteLocations
+        };
+        return Object.assign({}, coreProperties, cosmosProperties);
     }
 }

bindings/core/eventHubBinding.ts

@@ -1,4 +1,4 @@
-import { BindingBase, Trigger, InputBinding, OutputBinding } from "../../src/types/bindings/bindings"
+import { BindingBase, Trigger, Binding, OutputBinding } from "../../src/types/bindings"
 
 /**
  * EventHub Binding
@@ -24,8 +24,16 @@ class EventHubBinding extends BindingBase {
         this.connection = parameters.connection;
     }
 
-    public getRequiredProperties() {
-        return [...super.getRequiredProperties(), "path", "connection"];
+    public getProperties(): Binding {
+        const coreProperties = super.getProperties();
+        if (!this.path) throw new Error("Missing required property 'path'")
+        if (!this.connection) throw new Error("Missing required property 'connection'")
+
+        const eventHubProperties = {
+            path: this.path,
+            connection: this.connection
+        };
+        return Object.assign({}, coreProperties, eventHubProperties);
     }
 }
 
@@ -54,12 +62,15 @@ export class EventHubTrigger extends EventHubBinding implements Trigger {
         this.cardinality = parameters.cardinality;
     }
 
-    public getRequiredProperties() {
-        return [...super.getRequiredProperties(), "consumerGroup"];
-    }
+    public getProperties(): Binding {
+        const coreProperties = super.getProperties();
+        if (!this.consumerGroup) throw new Error("Missing required property 'consumerGroup'")
 
-    public getOptionalProperties() {
-        return [...super.getOptionalProperties(), "cardinality"];
+        const eventHubProperties = {
+            consumerGroup: this.consumerGroup,
+            cardinality: this.cardinality
+        };
+        return Object.assign({}, coreProperties, eventHubProperties);
     }
 }
 

bindings/core/httpBinding.ts

@@ -1,4 +1,4 @@
-import { Trigger, OutputBinding, TriggerType } from "../../src/types/bindings/bindings"
+import { Trigger, OutputBinding, TriggerType, Binding } from "../../src/types/bindings"
 
 export const HttpTriggerType: TriggerType = "httpTrigger";
 
@@ -39,12 +39,21 @@ export class HttpTrigger implements Trigger {
         this.webHookType = parameters.webHookType;
     }
 
-    public getRequiredProperties() {
-        return ["name", "type", "direction", "authLevel"];
-    }
+    public getProperties(): Binding {
+        if (!this.name) throw new Error("Missing required property 'name'")
+        if (!this.type) throw new Error("Missing required property 'type'")
+        if (!this.direction) throw new Error("Missing required property 'direction'")
+        if (!this.authLevel) throw new Error("Missing required property 'authLevel'")
 
-    public getOptionalProperties() {
-        return ["route", "webHookType", "methods"];
+        return {
+            name: this.name,
+            type: this.type,
+            direction: this.direction,
+            authLevel: this.authLevel,
+            route: this.route,
+            webHookType: this.webHookType,
+            methods: this.methods
+        };
     }
 }
 
@@ -59,11 +68,15 @@ export class HttpResponse implements OutputBinding {
         this.name = parameters.bindingName;
     }
 
-    public getRequiredProperties() {
-        return ["name", "type", "direction"];
-    }
+    public getProperties(): Binding {
+        if (!this.name) throw new Error("Missing required property 'name'")
+        if (!this.type) throw new Error("Missing required property 'type'")
+        if (!this.direction) throw new Error("Missing required property 'direction'")
 
-    getOptionalProperties() {
-        return [];
+        return {
+            name: this.name,
+            type: this.type,
+            direction: this.direction
+        };
     }
 }

bindings/core/queueBinding.ts

@@ -1,4 +1,4 @@
-import { BindingBase, Trigger, OutputBinding, TriggerType } from "../../src/types/bindings/bindings"
+import { BindingBase, Binding, Trigger, OutputBinding, TriggerType } from "../../src/types/bindings"
 
 export const QueueTriggerType: TriggerType = "queueTrigger";
 
@@ -26,8 +26,16 @@ class QueueBinding extends BindingBase {
         this.queueName = parameters.queueName;
     }
 
-    public getRequiredProperties() {
-        return [...super.getRequiredProperties(), "queueName", "connection"];
+    public getProperties(): Binding {
+        const coreProperties = super.getProperties();
+        if (!this.queueName) throw new Error("Missing required property 'queueName'")
+        if (!this.connection) throw new Error("Missing required property 'connection'")
+
+        const queueProperties = {
+            queueName: this.queueName,
+            connection: this.connection
+        };
+        return Object.assign({}, coreProperties, queueProperties);
     }
 }
 

bindings/core/serviceBusBinding.ts

@@ -1,4 +1,4 @@
-import { BindingBase, Trigger, OutputBinding } from "../../src/types/bindings/bindings"
+import { BindingBase, Trigger, OutputBinding, Binding } from "../../src/types/bindings"
 
 /**
  * Service bus binding
@@ -40,15 +40,21 @@ class ServiceBusBinding extends BindingBase {
         this.subscriptionName = parameters.subscriptionName;
         this.connection = parameters.connection;
         this.accessRights = parameters.accessRights;
-        this.dataType = parameters.dataType;
     }
 
-    public getRequiredProperties() {
-        return [...super.getRequiredProperties(), "connection", "subscriptionName", "connection"];
-    }
+    public getProperties(): Binding {
+        const coreProperties = super.getProperties();
+        if (!this.connection) throw new Error("Missing required property 'connection'")
+        if (!this.subscriptionName) throw new Error("Missing required property 'subscriptionName'")
 
-    public getOptionalProperties() {
-        return [...super.getOptionalProperties(), "queueName", "topicName", "accessRights"];
+        const serviceBusProperties = {
+            queueName: this.queueName,
+            connection: this.connection,
+            subscriptionName: this.subscriptionName,
+            topicName: this.topicName,
+            accessRights: this.accessRights
+        };
+        return Object.assign({}, coreProperties, serviceBusProperties);
     }
 }
 

bindings/core/timerBinding.ts

@@ -1,4 +1,4 @@
-import { BindingBase, Trigger } from "../../src/types/bindings/bindings"
+import { BindingBase, Trigger, Binding } from "../../src/types/bindings"
 
 /**
  * Timer binding
@@ -31,11 +31,15 @@ export class TimerTrigger extends BindingBase implements Trigger {
         this.runOnStartup = parameters.runOnStartup;
     }
 
-    public getRequiredProperties() {
-        return [...super.getRequiredProperties(), "schedule"];
-    }
+    public getProperties(): Binding {
+        const coreProperties = super.getProperties();
+        if (!this.schedule) throw new Error("Missing required property 'schedule'")
 
-    public getOptionalProperties() {
-        return [...super.getOptionalProperties(), "useMonitor", "runOnStartup"];
+        const serviceBusProperties = {
+            schedule: this.schedule,
+            useMonitor: this.useMonitor,
+            runOnStartup: this.runOnStartup
+        };
+        return Object.assign({}, coreProperties, serviceBusProperties);
     }
 }