Merge pull request #2 from TiMESPLiNTER/feat/mercylessly-typed

Add mercylessly typing to container

.github/workflows/publish.yml

@@ -0,0 +1,18 @@
+name: Publish Package to npmjs
+on:
+  release:
+    types: [published]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -4,10 +4,10 @@ on: [push]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
     steps:
-    - uses: actions/checkout@v1
-    - name: Run Jest
-      uses: stefanoeb/[email protected]
+      - uses: actions/checkout@v2
+      - name: Install modules
+        run: npm install
+      - name: Run coverage
+        run: npm run test:cov

README.md

@@ -9,13 +9,22 @@ and the original PHP Pimple container by Fabien Potencier.
 
 ## Usage
 
-```js
+```ts
 import Pimple from '@timesplinter/pimple';
 
-const container: Container = new Pimple({env: 'dev'});
+type ServiceMap = {
+   'foo': string, 
+   'bar': string,
+};
 
-container.set('foo', (container: Pimple) => {
-    return `bar (${container.get('env')})`;
+const container: Container = new Pimple<ServiceMap>({env: 'dev'});
+
+container.set('foo', () => {
+    return `baz (${container.get('env')})`;
+});
+
+container.set('bar', (container: Pimple<ServiceMap>) => {
+    return `bar: ${container.get('foo')}`;
 });
 
 console.log(container.get('foo')); // 'bar (dev)';

jest.config.ts

@@ -0,0 +1,19 @@
+import type {Config} from 'jest';
+
+const config: Config = {
+    coverageDirectory: "./build/coverage",
+    coverageReporters: ['text', 'html', 'lcov'],
+    coverageThreshold: {
+        global: {
+            branches: 80,
+            functions: 88,
+            lines: 93,
+            statements: 93
+        }
+    },
+    collectCoverageFrom: [
+        "src/**/*"
+    ],
+};
+
+export default config;

lib/cjs/container.d.ts

@@ -1,4 +1,5 @@
-export default interface Container {
-    get(service: string): any;
-    has(service: string): boolean;
+export type ServiceKey<T> = keyof T;
+export default interface Container<T> {
+    get<K extends ServiceKey<T>>(key: K): T[K];
+    has<K extends ServiceKey<T>>(key: K): boolean;
 }

lib/cjs/pimple.d.ts

@@ -1,8 +1,15 @@
-import Container from "./container";
+import Container, { ServiceKey } from "./container";
 import ServiceProvider from "./serviceProvider";
 /** Declaration types */
-declare type ServiceDeclaration = Function | Object;
-declare type ProviderDeclaration = Function | ServiceProvider;
+type ServiceProviderFunction<T> = (container: Pimple<T>) => void;
+type ProviderDeclaration<T> = ServiceProviderFunction<T> | ServiceProvider<T>;
+type LazyServiceDefinition<T, S> = (container: Pimple<T>) => S;
+type ProtectedServiceDefinition<T, S> = () => LazyServiceDefinition<T, S>;
+type PlainServiceDefinition<S> = S extends Function ? () => S : S;
+type ServiceDefinition<T, S> = PlainServiceDefinition<S> | LazyServiceDefinition<T, S> | ProtectedServiceDefinition<T, S> | (S extends Function ? () => S : S);
+type ServiceMap<T> = {
+    [key in ServiceKey<T>]: ServiceDefinition<T, T[ServiceKey<T>]>;
+};
 /**
  * Pimple dependency injection container
  *
@@ -12,7 +19,7 @@ declare type ProviderDeclaration = Function | ServiceProvider;
  * @license LGPL
  * @version 3.0.0
  */
-export default class Pimple implements Container {
+export default class Pimple<T> implements Container<T> {
     /**
      * @type {string}
      */
@@ -27,41 +34,39 @@ export default class Pimple implements Container {
      * @private
      */
     private _raw;
-    constructor(services?: {
-        [key: string]: any;
-    });
+    constructor(services?: Partial<ServiceMap<T>>);
     /**
      * Define a service
      */
-    set(name: string, service: ServiceDeclaration): Pimple;
+    set<K extends ServiceKey<T>>(name: K, service: ServiceDefinition<T, T[K]>): Pimple<T>;
     /**
      * Register a factory
      */
-    factory(name: string, callback: Function): Pimple;
+    factory<K extends ServiceKey<T>>(name: K, callback: ServiceDefinition<T, T[K]>): Pimple<T>;
     /**
      * Get a service instance
      */
-    get(name: string): any;
+    get<K extends ServiceKey<T>>(name: K): T[K];
     /**
      * Checks whether a service is registered or not
      */
-    has(service: string): boolean;
+    has<K extends ServiceKey<T>>(name: K): boolean;
     /**
      * Register a protected function
      */
-    protect(service: Function): Function;
+    protect<T extends Function>(func: T): () => T;
     /**
      * Extend a service
      */
-    extend(serviceName: string, service: Function): Function;
+    extend<K extends ServiceKey<T>>(serviceName: K, service: Function): Function;
     /**
      * Get a service raw definition
      */
-    raw(name: string): Function;
+    raw<K extends ServiceKey<T>>(name: K): ServiceDefinition<T, T[K]>;
     /**
      * Register a service provider
      */
-    register(provider: ProviderDeclaration): Pimple;
+    register(provider: ProviderDeclaration<T>): Pimple<T>;
     private instanceOfServiceProvider;
 }
 export {};

lib/cjs/serviceProvider.d.ts

@@ -2,6 +2,6 @@ import Pimple from "./pimple";
 /**
  * Service provider class for service injecting in Pimple container
  */
-export default interface ServiceProvider {
-    register(container: Pimple): void;
+export default interface ServiceProvider<T> {
+    register(container: Pimple<T>): void;
 }

lib/esm/container.d.ts

@@ -1,4 +1,5 @@
-export default interface Container {
-    get(service: string): any;
-    has(service: string): boolean;
+export type ServiceKey<T> = keyof T;
+export default interface Container<T> {
+    get<K extends ServiceKey<T>>(key: K): T[K];
+    has<K extends ServiceKey<T>>(key: K): boolean;
 }

lib/esm/pimple.d.ts

@@ -1,8 +1,15 @@
-import Container from "./container";
+import Container, { ServiceKey } from "./container";
 import ServiceProvider from "./serviceProvider";
 /** Declaration types */
-declare type ServiceDeclaration = Function | Object;
-declare type ProviderDeclaration = Function | ServiceProvider;
+type ServiceProviderFunction<T> = (container: Pimple<T>) => void;
+type ProviderDeclaration<T> = ServiceProviderFunction<T> | ServiceProvider<T>;
+type LazyServiceDefinition<T, S> = (container: Pimple<T>) => S;
+type ProtectedServiceDefinition<T, S> = () => LazyServiceDefinition<T, S>;
+type PlainServiceDefinition<S> = S extends Function ? () => S : S;
+type ServiceDefinition<T, S> = PlainServiceDefinition<S> | LazyServiceDefinition<T, S> | ProtectedServiceDefinition<T, S> | (S extends Function ? () => S : S);
+type ServiceMap<T> = {
+    [key in ServiceKey<T>]: ServiceDefinition<T, T[ServiceKey<T>]>;
+};
 /**
  * Pimple dependency injection container
  *
@@ -12,7 +19,7 @@ declare type ProviderDeclaration = Function | ServiceProvider;
  * @license LGPL
  * @version 3.0.0
  */
-export default class Pimple implements Container {
+export default class Pimple<T> implements Container<T> {
     /**
      * @type {string}
      */
@@ -27,41 +34,39 @@ export default class Pimple implements Container {
      * @private
      */
     private _raw;
-    constructor(services?: {
-        [key: string]: any;
-    });
+    constructor(services?: Partial<ServiceMap<T>>);
     /**
      * Define a service
      */
-    set(name: string, service: ServiceDeclaration): Pimple;
+    set<K extends ServiceKey<T>>(name: K, service: ServiceDefinition<T, T[K]>): Pimple<T>;
     /**
      * Register a factory
      */
-    factory(name: string, callback: Function): Pimple;
+    factory<K extends ServiceKey<T>>(name: K, callback: ServiceDefinition<T, T[K]>): Pimple<T>;
     /**
      * Get a service instance
      */
-    get(name: string): any;
+    get<K extends ServiceKey<T>>(name: K): T[K];
     /**
      * Checks whether a service is registered or not
      */
-    has(service: string): boolean;
+    has<K extends ServiceKey<T>>(name: K): boolean;
     /**
      * Register a protected function
      */
-    protect(service: Function): Function;
+    protect<T extends Function>(func: T): () => T;
     /**
      * Extend a service
      */
-    extend(serviceName: string, service: Function): Function;
+    extend<K extends ServiceKey<T>>(serviceName: K, service: Function): Function;
     /**
      * Get a service raw definition
      */
-    raw(name: string): Function;
+    raw<K extends ServiceKey<T>>(name: K): ServiceDefinition<T, T[K]>;
     /**
      * Register a service provider
      */
-    register(provider: ProviderDeclaration): Pimple;
+    register(provider: ProviderDeclaration<T>): Pimple<T>;
     private instanceOfServiceProvider;
 }
 export {};