feat(std/results): improve tags usage

Author: giveerr

experiments/example/src/definition.ts

@@ -6,7 +6,7 @@ declare global {
   namespace Std {
     // ------------ Std - results ------------
 
-    interface CustomErrors {
+    interface Error {
       examples: typeof exampleTags
     }
   }

experiments/example/src/users/say-hi.ts

@@ -1,4 +1,4 @@
-import { $try, Err, err, fromThrowable, ok } from '@sirutils/std/results'
+import { $try, Err, err, fromAsyncThrowable, ok } from '@sirutils/std/results'
 
 import { exampleTags } from '../tag'
 import { $getUser } from './get-user'
@@ -18,7 +18,7 @@ export const $sayHi = (name?: string) =>
     return ok(`Hi ${found.name}-${found.age}`)
   }, exampleTags.get('say-hi'))
 
-export const a = fromThrowable(
+export const a = fromAsyncThrowable(
   (path: string, data: string) => Bun.write(path, data),
   e =>
     (e instanceof Err

packages/std/src/io/definition.ts

@@ -1,11 +1,12 @@
 /// <reference path="../shared/index.ts" />
+/// <reference path="../results/index.ts" />
 
 import type { ioTags } from './tag'
 
 declare global {
   namespace Std {
     // ------------ Errors ------------
-    interface CustomErrors {
+    interface Error {
       'std/io': typeof ioTags
     }
   }

packages/std/src/io/tag.ts

@@ -5,4 +5,5 @@ export const ioTags = Tags.create('std/io')
   .add('invalid-mime')
 
   // causes
-  .add('read')
+  .add('read', '$read')
+  .add('read-json', '$readJson')

packages/std/src/io/utils/read.ts

@@ -29,4 +29,4 @@ export const $readJson = $fn(async <T>(path: string) => {
   }
 
   return (await file.json()) as T
-}, ioTags.get('read'))
+}, ioTags.get('read-json'))

packages/std/src/results/definition.ts

@@ -15,15 +15,10 @@ declare global {
   namespace Std {
     // ------------ Errors ------------
 
-    /**
-     * The interface where we combine tags in each project
-     */
-    interface CustomErrors {}
-
     /**
      * Use this instead of CustomErrors. CustomErrors is for overriding
      */
-    interface Error extends Std.CustomErrors {
+    interface Error {
       'std/results': typeof resultTags
     }
 

packages/std/src/results/utils/tag.ts

@@ -17,7 +17,7 @@ export class Tags<U extends [string, string], T extends string> {
     return this as Tags<U | [K, V], T>
   }
 
-  get<K extends LiteralUnion<U['0'], string>>(key: K) {
+  get<K extends LiteralUnion<U['0'], `?${string}`>>(key: K) {
     const found = this.tags.get(key)
 
     if (!found) {

packages/std/src/shared/definition.ts

@@ -1,7 +1,6 @@
-import './definition'
-
 export * from './types/common'
 
 export * from './utils/types'
+export * from './utils/timing'
 
 export type * from 'type-fest'

packages/std/src/shared/index.ts

@@ -0,0 +1,7 @@
+[
+  {
+    "name": "alice",
+    "surname": "zuberg",
+    "age": 19
+  }
+]

packages/std/src/shared/tag.ts

@@ -0,0 +1 @@
+[{]

packages/std/tests/io/read/correct.json

@@ -0,0 +1,17 @@
+import { describe, expect, test } from 'bun:test'
+import { join } from 'node:path'
+
+import { $read } from '../../../dist/io'
+import { Ok, ResultAsync } from '../../../dist/results'
+
+describe('std/io/read', () => {
+  describe('json', () => {
+    test('correct', async () => {
+      const result = $read(join(__dirname, './correct.json'))
+      const called = await result
+
+      expect(result).toBeInstanceOf(ResultAsync)
+      expect(called).toBeInstanceOf(Ok)
+    })
+  })
+})

packages/std/tests/io/read/correct.txt

@@ -1,7 +1,7 @@
 import { describe, expect, test } from 'bun:test'
 
 import { $fn, Err, Ok, ResultAsync, err, errAsync, ok, okAsync } from '../../dist/results'
-import { wait } from '../../src/shared/utils/timing'
+import { wait } from '../../dist/shared'
 
 describe('std/results/fn', () => {
   describe('sync', () => {