firebase-tools/lib/mcp/resources/guides/init_firestore.js

Command-Line Interface for Firebase

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.init_firestore = void 0;
const resource_1 = require("../../resource");
exports.init_firestore = (0, resource_1.resource)({
    uri: "firebase://guides/init/firestore",
    name: "firestore_init_guide",
    title: "Firestore Init Guide",
    description: "guides the coding agent through configuring Firestore in the current project",
}, async (uri) => {
    const date = getTomorrowDate();
    return {
        contents: [
            {
                uri,
                type: "text",
                text: `
### Setup Firestore Database
**Database Setup:**
- Configure Firestore as the application's primary database.
- Implement client-side CRUD using the Firebase SDK.
- Present the app's Firestore data model to the user. Do not confuse Firestore's document model (NoSQL) with Firebase Data Connect's schema.
- Write the default \`firestore.rules\` file (see below) explain what they do, and obtain the user's confirmation before deploying.
- Run \`firebase deploy --only firestore\` to create the database automatically Do not ask the user to create it in the console.
- Use production environment directly (avoid emulator for initial setup)

**Verify and test:**
- Only proceed with verification after successfully running \`firebase deploy --only firestore\`
- Guide the user to open \`https://console.firebase.google.com/u/0/project/{PROJECT_ID}/firestore\` where \`{PROJECT_ID}\` is the project they're currently using (or use \`_\` if project id is unknown) to confirm their database is created.
- Have developers test their application functionality and verify test data appears in the console. Using the shell, run a local version of their app for them so they can test it. To figure out how to run their app, investigate their environment.
  - For web apps you can check their \`package.json\` for a "start" or "dev" script
  - For Flutter apps, they can use \`flutter run\`
  - For Android apps, ask the user to run the app from Android Studio
  - For iOS / Apple apps, you can check their Package.swift, or read their Xcode project for the right target and use xcrun
- Proceed only after the user confirms the database exists and the data is visible in the Firestore console.

**Next Steps:**
- **Authentication**: Recommend implementing Firebase Authentication if the application handles sensitive user data or has open security rules.
- **User Management**: Implement sign-up and sign-in flows to support user-based access control and update security rules accordingly.
- **Security Rules**: Configure user-based security rules based on your application's specific requirements.

### Default \`firestore.rules\` file:

\`\`\`
// Allow reads and writes to all documents for authenticated users.
// This rule will only be valid until tomorrow.
rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write: if request.auth != null && request.time < timestamp.date(${date.year}, ${date.month}, ${date.day});
    }
  }
}
\`\`\`
`.trim(),
            },
        ],
    };
});
function getTomorrowDate() {
    const tomorrow = new Date();
    tomorrow.setDate(tomorrow.getDate() + 1);
    return { year: tomorrow.getFullYear(), month: tomorrow.getMonth() + 1, day: tomorrow.getDate() };
}