@fairdatasociety/fairdrive-opfs

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@fairdatasociety/fairdrive-opfs</title><meta name="description" content="Documentation for @fairdatasociety/fairdrive-opfs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> <div class="tsd-toolbar-contents container"> <div class="table-cell" id="tsd-search" data-base="."> <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div> <div class="field"> <div id="tsd-toolbar-links"></div></div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@fairdatasociety/fairdrive-opfs</a></div> <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header> <div class="container container-main"> <div class="col-8 col-content"> <div class="tsd-page-title"> <h2>@fairdatasociety/fairdrive-opfs</h2></div> <div class="tsd-panel tsd-typography"> <a href="#opfs---fairdrive-connector" id="opfs---fairdrive-connector" style="color: inherit; text-decoration: none;"> <h1>OPFS - fairdrive-connector</h1> </a> Fairdrive Connector - integrate data sources from Web 2.0 or Web 3.0 Warning: This project is in alpha state. There might (and most probably will) be changes in the future to its API and working. Also, no guarantees can be made about its stability, efficiency, and security at this stage. <a href="#table-of-contents" id="table-of-contents" style="color: inherit; text-decoration: none;"> <h2>Table of Contents</h2> </a> <ul> <li><a href="#install">Install</a></li> <li><a href="#usage">Usage</a></li> <li><a href="#api">API</a></li> <li><a href="#drivers">Drivers</a></li> <li><a href="#license">License</a></li> </ul> <a href="#install" id="install" style="color: inherit; text-decoration: none;"> <h2>Install</h2> </a> <code>npm install @fairdatasociety/fairdrive-opfs</code> <a href="#usage" id="usage" style="color: inherit; text-decoration: none;"> <h2>Usage</h2> </a> <pre><code class="language-typescript">import { FdpConnectModule, FairosProvider, IPFSMfsProvider } from '@fairdatasociety/fairdrive-opfs' import { fileSave } from 'browser-fs-access' // Add providers const module = new FdpConnectModule({ providers: { ipfs: { options: { host: 'http://localhost:5001', }, driver: import('@fairdatasociety/fairdrive-opfs'), type: 'IPFSMfsProvider', }, fairos: { options: { username: '', password: '', host: 'https://fairos.fairdatasociety.org/', }, driver: import('@fairdatasociety/fairdrive-opfs'), type: 'FairosProvider', }, }, }) // Connect to Fairos const connector = await module.connect('fairos') // Provider calls that manage authentication, authz and mounts are at the top level await connector.userLogin(process.env.REACT_APP_USERNAME, process.env.REACT_APP_PASSWORD) // Fairdrive Connector pods are called Mounts const podList = await connector.listMounts() const selectedMount = { name: podList[0], path: '/' } // OPFS driver interface is available with getFSHandler const currentFolderHandle = await connector.getFSHandler(selectedMount) const files = [] // =================================== // List of files and folders // =================================== for await (let [name, entry] of currentFolderHandle.entries()) { if (entry.kind === 'directory') { const item = { id: name, name: name, isDir: true, handle: entry } files.push(item) } else { const item = { id: name, name: name, isDir: false, handle: entry } files.push(item) } } // =================================== // Uploading file // =================================== // Request user to select a file const [picker] = await showOpenFilePicker({ types: [], // default multiple: false, // default excludeAcceptAllOption: false, // default _preferPolyfill: false, // default }) // returns a File Instance const file = await picker.getFile() const fileHandle = await currentFolderHandle.getFileHandle(file.name, { create: true }) const writable = await fileHandle.createWritable({ keepExistingData: false }) await writable.write(file) await writable.close() // =================================== // Downloading file // =================================== const blob = fileHandle.getFile() // Save a file. fileSave(blob, { fileName: fileHandle.name, }) // =================================== // Upload file using IPFS driver directly // =================================== await module.connect('ipfs', IPFSMfsProvider) const ipfsConnector = module.getConnectedProviders('ipfs') const DefaultMount = { name: 'default', path: '/', } await ipfsConnector.filesystemDriver.upload(file, DefaultMount, {}) </code></pre> <a href="#drivers" id="drivers" style="color: inherit; text-decoration: none;"> <h2>Drivers</h2> </a> <ul> <li>Fairos: <code>@fairdatasociety/fairdrive-connector/providers/fairos</code></li> <li>IPFS-Mfs: <code>@fairdatasociety/fairdrive-connector/providers/ipfs-mfs</code></li> </ul> <a href="#implementing-a-new-fairdrive-connector" id="implementing-a-new-fairdrive-connector" style="color: inherit; text-decoration: none;"> <h3>Implementing a new Fairdrive Connector</h3> </a> Create a new <code>FdpConnectProvider</code> and <code>ProviderDriver</code> and implement interfaces. Provider contains implementation logic related to non file system concerns like identity, authentication and authorization. <pre><code class="language-typescript">import { Mount, Entries, FdpConnectProvider } from '../core/provider' import { ProviderDriver } from '../core/provider-driver' import { create, IPFSHTTPClient } from 'ipfs-http-client' /** * IpfsMfsProviderDriver is the driver for the IPFS MFS provider. */ export class IpfsMfsProviderDriver implements ProviderDriver { host: any client: IPFSHTTPClient constructor(options: { host: string }) { this.host = options.host this.client = create({ url: options.host }) } /** * Verify if a file exists * @param path - path to the file * @param mount - mount to check * @returns Returns true if the file exists, else false */ async exists(path: string, mount: Mount): Promise<boolean> { const stat = await this.client.files.stat(path) return stat.cid.byteLength > 0 } /** * Creates a directory * @param name - directory name * @param mount - mount to check * @returns Returns true if the directory created, else false */ async createDir(name: string, mount: Mount): Promise<boolean> { try { await this.client.files.mkdir(name) return true } catch (e) { return false } } async delete(filePath: string, mount: Mount): Promise<boolean> { try { await this.client.files.rm(filePath) return true } catch (e) { console.error(e) return false } } async read(mount: Mount): Promise<Entries> { const entries = { dirs: [], files: [], mount, } as Entries for await (const i of this.client.files.ls(`${mount.path}`)) { if (i.type === 'directory') { entries.dirs.push(i.cid.toString()) } else { entries.files.push(i.cid.toString()) } } return entries } /** * Download a file * @param id - id of the file * @param mount - mount to download the file from * @param options - options * @returns */ async download(id: string, mount: Mount, options = {}): Promise<any> { let bs for await (const res of this.client.files.read(`${mount.path}/${id}`, options)) { bs = res } return bs as Uint8Array } /** * Upload a file * @param file - file to upload * @param mount - mount to upload to * @param options - options */ async upload(file: File, mount: Mount, options = {}): Promise<any> { const res = this.client.files.write(`${mount.path}/${file.name}`, file, options as any) return res } } /** * IPFSMfsProvider is the provider for IPFS MFS. */ export class IPFSMfsProvider extends FdpConnectProvider { constructor(private host: string = 'http://localhost:5001/api/v0/') { super({ name: 'IPFSMfsProvider', }) } initialize(options: any): void { super.initialize(options) this.filesystemDriver = new IpfsMfsProviderDriver(options) } } </code></pre> <a href="#api" id="api" style="color: inherit; text-decoration: none;"> <h2>API</h2> </a> See <code>/docs</code> for generated TypeScript documentation. <a href="#maintainers" id="maintainers" style="color: inherit; text-decoration: none;"> <h2>Maintainers</h2> </a> <ul> <li><a href="https://github.com/molekilla">molekilla</a></li> </ul> <a href="#license" id="license" style="color: inherit; text-decoration: none;"> <h2>License</h2> </a> <a href="./LICENSE">MIT</a> </div></div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <div class="tsd-navigation settings"> <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary> <div class="tsd-accordion-details"> <div class="tsd-filter-visibility"> <h4 class="uppercase">Member Visibility</h4><form> <ul id="tsd-filter-options"> <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Inherited</label></li></ul></form></div> <div class="tsd-theme-toggle"> <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div> <nav class="tsd-navigation primary"> <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary"> <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary> <div class="tsd-accordion-details"> <ul> <li class="current selected"><a href="modules.html">@fairdatasociety/fairdrive-opfs</a> <ul></ul></li></ul></div></details></nav> <nav class="tsd-navigation secondary menu-sticky"> <ul> <li class="tsd-kind-class"><a href="classes/FairDriveMount.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg>FairDriveMount</a></li> <li class="tsd-kind-class"><a href="classes/FairosProvider.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>FairosProvider</a></li> <li class="tsd-kind-class"><a href="classes/FairosProviderDriver.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>FairosProviderDriver</a></li> <li class="tsd-kind-class"><a href="classes/FdpConnectModule.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>FdpConnectModule</a></li> <li class="tsd-kind-class"><a href="classes/FdpConnectProvider.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>FdpConnectProvider</a></li> <li class="tsd-kind-class"><a href="classes/FileHandle.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>FileHandle</a></li> <li class="tsd-kind-class"><a href="classes/FolderHandle.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>FolderHandle</a></li> <li class="tsd-kind-class"><a href="classes/IPFSMfsProvider.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>IPFSMfsProvider</a></li> <li class="tsd-kind-class"><a href="classes/IpfsMfsProviderDriver.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>IpfsMfsProviderDriver</a></li> <li class="tsd-kind-class"><a href="classes/ModuleConfig.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>ModuleConfig</a></li> <li class="tsd-kind-class"><a href="classes/Permission.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Permission</a></li> <li class="tsd-kind-class"><a href="classes/ProviderConfig.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>ProviderConfig</a></li> <li class="tsd-kind-class"><a href="classes/S3Provider.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>S3Provider</a></li> <li class="tsd-kind-class"><a href="classes/S3ProviderDriver.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>S3ProviderDriver</a></li> <li class="tsd-kind-interface"><a href="interfaces/Entries.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>Entries</a></li> <li class="tsd-kind-interface"><a href="interfaces/FdpAdapterOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>FdpAdapterOptions</a></li> <li class="tsd-kind-interface"><a href="interfaces/Mount.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Mount</a></li> <li class="tsd-kind-interface"><a href="interfaces/ProviderDriver.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>ProviderDriver</a></li></ul></nav></div></div> <div class="container tsd-generator"> Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></div> <div class="overlay"></div><script src="assets/main.js"></script></body></html>