@atlaskit/embedded-document 1.1.0 → 1.1.1

package/CHANGELOG.md

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

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

@@ -6,10 +6,10 @@ import { type Mode } from '../context/context';
 import { type Document as DocumentModel } from '../model';
 export interface Props extends BaseProps {
     doc?: DocumentModel;
-    isLoading?: boolean;
+    editorProps?: Partial<EditorProps>;
     hasError?: boolean;
+    isLoading?: boolean;
     mode: Mode;
-    editorProps?: Partial<EditorProps>;
     rendererProps?: Partial<RendererProps>;
 }
 export default class Document extends Component<Props> {

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

@@ -1,7 +1,7 @@
 import React from 'react';
 import type { Mode } from '../context/context';
 declare const _default: (props: {
-    mode: Mode;
     editorActions?: any;
+    mode: Mode;
 }) => React.JSX.Element;
 export default _default;

package/dist/types/consumers/consumer.d.ts

@@ -1,15 +1,15 @@
 import React, { PureComponent } from 'react';
 import { type Actions, type State } from '../context/context';
 export interface Props<PropsFromState extends Object, PropsFromActions extends Object, RenderProps extends Object> {
-    stateMapper?: (state: State) => PropsFromState;
     actionsMapper?: (actions: Actions) => PropsFromActions;
-    renderPropsMapper?: (renderProps: any) => RenderProps;
     children: (props: PropsFromState & PropsFromActions & RenderProps) => React.ReactNode;
+    renderPropsMapper?: (renderProps: any) => RenderProps;
+    stateMapper?: (state: State) => PropsFromState;
 }
 export interface ConsumerProps<A, V, R> {
     actions: A;
-    value: V;
     renderProps: R;
+    value: V;
 }
 export declare class Consumer<PropsFromState extends Object, PropsFromActions extends Object, RenderProps extends Object> extends PureComponent<Props<PropsFromState, PropsFromActions, RenderProps>> {
     private previousActions;

package/dist/types/consumers/with-document-actions.d.ts

@@ -4,9 +4,9 @@ export interface Props {
     render: (actions: DocumentActions) => React.ReactNode;
 }
 export interface DocumentActions {
+    cancelEdit: () => void;
     createDocument: (value: any) => Promise<DocumentModel>;
     editDocument: () => void;
-    cancelEdit: () => void;
     updateDocument: (value: any) => Promise<DocumentModel>;
 }
 export default class WithDocumentActions extends PureComponent<Props> {

package/dist/types/context/context.d.ts

@@ -1,21 +1,21 @@
 import { type Document } from '../model';
 export interface ContextType {
-    value: State;
     actions: Actions;
     renderProps: any;
+    value: State;
 }
 export interface State {
     doc?: Document;
-    isLoading?: boolean;
     hasError?: boolean;
+    isLoading?: boolean;
     mode?: Mode;
 }
 export type Mode = 'view' | 'edit' | 'create';
 export interface Actions {
+    createDocument: (body: string, title?: string, language?: string) => Promise<Document>;
     getDocument: (documentId: string, language?: string) => void;
     getDocumentByObjectId: (objectId: string, language?: string) => void;
     setDocumentMode: (mode: Mode) => void;
     updateDocument: (body: string, title?: string, language?: string) => Promise<Document>;
-    createDocument: (body: string, title?: string, language?: string) => Promise<Document>;
 }
 export declare const Context: import("react").Context<ContextType>;

package/dist/types/context/embedded-document.d.ts

@@ -4,14 +4,14 @@ import type { Mode, State } from './context';
 import type { ProviderProps } from '../provider';
 export declare const akEditorFullPageMaxWidth = 680;
 export interface Props extends ProviderProps {
-    objectId: string;
-    documentId?: string;
+    children?: React.ReactNode;
     containerId?: string;
+    documentId?: string;
     language?: string;
     mode?: Mode;
+    objectId: string;
     renderTitle?: (mode: Mode, doc?: any) => ReactElement<any>;
     renderToolbar?: (mode: Mode, editorActions?: any) => ReactElement<any>;
-    children?: React.ReactNode;
 }
 export default class EmbeddedDocument extends Component<Props, State> {
     private actions;

package/dist/types/model/index.d.ts

@@ -1,11 +1,11 @@
 export interface Document {
-    documentId: string;
-    objectId: string;
+    body: string;
     containerId?: string;
     createdBy: User;
+    documentId: string;
     language?: string;
+    objectId: string;
     title?: string;
-    body: string;
 }
 export type User = Object;
 export interface BatchDocumentResponse {

package/dist/types/provider/provider.d.ts

@@ -1,7 +1,7 @@
 import { type Document } from '../model';
 export interface Provider {
+    createDocument: (body: string, objectId: string, title?: string, language?: string) => Promise<Document | null>;
     getDocument: (documentId: string, language?: string) => Promise<Document | null>;
     getDocumentByObjectId: (objectId: string, language?: string) => Promise<Document | null>;
     updateDocument: (documentId: string, body: string, objectId: string, title?: string, language?: string) => Promise<Document | null>;
-    createDocument: (body: string, objectId: string, title?: string, language?: string) => Promise<Document | null>;
 }

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

@@ -6,10 +6,10 @@ import { type Mode } from '../context/context';
 import { type Document as DocumentModel } from '../model';
 export interface Props extends BaseProps {
     doc?: DocumentModel;
-    isLoading?: boolean;
+    editorProps?: Partial<EditorProps>;
     hasError?: boolean;
+    isLoading?: boolean;
     mode: Mode;
-    editorProps?: Partial<EditorProps>;
     rendererProps?: Partial<RendererProps>;
 }
 export default class Document extends Component<Props> {

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

@@ -1,7 +1,7 @@
 import React from 'react';
 import type { Mode } from '../context/context';
 declare const _default: (props: {
-    mode: Mode;
     editorActions?: any;
+    mode: Mode;
 }) => React.JSX.Element;
 export default _default;

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

@@ -1,15 +1,15 @@
 import React, { PureComponent } from 'react';
 import { type Actions, type State } from '../context/context';
 export interface Props<PropsFromState extends Object, PropsFromActions extends Object, RenderProps extends Object> {
-    stateMapper?: (state: State) => PropsFromState;
     actionsMapper?: (actions: Actions) => PropsFromActions;
-    renderPropsMapper?: (renderProps: any) => RenderProps;
     children: (props: PropsFromState & PropsFromActions & RenderProps) => React.ReactNode;
+    renderPropsMapper?: (renderProps: any) => RenderProps;
+    stateMapper?: (state: State) => PropsFromState;
 }
 export interface ConsumerProps<A, V, R> {
     actions: A;
-    value: V;
     renderProps: R;
+    value: V;
 }
 export declare class Consumer<PropsFromState extends Object, PropsFromActions extends Object, RenderProps extends Object> extends PureComponent<Props<PropsFromState, PropsFromActions, RenderProps>> {
     private previousActions;

package/dist/types-ts4.5/consumers/with-document-actions.d.ts

@@ -4,9 +4,9 @@ export interface Props {
     render: (actions: DocumentActions) => React.ReactNode;
 }
 export interface DocumentActions {
+    cancelEdit: () => void;
     createDocument: (value: any) => Promise<DocumentModel>;
     editDocument: () => void;
-    cancelEdit: () => void;
     updateDocument: (value: any) => Promise<DocumentModel>;
 }
 export default class WithDocumentActions extends PureComponent<Props> {

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

@@ -1,21 +1,21 @@
 import { type Document } from '../model';
 export interface ContextType {
-    value: State;
     actions: Actions;
     renderProps: any;
+    value: State;
 }
 export interface State {
     doc?: Document;
-    isLoading?: boolean;
     hasError?: boolean;
+    isLoading?: boolean;
     mode?: Mode;
 }
 export type Mode = 'view' | 'edit' | 'create';
 export interface Actions {
+    createDocument: (body: string, title?: string, language?: string) => Promise<Document>;
     getDocument: (documentId: string, language?: string) => void;
     getDocumentByObjectId: (objectId: string, language?: string) => void;
     setDocumentMode: (mode: Mode) => void;
     updateDocument: (body: string, title?: string, language?: string) => Promise<Document>;
-    createDocument: (body: string, title?: string, language?: string) => Promise<Document>;
 }
 export declare const Context: import("react").Context<ContextType>;

package/dist/types-ts4.5/context/embedded-document.d.ts

@@ -4,14 +4,14 @@ import type { Mode, State } from './context';
 import type { ProviderProps } from '../provider';
 export declare const akEditorFullPageMaxWidth = 680;
 export interface Props extends ProviderProps {
-    objectId: string;
-    documentId?: string;
+    children?: React.ReactNode;
     containerId?: string;
+    documentId?: string;
     language?: string;
     mode?: Mode;
+    objectId: string;
     renderTitle?: (mode: Mode, doc?: any) => ReactElement<any>;
     renderToolbar?: (mode: Mode, editorActions?: any) => ReactElement<any>;
-    children?: React.ReactNode;
 }
 export default class EmbeddedDocument extends Component<Props, State> {
     private actions;

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

@@ -1,11 +1,11 @@
 export interface Document {
-    documentId: string;
-    objectId: string;
+    body: string;
     containerId?: string;
     createdBy: User;
+    documentId: string;
     language?: string;
+    objectId: string;
     title?: string;
-    body: string;
 }
 export type User = Object;
 export interface BatchDocumentResponse {

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

@@ -1,7 +1,7 @@
 import { type Document } from '../model';
 export interface Provider {
+    createDocument: (body: string, objectId: string, title?: string, language?: string) => Promise<Document | null>;
     getDocument: (documentId: string, language?: string) => Promise<Document | null>;
     getDocumentByObjectId: (objectId: string, language?: string) => Promise<Document | null>;
     updateDocument: (documentId: string, body: string, objectId: string, title?: string, language?: string) => Promise<Document | null>;
-    createDocument: (body: string, objectId: string, title?: string, language?: string) => Promise<Document | null>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/embedded-document",
-	"version": "1.1.0",
+	"version": "1.1.1",
 	"description": "DEPRECATED Embedded Document component",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -36,13 +36,13 @@
 		"@atlaskit/button": "^23.4.0",
 		"@atlaskit/editor-core": "^210.1.0",
 		"@atlaskit/editor-shared-styles": "^3.6.0",
-		"@atlaskit/renderer": "^120.4.0",
+		"@atlaskit/renderer": "^120.5.0",
 		"@atlaskit/tokens": "^6.0.0",
 		"@atlaskit/util-service-support": "^6.3.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.26.0",
+		"@atlaskit/editor-common": "^107.29.0",
 		"react": "^18.2.0",
 		"styled-components": "^3.2.6"
 	},