@danielhritcu/zenstack-custom 1.1.0 → 1.2.1

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-export { D as DerivedField, a as DerivedModelDescriptor, E as ExtendedSchema, G as GlobalConfig, M as ManyRelation, b as ModelConfig, c as ModelsOutput, O as OneRelation, S as SchemaConfig, d as SearchField, e as SearchProfile, T as ThroughPath, f as ThroughRelation, Z as ZenConfig, g as defineConfig } from './config-1Cdfs72F.cjs';
-export { APP_SLUG_JS, APP_SLUG_SQL, ComputedFieldDeclaration, ComputedFieldInfo, ComputedFieldsConfig, DerivedModelDeclaration, DerivedModelsConfig, EmitSchemaOptions, EnumInfo, FKInfo, FKRelationInfo, FieldInfo, FilteredRelationDeclaration, FilteredRelationsConfig, GENERATED_FILE_BANNER, RelationField, ResolvedRelationTargets, SearchDefaultDeclaration, SearchDefaultsConfig, TableInfo, ThroughRelationDeclaration, ThroughRelationPath, ThroughRelationsConfig, TypeDefField, TypeDefInfo, TypeDefMapping, TypedJsonArtifacts, TypedJsonFieldInfo, ViewInfo, adaptToLegacyConfig, assertNoTypedColumnOverrides, buildRelations, buildTypeDefs, capitalize, defineModels, derived, discoverEnums, discoverTables, discoverViews, emitCompatTs, emitEnumBlock, emitEnumsTs, emitFieldBlock, emitGeneratedFileBanner, emitIndexTs, emitInputTs, emitJsonNamespaceBlock, emitJsonRawNamespaceBlock, emitJsonRawTs, emitJsonTs, emitModelsTs, emitOrmTypesTs, emitRelationField, emitSchemaTs, emitTypeDefsBlock, emitViewsTs, esc, extend, extractFKs, getDrizzleTableName, many, mapColumn, model, one, through, toPascalCase, uncapitalize, writeFileIfChanged } from './codegen/index.cjs';
+export { D as DerivedField, a as DerivedModelDescriptor, E as ExtendedSchema, G as GlobalConfig, M as ManyRelation, b as ModelConfig, c as ModelsOutput, O as OneRelation, S as SchemaConfig, d as SearchField, e as SearchProfile, T as ThroughPath, f as ThroughRelation, Z as ZenConfig, g as defineConfig } from './config-rukOeRbn.cjs';
+export { APP_SLUG_JS, APP_SLUG_SQL, BrandingInfo, ComputedFieldDeclaration, ComputedFieldInfo, ComputedFieldsConfig, DerivedModelDeclaration, DerivedModelsConfig, EmitSchemaOptions, EnumInfo, FKInfo, FKRelationInfo, FieldInfo, FilteredRelationDeclaration, FilteredRelationsConfig, GENERATED_FILE_BANNER, RelationField, ResolvedRelationTargets, SearchDefaultDeclaration, SearchDefaultsConfig, TableInfo, ThroughRelationDeclaration, ThroughRelationPath, ThroughRelationsConfig, TypeDefField, TypeDefInfo, TypeDefMapping, TypedJsonArtifacts, TypedJsonFieldInfo, ViewInfo, adaptToLegacyConfig, assertNoTypedColumnOverrides, buildRelations, buildTypeDefs, capitalize, defineModels, derived, discoverEnums, discoverTables, discoverViews, emitCompatTs, emitEnumBlock, emitEnumsTs, emitFieldBlock, emitGeneratedFileBanner, emitIndexTs, emitInputTs, emitJsonNamespaceBlock, emitJsonRawNamespaceBlock, emitJsonRawTs, emitJsonTs, emitModelsTs, emitOrmTypesTs, emitRelationField, emitSchemaTs, emitTypeDefsBlock, emitViewsTs, esc, extend, extractFKs, getDrizzleTableName, many, mapColumn, model, one, through, toPascalCase, uncapitalize, writeFileIfChanged } from './codegen/index.cjs';
 export { ArgsBuilder, CategorizedChange, ChangeCategory, CronJobOpts, CustomHashes, CustomObject, CustomObjectEntry, CustomObjectType, CustomObjectsMap, ENUM_MAP, ExtensionOpts, FALSE, FunctionOpts, GenerateFlags, OrderIssue, PgCronJob, PgExtension, PgFunction, PgTrigger, PgTypes, TriggerEvent, TriggerForEach, TriggerFunction, TriggerFunctionOpts, TriggerOpts, TriggerTiming, appSlugForeignKey, auditColumns, categorizeChanges, cleanMeta, colAppSlug, colCreatedAt, colDeletedAt, colId, colNumeric, colTimestamp, colUpdatedAt, collectCustomObjects, computeHash, currentAppSlug, currentUser, custom, defaultPolicy, drop, fixOrder, formatChangeSummary, formatVerboseOutput, generate, generateDropSQL, getLatestSnapshotPath, hasAppSlug, hasBypassEnabled, loadSchemaModules, packToSgz, parseFlags, pgCron, pgExtension, pgFunction, pgOrmEnum, pgTrigger, pgTypes, readJournal, readSnapshotCustomObjects, serializeCustomObject, simpleDiff, syncMeta, toPgEnum, unpackFromSgz, validateOrder, validateTimestamps, writeSnapshotCustomObjects } from './drizzle/index.cjs';
 import 'drizzle-orm/pg-core';
 import 'drizzle-orm';

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-export { D as DerivedField, a as DerivedModelDescriptor, E as ExtendedSchema, G as GlobalConfig, M as ManyRelation, b as ModelConfig, c as ModelsOutput, O as OneRelation, S as SchemaConfig, d as SearchField, e as SearchProfile, T as ThroughPath, f as ThroughRelation, Z as ZenConfig, g as defineConfig } from './config-1Cdfs72F.js';
-export { APP_SLUG_JS, APP_SLUG_SQL, ComputedFieldDeclaration, ComputedFieldInfo, ComputedFieldsConfig, DerivedModelDeclaration, DerivedModelsConfig, EmitSchemaOptions, EnumInfo, FKInfo, FKRelationInfo, FieldInfo, FilteredRelationDeclaration, FilteredRelationsConfig, GENERATED_FILE_BANNER, RelationField, ResolvedRelationTargets, SearchDefaultDeclaration, SearchDefaultsConfig, TableInfo, ThroughRelationDeclaration, ThroughRelationPath, ThroughRelationsConfig, TypeDefField, TypeDefInfo, TypeDefMapping, TypedJsonArtifacts, TypedJsonFieldInfo, ViewInfo, adaptToLegacyConfig, assertNoTypedColumnOverrides, buildRelations, buildTypeDefs, capitalize, defineModels, derived, discoverEnums, discoverTables, discoverViews, emitCompatTs, emitEnumBlock, emitEnumsTs, emitFieldBlock, emitGeneratedFileBanner, emitIndexTs, emitInputTs, emitJsonNamespaceBlock, emitJsonRawNamespaceBlock, emitJsonRawTs, emitJsonTs, emitModelsTs, emitOrmTypesTs, emitRelationField, emitSchemaTs, emitTypeDefsBlock, emitViewsTs, esc, extend, extractFKs, getDrizzleTableName, many, mapColumn, model, one, through, toPascalCase, uncapitalize, writeFileIfChanged } from './codegen/index.js';
+export { D as DerivedField, a as DerivedModelDescriptor, E as ExtendedSchema, G as GlobalConfig, M as ManyRelation, b as ModelConfig, c as ModelsOutput, O as OneRelation, S as SchemaConfig, d as SearchField, e as SearchProfile, T as ThroughPath, f as ThroughRelation, Z as ZenConfig, g as defineConfig } from './config-rukOeRbn.js';
+export { APP_SLUG_JS, APP_SLUG_SQL, BrandingInfo, ComputedFieldDeclaration, ComputedFieldInfo, ComputedFieldsConfig, DerivedModelDeclaration, DerivedModelsConfig, EmitSchemaOptions, EnumInfo, FKInfo, FKRelationInfo, FieldInfo, FilteredRelationDeclaration, FilteredRelationsConfig, GENERATED_FILE_BANNER, RelationField, ResolvedRelationTargets, SearchDefaultDeclaration, SearchDefaultsConfig, TableInfo, ThroughRelationDeclaration, ThroughRelationPath, ThroughRelationsConfig, TypeDefField, TypeDefInfo, TypeDefMapping, TypedJsonArtifacts, TypedJsonFieldInfo, ViewInfo, adaptToLegacyConfig, assertNoTypedColumnOverrides, buildRelations, buildTypeDefs, capitalize, defineModels, derived, discoverEnums, discoverTables, discoverViews, emitCompatTs, emitEnumBlock, emitEnumsTs, emitFieldBlock, emitGeneratedFileBanner, emitIndexTs, emitInputTs, emitJsonNamespaceBlock, emitJsonRawNamespaceBlock, emitJsonRawTs, emitJsonTs, emitModelsTs, emitOrmTypesTs, emitRelationField, emitSchemaTs, emitTypeDefsBlock, emitViewsTs, esc, extend, extractFKs, getDrizzleTableName, many, mapColumn, model, one, through, toPascalCase, uncapitalize, writeFileIfChanged } from './codegen/index.js';
 export { ArgsBuilder, CategorizedChange, ChangeCategory, CronJobOpts, CustomHashes, CustomObject, CustomObjectEntry, CustomObjectType, CustomObjectsMap, ENUM_MAP, ExtensionOpts, FALSE, FunctionOpts, GenerateFlags, OrderIssue, PgCronJob, PgExtension, PgFunction, PgTrigger, PgTypes, TriggerEvent, TriggerForEach, TriggerFunction, TriggerFunctionOpts, TriggerOpts, TriggerTiming, appSlugForeignKey, auditColumns, categorizeChanges, cleanMeta, colAppSlug, colCreatedAt, colDeletedAt, colId, colNumeric, colTimestamp, colUpdatedAt, collectCustomObjects, computeHash, currentAppSlug, currentUser, custom, defaultPolicy, drop, fixOrder, formatChangeSummary, formatVerboseOutput, generate, generateDropSQL, getLatestSnapshotPath, hasAppSlug, hasBypassEnabled, loadSchemaModules, packToSgz, parseFlags, pgCron, pgExtension, pgFunction, pgOrmEnum, pgTrigger, pgTypes, readJournal, readSnapshotCustomObjects, serializeCustomObject, simpleDiff, syncMeta, toPgEnum, unpackFromSgz, validateOrder, validateTimestamps, writeSnapshotCustomObjects } from './drizzle/index.js';
 import 'drizzle-orm/pg-core';
 import 'drizzle-orm';

package/dist/index.js

@@ -138,7 +138,8 @@ function model(table, opts) {
     search: opts.search,
     defaultWhere: opts.defaultWhere,
     derived: opts.derived,
-    validate: opts.validate
+    validate: opts.validate,
+    branded: opts.branded
   };
 }
 __name(model, "model");
@@ -1850,6 +1851,32 @@ __name(sortTypedJsonFields, "sortTypedJsonFields");
 
 // src/codegen/emit.ts
 var DB_ATTR_RE = /@db\.(\w+)(?:\((\d+)\))?/;
+function isUuidField(t, fieldName) {
+  const col = t.table[fieldName];
+  if (!col) return false;
+  return col.columnType === "PgUUID";
+}
+__name(isUuidField, "isUuidField");
+function isPkField(t, fieldName) {
+  const col = t.table[fieldName];
+  if (!col) return false;
+  if (col.primary) return true;
+  const sqlName = col.name;
+  return t.cfg.primaryKeys.some((pk) => pk.columns.some((c) => c.name === sqlName));
+}
+__name(isPkField, "isPkField");
+function findFkTarget(t, fieldName, fkRelations) {
+  const modelFks = fkRelations[t.modelName];
+  if (!modelFks) return null;
+  for (const fkInfo of Object.values(modelFks)) {
+    const idx = fkInfo.fields.indexOf(fieldName);
+    if (idx >= 0) {
+      return fkInfo.targetExportName;
+    }
+  }
+  return null;
+}
+__name(findFkTarget, "findFkTarget");
 function buildDerivedEnumName(modelName, fieldName) {
   return `${toPascalCase(modelName)}${toPascalCase(fieldName)}`;
 }
@@ -2345,8 +2372,9 @@ function emitSchemaTs({ tables, enumMap, modelRelations, inverseRelations, searc
   return out.join("\n");
 }
 __name(emitSchemaTs, "emitSchemaTs");
-function emitModelsTs(tables, typedJsonFields = []) {
+function emitModelsTs(tables, typedJsonFields = [], branding) {
   const jsonFieldAliases = createJsonFieldAliasMap(typedJsonFields);
+  const hasBranding = branding && (Object.keys(branding.brandedFields).length > 0 || tables.some((t) => getEntityFieldNames(t).some((f) => isUuidField(t, f) && isPkField(t, f))));
   const out = [
     ...emitGeneratedFileBanner()
   ];
@@ -2354,6 +2382,10 @@ function emitModelsTs(tables, typedJsonFields = []) {
   out.push('import type * as $ from "@zenstackhq/orm";');
   out.push('import type * as Json from "./json";');
   out.push('import { type SchemaType as Schema } from "./schema";');
+  if (hasBranding) {
+    out.push("");
+    out.push("declare const __brand: unique symbol;");
+  }
   out.push("");
   for (const t of tables) {
     out.push(`export interface ${t.typeName} extends $.ModelResult<Schema, ${esc(t.modelName)}> {}`);
@@ -2364,7 +2396,12 @@ function emitModelsTs(tables, typedJsonFields = []) {
       if (jsonAlias) {
         out.push(`  export interface ${exportName} extends Json.${jsonAlias} {}`);
       } else {
-        out.push(`  export type ${exportName} = ${t.typeName}[${esc(fieldName)}];`);
+        const brandedLine = branding ? emitBrandedFieldLine(t, fieldName, exportName, branding, "  ") : null;
+        if (brandedLine) {
+          out.push(...brandedLine);
+        } else {
+          out.push(`  export type ${exportName} = ${t.typeName}[${esc(fieldName)}];`);
+        }
       }
     }
     out.push("}");
@@ -2373,6 +2410,33 @@ function emitModelsTs(tables, typedJsonFields = []) {
   return out.join("\n");
 }
 __name(emitModelsTs, "emitModelsTs");
+function emitBrandedFieldLine(t, fieldName, exportName, branding, indent2) {
+  const customBranded = branding.brandedFields[t.modelName]?.[fieldName];
+  if (isUuidField(t, fieldName) && isPkField(t, fieldName)) {
+    const brand = `${t.modelName}.${fieldName}`;
+    return [
+      `${indent2}export type ${exportName} = string & { [__brand]: '${brand}' };`,
+      `${indent2}export const ${exportName} = (id: string): ${exportName} => id as ${exportName};`
+    ];
+  }
+  if (isUuidField(t, fieldName)) {
+    const targetExportName = findFkTarget(t, fieldName, branding.fkRelations);
+    if (targetExportName) {
+      return [
+        `${indent2}export type ${exportName} = ${targetExportName}.Id;`
+      ];
+    }
+  }
+  if (customBranded) {
+    const brand = `${t.modelName}.${fieldName}`;
+    return [
+      `${indent2}export type ${exportName} = string & { [__brand]: '${brand}' };`,
+      `${indent2}export const ${exportName} = (id: string): ${exportName} => id as ${exportName};`
+    ];
+  }
+  return null;
+}
+__name(emitBrandedFieldLine, "emitBrandedFieldLine");
 function emitViewsTs(views, typedJsonFields = []) {
   const jsonFieldAliases = createJsonFieldAliasMap(typedJsonFields);
   const out = [
@@ -2438,12 +2502,13 @@ function emitInputTs(tables) {
   return out.join("\n");
 }
 __name(emitInputTs, "emitInputTs");
-function emitIndexTs({ tables, views, enumMap, typeDefs, typedJsonFields }) {
+function emitIndexTs({ tables, views, enumMap, typeDefs, typedJsonFields, branding }) {
   const allEnums = new Map([
     ...enumMap,
     ...collectDerivedEnums(tables, enumMap)
   ]);
   const jsonFieldAliases = createJsonFieldAliasMap(typedJsonFields);
+  const hasBranding = branding && (Object.keys(branding.brandedFields).length > 0 || tables.some((t) => getEntityFieldNames(t).some((f) => isUuidField(t, f) && isPkField(t, f))));
   const out = [
     ...emitGeneratedFileBanner()
   ];
@@ -2451,6 +2516,10 @@ function emitIndexTs({ tables, views, enumMap, typeDefs, typedJsonFields }) {
   out.push('import type * as $ from "@zenstackhq/orm";');
   out.push('import type * as RawJson from "../../supabase/schema/types";');
   out.push('import { type SchemaType as Schema } from "./schema";');
+  if (hasBranding) {
+    out.push("");
+    out.push("declare const __brand: unique symbol;");
+  }
   out.push("");
   out.push("export namespace Json {");
   out.push(...emitJsonNamespaceBlock(typeDefs, typedJsonFields, "  "));
@@ -2465,7 +2534,7 @@ function emitIndexTs({ tables, views, enumMap, typeDefs, typedJsonFields }) {
   out.push("");
   out.push("export namespace Table {");
   for (const table of tables) {
-    out.push(...emitEntityNamespaceBlock(table, table.modelName, jsonFieldAliases, "  "));
+    out.push(...emitEntityNamespaceBlock(table, table.modelName, jsonFieldAliases, "  ", branding));
     out.push("");
   }
   out.push("}");
@@ -2624,7 +2693,7 @@ function createJsonFieldAliasMap(typedJsonFields) {
   ]));
 }
 __name(createJsonFieldAliasMap, "createJsonFieldAliasMap");
-function emitEntityNamespaceBlock(entity, modelName, jsonFieldAliases, indent2 = "") {
+function emitEntityNamespaceBlock(entity, modelName, jsonFieldAliases, indent2 = "", branding) {
   const out = [];
   out.push(`${indent2}export interface ${entity.typeName} extends $.ModelResult<Schema, ${esc(modelName)}> {}`);
   out.push(`${indent2}export namespace ${entity.typeName} {`);
@@ -2634,7 +2703,13 @@ function emitEntityNamespaceBlock(entity, modelName, jsonFieldAliases, indent2 =
     if (jsonAlias) {
       out.push(`${indent2}  export interface ${exportName} extends Json.${jsonAlias} {}`);
     } else {
-      out.push(`${indent2}  export type ${exportName} = ${entity.typeName}[${esc(fieldName)}];`);
+      const isTable = "table" in entity;
+      const brandedLine = isTable && branding ? emitBrandedFieldLine(entity, fieldName, exportName, branding, `${indent2}  `) : null;
+      if (brandedLine) {
+        out.push(...brandedLine);
+      } else {
+        out.push(`${indent2}  export type ${exportName} = ${entity.typeName}[${esc(fieldName)}];`);
+      }
     }
   }
   out.push(`${indent2}}`);