@fileverse-dev/ddoc 1.3.9 → 1.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (12) hide show
  1. package/README.md +13 -12
  2. package/dist/constants/index.d.ts +7 -0
  3. package/dist/index.es.js +3700 -3631
  4. package/dist/index.umd.js +33 -33
  5. package/dist/packages/ddoc/components/bottom-toolbar.d.ts +2 -1
  6. package/dist/packages/ddoc/components/editor-toolbar.d.ts +2 -1
  7. package/dist/packages/ddoc/components/editor-utils.d.ts +2 -1
  8. package/dist/packages/ddoc/types.d.ts +1 -0
  9. package/dist/packages/ddoc/use-ddoc-editor.d.ts +1 -1
  10. package/dist/packages/ddoc/utils/buildUCANToken.d.ts +2 -0
  11. package/dist/packages/ddoc/utils/upload-images.d.ts +1 -2
  12. package/package.json +2 -1
package/README.md CHANGED
@@ -28,18 +28,19 @@ The `DdocProps` interface is a TypeScript interface that defines the properties
28
28
 
29
29
  ## Properties
30
30
 
31
- | Property | Type | Description |
32
- | ---------------------------------------------- | --------------------------- | ----------------------------------------------------------------------------------------------------- |
33
- | `isPreviewMode` | `boolean` | Indicates whether the page is in preview mode or not. |
34
- | `data` (optional) | `Data` | Optional property holding data related to the page. |
35
- | `enableCollaboration` (optional) | `boolean` | Optional property to enable collaboration |
36
- | `collaborationId` (optional) | `string` | When using enableCollaboration, you need to provide collaborationId, it can be uuid of doc |
37
- | `onAutoSave` (optional) | `(flag:boolean) => void` | Function which expose the current editor state every 10 seconds |
38
- | `renderToolRightSection` (optional) | `({editor}) => JSX.Element` | Function that render the right section of the toolbar. it calls the function with the editor instance |
39
- | `renderToolLeftSection` (optional) | `({editor}) => JSX.Element` | Accept a react component |
40
- | `username` (required when using collaboration) | `boolean` | Takes a username which can be used by collaboration cursor |
41
- | `ensProviderUrl` | `string` | Takes a url |
42
- | `ref` (optional) | `any` | Gets editor instance |
31
+ | Property | Type | Description |
32
+ | ---------------------------------------------- | --------------------------------- | ----------------------------------------------------------------------------------------------------- |
33
+ | `isPreviewMode` | `boolean` | Indicates whether the page is in preview mode or not. |
34
+ | `handleImageUploadToIpfs` | `(file: File) => Promise<string>` | Required function to upload ddoc editor's image on IPFS |
35
+ | `data` (optional) | `Data` | Optional property holding data related to the page. |
36
+ | `enableCollaboration` (optional) | `boolean` | Optional property to enable collaboration |
37
+ | `collaborationId` (optional) | `string` | When using enableCollaboration, you need to provide collaborationId, it can be uuid of doc |
38
+ | `onAutoSave` (optional) | `(flag:boolean) => void` | Function which expose the current editor state every 10 seconds |
39
+ | `renderToolRightSection` (optional) | `({editor}) => JSX.Element` | Function that render the right section of the toolbar. it calls the function with the editor instance |
40
+ | `renderToolLeftSection` (optional) | `({editor}) => JSX.Element` | Accept a react component |
41
+ | `username` (required when using collaboration) | `boolean` | Takes a username which can be used by collaboration cursor |
42
+ | `ensProviderUrl` | `string` | Takes a url |
43
+ | `ref` (optional) | `any` | Gets editor instance |
43
44
 
44
45
  ## Data Interface
45
46
 
package/dist/constants/index.d.ts ADDED
@@ -0,0 +1,7 @@
1
+ export declare const DEFAULT_AUTHENTICATED_HEADER: {
2
+ Authorization: string;
3
+ invoker: string;
4
+ contract: string;
5
+ chain: number;
6
+ };
7
+ export declare const API_URL = "https://dev-fileverse-storage.herokuapp.com";