@atlaskit/native-embeds-common 0.1.1 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/native-embeds-common
 
+## 0.1.2
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 0.1.1
 
 ### Patch Changes

package/dist/cjs/utils/constants.js

@@ -11,6 +11,7 @@ var NATIVE_EMBED_PARAMETER_DEFAULTS = exports.NATIVE_EMBED_PARAMETER_DEFAULTS =
   url: undefined,
   alwaysShowTitle: false,
   alignment: DEFAULT_ALIGNMENT,
+  displayText: undefined,
   height: 600,
   width: undefined
 };

package/dist/cjs/utils/plugin-actions/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/es2019/index.js

@@ -3,5 +3,7 @@ export { ALIGNMENT_VALUES, DEFAULT_ALIGNMENT, BUILTIN_TOOLBAR_KEYS, EDITOR_TOOLB
 
 // Re-export types
 
+// Plugin actions types
+
 // Re-export utilities
 export { createEditorToolbarActions, getParameter, getParameters, setParameter, setParameters } from './utils/utils';

package/dist/es2019/utils/constants.js

@@ -5,6 +5,7 @@ export const NATIVE_EMBED_PARAMETER_DEFAULTS = {
   url: undefined,
   alwaysShowTitle: false,
   alignment: DEFAULT_ALIGNMENT,
+  displayText: undefined,
   height: 600,
   width: undefined
 };

package/dist/es2019/utils/plugin-actions/types.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/index.js

@@ -3,5 +3,7 @@ export { ALIGNMENT_VALUES, DEFAULT_ALIGNMENT, BUILTIN_TOOLBAR_KEYS, EDITOR_TOOLB
 
 // Re-export types
 
+// Plugin actions types
+
 // Re-export utilities
 export { createEditorToolbarActions, getParameter, getParameters, setParameter, setParameters } from './utils/utils';

package/dist/esm/utils/constants.js

@@ -5,6 +5,7 @@ export var NATIVE_EMBED_PARAMETER_DEFAULTS = {
   url: undefined,
   alwaysShowTitle: false,
   alignment: DEFAULT_ALIGNMENT,
+  displayText: undefined,
   height: 600,
   width: undefined
 };

package/dist/esm/utils/plugin-actions/types.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
 export { ALIGNMENT_VALUES, DEFAULT_ALIGNMENT, BUILTIN_TOOLBAR_KEYS, EDITOR_TOOLBAR_HANDLER_KEYS, NATIVE_EMBED_PARAMETER_DEFAULTS, } from './utils/constants';
 export type { AlignmentValue, EditorToolbarButtonAction, EditorToolbarAction, EditorToolbarHandler, EditorToolbarHandlerContext, EditorToolbarHandlerKey, EditorToolbarHandlers, NativeEmbedAppearance, NativeEmbedParameterKey, NativeEmbedParameterValues, NativeEmbedParameterValue, NativeEmbedParameters, BuiltinToolbarKey, ManifestEditorToolbarActions, } from './utils/types';
+export type { CardToNativeEmbedNode, CardToNativeEmbedTransformOptions, CreateCardToNativeEmbedTransform, EditorPluginNativeEmbedsPlugin, NativeEmbedLayout, NativeEmbedTransformAttrs, } from './utils/plugin-actions/types';
 export { createEditorToolbarActions, getParameter, getParameters, setParameter, setParameters, } from './utils/utils';

package/dist/types/utils/plugin-actions/types.d.ts

@@ -0,0 +1,33 @@
+import type { Command, NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { Node, Schema } from '@atlaskit/editor-prosemirror/model';
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+/** Accepted layout values from ADF schema (embedCard) */
+export type NativeEmbedLayout = 'wide' | 'full-width' | 'center' | 'wrap-right' | 'wrap-left' | 'align-end' | 'align-start';
+/** Input attrs for embedCard node (subset used by transform) */
+export interface NativeEmbedTransformAttrs {
+    layout?: NativeEmbedLayout;
+    originalHeight?: number | null;
+    originalWidth?: number | null;
+    url: string;
+    width?: number;
+}
+/** Type for cardToNativeEmbedNode - converts embed attrs to native embed Node */
+export type CardToNativeEmbedNode = (schema: Schema, attrs: NativeEmbedTransformAttrs) => Node | undefined;
+/** Type for createEmbedCardToNativeEmbedTransform - returns a Command */
+export type CreateCardToNativeEmbedTransform = (options?: CardToNativeEmbedTransformOptions) => Command;
+export interface CardToNativeEmbedTransformOptions {
+    /**
+     * Called before dispatch to allow the caller to augment the transaction
+     * (e.g. datasource stash, analytics, link metadata).
+     */
+    augmentTransaction?: (tr: Transaction, state: EditorState) => void;
+}
+/**
+ * Minimal plugin type for native embeds action integration.
+ */
+export type EditorPluginNativeEmbedsPlugin = NextEditorPlugin<'editorPluginNativeEmbeds', {
+    actions: {
+        cardToNativeEmbedNode: CardToNativeEmbedNode;
+        createCardToNativeEmbedTransform: CreateCardToNativeEmbedTransform;
+    };
+}>;

package/dist/types/utils/types.d.ts

@@ -7,6 +7,7 @@ export type NativeEmbedAppearance = 'url' | 'inline' | 'block' | 'embed';
 export type NativeEmbedParameterValues = {
     alignment: AlignmentValue;
     alwaysShowTitle: boolean;
+    displayText?: string;
     height: number;
     url?: string;
     width?: number;
@@ -18,6 +19,7 @@ export type NativeEmbedParameters = {
     macroParams?: {
         alignment?: NativeEmbedParameterValue;
         alwaysShowTitle?: NativeEmbedParameterValue;
+        displayText?: NativeEmbedParameterValue;
         height?: NativeEmbedParameterValue;
         url?: NativeEmbedParameterValue;
         width?: NativeEmbedParameterValue;

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

@@ -1,3 +1,4 @@
 export { ALIGNMENT_VALUES, DEFAULT_ALIGNMENT, BUILTIN_TOOLBAR_KEYS, EDITOR_TOOLBAR_HANDLER_KEYS, NATIVE_EMBED_PARAMETER_DEFAULTS, } from './utils/constants';
 export type { AlignmentValue, EditorToolbarButtonAction, EditorToolbarAction, EditorToolbarHandler, EditorToolbarHandlerContext, EditorToolbarHandlerKey, EditorToolbarHandlers, NativeEmbedAppearance, NativeEmbedParameterKey, NativeEmbedParameterValues, NativeEmbedParameterValue, NativeEmbedParameters, BuiltinToolbarKey, ManifestEditorToolbarActions, } from './utils/types';
+export type { CardToNativeEmbedNode, CardToNativeEmbedTransformOptions, CreateCardToNativeEmbedTransform, EditorPluginNativeEmbedsPlugin, NativeEmbedLayout, NativeEmbedTransformAttrs, } from './utils/plugin-actions/types';
 export { createEditorToolbarActions, getParameter, getParameters, setParameter, setParameters, } from './utils/utils';

package/dist/types-ts4.5/utils/plugin-actions/types.d.ts

@@ -0,0 +1,33 @@
+import type { Command, NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { Node, Schema } from '@atlaskit/editor-prosemirror/model';
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+/** Accepted layout values from ADF schema (embedCard) */
+export type NativeEmbedLayout = 'wide' | 'full-width' | 'center' | 'wrap-right' | 'wrap-left' | 'align-end' | 'align-start';
+/** Input attrs for embedCard node (subset used by transform) */
+export interface NativeEmbedTransformAttrs {
+    layout?: NativeEmbedLayout;
+    originalHeight?: number | null;
+    originalWidth?: number | null;
+    url: string;
+    width?: number;
+}
+/** Type for cardToNativeEmbedNode - converts embed attrs to native embed Node */
+export type CardToNativeEmbedNode = (schema: Schema, attrs: NativeEmbedTransformAttrs) => Node | undefined;
+/** Type for createEmbedCardToNativeEmbedTransform - returns a Command */
+export type CreateCardToNativeEmbedTransform = (options?: CardToNativeEmbedTransformOptions) => Command;
+export interface CardToNativeEmbedTransformOptions {
+    /**
+     * Called before dispatch to allow the caller to augment the transaction
+     * (e.g. datasource stash, analytics, link metadata).
+     */
+    augmentTransaction?: (tr: Transaction, state: EditorState) => void;
+}
+/**
+ * Minimal plugin type for native embeds action integration.
+ */
+export type EditorPluginNativeEmbedsPlugin = NextEditorPlugin<'editorPluginNativeEmbeds', {
+    actions: {
+        cardToNativeEmbedNode: CardToNativeEmbedNode;
+        createCardToNativeEmbedTransform: CreateCardToNativeEmbedTransform;
+    };
+}>;

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

@@ -7,6 +7,7 @@ export type NativeEmbedAppearance = 'url' | 'inline' | 'block' | 'embed';
 export type NativeEmbedParameterValues = {
     alignment: AlignmentValue;
     alwaysShowTitle: boolean;
+    displayText?: string;
     height: number;
     url?: string;
     width?: number;
@@ -18,6 +19,7 @@ export type NativeEmbedParameters = {
     macroParams?: {
         alignment?: NativeEmbedParameterValue;
         alwaysShowTitle?: NativeEmbedParameterValue;
+        displayText?: NativeEmbedParameterValue;
         height?: NativeEmbedParameterValue;
         url?: NativeEmbedParameterValue;
         width?: NativeEmbedParameterValue;

package/package.json

@@ -24,8 +24,9 @@
 	],
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/editor-common": "^112.0.0",
-		"@atlaskit/icon": "^32.0.0",
+		"@atlaskit/editor-common": "^112.4.0",
+		"@atlaskit/editor-prosemirror": "^7.3.0",
+		"@atlaskit/icon": "^33.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.20.0"
 	},
@@ -78,7 +79,7 @@
 		}
 	},
 	"name": "@atlaskit/native-embeds-common",
-	"version": "0.1.1",
+	"version": "0.1.2",
 	"description": "A shared package for native embeds to be used across experiences and plugin",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",