I Shipped...

I proposed and launched an 'Advent of Jazz' initiative on our Discord. This PR adds a prominent link through a banner for December.

Previously, our analytics only captured successful search. This improvement allows us to track unsuccessful searches.

Normally, Jazz will throw if it cannot complete a resolve query as requested by the user (for example because the user doesn't have access to the data or it doesn't actually exist). Users can override this by specifying $onError: 'catch', which will instead return the rest of the query completed correctly with only the CoValue in question missing.

There was a bug in how this was implemented which I fixed.

We had some small issues with the new vanilla docs because the snippets were created before the big refactoring of code snippets was merged. This PR brought them in line with the framework specific snippets.

The Jazz docs have code examples that hide certain lines to keep things simple. In the Svelte permissions guide, a "hide this line" marker was only hiding the first line of a multi-line block of code, leaving extra lines visible that shouldn't have been shown. I fixed the formatting so the right lines are hidden.

Expo and React Native do not ship a TextDecoder implementation. This docs update explains how to polyfill for (huge) performance improvements in native apps.

In our docs, we have a hook which fetches the current framework, however, there were other bits of code around the codebase which do similar things, and the hook was becoming unwieldy and difficult to follow.

I refactored the useFramework hook to make it easier to use, and improve the separation of concerns on the homepage docs.

When a Jazz app is uninstalled, all data is deleted except the login credentials on iOS which are persisted to the keychain. This can cause issues if the account is not synced and the user reinstalls the app.

Jazz's documentation had a missing asterisk in a role permissions table, which meant a footnote reference wasn't displaying correctly. I added the missing character to fix the formatting.

The Jazz homepage stopped building after a recent change added a new dependency that made a previously-needed TypeScript workaround invalid. I removed the outdated workaround and added a proper type check, which got the homepage building and deploying again.

Users can create lists using Jazz, but there's no protection to stop users from inserting the same item multiple times into a CoList. For users wanting lists of unique items, I proposed and wrote up a pattern for using a CoRecord keyed on the CoValue ID.

We have an example chat app for all our supported frameworks. For our browser-based frameworks, this chat allows also uploading images to the chat, but our mobile apps did not.

I added the image upload functionality to the mobile framework examples.

Vercel's Workflow SDK helps you build long-running background tasks. SvelteKit (a web framework) generates a build folder called .svelte-kit that should be ignored by tools watching for file changes. I added it to the ignore list so the workflow SDK doesn't unnecessarily process those generated files.

Jazz is a framework for building collaborative apps. "Workflow World" is a Jazz feature that lets you run backend tasks and workflows. I wrote the documentation for it, covering how to get started, how to set up webhooks, and how to self-host it.

At some point, I introduced a regression that was causing our homepage docs to enter into a recursive navigation loop calling useEffect multiple times. This quick PR fixed it.

I was quite pleased with the PR title on this one: "...infinite recursion: a fix to prevent..."

Twoslash is a code-highlighting and type-checking plugin which helps to make sure all our code samples are kept up to date. Unfortunately though, it causes our build times to be very slow.

I extracted all of our code samples into separate files, and developed a new way of integrating them into our docs. This led to huge speed wins, bringing our build times down by around 5 minutes per build (on Vercel), roughly 14 hours of compute per month.

It also brought even more significant savings in terms of development. Where previously, it took me (M4 Macbook Pro) 110s to compile the docs in dev mode, now it takes 7s, a speed increase of 15×, making it much easier to develop our homepage and our docs overall.

The Jazz documentation had a page about codecs (tools for converting data between formats) that had become unlinked and unreachable from the navigation menu. I moved it under the "Schemas" section where it logically belongs and re-added the link so people can find it again.

Currently, Jazz stores secrets in localStorage. This is accessible by client-side JavaScript, and so any untrusted code running in a developers' app could allow the secret to be extracted. Although this is a required trade-off in order to avoid re-authenticating every single session, users are now warned about the risk of cross-site scripting, and advised to take steps to prevent it.

Jazz is a framework for building collaborative apps. It has various data types that developers use to build features, but one of them -- SingleCoFeedEntry -- wasn't being made available for outside use even though similar types were. I exported it so developers can actually use it in their own code.