@danielsimonjr/mathts-core 0.14.1 → 0.15.0

package/dist/factory/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Factory pattern exports
+ */
+export { FunctionRegistry, createFactory, createTypedFunction, registry, math, DEFAULT_CONFIG, } from './factory.js';
+export type { MathTSConfig, FactoryFunction, FactoryDependencies, FactoryImport, } from './factory.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/factory/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/factory/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACL,gBAAgB,EAChB,aAAa,EACb,mBAAmB,EACnB,QAAQ,EACR,IAAI,EACJ,cAAc,GACf,MAAM,cAAc,CAAC;AAEtB,YAAY,EACV,YAAY,EACZ,eAAe,EACf,mBAAmB,EACnB,aAAa,GACd,MAAM,cAAc,CAAC"}

package/dist/factory.d.ts

@@ -0,0 +1,112 @@
+/**
+ * Type for a factory function that creates instances
+ */
+export interface FactoryFunction<TResult = unknown> {
+    (scope: Record<string, unknown>): TResult;
+    isFactory: true;
+    fn: string;
+    dependencies: string[];
+    meta?: FactoryMeta;
+}
+/**
+ * Type for legacy factory objects (old-style factories)
+ */
+export interface LegacyFactory {
+    type?: string;
+    name: string;
+    factory: (...args: unknown[]) => unknown;
+    math?: boolean;
+    dependencies?: string[];
+    meta?: FactoryMeta;
+}
+/**
+ * Meta information that can be attached to a factory
+ */
+export interface FactoryMeta {
+    /**
+     * If true, the factory will be recreated when config changes
+     */
+    recreateOnConfigChange?: boolean;
+    /**
+     * If true, this is a lazy factory that should only be created when needed
+     */
+    lazy?: boolean;
+    /**
+     * Additional custom metadata
+     */
+    [key: string]: unknown;
+}
+/**
+ * Type for dependency names, which can be optional (prefixed with '?')
+ */
+export type DependencyName = string;
+/**
+ * Type for the create callback function
+ */
+export type CreateFunction<TDeps extends Record<string, unknown>, TResult> = (dependencies: TDeps) => TResult;
+/**
+ * Create a factory function, which can be used to inject dependencies.
+ *
+ * The created functions are memoized, a consecutive call of the factory
+ * with the exact same inputs will return the same function instance.
+ * The memoized cache is exposed on `factory.cache` and can be cleared
+ * if needed.
+ *
+ * Example:
+ *
+ *     const name = 'log'
+ *     const dependencies = ['config', 'typed', 'divideScalar', 'Complex']
+ *
+ *     export const createLog = factory(name, dependencies, ({ typed, config, divideScalar, Complex }) => {
+ *       // ... create the function log here and return it
+ *     }
+ *
+ * @param name           Name of the function to be created
+ * @param dependencies   The names of all required dependencies
+ * @param create         Callback function called with an object with all dependencies
+ * @param meta           Optional object with meta information that will be attached
+ *                       to the created factory function as property `meta`. For explanation
+ *                       of what meta properties can be specified and what they mean, see
+ *                       docs/core/extension.md.
+ * @returns The factory function
+ */
+export declare function factory<TDeps extends Record<string, unknown> = Record<string, unknown>, TResult = unknown>(name: string, dependencies: DependencyName[], create: CreateFunction<TDeps, TResult>, meta?: FactoryMeta): FactoryFunction<TResult>;
+/**
+ * Sort all factories such that when loading in order, the dependencies are resolved.
+ *
+ * @param factories Array of factory functions or legacy factories
+ * @returns Returns a new array with the sorted factories
+ */
+export declare function sortFactories(factories: Array<FactoryFunction | LegacyFactory>): Array<FactoryFunction | LegacyFactory>;
+export declare function create(factories: Array<FactoryFunction | LegacyFactory>, scope?: Record<string, unknown>): Record<string, unknown>;
+/**
+ * Test whether an object is a factory. This is the case when it has
+ * properties name, dependencies, and a function create.
+ * @param obj Any value to test
+ * @returns true if obj is a factory function
+ */
+export declare function isFactory(obj: unknown): obj is FactoryFunction;
+/**
+ * Assert that all dependencies of a list with dependencies are available in the provided scope.
+ *
+ * Will throw an exception when there are dependencies missing.
+ *
+ * @param name         Name for the function to be created. Used to generate a useful error message
+ * @param dependencies Array of dependency names
+ * @param scope        Object containing the available dependencies
+ * @throws Error if required dependencies are missing
+ */
+export declare function assertDependencies(name: string, dependencies: DependencyName[], scope: Record<string, unknown>): void;
+/**
+ * Check if a dependency is optional (starts with '?')
+ * @param dependency The dependency name to check
+ * @returns true if the dependency is optional
+ */
+export declare function isOptionalDependency(dependency: DependencyName): boolean;
+/**
+ * Remove the optional notation '?' from a dependency name
+ * @param dependency The dependency name
+ * @returns The dependency name without optional notation
+ */
+export declare function stripOptionalNotation(dependency: DependencyName): string;
+//# sourceMappingURL=factory.d.ts.map

package/dist/factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,OAAO,GAAG,OAAO;IAChD,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC;IAC1C,SAAS,EAAE,IAAI,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,IAAI,CAAC,EAAE,WAAW,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC;IACzC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,IAAI,CAAC,EAAE,WAAW,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,IAAI,CAC3E,YAAY,EAAE,KAAK,KAChB,OAAO,CAAC;AAEb;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,OAAO,CACrB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/D,OAAO,GAAG,OAAO,EAEjB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,cAAc,EAAE,EAC9B,MAAM,EAAE,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,EACtC,IAAI,CAAC,EAAE,WAAW,GACjB,eAAe,CAAC,OAAO,CAAC,CAoB1B;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,SAAS,EAAE,KAAK,CAAC,eAAe,GAAG,aAAa,CAAC,GAChD,KAAK,CAAC,eAAe,GAAG,aAAa,CAAC,CA0FxC;AAGD,wBAAgB,MAAM,CACpB,SAAS,EAAE,KAAK,CAAC,eAAe,GAAG,aAAa,CAAC,EACjD,KAAK,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAClC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAQzB;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,eAAe,CAG9D;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,cAAc,EAAE,EAC9B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,IAAI,CAeN;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAIxE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,cAAc,GAAG,MAAM,CAExE"}