Merge pull request #48 from tylim88/new-features

housekeeping

.opensource/project.json

@@ -7,7 +7,13 @@
 
 	"pages": [],
 
-	"related": ["tylim88/Firelordrn", "tylim88/Firelord"],
+	"related": [
+		"tylim88/Firelordrn",
+		"tylim88/Firelord",
+		"tylim88/FireLaw",
+		"tylim88/FireCall",
+		"tylim88/FireCaller"
+	],
 
 	"tabs": []
 }

codeForDoc/src/batch.ts

@@ -1,7 +1,10 @@
-import { example } from './init'
+import { example, db } from './init'
 import { writeBatch, serverTimestamp } from 'firelordjs'
 
-const batch = writeBatch()
+const batch = writeBatch(db)
+// OR
+const batch_Alt = writeBatch()
+
 export const dummy = async () => {
 	batch.set(example.doc('hij'), {
 		a: 6,

codeForDoc/src/documentIdFirelord.ts

@@ -1,12 +1,29 @@
-import { MetaTypeCreator, getFirelord, query, where } from 'firelordjs'
+import { MetaTypeCreator, getFirelord } from 'firelordjs'
 
-const firelord = getFirelord()
-
-type abc = MetaTypeCreator<
+type Parent = MetaTypeCreator<
 	{
-		a: { b: number; c: number }
-		d: number
+		a: 1
 	},
-	'abc',
+	'a',
 	string
 >
+const firelordParent = getFirelord<Parent>()
+const ParentCollectionGroupQuery = firelordParent('a').collectionGroup()
+
+type Child = MetaTypeCreator<
+	{
+		a: 1
+	},
+	'b',
+	string,
+	Parent
+>
+const firelordChild = getFirelord<Child>()
+
+const ChildCollectionGroupQuery = firelordChild(
+	'a/putAnyStringHere/b'
+).collectionGroup()
+
+const a = [1, 2, 3].forEach(i => {
+	exports[i]
+})

codeForDoc/src/groupCollectionQueryFirelord.ts

@@ -0,0 +1,12 @@
+import { MetaTypeCreator, getFirelord, query, where } from 'firelordjs'
+
+const firelord = getFirelord()
+
+type abc = MetaTypeCreator<
+	{
+		a: { b: number; c: number }
+		d: number
+	},
+	'abc',
+	string
+>

codeForDoc/src/init.ts

@@ -1,11 +1,18 @@
 import { getFirelord } from 'firelordjs'
 import { initializeApp } from 'firebase/app'
 import { Example } from './dataType'
+import { getFirestore } from 'firebase/firestore'
 
 initializeApp({
 	apiKey: '### FIREBASE API KEY ###',
 	authDomain: '### FIREBASE AUTH DOMAIN ###',
 	projectId: '### CLOUD FIRESTORE PROJECT ID ###',
 })
 
-export const example = getFirelord<Example>()('SomeCollectionName')
+export const db = getFirestore()
+
+const firelordExample = getFirelord<Example>(db)
+// OR
+const firelordExample_Alt = getFirelord<Example>()
+
+export const example = firelordExample('SomeCollectionName')

codeForDoc/src/transaction.ts

@@ -1,4 +1,4 @@
-import { example } from './init'
+import { example, db } from './init'
 import {
 	runTransaction,
 	serverTimestamp,
@@ -8,6 +8,10 @@ import {
 
 export const dummy = async () => {
 	try {
+		await runTransaction(db, async transaction => {
+			// ...
+		})
+		// OR you can skip 'db'
 		await runTransaction(async transaction => {
 			await transaction.get(example.doc('lmn')).then(docSnapshot => {
 				const data = docSnapshot.data()

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "firelordjs",
-	"version": "1.1.17",
+	"version": "1.1.18",
 	"description": "🔥 Extremely High Precision Typescript Wrapper for Firestore Web, Providing Unparalleled Type Safe and Dev Experience",
 	"source": "src/index.ts",
 	"main": "dist/src/index.js",

scripts/installLatest.ts

@@ -2,5 +2,5 @@ import pkg from '../package.json'
 import shell from 'shelljs'
 
 // https://stackoverflow.com/questions/38032047/how-to-execute-npm-run-command-programmatically
-// to make sure it always install the latest exact version because apparently `latest` is not working in package.json with just published package
+// this code is for newly published code testing because @latest apparently not alway able to target newly published package
 shell.exec(`npm --prefix codeForDoc i ${pkg.name}@${pkg.version}`)