@atlaskit/editor-plugin-card 0.9.1 → 0.9.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-card",
-  "version": "0.9.1",
+  "version": "0.9.2",
   "description": "Card plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -34,7 +34,7 @@
     "@atlaskit/adf-schema": "^32.0.0",
     "@atlaskit/analytics-next": "^9.1.0",
     "@atlaskit/custom-steps": "^0.0.2",
-    "@atlaskit/editor-common": "^76.6.0",
+    "@atlaskit/editor-common": "^76.10.0",
     "@atlaskit/editor-plugin-analytics": "^0.2.0",
     "@atlaskit/editor-plugin-decorations": "^0.2.0",
     "@atlaskit/editor-plugin-feature-flags": "^1.0.0",
@@ -50,7 +50,7 @@
     "@atlaskit/platform-feature-flags": "^0.2.0",
     "@atlaskit/smart-card": "^26.34.0",
     "@atlaskit/theme": "^12.6.0",
-    "@atlaskit/tokens": "^1.25.0",
+    "@atlaskit/tokens": "^1.26.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",
     "lodash": "^4.17.21",
@@ -74,6 +74,7 @@
     "@atlassian/feature-flags-test-utils": "*",
     "@testing-library/dom": "^8.17.1",
     "@testing-library/react": "^12.1.5",
+    "@testing-library/react-hooks": "^8.0.1",
     "@testing-library/user-event": "^14.4.3",
     "raf-stub": "^2.0.1",
     "react-dom": "^16.8.0",

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,193 @@
+## API Report File for "@atlaskit/editor-plugin-card"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ACTION } from '@atlaskit/editor-common/analytics';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import { CardAppearance } from '@atlaskit/editor-common/provider-factory';
+import type { CardOptions } from '@atlaskit/editor-common/card';
+import type { CardPluginActions } from '@atlaskit/editor-common/card';
+import { CardProvider } from '@atlaskit/editor-common/provider-factory';
+import type { CardReplacementInputMethod } from '@atlaskit/editor-common/card';
+import type { DatasourceModalType } from '@atlaskit/editor-common/types';
+import type { DecorationsPlugin } from '@atlaskit/editor-plugin-decorations';
+import type { EditorAppearance } from '@atlaskit/editor-common/types';
+import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
+import type { FloatingToolbarPlugin } from '@atlaskit/editor-plugin-floating-toolbar';
+import type { GridPlugin } from '@atlaskit/editor-plugin-grid';
+import type { HyperlinkPlugin } from '@atlaskit/editor-plugin-hyperlink';
+import type { LinkPickerOptions } from '@atlaskit/editor-common/types';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { Node as Node_2 } from '@atlaskit/editor-prosemirror/model';
+import type { OptionalPlugin } from '@atlaskit/editor-common/types';
+import { SmartLinkEvents } from '@atlaskit/smart-card';
+import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
+import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
+
+// @public (undocumented)
+type CardInfo = {
+    title?: string;
+    url?: string;
+    pos: number;
+};
+
+// @public (undocumented)
+export type CardPlugin = NextEditorPlugin<'card', {
+    pluginConfiguration: CardPluginOptions;
+    dependencies: [
+    FeatureFlagsPlugin,
+    OptionalPlugin<AnalyticsPlugin>,
+    WidthPlugin,
+    DecorationsPlugin,
+    GridPlugin,
+    FloatingToolbarPlugin,
+    HyperlinkPlugin
+    ];
+    sharedState: CardPluginState | null;
+    actions: CardPluginActions;
+}>;
+
+// @public
+export const cardPlugin: CardPlugin;
+
+// @public (undocumented)
+type CardPluginEvent = DatasourceEvent | LinkEvent;
+
+// @public (undocumented)
+type CardPluginOptions = CardOptions & {
+    editorAppearance?: EditorAppearance;
+    platform: 'mobile' | 'web';
+    fullWidthMode?: boolean;
+    linkPicker?: LinkPickerOptions;
+    cardPluginEvents?: EditorCardPluginEvents<CardPluginEvent>;
+};
+
+// @public (undocumented)
+type CardPluginState = {
+    requests: Request_2[];
+    provider: CardProvider | null;
+    cards: CardInfo[];
+    showLinkingToolbar: boolean;
+    smartLinkEvents?: SmartLinkEvents;
+    editorAppearance?: EditorAppearance;
+    showDatasourceModal: boolean;
+    datasourceModalType?: DatasourceModalType;
+    datasourceTableRef?: HTMLElement;
+    layout?: DatasourceTableLayout;
+};
+
+// @public (undocumented)
+type DatasourceCreatedEvent = {
+    event: EVENT.CREATED;
+    subject: EVENT_SUBJECT.DATASOURCE;
+    data: Metadata_2;
+};
+
+// @public (undocumented)
+type DatasourceDeletedEvent = {
+    event: EVENT.DELETED;
+    subject: EVENT_SUBJECT.DATASOURCE;
+    data: Metadata_2;
+};
+
+// @public (undocumented)
+type DatasourceEvent = DatasourceCreatedEvent | DatasourceDeletedEvent | DatasourceUpdatedEvent;
+
+// @public (undocumented)
+type DatasourceTableLayout = 'center' | 'full-width' | 'wide';
+
+// @public (undocumented)
+type DatasourceUpdatedEvent = {
+    event: EVENT.UPDATED;
+    subject: EVENT_SUBJECT.DATASOURCE;
+    data: Metadata_2<UpdateMetadata>;
+};
+
+// @public (undocumented)
+type EditorCardPluginEvents<T> = {
+    push: (...events: T[]) => void;
+    subscribe: (listener: Subscriber<T>) => () => void;
+    flush: () => void;
+    getSize: () => number;
+};
+
+// @public (undocumented)
+enum EVENT {
+    // (undocumented)
+    CREATED = "created",
+    // (undocumented)
+    DELETED = "deleted",
+    // (undocumented)
+    UPDATED = "updated"
+}
+
+// @public (undocumented)
+enum EVENT_SUBJECT {
+    // (undocumented)
+    DATASOURCE = "datasource",
+    // (undocumented)
+    LINK = "link"
+}
+
+// @public
+type LinkCreatedEvent = {
+    event: EVENT.CREATED;
+    subject: EVENT_SUBJECT.LINK;
+    data: Metadata_2;
+};
+
+// @public (undocumented)
+type LinkDeletedEvent = {
+    event: EVENT.DELETED;
+    subject: EVENT_SUBJECT.LINK;
+    data: Metadata_2;
+};
+
+// @public (undocumented)
+type LinkEvent = LinkCreatedEvent | LinkDeletedEvent | LinkUpdatedEvent;
+
+// @public (undocumented)
+type LinkUpdatedEvent = {
+    event: EVENT.UPDATED;
+    subject: EVENT_SUBJECT.LINK;
+    data: Metadata_2<UpdateMetadata>;
+};
+
+// @public (undocumented)
+type Metadata_2<T = {}> = {
+    node: Node_2;
+    isUndo?: boolean;
+    isRedo?: boolean;
+    action?: string;
+    inputMethod?: string;
+    sourceEvent?: unknown;
+    nodeContext?: string;
+} & T;
+
+// @public (undocumented)
+type Request_2 = {
+    pos: number;
+    url: string;
+    appearance: CardAppearance;
+    compareLinkText: boolean;
+    source: CardReplacementInputMethod;
+    previousAppearance?: 'url' | CardAppearance;
+    analyticsAction?: ACTION;
+    shouldReplaceLink?: boolean;
+    sourceEvent?: UIAnalyticsEvent | null | undefined;
+};
+export { Request_2 as Request }
+
+// @public (undocumented)
+type Subscriber<T> = (event: T) => void;
+
+// @public (undocumented)
+type UpdateMetadata = {
+    previousDisplay?: string;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```