@ambiten/core 1.0.0

package/dist/cli/buildInteractiveConfig.js

@@ -0,0 +1,198 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildInteractiveConfig = buildInteractiveConfig;
+const tslib_1 = require("tslib");
+const prompts_1 = tslib_1.__importDefault(require("prompts"));
+function normalizeProjectName(name) {
+    return name.trim().replace(/\s+/g, '-').toLowerCase();
+}
+function wasProvided(value) {
+    return typeof value !== 'undefined';
+}
+function printScaffoldSummary(config) {
+    const lines = [
+        '',
+        'Scaffold summary:',
+        `  Project: ${config.projectName}`,
+        `  MongoDB URI: ${config.connection?.uri ?? '(none)'}`,
+        `  GraphQL: ${config.graphql?.enabled ? 'enabled' : 'disabled'}`,
+        `  Multi-tenancy: ${config.multiTenant?.enabled ? 'enabled' : 'disabled'}`,
+        `  Logger: ${config.logger?.enabled ? 'enabled' : 'disabled'}`,
+        `  Redis Cache: ${config.features?.useRedisCache ? 'enabled' : 'disabled'}`,
+        `  Garbage Collector: ${config.advanced?.garbageCollector?.enabled ? 'enabled' : 'disabled'}`,
+        `  Auto-install: ${config.advanced?.autoInstall ? 'enabled' : 'disabled'}`,
+        '',
+    ];
+    console.log(lines.join('\n'));
+}
+async function buildInteractiveConfig(projectNameArg, options) {
+    const response = await (0, prompts_1.default)([
+        {
+            type: projectNameArg ? null : 'text',
+            name: 'projectName',
+            message: 'Project name',
+            initial: 'Ambiten-app',
+            validate: (value) => value.trim().length > 0 ? true : 'Project name is required',
+        },
+        {
+            type: wasProvided(options.uri) ? null : 'text',
+            name: 'uri',
+            message: 'MongoDB URI',
+            initial: (_prev, values) => {
+                const rawName = projectNameArg || values.projectName || 'Ambiten-app';
+                const projectName = normalizeProjectName(rawName);
+                return `mongodb://localhost:27017/${projectName}`;
+            },
+            validate: (value) => value.trim().length > 0 ? true : 'MongoDB URI is required',
+        },
+        {
+            type: wasProvided(options.withGraphql) ? null : 'toggle',
+            name: 'withGraphql',
+            message: 'Include GraphQL starter support?',
+            initial: false,
+            active: 'yes',
+            inactive: 'no',
+        },
+        {
+            type: wasProvided(options.multiTenant) ? null : 'toggle',
+            name: 'multiTenant',
+            message: 'Enable multi-tenancy?',
+            initial: false,
+            active: 'yes',
+            inactive: 'no',
+        },
+        {
+            type: wasProvided(options.logger) ? null : 'toggle',
+            name: 'logger',
+            message: 'Enable logger configuration?',
+            initial: true,
+            active: 'yes',
+            inactive: 'no',
+        },
+        {
+            type: wasProvided(options.withRedis) ? null : 'toggle',
+            name: 'withRedis',
+            message: 'Enable Redis cache defaults?',
+            initial: false,
+            active: 'yes',
+            inactive: 'no',
+        },
+        {
+            type: wasProvided(options.withGarbageCollector) ? null : 'toggle',
+            name: 'withGarbageCollector',
+            message: 'Enable garbage collector starter files?',
+            initial: false,
+            active: 'yes',
+            inactive: 'no',
+        },
+        {
+            type: wasProvided(options.install) ? null : 'toggle',
+            name: 'install',
+            message: 'Install dependencies after scaffold?',
+            initial: false,
+            active: 'yes',
+            inactive: 'no',
+        },
+    ], {
+        onCancel: () => {
+            throw new Error('CLI initialization cancelled by user.');
+        },
+    });
+    const projectName = normalizeProjectName(projectNameArg || response.projectName || 'Ambiten-app');
+    const uri = options.uri ||
+        response.uri ||
+        `mongodb://localhost:27017/${projectName}`;
+    const useGraphql = wasProvided(options.withGraphql)
+        ? Boolean(options.withGraphql)
+        : Boolean(response.withGraphql);
+    const useMultiTenant = wasProvided(options.multiTenant)
+        ? Boolean(options.multiTenant)
+        : Boolean(response.multiTenant);
+    const useLogger = wasProvided(options.logger)
+        ? Boolean(options.logger)
+        : Boolean(response.logger);
+    const useRedis = wasProvided(options.withRedis)
+        ? Boolean(options.withRedis)
+        : Boolean(response.withRedis);
+    const useGarbageCollector = wasProvided(options.withGarbageCollector)
+        ? Boolean(options.withGarbageCollector)
+        : Boolean(response.withGarbageCollector);
+    const autoInstall = wasProvided(options.install)
+        ? Boolean(options.install)
+        : Boolean(response.install);
+    const config = {
+        projectName,
+        connection: {
+            uri,
+            options: {
+                dbName: projectName,
+            },
+        },
+        features: {
+            useRedisCache: useRedis,
+            redisUri: useRedis ? 'redis://localhost:6379' : '',
+        },
+        advanced: {
+            autoInstall,
+            garbageCollector: {
+                enabled: useGarbageCollector,
+            },
+        },
+    };
+    if (useGraphql) {
+        config.graphql = {
+            enabled: true,
+            subscriptions: false,
+            playground: true,
+            schemaOutputPath: './src/graphql/schema.gql',
+        };
+    }
+    if (useLogger) {
+        config.logger = {
+            enabled: true,
+            level: 'info',
+            colorize: true,
+            json: false,
+            transports: [
+                {
+                    type: 'console',
+                    options: {},
+                },
+            ],
+        };
+    }
+    if (useMultiTenant) {
+        config.multiTenant = {
+            enabled: true,
+            headerKey: 'x-tenant-id',
+            tenants: {
+                tenant1: `mongodb://localhost:27017/${projectName}_tenant1`,
+            },
+            initOptions: {
+                lazy: true,
+            },
+        };
+    }
+    if (options.rbac) {
+        config.features = {
+            ...config.features,
+        };
+    }
+    printScaffoldSummary(config);
+    const confirmResponse = await (0, prompts_1.default)({
+        type: 'toggle',
+        name: 'proceed',
+        message: 'Proceed with project generation?',
+        initial: true,
+        active: 'yes',
+        inactive: 'no',
+    }, {
+        onCancel: () => {
+            throw new Error('Project generation cancelled by user.');
+        },
+    });
+    if (!confirmResponse.proceed) {
+        throw new Error('Project generation cancelled by user.');
+    }
+    return config;
+}

package/dist/cli/index.d.ts

@@ -0,0 +1,5 @@
+export * from './ambiten-core-cli';
+export * from './buildInteractiveConfig';
+export * from './prompt';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/cli/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,0BAA0B,CAAC;AACzC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC"}

package/dist/cli/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./ambiten-core-cli"), exports);
+tslib_1.__exportStar(require("./buildInteractiveConfig"), exports);
+tslib_1.__exportStar(require("./prompt"), exports);
+tslib_1.__exportStar(require("./types"), exports);

package/dist/cli/prompt.d.ts

@@ -0,0 +1,10 @@
+export interface ConfirmPromptOptions {
+    defaultValue?: boolean;
+}
+export interface InputPromptOptions {
+    defaultValue?: string;
+}
+export declare function askInput(question: string, options?: InputPromptOptions): Promise<string>;
+export declare function askConfirm(question: string, options?: ConfirmPromptOptions): Promise<boolean>;
+export declare function normalizeProjectName(name: string): string;
+//# sourceMappingURL=prompt.d.ts.map

package/dist/cli/prompt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.d.ts","sourceRoot":"","sources":["../../src/cli/prompt.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,oBAAoB;IACnC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AASD,wBAAsB,QAAQ,CAC5B,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,MAAM,CAAC,CAajB;AAED,wBAAsB,UAAU,CAC9B,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,OAAO,CAAC,CAuBlB;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEzD"}

package/dist/cli/prompt.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.askInput = askInput;
+exports.askConfirm = askConfirm;
+exports.normalizeProjectName = normalizeProjectName;
+const tslib_1 = require("tslib");
+const node_readline_1 = tslib_1.__importDefault(require("node:readline"));
+function createInterface() {
+    return node_readline_1.default.createInterface({
+        input: process.stdin,
+        output: process.stdout,
+    });
+}
+async function askInput(question, options = {}) {
+    const rl = createInterface();
+    const suffix = options.defaultValue
+        ? ` (${options.defaultValue})`
+        : '';
+    return new Promise((resolve) => {
+        rl.question(`${question}${suffix}: `, (answer) => {
+            rl.close();
+            const resolved = answer.trim() || options.defaultValue || '';
+            resolve(resolved);
+        });
+    });
+}
+async function askConfirm(question, options = {}) {
+    const rl = createInterface();
+    const defaultLabel = typeof options.defaultValue === 'boolean'
+        ? options.defaultValue
+            ? 'Y/n'
+            : 'y/N'
+        : 'y/N';
+    return new Promise((resolve) => {
+        rl.question(`${question} (${defaultLabel}): `, (answer) => {
+            rl.close();
+            const value = answer.trim().toLowerCase();
+            if (!value && typeof options.defaultValue === 'boolean') {
+                resolve(options.defaultValue);
+                return;
+            }
+            resolve(value === 'y' || value === 'yes');
+        });
+    });
+}
+function normalizeProjectName(name) {
+    return name.trim().replace(/\s+/g, '-').toLowerCase();
+}

package/dist/cli/types.d.ts

@@ -0,0 +1,11 @@
+export interface BootstrapCliOptions {
+    withGraphql?: boolean;
+    withRedis?: boolean;
+    logger?: boolean;
+    multiTenant?: boolean;
+    uri?: string;
+    rbac?: boolean;
+    withGarbageCollector?: boolean;
+    install?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/cli/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/cli/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB"}

package/dist/cli/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/config/ambiten.config.schema.json

@@ -0,0 +1,278 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Ambiten Configuration Schema",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "projectName": {
+            "type": "string",
+            "description": "The name of the project."
+        },
+        "connection": {
+            "type": "object",
+            "description": "MongoDB connection configuration used when no external provider is supplied at runtime.",
+            "properties": {
+                "uri": {
+                    "type": "string",
+                    "description": "MongoDB connection URI."
+                },
+                "options": {
+                    "type": "object",
+                    "description": "Additional MongoDB client options."
+                }
+            },
+            "required": [
+                "uri"
+            ],
+            "additionalProperties": true
+        },
+        "multiTenant": {
+            "type": "object",
+            "description": "Multi-tenant runtime configuration.",
+            "properties": {
+                "enabled": {
+                    "type": "boolean",
+                    "default": false
+                },
+                "headerKey": {
+                    "type": "string",
+                    "default": "x-tenant-id",
+                    "description": "Header used to resolve the tenant ID."
+                },
+                "tenants": {
+                    "type": "object",
+                    "description": "Mapping of tenant IDs to MongoDB URIs.",
+                    "additionalProperties": {
+                        "type": "string"
+                    }
+                },
+                "initOptions": {
+                    "type": "object",
+                    "description": "Initialization options for multi-tenancy.",
+                    "properties": {
+                        "lazy": {
+                            "type": "boolean",
+                            "default": false
+                        },
+                        "retryAttempts": {
+                            "type": "integer",
+                            "default": 3
+                        },
+                        "config": {
+                            "type": "object"
+                        }
+                    },
+                    "additionalProperties": true
+                }
+            },
+            "additionalProperties": false
+        },
+        "logger": {
+            "type": "object",
+            "description": "Logger configuration.",
+            "properties": {
+                "level": {
+                    "type": "string",
+                    "enum": [
+                        "debug",
+                        "info",
+                        "warn",
+                        "error",
+                        "fatal",
+                        "trace"
+                    ]
+                },
+                "colorize": {
+                    "type": "boolean"
+                },
+                "json": {
+                    "type": "boolean"
+                },
+                "transportConfigs": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "type": {
+                                "type": "string",
+                                "enum": [
+                                    "console",
+                                    "file",
+                                    "rotating-file"
+                                ]
+                            },
+                            "options": {
+                                "type": "object"
+                            }
+                        },
+                        "additionalProperties": false
+                    }
+                },
+                "formatOptions": {
+                    "type": "object"
+                },
+                "excludedSources": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "circuitBreaker": {
+                    "type": "object",
+                    "properties": {
+                        "enabled": {
+                            "type": "boolean",
+                            "default": true
+                        },
+                        "retryAttempts": {
+                            "type": "integer",
+                            "default": 5
+                        }
+                    },
+                    "additionalProperties": false
+                },
+                "enableMetrics": {
+                    "type": "object",
+                    "properties": {
+                        "enabled": {
+                            "type": "boolean",
+                            "default": false
+                        },
+                        "logInterval": {
+                            "type": "integer",
+                            "minimum": 1000,
+                            "default": 60000
+                        }
+                    },
+                    "additionalProperties": false,
+                    "default": {
+                        "enabled": false,
+                        "logInterval": 60000
+                    }
+                },
+                "compress": {
+                    "type": "object",
+                    "properties": {
+                        "enabled": {
+                            "type": "boolean",
+                            "default": false
+                        }
+                    },
+                    "additionalProperties": false,
+                    "default": {
+                        "enabled": false
+                    }
+                }
+            },
+            "additionalProperties": true
+        },
+        "graphql": {
+            "type": "object",
+            "description": "Optional GraphQL auto-generation/bootstrap feature. Useful for playgrounds, prototyping, and generated GraphQL flows.",
+            "properties": {
+                "enabled": {
+                    "type": "boolean",
+                    "default": false
+                },
+                "subscriptions": {
+                    "type": "boolean",
+                    "default": false
+                },
+                "playground": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "schemaOutputPath": {
+                    "type": "string",
+                    "default": "./src/graphql/schema.gql"
+                }
+            },
+            "additionalProperties": false
+        },
+        "features": {
+            "type": "object",
+            "description": "Optional feature paths and integrations.",
+            "properties": {
+                "models": {
+                    "type": "string",
+                    "default": "./src/models"
+                },
+                "schemas": {
+                    "type": "string",
+                    "default": "./src/schemas"
+                },
+                "typeDefs": {
+                    "type": "string",
+                    "default": "./src/graphql/typeDefs"
+                },
+                "resolvers": {
+                    "type": "string",
+                    "default": "./src/graphql/resolvers"
+                },
+                "useRedisCache": {
+                    "type": "boolean",
+                    "default": false
+                },
+                "redisUri": {
+                    "type": "string",
+                    "default": ""
+                }
+            },
+            "additionalProperties": false
+        },
+        "advanced": {
+            "type": "object",
+            "description": "Advanced runtime configuration.",
+            "properties": {
+                "autoInstall": {
+                    "type": "boolean",
+                    "default": false
+                },
+                "circuitBreaker": {
+                    "type": "object",
+                    "properties": {
+                        "enabled": {
+                            "type": "boolean",
+                            "default": true
+                        },
+                        "retryAttempts": {
+                            "type": "integer",
+                            "default": 5
+                        }
+                    },
+                    "additionalProperties": false
+                },
+                "garbageCollector": {
+                    "type": "object",
+                    "description": "Garbage collector configuration.",
+                    "properties": {
+                        "enabled": {
+                            "type": "boolean",
+                            "default": false
+                        },
+                        "retentionPeriod": {
+                            "type": "integer",
+                            "minimum": 1,
+                            "default": 30
+                        },
+                        "logResults": {
+                            "type": "boolean",
+                            "default": true
+                        }
+                    },
+                    "additionalProperties": false
+                },
+                "gcCron": {
+                    "type": "string",
+                    "default": "0 * * * *"
+                }
+            },
+            "additionalProperties": false
+        },
+        "configVersion": {
+            "type": "string",
+            "default": "1.0.0",
+            "description": "Version of the Ambiten config format."
+        }
+    }
+}

package/dist/config/index.d.ts

@@ -0,0 +1,2 @@
+export * from './loadAmbitenConfig';
+//# sourceMappingURL=index.d.ts.map

package/dist/config/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/config/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA"}

package/dist/config/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./loadAmbitenConfig"), exports);

package/dist/config/loadAmbitenConfig.d.ts

@@ -0,0 +1,3 @@
+import type { AmbitenConfig } from '../types';
+export declare function loadAmbitenConfig(configPath?: string): Promise<AmbitenConfig>;
+//# sourceMappingURL=loadAmbitenConfig.d.ts.map

package/dist/config/loadAmbitenConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadAmbitenConfig.d.ts","sourceRoot":"","sources":["../../src/config/loadAmbitenConfig.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AA0F9C,wBAAsB,iBAAiB,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAmEnF"}