skir-simple-data-objects-generator 0.1.0 → 0.2.0

package/README.md

@@ -122,10 +122,13 @@ Every Skir struct generates a final class extending `StdOut\SimpleDataObjects\Ba
 | --- | --- |
 | `skirType()` | Return the runtime `Type` descriptor. |
 | `makeFromSkirPayload(array $data)` | Validate raw named Skir data, recursively hydrate nested values, and return the DTO. |
-| `fromSkir(string $json)` | Decode dense Skir JSON and delegate to `makeFromSkirPayload()`. |
+| `fromSkir(string $json)` | Decode dense or readable Skir JSON and delegate to `makeFromSkirPayload()`. There is no separate `fromReadableJson()`. |
 | `toSkirArray()` | Convert DTO values to the named array representation expected by the runtime. |
 | `toSkir()` | Encode the DTO as the dense PHP array representation. |
 | `toSkirJson()` | Encode the DTO as dense Skir JSON. |
+| `toReadableJson()` | Encode the DTO as readable Skir JSON. |
+| `toBytes()` | Encode the DTO in the Skir binary format. |
+| `fromBytes(string $bytes)` | Decode the Skir binary format and delegate to `makeFromSkirPayload()`, so validation applies. |
 
 Generated classes inherit the current `BaseData` APIs, including `from()`, `fromValidated()`, `validate()`, `toArray()`, `toJson()`, `with()`, `equals()`, `diff()`, `only()`, `except()`, `collection()`, and `lazyCollection()`.
 
@@ -176,7 +179,7 @@ Nested arrays and arrays whose item is optional remain normal PHP arrays, althou
 
 ### Wrapper enums
 
-Skir enums generate readonly wrapper classes with a `Data` suffix. Constant variants have parameterless named constructors; payload variants have typed named constructors. Generated enum classes expose `name()`, `payload()`, `skirType()`, `toSkirValue()`, `fromSkirValue()`, `toDenseValue()`, `fromDenseValue()`, `toDenseJson()`, and `fromDenseJson()`.
+Skir enums generate readonly wrapper classes with a `Data` suffix. Constant variants have parameterless named constructors; payload variants have typed named constructors. Generated enum classes expose `name()`, `payload()`, `skirType()`, `toSkirValue()`, `fromSkirValue()`, `toDenseValue()`, `fromDenseValue()`, `toDenseJson()`, `fromDenseJson()`, `toReadableJson()`, `toBytes()`, and `fromBytes()`. `fromDenseJson()` accepts both dense and readable JSON.
 
 Structs, typed struct collections, nested arrays, optionals, and nested enum wrappers are converted to wire values when stored in a wrapper and converted back to target DTO values when `payload()` is read.
 
@@ -357,14 +360,3 @@ npm install --no-save --package-lock=false ../generator-core
 ```
 
 Once the compatible core package has been published and this repository has committed its normal `package-lock.json`, use `npm ci` instead of the local-path bootstrap.
-
-## Releasing
-
-Release the shared packages in dependency order:
-
-1. Merge and publish `@php-skir/generator-core` with the required adapter APIs.
-2. Replace the local link with the published compatible core version and commit the resulting `package-lock.json` update.
-3. Run `npm ci`, typecheck, build, package validation, the full test suite, and `git diff --check` again.
-4. Create the Simple Data Objects generator release only after those checks pass.
-
-The release workflow uses Node 24 and npm trusted publishing with provenance. Configure this GitHub repository as an npm trusted publisher before publishing; no release or publish action is performed by the test workflow.

package/dist/target.d.ts

@@ -25,5 +25,8 @@ export declare class SimpleDataObjectsTarget implements PhpTargetAdapter {
     private renderToSkirArray;
     private renderToSkir;
     private renderToSkirJson;
+    private renderToReadableJson;
+    private renderToBytes;
+    private renderFromBytes;
     private toSkirValueExpression;
 }

package/dist/target.js

@@ -1,15 +1,24 @@
 import { importClass, importClassAs, indent, renderPhpFile, renderUseStatements, resolveValidationRules, toClassName, toPhpNamespaceSegment, toPropertyName, } from "@php-skir/generator-core";
 import { GENERATOR_MODULE } from "./config.js";
 import { structuralRules } from "./structural-rules.js";
+const BINARY_FORMAT = "Skir\\Runtime\\BinaryFormat";
 const DENSE_JSON = "Skir\\Runtime\\DenseJson";
 const FIELD = "Skir\\Runtime\\Field";
+const READABLE_JSON = "Skir\\Runtime\\ReadableJson";
 const TYPE = "Skir\\Runtime\\Type";
 const DATA_COLLECTION = "StdOut\\SimpleDataObjects\\Attributes\\DataCollection";
 const MAP_PROPERTY_NAME = "StdOut\\SimpleDataObjects\\Attributes\\MapPropertyName";
 const RULES = "StdOut\\SimpleDataObjects\\Attributes\\Rules";
 const BASE_DATA = "StdOut\\SimpleDataObjects\\BaseData";
 const TYPED_DATA_COLLECTION = "StdOut\\SimpleDataObjects\\TypedDataCollection";
-const BASE_STRUCT_IMPORTS = [DENSE_JSON, FIELD, TYPE, BASE_DATA];
+const BASE_STRUCT_IMPORTS = [
+    BINARY_FORMAT,
+    DENSE_JSON,
+    FIELD,
+    READABLE_JSON,
+    TYPE,
+    BASE_DATA,
+];
 export class SimpleDataObjectsTarget {
     validation;
     id = GENERATOR_MODULE;
@@ -62,8 +71,10 @@ export class SimpleDataObjectsTarget {
         }
         const className = classNameForRecord(record, context);
         const imports = this.structImports(record);
+        const binaryFormat = importClass(context.imports, BINARY_FORMAT);
         const denseJson = importClass(context.imports, DENSE_JSON);
         const fieldClass = importClass(context.imports, FIELD);
+        const readableJson = importClass(context.imports, READABLE_JSON);
         const typeClass = importClass(context.imports, TYPE);
         const baseData = importClass(context.imports, BASE_DATA);
         const fields = record.fields.filter(isStructField);
@@ -76,6 +87,9 @@ export class SimpleDataObjectsTarget {
             this.renderToSkirArray(fields, context),
             this.renderToSkir(denseJson),
             this.renderToSkirJson(denseJson),
+            this.renderToReadableJson(readableJson),
+            this.renderToBytes(binaryFormat),
+            this.renderFromBytes(className, binaryFormat),
         ].filter((member) => member !== null);
         const body = [
             `final class ${className} extends ${baseData}`,
@@ -262,6 +276,32 @@ export class SimpleDataObjectsTarget {
             "}",
         ].join("\n");
     }
+    renderToReadableJson(readableJson) {
+        return [
+            "public function toReadableJson(): string",
+            "{",
+            `    return ${readableJson}::toJson(self::skirType(), $this->toSkirArray());`,
+            "}",
+        ].join("\n");
+    }
+    renderToBytes(binaryFormat) {
+        return [
+            "public function toBytes(): string",
+            "{",
+            `    return ${binaryFormat}::encode(self::skirType(), $this->toSkirArray());`,
+            "}",
+        ].join("\n");
+    }
+    renderFromBytes(className, binaryFormat) {
+        return [
+            `public static function fromBytes(string $bytes): ${className}`,
+            "{",
+            `    $data = ${binaryFormat}::decode(self::skirType(), $bytes);`,
+            "",
+            "    return self::makeFromSkirPayload($data);",
+            "}",
+        ].join("\n");
+    }
     toSkirValueExpression(type, expression, context, allowTypedCollection) {
         if (type.kind === "record") {
             return type.recordType === "enum"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skir-simple-data-objects-generator",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Skir code generator for std-out/simple-data-objects.",
   "type": "module",
   "license": "MIT",
@@ -43,11 +43,11 @@
     "pretest": "npm run build",
     "pack:dry-run": "npm pack --dry-run --cache .npm-cache",
     "test": "vitest run",
-    "test:coverage": "vitest run --coverage --coverage.reporter=json-summary --coverage.include=src/**/*.ts",
+    "test:coverage": "vitest run --coverage --coverage.reporter=json-summary --coverage.include=src/**/*.ts --coverage.thresholds.lines=80 --coverage.thresholds.statements=80 --coverage.thresholds.branches=75 --coverage.thresholds.functions=75",
     "typecheck": "tsc -p tsconfig.json --noEmit"
   },
   "dependencies": {
-    "@php-skir/generator-core": "^0.1.0",
+    "@php-skir/generator-core": "^0.2.0",
     "skir-internal": "^0.2.21",
     "zod": "^4.0.0"
   },
@@ -56,6 +56,7 @@
     "@vitest/coverage-v8": "^4.1.10",
     "skir": "^1.2.19",
     "typescript": "^5.9.0",
-    "vitest": "^4.0.0"
+    "vitest": "^4.0.0",
+    "yaml": "^2.9.0"
   }
 }