tsondb 0.4.0 → 0.5.1

package/lib/bin/tsondb.d.ts

@@ -1,8 +1,10 @@
 #!/usr/bin/env node
 import type { Output } from "../node/renderers/Output.ts";
 import type { Schema } from "../node/Schema.ts";
+import type { ServerOptions } from "../node/server/index.ts";
 export type Config = {
+    serverOptions?: ServerOptions;
     schema: Schema;
     outputs: Output[];
-    dataRootPath?: string;
+    dataRootPath: string;
 };

package/lib/bin/tsondb.js

@@ -12,7 +12,7 @@ import { access, constants } from "node:fs/promises";
 import { join } from "node:path";
 import { cwd } from "node:process";
 import { parseArguments } from "simple-cli-args";
-import { generateOutputs, serve, validate } from "../node/index.js";
+import { format, generateOutputs, serve, validate } from "../node/index.js";
 const debug = Debug("tsondb:cli");
 const passedArguments = parseArguments({
     commands: {
@@ -25,6 +25,9 @@ const passedArguments = parseArguments({
         serve: {
             name: "serve",
         },
+        format: {
+            name: "format",
+        },
     },
 });
 // import the config
@@ -68,16 +71,14 @@ switch (passedArguments.command.name) {
         break;
     case "serve":
         debug(`running command: serve`);
-        if (config.dataRootPath === undefined) {
-            throw new Error("No dataRootPath specified in config");
-        }
-        await serve(config.schema, config.dataRootPath);
+        await serve(config.schema, config.dataRootPath, config.serverOptions);
         break;
     case "validate":
         debug(`running command: validate`);
-        if (config.dataRootPath === undefined) {
-            throw new Error("No dataRootPath specified in config");
-        }
         await validate(config.schema, config.dataRootPath);
         break;
+    case "format":
+        debug(`running command: format`);
+        await format(config.schema, config.dataRootPath);
+        break;
 }

package/lib/node/Schema.js

@@ -4,10 +4,11 @@ import { isStringType } from "./schema/types/primitives/StringType.js";
 import { isNestedEntityMapType } from "./schema/types/references/NestedEntityMapType.js";
 import { findTypeAtPath } from "./schema/types/Type.js";
 const checkDuplicateIdentifier = (existingDecls, decl) => {
-    if (existingDecls
+    const existingDeclWithSameName = existingDecls
         .values()
-        .some(otherDecl => otherDecl !== decl && otherDecl.name.toLowerCase() === decl.name.toLowerCase())) {
-        throw new Error(`Duplicate declaration name: "${decl.name}". Make sure declaration names are globally unique.`);
+        .find(otherDecl => otherDecl !== decl && otherDecl.name.toLowerCase() === decl.name.toLowerCase());
+    if (existingDeclWithSameName) {
+        throw new Error(`Duplicate declaration name "${decl.name}" in "${decl.sourceUrl}" and "${existingDeclWithSameName.sourceUrl}". Make sure declaration names are globally unique.`);
     }
 };
 const checkParameterNamesShadowing = (decls) => {
@@ -21,7 +22,7 @@ const checkParameterNamesShadowing = (decls) => {
 };
 const checkEntityDisplayNamePaths = (decls, localeEntity) => {
     for (const decl of decls) {
-        if (isEntityDecl(decl)) {
+        if (isEntityDecl(decl) && decl.displayName !== null) {
             const displayName = decl.displayName ?? "name";
             if (typeof displayName === "object") {
                 const pathToLocaleMap = displayName.pathToLocaleMap ?? "translations";

package/lib/node/index.d.ts

@@ -6,3 +6,4 @@ export declare const validate: (schema: Schema, dataRootPath: string) => Promise
 export declare const generateAndValidate: (schema: Schema, outputs: Output[], dataRootPath: string) => Promise<void>;
 export declare const serve: (schema: Schema, dataRootPath: string, serverOptions?: Partial<ServerOptions>) => Promise<void>;
 export declare const generateValidateAndServe: (schema: Schema, outputs: Output[], dataRootPath: string, serverOptions?: Partial<ServerOptions>) => Promise<void>;
+export declare const format: (schema: Schema, dataRootPath: string) => Promise<void>;

package/lib/node/index.js

@@ -1,12 +1,12 @@
 import Debug from "debug";
-import { mkdir } from "fs/promises";
+import { mkdir, writeFile } from "fs/promises";
 import { join } from "path";
 import { parallelizeErrors } from "../shared/utils/validation.js";
 import { getEntities } from "./Schema.js";
 import { createValidators, validateEntityDecl } from "./schema/index.js";
 import { createServer } from "./server/index.js";
 import { getErrorMessageForDisplay, wrapErrorsIfAny } from "./utils/error.js";
-import { getInstancesByEntityName } from "./utils/instances.js";
+import { formatInstance, getInstancesByEntityName } from "./utils/instances.js";
 const debug = Debug("tsondb:schema");
 const prepareFolders = async (dataRootPath, entities) => {
     await mkdir(dataRootPath, { recursive: true });
@@ -20,8 +20,8 @@ export const generateOutputs = async (schema, outputs) => {
         await output.run(schema);
     }
 };
-const _validate = (entities, instancesByEntityName) => {
-    const errors = entities.flatMap(entity => parallelizeErrors(instancesByEntityName[entity.name]?.map(instance => wrapErrorsIfAny(`in file "${entity.name}/${instance.fileName}"`, validateEntityDecl(createValidators(instancesByEntityName), entity, instance.content))) ?? []));
+const _validate = (dataRootPath, entities, instancesByEntityName) => {
+    const errors = entities.flatMap(entity => parallelizeErrors(instancesByEntityName[entity.name]?.map(instance => wrapErrorsIfAny(`in file "${join(dataRootPath, entity.name, instance.fileName)}"`, validateEntityDecl(createValidators(instancesByEntityName), entity, instance.content))) ?? []));
     if (errors.length === 0) {
         debug("All entities are valid");
     }
@@ -37,14 +37,14 @@ export const validate = async (schema, dataRootPath) => {
     const entities = getEntities(schema);
     await prepareFolders(dataRootPath, entities);
     const instancesByEntityName = await getInstancesByEntityName(dataRootPath, entities);
-    _validate(entities, instancesByEntityName);
+    _validate(dataRootPath, entities, instancesByEntityName);
 };
 export const generateAndValidate = async (schema, outputs, dataRootPath) => {
     await generateOutputs(schema, outputs);
     const entities = getEntities(schema);
     await prepareFolders(dataRootPath, entities);
     const instancesByEntityName = await getInstancesByEntityName(dataRootPath, entities);
-    _validate(entities, instancesByEntityName);
+    _validate(dataRootPath, entities, instancesByEntityName);
 };
 export const serve = async (schema, dataRootPath, serverOptions) => {
     const entities = getEntities(schema);
@@ -57,6 +57,19 @@ export const generateValidateAndServe = async (schema, outputs, dataRootPath, se
     const entities = getEntities(schema);
     await prepareFolders(dataRootPath, entities);
     const instancesByEntityName = await getInstancesByEntityName(dataRootPath, entities);
-    _validate(entities, instancesByEntityName);
+    _validate(dataRootPath, entities, instancesByEntityName);
     await createServer(schema, dataRootPath, instancesByEntityName, serverOptions);
 };
+export const format = async (schema, dataRootPath) => {
+    const entities = getEntities(schema);
+    await prepareFolders(dataRootPath, entities);
+    const instancesByEntityName = await getInstancesByEntityName(dataRootPath, entities);
+    for (const entityName in instancesByEntityName) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const entity = entities.find(entity => entity.name === entityName);
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        for (const instance of instancesByEntityName[entityName]) {
+            await writeFile(join(dataRootPath, entityName, instance.fileName), formatInstance(entity, instance.content), { encoding: "utf-8" });
+        }
+    }
+};

package/lib/node/renderers/jsonschema/index.js

@@ -1,17 +1,21 @@
+import Debug from "debug";
 import { mkdir, rm, writeFile } from "node:fs/promises";
 import { basename, dirname, extname, join, relative } from "node:path";
 import { fileURLToPath } from "node:url";
 import { commonPrefix } from "../../../shared/utils/string.js";
 import { groupDeclarationsBySourceUrl, resolveTypeArgumentsInDecls } from "../../schema/index.js";
 import { render } from "./render.js";
+const debug = Debug("tsondb:renderer:jsonschema");
 const extension = ".schema.json";
 export const JsonSchemaOutput = (options) => ({
     run: async (schema) => {
         if (options.rendererOptions?.preserveFiles === true) {
+            debug("emitting declarations to multiple files...");
             await rm(options.targetPath, { recursive: true, force: true });
             await mkdir(options.targetPath, { recursive: true });
             const declarationsBySourceUrl = groupDeclarationsBySourceUrl(resolveTypeArgumentsInDecls(schema.declarations));
             const sourceRootPath = fileURLToPath(commonPrefix(...Object.keys(declarationsBySourceUrl)));
+            debug("common source root path: %s", sourceRootPath);
             if (sourceRootPath) {
                 for (const [sourceUrl, decls] of Object.entries(declarationsBySourceUrl)) {
                     const sourcePath = fileURLToPath(sourceUrl);
@@ -23,13 +27,16 @@ export const JsonSchemaOutput = (options) => ({
                         encoding: "utf-8",
                     });
                 }
+                debug("emitted declaration files to %s", options.targetPath);
             }
         }
         else {
+            debug("emitting declarations to single file...");
             await mkdir(dirname(options.targetPath), { recursive: true });
             await writeFile(options.targetPath, render(options.rendererOptions, resolveTypeArgumentsInDecls(schema.declarations)), {
                 encoding: "utf-8",
             });
+            debug("emitted declarations to %s", options.targetPath);
         }
     },
 });

package/lib/node/renderers/jsonschema/render.js

@@ -162,8 +162,13 @@ const renderDeclarations = (options, declarations) => Object.fromEntries(declara
 export const render = (options = defaultOptions, declarations) => {
     const finalOptions = { ...defaultOptions, ...options };
     return JSON.stringify({
-        $defs: renderDeclarations(finalOptions, flatMapAuxiliaryDecls(node => {
+        $defs: renderDeclarations(finalOptions, flatMapAuxiliaryDecls((node, existingDecls) => {
             if (isNestedEntityMapType(node)) {
+                if (existingDecls.some(decl => decl.name === node.name)) {
+                    // this may happen when a nested entity map is defined in a generic declaration and the generic declaration is used multiple times
+                    // TODO: circumvent by defining the nested entity declaration outside the generic declaration
+                    return undefined;
+                }
                 return TypeAliasDecl(getParentDecl(node)?.sourceUrl ?? "", {
                     name: node.name,
                     comment: node.comment,

package/lib/node/renderers/ts/render.js

@@ -1,6 +1,7 @@
 import { EOL } from "node:os";
 import { dirname, relative } from "node:path";
 import { discriminatorKey } from "../../../shared/enum.js";
+import { unique } from "../../../shared/utils/array.js";
 import { toCamelCase } from "../../../shared/utils/string.js";
 import { assertExhaustive } from "../../../shared/utils/typeSafety.js";
 import { addEphemeralUUIDToType, createEntityIdentifierTypeAsDecl, isEntityDecl, } from "../../schema/declarations/EntityDecl.js";
@@ -110,7 +111,9 @@ const renderImports = (currentUrl, imports) => {
         names,
     ])
         .toSorted(([sourceUrlA], [sourceUrlB]) => sourceUrlA.localeCompare(sourceUrlB))
-        .map(([sourceUrl, names]) => `import { ${names.toSorted((a, b) => a.localeCompare(b)).join(", ")} } from "${sourceUrl}"`)
+        .map(([sourceUrl, names]) => `import { ${unique(names)
+        .toSorted((a, b) => a.localeCompare(b))
+        .join(", ")} } from "${sourceUrl}"`)
         .join(EOL);
     return importsSyntax.length > 0 ? importsSyntax + EOL + EOL : "";
 };

package/lib/node/schema/Node.d.ts

@@ -26,7 +26,7 @@ export interface BaseNode {
     kind: (typeof NodeKind)[keyof typeof NodeKind];
 }
 export type Node = Decl | Type;
-export declare const flatMapAuxiliaryDecls: (callbackFn: (node: Node) => (Decl | undefined)[] | Decl | undefined, declarations: readonly Decl[]) => Decl[];
+export declare const flatMapAuxiliaryDecls: (callbackFn: (node: Node, existingDecls: Decl[]) => (Decl | undefined)[] | Decl | undefined, declarations: readonly Decl[]) => Decl[];
 export type IdentifierToCheck = {
     name: string;
     value: unknown;

package/lib/node/schema/Node.js

@@ -62,11 +62,12 @@ export const flatMapAuxiliaryDecls = (callbackFn, declarations) => {
         }
     };
     const reducer = (node, decls) => {
-        const result = callbackFn(node);
+        const result = callbackFn(node, decls);
         const normalizedResult = (Array.isArray(result) ? result : [result]).filter(decl => decl !== undefined);
         normalizedResult.forEach(decl => {
-            if (decls.some(existingDecl => existingDecl.name === decl.name)) {
-                throw new Error(`Duplicate declaration name: "${decl.name}". Make sure declaration names are globally unique.`);
+            const existingDeclWithSameName = decls.find(existingDecl => existingDecl !== decl && existingDecl.name === decl.name);
+            if (existingDeclWithSameName) {
+                throw new Error(`Duplicate declaration name: "${decl.name}" in "${decl.sourceUrl}" and "${existingDeclWithSameName.sourceUrl}". Make sure declaration names are globally unique.`);
             }
         });
         return decls.concat(normalizedResult);

package/lib/node/schema/declarations/EntityDecl.d.ts

@@ -24,7 +24,7 @@ export interface EntityDecl<Name extends string = string, T extends ObjectType =
          * @default "name"
          */
         pathInLocaleMap?: string;
-    };
+    } | null;
     isDeprecated?: boolean;
 }
 export interface SerializedEntityDecl<Name extends string = string, T extends SerializedObjectType = SerializedObjectType> extends SerializedBaseDecl<Name, []> {
@@ -43,7 +43,7 @@ export interface SerializedEntityDecl<Name extends string = string, T extends Se
          * @default "name"
          */
         pathInLocaleMap?: string;
-    };
+    } | null;
     isDeprecated?: boolean;
 }
 export declare const EntityDecl: <Name extends string, T extends ObjectType>(sourceUrl: string, options: {
@@ -63,7 +63,7 @@ export declare const EntityDecl: <Name extends string, T extends ObjectType>(sou
          * @default "name"
          */
         pathInLocaleMap?: string;
-    };
+    } | null;
     isDeprecated?: boolean;
 }) => EntityDecl<Name, T>;
 export { EntityDecl as Entity };

package/lib/node/schema/declarations/EntityDecl.js

@@ -2,7 +2,7 @@ import { Lazy } from "../../../shared/utils/lazy.js";
 import { NodeKind } from "../Node.js";
 import { getNestedDeclarationsInObjectType, getReferencesForObjectType, Required, resolveTypeArgumentsInObjectType, serializeObjectType, } from "../types/generic/ObjectType.js";
 import { StringType } from "../types/primitives/StringType.js";
-import { validate } from "../types/Type.js";
+import { setParent, validate } from "../types/Type.js";
 import { validateDeclName } from "./Declaration.js";
 import { TypeAliasDecl } from "./TypeAliasDecl.js";
 export const EntityDecl = (sourceUrl, options) => {
@@ -19,8 +19,7 @@ export const EntityDecl = (sourceUrl, options) => {
                     throw new TypeError(`Invalid object key "${key}" for entity "${options.name}". The key "id" is reserved for the entity identifier.`);
                 }
             });
-            type.parent = decl;
-            return type;
+            return setParent(type, decl);
         }),
     };
     return decl;

package/lib/node/schema/declarations/EnumDecl.d.ts

@@ -4,7 +4,7 @@ import { NodeKind } from "../Node.js";
 import type { SerializedTypeParameter, TypeParameter } from "../TypeParameter.js";
 import type { EnumCaseDecl, SerializedEnumCaseDecl, SerializedEnumType } from "../types/generic/EnumType.js";
 import { EnumType } from "../types/generic/EnumType.js";
-import type { Type } from "../types/Type.js";
+import { type Type } from "../types/Type.js";
 import type { ValidatorHelpers } from "../validation/type.js";
 import type { BaseDecl, GetNestedDeclarations, SerializedBaseDecl, TypeArguments } from "./Declaration.js";
 export interface EnumDecl<Name extends string = string, T extends Record<string, EnumCaseDecl> = Record<string, EnumCaseDecl>, Params extends TypeParameter[] = TypeParameter[]> extends BaseDecl<Name, Params> {

package/lib/node/schema/declarations/EnumDecl.js

@@ -2,6 +2,7 @@ import { Lazy } from "../../../shared/utils/lazy.js";
 import { NodeKind } from "../Node.js";
 import { serializeTypeParameter } from "../TypeParameter.js";
 import { EnumType, getNestedDeclarationsInEnumType, getReferencesForEnumType, resolveTypeArgumentsInEnumType, serializeEnumType, validateEnumType, } from "../types/generic/EnumType.js";
+import { setParent } from "../types/Type.js";
 import { getTypeArgumentsRecord, validateDeclName } from "./Declaration.js";
 export const GenEnumDecl = (sourceUrl, options) => {
     validateDeclName(options.name);
@@ -9,11 +10,7 @@ export const GenEnumDecl = (sourceUrl, options) => {
         ...options,
         kind: NodeKind.EnumDecl,
         sourceUrl,
-        type: Lazy.of(() => {
-            const type = EnumType(options.values(...options.parameters));
-            type.parent = decl;
-            return type;
-        }),
+        type: Lazy.of(() => setParent(EnumType(options.values(...options.parameters)), decl)),
     };
     return decl;
 };
@@ -25,11 +22,7 @@ export const EnumDecl = (sourceUrl, options) => {
         kind: NodeKind.EnumDecl,
         sourceUrl,
         parameters: [],
-        type: Lazy.of(() => {
-            const type = EnumType(options.values());
-            type.parent = decl;
-            return type;
-        }),
+        type: Lazy.of(() => setParent(EnumType(options.values()), decl)),
     };
     return decl;
 };

package/lib/node/schema/declarations/TypeAliasDecl.js

@@ -1,7 +1,7 @@
 import { Lazy } from "../../../shared/utils/lazy.js";
 import { NodeKind } from "../Node.js";
 import { serializeTypeParameter } from "../TypeParameter.js";
-import { getReferencesForType, resolveTypeArgumentsInType, serializeType, validate, } from "../types/Type.js";
+import { getReferencesForType, resolveTypeArgumentsInType, serializeType, setParent, validate, } from "../types/Type.js";
 import { getNestedDeclarations, getTypeArgumentsRecord, validateDeclName } from "./Declaration.js";
 export const GenTypeAliasDecl = (sourceUrl, options) => {
     validateDeclName(options.name);
@@ -9,11 +9,7 @@ export const GenTypeAliasDecl = (sourceUrl, options) => {
         ...options,
         kind: NodeKind.TypeAliasDecl,
         sourceUrl,
-        type: Lazy.of(() => {
-            const type = options.type(...options.parameters);
-            type.parent = decl;
-            return type;
-        }),
+        type: Lazy.of(() => setParent(options.type(...options.parameters), decl)),
     };
     return decl;
 };
@@ -25,11 +21,7 @@ export const TypeAliasDecl = (sourceUrl, options) => {
         kind: NodeKind.TypeAliasDecl,
         sourceUrl,
         parameters: [],
-        type: Lazy.of(() => {
-            const type = options.type();
-            type.parent = decl;
-            return type;
-        }),
+        type: Lazy.of(() => setParent(options.type(), decl)),
     };
     return decl;
 };

package/lib/node/schema/types/Type.d.ts

@@ -37,9 +37,15 @@ export type AsNode<T> = T extends (infer I)[] ? ArrayType<AsNode<I>> : T extends
     [K in keyof T]: T[K] extends MemberDecl ? T[K] : T extends null | undefined ? MemberDecl<AsNode<NonNullable<T[K]>>, false> : MemberDecl<AsNode<T[K]>, true>;
 }> : T extends string ? StringType : T extends number ? FloatType : T extends boolean ? BooleanType : never;
 export declare const getParentDecl: (type: Type) => Decl | undefined;
+/**
+ * Sets the `parent` property of the passed `type` to the passed `parentNode`.
+ *
+ * The property is set on the instance. It does not create a new instance.
+ */
+export declare const setParent: <T extends BaseType>(type: Omit<T, "parent">, parentNode: Type | Decl) => T;
+export declare const removeParentKey: <T extends BaseType>(type: T) => Omit<T, "parent">;
 export declare const findTypeAtPath: (type: Type, path: string[]) => Type | undefined;
 export declare const serializeType: Serializer<Type, SerializedType>;
-export declare const removeParentKey: <T extends BaseType>(type: T) => Omit<T, "parent">;
 export declare const getReferencesForType: GetReferences<Type>;
 /**
  * Format the structure of a value to always look the same when serialized as JSON.

package/lib/node/schema/types/Type.js

@@ -127,6 +127,20 @@ export const getParentDecl = (type) => {
         return getParentDecl(type.parent);
     }
 };
+/**
+ * Sets the `parent` property of the passed `type` to the passed `parentNode`.
+ *
+ * The property is set on the instance. It does not create a new instance.
+ */
+export const setParent = (type, parentNode) => {
+    ;
+    type.parent = parentNode;
+    return type;
+};
+export const removeParentKey = (type) => {
+    const { parent: _parent, ...rest } = type;
+    return rest;
+};
 export const findTypeAtPath = (type, path) => {
     const [head, ...tail] = path;
     if (head === undefined) {
@@ -173,10 +187,6 @@ export const serializeType = type => {
             return assertExhaustive(type);
     }
 };
-export const removeParentKey = (type) => {
-    const { parent: _parent, ...rest } = type;
-    return rest;
-};
 export const getReferencesForType = (type, value) => {
     switch (type.kind) {
         case NodeKind.ArrayType:

package/lib/node/schema/types/generic/ArrayType.js

@@ -4,7 +4,7 @@ import { wrapErrorsIfAny } from "../../../utils/error.js";
 import { getNestedDeclarations } from "../../declarations/Declaration.js";
 import { NodeKind } from "../../Node.js";
 import { validateOption } from "../../validation/options.js";
-import { formatValue, getReferencesForType, removeParentKey, resolveTypeArgumentsInType, serializeType, validate, } from "../Type.js";
+import { formatValue, getReferencesForType, removeParentKey, resolveTypeArgumentsInType, serializeType, setParent, validate, } from "../Type.js";
 export const ArrayType = (items, options = {}) => {
     const type = {
         ...options,
@@ -13,7 +13,7 @@ export const ArrayType = (items, options = {}) => {
         maxItems: validateOption(options.maxItems, "maxItems", option => Number.isInteger(option) && option >= 0),
         items,
     };
-    items.parent = type;
+    setParent(type.items, type);
     return type;
 };
 export { ArrayType as Array };

package/lib/node/schema/types/generic/EnumType.js

@@ -27,11 +27,15 @@ export const validateEnumType = (helpers, type, value) => {
     }
     const caseName = value[discriminatorKey];
     if (!(caseName in type.values)) {
-        return [TypeError(`discriminator "${caseName}" is not a valid enum case`)];
+        return [
+            TypeError(`discriminator "${caseName}" is not a valid enum case, possible cases are: ${Object.keys(type.values).join(", ")}`),
+        ];
     }
     const unknownKeyErrors = actualKeys.flatMap(actualKey => actualKey === discriminatorKey || actualKey in type.values
         ? []
-        : [TypeError(`key "${actualKey}" is not the discriminator key or a valid enum case`)]);
+        : [
+            TypeError(`key "${actualKey}" is not the discriminator key "${caseName}" or a valid enum case, possible cases are: ${Object.keys(type.values).join(", ")}`),
+        ]);
     if (unknownKeyErrors.length > 0) {
         return unknownKeyErrors;
     }

package/lib/node/schema/types/generic/ObjectType.js

@@ -5,7 +5,7 @@ import { wrapErrorsIfAny } from "../../../utils/error.js";
 import { getNestedDeclarations } from "../../declarations/Declaration.js";
 import { NodeKind } from "../../Node.js";
 import { validateOption } from "../../validation/options.js";
-import { getReferencesForType, removeParentKey, resolveTypeArgumentsInType, serializeType, validate, } from "../Type.js";
+import { formatValue, getReferencesForType, removeParentKey, resolveTypeArgumentsInType, serializeType, setParent, validate, } from "../Type.js";
 const keyPattern = /^[a-zA-Z0-9][a-zA-Z0-9_]*$/;
 export const ObjectType = (properties, options = {}) => {
     const type = {
@@ -20,7 +20,7 @@ export const ObjectType = (properties, options = {}) => {
             throw new TypeError(`Invalid object key "${key}". Object keys must not start with an underscore and may only contain letters, digits and underscores. (Pattern: ${keyPattern.source})`);
         }
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        properties[key].type.parent = type;
+        setParent(properties[key].type, type);
     });
     return type;
 };
@@ -75,5 +75,8 @@ export const getReferencesForObjectType = (type, value) => typeof value === "obj
     key in type.properties ? getReferencesForType(type.properties[key].type, propValue) : [])
     : [];
 export const formatObjectValue = (type, value) => typeof value === "object" && value !== null && !Array.isArray(value)
-    ? sortObjectKeys(value, Object.keys(type.properties))
+    ? sortObjectKeys(Object.fromEntries(Object.entries(value).map(([key, item]) => [
+        key,
+        type.properties[key] ? formatValue(type.properties[key].type, item) : item,
+    ])), Object.keys(type.properties))
     : value;

package/lib/node/schema/types/references/NestedEntityMapType.js

@@ -4,16 +4,12 @@ import { parallelizeErrors } from "../../../../shared/utils/validation.js";
 import { wrapErrorsIfAny } from "../../../utils/error.js";
 import { NodeKind } from "../../Node.js";
 import { getNestedDeclarationsInObjectType, getReferencesForObjectType, resolveTypeArgumentsInObjectType, serializeObjectType, validateObjectType, } from "../generic/ObjectType.js";
-import { removeParentKey } from "../Type.js";
+import { formatValue, removeParentKey, setParent } from "../Type.js";
 export const NestedEntityMapType = (options) => {
     const nestedEntityMapType = {
         ...options,
         kind: NodeKind.NestedEntityMapType,
-        type: Lazy.of(() => {
-            const type = options.type;
-            type.parent = nestedEntityMapType;
-            return type;
-        }),
+        type: Lazy.of(() => setParent(options.type, nestedEntityMapType)),
     };
     return nestedEntityMapType;
 };
@@ -22,11 +18,7 @@ const _NestedEntityMapType = (options) => {
     const nestedEntityMapType = {
         ...options,
         kind: NodeKind.NestedEntityMapType,
-        type: Lazy.of(() => {
-            const type = options.type();
-            type.parent = nestedEntityMapType;
-            return type;
-        }),
+        type: Lazy.of(() => setParent(options.type(), nestedEntityMapType)),
     };
     return nestedEntityMapType;
 };
@@ -55,6 +47,6 @@ export const getReferencesForNestedEntityMapType = (type, value) => typeof value
         .flatMap(item => getReferencesForObjectType(type.type.value, item))
         .concat(Object.keys(value))
     : [];
-export const formatNestedEntityMapValue = (_type, value) => typeof value === "object" && value !== null && !Array.isArray(value)
-    ? sortObjectKeysAlphabetically(value)
+export const formatNestedEntityMapValue = (type, value) => typeof value === "object" && value !== null && !Array.isArray(value)
+    ? sortObjectKeysAlphabetically(Object.fromEntries(Object.entries(value).map(([key, item]) => [key, formatValue(type.type.value, item)])))
     : value;

package/lib/node/server/api/declarations.js

@@ -1,8 +1,9 @@
 import Debug from "debug";
 import express from "express";
+import { getInstanceContainerOverview } from "../../../shared/utils/instances.js";
 import { isOk } from "../../../shared/utils/result.js";
 import { serializeDecl } from "../../schema/declarations/Declaration.js";
-import { isEntityDecl } from "../../schema/declarations/EntityDecl.js";
+import { isEntityDecl, serializeEntityDecl } from "../../schema/declarations/EntityDecl.js";
 import { isEnumDecl } from "../../schema/declarations/EnumDecl.js";
 import { isTypeAliasDecl } from "../../schema/declarations/TypeAliasDecl.js";
 import { createInstance, deleteInstance, updateInstance } from "./instanceOperations.js";
@@ -59,8 +60,11 @@ declarationsApi.get("/:name/instances", (req, res) => {
         res.status(400).send(`Declaration "${decl.name}" is not an entity`);
         return;
     }
+    const serializedEntityDecl = serializeEntityDecl(decl);
     const body = {
-        instances: req.instancesByEntityName[req.params.name] ?? [],
+        instances: req.instancesByEntityName[req.params.name]
+            ?.map(instanceContainer => getInstanceContainerOverview(serializedEntityDecl, instanceContainer, req.locales))
+            .toSorted((a, b) => a.displayName.localeCompare(b.displayName)) ?? [],
         isLocaleEntity: decl === req.localeEntity,
     };
     res.json(body);

package/lib/node/server/api/git.js

@@ -17,7 +17,6 @@ gitApi.use((req, res, next) => {
     next();
 });
 gitApi.get("/status", async (req, res) => {
-    const locales = (Array.isArray(req.query["locales"]) ? req.query["locales"] : [req.query["locales"]]).filter(locale => typeof locale === "string");
     const status = await req.git.status();
     attachGitStatusToInstancesByEntityName(req.instancesByEntityName, req.dataRoot, 
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -31,7 +30,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
-            serializeEntityDecl(req.entitiesByName[entityName]), instance, locales)),
+            serializeEntityDecl(req.entitiesByName[entityName]), instance, req.locales)),
         ])),
     };
     res.json(body);

package/lib/node/server/api/instanceOperations.js

@@ -4,10 +4,10 @@ import { v4 as uuidv4 } from "uuid";
 import { removeAt } from "../../../shared/utils/array.js";
 import { error, ok } from "../../../shared/utils/result.js";
 import { validateEntityDecl } from "../../schema/declarations/EntityDecl.js";
-import { formatValue } from "../../schema/index.js";
 import { createValidators } from "../../schema/Node.js";
 import { getErrorMessageForDisplay } from "../../utils/error.js";
 import { getGitFileStatusFromStatusResult } from "../../utils/git.js";
+import { formatInstance } from "../../utils/instances.js";
 import { updateReferencesToInstances } from "../../utils/references.js";
 export const createInstance = async (locals, entityName, instance, idQueryParam) => {
     const entity = locals.entitiesByName[entityName];
@@ -27,7 +27,9 @@ export const createInstance = async (locals, entityName, instance, idQueryParam)
         return error([400, `Duplicate id "${id}" for locale entity`]);
     }
     const fileName = `${id}.json`;
-    await writeFile(join(locals.dataRoot, entity.name, fileName), JSON.stringify(formatValue(entity.type.value, instance), undefined, 2), { encoding: "utf-8" });
+    await writeFile(join(locals.dataRoot, entity.name, fileName), formatInstance(entity, instance), {
+        encoding: "utf-8",
+    });
     const instanceContainer = {
         fileName,
         id,
@@ -56,7 +58,7 @@ export const updateInstance = async (locals, entityName, instanceId, instance) =
     if (validationErrors.length > 0) {
         return error([400, validationErrors.map(getErrorMessageForDisplay).join("\n\n")]);
     }
-    await writeFile(join(locals.dataRoot, entity.name, instanceContainer.fileName), JSON.stringify(formatValue(entity.type.value, instance), undefined, 2), { encoding: "utf-8" });
+    await writeFile(join(locals.dataRoot, entity.name, instanceContainer.fileName), formatInstance(entity, instance), { encoding: "utf-8" });
     const oldInstance = instanceContainer.content;
     instanceContainer.content = instance;
     instanceContainer.gitStatus =

package/lib/node/server/index.d.ts

@@ -5,7 +5,6 @@ import type { Decl } from "../schema/declarations/Declaration.js";
 import type { EntityDecl } from "../schema/declarations/EntityDecl.js";
 import type { ReferencesToInstances } from "../utils/references.js";
 export type ServerOptions = {
-    name: string;
     port: number;
 };
 export interface TSONDBRequestLocals {
@@ -18,6 +17,7 @@ export interface TSONDBRequestLocals {
     entitiesByName: Record<string, EntityDecl>;
     localeEntity?: EntityDecl;
     referencesToInstances: ReferencesToInstances;
+    locales: string[];
 }
 declare global {
     namespace Express {

package/lib/node/server/index.js

@@ -1,23 +1,32 @@
 import Debug from "debug";
 import express from "express";
-import { join } from "node:path";
+import { findPackageJSON } from "node:module";
+import { dirname, join } from "node:path";
 import { api } from "./api/index.js";
 import { init } from "./init.js";
 const debug = Debug("tsondb:server");
 const defaultOptions = {
-    name: "tsondb server",
     port: 3000,
 };
+const staticNodeModule = (moduleName) => {
+    const pathToPackageJson = findPackageJSON(moduleName, import.meta.url);
+    if (!pathToPackageJson) {
+        throw new Error(`Could not find module "${moduleName}"`);
+    }
+    return express.static(dirname(pathToPackageJson));
+};
 export const createServer = async (schema, dataRootPath, instancesByEntityName, options) => {
-    const { name, port } = { ...defaultOptions, ...options };
+    const { port } = { ...defaultOptions, ...options };
     const app = express();
-    app.use(express.static(join(import.meta.dirname, "../../public")));
-    app.use("/js/node_modules", express.static(join(import.meta.dirname, "../../node_modules")));
-    app.use("/js/client", express.static(join(import.meta.dirname, "../../lib/client")));
-    app.use("/js/shared", express.static(join(import.meta.dirname, "../../lib/shared")));
+    app.use(express.static(join(import.meta.dirname, "../../../public")));
+    app.use("/js/node_modules/preact", staticNodeModule("preact"));
+    app.use("/js/node_modules/preact-iso", staticNodeModule("preact-iso"));
+    app.use("/js/client", express.static(join(import.meta.dirname, "../../../lib/web")));
+    app.use("/js/shared", express.static(join(import.meta.dirname, "../../../lib/shared")));
     app.use(express.json());
     const requestLocals = await init(schema, dataRootPath, Object.assign({}, instancesByEntityName));
     app.use((req, _res, next) => {
+        debug("%s %s", req.method, req.originalUrl);
         Object.assign(req, requestLocals);
         next();
     });
@@ -47,7 +56,17 @@ export const createServer = async (schema, dataRootPath, instancesByEntityName,
 </body>
 </html>`);
     });
-    app.listen(port, () => {
-        debug(`${name} listening on http://localhost:${port.toString()}`);
+    app.listen(port, (error) => {
+        if (error) {
+            if (error.code === "EADDRINUSE") {
+                debug(`port ${port.toString()} is already in use`);
+            }
+            else {
+                debug("error starting server:", error);
+            }
+        }
+        else {
+            debug(`server listening on http://localhost:${port.toString()}`);
+        }
     });
 };

package/lib/node/server/init.js

@@ -39,6 +39,7 @@ export const init = async (schema, dataRootPath, instancesByEntityName) => {
         entitiesByName: entitiesByName,
         localeEntity: schema.localeEntity,
         referencesToInstances,
+        locales: ["de-DE", "en-US"], // TODO: Make this configurable
     };
     return requestLocals;
 };

package/lib/node/utils/instances.d.ts

@@ -3,3 +3,4 @@ import type { InstancesByEntityName } from "../../shared/utils/instances.js";
 import type { EntityDecl } from "../schema/declarations/EntityDecl.js";
 export declare const getInstancesByEntityName: (dataRoot: string, entities: readonly EntityDecl[]) => Promise<InstancesByEntityName>;
 export declare const attachGitStatusToInstancesByEntityName: (instancesByEntityName: InstancesByEntityName, dataRoot: string, gitRoot: string, gitStatus: StatusResult) => void;
+export declare const formatInstance: (entity: EntityDecl, instanceContent: unknown) => string;

package/lib/node/utils/instances.js

@@ -1,5 +1,6 @@
 import { readdir, readFile } from "node:fs/promises";
 import { basename, extname, join } from "node:path";
+import { formatValue } from "../schema/index.js";
 import { getGitFileStatusFromStatusResult } from "./git.js";
 export const getInstancesByEntityName = async (dataRoot, entities) => Object.fromEntries(await Promise.all(entities.map(async (entity) => {
     const entityDir = join(dataRoot, entity.name);
@@ -19,3 +20,4 @@ export const attachGitStatusToInstancesByEntityName = (instancesByEntityName, da
         }));
     });
 };
+export const formatInstance = (entity, instanceContent) => JSON.stringify(formatValue(entity.type.value, instanceContent), undefined, 2) + "\n";

package/lib/shared/api.d.ts

@@ -13,7 +13,7 @@ export interface GetDeclarationResponseBody<D extends SerializedDecl = Serialize
     isLocaleEntity: boolean;
 }
 export interface GetAllInstancesOfEntityResponseBody {
-    instances: InstanceContainer[];
+    instances: InstanceContainerOverview[];
     isLocaleEntity: boolean;
 }
 export interface CreateInstanceOfEntityResponseBody {

package/lib/shared/utils/array.d.ts

@@ -17,3 +17,4 @@ export interface ArrayDiffResult<T> {
      */
     removed: T[];
 }
+export declare const unique: <T>(arr: T[], equalityCheck?: (a: T, b: T) => boolean) => T[];

package/lib/shared/utils/array.js

@@ -28,3 +28,4 @@ export const difference = (oldArr, newArr) => newArr.reduce((acc, item) => {
     }
     return acc;
 }, { removed: oldArr, added: newArr });
+export const unique = (arr, equalityCheck = (a, b) => a === b) => arr.filter((item, index) => arr.findIndex(other => equalityCheck(item, other)) === index);

package/lib/shared/utils/displayName.js

@@ -12,6 +12,9 @@ const getValueAtPath = (value, path) => {
     return current;
 };
 export const getDisplayNameFromEntityInstance = (entity, instance, defaultName, locales = []) => {
+    if (entity.displayName === null) {
+        return defaultName;
+    }
     const displayNamePath = entity.displayName ?? "name";
     if (typeof displayNamePath === "string") {
         return getValueAtPath(instance, displayNamePath) ?? defaultName;

package/lib/shared/utils/object.js

@@ -1,4 +1,7 @@
-export const sortObjectKeys = (obj, keys) => Object.fromEntries(keys.flatMap(key => (obj[key] === undefined ? [] : [[key, obj[key]]])));
+export const sortObjectKeys = (obj, keys) => Object.fromEntries([
+    ...keys.flatMap(key => (obj[key] === undefined ? [] : [[key, obj[key]]])),
+    ...Object.entries(obj).filter(([key]) => !keys.includes(key)),
+]);
 export const sortObjectKeysAlphabetically = (obj) => Object.fromEntries(Object.entries(obj).sort(([keyA], [keyB]) => keyA.localeCompare(keyB)));
 export const mergeObjects = (obj1, obj2, solveConflict) => Object.entries(obj2).reduce((acc, [key, value]) => ({
     ...acc,

package/lib/web/api.d.ts

@@ -9,7 +9,7 @@ export declare const getInstanceByEntityNameAndId: (name: string, id: string) =>
 export declare const updateInstanceByEntityNameAndId: (name: string, id: string, content: unknown) => Promise<UpdateInstanceOfEntityResponseBody>;
 export declare const deleteInstanceByEntityNameAndId: (name: string, id: string) => Promise<DeleteInstanceOfEntityResponseBody>;
 export declare const getAllInstances: (locales: string[]) => Promise<GetAllInstancesResponseBody>;
-export declare const getGitStatus: (locales: string[]) => Promise<GitStatusResponseBody>;
+export declare const getGitStatus: () => Promise<GitStatusResponseBody>;
 export declare const stageAllFiles: () => Promise<void>;
 export declare const stageAllFilesOfEntity: (entityName: string) => Promise<void>;
 export declare const stageFileOfEntity: (entityName: string, id: string) => Promise<void>;

package/lib/web/api.js

@@ -81,11 +81,8 @@ export const getAllInstances = async (locales) => {
     }
     return response.json();
 };
-export const getGitStatus = async (locales) => {
+export const getGitStatus = async () => {
     const url = new URL("/api/git/status", window.location.origin);
-    for (const locale of locales) {
-        url.searchParams.append("locales", locale);
-    }
     const response = await fetch(url);
     if (!response.ok) {
         throw new Error(await response.text());

package/lib/web/components/Git.js

@@ -28,7 +28,7 @@ export const Git = () => {
     const [entities, setEntities] = useState([]);
     const [allBranches, setAllBranches] = useState([]);
     const [currentBranch, setCurrentBranch] = useState("");
-    const updateGitStatus = (localEntities) => Promise.all([getGitStatus(["de-DE"]), getBranches()]).then(([statusData, branchesData]) => {
+    const updateGitStatus = (localEntities) => Promise.all([getGitStatus(), getBranches()]).then(([statusData, branchesData]) => {
         setIndexFiles(filterFilesForDisplay(isChangedInIndex, localEntities, statusData));
         setWorkingTreeFiles(filterFilesForDisplay(isChangedInWorkingDir, localEntities, statusData));
         setCommitsAhead(statusData.commitsAhead);

package/lib/web/hooks/useAPIResource.js

@@ -1,2 +1,3 @@
 import { useMappedAPIResource } from "./useMappedAPIResource.js";
-export const useAPIResource = (apiFn, ...args) => useMappedAPIResource(apiFn, data => data, ...args);
+const identity = (data) => data;
+export const useAPIResource = (apiFn, ...args) => useMappedAPIResource(apiFn, identity, ...args);

package/lib/web/hooks/useInstanceNamesByEntity.js

@@ -12,7 +12,8 @@ export const useInstanceNamesByEntity = (locales = []) => {
                 console.error("Error fetching data:", error.toString());
             }
         });
-    }, [locales]);
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [locales.toString()]);
     useEffect(() => {
         updateInstanceNamesByEntity();
     }, [updateInstanceNamesByEntity]);

package/lib/web/hooks/useMappedAPIResource.js

@@ -3,7 +3,9 @@ export const useMappedAPIResource = (apiFn, mapFn, ...args) => {
     const [data, setData] = useState();
     const fetchData = useCallback(() => apiFn(...args).then(result => {
         setData(mapFn(result));
-    }), [apiFn, args, mapFn]);
+    }), 
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [apiFn, mapFn, ...args]);
     useEffect(() => {
         fetchData().catch((err) => {
             console.log(err);

package/lib/web/routes/Entity.js

@@ -1,17 +1,17 @@
 import { jsx as _jsx, jsxs as _jsxs } from "preact/jsx-runtime";
 import { useRoute } from "preact-iso";
 import { useEffect } from "preact/hooks";
-import { getDisplayNameFromEntityInstance } from "../../shared/utils/displayName.js";
 import { getGitStatusForDisplay, getLabelForGitStatus } from "../../shared/utils/git.js";
 import { deleteInstanceByEntityNameAndId, getEntityByName, getInstancesByEntityName, } from "../api.js";
 import { Layout } from "../components/Layout.js";
 import { useAPIResource } from "../hooks/useAPIResource.js";
 import { useMappedAPIResource } from "../hooks/useMappedAPIResource.js";
 import { NotFound } from "./NotFound.js";
+const mapInstances = (data) => data.instances;
 export const Entity = () => {
     const { params: { name }, query: { created }, } = useRoute();
     const [entity] = useAPIResource(getEntityByName, name ?? "");
-    const [instances, reloadInstances] = useMappedAPIResource(getInstancesByEntityName, data => data.instances, name ?? "");
+    const [instances, reloadInstances] = useMappedAPIResource(getInstancesByEntityName, mapInstances, name ?? "");
     useEffect(() => {
         if (created) {
             const instanceElement = document.getElementById(`instance-${created}`);
@@ -28,7 +28,7 @@ export const Entity = () => {
     }
     return (_jsxs(Layout, { breadcrumbs: [{ url: "/", label: "Home" }], children: [_jsxs("div", { class: "header-with-btns", children: [_jsx("h1", { children: name }), _jsx("a", { class: "btn btn--primary", href: `/entities/${entity.declaration.name}/instances/create`, children: "Add" })] }), entity.declaration.comment && _jsx("p", { className: "description", children: entity.declaration.comment }), _jsxs("p", { children: [instances.length, " instance", instances.length === 1 ? "" : "s"] }), _jsx("ul", { class: "instances", children: instances.map(instance => {
                     const gitStatusForDisplay = getGitStatusForDisplay(instance.gitStatus);
-                    return (_jsxs("li", { id: `instance-${instance.id}`, class: `instance-item ${created === instance.id ? "instance-item--created" : ""} ${gitStatusForDisplay === undefined ? "" : `git-status--${gitStatusForDisplay}`}`, children: [_jsx("h2", { children: getDisplayNameFromEntityInstance(entity.declaration, instance.content, instance.id) }), _jsx("p", { "aria-hidden": true, class: "id", children: instance.id }), gitStatusForDisplay !== undefined && (_jsx("p", { class: `git-status git-status--${gitStatusForDisplay}`, title: getLabelForGitStatus(gitStatusForDisplay), children: gitStatusForDisplay })), _jsxs("div", { className: "btns", children: [_jsx("a", { href: `/entities/${entity.declaration.name}/instances/${instance.id}`, class: "btn", children: "Edit" }), _jsx("button", { class: "destructive", onClick: () => {
+                    return (_jsxs("li", { id: `instance-${instance.id}`, class: `instance-item ${created === instance.id ? "instance-item--created" : ""} ${gitStatusForDisplay === undefined ? "" : `git-status--${gitStatusForDisplay}`}`, children: [_jsx("h2", { children: instance.displayName }), _jsx("p", { "aria-hidden": true, class: "id", children: instance.id }), gitStatusForDisplay !== undefined && (_jsx("p", { class: `git-status git-status--${gitStatusForDisplay}`, title: getLabelForGitStatus(gitStatusForDisplay), children: gitStatusForDisplay })), _jsxs("div", { className: "btns", children: [_jsx("a", { href: `/entities/${entity.declaration.name}/instances/${instance.id}`, class: "btn", children: "Edit" }), _jsx("button", { class: "destructive", onClick: () => {
                                             if (confirm("Are you sure you want to delete this instance?")) {
                                                 deleteInstanceByEntityNameAndId(entity.declaration.name, instance.id)
                                                     .then(() => reloadInstances())

package/lib/web/routes/Home.js

@@ -3,7 +3,8 @@ import { toTitleCase } from "../../shared/utils/string.js";
 import { getAllEntities } from "../api.js";
 import { Layout } from "../components/Layout.js";
 import { useMappedAPIResource } from "../hooks/useMappedAPIResource.js";
+const mapEntities = (data) => data.declarations.sort((a, b) => a.declaration.name.localeCompare(b.declaration.name));
 export const Home = () => {
-    const [entities] = useMappedAPIResource(getAllEntities, data => data.declarations.sort((a, b) => a.declaration.name.localeCompare(b.declaration.name)));
+    const [entities] = useMappedAPIResource(getAllEntities, mapEntities);
     return (_jsxs(Layout, { breadcrumbs: [{ url: "/", label: "Home" }], children: [_jsx("h1", { children: "Entities" }), _jsx("ul", { class: "entities", children: (entities ?? []).map(entity => (_jsxs("li", { class: "entity-item", children: [_jsxs("div", { className: "title", children: [_jsx("h2", { children: toTitleCase(entity.declaration.name) }), entity.declaration.comment && _jsx("p", { children: entity.declaration.comment })] }), _jsxs("p", { class: "meta", children: [entity.instanceCount, " instance", entity.instanceCount === 1 ? "" : "s"] }), _jsx("div", { className: "btns", children: _jsx("a", { href: `/entities/${entity.declaration.name}`, class: "btn", children: "View" }) })] }, entity.declaration.name))) })] }));
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tsondb",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "description": "",
   "license": "ISC",
   "author": "Lukas Obermann",
@@ -28,7 +28,8 @@
     "lint": "eslint",
     "check-format": "prettier \"{src,test}/**/*.{ts,tsx}\" --check",
     "format": "prettier \"{src,test}/**/*.{ts,tsx}\" --write",
-    "release": "commit-and-tag-version"
+    "release": "commit-and-tag-version",
+    "release:sign": "commit-and-tag-version --sign --signoff"
   },
   "devDependencies": {
     "@eslint/js": "^9.30.1",

package/public/css/styles.css

@@ -15,6 +15,7 @@
   --separator-color: #e9e5eb;
   --secondary-color: #7e7f87;
   --tertiary-color: #bcbdc2;
+  --input-border-color: #black;
   --button-background: #c7cad0;
   --button-background-hover: #dedfe4;
   --button-background-primary: black;
@@ -32,10 +33,51 @@
   --highlight-color: #a08500;
   --highlight-background: #fdfab9;
   --disabled-color: #cdced2;
+  --git-status-untracked-color: rgb(13, 149, 101);
+  --git-status-untracked-background: rgba(13, 149, 101, 0.15);
+  --git-status-added-color: rgb(20, 148, 29);
+  --git-status-added-background: rgba(20, 148, 29, 0.15);
+  --git-status-modified-color: rgb(196, 155, 18);
+  --git-status-modified-background: rgba(196, 155, 18, 0.15);
+  --git-status-deleted-color: rgb(135, 22, 11);
+  --git-status-deleted-background: rgba(135, 22, 11, 0.15);
+  --git-status-renamed-color: rgb(20, 97, 148);
+  --git-status-renamed-background: rgba(20, 97, 148, 0.15);
+  --shadow-color: rgba(160, 163, 165, 0.5);
+}
+
+@media (prefers-color-scheme: dark) {
+  :root {
+    --background: hsl(260, 6%, 10%);
+    --markdown-background: hsl(260, 6%, 17%);
+    --color: hsl(260, 6%, 88%);
+    --error-color: #ff6b6b;
+    --separator-color: hsl(260, 6%, 24%);
+    --secondary-color: hsl(260, 6%, 69%);
+    --tertiary-color: hsl(260, 6%, 49%);
+    --input-border-color: hsl(260, 6%, 40%);
+    --button-background: hsl(260, 6%, 24%);
+    --button-background-hover: hsl(260, 6%, 30%);
+    --button-background-primary: hsl(260, 6%, 80%);
+    --button-background-primary-hover: hsl(260, 6%, 60%);
+    --button-background-destructive: #922727;
+    --button-background-destructive-hover: #ff8080;
+    --button-background-disabled: hsl(260, 6%, 35%);
+    --button-color: #fff;
+    --button-color-hover: #fff;
+    --button-color-primary: #000;
+    --button-color-primary-hover: #000;
+    --button-color-destructive: #fff;
+    --button-color-destructive-hover: #fff;
+    --button-color-disabled: hsl(260, 6%, 54%);
+    --highlight-color: #f2d600;
+    --highlight-background: #333300;
+  }
 }
 
 body {
   font-family: var(--font-sans);
+  color: var(--color);
   margin: 0;
   padding: 1.5rem;
   line-height: 1.4;
@@ -143,6 +185,13 @@ button.primary {
   border: none;
 }
 
+@media (prefers-color-scheme: dark) {
+  a.btn--primary,
+  button.primary {
+    font-weight: 700;
+  }
+}
+
 a.btn--primary:hover,
 button.primary:hover {
   background: var(--button-background-primary-hover);
@@ -179,8 +228,10 @@ button.destructive:disabled {
 input,
 textarea,
 select {
+  background: var(--background);
+  color: var(--color);
   font-family: var(--font-sans);
-  border: 1px solid var(--color);
+  border: 1px solid var(--input-border-color);
   padding: 0.5rem;
   display: block;
   width: 100%;
@@ -301,7 +352,7 @@ select {
   font-size: 1rem;
   margin: 0;
   flex: 1 1 auto;
-  padding: 0.5rem 0;
+  padding: 0.65rem 0;
 }
 
 .entity-item .title {
@@ -507,28 +558,28 @@ button[type="submit"] {
 }
 
 .git-status.git-status--U {
-  color: rgb(13, 149, 101);
-  background: rgba(13, 149, 101, 0.15);
+  color: var(--git-status-untracked-color);
+  background: var(--git-status-untracked-background);
 }
 
 .git-status.git-status--A {
-  color: rgb(20, 148, 29);
-  background: rgba(20, 148, 29, 0.15);
+  color: var(--git-status-added-color);
+  background: var(--git-status-added-background);
 }
 
 .git-status.git-status--M {
-  color: rgb(196, 155, 18);
-  background: rgba(196, 155, 18, 0.15);
+  color: var(--git-status-modified-color);
+  background: var(--git-status-modified-background);
 }
 
 .git-status.git-status--D {
-  color: rgb(135, 22, 11);
-  background: rgba(135, 22, 11, 0.15);
+  color: var(--git-status-deleted-color);
+  background: var(--git-status-deleted-background);
 }
 
 .git-status.git-status--R {
-  color: rgb(20, 97, 148);
-  background: rgba(20, 97, 148, 0.15);
+  color: var(--git-status-renamed-color);
+  background: var(--git-status-renamed-background);
 }
 
 aside.git {
@@ -632,7 +683,7 @@ aside.git .branch .select-wrapper {
   display: none;
   position: absolute;
   right: 1.5rem;
-  box-shadow: 0 0.5rem 2rem rgba(160, 163, 165, 0.5);
+  box-shadow: 0 0.5rem 2rem var(--shadow-color);
   z-index: 1000;
   padding: 1rem;
   background: var(--background);