Use uppercase letters as though I were a professional

Author: chee

readme.md

@@ -1,6 +1,6 @@
 # SolidJS primitives for Automerge Repo
 
-helpers for using <a href="https://automerge.org/docs/repositories/">
+Helpers for using <a href="https://automerge.org/docs/repositories/">
 <img alt="" src=.assets/automerge.png width=22 height=22>
 Automerge
 </a> with <a href="https://www.solidjs.com/">
@@ -11,24 +11,25 @@ SolidJS
 > [!note]
 >
 > This library targets `@automerge/automerge-repo@2` which is currently in
-> Alpha.
+> Alpha
 >
 > Changes adapting to breaking changes will be reflected as patch bumps in this
 > library, until `@automerge/automerge-repo@2` is stable.
 
 ```sh
+pnpm add @automerge/automerge-repo@next
 pnpm add automerge-repo-solid-primitives@next
 ```
 
 ## useDocument ✨
 
-get a fine-grained live view of an automerge document from its URL.
+Get a fine-grained live view of an automerge document from its URL.
 
-when the handle receives changes, it converts the incoming automerge patch ops
+When the handle receives changes, it converts the incoming automerge patch ops
 to precise solid store updates, giving you fine-grained reactivity that's
 consistent across space and time.
 
-returns `[doc, handle]`.
+Returns `[doc, handle]`.
 
 ```ts
 useDocument<T>(
@@ -46,55 +47,55 @@ const inc = () => handle()?.change(d => d.count++)
 return <button onclick={inc}>{doc()?.count}</button>
 ```
 
-the `{repo}` option can be left out if you are using [RepoContext](#repocontext).
+The `{repo}` option can be left out if you are using [RepoContext](#repocontext).
 
 ## createDocumentProjection
 
-get a fine-grained live view from a signal automerge handle.
+Get a fine-grained live view from a signal automerge handle.
 
-underlying primitive for [`useDocument`](#usedocument-).
+Underlying primitive for [`useDocument`](#usedocument-).
 
-works with [`useHandle`](#usehandle).
+Works with [`useHandle`](#usehandle).
 
 ```ts
 createDocumentProjection<T>(() => AutomergeUrl): Doc<T>
 ```
 
 ```tsx
 // example
-let handle = repo.find(url)
-let doc = makeDeepDocumentProjection<{items: {title: string}[]}>(handle)
+const handle = repo.find(url)
+const doc = makeDocumentProjection<{items: {title: string}[]}>(handle)
 
 // subscribes fine-grained to doc.items[1].title
 return <h1>{doc.items[1].title}</h1>
 ```
 
 ## makeDocumentProjection
 
-just like `useDocument`, but without a reactive input.
+Just like `createDocumentProjection`, but without a reactive input.
 
-underlying primitive for [`createDocumentProjection`](#createdocumentprojection).
+Underlying primitive for [`createDocumentProjection`](#createDocumentProjection).
 
 ```ts
-makeDeepDocumentProjection<T>(handle: Handle<T>): Doc<T>
+makeDocumentProjection<T>(handle: Handle<T>): Doc<T>
 ```
 
 ```tsx
 // example
-let handle = repo.find(url)
-let doc = makeDeepDocumentProjection<{items: {title: string}[]}>(handle)
+const handle = repo.find(url)
+const doc = makeDocumentProjection<{items: {title: string}[]}>(handle)
 
 // subscribes fine-grained to doc.items[1].title
 return <h1>{doc.items[1].title}</h1>
 ```
 
 ## useHandle
 
-get a [handle](https://automerge.org/docs/repositories/dochandles/) from the
+Get a [handle](https://automerge.org/docs/repositories/dochandles/) from the
 repo as a
 [resource](https://docs.solidjs.com/reference/basic-reactivity/create-resource).
 
-perfect for handing to `createDocumentProjection`.
+Perfect for handing to `createDocumentProjection`.
 
 ```ts
 useHandle<T>(
@@ -109,7 +110,7 @@ const handle = useHandle(id, {repo})
 const handle = useHandle(id)
 ```
 
-the `repo` option can be left out if you are using [RepoContext](#repocontext).
+The `repo` option can be left out if you are using [RepoContext](#repocontext).
 
 ## context
 

src/autoproduce.ts

@@ -10,7 +10,7 @@ import {apply, fromAutomerge} from "cabbages"
  * [Solid
  * Stores](https://docs.solidjs.com/reference/store-utilities/create-store)
  */
-export function autoproduce<T>(patches: Patch[]) {
+export default function autoproduce<T>(patches: Patch[]) {
 	return (doc: T) => {
 		for (let patch of patches) {
 			const [path, range, val] = fromAutomerge(patch)

src/context.ts

@@ -0,0 +1,9 @@
+import type {Repo} from "@automerge/automerge-repo"
+import {createContext} from "solid-js"
+
+/**
+ * a [context](https://docs.solidjs.com/concepts/context) that provides access
+ * to an Automerge Repo. you don't need this, you can pass the repo in the
+ * second arg to the functions that need it.
+ */
+export const RepoContext = createContext<Repo | null>(null)

src/create-document-projection.ts src/createDocumentProjection.tssrc/create-document-projection.ts renamed to src/createDocumentProjection.ts

@@ -1,6 +1,6 @@
 import {createMemo, type Accessor} from "solid-js"
 import {DocHandle, type Doc} from "@automerge/automerge-repo"
-import {makeDocumentProjection} from "./make-document-projection.js"
+import makeDocumentProjection from "./makeDocumentProjection.js"
 import {access} from "@solid-primitives/utils"
 
 /**
@@ -9,7 +9,7 @@ import {access} from "@solid-primitives/utils"
  * @param handle an accessor (signal/resource) of a
  * [DocHandle](https://automerge.org/automerge-repo/classes/_automerge_automerge_repo.DocHandle.html)
  */
-export function createDocumentProjection<T>(
+export default function createDocumentProjection<T>(
 	handle: Accessor<DocHandle<T> | undefined>
 ) {
 	const projection = createMemo<Doc<T> | undefined>(

src/index.ts

@@ -1,6 +1,7 @@
-export {autoproduce} from "./autoproduce.js"
-export {useDocument} from "./use-document.js"
-export {useHandle} from "./use-handle.js"
-export {makeDocumentProjection} from "./make-document-projection.js"
-export {createDocumentProjection} from "./create-document-projection.js"
-export {RepoContext, useRepo} from "./use-repo.js"
+export {default as autoproduce} from "./autoproduce.js"
+export {default as useDocument} from "./useDocument.js"
+export {default as useHandle} from "./useDocHandle.js"
+export {default as makeDocumentProjection} from "./makeDocumentProjection.js"
+export {default as createDocumentProjection} from "./createDocumentProjection.js"
+export {default as useRepo} from "./useRepo.js"
+export {RepoContext} from "./context.js"

src/make-document-projection.ts src/makeDocumentProjection.tssrc/make-document-projection.ts renamed to src/makeDocumentProjection.ts

@@ -1,6 +1,6 @@
 import {onCleanup} from "solid-js"
 import {Doc, DocHandle, DocHandleChangePayload} from "@automerge/automerge-repo"
-import {autoproduce} from "./autoproduce.js"
+import autoproduce from "./autoproduce.js"
 import {createStore, produce, reconcile, type Store} from "solid-js/store"
 
 const cache = new WeakMap<
@@ -17,7 +17,7 @@ const cache = new WeakMap<
  * @param handle an Automerge
  * [DocHandle](https://automerge.org/automerge-repo/classes/_automerge_automerge_repo.DocHandle.html)
  */
-export function makeDocumentProjection<T>(handle: DocHandle<T>) {
+export default function makeDocumentProjection<T>(handle: DocHandle<T>) {
 	onCleanup(() => {
 		const item = cache.get(handle)!
 		if (!item) return

src/types.ts

@@ -1,6 +1,6 @@
 import type {Repo} from "@automerge/automerge-repo"
 
-export interface UseHandleOptions {
+export interface UseDocHandleOptions {
 	repo?: Repo
 	// @internal
 	"~skipInitialValue"?: boolean

src/use-repo.ts

@@ -6,8 +6,8 @@ import {
 } from "@automerge/automerge-repo/slim"
 import {createEffect, createResource, useContext} from "solid-js"
 import {access, type MaybeAccessor} from "@solid-primitives/utils"
-import {RepoContext} from "./use-repo.js"
-import type {UseHandleOptions} from "./types.js"
+import {RepoContext} from "./context.js"
+import type {UseDocHandleOptions} from "./types.js"
 
 const readyStates = ["ready", "deleted", "unavailable"] as HandleState[]
 const badStates = ["deleted", "unavailable"] as HandleState[]
@@ -22,15 +22,16 @@ const badStates = ["deleted", "unavailable"] as HandleState[]
  * Waits for the handle to be
  * [ready](https://automerge.org/automerge-repo/variables/_automerge_automerge_repo.HandleState-1.html).
  */
-export function useHandle<T>(
+export default function useDocHandle<T>(
 	url: MaybeAccessor<AutomergeUrl | undefined>,
-	options?: UseHandleOptions
+	options?: UseDocHandleOptions
 ) {
 	const contextRepo = useContext(RepoContext)
 
 	if (!options?.repo && !contextRepo) {
 		throw new Error("use outside <RepoContext> requires options.repo")
 	}
+
 	const repo = (options?.repo || contextRepo)!
 
 	function getExistingHandle() {

src/use-handle.ts src/useDocHandle.tssrc/use-handle.ts renamed to src/useDocHandle.ts

@@ -3,20 +3,20 @@ import {
 	type Doc,
 	type DocHandle,
 } from "@automerge/automerge-repo"
-import {createDocumentProjection} from "./create-document-projection.js"
+import createDocumentProjection from "./createDocumentProjection.js"
 import type {MaybeAccessor} from "@solid-primitives/utils"
-import {useHandle} from "./use-handle.js"
-import type {UseHandleOptions} from "./types.js"
+import useDocHandle from "./useDocHandle.js"
+import type {UseDocHandleOptions} from "./types.js"
 import type {Accessor, Resource} from "solid-js"
 
 /**
  * get a fine-grained live view of a document, and its handle, from a URL.
  * @param url a function that returns a url
  */
-export function useDocument<T>(
+export default function useDoc<T>(
 	url: MaybeAccessor<AutomergeUrl | undefined>,
-	options?: UseHandleOptions
+	options?: UseDocHandleOptions
 ): [Accessor<Doc<T> | undefined>, Resource<DocHandle<T> | undefined>] {
-	const handle = useHandle<T>(url, options)
+	const handle = useDocHandle<T>(url, options)
 	return [createDocumentProjection<T>(handle), handle] as const
 }