@alepha/protobuf 0.5.1 → 0.6.0

package/README.md

@@ -1 +1,35 @@
 # @alepha/protobuf
+
+Alepha Protobuf is a simple protobuf adapter for Alepha.
+It uses TypeBox Schema to define the protobuf schema and serialize/deserialize the data.
+
+## Installation
+
+```bash
+npm install @alepha/protobuf
+```
+
+## Usage
+
+```ts
+import { Alepha, t } from "@alepha/core";
+import { ProtobufProvider } from "@alepha/protobuf";
+
+const protobuf = Alepha.create().get(ProtobufProvider);
+
+const userSchema = t.object({
+	username: t.string(),
+	createdAt: t.datetime(),
+	age: t.int(),
+	isActive: t.boolean()
+});
+
+const buffer = protobuf.encode(userSchema, {
+	username: "John Doe",
+	createdAt: new Date().toISOString(),
+	age: 30,
+	isActive: true
+});
+
+const user = protobuf.decode(userSchema, buffer);
+```

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@alepha/protobuf",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "type": "module",
   "license": "MIT",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.cts",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "dependencies": {
-    "@alepha/core": "0.5.1",
+    "@alepha/core": "0.6.0",
     "protobufjs": "^7.4.0"
   },
   "devDependencies": {
@@ -18,13 +17,10 @@
     "build": "pkgroll --clean-dist"
   },
   "exports": {
-    "require": {
-      "types": "./dist/index.d.cts",
-      "default": "./dist/index.cjs"
-    },
-    "import": {
-      "types": "./dist/index.d.mts",
-      "default": "./dist/index.mjs"
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
     }
   }
 }

package/dist/index.d.mts

@@ -1,103 +0,0 @@
-import { Alepha, TObject, Static, TSchema as TSchema$1 } from '@alepha/core';
-import protobufjs, { Type } from 'protobufjs';
-
-/** Symbol key applied to readonly types */
-declare const ReadonlyKind: unique symbol;
-/** Symbol key applied to optional types */
-declare const OptionalKind: unique symbol;
-/** Symbol key applied to types */
-declare const Hint: unique symbol;
-/** Symbol key applied to types */
-declare const Kind: unique symbol;
-
-type TPropertyKey = string | number;
-type TProperties = Record<TPropertyKey, TSchema>;
-
-interface SchemaOptions {
-    $schema?: string;
-    /** Id for this schema */
-    $id?: string;
-    /** Title of this schema */
-    title?: string;
-    /** Description of this schema */
-    description?: string;
-    /** Default value for this schema */
-    default?: any;
-    /** Example values matching this schema */
-    examples?: any;
-    /** Optional annotation for readOnly */
-    readOnly?: boolean;
-    /** Optional annotation for writeOnly */
-    writeOnly?: boolean;
-    [prop: string]: any;
-}
-interface TKind {
-    [Kind]: string;
-}
-interface TSchema extends TKind, SchemaOptions {
-    [ReadonlyKind]?: string;
-    [OptionalKind]?: string;
-    [Hint]?: string;
-    params: unknown[];
-    static: unknown;
-}
-
-declare class ProtobufProvider {
-    protected readonly alepha: Alepha;
-    protected readonly schemas: Map<string | TObject<TProperties>, Type>;
-    protected readonly protobuf: typeof protobufjs;
-    /**
-     * Encode an object to a Uint8Array.
-     *
-     * @param schema - TypeBox schema used to generate the Protobuf schema.
-     * @param data - Object to encode. Can be any object or string.
-     */
-    encode(schema: TObject, data: any): Uint8Array;
-    /**
-     * Decode a Uint8Array to an object.
-     *
-     * @param schema
-     * @param data
-     */
-    decode<T extends TObject>(schema: T, data: Uint8Array): Static<T>;
-    /**
-     * Parse a TypeBox schema to a Protobuf Type schema ready for encoding/decoding.
-     *
-     * @param schema
-     * @param typeName
-     */
-    parse(schema: ProtobufSchema | TObject, typeName?: string): Type;
-    /**
-     * Convert a TypeBox schema to a Protobuf schema as a string.
-     *
-     * @param schema
-     * @param options
-     */
-    createProtobufSchema(schema: TSchema$1, options?: CreateProtobufSchemaOptions): string;
-    /**
-     * Parse an object schema to a Protobuf message.
-     *
-     * @param obj
-     * @param parentName
-     * @param context
-     * @protected
-     */
-    protected parseObject(obj: TSchema$1, parentName: string, context: {
-        proto: string;
-        fieldIndex: number;
-    }): string;
-    /**
-     * Convert a primitive TypeBox schema type to a Protobuf spec type.
-     *
-     * @param schema
-     * @protected
-     */
-    protected convertType(schema: TSchema$1): string;
-}
-type ProtobufSchema = string;
-interface CreateProtobufSchemaOptions {
-    rootName?: string;
-    mainMessageName?: string;
-}
-
-export { type CreateProtobufSchemaOptions, ProtobufProvider, type ProtobufSchema };