exporting few helper methods (#337)

Author: jbolda

.changes/convert-obj-to-prop.md

@@ -0,0 +1,6 @@
+---
+"@simulacrum/foundation-simulator": minor:enhance
+"@simulacrum/github-api-simulator": patch:deps
+---
+
+Export helpers from foundation simulator for use in dumping data into the stores, such as in the GitHub API simulator.

packages/foundation/src/index.ts

@@ -38,6 +38,7 @@ import { apiProxy } from "./middleware/proxy.ts";
 import { delayMiddleware } from "./middleware/delay.ts";
 import { generateRoutesHTML } from "./routeTemplate.ts";
 import { createAppServer } from "./server.ts";
+import type { IdProp } from "starfx";
 
 // for use in the OpenAPI handler functions
 type SimulationHandlerFunctions = (
@@ -60,6 +61,15 @@ export type {
   Document,
 };
 
+export const convertObjToProp = <T extends { [k: string]: any }>(
+  arrayOfObjects: T[],
+  key: IdProp = "id"
+): Record<IdProp, T> =>
+  arrayOfObjects.reduce((final, obj: T) => {
+    final[obj[key].toString()] = obj;
+    return final;
+  }, {} as Record<IdProp, T>);
+
 // public, nameable shape for downstream packages that wish to extend the
 // foundation simulation store without importing deep cyclical types.
 export type ExtendStoreConfig<Schema, Actions, Selectors> = {
@@ -71,6 +81,8 @@ export type ExtendStoreConfig<Schema, Actions, Selectors> = {
 
 export type { AnyState, TableOutput, IdProp } from "starfx";
 
+export type PartialDocument = RecursivePartial<Document>;
+
 // the return type after a server is listening, useful for
 // referring to the running server while testing
 export type FoundationSimulatorListening<ExtendedSimulationStore> = {
@@ -448,9 +460,7 @@ export function createFoundationSimulationServer<
   };
 }
 
-const mergeDocumentArray = (
-  documents: RecursivePartial<Document>[]
-): Document => {
+const mergeDocumentArray = (documents: PartialDocument[]): Document => {
   let document = defu({}, ...documents);
   return document as Document;
 };

packages/github-api/src/store/entities.ts

@@ -1,5 +1,5 @@
 import { z } from "zod";
-import { type IdProp } from "@simulacrum/foundation-simulator";
+import { convertObjToProp } from "@simulacrum/foundation-simulator";
 import { faker } from "@faker-js/faker";
 
 export const githubUserSchema = z
@@ -412,27 +412,17 @@ export const gitubInitialStoreSchema = z
 export type GitHubStore = z.output<typeof gitubInitialStoreSchema>;
 export type GitHubInitialStore = z.input<typeof gitubInitialStoreSchema>;
 
-export const convertToObj = <T extends { [k: string]: any }>(
-  arrayOfObjects: T[],
-  key: IdProp = "id"
-): Record<IdProp, T> =>
-  arrayOfObjects.reduce((final, obj: T) => {
-    final[obj[key].toString()] = obj;
-    return final;
-  }, {} as Record<IdProp, T>);
-
 export const convertInitialStateToStoreState = (
   initialState: GitHubStore | undefined
 ) => {
   if (!initialState) return undefined;
-  // TODO try to make this generic?
   const storeObject = {
-    users: convertToObj(initialState.users, "login"),
-    installations: convertToObj(initialState.installations, "id"),
-    repositories: convertToObj(initialState.repositories, "name"),
-    branches: convertToObj(initialState.branches, "name"),
-    organizations: convertToObj(initialState.organizations, "login"),
-    blobs: convertToObj(initialState.blobs),
+    users: convertObjToProp(initialState.users, "login"),
+    installations: convertObjToProp(initialState.installations, "id"),
+    repositories: convertObjToProp(initialState.repositories, "name"),
+    branches: convertObjToProp(initialState.branches, "name"),
+    organizations: convertObjToProp(initialState.organizations, "login"),
+    blobs: convertObjToProp(initialState.blobs),
   };
 
   return storeObject;