API reference: pyric/sandbox/firestore

Interfaces

Property	Type	Description
`recentEventLimit?`	`number`	Maximum number of recent requests and denials to return. Defaults to 10.

Stable JSON-serializable Firestore diagnostic used by Studio and tools.

Property	Type
`documents`	{ `byCollection`: `Record`<`string`, `number`>; `totalCount`: `number`; }
`documents.byCollection`	`Record`<`string`, `number`>
`documents.totalCount`	`number`
`events`	{ `recentDenials`: { `auth`: `unknown`; `debugMessage?`: `string`; `method`: `string`; `path`: `string`; }[]; `recentRequests`: { `auth`: `unknown`; `method`: `string`; `path`: `string`; `result`: `string`; }[]; `totalCount`: `number`; }
`events.recentDenials`	{ `auth`: `unknown`; `debugMessage?`: `string`; `method`: `string`; `path`: `string`; }[]
`events.recentRequests`	{ `auth`: `unknown`; `method`: `string`; `path`: `string`; `result`: `string`; }[]
`events.totalCount`	`number`
`rules`	{ `isEmpty`: `boolean`; `lint`: { `errors`: `number`; `findings`: { `message`: `string`; `rule`: `string`; `severity`: `string`; }[]; `info`: `number`; `warnings`: `number`; }; `sizeBytes`: `number`; `source`: `string`; }
`rules.isEmpty`	`boolean`
`rules.lint`	{ `errors`: `number`; `findings`: { `message`: `string`; `rule`: `string`; `severity`: `string`; }[]; `info`: `number`; `warnings`: `number`; }
`rules.lint.errors`	`number`
`rules.lint.findings`	{ `message`: `string`; `rule`: `string`; `severity`: `string`; }[]
`rules.lint.info`	`number`
`rules.lint.warnings`	`number`
`rules.sizeBytes`	`number`
`rules.source`	`string`

function inspect(sandbox: LocalSandbox, options?: FirestoreInspectOptions): FirestoreInspectReport;

Inspect Firestore rules, documents, and recent requests in one sandbox.

Parameter	Type
`sandbox`	`LocalSandbox`
`options?`	`FirestoreInspectOptions`

function seedDocuments(sandbox: LocalSandbox, documents: Record<string, DocumentData>): LintResult;

Replace Firestore documents in bulk, preserving rules and bypassing evaluation.

Parameter	Type
`sandbox`	`LocalSandbox`
`documents`	`Record`<`string`, `DocumentData`>

function setRules(sandbox: LocalSandbox, source: string): LintResult;

Load Firestore Rules into one sandbox and notify its live listeners.

Parameter	Type
`sandbox`	`LocalSandbox`
`source`	`string`

function snapshotDocuments(sandbox: LocalSandbox): Record<string, DocumentData>;

Snapshot only Firestore documents without traversing other sandbox services.

Parameter	Type
`sandbox`	`LocalSandbox`

Record<string, DocumentData>