@atlaskit/adf-schema 25.8.3 → 25.9.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/adf-schema
 
+## 25.9.1
+
+### Patch Changes
+
+- [`bf7e8e4968b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/bf7e8e4968b) - ED-15895 add unsupportedinline support to caption
+
+## 25.9.0
+
+### Minor Changes
+
+- [`6de13a329d4`](https://bitbucket.org/atlassian/atlassian-frontend/commits/6de13a329d4) - Move `width` and `layout` out from `datasource` into `attr` root (context blockCard node)
+
 ## 25.8.3
 
 ### Patch Changes

package/dist/cjs/schema/nodes/block-card.js

@@ -1,9 +1,13 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.blockCard = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 /**
  * @stage 0
  */
@@ -12,6 +16,17 @@ exports.blockCard = void 0;
  * @name blockCard_node
  */
 
+var getCommonAttributesFromDom = function getCommonAttributesFromDom(dom) {
+  var anchor = dom;
+  var data = anchor.getAttribute('data-card-data');
+  var datasource = anchor.getAttribute('data-datasource');
+  return {
+    data: data ? JSON.parse(data) : undefined,
+    layout: datasource ? dom.getAttribute('data-layout') || 'center' : undefined,
+    width: Number(dom.getAttribute('data-width')) || undefined,
+    datasource: datasource ? JSON.parse(datasource) : undefined
+  };
+};
 var blockCard = {
   inline: false,
   group: 'block',
@@ -26,6 +41,12 @@ var blockCard = {
     },
     datasource: {
       default: null
+    },
+    layout: {
+      default: null
+    },
+    width: {
+      default: null
     }
   },
   parseDOM: [{
@@ -34,34 +55,36 @@ var blockCard = {
     priority: 100,
     getAttrs: function getAttrs(dom) {
       var anchor = dom;
-      var data = anchor.getAttribute('data-card-data');
-      var datasource = anchor.getAttribute('data-datasource');
-      return {
-        url: anchor.getAttribute('href') || null,
-        data: data ? JSON.parse(data) : null,
-        datasource: datasource ? JSON.parse(datasource) : null
-      };
+      return _objectSpread({
+        url: anchor.getAttribute('href') || undefined
+      }, getCommonAttributesFromDom(dom));
     }
   }, {
     tag: 'div[data-block-card]',
     getAttrs: function getAttrs(dom) {
       var anchor = dom;
-      var data = anchor.getAttribute('data-card-data');
-      var datasource = anchor.getAttribute('data-datasource');
-      return {
-        url: anchor.getAttribute('data-card-url') || null,
-        data: data ? JSON.parse(data) : null,
-        datasource: datasource ? JSON.parse(datasource) : null
-      };
+      return _objectSpread({
+        url: anchor.getAttribute('data-card-url') || undefined
+      }, getCommonAttributesFromDom(dom));
     }
   }],
   toDOM: function toDOM(node) {
     var _node$attrs;
+    var _ref = node.attrs,
+      url = _ref.url;
+    var _ref2 = node.attrs,
+      data = _ref2.data;
+    var _ref3 = node.attrs,
+      layout = _ref3.layout,
+      width = _ref3.width,
+      datasource = _ref3.datasource;
     var attrs = {
       'data-block-card': '',
-      href: node.attrs.url || '',
-      'data-card-data': node.attrs.data ? JSON.stringify(node.attrs.data) : '',
-      'data-datasource': node.attrs.datasource ? JSON.stringify(node.attrs.datasource) : ''
+      href: url || '',
+      'data-card-data': data ? JSON.stringify(data) : '',
+      'data-datasource': datasource ? JSON.stringify(datasource) : '',
+      'data-layout': layout,
+      'data-width': "".concat(width)
     };
     return ['a', attrs, (node === null || node === void 0 ? void 0 : (_node$attrs = node.attrs) === null || _node$attrs === void 0 ? void 0 : _node$attrs.url) || ' '];
   }

package/dist/cjs/schema/nodes/caption.js

@@ -9,7 +9,7 @@ exports.caption = void 0;
  */
 
 var caption = {
-  content: '(text|hardBreak|mention|emoji|date|placeholder|inlineCard|status)*',
+  content: '(text|hardBreak|mention|emoji|date|placeholder|inlineCard|status|unsupportedInline)*',
   isolating: true,
   marks: '_',
   selectable: false,

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/adf-schema",
-	"version": "25.8.3",
+	"version": "25.9.1",
 	"sideEffects": false
 }

package/dist/es2019/schema/nodes/block-card.js

@@ -6,6 +6,17 @@
  * @name blockCard_node
  */
 
+const getCommonAttributesFromDom = dom => {
+  const anchor = dom;
+  const data = anchor.getAttribute('data-card-data');
+  const datasource = anchor.getAttribute('data-datasource');
+  return {
+    data: data ? JSON.parse(data) : undefined,
+    layout: datasource ? dom.getAttribute('data-layout') || 'center' : undefined,
+    width: Number(dom.getAttribute('data-width')) || undefined,
+    datasource: datasource ? JSON.parse(datasource) : undefined
+  };
+};
 export const blockCard = {
   inline: false,
   group: 'block',
@@ -20,6 +31,12 @@ export const blockCard = {
     },
     datasource: {
       default: null
+    },
+    layout: {
+      default: null
+    },
+    width: {
+      default: null
     }
   },
   parseDOM: [{
@@ -28,34 +45,41 @@ export const blockCard = {
     priority: 100,
     getAttrs: dom => {
       const anchor = dom;
-      const data = anchor.getAttribute('data-card-data');
-      const datasource = anchor.getAttribute('data-datasource');
       return {
-        url: anchor.getAttribute('href') || null,
-        data: data ? JSON.parse(data) : null,
-        datasource: datasource ? JSON.parse(datasource) : null
+        url: anchor.getAttribute('href') || undefined,
+        ...getCommonAttributesFromDom(dom)
       };
     }
   }, {
     tag: 'div[data-block-card]',
     getAttrs: dom => {
       const anchor = dom;
-      const data = anchor.getAttribute('data-card-data');
-      const datasource = anchor.getAttribute('data-datasource');
       return {
-        url: anchor.getAttribute('data-card-url') || null,
-        data: data ? JSON.parse(data) : null,
-        datasource: datasource ? JSON.parse(datasource) : null
+        url: anchor.getAttribute('data-card-url') || undefined,
+        ...getCommonAttributesFromDom(dom)
       };
     }
   }],
   toDOM(node) {
     var _node$attrs;
+    const {
+      url
+    } = node.attrs;
+    const {
+      data
+    } = node.attrs;
+    const {
+      layout,
+      width,
+      datasource
+    } = node.attrs;
     const attrs = {
       'data-block-card': '',
-      href: node.attrs.url || '',
-      'data-card-data': node.attrs.data ? JSON.stringify(node.attrs.data) : '',
-      'data-datasource': node.attrs.datasource ? JSON.stringify(node.attrs.datasource) : ''
+      href: url || '',
+      'data-card-data': data ? JSON.stringify(data) : '',
+      'data-datasource': datasource ? JSON.stringify(datasource) : '',
+      'data-layout': layout,
+      'data-width': `${width}`
     };
     return ['a', attrs, (node === null || node === void 0 ? void 0 : (_node$attrs = node.attrs) === null || _node$attrs === void 0 ? void 0 : _node$attrs.url) || ' '];
   }

package/dist/es2019/schema/nodes/caption.js

@@ -3,7 +3,7 @@
  */
 
 export const caption = {
-  content: '(text|hardBreak|mention|emoji|date|placeholder|inlineCard|status)*',
+  content: '(text|hardBreak|mention|emoji|date|placeholder|inlineCard|status|unsupportedInline)*',
   isolating: true,
   marks: '_',
   selectable: false,

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/adf-schema",
-	"version": "25.8.3",
+	"version": "25.9.1",
 	"sideEffects": false
 }

package/dist/esm/schema/nodes/block-card.js

@@ -1,3 +1,6 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 /**
  * @stage 0
  */
@@ -6,6 +9,17 @@
  * @name blockCard_node
  */
 
+var getCommonAttributesFromDom = function getCommonAttributesFromDom(dom) {
+  var anchor = dom;
+  var data = anchor.getAttribute('data-card-data');
+  var datasource = anchor.getAttribute('data-datasource');
+  return {
+    data: data ? JSON.parse(data) : undefined,
+    layout: datasource ? dom.getAttribute('data-layout') || 'center' : undefined,
+    width: Number(dom.getAttribute('data-width')) || undefined,
+    datasource: datasource ? JSON.parse(datasource) : undefined
+  };
+};
 export var blockCard = {
   inline: false,
   group: 'block',
@@ -20,6 +34,12 @@ export var blockCard = {
     },
     datasource: {
       default: null
+    },
+    layout: {
+      default: null
+    },
+    width: {
+      default: null
     }
   },
   parseDOM: [{
@@ -28,34 +48,36 @@ export var blockCard = {
     priority: 100,
     getAttrs: function getAttrs(dom) {
       var anchor = dom;
-      var data = anchor.getAttribute('data-card-data');
-      var datasource = anchor.getAttribute('data-datasource');
-      return {
-        url: anchor.getAttribute('href') || null,
-        data: data ? JSON.parse(data) : null,
-        datasource: datasource ? JSON.parse(datasource) : null
-      };
+      return _objectSpread({
+        url: anchor.getAttribute('href') || undefined
+      }, getCommonAttributesFromDom(dom));
     }
   }, {
     tag: 'div[data-block-card]',
     getAttrs: function getAttrs(dom) {
       var anchor = dom;
-      var data = anchor.getAttribute('data-card-data');
-      var datasource = anchor.getAttribute('data-datasource');
-      return {
-        url: anchor.getAttribute('data-card-url') || null,
-        data: data ? JSON.parse(data) : null,
-        datasource: datasource ? JSON.parse(datasource) : null
-      };
+      return _objectSpread({
+        url: anchor.getAttribute('data-card-url') || undefined
+      }, getCommonAttributesFromDom(dom));
     }
   }],
   toDOM: function toDOM(node) {
     var _node$attrs;
+    var _ref = node.attrs,
+      url = _ref.url;
+    var _ref2 = node.attrs,
+      data = _ref2.data;
+    var _ref3 = node.attrs,
+      layout = _ref3.layout,
+      width = _ref3.width,
+      datasource = _ref3.datasource;
     var attrs = {
       'data-block-card': '',
-      href: node.attrs.url || '',
-      'data-card-data': node.attrs.data ? JSON.stringify(node.attrs.data) : '',
-      'data-datasource': node.attrs.datasource ? JSON.stringify(node.attrs.datasource) : ''
+      href: url || '',
+      'data-card-data': data ? JSON.stringify(data) : '',
+      'data-datasource': datasource ? JSON.stringify(datasource) : '',
+      'data-layout': layout,
+      'data-width': "".concat(width)
     };
     return ['a', attrs, (node === null || node === void 0 ? void 0 : (_node$attrs = node.attrs) === null || _node$attrs === void 0 ? void 0 : _node$attrs.url) || ' '];
   }

package/dist/esm/schema/nodes/caption.js

@@ -3,7 +3,7 @@
  */
 
 export var caption = {
-  content: '(text|hardBreak|mention|emoji|date|placeholder|inlineCard|status)*',
+  content: '(text|hardBreak|mention|emoji|date|placeholder|inlineCard|status|unsupportedInline)*',
   isolating: true,
   marks: '_',
   selectable: false,

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/adf-schema",
-	"version": "25.8.3",
+	"version": "25.9.1",
 	"sideEffects": false
 }

package/dist/json-schema/v1/stage-0.json

@@ -774,32 +774,30 @@
                           "type"
                         ],
                         "additionalProperties": false
-                      }
-                    },
-                    "width": {
-                      "type": "number",
-                      "minimum": 0,
-                      "maximum": 100
-                    },
-                    "layout": {
-                      "enum": [
-                        "wide",
-                        "full-width",
-                        "center",
-                        "wrap-right",
-                        "wrap-left",
-                        "align-end",
-                        "align-start"
-                      ]
+                      },
+                      "minItems": 1
                     }
                   },
                   "required": [
                     "id",
                     "parameters",
-                    "views",
-                    "layout"
+                    "views"
                   ],
                   "additionalProperties": false
+                },
+                "width": {
+                  "type": "number"
+                },
+                "layout": {
+                  "enum": [
+                    "wide",
+                    "full-width",
+                    "center",
+                    "wrap-right",
+                    "wrap-left",
+                    "align-end",
+                    "align-start"
+                  ]
                 }
               },
               "additionalProperties": false,

package/dist/types/schema/nodes/block-card.d.ts

@@ -1,5 +1,5 @@
 import { NodeSpec } from 'prosemirror-model';
-import { RichMediaAttributes } from './types/rich-media-common';
+import { OptionalRichMediaAttributes } from './types/rich-media-common';
 export interface UrlType {
     /**
      * @validatorFn safeUrl
@@ -12,18 +12,21 @@ export interface DataType {
      */
     data: object;
 }
-export interface DatasourceAttributeProperties extends RichMediaAttributes {
+export interface DatasourceAttributeProperties {
     id: string;
     parameters: object;
-    views: [{
+    /**
+     * @minItems 1
+     */
+    views: {
         type: string;
         properties?: object;
-    }];
+    }[];
 }
 /**
  * @stage 0
  */
-export interface DatasourceAttributes {
+export interface DatasourceAttributes extends OptionalRichMediaAttributes {
     /**
      * @validatorFn safeUrl
      */

package/dist/types/schema/nodes/caption.d.ts

@@ -14,6 +14,7 @@ export interface CaptionDefinition {
     type: 'caption';
     /**
      * @minItems 0
+     * @allowUnsupportedInline true
      */
     content: Array<InlineFormattedText | InlineCode | HardBreak | Mention | Emoji | Date | Placeholder | InlineCard | Status>;
 }

package/dist/types/schema/nodes/types/rich-media-common.d.ts

@@ -7,3 +7,7 @@ export interface RichMediaAttributes {
     width?: number;
     layout: Layout;
 }
+export interface OptionalRichMediaAttributes {
+    width?: number;
+    layout?: Layout;
+}

package/dist/types-ts4.5/schema/nodes/block-card.d.ts

@@ -1,5 +1,5 @@
 import { NodeSpec } from 'prosemirror-model';
-import { RichMediaAttributes } from './types/rich-media-common';
+import { OptionalRichMediaAttributes } from './types/rich-media-common';
 export interface UrlType {
     /**
      * @validatorFn safeUrl
@@ -12,20 +12,21 @@ export interface DataType {
      */
     data: object;
 }
-export interface DatasourceAttributeProperties extends RichMediaAttributes {
+export interface DatasourceAttributeProperties {
     id: string;
     parameters: object;
-    views: [
-        {
-            type: string;
-            properties?: object;
-        }
-    ];
+    /**
+     * @minItems 1
+     */
+    views: {
+        type: string;
+        properties?: object;
+    }[];
 }
 /**
  * @stage 0
  */
-export interface DatasourceAttributes {
+export interface DatasourceAttributes extends OptionalRichMediaAttributes {
     /**
      * @validatorFn safeUrl
      */

package/dist/types-ts4.5/schema/nodes/caption.d.ts

@@ -14,6 +14,7 @@ export interface CaptionDefinition {
     type: 'caption';
     /**
      * @minItems 0
+     * @allowUnsupportedInline true
      */
     content: Array<InlineFormattedText | InlineCode | HardBreak | Mention | Emoji | Date | Placeholder | InlineCard | Status>;
 }

package/dist/types-ts4.5/schema/nodes/types/rich-media-common.d.ts

@@ -7,3 +7,7 @@ export interface RichMediaAttributes {
     width?: number;
     layout: Layout;
 }
+export interface OptionalRichMediaAttributes {
+    width?: number;
+    layout?: Layout;
+}

package/json-schema/v1/stage-0.json

@@ -774,32 +774,30 @@
                           "type"
                         ],
                         "additionalProperties": false
-                      }
-                    },
-                    "width": {
-                      "type": "number",
-                      "minimum": 0,
-                      "maximum": 100
-                    },
-                    "layout": {
-                      "enum": [
-                        "wide",
-                        "full-width",
-                        "center",
-                        "wrap-right",
-                        "wrap-left",
-                        "align-end",
-                        "align-start"
-                      ]
+                      },
+                      "minItems": 1
                     }
                   },
                   "required": [
                     "id",
                     "parameters",
-                    "views",
-                    "layout"
+                    "views"
                   ],
                   "additionalProperties": false
+                },
+                "width": {
+                  "type": "number"
+                },
+                "layout": {
+                  "enum": [
+                    "wide",
+                    "full-width",
+                    "center",
+                    "wrap-right",
+                    "wrap-left",
+                    "align-end",
+                    "align-start"
+                  ]
                 }
               },
               "additionalProperties": false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "25.8.3",
+  "version": "25.9.1",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -58,7 +58,7 @@
     "prosemirror-transform": "1.3.2"
   },
   "devDependencies": {
-    "@atlaskit/editor-test-helpers": "^18.6.0",
+    "@atlaskit/editor-test-helpers": "^18.7.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@types/linkify-it": "^2.0.4",
     "@types/prosemirror-history": "^1.0.1",

package/report.api.md

@@ -276,7 +276,6 @@ export const caption: NodeSpec;
 
 // @public
 export interface CaptionDefinition {
-  // (undocumented)
   content: Array<
     | DateDefinition
     | EmojiDefinition
@@ -427,22 +426,20 @@ export const dataConsumerToJSON: (mark: Mark) => {
 };
 
 // @public (undocumented)
-interface DatasourceAttributeProperties extends RichMediaAttributes {
+interface DatasourceAttributeProperties {
   // (undocumented)
   id: string;
   // (undocumented)
   parameters: object;
   // (undocumented)
-  views: [
-    {
-      type: string;
-      properties?: object;
-    },
-  ];
+  views: {
+    type: string;
+    properties?: object;
+  }[];
 }
 
 // @public (undocumented)
-export interface DatasourceAttributes {
+export interface DatasourceAttributes extends OptionalRichMediaAttributes {
   // (undocumented)
   datasource: DatasourceAttributeProperties;
   url?: string;
@@ -1290,6 +1287,14 @@ export function normalizeHexColor(
 // @public
 export function normalizeUrl(url?: string): string;
 
+// @public (undocumented)
+interface OptionalRichMediaAttributes {
+  // (undocumented)
+  layout?: RichMediaLayout;
+  // (undocumented)
+  width?: number;
+}
+
 // @public (undocumented)
 export const orderedList: NodeSpec;
 

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

@@ -240,7 +240,6 @@ export const caption: NodeSpec;
 
 // @public
 export interface CaptionDefinition {
-    // (undocumented)
     content: Array<DateDefinition | EmojiDefinition | HardBreakDefinition | InlineCardDefinition | InlineCode | InlineFormattedText | MentionDefinition | PlaceholderDefinition | StatusDefinition>;
     // (undocumented)
     type: 'caption';
@@ -373,20 +372,20 @@ export const dataConsumerToJSON: (mark: Mark) => {
 };
 
 // @public (undocumented)
-interface DatasourceAttributeProperties extends RichMediaAttributes {
+interface DatasourceAttributeProperties {
     // (undocumented)
     id: string;
     // (undocumented)
     parameters: object;
     // (undocumented)
-    views: [{
+    views: {
         type: string;
         properties?: object;
-    }];
+    }[];
 }
 
 // @public (undocumented)
-export interface DatasourceAttributes {
+export interface DatasourceAttributes extends OptionalRichMediaAttributes {
     // (undocumented)
     datasource: DatasourceAttributeProperties;
     url?: string;
@@ -1157,6 +1156,14 @@ export function normalizeHexColor(color: null | string, defaultColor?: string):
 // @public
 export function normalizeUrl(url?: string): string;
 
+// @public (undocumented)
+interface OptionalRichMediaAttributes {
+    // (undocumented)
+    layout?: RichMediaLayout;
+    // (undocumented)
+    width?: number;
+}
+
 // @public (undocumented)
 export const orderedList: NodeSpec;