@atlaskit/native-embeds-common 2.0.4 → 2.0.6

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/native-embeds-common
 
+## 2.0.6
+
+### Patch Changes
+
+- [`07226ab3fad50`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/07226ab3fad50) -
+  [ux] Reserve native embed first-paint layout
+- Updated dependencies
+
+## 2.0.5
+
+### Patch Changes
+
+- [`56d5d8d23bed9`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/56d5d8d23bed9) -
+  Bump native embeds i18n packages to include French and Portuguese (Brazil) translations.
+
 ## 2.0.4
 
 ### Patch Changes

package/compass.yml

@@ -0,0 +1,38 @@
+configVersion: 1
+id: ari:cloud:compass:a436116f-02ce-4520-8fbb-7301462a1674:component/c5751cc6-3513-4070-9deb-af31e86aed34/e056e542-a3ce-4443-88d3-ad37895abc0c
+name: '@atlaskit/native-embeds-common'
+ownerId: ari:cloud:identity::team/ebf6925a-b776-4f99-92b6-6f529449f814 # Eng - Create - Native Content Types - Team Silky (Stacey Douglas)
+labels:
+  - platform-code
+  - platform-afm
+typeId: OTHER
+fields:
+  tier: 4
+  lifecycle: Active
+  isMonorepoProject: true
+links:
+  - name: Root Repository
+    type: REPOSITORY
+    url: https://bitbucket.org/atlassian/atlassian-frontend-monorepo/src/master
+  - name: Slack Channel
+    type: CHAT_CHANNEL
+    url: https://atlassian.enterprise.slack.com/archives/C05BWLL499U # #native-content-types-eng
+  - name: Native Embeds Common
+    type: REPOSITORY
+    url: https://bitbucket.org/atlassian/atlassian-frontend-monorepo/src/master/platform/packages/native-embeds/native-embeds-common
+customFields:
+  - name: Department
+    type: text
+    value: Eng - Confluence Content Experience
+  - name: Technical Owner
+    type: user
+    value: ari:cloud:identity::user/5c75da8392ac9063b7e86a09 # Corne Alant
+  - name: Required Reviewers Opt In
+    type: boolean
+    value: true
+  - name: Reviewer Selection Mechanism
+    type: text
+    value: random(2)
+  - name: Required Reviewer Approvals
+    type: number
+    value: 1

package/dist/cjs/entry-points/initial-layout.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.resolveNativeEmbedInitialLayout = exports.NATIVE_EMBED_INITIAL_LAYOUT_FALLBACK_ASPECT_RATIO = void 0;
+var _utils = require("../utils/utils");
+var NATIVE_EMBED_INITIAL_LAYOUT_FALLBACK_ASPECT_RATIO = exports.NATIVE_EMBED_INITIAL_LAYOUT_FALLBACK_ASPECT_RATIO = '760 / 600';
+/**
+ * Resolve the dimensions needed to reserve native embed layout before the full iframe UI is ready.
+ *
+ * This intentionally depends only on ADF parameters and optional manifest-like metadata so it can be
+ * reused by React, DOMOutputSpec, SSR, and renderer placeholders without importing iframe UI code.
+ */
+var resolveNativeEmbedInitialLayout = exports.resolveNativeEmbedInitialLayout = function resolveNativeEmbedInitialLayout(_ref) {
+  var _manifest$parameterDe, _manifest$parameterDe2, _manifest$parameterDe3, _manifest$lockResizeA, _manifest$uiConfig$sh, _manifest$uiConfig;
+  var manifest = _ref.manifest,
+    parameters = _ref.parameters,
+    placeholderId = _ref.placeholderId;
+  var _getParameters = (0, _utils.getParameters)(parameters),
+    alignment = _getParameters.alignment,
+    aspectRatio = _getParameters.aspectRatio,
+    height = _getParameters.height,
+    width = _getParameters.width;
+  var effectiveWidth = width !== null && width !== void 0 ? width : manifest === null || manifest === void 0 || (_manifest$parameterDe = manifest.parameterDefaults) === null || _manifest$parameterDe === void 0 ? void 0 : _manifest$parameterDe.width;
+
+  // `getParameters` always supplies default values, so inspect raw macroParams to distinguish
+  // stored dimensions from package defaults. This prevents the default aspectRatio from affecting
+  // older embeds that never persisted original dimensions.
+  var macroParams = parameters === null || parameters === void 0 ? void 0 : parameters.macroParams;
+  var heightExplicitlyStored = !!(macroParams !== null && macroParams !== void 0 && macroParams.height);
+  var aspectRatioExplicitlyStored = !!(macroParams !== null && macroParams !== void 0 && macroParams.aspectRatio);
+  var effectiveHeightRaw = heightExplicitlyStored ? height : (_manifest$parameterDe2 = manifest === null || manifest === void 0 || (_manifest$parameterDe3 = manifest.parameterDefaults) === null || _manifest$parameterDe3 === void 0 ? void 0 : _manifest$parameterDe3.height) !== null && _manifest$parameterDe2 !== void 0 ? _manifest$parameterDe2 : null;
+  var effectiveHeight = aspectRatioExplicitlyStored && aspectRatio != null && aspectRatio > 0 && effectiveWidth != null && !heightExplicitlyStored ? Math.round(effectiveWidth / aspectRatio) : effectiveHeightRaw !== null && effectiveHeightRaw !== void 0 ? effectiveHeightRaw : height;
+  var lockAspectRatio = typeof (manifest === null || manifest === void 0 ? void 0 : manifest.lockResizeAspectRatio) === 'function' ? manifest.lockResizeAspectRatio() : (_manifest$lockResizeA = manifest === null || manifest === void 0 ? void 0 : manifest.lockResizeAspectRatio) !== null && _manifest$lockResizeA !== void 0 ? _manifest$lockResizeA : true;
+  return {
+    alignment: alignment,
+    effectiveHeight: effectiveHeight,
+    effectiveWidth: effectiveWidth,
+    hasEmbedBorder: (_manifest$uiConfig$sh = manifest === null || manifest === void 0 || (_manifest$uiConfig = manifest.uiConfig) === null || _manifest$uiConfig === void 0 ? void 0 : _manifest$uiConfig.showBorder) !== null && _manifest$uiConfig$sh !== void 0 ? _manifest$uiConfig$sh : true,
+    lockAspectRatio: lockAspectRatio,
+    placeholderId: placeholderId
+  };
+};

package/dist/cjs/i18n/fr.js

@@ -0,0 +1,16 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _fr = _interopRequireDefault(require("@atlassian/afm-i18n-platform-native-embeds-native-embeds-common/i18n/fr"));
+/* prettier-ignore */
+/**
+ * NOTE:
+ *
+ * This file is automatically generated by Traduki 2.0.
+ * DO NOT CHANGE IT BY HAND or your changes will be lost.
+ */
+var _default = exports.default = _fr.default;

package/dist/cjs/i18n/pt_BR.js

@@ -0,0 +1,16 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _pt_BR = _interopRequireDefault(require("@atlassian/afm-i18n-platform-native-embeds-native-embeds-common/i18n/pt_BR"));
+/* prettier-ignore */
+/**
+ * NOTE:
+ *
+ * This file is automatically generated by Traduki 2.0.
+ * DO NOT CHANGE IT BY HAND or your changes will be lost.
+ */
+var _default = exports.default = _pt_BR.default;

package/dist/es2019/entry-points/initial-layout.js

@@ -0,0 +1,40 @@
+import { getParameters } from '../utils/utils';
+export const NATIVE_EMBED_INITIAL_LAYOUT_FALLBACK_ASPECT_RATIO = '760 / 600';
+/**
+ * Resolve the dimensions needed to reserve native embed layout before the full iframe UI is ready.
+ *
+ * This intentionally depends only on ADF parameters and optional manifest-like metadata so it can be
+ * reused by React, DOMOutputSpec, SSR, and renderer placeholders without importing iframe UI code.
+ */
+export const resolveNativeEmbedInitialLayout = ({
+  manifest,
+  parameters,
+  placeholderId
+}) => {
+  var _manifest$parameterDe, _manifest$parameterDe2, _manifest$parameterDe3, _manifest$lockResizeA, _manifest$uiConfig$sh, _manifest$uiConfig;
+  const {
+    alignment,
+    aspectRatio,
+    height,
+    width
+  } = getParameters(parameters);
+  const effectiveWidth = width !== null && width !== void 0 ? width : manifest === null || manifest === void 0 ? void 0 : (_manifest$parameterDe = manifest.parameterDefaults) === null || _manifest$parameterDe === void 0 ? void 0 : _manifest$parameterDe.width;
+
+  // `getParameters` always supplies default values, so inspect raw macroParams to distinguish
+  // stored dimensions from package defaults. This prevents the default aspectRatio from affecting
+  // older embeds that never persisted original dimensions.
+  const macroParams = parameters === null || parameters === void 0 ? void 0 : parameters.macroParams;
+  const heightExplicitlyStored = !!(macroParams !== null && macroParams !== void 0 && macroParams.height);
+  const aspectRatioExplicitlyStored = !!(macroParams !== null && macroParams !== void 0 && macroParams.aspectRatio);
+  const effectiveHeightRaw = heightExplicitlyStored ? height : (_manifest$parameterDe2 = manifest === null || manifest === void 0 ? void 0 : (_manifest$parameterDe3 = manifest.parameterDefaults) === null || _manifest$parameterDe3 === void 0 ? void 0 : _manifest$parameterDe3.height) !== null && _manifest$parameterDe2 !== void 0 ? _manifest$parameterDe2 : null;
+  const effectiveHeight = aspectRatioExplicitlyStored && aspectRatio != null && aspectRatio > 0 && effectiveWidth != null && !heightExplicitlyStored ? Math.round(effectiveWidth / aspectRatio) : effectiveHeightRaw !== null && effectiveHeightRaw !== void 0 ? effectiveHeightRaw : height;
+  const lockAspectRatio = typeof (manifest === null || manifest === void 0 ? void 0 : manifest.lockResizeAspectRatio) === 'function' ? manifest.lockResizeAspectRatio() : (_manifest$lockResizeA = manifest === null || manifest === void 0 ? void 0 : manifest.lockResizeAspectRatio) !== null && _manifest$lockResizeA !== void 0 ? _manifest$lockResizeA : true;
+  return {
+    alignment,
+    effectiveHeight,
+    effectiveWidth,
+    hasEmbedBorder: (_manifest$uiConfig$sh = manifest === null || manifest === void 0 ? void 0 : (_manifest$uiConfig = manifest.uiConfig) === null || _manifest$uiConfig === void 0 ? void 0 : _manifest$uiConfig.showBorder) !== null && _manifest$uiConfig$sh !== void 0 ? _manifest$uiConfig$sh : true,
+    lockAspectRatio,
+    placeholderId
+  };
+};

package/dist/es2019/i18n/fr.js

@@ -0,0 +1,10 @@
+/* prettier-ignore */
+/**
+ * NOTE:
+ *
+ * This file is automatically generated by Traduki 2.0.
+ * DO NOT CHANGE IT BY HAND or your changes will be lost.
+ */
+
+import translations from '@atlassian/afm-i18n-platform-native-embeds-native-embeds-common/i18n/fr';
+export default translations;

package/dist/es2019/i18n/pt_BR.js

@@ -0,0 +1,10 @@
+/* prettier-ignore */
+/**
+ * NOTE:
+ *
+ * This file is automatically generated by Traduki 2.0.
+ * DO NOT CHANGE IT BY HAND or your changes will be lost.
+ */
+
+import translations from '@atlassian/afm-i18n-platform-native-embeds-native-embeds-common/i18n/pt_BR';
+export default translations;

package/dist/es2019/index.js

@@ -1,6 +1,5 @@
 // Re-export constants
 export { ALIGNMENT_VALUES, DEFAULT_ALIGNMENT, BUILTIN_TOOLBAR_KEYS, EDITOR_TOOLBAR_HANDLER_KEYS, NATIVE_EMBED_PARAMETER_DEFAULTS } from './utils/constants';
-
 // Re-export types
 
 // Plugin actions types

package/dist/esm/entry-points/initial-layout.js

@@ -0,0 +1,38 @@
+import { getParameters } from '../utils/utils';
+export var NATIVE_EMBED_INITIAL_LAYOUT_FALLBACK_ASPECT_RATIO = '760 / 600';
+/**
+ * Resolve the dimensions needed to reserve native embed layout before the full iframe UI is ready.
+ *
+ * This intentionally depends only on ADF parameters and optional manifest-like metadata so it can be
+ * reused by React, DOMOutputSpec, SSR, and renderer placeholders without importing iframe UI code.
+ */
+export var resolveNativeEmbedInitialLayout = function resolveNativeEmbedInitialLayout(_ref) {
+  var _manifest$parameterDe, _manifest$parameterDe2, _manifest$parameterDe3, _manifest$lockResizeA, _manifest$uiConfig$sh, _manifest$uiConfig;
+  var manifest = _ref.manifest,
+    parameters = _ref.parameters,
+    placeholderId = _ref.placeholderId;
+  var _getParameters = getParameters(parameters),
+    alignment = _getParameters.alignment,
+    aspectRatio = _getParameters.aspectRatio,
+    height = _getParameters.height,
+    width = _getParameters.width;
+  var effectiveWidth = width !== null && width !== void 0 ? width : manifest === null || manifest === void 0 || (_manifest$parameterDe = manifest.parameterDefaults) === null || _manifest$parameterDe === void 0 ? void 0 : _manifest$parameterDe.width;
+
+  // `getParameters` always supplies default values, so inspect raw macroParams to distinguish
+  // stored dimensions from package defaults. This prevents the default aspectRatio from affecting
+  // older embeds that never persisted original dimensions.
+  var macroParams = parameters === null || parameters === void 0 ? void 0 : parameters.macroParams;
+  var heightExplicitlyStored = !!(macroParams !== null && macroParams !== void 0 && macroParams.height);
+  var aspectRatioExplicitlyStored = !!(macroParams !== null && macroParams !== void 0 && macroParams.aspectRatio);
+  var effectiveHeightRaw = heightExplicitlyStored ? height : (_manifest$parameterDe2 = manifest === null || manifest === void 0 || (_manifest$parameterDe3 = manifest.parameterDefaults) === null || _manifest$parameterDe3 === void 0 ? void 0 : _manifest$parameterDe3.height) !== null && _manifest$parameterDe2 !== void 0 ? _manifest$parameterDe2 : null;
+  var effectiveHeight = aspectRatioExplicitlyStored && aspectRatio != null && aspectRatio > 0 && effectiveWidth != null && !heightExplicitlyStored ? Math.round(effectiveWidth / aspectRatio) : effectiveHeightRaw !== null && effectiveHeightRaw !== void 0 ? effectiveHeightRaw : height;
+  var lockAspectRatio = typeof (manifest === null || manifest === void 0 ? void 0 : manifest.lockResizeAspectRatio) === 'function' ? manifest.lockResizeAspectRatio() : (_manifest$lockResizeA = manifest === null || manifest === void 0 ? void 0 : manifest.lockResizeAspectRatio) !== null && _manifest$lockResizeA !== void 0 ? _manifest$lockResizeA : true;
+  return {
+    alignment: alignment,
+    effectiveHeight: effectiveHeight,
+    effectiveWidth: effectiveWidth,
+    hasEmbedBorder: (_manifest$uiConfig$sh = manifest === null || manifest === void 0 || (_manifest$uiConfig = manifest.uiConfig) === null || _manifest$uiConfig === void 0 ? void 0 : _manifest$uiConfig.showBorder) !== null && _manifest$uiConfig$sh !== void 0 ? _manifest$uiConfig$sh : true,
+    lockAspectRatio: lockAspectRatio,
+    placeholderId: placeholderId
+  };
+};

package/dist/esm/i18n/fr.js

@@ -0,0 +1,10 @@
+/* prettier-ignore */
+/**
+ * NOTE:
+ *
+ * This file is automatically generated by Traduki 2.0.
+ * DO NOT CHANGE IT BY HAND or your changes will be lost.
+ */
+
+import translations from '@atlassian/afm-i18n-platform-native-embeds-native-embeds-common/i18n/fr';
+export default translations;

package/dist/esm/i18n/pt_BR.js

@@ -0,0 +1,10 @@
+/* prettier-ignore */
+/**
+ * NOTE:
+ *
+ * This file is automatically generated by Traduki 2.0.
+ * DO NOT CHANGE IT BY HAND or your changes will be lost.
+ */
+
+import translations from '@atlassian/afm-i18n-platform-native-embeds-native-embeds-common/i18n/pt_BR';
+export default translations;

package/dist/esm/index.js

@@ -1,6 +1,5 @@
 // Re-export constants
 export { ALIGNMENT_VALUES, DEFAULT_ALIGNMENT, BUILTIN_TOOLBAR_KEYS, EDITOR_TOOLBAR_HANDLER_KEYS, NATIVE_EMBED_PARAMETER_DEFAULTS } from './utils/constants';
-
 // Re-export types
 
 // Plugin actions types

package/dist/types/entry-points/initial-layout.d.ts

@@ -0,0 +1,32 @@
+import type { AlignmentValue, NativeEmbedParameters } from '../utils/types';
+export declare const NATIVE_EMBED_INITIAL_LAYOUT_FALLBACK_ASPECT_RATIO = "760 / 600";
+export type NativeEmbedInitialLayoutManifest = {
+    lockResizeAspectRatio?: boolean | (() => boolean);
+    parameterDefaults?: {
+        height?: number;
+        width?: number;
+    };
+    uiConfig?: {
+        showBorder?: boolean;
+    };
+};
+export type NativeEmbedInitialLayout = {
+    alignment: AlignmentValue;
+    effectiveHeight: number;
+    effectiveWidth: number | undefined;
+    hasEmbedBorder: boolean;
+    lockAspectRatio: boolean;
+    placeholderId?: string;
+};
+export type ResolveNativeEmbedInitialLayoutInput = {
+    manifest?: NativeEmbedInitialLayoutManifest;
+    parameters?: NativeEmbedParameters;
+    placeholderId?: string;
+};
+/**
+ * Resolve the dimensions needed to reserve native embed layout before the full iframe UI is ready.
+ *
+ * This intentionally depends only on ADF parameters and optional manifest-like metadata so it can be
+ * reused by React, DOMOutputSpec, SSR, and renderer placeholders without importing iframe UI code.
+ */
+export declare const resolveNativeEmbedInitialLayout: ({ manifest, parameters, placeholderId, }: ResolveNativeEmbedInitialLayoutInput) => NativeEmbedInitialLayout;

package/dist/types/i18n/fr.d.ts

@@ -0,0 +1,8 @@
+/**
+ * NOTE:
+ *
+ * This file is automatically generated by Traduki 2.0.
+ * DO NOT CHANGE IT BY HAND or your changes will be lost.
+ */
+import translations from '@atlassian/afm-i18n-platform-native-embeds-native-embeds-common/i18n/fr';
+export default translations;

package/dist/types/i18n/pt_BR.d.ts

@@ -0,0 +1,8 @@
+/**
+ * NOTE:
+ *
+ * This file is automatically generated by Traduki 2.0.
+ * DO NOT CHANGE IT BY HAND or your changes will be lost.
+ */
+import translations from '@atlassian/afm-i18n-platform-native-embeds-native-embeds-common/i18n/pt_BR';
+export default translations;

package/initial-layout/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@atlaskit/native-embeds-common/initial-layout",
+  "main": "../dist/cjs/entry-points/initial-layout.js",
+  "module": "../dist/esm/entry-points/initial-layout.js",
+  "module:es2019": "../dist/es2019/entry-points/initial-layout.js",
+  "sideEffects": [
+    "*.compiled.css"
+  ],
+  "types": "../dist/types/entry-points/initial-layout.d.ts"
+}

package/package.json

@@ -17,14 +17,14 @@
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
 		"@atlaskit/button": "^24.3.0",
-		"@atlaskit/editor-common": "^116.17.0",
+		"@atlaskit/editor-common": "^116.24.0",
 		"@atlaskit/editor-plugin-local-id": "^10.1.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
-		"@atlaskit/heading": "^6.1.0",
-		"@atlaskit/icon": "^36.1.0",
-		"@atlaskit/primitives": "^20.2.0",
-		"@atlaskit/tokens": "^15.2.0",
-		"@atlassian/afm-i18n-platform-native-embeds-native-embeds-common": "1.5.0",
+		"@atlaskit/heading": "^6.2.0",
+		"@atlaskit/icon": "^36.2.0",
+		"@atlaskit/primitives": "^20.5.0",
+		"@atlaskit/tokens": "^15.5.0",
+		"@atlassian/afm-i18n-platform-native-embeds-native-embeds-common": "1.7.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.20.0"
 	},
@@ -80,7 +80,7 @@
 		}
 	},
 	"name": "@atlaskit/native-embeds-common",
-	"version": "2.0.4",
+	"version": "2.0.6",
 	"description": "A shared package for native embeds to be used across experiences and plugin",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",