@atlaskit/embedded-document 0.9.0 → 0.9.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/embedded-document
 
+## 0.9.2
+
+### Patch Changes
+
+- [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
+
+## 0.9.1
+
+### Patch Changes
+
+- [`41fae2c6f68`](https://bitbucket.org/atlassian/atlassian-frontend/commits/41fae2c6f68) - Upgrade Typescript from `4.5.5` to `4.9.5`
+
 ## 0.9.0
 
 ### Minor Changes

package/dist/cjs/version.json

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

package/dist/es2019/version.json

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

package/dist/esm/version.json

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

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

@@ -11,7 +11,7 @@ export interface State {
     hasError?: boolean;
     mode?: Mode;
 }
-export declare type Mode = 'view' | 'edit' | 'create';
+export type Mode = 'view' | 'edit' | 'create';
 export interface Actions {
     getDocument(documentId: string, language?: string): void;
     getDocumentByObjectId(objectId: string, language?: string): void;

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

@@ -0,0 +1,20 @@
+import { Component } from 'react';
+import { EditorProps } from '@atlaskit/editor-core';
+import { RendererProps } from '@atlaskit/renderer';
+import { Props as BaseProps } from '../context/embedded-document';
+import { Mode } from '../context/context';
+import { Document as DocumentModel } from '../model';
+export interface Props extends BaseProps {
+    doc?: DocumentModel;
+    isLoading?: boolean;
+    hasError?: boolean;
+    mode: Mode;
+    editorProps?: Partial<EditorProps>;
+    rendererProps?: Partial<RendererProps>;
+}
+export default class Document extends Component<Props> {
+    private renderToolbar;
+    private renderTitle;
+    private renderEditor;
+    render(): JSX.Element;
+}

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

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

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

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

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

@@ -0,0 +1,13 @@
+import { PureComponent } from 'react';
+import { EditorProps } from '@atlaskit/editor-core';
+import { RendererProps } from '@atlaskit/renderer';
+export interface Props {
+    editorProps?: Partial<EditorProps>;
+    rendererProps?: Partial<RendererProps>;
+}
+export default class DocumentBody extends PureComponent<Props> {
+    private renderChild;
+    private stateMapper;
+    private renderPropsMapper;
+    render(): JSX.Element;
+}

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

@@ -0,0 +1,16 @@
+import React from 'react';
+import { PureComponent } from 'react';
+import { Document as DocumentModel } from '../model';
+export interface Props {
+    render(actions: DocumentActions): React.ReactNode;
+}
+export interface DocumentActions {
+    createDocument(value: any): Promise<DocumentModel>;
+    editDocument(): void;
+    cancelEdit(): void;
+    updateDocument(value: any): Promise<DocumentModel>;
+}
+export default class WithDocumentActions extends PureComponent<Props> {
+    private actionsMapper;
+    render(): JSX.Element;
+}

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

@@ -0,0 +1,22 @@
+/// <reference types="react" />
+import { Document } from '../model';
+export interface ContextType {
+    value: State;
+    actions: Actions;
+    renderProps: any;
+}
+export interface State {
+    doc?: Document;
+    isLoading?: boolean;
+    hasError?: boolean;
+    mode?: Mode;
+}
+export type Mode = 'view' | 'edit' | 'create';
+export interface Actions {
+    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

@@ -0,0 +1,41 @@
+import { Component, ReactElement } from 'react';
+import { Mode, State } from './context';
+import { ProviderProps } from '../provider';
+export declare const akEditorFullPageMaxWidth = 680;
+export interface Props extends ProviderProps {
+    objectId: string;
+    documentId?: string;
+    containerId?: string;
+    language?: string;
+    mode?: Mode;
+    renderTitle?: (mode: Mode, doc?: any) => ReactElement<any>;
+    renderToolbar?: (mode: Mode, editorActions?: any) => ReactElement<any>;
+}
+export default class EmbeddedDocument extends Component<Props, State> {
+    private actions;
+    private provider;
+    constructor(props: Props);
+    componentDidMount(): Promise<void>;
+    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;
+}

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

@@ -0,0 +1,8 @@
+export { default as EmbeddedDocument } from './context/embedded-document';
+export { default as DocumentBody } from './consumers/document-body';
+export { default as WithDocumentActions } from './consumers/with-document-actions';
+export { default as ServiceProvider } from './provider/service-provider';
+export { default as Toolbar } from './components/toolbar';
+export type { Mode as DocumentMode } from './context/context';
+export type { Document } from './model';
+export type { Provider } from './provider';

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

@@ -0,0 +1,19 @@
+export interface Document {
+    documentId: string;
+    objectId: string;
+    containerId?: string;
+    createdBy: User;
+    language?: string;
+    title?: string;
+    body: string;
+}
+export interface User {
+}
+export interface BatchDocumentResponse {
+    documentId: string;
+    language: {
+        [key: string]: {
+            versions: Document[];
+        };
+    };
+}

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

@@ -0,0 +1,9 @@
+import { Provider } from './provider';
+import { default as ServiceProvider } from './service-provider';
+export { ServiceProvider };
+export type { Provider };
+export interface ProviderProps {
+    provider?: Provider;
+    url?: string;
+}
+export declare const getProvider: ({ provider, url }: ProviderProps) => Provider;

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

@@ -0,0 +1,7 @@
+import { Document } from '../model';
+export interface Provider {
+    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/provider/service-provider.d.ts

@@ -0,0 +1,13 @@
+import { ServiceConfig } from '@atlaskit/util-service-support';
+import { Provider } from './provider';
+import { Document } from '../model';
+export interface Config extends ServiceConfig {
+}
+export default class ServiceProvider implements Provider {
+    private config;
+    constructor(config: Config);
+    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": "0.9.0",
+  "version": "0.9.2",
   "description": "DEPRECATED Embedded Document component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,14 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "dist/types-ts4.5/*",
+        "dist/types-ts4.5/index.d.ts"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.ts",
   "atlassian": {
@@ -26,10 +34,10 @@
   },
   "dependencies": {
     "@atlaskit/button": "^16.7.0",
-    "@atlaskit/editor-common": "^74.0.0",
-    "@atlaskit/editor-core": "^183.0.0",
+    "@atlaskit/editor-common": "^74.1.0",
+    "@atlaskit/editor-core": "^183.1.0",
     "@atlaskit/editor-shared-styles": "^2.4.0",
-    "@atlaskit/renderer": "^108.0.0",
+    "@atlaskit/renderer": "^108.1.0",
     "@atlaskit/util-service-support": "^6.2.0",
     "@babel/runtime": "^7.0.0"
   },
@@ -42,7 +50,7 @@
     "enzyme": "^3.10.0",
     "fetch-mock": "^8.0.0",
     "react": "^16.8.0",
-    "typescript": "4.5.5"
+    "typescript": "~4.9.5"
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
 }