@apso/cli 0.8.5 → 0.10.1

package/dist/lib/apsorc-parser.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadConfig = exports.findConfigPath = exports.parseApsorc = exports.parseApsorcV2 = exports.parseApsorcV1 = exports.ApiType = void 0;
+exports.findConfigPath = exports.parseApsorc = exports.parseApsorcV2 = exports.parseApsorcV1 = exports.ApiType = void 0;
 const tslib_1 = require("tslib");
 const fs = tslib_1.__importStar(require("fs"));
 const path = tslib_1.__importStar(require("path"));
@@ -105,7 +105,6 @@ exports.parseApsorc = parseApsorc;
  */
 const findConfigPath = () => {
     let currentDir = process.cwd();
-    // Search upwards
     while (currentDir !== path.parse(currentDir).root) {
         const configPath = path.join(currentDir, ".apsorc");
         if (fs.existsSync(configPath)) {
@@ -113,80 +112,10 @@ const findConfigPath = () => {
         }
         currentDir = path.dirname(currentDir);
     }
-    // Check root directory as well
     const rootConfigPath = path.join(currentDir, ".apsorc");
     if (fs.existsSync(rootConfigPath)) {
         return rootConfigPath;
     }
-    return null; // Not found
+    return null;
 };
 exports.findConfigPath = findConfigPath;
-/**
- * Loads, validates, and potentially migrates the .apsorc configuration.
- * Uses the `rc` library to find and load the .apsorc file.
- * Detects config version (V1 or V2) and migrates V1 to V2 if necessary.
- * Performs basic validation on the final V2 structure.
- * @param appName The name of the application (used by `rc`). Defaults to 'apso'.
- * @param defaults Default configuration values (used by `rc`).
- * @returns The unified configuration (entities, relationships, rootFolder).
- * @throws Error if the config file cannot be found, is invalid, or migration fails.
- */
-const loadConfig = (appName = "apso", defaults = {}) => {
-    // Use rc to find and load the configuration file (.apsorc)
-    const configData = (0, rc_1.default)(appName, defaults);
-    const rootFolder = configData.rootFolder || "src"; // Get rootFolder early
-    // Check if rc found and loaded the config
-    // rc returns an object with default keys if nothing is found,
-    // so check for more than just default keys or if configData.config exists
-    const hasMeaningfulConfig = configData &&
-        Object.keys(configData).some((key) => !Object.prototype.hasOwnProperty.call(defaults, key) && key !== "_") &&
-        configData.configs &&
-        configData.configs.length > 0;
-    if (!hasMeaningfulConfig) {
-        // If rc didn't find it, try our manual search as a fallback
-        const foundPath = (0, exports.findConfigPath)();
-        // Use ternary to satisfy unicorn/prefer-ternary rule
-        throw foundPath
-            ? new Error(`Configuration file found at: ${foundPath}, but failed to parse. Ensure it is valid JSON or INI.`)
-            : new Error(".apsorc configuration file not found in the current directory or any parent directory.");
-    }
-    // Determine version and parse accordingly using existing functions
-    const version = configData.version || 1; // Default to 1 if undefined
-    let parsedData;
-    // Create an object matching ApsorcType structure from rc data
-    const apsorcInput = {
-        version: version,
-        rootFolder: rootFolder,
-        entities: configData.entities || [],
-        apiType: configData.apiType || ApiType.Rest,
-        relationships: configData.relationships || [],
-    };
-    if (version === 1) {
-        // Pass the correctly structured object
-        parsedData = (0, exports.parseApsorcV1)(apsorcInput);
-    }
-    else if (version === 2 && Array.isArray(configData.relationships)) {
-        // Pass the correctly structured object
-        parsedData = (0, exports.parseApsorcV2)(apsorcInput);
-    }
-    else {
-        throw new Error("Invalid .apsorc format. Could not determine configuration version or structure.");
-    }
-    // Basic validation on the result of parsing
-    if (!parsedData.entities || !Array.isArray(parsedData.entities)) {
-        throw new Error("Invalid config: 'entities' array is missing or invalid after parsing.");
-    }
-    if (!rootFolder || typeof rootFolder !== "string") {
-        throw new Error("Invalid config: 'rootFolder' string is missing or invalid.");
-    }
-    // Relationships are implicitly validated by parseRelationships/parseV1Relationships
-    return {
-        entities: parsedData.entities,
-        // Extract relationships from the relationshipMap keys/values if needed,
-        // or adjust UnifiedConfig. For now, returning empty array as placeholder.
-        // The relationshipMap is the primary output needed by downstream code.
-        relationships: [],
-        rootFolder: rootFolder,
-    };
-};
-exports.loadConfig = loadConfig;

package/dist/lib/guards.d.ts

@@ -1,8 +1,8 @@
-import { Entity, AuthConfig } from "./types";
+import { Entity } from "./types";
 /**
  * Represents a scope field configuration for template rendering
  */
-interface ScopeFieldConfig {
+export interface ScopeFieldConfig {
     field: string;
     contextKey: string;
     direct: boolean;
@@ -11,7 +11,7 @@ interface ScopeFieldConfig {
 /**
  * Represents a scoped entity configuration for template rendering
  */
-interface ScopedEntityConfig {
+export interface ScopedEntityConfig {
     name: string;
     routeName: string;
     repoName: string;
@@ -22,26 +22,9 @@ interface ScopedEntityConfig {
 }
 /**
  * Extracts scoped entity configurations from all entities.
- *
- * @param entities Array of all entities from the parsed .apsorc.
- * @returns Array of scoped entity configurations for entities that have scopeBy defined.
  */
 export declare function getScopedEntities(entities: Entity[]): ScopedEntityConfig[];
 /**
  * Checks if any entities have scopeBy configured.
- *
- * @param entities Array of all entities from the parsed .apsorc.
- * @returns True if at least one entity has scopeBy defined.
  */
 export declare function hasScopedEntities(entities: Entity[]): boolean;
-/**
- * Generates the guards module directory and files.
- * Creates auth.guard.ts, scope.guard.ts, guards.module.ts, and index.ts in the guards directory.
- *
- * @param rootPath The root path of the generated source (e.g., 'src').
- * @param entities All entities from the parsed .apsorc.
- * @param auth Optional auth configuration from .apsorc.
- * @returns {Promise<void>} A promise that resolves when the guard files are created.
- */
-export declare const createGuards: (rootPath: string, entities: Entity[], auth?: AuthConfig) => Promise<void>;
-export {};

package/dist/lib/guards.js

@@ -1,12 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createGuards = exports.hasScopedEntities = exports.getScopedEntities = void 0;
+exports.hasScopedEntities = exports.getScopedEntities = void 0;
 const tslib_1 = require("tslib");
-const Eta = tslib_1.__importStar(require("eta"));
-const path = tslib_1.__importStar(require("path"));
-const fs = tslib_1.__importStar(require("fs"));
-const file_system_1 = require("./utils/file-system");
-const types_1 = require("./types");
 const pluralize_1 = tslib_1.__importDefault(require("pluralize"));
 /**
  * Default scope options when not specified
@@ -18,17 +13,12 @@ const DEFAULT_SCOPE_OPTIONS = {
 };
 /**
  * Parses scopeBy configuration and returns structured scope fields.
- *
- * @param scopeBy The scope configuration - either a single field/path string or an array of them.
- * @returns An array of scope field configurations.
  */
 function parseScopeBy(scopeBy) {
     const scopes = Array.isArray(scopeBy) ? scopeBy : [scopeBy];
     return scopes.map((scope) => {
         const isDirect = !scope.includes(".");
         const field = isDirect ? scope : scope.split(".")[0];
-        // For direct fields, contextKey is the same as field
-        // For nested paths like 'task.workspaceId', we extract 'workspaceId' as contextKey
         const contextKey = isDirect ? scope : scope.split(".").pop();
         return {
             field,
@@ -38,32 +28,15 @@ function parseScopeBy(scopeBy) {
         };
     });
 }
-/**
- * Converts entity name to lowercase pluralized route name.
- * e.g., "Project" -> "projects", "DiscoverySession" -> "discoverysessions"
- *
- * @param entityName The entity name in PascalCase.
- * @returns The lowercase pluralized route name.
- */
 function toRouteName(entityName) {
     return (0, pluralize_1.default)(entityName).toLowerCase();
 }
-/**
- * Converts entity name to repository variable name.
- * e.g., "Project" -> "projectRepository", "DiscoverySession" -> "discoverySessionRepository"
- *
- * @param entityName The entity name in PascalCase.
- * @returns The camelCase repository variable name.
- */
 function toRepoName(entityName) {
     const camelCase = entityName.charAt(0).toLowerCase() + entityName.slice(1);
     return `${camelCase}Repository`;
 }
 /**
  * Extracts scoped entity configurations from all entities.
- *
- * @param entities Array of all entities from the parsed .apsorc.
- * @returns Array of scoped entity configurations for entities that have scopeBy defined.
  */
 function getScopedEntities(entities) {
     return entities
@@ -84,93 +57,8 @@ function getScopedEntities(entities) {
 exports.getScopedEntities = getScopedEntities;
 /**
  * Checks if any entities have scopeBy configured.
- *
- * @param entities Array of all entities from the parsed .apsorc.
- * @returns True if at least one entity has scopeBy defined.
  */
 function hasScopedEntities(entities) {
     return entities.some((entity) => entity.scopeBy);
 }
 exports.hasScopedEntities = hasScopedEntities;
-/**
- * Normalizes auth config by applying defaults for DB session providers
- * @param {AuthConfig | undefined} auth - The auth configuration to normalize
- * @returns {DbSessionAuthConfig | undefined} The normalized auth config or undefined
- */
-function normalizeAuthConfig(auth) {
-    if (!auth)
-        return undefined;
-    if ((0, types_1.isDbSessionAuth)(auth)) {
-        return {
-            ...types_1.DB_SESSION_AUTH_DEFAULTS,
-            ...auth,
-        };
-    }
-    // For now, only DB session providers are supported
-    // JWT providers will be added later
-    console.log(`[apso] Auth provider '${auth.provider}' is not yet supported, skipping auth guard generation`);
-    return undefined;
-}
-/**
- * Generates the guards module directory and files.
- * Creates auth.guard.ts, scope.guard.ts, guards.module.ts, and index.ts in the guards directory.
- *
- * @param rootPath The root path of the generated source (e.g., 'src').
- * @param entities All entities from the parsed .apsorc.
- * @param auth Optional auth configuration from .apsorc.
- * @returns {Promise<void>} A promise that resolves when the guard files are created.
- */
-const createGuards = async (rootPath, entities, auth) => {
-    const hasScopes = hasScopedEntities(entities);
-    const normalizedAuth = normalizeAuthConfig(auth);
-    // Only generate guards if there are scoped entities OR auth config
-    if (!hasScopes && !normalizedAuth) {
-        console.log("[apso] No scopeBy or auth configurations found, skipping guards generation");
-        return;
-    }
-    const guardsDir = path.join(rootPath, "autogen", "guards");
-    // Ensure guards directory exists
-    if (!fs.existsSync(guardsDir)) {
-        fs.mkdirSync(guardsDir, { recursive: true });
-    }
-    const scopedEntities = getScopedEntities(entities);
-    // Common template data
-    const templateData = {
-        scopedEntities,
-        authConfig: normalizedAuth,
-        generatedAt: new Date().toISOString(),
-        generatedBy: "Apso CLI",
-    };
-    // Generate auth.guard.ts if auth is configured
-    if (normalizedAuth) {
-        const authGuardPath = path.join(guardsDir, "auth.guard.ts");
-        const authGuardContent = await Eta.renderFileAsync("./guards/auth.guard.eta", templateData);
-        await (0, file_system_1.createFile)(authGuardPath, authGuardContent);
-        console.log(`[apso] Generated ${authGuardPath}`);
-    }
-    // Generate scope.guard.ts if there are scoped entities
-    if (hasScopes) {
-        const scopeGuardPath = path.join(guardsDir, "scope.guard.ts");
-        const scopeGuardContent = await Eta.renderFileAsync("./guards/scope.guard.eta", templateData);
-        await (0, file_system_1.createFile)(scopeGuardPath, scopeGuardContent);
-        console.log(`[apso] Generated ${scopeGuardPath}`);
-    }
-    // Generate guards.module.ts
-    const guardsModulePath = path.join(guardsDir, "guards.module.ts");
-    const guardsModuleContent = await Eta.renderFileAsync("./guards/guards.module.eta", templateData);
-    await (0, file_system_1.createFile)(guardsModulePath, guardsModuleContent);
-    console.log(`[apso] Generated ${guardsModulePath}`);
-    // Generate index.ts
-    const indexPath = path.join(guardsDir, "index.ts");
-    const indexContent = await Eta.renderFileAsync("./guards/index.eta", templateData);
-    await (0, file_system_1.createFile)(indexPath, indexContent);
-    console.log(`[apso] Generated ${indexPath}`);
-    // Summary
-    const parts = [];
-    if (normalizedAuth)
-        parts.push(`auth (${normalizedAuth.provider})`);
-    if (scopedEntities.length > 0)
-        parts.push(`${scopedEntities.length} scoped entities`);
-    console.log(`[apso] Generated guards for ${parts.join(" + ")}`);
-};
-exports.createGuards = createGuards;

package/dist/lib/index.d.ts

@@ -1,13 +1,5 @@
 export { Entity, RelationshipMap } from "./types";
 export { parseApsorc } from "./apsorc-parser";
-export { createEntity } from "./entity";
-export { createController } from "./controller";
-export { createService } from "./service";
-export { createModule } from "./module";
-export { createIndexAppModule } from "./index-module";
-export { createDto } from "./dto";
-export { createEnums } from "./enums";
-export { createGqlDTO } from "./gql-dto";
-export { createGuards, hasScopedEntities, getScopedEntities } from "./guards";
+export { hasScopedEntities, getScopedEntities } from "./guards";
 export { BaseGenerator, TypeScriptGenerator, createGenerator, isLanguageSupported, getSupportedLanguages, getImplementedLanguages, } from "./generators";
 export type { TargetLanguage, GeneratedFile, ValidationResult, GeneratorConfig, LanguageGenerator, } from "./types";

package/dist/lib/index.js

@@ -1,26 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getImplementedLanguages = exports.getSupportedLanguages = exports.isLanguageSupported = exports.createGenerator = exports.TypeScriptGenerator = exports.BaseGenerator = exports.getScopedEntities = exports.hasScopedEntities = exports.createGuards = exports.createGqlDTO = exports.createEnums = exports.createDto = exports.createIndexAppModule = exports.createModule = exports.createService = exports.createController = exports.createEntity = exports.parseApsorc = void 0;
+exports.getImplementedLanguages = exports.getSupportedLanguages = exports.isLanguageSupported = exports.createGenerator = exports.TypeScriptGenerator = exports.BaseGenerator = exports.getScopedEntities = exports.hasScopedEntities = exports.parseApsorc = void 0;
 var apsorc_parser_1 = require("./apsorc-parser");
 Object.defineProperty(exports, "parseApsorc", { enumerable: true, get: function () { return apsorc_parser_1.parseApsorc; } });
-var entity_1 = require("./entity");
-Object.defineProperty(exports, "createEntity", { enumerable: true, get: function () { return entity_1.createEntity; } });
-var controller_1 = require("./controller");
-Object.defineProperty(exports, "createController", { enumerable: true, get: function () { return controller_1.createController; } });
-var service_1 = require("./service");
-Object.defineProperty(exports, "createService", { enumerable: true, get: function () { return service_1.createService; } });
-var module_1 = require("./module");
-Object.defineProperty(exports, "createModule", { enumerable: true, get: function () { return module_1.createModule; } });
-var index_module_1 = require("./index-module");
-Object.defineProperty(exports, "createIndexAppModule", { enumerable: true, get: function () { return index_module_1.createIndexAppModule; } });
-var dto_1 = require("./dto");
-Object.defineProperty(exports, "createDto", { enumerable: true, get: function () { return dto_1.createDto; } });
-var enums_1 = require("./enums");
-Object.defineProperty(exports, "createEnums", { enumerable: true, get: function () { return enums_1.createEnums; } });
-var gql_dto_1 = require("./gql-dto");
-Object.defineProperty(exports, "createGqlDTO", { enumerable: true, get: function () { return gql_dto_1.createGqlDTO; } });
 var guards_1 = require("./guards");
-Object.defineProperty(exports, "createGuards", { enumerable: true, get: function () { return guards_1.createGuards; } });
 Object.defineProperty(exports, "hasScopedEntities", { enumerable: true, get: function () { return guards_1.hasScopedEntities; } });
 Object.defineProperty(exports, "getScopedEntities", { enumerable: true, get: function () { return guards_1.getScopedEntities; } });
 // Generator exports

package/dist/lib/migrate/entity-generator.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Sandbox Entity Generator Types
+ *
+ * Provides the input type for the migration sandbox.
+ */
+import { Entity } from "../types/entity";
+import { RelationshipMap } from "../types/relationship";
+/**
+ * Subset of ParsedApsorc needed for migration sandbox operations.
+ */
+export interface EntityGeneratorInput {
+    entities: Entity[];
+    relationshipMap: RelationshipMap;
+}

package/dist/lib/migrate/entity-generator.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Sandbox Entity Generator Types
+ *
+ * Provides the input type for the migration sandbox.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/migrate/sandbox.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Migration Sandbox
+ *
+ * The core migration testing engine. Uses PGlite (in-process Postgres) to:
+ * 1. Establish a baseline schema from the previous snapshot
+ * 2. Compute the diff against the current schema
+ * 3. Generate and test migration SQL locally
+ *
+ * This validates migrations before anything touches a remote database.
+ */
+import { EntityGeneratorInput } from "./entity-generator";
+/**
+ * Result of a migration sandbox run.
+ */
+export interface MigrationResult {
+    /** Whether the migration was needed (schema changed) */
+    needed: boolean;
+    /** Whether the migration executed without errors */
+    success: boolean;
+    /** Generated SQL statements (up direction) */
+    upSql: string[];
+    /** Generated SQL statements (down direction) */
+    downSql: string[];
+    /** Error message if migration failed */
+    error?: string;
+}
+/**
+ * Run the migration sandbox: detect changes, generate SQL, test execution.
+ *
+ * Uses PGlite's singleton pattern: all DataSources within a single
+ * runMigrationSandbox call share the same in-process Postgres instance.
+ * We reset the singleton at the start of each run for isolation.
+ */
+export declare function runMigrationSandbox(current: EntityGeneratorInput, projectDir?: string): Promise<MigrationResult>;
+/**
+ * Apply a successful migration: update the snapshot to current state.
+ */
+export declare function applyMigration(current: EntityGeneratorInput, projectDir?: string): void;
+/**
+ * Reset the sandbox: remove snapshot and PGlite data.
+ */
+export declare function resetSandbox(projectDir?: string): void;