@arkstack/contract 0.9.0 → 0.10.0

package/dist/global.d.ts

@@ -1,7 +1,7 @@
-import { ArkstackRouterAwareCore } from './index'
+import { Arkstack } from '.'
 
 declare global {
-  function app (): ArkstackRouterAwareCore<never, never>
+  function app (): Arkstack<never, never>
   var arkctx: {
     runtime: 'CLI' | 'HTTP' | 'Worker'
     command?: string

package/dist/index.d.ts

@@ -1,8 +1,4 @@
 /// <reference path="./global.d.ts" />
-//#region src/core.d.ts
-type PromiseOrValue<T> = T | Promise<T>;
-type ENV = 'development' | 'production' | 'stagging' | 'testing';
-//#endregion
 //#region src/http.d.ts
 interface ArkstackMiddlewareConfig<TMiddleware> {
   global: TMiddleware[];
@@ -37,10 +33,25 @@ interface ArkstackRouterContract<TApp, TRoutes = unknown> {
   bind(app: TApp): PromiseOrValue<unknown>;
   list(options?: ArkstackRouteListOptions, app?: TApp): PromiseOrValue<TRoutes>;
 }
-interface ArkstackRouterAwareCore<TApp, TRoutes = unknown> {
-  getAppInstance(): TApp;
-  getRouter(): ArkstackRouterContract<TApp, TRoutes>;
+//#endregion
+//#region src/core.d.ts
+type PromiseOrValue<T> = T | Promise<T>;
+type ENV = 'development' | 'production' | 'stagging' | 'testing';
+declare abstract class Arkstack<TApp, TRoutes = unknown, THandler = unknown> {
+  private static appRootDir;
+  protected app: TApp;
+  protected driver: ArkstackKitDriver<TApp, THandler>;
+  abstract getAppInstance(): TApp;
+  abstract getRouter(): ArkstackRouterContract<TApp, TRoutes>;
+  abstract boot(port: number, dontStart?: boolean): Promise<void>;
+  abstract getDriver(): ArkstackKitDriver<TApp, TRoutes>;
+  startup(defaultPort?: number, dontStart?: boolean): Promise<void>;
+  static rootDir(): string;
+  rootDir(): string;
+  static getRootDir(): string;
+  setRootDir(dir: string): void;
+  static setRootDir(dir: string): void;
 }
 //#endregion
-export { ArkstackKitContract, ArkstackKitDriver, ArkstackMiddlewareConfig, ArkstackRouteListOptions, ArkstackRouterAwareCore, ArkstackRouterContract, ENV, PromiseOrValue };
+export { Arkstack, ArkstackKitContract, ArkstackKitDriver, ArkstackMiddlewareConfig, ArkstackRouteListOptions, ArkstackRouterContract, ENV, PromiseOrValue };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,3 +1,66 @@
+//#region src/core.ts
+var Arkstack = class Arkstack {
+	static appRootDir = process.cwd();
+	app;
+	driver;
+	/**
+	* 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 dontStart Set to true to skip server startup
+	*/
+	async startup(defaultPort = 3e3, dontStart) {
+		const { bootWithDetectedPort } = await import("@arkstack/common");
+		await bootWithDetectedPort(async (port) => {
+			await this.boot(port, dontStart);
+		}, Number(process.env.APP_PORT ?? defaultPort), this);
+	}
+	/**
+	* Get the current app root directory
+	* 
+	* @alias getRootDir()
+	* @returns
+	*/
+	static rootDir() {
+		return this.appRootDir;
+	}
+	/**
+	* Get the current app root directory
+	* 
+	* @alias getRootDir()
+	* @returns
+	*/
+	rootDir() {
+		return Arkstack.appRootDir;
+	}
+	/**
+	* Get the current app root directory
+	* 
+	* @returns
+	*/
+	static getRootDir() {
+		return this.appRootDir;
+	}
+	/**
+	* Set the current app root directory
+	* 
+	* @param dir   The prefered app root directory
+	* @returns
+	*/
+	setRootDir(dir) {
+		Arkstack.appRootDir = dir;
+	}
+	/**
+	* Set the current app root directory
+	* 
+	* @param dir   The prefered app root directory
+	* @returns
+	*/
+	static setRootDir(dir) {
+		this.appRootDir = dir;
+	}
+};
+//#endregion
 //#region src/kits.ts
 /**
 * The ArkstackKitDriver class defines the contract for a driver 
@@ -12,6 +75,6 @@ var ArkstackKitDriver = class {
 */
 var ArkstackKitContract = class {};
 //#endregion
-export { ArkstackKitContract, ArkstackKitDriver };
+export { Arkstack, ArkstackKitContract, ArkstackKitDriver };
 
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/kits.ts"],"sourcesContent":["import { ArkstackMiddlewareConfig } from './http'\nimport { PromiseOrValue } from './core'\n\n/**\n * The ArkstackKitDriver class defines the contract for a driver \n * that can be used with the ArkstackKitContract. \n */\nexport abstract class ArkstackKitDriver<TApp, TMiddleware> {\n    abstract readonly name: string;\n    abstract createApp (): TApp;\n    abstract mountPublicAssets (app: TApp, publicPath: string): PromiseOrValue<void>;\n    abstract bindRouter (app: TApp): PromiseOrValue<void>;\n    abstract applyMiddleware (app: TApp, middleware: ArkstackMiddlewareConfig<TMiddleware>): PromiseOrValue<void>;\n    abstract applyMiddleware (app: TApp, middleware: TMiddleware): PromiseOrValue<void>;\n    registerErrorHandler (_app: TApp): PromiseOrValue<void> {\n        return\n    }\n    abstract start (app: TApp, port: number): PromiseOrValue<void>;\n}\n\n/**\n * The ArkstackKitContract class defines the contract for an \n * application that uses the ArkstackKitDriver.\n */\nexport abstract class ArkstackKitContract<TApp, TMiddleware> {\n    abstract app: TApp;\n    abstract driver: ArkstackKitDriver<TApp, TMiddleware>;\n    abstract middleware: ArkstackMiddlewareConfig<TMiddleware>;\n    abstract boot (port: number): Promise<void>;\n    abstract shutdown (): Promise<void>;\n}"],"mappings":";;;;;AAOA,IAAsB,oBAAtB,MAA2D;CAOvD,qBAAsB,MAAkC;;;;;;AAU5D,IAAsB,sBAAtB,MAA6D"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/core.ts","../src/kits.ts"],"sourcesContent":["import { ArkstackKitDriver } from './kits'\nimport { ArkstackRouterContract } from './routing'\n\nexport type PromiseOrValue<T> = T | Promise<T>;\n\nexport type ENV = 'development' | 'production' | 'stagging' | 'testing'\n\nexport abstract class Arkstack<TApp, TRoutes = unknown, THandler = unknown> {\n    private static appRootDir: string = process.cwd()\n    protected app!: TApp\n    protected driver!: ArkstackKitDriver<TApp, THandler>\n\n    abstract getAppInstance (): TApp;\n    abstract getRouter (): ArkstackRouterContract<TApp, TRoutes>;\n    /**\n     * Boots the application by mounting public assets, binding the \n     * router, applying middleware, and starting the server.\n     * \n     * @param port      The numeric port to run the server on\n     * @param dontStart Set to true to skip server startup\n     */\n    abstract boot (port: number, dontStart?: boolean): Promise<void>\n\n    /**\n     * Gets the ArkstackKitDriver instance used by the application.\n     * \n     * @returns \n     */\n    abstract getDriver (): ArkstackKitDriver<TApp, TRoutes>\n\n    /**\n     * Boostrap the app and start up the server\n     * \n     * @param defaultPort start the server with this port if none is APP_PORT env variable is not set\n     * @param dontStart Set to true to skip server startup\n     */\n    async startup (defaultPort: number = 3000, dontStart?: boolean) {\n        const { bootWithDetectedPort } = await import('@arkstack/common')\n        await bootWithDetectedPort(async (port) => {\n            await this.boot(port, dontStart)\n        }, Number(process.env.APP_PORT ?? defaultPort), this)\n    }\n\n    /**\n     * Get the current app root directory\n     * \n     * @alias getRootDir()\n     * @returns\n     */\n    static rootDir (): string {\n        return this.appRootDir\n    }\n\n    /**\n     * Get the current app root directory\n     * \n     * @alias getRootDir()\n     * @returns\n     */\n    rootDir (): string {\n        return Arkstack.appRootDir\n    }\n\n    /**\n     * Get the current app root directory\n     * \n     * @returns\n     */\n    static getRootDir (): string {\n        return this.appRootDir\n    }\n\n    /**\n     * Set the current app root directory\n     * \n     * @param dir   The prefered app root directory\n     * @returns\n     */\n    setRootDir (dir: string): void {\n        Arkstack.appRootDir = dir\n    }\n\n    /**\n     * Set the current app root directory\n     * \n     * @param dir   The prefered app root directory\n     * @returns\n     */\n    static setRootDir (dir: string): void {\n        this.appRootDir = dir\n    }\n}","import { ArkstackMiddlewareConfig } from './http'\nimport { PromiseOrValue } from './core'\n\n/**\n * The ArkstackKitDriver class defines the contract for a driver \n * that can be used with the ArkstackKitContract. \n */\nexport abstract class ArkstackKitDriver<TApp, TMiddleware> {\n    abstract readonly name: string;\n    abstract createApp (): TApp;\n    abstract mountPublicAssets (app: TApp, publicPath: string): PromiseOrValue<void>;\n    abstract bindRouter (app: TApp): PromiseOrValue<void>;\n    abstract applyMiddleware (app: TApp, middleware: ArkstackMiddlewareConfig<TMiddleware>): PromiseOrValue<void>;\n    abstract applyMiddleware (app: TApp, middleware: TMiddleware): PromiseOrValue<void>;\n    registerErrorHandler (_app: TApp): PromiseOrValue<void> {\n        return\n    }\n    abstract start (app: TApp, port: number): PromiseOrValue<void>;\n}\n\n/**\n * The ArkstackKitContract class defines the contract for an \n * application that uses the ArkstackKitDriver.\n */\nexport abstract class ArkstackKitContract<TApp, TMiddleware> {\n    abstract app: TApp;\n    abstract driver: ArkstackKitDriver<TApp, TMiddleware>;\n    abstract middleware: ArkstackMiddlewareConfig<TMiddleware>;\n    abstract boot (port: number): Promise<void>;\n    abstract shutdown (): Promise<void>;\n}"],"mappings":";AAOA,IAAsB,WAAtB,MAAsB,SAAsD;CACxE,OAAe,aAAqB,QAAQ,KAAK;CACjD;CACA;;;;;;;CA0BA,MAAM,QAAS,cAAsB,KAAM,WAAqB;EAC5D,MAAM,EAAE,yBAAyB,MAAM,OAAO;EAC9C,MAAM,qBAAqB,OAAO,SAAS;GACvC,MAAM,KAAK,KAAK,MAAM,UAAU;KACjC,OAAO,QAAQ,IAAI,YAAY,YAAY,EAAE,KAAK;;;;;;;;CASzD,OAAO,UAAmB;EACtB,OAAO,KAAK;;;;;;;;CAShB,UAAmB;EACf,OAAO,SAAS;;;;;;;CAQpB,OAAO,aAAsB;EACzB,OAAO,KAAK;;;;;;;;CAShB,WAAY,KAAmB;EAC3B,SAAS,aAAa;;;;;;;;CAS1B,OAAO,WAAY,KAAmB;EAClC,KAAK,aAAa;;;;;;;;;AClF1B,IAAsB,oBAAtB,MAA2D;CAOvD,qBAAsB,MAAkC;;;;;;AAU5D,IAAsB,sBAAtB,MAA6D"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/contract",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "type": "module",
   "description": "Contract module for Arkstack, providing shared interfaces and type contracts used across the framework.",
   "homepage": "https://arkstack.toneflix.net",