generate api pages

Author: ramfox

readme.md

@@ -21,10 +21,10 @@ Finally, open [http://localhost:3000](http://localhost:3000) in your browser to
 ## Editing docs content
 Our docs are generated. Use the following steps to make adjustments to the content and update the website to match:
 
-- make your edits to the documentation in the `command-code-examples/commands.mjs` file
+- make your edits to the documentation in the `api-code-examples/api.mjs` file
 - cd into the `scripts` folder
 - run `npm install` if you have not run it in this folder previously
-- run `node generate-commands-pages.js` to generate the doc files for the website
+- run `node generate-api-pages.js` to generate the doc files for the website
 
 ### Style / grammar guide
 Follow the style that has already been layed out. But as a general rule of thumb, follow normal English punctuation, but favor brevity over proper grammar. In other words, use capital letters at the start of sentences, and end them with a period, but sentences can be fragments if that gets the point across quicker.

src/app/docs/api/author-list/page.mdx

@@ -30,17 +30,24 @@ wkl4cgrykxvcvr6pjnbvymrzm7h4je7d4ztszp35xfnk2rnflcxq
 ```python {{ title: 'python' }}
 import iroh
 
-IROH_DATA_DIR = "./iroh-data"
+IROH_DATA_DIR = "./iroh_data_dir"
 
 node = iroh.IrohNode(IROH_DATA_DIR)
 print("Started Iroh node: {}".format(node.node_id()))
 
-author = node.author_new()
+author = node.author_create()
 print("Created author: {}".format(author.to_string()))
 
 authors = node.author_list()
+print("Authors:")
 for auth in authors:
-    print("Author: {}".format(auth.to_string()))
+    print("\t{}".format(auth.to_string()))
+
+# Output:
+# Started Iroh node: wbwpkauwmitrwwhmw534w3u6sxyhvbivuepcdze5jd3zeqpgxyfa
+# Created author: z2h3f3tozgz67g3ewvu7yxj5vtoddwoohzi2jgyrtgfl7tzocpda
+# Authors:
+#   z2h3f3tozgz67g3ewvu7yxj5vtoddwoohzi2jgyrtgfl7tzocpd
 
 ```
 
@@ -50,26 +57,29 @@ package main
 import (
 	"fmt"
 
-	"github.com/n0-computer/iroh-ffi/iroh"
+	"github.com/n0-computer/iroh-ffi/iroh-go/iroh"
 )
 
 func main() {
-	node, err := iroh.NewIrohNode()
+	node, err := iroh.NewIrohNode("iroh_data_dir")
 	if err != nil {
 		panic(err)
 	}
 
-	if _, err := node.AuthorNew(); err != nil {
+	author, err := node.AuthorCreate()
+	if err != nil {
 		panic(err)
 	}
+	fmt.Println("Created author:", author.ToString())
 
 	authors, err := node.AuthorList()
 	if err != nil {
 		panic(err)
 	}
 
+	fmt.Println("Authors:")
 	for _, author := range authors {
-		fmt.Println(author.ToString())
+		fmt.Println("\t", author.ToString())
 	}
 }
 

src/app/docs/api/author-new/page.mdx

@@ -40,12 +40,12 @@ author:2rkuvpk4…
 ```python {{ title: 'python' }}
 import iroh
 
-IROH_DATA_DIR = "./iroh-data"
+IROH_DATA_DIR = "./iroh_data_dir"
 
 node = iroh.IrohNode(IROH_DATA_DIR)
 print("Started Iroh node: {}".format(node.node_id()))
 
-author = node.author_new()
+author = node.author_create()
 print("Created author: {}".format(author.to_string()))
 
 ```
@@ -56,16 +56,16 @@ package main
 import (
 	"fmt"
 
-	"github.com/n0-computer/iroh-ffi/iroh"
+	"github.com/n0-computer/iroh-ffi/iroh-go/iroh"
 )
 
 func main() {
-	node, err := iroh.NewIrohNode()
+	node, err := iroh.NewIrohNode("iroh_data_dir")
 	if err != nil {
 		panic(err)
 	}
 
-	author, err := node.AuthorNew()
+	author, err := node.AuthorCreate()
 	if err != nil {
 		panic(err)
 	}

src/app/docs/api/blob-add/page.mdx

@@ -38,5 +38,247 @@ Total: 328 B
 Collection: bafkr4ie3xsx3vdsbflainnk6p4xs4h2hq3hdmuasuoflkgybvnsbljb3ke
 ```
 
+```python {{ title: 'python' }}
+import os
+import sys
+import threading
+import time
+import shutil
+import datetime
+from iroh import IrohNode, SetTagOption, WrapOption, AddProgressType
+
+class AddCallback:
+    def progress(self, event):
+        t = event.type()
+        if t == AddProgressType.FOUND:
+            print("AddProgress - Found:")
+            found = event.as_found()
+            print(f"\tid: {found.id}, name: {found.name}, size: {found.size}")
+        elif t == AddProgressType.PROGRESS:
+            print("AddProgress - Progress:")
+            progress = event.as_progress()
+            print(f"\tid: {progress.id}, offset: {progress.offset}")
+        elif t == AddProgressType.DONE:
+            print("AddProgress - Done:")
+            done = event.as_done()
+            print(f"\tid: {done.id}, hash: {done.hash.to_string()}")
+        elif t == AddProgressType.ALL_DONE:
+            print("AddProgress - AllDone:")
+            all_done = event.as_all_done()
+            print(f"\thash: {all_done.hash.to_string()}, format: {all_done.format}, tag: {all_done.tag.to_string()}")
+        elif t == AddProgressType.ABORT:
+            print("AddProgress - Abort:")
+            abort = event.as_abort()
+            print(f"\terror: {abort.error}")
+        else:
+            print("Unknown AddProgress event:", event)
+
+# Create folder
+os.mkdir("tmp")
+
+try:
+    path = os.path.abspath(os.path.join("tmp"))
+    print("Created dir \"tmp\"")
+
+    file_names = ["foo", "bar", "bat"]
+
+    # Create three files in the folder
+    for file_name in file_names:
+        file_path = os.path.join("tmp", file_name)
+        with open(file_path, "w") as f:
+            f.write(f"{file_name}")
+        print(f"Created file {file_path}")
+
+    node = IrohNode("iroh_data_dir")
+
+    # When `in_place` is True, iroh will NOT copy over the files into its
+    # internal database. Only use this option when you know the file will never
+    # move or change.
+    in_place = False
+
+    # Iroh blobs can be "tagged" with human-readable names, this creates a tag
+    # automatically.
+    tag = SetTagOption.auto()
+
+    # When adding a single file, if you use `WrapOption.wrap()`, you will turn
+    # the single file into a collection with one entry.
+    wrap = WrapOption.no_wrap()
+
+    # You can use this callback to react to progress updates.
+    callback = AddCallback()
+
+    # Import the directory, creating one blob for each file, and one metadata
+    # blob that stores the file names for each blob.
+    # Also creates a 'collection' from the directory, grouping together the
+    # blobs.
+
+    node.blobs_add_from_path(path, in_place, tag, wrap, callback)
+except Exception as e:
+    print("error: ", e)
+
+# cleanup dir
+shutil.rmtree("tmp")
+
+# Output:
+# Created dir "tmp"
+# Created file tmp/foo
+# Created file tmp/bar
+# Created file tmp/bat
+# AddProgress - Found:
+# 	id: 1, name: $HOME/tmp/bar, size: 3
+# AddProgress - Found:
+# 	id: 0, name: $HOME/tmp/foo, size: 3
+# AddProgress - Found:
+# 	id: 2, name: $HOME/tmp/bat, size: 3
+# AddProgress - Progress:
+# 	id: 2, offset: 3
+# AddProgress - Progress:
+# 	id: 0, offset: 3
+# AddProgress - Done:
+# 	id: 0, hash: bafkr4iae4c5tt4yldi76xcpvg3etxykqkvec352im5fqbutolj2xo5yc5e
+# AddProgress - Done:
+# 	id: 2, hash: bafkr4iabccdb2eyeu764xoewbcqv62sjaggxibtmxx5tnmwer3wp3rquq4
+# AddProgress - Progress:
+# 	id: 1, offset: 3
+# AddProgress - Done:
+# 	id: 1, hash: bafkr4ihs5cl65v6sa3gykxkecwmpuuq2xr22vfuvh2l4amgjmewdbqjjhu
+# AddProgress - AllDone:
+# 	hash: bafkr4iaotzhxuiak7eusnngngnwsqdu4crf4lmdxzkbhuebunevecjzkim, format: BlobFormat.HASH_SEQ, tag: "auto-2023-12-09T22:25:45.296Z"
+
+```
+
+```swift {{ title: 'go' }}
+package main
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/n0-computer/iroh-ffi/iroh-go/iroh"
+)
+
+type addCallback struct {
+}
+
+func (a addCallback) Progress(event *iroh.AddProgress) *iroh.IrohError {
+	switch t := event.Type(); t {
+	case iroh.AddProgressTypeFound:
+		fmt.Println("AddProgress - Found:")
+		found := event.AsFound()
+		fmt.Printf("\tid: %d, name: %s, size: %d\n", found.Id, found.Name, found.Size)
+	case iroh.AddProgressTypeProgress:
+		fmt.Println("AddProgress - Progress:")
+		progress := event.AsProgress()
+		fmt.Printf("\tid: %d, offset: %d\n", progress.Id, progress.Offset)
+	case iroh.AddProgressTypeDone:
+		fmt.Println("AddProgress - Done:")
+		done := event.AsDone()
+		fmt.Printf("\tid: %d, hash: %s\n", done.Id, done.Hash.ToString())
+	case iroh.AddProgressTypeAllDone:
+		fmt.Println("AddProgress - AllDone:")
+		allDone := event.AsAllDone()
+		fmt.Printf("\thash: %s, format: %v, tag: %s\n", allDone.Hash.ToString(), allDone.Format, allDone.Tag.ToString())
+	case iroh.AddProgressTypeAbort:
+		fmt.Println("AddProgress - Abort:")
+		abort := event.AsAbort()
+		fmt.Printf("\terror: %s", abort.Error)
+	default:
+		fmt.Println("Unknown AddProgress event: %v", event)
+		return &iroh.IrohError{}
+	}
+	return nil
+}
+
+func main() {
+	// create folder
+	if err := os.Mkdir("tmp", os.ModePerm); err != nil {
+		panic(err)
+	}
+	defer func() {
+		os.RemoveAll("tmp")
+		fmt.Println("Removed dir 'tmp'")
+	}()
+
+	path, err := filepath.Abs(filepath.Join("tmp"))
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println("Created dir \"tmp\"")
+
+	fileNames := []string{"foo", "bar", "bat"}
+	// create three files in the folder
+	for _, fileName := range fileNames {
+		path := filepath.Join("tmp", fileName)
+		f, err := os.Create(path)
+		if err != nil {
+			panic(err)
+		}
+		_, err = f.WriteString(fmt.Sprintf("%s", fileName))
+		if err != nil {
+			panic(err)
+		}
+		fmt.Printf("Created file %q\n", path)
+	}
+
+	node, err := iroh.NewIrohNode("iroh_data_dir")
+	if err != nil {
+		panic(err)
+	}
+
+	// when `inPlace` is true, iroh will NOT copy over the files into its
+	// internal database. Only use this option when you know the file will never
+	// move or change
+	inPlace := false
+	// iroh blobs can be "tagged" with human readable names, this creates a tag
+	// automatically
+	tag := iroh.SetTagOptionAuto()
+	// when adding a single file, if you use `iroh.WrapOptionWrap`, you will turn
+	// the single file into a collection with one entry
+	wrap := iroh.WrapOptionNoWrap()
+	// you can use this callback to react to progress updates
+	callback := addCallback{}
+
+	// import the directory, creating one blob for each file, and one metadata
+	// blob that stores the file names for each blob
+	// also creates a 'collection' from the directory, grouping together the
+	// blobs
+
+	err = node.BlobsAddFromPath(path, inPlace, tag, wrap, callback)
+	if err != nil {
+		panic(err)
+	}
+
+	// Output:
+	// Created dir "tmp"
+	// Created file "tmp/foo"
+	// Created file "tmp/bar"
+	// Created file "tmp/bat"
+	// AddProgress - Found:
+	//    id: 2, name: $HOME/tmp/bar, size: 3
+	// AddProgress - Found:
+	//		id: 0, name: $HOME/tmp/foo, size: 3
+	// AddProgress - Found:
+	//		id: 1, name: $HOME/tmp/bat, size: 3
+	// AddProgress - Progress:
+	//		id: 1, offset: 3
+	// AddProgress - Done:
+	//		id: 1, hash: bafkr4iabccdb2eyeu764xoewbcqv62sjaggxibtmxx5tnmwer3wp3rquq4
+	// AddProgress - Progress:
+	//		id: 2, offset: 3
+	// AddProgress - Progress:
+	//		id: 0, offset: 3
+	// AddProgress - Done:
+	//		id: 2, hash: bafkr4ihs5cl65v6sa3gykxkecwmpuuq2xr22vfuvh2l4amgjmewdbqjjhu
+	// AddProgress - Done:
+	//		id: 0, hash: bafkr4iae4c5tt4yldi76xcpvg3etxykqkvec352im5fqbutolj2xo5yc5e
+	// AddProgress - AllDone:
+	//		hash: bafkr4iaotzhxuiak7eusnngngnwsqdu4crf4lmdxzkbhuebunevecjzkim, format: 2, tag: "auto-2023-12-09T17:37:42.432Z"
+	// Removed dir 'tmp'
+}
+
+```
+
 
 </CodeGroup>