oddsdk · icidasset · Jan 25, 2023 · Jan 18, 2023 · Jan 20, 2023 · Jan 20, 2023
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,10 @@
 - Adds `program.accountDID(username)` shorthand method to retrieve the root DID of a given account username.
 - Adds the file system data functions as shorthand methods.
 
+#### Other
+
+- Introduces stricter types for paths to restrict the paths you can use with various functions and also to guide you a bit more.
+
 
 ### v0.35.2
 

diff --git a/src/capabilities.ts b/src/capabilities.ts
@@ -28,7 +28,7 @@ export type Capabilities = {
 
 export type FileSystemSecret = {
   bareNameFilter: string
-  path: Path.DistinctivePath
+  path: Path.Distinctive<Path.Segments>
   readKey: Uint8Array
 }
 
@@ -77,7 +77,7 @@ export async function collectSecret({ accountDID, bareNameFilter, crypto, path,
   accountDID: string
   bareNameFilter: string
   crypto: Crypto.Implementation
-  path: Path.DistinctivePath
+  path: Path.DistinctivePath<Path.Segments>
   readKey: Uint8Array
   storage: Storage.Implementation
 }) {
@@ -166,10 +166,10 @@ export async function validateSecrets(
   permissions: Permissions.Permissions
 ): Promise<boolean> {
   return Permissions.permissionPaths(permissions).reduce(
-    (acc: Promise<boolean>, path: Path.DistinctivePath): Promise<boolean> =>
+    (acc: Promise<boolean>, path: Path.Distinctive<Path.Partitioned<Path.Partition>>): Promise<boolean> =>
       acc.then(async (bool: boolean) => {
         if (bool === false) return bool
-        if (Path.isBranch(Path.Branch.Public, path)) return bool
+        if (Path.isPartition(Path.RootBranch.Public, path)) return bool
 
         const keyName = await Identifiers.readKey({ accountDID, crypto, path })
         return crypto.keystore.keyExists(keyName)

diff --git a/src/common/identifiers.ts b/src/common/identifiers.ts
@@ -9,7 +9,7 @@ import * as Path from "../path/index.js"
 type Arguments = {
   crypto: Crypto.Implementation
   accountDID: string
-  path: DistinctivePath
+  path: DistinctivePath<Path.Segments>
 }
 
 
@@ -30,7 +30,7 @@ export async function readKey(
 // 🛠
 
 
-async function pathHash(crypto: Crypto.Implementation, path: DistinctivePath): Promise<string> {
+async function pathHash(crypto: Crypto.Implementation, path: DistinctivePath<Path.Segments>): Promise<string> {
   return Uint8Arrays.toString(
     await crypto.hash.sha256(
       Uint8Arrays.fromString("/" + Path.unwrap(path).join("/"), "utf8")

diff --git a/src/common/root-key.ts b/src/common/root-key.ts
@@ -55,6 +55,6 @@ export function toString(a: Uint8Array): string {
 
 
 function identifier(crypto: Crypto.Implementation, accountDID: string): Promise<string> {
-  const path = Path.directory(Path.Branch.Private)
+  const path = Path.directory(Path.RootBranch.Private)
   return Identifiers.readKey({ crypto, path, accountDID })
 }
diff --git a/src/filesystem.ts b/src/filesystem.ts
@@ -11,7 +11,7 @@ import * as Ucan from "./ucan/index.js"
 import * as Versions from "./fs/versions.js"
 
 import { AuthenticationStrategy } from "./index.js"
-import { Branch } from "./path/index.js"
+import { RootBranch } from "./path/index.js"
 import { Configuration } from "./configuration.js"
 import { Dependencies } from "./fs/filesystem.js"
 import { Maybe, decodeCID, EMPTY_CID } from "./common/index.js"
@@ -194,12 +194,12 @@ export async function checkFileSystemVersion(
   const links = await Protocol.basic.getSimpleLinks(depot, filesystemCID)
   // if there's no version link, we assume it's from a 1.0.0-compatible version
   // (from before ~ November 2020)
-  const versionStr = links[ Branch.Version ] == null
+  const versionStr = links[ RootBranch.Version ] == null
     ? "1.0.0"
     : new TextDecoder().decode(
       await Protocol.basic.getFile(
         depot,
-        decodeCID(links[ Branch.Version ].cid)
+        decodeCID(links[ RootBranch.Version ].cid)
       )
     )
 

diff --git a/src/fs/bare/tree.ts b/src/fs/bare/tree.ts
@@ -8,7 +8,7 @@ import * as Link from "../link.js"
 import { HardLinks, BaseLinks, Tree, File, Puttable, UpdateCallback, PuttableUnixTree } from "../types.js"
 import { Maybe, decodeCID } from "../../common/index.js"
 import { isObject, hasProp } from "../../common/type-checks.js"
-import { Path } from "../../path/index.js"
+import { Segments as Path } from "../../path/index.js"
 
 import BareFile from "../bare/file.js"
 import BaseTree from "../base/tree.js"

diff --git a/src/fs/base/tree.ts b/src/fs/base/tree.ts
@@ -4,7 +4,7 @@ import * as Check from "../types/check.js"
 import * as Pathing from "../../path/index.js"
 
 import { Maybe } from "../../common/index.js"
-import { Path } from "../../path/index.js"
+import { Segments as Path } from "../../path/index.js"
 import { PutResult } from "../../components/depot/implementation.js"
 import { Tree, File, UnixTree, Links, UpdateCallback } from "../types.js"
 

diff --git a/src/fs/data.ts b/src/fs/data.ts
@@ -5,22 +5,20 @@ import * as FileSystem from "../fs/types.js"
 import * as Path from "../path/index.js"
 import * as Sharing from "./share.js"
 
-import { Branch } from "../path/index.js"
-
 
 /**
  * Adds some sample to the file system.
  */
 export async function addSampleData(fs: FileSystem.API): Promise<void> {
-  await fs.mkdir(Path.directory(Branch.Private, "Apps"))
-  await fs.mkdir(Path.directory(Branch.Private, "Audio"))
-  await fs.mkdir(Path.directory(Branch.Private, "Documents"))
-  await fs.mkdir(Path.directory(Branch.Private, "Photos"))
-  await fs.mkdir(Path.directory(Branch.Private, "Video"))
+  await fs.mkdir(Path.directory("private", "Apps"))
+  await fs.mkdir(Path.directory("private", "Audio"))
+  await fs.mkdir(Path.directory("private", "Documents"))
+  await fs.mkdir(Path.directory("private", "Photos"))
+  await fs.mkdir(Path.directory("private", "Video"))
 
   // Files
   await fs.write(
-    Path.file(Branch.Private, "Welcome.txt"),
+    Path.file("private", "Welcome.txt"),
     new TextEncoder().encode("Welcome to your personal transportable encrypted file system 👋")
   )
 }