pyric/sandbox/database

Type Aliases

RtdbRulesJson

type RtdbRulesJson = {
  rules: Record<string, unknown>;
};

Properties

RtdbTarget

type RtdbTarget =
  | LocalSandbox
  | {
  [TARGET_SYMBOL]: unknown;
};

Target accepting either a LocalSandbox root or a branded Database handle.

Functions

getActiveRules()

function getActiveRules(target: RtdbTarget): RtdbRulesJson;

Read the currently active rules as detached JSON.

Parameters

Returns

RtdbRulesJson

setData()

function setData(target: RtdbTarget, data: Record<string, unknown>): void;

Replace RTDB data in bulk without applying security rules.

Parameters

Returns

void

setDefaultPolicy()

function setDefaultPolicy(target: RtdbTarget, policy: "allow" | "deny"): void;

Set default access policy when no rules are loaded (‘allow’ or ‘deny’). Internal test/dev harness control.

Parameters

Returns

void

setRules()

function setRules(target: RtdbTarget, rules: RtdbRulesJson): void;

Replace the active RTDB rules. Pass null to restore default deny.

Parameters

Returns

void

snapshotState()

function snapshotState(target: RtdbTarget): JsonValue;

Snapshot the complete RTDB tree without applying security rules.

Parameters

Returns

JsonValue

stripJsonComments()

function stripJsonComments(text: string): string;

Strip JavaScript-style line comments (//...) and block comments (/*...*/) from JSON source text without altering string literals. Realtime Database rules files permit comment blocks, requiring pre-processing before evaluation.

Parameters

Returns

string