@open-core/framework 0.2.9 → 0.3.1

package/dist/adapters/database/resource.adapter.js

@@ -1,68 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResourceDatabaseAdapter = void 0;
-const database_contract_1 = require("../../runtime/server/database/database.contract");
-function getDbResourceName() {
-    const name = GetConvar('opencore_db_resource', '').trim();
-    if (!name) {
-        throw new Error('[OpenCore] opencore_db_resource is required when opencore_db_adapter=resource');
-    }
-    return name;
-}
-function getDbExports() {
-    const resourceName = getDbResourceName();
-    const db = exports[resourceName];
-    if (!db) {
-        throw new Error(`[OpenCore] Database resource '${resourceName}' is not available. Start it before this resource.`);
-    }
-    return db;
-}
-function normalizeQueries(queries) {
-    if (queries.length === 0)
-        return [];
-    const first = queries[0];
-    if (typeof first === 'string') {
-        return queries;
-    }
-    if (Array.isArray(first)) {
-        return queries.map(([query, values]) => ({
-            query,
-            values,
-        }));
-    }
-    return queries;
-}
-class ResourceDatabaseAdapter extends database_contract_1.DatabaseContract {
-    constructor() {
-        super();
-        this.db = getDbExports();
-    }
-    async query(sql, params) {
-        const result = await this.db.query_async(sql, params);
-        return result !== null && result !== void 0 ? result : [];
-    }
-    async single(sql, params) {
-        const result = await this.db.single_async(sql, params);
-        return result !== null && result !== void 0 ? result : null;
-    }
-    async scalar(sql, params) {
-        const result = await this.db.scalar_async(sql, params);
-        return result !== null && result !== void 0 ? result : null;
-    }
-    async execute(sql, params) {
-        return await this.db.execute_async(sql, params);
-    }
-    async insert(sql, params) {
-        return await this.db.insert_async(sql, params);
-    }
-    async transaction(queries, sharedParams) {
-        if (queries.length === 0)
-            return true;
-        const normalizedQueries = normalizeQueries(queries);
-        if (sharedParams) {
-            return await this.db.transaction_async(normalizedQueries, sharedParams);
-        }
-        return await this.db.transaction_async(normalizedQueries);
-    }
-}
-exports.ResourceDatabaseAdapter = ResourceDatabaseAdapter;

package/dist/kernel/shared/appearance/index.d.ts

@@ -1 +0,0 @@
-export * from './appearance.interface';

package/dist/runtime/index.d.ts

@@ -1,2 +0,0 @@
-export * as Client from './client';
-export * as Server from './server';

package/dist/runtime/index.js

@@ -1,39 +0,0 @@
-"use strict";
-// Runtime - System execution
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Server = exports.Client = void 0;
-exports.Client = __importStar(require("./client"));
-exports.Server = __importStar(require("./server"));

package/dist/runtime/server/bootstrap.validation.d.ts

@@ -1,12 +0,0 @@
-export type BootstrapValidator = () => string[] | Promise<string[]>;
-/**
- * Register a bootstrap validator.
- *  This is only used for cases of custom validators or resources that require validation,
- *  like Driver resources.
- *
- * @param name - The name of the validator.
- * @param validator - The validator function.
- */
-export declare function registerBootstrapValidator(name: string, validator: BootstrapValidator): void;
-export declare function runBootstrapValidatorsOrThrow(): Promise<void>;
-export declare function registerDefaultBootstrapValidators(): void;

package/dist/runtime/server/bootstrap.validation.js

@@ -1,104 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerBootstrapValidator = registerBootstrapValidator;
-exports.runBootstrapValidatorsOrThrow = runBootstrapValidatorsOrThrow;
-exports.registerDefaultBootstrapValidators = registerDefaultBootstrapValidators;
-const zod_1 = require("zod");
-const logger_1 = require("../../kernel/shared/logger");
-const validators = new Map();
-/**
- * Register a bootstrap validator.
- *  This is only used for cases of custom validators or resources that require validation,
- *  like Driver resources.
- *
- * @param name - The name of the validator.
- * @param validator - The validator function.
- */
-function registerBootstrapValidator(name, validator) {
-    if (validators.has(name)) {
-        throw new Error(`[OpenCore] Bootstrap validator '${name}' is already registered`);
-    }
-    validators.set(name, validator);
-}
-async function runBootstrapValidatorsOrThrow() {
-    const allErrors = [];
-    for (const [name, validator] of validators.entries()) {
-        const errors = await validator();
-        for (const err of errors)
-            allErrors.push(`[${name}] ${err}`);
-    }
-    if (allErrors.length === 0)
-        return;
-    const message = ['Invalid configuration detected during bootstrap:', ...allErrors].join('\n');
-    logger_1.loggers.bootstrap.fatal(message);
-    throw new Error(`[OpenCore] CRITICAL: ${message}`);
-}
-function getBooleanConvar(name, defaultValue = false) {
-    const raw = GetConvar(name, defaultValue ? 'true' : 'false')
-        .toLowerCase()
-        .trim();
-    return raw === 'true' || raw === '1' || raw === 'yes' || raw === 'y';
-}
-function getOptionalStringConvar(name) {
-    const raw = GetConvar(name, '').trim();
-    return raw.length > 0 ? raw : undefined;
-}
-function zodIssuesToLines(prefix, error) {
-    return error.issues.map((i) => {
-        const path = i.path.length ? `${prefix}.${i.path.join('.')}` : prefix;
-        return `${path}: ${i.message}`;
-    });
-}
-const PersistenceSchema = zod_1.z
-    .object({
-    enabled: zod_1.z.boolean(),
-    adapter: zod_1.z.string().min(1).optional(),
-    resourceName: zod_1.z.string().min(1).optional(),
-})
-    .superRefine((val, ctx) => {
-    if (!val.enabled)
-        return;
-    if (!val.adapter) {
-        ctx.addIssue({
-            code: 'custom',
-            path: ['adapter'],
-            message: 'Required when opencore_persistence_enabled=true (set opencore_db_adapter)',
-        });
-        return;
-    }
-    if (val.adapter === 'resource' && !val.resourceName) {
-        ctx.addIssue({
-            code: 'custom',
-            path: ['resourceName'],
-            message: 'Required when opencore_db_adapter=resource (set opencore_db_resource)',
-        });
-    }
-});
-function validatePersistence() {
-    const enabled = getBooleanConvar('opencore_persistence_enabled', false);
-    if (!enabled)
-        return [];
-    const adapter = getOptionalStringConvar('opencore_db_adapter');
-    const resourceName = getOptionalStringConvar('opencore_db_resource');
-    const parsed = PersistenceSchema.safeParse({ enabled, adapter, resourceName });
-    if (!parsed.success)
-        return zodIssuesToLines('persistence', parsed.error);
-    if (adapter === 'resource') {
-        if (!resourceName)
-            return ['persistence.resourceName: Missing opencore_db_resource'];
-        const db = exports[resourceName];
-        if (!db) {
-            return [
-                `persistence.resource: Database resource '${resourceName}' is not available. Start it before this resource.`,
-            ];
-        }
-    }
-    return [];
-}
-let defaultsRegistered = false;
-function registerDefaultBootstrapValidators() {
-    if (defaultsRegistered)
-        return;
-    registerBootstrapValidator('persistence', validatePersistence);
-    defaultsRegistered = true;
-}

package/dist/runtime/server/contracts/auth-provider.contract.d.ts

@@ -1,58 +0,0 @@
-import { Server } from '../../..';
-import { LinkedID } from '../services/types/linked-id';
-export interface AuthCredentials {
-    /** Standard username/password auth */
-    username?: string;
-    password?: string;
-    /** License-based auto-auth */
-    license?: string;
-    /** Discord OAuth */
-    discordToken?: string;
-    /** Custom auth data */
-    [key: string]: unknown;
-}
-export interface AuthResult {
-    success: boolean;
-    accountID?: LinkedID;
-    error?: string;
-    /** Optional: newly created account flag */
-    isNewAccount?: boolean;
-}
-/**
- * **Authentication**
- *
- * Defines the Authentication flow (login/register/logout).
- * This is separate from Authorization (roles/permissions) handled by PrincipalProviderContract.
- *
- * @example
- *
- * class MyAuthProvider implements AuthProviderContract {
- *   async authenticate(player, credentials) {
- *     const user = await db.users.findByLicense(credentials.license)
- *     if (!user) return { success: false, error: 'User not found' }
- *     player.linkAccount(user.id)
- *     return { success: true, accountID: user.id }
- *   }
- * }
- *  */
-export declare abstract class AuthProviderContract {
-    /**
-     * Authenticates a player and links their account.
-     * Called during the login flow.
-     */
-    abstract authenticate(player: Server.Player, credentials: AuthCredentials): Promise<AuthResult>;
-    /**
-     * Registers a new account for the player.
-     * Can optionally auto-authenticate after registration.
-     */
-    abstract register(player: Server.Player, credentials: AuthCredentials): Promise<AuthResult>;
-    /**
-     * Validates an existing session/token.
-     * Useful for reconnections or persistent sessions.
-     */
-    abstract validateSession(player: Server.Player): Promise<AuthResult>;
-    /**
-     * Clears the player's authenticated session.
-     */
-    abstract logout(player: Server.Player): Promise<void>;
-}

package/dist/runtime/server/contracts/auth-provider.contract.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AuthProviderContract = void 0;
-/**
- * **Authentication**
- *
- * Defines the Authentication flow (login/register/logout).
- * This is separate from Authorization (roles/permissions) handled by PrincipalProviderContract.
- *
- * @example
- *
- * class MyAuthProvider implements AuthProviderContract {
- *   async authenticate(player, credentials) {
- *     const user = await db.users.findByLicense(credentials.license)
- *     if (!user) return { success: false, error: 'User not found' }
- *     player.linkAccount(user.id)
- *     return { success: true, accountID: user.id }
- *   }
- * }
- *  */
-class AuthProviderContract {
-}
-exports.AuthProviderContract = AuthProviderContract;

package/dist/runtime/server/contracts/repository/index.d.ts

@@ -1,57 +0,0 @@
-/**
- * Repository Pattern Module
- *
- * Provides an abstract Repository base class for implementing
- * the Repository Pattern with type-safe CRUD operations.
- *
- * @example
- * ```typescript
- * import { Repository, FindOptions } from '@open-core/framework/server'
- * import { DatabaseContract } from '@open-core/framework/server'
- *
- * interface User {
- *   id: number
- *   name: string
- *   email: string
- *   active: boolean
- * }
- *
- * class UserRepository extends Repository<User> {
- *   protected tableName = 'users'
- *
- *   constructor(db: DatabaseContract) {
- *     super(db)
- *   }
- *
- *   protected toEntity(row: any): User {
- *     return {
- *       id: row.id,
- *       name: row.name,
- *       email: row.email,
- *       active: Boolean(row.active)
- *     }
- *   }
- *
- *   protected toRow(entity: User): Record<string, any> {
- *     return {
- *       id: entity.id,
- *       name: entity.name,
- *       email: entity.email,
- *       active: entity.active ? 1 : 0
- *     }
- *   }
- *
- *   // Custom methods
- *   async findByEmail(email: string): Promise<User | null> {
- *     return this.findOne({ email })
- *   }
- *
- *   async findActive(options?: FindOptions<User>): Promise<User[]> {
- *     const { data } = await this.findMany({ active: true }, options)
- *     return data
- *   }
- * }
- * ```
- */
-export { Repository } from './repository.contract';
-export type { FindManyResult, FindOptions, OrderDirection, WhereCondition, } from './repository.types';

package/dist/runtime/server/contracts/repository/index.js

@@ -1,61 +0,0 @@
-"use strict";
-/**
- * Repository Pattern Module
- *
- * Provides an abstract Repository base class for implementing
- * the Repository Pattern with type-safe CRUD operations.
- *
- * @example
- * ```typescript
- * import { Repository, FindOptions } from '@open-core/framework/server'
- * import { DatabaseContract } from '@open-core/framework/server'
- *
- * interface User {
- *   id: number
- *   name: string
- *   email: string
- *   active: boolean
- * }
- *
- * class UserRepository extends Repository<User> {
- *   protected tableName = 'users'
- *
- *   constructor(db: DatabaseContract) {
- *     super(db)
- *   }
- *
- *   protected toEntity(row: any): User {
- *     return {
- *       id: row.id,
- *       name: row.name,
- *       email: row.email,
- *       active: Boolean(row.active)
- *     }
- *   }
- *
- *   protected toRow(entity: User): Record<string, any> {
- *     return {
- *       id: entity.id,
- *       name: entity.name,
- *       email: entity.email,
- *       active: entity.active ? 1 : 0
- *     }
- *   }
- *
- *   // Custom methods
- *   async findByEmail(email: string): Promise<User | null> {
- *     return this.findOne({ email })
- *   }
- *
- *   async findActive(options?: FindOptions<User>): Promise<User[]> {
- *     const { data } = await this.findMany({ active: true }, options)
- *     return data
- *   }
- * }
- * ```
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Repository = void 0;
-// Contract
-var repository_contract_1 = require("./repository.contract");
-Object.defineProperty(exports, "Repository", { enumerable: true, get: function () { return repository_contract_1.Repository; } });

package/dist/runtime/server/contracts/repository/repository.contract.d.ts

@@ -1,224 +0,0 @@
-/**
- * Repository Contract
- *
- * Abstract base class for implementing the Repository Pattern.
- * Provides common CRUD operations with support for pagination, ordering, and field selection.
- *
- * @example
- * ```typescript
- * interface User {
- *   id: number
- *   name: string
- *   email: string
- *   createdAt: Date
- * }
- *
- * class UserRepository extends Repository<User> {
- *   protected tableName = 'users'
- *
- *   constructor(db: DatabaseContract) {
- *     super(db)
- *   }
- *
- *   protected toEntity(row: any): User {
- *     return {
- *       id: row.id,
- *       name: row.name,
- *       email: row.email,
- *       createdAt: new Date(row.created_at)
- *     }
- *   }
- *
- *   protected toRow(entity: User): Record<string, any> {
- *     return {
- *       id: entity.id,
- *       name: entity.name,
- *       email: entity.email,
- *       created_at: entity.createdAt.toISOString()
- *     }
- *   }
- * }
- *
- * // Usage
- * const userRepo = new UserRepository(db)
- * const user = await userRepo.findById(1)
- * const users = await userRepo.findMany({ active: true }, { limit: 10, orderBy: { createdAt: 'DESC' } })
- * ```
- */
-import { DatabaseContract } from '../../database/database.contract';
-import { FindManyResult, FindOptions, OrderDirection, WhereCondition } from './repository.types';
-/**
- * Abstract Repository base class
- *
- * Extend this class to create type-safe repositories for your entities.
- *
- * @typeParam TEntity - The entity type this repository manages
- * @typeParam TId - The type of the primary key (defaults to number)
- */
-export declare abstract class Repository<TEntity, TId = number> {
-    protected readonly db: DatabaseContract;
-    /**
-     * The database table name for this entity
-     */
-    protected abstract tableName: string;
-    /**
-     * The primary key column name (defaults to 'id')
-     */
-    protected primaryKey: string;
-    /**
-     * Creates a new repository instance
-     *
-     * @param db - The database contract/service to use for queries
-     */
-    constructor(db: DatabaseContract);
-    /**
-     * Maps a database row to an entity instance
-     *
-     * @param row - Raw database row
-     * @returns The mapped entity
-     */
-    protected abstract toEntity(row: any): TEntity;
-    /**
-     * Maps an entity to a database row
-     *
-     * @param entity - The entity to map
-     * @returns Object suitable for database operations
-     */
-    protected abstract toRow(entity: TEntity): Record<string, any>;
-    /**
-     * Find an entity by its primary key
-     *
-     * @param id - The primary key value
-     * @returns The entity or null if not found
-     *
-     * @example
-     * ```typescript
-     * const user = await userRepo.findById(1)
-     * if (user) {
-     *   console.log(user.name)
-     * }
-     * ```
-     */
-    findById(id: TId): Promise<TEntity | null>;
-    /**
-     * Find a single entity matching the given conditions
-     *
-     * @param where - Conditions to match (equality only)
-     * @returns The first matching entity or null
-     *
-     * @example
-     * ```typescript
-     * const user = await userRepo.findOne({ email: 'john@example.com' })
-     * ```
-     */
-    findOne(where: WhereCondition<TEntity>): Promise<TEntity | null>;
-    /**
-     * Find multiple entities with optional filtering, pagination, and ordering
-     *
-     * @param where - Optional conditions to filter by
-     * @param options - Query options (select, orderBy, limit, offset)
-     * @returns Result containing data array and optional total count
-     *
-     * @example
-     * ```typescript
-     * // Simple query
-     * const { data: users } = await userRepo.findMany({ active: true })
-     *
-     * // With pagination and ordering
-     * const result = await userRepo.findMany(
-     *   { role: 'admin' },
-     *   { limit: 10, offset: 20, orderBy: { createdAt: 'DESC' } }
-     * )
-     * console.log(`Page of ${result.data.length} admins`)
-     * ```
-     */
-    findMany(where?: WhereCondition<TEntity>, options?: FindOptions<TEntity>): Promise<FindManyResult<TEntity>>;
-    /**
-     * Count entities matching the given conditions
-     *
-     * @param where - Optional conditions to filter by
-     * @returns The count of matching entities
-     *
-     * @example
-     * ```typescript
-     * const activeCount = await userRepo.count({ active: true })
-     * ```
-     */
-    count(where?: WhereCondition<TEntity>): Promise<number>;
-    /**
-     * Save an entity (insert if new, update if exists)
-     *
-     * If the entity has a primary key value, it will be updated.
-     * Otherwise, a new record will be inserted.
-     *
-     * @param entity - The entity to save
-     * @returns The saved entity with updated ID (for inserts)
-     *
-     * @example
-     * ```typescript
-     * // Insert new user
-     * const newUser = await userRepo.save({ name: 'John', email: 'john@example.com' })
-     * console.log(newUser.id) // Generated ID
-     *
-     * // Update existing user
-     * user.name = 'John Doe'
-     * await userRepo.save(user)
-     * ```
-     */
-    save(entity: TEntity): Promise<TEntity>;
-    /**
-     * Delete an entity by its primary key
-     *
-     * @param id - The primary key of the entity to delete
-     * @returns true if deleted, false if not found
-     *
-     * @example
-     * ```typescript
-     * const deleted = await userRepo.delete(1)
-     * if (deleted) {
-     *   console.log('User deleted')
-     * }
-     * ```
-     */
-    delete(id: TId): Promise<boolean>;
-    /**
-     * Delete entities matching the given conditions
-     *
-     * @param where - Conditions to match for deletion
-     * @returns Number of deleted entities
-     *
-     * @example
-     * ```typescript
-     * const count = await userRepo.deleteWhere({ active: false })
-     * console.log(`Deleted ${count} inactive users`)
-     * ```
-     */
-    deleteWhere(where: WhereCondition<TEntity>): Promise<number>;
-    /**
-     * Update an entity by ID
-     */
-    protected update(id: TId, row: Record<string, any>): Promise<void>;
-    /**
-     * Insert a new row and return the inserted ID
-     */
-    protected insertRow(row: Record<string, any>): Promise<TId>;
-    /**
-     * Build SELECT clause from field selection
-     */
-    protected buildSelectClause(select?: (keyof TEntity)[]): string;
-    /**
-     * Build WHERE clause from conditions
-     */
-    protected buildWhereClause(where?: WhereCondition<TEntity>): {
-        clause: string;
-        params: any[];
-    };
-    /**
-     * Build ORDER BY clause from orderBy options
-     */
-    protected buildOrderClause(orderBy?: Partial<Record<keyof TEntity, OrderDirection>>): string;
-    /**
-     * Build LIMIT/OFFSET clause
-     */
-    protected buildLimitClause(limit?: number, offset?: number): string;
-}