tsondb 0.6.2 → 0.7.1

package/dist/src/node/schema/declarations/EntityDecl.d.ts

@@ -1,6 +1,6 @@
-import type { DisplayNameResult } from "../../../shared/utils/displayName.ts";
 import { Lazy } from "../../../shared/utils/lazy.ts";
 import type { Leaves } from "../../../shared/utils/object.ts";
+import type { DisplayNameCustomizer } from "../../utils/displayName.ts";
 import type { GetNestedDeclarations, GetReferences, Predicate, Serializer, TypeArgumentsResolver, Validator } from "../Node.ts";
 import { NodeKind } from "../Node.ts";
 import type { MemberDecl, ObjectType } from "../types/generic/ObjectType.ts";
@@ -8,12 +8,10 @@ import { StringType } from "../types/primitives/StringType.ts";
 import type { AsType } from "../types/Type.ts";
 import type { BaseDecl } from "./Declaration.ts";
 import { TypeAliasDecl } from "./TypeAliasDecl.ts";
-export type GenericDisplayNameFn = (instance: unknown, instanceDisplayName: string, getInstanceById: (id: string) => unknown, getDisplayNameForInstanceId: (id: string) => string | undefined, locales: string[]) => string;
 export type GenericEntityDisplayName = string | {
     pathToLocaleMap?: string;
     pathInLocaleMap?: string;
 } | null;
-export type DisplayNameFn<T extends ObjectType = ObjectType> = (instance: AsType<T>, instanceDisplayName: string, instanceDisplayNameLocaleId: string | undefined, getInstanceById: (id: string) => unknown, getDisplayNameForInstanceId: (id: string) => string | undefined, locales: string[]) => DisplayNameResult;
 export type EntityDisplayName<T extends TConstraint> = Leaves<AsType<ObjectType<T>>> | {
     /**
      * @default "translations"
@@ -34,7 +32,7 @@ export interface EntityDecl<Name extends string = string, T extends TConstraint
      * @default "name"
      */
     displayName?: EntityDisplayName<T>;
-    displayNameCustomizer?: DisplayNameFn<ObjectType<T>>;
+    displayNameCustomizer?: DisplayNameCustomizer<ObjectType<T>>;
     isDeprecated?: boolean;
 }
 export interface EntityDeclWithParentReference<Name extends string = string, T extends TConstraint = TConstraint, FK extends keyof T & string = keyof T & string> extends EntityDecl<Name, T, FK> {
@@ -49,7 +47,7 @@ export declare const EntityDecl: {
          * @default "name"
          */
         displayName?: EntityDisplayName<T>;
-        displayNameCustomizer?: DisplayNameFn<ObjectType<T>>;
+        displayNameCustomizer?: DisplayNameCustomizer<ObjectType<T>>;
         isDeprecated?: boolean;
     }): EntityDecl<Name, T, undefined>;
     <Name extends string, T extends TConstraint, FK extends keyof T & string>(sourceUrl: string, options: {
@@ -62,7 +60,7 @@ export declare const EntityDecl: {
          * @default "name"
          */
         displayName?: EntityDisplayName<T>;
-        displayNameCustomizer?: DisplayNameFn<ObjectType<T>>;
+        displayNameCustomizer?: DisplayNameCustomizer<ObjectType<T>>;
         isDeprecated?: boolean;
     }): EntityDecl<Name, T, FK>;
 };

package/dist/src/node/server/api/declarations.js

@@ -7,6 +7,7 @@ import { isEnumDecl } from "../../schema/declarations/EnumDecl.js";
 import { isTypeAliasDecl } from "../../schema/declarations/TypeAliasDecl.js";
 import { serializeNode } from "../../schema/index.js";
 import { getChildInstances } from "../../utils/childInstances.js";
+import { createChildInstancesForInstanceIdGetter } from "../utils/childInstances.js";
 import { createInstance, deleteInstance, updateInstance } from "../utils/instanceOperations.js";
 const debug = Debug("tsondb:server:api:declarations");
 export const declarationsApi = express.Router();
@@ -61,9 +62,10 @@ declarationsApi.get("/:name/instances", (req, res) => {
         res.status(400).send(`Declaration "${decl.name}" is not an entity`);
         return;
     }
+    const getChildInstancesForInstanceId = createChildInstancesForInstanceIdGetter(req);
     const body = {
         instances: req.instancesByEntityName[req.params.name]
-            ?.map(instanceContainer => getInstanceContainerOverview(decl, instanceContainer, req.getInstanceById, req.locales))
+            ?.map(instanceContainer => getInstanceContainerOverview(decl, instanceContainer, req.getInstanceById, getChildInstancesForInstanceId, req.locales))
             .toSorted((a, b) => a.displayName.localeCompare(b.displayName, undefined, { numeric: true })) ?? [],
         isLocaleEntity: decl === req.localeEntity,
     };

package/dist/src/node/server/api/git.js

@@ -5,6 +5,7 @@ import { hasFileChanges } from "../../../shared/utils/git.js";
 import { getInstanceContainerOverview } from "../../../shared/utils/instances.js";
 import { attachGitStatusToInstancesByEntityName } from "../../utils/instances.js";
 import { reinit } from "../init.js";
+import { createChildInstancesForInstanceIdGetter } from "../utils/childInstances.js";
 const debug = Debug("tsondb:server:api:git");
 export const gitApi = express.Router();
 gitApi.use((req, res, next) => {
@@ -20,6 +21,7 @@ gitApi.get("/status", async (req, res) => {
     attachGitStatusToInstancesByEntityName(req.instancesByEntityName, req.dataRoot, 
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     req.gitRoot, status);
+    const getChildInstancesForInstanceId = createChildInstancesForInstanceIdGetter(req);
     const body = {
         commitsAhead: status.ahead,
         commitsBehind: status.behind,
@@ -29,7 +31,7 @@ gitApi.get("/status", async (req, res) => {
                 .filter(instance => hasFileChanges(instance.gitStatus))
                 .map(instance => getInstanceContainerOverview(
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            req.entitiesByName[entityName], instance, req.getInstanceById, req.locales)),
+            req.entitiesByName[entityName], instance, req.getInstanceById, getChildInstancesForInstanceId, req.locales)),
         ])),
     };
     res.json(body);

package/dist/src/node/server/api/instances.js

@@ -1,6 +1,7 @@
 import Debug from "debug";
 import express from "express";
 import { getDisplayNameFromEntityInstance } from "../../utils/displayName.js";
+import { createChildInstancesForInstanceIdGetter } from "../utils/childInstances.js";
 const debug = Debug("tsondb:server:api:instances");
 export const instancesApi = express.Router();
 instancesApi.use((req, _res, next) => {
@@ -8,6 +9,7 @@ instancesApi.use((req, _res, next) => {
     next();
 });
 instancesApi.get("/", (req, res) => {
+    const getChildInstancesForInstanceId = createChildInstancesForInstanceIdGetter(req);
     const body = {
         instances: Object.fromEntries(Object.entries(req.instancesByEntityName)
             .filter(([entityName]) => Object.hasOwn(req.entitiesByName, entityName))
@@ -16,7 +18,7 @@ instancesApi.get("/", (req, res) => {
             instances.map(instance => {
                 const { name, localeId } = getDisplayNameFromEntityInstance(
                 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                req.entitiesByName[entityName], instance.content, req.getInstanceById, req.locales);
+                req.entitiesByName[entityName], instance, req.getInstanceById, getChildInstancesForInstanceId, req.locales);
                 return {
                     id: instance.id,
                     name,

package/dist/src/node/server/utils/childInstances.d.ts

@@ -1,4 +1,6 @@
 import { type Result } from "../../../shared/utils/result.ts";
-import type { EntityTaggedInstanceContainerWithChildInstances, UnsafeEntityTaggedInstanceContainerWithChildInstances } from "../../utils/childInstances.ts";
+import { type EntityTaggedInstanceContainerWithChildInstances, type UnsafeEntityTaggedInstanceContainerWithChildInstances } from "../../utils/childInstances.ts";
+import type { GetChildInstancesForInstanceId } from "../../utils/displayName.ts";
 import type { TSONDBRequestLocals } from "../index.ts";
 export declare const updateLocalsAfterInstanceTreeChangeToReflectDiskState: (locals: TSONDBRequestLocals, parentId: string | undefined, parentEntityName: string, oldChildInstances: EntityTaggedInstanceContainerWithChildInstances[], childInstances: UnsafeEntityTaggedInstanceContainerWithChildInstances[]) => Promise<Result<void, [code: number, message: string]>>;
+export declare const createChildInstancesForInstanceIdGetter: (locals: TSONDBRequestLocals) => GetChildInstancesForInstanceId;

package/dist/src/node/server/utils/childInstances.js

@@ -1,4 +1,6 @@
 import { error, ok } from "../../../shared/utils/result.js";
+import { isEntityDeclWithParentReference } from "../../schema/index.js";
+import { getChildInstancesFromEntity, } from "../../utils/childInstances.js";
 import { updateLocalsAfterInstanceChangeToReflectDiskState } from "./instanceOperations.js";
 export const updateLocalsAfterInstanceTreeChangeToReflectDiskState = async (locals, parentId, parentEntityName, oldChildInstances, childInstances) => {
     const parentEntity = locals.entitiesByName[parentEntityName];
@@ -39,3 +41,13 @@ export const updateLocalsAfterInstanceTreeChangeToReflectDiskState = async (loca
     }
     return ok();
 };
+export const createChildInstancesForInstanceIdGetter = (locals) => (parentEntityName, parentId, childEntityName) => {
+    const parentEntity = locals.entitiesByName[parentEntityName];
+    const childEntity = locals.entitiesByName[childEntityName];
+    if (parentEntity === undefined ||
+        childEntity === undefined ||
+        !isEntityDeclWithParentReference(childEntity)) {
+        return [];
+    }
+    return getChildInstancesFromEntity(locals.instancesByEntityName, parentEntity, parentId, childEntity);
+};

package/dist/src/node/utils/childInstances.d.ts

@@ -1,7 +1,7 @@
 import type { GitFileStatus } from "../../shared/utils/git.ts";
-import type { InstancesByEntityName } from "../../shared/utils/instances.ts";
+import type { InstanceContainer, InstancesByEntityName } from "../../shared/utils/instances.ts";
 import { type Result } from "../../shared/utils/result.ts";
-import type { EntityDecl } from "../schema/declarations/EntityDecl.ts";
+import type { EntityDecl, EntityDeclWithParentReference } from "../schema/declarations/EntityDecl.ts";
 import { type ReferencesToInstances } from "./references.ts";
 export interface ChildInstanceContainer {
     id?: string;
@@ -27,6 +27,7 @@ export interface GenEntityTaggedInstanceContainerWithChildInstances<ID extends s
     content: unknown;
     childInstances: C[];
 }
-export declare const getChildInstances: (instancesByEntityName: InstancesByEntityName, parentEntity: EntityDecl, parentId: string) => EntityTaggedInstanceContainerWithChildInstances[];
+export declare const getChildInstancesFromEntity: (instancesByEntityName: InstancesByEntityName, parentEntity: EntityDecl, parentId: string, childEntity: EntityDeclWithParentReference) => InstanceContainer[];
+export declare const getChildInstances: (instancesByEntityName: InstancesByEntityName, parentEntity: EntityDecl, parentId: string, recursive?: boolean) => EntityTaggedInstanceContainerWithChildInstances[];
 export declare const checkWriteInstanceTreePossible: (entitiesByName: Record<string, EntityDecl>, instancesByEntityName: InstancesByEntityName, referencesToInstances: ReferencesToInstances, parentId: string | undefined, parentEntityName: string, oldChildInstances: EntityTaggedInstanceContainerWithChildInstances[], childInstances: UnsafeEntityTaggedInstanceContainerWithChildInstances[]) => Result<void, [code: number, message: string]>;
 export declare const unsafeApplyInstanceTree: (dataRoot: string, entitiesByName: Record<string, EntityDecl>, instancesByEntityName: InstancesByEntityName, parentId: string | undefined, parentEntityName: string, oldChildInstances: EntityTaggedInstanceContainerWithChildInstances[], childInstances: UnsafeEntityTaggedInstanceContainerWithChildInstances[]) => Promise<Result<void, [code: number, message: string]>>;

package/dist/src/node/utils/childInstances.js

@@ -17,18 +17,19 @@ const isParentReferenceReferencingParent = (value, parentEntityName, parentId) =
         return false;
     }
 };
-export const getChildInstances = (instancesByEntityName, parentEntity, parentId) => {
+export const getChildInstancesFromEntity = (instancesByEntityName, parentEntity, parentId, childEntity) => instancesByEntityName[childEntity.name]?.filter(instanceContainer => typeof instanceContainer.content === "object" &&
+    instanceContainer.content !== null &&
+    hasKey(instanceContainer.content, childEntity.parentReferenceKey) &&
+    isParentReferenceReferencingParent(instanceContainer.content[childEntity.parentReferenceKey], parentEntity.name, parentId)) ?? [];
+export const getChildInstances = (instancesByEntityName, parentEntity, parentId, recursive = true) => {
     const childEntities = reduceNodes((_parentNodes, node, collectedResults) => isChildEntitiesType(node) ? [...collectedResults, node.entity] : collectedResults, [parentEntity], { followIncludes: true });
-    return childEntities.flatMap(childEntity => instancesByEntityName[childEntity.name]
-        ?.filter(instanceContainer => typeof instanceContainer.content === "object" &&
-        instanceContainer.content !== null &&
-        hasKey(instanceContainer.content, childEntity.parentReferenceKey) &&
-        isParentReferenceReferencingParent(instanceContainer.content[childEntity.parentReferenceKey], parentEntity.name, parentId))
-        .map(container => ({
+    return childEntities.flatMap(childEntity => getChildInstancesFromEntity(instancesByEntityName, parentEntity, parentId, childEntity).map(container => ({
         ...container,
         entityName: childEntity.name,
-        childInstances: getChildInstances(instancesByEntityName, childEntity, container.id),
-    })) ?? []);
+        childInstances: recursive
+            ? getChildInstances(instancesByEntityName, childEntity, container.id)
+            : [],
+    })));
 };
 export const checkWriteInstanceTreePossible = (entitiesByName, instancesByEntityName, referencesToInstances, parentId, parentEntityName, oldChildInstances, childInstances) => {
     const parentEntity = entitiesByName[parentEntityName];

package/dist/src/node/utils/displayName.d.ts

@@ -1,4 +1,17 @@
-import { type EntityDecl } from "../../node/schema/index.ts";
 import type { GetInstanceById } from "../../node/server/index.ts";
 import { type DisplayNameResult } from "../../shared/utils/displayName.ts";
-export declare const getDisplayNameFromEntityInstance: (entity: EntityDecl, instance: unknown, getInstanceById: GetInstanceById, locales: string[], defaultName?: string, useCustomizer?: boolean) => DisplayNameResult;
+import type { InstanceContainer } from "../../shared/utils/instances.ts";
+import { type EntityDecl } from "../schema/declarations/EntityDecl.ts";
+import type { AsType, Type } from "../schema/types/Type.ts";
+export type GetChildInstancesForInstanceId = (parentEntityName: string, parentId: string, childEntityName: string) => unknown[];
+export type DisplayNameCustomizer<T extends Type> = (params: {
+    instance: AsType<T>;
+    instanceId: string;
+    instanceDisplayName: string;
+    instanceDisplayNameLocaleId: string | undefined;
+    locales: string[];
+    getInstanceById: (id: string) => unknown;
+    getDisplayNameForInstanceId: (id: string) => string | undefined;
+    getChildInstancesForInstanceId: GetChildInstancesForInstanceId;
+}) => DisplayNameResult;
+export declare const getDisplayNameFromEntityInstance: (entity: EntityDecl, instanceContainer: InstanceContainer, getInstanceById: GetInstanceById, getChildInstancesForInstanceId: GetChildInstancesForInstanceId, locales: string[], defaultName?: string, useCustomizer?: boolean) => DisplayNameResult;

package/dist/src/node/utils/displayName.js

@@ -1,20 +1,29 @@
-import { serializeEntityDecl } from "../../node/schema/index.js";
 import { getSerializedDisplayNameFromEntityInstance, } from "../../shared/utils/displayName.js";
-export const getDisplayNameFromEntityInstance = (entity, instance, getInstanceById, locales, defaultName = "", useCustomizer = true) => {
+import { serializeEntityDecl } from "../schema/declarations/EntityDecl.js";
+export const getDisplayNameFromEntityInstance = (entity, instanceContainer, getInstanceById, getChildInstancesForInstanceId, locales, defaultName = "", useCustomizer = true) => {
     if (useCustomizer && entity.displayNameCustomizer) {
-        const calculatedName = getDisplayNameFromEntityInstance(entity, instance, getInstanceById, locales, defaultName, false);
-        return entity.displayNameCustomizer(instance, calculatedName.name, calculatedName.localeId, id => getInstanceById(id)?.instance.content, id => {
-            const result = getInstanceById(id);
-            if (result) {
-                const { entity, instance } = result;
-                return getDisplayNameFromEntityInstance(entity, instance.content, getInstanceById, locales, id).name;
-            }
-            else {
-                return undefined;
-            }
-        }, locales);
+        const calculatedName = getDisplayNameFromEntityInstance(entity, instanceContainer, getInstanceById, getChildInstancesForInstanceId, locales, defaultName, false);
+        return entity.displayNameCustomizer({
+            instance: instanceContainer.content,
+            instanceId: instanceContainer.id,
+            instanceDisplayName: calculatedName.name,
+            instanceDisplayNameLocaleId: calculatedName.localeId,
+            locales,
+            getInstanceById: id => getInstanceById(id)?.instance.content,
+            getDisplayNameForInstanceId: id => {
+                const result = getInstanceById(id);
+                if (result) {
+                    const { entity, instance } = result;
+                    return getDisplayNameFromEntityInstance(entity, instance, getInstanceById, getChildInstancesForInstanceId, locales, id).name;
+                }
+                else {
+                    return undefined;
+                }
+            },
+            getChildInstancesForInstanceId,
+        });
     }
     else {
-        return getSerializedDisplayNameFromEntityInstance(serializeEntityDecl(entity), instance, defaultName, locales);
+        return getSerializedDisplayNameFromEntityInstance(serializeEntityDecl(entity), instanceContainer.content, defaultName, locales);
     }
 };

package/dist/src/shared/utils/instances.d.ts

@@ -1,5 +1,6 @@
 import type { EntityDecl } from "../../node/schema/index.ts";
 import type { GetInstanceById } from "../../node/server/index.ts";
+import { type GetChildInstancesForInstanceId } from "../../node/utils/displayName.ts";
 import type { GitFileStatus } from "./git.ts";
 export interface InstanceContainer {
     id: string;
@@ -12,5 +13,5 @@ export interface InstanceContainerOverview {
     displayName: string;
     displayNameLocaleId?: string;
 }
-export declare const getInstanceContainerOverview: (entity: EntityDecl, instanceContainer: InstanceContainer, getInstanceById: GetInstanceById, locales: string[]) => InstanceContainerOverview;
+export declare const getInstanceContainerOverview: (entity: EntityDecl, instanceContainer: InstanceContainer, getInstanceById: GetInstanceById, getChildInstancesForInstanceId: GetChildInstancesForInstanceId, locales: string[]) => InstanceContainerOverview;
 export type InstancesByEntityName = Record<string, InstanceContainer[]>;

package/dist/src/shared/utils/instances.js

@@ -1,7 +1,7 @@
-import { getDisplayNameFromEntityInstance } from "../../node/utils/displayName.js";
-export const getInstanceContainerOverview = (entity, instanceContainer, getInstanceById, locales) => {
+import { getDisplayNameFromEntityInstance, } from "../../node/utils/displayName.js";
+export const getInstanceContainerOverview = (entity, instanceContainer, getInstanceById, getChildInstancesForInstanceId, locales) => {
     const { content: _, ...rest } = instanceContainer;
-    const { name: displayName, localeId: displayNameLocaleId } = getDisplayNameFromEntityInstance(entity, instanceContainer.content, getInstanceById, locales);
+    const { name: displayName, localeId: displayNameLocaleId } = getDisplayNameFromEntityInstance(entity, instanceContainer, getInstanceById, getChildInstancesForInstanceId, locales);
     return {
         ...rest,
         displayName,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tsondb",
-  "version": "0.6.2",
+  "version": "0.7.1",
   "description": "",
   "license": "ISC",
   "author": "Lukas Obermann",