chore: Add cache manager functions and tests

Author: tomerh2001

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

bun.lockb

@@ -4,17 +4,15 @@
   "module": "index.ts",
   "type": "module",
   "devDependencies": {
-    "@codedependant/semantic-release-docker": "^5.0.3",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/commit-analyzer": "^13.0.0",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/github": "^10.3.2",
+    "@semantic-release/github": "^10.3.3",
     "@semantic-release/npm": "^12.0.1",
     "@semantic-release/release-notes-generator": "^14.0.1",
     "@types/lodash": "^4.17.7",
     "bun-types": "latest",
-    "jest": "^29.7.0",
-    "vitest": "^2.0.5",
+    "cache-manager-ioredis-yet": "^2.1.1",
     "xo": "^0.59.3"
   },
   "peerDependencies": {
@@ -25,8 +23,6 @@
   },
   "dependencies": {
     "cache-manager": "^5.7.6",
-    "cache-manager-ioredis-yet": "^2.1.1",
-    "cache-manager-redis-store": "^3.0.1",
     "eslint-plugin-th-rules": "^1.13.4",
     "lodash": "^4.17.21",
     "reflect-metadata": "^0.2.2"

package.json

@@ -0,0 +1,5 @@
+import {type ArgumentPaths, type AnyFunction} from './paths.d';
+
+export type CachedFunctionOptions<F extends AnyFunction> = {
+	selector: ArgumentPaths<F>;
+};

src/index.d.ts

@@ -1 +1,31 @@
-console.log('test');
+
+import type {CachedFunctionOptions} from './index.d';
+import type {AnyFunction} from './paths.d';
+
+export function cachedFunction<F extends AnyFunction>(function_: F, options: CachedFunctionOptions<F>) {
+	console.log(options);
+	return function_;
+}
+
+/** TEST */
+type Person = {
+	name: string;
+	age: number;
+	address: {
+		city: string;
+		zip: number;
+	};
+};
+
+const person: Person = {
+	name: 'John Doe',
+	age: 30,
+	address: {
+		city: 'New York',
+		zip: 10_001,
+	},
+};
+
+cachedFunction((person: Person) => person.name, {
+	selector: person => person.name,
+});

src/index.ts

@@ -0,0 +1,48 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import _ from 'lodash';
+
+/**
+ * Represents a type that can either be a single value of type T or an array of type T.
+ *
+ * @typeParam T - The type of the value(s) that can be stored in the SingleOrArray.
+ */
+export type SingleOrArray<T> = T | T[];
+
+/**
+ * Represents any function that takes any number of arguments and returns any value.
+ */
+export type AnyFunction = (...arguments_: any[]) => any;
+
+/**
+ * Represents the type for generating paths of a given object.
+ *
+ * @template T - The type of the object.
+ */
+export type Paths<T> = T extends Record<string, unknown>
+	? {[K in keyof T]: `${Exclude<K, symbol>}${'' | `.${Paths<T[K]>}`}`}[keyof T]
+	: T extends Array<infer U>
+		? Paths<U> extends string
+			? `${number}` | `${number}.${Paths<U>}`
+			: never
+		: never;
+
+/**
+ * Represents the paths of the arguments of a given function type.
+ * @template F - The function type.
+ * @typeparam F - The function type.
+ * @typeparam Paths - The paths of the arguments of the function type.
+ */
+export type ArgumentPaths1<F extends AnyFunction> = SingleOrArray<Paths<Parameters<F>>>;
+
+/**
+ * Represents a function that takes arguments of type `Parameters<F>` and returns `ArgumentPaths1<F>`.
+ */
+export type ArgumentPaths2<F extends AnyFunction> = (...arguments_: Parameters<F>) => ArgumentPaths1<F>;
+
+/**
+ * Represents the argument paths for a given function type.
+ * @template F - The function type.
+ */
+export type ArgumentPaths<F extends AnyFunction> = ArgumentPaths1<F> | ArgumentPaths2<F>;