use js-yaml in test

docs/client.dnamodifiersopt.md

@@ -4,6 +4,7 @@
 
 ## DnaModifiersOpt type
 
+
 **Signature:**
 
 ```typescript

docs/client.md

@@ -1871,6 +1871,7 @@ This type is meant to be opaque
 </td><td>
 
 
+
 </td></tr>
 <tr><td>
 
@@ -2736,6 +2737,7 @@ If the key could not be deleted from all cells, the call [RevokeAgentKeyRequest]
 </td><td>
 
 
+
 </td></tr>
 <tr><td>
 

docs/client.rolesettings.md

@@ -4,6 +4,7 @@
 
 ## RoleSettings type
 
+
 **Signature:**
 
 ```typescript

package.json

@@ -48,13 +48,15 @@
     "isomorphic-ws": "^5.0.0",
     "js-base64": "^3.7.5",
     "js-sha512": "^0.9.0",
+    "js-yaml": "4.1.0",
     "libsodium-wrappers": "^0.7.13",
     "lodash-es": "^4.17.21",
     "ws": "^8.14.2"
   },
   "devDependencies": {
     "@microsoft/api-documenter": "^7.21.7",
     "@microsoft/api-extractor": "^7.34.4",
+    "@types/js-yaml": "4.0.9",
     "@types/libsodium-wrappers": "^0.7.11",
     "@types/lodash-es": "^4.17.6",
     "@types/tape": "^4.13.2",

src/api/admin/types.ts

@@ -163,6 +163,9 @@ export type MemproofMap = { [key: RoleName]: MembraneProof };
  */
 export type RoleSettingsMap = { [key: RoleName]: RoleSettings };
 
+/**
+ * @public
+ */
 export type RoleSettings =
   | {
       type: "UseExisting";
@@ -175,11 +178,15 @@ export type RoleSettings =
     };
 
 /**
+ *  @public
  * Any value that is serializable to a Yaml value
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type YamlProperties = any;
 
+/**
+ * @public
+ */
 export type DnaModifiersOpt = {
   network_seed?: NetworkSeed;
   properties?: YamlProperties;

test/e2e/common.ts

@@ -117,7 +117,7 @@ export const installAppAndDna = async (
     installed_app_id,
     agent_key: agent,
     path,
-    membrane_proofs: {},
+    roles_settings: {},
   });
   assert(CellType.Provisioned in app.cell_info[role_name][0]);
   const cell_id = app.cell_info[role_name][0][CellType.Provisioned].cell_id;
@@ -159,7 +159,7 @@ export const createAppWsAndInstallApp = async (
     installed_app_id,
     agent_key: agent,
     path,
-    membrane_proofs: {},
+    roles_settings: {},
   });
   assert(CellType.Provisioned in app.cell_info[role_name][0]);
   const cell_id = app.cell_info[role_name][0][CellType.Provisioned].cell_id;

test/e2e/index.ts

@@ -1,7 +1,8 @@
-import { decode, encode } from "@msgpack/msgpack";
+import { decode } from "@msgpack/msgpack";
 import assert from "node:assert/strict";
 import fs from "node:fs";
 import test from "tape";
+import yaml from "js-yaml";
 import zlib from "zlib";
 import {
   ActionHash,
@@ -580,6 +581,8 @@ test(
       nanos: 0,
     };
 
+    const progenitorKey = fakeAgentPubKey();
+
     await admin.installApp({
       installed_app_id,
       agent_key: agent,
@@ -610,7 +613,7 @@ test(
           membrane_proof: new Uint8Array(6),
           modifiers: {
             network_seed: "hello",
-            properties: { specialProp: "prop" },
+            properties: yaml.dump({ progenitor: progenitorKey }),
             origin_time: originTime,
             quantum_time: quantumTime,
           },
@@ -623,9 +626,10 @@ test(
     const provisionedCell: ProvisionedCell =
       appInfo.cell_info["foo"][0][CellType.Provisioned];
     t.equal(provisionedCell.dna_modifiers.network_seed, "hello");
-    t.deepEqual(decode(provisionedCell.dna_modifiers.properties), {
-      specialProp: "prop",
-    });
+    t.deepEqual(
+      yaml.load(decode(provisionedCell.dna_modifiers.properties) as string),
+      { progenitor: progenitorKey }
+    );
     t.equal(provisionedCell.dna_modifiers.origin_time, originTime);
     t.deepEqual(provisionedCell.dna_modifiers.quantum_time, quantumTime);
   })