@atlaskit/adf-utils 19.0.21 → 19.0.22

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/adf-utils
 
+## 19.0.22
+
+### Patch Changes
+
+- [#79538](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/79538) [`d4d91668d3ac`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/d4d91668d3ac) - ED-22501 Update validator specs for inline-card based on feature flag
+
 ## 19.0.21
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -20,6 +20,9 @@
     "references": [
         {
             "path": "../../../monorepo-tooling/codemod-utils/afm-cc/tsconfig.json"
+        },
+        {
+            "path": "../../../platform/feature-flags/afm-cc/tsconfig.json"
         }
     ]
 }

package/dist/cjs/validator/custom-specs/inline-card-with-annotation.js

@@ -0,0 +1,35 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.inlineCardWithAnnotation = void 0;
+// This is a custom spec we're using for inline card till the inline comments feature is fully rolled out.
+var inlineCardWithAnnotation = exports.inlineCardWithAnnotation = {
+  props: {
+    type: {
+      type: 'enum',
+      values: ['inlineCard']
+    },
+    attrs: [{
+      props: {
+        url: {
+          type: 'string',
+          validatorFn: 'safeUrl'
+        }
+      }
+    }, {
+      props: {
+        data: {
+          type: 'object'
+        }
+      }
+    }],
+    marks: {
+      type: 'array',
+      items: ['annotation'],
+      optional: true
+    }
+  },
+  required: ['attrs']
+};

package/dist/cjs/validator/specs/inlineCard.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+// PLEASE DO NOT ADD marks IN THIS FILE
 var _default = exports.default = {
   props: {
     type: {

package/dist/cjs/validator/validator.js

@@ -10,14 +10,17 @@ exports.validator = validator;
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var specs = _interopRequireWildcard(require("./specs"));
+var _inlineCardWithAnnotation = require("./custom-specs/inline-card-with-annotation");
 var _utils = require("./utils");
 var _rules = require("./rules");
 var _excluded = ["items"];
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var INLINE_NODES_SUPPORTING_COMMENTS = ['inlineCard'];
 function mapMarksItems(spec) {
   var fn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : function (x) {
     return x;
@@ -54,8 +57,12 @@ var partitionObject = function partitionObject(obj, predicate) {
  * We denormalised the spec to save bundle size.
  */
 function createSpec(nodes, marks) {
+  var allowCommentsOnInlineNodes = !!(0, _platformFeatureFlags.getBooleanFF)('platform.editor.allow-inline-comments-for-inline-nodes');
   return Object.keys(specs).reduce(function (newSpecs, k) {
     var spec = _objectSpread({}, specs[k]);
+    if (INLINE_NODES_SUPPORTING_COMMENTS.includes(k) && allowCommentsOnInlineNodes) {
+      spec.props = _inlineCardWithAnnotation.inlineCardWithAnnotation.props;
+    }
     if (spec.props) {
       spec.props = _objectSpread({}, spec.props);
       if (spec.props.content) {

package/dist/es2019/validator/custom-specs/inline-card-with-annotation.js

@@ -0,0 +1,29 @@
+// This is a custom spec we're using for inline card till the inline comments feature is fully rolled out.
+export const inlineCardWithAnnotation = {
+  props: {
+    type: {
+      type: 'enum',
+      values: ['inlineCard']
+    },
+    attrs: [{
+      props: {
+        url: {
+          type: 'string',
+          validatorFn: 'safeUrl'
+        }
+      }
+    }, {
+      props: {
+        data: {
+          type: 'object'
+        }
+      }
+    }],
+    marks: {
+      type: 'array',
+      items: ['annotation'],
+      optional: true
+    }
+  },
+  required: ['attrs']
+};

package/dist/es2019/validator/specs/inlineCard.js

@@ -1,3 +1,4 @@
+// PLEASE DO NOT ADD marks IN THIS FILE
 export default {
   props: {
     type: {

package/dist/es2019/validator/validator.js

@@ -1,6 +1,9 @@
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 import * as specs from './specs';
+import { inlineCardWithAnnotation } from './custom-specs/inline-card-with-annotation';
 import { copy, isBoolean, isDefined, isInteger, isNumber, isPlainObject, isString, makeArray } from './utils';
 import { validatorFnMap } from './rules';
+const INLINE_NODES_SUPPORTING_COMMENTS = ['inlineCard'];
 function mapMarksItems(spec, fn = x => x) {
   if (spec.props && spec.props.marks) {
     const {
@@ -36,10 +39,14 @@ const partitionObject = (obj, predicate) => Object.keys(obj).reduce((acc, key) =
  * We denormalised the spec to save bundle size.
  */
 function createSpec(nodes, marks) {
+  const allowCommentsOnInlineNodes = !!getBooleanFF('platform.editor.allow-inline-comments-for-inline-nodes');
   return Object.keys(specs).reduce((newSpecs, k) => {
     const spec = {
       ...specs[k]
     };
+    if (INLINE_NODES_SUPPORTING_COMMENTS.includes(k) && allowCommentsOnInlineNodes) {
+      spec.props = inlineCardWithAnnotation.props;
+    }
     if (spec.props) {
       spec.props = {
         ...spec.props

package/dist/esm/validator/custom-specs/inline-card-with-annotation.js

@@ -0,0 +1,29 @@
+// This is a custom spec we're using for inline card till the inline comments feature is fully rolled out.
+export var inlineCardWithAnnotation = {
+  props: {
+    type: {
+      type: 'enum',
+      values: ['inlineCard']
+    },
+    attrs: [{
+      props: {
+        url: {
+          type: 'string',
+          validatorFn: 'safeUrl'
+        }
+      }
+    }, {
+      props: {
+        data: {
+          type: 'object'
+        }
+      }
+    }],
+    marks: {
+      type: 'array',
+      items: ['annotation'],
+      optional: true
+    }
+  },
+  required: ['attrs']
+};

package/dist/esm/validator/specs/inlineCard.js

@@ -1,3 +1,4 @@
+// PLEASE DO NOT ADD marks IN THIS FILE
 export default {
   props: {
     type: {

package/dist/esm/validator/validator.js

@@ -4,9 +4,12 @@ import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProper
 var _excluded = ["items"];
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 import * as specs from './specs';
+import { inlineCardWithAnnotation } from './custom-specs/inline-card-with-annotation';
 import { copy, isBoolean, isDefined, isInteger, isNumber, isPlainObject, isString, makeArray } from './utils';
 import { validatorFnMap } from './rules';
+var INLINE_NODES_SUPPORTING_COMMENTS = ['inlineCard'];
 function mapMarksItems(spec) {
   var fn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : function (x) {
     return x;
@@ -43,8 +46,12 @@ var partitionObject = function partitionObject(obj, predicate) {
  * We denormalised the spec to save bundle size.
  */
 function createSpec(nodes, marks) {
+  var allowCommentsOnInlineNodes = !!getBooleanFF('platform.editor.allow-inline-comments-for-inline-nodes');
   return Object.keys(specs).reduce(function (newSpecs, k) {
     var spec = _objectSpread({}, specs[k]);
+    if (INLINE_NODES_SUPPORTING_COMMENTS.includes(k) && allowCommentsOnInlineNodes) {
+      spec.props = inlineCardWithAnnotation.props;
+    }
     if (spec.props) {
       spec.props = _objectSpread({}, spec.props);
       if (spec.props.content) {

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

@@ -1,4 +1,4 @@
-import { ADFEntity, ADFEntityMark } from '../types';
+import type { ADFEntity, ADFEntityMark } from '../types';
 export interface MarkValidationResult {
     valid: boolean;
     originalMark: ADFEntityMark;

package/dist/types/validator/custom-specs/inline-card-with-annotation.d.ts

@@ -0,0 +1,30 @@
+export declare const inlineCardWithAnnotation: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        attrs: ({
+            props: {
+                url: {
+                    type: string;
+                    validatorFn: string;
+                };
+                data?: undefined;
+            };
+        } | {
+            props: {
+                data: {
+                    type: string;
+                };
+                url?: undefined;
+            };
+        })[];
+        marks: {
+            type: string;
+            items: string[];
+            optional: boolean;
+        };
+    };
+    required: string[];
+};

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

@@ -1,3 +1,3 @@
-import { AttributesSpec, ValidationOptions, Validate } from '../types/validatorTypes';
+import type { AttributesSpec, ValidationOptions, Validate } from '../types/validatorTypes';
 export declare function validateAttrs<T>(spec: AttributesSpec, value: T): boolean;
 export declare function validator(nodes?: Array<string>, marks?: Array<string>, options?: ValidationOptions): Validate;

package/dist/types-ts4.5/types/validatorTypes.d.ts

@@ -1,4 +1,4 @@
-import { ADFEntity, ADFEntityMark } from '../types';
+import type { ADFEntity, ADFEntityMark } from '../types';
 export interface MarkValidationResult {
     valid: boolean;
     originalMark: ADFEntityMark;

package/dist/types-ts4.5/validator/custom-specs/inline-card-with-annotation.d.ts

@@ -0,0 +1,30 @@
+export declare const inlineCardWithAnnotation: {
+    props: {
+        type: {
+            type: string;
+            values: string[];
+        };
+        attrs: ({
+            props: {
+                url: {
+                    type: string;
+                    validatorFn: string;
+                };
+                data?: undefined;
+            };
+        } | {
+            props: {
+                data: {
+                    type: string;
+                };
+                url?: undefined;
+            };
+        })[];
+        marks: {
+            type: string;
+            items: string[];
+            optional: boolean;
+        };
+    };
+    required: string[];
+};

package/dist/types-ts4.5/validator/validator.d.ts

@@ -1,3 +1,3 @@
-import { AttributesSpec, ValidationOptions, Validate } from '../types/validatorTypes';
+import type { AttributesSpec, ValidationOptions, Validate } from '../types/validatorTypes';
 export declare function validateAttrs<T>(spec: AttributesSpec, value: T): boolean;
 export declare function validator(nodes?: Array<string>, marks?: Array<string>, options?: ValidationOptions): Validate;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-utils",
-  "version": "19.0.21",
+  "version": "19.0.22",
   "description": "Set of utilities to traverse, modify and create ADF documents.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -43,11 +43,13 @@
   "dependencies": {
     "@atlaskit/adf-schema": "^35.5.2",
     "@atlaskit/codemod-utils": "^4.2.0",
+    "@atlaskit/platform-feature-flags": "^0.2.0",
     "@babel/runtime": "^7.0.0"
   },
   "devDependencies": {
     "@atlassian/adf-schema-json": "^1.0.7",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
+    "@atlassian/feature-flags-test-utils": "*",
     "jscodeshift": "^0.13.0",
     "react": "^16.8.0",
     "typescript": "~4.9.5",
@@ -66,5 +68,10 @@
       ]
     }
   },
-  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1",
+  "platform-feature-flags": {
+    "platform.editor.allow-inline-comments-for-inline-nodes": {
+      "type": "boolean"
+    }
+  }
 }