@atlaskit/adf-utils 14.1.1 → 14.4.1

package/dist/esm/validator/validator.js

@@ -1,13 +1,15 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["items"];
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+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; }
 
 import * as specs from './specs';
 import { copy, isBoolean, isDefined, isInteger, isNumber, isPlainObject, isString, makeArray } from './utils';
+import { validatorFnMap } from './rules';
 
 function mapMarksItems(spec) {
   var fn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : function (x) {
@@ -17,7 +19,7 @@ function mapMarksItems(spec) {
   if (spec.props && spec.props.marks) {
     var _ref = spec.props.marks,
         items = _ref.items,
-        rest = _objectWithoutProperties(_ref, ["items"]);
+        rest = _objectWithoutProperties(_ref, _excluded);
 
     return _objectSpread(_objectSpread({}, spec), {}, {
       props: _objectSpread(_objectSpread({}, spec.props), {}, {
@@ -81,9 +83,9 @@ function createSpec(nodes, marks) {
           spec.props.content = _objectSpread({}, spec.props.content);
         }
 
-        spec.props.content.items = spec.props.content.items. // ['inline'] => [['emoji', 'hr', ...]]
+        spec.props.content.items = spec.props.content.items // ['inline'] => [['emoji', 'hr', ...]]
         // ['media'] => [['media']]
-        map(function (item) {
+        .map(function (item) {
           return isString(item) ? Array.isArray(specs[item]) ? specs[item] : [item] : item;
         }) // [['emoji', 'hr', 'inline_code']] => [['emoji', 'hr', ['text', { marks: {} }]]]
         .map(function (item) {
@@ -178,7 +180,11 @@ export function validateAttrs(spec, value) {
       return isInteger(value) && (isDefined(spec.minimum) ? spec.minimum <= value : true) && (isDefined(spec.maximum) ? spec.maximum >= value : true);
 
     case 'string':
-      return isString(value) && (isDefined(spec.minLength) ? spec.minLength <= value.length : true) && (spec.pattern ? new RegExp(spec.pattern).test(value) : true);
+      var validatorFnPassed = function validatorFnPassed(rule) {
+        return typeof value === 'string' && isDefined(validatorFnMap[rule]) && validatorFnMap[rule](value);
+      };
+
+      return isString(value) && (isDefined(spec.minLength) ? spec.minLength <= value.length : true) && (isDefined(spec.validatorFn) ? validatorFnPassed(spec.validatorFn) : true) && (spec.pattern ? new RegExp(spec.pattern).test(value) : true);
 
     case 'object':
       return isPlainObject(value);
@@ -385,19 +391,19 @@ export function validator(nodes, marks, options) {
         } // this checks for mark level attribute errors
         // and propagates error code and message
         else if (finalResult.marksValidationOutput && finalResult.marksValidationOutput.length) {
-            return {
-              valid: false,
-              originalMark: mark,
-              errorCode: finalResult.marksValidationOutput[0].errorCode,
-              message: finalResult.marksValidationOutput[0].message
-            };
-          } else {
-            return {
-              valid: false,
-              originalMark: mark,
-              errorCode: 'INVALID_TYPE'
-            };
-          }
+          return {
+            valid: false,
+            originalMark: mark,
+            errorCode: finalResult.marksValidationOutput[0].errorCode,
+            message: finalResult.marksValidationOutput[0].message
+          };
+        } else {
+          return {
+            valid: false,
+            originalMark: mark,
+            errorCode: 'INVALID_TYPE'
+          };
+        }
       } else {
         return {
           valid: false,

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/adf-utils",
-	"version": "14.1.1",
+	"version": "14.4.1",
 	"sideEffects": false
 }

package/dist/types/builders/marks/breakout.d.ts

@@ -1,3 +1,3 @@
 import { BreakoutMarkAttrs, BreakoutMarkDefinition, CodeBlockDefinition, LayoutSectionDefinition } from '@atlaskit/adf-schema';
 import { WithAppliedMark } from '../types';
-export declare const breakout: (attrs: BreakoutMarkAttrs) => (maybeNode: CodeBlockDefinition | LayoutSectionDefinition) => WithAppliedMark<CodeBlockDefinition | LayoutSectionDefinition, BreakoutMarkDefinition>;
+export declare const breakout: (attrs: BreakoutMarkAttrs) => (maybeNode: CodeBlockDefinition | LayoutSectionDefinition) => WithAppliedMark<CodeBlockDefinition | import("@atlaskit/adf-schema").LayoutSectionFullDefinition | import("@atlaskit/adf-schema").LayoutSectionWithSingleColumnDefinition, BreakoutMarkDefinition>;

package/dist/types/builders/marks/fragment.d.ts

@@ -0,0 +1,3 @@
+import { ExtensionDefinition, BodiedExtensionDefinition, InlineExtensionDefinition, TableDefinition, FragmentAttributes, FragmentDefinition } from '@atlaskit/adf-schema';
+import { WithAppliedMark } from '../types';
+export declare const fragment: (attrs: FragmentAttributes) => (maybeNode: TableDefinition | ExtensionDefinition | BodiedExtensionDefinition | InlineExtensionDefinition) => WithAppliedMark<ExtensionDefinition | BodiedExtensionDefinition | InlineExtensionDefinition | TableDefinition, FragmentDefinition>;

package/dist/types/builders/nodes/media-inline.d.ts

@@ -0,0 +1,2 @@
+import { MediaInlineDefinition, MediaInlineAttributes } from '@atlaskit/adf-schema';
+export declare const mediaInline: (attrs: MediaInlineAttributes) => MediaInlineDefinition;

package/dist/types/builders.d.ts

@@ -13,6 +13,7 @@ export { underline as u } from './builders/marks/underline';
 export { alignment } from './builders/marks/alignment';
 export { indentation } from './builders/marks/indentation';
 export { dataConsumer } from './builders/marks/data-consumer';
+export { fragment } from './builders/marks/fragment';
 export { blockQuote } from './builders/nodes/blockquote';
 export { bodiedExtension } from './builders/nodes/bodied-extension';
 export { blockCard } from './builders/nodes/block-card';

package/dist/types/index.d.ts

@@ -5,3 +5,4 @@ export { validateAttrs, validator } from './validator';
 export type { Content, ErrorCallback, Output, ValidationError, ValidationErrorMap, ValidationErrorType, ValidationMode, ValidationOptions, ErrorCallbackOptions, Validate, } from './types/validatorTypes';
 export type { ADFEntity, ADFEntityMark, Visitor, VisitorCollection, } from './types';
 export { getEmptyADF } from './empty-adf';
+export { transformTextLinkCodeMarks } from './transforms/text-link-code-transform';

package/dist/types/transforms/text-link-code-transform.d.ts

@@ -0,0 +1,5 @@
+import { ADFEntity } from '../types';
+export declare const transformTextLinkCodeMarks: (adf: ADFEntity) => {
+    transformedAdf: false | ADFEntity;
+    isTransformed: boolean;
+};

package/dist/types/types/validatorTypes.d.ts

@@ -43,6 +43,7 @@ export declare type AttributesSpec = {
     optional?: boolean;
     minLength?: number;
     pattern?: RegExp;
+    validatorFn?: string;
 } | {
     type: 'enum';
     values: Array<string>;

package/dist/types/validator/rules.d.ts

@@ -0,0 +1,3 @@
+export declare const validatorFnMap: {
+    [key: string]: (value: string) => boolean;
+};

package/dist/types/validator/specs/blockCard.d.ts

@@ -8,6 +8,7 @@ declare const _default: {
             props: {
                 url: {
                     type: string;
+                    validatorFn: string;
                 };
                 data?: undefined;
             };

package/dist/types/validator/specs/{bodiedExtension_with_no_marks.d.ts → bodiedExtension_with_experimental_marks.d.ts}

@@ -2,8 +2,7 @@ declare const _default: (string | {
     props: {
         marks: {
             type: string;
-            items: never[];
-            maxItems: number;
+            items: string[];
             optional: boolean;
         };
     };

package/dist/types/validator/specs/embedCard.d.ts

@@ -16,6 +16,7 @@ declare const _default: {
                 };
                 url: {
                     type: string;
+                    validatorFn: string;
                 };
                 width: {
                     type: string;

package/dist/types/validator/specs/{extension_with_no_marks.d.ts → extension_with_experimental_marks.d.ts}

@@ -2,8 +2,7 @@ declare const _default: (string | {
     props: {
         marks: {
             type: string;
-            items: never[];
-            maxItems: number;
+            items: string[];
             optional: boolean;
         };
     };

package/dist/types/validator/specs/fragment.d.ts

@@ -0,0 +1,21 @@
+declare const _default: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        attrs: {
+            props: {
+                localId: {
+                    type: string;
+                    minLength: number;
+                };
+                name: {
+                    type: string;
+                    optional: boolean;
+                };
+            };
+        };
+    };
+};
+export default _default;

package/dist/types/validator/specs/index.d.ts

@@ -12,18 +12,21 @@ export { default as alignment } from './alignment';
 export { default as indentation } from './indentation';
 export { default as annotation } from './annotation';
 export { default as dataConsumer } from './dataConsumer';
+export { default as fragment } from './fragment';
 export { default as hardBreak } from './hardBreak';
 export { default as mention } from './mention';
 export { default as emoji } from './emoji';
 export { default as inlineExtension } from './inlineExtension';
-export { default as inlineExtension_with_no_marks } from './inlineExtension_with_no_marks';
 export { default as inlineExtension_with_marks } from './inlineExtension_with_marks';
+export { default as inlineExtension_with_experimental_marks } from './inlineExtension_with_experimental_marks';
 export { default as date } from './date';
 export { default as placeholder } from './placeholder';
 export { default as blockCard } from './blockCard';
 export { default as inlineCard } from './inlineCard';
 export { default as status } from './status';
 export { default as text } from './text';
+export { default as media } from './media';
+export { default as mediaInline } from './mediaInline';
 export { default as formatted_text_inline } from './formatted_text_inline';
 export { default as link_text_inline } from './link_text_inline';
 export { default as code_inline } from './code_inline';
@@ -34,7 +37,6 @@ export { default as paragraph_with_no_marks } from './paragraph_with_no_marks';
 export { default as paragraph_with_alignment } from './paragraph_with_alignment';
 export { default as paragraph_with_indentation } from './paragraph_with_indentation';
 export { default as bulletList } from './bulletList';
-export { default as media } from './media';
 export { default as caption } from './caption';
 export { default as mediaSingle } from './mediaSingle';
 export { default as mediaSingle_full } from './mediaSingle_full';
@@ -57,8 +59,8 @@ export { default as decisionList } from './decisionList';
 export { default as taskItem } from './taskItem';
 export { default as taskList } from './taskList';
 export { default as extension } from './extension';
-export { default as extension_with_no_marks } from './extension_with_no_marks';
 export { default as extension_with_marks } from './extension_with_marks';
+export { default as extension_with_experimental_marks } from './extension_with_experimental_marks';
 export { default as embedCard } from './embedCard';
 export { default as nestedExpand_content } from './nestedExpand_content';
 export { default as nestedExpand } from './nestedExpand';
@@ -73,9 +75,11 @@ export { default as expand } from './expand';
 export { default as expand_with_no_mark } from './expand_with_no_mark';
 export { default as expand_with_breakout_mark } from './expand_with_breakout_mark';
 export { default as bodiedExtension } from './bodiedExtension';
-export { default as bodiedExtension_with_no_marks } from './bodiedExtension_with_no_marks';
 export { default as bodiedExtension_with_marks } from './bodiedExtension_with_marks';
+export { default as bodiedExtension_with_experimental_marks } from './bodiedExtension_with_experimental_marks';
 export { default as block_content } from './block_content';
 export { default as layoutColumn } from './layoutColumn';
 export { default as layoutSection } from './layoutSection';
+export { default as layoutSection_full } from './layoutSection_full';
+export { default as layoutSection_with_single_column } from './layoutSection_with_single_column';
 export { default as doc } from './doc';

package/dist/types/validator/specs/inlineCard.d.ts

@@ -8,6 +8,7 @@ declare const _default: {
             props: {
                 url: {
                     type: string;
+                    validatorFn: string;
                 };
                 data?: undefined;
             };

package/dist/types/validator/specs/{inlineExtension_with_no_marks.d.ts → inlineExtension_with_experimental_marks.d.ts}

@@ -2,8 +2,7 @@ declare const _default: (string | {
     props: {
         marks: {
             type: string;
-            items: never[];
-            maxItems: number;
+            items: string[];
             optional: boolean;
         };
     };

package/dist/types/validator/specs/layoutSection.d.ts

@@ -4,17 +4,14 @@ declare const _default: {
             type: string;
             values: string[];
         };
-        content: {
+        marks: {
             type: string;
             items: string[];
-            minItems: number;
-            maxItems: number;
-            allowUnsupportedBlock: boolean;
+            optional: boolean;
         };
-        marks: {
+        content: {
             type: string;
             items: string[];
-            optional: boolean;
         };
     };
 };

package/dist/types/validator/specs/layoutSection_full.d.ts

@@ -0,0 +1,21 @@
+declare const _default: (string | {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        marks: {
+            type: string;
+            items: string[];
+            optional: boolean;
+        };
+        content: {
+            type: string;
+            items: string[];
+            minItems: number;
+            maxItems: number;
+            allowUnsupportedBlock: boolean;
+        };
+    };
+})[];
+export default _default;

package/dist/types/validator/specs/layoutSection_with_single_column.d.ts

@@ -0,0 +1,21 @@
+declare const _default: (string | {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        marks: {
+            type: string;
+            items: string[];
+            optional: boolean;
+        };
+        content: {
+            type: string;
+            items: string[];
+            minItems: number;
+            maxItems: number;
+            allowUnsupportedBlock: boolean;
+        };
+    };
+})[];
+export default _default;

package/dist/types/validator/specs/link.d.ts

@@ -8,6 +8,7 @@ declare const _default: {
             props: {
                 href: {
                     type: string;
+                    validatorFn: string;
                 };
                 title: {
                     type: string;

package/dist/types/validator/specs/mediaInline.d.ts

@@ -0,0 +1,46 @@
+declare const _default: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        attrs: {
+            props: {
+                data: {
+                    type: string;
+                    optional: boolean;
+                };
+                id: {
+                    type: string;
+                    minLength: number;
+                };
+                collection: {
+                    type: string;
+                };
+                height: {
+                    type: string;
+                    optional: boolean;
+                };
+                width: {
+                    type: string;
+                    optional: boolean;
+                };
+                occurrenceKey: {
+                    type: string;
+                    minLength: number;
+                    optional: boolean;
+                };
+                alt: {
+                    type: string;
+                    optional: boolean;
+                };
+            };
+        };
+        marks: {
+            type: string;
+            items: string[];
+            optional: boolean;
+        };
+    };
+};
+export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-utils",
-  "version": "14.1.1",
+  "version": "14.4.1",
   "description": "Set of utilities to traverse, modify and create ADF documents.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -24,12 +24,12 @@
     "generate:spec": "rm -rf ./src/validator/specs/ && ../json-schema-generator/bin.js --outDir=./src/validator/specs/ --mode=Spec --stage=0 ./src/validator/entry.ts"
   },
   "dependencies": {
-    "@atlaskit/adf-schema": "^19.0.0",
+    "@atlaskit/adf-schema": "^20.1.0",
     "@babel/runtime": "^7.0.0"
   },
   "devDependencies": {
     "@atlaskit/docs": "*",
-    "@atlaskit/json-schema-generator": "^3.1.0",
+    "@atlaskit/json-schema-generator": "^3.2.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "react": "^16.8.0",
     "typescript": "3.9.6",
@@ -40,6 +40,9 @@
       "circular-dependencies": [
         "file-level"
       ]
+    },
+    "@repo/internal": {
+      "deprecation": "no-deprecated-imports"
     }
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"