@outputai/core 0.8.2-next.e1cd79b.0 → 0.8.2-next.e658cc2.0

package/src/utils/utils.js

@@ -1,334 +0,0 @@
-import { METADATA_ACCESS_SYMBOL } from '#consts';
-
-/**
- * Node safe clone implementation that doesn't use global structuredClone()
- * @param {object} v
- * @returns {object}
- */
-export const clone = v => {
-  try {
-    return JSON.parse( JSON.stringify( v ) );
-  } catch {
-    return v;
-  }
-};
-
-/**
- * Detect a JS plain object.
- *
- * @param {unknown} v
- * @returns {boolean}
- */
-export const isPlainObject = v =>
-  typeof v === 'object' &&
-    !Array.isArray( v ) &&
-    v !== null &&
-    [ Object.prototype, null ].includes( Object.getPrototypeOf( v ) );
-
-/**
- * Throw given error
- * @param {Error} e
- * @throws {e}
- */
-export const throws = e => {
-  throw e;
-};
-
-/**
- * Add metadata "values" property to a given object
- * @param {object} target
- * @param {object} values
- * @returns
- */
-export const setMetadata = ( target, values ) =>
-  Object.defineProperty( target, METADATA_ACCESS_SYMBOL, { value: values, writable: false, enumerable: false, configurable: false } );
-
-/**
- * Read metadata previously attached via setMetadata
- * @param {Function} target
- * @returns {object|null}
- */
-export const getMetadata = target => target[METADATA_ACCESS_SYMBOL] ?? null;
-
-/**
- * Returns true if string value is stringbool and true
- * @param {string} v
- * @returns
- */
-export const isStringboolTrue = v => [ '1', 'true', 'on' ].includes( v );
-
-/**
- * Consume Fetch's HTTP Response and return a serialized version of it;
- *
- * @param {Response} response
- * @returns {object} Serialized response
- */
-export const serializeFetchResponse = async response => {
-  const headers = Object.fromEntries( response.headers );
-  const contentType = headers['content-type'] || '';
-
-  const body = await ( async () => {
-    if ( contentType.includes( 'application/json' ) ) {
-      return response.json();
-    }
-    if ( contentType.startsWith( 'text/' ) ) {
-      return response.text();
-    }
-    return response.arrayBuffer().then( buf => Buffer.from( buf ).toString( 'base64' ) );
-  } )();
-
-  return {
-    url: response.url,
-    status: response.status,
-    statusText: response.statusText,
-    ok: response.ok,
-    headers,
-    body
-  };
-};
-
-/**
- * Duck-typing to detect a Node Readable (Stream) without importing anything
- *
- * @param {unknown} v
- * @returns {boolean}
- */
-const isReadable = v =>
-  typeof v === 'object' &&
-  typeof v?.read === 'function' &&
-  typeof v?.on === 'function' &&
-  typeof v?.pipe === 'function' &&
-  v?.readable !== false;
-
-/**
- * Based on the type of a payload, serialized it to be send as the body of a fetch POST request and also infer its Content Type.
- *
- * Non serializable types versus Content-Type reference (for Node)
- *
- * |Type|Is self-describing)|Inferred type by fetch|Defined mime type|
- * |-|-|-|-}
- * |Blob|yes|`blob.type`||
- * |File|yes|`file.type`||
- * |FormData|yes|"multipart/form-data; boundary=..."||
- * |URLSearchParams|yes|"application/x-www-form-urlencoded;charset=UTF-8"||
- * |ArrayBuffer|no||"application/octet-stream"|
- * |TypedArray (Uint8Array,Uint16Array)||"application/octet-stream"||
- * |DataView|no||"application/octet-stream"|
- * |ReadableStream, Readable, AsyncIterator|no||Can't, because stream must be read|
- *
- * If payload is none of the above types, test it:
- * If the it is an object, serialize using JSON.stringify and set content-type to `application/json`;
- * Else, it is a JS primitive, serialize using JSON.stringify and set content-type to `text/plain`;
- *
- * This implementation is overkill for temporal workflows since the only types available there will be:
- * - URLSearchParams
- * - ArrayBuffer
- * - TypedArrays
- * - DataView
- * - asyncGenerator
- * The others are non deterministic and are not available at runtime, but this function was build to be flexible
- *
- * @see {@link https://fetch.spec.whatwg.org/#bodyinit}
- * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch}
- *
- * @param {unknown} payload
- * @returns {object} An object with the serialized body and inferred content-type
- */
-export const serializeBodyAndInferContentType = payload => {
-  const dataTypes = [ Blob, File, URLSearchParams, FormData ];
-
-  // empty body
-  if ( [ null, undefined ].includes( payload ) ) {
-    return { body: undefined, contentType: undefined };
-  }
-
-  // Buffer types, covers ArrayBuffer, TypedArrays and DataView
-  if ( payload instanceof ArrayBuffer || ArrayBuffer.isView( payload ) ) {
-    return { body: payload, contentType: 'application/octet-stream' };
-  }
-
-  // These data types auto assigned mime types
-  if ( dataTypes.some( t => payload instanceof t ) ) {
-    return { body: payload, contentType: undefined };
-  }
-
-  // ReadableStream, Readable and Async Iterator mimes cant be determined without reading it
-  if ( payload instanceof ReadableStream || typeof payload[Symbol.asyncIterator] === 'function' || isReadable( payload ) ) {
-    return { body: payload, contentType: undefined };
-  }
-
-  if ( typeof payload === 'object' ) {
-    return { body: JSON.stringify( payload ), contentType: 'application/json; charset=UTF-8' };
-  }
-
-  return { body: String( payload ), contentType: 'text/plain; charset=UTF-8' };
-};
-
-/**
- * Receives an array and returns a copy of it with the elements shuffled
- *
- * @param {array} arr
- * @returns {array}
- */
-export const shuffleArray = arr => arr
-  .map( v => ( { v, sort: Math.random() } ) )
-  .sort( ( a, b ) => a.sort - b.sort )
-  .map( ( { v } ) => v );
-
-/**
- * Creates a new object merging object "b" onto object "a", using a resolver function to define the value to keep.
- * - Object "b" fields that also exists on "a" will have their value defined by the "resolver" function
- * - Object "b" fields that don't exist on object "a" will be added;
- * - Object "a" fields that don't exist on object "b" will be preserved;
- *
- * If "b" isn't an object, a new object equal to "a" is returned
- *
- * @param {object} a - The base object
- * @param {object} b - The target object
- * @param {function} resolver - A function that return the value to be kept. First argument is value a, second is value b
- * @returns {object} A new object
- */
-export const deepMergeWithResolver = ( a, b, resolver ) => {
-  if ( !isPlainObject( a ) ) {
-    throw new Error( 'Parameter "a" is not an object.' );
-  }
-  if ( !isPlainObject( b ) ) {
-    return clone( a );
-  }
-  return Object.entries( b ).reduce( ( obj, [ k, v ] ) =>
-    Object.assign( obj, {
-      [k]: ( () => {
-        if ( isPlainObject( v ) && isPlainObject( a[k] ) ) {
-          return deepMergeWithResolver( a[k], v, resolver );
-        }
-        if ( Object.hasOwn( a, k ) ) {
-          return resolver( a[k], v );
-        }
-        return v;
-      } )()
-    } )
-  , clone( a ) );
-};
-
-/**
- * Creates a new object merging object "b" onto object "a" biased to "b":
- * - Object "b" will overwrite fields on object "a";
- * - Object "b" fields that don't exist on object "a" will be added;
- * - Object "a" fields that don't exist on object "b" will be preserved;
- *
- * If "b" isn't an object, a new object equal to "a" is returned
- *
- * @param {object} a - The base object
- * @param {object} b - The target object
- * @returns {object} A new object
- */
-export const deepMerge = ( a, b ) => deepMergeWithResolver( a, b, ( _, b ) => b );
-
-/**
- * Shortens a UUID by re-encoding it to base62.
- *
- * This is a Temporal friendly, without crypto or Buffer.
- * @param {string} uuid
- * @returns {string}
- */
-export const toUrlSafeBase64 = uuid => {
-  const alphabet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_-';
-  const alphabetLen = alphabet.length;
-  const base = BigInt( alphabetLen );
-  const hex = uuid.replace( /-/g, '' );
-
-  const toDigits = n => n <= 0n ? [] : toDigits( n / base ).concat( alphabet[Number( n % base )] );
-  return toDigits( BigInt( '0x' + hex ) ).join( '' );
-};
-
-/**
- * Similar to native Promise.allSettled but throws an Error if the execution exceeds a given time.
- *
- * The error thrown will have attribute `.isTimeout` as `true`.
- *
- * @template T
- * @param {Array<T | PromiseLike<T>>} promises
- * @param {number} timeoutMs
- * @returns {Promise<PromiseSettledResult<Awaited<T>>[]>}
- * @throws {Error & { isTimeout: true }}
- */
-export const allSettledWithTimeout = ( () => {
-  class TimeoutError extends Error {
-    isTimeout = true;
-    constructor() {
-      super( 'Timed out before completing all promises' );
-    }
-  }
-
-  return async ( promises, timeoutMs ) => {
-    if ( promises.length === 0 ) {
-      return [];
-    }
-
-    const state = { timeoutMonitor: null };
-
-    try {
-      return await Promise.race( [
-        Promise.allSettled( promises ),
-        new Promise( ( _, reject ) => {
-          state.timeoutMonitor = setTimeout( () => reject( new TimeoutError() ), timeoutMs );
-        } )
-      ] );
-    } finally {
-      clearTimeout( state.timeoutMonitor );
-    }
-  };
-} )();
-
-/**
- * Builds a promise that can be resolved from the outside.
- */
-export class CancellablePromise {
-  #promise = null;
-  #complete = null;
-  #completed = false;
-
-  constructor() {
-    this.#promise = new Promise( resolve => {
-      this.#complete = () => {
-        resolve();
-        this.#completed = true;
-      };
-    } );
-  }
-  /** Retrieves the promise */
-  get promise() {
-    return this.#promise;
-  }
-  /** Returns whether the promise is resolved or not */
-  get completed() {
-    return this.#completed;
-  }
-  /** Resolves the promise */
-  complete() {
-    this.#complete();
-  }
-};
-
-/**
- * Returns a function that invokes the fn argument when called once, further calls do nothing.
- * @param {Function} fn
- * @returns {Function}
- */
-export const runOnce = fn => {
-  const state = { executed: false, result: undefined };
-  return ( ...args ) => {
-    if ( !state.executed ) {
-      state.executed = true;
-      return state.result = fn( ...args );
-    }
-    return state.result;
-  };
-};
-
-/**
- * Escape regexp characters in a string
- * @param {*} value
- * @returns
- */
-export const rxEscape = v => v.replace( /[.*+?^${}()|[\]\\]/g, '\\$&' );