@atlaskit/task-decision 19.2.8 → 19.2.9

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/task-decision
 
+## 19.2.9
+
+### Patch Changes
+
+- [`0fdcb6f2f96fd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0fdcb6f2f96fd) -
+  Sorted type and interface props to improve Atlaskit docs
+- Updated dependencies
+
 ## 19.2.8
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -3,9 +3,9 @@
 	"compilerOptions": {
 		"declaration": true,
 		"target": "es5",
-		"composite": true,
 		"outDir": "../../../../../confluence/tsDist/@atlaskit__task-decision",
-		"rootDir": "../"
+		"rootDir": "../",
+		"composite": true
 	},
 	"include": [
 		"../src/**/*.ts",

package/dist/types/components/DecisionItem.d.ts

@@ -1,13 +1,13 @@
 import { type Appearance, type ContentRef } from '../types';
 export interface Props {
+    appearance?: Appearance;
     children?: any;
     contentRef?: ContentRef;
-    placeholder?: string;
-    showPlaceholder?: boolean;
-    appearance?: Appearance;
     dataAttributes?: {
         [key: string]: string | number;
     };
+    placeholder?: string;
+    showPlaceholder?: boolean;
 }
 declare const DecisionItem: ({ appearance, children, contentRef, placeholder, showPlaceholder, dataAttributes, }: Props) => JSX.Element;
 export default DecisionItem;

package/dist/types/components/Item.d.ts

@@ -5,17 +5,17 @@
 import { PureComponent } from 'react';
 import { type Appearance, type ContentRef, type TaskType, type DecisionType } from '../types';
 export interface Props {
-    icon: JSX.Element;
-    itemType: TaskType | DecisionType;
-    children?: any;
     appearance?: Appearance;
+    checkBoxId?: string;
+    children?: any;
     contentRef?: ContentRef;
-    placeholder?: string;
-    showPlaceholder?: boolean;
     dataAttributes?: {
         [key: string]: string | number;
     };
-    checkBoxId?: string;
+    icon: JSX.Element;
+    itemType: TaskType | DecisionType;
+    placeholder?: string;
+    showPlaceholder?: boolean;
 }
 export default class Item extends PureComponent<Props, {}> {
     static defaultProps: Partial<Props>;

package/dist/types/components/ResourcedTaskItem.d.ts

@@ -2,25 +2,25 @@ import React, { type Ref } from 'react';
 import { PureComponent } from 'react';
 import { type Appearance, type ContentRef, type TaskDecisionProvider } from '../types';
 export interface Props {
-    taskId: string;
-    isDone?: boolean;
-    isRenderer?: boolean;
-    isFocused?: boolean;
-    onChange?: (taskId: string, isChecked: boolean) => void;
-    onClick?: () => void;
-    contentRef?: ContentRef;
-    children?: any;
-    taskDecisionProvider?: Promise<TaskDecisionProvider>;
-    objectAri?: string;
-    showPlaceholder?: boolean;
-    placeholder?: string;
     appearance?: Appearance;
-    disabled?: boolean;
+    children?: any;
+    contentRef?: ContentRef;
     dataAttributes?: {
         [key: string]: string | number;
     };
-    inputRef?: Ref<HTMLInputElement>;
+    disabled?: boolean;
     disableOnChange?: boolean;
+    inputRef?: Ref<HTMLInputElement>;
+    isDone?: boolean;
+    isFocused?: boolean;
+    isRenderer?: boolean;
+    objectAri?: string;
+    onChange?: (taskId: string, isChecked: boolean) => void;
+    onClick?: () => void;
+    placeholder?: string;
+    showPlaceholder?: boolean;
+    taskDecisionProvider?: Promise<TaskDecisionProvider>;
+    taskId: string;
 }
 export interface State {
     isDone?: boolean;

package/dist/types/components/TaskItem.d.ts

@@ -6,22 +6,22 @@ import React, { type Ref } from 'react';
 import { type Appearance, type ContentRef } from '../types';
 import { type WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
 export interface Props {
-    taskId: string;
+    appearance?: Appearance;
+    children?: any;
+    contentRef?: ContentRef;
+    dataAttributes?: {
+        [key: string]: string | number;
+    };
+    disabled?: boolean;
+    inputRef?: Ref<HTMLInputElement>;
     isDone?: boolean;
     isFocused?: boolean;
     isRenderer?: boolean;
     onChange?: (taskId: string, isChecked: boolean) => void;
     onClick?: () => void;
-    contentRef?: ContentRef;
-    children?: any;
     placeholder?: string;
     showPlaceholder?: boolean;
-    appearance?: Appearance;
-    disabled?: boolean;
-    dataAttributes?: {
-        [key: string]: string | number;
-    };
-    inputRef?: Ref<HTMLInputElement>;
+    taskId: string;
 }
 declare const _default: React.ForwardRefExoticComponent<Omit<Props, keyof WithAnalyticsEventsProps> & React.RefAttributes<any>>;
 export default _default;

package/dist/types/components/TaskList.d.ts

@@ -4,8 +4,8 @@
  */
 import { type ReactNode } from 'react';
 export interface Props {
-    listId?: string;
     children?: ReactNode;
+    listId?: string;
 }
 declare const TaskList: ({ listId, children }: Props) => JSX.Element | null;
 export default TaskList;

package/dist/types/types.d.ts

@@ -9,20 +9,20 @@ export interface ContentRef {
     (ref: HTMLElement | null): void;
 }
 export interface ObjectKey {
-    localId: string;
     containerAri?: string;
+    localId: string;
     objectAri: string;
 }
 export interface BaseItem<S> extends ObjectKey {
-    state: S;
     lastUpdateDate: Date;
+    state: S;
     type: DecisionType | TaskType;
 }
 export interface ServiceDecision {
     creationDate?: string;
     creatorId?: UserId;
-    lastUpdaterId?: UserId;
     lastUpdateDate: string;
+    lastUpdaterId?: UserId;
     localId: string;
     objectAri: string;
     participants?: UserId[];
@@ -47,8 +47,8 @@ export interface ServiceTaskState {
 export interface Decision extends BaseItem<DecisionState> {
     creationDate?: Date;
     creator?: UserId;
-    lastUpdater?: UserId;
     lastUpdateDate: Date;
+    lastUpdater?: UserId;
     participants?: UserId[];
     status: DecisionStatus;
     type: DecisionType;
@@ -58,8 +58,8 @@ export type UserId = string;
 export interface ServiceTask {
     creationDate?: string;
     creatorId?: UserId;
-    lastUpdaterId?: UserId;
     lastUpdateDate: string;
+    lastUpdaterId?: UserId;
     localId: string;
     objectAri: string;
     parentLocalId?: string;
@@ -71,8 +71,8 @@ export interface ServiceTask {
 export interface Task extends BaseItem<TaskState> {
     creationDate?: Date;
     creator?: UserId;
-    lastUpdater?: UserId;
     lastUpdateDate: Date;
+    lastUpdater?: UserId;
     parentLocalId?: string;
     participants?: UserId[];
     position?: number;
@@ -81,8 +81,8 @@ export interface Task extends BaseItem<TaskState> {
 export type Handler = (state: TaskState | DecisionState) => void;
 export type RecentUpdatesId = string;
 export interface RecentUpdateContext {
-    objectAri: string;
     localId?: string;
+    objectAri: string;
 }
 /**
  * A subscriber interface that can be called back if there are new decisions/tasks/items
@@ -104,7 +104,6 @@ export interface RecentUpdatesListener {
     recentUpdates(updateContext: RecentUpdateContext): void;
 }
 export interface TaskDecisionResourceConfig extends ServiceConfig {
-    pubSubClient?: PubSubClient;
     /**
      * Indicates if initial state for an action or decision is should be cached,
      * from the content, i.e. was originally hydrated from the service initially,
@@ -116,20 +115,21 @@ export interface TaskDecisionResourceConfig extends ServiceConfig {
      * If false the state will always be hydrated from the service on first view.
      */
     disableServiceHydration?: boolean;
+    pubSubClient?: PubSubClient;
 }
 export interface TaskDecisionProvider {
-    unsubscribeRecentUpdates(id: RecentUpdatesId): void;
     notifyRecentUpdates(updateContext: RecentUpdateContext): void;
-    toggleTask(objectKey: ObjectKey, state: TaskState): Promise<TaskState>;
     subscribe(objectKey: ObjectKey, handler: Handler, item?: BaseItem<TaskState | DecisionState>): void;
+    toggleTask(objectKey: ObjectKey, state: TaskState): Promise<TaskState>;
     unsubscribe(objectKey: ObjectKey, handler: Handler): void;
+    unsubscribeRecentUpdates(id: RecentUpdatesId): void;
 }
 /**
  * Same as RendererContext in editor-core (don't want an direct dep though)
  */
 export interface RendererContext {
-    objectAri: string;
     containerAri?: string;
+    objectAri: string;
 }
 export interface RenderDocument {
     (document: any, rendererContext?: RendererContext): JSX.Element;
@@ -147,10 +147,10 @@ export interface PubSubOnEvent<T = any> {
     (event: string, data: T): void;
 }
 export interface PubSubClient {
-    on(eventAvi: string, listener: PubSubOnEvent): PubSubClient;
-    off(eventAvi: string, listener: PubSubOnEvent): PubSubClient;
     join(aris: ARI[]): Promise<PubSubClient>;
     leave(aris: ARI[]): Promise<PubSubClient>;
+    off(eventAvi: string, listener: PubSubOnEvent): PubSubClient;
+    on(eventAvi: string, listener: PubSubOnEvent): PubSubClient;
 }
 export declare enum PubSubSpecialEventType {
     ERROR = "ERROR",

package/dist/types-ts4.5/components/DecisionItem.d.ts

@@ -1,13 +1,13 @@
 import { type Appearance, type ContentRef } from '../types';
 export interface Props {
+    appearance?: Appearance;
     children?: any;
     contentRef?: ContentRef;
-    placeholder?: string;
-    showPlaceholder?: boolean;
-    appearance?: Appearance;
     dataAttributes?: {
         [key: string]: string | number;
     };
+    placeholder?: string;
+    showPlaceholder?: boolean;
 }
 declare const DecisionItem: ({ appearance, children, contentRef, placeholder, showPlaceholder, dataAttributes, }: Props) => JSX.Element;
 export default DecisionItem;

package/dist/types-ts4.5/components/Item.d.ts

@@ -5,17 +5,17 @@
 import { PureComponent } from 'react';
 import { type Appearance, type ContentRef, type TaskType, type DecisionType } from '../types';
 export interface Props {
-    icon: JSX.Element;
-    itemType: TaskType | DecisionType;
-    children?: any;
     appearance?: Appearance;
+    checkBoxId?: string;
+    children?: any;
     contentRef?: ContentRef;
-    placeholder?: string;
-    showPlaceholder?: boolean;
     dataAttributes?: {
         [key: string]: string | number;
     };
-    checkBoxId?: string;
+    icon: JSX.Element;
+    itemType: TaskType | DecisionType;
+    placeholder?: string;
+    showPlaceholder?: boolean;
 }
 export default class Item extends PureComponent<Props, {}> {
     static defaultProps: Partial<Props>;

package/dist/types-ts4.5/components/ResourcedTaskItem.d.ts

@@ -2,25 +2,25 @@ import React, { type Ref } from 'react';
 import { PureComponent } from 'react';
 import { type Appearance, type ContentRef, type TaskDecisionProvider } from '../types';
 export interface Props {
-    taskId: string;
-    isDone?: boolean;
-    isRenderer?: boolean;
-    isFocused?: boolean;
-    onChange?: (taskId: string, isChecked: boolean) => void;
-    onClick?: () => void;
-    contentRef?: ContentRef;
-    children?: any;
-    taskDecisionProvider?: Promise<TaskDecisionProvider>;
-    objectAri?: string;
-    showPlaceholder?: boolean;
-    placeholder?: string;
     appearance?: Appearance;
-    disabled?: boolean;
+    children?: any;
+    contentRef?: ContentRef;
     dataAttributes?: {
         [key: string]: string | number;
     };
-    inputRef?: Ref<HTMLInputElement>;
+    disabled?: boolean;
     disableOnChange?: boolean;
+    inputRef?: Ref<HTMLInputElement>;
+    isDone?: boolean;
+    isFocused?: boolean;
+    isRenderer?: boolean;
+    objectAri?: string;
+    onChange?: (taskId: string, isChecked: boolean) => void;
+    onClick?: () => void;
+    placeholder?: string;
+    showPlaceholder?: boolean;
+    taskDecisionProvider?: Promise<TaskDecisionProvider>;
+    taskId: string;
 }
 export interface State {
     isDone?: boolean;

package/dist/types-ts4.5/components/TaskItem.d.ts

@@ -6,22 +6,22 @@ import React, { type Ref } from 'react';
 import { type Appearance, type ContentRef } from '../types';
 import { type WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
 export interface Props {
-    taskId: string;
+    appearance?: Appearance;
+    children?: any;
+    contentRef?: ContentRef;
+    dataAttributes?: {
+        [key: string]: string | number;
+    };
+    disabled?: boolean;
+    inputRef?: Ref<HTMLInputElement>;
     isDone?: boolean;
     isFocused?: boolean;
     isRenderer?: boolean;
     onChange?: (taskId: string, isChecked: boolean) => void;
     onClick?: () => void;
-    contentRef?: ContentRef;
-    children?: any;
     placeholder?: string;
     showPlaceholder?: boolean;
-    appearance?: Appearance;
-    disabled?: boolean;
-    dataAttributes?: {
-        [key: string]: string | number;
-    };
-    inputRef?: Ref<HTMLInputElement>;
+    taskId: string;
 }
 declare const _default: React.ForwardRefExoticComponent<Omit<Props, keyof WithAnalyticsEventsProps> & React.RefAttributes<any>>;
 export default _default;

package/dist/types-ts4.5/components/TaskList.d.ts

@@ -4,8 +4,8 @@
  */
 import { type ReactNode } from 'react';
 export interface Props {
-    listId?: string;
     children?: ReactNode;
+    listId?: string;
 }
 declare const TaskList: ({ listId, children }: Props) => JSX.Element | null;
 export default TaskList;

package/dist/types-ts4.5/types.d.ts

@@ -9,20 +9,20 @@ export interface ContentRef {
     (ref: HTMLElement | null): void;
 }
 export interface ObjectKey {
-    localId: string;
     containerAri?: string;
+    localId: string;
     objectAri: string;
 }
 export interface BaseItem<S> extends ObjectKey {
-    state: S;
     lastUpdateDate: Date;
+    state: S;
     type: DecisionType | TaskType;
 }
 export interface ServiceDecision {
     creationDate?: string;
     creatorId?: UserId;
-    lastUpdaterId?: UserId;
     lastUpdateDate: string;
+    lastUpdaterId?: UserId;
     localId: string;
     objectAri: string;
     participants?: UserId[];
@@ -47,8 +47,8 @@ export interface ServiceTaskState {
 export interface Decision extends BaseItem<DecisionState> {
     creationDate?: Date;
     creator?: UserId;
-    lastUpdater?: UserId;
     lastUpdateDate: Date;
+    lastUpdater?: UserId;
     participants?: UserId[];
     status: DecisionStatus;
     type: DecisionType;
@@ -58,8 +58,8 @@ export type UserId = string;
 export interface ServiceTask {
     creationDate?: string;
     creatorId?: UserId;
-    lastUpdaterId?: UserId;
     lastUpdateDate: string;
+    lastUpdaterId?: UserId;
     localId: string;
     objectAri: string;
     parentLocalId?: string;
@@ -71,8 +71,8 @@ export interface ServiceTask {
 export interface Task extends BaseItem<TaskState> {
     creationDate?: Date;
     creator?: UserId;
-    lastUpdater?: UserId;
     lastUpdateDate: Date;
+    lastUpdater?: UserId;
     parentLocalId?: string;
     participants?: UserId[];
     position?: number;
@@ -81,8 +81,8 @@ export interface Task extends BaseItem<TaskState> {
 export type Handler = (state: TaskState | DecisionState) => void;
 export type RecentUpdatesId = string;
 export interface RecentUpdateContext {
-    objectAri: string;
     localId?: string;
+    objectAri: string;
 }
 /**
  * A subscriber interface that can be called back if there are new decisions/tasks/items
@@ -104,7 +104,6 @@ export interface RecentUpdatesListener {
     recentUpdates(updateContext: RecentUpdateContext): void;
 }
 export interface TaskDecisionResourceConfig extends ServiceConfig {
-    pubSubClient?: PubSubClient;
     /**
      * Indicates if initial state for an action or decision is should be cached,
      * from the content, i.e. was originally hydrated from the service initially,
@@ -116,20 +115,21 @@ export interface TaskDecisionResourceConfig extends ServiceConfig {
      * If false the state will always be hydrated from the service on first view.
      */
     disableServiceHydration?: boolean;
+    pubSubClient?: PubSubClient;
 }
 export interface TaskDecisionProvider {
-    unsubscribeRecentUpdates(id: RecentUpdatesId): void;
     notifyRecentUpdates(updateContext: RecentUpdateContext): void;
-    toggleTask(objectKey: ObjectKey, state: TaskState): Promise<TaskState>;
     subscribe(objectKey: ObjectKey, handler: Handler, item?: BaseItem<TaskState | DecisionState>): void;
+    toggleTask(objectKey: ObjectKey, state: TaskState): Promise<TaskState>;
     unsubscribe(objectKey: ObjectKey, handler: Handler): void;
+    unsubscribeRecentUpdates(id: RecentUpdatesId): void;
 }
 /**
  * Same as RendererContext in editor-core (don't want an direct dep though)
  */
 export interface RendererContext {
-    objectAri: string;
     containerAri?: string;
+    objectAri: string;
 }
 export interface RenderDocument {
     (document: any, rendererContext?: RendererContext): JSX.Element;
@@ -147,10 +147,10 @@ export interface PubSubOnEvent<T = any> {
     (event: string, data: T): void;
 }
 export interface PubSubClient {
-    on(eventAvi: string, listener: PubSubOnEvent): PubSubClient;
-    off(eventAvi: string, listener: PubSubOnEvent): PubSubClient;
     join(aris: ARI[]): Promise<PubSubClient>;
     leave(aris: ARI[]): Promise<PubSubClient>;
+    off(eventAvi: string, listener: PubSubOnEvent): PubSubClient;
+    on(eventAvi: string, listener: PubSubOnEvent): PubSubClient;
 }
 export declare enum PubSubSpecialEventType {
     ERROR = "ERROR",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/task-decision",
-	"version": "19.2.8",
+	"version": "19.2.9",
 	"description": "Tasks and decisions react components",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"