@atlaskit/embedded-document 0.7.49 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/embedded-document
 
+## 0.8.0
+
+### Minor Changes
+
+- [`3e0d1d605e6`](https://bitbucket.org/atlassian/atlassian-frontend/commits/3e0d1d605e6) - Marking @atlaskit/embedded-document as deprecated as it is no longer being used.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 0.7.49
 
 ### Patch Changes

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/embedded-document",
-	"version": "0.7.49",
+	"version": "0.8.0",
 	"sideEffects": false
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/embedded-document",
-	"version": "0.7.49",
+	"version": "0.8.0",
 	"sideEffects": false
 }

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/embedded-document",
-	"version": "0.7.49",
+	"version": "0.8.0",
 	"sideEffects": false
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@atlaskit/embedded-document",
-  "version": "0.7.49",
-  "description": "Embedded Document component",
+  "version": "0.8.0",
+  "description": "DEPRECATED Embedded Document component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
@@ -18,14 +18,18 @@
     "team": "Editor Services",
     "deprecatedAutoEntryPoints": true,
     "inPublicMirror": true,
-    "releaseModel": "scheduled"
+    "releaseModel": "scheduled",
+    "website": {
+      "name": "embedded-document",
+      "deprecated": "This package is no longer being used and will not be actively maintained"
+    }
   },
   "dependencies": {
     "@atlaskit/button": "^16.3.0",
-    "@atlaskit/editor-common": "^68.0.0",
-    "@atlaskit/editor-core": "^169.0.0",
+    "@atlaskit/editor-common": "^69.0.0",
+    "@atlaskit/editor-core": "^169.1.0",
     "@atlaskit/editor-shared-styles": "^2.1.0",
-    "@atlaskit/renderer": "^98.0.0",
+    "@atlaskit/renderer": "^98.1.0",
     "@atlaskit/util-service-support": "^6.1.0",
     "@babel/runtime": "^7.0.0"
   },

package/report.api.md

@@ -13,63 +13,95 @@ import { ReactElement } from 'react';
 import { RendererProps } from '@atlaskit/renderer';
 import { ServiceConfig } from '@atlaskit/util-service-support';
 
-// @public (undocumented)
-interface Document_2 {
-  // (undocumented)
-  body: string;
-  // (undocumented)
+declare interface Config extends ServiceConfig {}
+
+declare interface Document_2 {
+  documentId: string;
+  objectId: string;
   containerId?: string;
-  // (undocumented)
   createdBy: User;
-  // (undocumented)
-  documentId: string;
-  // (undocumented)
   language?: string;
-  // (undocumented)
-  objectId: string;
-  // (undocumented)
   title?: string;
+  body: string;
 }
 export { Document_2 as Document };
 
-// @public (undocumented)
-export class DocumentBody extends PureComponent<Props_2> {
-  // (undocumented)
+declare interface DocumentActions {
+  createDocument(value: any): Promise<Document_2>;
+  editDocument(): void;
+  cancelEdit(): void;
+  updateDocument(value: any): Promise<Document_2>;
+}
+
+export declare class DocumentBody extends PureComponent<Props_2> {
+  private renderChild;
+  private stateMapper;
+  private renderPropsMapper;
   render(): JSX.Element;
 }
 
-// @public (undocumented)
-export type DocumentMode = 'view' | 'edit' | 'create';
+export declare type DocumentMode = 'view' | 'edit' | 'create';
 
-// @public (undocumented)
-export class EmbeddedDocument extends Component<Props, State> {
+export declare class EmbeddedDocument extends Component<Props, State> {
+  private actions;
+  private provider;
   constructor(props: Props);
-  // (undocumented)
   componentDidMount(): Promise<void>;
-  // (undocumented)
+  private getDocumentByObjectId;
+  private getDocument;
+  private setDocumentMode;
+  private updateDocument;
+  private createDocument;
+  private setDocumentState;
+  /**
+   * Toolbar will only be rendered here if we're in "view"-mode.
+   *
+   * In all other modes, the toolbar rendering will be triggered
+   * by the Document-component.
+   */
+  private renderToolbar;
+  /**
+   * Title will only be rendered here if we're in "view"-mode.
+   *
+   * In all other modes, the title rendering will be triggered
+   * by the Document-component.
+   */
+  private renderTitle;
+  private renderContent;
   render(): JSX.Element;
 }
 
-// @public (undocumented)
-export interface Provider {
-  // (undocumented)
-  createDocument(
-    body: string,
-    objectId: string,
-    title?: string,
-    language?: string,
-  ): Promise<Document_2 | null>;
-  // (undocumented)
+declare interface Props extends ProviderProps {
+  objectId: string;
+  documentId?: string;
+  containerId?: string;
+  language?: string;
+  mode?: DocumentMode;
+  renderTitle?: (mode: DocumentMode, doc?: any) => ReactElement<any>;
+  renderToolbar?: (
+    mode: DocumentMode,
+    editorActions?: any,
+  ) => ReactElement<any>;
+}
+
+declare interface Props_2 {
+  editorProps?: Partial<EditorProps>;
+  rendererProps?: Partial<RendererProps>;
+}
+
+declare interface Props_3 {
+  render(actions: DocumentActions): React_2.ReactNode;
+}
+
+export declare interface Provider {
   getDocument(
     documentId: string,
     language?: string,
   ): Promise<Document_2 | null>;
-  // (undocumented)
   getDocumentByObjectId(
     objectId: string,
     language?: string,
   ): Promise<Document_2 | null>;
-  // (undocumented)
   updateDocument(
     documentId: string,
     body: string,
@@ -77,29 +109,30 @@ export interface Provider {
     title?: string,
     language?: string,
   ): Promise<Document_2 | null>;
-}
-
-// @public (undocumented)
-export class ServiceProvider implements Provider {
-  constructor(config: Config);
-  // (undocumented)
   createDocument(
     body: string,
     objectId: string,
     title?: string,
     language?: string,
   ): Promise<Document_2 | null>;
-  // (undocumented)
+}
+
+declare interface ProviderProps {
+  provider?: Provider;
+  url?: string;
+}
+
+export declare class ServiceProvider implements Provider {
+  private config;
+  constructor(config: Config);
   getDocument(
     documentId: string,
     language?: string,
   ): Promise<Document_2 | null>;
-  // (undocumented)
   getDocumentByObjectId(
     objectId: string,
     language?: string,
   ): Promise<Document_2 | null>;
-  // (undocumented)
   updateDocument(
     documentId: string,
     body: string,
@@ -107,19 +140,32 @@ export class ServiceProvider implements Provider {
     title?: string,
     language?: string,
   ): Promise<Document_2 | null>;
+  createDocument(
+    body: string,
+    objectId: string,
+    title?: string,
+    language?: string,
+  ): Promise<Document_2 | null>;
 }
 
-// @public (undocumented)
-export const Toolbar: (props: {
+declare interface State {
+  doc?: Document_2;
+  isLoading?: boolean;
+  hasError?: boolean;
+  mode?: DocumentMode;
+}
+
+export declare const Toolbar: (props: {
   mode: DocumentMode;
   editorActions?: any;
 }) => JSX.Element;
 
-// @public (undocumented)
-export class WithDocumentActions extends PureComponent<Props_3> {
-  // (undocumented)
+declare interface User {}
+
+export declare class WithDocumentActions extends PureComponent<Props_3> {
+  private actionsMapper;
   render(): JSX.Element;
 }
 
-// (No @packageDocumentation comment for this package)
+export {};
 ```