feat(@sirutils/nuts): init structure

Author: giveerr

bun.lockb

@@ -6,8 +6,8 @@
   "files": ["dist"],
   "exports": {
     ".": {
-      "default": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "default": "./dist/core/index.js",
+      "types": "./dist/core/index.d.ts"
     }
   },
 
@@ -19,11 +19,15 @@
   },
 
   "devDependencies": {
-    "@sirutils/builder": "workspace:*"
+    "@sirutils/builder": "workspace:*",
+    "cbor-x": "^1.6.0"
   },
   "dependencies": {
     "@sirutils/core": "workspace:*",
     "@sirutils/schema": "workspace:*",
     "@sirutils/toolbox": "workspace:*"
+  },
+  "peerDependencies": {
+    "cbor-x": "^1.6.0"
   }
 }

packages/nuts/package.json

@@ -0,0 +1,49 @@
+import type { Duplex } from 'node:stream'
+import type { BlobType } from '@sirutils/core'
+
+import type { createNuts } from '../plugin/create'
+import type { NutsTags } from '../tag'
+
+declare global {
+  namespace Sirutils {
+    interface CustomErrors {
+      nuts: NutsTags
+    }
+
+    interface PluginDefinitions {
+      nuts: Sirutils.PluginSystem.ExtractDefinition<typeof createNuts>
+      'nuts-serializer': Sirutils.PluginSystem.Context<BlobType, Sirutils.Nuts.SerializerApi>
+    }
+
+    namespace Nuts {
+      interface Options {
+        id?: string
+        environment?: 'production' | 'development' | 'test'
+
+        port?: string
+        host?: string
+        logs?: boolean
+      }
+
+      interface Broker {}
+
+      interface BaseApi {}
+      interface BrokerApi {
+        broker: Sirutils.Nuts.Broker
+      }
+
+      type Context = Sirutils.PluginSystem.Context<
+        Sirutils.Nuts.Options,
+        Sirutils.Nuts.BaseApi & Sirutils.Nuts.BrokerApi
+      >
+
+      interface SerializerApi {
+        encode: <T = unknown>(data: T) => Buffer
+        decode: <T = unknown>(data: string | Buffer) => T
+
+        encodeStream: () => Duplex
+        decodeStream: () => Duplex
+      }
+    }
+  }
+}

packages/nuts/src/definitions/index.ts packages/nuts/src/core/definitions/index.ts

@@ -0,0 +1,23 @@
+import { createPlugin } from '@sirutils/core'
+
+import { nutsTags } from '../tag'
+import { brokerActions } from './internal/broker'
+
+export const createNuts = createPlugin<Sirutils.Nuts.Options, Sirutils.Nuts.BaseApi>(
+  {
+    name: 'nuts',
+    version: '0.2.3',
+
+    dependencies: {
+      'nuts-serializer': '*',
+    },
+  },
+  ctx => {
+    return {
+      broker: {},
+    }
+  },
+  nutsTags.plugin
+)
+  .register(brokerActions)
+  .lock()

packages/nuts/src/core/definitions/nuts.ts

@@ -0,0 +1,14 @@
+import { createActions } from '@sirutils/core'
+
+import { nutsTags } from '../../tag'
+
+export const brokerActions = createActions(
+  (context: Sirutils.Nuts.Context): Sirutils.Nuts.BrokerApi => {
+    const serializer = context.lookup('nuts-serializer')
+
+    return {
+      broker: {},
+    }
+  },
+  nutsTags.broker
+)

packages/nuts/src/index.ts packages/nuts/src/core/index.ts

@@ -1,10 +1,13 @@
-import { createTag } from './internal/tag'
+import { tagBuilder } from '@sirutils/core'
+
+export const createTag = tagBuilder('@sirutils/nuts')
 
 export const nutsTags = {
   // internal
   logger: createTag('logger'),
 
   plugin: createTag('plugin'),
+  broker: createTag('broker'),
 } as const
 
 export type NutsTags = (typeof nutsTags)[keyof typeof nutsTags]

packages/nuts/src/internal/logger.ts packages/nuts/src/core/internal/logger.ts

@@ -0,0 +1,34 @@
+import type { Options as CborOptions, Decoder, Encoder } from 'cbor-x'
+
+import type { createCbor } from '../plugin/create'
+import type { CborTags } from '../tag'
+
+declare global {
+  namespace Sirutils {
+    interface CustomErrors {
+      'nuts-cbor': CborTags
+    }
+
+    interface PluginDefinitions {
+      'nuts-cbor': Sirutils.PluginSystem.ExtractDefinition<typeof createCbor>
+    }
+
+    namespace Nuts {
+      namespace Cbor {
+        interface Options extends CborOptions {}
+
+        interface BaseApi {
+          $encoder: Encoder
+          $decoder: Decoder
+        }
+
+        interface SerializerApi extends Sirutils.Nuts.SerializerApi {}
+
+        type Context = Sirutils.PluginSystem.Context<
+          Sirutils.Nuts.Cbor.Options,
+          Sirutils.Nuts.Cbor.BaseApi & Sirutils.Nuts.Cbor.SerializerApi
+        >
+      }
+    }
+  }
+}

packages/nuts/src/core/plugin/create.ts

@@ -0,0 +1,6 @@
+/// <reference types="@sirutils/core" />
+/// <reference types="@sirutils/toolbox" />
+/// <reference types="@sirutils/schema" />
+
+import '../../core'
+import './cbor'

packages/nuts/src/core/plugin/internal/broker.ts

@@ -0,0 +1,5 @@
+import './definitions'
+
+export * from './plugin/create'
+
+export * from './tag'

packages/nuts/src/tag.ts packages/nuts/src/core/tag.ts

@@ -0,0 +1,27 @@
+import { createPlugin } from '@sirutils/core'
+import { Decoder, Encoder } from 'cbor-x'
+
+import { cborTags } from '../tag'
+import { serializerApiActions } from './internal/api'
+
+export const createCbor = createPlugin<Sirutils.Nuts.Cbor.Options, Sirutils.Nuts.Cbor.BaseApi>(
+  {
+    name: 'nuts-serializer', // cbor
+    version: '0.2.3',
+
+    dependencies: {},
+  },
+  context => {
+    const $encoder = new Encoder(context.options)
+    const $decoder = new Decoder(context.options)
+
+    return {
+      $encoder,
+      $decoder,
+    }
+  },
+  cborTags.plugin,
+  {}
+)
+  .register(serializerApiActions)
+  .lock()

packages/nuts/src/definitions/nuts.ts

@@ -0,0 +1,25 @@
+import { createActions } from '@sirutils/core'
+import { DecoderStream, EncoderStream } from 'cbor-x'
+
+import { cborTags } from '../../tag'
+
+export const serializerApiActions = createActions(
+  (context: Sirutils.Nuts.Cbor.Context): Sirutils.Nuts.Cbor.SerializerApi => {
+    return {
+      encode: data => {
+        return context.api.$encoder.encode(data)
+      },
+      decode: data => {
+        if (typeof data === 'string') {
+          return context.api.$decoder.decode(Buffer.from(data))
+        }
+
+        return context.api.$decoder.decode(data)
+      },
+
+      encodeStream: () => new EncoderStream(context.options),
+      decodeStream: () => new DecoderStream(context.options),
+    }
+  },
+  cborTags.api
+)

packages/nuts/src/internal/tag.ts

@@ -0,0 +1,11 @@
+import { tagBuilder } from '@sirutils/core'
+
+export const createTag = tagBuilder('@sirutils/nuts#cbor')
+
+export const cborTags = {
+  plugin: createTag('plugin'),
+
+  api: createTag('api'),
+} as const
+
+export type CborTags = (typeof cborTags)[keyof typeof cborTags]

packages/nuts/src/plugin/create.ts

@@ -1,3 +1,6 @@
-import { createNuts } from '../src'
+import { createNuts } from '../src/core'
+import { createCbor } from '../src/serializer-cbor'
 
-export const nuts = await createNuts()
+const [serializer] = await Promise.all([createCbor()])
+
+export const nuts = await createNuts({}, serializer)