@arkstack/contract 0.2.4 → 0.3.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Toneflix Technologies Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -22,6 +22,7 @@ declare abstract class ArkstackKitDriver<TApp, TMiddleware> {
   abstract createApp(): TApp;
   abstract mountPublicAssets(app: TApp, publicPath: string): PromiseOrValue<void>;
   abstract bindRouter(app: TApp): PromiseOrValue<void>;
+  abstract applyMiddleware(app: TApp, middleware: ArkstackMiddlewareConfig<TMiddleware>): PromiseOrValue<void>;
   abstract applyMiddleware(app: TApp, middleware: TMiddleware): PromiseOrValue<void>;
   registerErrorHandler(_app: TApp): PromiseOrValue<void>;
   abstract start(app: TApp, port: number): PromiseOrValue<void>;

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: 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;CAMzD,qBAAsB,MAAkC;;;;;;AAU1D,IAAsB,sBAAtB,MAA6D"}
+{"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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/contract",
-  "version": "0.2.4",
+  "version": "0.3.1",
   "type": "module",
   "description": "Contract package for Arkstack providing contract-specific implementations of core Arkstack features such as routing, middleware, and database integration.",
   "homepage": "https://arkstack.toneflix.net",