@arkstack/contract 0.1.1

package/README.md

@@ -0,0 +1,5 @@
+# @arkstack/contract
+
+Framework-agnostic contracts used by Arkstack runtime kits.
+
+This package defines the shared shape each framework driver must implement.

package/dist/index.d.ts

@@ -0,0 +1,45 @@
+//#region src/index.d.ts
+type PromiseOrValue<T> = T | Promise<T>;
+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>;
+}
+/**
+ * The ArkstackKitDriver class defines the contract for a driver
+ * that can be used with the ArkstackKitContract.
+ */
+declare abstract class ArkstackKitDriver<TApp, TMiddleware> {
+  abstract readonly name: string;
+  abstract createApp(): TApp;
+  abstract mountPublicAssets(app: TApp, publicPath: string): PromiseOrValue<void>;
+  abstract bindRouter(app: TApp): PromiseOrValue<void>;
+  abstract applyMiddleware(app: TApp, middleware: TMiddleware): PromiseOrValue<void>;
+  registerErrorHandler(_app: TApp): PromiseOrValue<void>;
+  abstract start(app: TApp, port: number): PromiseOrValue<void>;
+}
+/**
+ * The ArkstackKitContract class defines the contract for an
+ * application that uses the ArkstackKitDriver.
+ */
+declare abstract class ArkstackKitContract<TApp, TMiddleware> {
+  abstract app: TApp;
+  abstract driver: ArkstackKitDriver<TApp, TMiddleware>;
+  abstract middleware: ArkstackMiddlewareConfig<TMiddleware>;
+  abstract boot(port: number): Promise<void>;
+  abstract shutdown(): Promise<void>;
+}
+//#endregion
+export { ArkstackKitContract, ArkstackKitDriver, ArkstackMiddlewareConfig, ArkstackRouteListOptions, ArkstackRouterAwareCore, ArkstackRouterContract, PromiseOrValue };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,17 @@
+//#region src/index.ts
+/**
+* The ArkstackKitDriver class defines the contract for a driver 
+* that can be used with the ArkstackKitContract. 
+*/
+var ArkstackKitDriver = class {
+	registerErrorHandler(_app) {}
+};
+/**
+* The ArkstackKitContract class defines the contract for an 
+* application that uses the ArkstackKitDriver.
+*/
+var ArkstackKitContract = class {};
+
+//#endregion
+export { ArkstackKitContract, ArkstackKitDriver };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@arkstack/contract",
+  "version": "0.1.1",
+  "type": "module",
+  "description": "Contract package for Arkstack providing contract-specific implementations of core Arkstack features such as routing, middleware, and database integration.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/arkstack-hq/arkstack.git",
+    "directory": "packages/contract"
+  },
+  "keywords": [
+    "contract",
+    "interface",
+    "types",
+    "validation",
+    "schema",
+    "arkstack"
+  ],
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsdown",
+    "version:patch": "pnpm version patch --no-git-tag-version"
+  }
+}