@atlaskit/editor-common 109.7.1 → 109.8.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/editor-common
 
+## 109.8.0
+
+### Minor Changes
+
+- [`2ce1b7efe1d2e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/2ce1b7efe1d2e) -
+  EDITOR-1640 Create Sync-Block data manager scaffolding
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 109.7.1
 
 ### Patch Changes

package/dist/cjs/monitoring/error.js

@@ -16,7 +16,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "109.7.0";
+var packageVersion = "109.7.1";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/cjs/sync-block/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "SyncBlockStoreManager", {
+  enumerable: true,
+  get: function get() {
+    return _syncBlockStoreManager.SyncBlockStoreManager;
+  }
+});
+var _syncBlockStoreManager = require("./sync-block-store-manager");

package/dist/cjs/sync-block/sync-block-store-manager.js

@@ -0,0 +1,37 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SyncBlockStoreManager = void 0;
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+// Do this typedef to make it clear that
+// this is a local identifier for a resource for local use
+// Represents a SOURCE sync block within the editor.
+// A store manager responsible for the lifecycle and state management of sync blocks in an editor instance.
+// Supports create, read, update, and delete operations for sync blocks.
+// Designed to manage local in-memory state and synchronize with an external data provider.
+// Handles caching, debouncing updates, and publish/subscribe for local changes.
+// Ensures consistency between local and remote state, and can be used in both editor and renderer contexts.
+var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/function () {
+  function SyncBlockStoreManager(dataProvider) {
+    (0, _classCallCheck2.default)(this, SyncBlockStoreManager);
+    this.syncBlocks = new Map();
+    this.dataProvider = dataProvider;
+  }
+  return (0, _createClass2.default)(SyncBlockStoreManager, [{
+    key: "isSourceBlock",
+    value: function isSourceBlock(node) {
+      var _this$syncBlocks$get;
+      if (!this.dataProvider || node.type.name !== 'syncBlock') {
+        return false;
+      }
+      var _node$attrs = node.attrs,
+        resourceId = _node$attrs.resourceId,
+        localId = _node$attrs.localId;
+      return this.syncBlocks.has(resourceId) && ((_this$syncBlocks$get = this.syncBlocks.get(resourceId)) === null || _this$syncBlocks$get === void 0 ? void 0 : _this$syncBlocks$get.sourceLocalId) === localId;
+    }
+  }]);
+}();

package/dist/cjs/sync-block/types.js

@@ -0,0 +1 @@
+"use strict";

package/dist/cjs/ui/DropList/index.js

@@ -24,7 +24,7 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
  * @jsx jsx
  */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "109.7.0";
+var packageVersion = "109.7.1";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = (0, _react2.keyframes)({

package/dist/es2019/monitoring/error.js

@@ -1,7 +1,7 @@
 import { isFedRamp } from './environment';
 const SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 const packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-const packageVersion = "109.7.0";
+const packageVersion = "109.7.1";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/es2019/sync-block/index.js

@@ -0,0 +1,3 @@
+// Disable no-re-export rule for entry point files
+/* eslint-disable @atlaskit/editor/no-re-export */
+export { SyncBlockStoreManager } from './sync-block-store-manager';

package/dist/es2019/sync-block/sync-block-store-manager.js

@@ -0,0 +1,27 @@
+// Do this typedef to make it clear that
+// this is a local identifier for a resource for local use
+
+// Represents a SOURCE sync block within the editor.
+
+// A store manager responsible for the lifecycle and state management of sync blocks in an editor instance.
+// Supports create, read, update, and delete operations for sync blocks.
+// Designed to manage local in-memory state and synchronize with an external data provider.
+// Handles caching, debouncing updates, and publish/subscribe for local changes.
+// Ensures consistency between local and remote state, and can be used in both editor and renderer contexts.
+export class SyncBlockStoreManager {
+  constructor(dataProvider) {
+    this.syncBlocks = new Map();
+    this.dataProvider = dataProvider;
+  }
+  isSourceBlock(node) {
+    var _this$syncBlocks$get;
+    if (!this.dataProvider || node.type.name !== 'syncBlock') {
+      return false;
+    }
+    const {
+      resourceId,
+      localId
+    } = node.attrs;
+    return this.syncBlocks.has(resourceId) && ((_this$syncBlocks$get = this.syncBlocks.get(resourceId)) === null || _this$syncBlocks$get === void 0 ? void 0 : _this$syncBlocks$get.sourceLocalId) === localId;
+  }
+}

package/dist/es2019/ui/DropList/index.js

@@ -14,7 +14,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "109.7.0";
+const packageVersion = "109.7.1";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 const fadeIn = keyframes({

package/dist/esm/monitoring/error.js

@@ -7,7 +7,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { isFedRamp } from './environment';
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "109.7.0";
+var packageVersion = "109.7.1";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/esm/sync-block/index.js

@@ -0,0 +1,3 @@
+// Disable no-re-export rule for entry point files
+/* eslint-disable @atlaskit/editor/no-re-export */
+export { SyncBlockStoreManager } from './sync-block-store-manager';

package/dist/esm/sync-block/sync-block-store-manager.js

@@ -0,0 +1,32 @@
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+// Do this typedef to make it clear that
+// this is a local identifier for a resource for local use
+
+// Represents a SOURCE sync block within the editor.
+
+// A store manager responsible for the lifecycle and state management of sync blocks in an editor instance.
+// Supports create, read, update, and delete operations for sync blocks.
+// Designed to manage local in-memory state and synchronize with an external data provider.
+// Handles caching, debouncing updates, and publish/subscribe for local changes.
+// Ensures consistency between local and remote state, and can be used in both editor and renderer contexts.
+export var SyncBlockStoreManager = /*#__PURE__*/function () {
+  function SyncBlockStoreManager(dataProvider) {
+    _classCallCheck(this, SyncBlockStoreManager);
+    this.syncBlocks = new Map();
+    this.dataProvider = dataProvider;
+  }
+  return _createClass(SyncBlockStoreManager, [{
+    key: "isSourceBlock",
+    value: function isSourceBlock(node) {
+      var _this$syncBlocks$get;
+      if (!this.dataProvider || node.type.name !== 'syncBlock') {
+        return false;
+      }
+      var _node$attrs = node.attrs,
+        resourceId = _node$attrs.resourceId,
+        localId = _node$attrs.localId;
+      return this.syncBlocks.has(resourceId) && ((_this$syncBlocks$get = this.syncBlocks.get(resourceId)) === null || _this$syncBlocks$get === void 0 ? void 0 : _this$syncBlocks$get.sourceLocalId) === localId;
+    }
+  }]);
+}();

package/dist/esm/ui/DropList/index.js

@@ -21,7 +21,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "109.7.0";
+var packageVersion = "109.7.1";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = keyframes({

package/dist/types/sync-block/index.d.ts

@@ -0,0 +1,2 @@
+export { SyncBlockStoreManager } from './sync-block-store-manager';
+export type { SyncBlockDataProvider } from './types';

package/dist/types/sync-block/sync-block-store-manager.d.ts

@@ -0,0 +1,18 @@
+import type { ADFEntity } from '@atlaskit/adf-utils/types';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { SyncBlockDataProvider } from './types';
+export interface SyncBlock {
+    /**
+     * The local content of the block,
+     * this might or might not be synced with the server
+     */
+    content?: ADFEntity;
+    resourceId: string;
+    sourceLocalId: string;
+}
+export declare class SyncBlockStoreManager {
+    private syncBlocks;
+    private dataProvider?;
+    constructor(dataProvider?: SyncBlockDataProvider);
+    isSourceBlock(node: PMNode): boolean;
+}

package/dist/types/sync-block/types.d.ts

@@ -0,0 +1,2 @@
+export interface SyncBlockDataProvider {
+}

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

@@ -0,0 +1,2 @@
+export { SyncBlockStoreManager } from './sync-block-store-manager';
+export type { SyncBlockDataProvider } from './types';

package/dist/types-ts4.5/sync-block/sync-block-store-manager.d.ts

@@ -0,0 +1,18 @@
+import type { ADFEntity } from '@atlaskit/adf-utils/types';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { SyncBlockDataProvider } from './types';
+export interface SyncBlock {
+    /**
+     * The local content of the block,
+     * this might or might not be synced with the server
+     */
+    content?: ADFEntity;
+    resourceId: string;
+    sourceLocalId: string;
+}
+export declare class SyncBlockStoreManager {
+    private syncBlocks;
+    private dataProvider?;
+    constructor(dataProvider?: SyncBlockDataProvider);
+    isSourceBlock(node: PMNode): boolean;
+}

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

@@ -0,0 +1,2 @@
+export interface SyncBlockDataProvider {
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "109.7.1",
+	"version": "109.8.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -80,7 +80,7 @@
 		"@atlaskit/task-decision": "^19.2.0",
 		"@atlaskit/textfield": "^8.0.0",
 		"@atlaskit/theme": "^21.0.0",
-		"@atlaskit/tmp-editor-statsig": "^12.22.0",
+		"@atlaskit/tmp-editor-statsig": "^12.23.0",
 		"@atlaskit/tokens": "^6.3.0",
 		"@atlaskit/tooltip": "^20.4.0",
 		"@atlaskit/width-detector": "^5.0.0",

package/sync-block/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@atlaskit/editor-common/sync-block",
+  "main": "../dist/cjs/sync-block/index.js",
+  "module": "../dist/esm/sync-block/index.js",
+  "module:es2019": "../dist/es2019/sync-block/index.js",
+  "sideEffects": [
+    "**/*.compiled.css"
+  ],
+  "types": "../dist/types/sync-block/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.9": {
+      "*": [
+        "../dist/types-ts4.5/sync-block/index.d.ts"
+      ]
+    }
+  }
+}