@arkstack/contract 0.12.3 → 0.12.5
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/README.md +2 -0
- package/dist/index.d.ts +1 -2
- package/dist/index.js +0 -2
- package/package.json +2 -2
- package/dist/index.js.map +0 -1
package/README.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# @arkstack/contract
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@arkstack/contract)
|
|
4
|
+
|
|
3
5
|
Contract module for Arkstack, providing shared interfaces and type contracts used across the framework.
|
|
4
6
|
|
|
5
7
|
This package defines the shared shape each framework driver must implement.
|
package/dist/index.d.ts
CHANGED
|
@@ -57,5 +57,4 @@ declare abstract class Arkstack<TApp, TRoutes = unknown, THandler = unknown> {
|
|
|
57
57
|
static setRootDir(dir: string): void;
|
|
58
58
|
}
|
|
59
59
|
//#endregion
|
|
60
|
-
export { Arkstack, ArkstackKitContract, ArkstackKitDriver, ArkstackMiddlewareConfig, ArkstackRouteListOptions, ArkstackRouterContract, ENV, PromiseOrValue, RootDirChangeListener };
|
|
61
|
-
//# sourceMappingURL=index.d.ts.map
|
|
60
|
+
export { Arkstack, ArkstackKitContract, ArkstackKitDriver, ArkstackMiddlewareConfig, ArkstackRouteListOptions, ArkstackRouterContract, ENV, PromiseOrValue, RootDirChangeListener };
|
package/dist/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@arkstack/contract",
|
|
3
|
-
"version": "0.12.
|
|
3
|
+
"version": "0.12.5",
|
|
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",
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"./package.json": "./package.json"
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@arkstack/foundry": "^0.12.
|
|
31
|
+
"@arkstack/foundry": "^0.12.5"
|
|
32
32
|
},
|
|
33
33
|
"scripts": {
|
|
34
34
|
"build": "tsdown --config-loader unrun",
|
package/dist/index.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":[],"sources":["../src/Arkstack.ts","../src/kits.ts"],"sourcesContent":["import { ArkstackKitDriver } from './kits'\nimport { ArkstackRouterContract } from './routing'\nimport { Hook } from '@arkstack/foundry'\n\nexport type PromiseOrValue<T> = T | Promise<T>;\n\nexport type ENV = 'development' | 'production' | 'stagging' | 'testing'\nexport type RootDirChangeListener = (dir: string, previousDir: string) => void\n\nexport abstract class Arkstack<TApp, TRoutes = unknown, THandler = unknown> {\n static app: unknown\n private static appRootDir: string = process.cwd()\n protected app!: TApp\n protected driver!: ArkstackKitDriver<TApp, THandler>\n\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 defer Set to true to skip server startup\n */\n abstract boot (port: number, defer?: boolean): Promise<void>\n\n /**\n * Gets the driver application instance.\n * \n * @returns \n */\n getAppInstance () {\n return this.app\n }\n\n /**\n * Gets the static driver application instance.\n * \n * @returns \n */\n static getAppInstance<TApp = unknown> (): TApp {\n return Arkstack.app as TApp\n }\n\n /**\n * Gets the ArkstackKitDriver instance used by the application.\n * \n * @returns \n */\n getDriver () {\n return this.driver\n }\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 defer Set to true to skip server startup\n */\n async startup (defaultPort: number = 3000, defer?: boolean) {\n const { bootWithDetectedPort } = await import('@arkstack/common')\n await bootWithDetectedPort<TApp, TRoutes, THandler>(async (port) => {\n await this.boot(port, defer)\n }, Number(process.env.APP_PORT ?? defaultPort), this as never, defer)\n }\n\n /**\n * Shuts down the application by disconnecting from the database and exiting the process.\n */\n async shutdown () {\n process.exit(0)\n }\n\n /**\n * Get the current app root directory\n * \n * @alias getRootDir()\n * @returns\n */\n static rootDir (): string {\n return Arkstack.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 Arkstack.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.setRootDir(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 const previousDir = Arkstack.appRootDir\n Arkstack.appRootDir = dir\n\n if (previousDir === dir) {\n return\n }\n\n if (Hook.has('set:root-dir', 'after'))\n Hook.get('set:root-dir', 'after', dir)\n }\n}\n","import { ArkstackMiddlewareConfig } from './http'\nimport { PromiseOrValue } from './Arkstack'\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":";;AASA,IAAsB,WAAtB,MAAsB,SAAsD;CACxE,OAAO;CACP,OAAe,aAAqB,QAAQ,KAAK;CACjD;CACA;;;;;;CAiBA,iBAAkB;EACd,OAAO,KAAK;;;;;;;CAQhB,OAAO,iBAAwC;EAC3C,OAAO,SAAS;;;;;;;CAQpB,YAAa;EACT,OAAO,KAAK;;;;;;;;CAShB,MAAM,QAAS,cAAsB,KAAM,OAAiB;EACxD,MAAM,EAAE,yBAAyB,MAAM,OAAO;EAC9C,MAAM,qBAA8C,OAAO,SAAS;GAChE,MAAM,KAAK,KAAK,MAAM,MAAM;KAC7B,OAAO,QAAQ,IAAI,YAAY,YAAY,EAAE,MAAe,MAAM;;;;;CAMzE,MAAM,WAAY;EACd,QAAQ,KAAK,EAAE;;;;;;;;CASnB,OAAO,UAAmB;EACtB,OAAO,SAAS;;;;;;;;CASpB,UAAmB;EACf,OAAO,SAAS;;;;;;;CAQpB,OAAO,aAAsB;EACzB,OAAO,SAAS;;;;;;;;CASpB,WAAY,KAAmB;EAC3B,SAAS,WAAW,IAAI;;;;;;;;CAS5B,OAAO,WAAY,KAAmB;EAClC,MAAM,cAAc,SAAS;EAC7B,SAAS,aAAa;EAEtB,IAAI,gBAAgB,KAChB;EAGJ,IAAI,KAAK,IAAI,gBAAgB,QAAQ,EACjC,KAAK,IAAI,gBAAgB,SAAS,IAAI;;;;;;;;;ACvHlD,IAAsB,oBAAtB,MAA2D;CAOvD,qBAAsB,MAAkC;;;;;;AAU5D,IAAsB,sBAAtB,MAA6D"}
|