skir-php-generator 0.2.0 → 0.3.0

package/README.md

@@ -8,7 +8,7 @@
 
 Generates framework-agnostic PHP data objects, RPC clients, and server procedure contracts from Skir schemas.
 
-Generated PHP uses `php-skir/runtime` for dense JSON serialization. Install `php-skir/client` when using generated RPC clients and `php-skir/server` when using generated server contracts.
+Generated PHP uses `php-skir/runtime` for dense JSON, readable JSON, and binary serialization. Install `php-skir/client` when using generated RPC clients and `php-skir/server` when using generated server contracts.
 
 The npm package uses [`@php-skir/generator-core`](https://github.com/php-skir/generator-core) at generation time for schema normalization, PHP naming and imports, shared enum and RPC rendering, server manifests, and Composer configuration. This package remains the framework-agnostic adapter: it owns the standard PHP data-object representation and conversions, while `php-skir/runtime` remains the Composer dependency used by the generated PHP at runtime.
 
@@ -130,9 +130,19 @@ The generator emits readonly PHP classes for Skir structs and enum wrapper class
 
 - `skirType()` for runtime type descriptors.
 - `toArray()` and `fromArray()` for PHP array conversion.
-- `toDenseJson()` and `fromDenseJson()` for dense JSON payloads.
+- `toDenseJson()` and `fromDenseJson()` for dense JSON payloads. `fromDenseJson()` also accepts readable JSON, so there is no separate `fromReadableJson()`.
+- `toReadableJson()` for readable JSON payloads.
+- `toBytes()` and `fromBytes()` for Skir binary payloads.
 - `toSkirValue()` and `fromSkirValue()` on generated enum classes.
 
+```php
+$json = $user->toReadableJson();
+$user = User::fromDenseJson($json);
+
+$bytes = $user->toBytes();
+$user = User::fromBytes($bytes);
+```
+
 SkirRPC methods are emitted in `SkirMethods.php` as `MethodDescriptor` instances. The generator also emits a module-scoped method enum such as `AdminSkirMethod.php` for typed server routing.
 
 When a module defines SkirRPC methods, the generator emits `SkirRpcClient.php`. It wraps `Skir\Client\SkirClient` and exposes typed methods:

package/dist/target.d.ts

@@ -14,4 +14,7 @@ export declare class StandardPhpTarget implements PhpTargetAdapter {
     private renderFromArray;
     private renderToDenseJson;
     private renderFromDenseJson;
+    private renderToReadableJson;
+    private renderToBytes;
+    private renderFromBytes;
 }

package/dist/target.js

@@ -10,8 +10,10 @@ export class StandardPhpTarget {
             throw new Error(`Cannot render non-struct record ${record.identity} as a struct.`);
         }
         const className = classNameForRecord(record, context);
+        const binaryFormat = importClass(context.imports, "Skir\\Runtime\\BinaryFormat");
         const denseJson = importClass(context.imports, "Skir\\Runtime\\DenseJson");
         const fieldClass = importClass(context.imports, "Skir\\Runtime\\Field");
+        const readableJson = importClass(context.imports, "Skir\\Runtime\\ReadableJson");
         const typeClass = importClass(context.imports, "Skir\\Runtime\\Type");
         const fields = record.fields.filter(isStructField);
         const constructor = this.renderConstructor(fields, context);
@@ -22,6 +24,9 @@ export class StandardPhpTarget {
             this.renderFromArray(className, fields, context),
             this.renderToDenseJson(denseJson),
             this.renderFromDenseJson(className, denseJson),
+            this.renderToReadableJson(readableJson),
+            this.renderToBytes(binaryFormat),
+            this.renderFromBytes(className, binaryFormat),
         ].filter((member) => member !== null);
         const body = [
             `final readonly class ${className}`,
@@ -189,6 +194,30 @@ export class StandardPhpTarget {
             "}",
         ].join("\n");
     }
+    renderToReadableJson(readableJson) {
+        return [
+            "public function toReadableJson(): string",
+            "{",
+            `    return ${readableJson}::toJson(self::skirType(), $this->toArray());`,
+            "}",
+        ].join("\n");
+    }
+    renderToBytes(binaryFormat) {
+        return [
+            "public function toBytes(): string",
+            "{",
+            `    return ${binaryFormat}::encode(self::skirType(), $this->toArray());`,
+            "}",
+        ].join("\n");
+    }
+    renderFromBytes(className, binaryFormat) {
+        return [
+            `public static function fromBytes(string $bytes): ${className}`,
+            "{",
+            `    return self::fromArray(${binaryFormat}::decode(self::skirType(), $bytes));`,
+            "}",
+        ].join("\n");
+    }
 }
 function nullablePhpType(type) {
     const unionMembers = type.split("|");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skir-php-generator",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Skir code generator for standard PHP data objects.",
   "type": "module",
   "license": "MIT",
@@ -45,7 +45,7 @@
     "typecheck": "tsc -p tsconfig.json --noEmit"
   },
   "dependencies": {
-    "@php-skir/generator-core": "^0.1.0",
+    "@php-skir/generator-core": "^0.2.0",
     "jsonc-parser": "^3.3.1",
     "skir-internal": "^0.2.21",
     "yaml": "^2.9.0",