@arkstack/contract 0.12.6 → 0.12.7

package/dist/index.d.ts

@@ -7,6 +7,10 @@ interface ArkstackMiddlewareConfig<TMiddleware> {
 }
 //#endregion
 //#region src/kits.d.ts
+/**
+ * The ArkstackKitDriver class defines the contract for a driver
+ * that can be used with the ArkstackKitContract.
+ */
 declare abstract class ArkstackKitDriver<TApp, TMiddleware> {
   abstract readonly name: string;
   abstract createApp(): TApp;
@@ -17,6 +21,10 @@ declare abstract class ArkstackKitDriver<TApp, TMiddleware> {
   registerErrorHandler(_app: TApp): PromiseOrValue<void>;
   abstract start(app: TApp, port: number): PromiseOrValue<void>;
 }
+/**
+ * The ArkstackKitContract class defines the contract for an
+ * application that uses the ArkstackKitDriver.
+ */
 declare abstract class ArkstackKitContract<TApp, TMiddleware> {
   abstract app: TApp;
   abstract driver: ArkstackKitDriver<TApp, TMiddleware>;
@@ -44,16 +52,76 @@ declare abstract class Arkstack<TApp, TRoutes = unknown, THandler = unknown> {
   protected app: TApp;
   protected driver: ArkstackKitDriver<TApp, THandler>;
   abstract getRouter(): ArkstackRouterContract<TApp, TRoutes>;
+  /**
+   * Boots the application by mounting public assets, binding the
+   * router, applying middleware, and starting the server.
+   *
+   * @param port      The numeric port to run the server on
+   * @param defer     Set to true to skip server startup
+   */
   abstract boot(port: number, defer?: boolean): Promise<void>;
+  /**
+   * Gets the driver application instance.
+   *
+   * @returns
+   */
   getAppInstance(): TApp;
+  /**
+   * Gets the static driver application instance.
+   *
+   * @returns
+   */
   static getAppInstance<TApp = unknown>(): TApp;
+  /**
+   * Gets the ArkstackKitDriver instance used by the application.
+   *
+   * @returns
+   */
   getDriver(): ArkstackKitDriver<TApp, THandler>;
+  /**
+   * Boostrap the app and start up the server
+   *
+   * @param defaultPort   start the server with this port if none is APP_PORT env variable is not set
+   * @param defer         Set to true to skip server startup
+   */
   startup(defaultPort?: number, defer?: boolean): Promise<void>;
+  /**
+   * Shuts down the application by disconnecting from the database and exiting the process.
+   */
   shutdown(): Promise<void>;
+  /**
+   * Get the current app root directory
+   *
+   * @alias getRootDir()
+   * @returns
+   */
   static rootDir(): string;
+  /**
+   * Get the current app root directory
+   *
+   * @alias getRootDir()
+   * @returns
+   */
   rootDir(): string;
+  /**
+   * Get the current app root directory
+   *
+   * @returns
+   */
   static getRootDir(): string;
+  /**
+   * Set the current app root directory
+   *
+   * @param dir   The prefered app root directory
+   * @returns
+   */
   setRootDir(dir: string): void;
+  /**
+   * Set the current app root directory
+   *
+   * @param dir   The prefered app root directory
+   * @returns
+   */
   static setRootDir(dir: string): void;
 }
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/contract",
-  "version": "0.12.6",
+  "version": "0.12.7",
   "type": "module",
   "description": "Contract module for Arkstack, providing shared interfaces and type contracts used across the framework.",
   "homepage": "https://arkstack.toneflix.net",
@@ -28,7 +28,7 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@arkstack/foundry": "^0.12.6"
+    "@arkstack/foundry": "^0.12.7"
   },
   "scripts": {
     "build": "tsdown --config-loader unrun",