wip typeguard etc

.gitignore

@@ -11,6 +11,7 @@ node_modules
 dist
 dist-ssr
 *.local
+docs
 
 # Editor directories and files
 .vscode/*

iris-docs/package.json

@@ -6,10 +6,9 @@
   "engine": "node >=18.0.0",
   "scripts": {
     "dev": "vite",
-    "build": "tsc && vite build && npm run docs",
+    "build": "tsc && vite build",
     "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "preview": "vite preview",
-    "docs": "typedoc --out dist/irisdb ../irisdb/index.ts",
     "test": "vitest"
   },
   "dependencies": {
@@ -48,7 +47,6 @@
     "daisyui": "^4.7.2",
     "jsdom": "^24.0.0",
     "postcss": "^8.4.35",
-    "tailwindcss": "^3.4.1",
-    "typedoc": "^0.25.12"
+    "tailwindcss": "^3.4.1"
   }
 }

iris-docs/src/pages/canvas/Canvas.tsx

@@ -1,5 +1,5 @@
 import { PlusIcon } from '@heroicons/react/24/solid';
-import { useLocalState } from 'irisdb/useNodeState';
+import { useLocalState } from 'irisdb';
 import { PublicKey } from 'irisdb-ndk/Hex/PublicKey';
 import publicState from 'irisdb-ndk/PublicState';
 import useAuthors from 'irisdb-ndk/useAuthors';

iris-docs/src/pages/canvas/index.tsx

@@ -1,6 +1,6 @@
+import { useLocalState } from 'irisdb';
 import { useParams } from 'react-router-dom';
 
-import { useLocalState } from 'irisdb/useNodeState';
 import Canvas from '@/pages/canvas/Canvas';
 import { FileList } from '@/shared/components/FileList';
 import LoginDialog from '@/shared/components/LoginDialog';

iris-docs/src/pages/document/Document.tsx

@@ -1,5 +1,5 @@
 import { bytesToHex, hexToBytes } from '@noble/hashes/utils';
-import { useLocalState } from 'irisdb/useNodeState';
+import { useLocalState } from 'irisdb';
 import { PublicKey } from 'irisdb-ndk/Hex/PublicKey';
 import publicState from 'irisdb-ndk/PublicState';
 import useAuthors from 'irisdb-ndk/useAuthors';

iris-docs/src/pages/document/index.tsx

@@ -1,6 +1,6 @@
+import { useLocalState } from 'irisdb';
 import { useParams } from 'react-router-dom';
 
-import { useLocalState } from 'irisdb/useNodeState';
 import Document from '@/pages/document/Document';
 import { FileList } from '@/shared/components/FileList';
 import LoginDialog from '@/shared/components/LoginDialog';

iris-docs/src/pages/explorer/Explorer.tsx

@@ -1,5 +1,5 @@
 import localState from 'irisdb/LocalState';
-import { useLocalState } from 'irisdb/useNodeState';
+import { useLocalState } from 'irisdb';
 import { PublicKey } from 'irisdb-ndk/Hex/PublicKey';
 import publicState from 'irisdb-ndk/PublicState';
 import { useParams } from 'react-router-dom';

iris-docs/src/pages/explorer/ExplorerNode.tsx

@@ -1,8 +1,8 @@
 import { ChevronRightIcon } from '@heroicons/react/20/solid';
-import { useEffect, useState } from 'react';
-
 import Node, { DIR_VALUE } from 'irisdb/Node';
 import { JsonValue } from 'irisdb/types';
+import { useEffect, useState } from 'react';
+
 import Show from '@/shared/components/Show';
 import { SortedMap } from '@/utils/SortedMap/SortedMap';
 

iris-docs/src/pages/explorer/ExplorerNodeEditRow.tsx

@@ -1,6 +1,5 @@
-import { ChangeEvent, FormEvent, useState } from 'react';
-
 import Node, { DIR_VALUE } from 'irisdb/Node';
+import { ChangeEvent, FormEvent, useState } from 'react';
 
 type EditRowProps = {
   level: number;

iris-docs/src/shared/components/FileList.tsx

@@ -1,6 +1,6 @@
 import { FolderIcon } from '@heroicons/react/24/outline';
 import { FolderOpenIcon, PlusIcon, TrashIcon, UserPlusIcon } from '@heroicons/react/24/solid';
-import { useLocalState } from 'irisdb/useNodeState';
+import { useLocalState } from 'irisdb';
 import { PublicKey } from 'irisdb-ndk/Hex/PublicKey';
 import publicState from 'irisdb-ndk/PublicState';
 import useAuthors from 'irisdb-ndk/useAuthors';

iris-docs/src/shared/components/LoginDialog.tsx

@@ -1,6 +1,6 @@
 import { hexToBytes } from '@noble/hashes/utils';
 import classNames from 'classnames';
-import { useLocalState } from 'irisdb/useNodeState';
+import { useLocalState } from 'irisdb';
 import { newUserLogin, privateKeyLogin } from 'irisdb-ndk/ndk';
 import { nip19 } from 'nostr-tools';
 import { ChangeEvent, FormEvent, useEffect, useState } from 'react';

iris-docs/src/shared/components/UserButton.tsx

@@ -1,12 +1,12 @@
+import { useLocalState } from 'irisdb';
 import { useCallback, useEffect, useRef } from 'react';
 
-import { useLocalState } from 'irisdb/useNodeState';
 import LoginDialog from '@/shared/components/LoginDialog';
 import Show from '@/shared/components/Show';
 import { Avatar } from '@/shared/components/user/Avatar';
 
 export default function UserButton() {
-  const [pubKey] = useLocalState('user/publicKey', '');
+  const [pubKey] = useLocalState('user/publicKey', '', String);
   const userModal = useRef<HTMLDialogElement>(null);
 
   const showModal = useCallback(() => {
@@ -19,7 +19,7 @@ export default function UserButton() {
 
   return (
     <>
-      <Show when={pubKey}>
+      <Show when={!!pubKey}>
         <div className="ml-2 rounded-full cursor-pointer" onClick={showModal}>
           <Avatar pubKey={pubKey} />
         </div>

iris-docs/src/shared/components/ViewingUsers.tsx

@@ -1,9 +1,8 @@
+import { useLocalState } from 'irisdb';
+import { PublicKey, publicState } from 'irisdb-ndk';
 import { useEffect, useState } from 'react';
 
-import publicState from 'irisdb-ndk/PublicState';
-import { useLocalState } from 'irisdb/useNodeState';
 import { Avatar } from '@/shared/components/user/Avatar';
-import { PublicKey } from 'irisdb-ndk/Hex/PublicKey';
 
 interface ViewingUsersProps {
   file: string;
@@ -50,7 +49,7 @@ export function ViewingUsers({ file, authors }: ViewingUsersProps) {
       publicState(authors.map((k) => new PublicKey(k)))
         .get(file)
         .get('viewing')
-        .get(myPubKey)
+        .get(String(myPubKey))
         .put(isViewing, undefined, expiresAt);
     };
     setViewing();

iris-docs/src/shared/components/share/AddUserForm.tsx

@@ -1,13 +1,13 @@
 import classNames from 'classnames';
-import { useLocalState } from 'irisdb/useNodeState';
+import { useLocalState } from 'irisdb';
 import { PublicKey } from 'irisdb-ndk/Hex/PublicKey';
 import publicState from 'irisdb-ndk/PublicState';
 import { FormEvent, useMemo, useState } from 'react';
 
 import { UserRow } from '@/shared/components/user/UserRow';
 
 export const AddUserForm = ({ file }: { file: string }) => {
-  const [myPubKey] = useLocalState('user/publicKey', '');
+  const [myPubKey] = useLocalState('user/publicKey', '', String);
   const [userToAdd, setUserToAdd] = useState('');
   const userToAddValid = useMemo(() => {
     if (userToAdd === myPubKey) return false;
@@ -22,7 +22,7 @@ export const AddUserForm = ({ file }: { file: string }) => {
   const onSubmit = (e: FormEvent) => {
     e.preventDefault();
     if (userToAddValid) {
-      publicState([myPubKey])
+      publicState([new PublicKey(myPubKey)])
         .get(`${file}/writers/${new PublicKey(userToAdd).toString()}`)
         .put(true);
       setUserToAdd('');

iris-docs/src/shared/components/share/FollowUserForm.tsx

@@ -1,5 +1,5 @@
 import classNames from 'classnames';
-import { useLocalState } from 'irisdb/useNodeState';
+import { useLocalState } from 'irisdb';
 import { PublicKey } from 'irisdb-ndk/Hex/PublicKey';
 import ndk from 'irisdb-ndk/ndk';
 import { FormEvent, useMemo, useState } from 'react';
@@ -22,7 +22,7 @@ export const FollowUserForm = () => {
   const onSubmit = (e: FormEvent) => {
     e.preventDefault();
     if (userToAddValid) {
-      const me = ndk.getUser({ pubkey: myPubKey });
+      const me = ndk.getUser({ pubkey: String(myPubKey) });
       const userToFollow = ndk.getUser({ pubkey: new PublicKey(userToAdd).toString() });
       me.follow(userToFollow);
       setUserToAdd('');

iris-docs/src/shared/components/share/ShareMenuModal.tsx

@@ -1,4 +1,4 @@
-import { useLocalState } from 'irisdb/useNodeState';
+import { useLocalState } from 'irisdb';
 import { PublicKey } from 'irisdb-ndk/Hex/PublicKey';
 import { nip19 } from 'nostr-tools';
 import { RefObject, useMemo } from 'react';
@@ -19,7 +19,7 @@ export function ShareMenuModal({
 }) {
   const user = useSearchParam('user', 'follows');
   const [myPubKey] = useLocalState('user/publicKey', '');
-  const myNpub = useMemo(() => nip19.npubEncode(myPubKey), [myPubKey]);
+  const myNpub = useMemo(() => nip19.npubEncode(String(myPubKey)), [myPubKey]);
   const userPublicKey = useMemo(() => {
     if (!user || user === 'follows') return;
     return new PublicKey(user);

iris-docs/src/shared/components/share/WriteAccessUsers.tsx

@@ -1,5 +1,5 @@
 import { TrashIcon } from '@heroicons/react/24/solid';
-import { useLocalState } from 'irisdb/useNodeState';
+import { useLocalState } from 'irisdb';
 import { PublicKey } from 'irisdb-ndk/Hex/PublicKey';
 import publicState from 'irisdb-ndk/PublicState';
 import useAuthors from 'irisdb-ndk/useAuthors';
@@ -62,7 +62,7 @@ export const WriteAccessUsers = ({ user, isMine, file }: WriteAccessUsersProps)
                 className="btn btn-circle btn-sm btn-outline"
                 type="button"
                 onClick={() => {
-                  publicState([new PublicKey(myPubKey)])
+                  publicState([new PublicKey(String(myPubKey))])
                     .get(`${file}/writers/${pubKey}`)
                     .put(false);
                 }}

irisdb-ndk/Hex/Hex.test.ts

@@ -1,6 +1,5 @@
-import { describe, expect, it } from 'vitest';
-
 import { EventID, PublicKey } from 'irisdb-ndk/Hex/Hex';
+import { describe, expect, it } from 'vitest';
 
 describe('PublicKey', () => {
   it('should convert npub bech32 to hex', () => {

irisdb-ndk/NDKAdapter.ts

@@ -1,6 +1,6 @@
 import NDK, { NDKEvent, NostrEvent } from '@nostr-dev-kit/ndk';
 import debug from 'debug';
-import { Adapter, Callback, NodeValue, Unsubscribe } from 'irisdb/types';
+import { Adapter, Callback, NodeValue, Unsubscribe } from 'irisdb';
 
 import { PublicKey } from './Hex/PublicKey';
 

irisdb-ndk/PublicState.ts

@@ -1,7 +1,6 @@
-import MemoryAdapter from 'irisdb/adapters/MemoryAdapter';
+import { MemoryAdapter, Node } from 'irisdb';
 import { PublicKey } from 'irisdb-ndk/Hex/PublicKey';
 
-import Node from '../irisdb/Node';
 import ndk from './ndk';
 import NDKAdapter from './NDKAdapter';
 

irisdb-ndk/index.ts

@@ -0,0 +1,6 @@
+export { EventID } from './Hex/EventID';
+export { Hex } from './Hex/Hex';
+export { PublicKey } from './Hex/PublicKey';
+export { default as NDKAdapter } from './NDKAdapter';
+export { default as publicState } from './PublicState';
+export { default as useAuthors } from './useAuthors';

irisdb-ndk/ndk.ts

@@ -2,10 +2,9 @@ import { bytesToHex, hexToBytes } from '@noble/hashes/utils';
 import NDK, { NDKNip07Signer, NDKPrivateKeySigner } from '@nostr-dev-kit/ndk';
 import { NDKEvent } from '@nostr-dev-kit/ndk';
 import NDKCacheAdapterDexie from '@nostr-dev-kit/ndk-cache-dexie';
+import { localState } from 'irisdb';
 import { generateSecretKey, getPublicKey, nip19 } from 'nostr-tools';
 
-import localState from 'irisdb/LocalState';
-
 const dexieAdapter = new NDKCacheAdapterDexie({ dbName: 'nostree-db' });
 
 const ndk = new NDK({

irisdb-ndk/useAuthors.ts

@@ -1,5 +1,5 @@
 import { NDKTag } from '@nostr-dev-kit/ndk';
-import { useLocalState } from 'irisdb/useNodeState';
+import { useLocalState } from 'irisdb';
 import { Hex } from 'irisdb-ndk/Hex/Hex';
 import { PublicKey } from 'irisdb-ndk/Hex/PublicKey';
 import publicState from 'irisdb-ndk/PublicState';
@@ -9,10 +9,10 @@ import ndk from './ndk';
 
 export default function useAuthors(ownerOrGroup?: string, groupPath?: string): string[] {
   const [myPubKey] = useLocalState('user/publicKey', '');
-  const initialAuthors = useMemo(() => {
+  const initialAuthors = useMemo((): string[] => {
     if (!ownerOrGroup) return [];
     if (ownerOrGroup === 'follows') {
-      return myPubKey ? [myPubKey] : [];
+      return myPubKey ? [String(myPubKey)] : [];
     } else {
       const k = new PublicKey(ownerOrGroup);
       return [k.toString()];
@@ -22,10 +22,10 @@ export default function useAuthors(ownerOrGroup?: string, groupPath?: string): s
 
   useEffect(() => {
     if (ownerOrGroup === 'follows') {
-      const sub = ndk.subscribe({ kinds: [3], authors: [myPubKey] });
+      const sub = ndk.subscribe({ kinds: [3], authors: [String(myPubKey)] });
       sub.on('event', (event) => {
         if (event.kind === 3) {
-          const newAuthors = new Set([myPubKey]);
+          const newAuthors = new Set([String(myPubKey)]);
           let updated = false;
           event.tags.forEach((tag: NDKTag) => {
             if (tag[0] === 'p') {

irisdb/package.json

@@ -1,10 +1,12 @@
 {
   "name": "irisdb",
   "version": "1.0.0",
+  "type": "module",
   "description": "object-like data structure that can be subscribed to and easily synced over different transports",
-  "main": "index.ts",
+  "main": "src/index.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "docs": "typedoc --out docs ./src/index.ts"
   },
   "repository": {
     "type": "git",
@@ -15,5 +17,8 @@
   "bugs": {
     "url": "https://github.com/irislib/iris-docs/issues"
   },
-  "homepage": "https://github.com/irislib/iris/iris-docs"
+  "homepage": "https://github.com/irislib/iris/iris-docs",
+  "dependencies": {
+    "typedoc": "^0.25.12"
+  }
 }

irisdb/src/LocalState.ts

@@ -0,0 +1,11 @@
+import BroadcastChannelAdapter from './adapters/BroadcastChannelAdapter';
+import LocalStorageMemoryAdapter from './adapters/LocalStorageMemoryAdapter';
+import Node from './Node';
+
+const NAME = 'localState';
+const localState = new Node({
+  id: NAME,
+  adapters: [new LocalStorageMemoryAdapter(), new BroadcastChannelAdapter(NAME)],
+});
+
+export { localState };

irisdb/Node.test.ts → irisdb/src/Node.test.ts

@@ -1,8 +1,6 @@
+import { Callback, MemoryAdapter, Unsubscribe } from 'irisdb';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 
-import MemoryAdapter from 'irisdb/adapters/MemoryAdapter';
-import { Callback, Unsubscribe } from 'irisdb/types';
-
 import Node, { DIR_VALUE } from './Node';
 
 describe('Node', () => {