@arkstack/contract 0.8.0 → 0.9.1

package/dist/index.d.ts

@@ -1,22 +1,16 @@
 /// <reference path="./global.d.ts" />
-//#region src/index.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[];
   before: TMiddleware[];
   after: TMiddleware[];
 }
-interface ArkstackRouteListOptions {
-  path?: string;
-}
-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/kits.d.ts
 declare abstract class ArkstackKitDriver<TApp, TMiddleware> {
   abstract readonly name: string;
   abstract createApp(): TApp;
@@ -35,5 +29,20 @@ declare abstract class ArkstackKitContract<TApp, TMiddleware> {
   abstract shutdown(): Promise<void>;
 }
 //#endregion
-export { ArkstackKitContract, ArkstackKitDriver, ArkstackMiddlewareConfig, ArkstackRouteListOptions, ArkstackRouterAwareCore, ArkstackRouterContract, PromiseOrValue };
+//#region src/routing.d.ts
+interface ArkstackRouteListOptions {
+  path?: string;
+}
+interface ArkstackRouterContract<TApp, TRoutes = unknown> {
+  bind(app: TApp): PromiseOrValue<unknown>;
+  list(options?: ArkstackRouteListOptions, app?: TApp): PromiseOrValue<TRoutes>;
+}
+declare abstract class ArkstackRouterAwareCore<TApp, TRoutes = unknown> {
+  abstract getAppInstance(): TApp;
+  abstract getRouter(): ArkstackRouterContract<TApp, TRoutes>;
+  abstract boot(port: number, dontStart?: boolean): Promise<void>;
+  startup(defaultPort?: number, dontStart?: boolean): Promise<void>;
+}
+//#endregion
+export { ArkstackKitContract, ArkstackKitDriver, ArkstackMiddlewareConfig, ArkstackRouteListOptions, ArkstackRouterAwareCore, ArkstackRouterContract, ENV, PromiseOrValue };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,4 +1,4 @@
-//#region src/index.ts
+//#region src/kits.ts
 /**
 * The ArkstackKitDriver class defines the contract for a driver 
 * that can be used with the ArkstackKitContract. 
@@ -12,6 +12,22 @@ var ArkstackKitDriver = class {
 */
 var ArkstackKitContract = class {};
 //#endregion
-export { ArkstackKitContract, ArkstackKitDriver };
+//#region src/routing.ts
+var ArkstackRouterAwareCore = class {
+	/**
+	* 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);
+	}
+};
+//#endregion
+export { ArkstackKitContract, ArkstackKitDriver, ArkstackRouterAwareCore };
 
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["export type PromiseOrValue<T> = T | Promise<T>;\n\nexport interface ArkstackMiddlewareConfig<TMiddleware> {\n  global: TMiddleware[];\n  before: TMiddleware[];\n  after: TMiddleware[];\n}\n\nexport interface ArkstackRouteListOptions {\n  path?: string;\n}\n\nexport interface ArkstackRouterContract<TApp, TRoutes = unknown> {\n  bind (app: TApp): PromiseOrValue<unknown>;\n  list (options?: ArkstackRouteListOptions, app?: TApp): PromiseOrValue<TRoutes>;\n}\n\nexport interface ArkstackRouterAwareCore<TApp, TRoutes = unknown> {\n  getAppInstance (): TApp;\n  getRouter (): ArkstackRouterContract<TApp, TRoutes>;\n}\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}\n"],"mappings":";;;;;AA0BA,IAAsB,oBAAtB,MAA2D;CAOzD,qBAAsB,MAAkC;;;;;;AAU1D,IAAsB,sBAAtB,MAA6D"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/kits.ts","../src/routing.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}","import { PromiseOrValue } from './core'\n\nexport interface ArkstackRouteListOptions {\n    path?: string;\n}\n\nexport interface ArkstackRouterContract<TApp, TRoutes = unknown> {\n    bind (app: TApp): PromiseOrValue<unknown>;\n    list (options?: ArkstackRouteListOptions, app?: TApp): PromiseOrValue<TRoutes>;\n}\n\nexport abstract class ArkstackRouterAwareCore<TApp, TRoutes = unknown> {\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     * 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"],"mappings":";;;;;AAOA,IAAsB,oBAAtB,MAA2D;CAOvD,qBAAsB,MAAkC;;;;;;AAU5D,IAAsB,sBAAtB,MAA6D;;;ACb7D,IAAsB,0BAAtB,MAAuE;;;;;;;CAkBnE,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"}

package/package.json

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