@memberjunction/codegen-lib 4.4.0 → 5.1.0

package/dist/EntityNameScanner/EntityNameScanner.d.ts

@@ -0,0 +1,166 @@
+/**
+ * AST-based scanner/fixer for hardcoded entity names AND class name references
+ * in TypeScript source code, for the MemberJunction v5.0 migration.
+ *
+ * Three replacement strategies (ported from tools/migrate-entity-refs.js):
+ *
+ *   1. **Class names** (regex with word boundaries):
+ *      `ActionEntity` → `MJActionEntity`, `ActionSchema` → `MJActionSchema`,
+ *      `ActionEntityType` → `MJActionEntityType`
+ *
+ *   2. **Multi-word entity names** (regex with quote boundaries):
+ *      `'Action Categories'` → `'MJ: Action Categories'`
+ *
+ *   3. **Single-word entity names** (TypeScript AST):
+ *      Only replaces string literals in confirmed entity-name contexts
+ *      (EntityName properties, GetEntityObject args, RegisterClass decorators, etc.)
+ *
+ * Usage (via MJCLI):
+ *   mj codegen 5-0-fix-entity-names --path packages/Angular
+ *   mj codegen 5-0-fix-entity-names --path packages/Angular --fix
+ *
+ * Or programmatically:
+ *   import { scanEntityNames } from '@memberjunction/codegen-lib';
+ *   const result = await scanEntityNames({ TargetPath: './packages' });
+ */
+import { type EntityRenameEntry } from './entity-rename-map.js';
+/** The kind of pattern where an old name was found. */
+export type EntityNamePatternKind = 'GetEntityObject' | 'OpenEntityRecord' | 'EntityNameMethod' | 'EntityNameProperty' | 'RegisterClass' | 'NameComparison' | 'ClassName' | 'MultiWordEntityName';
+/**
+ * A single finding: one string literal or identifier in source code that uses
+ * an old entity name or class name.
+ */
+export interface EntityNameFinding {
+    /** Absolute path to the source file */
+    FilePath: string;
+    /** 1-based line number */
+    Line: number;
+    /** 0-based character offset within the line */
+    Column: number;
+    /** The old name found */
+    OldName: string;
+    /** The corrected name */
+    NewName: string;
+    /** The quote character used (' or " or `) — empty string for class name references */
+    QuoteChar: string;
+    /** 0-based start position of the token in the file */
+    StartPos: number;
+    /** 0-based end position of the token in the file */
+    EndPos: number;
+    /** The kind of pattern matched */
+    PatternKind: EntityNamePatternKind;
+}
+/**
+ * Options for the entity name scanner.
+ */
+export interface EntityNameScanOptions {
+    /** File or directory to scan */
+    TargetPath: string;
+    /**
+     * Path to entity_subclasses.ts for building the rename map dynamically.
+     * If not provided, uses the embedded rename map compiled into this package.
+     */
+    EntitySubclassesPath?: string;
+    /** Whether to apply fixes in place. Default: false (dry-run). */
+    Fix?: boolean;
+    /** Additional glob patterns to exclude from scanning. */
+    ExcludePatterns?: string[];
+    /** If true, logs progress to console. Default: true. */
+    Verbose?: boolean;
+}
+/**
+ * Result of a scan (and optional fix) operation.
+ */
+export interface EntityNameScanResult {
+    Success: boolean;
+    /** All findings across all scanned files */
+    Findings: EntityNameFinding[];
+    /** Absolute paths of files that were modified (only in fix mode) */
+    FixedFiles: string[];
+    /** Number of files scanned */
+    FilesScanned: number;
+    /** Number of entries in the rename map */
+    RenameMapSize: number;
+    /** Errors encountered during scanning */
+    Errors: string[];
+}
+export type { EntityRenameEntry } from './entity-rename-map.js';
+export { ENTITY_RENAME_MAP } from './entity-rename-map.js';
+/** A precompiled regex rule for class name or multi-word entity name replacement. */
+export interface RegexRule {
+    old: string;
+    new: string;
+    pattern: RegExp;
+}
+/** A multi-word entity name rule with patterns for each quote style. */
+export interface MultiWordNameRule {
+    old: string;
+    new: string;
+    singleQuotePattern: RegExp;
+    doubleQuotePattern: RegExp;
+    backtickPattern: RegExp;
+}
+/**
+ * Builds class rename rules from the rename map entries.
+ * For each entry with classNameChanged=true, creates regex rules for:
+ *   - OldClassNameEntityType → NewClassNameEntityType (zod inferred type)
+ *   - OldClassNameSchema     → NewClassNameSchema     (zod schema constant)
+ *   - OldClassNameEntity     → NewClassNameEntity     (class name itself)
+ *
+ * Uses negative lookbehind for / and . to avoid matching inside file paths
+ * (e.g., `import { Foo } from './custom/OldClassNameEntity'` should NOT rename the path).
+ */
+export declare function buildClassRenameRules(entries: EntityRenameEntry[]): RegexRule[];
+/**
+ * Builds multi-word entity name regex rules.
+ * For each entry with nameChanged=true AND a multi-word old name,
+ * creates patterns that match the old name inside quotes.
+ */
+export declare function buildMultiWordNameRules(entries: EntityRenameEntry[]): MultiWordNameRule[];
+/**
+ * Builds an entity name rename map (old → new) from the embedded data.
+ * This is the simple entity-name-only map used by the HTML and metadata scanners.
+ */
+export declare function loadEmbeddedRenameMap(): Map<string, string>;
+/**
+ * Parses entity_subclasses.ts to build a map of old entity names to new
+ * (MJ:-prefixed) entity names.
+ *
+ * Scans for `@RegisterClass(BaseEntity, 'MJ: SomeName')` decorators and
+ * creates a mapping: `'SomeName' -> 'MJ: SomeName'`.
+ */
+export declare function buildEntityNameMap(entitySubclassesPath: string): Map<string, string>;
+/**
+ * Builds the entity name rename map, trying entity_subclasses.ts first and
+ * falling back to the embedded rename map compiled into this package.
+ */
+export declare function resolveEntityNameMap(basePath: string, explicitPath: string | undefined, verbose: boolean): Map<string, string>;
+/**
+ * Scans a single TypeScript file for entity name and class name references
+ * that need updating for the v5.0 migration.
+ *
+ * Applies all three strategies:
+ * 1. Regex-based class name scanning
+ * 2. Regex-based multi-word entity name scanning
+ * 3. AST-based single-word entity name scanning
+ */
+export declare function scanFile(filePath: string, sourceText: string, renameMap: Map<string, string>, classRules?: RegexRule[], multiWordRules?: MultiWordNameRule[]): EntityNameFinding[];
+/**
+ * Applies fixes to a file by replacing old names with new names
+ * at the exact positions identified by the scanner.
+ *
+ * Processes findings from end to start to preserve byte offsets.
+ */
+export declare function fixFile(sourceText: string, findings: EntityNameFinding[]): string;
+/**
+ * Scans TypeScript files for hardcoded entity names and class name references
+ * that need updating for the MemberJunction v5.0 migration, and optionally
+ * fixes them in place.
+ *
+ * Three strategies are applied:
+ * 1. Class name renames (regex): ActionEntity → MJActionEntity
+ * 2. Multi-word entity name renames (regex): 'AI Models' → 'MJ: AI Models'
+ * 3. Single-word entity name renames (AST): 'Actions' → 'MJ: Actions' (context-verified)
+ */
+export declare function scanEntityNames(options: EntityNameScanOptions): Promise<EntityNameScanResult>;
+//# sourceMappingURL=EntityNameScanner.d.ts.map

package/dist/EntityNameScanner/EntityNameScanner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityNameScanner.d.ts","sourceRoot":"","sources":["../../src/EntityNameScanner/EntityNameScanner.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAMH,OAAO,EAAqB,KAAK,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAMhF,uDAAuD;AACvD,MAAM,MAAM,qBAAqB,GAC3B,iBAAiB,GACjB,kBAAkB,GAClB,kBAAkB,GAClB,oBAAoB,GACpB,eAAe,GACf,gBAAgB,GAChB,WAAW,GACX,qBAAqB,CAAC;AAE5B;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,sFAAsF;IACtF,SAAS,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,QAAQ,EAAE,MAAM,CAAC;IACjB,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAC;IACf,kCAAkC;IAClC,WAAW,EAAE,qBAAqB,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,iEAAiE;IACjE,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,yDAAyD;IACzD,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,wDAAwD;IACxD,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,4CAA4C;IAC5C,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B,oEAAoE;IACpE,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,8BAA8B;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,aAAa,EAAE,MAAM,CAAC;IACtB,yCAAyC;IACzC,MAAM,EAAE,MAAM,EAAE,CAAC;CACpB;AAGD,YAAY,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAmExD,qFAAqF;AACrF,MAAM,WAAW,SAAS;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,wEAAwE;AACxE,MAAM,WAAW,iBAAiB;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,iBAAiB,EAAE,GAAG,SAAS,EAAE,CAoB/E;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,iBAAiB,EAAE,GAAG,iBAAiB,EAAE,CAkBzF;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAQ3D;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,oBAAoB,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAmEpF;AAmCD;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,OAAO,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAuB9H;AAwJD;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACpB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAC9B,UAAU,CAAC,EAAE,SAAS,EAAE,EACxB,cAAc,CAAC,EAAE,iBAAiB,EAAE,GACrC,iBAAiB,EAAE,CA4IrB;AAyCD;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAiCjF;AA4BD;;;;;;;;;GASG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAkHnG"}