@seedprotocol/sdk 0.1.59 → 0.1.61

package/README.md

@@ -1,19 +1,22 @@
-# [WIP] Seed Protocol SDK
+# Seed Protocol SDK
 
-This API is a work in progress. It is not yet ready for production use. These docs are for keeping the community
-informed
-and generating feedback.
+The official SDK for [Seed Protocol](https://seedprotocol.io/).
 
-## Current research questions
+The SDK is a heavily opinionated ORM that saves its database (SQLite) and files (OPFS) within the user's browser. All
+user data
+is fetched from, or written to, the Ethereum Attestation Service (EAS) and Arweave (More attestation services
+and decentralized storage providers will be supported in the future).
 
-- Can we use TypeORM backed by Sqlite Wasm for more performant and future-proof storage?
-    - Track this research here: [TypeORM Sqlite Wasm](https://github.com/JournoDAO/typeorm-sqlite-wasm)
-- What would the tooling look like to allow export of data model as ProtoBuf and/or JSON Schema?
-    - Looking at [ts-proto](https://github.com/stephenh/ts-proto) for Typescript
+With all the remote storage on decentralized, public infrastructure, there's no server component to manage or rely on.
 
-## Installing
+The hope is that this local-first and distributed approach will make it easier for developers to build apps with Seed
+Protocol
+without ever custodying user data on their own infrastructure.
+
+The SDK is currently used and developed by [PermaPress](https://permapress.xyz), the first client for Seed Protocol.
+PermaPress is a product developed by JournoLabs (formerly JournoDAO).
 
-This package is not yet published to npm, but when it is, this will be the command to install it:
+## Installing
 
 ```bash
 yarn add @seedprotocol/sdk
@@ -21,47 +24,65 @@ yarn add @seedprotocol/sdk
 
 ## Getting Started
 
-The first thing to do when integrating Seed SDK is define you data model.
+The first thing to do when integrating Seed SDK is define your data model by placing a `schema.ts` file in the root
+of your project.
 
-For example, let's pretend we're creating a blog that uses Seed Protocol as its content store. We start by defining
-our `Models`, their `Properties`, and what type of data each `Property` is expecting.
+As an example, here's the actual data model for PermaPress:
 
 ```typescript=
-import {Model, Property, List, createStore} from '@seedprotocol/sdk'
-
-
-const Image = Model({
-      storageTransactionId: Property.String(),
-      uri: Property.String(),
-      alt: Property.String(),
-    },)
-
-const Link = Model({
-  url: Property.String(),
-  text: Property.String(),
-},)
-
-const Identity = Model({
-  name: Property.String(),
-  bio: Property.String(),
-  avatarImage: Image,
-},)
-
-const Post = Model({
-  title: Property.String(),
-  summary: Property.String(),
-  featureImage: Image,
-  html: Property.String(),
-  json: Property.String(),
-  authors: Property.List(Identity,),
-},)
-
-createStore({
+import { ImageSrc, List, Model, Relation, Text } from '@/browser/schema'
+
+@Model
+class Image {
+  @Text() storageTransactionId!: string
+  @Text() uri!: string
+  @Text() alt!: string
+  @ImageSrc() src!: string
+}
+
+@Model
+class Post {
+  @Text() title!: string
+  @Text() summary!: string
+  @Relation('Image', 'ImageSrc') featureImage!: string
+  @Text('ItemStorage', '/html', '.html') html!: string
+  @Text('ItemStorage', '/json', '.json') json!: string
+  @Text() storageTransactionId!: string
+  @List('Identity') authors!: string[]
+  @Text() importUrl!: string
+}
+
+@Model
+class Identity {
+  @Text() name!: string
+  @Text() profile!: string
+  @Text() displayName!: string
+  @Relation('Image', 'ImageSrc') avatarImage!: string
+  @Relation('Image', 'ImageSrc') coverImage!: string
+}
+
+@Model
+class Link {
+  @Text() url!: string
+  @Text() text!: string
+}
+
+const models = {
   Identity,
   Image,
   Link,
   Post,
-},)
+}
+
+const endpoints = {
+  filePaths: '/api/seed/migrations',
+  files: '/app-files',
+}
+
+export { models, endpoints }
+
+export default { models, endpoints }
+
 ```
 
 This will create a database locally in the browser with all the tables and fields necessary to support your Models. Feel

package/dist/{index-RCrXtjiO.js → index-BBcjMsIh.js}

@@ -989,7 +989,7 @@ const hydrateFromDb = fromCallback(({ sendBack, input: { context } }) => {
         if (propertyRecordSchema &&
             propertyRecordSchema.storageType &&
             propertyRecordSchema.storageType === 'ItemStorage') {
-            const { Item } = yield import('./index-C_WqqX4v.js');
+            const { Item } = yield import('./index-tV-MoWhc.js');
             const item = yield Item.find({
                 seedLocalId,
                 modelName: itemModelName,
@@ -2877,7 +2877,7 @@ const addModelsToDb = fromCallback(({ sendBack, input: { context } }) => {
         if (!models$1) {
             return;
         }
-        const { models: SeedModels } = yield import('./seed.schema.config-BH9Kq1yX.js');
+        const { models: SeedModels } = yield import('./seed.schema.config-BkdBBwUC.js');
         const allModels = Object.assign(Object.assign({}, SeedModels), models$1);
         let hasModelsInDb = false;
         const schemaDefsByModelName = new Map();
@@ -6334,16 +6334,6 @@ const getServiceUniqueKey = (service) => {
     }
     return uniqueKey;
 };
-const useIsDbReady = () => {
-    const [isDbReady, setIsDbReady] = useState(false);
-    const { internalStatus } = useGlobalServiceStatus();
-    useEffect(() => {
-        if (internalStatus === 'ready') {
-            setIsDbReady(true);
-        }
-    }, [internalStatus]);
-    return isDbReady;
-};
 const useServices = () => {
     const [actors, setActors] = useState([]);
     const [percentComplete, setPercentComplete] = useState(5);
@@ -6461,6 +6451,7 @@ const useItem = ({ modelName, seedLocalId, seedUid }) => {
         });
         if (!foundItem) {
             logger$2('[useItem] [getItemFromDb] no item found', modelName, seedLocalId);
+            isReadingDb.current = false;
             return;
         }
         setItem(foundItem);
@@ -6510,35 +6501,39 @@ const useItem = ({ modelName, seedLocalId, seedUid }) => {
 };
 const useItems = ({ modelName, deleted }) => {
     const [items, setItems] = useImmer([]);
-    const [isReadingDb, setIsReadingDb] = useState(false);
-    const [isInitialized, setIsInitialized] = useState(false);
-    const isDbReady = useIsDbReady();
+    const { status, internalStatus } = useGlobalServiceStatus();
     const modelNameRef = useRef(modelName);
-    const readFromDb = useCallback((event) => __awaiter(void 0, void 0, void 0, function* () {
-        if (!event ||
-            !event.modelName ||
-            event.modelName !== modelNameRef.current ||
-            isReadingDb) {
+    const isReadingDb = useRef(false);
+    const readFromDb = useCallback(() => __awaiter(void 0, void 0, void 0, function* () {
+        if (isReadingDb.current || internalStatus !== 'ready') {
             return;
         }
-        setIsReadingDb(true);
+        isReadingDb.current = true;
         const allItems = yield Item.all(modelNameRef.current, deleted);
+        setItems(() => []);
         setItems(() => allItems);
-        setIsReadingDb(false);
-    }), [modelName, isReadingDb]);
+        isReadingDb.current = false;
+    }), [internalStatus]);
+    const listenerRef = useRef(readFromDb);
     useEffect(() => {
-        if (isDbReady && !isInitialized) {
-            const _fetchItems = () => __awaiter(void 0, void 0, void 0, function* () {
-                yield readFromDb({ modelName });
-                setIsInitialized(true);
-            });
-            _fetchItems();
+        listenerRef.current = readFromDb;
+    }, [readFromDb]);
+    useEffect(() => {
+        if (internalStatus === 'ready') {
+            listenerRef.current();
         }
-    }, [isInitialized, isDbReady]);
+    }, [internalStatus, status]);
     useEffect(() => {
-        eventEmitter.addListener('item.requestAll', readFromDb);
+        eventEmitter.addListener('item.requestAll', (event) => {
+            if (!event ||
+                !event.modelName ||
+                event.modelName !== modelNameRef.current) {
+                return;
+            }
+            listenerRef.current();
+        });
         return () => {
-            eventEmitter.removeListener('item.requestAll');
+            eventEmitter.removeListener('item.requestAll', readFromDb);
         };
     }, []);
     return {
@@ -6548,7 +6543,6 @@ const useItems = ({ modelName, deleted }) => {
                 item.createdAt,
         ], ['desc']).slice(0, 10),
         isReadingDb,
-        isInitialized,
     };
 };
 const useItemIsReady = () => {
@@ -6774,7 +6768,7 @@ const client = {
             console.error('fs listeners not ready during init');
         }
         globalService.send({ type: 'init', endpoints, models, addresses });
-        import('./seed.schema.config-BH9Kq1yX.js').then(({ models }) => {
+        import('./seed.schema.config-BkdBBwUC.js').then(({ models }) => {
             for (const [key, value] of Object.entries(models)) {
                 setModel(key, value);
             }
@@ -7347,4 +7341,4 @@ if (isNode()) {
 }
 
 export { GET_SCHEMAS as G, Item as I, Json as J, List as L, Model as M, Property as P, Relation as R, Text as T, GET_SEEDS as a, GET_SEED_IDS as b, GET_STORAGE_TRANSACTION_ID as c, GET_VERSIONS as d, GET_PROPERTIES as e, GET_ALL_PROPERTIES_FOR_ALL_VERSIONS as f, itemMachineAll as g, ImageSrc as h, itemMachineSingle as i, ItemProperty as j, useItem as k, useItemProperties as l, useCreateItem as m, useItemProperty as n, useDeleteItem as o, useGlobalServiceStatus as p, useServices as q, getGlobalService as r, client as s, getCorrectId as t, useItems as u, withSeed as w };
-//# sourceMappingURL=index-RCrXtjiO.js.map
+//# sourceMappingURL=index-BBcjMsIh.js.map