@atlaskit/adf-schema 20.1.3 → 22.0.1

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

@@ -611,26 +611,14 @@
             "marks": {
               "type": "array",
               "items": {
-                "$ref": "#/definitions/dataConsumer_mark"
-              }
-            }
-          },
-          "additionalProperties": true
-        }
-      ]
-    },
-    "inlineExtension_with_experimental_marks_node": {
-      "allOf": [
-        {
-          "$ref": "#/definitions/inlineExtension_node"
-        },
-        {
-          "type": "object",
-          "properties": {
-            "marks": {
-              "type": "array",
-              "items": {
-                "$ref": "#/definitions/fragment_mark"
+                "anyOf": [
+                  {
+                    "$ref": "#/definitions/dataConsumer_mark"
+                  },
+                  {
+                    "$ref": "#/definitions/fragment_mark"
+                  }
+                ]
               }
             }
           },
@@ -1048,9 +1036,6 @@
         {
           "$ref": "#/definitions/inlineExtension_with_marks_node"
         },
-        {
-          "$ref": "#/definitions/inlineExtension_with_experimental_marks_node"
-        },
         {
           "$ref": "#/definitions/date_node"
         },
@@ -1534,6 +1519,12 @@
             "panelIcon": {
               "type": "string"
             },
+            "panelIconId": {
+              "type": "string"
+            },
+            "panelIconText": {
+              "type": "string"
+            },
             "panelColor": {
               "type": "string"
             }
@@ -1853,26 +1844,14 @@
             "marks": {
               "type": "array",
               "items": {
-                "$ref": "#/definitions/dataConsumer_mark"
-              }
-            }
-          },
-          "additionalProperties": true
-        }
-      ]
-    },
-    "extension_with_experimental_marks_node": {
-      "allOf": [
-        {
-          "$ref": "#/definitions/extension_node"
-        },
-        {
-          "type": "object",
-          "properties": {
-            "marks": {
-              "type": "array",
-              "items": {
-                "$ref": "#/definitions/fragment_mark"
+                "anyOf": [
+                  {
+                    "$ref": "#/definitions/dataConsumer_mark"
+                  },
+                  {
+                    "$ref": "#/definitions/fragment_mark"
+                  }
+                ]
               }
             }
           },
@@ -2032,6 +2011,12 @@
             "$ref": "#/definitions/table_row_node"
           },
           "minItems": 1
+        },
+        "marks": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/fragment_mark"
+          }
         }
       },
       "required": [
@@ -2126,9 +2111,6 @@
           {
             "$ref": "#/definitions/extension_with_marks_node"
           },
-          {
-            "$ref": "#/definitions/extension_with_experimental_marks_node"
-          },
           {
             "$ref": "#/definitions/embedCard_node"
           },
@@ -2264,9 +2246,6 @@
         {
           "$ref": "#/definitions/extension_with_marks_node"
         },
-        {
-          "$ref": "#/definitions/extension_with_experimental_marks_node"
-        },
         {
           "$ref": "#/definitions/embedCard_node"
         },
@@ -2416,26 +2395,14 @@
             "marks": {
               "type": "array",
               "items": {
-                "$ref": "#/definitions/dataConsumer_mark"
-              }
-            }
-          },
-          "additionalProperties": true
-        }
-      ]
-    },
-    "bodiedExtension_with_experimental_marks_node": {
-      "allOf": [
-        {
-          "$ref": "#/definitions/bodiedExtension_node"
-        },
-        {
-          "type": "object",
-          "properties": {
-            "marks": {
-              "type": "array",
-              "items": {
-                "$ref": "#/definitions/fragment_mark"
+                "anyOf": [
+                  {
+                    "$ref": "#/definitions/dataConsumer_mark"
+                  },
+                  {
+                    "$ref": "#/definitions/fragment_mark"
+                  }
+                ]
               }
             }
           },
@@ -2499,9 +2466,6 @@
         {
           "$ref": "#/definitions/extension_with_marks_node"
         },
-        {
-          "$ref": "#/definitions/extension_with_experimental_marks_node"
-        },
         {
           "$ref": "#/definitions/embedCard_node"
         },
@@ -2513,9 +2477,6 @@
         },
         {
           "$ref": "#/definitions/bodiedExtension_with_marks_node"
-        },
-        {
-          "$ref": "#/definitions/bodiedExtension_with_experimental_marks_node"
         }
       ]
     },
@@ -2732,9 +2693,6 @@
               {
                 "$ref": "#/definitions/extension_with_marks_node"
               },
-              {
-                "$ref": "#/definitions/extension_with_experimental_marks_node"
-              },
               {
                 "$ref": "#/definitions/embedCard_node"
               },
@@ -2750,9 +2708,6 @@
               {
                 "$ref": "#/definitions/bodiedExtension_with_marks_node"
               },
-              {
-                "$ref": "#/definitions/bodiedExtension_with_experimental_marks_node"
-              },
               {
                 "$ref": "#/definitions/layoutSection_full_node"
               },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "20.1.3",
+  "version": "22.0.1",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -16,10 +16,16 @@
   "atlaskit:src": "src/index.ts",
   "atlassian": {
     "team": "Editor",
-    "deprecatedAutoEntryPoints": true,
     "inPublicMirror": true,
     "releaseModel": "scheduled"
   },
+  "af:exports": {
+    ".": "./src/index.ts",
+    "./steps": "./src/steps.ts",
+    "./schema": "./src/schema/index.ts",
+    "./json-schema": "./src/json-schema/index.ts",
+    "./url": "./src/utils/url.ts"
+  },
   "scripts": {
     "build:json-schema": "mkdir -p dist && cp -r json-schema dist",
     "generate:json-schema": "mkdir -p json-schema/v1/ && yarn generate:json-schema:full && yarn generate:json-schema:stage-0",
@@ -40,8 +46,9 @@
     "prosemirror-transform": "1.3.2"
   },
   "devDependencies": {
+    "@atlaskit/adf-utils": "^16.0.0",
     "@atlaskit/editor-json-transformer": "^8.7.0",
-    "@atlaskit/editor-test-helpers": "^16.0.0",
+    "@atlaskit/editor-test-helpers": "^16.1.0",
     "@atlaskit/json-schema-generator": "^3.2.0",
     "@atlassian/adf-sample": "^1.0.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",

package/schema/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@atlaskit/adf-schema/schema",
+  "main": "../dist/cjs/schema/index.js",
+  "module": "../dist/esm/schema/index.js",
+  "module:es2019": "../dist/es2019/schema/index.js",
+  "types": "../dist/types/schema/index.d.ts"
+}

package/url/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@atlaskit/adf-schema/url",
+  "main": "../dist/cjs/utils/url.js",
+  "module": "../dist/esm/utils/url.js",
+  "module:es2019": "../dist/es2019/utils/url.js",
+  "types": "../dist/types/utils/url.d.ts"
+}

package/test-helpers/html-helpers.ts

@@ -1,40 +0,0 @@
-import {
-  DOMParser,
-  DOMSerializer,
-  Fragment,
-  Schema,
-  Node as PMNode,
-  ParseOptions,
-} from 'prosemirror-model';
-import { DocBuilder } from '@atlaskit/editor-test-helpers/doc-builder';
-import { TextSelection } from 'prosemirror-state';
-
-export const fromHTML = (
-  html: string,
-  schema: Schema,
-  options?: ParseOptions,
-): PMNode => {
-  const el = document.createElement('div');
-  el.innerHTML = html;
-
-  return DOMParser.fromSchema(schema).parse(el, options);
-};
-
-export const toDOM = (node: PMNode, schema: Schema): Node => {
-  const serializer = DOMSerializer.fromSchema(schema);
-  return serializer.serializeFragment(Fragment.from(node));
-};
-
-export const toContext = (node: DocBuilder, schema: Schema) => {
-  const document = node(schema);
-  const selection = TextSelection.near(
-    document.resolve(document.refs['<>'] || 0),
-  );
-  return selection.$from;
-};
-
-export const toHTML = (node: PMNode, schema: Schema): string => {
-  const el = document.createElement('div');
-  el.appendChild(toDOM(node, schema));
-  return el.innerHTML;
-};

package/test-helpers/matches.ts

@@ -1,8 +0,0 @@
-export default (text: string, regexp: RegExp) => {
-  const results: RegExpExecArray[] = [];
-  let match: RegExpExecArray | null;
-  while ((match = regexp.exec(text))) {
-    results.push(match);
-  }
-  return results;
-};

package/test-helpers/schema-builder.ts

@@ -1,329 +0,0 @@
-import {
-  Fragment,
-  MarkType,
-  Node,
-  NodeType,
-  Schema,
-  Slice /*MediaAttributes */,
-} from 'prosemirror-model';
-import { MediaAttributes } from '../src/schema/nodes/media';
-import { MediaInlineAttributes } from '../src/schema/nodes/media-inline';
-import matches from './matches';
-import sampleSchema from './schema';
-import {
-  TableAttributes,
-  CellAttributes,
-} from '../src/schema/nodes/tableNodes';
-
-/**
- * Represents a ProseMirror "position" in a document.
- */
-export type position = number;
-
-/**
- * A useful feature of the builder is being able to declaratively mark positions
- * in content using the curly braces e.g. `{<>}`.
- *
- * These positions are called "refs" (inspired by React), and are tracked on
- * every node in the tree that has a ref on any of its descendants.
- */
-export type Refs = { [name: string]: position };
-
-/**
- * Content that contains refs information.
- */
-export type RefsContentItem = RefsNode | RefsTracker;
-
-/**
- * Content node or mark builders can consume, e.g.
- *
- *     const builder = nodeFactory('p');
- *     builder('string');
- *     builder(aNode);
- *     builder(aRefsNode);
- *     builder(aRefsTracker);
- *     builder([aNode, aRefsNode, aRefsTracker]);
- */
-export type BuilderContent =
-  | string
-  | Node
-  | RefsContentItem
-  | (Node | RefsContentItem)[];
-
-/**
- * ProseMirror doesn't support empty text nodes, which can be quite
- * inconvenient when you want to capture a position ref without introducing
- * text.
- *
- * Take a couple of examples:
- *
- *     p('{<>}')
- *     p('Hello ', '{<>}', 'world!')
- *
- * After the ref syntax is stripped you're left with:
- *
- *     p('')
- *     p('Hello ', '', 'world!')
- *
- * This violates the rule of text nodes being non-empty. This class solves the
- * problem by providing an alternative data structure that *only* stores refs,
- * and can be used in scenarios where an empty text would be forbidden.
- *
- * This is done under the hood when using `text()` factory, and instead of
- * always returning a text node, it'll instead return one of two things:
- *
- * - a text node -- when given a non-empty string
- * - a refs tracker -- when given a string that *only* contains refs.
- */
-export class RefsTracker {
-  refs?: Refs;
-}
-
-/**
- * A standard ProseMirror Node that also tracks refs.
- */
-export interface RefsNode extends Node {
-  refs: Refs;
-}
-
-/**
- * Create a text node.
- *
- * Special markers called "refs" can be put in the text. Refs provide a way to
- * declaratively describe a position within some text, and then access the
- * position in the resulting node.
- */
-export function text(value: string, schema: Schema): RefsContentItem {
-  let stripped = '';
-  let textIndex = 0;
-  const refs: Refs = {};
-
-  // Helpers
-  const isEven = (n: number) => n % 2 === 0;
-
-  for (const match of matches(value, /([\\]+)?{(\w+|<|>|<>)}/g)) {
-    const [refToken, skipChars, refName] = match;
-    let { index } = match;
-
-    const skipLen = skipChars && skipChars.length;
-    if (skipLen) {
-      if (isEven(skipLen)) {
-        index += skipLen / 2;
-      } else {
-        stripped += value.slice(textIndex, index + (skipLen - 1) / 2);
-        stripped += value.slice(index + skipLen, index + refToken.length);
-        textIndex = index + refToken.length;
-        continue;
-      }
-    }
-
-    stripped += value.slice(textIndex, index);
-    refs[refName] = stripped.length;
-    textIndex = match.index + refToken.length;
-  }
-
-  stripped += value.slice(textIndex);
-
-  const node =
-    stripped === '' ? new RefsTracker() : (schema.text(stripped) as RefsNode);
-
-  node.refs = refs;
-  return node;
-}
-
-/**
- * Offset ref position values by some amount.
- */
-export function offsetRefs(refs: Refs, offset: number): Refs {
-  const result = {} as Refs;
-  for (const name in refs) {
-    result[name] = refs[name] + offset;
-  }
-  return result;
-}
-
-/**
- * Given a collection of nodes, sequence them in an array and return the result
- * along with the updated refs.
- */
-export function sequence(...content: RefsContentItem[]) {
-  let position = 0;
-  let refs = {} as Refs;
-  const nodes = [] as RefsNode[];
-
-  // It's bizarre that this is necessary. An if/else in the for...of should have
-  // sufficient but it did not work at the time of writing.
-  const isRefsTracker = (n: any): n is RefsTracker => n instanceof RefsTracker;
-  const isRefsNode = (n: any): n is RefsNode => !isRefsTracker(n);
-
-  for (const node of content) {
-    if (isRefsTracker(node)) {
-      refs = { ...refs, ...offsetRefs(node.refs!, position) };
-    }
-    if (isRefsNode(node)) {
-      const thickness = node.isText ? 0 : 1;
-      refs = { ...refs, ...offsetRefs(node.refs, position + thickness) };
-      position += node.nodeSize;
-      nodes.push(node as RefsNode);
-    }
-  }
-  return { nodes, refs };
-}
-
-/**
- * Given a jagged array, flatten it down to a single level.
- */
-export function flatten<T>(deep: (T | T[])[]): T[] {
-  const flat = [] as T[];
-  for (const item of deep) {
-    if (Array.isArray(item)) {
-      flat.splice(flat.length, 0, ...item);
-    } else {
-      flat.push(item);
-    }
-  }
-  return flat;
-}
-
-/**
- * Coerce builder content into ref nodes.
- */
-export function coerce(content: BuilderContent[], schema: Schema) {
-  const refsContent = content.map((item) =>
-    typeof item === 'string' ? text(item, schema) : item,
-  ) as (RefsContentItem | RefsContentItem[])[];
-  return sequence(...flatten<RefsContentItem>(refsContent));
-}
-
-/**
- * Create a factory for nodes.
- */
-export function nodeFactory(type: NodeType, attrs = {}) {
-  return function (...content: BuilderContent[]): RefsNode {
-    const { nodes, refs } = coerce(content, type.schema);
-    const node = type.create(attrs, nodes) as RefsNode;
-    node.refs = refs;
-    return node;
-  };
-}
-
-/**
- * Create a factory for marks.
- */
-export function markFactory(type: MarkType, attrs = {}) {
-  const mark = type.create(attrs);
-  return (...content: BuilderContent[]): RefsNode[] => {
-    const { nodes } = coerce(content, type.schema);
-    return nodes.map((node) => {
-      if (mark.type.isInSet(node.marks)) {
-        return node;
-      } else {
-        const refNode = node.mark(mark.addToSet(node.marks)) as RefsNode;
-        refNode.refs = node.refs;
-        return refNode;
-      }
-    });
-  };
-}
-
-export const createCell = (colspan: number, rowspan: number) =>
-  td({ colspan, rowspan })(p('x'));
-export const createHeaderCell = (colspan: number, rowspan: number) =>
-  th({ colspan, rowspan })(p('x'));
-
-export const doc = nodeFactory(sampleSchema.nodes.doc, {});
-export const p = nodeFactory(sampleSchema.nodes.paragraph, {});
-export const blockquote = nodeFactory(sampleSchema.nodes.blockquote, {});
-export const h1 = nodeFactory(sampleSchema.nodes.heading, { level: 1 });
-export const h2 = nodeFactory(sampleSchema.nodes.heading, { level: 2 });
-export const h3 = nodeFactory(sampleSchema.nodes.heading, { level: 3 });
-export const h4 = nodeFactory(sampleSchema.nodes.heading, { level: 4 });
-export const h5 = nodeFactory(sampleSchema.nodes.heading, { level: 5 });
-export const h6 = nodeFactory(sampleSchema.nodes.heading, { level: 6 });
-export const li = nodeFactory(sampleSchema.nodes.listItem, {});
-export const ul = nodeFactory(sampleSchema.nodes.bulletList, {});
-export const ol = nodeFactory(sampleSchema.nodes.orderedList, {});
-export const br = sampleSchema.nodes.hardBreak.createChecked();
-export const extension = nodeFactory(sampleSchema.nodes.extension, {});
-export const panel = nodeFactory(sampleSchema.nodes.panel, {});
-export const panelNote = nodeFactory(sampleSchema.nodes.panel, {
-  panelType: 'note',
-});
-export const plain = nodeFactory(sampleSchema.nodes.plain, {});
-export const hardBreak = nodeFactory(sampleSchema.nodes.hardBreak, {});
-
-export const code_block = (attrs: {} = {}) =>
-  nodeFactory(sampleSchema.nodes.codeBlock, attrs);
-export const img = (attrs: { src: string; alt?: string; title?: string }) =>
-  sampleSchema.nodes.image.createChecked(attrs);
-export const emoji = (attrs: {
-  shortName: string;
-  id?: string;
-  fallback?: string;
-}) => {
-  const emojiNodeAttrs = {
-    shortName: attrs.shortName,
-    id: attrs.id,
-    text: attrs.fallback || attrs.shortName,
-  };
-  return sampleSchema.nodes.emoji.createChecked(emojiNodeAttrs);
-};
-export const mention = (attrs: { id: string; text?: string }) =>
-  sampleSchema.nodes.mention.createChecked(attrs);
-export const hr = sampleSchema.nodes.rule.createChecked();
-export const em = markFactory(sampleSchema.marks.em, {});
-export const subsup = (attrs: { type: string }) =>
-  markFactory(sampleSchema.marks.subsup, attrs);
-export const underline = markFactory(sampleSchema.marks.underline, {});
-export const strong = markFactory(sampleSchema.marks.strong, {});
-export const code = markFactory(sampleSchema.marks.code, {});
-export const strike = markFactory(sampleSchema.marks.strike, {});
-export const mentionQuery = (attrs = { active: true }) =>
-  markFactory(sampleSchema.marks.mentionQuery, attrs ? attrs : {});
-export const a = (attrs: { href: string; title?: string }) =>
-  markFactory(sampleSchema.marks.link, attrs);
-export const fragment = (...content: BuilderContent[]) =>
-  flatten<BuilderContent>(content);
-export const slice = (...content: BuilderContent[]) =>
-  new Slice(Fragment.from(coerce(content, sampleSchema).nodes), 0, 0);
-export const mediaSingle = (attrs = {}) =>
-  nodeFactory(sampleSchema.nodes.mediaSingle, attrs);
-export const mediaGroup = nodeFactory(sampleSchema.nodes.mediaGroup);
-export const mediaInline = (attrs: MediaInlineAttributes) =>
-  sampleSchema.nodes.media.create(attrs);
-export const media = (attrs: MediaAttributes) =>
-  sampleSchema.nodes.media.create(attrs);
-export const textColor = (attrs: { color: string }) =>
-  markFactory(sampleSchema.marks.textColor, attrs);
-export const table = (attrs?: TableAttributes) =>
-  nodeFactory(sampleSchema.nodes.table, attrs);
-export const tr = nodeFactory(sampleSchema.nodes.tableRow, {});
-export const td = (attrs: CellAttributes) =>
-  nodeFactory(sampleSchema.nodes.tableCell, attrs);
-export const th = (attrs: CellAttributes) =>
-  nodeFactory(sampleSchema.nodes.tableHeader, attrs);
-export const tdEmpty = td({})(p(''));
-export const thEmpty = th({})(p(''));
-export const tdCursor = td({})(p('{<>}'));
-export const thCursor = th({})(p('{<>}'));
-export const td11 = createCell(1, 1);
-export const th11 = createHeaderCell(1, 1);
-export const decisionList = nodeFactory(sampleSchema.nodes.decisionList, {});
-export const decisionItem = nodeFactory(sampleSchema.nodes.decisionItem, {});
-export const taskList = nodeFactory(sampleSchema.nodes.taskList, {});
-export const taskItem = nodeFactory(sampleSchema.nodes.taskItem, {});
-export const confluenceUnsupportedBlock = (cxhtml: string) =>
-  nodeFactory(sampleSchema.nodes.confluenceUnsupportedBlock, { cxhtml })();
-export const confluenceUnsupportedInline = (cxhtml: string) =>
-  nodeFactory(sampleSchema.nodes.confluenceUnsupportedInline, { cxhtml })();
-export const confluenceJiraIssue = (attrs: {
-  issueKey?: string;
-  macroId?: string;
-  schemaVersion?: string;
-  server?: string;
-  serverId?: string;
-}) => sampleSchema.nodes.confluenceJiraIssue.create(attrs);
-export const unsupportedBlock = (originalValue: object) =>
-  nodeFactory(sampleSchema.nodes.unsupportedBlock, { originalValue })();
-export const unsupportedInline = (originalValue: object) =>
-  nodeFactory(sampleSchema.nodes.unsupportedInline, { originalValue })();