@atlaskit/adf-schema 26.0.1 → 26.1.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/adf-schema
 
+## 26.1.0
+
+### Minor Changes
+
+- [`65fe45e0cc0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/65fe45e0cc0) - Promoted border mark to full schema and add border support for email renderer
+
 ## 26.0.1
 
 ### Patch Changes

package/dist/cjs/schema/default-schema.js

@@ -7,12 +7,11 @@ Object.defineProperty(exports, "__esModule", {
 exports.getSchemaBasedOnStage = exports.defaultSchemaConfig = exports.defaultSchema = void 0;
 var _memoizeOne = _interopRequireDefault(require("memoize-one"));
 var _nodes = require("./nodes");
-var _marks = require("./marks");
 var _createSchema = require("./create-schema");
 var getDefaultSchemaConfig = function getDefaultSchemaConfig() {
   var defaultSchemaConfig = {
     nodes: ['doc', 'paragraph', 'text', 'bulletList', 'orderedList', 'listItem', 'heading', 'blockquote', 'codeBlock', 'panel', 'rule', 'image', 'caption', 'mention', 'media', 'mediaGroup', 'mediaSingle', 'mediaInline', 'confluenceUnsupportedBlock', 'confluenceUnsupportedInline', 'confluenceJiraIssue', 'expand', 'nestedExpand', 'extension', 'inlineExtension', 'bodiedExtension', 'hardBreak', 'emoji', 'table', 'tableCell', 'tableHeader', 'tableRow', 'decisionList', 'decisionItem', 'taskList', 'taskItem', 'unknownBlock', 'date', 'status', 'placeholder', 'layoutSection', 'layoutColumn', 'inlineCard', 'blockCard', 'embedCard', 'unsupportedBlock', 'unsupportedInline'],
-    marks: ['link', 'em', 'strong', 'strike', 'subsup', 'underline', 'code', 'textColor', 'confluenceInlineComment', 'breakout', 'alignment', 'indentation', 'annotation', 'dataConsumer', 'unsupportedMark', 'unsupportedNodeAttribute', 'typeAheadQuery',
+    marks: ['link', 'em', 'strong', 'strike', 'subsup', 'underline', 'code', 'textColor', 'confluenceInlineComment', 'breakout', 'alignment', 'indentation', 'annotation', 'dataConsumer', 'border', 'unsupportedMark', 'unsupportedNodeAttribute', 'typeAheadQuery',
     // https://product-fabric.atlassian.net/browse/ED-10214,
     'fragment']
   };
@@ -29,9 +28,6 @@ var getSchemaBasedOnStage = (0, _memoizeOne.default)(function () {
       table: _nodes.tableWithCustomWidth,
       mediaSingle: _nodes.mediaSingleFull
     };
-    defaultSchemaConfig.customMarkSpecs = {
-      border: _marks.border
-    };
   }
   return (0, _createSchema.createSchema)(defaultSchemaConfig);
 });

package/dist/cjs/schema/marks/border.js

@@ -10,7 +10,6 @@ var _editorPalette = require("@atlaskit/editor-palette");
 var _colors = require("../../utils/colors");
 /**
  * @name border_mark
- * @stage 0
  * @description This mark adds decoration to an element, and any element decorated with it will also have a border style.
  */
 

package/dist/cjs/version.json

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

package/dist/es2019/schema/default-schema.js

@@ -1,11 +1,10 @@
 import memoizeOne from 'memoize-one';
 import { mediaSingleFull, layoutSectionWithSingleColumn, tableWithCustomWidth } from './nodes';
-import { border } from './marks';
 import { createSchema } from './create-schema';
 const getDefaultSchemaConfig = () => {
   let defaultSchemaConfig = {
     nodes: ['doc', 'paragraph', 'text', 'bulletList', 'orderedList', 'listItem', 'heading', 'blockquote', 'codeBlock', 'panel', 'rule', 'image', 'caption', 'mention', 'media', 'mediaGroup', 'mediaSingle', 'mediaInline', 'confluenceUnsupportedBlock', 'confluenceUnsupportedInline', 'confluenceJiraIssue', 'expand', 'nestedExpand', 'extension', 'inlineExtension', 'bodiedExtension', 'hardBreak', 'emoji', 'table', 'tableCell', 'tableHeader', 'tableRow', 'decisionList', 'decisionItem', 'taskList', 'taskItem', 'unknownBlock', 'date', 'status', 'placeholder', 'layoutSection', 'layoutColumn', 'inlineCard', 'blockCard', 'embedCard', 'unsupportedBlock', 'unsupportedInline'],
-    marks: ['link', 'em', 'strong', 'strike', 'subsup', 'underline', 'code', 'textColor', 'confluenceInlineComment', 'breakout', 'alignment', 'indentation', 'annotation', 'dataConsumer', 'unsupportedMark', 'unsupportedNodeAttribute', 'typeAheadQuery',
+    marks: ['link', 'em', 'strong', 'strike', 'subsup', 'underline', 'code', 'textColor', 'confluenceInlineComment', 'breakout', 'alignment', 'indentation', 'annotation', 'dataConsumer', 'border', 'unsupportedMark', 'unsupportedNodeAttribute', 'typeAheadQuery',
     // https://product-fabric.atlassian.net/browse/ED-10214,
     'fragment']
   };
@@ -20,9 +19,6 @@ export const getSchemaBasedOnStage = memoizeOne((stage = 'final') => {
       table: tableWithCustomWidth,
       mediaSingle: mediaSingleFull
     };
-    defaultSchemaConfig.customMarkSpecs = {
-      border
-    };
   }
   return createSchema(defaultSchemaConfig);
 });

package/dist/es2019/schema/marks/border.js

@@ -3,7 +3,6 @@ import { N300A, N600, N1000 } from '../../utils/colors';
 
 /**
  * @name border_mark
- * @stage 0
  * @description This mark adds decoration to an element, and any element decorated with it will also have a border style.
  */
 

package/dist/es2019/version.json

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

package/dist/esm/schema/default-schema.js

@@ -1,11 +1,10 @@
 import memoizeOne from 'memoize-one';
 import { mediaSingleFull, layoutSectionWithSingleColumn, tableWithCustomWidth } from './nodes';
-import { border } from './marks';
 import { createSchema } from './create-schema';
 var getDefaultSchemaConfig = function getDefaultSchemaConfig() {
   var defaultSchemaConfig = {
     nodes: ['doc', 'paragraph', 'text', 'bulletList', 'orderedList', 'listItem', 'heading', 'blockquote', 'codeBlock', 'panel', 'rule', 'image', 'caption', 'mention', 'media', 'mediaGroup', 'mediaSingle', 'mediaInline', 'confluenceUnsupportedBlock', 'confluenceUnsupportedInline', 'confluenceJiraIssue', 'expand', 'nestedExpand', 'extension', 'inlineExtension', 'bodiedExtension', 'hardBreak', 'emoji', 'table', 'tableCell', 'tableHeader', 'tableRow', 'decisionList', 'decisionItem', 'taskList', 'taskItem', 'unknownBlock', 'date', 'status', 'placeholder', 'layoutSection', 'layoutColumn', 'inlineCard', 'blockCard', 'embedCard', 'unsupportedBlock', 'unsupportedInline'],
-    marks: ['link', 'em', 'strong', 'strike', 'subsup', 'underline', 'code', 'textColor', 'confluenceInlineComment', 'breakout', 'alignment', 'indentation', 'annotation', 'dataConsumer', 'unsupportedMark', 'unsupportedNodeAttribute', 'typeAheadQuery',
+    marks: ['link', 'em', 'strong', 'strike', 'subsup', 'underline', 'code', 'textColor', 'confluenceInlineComment', 'breakout', 'alignment', 'indentation', 'annotation', 'dataConsumer', 'border', 'unsupportedMark', 'unsupportedNodeAttribute', 'typeAheadQuery',
     // https://product-fabric.atlassian.net/browse/ED-10214,
     'fragment']
   };
@@ -21,9 +20,6 @@ export var getSchemaBasedOnStage = memoizeOne(function () {
       table: tableWithCustomWidth,
       mediaSingle: mediaSingleFull
     };
-    defaultSchemaConfig.customMarkSpecs = {
-      border: border
-    };
   }
   return createSchema(defaultSchemaConfig);
 });

package/dist/esm/schema/marks/border.js

@@ -4,7 +4,6 @@ import { N300A, N600, N1000 } from '../../utils/colors';
 
 /**
  * @name border_mark
- * @stage 0
  * @description This mark adds decoration to an element, and any element decorated with it will also have a border style.
  */
 

package/dist/esm/version.json

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

package/dist/json-schema/v1/full.json

@@ -458,6 +458,40 @@
       ],
       "additionalProperties": false
     },
+    "border_mark": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": [
+            "border"
+          ]
+        },
+        "attrs": {
+          "type": "object",
+          "properties": {
+            "size": {
+              "type": "number",
+              "minimum": 1,
+              "maximum": 3
+            },
+            "color": {
+              "type": "string",
+              "pattern": "^#[0-9a-fA-F]{8}$|^#[0-9a-fA-F]{6}$"
+            }
+          },
+          "required": [
+            "size",
+            "color"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "type",
+        "attrs"
+      ],
+      "additionalProperties": false
+    },
     "hardBreak_node": {
       "type": "object",
       "properties": {
@@ -887,7 +921,14 @@
         "marks": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/link_mark"
+            "anyOf": [
+              {
+                "$ref": "#/definitions/link_mark"
+              },
+              {
+                "$ref": "#/definitions/border_mark"
+              }
+            ]
           }
         }
       },

package/dist/types/schema/default-schema.d.ts

@@ -1,7 +1,7 @@
 /// <reference path="../../../../../../typings/prosemirror.d.ts" />
 import { SchemaConfig } from './create-schema';
 type DefaultSchemaNodes = 'doc' | 'paragraph' | 'text' | 'bulletList' | 'orderedList' | 'listItem' | 'heading' | 'blockquote' | 'codeBlock' | 'panel' | 'rule' | 'image' | 'mention' | 'media' | 'caption' | 'mediaGroup' | 'mediaSingle' | 'mediaInline' | 'confluenceUnsupportedBlock' | 'confluenceUnsupportedInline' | 'confluenceJiraIssue' | 'expand' | 'nestedExpand' | 'extension' | 'inlineExtension' | 'bodiedExtension' | 'hardBreak' | 'emoji' | 'table' | 'tableCell' | 'tableHeader' | 'tableRow' | 'decisionList' | 'decisionItem' | 'taskList' | 'taskItem' | 'unknownBlock' | 'date' | 'status' | 'placeholder' | 'layoutSection' | 'layoutColumn' | 'inlineCard' | 'blockCard' | 'embedCard' | 'unsupportedBlock' | 'unsupportedInline';
-type DefaultSchemaMarks = 'link' | 'em' | 'strong' | 'strike' | 'subsup' | 'underline' | 'code' | 'textColor' | 'confluenceInlineComment' | 'breakout' | 'alignment' | 'indentation' | 'annotation' | 'unsupportedMark' | 'unsupportedNodeAttribute' | 'typeAheadQuery' | 'dataConsumer' | 'fragment';
+type DefaultSchemaMarks = 'link' | 'em' | 'strong' | 'strike' | 'subsup' | 'underline' | 'code' | 'textColor' | 'confluenceInlineComment' | 'breakout' | 'alignment' | 'indentation' | 'annotation' | 'border' | 'unsupportedMark' | 'unsupportedNodeAttribute' | 'typeAheadQuery' | 'dataConsumer' | 'fragment';
 export declare const defaultSchemaConfig: SchemaConfig<DefaultSchemaNodes, DefaultSchemaMarks>;
 export declare const getSchemaBasedOnStage: import("memoize-one").MemoizedFn<(this: any, stage?: any) => import("prosemirror-model").Schema<DefaultSchemaNodes, DefaultSchemaMarks>>;
 export declare const defaultSchema: import("prosemirror-model").Schema<DefaultSchemaNodes, DefaultSchemaMarks>;

package/dist/types/schema/marks/border.d.ts

@@ -12,7 +12,6 @@ export type BorderMarkAttributes = {
 };
 /**
  * @name border_mark
- * @stage 0
  * @description This mark adds decoration to an element, and any element decorated with it will also have a border style.
  */
 export interface BorderMarkDefinition {

package/dist/types-ts4.5/schema/default-schema.d.ts

@@ -1,7 +1,7 @@
 /// <reference path="../../../../../../typings/prosemirror.d.ts" />
 import { SchemaConfig } from './create-schema';
 type DefaultSchemaNodes = 'doc' | 'paragraph' | 'text' | 'bulletList' | 'orderedList' | 'listItem' | 'heading' | 'blockquote' | 'codeBlock' | 'panel' | 'rule' | 'image' | 'mention' | 'media' | 'caption' | 'mediaGroup' | 'mediaSingle' | 'mediaInline' | 'confluenceUnsupportedBlock' | 'confluenceUnsupportedInline' | 'confluenceJiraIssue' | 'expand' | 'nestedExpand' | 'extension' | 'inlineExtension' | 'bodiedExtension' | 'hardBreak' | 'emoji' | 'table' | 'tableCell' | 'tableHeader' | 'tableRow' | 'decisionList' | 'decisionItem' | 'taskList' | 'taskItem' | 'unknownBlock' | 'date' | 'status' | 'placeholder' | 'layoutSection' | 'layoutColumn' | 'inlineCard' | 'blockCard' | 'embedCard' | 'unsupportedBlock' | 'unsupportedInline';
-type DefaultSchemaMarks = 'link' | 'em' | 'strong' | 'strike' | 'subsup' | 'underline' | 'code' | 'textColor' | 'confluenceInlineComment' | 'breakout' | 'alignment' | 'indentation' | 'annotation' | 'unsupportedMark' | 'unsupportedNodeAttribute' | 'typeAheadQuery' | 'dataConsumer' | 'fragment';
+type DefaultSchemaMarks = 'link' | 'em' | 'strong' | 'strike' | 'subsup' | 'underline' | 'code' | 'textColor' | 'confluenceInlineComment' | 'breakout' | 'alignment' | 'indentation' | 'annotation' | 'border' | 'unsupportedMark' | 'unsupportedNodeAttribute' | 'typeAheadQuery' | 'dataConsumer' | 'fragment';
 export declare const defaultSchemaConfig: SchemaConfig<DefaultSchemaNodes, DefaultSchemaMarks>;
 export declare const getSchemaBasedOnStage: import("memoize-one").MemoizedFn<(this: any, stage?: any) => import("prosemirror-model").Schema<DefaultSchemaNodes, DefaultSchemaMarks>>;
 export declare const defaultSchema: import("prosemirror-model").Schema<DefaultSchemaNodes, DefaultSchemaMarks>;

package/dist/types-ts4.5/schema/marks/border.d.ts

@@ -12,7 +12,6 @@ export type BorderMarkAttributes = {
 };
 /**
  * @name border_mark
- * @stage 0
  * @description This mark adds decoration to an element, and any element decorated with it will also have a border style.
  */
 export interface BorderMarkDefinition {

package/json-schema/v1/full.json

@@ -458,6 +458,40 @@
       ],
       "additionalProperties": false
     },
+    "border_mark": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": [
+            "border"
+          ]
+        },
+        "attrs": {
+          "type": "object",
+          "properties": {
+            "size": {
+              "type": "number",
+              "minimum": 1,
+              "maximum": 3
+            },
+            "color": {
+              "type": "string",
+              "pattern": "^#[0-9a-fA-F]{8}$|^#[0-9a-fA-F]{6}$"
+            }
+          },
+          "required": [
+            "size",
+            "color"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "type",
+        "attrs"
+      ],
+      "additionalProperties": false
+    },
     "hardBreak_node": {
       "type": "object",
       "properties": {
@@ -887,7 +921,14 @@
         "marks": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/link_mark"
+            "anyOf": [
+              {
+                "$ref": "#/definitions/link_mark"
+              },
+              {
+                "$ref": "#/definitions/border_mark"
+              }
+            ]
           }
         }
       },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "26.0.1",
+  "version": "26.1.0",
   "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.8.0",
+    "@atlaskit/editor-test-helpers": "^18.9.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@types/linkify-it": "^2.0.4",
     "prosemirror-history": "^1.1.3",