@temporalio/common 1.12.2 → 1.13.0

package/src/proto-utils.ts

@@ -113,29 +113,32 @@ export function historyFromJSON(history: unknown): History {
  * string that adheres to the same norm as JSON history files produced by other Temporal tools.
  */
 export function historyToJSON(history: History): string {
-  // toProto3JSON doesn't correctly handle some of our "bytes" fields, passing them untouched to the
-  // output, after which JSON.stringify() would convert them to an array of numbers. As a workaround,
-  // recursively walk the object and convert all Buffer instances to base64 strings. Note this only
-  // works on proto3-json-serializer v2.0.0. v2.0.2 throws an error before we even get the chance
-  // to fix the buffers. See https://github.com/googleapis/proto3-json-serializer-nodejs/issues/103.
-  function fixBuffers<T>(e: T): T {
-    if (e && typeof e === 'object') {
-      if (e instanceof Buffer) return e.toString('base64') as any;
-      if (Array.isArray(e)) return e.map(fixBuffers) as T;
-      return Object.fromEntries(Object.entries(e as object).map(([k, v]) => [k, fixBuffers(v)])) as T;
-    }
-    return e;
-  }
-
   const protoJson = toProto3JSON(proto.temporal.api.history.v1.History.fromObject(history) as any);
   return JSON.stringify(fixBuffers(protoJson), null, 2);
 }
 
+/**
+ * toProto3JSON doesn't correctly handle some of our "bytes" fields, passing them untouched to the
+ * output, after which JSON.stringify() would convert them to an array of numbers. As a workaround,
+ * recursively walk the object and convert all Buffer instances to base64 strings. Note this only
+ * works on proto3-json-serializer v2.0.0. v2.0.2 throws an error before we even get the chance
+ * to fix the buffers. See https://github.com/googleapis/proto3-json-serializer-nodejs/issues/103.
+ */
+export function fixBuffers<T>(e: T): T {
+  if (e && typeof e === 'object') {
+    if (e instanceof Buffer) return e.toString('base64') as any;
+    if (e instanceof Uint8Array) return Buffer.from(e).toString('base64') as any;
+    if (Array.isArray(e)) return e.map(fixBuffers) as T;
+    return Object.fromEntries(Object.entries(e as object).map(([k, v]) => [k, fixBuffers(v)])) as T;
+  }
+  return e;
+}
+
 /**
  * Convert from protobuf payload to JSON
  */
 export function payloadToJSON(payload: Payload): JSONPayload {
-  return toProto3JSON(patched.temporal.api.common.v1.Payload.create(payload)) as any;
+  return fixBuffers(toProto3JSON(patched.temporal.api.common.v1.Payload.create(payload))) as any;
 }
 
 /**

package/src/user-metadata.ts

@@ -1,7 +1,5 @@
-import { temporal } from '@temporalio/proto';
+import type { temporal } from '@temporalio/proto';
 import { convertOptionalToPayload, PayloadConverter } from './converter/payload-converter';
-import { LoadedDataConverter } from './converter/data-converter';
-import { decodeOptionalSinglePayload, encodeOptionalSingle } from './internal-non-workflow';
 
 /**
  * User metadata that can be attached to workflow commands.
@@ -27,32 +25,3 @@ export function userMetadataToPayload(
 
   return { summary, details };
 }
-
-export async function encodeUserMetadata(
-  dataConverter: LoadedDataConverter,
-  staticSummary: string | undefined,
-  staticDetails: string | undefined
-): Promise<temporal.api.sdk.v1.IUserMetadata | undefined> {
-  if (staticSummary == null && staticDetails == null) return undefined;
-
-  const { payloadConverter, payloadCodecs } = dataConverter;
-  const summary = await encodeOptionalSingle(payloadCodecs, convertOptionalToPayload(payloadConverter, staticSummary));
-  const details = await encodeOptionalSingle(payloadCodecs, convertOptionalToPayload(payloadConverter, staticDetails));
-
-  if (summary == null && details == null) return undefined;
-
-  return { summary, details };
-}
-
-export async function decodeUserMetadata(
-  dataConverter: LoadedDataConverter,
-  metadata: temporal.api.sdk.v1.IUserMetadata | undefined | null
-): Promise<UserMetadata> {
-  const res = { staticSummary: undefined, staticDetails: undefined };
-  if (metadata == null) return res;
-
-  const staticSummary = (await decodeOptionalSinglePayload<string>(dataConverter, metadata.summary)) ?? undefined;
-  const staticDetails = (await decodeOptionalSinglePayload<string>(dataConverter, metadata.details)) ?? undefined;
-
-  return { staticSummary, staticDetails };
-}

package/src/workflow-options.ts

@@ -197,14 +197,14 @@ export interface BaseWorkflowOptions {
    * General fixed details for this workflow execution that may appear in UI/CLI.
    * This can be in Temporal markdown format and can span multiple lines.
    *
-   * @experimental User metadata is a new API and suspectible to change.
+   * @experimental User metadata is a new API and susceptible to change.
    */
   staticDetails?: string;
   /**
    * A single-line fixed summary for this workflow execution that may appear in the UI/CLI.
    * This can be in single-line Temporal markdown format.
    *
-   * @experimental User metadata is a new API and suspectible to change.
+   * @experimental User metadata is a new API and susceptible to change.
    */
   staticSummary?: string;