@ambiten/core 1.0.0

package/dist/lib-core/ambitenSchema.d.ts

@@ -0,0 +1,126 @@
+import type { Collection, OptionalUnlessRequiredId } from 'mongodb';
+import type { SchemaDefinition, Document, Relationship, GCConfig } from '../types';
+import type { AmbitenMiddlewareOperation, AmbitenMiddlewareContext, AmbitenMiddlewareHandler } from '../types';
+/**
+ * The AmbitenSchema class allows you to define a schema for MongoDB documents.
+ * It supports:
+ * - schema definition
+ * - custom validation
+ * - indexes
+ * - relationships
+ * - virtual fields
+ * - context-aware middleware
+ * - garbage collection metadata
+ */
+export declare class AmbitenSchema<T extends Document> {
+    private schemaDefinition;
+    private indexes;
+    private virtuals;
+    private validators;
+    private relationships;
+    private gcConfig?;
+    private middleware;
+    /**
+     * Creates an instance of AmbitenSchema.
+     * @param schemaDefinition - The schema definition for the document.
+     */
+    constructor(schemaDefinition: SchemaDefinition<T>);
+    /**
+     * Retrieves the schema definition.
+     */
+    getSchema(): SchemaDefinition<T>;
+    /**
+     * Re-registers the schema definition.
+     */
+    registerSchema(schemaDefinition: SchemaDefinition<T>): void;
+    /**
+     * Adds a custom validator for a specific field.
+     */
+    validator(field: string, fn: (value: any, doc?: OptionalUnlessRequiredId<T>) => boolean | Promise<boolean>): void;
+    /**
+     * Validates a document synchronously.
+     * Throws if an async validator is encountered.
+     */
+    validate(doc: OptionalUnlessRequiredId<T>): void;
+    /**
+     * Validates a document asynchronously.
+     */
+    validateAsync(doc: OptionalUnlessRequiredId<T>): Promise<void>;
+    /**
+     * Adds an index to the schema.
+     */
+    index(fields: any, options?: any): void;
+    /**
+     * Applies all defined indexes to a MongoDB collection.
+     */
+    applyIndexes(collection: Collection<any>): Promise<void>;
+    /**
+     * Adds a relationship to the schema.
+     */
+    addRelationship(ref: string, localField: keyof T): void;
+    /**
+     * Retrieves all relationships defined in the schema.
+     */
+    getRelationships(): Relationship[];
+    /**
+     * Adds a virtual field to the schema.
+     */
+    virtual(name: string, getter: (doc: T) => any): void;
+    /**
+     * Applies all virtual fields to a document.
+     */
+    applyVirtuals(doc: T): void;
+    /**
+     * Adds a pre-middleware handler for a specific operation.
+     */
+    pre(operation: AmbitenMiddlewareOperation, fn: AmbitenMiddlewareHandler<T>): this;
+    /**
+     * Adds a post-middleware handler for a specific operation.
+     */
+    post(operation: AmbitenMiddlewareOperation, fn: AmbitenMiddlewareHandler<T>): this;
+    /**
+     * Returns all pre-middleware for an operation.
+     */
+    getPreHooks(operation: AmbitenMiddlewareOperation): AmbitenMiddlewareHandler<T>[];
+    /**
+     * Returns all post-middleware for an operation.
+     */
+    getPostHooks(operation: AmbitenMiddlewareOperation): AmbitenMiddlewareHandler<T>[];
+    /**
+     * Backward-compatible hook reader.
+     * Defaults to pre hooks to avoid breaking older callers that expect getHooks(action).
+     */
+    getHooks(operation: AmbitenMiddlewareOperation, phase?: 'pre' | 'post'): AmbitenMiddlewareHandler<T>[];
+    /**
+     * Executes pre-middleware for an operation.
+     */
+    executePre(operation: AmbitenMiddlewareOperation, ctx: AmbitenMiddlewareContext<T>): Promise<void>;
+    /**
+     * Executes post-middleware for an operation.
+     */
+    executePost(operation: AmbitenMiddlewareOperation, ctx: AmbitenMiddlewareContext<T>): Promise<void>;
+    /**
+     * Executes middleware for a given phase and operation.
+     */
+    executeMiddleware(phase: 'pre' | 'post', operation: AmbitenMiddlewareOperation, ctx: AmbitenMiddlewareContext<T>): Promise<void>;
+    /**
+     * Backward-compatible alias.
+     * If older callers use triggerMiddleware(action, data), they should be upgraded
+     * to pass explicit phase + operation + context.
+     */
+    triggerMiddleware(phase: 'pre' | 'post', operation: AmbitenMiddlewareOperation, ctx: AmbitenMiddlewareContext<T>): Promise<void>;
+    /**
+     * Sets garbage collection configuration.
+     */
+    setGCConfig(config: GCConfig): this;
+    /**
+     * Gets garbage collection configuration.
+     */
+    getGCConfig(): GCConfig | undefined;
+}
+export declare class Schema<T extends Document = Document> extends AmbitenSchema<T> {
+    constructor(schemaDefinition: SchemaDefinition<T>);
+    create(data: OptionalUnlessRequiredId<T>): Promise<T>;
+    static create<T extends Document = Document>(schemaDefinition: SchemaDefinition<T>): Schema<T>;
+}
+//# sourceMappingURL=ambitenSchema.d.ts.map

package/dist/lib-core/ambitenSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ambitenSchema.d.ts","sourceRoot":"","sources":["../../src/lib-core/ambitenSchema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,wBAAwB,EAEzB,MAAM,SAAS,CAAC;AAEjB,OAAO,KAAK,EACV,gBAAgB,EAChB,QAAQ,EACR,YAAY,EACZ,QAAQ,EACT,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EACV,0BAA0B,EAC1B,wBAAwB,EACxB,wBAAwB,EACzB,MAAM,UAAU,CAAC;AAOlB;;;;;;;;;;GAUG;AACH,qBAAa,aAAa,CAAC,CAAC,SAAS,QAAQ;IAC3C,OAAO,CAAC,gBAAgB,CAAsB;IAC9C,OAAO,CAAC,OAAO,CAAa;IAC5B,OAAO,CAAC,QAAQ,CAA0C;IAC1D,OAAO,CAAC,UAAU,CAEX;IACP,OAAO,CAAC,aAAa,CAAsB;IAC3C,OAAO,CAAC,QAAQ,CAAC,CAAW;IAE5B,OAAO,CAAC,UAAU,CAGhB;IAEF;;;OAGG;gBACS,gBAAgB,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAIjD;;OAEG;IACH,SAAS,IAAI,gBAAgB,CAAC,CAAC,CAAC;IAIhC;;OAEG;IACH,cAAc,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI;IAK3D;;OAEG;IACH,SAAS,CACP,KAAK,EAAE,MAAM,EACb,EAAE,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GAChF,IAAI;IAIP;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAAG,IAAI;IAiBhD;;OAEG;IACG,aAAa,CAAC,GAAG,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAWpE;;OAEG;IACH,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,IAAI;IAIvC;;OAEG;IACG,YAAY,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAM9D;;OAEG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,GAAG,IAAI;IAIvD;;OAEG;IACH,gBAAgB,IAAI,YAAY,EAAE;IAIlC;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,GAAG,GAAG,IAAI;IAIpD;;OAEG;IACH,aAAa,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI;IAS3B;;OAEG;IACH,GAAG,CACD,SAAS,EAAE,0BAA0B,EACrC,EAAE,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAC9B,IAAI;IAQP;;OAEG;IACH,IAAI,CACF,SAAS,EAAE,0BAA0B,EACrC,EAAE,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAC9B,IAAI;IAQP;;OAEG;IACH,WAAW,CACT,SAAS,EAAE,0BAA0B,GACpC,wBAAwB,CAAC,CAAC,CAAC,EAAE;IAIhC;;OAEG;IACH,YAAY,CACV,SAAS,EAAE,0BAA0B,GACpC,wBAAwB,CAAC,CAAC,CAAC,EAAE;IAIhC;;;OAGG;IACH,QAAQ,CACN,SAAS,EAAE,0BAA0B,EACrC,KAAK,GAAE,KAAK,GAAG,MAAc,GAC5B,wBAAwB,CAAC,CAAC,CAAC,EAAE;IAMhC;;OAEG;IACG,UAAU,CACd,SAAS,EAAE,0BAA0B,EACrC,GAAG,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IAOhB;;OAEG;IACG,WAAW,CACf,SAAS,EAAE,0BAA0B,EACrC,GAAG,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IAOhB;;OAEG;IACG,iBAAiB,CACrB,KAAK,EAAE,KAAK,GAAG,MAAM,EACrB,SAAS,EAAE,0BAA0B,EACrC,GAAG,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IAYhB;;;;OAIG;IACG,iBAAiB,CACrB,KAAK,EAAE,KAAK,GAAG,MAAM,EACrB,SAAS,EAAE,0BAA0B,EACrC,GAAG,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI;IAKnC;;OAEG;IACH,WAAW,IAAI,QAAQ,GAAG,SAAS;CAGpC;AAED,qBAAa,MAAM,CAAC,CAAC,SAAS,QAAQ,GAAG,QAAQ,CAAE,SAAQ,aAAa,CAAC,CAAC,CAAC;gBAC7D,gBAAgB,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAK3C,MAAM,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IA0B3D,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,QAAQ,GAAG,QAAQ,EACzC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC,CAAC,GACpC,MAAM,CAAC,CAAC,CAAC;CAGb"}

package/dist/lib-core/ambitenSchema.js

@@ -0,0 +1,247 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schema = exports.AmbitenSchema = void 0;
+/**
+ * The AmbitenSchema class allows you to define a schema for MongoDB documents.
+ * It supports:
+ * - schema definition
+ * - custom validation
+ * - indexes
+ * - relationships
+ * - virtual fields
+ * - context-aware middleware
+ * - garbage collection metadata
+ */
+class AmbitenSchema {
+    schemaDefinition;
+    indexes = [];
+    virtuals = {};
+    validators = {};
+    relationships = [];
+    gcConfig;
+    middleware = {
+        pre: {},
+        post: {},
+    };
+    /**
+     * Creates an instance of AmbitenSchema.
+     * @param schemaDefinition - The schema definition for the document.
+     */
+    constructor(schemaDefinition) {
+        this.schemaDefinition = schemaDefinition;
+    }
+    /**
+     * Retrieves the schema definition.
+     */
+    getSchema() {
+        return this.schemaDefinition;
+    }
+    /**
+     * Re-registers the schema definition.
+     */
+    registerSchema(schemaDefinition) {
+        this.schemaDefinition = schemaDefinition;
+        console.info('Schema registered:', this.schemaDefinition);
+    }
+    /**
+     * Adds a custom validator for a specific field.
+     */
+    validator(field, fn) {
+        this.validators[field] = fn;
+    }
+    /**
+     * Validates a document synchronously.
+     * Throws if an async validator is encountered.
+     */
+    validate(doc) {
+        for (const [field, validate] of Object.entries(this.validators)) {
+            const result = validate(doc[field], doc);
+            if (result instanceof Promise) {
+                throw new Error(`Validator for field "${field}" is async. Use validateAsync() instead.`);
+            }
+            if (!result) {
+                console.log(`[error]: Validation failed for field: ${field}`);
+                throw new Error(`Validation failed for field: ${field}`);
+            }
+        }
+    }
+    /**
+     * Validates a document asynchronously.
+     */
+    async validateAsync(doc) {
+        for (const [field, validate] of Object.entries(this.validators)) {
+            const isValid = await validate(doc[field], doc);
+            if (!isValid) {
+                console.log(`[error]: Validation failed for field: ${field}`);
+                throw new Error(`Validation failed for field: ${field}`);
+            }
+        }
+    }
+    /**
+     * Adds an index to the schema.
+     */
+    index(fields, options) {
+        this.indexes.push({ fields, options });
+    }
+    /**
+     * Applies all defined indexes to a MongoDB collection.
+     */
+    async applyIndexes(collection) {
+        for (const { fields, options } of this.indexes) {
+            await collection.createIndex(fields, options);
+        }
+    }
+    /**
+     * Adds a relationship to the schema.
+     */
+    addRelationship(ref, localField) {
+        this.relationships.push({ ref, localField });
+    }
+    /**
+     * Retrieves all relationships defined in the schema.
+     */
+    getRelationships() {
+        return this.relationships;
+    }
+    /**
+     * Adds a virtual field to the schema.
+     */
+    virtual(name, getter) {
+        this.virtuals[name] = getter;
+    }
+    /**
+     * Applies all virtual fields to a document.
+     */
+    applyVirtuals(doc) {
+        for (const [key, getter] of Object.entries(this.virtuals)) {
+            Object.defineProperty(doc, key, {
+                get: () => getter(doc),
+                enumerable: true,
+            });
+        }
+    }
+    /**
+     * Adds a pre-middleware handler for a specific operation.
+     */
+    pre(operation, fn) {
+        if (!this.middleware.pre[operation]) {
+            this.middleware.pre[operation] = [];
+        }
+        this.middleware.pre[operation].push(fn);
+        return this;
+    }
+    /**
+     * Adds a post-middleware handler for a specific operation.
+     */
+    post(operation, fn) {
+        if (!this.middleware.post[operation]) {
+            this.middleware.post[operation] = [];
+        }
+        this.middleware.post[operation].push(fn);
+        return this;
+    }
+    /**
+     * Returns all pre-middleware for an operation.
+     */
+    getPreHooks(operation) {
+        return this.middleware.pre[operation] || [];
+    }
+    /**
+     * Returns all post-middleware for an operation.
+     */
+    getPostHooks(operation) {
+        return this.middleware.post[operation] || [];
+    }
+    /**
+     * Backward-compatible hook reader.
+     * Defaults to pre hooks to avoid breaking older callers that expect getHooks(action).
+     */
+    getHooks(operation, phase = 'pre') {
+        return phase === 'pre'
+            ? this.getPreHooks(operation)
+            : this.getPostHooks(operation);
+    }
+    /**
+     * Executes pre-middleware for an operation.
+     */
+    async executePre(operation, ctx) {
+        const hooks = this.getPreHooks(operation);
+        for (const hook of hooks) {
+            await hook(ctx);
+        }
+    }
+    /**
+     * Executes post-middleware for an operation.
+     */
+    async executePost(operation, ctx) {
+        const hooks = this.getPostHooks(operation);
+        for (const hook of hooks) {
+            await hook(ctx);
+        }
+    }
+    /**
+     * Executes middleware for a given phase and operation.
+     */
+    async executeMiddleware(phase, operation, ctx) {
+        const hooks = this.getHooks(operation, phase);
+        for (const hook of hooks) {
+            try {
+                await hook(ctx);
+            }
+            catch (error) {
+                console.error(`[error]: Error in ${phase}:${operation} middleware:`, error);
+                throw error;
+            }
+        }
+    }
+    /**
+     * Backward-compatible alias.
+     * If older callers use triggerMiddleware(action, data), they should be upgraded
+     * to pass explicit phase + operation + context.
+     */
+    async triggerMiddleware(phase, operation, ctx) {
+        await this.executeMiddleware(phase, operation, ctx);
+    }
+    /**
+     * Sets garbage collection configuration.
+     */
+    setGCConfig(config) {
+        this.gcConfig = config;
+        return this;
+    }
+    /**
+     * Gets garbage collection configuration.
+     */
+    getGCConfig() {
+        return this.gcConfig;
+    }
+}
+exports.AmbitenSchema = AmbitenSchema;
+class Schema extends AmbitenSchema {
+    constructor(schemaDefinition) {
+        super(schemaDefinition);
+        this.registerSchema(schemaDefinition);
+    }
+    async create(data) {
+        await this.validateAsync(data);
+        const ctx = {
+            operation: 'create',
+            collectionName: 'schema-test',
+            doc: data,
+        };
+        await this.executePre('create', ctx);
+        const result = data;
+        this.applyVirtuals(result);
+        const postCtx = {
+            ...ctx,
+            result,
+            doc: result,
+        };
+        await this.executePost('create', postCtx);
+        return result;
+    }
+    static create(schemaDefinition) {
+        return new Schema(schemaDefinition);
+    }
+}
+exports.Schema = Schema;

package/dist/lib-core/bootstrap/ambitenBootstrap.d.ts

@@ -0,0 +1,38 @@
+import { InitMultiTenancyOptions } from '../../tanancy';
+import type { AmbitenAdapter } from '@ambiten/adapter-types';
+import type { AmbitenConfig } from '../../types';
+import { AmbitenRuntime } from '../../types/ambiten-runtime-type';
+export interface RegisterMultiTenancyOptions {
+    adapter?: AmbitenAdapter;
+    tenants?: Record<string, string>;
+    headerKey?: string;
+    initOptions?: InitMultiTenancyOptions;
+}
+export interface AmbitenBootstrapFactoryOptions {
+    config?: string | AmbitenConfig;
+    adapter?: AmbitenAdapter;
+}
+/**
+ * Factory class to create an instance of AmbitenBootstrap.
+ * This class encapsulates the logic for initializing the Ambiten application stack,
+ * including MongoDB, Multi-Tenancy, Redis, GraphQL logger etc. setup.
+ * It can be used to create a fully configured Ambiten instance
+ * with optional configuration parameters.
+ * @example
+ * const Ambiten = await AmbitenBootstrapFactory.create();
+ * const db = Ambiten.getMongoClient();
+ * await db.connect();
+ * const graphql = await Ambiten.getGraphQL();
+ * // You can now use the GraphQL instance to generate schema or start a server
+ * // or perform other GraphQL related operations
+ * graphql.generateSchema();
+ * Ambiten.getRedisClient();
+ * // or with custom config
+ * const Ambiten = await AmbitenBootstrapFactory.create(customConfig);
+ * @param {AmbitenConfig} [config] - Optional configuration object for Ambiten.
+ * @returns {Promise<AmbitenBootstrap>} - A promise that resolves to an instance of AmbitenBootstrap.
+ */
+export declare class AmbitenBootstrapFactory {
+    static create(options?: AmbitenBootstrapFactoryOptions): Promise<AmbitenRuntime>;
+}
+//# sourceMappingURL=ambitenBootstrap.d.ts.map

package/dist/lib-core/bootstrap/ambitenBootstrap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ambitenBootstrap.d.ts","sourceRoot":"","sources":["../../../src/lib-core/bootstrap/ambitenBootstrap.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAoB,uBAAuB,EAAE,MAAM,eAAe,CAAC;AAE1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,KAAK,EAAE,aAAa,EAA+C,MAAM,aAAa,CAAC;AAE9F,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAOlE,MAAM,WAAW,2BAA2B;IAC1C,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,uBAAuB,CAAC;CACvC;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;IAChC,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAkaD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,uBAAuB;WACrB,MAAM,CACjB,OAAO,GAAE,8BAAmC,GAC3C,OAAO,CAAC,cAAc,CAAC;CAK3B"}