@arkstack/contract 0.9.1 → 0.10.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/global.d.ts +2 -2
- package/dist/index.d.ts +15 -6
- package/dist/index.js +64 -17
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/global.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { Arkstack } from '.'
|
|
2
2
|
|
|
3
3
|
declare global {
|
|
4
|
-
function app ():
|
|
4
|
+
function app (): Arkstack<never, never>
|
|
5
5
|
var arkctx: {
|
|
6
6
|
runtime: 'CLI' | 'HTTP' | 'Worker'
|
|
7
7
|
command?: string
|
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,4 @@
|
|
|
1
1
|
/// <reference path="./global.d.ts" />
|
|
2
|
-
//#region src/core.d.ts
|
|
3
|
-
type PromiseOrValue<T> = T | Promise<T>;
|
|
4
|
-
type ENV = 'development' | 'production' | 'stagging' | 'testing';
|
|
5
|
-
//#endregion
|
|
6
2
|
//#region src/http.d.ts
|
|
7
3
|
interface ArkstackMiddlewareConfig<TMiddleware> {
|
|
8
4
|
global: TMiddleware[];
|
|
@@ -37,12 +33,25 @@ interface ArkstackRouterContract<TApp, TRoutes = unknown> {
|
|
|
37
33
|
bind(app: TApp): PromiseOrValue<unknown>;
|
|
38
34
|
list(options?: ArkstackRouteListOptions, app?: TApp): PromiseOrValue<TRoutes>;
|
|
39
35
|
}
|
|
40
|
-
|
|
36
|
+
//#endregion
|
|
37
|
+
//#region src/core.d.ts
|
|
38
|
+
type PromiseOrValue<T> = T | Promise<T>;
|
|
39
|
+
type ENV = 'development' | 'production' | 'stagging' | 'testing';
|
|
40
|
+
declare abstract class Arkstack<TApp, TRoutes = unknown, THandler = unknown> {
|
|
41
|
+
private static appRootDir;
|
|
42
|
+
protected app: TApp;
|
|
43
|
+
protected driver: ArkstackKitDriver<TApp, THandler>;
|
|
41
44
|
abstract getAppInstance(): TApp;
|
|
42
45
|
abstract getRouter(): ArkstackRouterContract<TApp, TRoutes>;
|
|
43
46
|
abstract boot(port: number, dontStart?: boolean): Promise<void>;
|
|
47
|
+
abstract getDriver(): ArkstackKitDriver<TApp, TRoutes>;
|
|
44
48
|
startup(defaultPort?: number, dontStart?: boolean): Promise<void>;
|
|
49
|
+
static rootDir(): string;
|
|
50
|
+
rootDir(): string;
|
|
51
|
+
static getRootDir(): string;
|
|
52
|
+
setRootDir(dir: string): void;
|
|
53
|
+
static setRootDir(dir: string): void;
|
|
45
54
|
}
|
|
46
55
|
//#endregion
|
|
47
|
-
export { ArkstackKitContract, ArkstackKitDriver, ArkstackMiddlewareConfig, ArkstackRouteListOptions,
|
|
56
|
+
export { Arkstack, ArkstackKitContract, ArkstackKitDriver, ArkstackMiddlewareConfig, ArkstackRouteListOptions, ArkstackRouterContract, ENV, PromiseOrValue };
|
|
48
57
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.js
CHANGED
|
@@ -1,19 +1,8 @@
|
|
|
1
|
-
//#region src/
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
var ArkstackKitDriver = class {
|
|
7
|
-
registerErrorHandler(_app) {}
|
|
8
|
-
};
|
|
9
|
-
/**
|
|
10
|
-
* The ArkstackKitContract class defines the contract for an
|
|
11
|
-
* application that uses the ArkstackKitDriver.
|
|
12
|
-
*/
|
|
13
|
-
var ArkstackKitContract = class {};
|
|
14
|
-
//#endregion
|
|
15
|
-
//#region src/routing.ts
|
|
16
|
-
var ArkstackRouterAwareCore = class {
|
|
1
|
+
//#region src/core.ts
|
|
2
|
+
var Arkstack = class Arkstack {
|
|
3
|
+
static appRootDir = process.cwd();
|
|
4
|
+
app;
|
|
5
|
+
driver;
|
|
17
6
|
/**
|
|
18
7
|
* Boostrap the app and start up the server
|
|
19
8
|
*
|
|
@@ -26,8 +15,66 @@ var ArkstackRouterAwareCore = class {
|
|
|
26
15
|
await this.boot(port, dontStart);
|
|
27
16
|
}, Number(process.env.APP_PORT ?? defaultPort), this);
|
|
28
17
|
}
|
|
18
|
+
/**
|
|
19
|
+
* Get the current app root directory
|
|
20
|
+
*
|
|
21
|
+
* @alias getRootDir()
|
|
22
|
+
* @returns
|
|
23
|
+
*/
|
|
24
|
+
static rootDir() {
|
|
25
|
+
return this.appRootDir;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Get the current app root directory
|
|
29
|
+
*
|
|
30
|
+
* @alias getRootDir()
|
|
31
|
+
* @returns
|
|
32
|
+
*/
|
|
33
|
+
rootDir() {
|
|
34
|
+
return Arkstack.appRootDir;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Get the current app root directory
|
|
38
|
+
*
|
|
39
|
+
* @returns
|
|
40
|
+
*/
|
|
41
|
+
static getRootDir() {
|
|
42
|
+
return this.appRootDir;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Set the current app root directory
|
|
46
|
+
*
|
|
47
|
+
* @param dir The prefered app root directory
|
|
48
|
+
* @returns
|
|
49
|
+
*/
|
|
50
|
+
setRootDir(dir) {
|
|
51
|
+
Arkstack.appRootDir = dir;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Set the current app root directory
|
|
55
|
+
*
|
|
56
|
+
* @param dir The prefered app root directory
|
|
57
|
+
* @returns
|
|
58
|
+
*/
|
|
59
|
+
static setRootDir(dir) {
|
|
60
|
+
this.appRootDir = dir;
|
|
61
|
+
}
|
|
62
|
+
};
|
|
63
|
+
//#endregion
|
|
64
|
+
//#region src/kits.ts
|
|
65
|
+
/**
|
|
66
|
+
* The ArkstackKitDriver class defines the contract for a driver
|
|
67
|
+
* that can be used with the ArkstackKitContract.
|
|
68
|
+
*/
|
|
69
|
+
var ArkstackKitDriver = class {
|
|
70
|
+
registerErrorHandler(_app) {}
|
|
29
71
|
};
|
|
72
|
+
/**
|
|
73
|
+
* The ArkstackKitContract class defines the contract for an
|
|
74
|
+
* application that uses the ArkstackKitDriver.
|
|
75
|
+
*/
|
|
76
|
+
var ArkstackKitContract = class {};
|
|
30
77
|
//#endregion
|
|
31
|
-
export { ArkstackKitContract, ArkstackKitDriver
|
|
78
|
+
export { Arkstack, ArkstackKitContract, ArkstackKitDriver };
|
|
32
79
|
|
|
33
80
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":[],"sources":["../src/
|
|
1
|
+
{"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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@arkstack/contract",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.10.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Contract module for Arkstack, providing shared interfaces and type contracts used across the framework.",
|
|
6
6
|
"homepage": "https://arkstack.toneflix.net",
|