add test, exit beta

Author: tylim88

.github/workflows/all-except-main-push.yml

@@ -16,12 +16,5 @@ jobs:
       - run: npm run lint --fix
       - run: npm run pretty-quick
       - run: npm test
-        # env:
-        #   PROJECT_ID: ${{ secrets.PROJECT_ID }}
       - run: npm run build
-      # - run: npm run link
-      # - run: npm run b-tsc
-      # - run: npm run b-test
-      #   env:
-      #     PROJECT_ID: ${{ secrets.PROJECT_ID }}
       - uses: codecov/codecov-action@v2

.github/workflows/all-pull-request.yml

@@ -15,12 +15,5 @@ jobs:
       - run: npm run lint --fix
       - run: npm run pretty-quick
       - run: npm test
-        # env:
-        #   PROJECT_ID: ${{ secrets.PROJECT_ID }}
       - run: npm run build
-        # - run: npm run link
-        # - run: npm run b-tsc
-        # - run: npm run b-test
-        # env:
-        #   PROJECT_ID: ${{ secrets.PROJECT_ID }}
       - uses: codecov/codecov-action@v2

.github/workflows/main.yml

@@ -18,7 +18,3 @@ jobs:
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-      # - run: npm run p-reinstall
-      # - run: npm run p-test
-      # env:
-      #   PROJECT_ID: ${{ secrets.PROJECT_ID }}

.gitignore

@@ -19,6 +19,9 @@
 .env.test.local
 .env.production.local
 /.config
-.env
 /.parcel-cache
+
+# env
+env.json
+.env
 .firebaserc

.husky/pre-commit

@@ -3,6 +3,4 @@
 
 npm run lint --fix
 npm run pretty-quick
-npm run build 
-npm run d-test
-# npm run d-b-test
+npm run d-test

.npmignore

@@ -22,12 +22,16 @@ tsconfig.json
 .eslintrc.js
 .prettierrc.js
 babel.config.js    
-.env
 jest.config.doc.js
 tsconfig.doc.json
 lgtm.yml
 tsconfig.prod.json
 
+# env
+env.json
+.env
+.firebaserc
+
 # types
 /types/**/*
 !/types/**/*.ts
@@ -41,5 +45,4 @@ CHANGELOG.md
 package-lock.json
 firebase.json
 .eslintignore
-.firebaserc
 note.txt

README.md

@@ -4,7 +4,7 @@
 
 <div align="center">
 		<img src="https://raw.githubusercontent.com/tylim88/Firelord/main/img/ozai.png" width="200px"/>
-		<h1>FireCall 烈火唤(Beta)</h1>
+		<h1>FireCall 烈火唤</h1>
 </div>
 
 <div align="center">
@@ -39,6 +39,54 @@
 				src="https://img.shields.io/badge/gzipped-2KB-brightgreen"
 				alt="package size"
 			/>
+			&nbsp;
+			<a href="https://github.com/tylim88/FireCall/actions" target="_blank">
+				<img
+					src="https://github.com/tylim88/FireCall/workflows/Main/badge.svg"
+					alt="github action"
+				/>
+			</a>
+			&nbsp;
+			<a href="https://codecov.io/gh/tylim88/FireCall" target="_blank">
+				<img
+					src="https://codecov.io/gh/tylim88/FireCall/branch/main/graph/badge.svg"
+					alt="code coverage"
+				/>
+			</a>
+			&nbsp;
+			<a href="https://github.com/tylim88/FireCall/issues" target="_blank">
+				<img
+					alt="GitHub issues"
+					src="https://img.shields.io/github/issues-raw/tylim88/FireCall"
+				></img>
+			</a>
+			&nbsp;
+			<a href="https://snyk.io/test/github/tylim88/FirelordJS" target="_blank">
+				<img
+					src="https://snyk.io/test/github/tylim88/FirelordJS/badge.svg"
+					alt="code coverage"
+				/>
+			</a>
+			&nbsp;
+			<a
+				href="https://lgtm.com/projects/g/tylim88/FireCall/alerts/"
+				target="_blank"
+			>
+				<img
+					alt="Total alerts"
+					src="https://img.shields.io/lgtm/alerts/g/tylim88/FireCall.svg?logo=lgtm&logoWidth=18"
+				/>
+			</a>
+			&nbsp;
+			<a
+				href="https://lgtm.com/projects/g/tylim88/FireCall/context:javascript"
+				target="_blank"
+			>
+				<img
+					alt="Language grade: JavaScript"
+					src="https://img.shields.io/lgtm/grade/javascript/g/tylim88/FireCall.svg?logo=lgtm&logoWidth=18"
+				/>
+			</a>
 			<br/>
 			<br/>
 			<p>🔥 Write callable functions systematically like a Firelord. No more chaotic error handling, no more unsafe endpoint data type, no more messy validation. Be the Master of Fire you always wanted to be.</p>
@@ -64,6 +112,8 @@ Ensuring:
 
 Optional: For maximum benefit, please use [FireCaller](https://github.com/tylim88/firecaller) in front end.
 
+support [firebase-functions-test](#firebase-function-test):
+
 ## Why Do You Need This? What Is The Problem FireCall Trying To Solve?
 
 When coding a callable function (or any endpoint in general), we need to deal with 5 basic errors, which is basically 99% of your errors, the rest are system errors.
@@ -92,7 +142,7 @@ Long thing short, FireCall make sure that there is only one way to do stuff and
 
 ## Related Projects
 
-1. [FirelordJS](https://github.com/tylim88/Firelordjs) - Typescript wrapper for Firestore Web V9
+1. [FirelordJS](https://github.com/tylim88/FireCall) - Typescript wrapper for Firestore Web V9
 2. [Firelord](https://github.com/tylim88/Firelord) - Typescript wrapper for Firestore Admin
 3. [Firelordrn](https://github.com/tylim88/firelordrn) - Typescript wrapper for Firestore React Native
 4. [FireLaw](https://github.com/tylim88/firelaw) - Write Firestore security rule with Typescript, utilizing Firelord type engine.
@@ -233,6 +283,76 @@ exp(allFunc).forEach(func => {
 })
 ```
 
+## Firebase Function Test
+
+You can use FireCall with [firebase-functions-test](https://firebase.google.com/docs/functions/unit-testing):
+
+ok test example:
+
+```ts
+const wrapped = test.wrap(
+	onCall(
+		schema,
+		{
+			route: 'private',
+		},
+		async () => {
+			return { code: 'ok', data: 'okie' }
+		}
+	).onCall
+)
+await expect(wrapped('123', { auth: { uid: '123' } })).resolves.toEqual('okie')
+```
+
+error tests examples:
+
+```ts
+const wrapped = test.wrap(
+	onCall(
+		schema,
+		{
+			route: 'private',
+		},
+		() => {
+			return { code: 'cancelled', message: 'cancelled' }
+		}
+	).onCall
+)
+await expect(wrapped('123', { auth: { uid: '123' } })).rejects.toEqual(
+	new functions.https.HttpsError('cancelled', 'cancelled')
+)
+
+const wrapped = test.wrap(
+	onCall(
+		schema,
+		{
+			route: 'private',
+		},
+		async () => {
+			return { code: 'ok', data: 'okRes' }
+		}
+	).onCall
+)
+await expect(wrapped('123')).rejects.toEqual(
+	new functions.https.HttpsError('unauthenticated', 'Please Login First')
+)
+```
+
+## Const Assertion
+
+You can use const assertion if the handler is returning response from another callback, example from the transaction.
+
+```ts
+import { onCall } from 'firecall'
+
+export const someFun = onCall(someSchema, { route: 'private' }, async () => {
+	// return the transaction
+	return await db.runTransaction(async transaction => {
+		return { code: 'ok', data: null } as const // do const assertion here
+	})
+})
+```
+
 ## Function Builder
 
 If you need custom setting for you function like changing ram or region, you can pass function builder to `onCall` config.
@@ -295,21 +415,6 @@ Whatever object literal the function return and(empty object = nothing to log) g
 
 `logType` props is an optional prop that set the type of your log, by default it is `error`.
 
-## Const Assertion
-
-You can use const assertion if the handler is returning response from another callback, example from the transaction.
-
-```ts
-import { onCall } from 'firecall'
-
-export const someFun = onCall(someSchema, { route: 'private' }, async () => {
-	// return the transaction
-	return await db.runTransaction(async transaction => {
-		return { code: 'ok', data: null } as const // do const assertion here
-	})
-})
-```
-
 ## Change Built In Error Message
 
 Here is how you change the built in error message:

babel.config.js

@@ -0,0 +1,13 @@
+module.exports = {
+	presets: [
+		'@babel/preset-typescript',
+		[
+			'@babel/preset-env',
+			{
+				targets: {
+					node: 'current',
+				},
+			},
+		],
+	],
+}