feat(bundle): Added support for running without bundler

grantila · grantila · commit 113f94037f83 · 2019-07-15T16:19:04.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 node_modules
 generated-*
 dist
+dist-bundle
+bundle.js
diff --git a/README.md b/README.md
@@ -8,6 +8,8 @@ U2F API for browsers
 
 ## History
 
+- 1.1.0
+    - Can be used [without bundler](#using-without-bundler)
 - 1.0.0
 	- Support for custom promise libraries removed
 	- Promises no longer cancellable
@@ -103,6 +105,16 @@ var u2fApi = require( 'u2f-api' ); // CommonJS
 import u2fApi from 'u2f-api' // ES modules
 ```
 
+#### Using without bundler
+
+`u2f-api` can be used without a bundler (like Webpack). Just include:
+
+```html
+<head><script src="https://cdn.jsdelivr.net/npm/u2f-api@latest/bundle.js"></script></head>
+```
+
+The functionality will be in the `window.u2fApi` object.
+
 
 ### Registering a passkey
 
diff --git a/external.d.ts b/external.d.ts
@@ -0,0 +1 @@
+declare module "jsdom";
diff --git a/google/modules.patch b/google/modules.patch
@@ -0,0 +1,11 @@
+--- generated-google-u2f-api.js	2019-07-15 16:08:47.000000000 +0200
++++ generated-google-u2f-api.js	2019-07-15 16:08:52.000000000 +0200
+@@ -16,7 +16,7 @@
+  */
+ var u2f = u2f || {};
+
+-module.exports.chromeApi = u2f; // Adaptation for u2f-api package
++export const chromeApi = u2f; // Adaptation for u2f-api package
+
+ /**
+  * FIDO U2F Javascript API Version
diff --git a/google/this.patch b/google/this.patch
@@ -1,10 +1,19 @@
 --- google-u2f-api.js	2018-03-20 12:07:45.000000000 +0100
 +++ generated-google-u2f-api.js	2018-03-20 13:38:17.000000000 +0100
+@@ -7,7 +7,7 @@
+ /**
+  * @fileoverview The U2F api.
+  */
+-'use strict';
++// 'use strict';
+
+
+ /**
 @@ -16,6 +16,8 @@
   */
  var u2f = u2f || {};
  
-+module.exports = u2f; // Adaptation for u2f-api package
++module.exports.chromeApi = u2f; // Adaptation for u2f-api package
 +
  /**
   * FIDO U2F Javascript API Version
diff --git a/index.bundle.ts b/index.bundle.ts
@@ -0,0 +1,5 @@
+'use strict';
+
+import * as u2fApi from './lib/u2f-api'
+
+( < any >window ).u2fApi = u2fApi;
diff --git a/lib/u2f-api.ts b/lib/u2f-api.ts
@@ -1,6 +1,7 @@
 'use strict';
 
-import * as chromeApi from './generated-google-u2f-api'
+// @ts-ignore
+import { chromeApi } from './generated-google-u2f-api'
 
 
 // Feature detection (yes really)
@@ -40,6 +41,12 @@ export interface SignResponse {
 	signatureData: string;
 }
 
+interface BackendError {
+	errorCode: keyof typeof ErrorCodes;
+}
+
+type OrError< T > = T & BackendError;
+
 export type Transport = 'bt' | 'ble' | 'nfc' | 'usb';
 export type Transports = Array< Transport >;
 
@@ -50,7 +57,7 @@ export interface RegisteredKey {
 	appId: string;
 }
 
-var _backend: Promise< API > = null;
+var _backend: Promise< API > | null = null;
 function getBackend( )
 {
 	if ( _backend )
@@ -93,7 +100,7 @@ function getBackend( )
 			return notSupported( );
 
 		// Test for google extension support
-		chromeApi.isSupported( function( ok )
+		chromeApi.isSupported( function( ok: any )
 		{
 			if ( ok )
 				resolve( { u2f: chromeApi } );
@@ -128,10 +135,10 @@ export const ErrorNames = {
 	"5": "TIMEOUT"
 };
 
-function makeError( msg, err )
+function makeError( msg: string, err: BackendError )
 {
 	const code = err != null ? err.errorCode : 1; // Default to OTHER_ERROR
-	const type = ErrorNames[ '' + code ];
+	const type = ErrorNames[ < keyof typeof ErrorNames >( '' + code ) ];
 	const error = new Error( msg );
 	( < any >error ).metaData = { type, code };
 	return error;
@@ -143,7 +150,7 @@ export function isSupported( )
 	.then( backend => !!backend.u2f );
 }
 
-function _ensureSupport( backend )
+function _ensureSupport( backend: API )
 {
 	if ( !backend.u2f )
 	{
@@ -196,7 +203,7 @@ export function register(
 	if ( typeof signRequests === 'number' && typeof timeout === 'undefined' )
 	{
 		timeout = signRequests;
-		signRequests = null;
+		signRequests = [ ];
 	}
 
 	const _signRequests = arrayify(
@@ -212,7 +219,7 @@ export function register(
 
 		return new Promise< RegisterResponse >( function( resolve, reject )
 		{
-			function callback( response )
+			function callback( response: OrError< RegisterResponse > )
 			{
 				if ( response.errorCode )
 					reject( makeError( "Registration failed", response ) );
@@ -248,7 +255,7 @@ export function sign(
 
 		return new Promise< SignResponse >( function( resolve, reject )
 		{
-			function callback( response )
+			function callback( response: OrError< SignResponse > )
 			{
 				if ( response.errorCode )
 					reject( makeError( "Sign failed", response ) );
diff --git a/package.json b/package.json
@@ -9,10 +9,13 @@
     "url": "https://github.com/grantila/u2f-api.git"
   },
   "files": [
-    "dist"
+    "dist",
+    "bundle.js"
   ],
   "scripts": {
-    "build": "scripts/build.sh",
+    "build:lib": "scripts/build.sh",
+    "build:rollup": "node_modules/.bin/rimraf bundle.js && node_modules/.bin/rollup dist-bundle/index.bundle.js --file bundle.js --format iife",
+    "build": "yarn build:lib && yarn build:rollup",
     "test": "node_modules/.bin/mocha dist/test",
     "buildtest": "npm run build && npm run test",
     "travis-deploy-once": "travis-deploy-once",
@@ -35,6 +38,7 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "devDependencies": {
+    "@types/chai": "^4.1.7",
     "@types/mocha": "5.x",
     "already": "1.x",
     "chai": "4.x",
@@ -44,9 +48,11 @@
     "mocha": "6.x",
     "pre-commit": "1.x",
     "rimraf": "2.x",
+    "rollup": "^1.17.0",
     "semantic-release": "15.x",
     "source-map-support": "0.x",
     "travis-deploy-once": "5.x",
+    "ts-node": "^8.3.0",
     "typescript": "3.x"
   },
   "config": {
diff --git a/scripts/build.sh b/scripts/build.sh
@@ -3,7 +3,11 @@
 patch google/google-u2f-api.js google/this.patch -o lib/generated-google-u2f-api.js
 
 node_modules/.bin/rimraf dist
-
 node_modules/.bin/tsc -p .
-
 find test lib -name '*.js' | cpio -pdm dist/
+
+patch lib/generated-google-u2f-api.js < google/modules.patch
+
+node_modules/.bin/rimraf dist-bundle
+node_modules/.bin/tsc -p tsconfig.bundle.json
+find test lib -name '*.js' | cpio -pdm dist-bundle/
diff --git a/test/u2f-api/index.ts b/test/u2f-api/index.ts
@@ -1,5 +1,3 @@
-'use strict';
-
 declare var global: any;
 declare var require: any;
 
@@ -41,8 +39,8 @@ type KeyValues = Array< KeyValue >;
 class MonkeyPatcher
 {
 	_object: any;
-	_values: Array< string >;
-	_overwrittenValues: KeyValues;
+	_values: Array< string > = [ ];
+	_overwrittenValues: KeyValues = [ ];
 
 	constructor( obj: any )
 	{
@@ -133,7 +131,7 @@ interface MockProps
 
 function handleTimeout(
 	props: MockProps,
-	timeout,
+	timeout: number,
 	fn: ( ) => any
 )
 : Promise< any >
@@ -161,11 +159,11 @@ function u2fMock( props: MockProps = { } )
 
 	return {
 		sign(
-			appId,
-			challenge,
+			appId: string,
+			challenge: any,
 			registeredKeys: Array< u2fApi.RegisteredKey >,
-			cbNative,
-			timeout
+			cbNative: ( ) => void,
+			timeout: number
 		)
 		{
 			return handleTimeout( props, timeout, ( ) =>
@@ -186,11 +184,11 @@ function u2fMock( props: MockProps = { } )
 			.then( cbNative );
 		},
 		register(
-			appId,
+			appId: string,
 			registerRequests: Array< FakeRequest >,
 			signRequests: Array< FakeRequest >,
-			cbNative,
-			timeout
+			cbNative: ( ) => void,
+			timeout: number
 		)
 		{
 			return handleTimeout( props, timeout, ( ) =>
@@ -229,7 +227,7 @@ function wrappedTest(
 		{
 			const mock = ( props || { } ).mock || { };
 
-			dom.window.u2f = u2fMock( );
+			( < any >dom.window ).u2f = u2fMock( );
 		}
 
 		const gmp = new GlobalMonkeyPatcher( );
diff --git a/tsconfig.bundle.json b/tsconfig.bundle.json
@@ -0,0 +1,16 @@
+{
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"declaration": true,
+		"lib": [ "es2015", "es2017", "dom" ],
+		"outDir": "dist-bundle",
+		"sourceMap": true,
+		"module": "es6",
+		"target": "es5"
+	},
+	"include": [
+		"external.d.ts",
+		"index.bundle.ts",
+		"src"
+	]
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -4,10 +4,12 @@
 		"lib": [ "es2015", "es2017", "dom" ],
 		"outDir": "dist",
 		"sourceMap": true,
+		"strict": true,
 		"module": "CommonJS",
 		"target": "es5"
 	},
 	"include": [
+		"external.d.ts",
 		"index.ts",
 		"src",
 		"test"

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`'use strict';`
`2`	`2`
`3`		`-import * as chromeApi from './generated-google-u2f-api'`
	`3`	`+// @ts-ignore`
	`4`	`+import { chromeApi } from './generated-google-u2f-api'`
`4`	`5`
`5`	`6`
`6`	`7`	`// Feature detection (yes really)`
`@@ -40,6 +41,12 @@ export interface SignResponse {`
`40`	`41`	`signatureData: string;`
`41`	`42`	`}`
`42`	`43`
	`44`	`+interface BackendError {`
	`45`	`+ errorCode: keyof typeof ErrorCodes;`
	`46`	`+}`
	`47`	`+`
	`48`	`+type OrError< T > = T & BackendError;`
	`49`	`+`
`43`	`50`	`export type Transport = 'bt' \| 'ble' \| 'nfc' \| 'usb';`
`44`	`51`	`export type Transports = Array< Transport >;`
`45`	`52`
`@@ -50,7 +57,7 @@ export interface RegisteredKey {`
`50`	`57`	`appId: string;`
`51`	`58`	`}`
`52`	`59`
`53`		`-var _backend: Promise< API > = null;`
	`60`	`+var _backend: Promise< API > \| null = null;`
`54`	`61`	`function getBackend( )`
`55`	`62`	`{`
`56`	`63`	`if ( _backend )`
`@@ -93,7 +100,7 @@ function getBackend( )`
`93`	`100`	`return notSupported( );`
`94`	`101`
`95`	`102`	`// Test for google extension support`
`96`		`- chromeApi.isSupported( function( ok )`
	`103`	`+ chromeApi.isSupported( function( ok: any )`
`97`	`104`	`{`
`98`	`105`	`if ( ok )`
`99`	`106`	`resolve( { u2f: chromeApi } );`
`@@ -128,10 +135,10 @@ export const ErrorNames = {`
`128`	`135`	`"5": "TIMEOUT"`
`129`	`136`	`};`
`130`	`137`
`131`		`-function makeError( msg, err )`
	`138`	`+function makeError( msg: string, err: BackendError )`
`132`	`139`	`{`
`133`	`140`	`const code = err != null ? err.errorCode : 1; // Default to OTHER_ERROR`
`134`		`- const type = ErrorNames[ '' + code ];`
	`141`	`+ const type = ErrorNames[ < keyof typeof ErrorNames >( '' + code ) ];`
`135`	`142`	`const error = new Error( msg );`
`136`	`143`	`( < any >error ).metaData = { type, code };`
`137`	`144`	`return error;`
`@@ -143,7 +150,7 @@ export function isSupported( )`
`143`	`150`	`.then( backend => !!backend.u2f );`
`144`	`151`	`}`
`145`	`152`
`146`		`-function _ensureSupport( backend )`
	`153`	`+function _ensureSupport( backend: API )`
`147`	`154`	`{`
`148`	`155`	`if ( !backend.u2f )`
`149`	`156`	`{`
`@@ -196,7 +203,7 @@ export function register(`
`196`	`203`	`if ( typeof signRequests === 'number' && typeof timeout === 'undefined' )`
`197`	`204`	`{`
`198`	`205`	`timeout = signRequests;`
`199`		`- signRequests = null;`
	`206`	`+ signRequests = [ ];`
`200`	`207`	`}`
`201`	`208`
`202`	`209`	`const _signRequests = arrayify(`
`@@ -212,7 +219,7 @@ export function register(`
`212`	`219`
`213`	`220`	`return new Promise< RegisterResponse >( function( resolve, reject )`
`214`	`221`	`{`
`215`		`- function callback( response )`
	`222`	`+ function callback( response: OrError< RegisterResponse > )`
`216`	`223`	`{`
`217`	`224`	`if ( response.errorCode )`
`218`	`225`	`reject( makeError( "Registration failed", response ) );`
`@@ -248,7 +255,7 @@ export function sign(`
`248`	`255`
`249`	`256`	`return new Promise< SignResponse >( function( resolve, reject )`
`250`	`257`	`{`
`251`		`- function callback( response )`
	`258`	`+ function callback( response: OrError< SignResponse > )`
`252`	`259`	`{`
`253`	`260`	`if ( response.errorCode )`
`254`	`261`	`reject( makeError( "Sign failed", response ) );`