di-sacala 0.1.3 → 0.1.4

package/README.md

@@ -1,12 +1,33 @@
 # di-sacala
 
 [![Tests](https://github.com/monkin/di-sacala/actions/workflows/test.yml/badge.svg)](https://github.com/monkin/di-sacala/actions/workflows/test.yml)
+[![NPM version](https://img.shields.io/npm/v/di-sacala.svg)](https://www.npmjs.com/package/di-sacala)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Bundle Size](https://img.shields.io/bundlephobia/min/di-sacala)](https://bundlephobia.com/package/di-sacala)
 
 `di-sacala` is a lightweight, type-safe dependency injection container for TypeScript. It leverages TypeScript's advanced type system to provide a fluent API for service registration and resolution with full type safety and autocompletion.
 
+## Table of Contents
+
+- [Features](#features)
+- [Motivation](#motivation)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [1. Defining a Service](#1-defining-a-service)
+  - [2. Basic Injection](#2-basic-injection)
+  - [3. Services with Dependencies](#3-services-with-dependencies)
+  - [4. Merging Containers](#4-merging-containers)
+  - [5. Lazy & Singleton](#5-lazy--singleton)
+  - [6. Duplicate Service Name Protection](#6-duplicate-service-name-protection)
+  - [7. Reserved Field Names](#7-reserved-field-names)
+- [API Reference](#api-reference)
+- [Development](#development)
+- [License](#license)
+
 ## Features
 
 - **Full Type Safety**: Get autocompletion and type checks for all your injected services.
+- **No Decorators**: No need for `reflect-metadata` or experimental decorators. Pure TypeScript.
 - **Fluent API**: Chainable service registration makes it easy to compose your container.
 - **Container Composition**: Merge multiple containers together to share dependencies across different parts of your application.
 - **Lazy & Singleton**: Services are instantiated only on demand (when first accessed) and reused for subsequent accesses.
@@ -60,23 +81,29 @@ To inject dependencies into a service, define its constructor to accept the cont
 ```typescript
 import { Di, DiService } from 'di-sacala';
 import { LoggerService } from './LoggerService';
+import { ConfigService } from './ConfigService';
 
 export class UserService implements DiService<"user"> {
     getServiceName() {
         return "user" as const;
     }
     
-    // Use Di<ServiceType> or Di<[Service1, Service2]> for type-safe dependencies
-    constructor(private di: Di<LoggerService>) {}
+    // Single dependency:
+    // constructor(private di: Di<LoggerService>) {}
+
+    // Multiple dependencies using a tuple:
+    constructor(private di: Di<[LoggerService, ConfigService]>) {}
 
     getUser(id: string) {
-        this.di.logger.log(`Fetching user: ${id}`);
+        const prefix = this.di.config.get("userPrefix");
+        this.di.logger.log(`Fetching user: ${prefix}${id}`);
         return { id, name: "User " + id };
     }
 }
 
 const container = new DiContainer()
     .inject(LoggerService)
+    .inject(ConfigService)
     .inject(UserService);
 
 container.user.getUser("42");
@@ -149,6 +176,31 @@ const container = new DiContainer();
 container.inject(InjectService);
 ```
 
+## API Reference
+
+### `DiContainer`
+
+The main class for managing services.
+
+- `inject(ServiceClass: new (di: this) => S): DiContainer & Di<S>`
+  Registers a service class. Returns the container instance, typed with the newly added service.
+- `injectContainer(other: DiContainer): DiContainer & ...`
+  Copies all services from another container into this one.
+
+### `DiService<Name>`
+
+An interface that your service classes must implement.
+
+- `getServiceName(this: null): Name`
+  Must return the unique name of the service as a string literal type.
+
+### `Di<S>`
+
+A utility type to help define dependencies in your service constructors.
+
+- `Di<ServiceClass>`: Resolves to an object with the service name as the key and the service instance as the value.
+- `Di<[Service1, Service2]>`: Resolves to a merged object containing all specified services.
+
 ## Development
 
 ### Installation

package/dist/di-sacala.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"di-sacala.d.ts","sourceRoot":"","sources":["../src/di-sacala.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,SAAS,CAAC,IAAI,SAAS,MAAM;IAC1C;;;;;OAKG;IACH,cAAc,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CACpC;AAED;;;;;;GAMG;AACH,MAAM,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,GAAG,MAAM,IAAI,CAAC,GACjD,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,GACjB,CAAC,SAAS,EAAE,GACV,OAAO,GACP,CAAC,SAAS,SAAS,CAAC,MAAM,IAAI,CAAC,GAC7B;KAAG,GAAG,IAAI,IAAI,GAAG,CAAC;CAAE,GACpB,KAAK,CAAC;AAIhB,KAAK,kBAAkB,CAAC,IAAI,EAAE,CAAC,IAAI,IAAI,SAAS,MAAM,WAAW,GAC3D,wBAAwB,IAAI,EAAE,GAC9B,CAAC,CAAC;AAER,KAAK,MAAM,CAAC,SAAS,EAAE,OAAO,SAAS,SAAS,CAAC,MAAM,CAAC,IACpD,OAAO,SAAS,SAAS,CAAC,MAAM,IAAI,CAAC,GAC/B,kBAAkB,CACd,IAAI,EACJ,SAAS,SAAS;KAAG,GAAG,IAAI,IAAI,GAAG,OAAO;CAAE,GACtC,2BAA2B,IAAI,EAAE,GACjC,SAAS,GAAG,EAAE,CAAC,OAAO,CAAC,CAChC,GACD,KAAK,CAAC;AAEhB,KAAK,KAAK,CAAC,GAAG,EAAE,GAAG,IAAI,OAAO,CAAC,MAAM,GAAG,EAAE,QAAQ,GAAG,iBAAiB,CAAC,GACnE,OAAO,CAAC,MAAM,GAAG,EAAE,QAAQ,GAAG,iBAAiB,CAAC,SAAS,KAAK,GAC5D,GAAG,GAAG,GAAG,GACT,oCAAoC,CAAC,OAAO,CACxC,MAAM,GAAG,EACT,QAAQ,GAAG,iBAAiB,CAC/B,GACG,OAAO,CAAC,MAAM,GAAG,EAAE,QAAQ,GAAG,iBAAiB,CAAC,CAAC,GACjD,MAAM,EAAE,CAAC;AAiBnB;;;;GAIG;AACH,qBAAa,WAAW;;IAGpB;;;;;;;;OAQG;IACH,MAAM,CAAC,CAAC,SAAS,SAAS,CAAC,MAAM,CAAC,EAC9B,UAAU,EAAE,KAAK,YAAY,EAAE,IAAI,KAAK,CAAC,GAC1C,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IAwBlB;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,SAAS,WAAW,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;CAetE"}
+{"version":3,"file":"di-sacala.d.ts","sourceRoot":"","sources":["../src/di-sacala.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,SAAS,CAAC,IAAI,SAAS,MAAM;IAC1C;;;;;OAKG;IACH,cAAc,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CACpC;AAED;;;;;;GAMG;AACH,MAAM,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,GAAG,MAAM,IAAI,CAAC,GACjD,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,GACjB,CAAC,SAAS,EAAE,GACV,OAAO,GACP,CAAC,SAAS,SAAS,CAAC,MAAM,IAAI,CAAC,GAC7B;KAAG,GAAG,IAAI,IAAI,GAAG,CAAC;CAAE,GACpB,KAAK,CAAC;AAIhB,KAAK,kBAAkB,CAAC,IAAI,EAAE,CAAC,IAAI,IAAI,SAAS,MAAM,WAAW,GAC3D,wBAAwB,IAAI,EAAE,GAC9B,CAAC,CAAC;AAER,KAAK,MAAM,CAAC,SAAS,EAAE,OAAO,SAAS,SAAS,CAAC,MAAM,CAAC,IACpD,OAAO,SAAS,SAAS,CAAC,MAAM,IAAI,CAAC,GAC/B,kBAAkB,CACd,IAAI,EACJ,SAAS,SAAS;KAAG,GAAG,IAAI,IAAI,GAAG,OAAO;CAAE,GACtC,2BAA2B,IAAI,EAAE,GACjC,SAAS,GAAG,EAAE,CAAC,OAAO,CAAC,CAChC,GACD,KAAK,CAAC;AAEhB,KAAK,KAAK,CAAC,GAAG,EAAE,GAAG,IAAI,OAAO,CAAC,MAAM,GAAG,EAAE,QAAQ,GAAG,iBAAiB,CAAC,GACnE,OAAO,CAAC,MAAM,GAAG,EAAE,QAAQ,GAAG,iBAAiB,CAAC,SAAS,KAAK,GAC5D,GAAG,GAAG,GAAG,GACT,oCAAoC,CAAC,OAAO,CACxC,MAAM,GAAG,EACT,QAAQ,GAAG,iBAAiB,CAC/B,GACG,OAAO,CAAC,MAAM,GAAG,EAAE,QAAQ,GAAG,iBAAiB,CAAC,CAAC,GACjD,MAAM,EAAE,CAAC;AAYnB;;;;GAIG;AACH,qBAAa,WAAW;;IAGpB;;;;;;;;OAQG;IACH,MAAM,CAAC,CAAC,SAAS,SAAS,CAAC,MAAM,CAAC,EAC9B,UAAU,EAAE,KAAK,YAAY,EAAE,IAAI,KAAK,CAAC,GAC1C,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IAwBlB;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,SAAS,WAAW,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;CAetE"}

package/dist/index.js

@@ -1,27 +1,23 @@
-const s =  new Set(["inject", "injectContainer"]), i = (n, t) => Object.prototype.hasOwnProperty.call(n, t);
-function c(n, t) {
-  for (const e in n) i(n, e) && t(e);
-}
-const r = (n) => {
-  throw new Error(n);
+const a =  new Set(["inject", "injectContainer"]), c = (r, t) => Object.prototype.hasOwnProperty.call(r, t), s = (r, t) => Object.keys(r).forEach(t), n = (r) => {
+  throw new Error(r);
 };
-class a {
+class o {
   constructor() {
   }
   inject(t) {
     const e = t.prototype.getServiceName.call(null);
-    s.has(e) && r(`Reserved field name: ${e}`), i(this, e) && r(`Duplicate service name: ${e}`);
-    let o;
-    return Object.defineProperty(this, e, { enumerable: !0, get: () => o ?? (o = new t(this)) }), this;
+    a.has(e) && n(`Reserved field name: ${e}`), c(this, e) && n(`Duplicate service name: ${e}`);
+    let i;
+    return Object.defineProperty(this, e, { enumerable: !0, get: () => i ?? (i = new t(this)) }), this;
   }
   injectContainer(t) {
-    return c(t, (e) => {
-      i(this, e) && r(`Containers have duplicated keys: ${String(e)}`);
-    }), c(t, (e) => {
+    return s(t, (e) => {
+      c(this, e) && n(`Containers have duplicated keys: ${String(e)}`);
+    }), s(t, (e) => {
       Object.defineProperty(this, e, { enumerable: !0, get: () => t[e] });
     }), this;
   }
 }
 export {
-  a as DiContainer
+  o as DiContainer
 };

package/dist/index.umd.cjs

@@ -1 +1 @@
-(function(o,i){typeof exports=="object"&&typeof module<"u"?i(exports):typeof define=="function"&&define.amd?define(["exports"],i):(o=typeof globalThis<"u"?globalThis:o||self,i(o.DiSacala={}))})(this,(function(o){"use strict";const i=new Set(["inject","injectContainer"]),r=(n,t)=>Object.prototype.hasOwnProperty.call(n,t);function c(n,t){for(const e in n)r(n,e)&&t(e)}const s=n=>{throw new Error(n)};class l{constructor(){}inject(t){const e=t.prototype.getServiceName.call(null);i.has(e)&&s(`Reserved field name: ${e}`),r(this,e)&&s(`Duplicate service name: ${e}`);let a;return Object.defineProperty(this,e,{enumerable:!0,get:()=>a??(a=new t(this))}),this}injectContainer(t){return c(t,e=>{r(this,e)&&s(`Containers have duplicated keys: ${String(e)}`)}),c(t,e=>{Object.defineProperty(this,e,{enumerable:!0,get:()=>t[e]})}),this}}o.DiContainer=l,Object.defineProperty(o,Symbol.toStringTag,{value:"Module"})}));
+(function(i,o){typeof exports=="object"&&typeof module<"u"?o(exports):typeof define=="function"&&define.amd?define(["exports"],o):(i=typeof globalThis<"u"?globalThis:i||self,o(i.DiSacala={}))})(this,(function(i){"use strict";const o=new Set(["inject","injectContainer"]),s=(n,t)=>Object.prototype.hasOwnProperty.call(n,t),c=(n,t)=>Object.keys(n).forEach(t),r=n=>{throw new Error(n)};class l{constructor(){}inject(t){const e=t.prototype.getServiceName.call(null);o.has(e)&&r(`Reserved field name: ${e}`),s(this,e)&&r(`Duplicate service name: ${e}`);let a;return Object.defineProperty(this,e,{enumerable:!0,get:()=>a??(a=new t(this))}),this}injectContainer(t){return c(t,e=>{s(this,e)&&r(`Containers have duplicated keys: ${String(e)}`)}),c(t,e=>{Object.defineProperty(this,e,{enumerable:!0,get:()=>t[e]})}),this}}i.DiContainer=l,Object.defineProperty(i,Symbol.toStringTag,{value:"Module"})}));

package/package.json

@@ -1,27 +1,55 @@
 {
     "name": "di-sacala",
-    "version": "0.1.3",
+    "version": "0.1.4",
     "description": "Small type-safe dependency injection lib",
     "type": "module",
     "main": "./dist/index.js",
     "types": "./dist/di-sacala.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/di-sacala.d.ts",
+            "import": "./dist/index.js",
+            "require": "./dist/index.umd.cjs"
+        }
+    },
     "files": [
         "dist"
     ],
+    "sideEffects": false,
+    "engines": {
+        "node": ">=18.0.0"
+    },
     "scripts": {
         "build": "vite build",
         "test": "vitest run",
         "test:watch": "vitest",
         "lint": "eslint src --ext .ts",
         "format": "prettier --write \"src/**/*.ts\"",
-        "format:check": "prettier --check \"src/**/*.ts\""
+        "format:check": "prettier --check \"src/**/*.ts\"",
+        "prepublishOnly": "npm run lint && npm run test && npm run build"
     },
-    "keywords": [],
+    "keywords": [
+        "dependency-injection",
+        "di",
+        "typescript",
+        "type-safe",
+        "container",
+        "ioc",
+        "lightweight"
+    ],
     "author": {
         "name": "Andrei Monkin",
         "email": "monkin.andrey@gmail.com",
         "url": "https://github.com/monkin"
     },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/monkin/di-sacala.git"
+    },
+    "bugs": {
+        "url": "https://github.com/monkin/di-sacala/issues"
+    },
+    "homepage": "https://github.com/monkin/di-sacala#readme",
     "license": "MIT",
     "devDependencies": {
         "@eslint/js": "^9.39.2",