@open-core/framework 1.0.8 → 1.0.9

package/README.md

@@ -141,6 +141,44 @@ export class ExampleNetController {
 - `@Throttle(limit, windowMs)`
 - `@RequiresState({ missing: [...] })`
 
+### Exports
+
+`@Export()` defines a public resource API. Adapters may expose both direct/local access through `getResource()` and an optional explicit async helper layer through `getRemoteResource()` / `waitForRemoteResource()`.
+
+```ts
+import { Controller, Export } from '@open-core/framework/server'
+import { IExports } from '@open-core/framework/contracts/server'
+
+@Controller()
+export class DatabaseController {
+  @Export('pingDatabase')
+  async pingDatabase() {
+    return { success: true }
+  }
+}
+
+interface DatabaseExports {
+  pingDatabase(): Promise<{ success: boolean }>
+}
+
+class ExampleConsumer {
+  constructor(private readonly exportsService: IExports) {}
+
+  async ping() {
+    const database = await this.exportsService.waitForRemoteResource<DatabaseExports>('database', {
+      exportName: 'pingDatabase',
+    })
+
+    return database.pingDatabase()
+  }
+}
+```
+
+Guidance:
+
+- `getResource()` is for local/synchronous resolution used by framework internals.
+- `waitForRemoteResource()` / `getRemoteResource()` are optional adapter utilities for explicit async resource-to-resource calls.
+
 ### Library events
 
 Use library wrappers to emit domain events and `@OnLibraryEvent()` to observe them.

package/dist/adapters/contracts/IExports.d.ts

@@ -1,4 +1,42 @@
 export declare abstract class IExports {
+    /**
+     * Registers a local export handler for the current resource.
+     *
+     * @remarks
+     * This is called by the framework during metadata processing when it discovers
+     * methods decorated with `@Export()`.
+     */
     abstract register(exportName: string, handler: (...args: unknown[]) => unknown): void;
+    /**
+     * Resolves exports for a resource using the adapter's direct/local mechanism.
+     *
+     * @remarks
+     * Framework internals rely on this method remaining synchronous and side-effect free.
+     * Adapters should return `undefined` when the resource is not directly resolvable.
+     */
     abstract getResource<T = unknown>(resourceName: string): T | undefined;
+    /**
+     * Returns an async proxy for resource exports when the adapter provides a remote helper layer.
+     *
+     * @remarks
+     * This is optional and should not change the semantics of `getResource()`.
+     * Consumers should treat methods on the returned proxy as async.
+     */
+    getRemoteResource<T = unknown>(_resourceName: string): T;
+    /**
+     * Calls a single exported method through the adapter's optional remote helper layer.
+     */
+    callRemoteExport<TResult = unknown>(_resourceName: string, _exportName: string, ..._args: unknown[]): Promise<TResult>;
+    /**
+     * Waits until a resource exposes exports compatible with the adapter's remote helper layer.
+     *
+     * @param _options.exportName Optional export name that must be present before resolving.
+     * @param _options.timeoutMs Maximum time to wait before failing.
+     * @param _options.intervalMs Polling interval used by adapters that implement polling.
+     */
+    waitForRemoteResource<T = unknown>(_resourceName: string, _options?: {
+        exportName?: string;
+        timeoutMs?: number;
+        intervalMs?: number;
+    }): Promise<T>;
 }

package/dist/adapters/contracts/IExports.js

@@ -1,2 +1,28 @@
 export class IExports {
+    /**
+     * Returns an async proxy for resource exports when the adapter provides a remote helper layer.
+     *
+     * @remarks
+     * This is optional and should not change the semantics of `getResource()`.
+     * Consumers should treat methods on the returned proxy as async.
+     */
+    getRemoteResource(_resourceName) {
+        throw new Error('[OpenCore] Remote exports are not supported by the active adapter.');
+    }
+    /**
+     * Calls a single exported method through the adapter's optional remote helper layer.
+     */
+    callRemoteExport(_resourceName, _exportName, ..._args) {
+        return Promise.reject(new Error('[OpenCore] Remote exports are not supported by the active adapter.'));
+    }
+    /**
+     * Waits until a resource exposes exports compatible with the adapter's remote helper layer.
+     *
+     * @param _options.exportName Optional export name that must be present before resolving.
+     * @param _options.timeoutMs Maximum time to wait before failing.
+     * @param _options.intervalMs Polling interval used by adapters that implement polling.
+     */
+    waitForRemoteResource(_resourceName, _options) {
+        return Promise.reject(new Error('[OpenCore] Remote exports are not supported by the active adapter.'));
+    }
 }

package/dist/adapters/node/node-exports.d.ts

@@ -7,6 +7,13 @@ export declare class NodeExports implements IExports {
     private exports;
     register(exportName: string, handler: (...args: any[]) => any): void;
     getResource(resourceName: string): any;
+    getRemoteResource<T = unknown>(_resourceName: string): T;
+    callRemoteExport<TResult = unknown>(_resourceName: string, _exportName: string, ..._args: unknown[]): Promise<TResult>;
+    waitForRemoteResource<T = unknown>(_resourceName: string, _options?: {
+        exportName?: string;
+        timeoutMs?: number;
+        intervalMs?: number;
+    }): Promise<T>;
     /**
      * Get all registered exports as an object
      */

package/dist/adapters/node/node-exports.js

@@ -23,6 +23,15 @@ let NodeExports = class NodeExports {
         throw new Error(`Cross-resource exports not supported in Node.js runtime. ` +
             `Attempted to access resource: ${resourceName}`);
     }
+    getRemoteResource(_resourceName) {
+        throw new Error('[OpenCore] Remote exports are not supported in Node.js runtime.');
+    }
+    callRemoteExport(_resourceName, _exportName, ..._args) {
+        return Promise.reject(new Error('[OpenCore] Remote exports are not supported in Node.js runtime.'));
+    }
+    waitForRemoteResource(_resourceName, _options) {
+        return Promise.reject(new Error('[OpenCore] Remote exports are not supported in Node.js runtime.'));
+    }
     /**
      * Get all registered exports as an object
      */

package/dist/runtime/server/bootstrap.js

@@ -278,13 +278,32 @@ async function tryImportAutoLoad() {
         await import('./.opencore/autoload.server.controllers');
     }
     catch (err) {
-        if (err instanceof Error && err.message.includes('Cannot find module')) {
+        if (isAutoloadModuleNotFound(err)) {
             loggers.bootstrap.warn(`[Bootstrap] No server controllers autoload file found, skipping.`);
             return;
         }
+        const message = err instanceof Error ? err.message : String(err);
+        loggers.bootstrap.error(`[Bootstrap] Failed to import server controllers autoload file.`, {
+            error: message,
+        });
         throw err;
     }
 }
+function isAutoloadModuleNotFound(err) {
+    if (!err || typeof err !== 'object') {
+        return false;
+    }
+    const error = err;
+    const message = typeof error.message === 'string' ? error.message : '';
+    const requireStack = Array.isArray(error.requireStack) ? error.requireStack : [];
+    if (error.code !== 'MODULE_NOT_FOUND' && !message.includes('Cannot find module')) {
+        return false;
+    }
+    if (message.includes('autoload.server.controllers')) {
+        return true;
+    }
+    return requireStack.some((entry) => entry.includes('autoload.server.controllers'));
+}
 /**
  * Runs session recovery to restore sessions for players already connected.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-core/framework",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "Secure, event-driven TypeScript Framework & Runtime engine for CitizenFX (Cfx).",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",