tsondb 0.11.3 → 0.12.0

package/dist/src/bin/tsondb.js

@@ -13,6 +13,7 @@ import { join } from "node:path";
 import { cwd } from "node:process";
 import { pathToFileURL } from "node:url";
 import { parseArguments } from "simple-cli-args";
+import { validateConfigForFormatting, validateConfigForGeneration, validateConfigForServer, validateConfigForTesting, } from "../node/config.js";
 import { format, generateOutputs, serve, validate } from "../node/index.js";
 const debug = Debug("tsondb:cli");
 const passedArguments = parseArguments({
@@ -80,14 +81,17 @@ if (passedArguments.command === undefined) {
 switch (passedArguments.command.name) {
     case "generate":
         debug(`running command: generate`);
+        validateConfigForGeneration(config);
         await generateOutputs(config.schema, config.outputs);
         break;
     case "serve":
         debug(`running command: serve`);
+        validateConfigForServer(config);
         await serve(config.schema, config.dataRootPath, config.defaultLocales, config.homeLayoutSections, config.serverOptions, config.customStylesheetPath);
         break;
     case "validate":
         debug(`running command: validate`);
+        validateConfigForTesting(config);
         if (passedArguments.command.options?.checkReferentialIntegrity !== undefined) {
             debug(`check referential integrity: ${passedArguments.command.options.checkReferentialIntegrity ? "yes" : "no"}`);
         }
@@ -102,6 +106,7 @@ switch (passedArguments.command.name) {
         break;
     case "format":
         debug(`running command: format`);
+        validateConfigForFormatting(config);
         await format(config.schema, config.dataRootPath);
         break;
 }

package/dist/src/node/config.d.ts

@@ -1,12 +1,15 @@
 import type { Output } from "../shared/output.ts";
 import type { EntityDecl } from "./schema/index.ts";
 import type { Schema } from "./schema/Schema.ts";
+/**
+ * The main configuration type for TSONDB.
+ */
 export type Config = {
     serverOptions?: ServerOptions;
     schema: Schema;
-    outputs: Output[];
-    defaultLocales: string[];
-    dataRootPath: string;
+    outputs?: Output[];
+    defaultLocales?: string[];
+    dataRootPath?: string;
     homeLayoutSections?: HomeLayoutSection[];
     customStylesheetPath?: string;
 };
@@ -18,4 +21,30 @@ export type HomeLayoutSection = {
     comment?: string;
     entities: EntityDecl[];
 };
-export declare const validateConfig: (config: Config) => void;
+/**
+ * The configuration type required for generation commands.
+ */
+export type GenerationConfig = {
+    schema: Schema;
+    outputs: Output[];
+};
+export declare const validateConfigForGeneration: (config: Config) => asserts config is GenerationConfig;
+/**
+ * The configuration type required for any commands that need to read data stored in the database.
+ */
+export type DataConfig = {
+    schema: Schema;
+    dataRootPath: string;
+};
+/**
+ * The configuration type required for running the server for the editor.
+ */
+export type ServerConfig = DataConfig & {
+    serverOptions?: ServerOptions;
+    defaultLocales: string[];
+    homeLayoutSections?: HomeLayoutSection[];
+    customStylesheetPath?: string;
+};
+export declare const validateConfigForServer: (config: Config) => asserts config is ServerConfig;
+export declare const validateConfigForTesting: (config: Config) => asserts config is DataConfig;
+export declare const validateConfigForFormatting: (config: Config) => asserts config is DataConfig;

package/dist/src/node/config.js

@@ -1,5 +1,23 @@
-export const validateConfig = (config) => {
-    if (config.defaultLocales.length === 0) {
+export const validateConfigForGeneration = config => {
+    if ((config.outputs?.length ?? 0) === 0) {
+        throw new Error("At least one output must be specified in the config.");
+    }
+};
+export const validateConfigForServer = config => {
+    if ((config.defaultLocales?.length ?? 0) === 0) {
         throw new Error("At least one default locale must be specified in the config.");
     }
+    if (config.dataRootPath === undefined) {
+        throw new Error("A data root path must be specified in the config.");
+    }
+};
+export const validateConfigForTesting = config => {
+    if (config.dataRootPath === undefined) {
+        throw new Error("A data root path must be specified in the config.");
+    }
+};
+export const validateConfigForFormatting = config => {
+    if (config.dataRootPath === undefined) {
+        throw new Error("A data root path must be specified in the config.");
+    }
 };

package/dist/src/node/renderers/ts/index.js

@@ -7,6 +7,7 @@ import { groupDeclarationsBySourceUrl } from "../../schema/declarations/Declarat
 import { render } from "./render.js";
 const debug = Debug("tsondb:renderer:ts");
 const extension = ".d.ts";
+const pragma = "// Generated by TSONDB -- do not edit manually.\n\n";
 export const TypeScriptOutput = (options) => ({
     run: async (schema) => {
         if (options.rendererOptions?.preserveFiles === true) {
@@ -23,7 +24,7 @@ export const TypeScriptOutput = (options) => ({
                     const newDir = join(options.targetPath, relativePath);
                     const newPath = join(newDir, basename(sourcePath, extname(sourcePath)) + extension);
                     await mkdir(newDir, { recursive: true });
-                    await writeFile(newPath, render(options.rendererOptions, decls ?? []), {
+                    await writeFile(newPath, pragma + render(options.rendererOptions, decls ?? []), {
                         encoding: "utf-8",
                     });
                 }
@@ -33,7 +34,7 @@ export const TypeScriptOutput = (options) => ({
         else {
             debug("emitting declarations to single file...");
             await mkdir(dirname(options.targetPath), { recursive: true });
-            await writeFile(options.targetPath, render(options.rendererOptions, schema.declarations), {
+            await writeFile(options.targetPath, pragma + render(options.rendererOptions, schema.declarations), {
                 encoding: "utf-8",
             });
             debug("emitted declarations to %s", options.targetPath);

package/dist/src/node/renderers/ts/render.d.ts

@@ -3,5 +3,7 @@ export type TypeScriptRendererOptions = {
     indentation: number;
     objectTypeKeyword: "interface" | "type";
     preserveFiles: boolean;
+    generateEntityMapType: boolean;
+    addIdentifierToEntities: boolean;
 };
 export declare const render: (options: Partial<TypeScriptRendererOptions> | undefined, declarations: readonly Decl[]) => string;

package/dist/src/node/renderers/ts/render.js

@@ -13,11 +13,13 @@ import { isObjectType } from "../../schema/types/generic/ObjectType.js";
 import { isNestedEntityMapType } from "../../schema/types/references/NestedEntityMapType.js";
 import { ReferenceIdentifierType } from "../../schema/types/references/ReferenceIdentifierType.js";
 import { ensureSpecialDirStart } from "../../utils/path.js";
-import { combineSyntaxes, indent, prefixLines, syntax } from "../../utils/render.js";
+import { combineSyntaxes, emptyRenderResult, indent, prefixLines, syntax, } from "../../utils/render.js";
 const defaultOptions = {
     indentation: 2,
     objectTypeKeyword: "interface",
     preserveFiles: false,
+    generateEntityMapType: false,
+    addIdentifierToEntities: false,
 };
 const renderDocumentation = (comment, isDeprecated) => syntax `${comment === undefined
     ? ""
@@ -91,7 +93,7 @@ const renderType = (options, type) => {
             return assertExhaustive(type, "Unknown type");
     }
 };
-const renderEntityDecl = (options, decl) => syntax `${renderDocumentation(decl.comment, decl.isDeprecated)}export ${options.objectTypeKeyword} ${decl.name} ${options.objectTypeKeyword === "type" ? "= " : ""}${renderType(options, addEphemeralUUIDToType(decl))}`;
+const renderEntityDecl = (options, decl) => syntax `${renderDocumentation(decl.comment, decl.isDeprecated)}export ${options.objectTypeKeyword} ${decl.name} ${options.objectTypeKeyword === "type" ? "= " : ""}${renderType(options, options.addIdentifierToEntities ? addEphemeralUUIDToType(decl) : decl.type.value)}`;
 const renderEnumDecl = (options, decl) => syntax `${renderDocumentation(decl.comment, decl.isDeprecated)}export type ${decl.name}${renderTypeParameters(options, decl.parameters)} =${renderEnumType(options, decl.type.value)}`;
 const renderTypeAliasDecl = (options, decl) => isObjectType(decl.type.value)
     ? syntax `${renderDocumentation(decl.comment, decl.isDeprecated)}export ${options.objectTypeKeyword} ${decl.name}${renderTypeParameters(options, decl.parameters)} ${options.objectTypeKeyword === "type" ? "= " : ""}${renderType(options, decl.type.value)}`
@@ -123,8 +125,15 @@ const renderImports = (currentUrl, imports) => {
         .join(EOL);
     return importsSyntax.length > 0 ? importsSyntax + EOL + EOL : "";
 };
+const renderEntityMapType = (options, declarations) => syntax `export type EntityMap = {${EOL}${indent(options.indentation, 1, combineSyntaxes(declarations
+    .filter(isEntityDecl)
+    .sort((a, b) => a.name.localeCompare(b.name))
+    .map(decl => syntax `${decl.name}: ${decl.name}`), EOL))}${EOL}}${EOL + EOL}`;
 export const render = (options = defaultOptions, declarations) => {
     const finalOptions = { ...defaultOptions, ...options };
+    const [_, entityMap] = finalOptions.generateEntityMapType
+        ? renderEntityMapType(finalOptions, declarations)
+        : emptyRenderResult;
     const [imports, content] = renderDeclarations(finalOptions, flatMapAuxiliaryDecls((parentNodes, node) => {
         if (isNestedEntityMapType(node)) {
             return TypeAliasDecl(asDecl(parentNodes[0])?.sourceUrl ?? "", {
@@ -138,8 +147,9 @@ export const render = (options = defaultOptions, declarations) => {
         }
         return undefined;
     }, declarations));
-    return finalOptions.preserveFiles
-        ? (declarations[0] === undefined ? "" : renderImports(declarations[0].sourceUrl, imports)) +
-            content
-        : content;
+    return (entityMap +
+        (finalOptions.preserveFiles
+            ? (declarations[0] === undefined ? "" : renderImports(declarations[0].sourceUrl, imports)) +
+                content
+            : content));
 };

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

@@ -228,6 +228,7 @@ gitApi.post("/pull", async (req, res) => {
         const status = await req.git.status();
         const remotes = await req.git.getRemotes();
         await req.git.pull(remotes[0]?.name, status.current ?? undefined);
+        await reinit(req);
         res.set("Content-Type", "text/plain");
         res.status(200).send("Pull successful");
     }

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

@@ -4,6 +4,7 @@ export declare const joinSyntax: (...syntaxes: (string | undefined)[]) => string
 export type RenderResult = [imports: {
     [sourcePath: string]: string[];
 }, syntax: string];
+export declare const emptyRenderResult: RenderResult;
 export declare const combineSyntaxes: (syntaxes: (RenderResult | string | undefined)[], separator?: string) => RenderResult;
 export declare const syntax: (strings: TemplateStringsArray, ...values: (RenderResult | string | undefined)[]) => RenderResult;
 export declare const indent: (spaces: number, indentLevel: number, text: RenderResult) => RenderResult;

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

@@ -6,7 +6,7 @@ export const prefixLines = (prefix, text, includeEmptyLines = false) => text
     .join(EOL);
 export const applyIndentation = (indentLevel, text, spaces) => prefixLines(" ".repeat(spaces * indentLevel), text);
 export const joinSyntax = (...syntaxes) => syntaxes.filter(syntax => syntax !== undefined).join("");
-const emptyRenderResult = [{}, ""];
+export const emptyRenderResult = [{}, ""];
 export const combineSyntaxes = (syntaxes, separator = "") => syntaxes
     .filter(syntax => syntax !== undefined)
     .reduce((acc, value, i) => typeof value === "string"

package/package.json

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