@atlaskit/editor-plugin-ui-control-registry 0.0.0 → 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,25 @@
+# @atlaskit/editor-plugin-ui-control-registry
+
+## 1.1.0
+
+### Minor Changes
+
+- [`031e535207444`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/031e535207444) -
+  Implements the surface renderer for the new Editor UI controls registry, providing a unified
+  component for rendering editor menu trees.
+
+### Patch Changes
+
+- Updated dependencies
+
+## 1.0.0
+
+### Major Changes
+
+- [`35fd4b17a4355`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/35fd4b17a4355) -
+  EDITOR-5598 Create initial implementation of Editor UI Control Registry, implementing its API for
+  adding elements to the registry and retrieving menu elements for a surface.
+
+### Patch Changes
+
+- Updated dependencies

package/afm-cc/tsconfig.json

@@ -19,6 +19,9 @@
 		"../src/**/examples.*"
 	],
 	"references": [
+		{
+			"path": "../../editor-ui-control-model/afm-cc/tsconfig.json"
+		},
 		{
 			"path": "../../editor-common/afm-cc/tsconfig.json"
 		}

package/afm-jira/tsconfig.json

@@ -19,6 +19,9 @@
 		"../src/**/examples.*"
 	],
 	"references": [
+		{
+			"path": "../../editor-ui-control-model/afm-jira/tsconfig.json"
+		},
 		{
 			"path": "../../editor-common/afm-jira/tsconfig.json"
 		}

package/afm-products/tsconfig.json

@@ -19,6 +19,9 @@
 		"../src/**/examples.*"
 	],
 	"references": [
+		{
+			"path": "../../editor-ui-control-model/afm-products/tsconfig.json"
+		},
 		{
 			"path": "../../editor-common/afm-products/tsconfig.json"
 		}

package/dist/cjs/uiControlRegistryPlugin.js

@@ -4,8 +4,64 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.uiControlRegistryPlugin = void 0;
+var _editorUiControlModel = require("@atlaskit/editor-ui-control-model");
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+/**
+ * Collect all components that belong to the tree rooted at `surfaceKey`.
+ *
+ * A surface is a root component (one with no `parents`). Starting from that
+ * root, every component whose parent chain leads back to it is included.
+ */
+function getComponentsForSurface(allComponents, surfaceKey) {
+  var root = allComponents.find(function (c) {
+    return c.key === surfaceKey && (!c.parents || c.parents.length === 0);
+  });
+  if (!root) {
+    return [];
+  }
+  var includedKeys = new Set([surfaceKey]);
+  var changed = true;
+  while (changed) {
+    changed = false;
+    var _iterator = _createForOfIteratorHelper(allComponents),
+      _step;
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        var _component$parents;
+        var component = _step.value;
+        if (includedKeys.has(component.key)) {
+          continue;
+        }
+        if ((_component$parents = component.parents) !== null && _component$parents !== void 0 && _component$parents.some(function (p) {
+          return includedKeys.has(p.key);
+        })) {
+          includedKeys.add(component.key);
+          changed = true;
+        }
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+  }
+  return allComponents.filter(function (c) {
+    return includedKeys.has(c.key);
+  });
+}
 var uiControlRegistryPlugin = exports.uiControlRegistryPlugin = function uiControlRegistryPlugin() {
+  var registry = (0, _editorUiControlModel.createRegistry)();
   return {
-    name: 'uiControlRegistry'
+    name: 'uiControlRegistry',
+    actions: {
+      register: function register(components) {
+        registry.register(components);
+      },
+      getComponents: function getComponents(surface) {
+        return getComponentsForSurface(registry.components, surface);
+      }
+    }
   };
 };

package/dist/es2019/uiControlRegistryPlugin.js

@@ -1,3 +1,43 @@
-export const uiControlRegistryPlugin = () => ({
-  name: 'uiControlRegistry'
-});
+import { createRegistry } from '@atlaskit/editor-ui-control-model';
+/**
+ * Collect all components that belong to the tree rooted at `surfaceKey`.
+ *
+ * A surface is a root component (one with no `parents`). Starting from that
+ * root, every component whose parent chain leads back to it is included.
+ */
+function getComponentsForSurface(allComponents, surfaceKey) {
+  const root = allComponents.find(c => c.key === surfaceKey && (!c.parents || c.parents.length === 0));
+  if (!root) {
+    return [];
+  }
+  const includedKeys = new Set([surfaceKey]);
+  let changed = true;
+  while (changed) {
+    changed = false;
+    for (const component of allComponents) {
+      var _component$parents;
+      if (includedKeys.has(component.key)) {
+        continue;
+      }
+      if ((_component$parents = component.parents) !== null && _component$parents !== void 0 && _component$parents.some(p => includedKeys.has(p.key))) {
+        includedKeys.add(component.key);
+        changed = true;
+      }
+    }
+  }
+  return allComponents.filter(c => includedKeys.has(c.key));
+}
+export const uiControlRegistryPlugin = () => {
+  const registry = createRegistry();
+  return {
+    name: 'uiControlRegistry',
+    actions: {
+      register: components => {
+        registry.register(components);
+      },
+      getComponents: surface => {
+        return getComponentsForSurface(registry.components, surface);
+      }
+    }
+  };
+};

package/dist/esm/uiControlRegistryPlugin.js

@@ -1,5 +1,61 @@
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+import { createRegistry } from '@atlaskit/editor-ui-control-model';
+/**
+ * Collect all components that belong to the tree rooted at `surfaceKey`.
+ *
+ * A surface is a root component (one with no `parents`). Starting from that
+ * root, every component whose parent chain leads back to it is included.
+ */
+function getComponentsForSurface(allComponents, surfaceKey) {
+  var root = allComponents.find(function (c) {
+    return c.key === surfaceKey && (!c.parents || c.parents.length === 0);
+  });
+  if (!root) {
+    return [];
+  }
+  var includedKeys = new Set([surfaceKey]);
+  var changed = true;
+  while (changed) {
+    changed = false;
+    var _iterator = _createForOfIteratorHelper(allComponents),
+      _step;
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        var _component$parents;
+        var component = _step.value;
+        if (includedKeys.has(component.key)) {
+          continue;
+        }
+        if ((_component$parents = component.parents) !== null && _component$parents !== void 0 && _component$parents.some(function (p) {
+          return includedKeys.has(p.key);
+        })) {
+          includedKeys.add(component.key);
+          changed = true;
+        }
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+  }
+  return allComponents.filter(function (c) {
+    return includedKeys.has(c.key);
+  });
+}
 export var uiControlRegistryPlugin = function uiControlRegistryPlugin() {
+  var registry = createRegistry();
   return {
-    name: 'uiControlRegistry'
+    name: 'uiControlRegistry',
+    actions: {
+      register: function register(components) {
+        registry.register(components);
+      },
+      getComponents: function getComponents(surface) {
+        return getComponentsForSurface(registry.components, surface);
+      }
+    }
   };
 };

package/dist/types/uiControlRegistryPluginType.d.ts

@@ -1,2 +1,8 @@
 import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
-export type UiControlRegistryPlugin = NextEditorPlugin<'uiControlRegistry'>;
+import type { RegisterComponent } from '@atlaskit/editor-ui-control-model';
+export type UiControlRegistryPlugin = NextEditorPlugin<'uiControlRegistry', {
+    actions: {
+        getComponents: (surface: string) => RegisterComponent[];
+        register: (components: RegisterComponent[]) => void;
+    };
+}>;

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

@@ -1,2 +1,8 @@
 import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
-export type UiControlRegistryPlugin = NextEditorPlugin<'uiControlRegistry'>;
+import type { RegisterComponent } from '@atlaskit/editor-ui-control-model';
+export type UiControlRegistryPlugin = NextEditorPlugin<'uiControlRegistry', {
+    actions: {
+        getComponents: (surface: string) => RegisterComponent[];
+        register: (components: RegisterComponent[]) => void;
+    };
+}>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-ui-control-registry",
-	"version": "0.0.0",
+	"version": "1.1.0",
 	"description": "UiControlRegistry plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -28,10 +28,11 @@
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
+		"@atlaskit/editor-ui-control-model": "^1.1.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^111.18.0",
+		"@atlaskit/editor-common": "^111.21.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {