@simondotm/nx-firebase 2.2.0 → 17.3.1

package/README.md

@@ -1,31 +1,116 @@
-# @simondotm/nx-firebase
+# @simondotm/nx-firebase ![actions](https://github.com/simondotm/nx-firebase/actions/workflows/ci.yml/badge.svg) ![nx](https://img.shields.io/badge/Nx-v16.8.1-blue) ![npm](https://img.shields.io/npm/v/@simondotm/nx-firebase) ![downloads](https://img.shields.io/npm/dw/@simondotm/nx-firebase.svg)
 
-A plugin for [Nx](https://nx.dev) v16.1.1+ that provides support for Firebase projects in an Nx monorepo workspace.
+A plugin for [Nx](https://nx.dev) v16.8.1+ that integrates Firebase workflows in an Nx monorepo workspace.
+
+* Easily generate Firebase applications and functions
+* Uses `esbuild` for fast Firebase function builds so you can easily create & import shared Nx libraries with the benefits of tree-shaking
+* Supports function environment variables and secrets
+* Supports single or multiple firebase projects/apps within an Nx workspace
+* Full support for the Firebase Emulator suite for local development, with watch mode for functions
+* Keeps your `firebase.json` configurations in sync when renaming or deleting Firebase apps & functions
+* Only very lightly opinionated about your Firebase configurations and workspace layouts; you can use Nx or the Firebase CLI
 
 See [CHANGELOG](https://github.com/simondotm/nx-firebase/blob/main/CHANGELOG.md) for release notes.
 
-## Overview
+## Install Plugin
+
+**`npm install @simondotm/nx-firebase --save-dev`**
+
+- Installs this plugin into your Nx workspace
+- This will also install `@nx/node` and firebase SDK's to your root workspace `package.json` if they are not already installed
+
+## Generate Firebase Application
+
+**`nx g @simondotm/nx-firebase:app my-new-firebase-app [--directory=dir] [--project=proj]`**
+
+- Generates a new Nx Firebase application project in the workspace
+- The app generator will also create a Firebase configuration file in the root of your workspace (along with a default `.firebaserc` and `firebase.json` if they don't already exist)
+- For the first firebase application you create, the project firebase configuration will be `firebase.json`
+- If you create additional firebase applications, the project firebase configuration will be `firebase.<app-project-name>.json`
+- Use `--project` to link your Firebase App to a Firebase project name in your `.firebaserc` file
+
+## Generate Firebase Function
+
+**`nx g @simondotm/nx-firebase:function my-new-firebase-function --app=my-new-firebase-app [--directory=dir]`**
+
+- Generates a new Nx Firebase function application project in the workspace
+- Firebase Function projects must be linked to a Firebase application project with the `--app` option
+- Firebase Function projects can contain one or more firebase functions
+- You can generate as many Firebase Function projects as you need for your application
+
+## Build 
+
+**`nx build my-new-firebase-app`**
+
+- Compiles & builds all Firebase function applications linked to the Nx Firebase application or an individual function
+
+**`nx build my-new-firebase-function`**
+
+- Compiles & builds an individual function
+
+
+## Serve
+
+**`nx serve my-new-firebase-app`**
+
+- Builds & Watches all Firebase functions apps linked to the Firebase application
+- Starts the Firebase emulators
+
+## Deploy
+
+### Firebase Application
+
+**`nx deploy my-new-firebase-app [--only ...]`**
+
+- By default, deploys ALL of your cloud resources associated with your Firebase application (eg. sites, functions, database rules etc.)
+- Use the `--only` option to selectively deploy (same as Firebase CLI)
+
+For initial deployment:
+
+- **`firebase login`** if not already authenticated
+- **`firebase use --add`** to add your Firebase Project(s) to the `.firebaserc` file in your workspace. This step must be completed before you can deploy anything to Firebase.
+
+Note that you can also use the firebase CLI directly if you prefer:
+
+- **`firebase deploy --config=firebase.<appname>.json --only functions`**
+
+### Firebase Function
+
+**`nx deploy my-new-firebase-function`**
+
+- Deploys only a specific Firebase function
+
+
+
+## Test
+
+**`nx test my-new-firebase-app`**
+
+- Runs unit tests for all Firebase functions apps linked to the Firebase application
+
+**`nx test my-new-firebase-function`**
+
+- Runs unit tests for an individual function
+
+
+## Lint
+
+**`nx lint my-new-firebase-app`**
+
+- Runs linter for all Firebase functions apps linked to the Firebase application or an individual function
+
+**`nx lint my-new-firebase-function`**
+
+- Runs linter for an individual function
 
-Nx provides a great way to manage monorepo workflows and this plugin helps make it easy to integrate Firebase projects with Nx.
+## Sync Workspace
 
-### Features
+**`nx g @simondotm/nx-firebase:sync`**
 
-* **Firebase Apps**
-  * Generates Firebase application projects, with default `firebase.json` configurations, rules and indexes for each Firebase app
-* **Firebase Functions**
-  * Generates Firebase function apps based on Typescript Nx node applications
-  * Bundling of Firebase functions using `esbuild` for extremely fast compilation & tree-shaking for optimal function cold starts
-  * Easily import Typescript Nx libraries from your Nx workspace into your Firebase functions for code sharing across projects
-  * Supports function environment variables and secrets
-* **Firebase Features**
-  * Use the Firebase Emulator suite whilst developing locally - all functions are watched and updated live while you work
-  * Use Firebase hosting with Nx to easily build & deploy web apps
-* **Workspace Management**
-  * Nx's automatic dependency checking for no-fuss builds, and per-project or per-function deployments
-  * Supports single or multiple firebase projects/apps within an Nx workspace
-  * Nx workspace management with the `sync` generator keeps your project & `firebase.json` configs automatically updated when renaming or deleting Firebase apps & functions
-  * Only very lightly opinionated about your Firebase configurations and workspace layouts; you can use Nx or the Firebase CLI
+- Ensures that your `firebase.json` configurations are kept up to date with your workspace
+  - If you rename or move firebase application or firebase function projects
+  - If you delete firebase function projects
 
 ## Further Information
 
-See the full plugin [README](https://github.com/simondotm/nx-firebase/blob/main/README.md) for more details.
+See the full plugin [User Guide](https://github.com/simondotm/nx-firebase/blob/main/docs/user-guide.md) for more details.

package/executors.json

@@ -5,6 +5,6 @@
       "implementation": "./src/executors/serve/serve",
       "schema": "./src/executors/serve/schema.json",
       "description": "firebase cli emulation serve executor"
-    }    
+    }
   }
-}
+}

package/generators.json

@@ -30,6 +30,6 @@
       "factory": "./src/generators/migrate/migrate",
       "schema": "./src/generators/migrate/schema.json",
       "description": "nx-firebase project migration tool"
-    }    
+    }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simondotm/nx-firebase",
-  "version": "2.2.0",
+  "version": "17.3.1",
   "description": "A Firebase plugin for Nx monorepo workspaces.",
   "author": "Simon Morris",
   "license": "MIT",
@@ -17,14 +17,14 @@
     "Nx",
     "Monorepo"
   ],
-  "main": "src/index.js",
+  "main": "./src/index.js",
   "generators": "./generators.json",
   "executors": "./executors.json",
   "peerDependencies": {
-    "@nx/devkit": ">= 16.1.1",
-    "@nx/workspace": ">= 16.1.1",
-    "nx": ">= 16.1.1"
+    "@nx/devkit": ">= 17.3.1",
+    "@nx/workspace": ">= 17.3.1",
+    "nx": ">= 17.3.1"
   },
   "dependencies": {},
-  "types": "./src/index.d.ts"
-}
+  "type": "commonjs"
+}

package/src/__generated__/nx-firebase-versions.d.ts

@@ -0,0 +1,11 @@
+export declare const packageVersions: {
+    nx: string;
+    firebase: string;
+    firebaseAdmin: string;
+    firebaseFunctions: string;
+    firebaseFunctionsTest: string;
+    firebaseTools: string;
+    killPort: string;
+    nodeEngine: string;
+    googleCloudFunctionsFramework: string;
+};

package/src/__generated__/nx-firebase-versions.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.packageVersions = void 0;
+//------------------------------------------------------------------------------
+// This file is automatically generated by tools/generate-package-versions.js
+// Do not edit this file manually
+//------------------------------------------------------------------------------
+exports.packageVersions = {
+    nx: '17.3.1',
+    firebase: '10.10.0',
+    firebaseAdmin: '11.11.1',
+    firebaseFunctions: '4.8.2',
+    firebaseFunctionsTest: '3.1.1',
+    firebaseTools: '12.9.1',
+    killPort: '2.0.1',
+    nodeEngine: '18',
+    googleCloudFunctionsFramework: '3.3.0',
+};
+//# sourceMappingURL=nx-firebase-versions.js.map

package/src/__generated__/nx-firebase-versions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nx-firebase-versions.js","sourceRoot":"","sources":["../../../../../packages/nx-firebase/src/__generated__/nx-firebase-versions.ts"],"names":[],"mappings":";;;AAAA,gFAAgF;AAChF,6EAA6E;AAC7E,iCAAiC;AACjC,gFAAgF;AACnE,QAAA,eAAe,GAAG;IAC7B,EAAE,EAAE,QAAQ;IACZ,QAAQ,EAAE,SAAS;IACnB,aAAa,EAAE,SAAS;IACxB,iBAAiB,EAAE,OAAO;IAC1B,qBAAqB,EAAE,OAAO;IAC9B,aAAa,EAAE,QAAQ;IACvB,QAAQ,EAAE,OAAO;IACjB,UAAU,EAAE,IAAI;IAChB,6BAA6B,EAAE,OAAO;CACvC,CAAA"}

package/src/executors/serve/schema.json

@@ -11,7 +11,7 @@
       "items": {
         "type": "string"
       }
-    }, 
+    },
     "__unparsed__": {
       "hidden": true,
       "type": "array",
@@ -22,7 +22,7 @@
         "$source": "unparsed"
       },
       "x-priority": "internal"
-    }           
+    }
   },
   "required": []
-}
+}

package/src/generators/application/application.d.ts

@@ -1,13 +1,13 @@
 import { GeneratorCallback, Tree } from '@nx/devkit';
-import type { ApplicationGeneratorOptions, NormalizedOptions } from './schema';
-export declare function normalizeOptions(tree: Tree, options: ApplicationGeneratorOptions): NormalizedOptions;
+import type { Schema, NormalizedSchema } from './schema';
+export declare function normalizeOptions(host: Tree, options: Schema, callingGenerator?: string): Promise<NormalizedSchema>;
 /**
  * Firebase application generator
  *
- * @param tree
- * @param rawOptions
+ * @param host
+ * @param schema
  * @returns
  */
-export declare function applicationGenerator(tree: Tree, rawOptions: ApplicationGeneratorOptions): Promise<GeneratorCallback>;
+export declare function applicationGenerator(host: Tree, schema: Schema): Promise<GeneratorCallback>;
 export default applicationGenerator;
-export declare const applicationSchematic: (generatorOptions: ApplicationGeneratorOptions) => (tree: any, context: any) => Promise<any>;
+export declare const applicationSchematic: (generatorOptions: Schema) => (tree: any, context: any) => Promise<any>;

package/src/generators/application/application.js

@@ -4,53 +4,82 @@ exports.applicationSchematic = exports.applicationGenerator = exports.normalizeO
 const tslib_1 = require("tslib");
 const devkit_1 = require("@nx/devkit");
 const lib_1 = require("./lib");
-const utils_1 = require("../../utils");
 const init_1 = require("../init/init");
-function normalizeOptions(tree, options) {
-    const { projectName, projectRoot } = (0, utils_1.getProjectName)(tree, options.name, options.directory);
-    /**
-     * Plugin filename naming convention for firebase.json config is:
-     *  firebase config will be `firebase.json` for the first firebase app
-     *  additional apps will use `firebase.<projectname>.json`
-     *  this makes the config filename deterministic for the plugin
-     *
-     * - plugin can try `firebase.<projectname>.json` and use if exists
-     * - otherwise fallback is `firebase.json`
-     */
-    const firebaseConfigName = tree.exists('firebase.json')
-        ? `firebase.${projectName}.json`
-        : 'firebase.json';
-    // firebase config name has to be unique.
-    if (tree.exists(firebaseConfigName)) {
-        throw Error(`There is already a firebase configuration called '${firebaseConfigName}' in this workspace. Please use a different project name.`);
-    }
-    return Object.assign(Object.assign({}, options), { projectRoot,
-        projectName,
-        firebaseConfigName });
+const project_name_and_root_utils_1 = require("@nx/devkit/src/generators/project-name-and-root-utils");
+function normalizeOptions(host, options, callingGenerator = '@simondotm/nx-firebase:application') {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const { projectName: appProjectName, projectRoot, projectNameAndRootFormat, } = yield (0, project_name_and_root_utils_1.determineProjectNameAndRootOptions)(host, {
+            name: options.name,
+            projectType: 'application',
+            directory: options.directory,
+            projectNameAndRootFormat: options.projectNameAndRootFormat,
+            rootProject: options.rootProject,
+            callingGenerator,
+        });
+        options.rootProject = projectRoot === '.';
+        options.projectNameAndRootFormat = projectNameAndRootFormat;
+        const parsedTags = options.tags
+            ? options.tags.split(',').map((s) => s.trim())
+            : [];
+        // const { projectName, projectRoot } = getProjectName(
+        //   host,
+        //   options.name,
+        //   options.directory,
+        // )
+        /**
+         * Plugin filename naming convention for firebase.json config is:
+         *  firebase config will be `firebase.json` for the first firebase app
+         *  additional apps will use `firebase.<projectname>.json`
+         *  this makes the config filename deterministic for the plugin
+         *
+         * - plugin can try `firebase.<projectname>.json` and use if exists
+         * - otherwise fallback is `firebase.json`
+         */
+        const firebaseConfigName = host.exists('firebase.json')
+            ? `firebase.${appProjectName}.json`
+            : 'firebase.json';
+        // firebase config name has to be unique.
+        if (host.exists(firebaseConfigName)) {
+            throw Error(`There is already a firebase configuration called '${firebaseConfigName}' in this workspace. Please use a different project name.`);
+        }
+        return Object.assign(Object.assign({}, options), { name: (0, devkit_1.names)(options.name).fileName, projectName: appProjectName, projectRoot,
+            parsedTags,
+            firebaseConfigName });
+        // return {
+        //   ...options,
+        //   projectRoot,
+        //   projectName,
+        //   firebaseConfigName,
+        // }
+    });
 }
 exports.normalizeOptions = normalizeOptions;
 /**
  * Firebase application generator
  *
- * @param tree
- * @param rawOptions
+ * @param host
+ * @param schema
  * @returns
  */
-function applicationGenerator(tree, rawOptions) {
+function applicationGenerator(host, schema) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const options = normalizeOptions(tree, rawOptions);
-        const initTask = yield (0, init_1.default)(tree, {});
+        const options = yield normalizeOptions(host, Object.assign({ projectNameAndRootFormat: 'derived' }, schema));
+        const initTask = yield (0, init_1.default)(host, {});
         const firebaseCliProject = options.project
             ? ` --project=${options.project}`
             : '';
-        const tags = [`firebase:app`, `firebase:name:${options.projectName}`];
-        if (options.tags) {
-            options.tags.split(',').map((s) => {
-                s.trim();
-                tags.push(s);
-            });
-        }
-        (0, devkit_1.addProjectConfiguration)(tree, options.projectName, {
+        const tags = [
+            `firebase:app`,
+            `firebase:name:${options.projectName}`,
+            ...options.parsedTags,
+        ];
+        // if (options.tags) {
+        //   options.tags.split(',').map((s) => {
+        //     s.trim()
+        //     tags.push(s)
+        //   })
+        // }
+        (0, devkit_1.addProjectConfiguration)(host, options.projectName, {
             root: options.projectRoot,
             projectType: 'application',
             targets: {
@@ -130,7 +159,7 @@ function applicationGenerator(tree, rawOptions) {
             },
             tags,
         });
-        (0, lib_1.createFiles)(tree, options);
+        (0, lib_1.createFiles)(host, options);
         return (0, devkit_1.runTasksInSerial)(initTask);
     });
 }

package/src/generators/application/application.js.map

@@ -1 +1 @@
-{"version":3,"file":"application.js","sourceRoot":"","sources":["../../../../../../packages/nx-firebase/src/generators/application/application.ts"],"names":[],"mappings":";;;;AAAA,uCAMmB;AAEnB,+BAAmC;AAEnC,uCAA4C;AAE5C,uCAAwC;AAExC,SAAgB,gBAAgB,CAC9B,IAAU,EACV,OAAoC;IAEpC,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,IAAA,sBAAc,EACjD,IAAI,EACJ,OAAO,CAAC,IAAI,EACZ,OAAO,CAAC,SAAS,CAClB,CAAA;IAED;;;;;;;;OAQG;IACH,MAAM,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;QACrD,CAAC,CAAC,YAAY,WAAW,OAAO;QAChC,CAAC,CAAC,eAAe,CAAA;IAEnB,yCAAyC;IACzC,IAAI,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE;QACnC,MAAM,KAAK,CACT,qDAAqD,kBAAkB,2DAA2D,CACnI,CAAA;KACF;IAED,uCACK,OAAO,KACV,WAAW;QACX,WAAW;QACX,kBAAkB,IACnB;AACH,CAAC;AApCD,4CAoCC;AAED;;;;;;GAMG;AACH,SAAsB,oBAAoB,CACxC,IAAU,EACV,UAAuC;;QAEvC,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;QAClD,MAAM,QAAQ,GAAG,MAAM,IAAA,cAAa,EAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QAE9C,MAAM,kBAAkB,GAAG,OAAO,CAAC,OAAO;YACxC,CAAC,CAAC,cAAc,OAAO,CAAC,OAAO,EAAE;YACjC,CAAC,CAAC,EAAE,CAAA;QAEN,MAAM,IAAI,GAAG,CAAC,cAAc,EAAE,iBAAiB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;QACrE,IAAI,OAAO,CAAC,IAAI,EAAE;YAChB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBAChC,CAAC,CAAC,IAAI,EAAE,CAAA;gBACR,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACd,CAAC,CAAC,CAAA;SACH;QAED,IAAA,gCAAuB,EAAC,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE;YACjD,IAAI,EAAE,OAAO,CAAC,WAAW;YACzB,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,uBAAuB;qBACjC;iBACF;gBACD,KAAK,EAAE;oBACL,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,2DAA2D,OAAO,CAAC,WAAW,yBAAyB;qBACjH;iBACF;gBACD,IAAI,EAAE;oBACJ,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,0DAA0D,OAAO,CAAC,WAAW,iBAAiB;qBACxG;iBACF;gBACD,IAAI,EAAE;oBACJ,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,0DAA0D,OAAO,CAAC,WAAW,iBAAiB;qBACxG;iBACF;gBACD,QAAQ,EAAE;oBACR,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,qBAAqB,OAAO,CAAC,kBAAkB,GAAG,kBAAkB,EAAE;qBAChF;oBACD,cAAc,EAAE;wBACd,UAAU,EAAE;4BACV,OAAO,EAAE,qBAAqB,OAAO,CAAC,kBAAkB,GAAG,kBAAkB,EAAE;yBAChF;qBACF;iBACF;gBACD,SAAS,EAAE;oBACT,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,yEAAyE;qBACnF;iBACF;gBACD,SAAS,EAAE;oBACT,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,UAAU,OAAO,CAAC,WAAW,oCAAoC,OAAO,CAAC,WAAW,kCAAkC;qBAChI;iBACF;gBACD,OAAO,EAAE;oBACP,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,QAAQ,EAAE;4BACR,UAAU,OAAO,CAAC,WAAW,YAAY;4BACzC,UAAU,OAAO,CAAC,WAAW,sCAAsC,OAAO,CAAC,WAAW,8BAA8B;yBACrH;wBACD,QAAQ,EAAE,KAAK;qBAChB;iBACF;gBACD,KAAK,EAAE;oBACL,QAAQ,EAAE,8BAA8B;oBACxC,OAAO,EAAE;wBACP,QAAQ,EAAE;4BACR,UAAU,OAAO,CAAC,WAAW,QAAQ;4BACrC,UAAU,OAAO,CAAC,WAAW,UAAU;yBACxC;qBACF;iBACF;gBACD,MAAM,EAAE;oBACN,QAAQ,EAAE,iBAAiB;oBAC3B,SAAS,EAAE,CAAC,OAAO,CAAC;oBACpB,OAAO,EAAE;wBACP,OAAO,EAAE,UAAU,OAAO,CAAC,WAAW,kBAAkB;qBACzD;iBACF;aACF;YACD,IAAI;SACL,CAAC,CAAA;QAEF,IAAA,iBAAW,EAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE1B,OAAO,IAAA,yBAAgB,EAAC,QAAQ,CAAC,CAAA;IACnC,CAAC;CAAA;AAvGD,oDAuGC;AAED,kBAAe,oBAAoB,CAAA;AACtB,QAAA,oBAAoB,GAAG,IAAA,2BAAkB,EAAC,oBAAoB,CAAC,CAAA"}
+{"version":3,"file":"application.js","sourceRoot":"","sources":["../../../../../../packages/nx-firebase/src/generators/application/application.ts"],"names":[],"mappings":";;;;AAAA,uCAOmB;AAEnB,+BAAmC;AAInC,uCAAwC;AACxC,uGAA0G;AAE1G,SAAsB,gBAAgB,CACpC,IAAU,EACV,OAAe,EACf,gBAAgB,GAAG,oCAAoC;;QAEvD,MAAM,EACJ,WAAW,EAAE,cAAc,EAC3B,WAAW,EACX,wBAAwB,GACzB,GAAG,MAAM,IAAA,gEAAkC,EAAC,IAAI,EAAE;YACjD,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,WAAW,EAAE,aAAa;YAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,wBAAwB,EAAE,OAAO,CAAC,wBAAwB;YAC1D,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,gBAAgB;SACjB,CAAC,CAAA;QAEF,OAAO,CAAC,WAAW,GAAG,WAAW,KAAK,GAAG,CAAA;QACzC,OAAO,CAAC,wBAAwB,GAAG,wBAAwB,CAAA;QAE3D,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI;YAC7B,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAC9C,CAAC,CAAC,EAAE,CAAA;QAEN,uDAAuD;QACvD,UAAU;QACV,kBAAkB;QAClB,uBAAuB;QACvB,IAAI;QAEJ;;;;;;;;WAQG;QACH,MAAM,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;YACrD,CAAC,CAAC,YAAY,cAAc,OAAO;YACnC,CAAC,CAAC,eAAe,CAAA;QAEnB,yCAAyC;QACzC,IAAI,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE;YACnC,MAAM,KAAK,CACT,qDAAqD,kBAAkB,2DAA2D,CACnI,CAAA;SACF;QAED,uCACK,OAAO,KACV,IAAI,EAAE,IAAA,cAAK,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,EAClC,WAAW,EAAE,cAAc,EAC3B,WAAW;YACX,UAAU;YACV,kBAAkB,IACnB;QAED,WAAW;QACX,gBAAgB;QAChB,iBAAiB;QACjB,iBAAiB;QACjB,wBAAwB;QACxB,IAAI;IACN,CAAC;CAAA;AAlED,4CAkEC;AAED;;;;;;GAMG;AACH,SAAsB,oBAAoB,CACxC,IAAU,EACV,MAAc;;QAEd,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,IAAI,kBACzC,wBAAwB,EAAE,SAAS,IAChC,MAAM,EACT,CAAA;QACF,MAAM,QAAQ,GAAG,MAAM,IAAA,cAAa,EAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QAE9C,MAAM,kBAAkB,GAAG,OAAO,CAAC,OAAO;YACxC,CAAC,CAAC,cAAc,OAAO,CAAC,OAAO,EAAE;YACjC,CAAC,CAAC,EAAE,CAAA;QAEN,MAAM,IAAI,GAAG;YACX,cAAc;YACd,iBAAiB,OAAO,CAAC,WAAW,EAAE;YACtC,GAAG,OAAO,CAAC,UAAU;SACtB,CAAA;QACD,sBAAsB;QACtB,yCAAyC;QACzC,eAAe;QACf,mBAAmB;QACnB,OAAO;QACP,IAAI;QAEJ,IAAA,gCAAuB,EAAC,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE;YACjD,IAAI,EAAE,OAAO,CAAC,WAAW;YACzB,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,uBAAuB;qBACjC;iBACF;gBACD,KAAK,EAAE;oBACL,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,2DAA2D,OAAO,CAAC,WAAW,yBAAyB;qBACjH;iBACF;gBACD,IAAI,EAAE;oBACJ,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,0DAA0D,OAAO,CAAC,WAAW,iBAAiB;qBACxG;iBACF;gBACD,IAAI,EAAE;oBACJ,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,0DAA0D,OAAO,CAAC,WAAW,iBAAiB;qBACxG;iBACF;gBACD,QAAQ,EAAE;oBACR,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,qBAAqB,OAAO,CAAC,kBAAkB,GAAG,kBAAkB,EAAE;qBAChF;oBACD,cAAc,EAAE;wBACd,UAAU,EAAE;4BACV,OAAO,EAAE,qBAAqB,OAAO,CAAC,kBAAkB,GAAG,kBAAkB,EAAE;yBAChF;qBACF;iBACF;gBACD,SAAS,EAAE;oBACT,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,yEAAyE;qBACnF;iBACF;gBACD,SAAS,EAAE;oBACT,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,UAAU,OAAO,CAAC,WAAW,oCAAoC,OAAO,CAAC,WAAW,kCAAkC;qBAChI;iBACF;gBACD,OAAO,EAAE;oBACP,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,QAAQ,EAAE;4BACR,UAAU,OAAO,CAAC,WAAW,YAAY;4BACzC,UAAU,OAAO,CAAC,WAAW,sCAAsC,OAAO,CAAC,WAAW,8BAA8B;yBACrH;wBACD,QAAQ,EAAE,KAAK;qBAChB;iBACF;gBACD,KAAK,EAAE;oBACL,QAAQ,EAAE,8BAA8B;oBACxC,OAAO,EAAE;wBACP,QAAQ,EAAE;4BACR,UAAU,OAAO,CAAC,WAAW,QAAQ;4BACrC,UAAU,OAAO,CAAC,WAAW,UAAU;yBACxC;qBACF;iBACF;gBACD,MAAM,EAAE;oBACN,QAAQ,EAAE,iBAAiB;oBAC3B,SAAS,EAAE,CAAC,OAAO,CAAC;oBACpB,OAAO,EAAE;wBACP,OAAO,EAAE,UAAU,OAAO,CAAC,WAAW,kBAAkB;qBACzD;iBACF;aACF;YACD,IAAI;SACL,CAAC,CAAA;QAEF,IAAA,iBAAW,EAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE1B,OAAO,IAAA,yBAAgB,EAAC,QAAQ,CAAC,CAAA;IACnC,CAAC;CAAA;AA9GD,oDA8GC;AAED,kBAAe,oBAAoB,CAAA;AACtB,QAAA,oBAAoB,GAAG,IAAA,2BAAkB,EAAC,oBAAoB,CAAC,CAAA"}

package/src/generators/application/files/firestore.indexes.json

@@ -1,3 +1,26 @@
 {
-  "indexes": []
-}
+  // Example:
+  //
+  // "indexes": [
+  //   {
+  //     "collectionGroup": "widgets",
+  //     "queryScope": "COLLECTION",
+  //     "fields": [
+  //       { "fieldPath": "foo", "arrayConfig": "CONTAINS" },
+  //       { "fieldPath": "bar", "mode": "DESCENDING" }
+  //     ]
+  //   },
+  //
+  //  "fieldOverrides": [
+  //    {
+  //      "collectionGroup": "widgets",
+  //      "fieldPath": "baz",
+  //      "indexes": [
+  //        { "order": "ASCENDING", "queryScope": "COLLECTION" }
+  //      ]
+  //    },
+  //   ]
+  // ]
+  "indexes": [],
+  "fieldOverrides": []
+}

package/src/generators/application/files/firestore.rules

@@ -1,12 +1,16 @@
-rules_version = '2';
-// These default Firestore rules were generated by Nx-Firebase plugin
-// Change them to suit your own requirements. 
-
-// Allow read/write access on all documents to any user signed in to the application
 service cloud.firestore {
   match /databases/{database}/documents {
     match /{document=**} {
-      allow read, write: if request.auth != null;
+      // This rule allows anyone with your database reference to view, edit,
+      // and delete all data in your database. It is useful for getting
+      // started, but it is configured to expire after 30 days because it
+      // leaves your app open to attackers. At that time, all client
+      // requests to your database will be denied.
+      //
+      // Make sure to write security rules for your app before that time, or
+      // else all client requests to your database will be denied until you
+      // update your rules.
+      allow read, write: if request.time < timestamp.date(<%= IN_30_DAYS %>);
     }
   }
 }

package/src/generators/application/files/public/404.html

@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Page Not Found</title>
+
+    <style media="screen">
+      body { background: #ECEFF1; color: rgba(0,0,0,0.87); font-family: Roboto, Helvetica, Arial, sans-serif; margin: 0; padding: 0; }
+      #message { background: white; max-width: 360px; margin: 100px auto 16px; padding: 32px 24px 16px; border-radius: 3px; }
+      #message h3 { color: #888; font-weight: normal; font-size: 16px; margin: 16px 0 12px; }
+      #message h2 { color: #ffa100; font-weight: bold; font-size: 16px; margin: 0 0 8px; }
+      #message h1 { font-size: 22px; font-weight: 300; color: rgba(0,0,0,0.6); margin: 0 0 16px;}
+      #message p { line-height: 140%; margin: 16px 0 24px; font-size: 14px; }
+      #message a { display: block; text-align: center; background: #039be5; text-transform: uppercase; text-decoration: none; color: white; padding: 16px; border-radius: 4px; }
+      #message, #message a { box-shadow: 0 1px 3px rgba(0,0,0,0.12), 0 1px 2px rgba(0,0,0,0.24); }
+      #load { color: rgba(0,0,0,0.4); text-align: center; font-size: 13px; }
+      @media (max-width: 600px) {
+        body, #message { margin-top: 0; background: white; box-shadow: none; }
+        body { border-top: 16px solid #ffa100; }
+      }
+    </style>
+  </head>
+  <body>
+    <div id="message">
+      <h2>404</h2>
+      <h1>Page Not Found</h1>
+      <p>The specified file was not found on this website. Please check the URL for mistakes and try again.</p>
+      <h3>Why am I seeing this?</h3>
+      <p>This page was generated by the Firebase Command-Line Interface. To modify it, edit the <code>404.html</code> file in your project's configured <code>public</code> directory.</p>
+    </div>
+  </body>
+</html>

package/src/generators/application/files/public/index.html

@@ -6,17 +6,17 @@
     <title>Welcome to Firebase Hosting</title>
 
     <!-- update the version number as needed -->
-    <script defer src="/__/firebase/9.14.0/firebase-app-compat.js"></script>
+    <script defer src="/__/firebase/10.10.0/firebase-app-compat.js"></script>
     <!-- include only the Firebase features as you need -->
-    <script defer src="/__/firebase/9.14.0/firebase-auth-compat.js"></script>
-    <script defer src="/__/firebase/9.14.0/firebase-database-compat.js"></script>
-    <script defer src="/__/firebase/9.14.0/firebase-firestore-compat.js"></script>
-    <script defer src="/__/firebase/9.14.0/firebase-functions-compat.js"></script>
-    <script defer src="/__/firebase/9.14.0/firebase-messaging-compat.js"></script>
-    <script defer src="/__/firebase/9.14.0/firebase-storage-compat.js"></script>
-    <script defer src="/__/firebase/9.14.0/firebase-analytics-compat.js"></script>
-    <script defer src="/__/firebase/9.14.0/firebase-remote-config-compat.js"></script>
-    <script defer src="/__/firebase/9.14.0/firebase-performance-compat.js"></script>
+    <script defer src="/__/firebase/10.10.0/firebase-auth-compat.js"></script>
+    <script defer src="/__/firebase/10.10.0/firebase-database-compat.js"></script>
+    <script defer src="/__/firebase/10.10.0/firebase-firestore-compat.js"></script>
+    <script defer src="/__/firebase/10.10.0/firebase-functions-compat.js"></script>
+    <script defer src="/__/firebase/10.10.0/firebase-messaging-compat.js"></script>
+    <script defer src="/__/firebase/10.10.0/firebase-storage-compat.js"></script>
+    <script defer src="/__/firebase/10.10.0/firebase-analytics-compat.js"></script>
+    <script defer src="/__/firebase/10.10.0/firebase-remote-config-compat.js"></script>
+    <script defer src="/__/firebase/10.10.0/firebase-performance-compat.js"></script>
     <!-- 
       initialize the SDK after all desired features are loaded, set useEmulator to false
       to avoid connecting the SDK to running emulators.
@@ -86,4 +86,4 @@
       });
     </script>
   </body>
-</html>
+</html>

package/src/generators/application/files/storage.rules

@@ -1,9 +1,12 @@
-// replace this file with your own firebase storage rules
 rules_version = '2';
+
+// Craft rules based on data in your Firestore database
+// allow write: if firestore.get(
+//    /databases/(default)/documents/users/$(request.auth.uid)).data.isAdmin;
 service firebase.storage {
   match /b/{bucket}/o {
     match /{allPaths=**} {
-      allow read, write: if request.auth != null;
+      allow read, write: if false;
     }
   }
-}
+}

package/src/generators/application/lib/create-files.d.ts

@@ -1,9 +1,9 @@
 import { Tree } from '@nx/devkit';
-import type { NormalizedOptions } from '../schema';
+import type { NormalizedSchema } from '../schema';
 /**
  * Generate the firebase app specific files
  *
  * @param tree
  * @param options
  */
-export declare function createFiles(tree: Tree, options: NormalizedOptions): void;
+export declare function createFiles(tree: Tree, options: NormalizedSchema): void;

package/src/generators/application/lib/create-files.js

@@ -10,11 +10,22 @@ const devkit_1 = require("@nx/devkit");
  */
 function createFiles(tree, options) {
     const firebaseAppConfig = options.firebaseConfigName;
+    // Firebase SDK firestore.rules template has a placeholder for the date 30 days from now
+    // so we add that substitution here at the point of app generation
+    const date = new Date();
+    date.setDate(date.getDate() + 30);
+    const dateString = date
+        .toISOString()
+        .split('T')[0]
+        .split('-')
+        .map((v) => parseInt(v).toString())
+        .join(', ');
     const substitutions = {
         tmpl: '',
         projectName: options.projectName,
         projectRoot: options.projectRoot,
         firebaseAppConfig,
+        IN_30_DAYS: dateString,
     };
     // The default functions package.json & templated typescript source files are added here
     // to match the `firebase init` cli setup

package/src/generators/application/lib/create-files.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-files.js","sourceRoot":"","sources":["../../../../../../../packages/nx-firebase/src/generators/application/lib/create-files.ts"],"names":[],"mappings":";;;AAAA,uCAAmE;AAInE;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,IAAU,EAAE,OAA0B;IAChE,MAAM,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAA;IAEpD,MAAM,aAAa,GAAG;QACpB,IAAI,EAAE,EAAE;QACR,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,iBAAiB;KAClB,CAAA;IAED,wFAAwF;IACxF,yCAAyC;IACzC,uGAAuG;IACvG,EAAE;IACF,sEAAsE;IACtE,qDAAqD;IACrD,wFAAwF;IACxF,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,EAC3C,OAAO,CAAC,WAAW,EACnB,aAAa,CACd,CAAA;IAED,mGAAmG;IACnG,+HAA+H;IAC/H,IAAI,iBAAiB,KAAK,eAAe,EAAE;QACzC,wCAAwC;QACxC,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,IAAI,EAAE,gBAAgB,CAAC,EACpD,EAAE,EACF,aAAa,CACd,CAAA;KACF;SAAM;QACL,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,IAAI,EAAE,iBAAiB,CAAC,EACrD,EAAE,EAAE,kDAAkD;QACtD,aAAa,CACd,CAAA;KACF;IAED,kGAAkG;IAClG,sDAAsD;IACtD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE;QAC/B,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,IAAI,EAAE,kBAAkB,CAAC,EACtD,EAAE,EACF,aAAa,CACd,CAAA;KACF;IACD,SAAS;IACT,iEAAiE;IACjE,IAAI;AACN,CAAC;AAxDD,kCAwDC"}
+{"version":3,"file":"create-files.js","sourceRoot":"","sources":["../../../../../../../packages/nx-firebase/src/generators/application/lib/create-files.ts"],"names":[],"mappings":";;;AAAA,uCAAmE;AAInE;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,IAAU,EAAE,OAAyB;IAC/D,MAAM,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAA;IAEpD,wFAAwF;IACxF,kEAAkE;IAClE,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAA;IACvB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAAA;IACjC,MAAM,UAAU,GAAG,IAAI;SACpB,WAAW,EAAE;SACb,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SACb,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;SAClC,IAAI,CAAC,IAAI,CAAC,CAAA;IAEb,MAAM,aAAa,GAAG;QACpB,IAAI,EAAE,EAAE;QACR,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,iBAAiB;QACjB,UAAU,EAAE,UAAU;KACvB,CAAA;IAED,wFAAwF;IACxF,yCAAyC;IACzC,uGAAuG;IACvG,EAAE;IACF,sEAAsE;IACtE,qDAAqD;IACrD,wFAAwF;IACxF,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,EAC3C,OAAO,CAAC,WAAW,EACnB,aAAa,CACd,CAAA;IAED,mGAAmG;IACnG,+HAA+H;IAC/H,IAAI,iBAAiB,KAAK,eAAe,EAAE;QACzC,wCAAwC;QACxC,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,IAAI,EAAE,gBAAgB,CAAC,EACpD,EAAE,EACF,aAAa,CACd,CAAA;KACF;SAAM;QACL,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,IAAI,EAAE,iBAAiB,CAAC,EACrD,EAAE,EAAE,kDAAkD;QACtD,aAAa,CACd,CAAA;KACF;IAED,kGAAkG;IAClG,sDAAsD;IACtD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE;QAC/B,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,IAAI,EAAE,kBAAkB,CAAC,EACtD,EAAE,EACF,aAAa,CACd,CAAA;KACF;IACD,SAAS;IACT,iEAAiE;IACjE,IAAI;AACN,CAAC;AApED,kCAoEC"}

package/src/generators/application/schema.d.ts

@@ -1,16 +1,21 @@
-export interface ApplicationGeneratorOptions {
-  // standard @nx/node:app options
+import { ProjectNameAndRootFormat } from '@nx/devkit/src/generators/project-name-and-root-utils'
+
+export interface Schema {
+  // standard @nx project generator options
   name: string
   directory?: string
   tags?: string
+  projectNameAndRootFormat?: ProjectNameAndRootFormat
+  rootProject?: boolean
   // extra options for @simondotm/nx-firebase:app generator
   project?: string
   // firebaseProject?: string
   // firebaseConfig?: string
 }
 
-export interface NormalizedOptions extends ApplicationGeneratorOptions {
-  projectRoot: Path
+export interface NormalizedSchema extends Schema {
   projectName: string
+  projectRoot: string
+  parsedTags: string[]
   firebaseConfigName: string
 }