Skip to content

Commit

Permalink
Merge 9339499 into a5e4ca5
Browse files Browse the repository at this point in the history
  • Loading branch information
xc1427 committed Apr 18, 2020
2 parents a5e4ca5 + 9339499 commit aa56ffe
Show file tree
Hide file tree
Showing 18 changed files with 5,837 additions and 5,898 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ node_js:
- "12"

before_script:
- npm run build
- npm run bootstrap
- npm run build

after_success:
- npm run coveralls
Expand Down
2 changes: 2 additions & 0 deletions packages/dva-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "The core lightweight library for dva, based on redux and redux-saga.",
"main": "dist/index.js",
"module": "dist/index.esm.js",
"typings": "typings/index.d.ts",
"sideEffects": false,
"repository": {
"type": "git",
Expand All @@ -28,6 +29,7 @@
},
"dependencies": {
"@babel/runtime": "^7.0.0",
"@types/history": "^4.7.5",
"flatten": "^1.0.2",
"global": "^4.3.2",
"invariant": "^2.2.1",
Expand Down
6 changes: 3 additions & 3 deletions packages/dva-core/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -105,15 +105,15 @@ export function create(hooksAndOpts = {}, createOpts = {}) {
// Cancel effects
store.dispatch({ type: `${namespace}/@@CANCEL_EFFECTS` });

// Unlisten subscrioptions
// Unlisten subscriptions
unlistenSubscription(unlisteners, namespace);

// Delete model from app._models
app._models = app._models.filter(model => model.namespace !== namespace);
}

/**
* Replace a model if it exsits, if not, add it to app
* Replace a model if it exists, if not, add it to app
* Attention:
* - Only available after dva.start gets called
* - Will not check origin m is strict equal to the new one
Expand All @@ -137,7 +137,7 @@ export function create(hooksAndOpts = {}, createOpts = {}) {
delete store.asyncReducers[namespace];
delete reducers[namespace];

// Unlisten subscrioptions
// Unlisten subscriptions
unlistenSubscription(unlisteners, namespace);

// Delete model from app._models
Expand Down
66 changes: 66 additions & 0 deletions packages/dva-core/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
{
"compilerOptions": {
/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "esnext", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
"module": "esnext", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
// "lib": [], /* Specify library files to be included in the compilation. */
"allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
"outDir": "./dist2", /* Redirect output structure to the directory. */
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

/* Strict Type-Checking Options */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */

/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */

/* Module Resolution Options */
"moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */

/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */

/* Advanced Options */
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
}
}
129 changes: 129 additions & 0 deletions packages/dva-core/typings/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
// NOTE: This file should net be here if all dva-dore is rewritten in TypeScript
import { Store, StoreEnhancer, ReducersMapObject, Middleware, MiddlewareAPI, Dispatch, Reducer } from 'redux';
import { History } from 'history';
import Plugin from '../src/Plugin'; // NOTE: src should be packaged for the moment because "Plugin" and "utils" are served as type

declare module 'redux' {
interface Dispatch<A extends Action = AnyAction> {
<T extends A>(action: T): Promise<any>;
}
}

interface Model {
namespace: string;
state?: any;
reducers?: any; // WIP cxi
effects?:any;
subscriptions?:any;
}

/**
* EffectsCommandMap
* Effect
* EffectType
* EffectWithType
* Subscription
* ReducersMapObjectWithEnhancer
* EffectsMapObject
* SubscriptionAPI
* SubscriptionsMapObject
*/

export type DvaHooks = {
onError?: (e: Error, dispatch: Dispatch<any>) => void,
onAction?: OnActionFunc | OnActionFunc[],
onStateChange?: () => void,
onReducer?: ReducerEnhancer,
onEffect?: () => void,
onHmr?: () => void,
extraReducers?: ReducersMapObject,
extraEnhancers?: StoreEnhancer<any>[],
};

/**
* @deprecated
* Conserved for compatibility reason. Use `DvaHooks` instead.
*/
export type Hooks = DvaHooks;

/**
*
* Create dva-core instance
*/
export interface DvaInstance {
/**
* Register an object of hooks on the application. Note that the "hooks" here has nothing to do with react hooks.
*
* @param hooks
*/
use: (hooks: DvaHooks) => void,

/**
* Register a model
*
* @param model
* @returns - a prefixed model
*/
model: (model: Model) => Model;

/**
* Unregister a model.
*
* @param namespace
*/
unmodel: (namespace: string) => void;

replaceModel: (model: Model) => void;

/**
* Start the application. Selector is optional. If no selector
* arguments, it will return a function that return JSX elements.
*
* @param selector
*/
start: (selector?: HTMLElement | string) => any;
_store: Store | null;
_models: Model[];
_plugin: Plugin;
_getSaga?: Function;
}

export type DvaOptions = {
namespacePrefixWarning?: boolean;
initialState?: object;
history?: History;
}

export type OnActionFunc = (api: MiddlewareAPI<any>) => void;

/**
* @deprecated
* Conserved for compatibility reason. Use `OnActionFunc` instead.
*/
export interface onActionFunc {
(api: MiddlewareAPI<any>): void,
}

export type ReducerEnhancer = (reducer: Reducer<any>) => Reducer<any>;

export type DvaOptionsAndDvaHooks = DvaOptions & DvaHooks;

/**
* @deprecated
* Conserved for compatibility reason. Use `DvaHooksAndDvaOptions` instead.
*/
export type DvaOption = DvaOptionsAndDvaHooks;

export type CreateOpts = {
initialReducer: ReducersMapObject<any, any>,
setupApp: (app: DvaInstance) => void;

/** Give a chance to append other middlewares (usually router middleware) onto dva-core registered middlewares */
setupMiddlewares: (middlewares: Middleware[]) => Middleware[];
};

export declare function create(optsAndHooks: DvaOptionsAndDvaHooks, createOpts: CreateOpts): DvaInstance;

export * as saga from 'redux-saga';

export * as utils from '../src/utils';

0 comments on commit aa56ffe

Please sign in to comment.