Refactored relationship validation to include type validation and partial matches

Author: oskardudycz

plan.md

@@ -6,18 +6,23 @@ import {
 } from '../schemaComponent';
 
 export type ColumnURNType = 'sc:dumbo:column';
-export type ColumnURN = `${ColumnURNType}:${string}`;
+export type ColumnURN<ColumnName extends string = string> =
+  `${ColumnURNType}:${ColumnName}`;
 
 export const ColumnURNType: ColumnURNType = 'sc:dumbo:column';
-export const ColumnURN = ({ name }: { name: string }): ColumnURN =>
-  `${ColumnURNType}:${name}`;
+export const ColumnURN = <ColumnName extends string = string>({
+  name,
+}: {
+  name: ColumnName;
+}): ColumnURN<ColumnName> => `${ColumnURNType}:${name}`;
 
 export type ColumnSchemaComponent<
   ColumnType extends AnyColumnTypeToken | string = AnyColumnTypeToken | string,
+  ColumnName extends string = string,
 > = SchemaComponent<
-  ColumnURN,
+  ColumnURN<ColumnName>,
   Readonly<{
-    columnName: string;
+    columnName: ColumnName;
   }>
 > &
   SQLColumnToken<ColumnType>;
@@ -31,14 +36,17 @@ export type ColumnSchemaComponentOptions<
   SchemaComponentOptions;
 
 export const columnSchemaComponent = <
-  ColumnType extends AnyColumnTypeToken | string = AnyColumnTypeToken | string,
-  TOptions extends
+  const ColumnType extends AnyColumnTypeToken | string =
+    | AnyColumnTypeToken
+    | string,
+  const TOptions extends
     ColumnSchemaComponentOptions<ColumnType> = ColumnSchemaComponentOptions<ColumnType>,
+  const ColumnName extends string = string,
 >(
   params: {
-    columnName: string;
+    columnName: ColumnName;
   } & TOptions,
-): ColumnSchemaComponent<ColumnType> &
+): ColumnSchemaComponent<ColumnType, ColumnName> &
   (TOptions extends { notNull: true } | { primaryKey: true }
     ? { notNull: true }
     : { notNull?: false }) => {
@@ -66,7 +74,7 @@ export const columnSchemaComponent = <
     type,
   };
 
-  return result as ColumnSchemaComponent<ColumnType> &
+  return result as ColumnSchemaComponent<ColumnType, ColumnName> &
     (TOptions extends { notNull: true } | { primaryKey: true }
       ? { notNull: true }
       : { notNull?: false });

src/packages/dumbo/src/core/schema/MIGRATION_UNIFICATION_PLAN.md

@@ -12,45 +12,51 @@ import {
 } from './tableSchemaComponent';
 
 export type DatabaseSchemaURNType = 'sc:dumbo:database_schema';
-export type DatabaseSchemaURN = `${DatabaseSchemaURNType}:${string}`;
+export type DatabaseSchemaURN<SchemaName extends string = string> =
+  `${DatabaseSchemaURNType}:${SchemaName}`;
 
 export const DatabaseSchemaURNType: DatabaseSchemaURNType =
   'sc:dumbo:database_schema';
-export const DatabaseSchemaURN = ({
+export const DatabaseSchemaURN = <SchemaName extends string = string>({
   name,
 }: {
-  name: string;
-}): DatabaseSchemaURN => `${DatabaseSchemaURNType}:${name}`;
+  name: SchemaName;
+}): DatabaseSchemaURN<SchemaName> => `${DatabaseSchemaURNType}:${name}`;
 
 export type DatabaseSchemaTables<
   Tables extends AnyTableSchemaComponent = AnyTableSchemaComponent,
 > = Record<string, Tables>;
 
 export type DatabaseSchemaSchemaComponent<
   Tables extends DatabaseSchemaTables = DatabaseSchemaTables,
+  SchemaName extends string = string,
 > = SchemaComponent<
-  DatabaseSchemaURN,
+  DatabaseSchemaURN<SchemaName>,
   Readonly<{
-    schemaName: string;
+    schemaName: SchemaName;
     tables: ReadonlyMap<string, TableSchemaComponent> & Tables;
     addTable: (table: string | TableSchemaComponent) => TableSchemaComponent;
   }>
 >;
 
 export type AnyDatabaseSchemaSchemaComponent =
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  DatabaseSchemaSchemaComponent<any>;
+  DatabaseSchemaSchemaComponent<any, any>;
 
 export const databaseSchemaSchemaComponent = <
-  Tables extends DatabaseSchemaTables = DatabaseSchemaTables,
+  const Tables extends DatabaseSchemaTables = DatabaseSchemaTables,
+  const SchemaName extends string = string,
 >({
   schemaName,
   tables,
   ...migrationsOrComponents
 }: {
-  schemaName: string;
+  schemaName: SchemaName;
   tables?: Tables;
-} & SchemaComponentOptions): DatabaseSchemaSchemaComponent<Tables> => {
+} & SchemaComponentOptions): DatabaseSchemaSchemaComponent<
+  Tables,
+  SchemaName
+> => {
   const base = schemaComponent(DatabaseSchemaURN({ name: schemaName }), {
     migrations: migrationsOrComponents.migrations ?? [],
     components: [