@karmaniverous/entity-manager 6.0.1 → 6.1.0-1

package/dist/cjs/src/EntityManagerClient.js

@@ -0,0 +1,42 @@
+'use strict';
+
+var tslib_es6 = require('../node_modules/tslib/tslib.es6.js');
+var conditionalize = require('./conditionalize.js');
+var typed = require('../node_modules/radash/dist/esm/typed.js');
+
+var _EntityManagerClient_options;
+/**
+ * EntityManagerClient base class.
+ *
+ * @category Client
+ */
+class EntityManagerClient {
+    constructor({ batchSize = 25, delayIncrement = 100, maxRetries = 5, throttle = 10, logger = console, logInternals = false, ...childOptions }) {
+        _EntityManagerClient_options.set(this, void 0);
+        if (!typed.isFunction(logger.debug))
+            throw new Error('logger must support debug method');
+        if (!typed.isFunction(logger.error))
+            throw new Error('logger must support error method');
+        tslib_es6.__classPrivateFieldSet(this, _EntityManagerClient_options, {
+            batchSize,
+            delayIncrement,
+            maxRetries,
+            throttle,
+            logInternals,
+            logger: {
+                ...logger,
+                debug: conditionalize.conditionalize(logger.debug, logInternals),
+            },
+            ...childOptions,
+        }, "f");
+    }
+    /**
+     * Returns the options used to create the EntityManagerClient instance.
+     */
+    get options() {
+        return tslib_es6.__classPrivateFieldGet(this, _EntityManagerClient_options, "f");
+    }
+}
+_EntityManagerClient_options = new WeakMap();
+
+exports.EntityManagerClient = EntityManagerClient;

package/dist/cjs/src/conditionalize.js

@@ -0,0 +1,25 @@
+'use strict';
+
+/**
+ * Transforms a function such that it only executes when `condition` is truthy.
+ *
+ * @param fn - The function to conditionally execute.
+ * @param condition - The condition to check before executing `fn`.
+ *
+ * @typeParam F - The type of the function to conditionally execute.
+ *
+ * @returns The conditionalized function with the same signature as `fn`.
+ *
+ */
+function conditionalize(fn, condition) {
+    return (...args) => {
+        if (condition) {
+            return fn(...args);
+        }
+        else {
+            return undefined;
+        }
+    };
+}
+
+exports.conditionalize = conditionalize;

package/dist/cjs/src/index.js

@@ -1,7 +1,11 @@
 'use strict';
 
+var conditionalize = require('./conditionalize.js');
 var EntityManager = require('./EntityManager.js');
+var EntityManagerClient = require('./EntityManagerClient.js');
 
 
 
+exports.conditionalize = conditionalize.conditionalize;
 exports.EntityManager = EntityManager.EntityManager;
+exports.EntityManagerClient = EntityManagerClient.EntityManagerClient;

package/dist/index.d.cts

@@ -2,6 +2,19 @@ import { Entity, Exactify, TranscodeMap, PropertiesOfType, TranscodablePropertie
 export { DefaultTranscodeMap, Entity, PropertiesOfType, SortOrder, TranscodableProperties, TranscodeMap, Transcodes, defaultTranscodes } from '@karmaniverous/entity-tools';
 import { z } from 'zod';
 
+/**
+ * Transforms a function such that it only executes when `condition` is truthy.
+ *
+ * @param fn - The function to conditionally execute.
+ * @param condition - The condition to check before executing `fn`.
+ *
+ * @typeParam F - The type of the function to conditionally execute.
+ *
+ * @returns The conditionalized function with the same signature as `fn`.
+ *
+ */
+declare function conditionalize<F extends (...args: Parameters<F>) => ReturnType<F>>(fn: F, condition?: unknown): (...args: Parameters<F>) => ReturnType<F> | undefined;
+
 /**
  * The base EntityMap type. All EntityMaps should extend this type.
  *
@@ -823,4 +836,65 @@ declare class EntityManager<M extends EntityMap, HashKey extends string, RangeKe
     query<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string>(options: QueryOptions<Item, EntityToken, M, HashKey, RangeKey, T>): Promise<QueryResult<Item, EntityToken, M, HashKey, RangeKey>>;
 }
 
-export { type Config, type ConfigEntities, type ConfigEntity, type ConfigEntityGenerated, type ConfigKeys, type ConfigTranscodes, EntityManager, type EntityMap, type ExclusiveKey, type ItemMap, type ParsedConfig, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryResult, type Unwrap };
+/**
+ * Options for EntityManager client methods that support batch operations.
+ */
+interface EntityManagerClientBatchOptions {
+    /** Batch size. */
+    batchSize?: number;
+    /** Delay increment in ms for retry operations. Doubles on each retry. */
+    delayIncrement?: number;
+    /** Max retries for retry operations. */
+    maxRetries?: number;
+    /** Throttle for parallel operations. */
+    throttle?: number;
+}
+
+/**
+ * Generic logger endpoint type.
+ *
+ * @category Logger
+ */
+type LoggerEndpoint = (...args: unknown[]) => void;
+/**
+ * Logger interface.
+ *
+ * @category Logger
+ */
+interface Logger {
+    debug: LoggerEndpoint;
+    error: LoggerEndpoint;
+}
+/**
+ * Logger options.
+ *
+ * @category Logger
+ */
+interface LoggerOptions {
+    /** Logger to use for internal logging. Must support the `debug` & `error` methods. Defaults to `console`. */
+    logger?: Logger;
+    /** Enables internal logging when `true`. */
+    logInternals?: boolean;
+}
+
+/**
+ * EntityManagerClient base class options.
+ *
+ * @category Client
+ */
+type EntityManagerClientOptions = EntityManagerClientBatchOptions & LoggerOptions;
+/**
+ * EntityManagerClient base class.
+ *
+ * @category Client
+ */
+declare abstract class EntityManagerClient<O extends EntityManagerClientOptions> {
+    #private;
+    constructor({ batchSize, delayIncrement, maxRetries, throttle, logger, logInternals, ...childOptions }: O);
+    /**
+     * Returns the options used to create the EntityManagerClient instance.
+     */
+    get options(): Required<O>;
+}
+
+export { type Config, type ConfigEntities, type ConfigEntity, type ConfigEntityGenerated, type ConfigKeys, type ConfigTranscodes, EntityManager, EntityManagerClient, type EntityManagerClientBatchOptions, type EntityManagerClientOptions, type EntityMap, type ExclusiveKey, type ItemMap, type Logger, type LoggerEndpoint, type LoggerOptions, type ParsedConfig, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryResult, type Unwrap, conditionalize };

package/dist/index.d.mts

@@ -2,6 +2,19 @@ import { Entity, Exactify, TranscodeMap, PropertiesOfType, TranscodablePropertie
 export { DefaultTranscodeMap, Entity, PropertiesOfType, SortOrder, TranscodableProperties, TranscodeMap, Transcodes, defaultTranscodes } from '@karmaniverous/entity-tools';
 import { z } from 'zod';
 
+/**
+ * Transforms a function such that it only executes when `condition` is truthy.
+ *
+ * @param fn - The function to conditionally execute.
+ * @param condition - The condition to check before executing `fn`.
+ *
+ * @typeParam F - The type of the function to conditionally execute.
+ *
+ * @returns The conditionalized function with the same signature as `fn`.
+ *
+ */
+declare function conditionalize<F extends (...args: Parameters<F>) => ReturnType<F>>(fn: F, condition?: unknown): (...args: Parameters<F>) => ReturnType<F> | undefined;
+
 /**
  * The base EntityMap type. All EntityMaps should extend this type.
  *
@@ -823,4 +836,65 @@ declare class EntityManager<M extends EntityMap, HashKey extends string, RangeKe
     query<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string>(options: QueryOptions<Item, EntityToken, M, HashKey, RangeKey, T>): Promise<QueryResult<Item, EntityToken, M, HashKey, RangeKey>>;
 }
 
-export { type Config, type ConfigEntities, type ConfigEntity, type ConfigEntityGenerated, type ConfigKeys, type ConfigTranscodes, EntityManager, type EntityMap, type ExclusiveKey, type ItemMap, type ParsedConfig, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryResult, type Unwrap };
+/**
+ * Options for EntityManager client methods that support batch operations.
+ */
+interface EntityManagerClientBatchOptions {
+    /** Batch size. */
+    batchSize?: number;
+    /** Delay increment in ms for retry operations. Doubles on each retry. */
+    delayIncrement?: number;
+    /** Max retries for retry operations. */
+    maxRetries?: number;
+    /** Throttle for parallel operations. */
+    throttle?: number;
+}
+
+/**
+ * Generic logger endpoint type.
+ *
+ * @category Logger
+ */
+type LoggerEndpoint = (...args: unknown[]) => void;
+/**
+ * Logger interface.
+ *
+ * @category Logger
+ */
+interface Logger {
+    debug: LoggerEndpoint;
+    error: LoggerEndpoint;
+}
+/**
+ * Logger options.
+ *
+ * @category Logger
+ */
+interface LoggerOptions {
+    /** Logger to use for internal logging. Must support the `debug` & `error` methods. Defaults to `console`. */
+    logger?: Logger;
+    /** Enables internal logging when `true`. */
+    logInternals?: boolean;
+}
+
+/**
+ * EntityManagerClient base class options.
+ *
+ * @category Client
+ */
+type EntityManagerClientOptions = EntityManagerClientBatchOptions & LoggerOptions;
+/**
+ * EntityManagerClient base class.
+ *
+ * @category Client
+ */
+declare abstract class EntityManagerClient<O extends EntityManagerClientOptions> {
+    #private;
+    constructor({ batchSize, delayIncrement, maxRetries, throttle, logger, logInternals, ...childOptions }: O);
+    /**
+     * Returns the options used to create the EntityManagerClient instance.
+     */
+    get options(): Required<O>;
+}
+
+export { type Config, type ConfigEntities, type ConfigEntity, type ConfigEntityGenerated, type ConfigKeys, type ConfigTranscodes, EntityManager, EntityManagerClient, type EntityManagerClientBatchOptions, type EntityManagerClientOptions, type EntityMap, type ExclusiveKey, type ItemMap, type Logger, type LoggerEndpoint, type LoggerOptions, type ParsedConfig, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryResult, type Unwrap, conditionalize };

package/dist/index.d.ts

@@ -2,6 +2,19 @@ import { Entity, Exactify, TranscodeMap, PropertiesOfType, TranscodablePropertie
 export { DefaultTranscodeMap, Entity, PropertiesOfType, SortOrder, TranscodableProperties, TranscodeMap, Transcodes, defaultTranscodes } from '@karmaniverous/entity-tools';
 import { z } from 'zod';
 
+/**
+ * Transforms a function such that it only executes when `condition` is truthy.
+ *
+ * @param fn - The function to conditionally execute.
+ * @param condition - The condition to check before executing `fn`.
+ *
+ * @typeParam F - The type of the function to conditionally execute.
+ *
+ * @returns The conditionalized function with the same signature as `fn`.
+ *
+ */
+declare function conditionalize<F extends (...args: Parameters<F>) => ReturnType<F>>(fn: F, condition?: unknown): (...args: Parameters<F>) => ReturnType<F> | undefined;
+
 /**
  * The base EntityMap type. All EntityMaps should extend this type.
  *
@@ -823,4 +836,65 @@ declare class EntityManager<M extends EntityMap, HashKey extends string, RangeKe
     query<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string>(options: QueryOptions<Item, EntityToken, M, HashKey, RangeKey, T>): Promise<QueryResult<Item, EntityToken, M, HashKey, RangeKey>>;
 }
 
-export { type Config, type ConfigEntities, type ConfigEntity, type ConfigEntityGenerated, type ConfigKeys, type ConfigTranscodes, EntityManager, type EntityMap, type ExclusiveKey, type ItemMap, type ParsedConfig, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryResult, type Unwrap };
+/**
+ * Options for EntityManager client methods that support batch operations.
+ */
+interface EntityManagerClientBatchOptions {
+    /** Batch size. */
+    batchSize?: number;
+    /** Delay increment in ms for retry operations. Doubles on each retry. */
+    delayIncrement?: number;
+    /** Max retries for retry operations. */
+    maxRetries?: number;
+    /** Throttle for parallel operations. */
+    throttle?: number;
+}
+
+/**
+ * Generic logger endpoint type.
+ *
+ * @category Logger
+ */
+type LoggerEndpoint = (...args: unknown[]) => void;
+/**
+ * Logger interface.
+ *
+ * @category Logger
+ */
+interface Logger {
+    debug: LoggerEndpoint;
+    error: LoggerEndpoint;
+}
+/**
+ * Logger options.
+ *
+ * @category Logger
+ */
+interface LoggerOptions {
+    /** Logger to use for internal logging. Must support the `debug` & `error` methods. Defaults to `console`. */
+    logger?: Logger;
+    /** Enables internal logging when `true`. */
+    logInternals?: boolean;
+}
+
+/**
+ * EntityManagerClient base class options.
+ *
+ * @category Client
+ */
+type EntityManagerClientOptions = EntityManagerClientBatchOptions & LoggerOptions;
+/**
+ * EntityManagerClient base class.
+ *
+ * @category Client
+ */
+declare abstract class EntityManagerClient<O extends EntityManagerClientOptions> {
+    #private;
+    constructor({ batchSize, delayIncrement, maxRetries, throttle, logger, logInternals, ...childOptions }: O);
+    /**
+     * Returns the options used to create the EntityManagerClient instance.
+     */
+    get options(): Required<O>;
+}
+
+export { type Config, type ConfigEntities, type ConfigEntity, type ConfigEntityGenerated, type ConfigKeys, type ConfigTranscodes, EntityManager, EntityManagerClient, type EntityManagerClientBatchOptions, type EntityManagerClientOptions, type EntityMap, type ExclusiveKey, type ItemMap, type Logger, type LoggerEndpoint, type LoggerOptions, type ParsedConfig, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryResult, type Unwrap, conditionalize };

package/dist/mjs/src/EntityManagerClient.js

@@ -0,0 +1,40 @@
+import { __classPrivateFieldSet, __classPrivateFieldGet } from '../node_modules/tslib/tslib.es6.js';
+import { conditionalize } from './conditionalize.js';
+import { isFunction } from '../node_modules/radash/dist/esm/typed.js';
+
+var _EntityManagerClient_options;
+/**
+ * EntityManagerClient base class.
+ *
+ * @category Client
+ */
+class EntityManagerClient {
+    constructor({ batchSize = 25, delayIncrement = 100, maxRetries = 5, throttle = 10, logger = console, logInternals = false, ...childOptions }) {
+        _EntityManagerClient_options.set(this, void 0);
+        if (!isFunction(logger.debug))
+            throw new Error('logger must support debug method');
+        if (!isFunction(logger.error))
+            throw new Error('logger must support error method');
+        __classPrivateFieldSet(this, _EntityManagerClient_options, {
+            batchSize,
+            delayIncrement,
+            maxRetries,
+            throttle,
+            logInternals,
+            logger: {
+                ...logger,
+                debug: conditionalize(logger.debug, logInternals),
+            },
+            ...childOptions,
+        }, "f");
+    }
+    /**
+     * Returns the options used to create the EntityManagerClient instance.
+     */
+    get options() {
+        return __classPrivateFieldGet(this, _EntityManagerClient_options, "f");
+    }
+}
+_EntityManagerClient_options = new WeakMap();
+
+export { EntityManagerClient };

package/dist/mjs/src/conditionalize.js

@@ -0,0 +1,23 @@
+/**
+ * Transforms a function such that it only executes when `condition` is truthy.
+ *
+ * @param fn - The function to conditionally execute.
+ * @param condition - The condition to check before executing `fn`.
+ *
+ * @typeParam F - The type of the function to conditionally execute.
+ *
+ * @returns The conditionalized function with the same signature as `fn`.
+ *
+ */
+function conditionalize(fn, condition) {
+    return (...args) => {
+        if (condition) {
+            return fn(...args);
+        }
+        else {
+            return undefined;
+        }
+    };
+}
+
+export { conditionalize };

package/dist/mjs/src/index.js

@@ -1 +1,3 @@
+export { conditionalize } from './conditionalize.js';
 export { EntityManager } from './EntityManager.js';
+export { EntityManagerClient } from './EntityManagerClient.js';

package/package.json

@@ -132,5 +132,5 @@
   },
   "type": "module",
   "types": "dist/index.d.ts",
-  "version": "6.0.1"
+  "version": "6.1.0-1"
 }