Skip to content

js-bao-wss-client


js-bao-wss-client / CreateDatabaseTypeConfigParams

Interface: CreateDatabaseTypeConfigParams ​

Parameters for databaseTypeConfigs.create(): the database type to configure plus its optional rule set, trigger rules, and declared-access manifest.

Properties ​

databaseType ​

databaseType: string

The database type identifier to configure (e.g., "userDB")


metadataAccess? ​

optional metadataAccess?: string

Optional CEL expression gating metadata access.

Deprecated ​

Prefer resource metadata categories — declare a category in metadataManifest (separate readRule/writeRule, so read no longer implies update) and read it as md.self.<category>.<key>.


metadataManifest? ​

optional metadataManifest?: DeclaredMetadataManifest

Optional declared-access manifest that lets this type's CEL rules load metadata categories as md.self.<category>.<key> (and traversed md.<node>.*). Declaring a category here is the prerequisite for migrating a metadataAccess gate to a metadata category.


ruleSetId? ​

optional ruleSetId?: string

Rule set to enforce for databases of this type. Must have resourceType: "database_type".


triggers? ​

optional triggers?: Record<string, ModelRulesInfo>

Optional trigger rules keyed by model name. Validated server-side on create.

Documentation validated against js-bao-wss-client 3.4.0 · js-bao 0.11.0 · primitive-admin 1.0.62 · primitive-app 3.1.0 — 2026-09-30