build: add tsc type checking in the ci/test pipeline

This commit introduces TypeScript checks and generates type declarations
for the existing JavaScript codebase using `tsc` prior to running the linter task.

Ref: #9
Signed-off-by: Lance Ball <[email protected]>

Author: lance

index.d.ts

@@ -0,0 +1,2 @@
+export const CloudEvent: typeof import("./lib/cloudevent.js");
+export const HTTPReceiver: typeof import("./lib/bindings/http/http_receiver.js");

lib/bindings/http/commons.d.ts

@@ -0,0 +1,2 @@
+export function sanityAndClone(headers: any): {};
+export function sanityContentType(contentType: any): any;

lib/bindings/http/constants.d.ts

@@ -0,0 +1,62 @@
+declare const _exports: {
+    readonly HEADERS: string;
+    readonly CHARSET_DEFAULT: string;
+    readonly SPEC_V03: string;
+    readonly SPEC_V1: string;
+    readonly DEFAULT_SPEC_VERSION_HEADER: string;
+    readonly ENCODING_BASE64: string;
+    readonly DATA_ATTRIBUTE: string;
+    readonly MIME_JSON: string;
+    readonly MIME_OCTET_STREAM: string;
+    readonly MIME_CE: string;
+    readonly MIME_CE_JSON: string;
+    readonly HEADER_CONTENT_TYPE: string;
+    readonly DEFAULT_CONTENT_TYPE: string;
+    readonly DEFAULT_CE_CONTENT_TYPE: string;
+    readonly BINARY_HEADERS_03: {
+        TYPE: string;
+        SPEC_VERSION: string;
+        SOURCE: string;
+        ID: string;
+        TIME: string;
+        SCHEMA_URL: string;
+        CONTENT_ENCONDING: string;
+        SUBJECT: string;
+        EXTENSIONS_PREFIX: string;
+    };
+    readonly STRUCTURED_ATTRS_03: {
+        TYPE: string;
+        SPEC_VERSION: string;
+        SOURCE: string;
+        ID: string;
+        TIME: string;
+        SCHEMA_URL: string;
+        CONTENT_ENCONDING: string;
+        CONTENT_TYPE: string;
+        SUBJECT: string;
+        DATA: string;
+    };
+    readonly BINARY_HEADERS_1: {
+        TYPE: string;
+        SPEC_VERSION: string;
+        SOURCE: string;
+        ID: string;
+        TIME: string;
+        DATA_SCHEMA: string;
+        SUBJECT: string;
+        EXTENSIONS_PREFIX: string;
+    };
+    readonly STRUCTURED_ATTRS_1: {
+        TYPE: string;
+        SPEC_VERSION: string;
+        SOURCE: string;
+        ID: string;
+        TIME: string;
+        DATA_SCHEMA: string;
+        CONTENT_TYPE: string;
+        SUBJECT: string;
+        DATA: string;
+        DATA_BASE64: string;
+    };
+};
+export = _exports;

lib/bindings/http/http_receiver.d.ts

@@ -0,0 +1,26 @@
+export = HTTPReceiver;
+/**
+ * A class to receive a CloudEvent from an HTTP POST request.
+ */
+declare class HTTPReceiver {
+    receivers: {
+        v1: {
+            structured: import("./receiver_structured_1.js");
+            binary: import("./receiver_binary_1.js");
+        };
+        v03: {
+            structured: import("./receiver_structured_0_3.js");
+            binary: import("./receiver_binary_0_3.js");
+        };
+    };
+    /**
+     * Acceptor for an incoming HTTP CloudEvent POST. Can process
+     * binary and structured incoming CloudEvents.
+     *
+     * @param {Object} headers HTTP headers keyed by header name ("Content-Type")
+     * @param {Object|JSON} body The body of the HTTP request
+     // @ts-ignore tsc can't find CloudEvent - is that because it's not imported?
+     * @return {CloudEvent} A new {CloudEvent} instance
+     */
+    accept(headers: any, body: any): any;
+}

lib/bindings/http/http_receiver.js

@@ -38,6 +38,7 @@ class HTTPReceiver {
    *
    * @param {Object} headers HTTP headers keyed by header name ("Content-Type")
    * @param {Object|JSON} body The body of the HTTP request
+   // @ts-ignore tsc can't find CloudEvent - is that because it's not imported?
    * @return {CloudEvent} A new {CloudEvent} instance
    */
   accept(headers, body) {
@@ -76,8 +77,7 @@ function getVersion(mode, headers, body) {
     if (versionHeader) { version = versionHeader; }
   } else {
     // structured mode - the version is in the body
-    version = body instanceof String
-      ? JSON.parse(body).specversion : body.specversion;
+    version = (typeof body == "string") ? JSON.parse(body).specversion : body.specversion;
   }
   return version;
 }

lib/bindings/http/receiver_binary.d.ts

@@ -0,0 +1,16 @@
+export = BinaryHTTPReceiver;
+declare function BinaryHTTPReceiver(parsersByEncoding: any, setterByHeader: any, allowedContentTypes: any, requiredHeaders: any, Spec: any, specversion: any, extensionsPrefix: any, checkDecorator: any): void;
+declare class BinaryHTTPReceiver {
+    constructor(parsersByEncoding: any, setterByHeader: any, allowedContentTypes: any, requiredHeaders: any, Spec: any, specversion: any, extensionsPrefix: any, checkDecorator: any);
+    parsersByEncoding: any;
+    setterByHeader: any;
+    allowedContentTypes: any;
+    requiredHeaders: any;
+    Spec: any;
+    spec: any;
+    specversion: any;
+    extensionsPrefix: any;
+    checkDecorator: any;
+    check(payload: any, headers: any): void;
+    parse(payload: any, headers: any): import("../../cloudevent.js");
+}

lib/bindings/http/receiver_binary_0_3.d.ts

@@ -0,0 +1,8 @@
+export = Receiver;
+declare function Receiver(configuration: any): void;
+declare class Receiver {
+    constructor(configuration: any);
+    receiver: import("./receiver_binary.js");
+    check(payload: any, headers: any): void;
+    parse(payload: any, headers: any): import("../../cloudevent.js");
+}

lib/bindings/http/receiver_binary_1.d.ts

@@ -0,0 +1,8 @@
+export = Receiver;
+declare function Receiver(configuration: any): void;
+declare class Receiver {
+    constructor(configuration: any);
+    receiver: import("./receiver_binary.js");
+    check(payload: any, headers: any): void;
+    parse(payload: any, headers: any): import("../../cloudevent.js");
+}

lib/bindings/http/receiver_structured.d.ts

@@ -0,0 +1,12 @@
+export = StructuredHTTPReceiver;
+declare function StructuredHTTPReceiver(parserByMime: any, parserMap: any, allowedContentTypes: any, Spec: any): void;
+declare class StructuredHTTPReceiver {
+    constructor(parserByMime: any, parserMap: any, allowedContentTypes: any, Spec: any);
+    parserByMime: any;
+    parserMap: any;
+    allowedContentTypes: any;
+    Spec: any;
+    spec: any;
+    check(payload: any, headers: any): void;
+    parse(payload: any, headers: any): import("../../cloudevent.js");
+}

lib/bindings/http/receiver_structured_0_3.d.ts

@@ -0,0 +1,8 @@
+export = Receiver;
+declare function Receiver(configuration: any): void;
+declare class Receiver {
+    constructor(configuration: any);
+    receiver: import("./receiver_structured.js");
+    check(payload: any, headers: any): void;
+    parse(payload: any, headers: any): import("../../cloudevent.js");
+}