@sima-land/isomorph 11.0.0-alpha.36 → 11.0.0-alpha.38

package/package.json

@@ -1,24 +1,190 @@
 {
   "name": "@sima-land/isomorph",
-  "version": "11.0.0-alpha.36",
+  "version": "11.0.0-alpha.38",
   "description": "Tiny framework for fast start frontend microservices",
   "author": "www.sima-land.ru team",
   "license": "Apache-2.0",
   "engines": {
     "node": ">=16.15.1"
   },
+  "files": [
+    "dist",
+    "src",
+    "README.md"
+  ],
+  "exports": {
+    "./cache": {
+      "types": "./dist/types/cache/index.d.ts",
+      "require": "./dist/cjs/cache/index.js",
+      "import": "./dist/esm/cache/index.js",
+      "default": "./dist/esm/cache/index.js"
+    },
+    "./config": {
+      "types": "./dist/types/config/index.d.ts",
+      "require": "./dist/cjs/config/index.js",
+      "import": "./dist/esm/config/index.js",
+      "default": "./dist/esm/config/index.js"
+    },
+    "./di": {
+      "types": "./dist/types/di/index.d.ts",
+      "require": "./dist/cjs/di/index.js",
+      "import": "./dist/esm/di/index.js",
+      "default": "./dist/esm/di/index.js"
+    },
+    "./http": {
+      "types": "./dist/types/http/index.d.ts",
+      "require": "./dist/cjs/http/index.js",
+      "import": "./dist/esm/http/index.js",
+      "default": "./dist/esm/http/index.js"
+    },
+    "./log": {
+      "types": "./dist/types/log/index.d.ts",
+      "require": "./dist/cjs/log/index.js",
+      "import": "./dist/esm/log/index.js",
+      "default": "./dist/esm/log/index.js"
+    },
+    "./tokens": {
+      "types": "./dist/types/tokens.d.ts",
+      "require": "./dist/cjs/tokens.js",
+      "import": "./dist/esm/tokens.js",
+      "default": "./dist/esm/tokens.js"
+    },
+    "./preset/isomorphic": {
+      "types": "./dist/types/preset/isomorphic/index.d.ts",
+      "require": "./dist/cjs/preset/isomorphic/index.js",
+      "import": "./dist/esm/preset/isomorphic/index.js",
+      "default": "./dist/esm/preset/isomorphic/index.js"
+    },
+    "./preset/isomorphic/providers": {
+      "types": "./dist/types/preset/isomorphic/providers/index.d.ts",
+      "require": "./dist/cjs/preset/isomorphic/providers/index.js",
+      "import": "./dist/esm/preset/isomorphic/providers/index.js",
+      "default": "./dist/esm/preset/isomorphic/providers/index.js"
+    },
+    "./preset/isomorphic/utils": {
+      "types": "./dist/types/preset/isomorphic/utils/index.d.ts",
+      "require": "./dist/cjs/preset/isomorphic/utils/index.js",
+      "import": "./dist/esm/preset/isomorphic/utils/index.js",
+      "default": "./dist/esm/preset/isomorphic/utils/index.js"
+    },
+    "./preset/web": {
+      "types": "./dist/types/preset/web/index.d.ts",
+      "require": "./dist/cjs/preset/web/index.js",
+      "import": "./dist/esm/preset/web/index.js",
+      "default": "./dist/esm/preset/web/index.js"
+    },
+    "./preset/web/providers": {
+      "types": "./dist/types/preset/web/providers/index.d.ts",
+      "require": "./dist/cjs/preset/web/providers/index.js",
+      "import": "./dist/esm/preset/web/providers/index.js",
+      "default": "./dist/esm/preset/web/providers/index.js"
+    },
+    "./preset/node": {
+      "types": "./dist/types/preset/node/index.d.ts",
+      "require": "./dist/cjs/preset/node/index.js",
+      "import": "./dist/esm/preset/node/index.js",
+      "default": "./dist/esm/preset/node/index.js"
+    },
+    "./preset/node/node/providers": {
+      "types": "./dist/types/preset/node/node/providers/index.d.ts",
+      "require": "./dist/cjs/preset/node/node/providers/index.js",
+      "import": "./dist/esm/preset/node/node/providers/index.js",
+      "default": "./dist/esm/preset/node/node/providers/index.js"
+    },
+    "./preset/node/node/utils": {
+      "types": "./dist/types/preset/node/node/utils/index.d.ts",
+      "require": "./dist/cjs/preset/node/node/utils/index.js",
+      "import": "./dist/esm/preset/node/node/utils/index.js",
+      "default": "./dist/esm/preset/node/node/utils/index.js"
+    },
+    "./preset/node/handler/providers": {
+      "types": "./dist/types/preset/node/handler/providers/index.d.ts",
+      "require": "./dist/cjs/preset/node/handler/providers/index.js",
+      "import": "./dist/esm/preset/node/handler/providers/index.js",
+      "default": "./dist/esm/preset/node/handler/providers/index.js"
+    },
+    "./preset/node/handler/utils": {
+      "types": "./dist/types/preset/node/handler/utils/index.d.ts",
+      "require": "./dist/cjs/preset/node/handler/utils/index.js",
+      "import": "./dist/esm/preset/node/handler/utils/index.js",
+      "default": "./dist/esm/preset/node/handler/utils/index.js"
+    },
+    "./utils": {
+      "types": "./dist/types/utils/index.d.ts",
+      "require": "./dist/cjs/utils/index.js",
+      "import": "./dist/esm/utils/index.js",
+      "default": "./dist/esm/utils/index.js"
+    },
+    "./utils/axios": {
+      "types": "./dist/types/utils/axios/index.d.ts",
+      "require": "./dist/cjs/utils/axios/index.js",
+      "import": "./dist/esm/utils/axios/index.js",
+      "default": "./dist/esm/utils/axios/index.js"
+    },
+    "./utils/express": {
+      "types": "./dist/types/utils/express/index.d.ts",
+      "require": "./dist/cjs/utils/express/index.js",
+      "import": "./dist/esm/utils/express/index.js",
+      "default": "./dist/esm/utils/express/index.js"
+    },
+    "./utils/react": {
+      "types": "./dist/types/utils/react/index.d.ts",
+      "require": "./dist/cjs/utils/react/index.js",
+      "import": "./dist/esm/utils/react/index.js",
+      "default": "./dist/esm/utils/react/index.js"
+    },
+    "./utils/redux": {
+      "types": "./dist/types/utils/redux/index.d.ts",
+      "require": "./dist/cjs/utils/redux/index.js",
+      "import": "./dist/esm/utils/redux/index.js",
+      "default": "./dist/esm/utils/redux/index.js"
+    },
+    "./utils/redux-saga": {
+      "types": "./dist/types/utils/redux-saga/index.d.ts",
+      "require": "./dist/cjs/utils/redux-saga/index.js",
+      "import": "./dist/esm/utils/redux-saga/index.js",
+      "default": "./dist/esm/utils/redux-saga/index.js"
+    },
+    "./utils/ssr": {
+      "types": "./dist/types/utils/ssr/index.d.ts",
+      "require": "./dist/cjs/utils/ssr/index.js",
+      "import": "./dist/esm/utils/ssr/index.js",
+      "default": "./dist/esm/utils/ssr/index.js"
+    },
+    "./utils/web/analytics": {
+      "types": "./dist/types/utils/web/analytics/index.d.ts",
+      "require": "./dist/cjs/utils/web/analytics/index.js",
+      "import": "./dist/esm/utils/web/analytics/index.js",
+      "default": "./dist/esm/utils/web/analytics/index.js"
+    },
+    "./utils/webpack": {
+      "types": "./dist/types/utils/webpack/index.d.ts",
+      "require": "./dist/cjs/utils/webpack/index.js",
+      "import": "./dist/esm/utils/webpack/index.js",
+      "default": "./dist/esm/utils/webpack/index.js"
+    }
+  },
+  "typesVersions": {
+    ">=4.2": {
+      "*": [
+        "dist/types/*"
+      ]
+    }
+  },
   "scripts": {
     "type-check": "tsc -p . --noEmit",
     "build:before": "rm -rf dist",
-    "build:main": "tsc --project tsconfig.build.json",
-    "build:after": "cp package.json dist/package.json && cd dist && npm pkg delete scripts.prepare",
-    "build": "npm run build:before && npm run build:main && npm run build:after",
+    "build:esm": "babel src --config-file ./babel.config.esm.js -d dist/esm --source-maps --extensions '.ts,.tsx' --ignore='**/__test__/**/*' --ignore='**/*.d.ts' && echo '{ \"type\": \"module\" }' > dist/esm/package.json",
+    "build:cjs": "babel src --config-file ./babel.config.cjs.js -d dist/cjs --source-maps --extensions '.ts,.tsx' --ignore='**/__test__/**/*' --ignore='**/*.d.ts' && echo '{ \"type\": \"commonjs\" }' > dist/cjs/package.json",
+    "build:types": "tsc --project tsconfig.types.json",
+    "post-build-esm": "node scripts/post-build-esm.mjs",
+    "build": "npm run build:before && npm run build:esm && npm run build:cjs && npm run build:types && npm run post-build-esm",
     "lint": "eslint --cache ./src --ext .js,.jsx,.ts,.tsx",
-    "test": "jest",
-    "test:coverage": "jest --clearCache && jest --coverage"
+    "test": "jest"
   },
   "devDependencies": {
-    "@babel/core": "^7.22.5",
+    "@babel/cli": "^7.23.0",
+    "@babel/core": "^7.23.0",
     "@babel/preset-env": "^7.22.5",
     "@babel/preset-react": "^7.22.5",
     "@babel/preset-typescript": "^7.22.5",
@@ -27,7 +193,6 @@
     "@types/express": "^4.17.17",
     "@types/jest": "^28.1.7",
     "@types/jsesc": "^3.0.1",
-    "@types/lodash": "^4.14.194",
     "@types/react": "^18.2.14",
     "@types/react-dom": "^18.2.6",
     "@types/webpack": "^5.28.1",
@@ -65,7 +230,6 @@
   "peerDependencies": {
     "@reduxjs/toolkit": "^1.9.5",
     "axios": "^1.4.0",
-    "lodash": "^4.17.21",
     "react": "^17.0 || ^18.0",
     "react-dom": "^17.0 || ^18.0",
     "react-redux": "^8.0.5",

package/src/cache/index.ts

@@ -0,0 +1 @@
+export type { Cache } from './types';

package/src/cache/types.ts

@@ -0,0 +1,34 @@
+/**
+ * Простейший интерфейс кэша.
+ * @todo Рассмотреть web-стандарт CacheStorage.
+ */
+export interface Cache {
+  /**
+   * Возвращает значение из кэша по ключу.
+   * @param key Ключ.
+   * @return Значение.
+   */
+  get: (key: string) => unknown;
+
+  /**
+   * Записывает значение в кэш по ключу.
+   * @param key Ключ.
+   */
+  set: (key: string, value: any) => void;
+
+  /**
+   * Удаляет значение из кэша по ключу.
+   * @param key Ключ.
+   */
+  delete: (key: string) => void;
+
+  /**
+   * Полностью очищает кэш.
+   */
+  clear: () => void;
+
+  /**
+   * Возвращает `true` в случае, если значение под переданным ключом присутствует в кэше, `false` в противном случае.
+   */
+  has: (key: string) => boolean;
+}

package/src/config/base.ts

@@ -0,0 +1,18 @@
+import type { ConfigSource, BaseConfig } from './types';
+
+/**
+ * Возвращает новую базовую конфигурацию.
+ * @param source Источник конфигурации.
+ * @return Базовая конфигурация.
+ */
+export function createBaseConfig(source: ConfigSource): BaseConfig {
+  const env = source.require('NODE_ENV');
+  const appName = source.require('APP_NAME');
+  const appVersion = source.require('APP_VERSION');
+
+  return {
+    env,
+    appName,
+    appVersion,
+  };
+}

package/src/config/index.ts

@@ -0,0 +1,3 @@
+export type { ConfigSource, BaseConfig } from './types';
+export { createConfigSource } from './source';
+export { createBaseConfig } from './base';

package/src/config/source.ts

@@ -0,0 +1,23 @@
+import type { ConfigSource, Dictionary } from './types';
+import { Env } from '@humanwhocodes/env';
+
+declare const __ISOMORPH_ENV__: unknown;
+
+/**
+ * Возвращает новый источник конфигурации.
+ * @param dictionary Опции.
+ * @return Источник.
+ */
+export function createConfigSource(dictionary: Dictionary): ConfigSource {
+  const source: Dictionary = {};
+
+  // берем все переменные из предоставленной среды
+  Object.assign(source, dictionary);
+
+  // докидываем зашиваемые переменные окружения
+  if (typeof __ISOMORPH_ENV__ !== 'undefined') {
+    Object.assign(source, __ISOMORPH_ENV__);
+  }
+
+  return new Env(source);
+}

package/src/config/types.ts

@@ -0,0 +1,25 @@
+import type { Env } from '@humanwhocodes/env';
+
+/** Источник конфигурации. */
+export type ConfigSource = Env;
+
+/**
+ * Базовая информация о приложении, необходимая в большинстве мест.
+ */
+export interface BaseConfig {
+  /** Строка, характеризующая среду выполнения, например "production". */
+  env: string;
+
+  /** Имя приложения. */
+  appName: string;
+
+  /** Версия приложения. */
+  appVersion: string;
+}
+
+/**
+ * Словарь.
+ */
+export interface Dictionary {
+  readonly [key: string]: string | undefined;
+}

package/src/di/__test__/application.test.ts

@@ -0,0 +1,258 @@
+import { createApplication, CURRENT_APP } from '../application';
+import { AlreadyBoundError, CircularDependencyError } from '../errors';
+import { createPreset } from '../preset';
+import { createToken } from '../token';
+
+describe('Application', () => {
+  it('should throw exception properly when component not found', () => {
+    const TOKEN = {
+      config: createToken<any>('config'),
+      server: createToken<any>('server'),
+      client: createToken<any>('client'),
+      logger: createToken<any>('logger'),
+    } as const;
+
+    const app = createApplication();
+    const spy = jest.fn();
+
+    app.bind(TOKEN.config).toProvider(() => {
+      spy();
+      return { type: 'config' };
+    });
+
+    app.bind(TOKEN.logger).toProvider(resolve => {
+      const config = resolve(TOKEN.config);
+      return { type: 'logger', config };
+    });
+
+    app.bind(TOKEN.client).toProvider(resolve => {
+      const logger = resolve(TOKEN.logger);
+      return { type: 'client', logger };
+    });
+
+    expect(() => {
+      app.get(TOKEN.server);
+    }).toThrow('Nothing bound to Token(server)');
+  });
+
+  it('should bound itself to known token', () => {
+    const app = createApplication();
+
+    expect(app.get(CURRENT_APP)).toBe(app);
+  });
+
+  it('bind() should return binding with .toValue() method', () => {
+    const token = createToken<any>('foo');
+    const app = createApplication();
+    const component = { count: 10 };
+
+    app.bind(token).toValue(component);
+
+    expect(app.get(token)).toBe(component);
+  });
+
+  it('should prevent second binding to same token', () => {
+    const token = createToken<number>('age');
+    const app = createApplication();
+
+    expect(() => {
+      app.bind(token).toValue(23);
+    }).not.toThrow();
+
+    expect(() => {
+      app.bind(token).toValue(34);
+    }).toThrow(new AlreadyBoundError(token, 'Application'));
+  });
+
+  it('should handle presets', () => {
+    const TOKEN = {
+      admin: createToken<{ role: 'admin'; rule: { for: string } }>('rules'),
+      rules: createToken<Array<{ for: string }>>('admin'),
+    };
+
+    const adminPreset = createPreset([
+      [
+        TOKEN.admin,
+        resolve => {
+          const rules = resolve(TOKEN.rules);
+
+          return {
+            role: 'admin',
+            rule: rules.find(r => r.for === 'admin'),
+          };
+        },
+      ],
+    ]);
+
+    const rulesPreset = createPreset([
+      [TOKEN.rules, () => [{ for: 'admin' }, { for: 'user' }, { for: 'guest' }]],
+    ]);
+
+    const app = createApplication();
+
+    app.preset(adminPreset);
+    app.preset(rulesPreset);
+
+    expect(app.get(TOKEN.admin)).toEqual({
+      role: 'admin',
+      rule: { for: 'admin' },
+    });
+  });
+
+  it('should handle parent app attach', () => {
+    const TOKEN = {
+      config: createToken<{ port: number }>('config'),
+      server: createToken<{ start: VoidFunction }>('server'),
+    };
+
+    const parentApp = createApplication();
+    const childApp = createApplication();
+    const spy = jest.fn();
+
+    childApp.attach(parentApp);
+
+    childApp.bind(TOKEN.server).toProvider(resolve => {
+      const config = resolve(TOKEN.config);
+
+      return {
+        start() {
+          spy(config.port);
+        },
+      };
+    });
+
+    parentApp.bind(TOKEN.config).toValue({ port: 1200 });
+
+    const server = childApp.get(TOKEN.server);
+
+    expect(spy).toBeCalledTimes(0);
+    server.start();
+    expect(spy).toBeCalledTimes(1);
+    expect(spy).toBeCalledWith(1200);
+  });
+
+  it('should prevent reattach', () => {
+    const parentApp = createApplication();
+    const childApp = createApplication();
+    const otherApp = createApplication();
+
+    childApp.attach(parentApp);
+
+    // other app reattach
+    expect(() => {
+      childApp.attach(otherApp);
+    }).toThrow(Error('Cannot reattach application'));
+
+    // same app reattach
+    expect(() => {
+      childApp.attach(parentApp);
+    }).toThrow(Error('Cannot reattach application'));
+  });
+
+  it('invoke() should works properly', () => {
+    const TOKEN = {
+      sword: createToken<{ sharpness: number }>('sword'),
+      knight: createToken<{ power: number; attack: () => number }>('knight'),
+    } as const;
+
+    const app = createApplication();
+
+    app.bind(TOKEN.knight).toProvider(resolve => {
+      const weapon = resolve(TOKEN.sword);
+
+      return {
+        power: 12,
+
+        attack() {
+          return weapon.sharpness + this.power;
+        },
+      };
+    });
+
+    app.bind(TOKEN.sword).toValue({ sharpness: 5 });
+
+    const spy = jest.fn();
+
+    app.invoke([TOKEN.knight], knight => {
+      spy(knight.attack());
+    });
+
+    expect(spy).toBeCalledTimes(1);
+    expect(spy).toBeCalledWith(17);
+  });
+
+  it('should properly handle circular dependencies', () => {
+    const TOKEN = {
+      config: createToken<any>('config'),
+      logger: createToken<any>('logger'),
+    } as const;
+
+    const app = createApplication();
+
+    app.bind(TOKEN.config).toProvider(resolve => {
+      const logger = resolve(TOKEN.logger);
+
+      logger.info('Config created');
+
+      return {
+        appName: 'test app',
+      };
+    });
+
+    app.bind(TOKEN.logger).toProvider(resolve => {
+      const config = resolve(TOKEN.config);
+
+      return {
+        info(message: any) {
+          // eslint-disable-next-line no-console
+          console.log(config.appName, message);
+        },
+      };
+    });
+
+    expect(() => app.get(TOKEN.config)).toThrow(
+      new CircularDependencyError([TOKEN.config, TOKEN.logger, TOKEN.config], 'Application'),
+    );
+  });
+
+  it('should throw exception properly when component not found in parent app too', () => {
+    const TOKEN = {
+      config: createToken<any>('config'),
+      client: createToken<any>('client'),
+      logger: createToken<any>('logger'),
+    } as const;
+
+    const parent = createApplication();
+    const child = createApplication();
+    child.attach(parent);
+
+    child.bind(TOKEN.logger).toProvider(resolve => {
+      const config = resolve(TOKEN.config);
+      return { type: 'logger', config };
+    });
+
+    child.bind(TOKEN.client).toProvider(resolve => {
+      const logger = resolve(TOKEN.logger);
+      return { type: 'client', logger };
+    });
+
+    expect(() => {
+      child.get(TOKEN.client);
+    }).toThrow('Nothing bound to Token(config)');
+  });
+
+  it('should get component from cache', () => {
+    const app = createApplication();
+    const token = createToken<{ id: number }>('foo');
+
+    const value = { id: 123 };
+    app.bind(token).toValue(value);
+
+    const first = app.get(token);
+    const second = app.get(token);
+
+    expect(Object.is(value, first)).toBe(true);
+    expect(Object.is(value, second)).toBe(true);
+    expect(Object.is(first, second)).toBe(true);
+  });
+});

package/src/di/__test__/container.test.ts

@@ -0,0 +1,103 @@
+import { createContainer } from '../container';
+import { AlreadyBoundError, CircularDependencyError, NothingBoundError } from '../errors';
+import { createToken } from '../token';
+
+describe('Container', () => {
+  it('should prevent second binding to same token', () => {
+    const token = createToken<number>('age');
+    const container = createContainer();
+
+    expect(() => {
+      container.set(token, () => 23);
+    }).not.toThrow(new AlreadyBoundError(token));
+
+    expect(() => {
+      container.set(token, () => 23);
+    }).toThrow(new AlreadyBoundError(token));
+  });
+
+  it('should throw type error when provider is not a function', () => {
+    const token = createToken<number>('answer');
+    const container = createContainer();
+
+    container.set(token, 42 as any);
+
+    expect(() => {
+      container.get(token);
+    }).toThrow(new Error('Provider is not a function'));
+  });
+
+  it('should properly get component from cache', () => {
+    const token = createToken<{ id: number; name: string }>('user');
+    const container = createContainer();
+
+    container.set(token, () => ({
+      id: 1,
+      name: 'John',
+    }));
+
+    const user1 = container.get(token);
+    const user2 = container.get(token);
+
+    expect(user1).toBe(user2);
+  });
+
+  it('should provide resolve', () => {
+    const TOKEN = {
+      foo: createToken<number>('foo'),
+      bar: createToken<string>('bar'),
+    } as const;
+
+    const container = createContainer();
+
+    container.set(TOKEN.foo, () => 123.45);
+
+    container.set(TOKEN.bar, resolve => {
+      const foo = resolve(TOKEN.foo);
+      return foo.toString();
+    });
+
+    expect(container.get(TOKEN.bar)).toBe('123.45');
+  });
+
+  it('should handle circular dependencies', () => {
+    const TOKEN = {
+      foo: createToken<number>('foo'),
+      bar: createToken<string>('bar'),
+      baz: createToken<boolean>('baz'),
+    } as const;
+
+    const container = createContainer();
+
+    container.set(TOKEN.foo, resolve => {
+      const baz = resolve(TOKEN.baz);
+
+      return Number(baz);
+    });
+
+    container.set(TOKEN.bar, resolve => {
+      const foo = resolve(TOKEN.foo);
+
+      return String(foo + 11);
+    });
+
+    container.set(TOKEN.baz, resolve => {
+      const bar = resolve(TOKEN.bar);
+
+      return bar.length > 1;
+    });
+
+    expect(() => {
+      container.get(TOKEN.bar);
+    }).toThrow(new CircularDependencyError([TOKEN.bar, TOKEN.foo, TOKEN.baz, TOKEN.bar]));
+  });
+
+  it('should throw error when nothing boud to token', () => {
+    const container = createContainer();
+    const token = createToken('test');
+
+    expect(() => {
+      container.get(token);
+    }).toThrow(new NothingBoundError(token));
+  });
+});