Skip to content

feat(node-type-registry): add table_provision to BlueprintMembershipType #988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pyramation merged 1 commit into from
Apr 17, 2026
Merged

feat(node-type-registry): add table_provision to BlueprintMembershipType #988

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions graphql/node-type-registry/src/blueprint-types.generated.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -813,6 +813,21 @@ export interface BlueprintTableUniqueConstraint {
/** Optional schema name override. */
schema_name?: string;
}
/** Override object for the entity table created by a BlueprintMembershipType. Shape mirrors BlueprintTable / secure_table_provision vocabulary. When supplied, policies[] replaces the default entity-table policies entirely. */
export interface BlueprintEntityTableProvision {
/** Whether to enable RLS on the entity table. Forwarded to secure_table_provision. Defaults to true. */
use_rls?: boolean;
/** Node objects applied to the entity table for field creation (e.g., DataTimestamps, DataPeoplestamps). Forwarded to secure_table_provision as-is. */
nodes?: BlueprintNode[];
/** Custom fields (columns) to add to the entity table. Forwarded to secure_table_provision as-is. */
fields?: BlueprintField[];
/** Privilege grants for the entity table as [verb, columns] tuples (e.g. [["select","*"],["insert","*"]]). Forwarded to secure_table_provision as-is. */
grant_privileges?: unknown[];
/** Database roles to grant privileges to. Forwarded to secure_table_provision as-is. Defaults to ["authenticated"]. */
grant_roles?: string[];
/** RLS policies for the entity table. When present, these policies fully replace the five default entity-table policies (is_visible becomes a no-op). */
policies?: BlueprintPolicy[];
}
/** A membership type entry for Phase 0 of construct_blueprint(). Provisions a full entity type with its own entity table, membership modules, and security policies via entity_type_provision. */
export interface BlueprintMembershipType {
/** Entity type name (e.g., "data_room", "channel", "department"). Must be unique per database. */
Expand All @@ -825,16 +840,18 @@ export interface BlueprintMembershipType {
parent_entity?: string;
/** Custom table name for the entity table. Defaults to name-derived convention. */
table_name?: string;
/** Whether this entity type is visible in the API. Defaults to true. */
/** Whether parent-entity members can see child entities via the default parent_member SELECT policy. Gates one of the five default policies. No-op when table_provision is supplied. Defaults to true. */
is_visible?: boolean;
/** Whether to provision a limits module for this entity type. Defaults to false. */
has_limits?: boolean;
/** Whether to provision a profiles module for this entity type. Defaults to false. */
has_profiles?: boolean;
/** Whether to provision a levels module for this entity type. Defaults to false. */
has_levels?: boolean;
/** Whether to skip creating default RLS policies on the entity table. Defaults to false. */
/** Escape hatch: when true AND table_provision is NULL, zero policies are provisioned on the entity table. Defaults to false. */
skip_entity_policies?: boolean;
/** Override for the entity table. Shape mirrors BlueprintTable / secure_table_provision vocabulary. When supplied, its policies[] replaces the five default entity-table policies; is_visible becomes a no-op. When NULL (default), the five default policies are applied (gated by is_visible). */
table_provision?: BlueprintEntityTableProvision;
}
/**
* ===========================================================================
Expand Down
53 changes: 51 additions & 2 deletions graphql/node-type-registry/src/codegen/generate-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -599,6 +599,47 @@ function buildBlueprintTableUniqueConstraint(): t.ExportNamedDeclaration {
);
}

function buildBlueprintEntityTableProvision(): t.ExportNamedDeclaration {
return addJSDoc(
exportInterface('BlueprintEntityTableProvision', [
addJSDoc(
optionalProp('use_rls', t.tsBooleanKeyword()),
'Whether to enable RLS on the entity table. Forwarded to secure_table_provision. Defaults to true.'
),
addJSDoc(
optionalProp(
'nodes',
t.tsArrayType(t.tsTypeReference(t.identifier('BlueprintNode')))
),
'Node objects applied to the entity table for field creation (e.g., DataTimestamps, DataPeoplestamps). Forwarded to secure_table_provision as-is.'
),
addJSDoc(
optionalProp(
'fields',
t.tsArrayType(t.tsTypeReference(t.identifier('BlueprintField')))
),
'Custom fields (columns) to add to the entity table. Forwarded to secure_table_provision as-is.'
),
addJSDoc(
optionalProp('grant_privileges', t.tsArrayType(t.tsUnknownKeyword())),
'Privilege grants for the entity table as [verb, columns] tuples (e.g. [["select","*"],["insert","*"]]). Forwarded to secure_table_provision as-is.'
),
addJSDoc(
optionalProp('grant_roles', t.tsArrayType(t.tsStringKeyword())),
'Database roles to grant privileges to. Forwarded to secure_table_provision as-is. Defaults to ["authenticated"].'
),
addJSDoc(
optionalProp(
'policies',
t.tsArrayType(t.tsTypeReference(t.identifier('BlueprintPolicy')))
),
'RLS policies for the entity table. When present, these policies fully replace the five default entity-table policies (is_visible becomes a no-op).'
),
]),
'Override object for the entity table created by a BlueprintMembershipType. Shape mirrors BlueprintTable / secure_table_provision vocabulary. When supplied, policies[] replaces the default entity-table policies entirely.'
);
}

function buildBlueprintMembershipType(): t.ExportNamedDeclaration {
return addJSDoc(
exportInterface('BlueprintMembershipType', [
Expand All @@ -624,7 +665,7 @@ function buildBlueprintMembershipType(): t.ExportNamedDeclaration {
),
addJSDoc(
optionalProp('is_visible', t.tsBooleanKeyword()),
'Whether this entity type is visible in the API. Defaults to true.'
'Whether parent-entity members can see child entities via the default parent_member SELECT policy. Gates one of the five default policies. No-op when table_provision is supplied. Defaults to true.'
),
addJSDoc(
optionalProp('has_limits', t.tsBooleanKeyword()),
Expand All @@ -640,7 +681,14 @@ function buildBlueprintMembershipType(): t.ExportNamedDeclaration {
),
addJSDoc(
optionalProp('skip_entity_policies', t.tsBooleanKeyword()),
'Whether to skip creating default RLS policies on the entity table. Defaults to false.'
'Escape hatch: when true AND table_provision is NULL, zero policies are provisioned on the entity table. Defaults to false.'
),
addJSDoc(
optionalProp(
'table_provision',
t.tsTypeReference(t.identifier('BlueprintEntityTableProvision'))
),
'Override for the entity table. Shape mirrors BlueprintTable / secure_table_provision vocabulary. When supplied, its policies[] replaces the five default entity-table policies; is_visible becomes a no-op. When NULL (default), the five default policies are applied (gated by is_visible).'
),
]),
'A membership type entry for Phase 0 of construct_blueprint(). Provisions a full entity type with its own entity table, membership modules, and security policies via entity_type_provision.'
Expand Down Expand Up @@ -839,6 +887,7 @@ function buildProgram(meta?: MetaTableInfo[]): string {
statements.push(buildBlueprintTableIndex());
statements.push(buildBlueprintUniqueConstraint());
statements.push(buildBlueprintTableUniqueConstraint());
statements.push(buildBlueprintEntityTableProvision());
statements.push(buildBlueprintMembershipType());

// -- Node types discriminated union --
Expand Down
Loading