fix types & add support for third parameter of map "callback" (the list itself)

Author: seefeldb

typescript/packages/common-builder/src/opaque-ref.ts

@@ -78,8 +78,9 @@ export function opaqueRef<T>(value?: Opaque<T> | T): OpaqueRef<T> {
       },
       map: <S>(
         fn: (
-          value: Opaque<Required<T extends Array<infer U> ? U : T>>,
+          element: Opaque<Required<T extends Array<infer U> ? U : T>>,
           index: Opaque<number>,
+          array: T,
         ) => Opaque<S>,
       ) => {
         // Create the factory if it doesn't exist. Doing it here to avoid
@@ -90,8 +91,10 @@ export function opaqueRef<T>(value?: Opaque<T> | T): OpaqueRef<T> {
         });
         return mapFactory({
           list: proxy,
-          op: recipe("mapping function", ({ item, index }: Opaque<any>) =>
-            fn(item, index),
+          op: recipe(
+            "mapping function",
+            ({ element, index, array }: Opaque<any>) =>
+              fn(element, index, array),
           ),
         });
       },

typescript/packages/common-builder/src/types.ts

@@ -46,7 +46,11 @@ export type OpaqueRefMethods<T> = {
   unsafe_bindToRecipeAndPath(recipe: Recipe, path: PropertyKey[]): void;
   unsafe_getExternal(): OpaqueRef<T>;
   map<S>(
-    fn: (value: T extends Array<infer U> ? Opaque<U> : Opaque<T>) => Opaque<S>,
+    fn: (
+      element: T extends Array<infer U> ? Opaque<U> : Opaque<T>,
+      index: Opaque<number>,
+      array: T,
+    ) => Opaque<S>,
   ): Opaque<S[]>;
   [Symbol.iterator](): Iterator<T>;
   [Symbol.toPrimitive](hint: string): T;

typescript/packages/common-runner/src/builtins/map.ts

@@ -120,7 +120,7 @@ export function map(
         if (!value.cell.entityId) value.cell.generateEntityId();
         const resultCell = cell();
         resultCell.generateEntityId({ map: value.cell.entityId });
-        run(op, { item: value, index }, resultCell);
+        run(op, { element: value, index, array: list }, resultCell);
         resultCell.sourceCell!.sourceCell = parentCell;
         if (Array.isArray(parentCell.get())) debugger;
 

typescript/packages/common-runner/test/recipes.test.ts

@@ -76,8 +76,8 @@ describe("Recipe Runner", () => {
     const multipliedArray = recipe<{ values: { x: number }[] }>(
       "Multiply numbers",
       ({ values }) => {
-        const multiplied = values.map(({ x }, index) => {
-          const multiply = lift<number>(x => x * (index + 1));
+        const multiplied = values.map(({ x }, index, array) => {
+          const multiply = lift<number>(x => x * (index + 1) * array.length);
           return { multiplied: multiply(x) };
         });
         return { multiplied };
@@ -91,7 +91,7 @@ describe("Recipe Runner", () => {
     await idle();
 
     expect(result.getAsQueryResult()).toMatchObject({
-      multiplied: [{ multiplied: 1 }, { multiplied: 4 }, { multiplied: 9 }],
+      multiplied: [{ multiplied: 3 }, { multiplied: 12 }, { multiplied: 27 }],
     });
   });