feat: introduce browser support

lance · lance · commit ad72693d76a2 · 2020-06-01T14:53:48.000-04:00
This commit introduces a second `tsc` execution which generates JS in ES5 form.
Then, webpack is used to generate a browser bundle.

WIP: Tests still pending.
Signed-off-by: Lance Ball &lt;lball@redhat.com&gt;
diff --git a/.gitignore b/.gitignore
@@ -8,7 +8,9 @@ yarn-error.log*
 # Generated files
 *.d.ts
 index.js
-lib
+/lib
+/browser
+/_bundles
 
 # Runtime data
 pids
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -5,7 +5,7 @@
   "main": "index.js",
   "scripts": {
     "watch": "tsc --project tsconfig.json --watch",
-    "build": "tsc --project tsconfig.json",
+    "build": "tsc --project tsconfig.json && tsc --project tsconfig.browser.json && webpack",
     "prelint": "npm run build",
     "lint": "standardx src examples",
     "fix": "standardx --fix",
@@ -105,6 +105,7 @@
     "@types/ajv": "^1.0.0",
     "@types/axios": "^0.14.0",
     "@types/node": "^13.13.9",
+    "awesome-typescript-loader": "^5.2.1",
     "chai": "~4.2.0",
     "eslint-config-standard": "^14.1.1",
     "eslint-plugin-import": "^2.20.2",
@@ -114,7 +115,11 @@
     "nyc": "~15.0.0",
     "standard-version": "^7.1.0",
     "standardx": "^5.0.0",
-    "typescript": "^3.8.3"
+    "ts-loader": "^7.0.5",
+    "typescript": "^3.8.3",
+    "uglifyjs-webpack-plugin": "^2.2.0",
+    "webpack": "^4.43.0",
+    "webpack-cli": "^3.3.11"
   },
   "publishConfig": {
     "access": "public"
diff --git a/src/lib/bindings/http/emitter_binary.js b/src/lib/bindings/http/emitter_binary.js
@@ -11,7 +11,7 @@ const {
   DATA_ATTRIBUTE,
   SPEC_V1,
   SPEC_V03
-} = require("./constants.js");
+} = require("./constants");
 
 const defaults = {
   [HEADERS]: {
diff --git a/src/lib/bindings/http/emitter_structured.js b/src/lib/bindings/http/emitter_structured.js
@@ -7,7 +7,7 @@ const {
   DEFAULT_CE_CONTENT_TYPE,
   HEADERS,
   HEADER_CONTENT_TYPE
-} = require("./constants.js");
+} = require("./constants");
 
 const defaults = {
   [HEADERS]: {
diff --git a/src/lib/bindings/http/receiver_binary.js b/src/lib/bindings/http/receiver_binary.js
@@ -1,7 +1,7 @@
 const ReceiverV1 = require("./v1/receiver_binary_1.js");
 const ReceiverV3 = require("./v03/receiver_binary_0_3.js");
 
-const { SPEC_V03, SPEC_V1 } = require("./constants.js");
+const { SPEC_V03, SPEC_V1 } = require("./constants");
 const { check, parse } = require("./validation/binary.js");
 
 /** @typedef {import("../../cloudevent")} CloudEvent */
diff --git a/src/lib/bindings/http/receiver_structured.js b/src/lib/bindings/http/receiver_structured.js
@@ -1,7 +1,7 @@
 const ReceiverV1 = require("./v1/receiver_structured_1.js");
 const ReceiverV3 = require("./v03/receiver_structured_0_3.js");
 
-const { SPEC_V03, SPEC_V1 } = require("./constants.js");
+const { SPEC_V03, SPEC_V1 } = require("./constants");
 const { check, parse } = require("./validation/structured.js");
 
 /** @typedef {import("../../cloudevent")} CloudEvent */
diff --git a/src/lib/bindings/http/v03/emitter_binary_0_3.js b/src/lib/bindings/http/v03/emitter_binary_0_3.js
@@ -10,7 +10,7 @@ const {
    TIME,
    SCHEMA_URL
   }
-} = require("../constants.js");
+} = require("../constants");
 
 function parser(header, parser = (v) => v) {
   return { headerName: header, parse: parser };
diff --git a/src/lib/bindings/http/v03/receiver_binary_0_3.js b/src/lib/bindings/http/v03/receiver_binary_0_3.js
@@ -5,7 +5,7 @@ const {
   ENCODING_BASE64,
   HEADER_CONTENT_TYPE,
   BINARY_HEADERS_03
-} = require("../constants.js");
+} = require("../constants");
 const Spec = require("./spec_0_3.js");
 
 const JSONParser = require("../../../formats/json/parser.js");
diff --git a/src/lib/bindings/http/v03/receiver_structured_0_3.js b/src/lib/bindings/http/v03/receiver_structured_0_3.js
@@ -13,7 +13,7 @@ const {
     SUBJECT,
     DATA
   }
-} = require("../constants.js");
+} = require("../constants");
 const Spec = require("./spec_0_3.js");
 const JSONParser = require("../../../formats/json/parser.js");
 
diff --git a/src/lib/bindings/http/v1/emitter_binary_1.js b/src/lib/bindings/http/v1/emitter_binary_1.js
@@ -9,7 +9,7 @@ const {
    TIME,
    DATA_SCHEMA
  }
-} = require("../constants.js");
+} = require("../constants");
 
 function parser(header, parser = (v) => v) {
   return { headerName: header, parse: parser };
diff --git a/src/lib/bindings/http/v1/receiver_structured_1.js b/src/lib/bindings/http/v1/receiver_structured_1.js
@@ -13,7 +13,7 @@ const {
     DATA_BASE64,
     MIME_JSON
   }
-} = require("../constants.js");
+} = require("../constants");
 
 const Spec = require("./spec_1.js");
 const JSONParser = require("../../../formats/json/parser.js");
diff --git a/src/lib/bindings/http/validation/binary.js b/src/lib/bindings/http/validation/binary.js
@@ -9,7 +9,7 @@ const {
   HEADER_CONTENT_TYPE,
   MIME_JSON,
   DEFAULT_SPEC_VERSION_HEADER
-} = require("../constants.js");
+} = require("../constants");
 
 const {
   isString,
diff --git a/src/lib/bindings/http/validation/commons.js b/src/lib/bindings/http/validation/commons.js
@@ -1,5 +1,5 @@
 const ValidationError = require("./validation_error.js");
-const Constants = require("../constants.js");
+const Constants = require("../constants");
 const {
   isDefinedOrThrow,
   isStringOrObjectOrThrow
diff --git a/src/lib/bindings/http/validation/structured.js b/src/lib/bindings/http/validation/structured.js
@@ -6,7 +6,7 @@ const {
 } = require("./commons.js");
 const {
   HEADER_CONTENT_TYPE
-} = require("../constants.js");
+} = require("../constants");
 
 function check(payload, headers, receiver) {
   validateArgs(payload, headers);
diff --git a/src/lib/cloudevent.ts b/src/lib/cloudevent.ts
@@ -6,7 +6,7 @@ import Spec03 from "./bindings/http/v03/spec_0_3.js";
 import Formatter from "./formats/json/formatter.js";
 import { isBinary } from "./bindings/http/validation/fun.js";
 
-const { SPEC_V1, SPEC_V03 } = require("./bindings/http/constants.js");
+const { SPEC_V1, SPEC_V03 } = require("./bindings/http/constants");
 
 export type CE = CloudEventV1 | CloudEventV1Attributes | CloudEventV03 | CloudEventV03Attributes
 
diff --git a/tsconfig.browser.json b/tsconfig.browser.json
@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "allowJs": true,                          /* Allow javascript files to be compiled. */
+    "checkJs": false,                          /* Report errors in .js files. */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    "baseUrl": ".",
+    "outDir": "./browser",
+    "target": "es5",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "lib": ["es2016", "dom", "es5"]
+  },
+  "include": [
+    "src/**/*.ts"
+  ]
+}
diff --git a/webpack.config.js b/webpack.config.js
@@ -0,0 +1,15 @@
+const path = require("path");
+
+module.exports = {
+  entry: {
+    "cloudevents-sdk": "./browser/index.js"
+  },
+  output: {
+    path: path.resolve(__dirname, "_bundles"),
+    filename: "[name].js",
+    libraryTarget: "umd",
+    library: "cloudevents-sdk",
+    umdNamedDefine: true
+  },
+  devtool: "source-map"
+};

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ const {`
`10`	`10`	`TIME,`
`11`	`11`	`SCHEMA_URL`
`12`	`12`	`}`
`13`		`-} = require("../constants.js");`
	`13`	`+} = require("../constants");`
`14`	`14`
`15`	`15`	`function parser(header, parser = (v) => v) {`
`16`	`16`	`return { headerName: header, parse: parser };`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ const {`
`13`	`13`	`SUBJECT,`
`14`	`14`	`DATA`
`15`	`15`	`}`
`16`		`-} = require("../constants.js");`
	`16`	`+} = require("../constants");`
`17`	`17`	`const Spec = require("./spec_0_3.js");`
`18`	`18`	`const JSONParser = require("../../../formats/json/parser.js");`
`19`	`19`