@atlaskit/editor-plugin-synced-block 0.1.0

package/dist/types-ts4.5/pm-plugins/SyncClient.d.ts

@@ -0,0 +1,14 @@
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+export declare class SyncClient {
+    private requestMap;
+    constructor();
+    private getRequestState;
+    private setRequestState;
+    private sendRequest;
+    syncContent({ sourceDocumentAri, contentAri, contentPropertyKey, node, }: {
+        contentAri: string;
+        contentPropertyKey: string;
+        node: PMNode;
+        sourceDocumentAri: string;
+    }): void;
+}

package/dist/types-ts4.5/pm-plugins/main.d.ts

@@ -0,0 +1,6 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export declare const syncedBlockPluginKey: PluginKey<any>;
+type SyncedBlockPluginState = {};
+export declare const createPlugin: () => SafePlugin<SyncedBlockPluginState>;
+export {};

package/dist/types-ts4.5/pm-plugins/utils.d.ts

@@ -0,0 +1,5 @@
+import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
+export declare const findSyncedBlockParent: ($pos: ResolvedPos) => {
+    node: import("prosemirror-model").Node;
+    attributes: import("../ui/extensions/synced-block/utils/synced-block").SyncedBlockAttributes;
+} | undefined;

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

@@ -0,0 +1,2 @@
+import type { SyncedBlockPlugin } from './syncedBlockPluginType';
+export declare const syncedBlockPlugin: SyncedBlockPlugin;

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

@@ -0,0 +1,2 @@
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+export type SyncedBlockPlugin = NextEditorPlugin<'syncedBlock'>;

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

@@ -0,0 +1,3 @@
+export type SyncedBlockPluginOptions = {
+    clouldId?: string;
+};

package/dist/types-ts4.5/ui/extensions/synced-block/components/GlobalStyles.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @jsxRuntime classic
+ * @jsx jsx
+ */
+import { jsx } from '@emotion/react';
+export declare const GlobalStylesWrapper: () => jsx.JSX.Element;

package/dist/types-ts4.5/ui/extensions/synced-block/components/SyncedBlockLiveView.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+type SyncedBlockLiveView = {
+    contentAri: string;
+    sourceDocumentAri: string;
+};
+declare const SyncedBlockLiveView: ({ sourceDocumentAri, contentAri }: SyncedBlockLiveView) => React.JSX.Element;
+export default SyncedBlockLiveView;

package/dist/types-ts4.5/ui/extensions/synced-block/components/SyncedBlockRenderer.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import type { SyncedBlockContentPropertyValue } from '../utils/synced-block';
+type SyncedBlockRenderer = {
+    syncedBlockContent: SyncedBlockContentPropertyValue;
+};
+declare const SyncedBlockRenderer: ({ syncedBlockContent }: SyncedBlockRenderer) => React.JSX.Element;
+export default SyncedBlockRenderer;

package/dist/types-ts4.5/ui/extensions/synced-block/constants.d.ts

@@ -0,0 +1,8 @@
+export declare const getPageId: () => string;
+/**
+ * This by no means is a stable way to get the cloud id, but it works for now.
+ * We should switch passing the cloud id from Confluence to a Editor plugin,
+ * for instance the user preferences plugin would have a seperate place for user and cloud info
+ * @returns the cloud id from the initial state
+ */
+export declare const getCloudId: () => string;

package/dist/types-ts4.5/ui/extensions/synced-block/getSyncedBlockExtensionProvider.d.ts

@@ -0,0 +1,2 @@
+import { DefaultExtensionProvider } from '@atlaskit/editor-common/extensions';
+export declare const getSyncedBlockExtensionProvider: () => DefaultExtensionProvider<import("@atlaskit/editor-common/extensions").Parameters>;

package/dist/types-ts4.5/ui/extensions/synced-block/hooks/useLiveSyncedBlockContent.d.ts

@@ -0,0 +1,6 @@
+type UseLiveSyncedBlockContentOptions = {
+    contentAri: string;
+    sourceDocumentAri: string;
+};
+export declare const useLiveSyncedBlockContent: ({ sourceDocumentAri, contentAri, }: UseLiveSyncedBlockContentOptions) => import("../utils/synced-block").SyncedBlockContentPropertyValue | null;
+export {};

package/dist/types-ts4.5/ui/extensions/synced-block/hooks/usePollContentProperty.d.ts

@@ -0,0 +1,7 @@
+import type { ContentProperty } from '../utils/content-property';
+type UsePollContentPropertyOptions = {
+    contentAri: string;
+    sourceDocumentAri: string;
+};
+export declare const usePollContentProperty: ({ sourceDocumentAri, contentAri, }: UsePollContentPropertyOptions) => ContentProperty | undefined;
+export {};

package/dist/types-ts4.5/ui/extensions/synced-block/index.d.ts

@@ -0,0 +1,2 @@
+export { getSyncedBlockExtensionProvider } from './getSyncedBlockExtensionProvider';
+export { getSyncedBlockManifest } from './manifest';

package/dist/types-ts4.5/ui/extensions/synced-block/manifest.d.ts

@@ -0,0 +1,2 @@
+import type { ExtensionManifest } from '@atlaskit/editor-common/extensions';
+export declare const getSyncedBlockManifest: () => ExtensionManifest;

package/dist/types-ts4.5/ui/extensions/synced-block/utils/ari.d.ts

@@ -0,0 +1,4 @@
+export declare const getConfluencePageAri: (pageId: string) => string;
+export declare const getPageIdFromAri: (ari: string) => string;
+export declare const getContentPropertyAri: (contentPropertyId: string) => string;
+export declare const getContentPropertyIdFromAri: (ari: string) => string;

package/dist/types-ts4.5/ui/extensions/synced-block/utils/content-property.d.ts

@@ -0,0 +1,33 @@
+export type ContentProperty = {
+    id: string;
+    key: string;
+    value: string;
+    version: ContentPropertyVersion;
+};
+type ContentPropertyVersion = {
+    authorId: string;
+    createdAt: string;
+    message: string;
+    minorEdit: boolean;
+    number: number;
+};
+type CreateContentPropertyOptions = {
+    key: string;
+    pageId: string;
+    value: string;
+};
+export declare const createContentProperty: ({ pageId, key, value, }: CreateContentPropertyOptions) => Promise<ContentProperty>;
+type GetContentPropertyOptions = {
+    contentPropertyId: string;
+    pageId: string;
+    signal?: AbortSignal;
+};
+export declare const getContentProperty: ({ pageId, contentPropertyId, signal, }: GetContentPropertyOptions) => Promise<ContentProperty>;
+type UpdateContentPropertyOptions = {
+    key: string;
+    pageId: string;
+    signal?: AbortSignal;
+    value: string;
+};
+export declare const updateContentProperty: ({ pageId, key, value, }: UpdateContentPropertyOptions) => Promise<ContentProperty>;
+export {};

package/dist/types-ts4.5/ui/extensions/synced-block/utils/synced-block.d.ts

@@ -0,0 +1,24 @@
+import type { ADFEntity } from '@atlaskit/adf-utils/types';
+export declare const SYNCED_BLOCK_EXTENSION_TYPE = "com.atlassian.platform.extensions";
+export declare const SYNCED_BLOCK_EXTENSION_KEY = "synced-block";
+export declare const SYNCED_BLOCK_SOURCE_NODE = "source";
+export declare const SYNCED_BLOCK_SOURCE_KEY = "synced-block:source";
+export declare const SYNCED_BLOCK_REFERENCE_NODE = "reference";
+export declare const SYNCED_BLOCK_REFERENCE_KEY = "synced-block:reference";
+export type SyncedBlockAttributes = {
+    extensionKey: typeof SYNCED_BLOCK_SOURCE_KEY | typeof SYNCED_BLOCK_REFERENCE_KEY;
+    extensionType: typeof SYNCED_BLOCK_EXTENSION_TYPE;
+    localId: string;
+    parameters: {
+        contentAri: string;
+        contentPropertyKey: string;
+        sourceDocumentAri: string;
+    };
+};
+export declare const isSyncedBlockAttributes: (attributes: unknown) => attributes is SyncedBlockAttributes;
+export type SyncedBlockContentPropertyValue = {
+    adf: ADFEntity;
+};
+export declare const getDefaultSyncedBlockContent: () => ADFEntity;
+export declare const parseSyncedBlockContentPropertyValue: (value: string | object) => SyncedBlockContentPropertyValue;
+export declare const stringifySyncedBlockContentPropertyValue: (value: SyncedBlockContentPropertyValue) => string;

package/docs/0-intro.tsx

@@ -0,0 +1,43 @@
+import React from 'react';
+
+import { AtlassianInternalWarning, code, md } from '@atlaskit/docs';
+// eslint-disable-next-line @atlassian/tangerine/import/entry-points
+import { createEditorUseOnlyNotice } from '@atlaskit/editor-common/doc-utils';
+import { token } from '@atlaskit/tokens';
+
+export default md`
+
+${createEditorUseOnlyNotice('Editor Plugin Synced Block', [
+	{ name: 'Editor Core', link: '/packages/editor/editor-core' },
+])}
+
+
+  ${
+		(
+			// eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Ignored via go/DSP-18766
+			<div style={{ marginTop: token('space.100', '8px') }}>
+				<AtlassianInternalWarning />
+			</div>
+		)
+	}
+
+  This package includes the synced block plugin used by \`@atlaskit/editor-core\`.
+
+  ## Usage
+---
+
+The \`dependencies\`, \`configuration\`, \`state\`, \`actions\`, and \`commands\` of the plugin are defined
+below:
+
+${code`
+type SyncedBlockPlugin = NextEditorPlugin<'syncedBlock'>
+`}
+
+
+  ## Support
+---
+For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
+## License
+---
+ Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.
+`;

package/package.json

@@ -0,0 +1,88 @@
+{
+	"name": "@atlaskit/editor-plugin-synced-block",
+	"version": "0.1.0",
+	"description": "SyncedBlock plugin for @atlaskit/editor-core",
+	"author": "Atlassian Pty Ltd",
+	"license": "Apache-2.0",
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/"
+	},
+	"atlassian": {
+		"team": "Editor: Lego",
+		"releaseModel": "continuous",
+		"singleton": true
+	},
+	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"module:es2019": "dist/es2019/index.js",
+	"types": "dist/types/index.d.ts",
+	"typesVersions": {
+		">=4.5 <4.9": {
+			"*": [
+				"dist/types-ts4.5/*",
+				"dist/types-ts4.5/index.d.ts"
+			]
+		}
+	},
+	"sideEffects": false,
+	"atlaskit:src": "src/index.ts",
+	"af:exports": {
+		".": "./src/index.ts",
+		"./SyncedBlock": "./src/ui/extensions/synced-block/index.ts"
+	},
+	"dependencies": {
+		"@atlaskit/adf-schema": "^50.2.2",
+		"@atlaskit/adf-utils": "^19.21.0",
+		"@atlaskit/editor-json-transformer": "^8.27.0",
+		"@atlaskit/editor-prosemirror": "7.0.0",
+		"@atlaskit/icon": "^28.0.0",
+		"@atlaskit/renderer": "^120.5.0",
+		"@atlaskit/tokens": "^6.0.0",
+		"@babel/runtime": "^7.0.0",
+		"@emotion/react": "^11.7.1"
+	},
+	"peerDependencies": {
+		"@atlaskit/editor-common": "^107.31.0",
+		"react": "^18.2.0"
+	},
+	"devDependencies": {
+		"typescript": "5.9.2"
+	},
+	"techstack": {
+		"@atlassian/frontend": {
+			"code-structure": [
+				"editor-plugin"
+			],
+			"import-structure": [
+				"atlassian-conventions"
+			],
+			"circular-dependencies": [
+				"file-and-folder-level"
+			]
+		},
+		"@repo/internal": {
+			"dom-events": "use-bind-event-listener",
+			"analytics": [
+				"analytics-next"
+			],
+			"design-tokens": [
+				"color"
+			],
+			"theming": [
+				"react-context"
+			],
+			"ui-components": [
+				"lite-mode"
+			],
+			"deprecation": "no-deprecated-imports",
+			"styling": [
+				"emotion",
+				"emotion"
+			],
+			"imports": [
+				"import-no-extraneous-disable-for-examples-and-docs"
+			]
+		}
+	}
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+	"extends": "../../../tsconfig.json",
+	"include": [
+		"src/**/*.ts",
+		"src/**/*.tsx"
+	],
+	"compilerOptions": {}
+}