serverstruct 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Eric Afes
+
+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/README.md

@@ -0,0 +1,3 @@
+# Commandstruct
+
+Type safe and modular servers with [Hono](https://github.com/honojs/hono).

package/dist/index.d.mts

@@ -0,0 +1,57 @@
+import { InitFactory, InstantiableConstructor, RegisterTokens, inferContainer, Hollywood, AnyHollywood } from 'hollywood-di';
+import { Env, Hono } from 'hono';
+
+type IsAny<T> = unknown extends T & string ? true : false;
+type WithoutTrailingSlash<T extends string> = T extends `${infer P}/` ? P : T;
+type WithoutLeadingSlash<T extends string> = T extends `/${infer P}` ? P : T;
+type WithMinimumSlash<T extends string> = T extends "" ? "/" : T;
+type MergePath<P extends string, T extends string> = IsAny<T> extends true ? any : WithMinimumSlash<WithoutTrailingSlash<`${WithoutTrailingSlash<P>}/${WithoutLeadingSlash<T>}`>>;
+
+type Router<BasePath extends string = "/", Path extends string = "/", E extends Env = Env, S = {}> = Hono<E, S, MergePath<BasePath, Path>>;
+declare class ControllerDef<BasePath extends string = "/", Path extends string = "/", E extends Env = Env, S = {}, Out = S> {
+    path: Path;
+    route: (router: Router<BasePath, Path, E, S>) => Router<BasePath, Path, E, Out>;
+    constructor(path: Path, route: (router: Router<BasePath, Path, E, S>) => Router<BasePath, Path, E, Out>);
+    mountTo(parent: Hono<any, any, BasePath>): void;
+}
+type Controller<BasePath extends string, Path extends string, T extends Record<string, any> = {}, E extends Env = Env, S = {}, Out = S> = InitFactory<T, ControllerDef<BasePath, Path, E, S, Out>>;
+type inferController<T extends Controller<any, any, any, any, any>> = T extends Controller<infer BasePath, infer Path, any, infer E, any, infer Out> ? Router<BasePath, Path, E, Out> : never;
+type ControllerInit<T> = <U extends Record<string, any>>(constructor: InstantiableConstructor<T, U>) => U;
+type ControllerContext<TContainer, TRouter> = {
+    router: TRouter;
+    container: TContainer;
+    /**
+     * Initialize an instantiable constructor with the controller's container.
+     *
+     * Also automatically binds class methods to their instance using `auto-bind`.
+     */
+    init: ControllerInit<TContainer>;
+};
+type ControllerBuilder<BasePath extends string = "/", Path extends string = "/", T extends Record<string, any> = {}, E extends Env = Env, S = {}> = {
+    build<Out>(config: (ctx: ControllerContext<T, Router<BasePath, Path, E, S>>) => Router<BasePath, Path, E, Out>): Controller<BasePath, Path, T, E, S, Out>;
+};
+declare function createController<BasePath extends string = "/", Path extends string = "/", T extends Record<string, any> = {}, E extends Env = Env, S = {}>(path: Path): ControllerBuilder<BasePath, Path, T, E, S>;
+
+interface Module<BasePath extends string, Path extends string, P extends Record<string, any>> {
+    path: Path;
+    tokens: RegisterTokens<any, P>;
+    controllers: Controller<MergePath<BasePath, Path>, any, P, any, any, any>[];
+    submodules?: Module<MergePath<BasePath, Path>, any, P>[];
+}
+interface ModuleConfig<BasePath extends string, Path extends string, T extends Record<string, any>, P extends Record<string, any>> {
+    tokens: RegisterTokens<T, P>;
+    controllers: Controller<MergePath<BasePath, Path>, any, inferContainer<Hollywood<T, Hollywood<P, any>>>, any, any, any>[];
+    submodules?: Module<MergePath<BasePath, Path>, any, inferContainer<Hollywood<T, Hollywood<P, any>>>>[];
+}
+type ModuleBuilder<BasePath extends string = "/", Path extends string = "/", P extends Record<string, any> = {}> = {
+    build<T extends Record<string, any> = {}>(config: ModuleConfig<BasePath, Path, T, P>): Module<BasePath, Path, P>;
+};
+declare function createModule<BasePath extends string = "/", Path extends string = "/", P extends Record<string, any> = {}>(path: Path): ModuleBuilder<BasePath, Path, P>;
+
+interface Serverstruct<Container extends AnyHollywood, BasePath extends string> {
+    modules(...modules: Module<BasePath, any, inferContainer<Container>>[]): this;
+    controllers(...controllers: Controller<BasePath, any, inferContainer<Container>, any, any, any>[]): this;
+}
+declare function serverstruct<App extends Hono<any, any, BasePath>, Container extends AnyHollywood, BasePath extends string = "/">(app: App, container: Container, _base?: BasePath): Serverstruct<Container, BasePath>;
+
+export { Controller, ControllerContext, Module, ModuleConfig, Router, Serverstruct, createController, createModule, inferController, serverstruct };

package/dist/index.d.ts

@@ -0,0 +1,57 @@
+import { InitFactory, InstantiableConstructor, RegisterTokens, inferContainer, Hollywood, AnyHollywood } from 'hollywood-di';
+import { Env, Hono } from 'hono';
+
+type IsAny<T> = unknown extends T & string ? true : false;
+type WithoutTrailingSlash<T extends string> = T extends `${infer P}/` ? P : T;
+type WithoutLeadingSlash<T extends string> = T extends `/${infer P}` ? P : T;
+type WithMinimumSlash<T extends string> = T extends "" ? "/" : T;
+type MergePath<P extends string, T extends string> = IsAny<T> extends true ? any : WithMinimumSlash<WithoutTrailingSlash<`${WithoutTrailingSlash<P>}/${WithoutLeadingSlash<T>}`>>;
+
+type Router<BasePath extends string = "/", Path extends string = "/", E extends Env = Env, S = {}> = Hono<E, S, MergePath<BasePath, Path>>;
+declare class ControllerDef<BasePath extends string = "/", Path extends string = "/", E extends Env = Env, S = {}, Out = S> {
+    path: Path;
+    route: (router: Router<BasePath, Path, E, S>) => Router<BasePath, Path, E, Out>;
+    constructor(path: Path, route: (router: Router<BasePath, Path, E, S>) => Router<BasePath, Path, E, Out>);
+    mountTo(parent: Hono<any, any, BasePath>): void;
+}
+type Controller<BasePath extends string, Path extends string, T extends Record<string, any> = {}, E extends Env = Env, S = {}, Out = S> = InitFactory<T, ControllerDef<BasePath, Path, E, S, Out>>;
+type inferController<T extends Controller<any, any, any, any, any>> = T extends Controller<infer BasePath, infer Path, any, infer E, any, infer Out> ? Router<BasePath, Path, E, Out> : never;
+type ControllerInit<T> = <U extends Record<string, any>>(constructor: InstantiableConstructor<T, U>) => U;
+type ControllerContext<TContainer, TRouter> = {
+    router: TRouter;
+    container: TContainer;
+    /**
+     * Initialize an instantiable constructor with the controller's container.
+     *
+     * Also automatically binds class methods to their instance using `auto-bind`.
+     */
+    init: ControllerInit<TContainer>;
+};
+type ControllerBuilder<BasePath extends string = "/", Path extends string = "/", T extends Record<string, any> = {}, E extends Env = Env, S = {}> = {
+    build<Out>(config: (ctx: ControllerContext<T, Router<BasePath, Path, E, S>>) => Router<BasePath, Path, E, Out>): Controller<BasePath, Path, T, E, S, Out>;
+};
+declare function createController<BasePath extends string = "/", Path extends string = "/", T extends Record<string, any> = {}, E extends Env = Env, S = {}>(path: Path): ControllerBuilder<BasePath, Path, T, E, S>;
+
+interface Module<BasePath extends string, Path extends string, P extends Record<string, any>> {
+    path: Path;
+    tokens: RegisterTokens<any, P>;
+    controllers: Controller<MergePath<BasePath, Path>, any, P, any, any, any>[];
+    submodules?: Module<MergePath<BasePath, Path>, any, P>[];
+}
+interface ModuleConfig<BasePath extends string, Path extends string, T extends Record<string, any>, P extends Record<string, any>> {
+    tokens: RegisterTokens<T, P>;
+    controllers: Controller<MergePath<BasePath, Path>, any, inferContainer<Hollywood<T, Hollywood<P, any>>>, any, any, any>[];
+    submodules?: Module<MergePath<BasePath, Path>, any, inferContainer<Hollywood<T, Hollywood<P, any>>>>[];
+}
+type ModuleBuilder<BasePath extends string = "/", Path extends string = "/", P extends Record<string, any> = {}> = {
+    build<T extends Record<string, any> = {}>(config: ModuleConfig<BasePath, Path, T, P>): Module<BasePath, Path, P>;
+};
+declare function createModule<BasePath extends string = "/", Path extends string = "/", P extends Record<string, any> = {}>(path: Path): ModuleBuilder<BasePath, Path, P>;
+
+interface Serverstruct<Container extends AnyHollywood, BasePath extends string> {
+    modules(...modules: Module<BasePath, any, inferContainer<Container>>[]): this;
+    controllers(...controllers: Controller<BasePath, any, inferContainer<Container>, any, any, any>[]): this;
+}
+declare function serverstruct<App extends Hono<any, any, BasePath>, Container extends AnyHollywood, BasePath extends string = "/">(app: App, container: Container, _base?: BasePath): Serverstruct<Container, BasePath>;
+
+export { Controller, ControllerContext, Module, ModuleConfig, Router, Serverstruct, createController, createModule, inferController, serverstruct };

package/dist/index.js

@@ -0,0 +1,133 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  createController: () => createController,
+  createModule: () => createModule,
+  serverstruct: () => serverstruct
+});
+module.exports = __toCommonJS(src_exports);
+var import_hono2 = require("hono");
+
+// src/controller.ts
+var import_auto_bind = __toESM(require("auto-bind"));
+var import_hollywood_di = require("hollywood-di");
+var import_hono = require("hono");
+var ControllerDef = class {
+  constructor(path, route) {
+    this.path = path;
+    this.route = route;
+  }
+  mountTo(parent) {
+    const router = new import_hono.Hono();
+    const mountedRouter = this.route(router);
+    parent.route(this.path, mountedRouter);
+  }
+};
+function createController(path) {
+  return {
+    build(config) {
+      return {
+        init(container) {
+          const init = (constructor) => {
+            const instance = import_hollywood_di.Hollywood.initConstructor(constructor, container);
+            return (0, import_auto_bind.default)(instance);
+          };
+          return new ControllerDef(path, (router) => config({ router, container, init }));
+        }
+      };
+    }
+  };
+}
+
+// src/module.ts
+function createModule(path) {
+  return {
+    build(config) {
+      return __spreadProps(__spreadValues({}, config), { path });
+    }
+  };
+}
+
+// src/index.ts
+function serverstruct(app, container, _base) {
+  return {
+    controllers(...controllers) {
+      registerControllers(app, container, controllers);
+      return this;
+    },
+    modules(...modules) {
+      for (const module2 of modules) {
+        registerModule(app, container, module2);
+      }
+      return this;
+    }
+  };
+}
+function registerControllers(app, container, controllers) {
+  for (const controllerInit of controllers) {
+    const controller = container.resolve(controllerInit);
+    controller.mountTo(app);
+  }
+}
+function registerModule(app, container, module2) {
+  var _a;
+  const moduleContainer = container.createChild(module2.tokens);
+  const subapp = new import_hono2.Hono();
+  registerControllers(subapp, moduleContainer, module2.controllers);
+  for (const submodule of (_a = module2.submodules) != null ? _a : []) {
+    registerModule(subapp, moduleContainer, submodule);
+  }
+  app.route(module2.path, subapp);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createController,
+  createModule,
+  serverstruct
+});

package/dist/index.mjs

@@ -0,0 +1,99 @@
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+
+// src/index.ts
+import { Hono as Hono2 } from "hono";
+
+// src/controller.ts
+import autoBind from "auto-bind";
+import { Hollywood } from "hollywood-di";
+import { Hono } from "hono";
+var ControllerDef = class {
+  constructor(path, route) {
+    this.path = path;
+    this.route = route;
+  }
+  mountTo(parent) {
+    const router = new Hono();
+    const mountedRouter = this.route(router);
+    parent.route(this.path, mountedRouter);
+  }
+};
+function createController(path) {
+  return {
+    build(config) {
+      return {
+        init(container) {
+          const init = (constructor) => {
+            const instance = Hollywood.initConstructor(constructor, container);
+            return autoBind(instance);
+          };
+          return new ControllerDef(path, (router) => config({ router, container, init }));
+        }
+      };
+    }
+  };
+}
+
+// src/module.ts
+function createModule(path) {
+  return {
+    build(config) {
+      return __spreadProps(__spreadValues({}, config), { path });
+    }
+  };
+}
+
+// src/index.ts
+function serverstruct(app, container, _base) {
+  return {
+    controllers(...controllers) {
+      registerControllers(app, container, controllers);
+      return this;
+    },
+    modules(...modules) {
+      for (const module of modules) {
+        registerModule(app, container, module);
+      }
+      return this;
+    }
+  };
+}
+function registerControllers(app, container, controllers) {
+  for (const controllerInit of controllers) {
+    const controller = container.resolve(controllerInit);
+    controller.mountTo(app);
+  }
+}
+function registerModule(app, container, module) {
+  var _a;
+  const moduleContainer = container.createChild(module.tokens);
+  const subapp = new Hono2();
+  registerControllers(subapp, moduleContainer, module.controllers);
+  for (const submodule of (_a = module.submodules) != null ? _a : []) {
+    registerModule(subapp, moduleContainer, submodule);
+  }
+  app.route(module.path, subapp);
+}
+export {
+  createController,
+  createModule,
+  serverstruct
+};

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "serverstruct",
+  "version": "0.1.0",
+  "description": "Type safe and modular servers with Hono",
+  "private": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "prebuild": "shx rm -rf dist",
+    "build": "tsc --noEmit && tsup src/index.ts --format esm,cjs --dts",
+    "release": "pnpm run build && changeset publish",
+    "watch": "vitest",
+    "test": "vitest run"
+  },
+  "keywords": [
+    "command",
+    "cli",
+    "sade",
+    "hollywood-di",
+    "typescript"
+  ],
+  "author": "Eric Afes <eriicafes@gmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eriicafes/serverstruct.git"
+  },
+  "bugs": {
+    "url": "https://github.com/eriicafes/serverstruct/issues"
+  },
+  "homepage": "https://github.com/eriicafes/serverstruct#readme",
+  "dependencies": {
+    "auto-bind": "^5.0.1"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.26.2",
+    "@hono/node-server": "^1.1.0",
+    "@types/node": "^20.4.2",
+    "@types/supertest": "^2.0.12",
+    "shx": "^0.3.4",
+    "supertest": "^6.3.3",
+    "tsup": "^7.1.0",
+    "typescript": "^5.1.6",
+    "vitest": "^0.33.0"
+  },
+  "peerDependencies": {
+    "hollywood-di": ">= 0.2.1",
+    "hono": ">= 3.3.0"
+  }
+}