@atlaskit/editor-plugin-synced-block 1.0.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (117) hide show
  1. package/CHANGELOG.md +8 -16
  2. package/afm-cc/tsconfig.json +0 -12
  3. package/afm-dev-agents/tsconfig.json +0 -12
  4. package/afm-jira/tsconfig.json +0 -12
  5. package/afm-passionfruit/tsconfig.json +0 -12
  6. package/afm-post-office/tsconfig.json +0 -12
  7. package/afm-rovo-extension/tsconfig.json +0 -12
  8. package/afm-townsquare/tsconfig.json +0 -12
  9. package/dist/cjs/nodeviews/lazySyncedBlock.js +26 -0
  10. package/dist/cjs/nodeviews/syncedBlock.js +137 -0
  11. package/dist/cjs/pm-plugins/actions.js +25 -0
  12. package/dist/cjs/pm-plugins/main.js +10 -22
  13. package/dist/cjs/syncedBlockPlugin.js +35 -5
  14. package/dist/cjs/ui/floating-toolbar.js +11 -0
  15. package/dist/es2019/nodeviews/lazySyncedBlock.js +16 -0
  16. package/dist/es2019/nodeviews/syncedBlock.js +105 -0
  17. package/dist/es2019/pm-plugins/actions.js +19 -0
  18. package/dist/es2019/pm-plugins/main.js +10 -25
  19. package/dist/es2019/syncedBlockPlugin.js +38 -15
  20. package/dist/es2019/ui/floating-toolbar.js +3 -0
  21. package/dist/esm/nodeviews/lazySyncedBlock.js +15 -0
  22. package/dist/esm/nodeviews/syncedBlock.js +129 -0
  23. package/dist/esm/pm-plugins/actions.js +19 -0
  24. package/dist/esm/pm-plugins/main.js +10 -22
  25. package/dist/esm/syncedBlockPlugin.js +35 -5
  26. package/dist/esm/ui/floating-toolbar.js +5 -0
  27. package/dist/types/index.d.ts +1 -2
  28. package/dist/types/nodeviews/lazySyncedBlock.d.ts +3 -0
  29. package/dist/types/nodeviews/syncedBlock.d.ts +28 -0
  30. package/dist/types/pm-plugins/actions.d.ts +2 -0
  31. package/dist/types/pm-plugins/main.d.ts +3 -1
  32. package/dist/types/syncedBlockPluginType.d.ts +36 -1
  33. package/dist/types/ui/floating-toolbar.d.ts +2 -0
  34. package/dist/types-ts4.5/index.d.ts +1 -2
  35. package/dist/types-ts4.5/nodeviews/lazySyncedBlock.d.ts +3 -0
  36. package/dist/types-ts4.5/nodeviews/syncedBlock.d.ts +28 -0
  37. package/dist/types-ts4.5/pm-plugins/actions.d.ts +2 -0
  38. package/dist/types-ts4.5/pm-plugins/main.d.ts +3 -1
  39. package/dist/types-ts4.5/syncedBlockPluginType.d.ts +36 -1
  40. package/dist/types-ts4.5/ui/floating-toolbar.d.ts +2 -0
  41. package/package.json +5 -9
  42. package/SyncedBlock/package.json +0 -15
  43. package/dist/cjs/pm-plugins/SyncClient.js +0 -167
  44. package/dist/cjs/pm-plugins/utils.js +0 -19
  45. package/dist/cjs/types/index.js +0 -1
  46. package/dist/cjs/ui/extensions/synced-block/components/GlobalStyles.js +0 -25
  47. package/dist/cjs/ui/extensions/synced-block/components/SyncedBlockLiveView.js +0 -25
  48. package/dist/cjs/ui/extensions/synced-block/components/SyncedBlockRenderer.js +0 -25
  49. package/dist/cjs/ui/extensions/synced-block/constants.js +0 -32
  50. package/dist/cjs/ui/extensions/synced-block/getSyncedBlockExtensionProvider.js +0 -11
  51. package/dist/cjs/ui/extensions/synced-block/hooks/useLiveSyncedBlockContent.js +0 -29
  52. package/dist/cjs/ui/extensions/synced-block/hooks/usePollContentProperty.js +0 -121
  53. package/dist/cjs/ui/extensions/synced-block/index.js +0 -19
  54. package/dist/cjs/ui/extensions/synced-block/manifest.js +0 -281
  55. package/dist/cjs/ui/extensions/synced-block/utils/ari.js +0 -29
  56. package/dist/cjs/ui/extensions/synced-block/utils/content-property.js +0 -159
  57. package/dist/cjs/ui/extensions/synced-block/utils/synced-block.js +0 -65
  58. package/dist/es2019/pm-plugins/SyncClient.js +0 -102
  59. package/dist/es2019/pm-plugins/utils.js +0 -13
  60. package/dist/es2019/types/index.js +0 -0
  61. package/dist/es2019/ui/extensions/synced-block/components/GlobalStyles.js +0 -18
  62. package/dist/es2019/ui/extensions/synced-block/components/SyncedBlockLiveView.js +0 -19
  63. package/dist/es2019/ui/extensions/synced-block/components/SyncedBlockRenderer.js +0 -19
  64. package/dist/es2019/ui/extensions/synced-block/constants.js +0 -26
  65. package/dist/es2019/ui/extensions/synced-block/getSyncedBlockExtensionProvider.js +0 -5
  66. package/dist/es2019/ui/extensions/synced-block/hooks/useLiveSyncedBlockContent.js +0 -24
  67. package/dist/es2019/ui/extensions/synced-block/hooks/usePollContentProperty.js +0 -107
  68. package/dist/es2019/ui/extensions/synced-block/index.js +0 -5
  69. package/dist/es2019/ui/extensions/synced-block/manifest.js +0 -172
  70. package/dist/es2019/ui/extensions/synced-block/utils/ari.js +0 -19
  71. package/dist/es2019/ui/extensions/synced-block/utils/content-property.js +0 -108
  72. package/dist/es2019/ui/extensions/synced-block/utils/synced-block.js +0 -57
  73. package/dist/esm/pm-plugins/SyncClient.js +0 -160
  74. package/dist/esm/pm-plugins/utils.js +0 -13
  75. package/dist/esm/types/index.js +0 -0
  76. package/dist/esm/ui/extensions/synced-block/components/GlobalStyles.js +0 -18
  77. package/dist/esm/ui/extensions/synced-block/components/SyncedBlockLiveView.js +0 -18
  78. package/dist/esm/ui/extensions/synced-block/components/SyncedBlockRenderer.js +0 -18
  79. package/dist/esm/ui/extensions/synced-block/constants.js +0 -26
  80. package/dist/esm/ui/extensions/synced-block/getSyncedBlockExtensionProvider.js +0 -5
  81. package/dist/esm/ui/extensions/synced-block/hooks/useLiveSyncedBlockContent.js +0 -23
  82. package/dist/esm/ui/extensions/synced-block/hooks/usePollContentProperty.js +0 -114
  83. package/dist/esm/ui/extensions/synced-block/index.js +0 -5
  84. package/dist/esm/ui/extensions/synced-block/manifest.js +0 -274
  85. package/dist/esm/ui/extensions/synced-block/utils/ari.js +0 -23
  86. package/dist/esm/ui/extensions/synced-block/utils/content-property.js +0 -153
  87. package/dist/esm/ui/extensions/synced-block/utils/synced-block.js +0 -58
  88. package/dist/types/pm-plugins/SyncClient.d.ts +0 -14
  89. package/dist/types/pm-plugins/utils.d.ts +0 -5
  90. package/dist/types/types/index.d.ts +0 -3
  91. package/dist/types/ui/extensions/synced-block/components/GlobalStyles.d.ts +0 -6
  92. package/dist/types/ui/extensions/synced-block/components/SyncedBlockLiveView.d.ts +0 -7
  93. package/dist/types/ui/extensions/synced-block/components/SyncedBlockRenderer.d.ts +0 -7
  94. package/dist/types/ui/extensions/synced-block/constants.d.ts +0 -8
  95. package/dist/types/ui/extensions/synced-block/getSyncedBlockExtensionProvider.d.ts +0 -3
  96. package/dist/types/ui/extensions/synced-block/hooks/useLiveSyncedBlockContent.d.ts +0 -6
  97. package/dist/types/ui/extensions/synced-block/hooks/usePollContentProperty.d.ts +0 -7
  98. package/dist/types/ui/extensions/synced-block/index.d.ts +0 -2
  99. package/dist/types/ui/extensions/synced-block/manifest.d.ts +0 -3
  100. package/dist/types/ui/extensions/synced-block/utils/ari.d.ts +0 -4
  101. package/dist/types/ui/extensions/synced-block/utils/content-property.d.ts +0 -33
  102. package/dist/types/ui/extensions/synced-block/utils/synced-block.d.ts +0 -24
  103. package/dist/types-ts4.5/pm-plugins/SyncClient.d.ts +0 -14
  104. package/dist/types-ts4.5/pm-plugins/utils.d.ts +0 -5
  105. package/dist/types-ts4.5/types/index.d.ts +0 -3
  106. package/dist/types-ts4.5/ui/extensions/synced-block/components/GlobalStyles.d.ts +0 -6
  107. package/dist/types-ts4.5/ui/extensions/synced-block/components/SyncedBlockLiveView.d.ts +0 -7
  108. package/dist/types-ts4.5/ui/extensions/synced-block/components/SyncedBlockRenderer.d.ts +0 -7
  109. package/dist/types-ts4.5/ui/extensions/synced-block/constants.d.ts +0 -8
  110. package/dist/types-ts4.5/ui/extensions/synced-block/getSyncedBlockExtensionProvider.d.ts +0 -3
  111. package/dist/types-ts4.5/ui/extensions/synced-block/hooks/useLiveSyncedBlockContent.d.ts +0 -6
  112. package/dist/types-ts4.5/ui/extensions/synced-block/hooks/usePollContentProperty.d.ts +0 -7
  113. package/dist/types-ts4.5/ui/extensions/synced-block/index.d.ts +0 -2
  114. package/dist/types-ts4.5/ui/extensions/synced-block/manifest.d.ts +0 -3
  115. package/dist/types-ts4.5/ui/extensions/synced-block/utils/ari.d.ts +0 -4
  116. package/dist/types-ts4.5/ui/extensions/synced-block/utils/content-property.d.ts +0 -33
  117. package/dist/types-ts4.5/ui/extensions/synced-block/utils/synced-block.d.ts +0 -24
@@ -1,14 +0,0 @@
1
- import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
2
- export declare class SyncClient {
3
- private requestMap;
4
- constructor();
5
- private getRequestState;
6
- private setRequestState;
7
- private sendRequest;
8
- syncContent({ sourceDocumentAri, contentAri, contentPropertyKey, node, }: {
9
- contentAri: string;
10
- contentPropertyKey: string;
11
- node: PMNode;
12
- sourceDocumentAri: string;
13
- }): void;
14
- }
@@ -1,5 +0,0 @@
1
- import type { ResolvedPos } from '@atlaskit/editor-prosemirror/model';
2
- export declare const findSyncedBlockParent: ($pos: ResolvedPos) => {
3
- node: import("prosemirror-model").Node;
4
- attributes: import("../ui/extensions/synced-block/utils/synced-block").SyncedBlockAttributes;
5
- } | undefined;
@@ -1,3 +0,0 @@
1
- export type SyncedBlockPluginOptions = {
2
- clouldId?: string;
3
- };
@@ -1,6 +0,0 @@
1
- /**
2
- * @jsxRuntime classic
3
- * @jsx jsx
4
- */
5
- import { jsx } from '@emotion/react';
6
- export declare const GlobalStylesWrapper: () => jsx.JSX.Element;
@@ -1,7 +0,0 @@
1
- import React from 'react';
2
- type SyncedBlockLiveView = {
3
- contentAri: string;
4
- sourceDocumentAri: string;
5
- };
6
- declare const SyncedBlockLiveView: ({ sourceDocumentAri, contentAri }: SyncedBlockLiveView) => React.JSX.Element;
7
- export default SyncedBlockLiveView;
@@ -1,7 +0,0 @@
1
- import React from 'react';
2
- import type { SyncedBlockContentPropertyValue } from '../utils/synced-block';
3
- type SyncedBlockRenderer = {
4
- syncedBlockContent: SyncedBlockContentPropertyValue;
5
- };
6
- declare const SyncedBlockRenderer: ({ syncedBlockContent }: SyncedBlockRenderer) => React.JSX.Element;
7
- export default SyncedBlockRenderer;
@@ -1,8 +0,0 @@
1
- export declare const getPageId: () => string;
2
- /**
3
- * This by no means is a stable way to get the cloud id, but it works for now.
4
- * We should switch passing the cloud id from Confluence to a Editor plugin,
5
- * for instance the user preferences plugin would have a seperate place for user and cloud info
6
- * @returns the cloud id from the initial state
7
- */
8
- export declare const getCloudId: () => string;
@@ -1,3 +0,0 @@
1
- import { DefaultExtensionProvider } from '@atlaskit/editor-common/extensions';
2
- import type { Schema } from '@atlaskit/editor-prosemirror/model';
3
- export declare const getSyncedBlockExtensionProvider: (schema?: Schema) => DefaultExtensionProvider<import("@atlaskit/editor-common/extensions").Parameters>;
@@ -1,6 +0,0 @@
1
- type UseLiveSyncedBlockContentOptions = {
2
- contentAri: string;
3
- sourceDocumentAri: string;
4
- };
5
- export declare const useLiveSyncedBlockContent: ({ sourceDocumentAri, contentAri, }: UseLiveSyncedBlockContentOptions) => import("../utils/synced-block").SyncedBlockContentPropertyValue | null;
6
- export {};
@@ -1,7 +0,0 @@
1
- import type { ContentProperty } from '../utils/content-property';
2
- type UsePollContentPropertyOptions = {
3
- contentAri: string;
4
- sourceDocumentAri: string;
5
- };
6
- export declare const usePollContentProperty: ({ sourceDocumentAri, contentAri, }: UsePollContentPropertyOptions) => ContentProperty | undefined;
7
- export {};
@@ -1,2 +0,0 @@
1
- export { getSyncedBlockExtensionProvider } from './getSyncedBlockExtensionProvider';
2
- export { getSyncedBlockManifest } from './manifest';
@@ -1,3 +0,0 @@
1
- import type { ExtensionManifest } from '@atlaskit/editor-common/extensions';
2
- import { type Schema } from '@atlaskit/editor-prosemirror/model';
3
- export declare const getSyncedBlockManifest: (schema?: Schema) => ExtensionManifest;
@@ -1,4 +0,0 @@
1
- export declare const getConfluencePageAri: (pageId: string) => string;
2
- export declare const getPageIdFromAri: (ari: string) => string;
3
- export declare const getContentPropertyAri: (contentPropertyId: string) => string;
4
- export declare const getContentPropertyIdFromAri: (ari: string) => string;
@@ -1,33 +0,0 @@
1
- export type ContentProperty = {
2
- id: string;
3
- key: string;
4
- value: string;
5
- version: ContentPropertyVersion;
6
- };
7
- type ContentPropertyVersion = {
8
- authorId: string;
9
- createdAt: string;
10
- message: string;
11
- minorEdit: boolean;
12
- number: number;
13
- };
14
- type CreateContentPropertyOptions = {
15
- key: string;
16
- pageId: string;
17
- value: string;
18
- };
19
- export declare const createContentProperty: ({ pageId, key, value, }: CreateContentPropertyOptions) => Promise<ContentProperty>;
20
- type GetContentPropertyOptions = {
21
- contentPropertyId: string;
22
- pageId: string;
23
- signal?: AbortSignal;
24
- };
25
- export declare const getContentProperty: ({ pageId, contentPropertyId, signal, }: GetContentPropertyOptions) => Promise<ContentProperty>;
26
- type UpdateContentPropertyOptions = {
27
- key: string;
28
- pageId: string;
29
- signal?: AbortSignal;
30
- value: string;
31
- };
32
- export declare const updateContentProperty: ({ pageId, key, value, }: UpdateContentPropertyOptions) => Promise<ContentProperty>;
33
- export {};
@@ -1,24 +0,0 @@
1
- import type { ADFEntity } from '@atlaskit/adf-utils/types';
2
- export declare const SYNCED_BLOCK_EXTENSION_TYPE = "com.atlassian.platform.extensions";
3
- export declare const SYNCED_BLOCK_EXTENSION_KEY = "synced-block";
4
- export declare const SYNCED_BLOCK_SOURCE_NODE = "source";
5
- export declare const SYNCED_BLOCK_SOURCE_KEY = "synced-block:source";
6
- export declare const SYNCED_BLOCK_REFERENCE_NODE = "reference";
7
- export declare const SYNCED_BLOCK_REFERENCE_KEY = "synced-block:reference";
8
- export type SyncedBlockAttributes = {
9
- extensionKey: typeof SYNCED_BLOCK_SOURCE_KEY | typeof SYNCED_BLOCK_REFERENCE_KEY;
10
- extensionType: typeof SYNCED_BLOCK_EXTENSION_TYPE;
11
- localId: string;
12
- parameters: {
13
- contentAri: string;
14
- contentPropertyKey: string;
15
- sourceDocumentAri: string;
16
- };
17
- };
18
- export declare const isSyncedBlockAttributes: (attributes: unknown) => attributes is SyncedBlockAttributes;
19
- export type SyncedBlockContentPropertyValue = {
20
- adf: ADFEntity;
21
- };
22
- export declare const getDefaultSyncedBlockContent: () => ADFEntity;
23
- export declare const parseSyncedBlockContentPropertyValue: (value: string | object) => SyncedBlockContentPropertyValue;
24
- export declare const stringifySyncedBlockContentPropertyValue: (value: SyncedBlockContentPropertyValue) => string;