Expose createSyncManager and constants under private API

Author: chriszarate

package-lock.json

@@ -10,7 +10,6 @@ import { v4 as uuid } from 'uuid';
 import apiFetch from '@wordpress/api-fetch';
 import { addQueryArgs } from '@wordpress/url';
 import deprecated from '@wordpress/deprecated';
-import { LOCAL_EDITOR_ORIGIN, syncManager } from '@wordpress/sync';
 
 /**
  * Internal dependencies
@@ -20,6 +19,7 @@ import { receiveItems, removeItems, receiveQueriedItems } from './queried-data';
 import { DEFAULT_ENTITY_KEY } from './entities';
 import { createBatch } from './batch';
 import { STORE_NAME } from './name';
+import { LOCAL_EDITOR_ORIGIN, syncManager } from './sync';
 import logEntityDeprecation from './utils/log-entity-deprecation';
 
 /**

packages/core-data/src/actions.js

@@ -9,13 +9,13 @@ import { camelCase } from 'change-case';
 import { addQueryArgs } from '@wordpress/url';
 import { decodeEntities } from '@wordpress/html-entities';
 import apiFetch from '@wordpress/api-fetch';
-import { syncManager } from '@wordpress/sync';
 
 /**
  * Internal dependencies
  */
 import { STORE_NAME } from './name';
 import { additionalEntityConfigLoaders, DEFAULT_ENTITY_KEY } from './entities';
+import { syncManager } from './sync';
 import {
 	forwardResolver,
 	getNormalizedCommaSeparable,

packages/core-data/src/resolvers.js

@@ -2,10 +2,14 @@
  * WordPress dependencies
  */
 import triggerFetch from '@wordpress/api-fetch';
-import { syncManager } from '@wordpress/sync';
+
+/**
+ * Internal dependencies
+ */
+import { syncManager } from '../sync';
 
 jest.mock( '@wordpress/api-fetch' );
-jest.mock( '@wordpress/sync', () => ( {
+jest.mock( '../sync', () => ( {
 	syncManager: {
 		load: jest.fn(),
 	},

packages/core-data/src/test/resolvers.js

@@ -1,11 +1,12 @@
 /**
  * WordPress dependencies
  */
-import {
-	type CRDTDoc,
-	CRDT_RECORD_MAP_KEY,
-	type ObjectData,
-} from '@wordpress/sync';
+import { type CRDTDoc, type ObjectData } from '@wordpress/sync';
+
+/**
+ * Internal dependencies
+ */
+import { CRDT_RECORD_MAP_KEY } from '../sync';
 
 export function defaultApplyChangesToCRDTDoc(
 	crdtDoc: CRDTDoc,

packages/core-data/src/utils/crdt.ts

@@ -29,6 +29,7 @@ const CORE_MODULES_USING_PRIVATE_APIS = [
 	'@wordpress/preferences',
 	'@wordpress/reusable-blocks',
 	'@wordpress/router',
+	'@wordpress/sync',
 	'@wordpress/dataviews',
 	'@wordpress/fields',
 	'@wordpress/media-utils',

packages/private-apis/src/implementation.ts

@@ -14,21 +14,9 @@ npm install @wordpress/sync --save
 
 <!-- START TOKEN(Autogenerated API docs) -->
 
-### CRDT_RECORD_MAP_KEY
+### privateApis
 
-Root-level key for the CRDT document that holds the entity record data.
-
-### LOCAL_EDITOR_ORIGIN
-
-Origin string for CRDT document changes originating from the local editor.
-
-### syncManager
-
-The sync manager orchestrates the lifecycle of syncing entity records. It creates Yjs documents, connects to providers, creates awareness instances, and coordinates with the `core-data` store.
-
-_Type_
-
--   `SyncManager`
+Private @wordpress/sync APIs
 
 ### Y
 

packages/sync/README.md

@@ -39,6 +39,7 @@
 	"dependencies": {
 		"@types/simple-peer": "^9.11.5",
 		"@wordpress/hooks": "file:../hooks",
+		"@wordpress/private-apis": "file:../private-apis",
 		"@wordpress/url": "file:../url",
 		"import-locals": "^2.0.0",
 		"lib0": "^0.2.42",

packages/sync/package.json

@@ -11,6 +11,5 @@
  */
 export * as Y from 'yjs';
 
-export { CRDT_RECORD_MAP_KEY, LOCAL_EDITOR_ORIGIN } from './config';
-export { syncManager } from './manager';
+export * from './private-apis';
 export type * from './types';

packages/sync/src/index.ts

@@ -0,0 +1,10 @@
+/**
+ * WordPress dependencies
+ */
+import { __dangerousOptInToUnstableAPIsOnlyForCoreModules } from '@wordpress/private-apis';
+
+export const { lock, unlock } =
+	__dangerousOptInToUnstableAPIsOnlyForCoreModules(
+		'I acknowledge private features are not for use in themes or plugins and doing so will break in the next version of WordPress.',
+		'@wordpress/sync'
+	);