rename core packages: core -> common; di-core -> core

closes #4
just-dandi · Jul 25, 2018 · 6542029 · 6542029
1 parent 02f1554
commit 6542029
Show file tree

Hide file tree

Showing 244 changed files with 698 additions and 707 deletions.
diff --git a/README.md b/README.md
@@ -25,16 +25,16 @@ allow developers to use only the features they require.
 
 # Core Modules
 
-* **[@dandi/core](./core)** 🕸 - Core types and utilities
+* **[@dandi/common](./common)** 🕸 - Common types and utilities
+* **[@dandi/core](./core)** - Dependency Injection
 * **[@dandi/data](./data)** - Base types and utilities for working with data services
 * **[@dandi/config](./config)** - Configuration services
-* **[@dandi/di-core](./di-core)** - Dependency Injection
 * **[@dandi/model](./model)** 🕸 - Model decorators
 * **[@dandi/model-validation](./model-validation)** - Model validation utilities
 * **[@dandi/mvc](./mvc)** - MVC decorators and base utilities (not specific to Express)
 
 # 3rd Party Integration Modules
-* **[@dandi/aws-lambda](./aws-lambda-wrap)** Helpers for using `@dandi/di-core` with AWS Lambda
+* **[@dandi/aws-lambda](./aws-lambda-wrap)** Helpers for using `@dandi/di-common` with AWS Lambda
 * **[@dandi/config-aws-ssm](./config-aws-ssm)** - `@dandi/config` client for AWS SSM Parameter Store
 * **[@dandi/data-pg](./data-pg)** - `@dandi/data` client implementations for Postgres
 * **[@dandi/mvc-auth-firebase](./mvc-auth-firebase)** - Google Firebase Authorization service implementation for `@dandi/mvc`

diff --git a/aws-lambda-wrap/README.md b/aws-lambda-wrap/README.md
@@ -68,7 +68,7 @@ Implementations of `HttpResponseInterceptor` can be used to modify
 
 ```typescript
 // my-interceptor.ts
-import { Injectable } from '@dandi/di-core';
+import { Injectable } from '@dandi/core';
 import { HttpResponseInterceptor } from '@dandi/aws-lambda';
 import { APIGatewayProxyResult } from 'aws-lambda';
 

diff --git a/aws-lambda-wrap/npm.link b/aws-lambda-wrap/npm.link
@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
 
+npm link @dandi/common
 npm link @dandi/core
-npm link @dandi/di-core
 npm link @dandi/model-validation
diff --git a/aws-lambda-wrap/package-lock.json b/aws-lambda-wrap/package-lock.json
diff --git a/aws-lambda-wrap/package.json b/aws-lambda-wrap/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@dandi/aws-lambda",
- "version": "1.0.0-alpha.12",
+ "version": "1.0.0-alpha.13",
  "scripts": {},
  "repository": {
  "type": "git",
@@ -13,9 +13,9 @@
  "homepage": "https://github.com/dandi-mvc/dandi#readme",
  "module": "index.js",
  "peerDependencies": {
- "@dandi/core": "1.0.0-alpha.12",
- "@dandi/di-core": "1.0.0-alpha.12",
- "@dandi/model-validation": "1.0.0-alpha.12"
+ "@dandi/common": "1.0.0-alpha.13",
+ "@dandi/core": "1.0.0-alpha.13",
+ "@dandi/model-validation": "1.0.0-alpha.13"
  },
  "dependencies": {
  "aws-lambda": "^0.1.2"

diff --git a/aws-lambda-wrap/src/dandi.aws.lambda.error.ts b/aws-lambda-wrap/src/dandi.aws.lambda.error.ts
@@ -1,4 +1,4 @@
-import { AppError } from '@dandi/core';
+import { AppError } from '@dandi/common';
 
 export class DandiAwsLambdaError extends AppError {
 

diff --git a/aws-lambda-wrap/src/dynamo.stream.event.transformer.ts b/aws-lambda-wrap/src/dynamo.stream.event.transformer.ts
@@ -1,4 +1,4 @@
-import { Injectable } from '@dandi/di-core';
+import { Injectable } from '@dandi/core';
 
 import { DynamoDBRecord, DynamoDBStreamEvent } from 'aws-lambda';
 

diff --git a/aws-lambda-wrap/src/http.event.options.ts b/aws-lambda-wrap/src/http.event.options.ts
@@ -1,5 +1,5 @@
-import { Constructor } from '@dandi/core';
-import { InjectionToken } from '@dandi/di-core';
+import { Constructor } from '@dandi/common';
+import { InjectionToken } from '@dandi/core';
 
 import { localOpinionatedToken } from './local.token';
 

diff --git a/aws-lambda-wrap/src/http.event.transformer.spec.ts b/aws-lambda-wrap/src/http.event.transformer.spec.ts
@@ -1,4 +1,4 @@
-import { stubProvider, testHarness } from '@dandi/di-core-testing';
+import { stubProvider, testHarness } from '@dandi/core-testing';
 import { DecoratorModelValidator, ModelValidator } from '@dandi/model-validation';
 
 import { APIGatewayProxyEvent, Context } from 'aws-lambda';

diff --git a/aws-lambda-wrap/src/http.event.transformer.ts b/aws-lambda-wrap/src/http.event.transformer.ts
@@ -1,4 +1,4 @@
-import { Inject, Injectable, Optional } from '@dandi/di-core';
+import { Inject, Injectable, Optional } from '@dandi/core';
 import { ModelValidator } from '@dandi/model-validation';
 
 import { APIGatewayProxyEvent, APIGatewayEventRequestContext, Context } from 'aws-lambda';

diff --git a/aws-lambda-wrap/src/http.handler.ts b/aws-lambda-wrap/src/http.handler.ts
@@ -1,6 +1,6 @@
 // /* eslint no-magic-numbers: ['error', { 'ignore': [200,500] }] */
 //
-// import { ErrorUtil } from '@dandi/core';
+// import { ErrorUtil } from '@dandi/common';
 //
 // import {
 // APIGatewayEventRequestContext,

diff --git a/aws-lambda-wrap/src/http.responder.spec.ts b/aws-lambda-wrap/src/http.responder.spec.ts
@@ -1,4 +1,4 @@
-import { stubProvider, testHarness } from '@dandi/di-core-testing';
+import { stubProvider, testHarness } from '@dandi/core-testing';
 import { APIGatewayProxyResult } from 'aws-lambda';
 
 import { expect } from 'chai';

diff --git a/aws-lambda-wrap/src/http.responder.ts b/aws-lambda-wrap/src/http.responder.ts
@@ -1,4 +1,4 @@
-import { Inject, Injectable, Optional } from '@dandi/di-core';
+import { Inject, Injectable, Optional } from '@dandi/core';
 
 import { APIGatewayProxyResult } from 'aws-lambda';
 

diff --git a/aws-lambda-wrap/src/http.response.interceptor.ts b/aws-lambda-wrap/src/http.response.interceptor.ts
@@ -1,4 +1,4 @@
-import { InjectionToken } from '@dandi/di-core';
+import { InjectionToken } from '@dandi/core';
 
 import { APIGatewayProxyResult } from 'aws-lambda';
 

diff --git a/aws-lambda-wrap/src/lambda.error.handler.ts b/aws-lambda-wrap/src/lambda.error.handler.ts
@@ -1,4 +1,4 @@
-import { InjectionToken } from '@dandi/di-core';
+import { InjectionToken } from '@dandi/core';
 
 import { localOpinionatedToken } from './local.token';
 

diff --git a/aws-lambda-wrap/src/lambda.event.transformer.ts b/aws-lambda-wrap/src/lambda.event.transformer.ts
@@ -1,4 +1,4 @@
-import { InjectionToken } from '@dandi/di-core';
+import { InjectionToken } from '@dandi/core';
 
 import { Context } from 'aws-lambda';
 

diff --git a/aws-lambda-wrap/src/lambda.responder.ts b/aws-lambda-wrap/src/lambda.responder.ts
@@ -1,4 +1,4 @@
-import { InjectionToken } from '@dandi/di-core';
+import { InjectionToken } from '@dandi/core';
 
 import { localOpinionatedToken } from './local.token';
 

diff --git a/aws-lambda-wrap/src/lambda.spec.ts b/aws-lambda-wrap/src/lambda.spec.ts
@@ -1,6 +1,6 @@
 import { LambdaErrorHandler } from '@dandi/aws-lambda-wrap';
-import { AmbientInjectableScanner } from '@dandi/di-core';
-import { stubProvider, testHarness } from '@dandi/di-core-testing';
+import { AmbientInjectableScanner } from '@dandi/core';
+import { stubProvider, testHarness } from '@dandi/core-testing';
 
 import { Context } from 'aws-lambda';
 

diff --git a/aws-lambda-wrap/src/lambda.ts b/aws-lambda-wrap/src/lambda.ts
@@ -1,4 +1,4 @@
-import { Constructor } from '@dandi/core';
+import { Constructor } from '@dandi/common';
 import {
  AmbientInjectableScanner,
  Container,
@@ -7,7 +7,7 @@ import {
  InjectionToken,
  Optional,
  Repository,
-} from '@dandi/di-core';
+} from '@dandi/core';
 
 import { Context } from 'aws-lambda';
 

diff --git a/aws-lambda-wrap/src/local.token.ts b/aws-lambda-wrap/src/local.token.ts
@@ -1,4 +1,4 @@
-import { InjectionOptions, InjectionToken, OpinionatedToken, SymbolToken } from '@dandi/di-core';
+import { InjectionOptions, InjectionToken, OpinionatedToken, SymbolToken } from '@dandi/core';
 
 const PKG = '@dandi/aws-lambda';
 

diff --git a/aws-lambda-wrap/src/sns.handler.ts b/aws-lambda-wrap/src/sns.handler.ts
@@ -1,4 +1,4 @@
-import { ErrorUtil } from '@dandi/core';
+import { ErrorUtil } from '@dandi/common';
 
 import { SNSEvent } from 'aws-lambda';
 

diff --git a/cache/npm.link b/cache/npm.link
@@ -1,4 +1,4 @@
 #!/usr/bin/env bash
 
+npm link @dandi/common
 npm link @dandi/core
-npm link @dandi/di-core
diff --git a/cache/package-lock.json b/cache/package-lock.json
diff --git a/cache/package.json b/cache/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@dandi/cache",
- "version": "1.0.0-alpha.12",
+ "version": "1.0.0-alpha.13",
  "scripts": {},
  "repository": {
  "type": "git",
@@ -17,7 +17,7 @@
  "uuid": "^3.2.1"
  },
  "peerDependencies": {
- "@dandi/core": "1.0.0-alpha.12",
- "@dandi/di-core": "1.0.0-alpha.12"
+ "@dandi/common": "1.0.0-alpha.13",
+ "@dandi/core": "1.0.0-alpha.13"
  }
 }
diff --git a/cache/src/cache.key.generator.ts b/cache/src/cache.key.generator.ts
@@ -1,4 +1,4 @@
-import { InjectionToken } from '@dandi/di-core';
+import { InjectionToken } from '@dandi/core';
 
 import { localOpinionatedToken } from './local.token';
 

diff --git a/cache/src/cache.provider.ts b/cache/src/cache.provider.ts
@@ -1,5 +1,5 @@
-import { Duration } from '@dandi/core';
-import { MappedInjectionToken } from '@dandi/di-core';
+import { Duration } from '@dandi/common';
+import { MappedInjectionToken } from '@dandi/core';
 
 import { localOpinionatedToken } from './local.token';
 

diff --git a/cache/src/cascading.cache.ts b/cache/src/cascading.cache.ts
@@ -1,5 +1,5 @@
-import { Duration } from '@dandi/core';
-import { Inject, Injectable, Optional } from '@dandi/di-core';
+import { Duration } from '@dandi/common';
+import { Inject, Injectable, Optional } from '@dandi/core';
 
 import { Cache, CacheProvider, CacheProviderType } from './cache.provider';
 

diff --git a/cache/src/local.token.ts b/cache/src/local.token.ts
@@ -1,4 +1,4 @@
-import { InjectionOptions, InjectionToken, OpinionatedToken, SymbolToken } from '@dandi/di-core';
+import { InjectionOptions, InjectionToken, OpinionatedToken, SymbolToken } from '@dandi/core';
 
 const PKG = '@dandi/cache';
 

diff --git a/cache/src/memory.cache.ts b/cache/src/memory.cache.ts
@@ -1,5 +1,5 @@
-import { Duration } from '@dandi/core';
-import { Injectable, Singleton } from '@dandi/di-core';
+import { Duration } from '@dandi/common';
+import { Injectable, Singleton } from '@dandi/core';
 
 import { Cache, CacheProvider, CacheProviderType } from './cache.provider';
 import Timer = NodeJS.Timer;

diff --git a/cache/src/service.context.cache.key.generator.ts b/cache/src/service.context.cache.key.generator.ts
@@ -1,4 +1,4 @@
-import { Inject, Injectable, InjectionContext, InjectionToken } from '@dandi/di-core';
+import { Inject, Injectable, InjectionContext, InjectionToken } from '@dandi/core';
 
 import { CacheKeyGenerator } from './cache.key.generator';
 

diff --git a/cleanup.sh b/cleanup.sh
diff --git a/common/README.md b/common/README.md
@@ -0,0 +1,52 @@
+# @dandi/common
+
+`@dandi/common` provides common types and utilities for the rest of the
+`@dandi` system.
+
+`@dandi/common` does not have any dependencies on NodeJS, and therefore
+can be used on classes shared with projects targeted for the web.
+
+## Disposable
+
+The `Disposable` interface allows implementing classes to define
+ behavior for cleaning up resources like IO streams, database
+ connections, as well as Observable and other event subscriptions.
+
+When used with `@dandi/di-common`, `Disposable` instances are
+ automatically disposed by Dandi at the end of their lifecycle.
+
+```typescript
+class MyService implements Disposable {
+
+ constructor(private dbClient: DbClient) {}
+
+ public dispose(reason: string): void {
+ this.dbClient.release();
+ }
+
+}
+```
+
+### Disposable Utilities
+
+`Disposable` is also a static class provides several utility functions:
+
+* **isDisposable(obj)** - Returns `true` if the object implements
+ `dispose()`; otherwise, `false`.
+
+* **makeDisposable(obj, disposeFn)** - Modifies the specified object to
+ add the provided {@see DisposeFn} as the `Disposable.dispose`
+ implementation. If the object already has a function member named
+ `dispose`, it is wrapped and called before the new function.
+
+* **use(obj, fn)** - Invokes the specified function in a `try`/`catch`,
+ statement, then `finally` disposes the object. Returns the value
+ returned by `fn`, or rethrows the error thrown by it.
+
+* **useAsync(obj, fn)** - Same as `use`, but `fn` is invoked using `await`.
+
+* **remapDisposed(target, reason)** - Overwrites members of the target
+ such that functions and property/field accessors throw an
+ `AlreadyDisposedError`, a read-only `disposed` property is set with
+ the value `true`, and the target is frozen (using `Object.freeze`) to
+ prevent further modification.
diff --git a/common/index.ts b/common/index.ts
@@ -0,0 +1,10 @@
+export * from './src/app.error';
+export * from './src/constructor';
+export * from './src/disposable';
+export * from './src/error.util';
+export * from './src/metadata';
+export * from './src/primitive';
+export * from './src/type.helpers';
+export * from './src/url';
+export * from './src/uuid';
+export { DateTime, Duration } from 'luxon';
diff --git a/common/npm.link b/common/npm.link
@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+# no deps
diff --git a/common/package-lock.json b/common/package-lock.json
diff --git a/di-core/package.json → common/package.json b/di-core/package.json → common/package.json
@@ -1,7 +1,9 @@
 {
- "name": "@dandi/di-core",
- "version": "1.0.0-alpha.12",
- "scripts": {},
+ "name": "@dandi/common",
+ "version": "1.0.0-alpha.13",
+ "scripts": {
+ "postbuild": "cp src/url.* dist/src"
+ },
  "repository": {
  "type": "git",
  "url": "git+https://github.com/dandi-mvc/dandi.git"
@@ -11,16 +13,15 @@
  "url": "https://github.com/dandi-mvc/dandi/issues"
  },
  "homepage": "https://github.com/dandi-mvc/dandi#readme",
- "dependencies": {
- "fs-extra": "^5.0.0"
+ "module": "index.js",
+ "peerDependencies": {
+ "luxon": "^1.3.0",
+ "uuid": "^3.2.1"
  },
  "devDependencies": {
- "@types/fs-extra": "^5.0.2",
+ "@types/luxon": "^1.2.0",
  "@types/node": "^9.6.17",
- "luxon": "^1.2.1",
+ "luxon": "^1.3.0",
  "uuid": "^3.2.1"
- },
- "peerDependencies": {
- "@dandi/core": "1.0.0-alpha.12"
  }
 }
diff --git a/core/src/app.error.spec.ts → common/src/app.error.spec.ts b/core/src/app.error.spec.ts → common/src/app.error.spec.ts
diff --git a/core/src/app.error.ts → common/src/app.error.ts b/core/src/app.error.ts → common/src/app.error.ts
diff --git a/core/src/constructor.spec.ts → common/src/constructor.spec.ts b/core/src/constructor.spec.ts → common/src/constructor.spec.ts
diff --git a/core/src/constructor.ts → common/src/constructor.ts b/core/src/constructor.ts → common/src/constructor.ts
diff --git a/core/src/disposable.spec.ts → common/src/disposable.spec.ts b/core/src/disposable.spec.ts → common/src/disposable.spec.ts
diff --git a/core/src/disposable.ts → common/src/disposable.ts b/core/src/disposable.ts → common/src/disposable.ts
diff --git a/core/src/error.util.spec.ts → common/src/error.util.spec.ts b/core/src/error.util.spec.ts → common/src/error.util.spec.ts
diff --git a/core/src/error.util.ts → common/src/error.util.ts b/core/src/error.util.ts → common/src/error.util.ts
diff --git a/core/src/metadata.spec.ts → common/src/metadata.spec.ts b/core/src/metadata.spec.ts → common/src/metadata.spec.ts
diff --git a/core/src/metadata.ts → common/src/metadata.ts b/core/src/metadata.ts → common/src/metadata.ts
diff --git a/core/src/primitive.spec.ts → common/src/primitive.spec.ts b/core/src/primitive.spec.ts → common/src/primitive.spec.ts
diff --git a/core/src/primitive.ts → common/src/primitive.ts b/core/src/primitive.ts → common/src/primitive.ts
diff --git a/core/src/type.helpers.ts → common/src/type.helpers.ts b/core/src/type.helpers.ts → common/src/type.helpers.ts
diff --git a/core/src/url.d.ts → common/src/url.d.ts b/core/src/url.d.ts → common/src/url.d.ts
diff --git a/core/src/url.js → common/src/url.js b/core/src/url.js → common/src/url.js
diff --git a/core/src/uuid.spec.ts → common/src/uuid.spec.ts b/core/src/uuid.spec.ts → common/src/uuid.spec.ts
diff --git a/core/src/uuid.ts → common/src/uuid.ts b/core/src/uuid.ts → common/src/uuid.ts