esp-js-react 6.5.1 → 7.0.1-next.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,36 @@
1
+ import * as React from 'react';
2
+ import { ModelAddress, Router } from 'esp-js';
3
+ import { PropsWithChildren } from 'react';
4
+ export type GetModelIdDelegate = () => string;
5
+ export declare const GetModelIdContext: React.Context<GetModelIdDelegate>;
6
+ /**
7
+ * Returns a function which will return the ID of the model currently being rendered.
8
+ */
9
+ export declare const useGetModelId: () => GetModelIdDelegate;
10
+ export type PublishEventDelegate = (modelIdOrModelAddress: string | ModelAddress, eventType: string, event: any) => void;
11
+ export declare const PublishEventContext: React.Context<PublishEventDelegate>;
12
+ /**
13
+ * Returns a function which can be used to publish an event.
14
+ */
15
+ export declare const usePublishEvent: () => PublishEventDelegate;
16
+ export type PublishModelEventDelegate = (eventType: string, event: any) => void;
17
+ export declare const PublishModelEventContext: React.Context<PublishModelEventDelegate>;
18
+ /**
19
+ * Returns a function which can be used to publish an event to the current model being rendered.
20
+ *
21
+ * Effectively, this is a version of usePublishEvent() which closes over the current modelId.
22
+ */
23
+ export declare const usePublishModelEvent: () => PublishModelEventDelegate;
24
+ export type PublishModelEventWithEntityKeyDelegate = (entityKey: string, eventType: string, event: any) => void;
25
+ export declare const PublishModelEventWithEntityKeyContext: React.Context<PublishModelEventWithEntityKeyDelegate>;
26
+ /**
27
+ * Returns a function which can be used to publish an event to the current model being rendered, allows an entityKey to be specified.
28
+ *
29
+ * Effectively, this is a version of usePublishEvent() which closes over the current modelId.
30
+ */
31
+ export declare const usePublishModelEventWithEntityKey: () => PublishModelEventWithEntityKeyDelegate;
32
+ export interface EspModelContextProps {
33
+ modelId: string;
34
+ router: Router;
35
+ }
36
+ export declare const EspModelContext: ({ modelId, children, router }: PropsWithChildren<EspModelContextProps>) => React.JSX.Element;
@@ -1,9 +1,10 @@
1
1
  import './polimer/polimerExtentsions';
2
- export { RouterProvider, HooksRouterProvider, RouterContext } from './routerProvider';
2
+ export { RouterProvider, RouterContext, useRouter } from './routerProvider';
3
3
  export { SmartComponent } from './smartComponent';
4
4
  export { ViewBinder } from './viewBinder';
5
5
  export { viewBinding, DEFAULT_VIEW_KEY } from './viewBindingDecorator';
6
6
  export * from './getEspReactRenderModel';
7
7
  export { shouldUpdateMixin } from './shouldUpdateMixin';
8
8
  export { createViewForModel } from './viewBindingDecorator';
9
- export { ConnectableComponent, connect, ConnectableComponentProps, MapModelToProps, CreatePublishEventProps, ConnectableView, ConnectableComponentChildProps, PublishModelEventDelegate, PublishModelEventContext } from './connectableComponent';
9
+ export { ConnectableComponent, connect, ConnectableComponentProps, MapModelToProps, CreatePublishEventProps, ConnectableView, ConnectableComponentChildProps, } from './connectableComponent';
10
+ export { useGetModelId, GetModelIdDelegate, GetModelIdContext, PublishEventDelegate, PublishEventContext, usePublishEvent, PublishModelEventDelegate, PublishModelEventContext, usePublishModelEvent, PublishModelEventWithEntityKeyDelegate, PublishModelEventWithEntityKeyContext, usePublishModelEventWithEntityKey, EspModelContext, EspModelContextProps } from './espModelContext';
@@ -1,4 +1,4 @@
1
- declare module 'esp-js-polimer/.dist/typings/modelBuilder' {
1
+ declare module 'esp-js-polimer/.dist/typings/modelBuilderUpdater' {
2
2
  interface PolimerModelBuilder<TModel> {
3
3
  withViewBindings?(view: any, displayContext?: string): PolimerModelBuilder<TModel>;
4
4
  }
@@ -3,9 +3,10 @@ import * as PropTypes from 'prop-types';
3
3
  import { Router } from 'esp-js';
4
4
  export interface RouterProviderProps {
5
5
  router: Router;
6
+ children: any;
6
7
  }
7
8
  export declare const RouterContext: React.Context<Router>;
8
- export declare const HooksRouterProvider: React.Provider<Router>;
9
+ export declare const useRouter: () => Router;
9
10
  export declare class RouterProvider extends React.Component<RouterProviderProps, any> {
10
11
  static childContextTypes: {
11
12
  router: PropTypes.Validator<Router>;
@@ -1,5 +1,7 @@
1
1
  import * as React from 'react';
2
- export declare function shouldUpdateMixin<TProps, TState, TPropBindings>(itemsThatEffectUpdateSelector: (nextProps: TProps) => TPropBindings): <TConstructor extends new (...args: any[]) => {}>(Constructor: TConstructor) => {
2
+ export declare function shouldUpdateMixin<TProps, TState, TPropBindings>(itemsThatEffectUpdateSelector: (nextProps: TProps) => TPropBindings): <TConstructor extends {
3
+ new (...args: any[]): {};
4
+ }>(Constructor: TConstructor) => {
3
5
  new (...args: any[]): {
4
6
  _propBindings: {};
5
7
  shouldComponentUpdate(nextProps: any, nextState: any): boolean;
@@ -28,6 +28,6 @@ export declare class SmartComponent extends React.Component<SmartComponentProps,
28
28
  router: any;
29
29
  } & {
30
30
  readonly [x: string]: any;
31
- children?: React.ReactNode;
31
+ children?: React.ReactNode | undefined;
32
32
  };
33
33
  }
@@ -1,5 +1,5 @@
1
1
  export declare function removeAll(arr: any, item: any): void;
2
- export declare function isString(value: any): boolean;
2
+ export declare function isString(value: any): value is string | String;
3
3
  export declare function format(formatString: any): any;
4
4
  export declare function startsWith(string: any, searchString: any, position: any): boolean;
5
5
  export declare function getPropertyNames(object: any): any[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "esp-js-react",
3
- "version": "6.5.1",
3
+ "version": "7.0.1-next.0",
4
4
  "description": "Evented State Processor (ESP) React Components",
5
5
  "keywords": [
6
6
  "esp",
@@ -24,17 +24,17 @@
24
24
  "dev": "nps dev"
25
25
  },
26
26
  "dependencies": {
27
- "esp-js": "^6.5.1",
28
- "esp-js-polimer": "^6.5.1",
27
+ "esp-js": "^7.0.1-next.0",
28
+ "esp-js-polimer": "^7.0.1-next.0",
29
29
  "prop-types": "^15.7.2",
30
30
  "react": "16.14.0"
31
31
  },
32
32
  "devDependencies": {
33
- "jest": "26.0.1",
34
- "typescript": "4.5.4",
35
- "webpack": "4.43.0",
36
- "webpack-cli": "^3.3.0",
37
- "webpack-dev-server": "3.11.0"
33
+ "jest": "29.7.0",
34
+ "typescript": "5.5.2",
35
+ "webpack": "^5.92.1",
36
+ "webpack-cli": "^5.1.4",
37
+ "webpack-dev-server": "^5.0.4"
38
38
  },
39
39
  "peerDependencies": {
40
40
  "esp-js": "^6.0.0",
@@ -42,5 +42,5 @@
42
42
  "prop-types": "^15.7.2",
43
43
  "react": "16.14.0"
44
44
  },
45
- "gitHead": "aece26fca1834f9b9f6614a2b9bf41e68b05e8a6"
45
+ "gitHead": "89b38f8cfde03b4a2888a0998d84ea3c049ab5ce"
46
46
  }
@@ -3,6 +3,7 @@ import * as PropTypes from 'prop-types';
3
3
  import {Disposable, Router, EspDecoratorUtil, utils, DisposableBase} from 'esp-js';
4
4
  import {createViewForModel } from './viewBindingDecorator';
5
5
  import {GetEspReactRenderModelConsts, GetEspReactRenderModelMetadata} from './getEspReactRenderModel';
6
+ import {EspModelContext} from './espModelContext';
6
7
 
7
8
  export type PublishEvent = (eventType: string, event: any) => void;
8
9
 
@@ -45,10 +46,6 @@ interface ConnectableComponentContext {
45
46
 
46
47
  export type PublishModelEventDelegate = (eventType: string, event: any) => void;
47
48
 
48
- export const PublishModelEventContext = React.createContext<PublishModelEventDelegate>(null);
49
-
50
- export const HooksPublishModelEventProvider = PublishModelEventContext.Provider;
51
-
52
49
  export class ConnectableComponent<TModel, TPublishEventProps = {}, TModelMappedToProps = {}> extends React.Component<ConnectableComponentProps<TModel, TPublishEventProps, TModelMappedToProps>, State> {
53
50
  private _isMounted = false;
54
51
  private _observationSubscription: Disposable;
@@ -146,7 +143,8 @@ export class ConnectableComponent<TModel, TPublishEventProps = {}, TModelMappedT
146
143
  }
147
144
  let childProps = this._getChildProps();
148
145
  let view = createViewForModel(this.state.model, childProps, this.props.viewContext, this.props.view);
149
- return (<HooksPublishModelEventProvider value={this.state.publishEvent}>{view}</HooksPublishModelEventProvider>);
146
+
147
+ return (<EspModelContext modelId={this.props.modelId} router={this.context.router} {...childProps}>{view}</EspModelContext>);
150
148
  }
151
149
 
152
150
  private _getChildProps(): ConnectableComponentChildProps<TModel> {
@@ -0,0 +1,69 @@
1
+ import * as React from 'react';
2
+ import {DefaultModelAddress, ModelAddress, Router} from 'esp-js';
3
+ import {useContext, useCallback, createContext, PropsWithChildren} from 'react';
4
+ import {RouterContext} from './routerProvider';
5
+
6
+ export type GetModelIdDelegate = () => string;
7
+ export const GetModelIdContext = createContext<GetModelIdDelegate>(null);
8
+ /**
9
+ * Returns a function which will return the ID of the model currently being rendered.
10
+ */
11
+ export const useGetModelId = () => useContext(GetModelIdContext);
12
+
13
+ export type PublishEventDelegate = (modelIdOrModelAddress: string | ModelAddress, eventType: string, event: any) => void;
14
+ export const PublishEventContext = createContext<PublishEventDelegate>(null);
15
+ /**
16
+ * Returns a function which can be used to publish an event.
17
+ */
18
+ export const usePublishEvent = () => useContext(PublishEventContext);
19
+
20
+ export type PublishModelEventDelegate = (eventType: string, event: any) => void;
21
+ export const PublishModelEventContext = createContext<PublishModelEventDelegate>(null);
22
+ /**
23
+ * Returns a function which can be used to publish an event to the current model being rendered.
24
+ *
25
+ * Effectively, this is a version of usePublishEvent() which closes over the current modelId.
26
+ */
27
+ export const usePublishModelEvent = () => useContext(PublishModelEventContext);
28
+
29
+ export type PublishModelEventWithEntityKeyDelegate = (entityKey: string, eventType: string, event: any) => void;
30
+ export const PublishModelEventWithEntityKeyContext = createContext<PublishModelEventWithEntityKeyDelegate>(null);
31
+ /**
32
+ * Returns a function which can be used to publish an event to the current model being rendered, allows an entityKey to be specified.
33
+ *
34
+ * Effectively, this is a version of usePublishEvent() which closes over the current modelId.
35
+ */
36
+ export const usePublishModelEventWithEntityKey = () => useContext(PublishModelEventWithEntityKeyContext);
37
+
38
+ export interface EspModelContextProps {
39
+ modelId: string;
40
+ router: Router;
41
+ }
42
+
43
+ export const EspModelContext = ({modelId, children, router}: PropsWithChildren<EspModelContextProps>) => {
44
+ const getModelId: () => string = useCallback(() => {
45
+ return modelId;
46
+ }, [router, modelId]);
47
+ const publishEvent: PublishEventDelegate = useCallback((modelIdOrModelAddress: string, eventType: string, event: any) => {
48
+ router.publishEvent(modelIdOrModelAddress, eventType, event);
49
+ }, [router]);
50
+ const publishModelEvent: PublishModelEventDelegate = useCallback((eventType: string, event: any) => {
51
+ router.publishEvent(modelId, eventType, event);
52
+ }, [router, modelId]);
53
+ const publishModelEventWithEntityKey: PublishModelEventWithEntityKeyDelegate = useCallback((entityKey: string, eventType: string, event: any) => {
54
+ router.publishEvent(new DefaultModelAddress(modelId, entityKey), eventType, event);
55
+ }, [router, modelId]);
56
+ return (
57
+ <RouterContext.Provider value={router}>
58
+ <GetModelIdContext.Provider value={getModelId}>
59
+ <PublishEventContext.Provider value={publishEvent}>
60
+ <PublishModelEventContext.Provider value={publishModelEvent}>
61
+ <PublishModelEventWithEntityKeyContext.Provider value={publishModelEventWithEntityKey}>
62
+ {children}
63
+ </PublishModelEventWithEntityKeyContext.Provider>
64
+ </PublishModelEventContext.Provider>
65
+ </PublishEventContext.Provider>
66
+ </GetModelIdContext.Provider>
67
+ </RouterContext.Provider>
68
+ );
69
+ };
package/src/index.ts CHANGED
@@ -20,7 +20,7 @@
20
20
  // import for side effects
21
21
  import './polimer/polimerExtentsions';
22
22
 
23
- export {RouterProvider, HooksRouterProvider, RouterContext} from './routerProvider';
23
+ export {RouterProvider, RouterContext, useRouter} from './routerProvider';
24
24
  export {SmartComponent} from './smartComponent';
25
25
  export {ViewBinder} from './viewBinder';
26
26
  export {viewBinding, DEFAULT_VIEW_KEY} from './viewBindingDecorator';
@@ -35,6 +35,24 @@ export {
35
35
  CreatePublishEventProps,
36
36
  ConnectableView,
37
37
  ConnectableComponentChildProps,
38
- PublishModelEventDelegate,
39
- PublishModelEventContext
40
38
  } from './connectableComponent';
39
+ export {
40
+ useGetModelId,
41
+ GetModelIdDelegate,
42
+ GetModelIdContext,
43
+
44
+ PublishEventDelegate,
45
+ PublishEventContext,
46
+ usePublishEvent,
47
+
48
+ PublishModelEventDelegate,
49
+ PublishModelEventContext,
50
+ usePublishModelEvent,
51
+
52
+ PublishModelEventWithEntityKeyDelegate,
53
+ PublishModelEventWithEntityKeyContext,
54
+ usePublishModelEventWithEntityKey,
55
+
56
+ EspModelContext,
57
+ EspModelContextProps
58
+ } from './espModelContext';
@@ -1,7 +1,7 @@
1
1
  import {PolimerModelBuilder, PolimerModel} from 'esp-js-polimer';
2
2
  import {DEFAULT_VIEW_KEY, viewBinding} from '../viewBindingDecorator';
3
3
 
4
- declare module 'esp-js-polimer/.dist/typings/modelBuilder' {
4
+ declare module 'esp-js-polimer/.dist/typings/modelBuilderUpdater' {
5
5
  export interface PolimerModelBuilder<TModel> {
6
6
  withViewBindings?(view: any, displayContext?: string): PolimerModelBuilder<TModel>;
7
7
  }
@@ -19,14 +19,18 @@
19
19
  import * as React from 'react';
20
20
  import * as PropTypes from 'prop-types';
21
21
  import { Router } from 'esp-js';
22
+ import {useContext} from 'react';
22
23
 
23
24
  export interface RouterProviderProps {
24
25
  router: Router;
26
+ // React 18 Fix:
27
+ // The current codebase is React 16, it will work with React 18, but there were changes to the types in React 18.
28
+ // The `children` prop was removed from some React types that cause the RouterProvider to fail, this fixes that.
29
+ children: any;
25
30
  }
26
31
 
27
32
  export const RouterContext = React.createContext<Router>(null);
28
-
29
- export const HooksRouterProvider = RouterContext.Provider;
33
+ export const useRouter = () => useContext(RouterContext);
30
34
 
31
35
  export class RouterProvider extends React.Component<RouterProviderProps, any> {
32
36
  static childContextTypes = {
@@ -38,6 +42,6 @@ export class RouterProvider extends React.Component<RouterProviderProps, any> {
38
42
  };
39
43
  }
40
44
  render() {
41
- return (<HooksRouterProvider value={this.props.router}>{this.props.children}</HooksRouterProvider>);
45
+ return (<RouterContext.Provider value={this.props.router}>{this.props.children}</RouterContext.Provider>);
42
46
  }
43
47
  }
@@ -2,11 +2,11 @@ import 'jest';
2
2
  import * as React from 'react';
3
3
  import * as PropTypes from 'prop-types';
4
4
  import {configure, mount, ReactWrapper} from 'enzyme';
5
- import ReactSixteenAdapter = require('enzyme-adapter-react-16');
5
+ import ReactSixteenAdapter = require('enzyme-adapter-react-16');
6
6
  import {ConnectableComponent, ConnectableComponentProps, viewBinding, connect, getEspReactRenderModel} from '../src';
7
7
  import {Router} from 'esp-js';
8
8
  import {observeEvent} from 'esp-js/src/decorators/observeEvent';
9
- import {ConnectableComponentChildProps, PublishEvent, PublishModelEventContext, PublishModelEventDelegate} from '../src/connectableComponent';
9
+ import {ConnectableComponentChildProps, PublishEvent} from '../src/connectableComponent';
10
10
 
11
11
  configure({adapter: new ReactSixteenAdapter()});
12
12
 
@@ -126,10 +126,10 @@ describe('ConnectableComponent', () => {
126
126
  modelId: 'model-id'
127
127
  };
128
128
  if (options.useMapModelToProps) {
129
- mapModelToProps = (model: TestModel | MappedModel, publishEventProps: any) => {
129
+ mapModelToProps = (model: TestModel | MappedModel, publishEventProps1: any) => {
130
130
  return {
131
131
  foo: model.value,
132
- publishEventProps,
132
+ publishEventProps: publishEventProps1,
133
133
  ...model
134
134
  };
135
135
  };
@@ -293,34 +293,34 @@ describe('ConnectableComponent', () => {
293
293
  setup({useConnectFunction: false});
294
294
  });
295
295
 
296
- // Cant test hooks yet, will test using state below
297
- // https://github.com/enzymejs/enzyme/issues/2011
298
- xit('Can publish event via context', () => {
299
- const childViewContext = connectableComponentWrapper.context();
300
- let publishEvent: PublishModelEventDelegate = React.useContext(PublishModelEventContext);
301
- publishEvent('test-event', 'the-event-value');
302
- connectableComponentWrapper.update();
303
- let props = getChidViewProps();
304
- expect(props.foo).toBe('the-event-value');
305
- });
306
-
307
- // Note this is a a best effort to test the context hook created via state
296
+ // // Cant test hooks yet, will test using state below
297
+ // // https://github.com/enzymejs/enzyme/issues/2011
298
+ // xit('Can publish event via context', () => {
299
+ // const childViewContext = connectableComponentWrapper.context();
300
+ // let publishEvent: PublishModelEventDelegate = React.useContext(PublishModelEventContext);
301
+ // publishEvent('test-event', 'the-event-value');
302
+ // connectableComponentWrapper.update();
303
+ // let props = getChidViewProps();
304
+ // expect(props.foo).toBe('the-event-value');
305
+ // });
306
+
307
+ // Note this is a best effort to test the context hook created via state
308
308
  it('publishEvent set', () => {
309
- const state = connectableComponentWrapper.state();
309
+ const state: any = connectableComponentWrapper.state();
310
310
  state.publishEvent('test-event', 'the-event-value');
311
311
  connectableComponentWrapper.update();
312
312
  let props = getChidViewProps();
313
313
  expect(props.model.value).toBe('the-event-value');
314
314
  });
315
315
 
316
- it('publishEvent recreated on modle change', () => {
316
+ it('publishEvent recreated on model change', () => {
317
317
  const newProps = {
318
318
  ...connectableComponentWrapper.props(),
319
319
  modelId: 'model-id2',
320
320
  };
321
321
  connectableComponentWrapper.setProps(newProps);
322
322
  connectableComponentWrapper.update();
323
- const state = connectableComponentWrapper.state();
323
+ const state: any = connectableComponentWrapper.state();
324
324
  state.publishEvent('test-event', 'the-event-value');
325
325
  connectableComponentWrapper.update();
326
326
  let props = getChidViewProps();
@@ -18,14 +18,28 @@
18
18
 
19
19
  import * as espReact from '../src/index';
20
20
  import {
21
- RouterProvider,
22
- RouterContext,
23
21
  SmartComponent,
24
22
  ViewBinder,
25
23
  viewBinding,
26
24
  getEspReactRenderModel,
27
25
  GetEspReactRenderModelConsts,
28
- shouldUpdateMixin
26
+ shouldUpdateMixin,
27
+
28
+ useRouter,
29
+ RouterContext,
30
+ RouterProvider,
31
+
32
+ useGetModelId,
33
+ GetModelIdContext,
34
+
35
+ PublishEventContext,
36
+ usePublishEvent,
37
+
38
+ PublishModelEventContext,
39
+ usePublishModelEvent,
40
+
41
+ PublishModelEventWithEntityKeyContext,
42
+ usePublishModelEventWithEntityKey,
29
43
  } from '../src';
30
44
 
31
45
  describe('index exports', () => {
@@ -68,4 +82,47 @@ describe('index exports', () => {
68
82
  expect(espReact.shouldUpdateMixin).toBeDefined();
69
83
  expect(shouldUpdateMixin).toBeDefined();
70
84
  });
85
+
86
+ describe('hooks', () => {
87
+
88
+ it('should export useRouter and related', () => {
89
+ expect(espReact.useRouter).toBeDefined();
90
+ expect(useRouter).toBeDefined();
91
+
92
+ expect(espReact.RouterContext).toBeDefined();
93
+ expect(RouterContext).toBeDefined();
94
+ });
95
+
96
+ it('should export useGetModelId and related', () => {
97
+ expect(espReact.useGetModelId).toBeDefined();
98
+ expect(useGetModelId).toBeDefined();
99
+
100
+ expect(espReact.GetModelIdContext).toBeDefined();
101
+ expect(GetModelIdContext).toBeDefined();
102
+ });
103
+
104
+ it('should export usePublishEvent and related', () => {
105
+ expect(espReact.usePublishEvent).toBeDefined();
106
+ expect(usePublishEvent).toBeDefined();
107
+
108
+ expect(espReact.PublishEventContext).toBeDefined();
109
+ expect(PublishEventContext).toBeDefined();
110
+ });
111
+
112
+ it('should export usePublishModelEvent and related', () => {
113
+ expect(espReact.usePublishModelEvent).toBeDefined();
114
+ expect(usePublishModelEvent).toBeDefined();
115
+
116
+ expect(espReact.PublishModelEventContext).toBeDefined();
117
+ expect(PublishModelEventContext).toBeDefined();
118
+ });
119
+
120
+ it('should export usePublishModelEventWithEntityKey and related', () => {
121
+ expect(espReact.usePublishModelEventWithEntityKey).toBeDefined();
122
+ expect(usePublishModelEventWithEntityKey).toBeDefined();
123
+
124
+ expect(espReact.PublishModelEventContext).toBeDefined();
125
+ expect(PublishModelEventWithEntityKeyContext).toBeDefined();
126
+ });
127
+ });
71
128
  });