@synnaxlabs/x 0.16.1 → 0.24.0

package/src/compare/compare.spec.ts

@@ -0,0 +1,49 @@
+// Copyright 2024 Synnax Labs, Inc.
+//
+// Use of this software is governed by the Business Source License included in the file
+// licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with the Business Source
+// License, use of this software will be governed by the Apache License, Version 2.0,
+// included in the file licenses/APL.txt.
+
+import { describe, expect, it } from "vitest";
+
+import { compare } from "@/compare";
+
+describe("compare", () => {
+  describe("numericStrings", () => {
+    interface Spec {
+      name: string;
+      input: string[];
+      expected: string[];
+    }
+    const SPECS: Spec[] = [
+      {
+        name: "pure numbers",
+        input: ["5", "4", "3", "2", "1"],
+        expected: ["1", "2", "3", "4", "5"],
+      },
+      {
+        name: "suffixed numbers with equal prefixes",
+        input: ["a5", "a4", "a3", "a2", "a1"],
+        expected: ["a1", "a2", "a3", "a4", "a5"],
+      },
+      {
+        name: "suffixed numbers with different prefixes",
+        input: ["a1", "b1", "a2", "b2", "a3", "b3"],
+        expected: ["a1", "a2", "a3", "b1", "b2", "b3"],
+      },
+      {
+        name: "mixed separators",
+        input: ["a2", "a.1", "a-3", "a_4"],
+        expected: ["a.1", "a2", "a-3", "a_4"],
+      },
+    ];
+    SPECS.forEach((spec) => {
+      it(spec.name, () => {
+        expect(spec.input.sort(compare.stringsWithNumbers)).toEqual(spec.expected);
+      });
+    });
+  });
+});

package/src/compare/compare.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -7,7 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { type Primitive, isStringer, type PrimitiveRecord } from "@/primitive";
+import { isStringer, type Primitive } from "@/primitive";
 import { type spatial } from "@/spatial";
 
 export type CompareF<T> = (a: T, b: T) => number;
@@ -20,10 +20,7 @@ export type CompareF<T> = (a: T, b: T) => number;
  * This is used to determine the type of comparison to perform.
  * @param reverse Whether to reverse the sort order.
  */
-export const newF = <T extends Primitive>(
-  v: T,
-  reverse: boolean = false,
-): CompareF<T> => {
+export const newF = <T>(v: T, reverse: boolean = false): CompareF<T> => {
   const t = isStringer(v) ? "stringer" : typeof v;
   let f: CompareF<T>;
   switch (t) {
@@ -35,16 +32,19 @@ export const newF = <T extends Primitive>(
         (a as string).toString().localeCompare((b as string).toString());
       break;
     case "number":
-      f = (a: T, b: T) => (a as number) - (b as number);
+      f = (a: T, b: T) => Number(a) - Number(b);
       break;
     case "bigint":
-      f = (a: T, b: T) => ((a as bigint) - (b as bigint) > BigInt(0) ? 1 : -1);
+      f = (a: T, b: T) => (BigInt(a as number) - BigInt(b as number) > 0n ? 1 : -1);
       break;
     case "boolean":
       f = (a: T, b: T) => Number(a) - Number(b);
       break;
+    case "undefined":
+      f = () => 0;
+      break;
     default:
-      console.warn("sortFunc: unknown type");
+      console.warn(`sortFunc: unknown type ${t}`);
       return () => -1;
   }
   return reverse ? reverseF(f) : f;
@@ -58,7 +58,7 @@ export const newF = <T extends Primitive>(
  * comparison to perform.
  * @param reverse Whether to reverse the sort order.
  */
-export const newFieldF = <T extends PrimitiveRecord>(
+export const newFieldF = <T>(
   key: keyof T,
   value: T,
   reverse?: boolean,
@@ -120,3 +120,30 @@ export const isLessThan = (n: number): boolean => n < EQUAL;
 export const isGreaterThan = (n: number): boolean => n > EQUAL;
 
 export const isGreaterThanEqual = (n: number): boolean => n >= EQUAL;
+
+export const stringsWithNumbers = (a: string, b: string): number => {
+  const alphaNumericRegex = /([a-zA-Z]+)|(\d+)/g;
+
+  // Remove separators and split into parts
+  const aParts = a.replace(/[\s_.\-]+/g, "").match(alphaNumericRegex);
+  const bParts = b.replace(/[\s_.\-]+/g, "").match(alphaNumericRegex);
+
+  if (!aParts || !bParts) return 0;
+
+  for (let i = 0; i < Math.min(aParts.length, bParts.length); i++) {
+    const aPart = aParts[i];
+    const bPart = bParts[i];
+
+    if (isNaN(Number(aPart)) && isNaN(Number(bPart))) {
+      const localeComparison = aPart.localeCompare(bPart);
+      if (localeComparison !== 0) return localeComparison;
+    } else if (!isNaN(Number(aPart)) && !isNaN(Number(bPart))) {
+      const numComparison = Number(aPart) - Number(bPart);
+      if (numComparison !== 0) return numComparison;
+    } else {
+      return isNaN(Number(aPart)) ? -1 : 1;
+    }
+  }
+
+  return aParts.length - bParts.length;
+};

package/src/compare/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/control/control.ts

@@ -0,0 +1,77 @@
+// Copyright 2024 Synnax Labs, Inc.
+//
+// Use of this software is governed by the Business Source License included in the file
+// licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with the Business Source
+// License, use of this software will be governed by the Apache License, Version 2.0,
+// included in the file licenses/APL.txt.
+
+import { z } from "zod";
+
+export class Authority extends Number {
+  static readonly Absolute = 255;
+  static readonly Default = 1;
+
+  static readonly z = z.union([
+    z.instanceof(Authority),
+    z
+      .number()
+      .int()
+      .min(0)
+      .max(255)
+      .transform((n) => new Authority(n)),
+    z.instanceof(Number).transform((n) => new Authority(n)),
+  ]);
+}
+
+export const subjectZ = z.object({
+  name: z.string(),
+  key: z.string(),
+});
+
+export interface Subject {
+  name: string;
+  key: string;
+}
+
+export const stateZ = <T extends z.ZodTypeAny>(r: T) =>
+  z.object({
+    subject: subjectZ,
+    resource: r,
+    authority: Authority.z,
+  });
+
+export interface State<R> {
+  subject: Subject;
+  resource: R;
+  authority: Authority;
+}
+
+export const filterTransfersByChannelKey =
+  <R>(...resources: R[]) =>
+  (transfers: Transfer<R>[]): Transfer<R>[] =>
+    transfers.filter((t) => {
+      let ok = false;
+      if (t.to != null) ok = resources.includes(t.to.resource);
+      if (t.from != null && !ok) ok = resources.includes(t.from.resource);
+      return ok;
+    });
+
+interface Release<R> {
+  from: State<R>;
+  to?: null;
+}
+
+interface Acquire<R> {
+  from?: null;
+  to: State<R>;
+}
+
+export type Transfer<R> =
+  | {
+      from: State<R>;
+      to: State<R>;
+    }
+  | Release<R>
+  | Acquire<R>;

package/src/control/index.ts

@@ -0,0 +1 @@
+export * as control from "@/control/control";

package/src/debounce/debounce.spec.ts

@@ -0,0 +1,52 @@
+// Copyright 2024 Synnax Labs, Inc.
+//
+// Use of this software is governed by the Business Source License included in the file
+// licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with the Business Source
+// License, use of this software will be governed by the Apache License, Version 2.0,
+// included in the file licenses/APL.txt.
+
+import { describe, expect, it, vi } from "vitest";
+
+import { debounce, throttle } from "@/debounce/debounce";
+
+describe("debounce", () => {
+  describe("debounce", () => {
+    it("should debounce the execution of the given function", () => {
+      vi.useFakeTimers();
+      const fn = vi.fn();
+      const debounced = debounce(fn, 100);
+      debounced(10);
+      debounced(20);
+      debounced(30);
+      debounced(40);
+      expect(fn).toHaveBeenCalledTimes(0);
+      vi.advanceTimersByTime(100);
+      expect(fn).toHaveBeenCalledTimes(1);
+      expect(fn).toHaveBeenCalledWith(40);
+    });
+    it("should not debounce the execution of the given function if the time is 0", () => {
+      const fn = vi.fn();
+      const debounced = debounce(fn, 0);
+      // assert that debounced is the same
+      expect(debounced).toBe(fn);
+    });
+  });
+  describe("throttle", () => {
+    it("should throttle the execution of the given function", () => {
+      vi.useFakeTimers();
+      const fn = vi.fn();
+      const debounced = throttle(fn, 100);
+      debounced(10);
+      debounced(20);
+      debounced(30);
+      debounced(40);
+      vi.advanceTimersByTime(100);
+      expect(fn).toHaveBeenCalledTimes(1);
+      expect(fn).toHaveBeenCalledWith(10);
+      vi.advanceTimersByTime(100);
+      expect(fn).toHaveBeenCalledTimes(1);
+    });
+  });
+});

package/src/{debounce.ts → debounce/debounce.ts}

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -9,7 +9,7 @@
 
 export const debounce = <F extends (...args: any[]) => void>(
   func: F,
-  waitFor: number
+  waitFor: number,
 ): F => {
   let timeout: ReturnType<typeof setTimeout> | null = null;
   if (waitFor === 0) return func;
@@ -27,7 +27,7 @@ export const debounce = <F extends (...args: any[]) => void>(
 
 export const throttle = <F extends (...args: any[]) => void>(
   func: F,
-  waitFor: number
+  waitFor: number,
 ): F => {
   let timeout: ReturnType<typeof setTimeout> | null = null;
   if (waitFor === 0) return func;
@@ -42,4 +42,4 @@ export const throttle = <F extends (...args: any[]) => void>(
   };
 
   return throttled as F;
-}
+};

package/src/debounce/index.ts

@@ -0,0 +1,10 @@
+// Copyright 2024 Synnax Labs, Inc.
+//
+// Use of this software is governed by the Business Source License included in the file
+// licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with the Business Source
+// License, use of this software will be governed by the Apache License, Version 2.0,
+// included in the file licenses/APL.txt.
+
+export * from "@/debounce/debounce";

package/src/deep/copy.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -7,5 +7,4 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-export const copy = <T>(obj: T): T =>
-  JSON.parse(JSON.stringify(obj));
+export const copy = <T>(obj: T): T => JSON.parse(JSON.stringify(obj));

package/src/deep/delete.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -7,7 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { describe, it, expect } from "vitest";
+import { describe, expect,it } from "vitest";
 
 import { deep } from "@/deep";
 

package/src/deep/delete.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -9,6 +9,7 @@
 
 import { type Key } from "@/deep/path";
 
+// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-constraint
 export const deleteD = <T extends any, D extends number = 5>(
   target: T,
   ...keys: Array<Key<T, D>>
@@ -17,7 +18,7 @@ export const deleteD = <T extends any, D extends number = 5>(
     let curr: any = target;
     const arr = key.split(".");
     arr.forEach((k, i) => {
-      // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+       
       if (i === arr.length - 1) delete curr[k];
       else curr = curr[k];
     });

package/src/deep/difference.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -8,31 +8,32 @@
 // included in the file licenses/APL.txt.
 
 import { describe, expect, it } from "vitest";
+
 import { deep } from "@/deep";
 
-describe('deep/difference', () => {
-    it('should return a map of differences between two objects', () => {
-        const obj1 = {
-        a: 1,
-        b: 2,
-        c: {
-            d: 4,
-            e: 5,
-            f: [6, 7, 8],
-        },
-        };
-        const obj2 = {
-        a: 1,
-        b: 3,
-        c: {
-            d: 4,
-            e: 6,
-            f: [6, 7, 8],
-        },
-        };
-        const diff = deep.difference(obj1, obj2);
-        expect(Object.keys(diff).length).toEqual(2);
-        expect(diff['b']).toEqual([2, 3]);
-        expect(diff['c.e']).toEqual([5, 6]);
-    });
-});
+describe("deep/difference", () => {
+  it("should return a map of differences between two objects", () => {
+    const obj1 = {
+      a: 1,
+      b: 2,
+      c: {
+        d: 4,
+        e: 5,
+        f: [6, 7, 8],
+      },
+    };
+    const obj2 = {
+      a: 1,
+      b: 3,
+      c: {
+        d: 4,
+        e: 6,
+        f: [6, 7, 8],
+      },
+    };
+    const diff = deep.difference(obj1, obj2);
+    expect(Object.keys(diff).length).toEqual(2);
+    expect(diff.b).toEqual([2, 3]);
+    expect(diff["c.e"]).toEqual([5, 6]);
+  });
+});

package/src/deep/difference.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -7,31 +7,34 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-
 type PathValueTuple = [any, any];
 
-export const difference = (obj1: Record<string, any>, obj2: Record<string, any>, path: string = ''): Record<string, PathValueTuple> => {
+export const difference = (
+  obj1: Record<string, any>,
+  obj2: Record<string, any>,
+  path: string = "",
+): Record<string, PathValueTuple> => {
   const diffMap: Record<string, PathValueTuple> = {};
 
-  const compare = (a: any, b: any, currentPath: string) => {
+  const compare = (a: any, b: any, currentPath: string): void => {
     if (typeof a !== typeof b || a === null || b === null) {
       diffMap[currentPath] = [a, b];
       return;
     }
 
-    if (typeof a === 'object' && typeof b === 'object') {
+    if (typeof a === "object" && typeof b === "object") {
       if (Array.isArray(a) && Array.isArray(b)) {
         if (a.length !== b.length) {
-          diffMap[currentPath] =  [a, b];
+          diffMap[currentPath] = [a, b];
           return;
         }
         for (let i = 0; i < a.length; i++) {
           compare(a[i], b[i], `${currentPath}[${i}]`);
         }
       } else {
-        const keys = new Set([...Object.keys(a), ...Object.keys(b)]);
-        keys.forEach(key => {
-          compare(a[key], b[key], currentPath ? `${currentPath}.${key}` : key);
+        const keys = new Set([...Object.keys(a as {}), ...Object.keys(b as {})]);
+        keys.forEach((key) => {
+          compare(a[key], b[key], currentPath !== "" ? `${currentPath}.${key}` : key);
         });
       }
     } else {
@@ -43,5 +46,4 @@ export const difference = (obj1: Record<string, any>, obj2: Record<string, any>,
 
   compare(obj1, obj2, path);
   return diffMap;
-}
-
+};

package/src/deep/equal.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -7,7 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { describe, it, expect } from "vitest";
+import { describe, expect,it } from "vitest";
 
 import { deep } from "@/deep";
 
@@ -52,7 +52,7 @@ describe("deepEqual", () => {
       const a = [1, 2, 3];
       const b = [1, 2, 3];
       expect(deep.equal(a, b)).toBe(true);
-    })
+    });
     it("should true for object arrays that are equal", () => {
       const a = [{ a: 1 }, { b: 2 }];
       const b = [{ a: 1 }, { b: 2 }];
@@ -75,7 +75,7 @@ describe("deepEqual", () => {
     });
     it("should return false for object arrays that are not equal", () => {
       const a = [{ a: 1 }, { b: 2 }];
-      const b = [{ a: 1 }, { b: 2, c: 4}];
+      const b = [{ a: 1 }, { b: 2, c: 4 }];
       expect(deep.equal(a, b)).toBe(false);
     });
   });

package/src/deep/equal.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -36,9 +36,9 @@ export const equal = <
   const bKeys = Object.keys(b);
   if (aKeys.length !== bKeys.length) return false;
   for (const key of aKeys) {
-    // @ts-expect-error
+    // @ts-expect-error - indexing nested value.
     const aVal = a[key];
-    // @ts-expect-error
+    // @ts-expect-error - indexing nested value.
     const bVal = b[key];
     if (typeof aVal === "object" && typeof bVal === "object") {
       if (!equal(aVal, bVal)) return false;
@@ -56,9 +56,9 @@ export const partialEqual = <T extends unknown | DeepEqualBaseRecord | Primitive
   const partialKeys = Object.keys(partial);
   if (partialKeys.length > baseKeys.length) return false;
   for (const key of partialKeys) {
-    // @ts-expect-error
+    // @ts-expect-error - indexing nested value.
     const baseVal = base[key];
-    // @ts-expect-error
+    // @ts-expect-error - indexing nested value.
     const partialVal = partial[key];
     if (typeof baseVal === "object" && typeof partialVal === "object") {
       if (!partialEqual(baseVal, partialVal)) return false;

package/src/deep/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -9,9 +9,8 @@
 
 export * from "@/deep/copy";
 export * from "@/deep/delete";
-export * from "@/deep/path";
+export * from "@/deep/difference";
+export * from "@/deep/equal";
 export * from "@/deep/merge";
 export * from "@/deep/partial";
-export * from "@/deep/equal";
-export * from "@/deep/memo";
-export * from "@/deep/difference";
+export * from "@/deep/path";

package/src/deep/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.