@temporalio/common 1.1.0 → 1.4.0

package/lib/converter/search-attribute-payload-converter.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchAttributePayloadConverter = void 0;
-const internal_workflow_common_1 = require("@temporalio/internal-workflow-common");
-const json_payload_converter_1 = require("./json-payload-converter");
-const types_1 = require("./types");
-const jsonConverter = new json_payload_converter_1.JsonPayloadConverter();
-const validNonDateTypes = ['string', 'number', 'boolean'];
-/**
- * Converts Search Attribute values using JsonPayloadConverter
- */
-class SearchAttributePayloadConverter {
-    toPayload(values) {
-        if (!(values instanceof Array)) {
-            throw new internal_workflow_common_1.ValueError(`SearchAttribute value must be an array`);
-        }
-        if (values.length > 0) {
-            const firstValue = values[0];
-            const firstType = typeof firstValue;
-            if (firstType === 'object') {
-                for (const idx in values) {
-                    const value = values[idx];
-                    if (!(value instanceof Date)) {
-                        throw new internal_workflow_common_1.ValueError(`SearchAttribute values must arrays of strings, numbers, booleans, or Dates. The value ${value} at index ${idx} is of type ${typeof value}`);
-                    }
-                }
-            }
-            else {
-                if (!validNonDateTypes.includes(firstType)) {
-                    throw new internal_workflow_common_1.ValueError(`SearchAttribute array values must be: string | number | boolean | Date`);
-                }
-                for (const idx in values) {
-                    const value = values[idx];
-                    if (typeof value !== firstType) {
-                        throw new internal_workflow_common_1.ValueError(`All SearchAttribute array values must be of the same type. The first value ${firstValue} of type ${firstType} doesn't match value ${value} of type ${typeof value} at index ${idx}`);
-                    }
-                }
-            }
-        }
-        // JSON.stringify takes care of converting Dates to ISO strings
-        const ret = jsonConverter.toPayload(values);
-        if (ret === undefined) {
-            throw new internal_workflow_common_1.IllegalStateError('Could not convert search attributes to payloads');
-        }
-        return ret;
-    }
-    /**
-     * Datetime Search Attribute values are converted to `Date`s
-     */
-    fromPayload(payload) {
-        if (payload.metadata === undefined || payload.metadata === null) {
-            throw new internal_workflow_common_1.ValueError('Missing payload metadata');
-        }
-        const value = jsonConverter.fromPayload(payload);
-        let arrayWrappedValue = value instanceof Array ? value : [value];
-        const searchAttributeType = (0, types_1.str)(payload.metadata.type);
-        if (searchAttributeType === 'Datetime') {
-            arrayWrappedValue = arrayWrappedValue.map((dateString) => new Date(dateString));
-        }
-        return arrayWrappedValue;
-    }
-}
-exports.SearchAttributePayloadConverter = SearchAttributePayloadConverter;
-//# sourceMappingURL=search-attribute-payload-converter.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"search-attribute-payload-converter.js","sourceRoot":"","sources":["../../src/converter/search-attribute-payload-converter.ts"],"names":[],"mappings":";;;AAAA,mFAAqF;AAErF,qEAAgE;AAChE,mCAAuC;AAEvC,MAAM,aAAa,GAAG,IAAI,6CAAoB,EAAE,CAAC;AACjD,MAAM,iBAAiB,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAa,+BAA+B;IACnC,SAAS,CAAC,MAAe;QAC9B,IAAI,CAAC,CAAC,MAAM,YAAY,KAAK,CAAC,EAAE;YAC9B,MAAM,IAAI,qCAAU,CAAC,wCAAwC,CAAC,CAAC;SAChE;QAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACrB,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,SAAS,GAAG,OAAO,UAAU,CAAC;YACpC,IAAI,SAAS,KAAK,QAAQ,EAAE;gBAC1B,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;oBACxB,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;oBAC1B,IAAI,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,EAAE;wBAC5B,MAAM,IAAI,qCAAU,CAClB,yFAAyF,KAAK,aAAa,GAAG,eAAe,OAAO,KAAK,EAAE,CAC5I,CAAC;qBACH;iBACF;aACF;iBAAM;gBACL,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;oBAC1C,MAAM,IAAI,qCAAU,CAAC,wEAAwE,CAAC,CAAC;iBAChG;gBAED,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;oBACxB,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;oBAC1B,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;wBAC9B,MAAM,IAAI,qCAAU,CAClB,8EAA8E,UAAU,YAAY,SAAS,wBAAwB,KAAK,YAAY,OAAO,KAAK,aAAa,GAAG,EAAE,CACrL,CAAC;qBACH;iBACF;aACF;SACF;QAED,+DAA+D;QAC/D,MAAM,GAAG,GAAG,aAAa,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,GAAG,KAAK,SAAS,EAAE;YACrB,MAAM,IAAI,4CAAiB,CAAC,iDAAiD,CAAC,CAAC;SAChF;QACD,OAAO,GAAG,CAAC;IACb,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;QAED,MAAM,KAAK,GAAG,aAAa,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,iBAAiB,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAEjE,MAAM,mBAAmB,GAAG,IAAA,WAAG,EAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvD,IAAI,mBAAmB,KAAK,UAAU,EAAE;YACtC,iBAAiB,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;SACjF;QACD,OAAO,iBAAiC,CAAC;IAC3C,CAAC;CACF;AA3DD,0EA2DC"}

package/src/converter/json-payload-converter.ts

@@ -1,37 +0,0 @@
-import { ValueError } from '@temporalio/internal-workflow-common';
-import { PayloadConverterWithEncoding } from './payload-converters';
-import { encodingKeys, encodingTypes, METADATA_ENCODING_KEY, Payload, str, u8 } from './types';
-
-/**
- * Converts between non-undefined values and serialized JSON Payload
- */
-export class JsonPayloadConverter implements PayloadConverterWithEncoding {
-  public encodingType = encodingTypes.METADATA_ENCODING_JSON;
-
-  public toPayload(value: unknown): Payload | undefined {
-    if (value === undefined) {
-      return undefined;
-    }
-
-    let json;
-    try {
-      json = JSON.stringify(value);
-    } catch (e) {
-      return undefined;
-    }
-
-    return {
-      metadata: {
-        [METADATA_ENCODING_KEY]: encodingKeys.METADATA_ENCODING_JSON,
-      },
-      data: u8(json),
-    };
-  }
-
-  public fromPayload<T>(content: Payload): T {
-    if (content.data === undefined || content.data === null) {
-      throw new ValueError('Got payload with no data');
-    }
-    return JSON.parse(str(content.data));
-  }
-}

package/src/converter/payload-converters.ts

@@ -1,148 +0,0 @@
-import { PayloadConverterError, ValueError } from '@temporalio/internal-workflow-common';
-import { JsonPayloadConverter } from './json-payload-converter';
-import { PayloadConverter } from './payload-converter';
-import { SearchAttributePayloadConverter } from './search-attribute-payload-converter';
-import { encodingKeys, encodingTypes, METADATA_ENCODING_KEY, Payload, str } 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 class CompositePayloadConverter implements PayloadConverter {
-  readonly converters: PayloadConverterWithEncoding[];
-  readonly converterByEncoding: Map<string, PayloadConverterWithEncoding> = new Map();
-
-  constructor(...converters: PayloadConverterWithEncoding[]) {
-    if (converters.length === 0) {
-      throw new PayloadConverterError('Must provide at least one PayloadConverterWithEncoding');
-    }
-
-    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, throws {@link ValueError} if there is no converter that can handle the value.
-   */
-  public toPayload<T>(value: T): Payload {
-    for (const converter of this.converters) {
-      const result = converter.toPayload(value);
-      if (result !== undefined) {
-        return result;
-      }
-    }
-
-    throw new ValueError(`Unable to convert ${value} to payload`);
-  }
-
-  /**
-   * Run {@link PayloadConverterWithEncoding.fromPayload} based on the {@link encodingTypes | encoding type} of the {@link Payload}.
-   */
-  public fromPayload<T>(payload: Payload): T {
-    if (payload.metadata === undefined || payload.metadata === null) {
-      throw new ValueError('Missing payload metadata');
-    }
-    const encoding = str(payload.metadata[METADATA_ENCODING_KEY]);
-    const converter = this.converterByEncoding.get(encoding);
-    if (converter === undefined) {
-      throw new ValueError(`Unknown encoding: ${encoding}`);
-    }
-    return converter.fromPayload(payload);
-  }
-}
-
-/**
- * Converts between JS undefined and NULL Payload
- */
-export class UndefinedPayloadConverter implements PayloadConverterWithEncoding {
-  public encodingType = encodingTypes.METADATA_ENCODING_NULL;
-
-  public toPayload(value: unknown): Payload | undefined {
-    if (value !== undefined) {
-      return undefined;
-    }
-
-    return {
-      metadata: {
-        [METADATA_ENCODING_KEY]: encodingKeys.METADATA_ENCODING_NULL,
-      },
-    };
-  }
-
-  public fromPayload<T>(_content: Payload): T {
-    return undefined as any; // Just return undefined
-  }
-}
-
-/**
- * Converts between binary data types and RAW Payload
- */
-export class BinaryPayloadConverter implements PayloadConverterWithEncoding {
-  public encodingType = encodingTypes.METADATA_ENCODING_RAW;
-
-  public toPayload(value: unknown): Payload | undefined {
-    // TODO: support any DataView or ArrayBuffer?
-    if (!(value instanceof Uint8Array)) {
-      return undefined;
-    }
-
-    return {
-      metadata: {
-        [METADATA_ENCODING_KEY]: encodingKeys.METADATA_ENCODING_RAW,
-      },
-      data: value,
-    };
-  }
-
-  public fromPayload<T>(content: Payload): T {
-    // TODO: support any DataView or ArrayBuffer?
-    return content.data as any;
-  }
-}
-
-export const searchAttributePayloadConverter = new SearchAttributePayloadConverter();
-
-export 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 UndefinedPayloadConverter(), new BinaryPayloadConverter(), new JsonPayloadConverter());
-  }
-}
-
-/**
- * The default {@link PayloadConverter} used by the SDK. Supports `Uint8Array` and JSON serializables (so if
- * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#description | `JSON.stringify(yourArgOrRetval)`}
- * 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 const defaultPayloadConverter = new DefaultPayloadConverter();

package/src/converter/search-attribute-payload-converter.ts

@@ -1,71 +0,0 @@
-import { IllegalStateError, ValueError } from '@temporalio/internal-workflow-common';
-import { PayloadConverter } from './payload-converter';
-import { JsonPayloadConverter } from './json-payload-converter';
-import { Payload, str } from './types';
-
-const jsonConverter = new JsonPayloadConverter();
-const validNonDateTypes = ['string', 'number', 'boolean'];
-
-/**
- * Converts Search Attribute values using JsonPayloadConverter
- */
-export class SearchAttributePayloadConverter implements PayloadConverter {
-  public toPayload(values: unknown): Payload {
-    if (!(values instanceof Array)) {
-      throw new ValueError(`SearchAttribute value must be an array`);
-    }
-
-    if (values.length > 0) {
-      const firstValue = values[0];
-      const firstType = typeof firstValue;
-      if (firstType === 'object') {
-        for (const idx in values) {
-          const value = values[idx];
-          if (!(value instanceof Date)) {
-            throw new ValueError(
-              `SearchAttribute values must arrays of strings, numbers, booleans, or Dates. The value ${value} at index ${idx} is of type ${typeof value}`
-            );
-          }
-        }
-      } else {
-        if (!validNonDateTypes.includes(firstType)) {
-          throw new ValueError(`SearchAttribute array values must be: string | number | boolean | Date`);
-        }
-
-        for (const idx in values) {
-          const value = values[idx];
-          if (typeof value !== firstType) {
-            throw new ValueError(
-              `All SearchAttribute array values must be of the same type. The first value ${firstValue} of type ${firstType} doesn't match value ${value} of type ${typeof value} at index ${idx}`
-            );
-          }
-        }
-      }
-    }
-
-    // JSON.stringify takes care of converting Dates to ISO strings
-    const ret = jsonConverter.toPayload(values);
-    if (ret === undefined) {
-      throw new IllegalStateError('Could not convert search attributes to payloads');
-    }
-    return ret;
-  }
-
-  /**
-   * Datetime Search Attribute values are converted to `Date`s
-   */
-  public fromPayload<T>(payload: Payload): T {
-    if (payload.metadata === undefined || payload.metadata === null) {
-      throw new ValueError('Missing payload metadata');
-    }
-
-    const value = jsonConverter.fromPayload(payload);
-    let arrayWrappedValue = value instanceof Array ? value : [value];
-
-    const searchAttributeType = str(payload.metadata.type);
-    if (searchAttributeType === 'Datetime') {
-      arrayWrappedValue = arrayWrappedValue.map((dateString) => new Date(dateString));
-    }
-    return arrayWrappedValue as unknown as T;
-  }
-}