@logseq/capacitor-file-sync

Logseq Sync for mobile platforms.

Local Development

# run the following in capacitor-file-sync/ folder
yarn link

# run the following in logseq/ folder
yarn link @logseq/capacitor-file-sync

Install

npm install @logseq/capacitor-file-sync
npx cap sync

API Doc

• keygen()
• setEnv(...)
• encryptFnames(...)
• decryptFnames(...)
• getLocalFilesMeta(...)
• getLocalAllFilesMeta(...)
• deleteLocalFiles(...)
• fetchRemoteFiles(...)
• updateLocalFiles(...)
• updateLocalVersionFiles(...)
• deleteRemoteFiles(...)
• updateRemoteFiles(...)
• encryptWithPassphrase(...)
• decryptWithPassphrase(...)
• cancelAllRequests(...)

keygen()

keygen() => Promise<{ secretKey: string; publicKey: string; }>

Returns: Promise<{ secretKey: string; publicKey: string; }>

setEnv(...)

setEnv(options: { graphUUID: string; env: string; secretKey: string; publicKey: string; }) => Promise<void>

| Param | Type | | ------------- | -------------------------------------------------------------------------------------- | | options | { graphUUID: string; env: string; secretKey: string; publicKey: string; } |

encryptFnames(...)

encryptFnames(options: { graphUUID: string; filePaths: string[]; }) => Promise<{ value: string[]; }>

| Param | Type | | ------------- | -------------------------------------------------------- | | options | { graphUUID: string; filePaths: string[]; } |

Returns: Promise<{ value: string[]; }>

decryptFnames(...)

decryptFnames(options: { graphUUID: string; filePaths: string[]; }) => Promise<{ value: string[]; }>

| Param | Type | | ------------- | -------------------------------------------------------- | | options | { graphUUID: string; filePaths: string[]; } |

Returns: Promise<{ value: string[]; }>

getLocalFilesMeta(...)

getLocalFilesMeta(options: { graphUUID: string; basePath: string; filePaths: string[]; }) => Promise<{ result: any[]; }>

| Param | Type | | ------------- | -------------------------------------------------------------------------- | | options | { graphUUID: string; basePath: string; filePaths: string[]; } |

Returns: Promise<{ result: any[]; }>

getLocalAllFilesMeta(...)

getLocalAllFilesMeta(options: { graphUUID: string; basePath: string; }) => Promise<{ result: any[]; }>

| Param | Type | | ------------- | ----------------------------------------------------- | | options | { graphUUID: string; basePath: string; } |

Returns: Promise<{ result: any[]; }>

deleteLocalFiles(...)

deleteLocalFiles(options: { graphUUID: string; basePath: string; filePaths: string[]; }) => Promise<void>

| Param | Type | | ------------- | -------------------------------------------------------------------------- | | options | { graphUUID: string; basePath: string; filePaths: string[]; } |

fetchRemoteFiles(...)

fetchRemoteFiles(options: { graphUUID: string; basePath: string; filePaths: string[]; token: string; }) => Promise<void>

| Param | Type | | ------------- | ----------------------------------------------------------------------------------------- | | options | { graphUUID: string; basePath: string; filePaths: string[]; token: string; } |

updateLocalFiles(...)

updateLocalFiles(options: { graphUUID: string; basePath: string; filePaths: string[]; token: string; }) => Promise<void>

| Param | Type | | ------------- | ----------------------------------------------------------------------------------------- | | options | { graphUUID: string; basePath: string; filePaths: string[]; token: string; } |

updateLocalVersionFiles(...)

updateLocalVersionFiles(options: { graphUUID: string; basePath: string; filePaths: string[]; token: string; }) => Promise<void>

| Param | Type | | ------------- | ----------------------------------------------------------------------------------------- | | options | { graphUUID: string; basePath: string; filePaths: string[]; token: string; } |

deleteRemoteFiles(...)

deleteRemoteFiles(options: { graphUUID: string; filePaths: string[]; token: string; txid: number; }) => Promise<{ txid: number; }>

| Param | Type | | ------------- | ------------------------------------------------------------------------------------- | | options | { graphUUID: string; filePaths: string[]; token: string; txid: number; } |

Returns: Promise<{ txid: number; }>

updateRemoteFiles(...)

updateRemoteFiles(options: { graphUUID: string; basePath: string; filePaths: string[]; token: string; txid: number; }) => Promise<{ txid: number; }>

| Param | Type | | ------------- | ------------------------------------------------------------------------------------------------------- | | options | { graphUUID: string; basePath: string; filePaths: string[]; token: string; txid: number; } |

Returns: Promise<{ txid: number; }>

encryptWithPassphrase(...)

encryptWithPassphrase(options: { passphrase: string; content: string; }) => Promise<{ data: string; }>

| Param | Type | | ------------- | ----------------------------------------------------- | | options | { passphrase: string; content: string; } |

Returns: Promise<{ data: string; }>

decryptWithPassphrase(...)

decryptWithPassphrase(options: { passphrase: string; content: string; }) => Promise<{ data: string; }>

| Param | Type | | ------------- | ----------------------------------------------------- | | options | { passphrase: string; content: string; } |

Returns: Promise<{ data: string; }>

cancelAllRequests(...)

cancelAllRequests(options: unknown) => Promise<void>

| Param | Type | | ------------- | -------------------- | | options | unknown |