fission-suite/webnative

# Changelog

### V0.37.2

- Fixes an issue with the capabilities system which prevented ODD apps from receiving the capabilities.
- Increases the default life time of a UCAN.

### V0.37.0

- Adds browser extension support
- Moves events onto top-level program and renames them. For example, the `local-change` is now `fileSystem:local-change`.
- Adds session create and destroy events
- Rename Webnative SDK to ODD SDK and update external URLs


### V0.36.3

Now parses DAG-JSON formatted CIDs.

### v0.36.2

Allow symlinks to other file systems to be created.

### v0.36.1

Fixes an issue with the CID log, which, in certain scenarios, caused Webnative to load the wrong version of an account's file system.

### v0.36.0

#### Breaking changes

- Removes the `fs.add` and `fs.cat` functions, use `fs.read` and `fs.write` instead.
- Renames `program.loadFileSystem()` to `program.fileSystem.load()`

#### Additions

- Adds an event emitter interface so you can listen to various events. This release comes with two events: `fileSystem.local-change` for listening to file system changes and `fileSystem.publish` to listen for successful publishes.
- Adds `program.fileSystem.recover({ newUsername, oldUsername, readKey })` shorthand method so apps will no longer have to implement the file system recovery flow manually.
- Adds `program.accountDID(username)` shorthand method to retrieve the root DID of a given account username.
- Adds the file system data functions as shorthand methods.
- Injects programs into the global namespace when in debug mode. Can be disabled via the configuration.

#### Other

- Introduces stricter types for paths to restrict the paths you can use with various functions and also to guide you a bit more.
- Improved Program type.

#### Fixes

- Fixes persistance issue with `fs.mv()`
- Fixes various issues with file/directory history.


### v0.35.2

Fixes issue with the types of the `path.appData` function. Now has the correct overloads.

### v0.35.1

- Fixes `waitForRootDid` retry issues. The function did not make enough attempts nor did it make them frequently enough.
- Moves `shareLink` function to `common/fission` for reachability.
- Improve capabilities documentation.

### v0.35.0

Full rewrite of webnative. 🎉

**Components**

We've moved to a component system to make webnative more customizable and indepent of Fission infrastructure. The system removes all global state, avoiding bundler issues. We previously had dependency injection; this is basically more of the same without global state.

The documentation should give you some information on how the various components fit together. If you want to write implementations for a component, see the directories in `src/components` (or the lib folder). All existing components have been expanded and refactored, and we've introduced the following:

- Introduction of a `depot` component: All IPFS functionality has been moved into here. Can now be swapped out with something else. Note that webnative still uses CIDs & IPLD.
- Introduction of a `reference` component: Data root lookups & updating, DID root lookups, DNS and various repositories (cid log & UCANs) have been moved in here.
- Introduction of a `manners` component: Debug functionality has moved to here.
- Introduction of a `capabilities` components: Responsible for accepting UCANs and filesystem secrets from external sources (eg. Fission Lobby)

**Improvements**

- The `program` function now serves as the single entrypoint. You can customise all components and configuration via this function. It'll give you a `Program` with possibly a `Session` (and many other things) instead of the `State` we had before. Basically, when you get a session you're "logged in", otherwise you're not.
- Webnative can now have many apps run on the same domain without any conflicts. This should help a lot when developing apps on the same localhost port. All storage and filesystems are namespaced by default.
- When loading a filesystem the data root is tried multiple times (to get around the DNS issue)
- Multiple filesystems can be loaded at the same time (conflicts with identifiers have been resolved), which allows for a temporary filesystem (progressive login).

**(Re)moved**

- Removal of various confusing filesystem parameters, all data and read keys are `Uint8Array`s now.
- Removal of the `webnative.initialise`, `app` and `permissionedApp` functions. These have been replaced by the `program` function mentioned above.
- Removal of the `fs.appPath` function, replaced with the `appData` function located in the path module.
- Removal of the `fs.addPublicExchangeKey` and `fs.hasPublicExchangeKey` functions, replaced with non-class-instance functions located in `fs/data.js`.

### v0.34.2

- Fixes `LinkError: import object field '__wbg_putBlock_88cdb3be9020efb7' is not a Function` when loading WASM.

### v0.34.1

#### Bug fixes

- Fixes the depedency-injected `lookupDnsLink` function
- Fixes issue with IPFS peer-list storage
- Removes Vite warning caused by a dynamic import

### v0.34.0

Enable new EXPERIMENTAL public file system version 3.0.0 using rs-wnfs. Use this for experimentation. File system verion 3.0.0 _will_ have breaking changes.

- Add `setup.fsVersion` setting for configuring the default version for new file systems, can be `3.0.0` or `2.0.0`.
- Add `setup.wnfsWasmLookup` setting for configuring from where and how to load the rs-wnfs WASM blob. By default it uses the https://unpkg.com CDN.
- Add `WASM_WNFS_VERSION` constant, which is the dependency version for the `wnfs` npm package.

- Adds app owned WNFS
- Separates initialize into `app` and `permissionedApp` entrypoints
- Make email optional at registration
- Add reset option to bootstrapFileSystem
- Add dependency-injected DNS lookup implementation
- No longer uses a locally-shared IPFS client (was originally using a shared worker). This fixes various error messages you may have seen relating to CIDs.

### v0.32.0

#### Features

Adds app owned account linking.

#### Bug fixes

Fixes issue with loading private shares.

#### Other

Updated ipfs-related dependencies.

### v0.31.1

Move `madge` and `typedoc-plugin-missing-exports` from `dependencies` into `devDependencies`.

### v0.31.0

Fixes circular dependencies.

### v0.30.0

#### Breaking Changes

- Encrypts the filesystem using AES-GCM instead of AES-CTR. Also wraps the filesystem blocks with some information about the encryption algorithm used.
  Users will need to migrate their filesystems to be able to load apps with this webnative version.
  Apps will need to update to this webnative version to load migrated/new filesystems.
- CID strings have been replaced with CID class instances from the [multiformats](https://github.com/multiformats/js-multiformats/blob/master/src/cid.js#L22) library.

#### Features

- Adds ability to share private files.
- Adds soft/symbolic links.
- Adds dependency injection for initialising and registering accounts.

### v0.29.2

- Make webnative work across more environments and bundlers (upgrade one-webcrypto to 1.0.3)
- Make full API URL configurable (not just API host).
- Fix version checking failing on old filesystems which are missing a `version` tag.

### v0.29.1

- Check the wnfs version field when initialising a filesystem and alert users about outdated filesystems or outdated apps.
- Make version mismatch errors configurable through `setup.userMessages(...)`.

### v0.29.0

- Upgrade js-ipfs libraries to the versions corresponding to the 0.58 release.
- Update API endpoints to v2 and add setup parameter to specify API version.
- No longer uses `ipfs-message-port-client` and `ipfs-message-port-protocol` forks which sometimes caused weird dependency conflicts.

### v0.28.1

- Fixed bundling issues with older bundlers, ie. bundlers that did not yet support the `exports` map in `package.json`.
- Switch from noble-ed25519 to tweetnacl. Tweetnacl has been audited and can be used in a wider range of environments.

### v0.28.0

- Added the `fs.addPublicExchangeKey()` function which adds the public exchange key of that domain/browser/device to your filesystem at `/public/.well-known/exchange/DID_KEY`. Along with the `fs.hasPublicExchangeKey()` to check if it's there.
- Made the login low more resilient. Should work better with extensions triggering `postMessage`s now.
- Updated keystore-idb to v0.15.0, which renamed `publicReadKey()` to `publicExchangeKey()` (among other functions). The read key-pair is now properly named the exchange key-pair.

### v0.27.0

- Fixed `webnative.apps.index()`, and now returns a list of domains, along with their `insertedAt` and `modifiedAt` ISO8601 timestamps.
- Fixed `webnative.apps.deleteByDomain()` so it aligns with backend changes.

### v0.26.2

- Add `extraLobbyParams` to `redirectToLobby`. Extra lobby params are transformed into query params that may be read by the auth lobby. (#273)

### v0.26.1

- Bring back the [UMD](https://github.com/umdjs/umd) build (#261)
- Bugfix: Internal `keystore-idb/*` imports were extensionless. Only some bundlers like esbuild and vite handle this fine. We added `*.js` extensions. (#265)

### v0.26.0

- Export maps, you can now import `webnative/path` instead of `webnative/dist/path`
- Move library files from `dist` to `lib`
- Use a better and faster build system
- Fix issues with `Buffer`
- `fs.write` on the public side now takes raw objects, arrays and numeric values as well
- Use the IPFS types from `ipfs-core`
- Switch from the borc library to cborg

### v0.25.2

Typescript output to `dist/` instead of `dist/src/`

### v0.25.1

Fix naming for minified UMD build

### v0.25.0

- Allow raw UCANs
- Expose functions for looking up stored UCANs
- Add function to look up user's root DID
- Default browser build to minified UMD
- Build CJS & ES5 for node

### v0.24.2

Fixed issue with browser detection, didn't work in web/service workers.

### v0.24.1

Fix a couple of bugs in dependency injection

### v0.24.0

- Dependency injection for crypto and storage functions to allow for use in Node.js
- Fix race condition in private tree that would occasionally drop filesystem nodes
- Improved path management (`webnative.path` module)
- Add support for Ed25519 & BLS DIDs
- Allow permissioning of files

### v0.23.2

Don't keep old UCANs around.

### v0.23.1

More detailed error message for NoPermissionError.

### v0.23.0

- **UCAN permission system and improved security**.
- Show alert when leaving the page while publishing changes, to avoid data loss.
- Fix issue with urls that were too long while redirecting back from the lobby.
- Better usage of the `Ucan` type in the UCAN functions.
- Data root update function returns `{ success }` boolean.
- Improved username validation

### v0.21.5

Fix regex of username validation and allow non-prefixed underscores in usernames.

### v0.21.4

Does not cancel data-root updates anymore, slightly increasing the performance of concurrent writes.

### v0.21.3

- IPFS connection and pinning improvements
- Don't show the "failed to update dnslink" debug message when cancelling a dnslink update

### v0.21.2

- `fs.mv` will no longer overwrite existing files, but instead throw an error.
- `initialise` will return a rejected Promise if the browser, or context, is not supported.
- DNSLink updated debug statement will no longer be shown if it failed to update.
- Hide iframe completely

### v0.21.1

Fix issue with `leave` function, `withoutRedirect` option should not be required.

### v0.21.0

Local IPFS data is shared across all browser tabs through the use of a shared web worker.

### v0.20.5

Adds the `read` and `write` methods to trees.

### v0.20.4

Fix `mv` issue.

### v0.20.3

Re-enable the `mv` filesystem function.

### v0.20.2

Fixed dependency loading issue.

### v0.20.1

Added versioning info to the README.

### v0.20.0

- Adds versioning
- Allows for concurrent filesystem operations

### v0.19.12

- Adds facts `fct` to the UCANs (v0.3.1)
- Update IPFS to v0.51.0

### v0.19.11

- Fixes `isUsernameAvailable` function (was broken due to adjusted `dataRoot.lookup` behaviour)
- Fixes issue with clearing data from browser.
- Tries reconnecting to Fission gateway if initial connection fails
- Removes `yarn` as a dependency (should've been devDependency)

### v0.19.10

Support the decoding of the url-safe base64 encoded read-key from the auth lobby.

### v0.19.9

The expiration timestamp of a UCAN cannot exceed that of its proof.

### v0.19.8

Bugfix: clear all data when using the `leave` function.

### v0.19.7

Bugfix: updates to files on public side were failing.

### v0.19.6

Bugfix: changes to public tree were not being reflected in pretty tree.

### v0.19.5

Don't error on failed pins.

### v0.19.2

Do not recursively pin content.

### v0.19.1

Permissions should be optional for `redirectToLobby` and `loadFileSystem` as well.

### v0.19

- Reliability & performance improvements
- Permissions are now optional

### v0.18.1

Added proofs to JWT for app routes (index, create & delete)

### v0.18.0

###### Breaking changes

- Renamed `publicise`/`publicize` to `publish`
- Renamed `prerequisites` to `permissions`
- The `app` and `fs` params to `initialise` are now grouped together by passing the `permissions` parameter.
- Decrypt `readKey` from auth lobby (behind the scenes)

### v0.17.3

Upgrade to js-ipfs v0.50

### v0.17.2

Connect to signaling server to find your other devices more easily.

### v0.17.1

Upgrade to CIDv1.

### v0.17

###### Changes

- `initialise` now accepts two additional options, named "prerequisites":

  ```javascript
  const { prerequisites, scenario, state } = await wn.initialise({
    // Will ask the user permission to store
    // your apps data in `private/Apps/Nullsoft/Winamp`
    app: {
      name: "Winamp",
      creator: "Nullsoft",
    },

    // Ask the user permission for additional filesystem paths
    fs: {
      privatePaths: ["Music"],
      publicPaths: ["Mixtapes"],
    },
  });
  ```

- Those prerequisites are passed to the `wn.redirectToLobby` function.
  (So the auth lobby has the correct parameters to determine the permissions to ask the user)
- Adds the ability to use multiple apps with one file system (closes #73)
- The SDK now handles multiple UCANs
- Works offline (fixes #82)
- Added `initialize` (american spelling) as an alias for `initialise`
- Adds ability to set the potency `ptc` of a UCAN
- Uses the Fission gateway as a [delegate node](https://github.com/ipfs/js-ipfs/blob/2b24f590041a0df9da87b75ae2344232fe22fe3a/docs/CONFIG.md#delegates)

###### Breaking changes

- File system actions (ie. POSIX interface methods) throw an error when they are missing the necessary permissions (read UCAN)
- Does no longer automatically call the `fs.publicise()` method. You have to call this yourself from now on.
- Changed the `fs.appPath` function (see README)
- Renamed `scenario.isAuthenticated` to `scenario.isAuthorised`
- Renamed `scenario.continuum` to `scenario.continuation`
- The first parameter to `redirectToLobby` has now become the second parameter.
- Replaced `deauthenticate` with `leave`, which now redirects to the auth lobby automatically, so you can "sign out" there as well.

### v0.16.x

- Fixed issue with private trees
- Improved connectivity
- Switched from AES-128 read keys to AES-256

### v0.16

- Big rewrite of filesystem
  - private side derives names using bloomfilters and stores nodes in an MMPT
  - reorganize header info on public side and store metadata/skeleton as cbor data
- Improved `fs.write` method, is an alias for `add` now (because `add` overwrites by default)
- Improved file system loading and saving

### v0.15

- Skipped because of a botched npm publish

### v0.14.3

- Added apps API `apps.create`, `apps.index`, `apps.deleteByURL`

### v0.14.2

- Improved DNSLink lookup error handling
- Reduced time-to-save for the file system to 3 seconds instead of 5
- Removed unnecessary `console.log` calls
- Updated default `js-ipfs` to `v0.48.1` (was `v0.48.0`)

### v0.14.1

Removed the default import from the index file. Now you use the SDK as follows, browser stays the same.

```js
import * as sdk from "fission-sdk";
import { initialise } from "fission-sdk";

sdk.initialise();
initialise();
```

### v0.14.0

- Renamed `isAuthenticated` to `initialise`
- `initialise` will return an instance of the file system (can be disabled in case you use web workers)
- Adds `loadFileSystem` to load a file system (called automatically from `initialise` unless disabled). This function is responsible for caching the file system locally and making a file system if the user hasn't got one yet.
- Adds the `fs.appPath.private` and `fs.appPath.public` function to build paths.
- Adds the `fs.exists`, `fs.read` and `fs.write` file system methods