magic-utils-yonava 1.0.2 → 1.0.4

package/src/localStorage.ts

@@ -1,49 +0,0 @@
-
-
-type LocalStorageGetter = (...args: any[]) => string;
-type LocalStorageRecord = Record<string, string | LocalStorageGetter>;
-
-/**
- * a registry for all localStorage keys this application uses
- */
-export const localKeys = {
-  /** nodes in graph product */
-  nodes: (key: string) => `nodes-${key}` as const,
-  /** edges in graph product */
-  edges: (key: string) => `edges-${key}` as const,
-  /** graph product simulation speed */
-  simulationPlaybackSpeed: 'simulation-playback-speed',
-  /** graph theme set by user - {@link Graph.preferredTheme} */
-  preferredTheme: 'preferred-theme',
-} as const satisfies LocalStorageRecord;
-
-/**
- * all return values of localStorage are, by default, string.
- * this type allows string to be narrowed to types such as 'true' | 'false'
- */
-type TypeOverride = {};
-
-type LocalObj = typeof localKeys;
-
-/**
- * @example
- * type T = TypeOrReturnType<number> // number
- * type TFunc = TypeOrReturnType<() => number> // number
- */
-type TypeOrReturnType<T> = T extends (...args: any[]) => infer U ? U : T;
-
-type LocalKeys = TypeOrReturnType<LocalObj[keyof LocalObj]>;
-type LocalType<T extends LocalKeys> = T extends keyof TypeOverride
-  ? TypeOverride[T]
-  : string;
-
-/**
- * perform **type safe** localStorage actions
- */
-export const local = {
-  get: <T extends LocalKeys>(key: T) => localStorage.getItem(key),
-  set: <T extends LocalKeys, K extends LocalType<T>>(key: T, value: K) =>
-    localStorage.setItem(key, value),
-  remove: <T extends LocalKeys>(key: T) => localStorage.removeItem(key),
-  clear: localStorage.clear,
-};

package/src/math.test.ts

@@ -1,57 +0,0 @@
-import { describe, expect, test } from 'vitest';
-
-import {
-  average,
-  gcd,
-  getPrimeFactors,
-  lowestPrimeFactor,
-  roundToNearestN,
-} from './math';
-
-describe('roundToNearestN', () => {
-  test('rounds a number to the nearest multiple of n', () => {
-    const roundToNearest5 = roundToNearestN(5);
-    expect(roundToNearest5(13)).toBe(15);
-    expect(roundToNearest5(12)).toBe(10);
-  });
-});
-
-describe('getPrimeFactors', () => {
-  test('returns the prime factors of a number', () => {
-    expect(getPrimeFactors(12)).toEqual([2, 2, 3]);
-    expect(getPrimeFactors(15)).toEqual([3, 5]);
-  });
-
-  test('edge case: 1', () => {
-    expect(getPrimeFactors(1)).toEqual([]);
-  });
-});
-
-describe('lowestPrimeFactor', () => {
-  test('returns the lowest prime factor of a number', () => {
-    expect(lowestPrimeFactor(12)).toBe(2);
-    expect(lowestPrimeFactor(15)).toBe(3);
-  });
-
-  test('edge case: 1', () => {
-    expect(lowestPrimeFactor(1)).toBe(1);
-  });
-});
-
-describe('gcd', () => {
-  test('returns the greatest common divisor of two numbers', () => {
-    expect(gcd(12, 15)).toBe(3);
-    expect(gcd(12, 18)).toBe(6);
-  });
-});
-
-describe('average', () => {
-  test('returns the average of a list of numbers', () => {
-    expect(average([1, 2, 3, 4, 5])).toBe(3);
-    expect(average([1, 2, 3, 4, 5, 6])).toBe(3.5);
-  });
-
-  test('edge case: empty list', () => {
-    expect(average([])).toBe(0);
-  });
-});

package/src/random.ts

@@ -1,27 +0,0 @@
-/**
- * given two numbers, this function returns a random number between them (inclusive)
- *
- * @param min - the lowest number
- * @param max - the highest number
- * @returns a random number between min and max
- */
-export const getRandomInRange = (min: number, max: number) =>
-  Math.round(Math.random() * (max - min) + min);
-
-export const getRandomPointOnCanvas = (
-  canvas: HTMLCanvasElement,
-  buffer = 50,
-) => ({
-  x: getRandomInRange(buffer, canvas.width - buffer),
-  y: getRandomInRange(buffer, canvas.height - buffer),
-});
-
-/**
- * get a random element from an array
- *
- * @param array
- * @returns random element from given array
- */
-export const getRandomElement = <T>(array: ArrayLike<T>) => {
-  return array[Math.floor(Math.random() * array.length)];
-};

package/src/string.test.ts

@@ -1,17 +0,0 @@
-import { describe, expect, test } from 'vitest';
-
-import { camelCaseToTitleCase, capitalize } from './string';
-
-describe('capitalize', () => {
-  test('capitalizes the first letter of a string', () => {
-    expect(capitalize('hello')).toBe('Hello');
-    expect(capitalize('this is one string')).toBe('This is one string');
-  });
-});
-
-describe('camelCaseToTitleCase', () => {
-  test('converts camelCase to title case', () => {
-    expect(camelCaseToTitleCase('camelCase')).toBe('Camel Case');
-    expect(camelCaseToTitleCase('thisIsOneString')).toBe('This Is One String');
-  });
-});

package/tsconfig.json

@@ -1,20 +0,0 @@
-{
-  "compilerOptions": {
-    "outDir": "./dist",
-    "rootDir": "./src",
-
-    "target": "ES2022",
-    "module": "ESNext",
-    "lib": ["ES2023", "DOM"],
-    "types": ["node"],
-    "moduleResolution": "node",
-    "allowJs": false,
-    "strict": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "declaration": true,
-  },
-  "include": ["src/**/*"],
-}