@atlaskit/editor-ui-control-model 0.0.1 → 1.0.0

package/CHANGELOG.md

@@ -1 +1,9 @@
 # @atlaskit/editor-ui-control-model
+
+## 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.

package/dist/cjs/createRegistry.js

@@ -0,0 +1,48 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createRegistry = void 0;
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+/**
+ * Create a registry for UI control components (toolbar buttons, menu items, etc.).
+ *
+ * Follows the same pattern as `createBlockMenuRegistry` from `editor-plugin-block-menu`
+ * but uses generic types to support any surface (toolbars, menus, etc.).
+ *
+ * Each component should have a unique `type` + `key` combination. The parent-child
+ * model relies on key-based lookup, so duplicate keys lead to undefined behaviour.
+ *
+ * @returns A registry object with a `register` method and a `components` array.
+ *
+ * @example
+ * ```ts
+ * const registry = createRegistry();
+ *
+ * registry.register([
+ *   {
+ *     type: 'toolbar',
+ *     key: 'primary-toolbar',
+ *     component: ({ children }) => <div>{children}</div>,
+ *   },
+ *   {
+ *     type: 'section',
+ *     key: 'section-1',
+ *     parents: [{ type: 'toolbar', key: 'primary-toolbar', rank: 1 }],
+ *     component: ({ children }) => <div>{children}</div>,
+ *   },
+ * ]);
+ * ```
+ */
+var createRegistry = exports.createRegistry = function createRegistry() {
+  var components = [];
+  var register = function register(newComponents) {
+    components.push.apply(components, (0, _toConsumableArray2.default)(newComponents));
+  };
+  return {
+    register: register,
+    components: components
+  };
+};

package/dist/cjs/index.js

@@ -3,6 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
-var HelloWorld = 'hello world';
-var _default = exports.default = HelloWorld;
+Object.defineProperty(exports, "createRegistry", {
+  enumerable: true,
+  get: function get() {
+    return _createRegistry.createRegistry;
+  }
+});
+var _createRegistry = require("./createRegistry");

package/dist/cjs/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/es2019/createRegistry.js

@@ -0,0 +1,40 @@
+/**
+ * Create a registry for UI control components (toolbar buttons, menu items, etc.).
+ *
+ * Follows the same pattern as `createBlockMenuRegistry` from `editor-plugin-block-menu`
+ * but uses generic types to support any surface (toolbars, menus, etc.).
+ *
+ * Each component should have a unique `type` + `key` combination. The parent-child
+ * model relies on key-based lookup, so duplicate keys lead to undefined behaviour.
+ *
+ * @returns A registry object with a `register` method and a `components` array.
+ *
+ * @example
+ * ```ts
+ * const registry = createRegistry();
+ *
+ * registry.register([
+ *   {
+ *     type: 'toolbar',
+ *     key: 'primary-toolbar',
+ *     component: ({ children }) => <div>{children}</div>,
+ *   },
+ *   {
+ *     type: 'section',
+ *     key: 'section-1',
+ *     parents: [{ type: 'toolbar', key: 'primary-toolbar', rank: 1 }],
+ *     component: ({ children }) => <div>{children}</div>,
+ *   },
+ * ]);
+ * ```
+ */
+export const createRegistry = () => {
+  const components = [];
+  const register = newComponents => {
+    components.push(...newComponents);
+  };
+  return {
+    register,
+    components
+  };
+};

package/dist/es2019/index.js

@@ -1,2 +1,4 @@
-const HelloWorld = 'hello world';
-export default HelloWorld;
+/* eslint-disable @atlaskit/editor/no-re-export */
+// Entry file in package.json
+
+export { createRegistry } from './createRegistry';

package/dist/es2019/types.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/createRegistry.js

@@ -0,0 +1,41 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+/**
+ * Create a registry for UI control components (toolbar buttons, menu items, etc.).
+ *
+ * Follows the same pattern as `createBlockMenuRegistry` from `editor-plugin-block-menu`
+ * but uses generic types to support any surface (toolbars, menus, etc.).
+ *
+ * Each component should have a unique `type` + `key` combination. The parent-child
+ * model relies on key-based lookup, so duplicate keys lead to undefined behaviour.
+ *
+ * @returns A registry object with a `register` method and a `components` array.
+ *
+ * @example
+ * ```ts
+ * const registry = createRegistry();
+ *
+ * registry.register([
+ *   {
+ *     type: 'toolbar',
+ *     key: 'primary-toolbar',
+ *     component: ({ children }) => <div>{children}</div>,
+ *   },
+ *   {
+ *     type: 'section',
+ *     key: 'section-1',
+ *     parents: [{ type: 'toolbar', key: 'primary-toolbar', rank: 1 }],
+ *     component: ({ children }) => <div>{children}</div>,
+ *   },
+ * ]);
+ * ```
+ */
+export var createRegistry = function createRegistry() {
+  var components = [];
+  var register = function register(newComponents) {
+    components.push.apply(components, _toConsumableArray(newComponents));
+  };
+  return {
+    register: register,
+    components: components
+  };
+};

package/dist/esm/index.js

@@ -1,2 +1,4 @@
-var HelloWorld = 'hello world';
-export default HelloWorld;
+/* eslint-disable @atlaskit/editor/no-re-export */
+// Entry file in package.json
+
+export { createRegistry } from './createRegistry';

package/dist/esm/types.js

@@ -0,0 +1 @@
+export {};

package/dist/types/createRegistry.d.ts

@@ -0,0 +1,35 @@
+import type { RegisterComponent } from './types';
+/**
+ * Create a registry for UI control components (toolbar buttons, menu items, etc.).
+ *
+ * Follows the same pattern as `createBlockMenuRegistry` from `editor-plugin-block-menu`
+ * but uses generic types to support any surface (toolbars, menus, etc.).
+ *
+ * Each component should have a unique `type` + `key` combination. The parent-child
+ * model relies on key-based lookup, so duplicate keys lead to undefined behaviour.
+ *
+ * @returns A registry object with a `register` method and a `components` array.
+ *
+ * @example
+ * ```ts
+ * const registry = createRegistry();
+ *
+ * registry.register([
+ *   {
+ *     type: 'toolbar',
+ *     key: 'primary-toolbar',
+ *     component: ({ children }) => <div>{children}</div>,
+ *   },
+ *   {
+ *     type: 'section',
+ *     key: 'section-1',
+ *     parents: [{ type: 'toolbar', key: 'primary-toolbar', rank: 1 }],
+ *     component: ({ children }) => <div>{children}</div>,
+ *   },
+ * ]);
+ * ```
+ */
+export declare const createRegistry: () => {
+    register: (newComponents: RegisterComponent[]) => void;
+    components: RegisterComponent[];
+};

package/dist/types/index.d.ts

@@ -1,2 +1,2 @@
-declare const HelloWorld = "hello world";
-export default HelloWorld;
+export { createRegistry } from './createRegistry';
+export type { RegisterComponent, RegisterComponentParent } from './types';

package/dist/types/types.d.ts

@@ -0,0 +1,13 @@
+import type React from 'react';
+export type RegisterComponentParent = {
+    key: string;
+    rank: number;
+    type: string;
+};
+export type RegisterComponent = {
+    component?: (props: Record<string, unknown>) => React.ReactNode;
+    isHidden?: () => boolean;
+    key: string;
+    parents?: RegisterComponentParent[];
+    type: string;
+};

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

@@ -0,0 +1,35 @@
+import type { RegisterComponent } from './types';
+/**
+ * Create a registry for UI control components (toolbar buttons, menu items, etc.).
+ *
+ * Follows the same pattern as `createBlockMenuRegistry` from `editor-plugin-block-menu`
+ * but uses generic types to support any surface (toolbars, menus, etc.).
+ *
+ * Each component should have a unique `type` + `key` combination. The parent-child
+ * model relies on key-based lookup, so duplicate keys lead to undefined behaviour.
+ *
+ * @returns A registry object with a `register` method and a `components` array.
+ *
+ * @example
+ * ```ts
+ * const registry = createRegistry();
+ *
+ * registry.register([
+ *   {
+ *     type: 'toolbar',
+ *     key: 'primary-toolbar',
+ *     component: ({ children }) => <div>{children}</div>,
+ *   },
+ *   {
+ *     type: 'section',
+ *     key: 'section-1',
+ *     parents: [{ type: 'toolbar', key: 'primary-toolbar', rank: 1 }],
+ *     component: ({ children }) => <div>{children}</div>,
+ *   },
+ * ]);
+ * ```
+ */
+export declare const createRegistry: () => {
+    register: (newComponents: RegisterComponent[]) => void;
+    components: RegisterComponent[];
+};

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

@@ -1,2 +1,2 @@
-declare const HelloWorld = "hello world";
-export default HelloWorld;
+export { createRegistry } from './createRegistry';
+export type { RegisterComponent, RegisterComponentParent } from './types';

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

@@ -0,0 +1,13 @@
+import type React from 'react';
+export type RegisterComponentParent = {
+    key: string;
+    rank: number;
+    type: string;
+};
+export type RegisterComponent = {
+    component?: (props: Record<string, unknown>) => React.ReactNode;
+    isHidden?: () => boolean;
+    key: string;
+    parents?: RegisterComponentParent[];
+    type: string;
+};

package/package.json

@@ -23,6 +23,9 @@
 	"dependencies": {
 		"@babel/runtime": "^7.0.0"
 	},
+	"peerDependencies": {
+		"react": "^18.2.0"
+	},
 	"techstack": {
 		"@atlassian/frontend": {
 			"import-structure": [
@@ -59,7 +62,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-ui-control-model",
-	"version": "0.0.1",
+	"version": "1.0.0",
 	"description": "Rendering logic and model-types for Editor controls registry ( editor-plugin-ui-control-registry)",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",