@temporalio/common 0.21.0 → 1.0.0-rc.0

package/README.md

@@ -2,10 +2,10 @@
 
 [![NPM](https://img.shields.io/npm/v/@temporalio/common?style=for-the-badge)](https://www.npmjs.com/package/@temporalio/common)
 
-Part of [Temporal](https://temporal.io)'s TypeScript SDK (see [docs](https://docs.temporal.io/docs/typescript/introduction/) and [samples](https://github.com/temporalio/samples-typescript)).
+Part of [Temporal](https://temporal.io)'s TypeScript SDK (see [docs](https://docs.temporal.io/typescript/introduction/) and [samples](https://github.com/temporalio/samples-typescript)).
 
 Common library for code that's used across the Client, Worker, and/or Workflow:
 
-- [DataConverter docs](https://docs.temporal.io/docs/typescript/data-converters)
-- [Failure docs](https://docs.temporal.io/docs/typescript/handling-failure)
+- [DataConverter docs](https://docs.temporal.io/typescript/data-converters)
+- [Failure docs](https://docs.temporal.io/typescript/handling-failure)
 - [API reference](https://typescript.temporal.io/api/namespaces/common)

package/lib/converter/data-converter.d.ts

@@ -7,7 +7,7 @@ import { PayloadConverter } from './payload-converter';
  * The default `DataConverter` supports `undefined`, `Uint8Array`, and JSON serializables (so if
  * [`JSON.stringify(yourArgOrRetval)`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#description)
  * works, the default data converter will work). Protobufs are supported via [this
- * API](https://docs.temporal.io/docs/typescript/data-converters#protobufs).
+ * API](https://docs.temporal.io/typescript/data-converters#protobufs).
  *
  * Use a custom `DataConverter` to control the contents of your {@link Payload}s. Common reasons for using a custom
  * `DataConverter` are:
@@ -32,15 +32,19 @@ export interface DataConverter {
      */
     payloadConverterPath?: string;
     /**
-     * A {@link PayloadCodec} instance. The default codec is a no-op.
+     * An array of {@link PayloadCodec} instances.
+     *
+     * Payloads are encoded in the order of the array and decoded in the opposite order. For example, if you have a
+     * compression codec and an encryption codec, then you want data to be encoded with the compression codec first, so
+     * you'd do `payloadCodecs: [compressionCodec, encryptionCodec]`.
      */
-    payloadCodec?: PayloadCodec;
+    payloadCodecs?: PayloadCodec[];
 }
 /**
  * A {@link DataConverter} that has been loaded via {@link loadDataConverter}.
  */
 export interface LoadedDataConverter {
     payloadConverter: PayloadConverter;
-    payloadCodec: PayloadCodec;
+    payloadCodecs: PayloadCodec[];
 }
 export declare const defaultDataConverter: LoadedDataConverter;

package/lib/converter/data-converter.js

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultDataConverter = void 0;
-const payload_codec_1 = require("./payload-codec");
-const payload_converter_1 = require("./payload-converter");
+const payload_converters_1 = require("./payload-converters");
 exports.defaultDataConverter = {
-    payloadConverter: payload_converter_1.defaultPayloadConverter,
-    payloadCodec: payload_codec_1.defaultPayloadCodec,
+    payloadConverter: payload_converters_1.defaultPayloadConverter,
+    payloadCodecs: [],
 };
 //# sourceMappingURL=data-converter.js.map

package/lib/converter/data-converter.js.map

@@ -1 +1 @@
-{"version":3,"file":"data-converter.js","sourceRoot":"","sources":["../../src/converter/data-converter.ts"],"names":[],"mappings":";;;AAAA,mDAAoE;AACpE,2DAAgF;AAgDnE,QAAA,oBAAoB,GAAwB;IACvD,gBAAgB,EAAE,2CAAuB;IACzC,YAAY,EAAE,mCAAmB;CAClC,CAAC"}
+{"version":3,"file":"data-converter.js","sourceRoot":"","sources":["../../src/converter/data-converter.ts"],"names":[],"mappings":";;;AAEA,6DAA+D;AAoDlD,QAAA,oBAAoB,GAAwB;IACvD,gBAAgB,EAAE,4CAAuB;IACzC,aAAa,EAAE,EAAE;CAClB,CAAC"}

package/lib/converter/json-payload-converter.d.ts

@@ -0,0 +1,10 @@
+import { PayloadConverterWithEncoding } from './payload-converters';
+import { Payload } from './types';
+/**
+ * Converts between non-undefined values and serialized JSON Payload
+ */
+export declare class JsonPayloadConverter implements PayloadConverterWithEncoding {
+    encodingType: "json/plain";
+    toPayload(value: unknown): Payload | undefined;
+    fromPayload<T>(content: Payload): T;
+}

package/lib/converter/json-payload-converter.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonPayloadConverter = void 0;
+const internal_workflow_common_1 = require("@temporalio/internal-workflow-common");
+const types_1 = require("./types");
+/**
+ * Converts between non-undefined values and serialized JSON Payload
+ */
+class JsonPayloadConverter {
+    constructor() {
+        this.encodingType = types_1.encodingTypes.METADATA_ENCODING_JSON;
+    }
+    toPayload(value) {
+        if (value === undefined) {
+            return undefined;
+        }
+        let json;
+        try {
+            json = JSON.stringify(value);
+        }
+        catch (e) {
+            return undefined;
+        }
+        return {
+            metadata: {
+                [types_1.METADATA_ENCODING_KEY]: types_1.encodingKeys.METADATA_ENCODING_JSON,
+            },
+            data: (0, types_1.u8)(json),
+        };
+    }
+    fromPayload(content) {
+        if (content.data === undefined || content.data === null) {
+            throw new internal_workflow_common_1.ValueError('Got payload with no data');
+        }
+        return JSON.parse((0, types_1.str)(content.data));
+    }
+}
+exports.JsonPayloadConverter = JsonPayloadConverter;
+//# sourceMappingURL=json-payload-converter.js.map

package/lib/converter/json-payload-converter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-payload-converter.js","sourceRoot":"","sources":["../../src/converter/json-payload-converter.ts"],"names":[],"mappings":";;;AAAA,mFAAkE;AAElE,mCAA+F;AAE/F;;GAEG;AACH,MAAa,oBAAoB;IAAjC;QACS,iBAAY,GAAG,qBAAa,CAAC,sBAAsB,CAAC;IA4B7D,CAAC;IA1BQ,SAAS,CAAC,KAAc;QAC7B,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,OAAO,SAAS,CAAC;SAClB;QAED,IAAI,IAAI,CAAC;QACT,IAAI;YACF,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;SAC9B;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,SAAS,CAAC;SAClB;QAED,OAAO;YACL,QAAQ,EAAE;gBACR,CAAC,6BAAqB,CAAC,EAAE,oBAAY,CAAC,sBAAsB;aAC7D;YACD,IAAI,EAAE,IAAA,UAAE,EAAC,IAAI,CAAC;SACf,CAAC;IACJ,CAAC;IAEM,WAAW,CAAI,OAAgB;QACpC,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE;YACvD,MAAM,IAAI,qCAAU,CAAC,0BAA0B,CAAC,CAAC;SAClD;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAA,WAAG,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACvC,CAAC;CACF;AA7BD,oDA6BC"}

package/lib/converter/patch-protobuf-root.d.ts

@@ -1,8 +1 @@
-/**
- * Create a version of `root` with non-nested namespaces to match the generated types.
- * For more information, see:
- * https://github.com/temporalio/sdk-typescript/blob/main/docs/protobuf-libraries.md#current-solution
- * @param root Generated by `pbjs -t json-module -w commonjs -o json-module.js *.proto`
- * @returns A new patched `root`
- */
-export declare function patchProtobufRoot<T extends Record<string, unknown>>(root: T): T;
+export { patchProtobufRoot } from '@temporalio/proto/lib/patch-protobuf-root';

package/lib/converter/patch-protobuf-root.js

@@ -1,43 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.patchProtobufRoot = void 0;
-const internal_workflow_common_1 = require("@temporalio/internal-workflow-common");
-/**
- * Create a version of `root` with non-nested namespaces to match the generated types.
- * For more information, see:
- * https://github.com/temporalio/sdk-typescript/blob/main/docs/protobuf-libraries.md#current-solution
- * @param root Generated by `pbjs -t json-module -w commonjs -o json-module.js *.proto`
- * @returns A new patched `root`
- */
-function patchProtobufRoot(root) {
-    return _patchProtobufRoot(root);
-}
-exports.patchProtobufRoot = patchProtobufRoot;
-function _patchProtobufRoot(root, name) {
-    const newRoot = new root.constructor(isNamespace(root) ? name : {});
-    for (const key in root) {
-        newRoot[key] = root[key];
-    }
-    if ((0, internal_workflow_common_1.isRecord)(root.nested)) {
-        for (const typeOrNamespace in root.nested) {
-            const value = root.nested[typeOrNamespace];
-            if (typeOrNamespace in root && !(isType(root[typeOrNamespace]) || isNamespace(root[typeOrNamespace]))) {
-                console.log(`patchRoot warning: overriding property '${typeOrNamespace}' that is used by protobufjs with the '${typeOrNamespace}' protobuf namespace. This may result in protobufjs not working property.`);
-            }
-            if (isNamespace(value)) {
-                newRoot[typeOrNamespace] = _patchProtobufRoot(value, typeOrNamespace);
-            }
-            else if (isType(value)) {
-                newRoot[typeOrNamespace] = value;
-            }
-        }
-    }
-    return newRoot;
-}
-function isType(value) {
-    return (0, internal_workflow_common_1.isRecord)(value) && value.constructor.name === 'Type';
-}
-function isNamespace(value) {
-    return (0, internal_workflow_common_1.isRecord)(value) && value.constructor.name === 'Namespace';
-}
+var patch_protobuf_root_1 = require("@temporalio/proto/lib/patch-protobuf-root");
+Object.defineProperty(exports, "patchProtobufRoot", { enumerable: true, get: function () { return patch_protobuf_root_1.patchProtobufRoot; } });
 //# sourceMappingURL=patch-protobuf-root.js.map

package/lib/converter/patch-protobuf-root.js.map

@@ -1 +1 @@
-{"version":3,"file":"patch-protobuf-root.js","sourceRoot":"","sources":["../../src/converter/patch-protobuf-root.ts"],"names":[],"mappings":";;;AAAA,mFAAgE;AAEhE;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAAoC,IAAO;IAC1E,OAAO,kBAAkB,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC;AAFD,8CAEC;AAED,SAAS,kBAAkB,CAAoC,IAAO,EAAE,IAAa;IACnF,MAAM,OAAO,GAAG,IAAK,IAAI,CAAC,WAAmB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC7E,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACtB,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;KAC1B;IAED,IAAI,IAAA,mCAAQ,EAAC,IAAI,CAAC,MAAM,CAAC,EAAE;QACzB,KAAK,MAAM,eAAe,IAAI,IAAI,CAAC,MAAM,EAAE;YACzC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;YAC3C,IAAI,eAAe,IAAI,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE;gBACrG,OAAO,CAAC,GAAG,CACT,2CAA2C,eAAe,0CAA0C,eAAe,2EAA2E,CAC/L,CAAC;aACH;YAED,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE;gBACtB,OAAO,CAAC,eAAe,CAAC,GAAG,kBAAkB,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;aACvE;iBAAM,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE;gBACxB,OAAO,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC;aAClC;SACF;KACF;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAKD,SAAS,MAAM,CAAC,KAAc;IAC5B,OAAO,IAAA,mCAAQ,EAAC,KAAK,CAAC,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,MAAM,CAAC;AAC9D,CAAC;AAED,SAAS,WAAW,CAAC,KAAc;IACjC,OAAO,IAAA,mCAAQ,EAAC,KAAK,CAAC,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,WAAW,CAAC;AACnE,CAAC"}
+{"version":3,"file":"patch-protobuf-root.js","sourceRoot":"","sources":["../../src/converter/patch-protobuf-root.ts"],"names":[],"mappings":";;;AAAA,iFAA8E;AAArE,wHAAA,iBAAiB,OAAA"}

package/lib/converter/payload-codec.d.ts

@@ -18,10 +18,3 @@ export interface PayloadCodec {
      */
     decode(payloads: Payload[]): Promise<Payload[]>;
 }
-/**
- * No-op implementation of {@link PayloadCodec}.
- */
-export declare const defaultPayloadCodec: {
-    encode: (payloads: Payload[]) => Promise<Payload[]>;
-    decode: (payloads: Payload[]) => Promise<Payload[]>;
-};

package/lib/converter/payload-codec.js

@@ -1,11 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultPayloadCodec = void 0;
-/**
- * No-op implementation of {@link PayloadCodec}.
- */
-exports.defaultPayloadCodec = {
-    encode: async (payloads) => payloads,
-    decode: async (payloads) => payloads,
-};
 //# sourceMappingURL=payload-codec.js.map

package/lib/converter/payload-codec.js.map

@@ -1 +1 @@
-{"version":3,"file":"payload-codec.js","sourceRoot":"","sources":["../../src/converter/payload-codec.ts"],"names":[],"mappings":";;;AAuBA;;GAEG;AACU,QAAA,mBAAmB,GAAG;IACjC,MAAM,EAAE,KAAK,EAAE,QAAmB,EAAsB,EAAE,CAAC,QAAQ;IACnE,MAAM,EAAE,KAAK,EAAE,QAAmB,EAAsB,EAAE,CAAC,QAAQ;CACpE,CAAC"}
+{"version":3,"file":"payload-codec.js","sourceRoot":"","sources":["../../src/converter/payload-codec.ts"],"names":[],"mappings":""}

package/lib/converter/payload-converter.d.ts

@@ -1,58 +1,40 @@
-import { JsonPayloadConverter, PayloadConverterWithEncoding } from './payload-converters';
 import { Payload } from './types';
 /**
- * Used by the framework to serialize/deserialize parameters and return values.
+ * Used by the framework to serialize/deserialize data like parameters and return values.
  *
- * This is called inside the [Workflow isolate](https://docs.temporal.io/docs/typescript/determinism).
+ * This is called inside the [Workflow isolate](https://docs.temporal.io/typescript/determinism).
  * To write async code or use Node APIs (or use packages that use Node APIs), use a {@link PayloadCodec}.
  */
 export interface PayloadConverter {
     /**
      * Converts a value to a {@link Payload}.
-     * @param value The value to convert. Example values include the Workflow args sent by the client and the values returned by a Workflow or Activity.
-     */
-    toPayload<T>(value: T): Payload | undefined;
-    /**
-     * Converts a {@link Payload} back to a value.
-     */
-    fromPayload<T>(payload: Payload): T;
-}
-export declare class CompositePayloadConverter implements PayloadConverter {
-    readonly converters: PayloadConverterWithEncoding[];
-    readonly converterByEncoding: Map<string, PayloadConverterWithEncoding>;
-    constructor(...converters: PayloadConverterWithEncoding[]);
-    /**
-     * Tries to run `.toPayload(value)` on each converter in the order provided at construction.
-     * Returns the first successful result, or `undefined` if there is no converter that can handle the value.
      *
-     * @throws UnsupportedJsonTypeError
+     * @param value The value to convert. Example values include the Workflow args sent from the Client and the values returned by a Workflow or Activity.
+     *
+     * @returns The {@link Payload}.
+     *
+     * Should throw {@link ValueError} if unable to convert.
      */
-    toPayload<T>(value: T): Payload | undefined;
+    toPayload<T>(value: T): Payload;
     /**
-     * Run {@link PayloadConverterWithEncoding.fromPayload} based on the {@link encodingTypes | encoding type} of the {@link Payload}.
+     * Converts a {@link Payload} back to a value.
      */
     fromPayload<T>(payload: Payload): T;
 }
-/**
- * Tries to convert `value` to a {@link Payload}. Throws if conversion fails.
- *
- * @throws {@link PayloadConverterError}
- */
-export declare function toPayload(converter: PayloadConverter, value: unknown): Payload;
 /**
  * Implements conversion of a list of values.
  *
  * @param converter
  * @param values JS values to convert to Payloads
- * @return converted values
- * @throws PayloadConverterError if conversion of the value passed as parameter failed for any
+ * @return list of {@link Payload}s
+ * @throws {@link ValueError} if conversion of the value passed as parameter failed for any
  *     reason.
  */
 export declare function toPayloads(converter: PayloadConverter, ...values: unknown[]): Payload[] | undefined;
 /**
  * Run {@link PayloadConverter.toPayload} on each value in the map.
  *
- * @throws {@link PayloadConverterError} if conversion of any value in the map fails
+ * @throws {@link ValueError} if conversion of any value in the map fails
  */
 export declare function mapToPayloads<K extends string>(converter: PayloadConverter, map: Record<K, any>): Record<K, Payload>;
 /**
@@ -71,17 +53,4 @@ export declare function fromPayloadsAtIndex<T>(converter: PayloadConverter, inde
  * Run {@link PayloadConverter.fromPayload} on each value in the array.
  */
 export declare function arrayFromPayloads(converter: PayloadConverter, payloads?: Payload[] | null): unknown[];
-export declare function mapFromPayloads<K extends string>(converter: PayloadConverter, map?: Record<K, Payload> | null | undefined): Record<K, unknown> | undefined;
-export declare const searchAttributePayloadConverter: JsonPayloadConverter;
-export declare class DefaultPayloadConverter extends CompositePayloadConverter {
-    constructor();
-}
-/**
- * The default {@link PayloadConverter} used by the SDK.
- * Supports `Uint8Array` and JSON serializables (so if [`JSON.stringify(yourArgOrRetval)`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#description) works, the default payload converter will work).
- *
- * To also support Protobufs, create a custom payload converter with {@link DefaultPayloadConverter}:
- *
- * `const myConverter = new DefaultPayloadConverter({ protobufRoot })`
- */
-export declare const defaultPayloadConverter: DefaultPayloadConverter;
+export declare function mapFromPayloads<K extends string>(converter: PayloadConverter, map?: Record<K, Payload> | null | undefined): Record<K, unknown> | undefined | null;

package/lib/converter/payload-converter.js

@@ -1,84 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultPayloadConverter = exports.DefaultPayloadConverter = exports.searchAttributePayloadConverter = exports.mapFromPayloads = exports.arrayFromPayloads = exports.fromPayloadsAtIndex = exports.mapToPayloads = exports.toPayloads = exports.toPayload = exports.CompositePayloadConverter = void 0;
-const internal_workflow_common_1 = require("@temporalio/internal-workflow-common");
-const payload_converters_1 = require("./payload-converters");
-const types_1 = require("./types");
-class CompositePayloadConverter {
-    constructor(...converters) {
-        this.converterByEncoding = new Map();
-        this.converters = converters;
-        for (const converter of converters) {
-            this.converterByEncoding.set(converter.encodingType, converter);
-        }
-    }
-    /**
-     * Tries to run `.toPayload(value)` on each converter in the order provided at construction.
-     * Returns the first successful result, or `undefined` if there is no converter that can handle the value.
-     *
-     * @throws UnsupportedJsonTypeError
-     */
-    toPayload(value) {
-        for (const converter of this.converters) {
-            const result = converter.toPayload(value);
-            if (result !== undefined) {
-                return result;
-            }
-        }
-        return undefined;
-    }
-    /**
-     * Run {@link PayloadConverterWithEncoding.fromPayload} based on the {@link encodingTypes | encoding type} of the {@link Payload}.
-     */
-    fromPayload(payload) {
-        if (payload.metadata === undefined || payload.metadata === null) {
-            throw new internal_workflow_common_1.ValueError('Missing payload metadata');
-        }
-        const encoding = (0, types_1.str)(payload.metadata[types_1.METADATA_ENCODING_KEY]);
-        const converter = this.converterByEncoding.get(encoding);
-        if (converter === undefined) {
-            throw new internal_workflow_common_1.ValueError(`Unknown encoding: ${encoding}`);
-        }
-        return converter.fromPayload(payload);
-    }
-}
-exports.CompositePayloadConverter = CompositePayloadConverter;
-/**
- * Tries to convert `value` to a {@link Payload}. Throws if conversion fails.
- *
- * @throws {@link PayloadConverterError}
- */
-function toPayload(converter, value) {
-    const payload = converter.toPayload(value);
-    if (payload === undefined) {
-        throw new internal_workflow_common_1.PayloadConverterError(`Failed to convert value: ${value}`);
-    }
-    return payload;
-}
-exports.toPayload = toPayload;
+exports.mapFromPayloads = exports.arrayFromPayloads = exports.fromPayloadsAtIndex = exports.mapToPayloads = exports.toPayloads = void 0;
 /**
  * Implements conversion of a list of values.
  *
  * @param converter
  * @param values JS values to convert to Payloads
- * @return converted values
- * @throws PayloadConverterError if conversion of the value passed as parameter failed for any
+ * @return list of {@link Payload}s
+ * @throws {@link ValueError} if conversion of the value passed as parameter failed for any
  *     reason.
  */
 function toPayloads(converter, ...values) {
     if (values.length === 0) {
         return undefined;
     }
-    return values.map((value) => toPayload(converter, value));
+    return values.map((value) => converter.toPayload(value));
 }
 exports.toPayloads = toPayloads;
 /**
  * Run {@link PayloadConverter.toPayload} on each value in the map.
  *
- * @throws {@link PayloadConverterError} if conversion of any value in the map fails
+ * @throws {@link ValueError} if conversion of any value in the map fails
  */
 function mapToPayloads(converter, map) {
-    return Object.fromEntries(Object.entries(map).map(([k, v]) => [k, toPayload(converter, v)]));
+    return Object.fromEntries(Object.entries(map).map(([k, v]) => [k, converter.toPayload(v)]));
 }
 exports.mapToPayloads = mapToPayloads;
 /**
@@ -111,34 +56,12 @@ function arrayFromPayloads(converter, payloads) {
 }
 exports.arrayFromPayloads = arrayFromPayloads;
 function mapFromPayloads(converter, map) {
-    if (map === undefined || map === null)
-        return undefined;
+    if (map == null)
+        return map;
     return Object.fromEntries(Object.entries(map).map(([k, payload]) => {
         const value = converter.fromPayload(payload);
         return [k, value];
     }));
 }
 exports.mapFromPayloads = mapFromPayloads;
-exports.searchAttributePayloadConverter = new payload_converters_1.JsonPayloadConverter();
-class DefaultPayloadConverter extends CompositePayloadConverter {
-    // Match the order used in other SDKs, but exclude Protobuf converters so that the code, including
-    // `proto3-json-serializer`, doesn't take space in Workflow bundles that don't use Protobufs. To use Protobufs, use
-    // {@link DefaultPayloadConverterWithProtobufs}.
-    //
-    // Go SDK:
-    // https://github.com/temporalio/sdk-go/blob/5e5645f0c550dcf717c095ae32c76a7087d2e985/converter/default_data_converter.go#L28
-    constructor() {
-        super(new payload_converters_1.UndefinedPayloadConverter(), new payload_converters_1.BinaryPayloadConverter(), new payload_converters_1.JsonPayloadConverter());
-    }
-}
-exports.DefaultPayloadConverter = DefaultPayloadConverter;
-/**
- * The default {@link PayloadConverter} used by the SDK.
- * Supports `Uint8Array` and JSON serializables (so if [`JSON.stringify(yourArgOrRetval)`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#description) works, the default payload converter will work).
- *
- * To also support Protobufs, create a custom payload converter with {@link DefaultPayloadConverter}:
- *
- * `const myConverter = new DefaultPayloadConverter({ protobufRoot })`
- */
-exports.defaultPayloadConverter = new DefaultPayloadConverter();
 //# sourceMappingURL=payload-converter.js.map

package/lib/converter/payload-converter.js.map

@@ -1 +1 @@
-{"version":3,"file":"payload-converter.js","sourceRoot":"","sources":["../../src/converter/payload-converter.ts"],"names":[],"mappings":";;;AAAA,mFAAyF;AACzF,6DAK8B;AAC9B,mCAA8D;AAqB9D,MAAa,yBAAyB;IAIpC,YAAY,GAAG,UAA0C;QAFhD,wBAAmB,GAA8C,IAAI,GAAG,EAAE,CAAC;QAGlF,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;YAClC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;SACjE;IACH,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAI,KAAQ;QAC1B,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE;YACvC,MAAM,MAAM,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC1C,IAAI,MAAM,KAAK,SAAS,EAAE;gBACxB,OAAO,MAAM,CAAC;aACf;SACF;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,WAAW,CAAI,OAAgB;QACpC,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,EAAE;YAC/D,MAAM,IAAI,qCAAU,CAAC,0BAA0B,CAAC,CAAC;SAClD;QACD,MAAM,QAAQ,GAAG,IAAA,WAAG,EAAC,OAAO,CAAC,QAAQ,CAAC,6BAAqB,CAAC,CAAC,CAAC;QAC9D,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACzD,IAAI,SAAS,KAAK,SAAS,EAAE;YAC3B,MAAM,IAAI,qCAAU,CAAC,qBAAqB,QAAQ,EAAE,CAAC,CAAC;SACvD;QACD,OAAO,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;CACF;AAzCD,8DAyCC;AAED;;;;GAIG;AACH,SAAgB,SAAS,CAAC,SAA2B,EAAE,KAAc;IACnE,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC3C,IAAI,OAAO,KAAK,SAAS,EAAE;QACzB,MAAM,IAAI,gDAAqB,CAAC,4BAA4B,KAAK,EAAE,CAAC,CAAC;KACtE;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAND,8BAMC;AAED;;;;;;;;GAQG;AACH,SAAgB,UAAU,CAAC,SAA2B,EAAE,GAAG,MAAiB;IAC1E,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QACvB,OAAO,SAAS,CAAC;KAClB;IAED,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;AAC5D,CAAC;AAND,gCAMC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAAmB,SAA2B,EAAE,GAAmB;IAC9F,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAgB,EAAE,CAAC,CAAC,CAAM,EAAE,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAC/D,CAAC;AAC1B,CAAC;AAJD,sCAIC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,mBAAmB,CAAI,SAA2B,EAAE,KAAa,EAAE,QAA2B;IAC5G,yDAAyD;IACzD,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,IAAI,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE;QAC3E,OAAO,SAAgB,CAAC;KACzB;IACD,OAAO,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;AAChD,CAAC;AAND,kDAMC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAAC,SAA2B,EAAE,QAA2B;IACxF,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,EAAE,CAAC;KACX;IACD,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAgB,EAAE,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;AAC5E,CAAC;AALD,8CAKC;AAED,SAAgB,eAAe,CAC7B,SAA2B,EAC3B,GAA2C;IAE3C,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,SAAS,CAAC;IACxD,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAgB,EAAE;QACrD,MAAM,KAAK,GAAG,SAAS,CAAC,WAAW,CAAC,OAAkB,CAAC,CAAC;QACxD,OAAO,CAAC,CAAM,EAAE,KAAK,CAAC,CAAC;IACzB,CAAC,CAAC,CACmB,CAAC;AAC1B,CAAC;AAXD,0CAWC;AAEY,QAAA,+BAA+B,GAAG,IAAI,yCAAoB,EAAE,CAAC;AAE1E,MAAa,uBAAwB,SAAQ,yBAAyB;IACpE,kGAAkG;IAClG,mHAAmH;IACnH,gDAAgD;IAChD,EAAE;IACF,UAAU;IACV,6HAA6H;IAC7H;QACE,KAAK,CAAC,IAAI,8CAAyB,EAAE,EAAE,IAAI,2CAAsB,EAAE,EAAE,IAAI,yCAAoB,EAAE,CAAC,CAAC;IACnG,CAAC;CACF;AAVD,0DAUC;AAED;;;;;;;GAOG;AACU,QAAA,uBAAuB,GAAG,IAAI,uBAAuB,EAAE,CAAC"}
+{"version":3,"file":"payload-converter.js","sourceRoot":"","sources":["../../src/converter/payload-converter.ts"],"names":[],"mappings":";;;AA0BA;;;;;;;;GAQG;AACH,SAAgB,UAAU,CAAC,SAA2B,EAAE,GAAG,MAAiB;IAC1E,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QACvB,OAAO,SAAS,CAAC;KAClB;IAED,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;AAC3D,CAAC;AAND,gCAMC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAAmB,SAA2B,EAAE,GAAmB;IAC9F,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAgB,EAAE,CAAC,CAAC,CAAM,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAC9D,CAAC;AAC1B,CAAC;AAJD,sCAIC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,mBAAmB,CAAI,SAA2B,EAAE,KAAa,EAAE,QAA2B;IAC5G,yDAAyD;IACzD,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,IAAI,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE;QAC3E,OAAO,SAAgB,CAAC;KACzB;IACD,OAAO,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;AAChD,CAAC;AAND,kDAMC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAAC,SAA2B,EAAE,QAA2B;IACxF,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,EAAE,CAAC;KACX;IACD,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAgB,EAAE,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;AAC5E,CAAC;AALD,8CAKC;AAED,SAAgB,eAAe,CAC7B,SAA2B,EAC3B,GAA2C;IAE3C,IAAI,GAAG,IAAI,IAAI;QAAE,OAAO,GAAG,CAAC;IAC5B,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAgB,EAAE;QACrD,MAAM,KAAK,GAAG,SAAS,CAAC,WAAW,CAAC,OAAkB,CAAC,CAAC;QACxD,OAAO,CAAC,CAAM,EAAE,KAAK,CAAC,CAAC;IACzB,CAAC,CAAC,CACmB,CAAC;AAC1B,CAAC;AAXD,0CAWC"}

package/lib/converter/payload-converters.d.ts

@@ -1,7 +1,39 @@
 import { PayloadConverter } from './payload-converter';
-import { EncodingType, Payload } from './types';
-export interface PayloadConverterWithEncoding extends PayloadConverter {
-    readonly encodingType: EncodingType;
+import { SearchAttributePayloadConverter } from './search-attribute-payload-converter';
+import { Payload } from './types';
+export interface PayloadConverterWithEncoding {
+    /**
+     * Converts a value to a {@link Payload}.
+     *
+     * @param value The value to convert. Example values include the Workflow args sent from the Client and the values returned by a Workflow or Activity.
+     * @returns The {@link Payload}, or `undefined` if unable to convert.
+     */
+    toPayload<T>(value: T): Payload | undefined;
+    /**
+     * Converts a {@link Payload} back to a value.
+     */
+    fromPayload<T>(payload: Payload): T;
+    readonly encodingType: string;
+}
+/**
+ * Tries to convert values to {@link Payload}s using the {@link PayloadConverterWithEncoding}s provided to the constructor, in the order provided.
+ *
+ * Converts Payloads to values based on the `Payload.metadata.encoding` field, which matches the {@link PayloadConverterWithEncoding.encodingType}
+ * of the converter that created the Payload.
+ */
+export declare class CompositePayloadConverter implements PayloadConverter {
+    readonly converters: PayloadConverterWithEncoding[];
+    readonly converterByEncoding: Map<string, PayloadConverterWithEncoding>;
+    constructor(...converters: PayloadConverterWithEncoding[]);
+    /**
+     * Tries to run `.toPayload(value)` on each converter in the order provided at construction.
+     * Returns the first successful result, throws {@link ValueError} if there is no converter that can handle the value.
+     */
+    toPayload<T>(value: T): Payload;
+    /**
+     * Run {@link PayloadConverterWithEncoding.fromPayload} based on the {@link encodingTypes | encoding type} of the {@link Payload}.
+     */
+    fromPayload<T>(payload: Payload): T;
 }
 /**
  * Converts between JS undefined and NULL Payload
@@ -11,16 +43,6 @@ export declare class UndefinedPayloadConverter implements PayloadConverterWithEn
     toPayload(value: unknown): Payload | undefined;
     fromPayload<T>(_content: Payload): T;
 }
-/**
- * Converts between non-undefined values and serialized JSON Payload
- *
- * @throws UnsupportedJsonTypeError
- */
-export declare class JsonPayloadConverter implements PayloadConverterWithEncoding {
-    encodingType: "json/plain";
-    toPayload(value: unknown): Payload | undefined;
-    fromPayload<T>(content: Payload): T;
-}
 /**
  * Converts between binary data types and RAW Payload
  */
@@ -29,3 +51,16 @@ export declare class BinaryPayloadConverter implements PayloadConverterWithEncod
     toPayload(value: unknown): Payload | undefined;
     fromPayload<T>(content: Payload): T;
 }
+export declare const searchAttributePayloadConverter: SearchAttributePayloadConverter;
+export declare class DefaultPayloadConverter extends CompositePayloadConverter {
+    constructor();
+}
+/**
+ * The default {@link PayloadConverter} used by the SDK.
+ * Supports `Uint8Array` and JSON serializables (so if [`JSON.stringify(yourArgOrRetval)`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#description) works, the default payload converter will work).
+ *
+ * To also support Protobufs, create a custom payload converter with {@link DefaultPayloadConverter}:
+ *
+ * `const myConverter = new DefaultPayloadConverter({ protobufRoot })`
+ */
+export declare const defaultPayloadConverter: DefaultPayloadConverter;