@electron-tools/ioc - npm Package Compare versions

Comparing version 1.0.6 to 1.0.7

dist/cjs/index.js

@@ -1,8 +0,52 @@
-'use strict';
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __accessCheck = (obj, member, msg) => {
+  if (!member.has(obj))
+    throw TypeError("Cannot " + msg);
+};
+var __privateGet = (obj, member, getter) => {
+  __accessCheck(obj, member, "read from private field");
+  return getter ? getter.call(obj) : member.get(obj);
+};
+var __privateAdd = (obj, member, value) => {
+  if (member.has(obj))
+    throw TypeError("Cannot add the same private member more than once");
+  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+};
+var __privateMethod = (obj, member, method) => {
+  __accessCheck(obj, member, "access private method");
+  return method;
+};
 
-Object.defineProperty(exports, '__esModule', { value: true });
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  INSTANTIATION_SERVICE_ID: () => INSTANTIATION_SERVICE_ID,
+  default: () => InstantiationService,
+  inject: () => inject,
+  register: () => register,
+  service: () => service
+});
+module.exports = __toCommonJS(src_exports);
 
-require('reflect-metadata');
+// src/instantiation.ts
+var import_reflect_metadata = require("reflect-metadata");
 
-class Node {
+// src/graph.ts
+var Node = class {
   constructor(data) {
@@ -13,4 +57,4 @@ this.incoming = /* @__PURE__ */ new Map();
   }
-}
-class Graph {
+};
+var Graph = class {
   constructor(_hashFn) {
@@ -89,25 +133,9 @@ this._hashFn = _hashFn;
   }
-}
+};
 
-var __accessCheck = (obj, member, msg) => {
-  if (!member.has(obj))
-    throw TypeError("Cannot " + msg);
-};
-var __privateGet = (obj, member, getter) => {
-  __accessCheck(obj, member, "read from private field");
-  return getter ? getter.call(obj) : member.get(obj);
-};
-var __privateAdd = (obj, member, value) => {
-  if (member.has(obj))
-    throw TypeError("Cannot add the same private member more than once");
-  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-};
-var __privateMethod = (obj, member, method) => {
-  __accessCheck(obj, member, "access private method");
-  return method;
-};
+// src/instantiation.ts
+var serviceCtorStore = /* @__PURE__ */ new Map();
+var INSTANTIATION_SERVICE_ID = Symbol.for("instantiationService");
 var _serviceStore, _createAndCacheService, createAndCacheService_fn, _getServiceDependencies, getServiceDependencies_fn, _getServiceCtorById, getServiceCtorById_fn;
-const serviceCtorStore = /* @__PURE__ */ new Map();
-const INSTANTIATION_SERVICE_ID = Symbol.for("instantiationService");
-class InstantiationService {
+var InstantiationService = class {
   constructor() {
@@ -136,3 +164,3 @@ __privateAdd(this, _createAndCacheService);
   }
-}
+};
 _serviceStore = new WeakMap();
@@ -191,3 +219,3 @@ _createAndCacheService = new WeakSet();
 };
-class CyclicDependencyError extends Error {
+var CyclicDependencyError = class extends Error {
   constructor(graph) {
@@ -199,4 +227,4 @@ var _a;
   }
-}
-const dependencyMetadataKey = Symbol.for("$di$dependency");
+};
+var dependencyMetadataKey = Symbol.for("$di$dependency");
 function register(id, Ctor) {
@@ -238,8 +266,2 @@ if (serviceCtorStore.has(id))
 }
-
-exports.INSTANTIATION_SERVICE_ID = INSTANTIATION_SERVICE_ID;
-exports["default"] = InstantiationService;
-exports.inject = inject;
-exports.register = register;
-exports.service = service;
 //# sourceMappingURL=index.js.map

dist/esm/index.js

@@ -1,4 +0,24 @@
-import 'reflect-metadata';
+var __accessCheck = (obj, member, msg) => {
+  if (!member.has(obj))
+    throw TypeError("Cannot " + msg);
+};
+var __privateGet = (obj, member, getter) => {
+  __accessCheck(obj, member, "read from private field");
+  return getter ? getter.call(obj) : member.get(obj);
+};
+var __privateAdd = (obj, member, value) => {
+  if (member.has(obj))
+    throw TypeError("Cannot add the same private member more than once");
+  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+};
+var __privateMethod = (obj, member, method) => {
+  __accessCheck(obj, member, "access private method");
+  return method;
+};
 
-class Node {
+// src/instantiation.ts
+import "reflect-metadata";
+
+// src/graph.ts
+var Node = class {
   constructor(data) {
@@ -9,4 +29,4 @@ this.incoming = /* @__PURE__ */ new Map();
   }
-}
-class Graph {
+};
+var Graph = class {
   constructor(_hashFn) {
@@ -85,25 +105,9 @@ this._hashFn = _hashFn;
   }
-}
+};
 
-var __accessCheck = (obj, member, msg) => {
-  if (!member.has(obj))
-    throw TypeError("Cannot " + msg);
-};
-var __privateGet = (obj, member, getter) => {
-  __accessCheck(obj, member, "read from private field");
-  return getter ? getter.call(obj) : member.get(obj);
-};
-var __privateAdd = (obj, member, value) => {
-  if (member.has(obj))
-    throw TypeError("Cannot add the same private member more than once");
-  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-};
-var __privateMethod = (obj, member, method) => {
-  __accessCheck(obj, member, "access private method");
-  return method;
-};
+// src/instantiation.ts
+var serviceCtorStore = /* @__PURE__ */ new Map();
+var INSTANTIATION_SERVICE_ID = Symbol.for("instantiationService");
 var _serviceStore, _createAndCacheService, createAndCacheService_fn, _getServiceDependencies, getServiceDependencies_fn, _getServiceCtorById, getServiceCtorById_fn;
-const serviceCtorStore = /* @__PURE__ */ new Map();
-const INSTANTIATION_SERVICE_ID = Symbol.for("instantiationService");
-class InstantiationService {
+var InstantiationService = class {
   constructor() {
@@ -132,3 +136,3 @@ __privateAdd(this, _createAndCacheService);
   }
-}
+};
 _serviceStore = new WeakMap();
@@ -187,3 +191,3 @@ _createAndCacheService = new WeakSet();
 };
-class CyclicDependencyError extends Error {
+var CyclicDependencyError = class extends Error {
   constructor(graph) {
@@ -195,4 +199,4 @@ var _a;
   }
-}
-const dependencyMetadataKey = Symbol.for("$di$dependency");
+};
+var dependencyMetadataKey = Symbol.for("$di$dependency");
 function register(id, Ctor) {
@@ -234,4 +238,9 @@ if (serviceCtorStore.has(id))
 }
-
-export { INSTANTIATION_SERVICE_ID, InstantiationService as default, inject, register, service };
+export {
+  INSTANTIATION_SERVICE_ID,
+  InstantiationService as default,
+  inject,
+  register,
+  service
+};
 //# sourceMappingURL=index.js.map

dist/types/index.d.ts

@@ -1,24 +0,25 @@
-// Generated by dts-bundle-generator v6.10.0
+export declare function inject(id: ServiceUniqueId): (Ctor: ServiceCtor, parameterKey: string, parameterIndex: number) => void;
 
-export declare type ServiceUniqueId = string | Symbol;
 export declare const INSTANTIATION_SERVICE_ID: unique symbol;
+
 declare class InstantiationService {
-	#private;
-	get services(): Map<ServiceUniqueId, unknown>;
-	constructor();
-	init(): void;
-	registerService(id: ServiceUniqueId, service: any): void;
-	getService<S = any>(id: ServiceUniqueId): S;
+    #private;
+    get services(): Map<ServiceUniqueId, unknown>;
+    constructor();
+    init(): void;
+    registerService(id: ServiceUniqueId, service: any): void;
+    getService<S = any>(id: ServiceUniqueId): S;
 }
-export interface ServiceCtor<T = any, A extends any[] = any[]> {
-	new (...args: A): T;
-}
+export default InstantiationService;
+
 export declare function register(id: ServiceUniqueId, Ctor: ServiceCtor): void;
+
 export declare function service(id?: ServiceUniqueId): (Ctor: ServiceCtor) => void;
-export declare function inject(id: ServiceUniqueId): (Ctor: ServiceCtor, parameterKey: string, parameterIndex: number) => void;
 
-export {
-	InstantiationService as default,
-};
+declare interface ServiceCtor<T = any, A extends any[] = any[]> {
+    new (...args: A): T;
+}
 
-export {};
+declare type ServiceUniqueId = string | Symbol;
+
+export { }

package.json

 {
   "name": "@electron-tools/ioc",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "DI implement of IOC",
@@ -14,3 +14,2 @@ "main": "dist/cjs/index.js",
   "dependencies": {
-    "dts-bundle-generator": "^6.10.0",
     "reflect-metadata": "^0.1.13",
@@ -20,8 +19,10 @@ "tslib": "^2.4.0"
   "devDependencies": {
-    "@electron-tools/libbuilder": "0.0.0"
+    "eslibc": "0.0.3"
   },
   "scripts": {
-    "dev": "libbuilder watch",
-    "build": "libbuilder build"
-  }
+    "clean": "eslibc clean",
+    "dev": "eslibc dev",
+    "build": "eslibc clean && eslibc build"
+  },
+  "readme": "# Introduction\n\nA simple DI implement of IOC using typescript. inspired by vscode IOC implement.\n\n# Installation\n\n```bash\n# install by npm\n$npm install @electron-tools/ioc\n# install by pnpm\n$pnpm add @electron-tools/ioc\n# install by yarn\n$yarn add @electron-tools/ioc\n```\n\n# Usage\n\n1. enable `experimentalDecorators` option in your tsconfig.json.\n\n2. register your service by `service` decorator exported from this package.\n\n```typescript\n// src/serviceA.ts\nimport { service } from '@electron-tools/ioc';\n\n@service('serviceA') // register ServiceA with unique id 'serviceA' using service decorator exported by this package.\nclass ServiceA {\n  // ....\n}\n```\n\n3. use `inject` decorator inject your service to another service.\n\n```typescript\n// src/serviceB.ts\nimport { service, inject } from '@electron-tools/ioc';\n\n@service('serviceB') // also register ServiceB with unique id 'serviceB'\nclass ServiceB {\n  constructor(\n    @inject('serviceA') // inject serviceA to serviceB, the only args passed to inject is the service unique id.\n    readonly serviceA: ServiceA,\n  ) {}\n}\n```\n\n4. import all your services and crate a IOC instance in your entry file.\n\n```typescript\n// src/index.ts\nimport IOC from '@electron-tools/ioc';\nimport './serviceA.ts';\nimport './serviceB.ts';\n\nconst ioc = new IOC();\nconst serviceA = ioc.getService('serviceA');\nconst serviceB = ioc.getService('serviceB');\nconsole.log(serviceA instanceof ServiceA); // true\nconsole.log(serviceB instanceof ServiceB); // true\nconsole.log(serviceA === serviceB.a); // true\n```\n\n# Features\n\n1. Instance all service in one place.  \n   by default. service only be instanced when needed. in the case above. if you only call `ioc.getService('serviceA')`, serviceB will not be instance, cause serviceB is not dependencied by any service, but if you only call `ioc.getService('serviceB')`, serviceA will be instance, and inject into serviceB. this maybe not what you want. you can init all services in one place by call `ioc.init()`.\n\n```typescript\nconst ioc = new IOC();\nioc.init(); // this statement will instance all services registered.\n```\n\n2. Cycle reference.\n   if there are some cycle reference between your services. such as serviceA dependencied by serviceB, serviceB also dependencied by serviceA, you can resolve this issue by get service later instead of constructor of service.\n\n```typescript\n// src/serviceA.ts\nimport IOC, { service, inject, INSTANTIATION_SERVICE_ID } from '@electron-tools/ioc';\n\n@service('serviceA') // register ServiceA with unique id 'serviceA' using service decorator exported by ioc.\nclass ServiceA {\n  constructor(\n    @inject(INSTANTIATION_SERVICE_ID) readonly ioc: IOC, // ioc itself is also a service can be injected.\n  ) {}\n\n  someMethod() {\n    // dynamic get serviceB by ioc#getService API. then you can do anything what serviceB can do.\n    const serviceB = this.ioc.getService('serviceB');\n    serviceB.xxx;\n  }\n}\n```\n"
 }

No alert changes

Improved metrics

Dependency count

2

decreased by-33.33%

Lines of code

512

increased by6%

Worsened metrics

Total package byte prevSize

50089

decreased by-10.07%

Dependency changes

• - Removeddts-bundle-generator@^6.10.0

• - Removedansi-regex@5.0.1(transitive)

• - Removedansi-styles@4.3.0(transitive)

• - Removedcliui@8.0.1(transitive)

• - Removedcolor-convert@2.0.1(transitive)

• - Removedcolor-name@1.1.4(transitive)

• - Removeddts-bundle-generator@6.13.0(transitive)

• - Removedemoji-regex@8.0.0(transitive)

• - Removedescalade@3.2.0(transitive)

• - Removedget-caller-file@2.0.5(transitive)

• - Removedis-fullwidth-code-point@3.0.0(transitive)

• - Removedrequire-directory@2.1.1(transitive)

• - Removedstring-width@4.2.3(transitive)

• - Removedstrip-ansi@6.0.1(transitive)

• - Removedtypescript@5.7.3(transitive)

• - Removedwrap-ansi@7.0.0(transitive)

• - Removedy18n@5.0.8(transitive)

• - Removedyargs@17.7.2(transitive)

• - Removedyargs-parser@21.1.1(transitive)