@rocketmakers/ioc 0.1.6 → 0.2.6

package/README.md

@@ -10,12 +10,16 @@ This package provides helper methods for inversify (https://inversify.io/) to:
 
 You should first create a type that describes your Container items, then create a `containerRegister` to help you to register those types.
 
+## Application
 
 `service/admin.ts`
 ```TypeScript
 export class AdminService {
-  constructor() {}
+  doSomething(value: number) {
+    return Math.round(value);
+  }
 }
+
 ```
 
 `controller/admin.ts`
@@ -23,68 +27,135 @@ export class AdminService {
 import { AdminService } from '../service/admin';
 
 export class AdminController {
-  constructor(private service: AdminService) {}
+  constructor(private adminService: AdminService) {}
 }
+
 ```
 
 `service/external-api.ts`
 ```TypeScript
+import { fetchUserData, IUser } from './external';
+
 // NOTE: we want the apiKey param to be provided (curried) from the container - so we never need to explicitly pass this when consuming this function!
-export function getExternalData(apiKey: string, id: number): number {
-  // ...
+export function getExternalUserData(apiKey: string, id: number): IUser {
+  return fetchUserData(apiKey, id);
 }
-```
 
-`ioc/containerRegistration.ts`
+```
+`ioc/types.ts`
 ```TypeScript
-import type { AdminService } from '../service/admin';
-import type { getExternalData } from '../service/external-api';
-import type { AdminController } from '../controller/admin';
+import { Curried1 } from '@rocketmakers/ioc';
 
-import { containerRegister, containerRegisterFunctionResolver, containerFactory, Curried1 } from '@rocketmakers/ioc';
+// Application Types
+import type { AdminController } from '../controller/admin';
+import type { AdminService } from '../service/admin';
+import type { getExternalUserData } from '../service/external-api';
 
+/** Define the types registered within the container */
 export type ControllerContainerTypes = {
   adminService: AdminService;
   adminController: AdminController;
   apiKey: string;
-  getExternalData: Curried1<typeof getExternalData>
+  getExternalUserData: Curried1<typeof getExternalUserData>;
 };
 
-export const register = containerRegister<ControllerContainerTypes>();
-export const functionResolver = containerRegisterFunctionResolver<ContainerTypes>();
-export const container = containerFactory<ContainerTypes>();
 ```
 
-## Registration
+## Registration (IoC Container Modules)
 
+### Building the container
 
 `ioc/register.ts`
 ```TypeScript
+import { containerRegisterFunctionResolver, IContainer, register } from '@rocketmakers/ioc';
+
+import { AdminController } from '../controller/admin';
 import { AdminService } from '../service/admin';
-import { getExternalData } from '../service/external-api';
+import { getExternalUserData } from '../service/external-api';
+import { ControllerContainerTypes } from './types';
+
+export const functionResolver = containerRegisterFunctionResolver<ControllerContainerTypes>();
+
+export function makeContainer(): IContainer<ControllerContainerTypes> {
+  // Register all the keys of the 'ControllerContainerTypes'
+  return register<ControllerContainerTypes>({
+    adminController: b => b.class(AdminController).construct(['adminService']),
+    adminService: b => b.class(AdminService).construct([]),
+    apiKey: b => b.constant('xyz...'),
+    getExternalUserData: b => b.functionResolver(functionResolver.curry1(getExternalUserData, 'apiKey')),
+  });
+}
+
+```
+
+### Resolving with the container
+
+```TypeScript
+import { makeContainer } from './ioc/register-new';
+
+export function boot() {
+  // Register the container
+  const container = makeContainer();
+
+  //  getExternalUserData has type "(id: number): IUser" as we curried out the apiKey param
+  const getExternalUserData = container.get('getExternalUserData');
+
+  const userData = getExternalUserData(23);
+  return userData;
+}
+
+boot();
+
+```
+
+
+## Registration (Legacy)
+
+### Building the container
+
+`ioc/register.ts`
+```TypeScript
+import { containerFactory, containerRegister, containerRegisterFunctionResolver } from '@rocketmakers/ioc';
+
+// Application Types
 import { AdminController } from '../controller/admin';
+import { AdminService } from '../service/admin';
+import { getExternalUserData } from '../service/external-api';
+import { ControllerContainerTypes } from './types';
 
-import { register, functionResolver } from './containerRegistration';
+// Create legacy helper functions
+export const register = containerRegister<ControllerContainerTypes>();
+export const functionResolver = containerRegisterFunctionResolver<ControllerContainerTypes>();
+export const container = containerFactory<ControllerContainerTypes>();
 
-export function registerIoC() {
+export function registerIoC(): void {
+  // Register all the keys of the 'ControllerContainerTypes'
   register.class('adminService', AdminService).construct([]).inSingletonScope();
   register.class('adminController', AdminController).construct(['adminService']).inSingletonScope();
-
   register.constant('apiKey', 'xyz...');
-
-  register.function('getExternalData', functionResolver.curry1(getExternalData, 'apiKey'));
+  register.function('getExternalUserData', functionResolver.curry1(getExternalUserData, 'apiKey'));
 }
+
 ```
 
-## Resolving with the container
+### Resolving with the container
 
 ```TypeScript
-import { container } from '../ioc/containerRegistration';
+import { container, registerIoC } from './ioc/register';
 
-export function doSomething() {
+export function boot() {
+  // Register the container
+  registerIoC();
 
-  const fn = container.get('getExternalData'); //  fn has type "(id: number): number" as we curried out the apiKey param
-  const extData = fn(23); // returns a "number"
-  // ...
+  //  getExternalUserData has type "(id: number): IUser" as we curried out the apiKey param
+  const getExternalUserData = container.get('getExternalUserData');
+
+  const userData = getExternalUserData(23);
+  return userData;
 }
+
+boot();
+
 ```
+
+

package/lib/curry.generated.d.ts

@@ -0,0 +1,143 @@
+/** Returns a mapped type that removes the first element from the type array */
+export declare type Tail1<T extends any[]> = ((...t: T) => any) extends (_1: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 2 elements from the type array */
+export declare type Tail2<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 3 elements from the type array */
+export declare type Tail3<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 4 elements from the type array */
+export declare type Tail4<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, _4: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 5 elements from the type array */
+export declare type Tail5<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, _4: any, _5: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 6 elements from the type array */
+export declare type Tail6<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, _4: any, _5: any, _6: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 7 elements from the type array */
+export declare type Tail7<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, _4: any, _5: any, _6: any, _7: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 8 elements from the type array */
+export declare type Tail8<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, _4: any, _5: any, _6: any, _7: any, _8: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 9 elements from the type array */
+export declare type Tail9<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, _4: any, _5: any, _6: any, _7: any, _8: any, _9: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 10 elements from the type array */
+export declare type Tail10<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, _4: any, _5: any, _6: any, _7: any, _8: any, _9: any, _10: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 11 elements from the type array */
+export declare type Tail11<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, _4: any, _5: any, _6: any, _7: any, _8: any, _9: any, _10: any, _11: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 12 elements from the type array */
+export declare type Tail12<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, _4: any, _5: any, _6: any, _7: any, _8: any, _9: any, _10: any, _11: any, _12: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 13 elements from the type array */
+export declare type Tail13<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, _4: any, _5: any, _6: any, _7: any, _8: any, _9: any, _10: any, _11: any, _12: any, _13: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 14 elements from the type array */
+export declare type Tail14<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, _4: any, _5: any, _6: any, _7: any, _8: any, _9: any, _10: any, _11: any, _12: any, _13: any, _14: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 15 elements from the type array */
+export declare type Tail15<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, _4: any, _5: any, _6: any, _7: any, _8: any, _9: any, _10: any, _11: any, _12: any, _13: any, _14: any, _15: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 16 elements from the type array */
+export declare type Tail16<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, _4: any, _5: any, _6: any, _7: any, _8: any, _9: any, _10: any, _11: any, _12: any, _13: any, _14: any, _15: any, _16: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 17 elements from the type array */
+export declare type Tail17<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, _4: any, _5: any, _6: any, _7: any, _8: any, _9: any, _10: any, _11: any, _12: any, _13: any, _14: any, _15: any, _16: any, _17: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 18 elements from the type array */
+export declare type Tail18<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, _4: any, _5: any, _6: any, _7: any, _8: any, _9: any, _10: any, _11: any, _12: any, _13: any, _14: any, _15: any, _16: any, _17: any, _18: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 19 elements from the type array */
+export declare type Tail19<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, _4: any, _5: any, _6: any, _7: any, _8: any, _9: any, _10: any, _11: any, _12: any, _13: any, _14: any, _15: any, _16: any, _17: any, _18: any, _19: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type that removes the first 20 elements from the type array */
+export declare type Tail20<T extends any[]> = ((...t: T) => any) extends (_1: any, _2: any, _3: any, _4: any, _5: any, _6: any, _7: any, _8: any, _9: any, _10: any, _11: any, _12: any, _13: any, _14: any, _15: any, _16: any, _17: any, _18: any, _19: any, _20: any, ...tail: infer TTail) => any ? TTail : [
+];
+/** Returns a mapped type of the function that removes the first parameter from the method */
+export declare type Curried1<T extends (...args: any[]) => any> = (...tail: Tail1<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 2 parameters from the method */
+export declare type Curried2<T extends (...args: any[]) => any> = (...tail: Tail2<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 3 parameters from the method */
+export declare type Curried3<T extends (...args: any[]) => any> = (...tail: Tail3<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 4 parameters from the method */
+export declare type Curried4<T extends (...args: any[]) => any> = (...tail: Tail4<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 5 parameters from the method */
+export declare type Curried5<T extends (...args: any[]) => any> = (...tail: Tail5<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 6 parameters from the method */
+export declare type Curried6<T extends (...args: any[]) => any> = (...tail: Tail6<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 7 parameters from the method */
+export declare type Curried7<T extends (...args: any[]) => any> = (...tail: Tail7<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 8 parameters from the method */
+export declare type Curried8<T extends (...args: any[]) => any> = (...tail: Tail8<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 9 parameters from the method */
+export declare type Curried9<T extends (...args: any[]) => any> = (...tail: Tail9<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 10 parameters from the method */
+export declare type Curried10<T extends (...args: any[]) => any> = (...tail: Tail10<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 11 parameters from the method */
+export declare type Curried11<T extends (...args: any[]) => any> = (...tail: Tail11<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 12 parameters from the method */
+export declare type Curried12<T extends (...args: any[]) => any> = (...tail: Tail12<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 13 parameters from the method */
+export declare type Curried13<T extends (...args: any[]) => any> = (...tail: Tail13<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 14 parameters from the method */
+export declare type Curried14<T extends (...args: any[]) => any> = (...tail: Tail14<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 15 parameters from the method */
+export declare type Curried15<T extends (...args: any[]) => any> = (...tail: Tail15<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 16 parameters from the method */
+export declare type Curried16<T extends (...args: any[]) => any> = (...tail: Tail16<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 17 parameters from the method */
+export declare type Curried17<T extends (...args: any[]) => any> = (...tail: Tail17<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 18 parameters from the method */
+export declare type Curried18<T extends (...args: any[]) => any> = (...tail: Tail18<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 19 parameters from the method */
+export declare type Curried19<T extends (...args: any[]) => any> = (...tail: Tail19<Parameters<T>>) => ReturnType<T>;
+/** Returns a mapped type of the function that removes the first 20 parameters from the method */
+export declare type Curried20<T extends (...args: any[]) => any> = (...tail: Tail20<Parameters<T>>) => ReturnType<T>;
+/** Returns the type in position 1 of the type array */
+export declare type Param1<T extends any[]> = T extends [
+    any,
+    ...any[]
+] ? T[0] : never;
+/** Returns the type in position 2 of the type array */
+export declare type Param2<T extends any[]> = Param1<Tail1<T>>;
+/** Returns the type in position 3 of the type array */
+export declare type Param3<T extends any[]> = Param1<Tail2<T>>;
+/** Returns the type in position 4 of the type array */
+export declare type Param4<T extends any[]> = Param1<Tail3<T>>;
+/** Returns the type in position 5 of the type array */
+export declare type Param5<T extends any[]> = Param1<Tail4<T>>;
+/** Returns the type in position 6 of the type array */
+export declare type Param6<T extends any[]> = Param1<Tail5<T>>;
+/** Returns the type in position 7 of the type array */
+export declare type Param7<T extends any[]> = Param1<Tail6<T>>;
+/** Returns the type in position 8 of the type array */
+export declare type Param8<T extends any[]> = Param1<Tail7<T>>;
+/** Returns the type in position 9 of the type array */
+export declare type Param9<T extends any[]> = Param1<Tail8<T>>;
+/** Returns the type in position 10 of the type array */
+export declare type Param10<T extends any[]> = Param1<Tail9<T>>;
+/** Returns the type in position 11 of the type array */
+export declare type Param11<T extends any[]> = Param1<Tail10<T>>;
+/** Returns the type in position 12 of the type array */
+export declare type Param12<T extends any[]> = Param1<Tail11<T>>;
+/** Returns the type in position 13 of the type array */
+export declare type Param13<T extends any[]> = Param1<Tail12<T>>;
+/** Returns the type in position 14 of the type array */
+export declare type Param14<T extends any[]> = Param1<Tail13<T>>;
+/** Returns the type in position 15 of the type array */
+export declare type Param15<T extends any[]> = Param1<Tail14<T>>;
+/** Returns the type in position 16 of the type array */
+export declare type Param16<T extends any[]> = Param1<Tail15<T>>;
+/** Returns the type in position 17 of the type array */
+export declare type Param17<T extends any[]> = Param1<Tail16<T>>;
+/** Returns the type in position 18 of the type array */
+export declare type Param18<T extends any[]> = Param1<Tail17<T>>;
+/** Returns the type in position 19 of the type array */
+export declare type Param19<T extends any[]> = Param1<Tail18<T>>;
+/** Returns the type in position 20 of the type array */
+export declare type Param20<T extends any[]> = Param1<Tail19<T>>;

package/lib/curry.generated.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/error.d.ts

@@ -0,0 +1,4 @@
+export declare class IocDuplicateKeyError extends Error {
+    duplicateKeys: string[];
+    constructor(duplicateKeys: string[]);
+}

package/lib/error.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IocDuplicateKeyError = void 0;
+var tslib_1 = require("tslib");
+var IocDuplicateKeyError = /** @class */ (function (_super) {
+    tslib_1.__extends(IocDuplicateKeyError, _super);
+    function IocDuplicateKeyError(duplicateKeys) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this) || this;
+        _this.duplicateKeys = duplicateKeys;
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        _this.message = "Duplicate keys found\n".concat(duplicateKeys.join("\n"));
+        if (Error.captureStackTrace !== undefined) {
+            Error.captureStackTrace(_this, _this.constructor);
+        }
+        return _this;
+    }
+    return IocDuplicateKeyError;
+}(Error));
+exports.IocDuplicateKeyError = IocDuplicateKeyError;

package/lib/global.d.ts

@@ -0,0 +1,9 @@
+import { Container } from "inversify";
+declare global {
+    namespace NodeJS {
+        interface Global {
+            _rocketmakers_ioc: Container;
+        }
+    }
+}
+export declare function getGlobalContainer(): Container;

package/lib/global.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGlobalContainer = void 0;
+/* eslint-disable no-underscore-dangle */
+/* eslint-disable @typescript-eslint/no-namespace */
+var inversify_1 = require("inversify");
+function getGlobalContainer() {
+    if (!global._rocketmakers_ioc) {
+        global._rocketmakers_ioc = new inversify_1.Container();
+    }
+    return global._rocketmakers_ioc;
+}
+exports.getGlobalContainer = getGlobalContainer;