inversify-typesafe-spring-like 0.5.3 → 0.5.5

package/README.md

@@ -24,4 +24,110 @@
   <a href="https://raw.githubusercontent.com/myeongjae-kim/inversify-typesafe/refs/heads/main/packages/inversify-typesafe-spring-like/LICENSE">
     <img src="https://img.shields.io/npm/l/inversify-typesafe-spring-like.svg" alt="MIT license" height="18">
   </a>
-</p>
+</p>
+
+```ts
+import { ApplicationContext, BeanConfig, returnAutowired } from "inversify-typesafe-spring-like";
+
+interface Article {
+  id: number;
+  title: string;
+  content: string;
+}
+
+interface ArticleOutgoingPort {
+  getById(id: number): Promise<Article>
+}
+
+class ArticleRepository implements ArticleOutgoingPort {
+  getById(id: number): Promise<Article> {
+    return Promise.resolve({
+      id: id,
+      title: `title #${id}`,
+      content: `content #${id}`,
+    })
+  }
+}
+
+interface GetArticleUseCase {
+  execute(id: number): Promise<Article>
+}
+
+const { Autowired } = returnAutowired<Beans>();
+
+class ArticleQueryService implements GetArticleUseCase {
+  constructor(
+    @Autowired("ArticleOutgoingPort") // compile error if a parameter of @Autowired is not a key of Beans.
+    private readonly articleOutgoingPort: ArticleOutgoingPort,
+  ) { }
+  execute(id: number): Promise<Article> {
+    return this.articleOutgoingPort.getById(id);
+  }
+}
+
+type Beans = {
+  GetArticleUseCase: GetArticleUseCase; // interface (class is also possible)
+  ArticleOutgoingPort: ArticleOutgoingPort; // interface (class is also possible)
+}
+
+const beanConfig: BeanConfig<Beans> = {
+  // compile error if ArticleQueryService is not compatible with GetArticleUseCase.
+  GetArticleUseCase: (bind) => bind().to(ArticleQueryService),
+  // compile error if ArticleRepository is not compatible with ArticleOutgoingPort.
+  ArticleOutgoingPort: (bind) => bind().to(ArticleRepository), 
+}
+
+const applicationContext = ApplicationContext(beanConfig);
+
+const getArticleUseCase = applicationContext.get("GetArticleUseCase")
+
+getArticleUseCase.execute(1).then(console.log)
+```
+
+## Introduction
+
+This library extends [inversify-typesafe](https://github.com/myeongjae-kim/inversify-typesafe) to provide a development experience similar to [Spring Framework](https://spring.io/).
+
+It sets the default container scope to `Singleton` and exports standard `inversify-typesafe` utilities with Spring-like naming conventions, making it easier for developers familiar with Spring to adopt Inversify in TypeScript projects.
+
+## Installation
+
+Via npm
+
+```bash
+npm install inversify-typesafe-spring-like
+```
+
+Via yarn
+
+```bash
+yarn add inversify-typesafe-spring-like
+```
+
+Via pnpm
+
+```bash
+pnpm add inversify-typesafe-spring-like
+```
+
+## Demo
+
+Try it out on <a href="https://stackblitz.com/edit/inversify-typesafe-spring-like?file=test%2Fmain.test.ts" target="_blank">StackBlitz</a>.
+
+## Types
+
+https://inversify-typesafe-spring-like.myeongjae.kim/modules.html
+
+## Usage
+
+The API is designed to mirror Spring's terminology:
+1. `createTypesafeContext()` $\rightarrow$ `ApplicationContext()`
+   - Note: `defaultScope` is set to `Singleton` by default.
+2. `returnTypesafeInject()` $\rightarrow$ `returnAutowired()`
+3. `TypesafeServiceConfig<T>` $\rightarrow$ `BeanConfig<T>`
+
+For complete usage documentation and advanced features, please refer to the [inversify-typesafe documentation](https://github.com/myeongjae-kim/inversify-typesafe/tree/main?tab=readme-ov-file#usage).
+
+## License
+
+MIT © [Myeongjae Kim](https://myeongjae.kim)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "inversify-typesafe-spring-like",
   "type": "module",
-  "version": "0.5.3",
+  "version": "0.5.5",
   "description": "Add-On Library for inversify-typesafe to make it more like Spring.",
   "source": "src/index.ts",
   "exports": {
@@ -32,7 +32,7 @@
     "setup": "husky install",
     "clean": "rimraf dist",
     "bundle": "microbundle --format modern,cjs,umd",
-    "typedoc": "typedoc src/index.ts --out docs/public/docs",
+    "typedoc": "typedoc src/index.ts --out docs/web/types",
     "build": "pnpm run clean && pnpm run bundle && sh ../../scripts/generate-cts.sh && rimraf dist/index.d.ts\\'\\'",
     "dev": "microbundle watch",
     "prepublishOnly": "pnpm run test && pnpm run build",
@@ -61,6 +61,6 @@
   "author": "Myeongjae Kim",
   "license": "MIT",
   "dependencies": {
-    "inversify-typesafe": "^0.5.3"
+    "inversify-typesafe": "^0.5.4"
   }
 }