@pattern-stack/codegen 0.10.1 → 0.12.0

package/dist/src/index.d.ts

@@ -51,16 +51,16 @@ interface ParsedQuery {
     limit?: boolean;
     via?: string;
 }
-interface ParsedProviderSync {
+interface ParsedProviderIntegration {
     remoteEntity: string;
     direction: 'inbound' | 'outbound' | 'bidirectional';
     cdc: boolean;
     fieldMapping?: Record<string, string>;
     readOnlyFields?: string[];
 }
-interface ParsedSync {
+interface ParsedIntegration {
     electric: boolean;
-    providers?: Record<string, ParsedProviderSync>;
+    providers?: Record<string, ParsedProviderIntegration>;
 }
 interface ParsedEvent {
     name: string;
@@ -94,7 +94,7 @@ interface ParsedEntity {
     relationships: Map<string, ParsedRelationship>;
     behaviors: string[];
     queries?: ParsedQuery[];
-    sync?: ParsedSync;
+    integration?: ParsedIntegration;
     events?: ParsedEvent[];
     /**
      * EVT-7: Opt-in list of event types this entity emits from its generated
@@ -1432,7 +1432,7 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         order?: string | undefined;
         via?: string | undefined;
     }>]>, "many">>;
-    sync: z.ZodOptional<z.ZodObject<{
+    integration: z.ZodOptional<z.ZodObject<{
         electric: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
         providers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
             remote_entity: z.ZodString;
@@ -1692,6 +1692,8 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
             value?: unknown;
         }[] | undefined;
     }>]>>>;
+    surface: z.ZodOptional<z.ZodString>;
+    context: z.ZodOptional<z.ZodString>;
     events: z.ZodOptional<z.ZodArray<z.ZodObject<{
         name: z.ZodString;
         queue: z.ZodString;
@@ -1955,6 +1957,16 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         measure_packs?: string[] | undefined;
         cube_name?: string | undefined;
     }>>;
+    unique_indexes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        fields: z.ZodArray<z.ZodString, "many">;
+        name: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        fields: string[];
+        name?: string | undefined;
+    }, {
+        fields: string[];
+        name?: string | undefined;
+    }>, "many">>;
 }, "strict", z.ZodTypeAny, {
     fields: Record<string, {
         type: "string" | "boolean" | "integer" | "date" | "json" | "decimal" | "uuid" | "datetime" | "entity_ref" | "string_array" | "enum";
@@ -2046,7 +2058,7 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         search?: string | undefined;
         order?: string | undefined;
     })[] | undefined;
-    sync?: {
+    integration?: {
         electric: boolean;
         providers?: Record<string, {
             cdc: boolean;
@@ -2100,6 +2112,8 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
             value?: unknown;
         }[];
     }> | undefined;
+    surface?: string | undefined;
+    context?: string | undefined;
     events?: {
         name: string;
         queue: string;
@@ -2153,6 +2167,10 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         measure_packs?: string[] | undefined;
         cube_name?: string | undefined;
     } | undefined;
+    unique_indexes?: {
+        fields: string[];
+        name?: string | undefined;
+    }[] | undefined;
 }, {
     fields: Record<string, {
         type: "string" | "boolean" | "integer" | "date" | "json" | "decimal" | "uuid" | "datetime" | "entity_ref" | "string_array" | "enum";
@@ -2244,7 +2262,7 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         order?: string | undefined;
         paginate?: boolean | undefined;
     })[] | undefined;
-    sync?: {
+    integration?: {
         electric?: boolean | undefined;
         providers?: Record<string, {
             direction: "inbound" | "outbound" | "bidirectional";
@@ -2298,6 +2316,8 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
             value?: unknown;
         }[] | undefined;
     }> | undefined;
+    surface?: string | undefined;
+    context?: string | undefined;
     events?: {
         name: string;
         queue: string;
@@ -2351,6 +2371,10 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         measure_packs?: string[] | undefined;
         cube_name?: string | undefined;
     } | undefined;
+    unique_indexes?: {
+        fields: string[];
+        name?: string | undefined;
+    }[] | undefined;
 }>, {
     fields: Record<string, {
         type: "string" | "boolean" | "integer" | "date" | "json" | "decimal" | "uuid" | "datetime" | "entity_ref" | "string_array" | "enum";
@@ -2442,7 +2466,7 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         search?: string | undefined;
         order?: string | undefined;
     })[] | undefined;
-    sync?: {
+    integration?: {
         electric: boolean;
         providers?: Record<string, {
             cdc: boolean;
@@ -2496,6 +2520,8 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
             value?: unknown;
         }[];
     }> | undefined;
+    surface?: string | undefined;
+    context?: string | undefined;
     events?: {
         name: string;
         queue: string;
@@ -2549,6 +2575,10 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         measure_packs?: string[] | undefined;
         cube_name?: string | undefined;
     } | undefined;
+    unique_indexes?: {
+        fields: string[];
+        name?: string | undefined;
+    }[] | undefined;
 }, {
     fields: Record<string, {
         type: "string" | "boolean" | "integer" | "date" | "json" | "decimal" | "uuid" | "datetime" | "entity_ref" | "string_array" | "enum";
@@ -2640,7 +2670,7 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         order?: string | undefined;
         paginate?: boolean | undefined;
     })[] | undefined;
-    sync?: {
+    integration?: {
         electric?: boolean | undefined;
         providers?: Record<string, {
             direction: "inbound" | "outbound" | "bidirectional";
@@ -2694,6 +2724,8 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
             value?: unknown;
         }[] | undefined;
     }> | undefined;
+    surface?: string | undefined;
+    context?: string | undefined;
     events?: {
         name: string;
         queue: string;
@@ -2747,6 +2779,10 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         measure_packs?: string[] | undefined;
         cube_name?: string | undefined;
     } | undefined;
+    unique_indexes?: {
+        fields: string[];
+        name?: string | undefined;
+    }[] | undefined;
 }>, {
     fields: Record<string, {
         type: "string" | "boolean" | "integer" | "date" | "json" | "decimal" | "uuid" | "datetime" | "entity_ref" | "string_array" | "enum";
@@ -2838,7 +2874,7 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         search?: string | undefined;
         order?: string | undefined;
     })[] | undefined;
-    sync?: {
+    integration?: {
         electric: boolean;
         providers?: Record<string, {
             cdc: boolean;
@@ -2892,6 +2928,8 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
             value?: unknown;
         }[];
     }> | undefined;
+    surface?: string | undefined;
+    context?: string | undefined;
     events?: {
         name: string;
         queue: string;
@@ -2945,6 +2983,10 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         measure_packs?: string[] | undefined;
         cube_name?: string | undefined;
     } | undefined;
+    unique_indexes?: {
+        fields: string[];
+        name?: string | undefined;
+    }[] | undefined;
 }, {
     fields: Record<string, {
         type: "string" | "boolean" | "integer" | "date" | "json" | "decimal" | "uuid" | "datetime" | "entity_ref" | "string_array" | "enum";
@@ -3036,7 +3078,7 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         order?: string | undefined;
         paginate?: boolean | undefined;
     })[] | undefined;
-    sync?: {
+    integration?: {
         electric?: boolean | undefined;
         providers?: Record<string, {
             direction: "inbound" | "outbound" | "bidirectional";
@@ -3090,6 +3132,8 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
             value?: unknown;
         }[] | undefined;
     }> | undefined;
+    surface?: string | undefined;
+    context?: string | undefined;
     events?: {
         name: string;
         queue: string;
@@ -3143,6 +3187,10 @@ declare const EntityDefinitionSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         measure_packs?: string[] | undefined;
         cube_name?: string | undefined;
     } | undefined;
+    unique_indexes?: {
+        fields: string[];
+        name?: string | undefined;
+    }[] | undefined;
 }>;
 type EntityDefinition = z.infer<typeof EntityDefinitionSchema>;
 
@@ -3817,7 +3865,7 @@ type PatternKind = 'domain' | 'orchestration';
  * store these and look them up by `name`.
  */
 interface PatternDefinition<TConfig = unknown> {
-    /** Unique name used in YAML — e.g. `pattern: Synced` */
+    /** Unique name used in YAML — e.g. `pattern: Integrated` */
     name: string;
     /**
      * ADR-032: defaults to `"domain"`. Phase 3 adds `"orchestration"` as a
@@ -3828,7 +3876,7 @@ interface PatternDefinition<TConfig = unknown> {
     kind?: 'domain';
     /**
      * Built-in patterns this extends, by name. Phase 1 supports single-depth
-     * chains only — a pattern may `extends: ['Synced']` but the transitive
+     * chains only — a pattern may `extends: ['Integrated']` but the transitive
      * chain is not yet resolved. Multi-depth inheritance is deferred until
      * a real consumer asks.
      */
@@ -3840,7 +3888,7 @@ interface PatternDefinition<TConfig = unknown> {
     /**
      * Fully-qualified TypeScript path alias the consumer's tsconfig resolves.
      * Library patterns use the consumer-installed runtime base class path
-     * (e.g. `@shared/base-classes/synced-entity-repository`); app patterns
+     * (e.g. `@shared/base-classes/integrated-entity-repository`); app patterns
      * use whatever alias the consumer has configured (e.g. `@/patterns/...`).
      */
     repositoryImport?: string;
@@ -4028,7 +4076,7 @@ declare const BasePattern: PatternDefinition<unknown>;
  * JunctionPattern — top-level discriminator for explicit many-to-many
  * junction YAML files.
  *
- * Unlike `Activity` / `Synced` / `Metadata` (which attach to an entity via
+ * Unlike `Activity` / `Integrated` / `Metadata` (which attach to an entity via
  * `pattern:` / `patterns:`), `Junction` IS the top-level YAML shape — a
  * junction file's discriminator is `pattern: Junction`, not `entity:`.
  * It therefore does not declare `repositoryClass` / `serviceClass`: the
@@ -4072,19 +4120,19 @@ declare const KnowledgePattern: PatternDefinition<unknown>;
 declare const MetadataPattern: PatternDefinition<unknown>;
 
 /**
- * SyncedPattern — adds external-system sync columns and methods.
+ * IntegratedPattern — adds external-system integration columns and methods.
  *
- * Replaces the legacy `family: synced` entry in
+ * Replaces the legacy `family: integrated` entry in
  * `templates/entity/new/clean-lite-ps/prompt-extension.js`. Class names,
  * import paths, and inherited-method comment lines are preserved verbatim
  * so PATTERN-5's template swap produces byte-identical output for
- * pre-existing `family: synced` fixtures.
+ * pre-existing `family: integrated` fixtures.
  *
  * Implies `external_id_tracking` — the behavior that contributes the
  * `external_id`, `provider`, and `provider_metadata` columns to the table.
- * An entity declaring `pattern: Synced` need not re-declare the behavior.
+ * An entity declaring `pattern: Integrated` need not re-declare the behavior.
  */
-declare const SyncedPattern: PatternDefinition<unknown>;
+declare const IntegratedPattern: PatternDefinition<unknown>;
 
 /**
  * BaseJunctionFields — shared column shape every junction table carries.
@@ -4255,7 +4303,7 @@ interface PatternProjectContext {
  *
  * Today this only covers plan Risk 4: warn when patterns are declared
  * but the selected architecture is `clean`, which does not yet consume
- * them. A `clean` consumer with `pattern: Synced` is not broken — the
+ * them. A `clean` consumer with `pattern: Integrated` is not broken — the
  * `clean` pipeline ignores the key — but they see no effect, which is
  * confusing without the warning.
  */
@@ -4344,4 +4392,4 @@ declare function validateEntities(entitiesDir: string): {
     errors: string[];
 };
 
-export { ActivityPattern, type AnalysisIssue, type AnalysisResult, type AnalyzeDomainOptions, type AnyPatternDefinition, BASE_JUNCTION_FIELD_NAMES, BaseJunctionFields, BasePattern, type CodegenManifest, type DomainGraph, type DomainStatistics, type EntityNode, type JunctionDefinition, JunctionDefinitionSchema, JunctionPattern, KnowledgePattern, type LoadAppPatternsResult, type ManifestEntity, type ManifestField, type ManifestRelationship, type ManifestSuggestion, MetadataPattern, type OrchestrationPatternDefinition, type OrchestrationProjectContext, type OrchestrationRegistrySpec, type OutputFormat, type ParsedEntity, type ParsedEvent, type ParsedField, type ParsedProviderSync, type ParsedQuery, type ParsedRelationship, type ParsedRelationshipDefinition, type ParsedSync, type ParsedTypeDirection, type PathHop, type PatternColumnContribution, type PatternDefinition, type PatternKind, type PatternProjectContext, type RelationshipEdge, type Severity, SyncedPattern, type TransitivePath, type TransitiveSuggestion, analyzeDomain, buildDomainGraph, checkConsistency, computeStatistics, defineOrchestrationPattern, definePattern, findCircularDependencies, findOrphanEntities, formatConsole, formatJson, formatMarkdown, formatMermaidGraph, getAllOrchestrationPatterns, getAllPatternNames, getAppPatternNames, getLibraryPatternNames, getOrchestrationPattern, getOrchestrationPatternNames, getPattern, getRelatedEntities, isDomainPattern, isOrchestrationPattern, isPatternDefinition, loadAppPatterns, loadEntities, loadEntityFromYaml, loadJunctionFromYaml, loadRelationshipFromYaml, loadRelationships, registerLibraryPattern, safeValidateJunctionDefinition, validateEntities, validateJunctionDefinition, validateOrchestrationProject, validatePatternComposition, validatePatternProject };
+export { ActivityPattern, type AnalysisIssue, type AnalysisResult, type AnalyzeDomainOptions, type AnyPatternDefinition, BASE_JUNCTION_FIELD_NAMES, BaseJunctionFields, BasePattern, type CodegenManifest, type DomainGraph, type DomainStatistics, type EntityNode, IntegratedPattern, type JunctionDefinition, JunctionDefinitionSchema, JunctionPattern, KnowledgePattern, type LoadAppPatternsResult, type ManifestEntity, type ManifestField, type ManifestRelationship, type ManifestSuggestion, MetadataPattern, type OrchestrationPatternDefinition, type OrchestrationProjectContext, type OrchestrationRegistrySpec, type OutputFormat, type ParsedEntity, type ParsedEvent, type ParsedField, type ParsedIntegration, type ParsedProviderIntegration, type ParsedQuery, type ParsedRelationship, type ParsedRelationshipDefinition, type ParsedTypeDirection, type PathHop, type PatternColumnContribution, type PatternDefinition, type PatternKind, type PatternProjectContext, type RelationshipEdge, type Severity, type TransitivePath, type TransitiveSuggestion, analyzeDomain, buildDomainGraph, checkConsistency, computeStatistics, defineOrchestrationPattern, definePattern, findCircularDependencies, findOrphanEntities, formatConsole, formatJson, formatMarkdown, formatMermaidGraph, getAllOrchestrationPatterns, getAllPatternNames, getAppPatternNames, getLibraryPatternNames, getOrchestrationPattern, getOrchestrationPatternNames, getPattern, getRelatedEntities, isDomainPattern, isOrchestrationPattern, isPatternDefinition, loadAppPatterns, loadEntities, loadEntityFromYaml, loadJunctionFromYaml, loadRelationshipFromYaml, loadRelationships, registerLibraryPattern, safeValidateJunctionDefinition, validateEntities, validateJunctionDefinition, validateOrchestrationProject, validatePatternComposition, validatePatternProject };