@memberjunction/integration-schema-builder 0.0.1 → 5.9.0

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export type { DatabasePlatform, SourceSchemaInfo, SourceObjectInfo, SourceFieldInfo, SourceRelationshipInfo, TargetTableConfig, TargetColumnConfig, SoftFKEntry, ExistingTableInfo, ExistingColumnInfo, SchemaDiff, ColumnModification, TypeMappingEntry, EmittedFile, MigrationMetadata, SchemaBuilderInput, SchemaBuilderOutput, AccessControlResult, } from './interfaces.js';
+export { TypeMapper } from './TypeMapper.js';
+export { DDLGenerator, ValidateIdentifier } from './DDLGenerator.js';
+export { MigrationFileWriter } from './MigrationFileWriter.js';
+export { SoftFKConfigEmitter } from './SoftFKConfigEmitter.js';
+export { MetadataEmitter } from './MetadataEmitter.js';
+export { SchemaEvolution } from './SchemaEvolution.js';
+export { SchemaBuilder } from './SchemaBuilder.js';
+export { IsEntityBlocked, IsIntegrationWriteAllowed, GetBlockedEntities } from './AccessControl.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EACR,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,sBAAsB,EACtB,iBAAiB,EACjB,kBAAkB,EAClB,WAAW,EACX,iBAAiB,EACjB,kBAAkB,EAClB,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAChB,WAAW,EACX,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,GACtB,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGnD,OAAO,EAAE,eAAe,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/index.js

@@ -0,0 +1,11 @@
+// Classes
+export { TypeMapper } from './TypeMapper.js';
+export { DDLGenerator, ValidateIdentifier } from './DDLGenerator.js';
+export { MigrationFileWriter } from './MigrationFileWriter.js';
+export { SoftFKConfigEmitter } from './SoftFKConfigEmitter.js';
+export { MetadataEmitter } from './MetadataEmitter.js';
+export { SchemaEvolution } from './SchemaEvolution.js';
+export { SchemaBuilder } from './SchemaBuilder.js';
+// Functions
+export { IsEntityBlocked, IsIntegrationWriteAllowed, GetBlockedEntities } from './AccessControl.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAsBA,UAAU;AACV,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,YAAY;AACZ,OAAO,EAAE,eAAe,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/interfaces.d.ts

@@ -0,0 +1,182 @@
+/**
+ * Integration Schema Builder — Shared Interfaces
+ *
+ * These interfaces define the contracts between the Schema Builder's components
+ * and between connectors and the Schema Builder.
+ */
+/** Supported database platforms for DDL generation. */
+export type DatabasePlatform = 'sqlserver' | 'postgresql';
+import type { SourceSchemaInfo as _SourceSchemaInfo, SourceObjectInfo as _SourceObjectInfo, SourceFieldInfo as _SourceFieldInfo, SourceRelationshipInfo as _SourceRelationshipInfo } from '@memberjunction/integration-engine';
+export type SourceSchemaInfo = _SourceSchemaInfo;
+export type SourceObjectInfo = _SourceObjectInfo;
+export type SourceFieldInfo = _SourceFieldInfo;
+export type SourceRelationshipInfo = _SourceRelationshipInfo;
+/** User's customization of a target table to be created. */
+export interface TargetTableConfig {
+    /** Source object this table maps from. */
+    SourceObjectName: string;
+    /** Target database schema name (e.g., "hubspot", "ym"). */
+    SchemaName: string;
+    /** Target table name (e.g., "Deal", "Member"). */
+    TableName: string;
+    /** MJ entity display name (e.g., "HubSpot Deal", "YM Member"). */
+    EntityName: string;
+    /** Human-readable description for the table (emitted as sp_addextendedproperty). */
+    Description?: string;
+    /**
+     * Primary key field name(s) from the source system.
+     * These columns get a UNIQUE constraint and are registered as soft PKs.
+     * Supports composite PKs (multiple fields). Must be a subset of Columns.
+     */
+    PrimaryKeyFields: string[];
+    /** Column configurations (includes PK fields — they are regular columns). */
+    Columns: TargetColumnConfig[];
+    /** Soft FK relationships to configure. */
+    SoftForeignKeys: SoftFKEntry[];
+}
+/** User's customization of a single column. */
+export interface TargetColumnConfig {
+    /** Name of the field in the source object. */
+    SourceFieldName: string;
+    /** Column name in the target table. */
+    TargetColumnName: string;
+    /** SQL type for the target platform (populated by TypeMapper). */
+    TargetSqlType: string;
+    /** Whether the column allows NULLs. */
+    IsNullable: boolean;
+    /** Max length for string columns (null if not applicable). */
+    MaxLength: number | null;
+    /** Precision for numeric columns (null if not applicable). */
+    Precision: number | null;
+    /** Scale for numeric columns (null if not applicable). */
+    Scale: number | null;
+    /** Default value SQL expression (null if none). */
+    DefaultValue: string | null;
+    /** Human-readable description for the column (emitted as sp_addextendedproperty). */
+    Description?: string;
+}
+/** A single soft FK entry for additionalSchemaInfo. */
+export interface SoftFKEntry {
+    /** Schema containing the table with the FK column. */
+    SchemaName: string;
+    /** Table containing the FK column. */
+    TableName: string;
+    /** Column name that references another table. */
+    FieldName: string;
+    /** Schema of the target (referenced) table. */
+    TargetSchemaName: string;
+    /** Target (referenced) table name. */
+    TargetTableName: string;
+    /** Target (referenced) field name (usually "ID"). */
+    TargetFieldName: string;
+}
+/** Describes the current state of an existing table in the target database. */
+export interface ExistingTableInfo {
+    SchemaName: string;
+    TableName: string;
+    Columns: ExistingColumnInfo[];
+}
+/** Describes an existing column in a target table. */
+export interface ExistingColumnInfo {
+    Name: string;
+    SqlType: string;
+    IsNullable: boolean;
+    MaxLength: number | null;
+    Precision: number | null;
+    Scale: number | null;
+}
+/** Result of diffing source schema against existing table. */
+export interface SchemaDiff {
+    /** Columns that exist in source but not in target — need ALTER TABLE ADD. */
+    AddedColumns: TargetColumnConfig[];
+    /** Columns that exist in both but with different types — need ALTER TABLE ALTER. */
+    ModifiedColumns: ColumnModification[];
+    /** Columns that exist in target but not in source — deprecated (no physical drop). */
+    RemovedColumns: string[];
+}
+/** Describes a column type/nullability change. */
+export interface ColumnModification {
+    ColumnName: string;
+    OldType: string;
+    NewType: string;
+    OldNullable: boolean;
+    NewNullable: boolean;
+}
+/** Maps a generic source type to platform-specific SQL types. */
+export interface TypeMappingEntry {
+    /** Generic source type (e.g., "string", "integer"). */
+    SourceType: string;
+    /** SQL Server type template (e.g., "NVARCHAR(n)"). */
+    SqlServerType: string;
+    /** PostgreSQL type template (e.g., "VARCHAR(n)"). */
+    PostgresType: string;
+    /** MJ EntityField.Type value (informational — CodeGen discovers actual type). */
+    MJFieldType: string;
+}
+/** A single file produced by the Schema Builder. */
+export interface EmittedFile {
+    /** Relative path from repo root (e.g., "migrations/v2/V2026...sql"). */
+    FilePath: string;
+    /** Full file content. */
+    Content: string;
+    /** Human-readable description of what this file does. */
+    Description: string;
+}
+/** Metadata for a migration file header comment. */
+export interface MigrationMetadata {
+    /** Source system name (e.g., "HubSpot", "YourMembership"). */
+    SourceType: string;
+    /** Source object being migrated (e.g., "Deal", "Member"). */
+    ObjectName: string;
+    /** Action description (e.g., "CreateSchema", "CreateDealTable"). */
+    Action: string;
+    /** Who/what generated this migration. */
+    GeneratedBy: string;
+    /** ISO timestamp of generation. */
+    Timestamp: string;
+}
+/** Complete input to the SchemaBuilder orchestrator. */
+export interface SchemaBuilderInput {
+    /** Introspected source schema from connector. */
+    SourceSchema: SourceSchemaInfo;
+    /** User's customizations for target tables. */
+    TargetConfigs: TargetTableConfig[];
+    /** Target database platform. */
+    Platform: DatabasePlatform;
+    /** Current MJ version for migration naming. */
+    MJVersion: string;
+    /** Source system name (e.g., "HubSpot"). */
+    SourceType: string;
+    /** Path to existing additionalSchemaInfo JSON file. */
+    AdditionalSchemaInfoPath: string;
+    /** Path to migrations directory (e.g., "migrations/v2"). */
+    MigrationsDir: string;
+    /** Path to metadata directory (e.g., "metadata"). */
+    MetadataDir: string;
+    /** Current state of target tables (for evolution scenarios). Empty array for new tables. */
+    ExistingTables: ExistingTableInfo[];
+    /** EntitySettings for any __mj target entities (keyed by entity name). */
+    EntitySettingsForTargets: Record<string, Array<{
+        Name: string;
+        Value: string;
+    }>>;
+}
+/** Complete output of the SchemaBuilder orchestrator. */
+export interface SchemaBuilderOutput {
+    /** Migration SQL files to write. */
+    MigrationFiles: EmittedFile[];
+    /** Updated additionalSchemaInfo JSON content. */
+    AdditionalSchemaInfoUpdate: EmittedFile | null;
+    /** Metadata JSON files for mj-sync. */
+    MetadataFiles: EmittedFile[];
+    /** Warnings generated during processing (non-fatal). */
+    Warnings: string[];
+    /** Errors that prevented processing (fatal). */
+    Errors: string[];
+}
+/** Result of an access control check. */
+export interface AccessControlResult {
+    Allowed: boolean;
+    Reason: string;
+}
+//# sourceMappingURL=interfaces.d.ts.map

package/dist/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,uDAAuD;AACvD,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG,YAAY,CAAC;AAK1D,OAAO,KAAK,EACR,gBAAgB,IAAI,iBAAiB,EACrC,gBAAgB,IAAI,iBAAiB,EACrC,eAAe,IAAI,gBAAgB,EACnC,sBAAsB,IAAI,uBAAuB,EACpD,MAAM,oCAAoC,CAAC;AAE5C,MAAM,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AACjD,MAAM,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AACjD,MAAM,MAAM,eAAe,GAAG,gBAAgB,CAAC;AAC/C,MAAM,MAAM,sBAAsB,GAAG,uBAAuB,CAAC;AAI7D,4DAA4D;AAC5D,MAAM,WAAW,iBAAiB;IAC9B,0CAA0C;IAC1C,gBAAgB,EAAE,MAAM,CAAC;IACzB,2DAA2D;IAC3D,UAAU,EAAE,MAAM,CAAC;IACnB,kDAAkD;IAClD,SAAS,EAAE,MAAM,CAAC;IAClB,kEAAkE;IAClE,UAAU,EAAE,MAAM,CAAC;IACnB,oFAAoF;IACpF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,6EAA6E;IAC7E,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC9B,0CAA0C;IAC1C,eAAe,EAAE,WAAW,EAAE,CAAC;CAClC;AAED,+CAA+C;AAC/C,MAAM,WAAW,kBAAkB;IAC/B,8CAA8C;IAC9C,eAAe,EAAE,MAAM,CAAC;IACxB,uCAAuC;IACvC,gBAAgB,EAAE,MAAM,CAAC;IACzB,kEAAkE;IAClE,aAAa,EAAE,MAAM,CAAC;IACtB,uCAAuC;IACvC,UAAU,EAAE,OAAO,CAAC;IACpB,8DAA8D;IAC9D,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,8DAA8D;IAC9D,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,0DAA0D;IAC1D,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,mDAAmD;IACnD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,qFAAqF;IACrF,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAID,uDAAuD;AACvD,MAAM,WAAW,WAAW;IACxB,sDAAsD;IACtD,UAAU,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB,+CAA+C;IAC/C,gBAAgB,EAAE,MAAM,CAAC;IACzB,sCAAsC;IACtC,eAAe,EAAE,MAAM,CAAC;IACxB,qDAAqD;IACrD,eAAe,EAAE,MAAM,CAAC;CAC3B;AAID,+EAA+E;AAC/E,MAAM,WAAW,iBAAiB;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,kBAAkB,EAAE,CAAC;CACjC;AAED,sDAAsD;AACtD,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,8DAA8D;AAC9D,MAAM,WAAW,UAAU;IACvB,6EAA6E;IAC7E,YAAY,EAAE,kBAAkB,EAAE,CAAC;IACnC,oFAAoF;IACpF,eAAe,EAAE,kBAAkB,EAAE,CAAC;IACtC,sFAAsF;IACtF,cAAc,EAAE,MAAM,EAAE,CAAC;CAC5B;AAED,kDAAkD;AAClD,MAAM,WAAW,kBAAkB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;CACxB;AAID,iEAAiE;AACjE,MAAM,WAAW,gBAAgB;IAC7B,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,aAAa,EAAE,MAAM,CAAC;IACtB,qDAAqD;IACrD,YAAY,EAAE,MAAM,CAAC;IACrB,iFAAiF;IACjF,WAAW,EAAE,MAAM,CAAC;CACvB;AAID,oDAAoD;AACpD,MAAM,WAAW,WAAW;IACxB,wEAAwE;IACxE,QAAQ,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,yDAAyD;IACzD,WAAW,EAAE,MAAM,CAAC;CACvB;AAED,oDAAoD;AACpD,MAAM,WAAW,iBAAiB;IAC9B,8DAA8D;IAC9D,UAAU,EAAE,MAAM,CAAC;IACnB,6DAA6D;IAC7D,UAAU,EAAE,MAAM,CAAC;IACnB,oEAAoE;IACpE,MAAM,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;CACrB;AAID,wDAAwD;AACxD,MAAM,WAAW,kBAAkB;IAC/B,iDAAiD;IACjD,YAAY,EAAE,gBAAgB,CAAC;IAC/B,+CAA+C;IAC/C,aAAa,EAAE,iBAAiB,EAAE,CAAC;IACnC,gCAAgC;IAChC,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,+CAA+C;IAC/C,SAAS,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,UAAU,EAAE,MAAM,CAAC;IACnB,uDAAuD;IACvD,wBAAwB,EAAE,MAAM,CAAC;IACjC,4DAA4D;IAC5D,aAAa,EAAE,MAAM,CAAC;IACtB,qDAAqD;IACrD,WAAW,EAAE,MAAM,CAAC;IACpB,4FAA4F;IAC5F,cAAc,EAAE,iBAAiB,EAAE,CAAC;IACpC,0EAA0E;IAC1E,wBAAwB,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC,CAAC;CACpF;AAED,yDAAyD;AACzD,MAAM,WAAW,mBAAmB;IAChC,oCAAoC;IACpC,cAAc,EAAE,WAAW,EAAE,CAAC;IAC9B,iDAAiD;IACjD,0BAA0B,EAAE,WAAW,GAAG,IAAI,CAAC;IAC/C,uCAAuC;IACvC,aAAa,EAAE,WAAW,EAAE,CAAC;IAC7B,wDAAwD;IACxD,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,gDAAgD;IAChD,MAAM,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,yCAAyC;AACzC,MAAM,WAAW,mBAAmB;IAChC,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAClB"}

package/dist/interfaces.js

@@ -0,0 +1,8 @@
+/**
+ * Integration Schema Builder — Shared Interfaces
+ *
+ * These interfaces define the contracts between the Schema Builder's components
+ * and between connectors and the Schema Builder.
+ */
+export {};
+//# sourceMappingURL=interfaces.js.map

package/dist/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/package.json

@@ -1,10 +1,31 @@
 {
   "name": "@memberjunction/integration-schema-builder",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @memberjunction/integration-schema-builder",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
+  "type": "module",
+  "version": "5.9.0",
+  "description": "MemberJunction Integration Schema Builder - file-emission-only DDL generation for integration tables",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "build": "tsc && tsc-alias -f",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "dependencies": {
+    "@memberjunction/global": "5.9.0",
+    "@memberjunction/integration-engine": "5.9.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3",
+    "tsc-alias": "^1.8.16",
+    "vitest": "^4.0.18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MemberJunction/MJ"
+  },
+  "author": "MemberJunction.com",
+  "license": "ISC"
 }

package/README.md

@@ -1,45 +0,0 @@
-# @memberjunction/integration-schema-builder
-
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@memberjunction/integration-schema-builder`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**