node-type-registry 0.10.0 → 0.11.0

package/README.md

@@ -1,5 +1,17 @@
 # node-type-registry
 
+<p align="center" width="100%">
+  <img height="250" src="https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg" />
+</p>
+
+<p align="center" width="100%">
+  <a href="https://github.com/constructive-io/constructive/actions/workflows/run-tests.yaml">
+    <img height="20" src="https://github.com/constructive-io/constructive/actions/workflows/run-tests.yaml/badge.svg" />
+  </a>
+   <a href="https://github.com/constructive-io/constructive/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
+   <a href="https://www.npmjs.com/package/node-type-registry"><img height="20" src="https://img.shields.io/github/package-json/v/constructive-io/constructive?filename=graphql%2Fnode-type-registry%2Fpackage.json"/></a>
+</p>
+
 Node type definitions for the Constructive blueprint system. Single source of truth for all Authz*, Data*, Relation*, View*, and Table* node types.
 
 ## Usage

package/authz/authz-entity-membership.js

@@ -19,7 +19,11 @@ exports.AuthzEntityMembership = {
                     "integer",
                     "string"
                 ],
-                "description": "Scope: 1=app, 2=org, 3=group (or string name resolved via membership_types_module)"
+                "description": "Scope: 1=app, 2=org, 3+=dynamic entity types (or string name resolved via membership_types_module)"
+            },
+            "entity_type": {
+                "type": "string",
+                "description": "Entity type prefix (e.g. 'channel', 'department'). Resolved to membership_type integer via memberships_module lookup. Use instead of membership_type for readability."
             },
             "permission": {
                 "type": "string",

package/authz/authz-membership-check.js

@@ -15,7 +15,11 @@ exports.AuthzMembership = {
                     "integer",
                     "string"
                 ],
-                "description": "Scope: 1=app, 2=org, 3=group (or string name resolved via membership_types_module)"
+                "description": "Scope: 1=app, 2=org, 3+=dynamic entity types (or string name resolved via membership_types_module)"
+            },
+            "entity_type": {
+                "type": "string",
+                "description": "Entity type prefix (e.g. 'channel', 'department'). Resolved to membership_type integer via memberships_module lookup. Use instead of membership_type for readability."
             },
             "permission": {
                 "type": "string",
@@ -37,9 +41,7 @@ exports.AuthzMembership = {
                 "description": "If true, require is_owner flag"
             }
         },
-        "required": [
-            "membership_type"
-        ]
+        "required": []
     },
     "tags": [
         "membership",

package/authz/authz-peer-ownership.js

@@ -19,7 +19,11 @@ exports.AuthzPeerOwnership = {
                     "integer",
                     "string"
                 ],
-                "description": "Scope: 1=app, 2=org, 3=group (or string name resolved via membership_types_module)"
+                "description": "Scope: 1=app, 2=org, 3+=dynamic entity types (or string name resolved via membership_types_module)"
+            },
+            "entity_type": {
+                "type": "string",
+                "description": "Entity type prefix (e.g. 'channel', 'department'). Resolved to membership_type integer via memberships_module lookup. Use instead of membership_type for readability."
             },
             "permission": {
                 "type": "string",

package/authz/authz-related-entity-membership.js

@@ -19,7 +19,11 @@ exports.AuthzRelatedEntityMembership = {
                     "integer",
                     "string"
                 ],
-                "description": "Scope: 1=app, 2=org, 3=group (or string name resolved via membership_types_module)"
+                "description": "Scope: 1=app, 2=org, 3+=dynamic entity types (or string name resolved via membership_types_module)"
+            },
+            "entity_type": {
+                "type": "string",
+                "description": "Entity type prefix (e.g. 'channel', 'department'). Resolved to membership_type integer via memberships_module lookup. Use instead of membership_type for readability."
             },
             "obj_table_id": {
                 "type": "string",

package/authz/authz-related-peer-ownership.js

@@ -19,7 +19,11 @@ exports.AuthzRelatedPeerOwnership = {
                     "integer",
                     "string"
                 ],
-                "description": "Scope: 1=app, 2=org, 3=group (or string name resolved via membership_types_module)"
+                "description": "Scope: 1=app, 2=org, 3+=dynamic entity types (or string name resolved via membership_types_module)"
+            },
+            "entity_type": {
+                "type": "string",
+                "description": "Entity type prefix (e.g. 'channel', 'department'). Resolved to membership_type integer via memberships_module lookup. Use instead of membership_type for readability."
             },
             "obj_table_id": {
                 "type": "string",

package/blueprint-types.generated.d.ts

@@ -549,6 +549,29 @@ export interface BlueprintTableUniqueConstraint {
     /** Optional schema name override. */
     schema_name?: string;
 }
+/** 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. */
+    name: string;
+    /** Short prefix for generated objects (e.g., "dr", "ch", "dept"). Used in table/trigger naming. */
+    prefix: string;
+    /** Human-readable description of this entity type. */
+    description?: string;
+    /** Parent entity type name. Defaults to "org". */
+    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. */
+    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. */
+    skip_entity_policies?: boolean;
+}
 /** String shorthand -- just the node type name. */
 export type BlueprintNodeShorthand = "AuthzDirectOwner" | "AuthzDirectOwnerAny" | "AuthzMembership" | "AuthzEntityMembership" | "AuthzRelatedEntityMembership" | "AuthzOrgHierarchy" | "AuthzTemporal" | "AuthzPublishable" | "AuthzMemberList" | "AuthzRelatedMemberList" | "AuthzAllowAll" | "AuthzDenyAll" | "AuthzComposite" | "AuthzPeerOwnership" | "AuthzRelatedPeerOwnership" | "DataId" | "DataDirectOwner" | "DataEntityMembership" | "DataOwnershipInEntity" | "DataTimestamps" | "DataPeoplestamps" | "DataPublishable" | "DataSoftDelete" | "SearchVector" | "SearchFullText" | "SearchBm25" | "SearchUnified" | "SearchSpatial" | "SearchSpatialAggregate" | "DataJobTrigger" | "DataTags" | "DataStatusField" | "DataJsonb" | "SearchTrgm" | "DataSlug" | "DataInflection" | "DataOwnedFields" | "DataInheritFromParent" | "DataForceCurrentUser" | "DataImmutableFields" | "DataCompositeField" | "TableUserProfiles" | "TableOrganizationSettings" | "TableUserSettings";
 /** Object form -- { $type, data } with typed parameters. */
@@ -750,4 +773,6 @@ export interface BlueprintDefinition {
     full_text_searches?: BlueprintFullTextSearch[];
     /** Unique constraints on table columns. */
     unique_constraints?: BlueprintUniqueConstraint[];
+    /** Entity types to provision in Phase 0 (before tables). Each entry creates an entity table with membership modules and security. */
+    membership_types?: BlueprintMembershipType[];
 }

package/codegen/generate-types.js

@@ -384,6 +384,20 @@ function buildBlueprintTableUniqueConstraint() {
         addJSDoc(optionalProp('schema_name', t.tsStringKeyword()), 'Optional schema name override.'),
     ]), 'A unique constraint nested inside a table definition (table_name not required).');
 }
+function buildBlueprintMembershipType() {
+    return addJSDoc(exportInterface('BlueprintMembershipType', [
+        addJSDoc(requiredProp('name', t.tsStringKeyword()), 'Entity type name (e.g., "data_room", "channel", "department"). Must be unique per database.'),
+        addJSDoc(requiredProp('prefix', t.tsStringKeyword()), 'Short prefix for generated objects (e.g., "dr", "ch", "dept"). Used in table/trigger naming.'),
+        addJSDoc(optionalProp('description', t.tsStringKeyword()), 'Human-readable description of this entity type.'),
+        addJSDoc(optionalProp('parent_entity', t.tsStringKeyword()), 'Parent entity type name. Defaults to "org".'),
+        addJSDoc(optionalProp('table_name', t.tsStringKeyword()), 'Custom table name for the entity table. Defaults to name-derived convention.'),
+        addJSDoc(optionalProp('is_visible', t.tsBooleanKeyword()), 'Whether this entity type is visible in the API. Defaults to true.'),
+        addJSDoc(optionalProp('has_limits', t.tsBooleanKeyword()), 'Whether to provision a limits module for this entity type. Defaults to false.'),
+        addJSDoc(optionalProp('has_profiles', t.tsBooleanKeyword()), 'Whether to provision a profiles module for this entity type. Defaults to false.'),
+        addJSDoc(optionalProp('has_levels', t.tsBooleanKeyword()), 'Whether to provision a levels module for this entity type. Defaults to false.'),
+        addJSDoc(optionalProp('skip_entity_policies', t.tsBooleanKeyword()), 'Whether to skip creating default RLS policies on the entity table. Defaults to false.'),
+    ]), '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.');
+}
 function buildBlueprintTable() {
     return addJSDoc(exportInterface('BlueprintTable', [
         addJSDoc(requiredProp('table_name', t.tsStringKeyword()), 'The PostgreSQL table name to create.'),
@@ -406,6 +420,7 @@ function buildBlueprintDefinition() {
         addJSDoc(optionalProp('indexes', t.tsArrayType(t.tsTypeReference(t.identifier('BlueprintIndex')))), 'Indexes on table columns.'),
         addJSDoc(optionalProp('full_text_searches', t.tsArrayType(t.tsTypeReference(t.identifier('BlueprintFullTextSearch')))), 'Full-text search configurations.'),
         addJSDoc(optionalProp('unique_constraints', t.tsArrayType(t.tsTypeReference(t.identifier('BlueprintUniqueConstraint')))), 'Unique constraints on table columns.'),
+        addJSDoc(optionalProp('membership_types', t.tsArrayType(t.tsTypeReference(t.identifier('BlueprintMembershipType')))), 'Entity types to provision in Phase 0 (before tables). Each entry creates an entity table with membership modules and security.'),
     ]), 'The complete blueprint definition -- the JSONB shape accepted by construct_blueprint().');
 }
 // ---------------------------------------------------------------------------
@@ -459,6 +474,7 @@ function buildProgram(meta) {
     statements.push(buildBlueprintTableIndex());
     statements.push(buildBlueprintUniqueConstraint());
     statements.push(buildBlueprintTableUniqueConstraint());
+    statements.push(buildBlueprintMembershipType());
     // -- Node types discriminated union --
     statements.push(sectionComment('Node types -- discriminated union for nodes[] entries'));
     statements.push(...buildNodeTypes(dataNodes));

package/esm/authz/authz-entity-membership.js

@@ -16,7 +16,11 @@ export const AuthzEntityMembership = {
                     "integer",
                     "string"
                 ],
-                "description": "Scope: 1=app, 2=org, 3=group (or string name resolved via membership_types_module)"
+                "description": "Scope: 1=app, 2=org, 3+=dynamic entity types (or string name resolved via membership_types_module)"
+            },
+            "entity_type": {
+                "type": "string",
+                "description": "Entity type prefix (e.g. 'channel', 'department'). Resolved to membership_type integer via memberships_module lookup. Use instead of membership_type for readability."
             },
             "permission": {
                 "type": "string",

package/esm/authz/authz-membership-check.js

@@ -12,7 +12,11 @@ export const AuthzMembership = {
                     "integer",
                     "string"
                 ],
-                "description": "Scope: 1=app, 2=org, 3=group (or string name resolved via membership_types_module)"
+                "description": "Scope: 1=app, 2=org, 3+=dynamic entity types (or string name resolved via membership_types_module)"
+            },
+            "entity_type": {
+                "type": "string",
+                "description": "Entity type prefix (e.g. 'channel', 'department'). Resolved to membership_type integer via memberships_module lookup. Use instead of membership_type for readability."
             },
             "permission": {
                 "type": "string",
@@ -34,9 +38,7 @@ export const AuthzMembership = {
                 "description": "If true, require is_owner flag"
             }
         },
-        "required": [
-            "membership_type"
-        ]
+        "required": []
     },
     "tags": [
         "membership",

package/esm/authz/authz-peer-ownership.js

@@ -16,7 +16,11 @@ export const AuthzPeerOwnership = {
                     "integer",
                     "string"
                 ],
-                "description": "Scope: 1=app, 2=org, 3=group (or string name resolved via membership_types_module)"
+                "description": "Scope: 1=app, 2=org, 3+=dynamic entity types (or string name resolved via membership_types_module)"
+            },
+            "entity_type": {
+                "type": "string",
+                "description": "Entity type prefix (e.g. 'channel', 'department'). Resolved to membership_type integer via memberships_module lookup. Use instead of membership_type for readability."
             },
             "permission": {
                 "type": "string",

package/esm/authz/authz-related-entity-membership.js

@@ -16,7 +16,11 @@ export const AuthzRelatedEntityMembership = {
                     "integer",
                     "string"
                 ],
-                "description": "Scope: 1=app, 2=org, 3=group (or string name resolved via membership_types_module)"
+                "description": "Scope: 1=app, 2=org, 3+=dynamic entity types (or string name resolved via membership_types_module)"
+            },
+            "entity_type": {
+                "type": "string",
+                "description": "Entity type prefix (e.g. 'channel', 'department'). Resolved to membership_type integer via memberships_module lookup. Use instead of membership_type for readability."
             },
             "obj_table_id": {
                 "type": "string",

package/esm/authz/authz-related-peer-ownership.js

@@ -16,7 +16,11 @@ export const AuthzRelatedPeerOwnership = {
                     "integer",
                     "string"
                 ],
-                "description": "Scope: 1=app, 2=org, 3=group (or string name resolved via membership_types_module)"
+                "description": "Scope: 1=app, 2=org, 3+=dynamic entity types (or string name resolved via membership_types_module)"
+            },
+            "entity_type": {
+                "type": "string",
+                "description": "Entity type prefix (e.g. 'channel', 'department'). Resolved to membership_type integer via memberships_module lookup. Use instead of membership_type for readability."
             },
             "obj_table_id": {
                 "type": "string",

package/esm/blueprint-types.generated.d.ts

@@ -549,6 +549,29 @@ export interface BlueprintTableUniqueConstraint {
     /** Optional schema name override. */
     schema_name?: string;
 }
+/** 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. */
+    name: string;
+    /** Short prefix for generated objects (e.g., "dr", "ch", "dept"). Used in table/trigger naming. */
+    prefix: string;
+    /** Human-readable description of this entity type. */
+    description?: string;
+    /** Parent entity type name. Defaults to "org". */
+    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. */
+    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. */
+    skip_entity_policies?: boolean;
+}
 /** String shorthand -- just the node type name. */
 export type BlueprintNodeShorthand = "AuthzDirectOwner" | "AuthzDirectOwnerAny" | "AuthzMembership" | "AuthzEntityMembership" | "AuthzRelatedEntityMembership" | "AuthzOrgHierarchy" | "AuthzTemporal" | "AuthzPublishable" | "AuthzMemberList" | "AuthzRelatedMemberList" | "AuthzAllowAll" | "AuthzDenyAll" | "AuthzComposite" | "AuthzPeerOwnership" | "AuthzRelatedPeerOwnership" | "DataId" | "DataDirectOwner" | "DataEntityMembership" | "DataOwnershipInEntity" | "DataTimestamps" | "DataPeoplestamps" | "DataPublishable" | "DataSoftDelete" | "SearchVector" | "SearchFullText" | "SearchBm25" | "SearchUnified" | "SearchSpatial" | "SearchSpatialAggregate" | "DataJobTrigger" | "DataTags" | "DataStatusField" | "DataJsonb" | "SearchTrgm" | "DataSlug" | "DataInflection" | "DataOwnedFields" | "DataInheritFromParent" | "DataForceCurrentUser" | "DataImmutableFields" | "DataCompositeField" | "TableUserProfiles" | "TableOrganizationSettings" | "TableUserSettings";
 /** Object form -- { $type, data } with typed parameters. */
@@ -750,4 +773,6 @@ export interface BlueprintDefinition {
     full_text_searches?: BlueprintFullTextSearch[];
     /** Unique constraints on table columns. */
     unique_constraints?: BlueprintUniqueConstraint[];
+    /** Entity types to provision in Phase 0 (before tables). Each entry creates an entity table with membership modules and security. */
+    membership_types?: BlueprintMembershipType[];
 }

package/esm/codegen/generate-types.js

@@ -349,6 +349,20 @@ function buildBlueprintTableUniqueConstraint() {
         addJSDoc(optionalProp('schema_name', t.tsStringKeyword()), 'Optional schema name override.'),
     ]), 'A unique constraint nested inside a table definition (table_name not required).');
 }
+function buildBlueprintMembershipType() {
+    return addJSDoc(exportInterface('BlueprintMembershipType', [
+        addJSDoc(requiredProp('name', t.tsStringKeyword()), 'Entity type name (e.g., "data_room", "channel", "department"). Must be unique per database.'),
+        addJSDoc(requiredProp('prefix', t.tsStringKeyword()), 'Short prefix for generated objects (e.g., "dr", "ch", "dept"). Used in table/trigger naming.'),
+        addJSDoc(optionalProp('description', t.tsStringKeyword()), 'Human-readable description of this entity type.'),
+        addJSDoc(optionalProp('parent_entity', t.tsStringKeyword()), 'Parent entity type name. Defaults to "org".'),
+        addJSDoc(optionalProp('table_name', t.tsStringKeyword()), 'Custom table name for the entity table. Defaults to name-derived convention.'),
+        addJSDoc(optionalProp('is_visible', t.tsBooleanKeyword()), 'Whether this entity type is visible in the API. Defaults to true.'),
+        addJSDoc(optionalProp('has_limits', t.tsBooleanKeyword()), 'Whether to provision a limits module for this entity type. Defaults to false.'),
+        addJSDoc(optionalProp('has_profiles', t.tsBooleanKeyword()), 'Whether to provision a profiles module for this entity type. Defaults to false.'),
+        addJSDoc(optionalProp('has_levels', t.tsBooleanKeyword()), 'Whether to provision a levels module for this entity type. Defaults to false.'),
+        addJSDoc(optionalProp('skip_entity_policies', t.tsBooleanKeyword()), 'Whether to skip creating default RLS policies on the entity table. Defaults to false.'),
+    ]), '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.');
+}
 function buildBlueprintTable() {
     return addJSDoc(exportInterface('BlueprintTable', [
         addJSDoc(requiredProp('table_name', t.tsStringKeyword()), 'The PostgreSQL table name to create.'),
@@ -371,6 +385,7 @@ function buildBlueprintDefinition() {
         addJSDoc(optionalProp('indexes', t.tsArrayType(t.tsTypeReference(t.identifier('BlueprintIndex')))), 'Indexes on table columns.'),
         addJSDoc(optionalProp('full_text_searches', t.tsArrayType(t.tsTypeReference(t.identifier('BlueprintFullTextSearch')))), 'Full-text search configurations.'),
         addJSDoc(optionalProp('unique_constraints', t.tsArrayType(t.tsTypeReference(t.identifier('BlueprintUniqueConstraint')))), 'Unique constraints on table columns.'),
+        addJSDoc(optionalProp('membership_types', t.tsArrayType(t.tsTypeReference(t.identifier('BlueprintMembershipType')))), 'Entity types to provision in Phase 0 (before tables). Each entry creates an entity table with membership modules and security.'),
     ]), 'The complete blueprint definition -- the JSONB shape accepted by construct_blueprint().');
 }
 // ---------------------------------------------------------------------------
@@ -424,6 +439,7 @@ function buildProgram(meta) {
     statements.push(buildBlueprintTableIndex());
     statements.push(buildBlueprintUniqueConstraint());
     statements.push(buildBlueprintTableUniqueConstraint());
+    statements.push(buildBlueprintMembershipType());
     // -- Node types discriminated union --
     statements.push(sectionComment('Node types -- discriminated union for nodes[] entries'));
     statements.push(...buildNodeTypes(dataNodes));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-type-registry",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "Node type definitions for the Constructive blueprint system. Single source of truth for all Authz*, Data*, Relation*, and View* node types.",
   "author": "Constructive <developers@constructive.io>",
   "main": "index.js",
@@ -48,5 +48,5 @@
     "registry",
     "graphile"
   ],
-  "gitHead": "2128d45cd2dba727e18910a05665b1f5c7c137ae"
+  "gitHead": "ec793fd5de36264f5c9738732657522c1d783a6d"
 }