@atlaskit/task-decision 17.5.2 → 17.5.4
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.
- package/CHANGELOG.md +12 -0
- package/dist/cjs/version.json +1 -1
- package/dist/es2019/version.json +1 -1
- package/dist/esm/version.json +1 -1
- package/package.json +5 -13
- package/report.api.md +19 -12
- package/dist/types-ts4.0/analytics/index.d.ts +0 -2
- package/dist/types-ts4.0/api/TaskDecisionResource.d.ts +0 -67
- package/dist/types-ts4.0/api/TaskDecisionUtils.d.ts +0 -4
- package/dist/types-ts4.0/components/DecisionItem.d.ts +0 -15
- package/dist/types-ts4.0/components/DecisionList.d.ts +0 -9
- package/dist/types-ts4.0/components/Item.d.ts +0 -25
- package/dist/types-ts4.0/components/ResourcedTaskItem.d.ts +0 -35
- package/dist/types-ts4.0/components/TaskItem.d.ts +0 -21
- package/dist/types-ts4.0/components/TaskList.d.ts +0 -9
- package/dist/types-ts4.0/components/listStyle.d.ts +0 -2
- package/dist/types-ts4.0/constants.d.ts +0 -1
- package/dist/types-ts4.0/index.d.ts +0 -9
- package/dist/types-ts4.0/type-helpers.d.ts +0 -6
- package/dist/types-ts4.0/types.d.ts +0 -160
package/CHANGELOG.md
CHANGED
package/dist/cjs/version.json
CHANGED
package/dist/es2019/version.json
CHANGED
package/dist/esm/version.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/task-decision",
|
|
3
|
-
"version": "17.5.
|
|
3
|
+
"version": "17.5.4",
|
|
4
4
|
"description": "Tasks and decisions react components",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -12,14 +12,6 @@
|
|
|
12
12
|
"module": "dist/esm/index.js",
|
|
13
13
|
"module:es2019": "dist/es2019/index.js",
|
|
14
14
|
"types": "dist/types/index.d.ts",
|
|
15
|
-
"typesVersions": {
|
|
16
|
-
">=4.0 <4.5": {
|
|
17
|
-
"*": [
|
|
18
|
-
"dist/types-ts4.0/*",
|
|
19
|
-
"dist/types-ts4.0/index.d.ts"
|
|
20
|
-
]
|
|
21
|
-
}
|
|
22
|
-
},
|
|
23
15
|
"sideEffects": false,
|
|
24
16
|
"atlaskit:src": "src/index.ts",
|
|
25
17
|
"atlassian": {
|
|
@@ -38,7 +30,7 @@
|
|
|
38
30
|
"@atlaskit/analytics-next": "^8.2.0",
|
|
39
31
|
"@atlaskit/icon": "^21.11.0",
|
|
40
32
|
"@atlaskit/theme": "^12.2.0",
|
|
41
|
-
"@atlaskit/tokens": "^0.
|
|
33
|
+
"@atlaskit/tokens": "^0.12.0",
|
|
42
34
|
"@atlaskit/util-service-support": "^6.1.0",
|
|
43
35
|
"@babel/runtime": "^7.0.0",
|
|
44
36
|
"@emotion/react": "^11.7.1",
|
|
@@ -53,10 +45,10 @@
|
|
|
53
45
|
"@atlaskit/analytics-listeners": "^8.3.0",
|
|
54
46
|
"@atlaskit/avatar": "^21.1.0",
|
|
55
47
|
"@atlaskit/docs": "*",
|
|
56
|
-
"@atlaskit/editor-common": "^
|
|
48
|
+
"@atlaskit/editor-common": "^71.0.0",
|
|
57
49
|
"@atlaskit/elements-test-helpers": "^0.7.0",
|
|
58
|
-
"@atlaskit/renderer": "^
|
|
59
|
-
"@atlaskit/util-data-test": "^17.
|
|
50
|
+
"@atlaskit/renderer": "^104.0.0",
|
|
51
|
+
"@atlaskit/util-data-test": "^17.6.0",
|
|
60
52
|
"@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
|
|
61
53
|
"@emotion/jest": "^11.8.0",
|
|
62
54
|
"@types/url-search-params": "^0.10.0",
|
package/report.api.md
CHANGED
|
@@ -1,12 +1,17 @@
|
|
|
1
|
+
<!-- API Report Version: 2.2 -->
|
|
2
|
+
|
|
1
3
|
## API Report File for "@atlaskit/task-decision"
|
|
2
4
|
|
|
3
|
-
> Do not edit this file.
|
|
5
|
+
> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
|
|
6
|
+
> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
|
|
7
|
+
|
|
8
|
+
### Table of contents
|
|
4
9
|
|
|
5
|
-
|
|
6
|
-
Generated API Report version: 2.0
|
|
7
|
-
-->
|
|
10
|
+
- [Main Entry Types](#main-entry-types)
|
|
8
11
|
|
|
9
|
-
|
|
12
|
+
### Main Entry Types
|
|
13
|
+
|
|
14
|
+
<!--SECTION START: Main Entry Types-->
|
|
10
15
|
|
|
11
16
|
```ts
|
|
12
17
|
/// <reference types="react" />
|
|
@@ -90,7 +95,7 @@ export type DecisionStatus = 'CREATED';
|
|
|
90
95
|
export type DecisionType = 'DECISION';
|
|
91
96
|
|
|
92
97
|
// @public (undocumented)
|
|
93
|
-
export type Handler = (state:
|
|
98
|
+
export type Handler = (state: DecisionState | TaskState) => void;
|
|
94
99
|
|
|
95
100
|
// @public (undocumented)
|
|
96
101
|
export type Item = Decision | Task;
|
|
@@ -127,7 +132,7 @@ interface Props {
|
|
|
127
132
|
contentRef?: ContentRef;
|
|
128
133
|
// (undocumented)
|
|
129
134
|
dataAttributes?: {
|
|
130
|
-
[key: string]:
|
|
135
|
+
[key: string]: number | string;
|
|
131
136
|
};
|
|
132
137
|
// (undocumented)
|
|
133
138
|
placeholder?: string;
|
|
@@ -151,7 +156,7 @@ interface Props_3 {
|
|
|
151
156
|
contentRef?: ContentRef;
|
|
152
157
|
// (undocumented)
|
|
153
158
|
dataAttributes?: {
|
|
154
|
-
[key: string]:
|
|
159
|
+
[key: string]: number | string;
|
|
155
160
|
};
|
|
156
161
|
// (undocumented)
|
|
157
162
|
disabled?: boolean;
|
|
@@ -183,7 +188,7 @@ interface Props_4 {
|
|
|
183
188
|
contentRef?: ContentRef;
|
|
184
189
|
// (undocumented)
|
|
185
190
|
dataAttributes?: {
|
|
186
|
-
[key: string]:
|
|
191
|
+
[key: string]: number | string;
|
|
187
192
|
};
|
|
188
193
|
// (undocumented)
|
|
189
194
|
disabled?: boolean;
|
|
@@ -390,7 +395,7 @@ export interface TaskDecisionProvider {
|
|
|
390
395
|
subscribe(
|
|
391
396
|
objectKey: ObjectKey,
|
|
392
397
|
handler: Handler,
|
|
393
|
-
item?: BaseItem<
|
|
398
|
+
item?: BaseItem<DecisionState | TaskState>,
|
|
394
399
|
): void;
|
|
395
400
|
// (undocumented)
|
|
396
401
|
toggleTask(objectKey: ObjectKey, state: TaskState): Promise<TaskState>;
|
|
@@ -410,7 +415,7 @@ export class TaskDecisionResource implements TaskDecisionProvider {
|
|
|
410
415
|
subscribe(
|
|
411
416
|
objectKey: ObjectKey,
|
|
412
417
|
handler: Handler,
|
|
413
|
-
item?: BaseItem<
|
|
418
|
+
item?: BaseItem<DecisionState | TaskState>,
|
|
414
419
|
): void;
|
|
415
420
|
// (undocumented)
|
|
416
421
|
toggleTask(objectKey: ObjectKey, state: TaskState): Promise<TaskState>;
|
|
@@ -440,7 +445,7 @@ export class TaskList extends PureComponent<Props_5, {}> {
|
|
|
440
445
|
}
|
|
441
446
|
|
|
442
447
|
// @public (undocumented)
|
|
443
|
-
export type TaskState = '
|
|
448
|
+
export type TaskState = 'DONE' | 'TODO';
|
|
444
449
|
|
|
445
450
|
// @public (undocumented)
|
|
446
451
|
export type TaskType = 'TASK';
|
|
@@ -450,3 +455,5 @@ export type UserId = string;
|
|
|
450
455
|
|
|
451
456
|
// (No @packageDocumentation comment for this package)
|
|
452
457
|
```
|
|
458
|
+
|
|
459
|
+
<!--SECTION END: Main Entry Types-->
|
|
@@ -1,2 +0,0 @@
|
|
|
1
|
-
export declare const fabricElementsChannel = "fabric-elements";
|
|
2
|
-
export declare const createAndFireEventInElementsChannel: (payload: import("@atlaskit/analytics-next").AnalyticsEventPayload) => (createAnalyticsEvent: import("@atlaskit/analytics-next").CreateUIAnalyticsEvent) => import("@atlaskit/analytics-next").UIAnalyticsEvent;
|
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
import { BaseItem, ServiceTaskState, DecisionState, Handler, ObjectKey, PubSubClient, RecentUpdateContext, RecentUpdatesId, RecentUpdatesListener, ServiceTask, TaskDecisionProvider, TaskDecisionResourceConfig, TaskState, ServiceItem } from '../types';
|
|
2
|
-
export declare const ACTION_CREATED_FPS_EVENT = "avi:task-decision-service:created:action";
|
|
3
|
-
export declare const ACTION_EDITED_FPS_EVENT = "avi:task-decision-service:edited:action";
|
|
4
|
-
export declare const ACTION_DELETED_FPS_EVENT = "avi:task-decision-service:deleted:action";
|
|
5
|
-
export declare const ACTION_ARCHIVED_FPS_EVENT = "avi:task-decision-service:archived:action";
|
|
6
|
-
export declare const ACTION_STATE_CHANGED_FPS_EVENT = "avi:task-decision-service:stateChanged:action";
|
|
7
|
-
export declare const DECISION_CREATED_FPS_EVENT = "avi:task-decision-service:created:decision";
|
|
8
|
-
export declare const DECISION_EDITED_FPS_EVENT = "avi:task-decision-service:edited:decision";
|
|
9
|
-
export declare const DECISION_DELETED_FPS_EVENT = "avi:task-decision-service:deleted:decision";
|
|
10
|
-
export declare const DECISION_ARCHIVED_FPS_EVENT = "avi:task-decision-service:archived:decision";
|
|
11
|
-
export declare const DECISION_STATE_CHANGED_FPS_EVENT = "avi:task-decision-service:stateChanged:decision";
|
|
12
|
-
export declare const ACTION_DECISION_FPS_EVENTS = "avi:task-decision-service:*:*";
|
|
13
|
-
export declare class RecentUpdates {
|
|
14
|
-
private idsByContainer;
|
|
15
|
-
private listenersById;
|
|
16
|
-
private pubSubClient?;
|
|
17
|
-
constructor(pubSubClient?: PubSubClient);
|
|
18
|
-
subscribe(objectAri: string, recentUpdatesListener: RecentUpdatesListener): void;
|
|
19
|
-
unsubscribe(unsubscribeId: RecentUpdatesId): void;
|
|
20
|
-
notify(recentUpdateContext: RecentUpdateContext): void;
|
|
21
|
-
onPubSubEvent: (_event: string, payload: ServiceItem) => void;
|
|
22
|
-
destroy(): void;
|
|
23
|
-
private subscribeToPubSubEvents;
|
|
24
|
-
private unsubscribeFromPubSubEvents;
|
|
25
|
-
}
|
|
26
|
-
export declare class ItemStateManager {
|
|
27
|
-
private debouncedTaskStateQuery;
|
|
28
|
-
private debouncedTaskToggle;
|
|
29
|
-
private serviceConfig;
|
|
30
|
-
private subscribers;
|
|
31
|
-
private trackedObjectKeys;
|
|
32
|
-
private cachedItems;
|
|
33
|
-
private batchedKeys;
|
|
34
|
-
constructor(serviceConfig: TaskDecisionResourceConfig);
|
|
35
|
-
destroy(): void;
|
|
36
|
-
toggleTask(objectKey: ObjectKey, state: TaskState): Promise<TaskState>;
|
|
37
|
-
refreshAllTasks(): void;
|
|
38
|
-
subscribe(objectKey: ObjectKey, handler: Handler, item?: BaseItem<TaskState | DecisionState>): void;
|
|
39
|
-
unsubscribe(objectKey: ObjectKey, handler: Handler): void;
|
|
40
|
-
getTaskState(keys: ObjectKey[]): Promise<ServiceTaskState[]>;
|
|
41
|
-
notifyUpdated(objectKey: ObjectKey, state: TaskState | DecisionState): void;
|
|
42
|
-
onTaskUpdatedEvent: (_event: string, payload: ServiceTask) => void;
|
|
43
|
-
onReconnect: () => void;
|
|
44
|
-
private updateCache;
|
|
45
|
-
private getCached;
|
|
46
|
-
private subscribeToPubSubEvents;
|
|
47
|
-
private unsubscribeFromPubSubEvents;
|
|
48
|
-
private queueAllItems;
|
|
49
|
-
private queueItem;
|
|
50
|
-
private dequeueItem;
|
|
51
|
-
private scheduleGetTaskState;
|
|
52
|
-
}
|
|
53
|
-
export default class TaskDecisionResource implements TaskDecisionProvider {
|
|
54
|
-
private recentUpdates;
|
|
55
|
-
private itemStateManager;
|
|
56
|
-
constructor(serviceConfig: TaskDecisionResourceConfig);
|
|
57
|
-
unsubscribeRecentUpdates(id: RecentUpdatesId): void;
|
|
58
|
-
notifyRecentUpdates(recentUpdateContext: RecentUpdateContext): void;
|
|
59
|
-
toggleTask(objectKey: ObjectKey, state: TaskState): Promise<TaskState>;
|
|
60
|
-
subscribe(objectKey: ObjectKey, handler: Handler, item?: BaseItem<TaskState | DecisionState>): void;
|
|
61
|
-
unsubscribe(objectKey: ObjectKey, handler: Handler): void;
|
|
62
|
-
/**
|
|
63
|
-
* Usually only needed for testing to ensure no outstanding requests
|
|
64
|
-
* are sent to a server (typically mocked).
|
|
65
|
-
*/
|
|
66
|
-
destroy(): void;
|
|
67
|
-
}
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import { ServiceTask, Task, ServiceTaskState, BaseItem, TaskState } from '../types';
|
|
2
|
-
export declare const convertServiceTaskToTask: (serviceTask: ServiceTask) => Task;
|
|
3
|
-
export declare const convertServiceTaskStateToBaseItem: (serviceTaskInfo: ServiceTaskState) => BaseItem<TaskState>;
|
|
4
|
-
export declare const findIndex: (array: any[], predicate: (item: any) => boolean) => number;
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
/** @jsx jsx */
|
|
2
|
-
import { jsx } from '@emotion/react';
|
|
3
|
-
import { Appearance, ContentRef } from '../types';
|
|
4
|
-
export interface Props {
|
|
5
|
-
children?: any;
|
|
6
|
-
contentRef?: ContentRef;
|
|
7
|
-
placeholder?: string;
|
|
8
|
-
showPlaceholder?: boolean;
|
|
9
|
-
appearance?: Appearance;
|
|
10
|
-
dataAttributes?: {
|
|
11
|
-
[key: string]: string | number;
|
|
12
|
-
};
|
|
13
|
-
}
|
|
14
|
-
declare const DecisionItem: ({ appearance, children, contentRef, placeholder, showPlaceholder, dataAttributes, }: Props) => jsx.JSX.Element;
|
|
15
|
-
export default DecisionItem;
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
/** @jsx jsx */
|
|
2
|
-
import { PureComponent, ReactNode } from 'react';
|
|
3
|
-
import { jsx } from '@emotion/react';
|
|
4
|
-
export interface Props {
|
|
5
|
-
children?: ReactNode;
|
|
6
|
-
}
|
|
7
|
-
export default class DecisionList extends PureComponent<Props, {}> {
|
|
8
|
-
render(): jsx.JSX.Element | null;
|
|
9
|
-
}
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
/** @jsx jsx */
|
|
2
|
-
import { PureComponent } from 'react';
|
|
3
|
-
import { jsx } from '@emotion/react';
|
|
4
|
-
import { Appearance, ContentRef, TaskType, DecisionType } from '../types';
|
|
5
|
-
import type { Theme } from '@atlaskit/theme/types';
|
|
6
|
-
export interface Props {
|
|
7
|
-
icon: JSX.Element;
|
|
8
|
-
itemType: TaskType | DecisionType;
|
|
9
|
-
children?: any;
|
|
10
|
-
appearance?: Appearance;
|
|
11
|
-
contentRef?: ContentRef;
|
|
12
|
-
placeholder?: string;
|
|
13
|
-
showPlaceholder?: boolean;
|
|
14
|
-
dataAttributes?: {
|
|
15
|
-
[key: string]: string | number;
|
|
16
|
-
};
|
|
17
|
-
checkBoxId?: string;
|
|
18
|
-
theme: Theme;
|
|
19
|
-
}
|
|
20
|
-
export default class Item extends PureComponent<Props, {}> {
|
|
21
|
-
static defaultProps: Partial<Props>;
|
|
22
|
-
private renderPlaceholder;
|
|
23
|
-
renderMessageAppearance(): jsx.JSX.Element | null;
|
|
24
|
-
render(): jsx.JSX.Element | null;
|
|
25
|
-
}
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
import { PureComponent } from 'react';
|
|
2
|
-
import { Appearance, ContentRef, TaskDecisionProvider } from '../types';
|
|
3
|
-
export interface Props {
|
|
4
|
-
taskId: string;
|
|
5
|
-
isDone?: boolean;
|
|
6
|
-
isRenderer?: boolean;
|
|
7
|
-
onChange?: (taskId: string, isChecked: boolean) => void;
|
|
8
|
-
contentRef?: ContentRef;
|
|
9
|
-
children?: any;
|
|
10
|
-
taskDecisionProvider?: Promise<TaskDecisionProvider>;
|
|
11
|
-
objectAri?: string;
|
|
12
|
-
showPlaceholder?: boolean;
|
|
13
|
-
placeholder?: string;
|
|
14
|
-
appearance?: Appearance;
|
|
15
|
-
disabled?: boolean;
|
|
16
|
-
dataAttributes?: {
|
|
17
|
-
[key: string]: string | number;
|
|
18
|
-
};
|
|
19
|
-
}
|
|
20
|
-
export interface State {
|
|
21
|
-
isDone?: boolean;
|
|
22
|
-
}
|
|
23
|
-
export default class ResourcedTaskItem extends PureComponent<Props, State> {
|
|
24
|
-
static defaultProps: Partial<Props>;
|
|
25
|
-
private mounted;
|
|
26
|
-
constructor(props: Props);
|
|
27
|
-
componentDidMount(): void;
|
|
28
|
-
UNSAFE_componentWillReceiveProps(nextProps: Props): void;
|
|
29
|
-
componentWillUnmount(): void;
|
|
30
|
-
private subscribe;
|
|
31
|
-
private unsubscribe;
|
|
32
|
-
private onUpdate;
|
|
33
|
-
private handleOnChange;
|
|
34
|
-
render(): JSX.Element;
|
|
35
|
-
}
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
/** @jsx jsx */
|
|
2
|
-
import React from 'react';
|
|
3
|
-
import { Appearance, ContentRef } from '../types';
|
|
4
|
-
import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
|
|
5
|
-
export interface Props {
|
|
6
|
-
taskId: string;
|
|
7
|
-
isDone?: boolean;
|
|
8
|
-
isRenderer?: boolean;
|
|
9
|
-
onChange?: (taskId: string, isChecked: boolean) => void;
|
|
10
|
-
contentRef?: ContentRef;
|
|
11
|
-
children?: any;
|
|
12
|
-
placeholder?: string;
|
|
13
|
-
showPlaceholder?: boolean;
|
|
14
|
-
appearance?: Appearance;
|
|
15
|
-
disabled?: boolean;
|
|
16
|
-
dataAttributes?: {
|
|
17
|
-
[key: string]: string | number;
|
|
18
|
-
};
|
|
19
|
-
}
|
|
20
|
-
declare const _default: React.ForwardRefExoticComponent<Omit<Props & WithAnalyticsEventsProps, keyof WithAnalyticsEventsProps> & React.RefAttributes<any>>;
|
|
21
|
-
export default _default;
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import { PureComponent, ReactNode } from 'react';
|
|
2
|
-
import { jsx } from '@emotion/react';
|
|
3
|
-
export interface Props {
|
|
4
|
-
listId?: string;
|
|
5
|
-
children?: ReactNode;
|
|
6
|
-
}
|
|
7
|
-
export default class TaskList extends PureComponent<Props, {}> {
|
|
8
|
-
render(): jsx.JSX.Element | null;
|
|
9
|
-
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const defaultLimit = 100;
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import DecisionItem from './components/DecisionItem';
|
|
2
|
-
import DecisionList from './components/DecisionList';
|
|
3
|
-
import ResourcedTaskItem from './components/ResourcedTaskItem';
|
|
4
|
-
import TaskDecisionResource from './api/TaskDecisionResource';
|
|
5
|
-
import TaskItem from './components/TaskItem';
|
|
6
|
-
import TaskList from './components/TaskList';
|
|
7
|
-
export { PubSubSpecialEventType } from './types';
|
|
8
|
-
export type { Appearance, ARI, AVI, BaseItem, ContentRef, Cursor, Decision, DecisionState, DecisionStatus, DecisionType, Handler, Item, Meta, ObjectKey, OnUpdate, PubSubClient, PubSubOnEvent, RecentUpdateContext, RecentUpdatesId, RecentUpdatesListener, RenderDocument, RendererContext, ServiceDecision, ServiceDecisionResponse, ServiceItem, ServiceTask, ServiceTaskState, Task, TaskDecisionProvider, TaskDecisionResourceConfig, TaskState, TaskType, UserId, } from './types';
|
|
9
|
-
export { DecisionItem, DecisionList, ResourcedTaskItem, TaskDecisionResource, TaskItem, TaskList, };
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import { BaseItem, Decision, Item, ObjectKey, ServiceDecision, ServiceTask, Task, TaskState } from './types';
|
|
2
|
-
export declare const isDecision: (item: Item) => item is Decision;
|
|
3
|
-
export declare const isTask: (item: Item) => item is Task;
|
|
4
|
-
export declare const toObjectKey: (item: Item | ServiceDecision | ServiceTask | BaseItem<any>) => ObjectKey;
|
|
5
|
-
export declare const objectKeyToString: (objectKey: ObjectKey) => string;
|
|
6
|
-
export declare const toggleTaskState: (state: TaskState) => TaskState;
|
|
@@ -1,160 +0,0 @@
|
|
|
1
|
-
/// <reference types="react" />
|
|
2
|
-
import { ServiceConfig } from '@atlaskit/util-service-support';
|
|
3
|
-
export declare type DecisionState = 'DECIDED';
|
|
4
|
-
export declare type DecisionStatus = 'CREATED';
|
|
5
|
-
export declare type TaskState = 'TODO' | 'DONE';
|
|
6
|
-
export declare type Cursor = string;
|
|
7
|
-
export declare type DecisionType = 'DECISION';
|
|
8
|
-
export declare type TaskType = 'TASK';
|
|
9
|
-
export interface ContentRef {
|
|
10
|
-
(ref: HTMLElement | null): void;
|
|
11
|
-
}
|
|
12
|
-
export interface ObjectKey {
|
|
13
|
-
localId: string;
|
|
14
|
-
containerAri?: string;
|
|
15
|
-
objectAri: string;
|
|
16
|
-
}
|
|
17
|
-
export interface BaseItem<S> extends ObjectKey {
|
|
18
|
-
state: S;
|
|
19
|
-
lastUpdateDate: Date;
|
|
20
|
-
type: DecisionType | TaskType;
|
|
21
|
-
}
|
|
22
|
-
export interface ServiceDecision {
|
|
23
|
-
creationDate?: string;
|
|
24
|
-
creatorId?: UserId;
|
|
25
|
-
lastUpdaterId?: UserId;
|
|
26
|
-
lastUpdateDate: string;
|
|
27
|
-
localId: string;
|
|
28
|
-
objectAri: string;
|
|
29
|
-
participants?: UserId[];
|
|
30
|
-
state?: DecisionState;
|
|
31
|
-
status: DecisionStatus;
|
|
32
|
-
type: DecisionType;
|
|
33
|
-
}
|
|
34
|
-
export interface Meta {
|
|
35
|
-
cursor?: string;
|
|
36
|
-
}
|
|
37
|
-
export interface ServiceDecisionResponse {
|
|
38
|
-
decisions: ServiceDecision[];
|
|
39
|
-
meta: Meta;
|
|
40
|
-
}
|
|
41
|
-
export declare type ServiceItem = ServiceDecision | ServiceTask;
|
|
42
|
-
export interface ServiceTaskState {
|
|
43
|
-
lastUpdateDate: string;
|
|
44
|
-
localId: string;
|
|
45
|
-
objectAri: string;
|
|
46
|
-
state: TaskState;
|
|
47
|
-
}
|
|
48
|
-
export interface Decision extends BaseItem<DecisionState> {
|
|
49
|
-
creationDate?: Date;
|
|
50
|
-
creator?: UserId;
|
|
51
|
-
lastUpdater?: UserId;
|
|
52
|
-
lastUpdateDate: Date;
|
|
53
|
-
participants?: UserId[];
|
|
54
|
-
status: DecisionStatus;
|
|
55
|
-
type: DecisionType;
|
|
56
|
-
}
|
|
57
|
-
export declare type Item = Decision | Task;
|
|
58
|
-
export declare type UserId = string;
|
|
59
|
-
export interface ServiceTask {
|
|
60
|
-
creationDate?: string;
|
|
61
|
-
creatorId?: UserId;
|
|
62
|
-
lastUpdaterId?: UserId;
|
|
63
|
-
lastUpdateDate: string;
|
|
64
|
-
localId: string;
|
|
65
|
-
objectAri: string;
|
|
66
|
-
parentLocalId?: string;
|
|
67
|
-
participants?: UserId[];
|
|
68
|
-
position: number;
|
|
69
|
-
state: TaskState;
|
|
70
|
-
type: TaskType;
|
|
71
|
-
}
|
|
72
|
-
export interface Task extends BaseItem<TaskState> {
|
|
73
|
-
creationDate?: Date;
|
|
74
|
-
creator?: UserId;
|
|
75
|
-
lastUpdater?: UserId;
|
|
76
|
-
lastUpdateDate: Date;
|
|
77
|
-
parentLocalId?: string;
|
|
78
|
-
participants?: UserId[];
|
|
79
|
-
position?: number;
|
|
80
|
-
type: TaskType;
|
|
81
|
-
}
|
|
82
|
-
export declare type Handler = (state: TaskState | DecisionState) => void;
|
|
83
|
-
export declare type RecentUpdatesId = string;
|
|
84
|
-
export interface RecentUpdateContext {
|
|
85
|
-
objectAri: string;
|
|
86
|
-
localId?: string;
|
|
87
|
-
}
|
|
88
|
-
/**
|
|
89
|
-
* A subscriber interface that can be called back if there are new decisions/tasks/items
|
|
90
|
-
* available as the result of an external change.
|
|
91
|
-
*/
|
|
92
|
-
export interface RecentUpdatesListener {
|
|
93
|
-
/**
|
|
94
|
-
* An id that can be used to unsubscribe
|
|
95
|
-
*/
|
|
96
|
-
id(id: RecentUpdatesId): void;
|
|
97
|
-
/**
|
|
98
|
-
* Indicates there are recent updates, and the listener should refresh
|
|
99
|
-
* the latest items from the TaskDecisionProvider.
|
|
100
|
-
*
|
|
101
|
-
* There will be a number of retries until expectedLocalId, if passed.
|
|
102
|
-
*
|
|
103
|
-
* @param updateContext Recent update context
|
|
104
|
-
*/
|
|
105
|
-
recentUpdates(updateContext: RecentUpdateContext): void;
|
|
106
|
-
}
|
|
107
|
-
export interface TaskDecisionResourceConfig extends ServiceConfig {
|
|
108
|
-
pubSubClient?: PubSubClient;
|
|
109
|
-
/**
|
|
110
|
-
* Indicates if initial state for an action or decision is should be cached,
|
|
111
|
-
* from the content, i.e. was originally hydrated from the service initially,
|
|
112
|
-
* and so should be considered up to date.
|
|
113
|
-
*
|
|
114
|
-
* Will stop the initiation of the hydration from the service the first
|
|
115
|
-
* time an action or decision is seen.
|
|
116
|
-
*
|
|
117
|
-
* If false the state will always be hydrated from the service on first view.
|
|
118
|
-
*/
|
|
119
|
-
disableServiceHydration?: boolean;
|
|
120
|
-
}
|
|
121
|
-
export interface TaskDecisionProvider {
|
|
122
|
-
unsubscribeRecentUpdates(id: RecentUpdatesId): void;
|
|
123
|
-
notifyRecentUpdates(updateContext: RecentUpdateContext): void;
|
|
124
|
-
toggleTask(objectKey: ObjectKey, state: TaskState): Promise<TaskState>;
|
|
125
|
-
subscribe(objectKey: ObjectKey, handler: Handler, item?: BaseItem<TaskState | DecisionState>): void;
|
|
126
|
-
unsubscribe(objectKey: ObjectKey, handler: Handler): void;
|
|
127
|
-
}
|
|
128
|
-
/**
|
|
129
|
-
* Same as RendererContext in editor-core (don't want an direct dep though)
|
|
130
|
-
*/
|
|
131
|
-
export interface RendererContext {
|
|
132
|
-
objectAri: string;
|
|
133
|
-
containerAri?: string;
|
|
134
|
-
}
|
|
135
|
-
export interface RenderDocument {
|
|
136
|
-
(document: any, rendererContext?: RendererContext): JSX.Element;
|
|
137
|
-
}
|
|
138
|
-
export interface OnUpdate<T> {
|
|
139
|
-
(allDecisions: T[], newDecisions: T[]): void;
|
|
140
|
-
}
|
|
141
|
-
export declare type Appearance = 'inline';
|
|
142
|
-
/**
|
|
143
|
-
* Same as PubSub client types (don't want a direct dep though)
|
|
144
|
-
*/
|
|
145
|
-
export declare type ARI = string;
|
|
146
|
-
export declare type AVI = string;
|
|
147
|
-
export interface PubSubOnEvent<T = any> {
|
|
148
|
-
(event: string, data: T): void;
|
|
149
|
-
}
|
|
150
|
-
export interface PubSubClient {
|
|
151
|
-
on(eventAvi: string, listener: PubSubOnEvent): PubSubClient;
|
|
152
|
-
off(eventAvi: string, listener: PubSubOnEvent): PubSubClient;
|
|
153
|
-
join(aris: ARI[]): Promise<PubSubClient>;
|
|
154
|
-
leave(aris: ARI[]): Promise<PubSubClient>;
|
|
155
|
-
}
|
|
156
|
-
export declare enum PubSubSpecialEventType {
|
|
157
|
-
ERROR = "ERROR",
|
|
158
|
-
CONNECTED = "CONNECTED",
|
|
159
|
-
RECONNECT = "RECONNECT"
|
|
160
|
-
}
|