@automerge/automerge-repo-solid-primitives 2.2.0

package/.github/workflows/tests.yml

@@ -0,0 +1,28 @@
+name: run our tests
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [22.x]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "pnpm"
+      - run: pnpm install
+      - run: pnpm mk
+      - run: pnpm t

package/.github/workflows/typedoc.yml

@@ -0,0 +1,53 @@
+name: Deploy typedoc to pages
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: "pnpm"
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Install dependencies
+        run: pnpm install
+      - name: Build
+        run: pnpm typedoc
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2025, Ink & Switch LLC
+Copyright (c) 2024, chee
+Copyright (c) 2019-2023, Ink & Switch LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/autoproduce.d.ts

@@ -0,0 +1,13 @@
+import { DocHandleChangePayload } from '@automerge/automerge-repo/slim';
+
+/**
+ * convert automerge patches to solid producer operations
+ * @param payload the
+ * [DocHandleChangePayload](https://automerge.org/automerge-repo/interfaces/_automerge_automerge_repo.DocHandleChangePayload.html)
+ * from the handle.on("change
+ * @returns a callback for an immer-like function. e.g.
+ * [produce](https://docs.solidjs.com/reference/store-utilities/produce) for
+ * [Solid
+ * Stores](https://docs.solidjs.com/reference/store-utilities/create-store)
+ */
+export default function autoproduce<T>(payload: DocHandleChangePayload<T>): (doc: T) => void;

package/dist/context.d.ts

@@ -0,0 +1,9 @@
+import { Repo } from '@automerge/automerge-repo/slim';
+import { Context } 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 declare const RepoContext: Context<Repo | null>;

package/dist/createDocumentProjection.d.ts

@@ -0,0 +1,10 @@
+import { Accessor } from 'solid-js';
+import { DocHandle, Doc } from '@automerge/automerge-repo/slim';
+
+/**
+ * get a fine-grained live view of a document from a handle. works with
+ * {@link useDocHandle}.
+ * @param handle an accessor (signal/resource) of a
+ * [DocHandle](https://automerge.org/automerge-repo/classes/_automerge_automerge_repo.DocHandle.html)
+ */
+export default function createDocumentProjection<T extends object>(handle: Accessor<DocHandle<T> | undefined>): Accessor<Doc<T> | undefined>;

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export { default as autoproduce } from './autoproduce.js';
+export { default as useDocument } from './useDocument.js';
+export { default as useDocHandle } 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';