typedapi-client-helpers 0.3.0 → 0.3.2

package/scripts/generate-api-minimal.mjs

@@ -118,6 +118,13 @@ const defaultErrorHandlerName = getStringSetting(
   "handleErrors",
 );
 
+const defaultErrorMessageName = getStringSetting(
+  process.env.TYPED_API_DEFAULT_ERROR_MESSAGE,
+  process.env.npm_config_typed_api_default_error_message,
+  config.typedApiDefaultErrorMessage,
+  "unknownErrorMessage",
+);
+
 const generatorOptions = {
   cleanOutput: getBooleanSetting(
     process.env.TYPED_API_CLEAN_OUTPUT,
@@ -408,6 +415,7 @@ function createDefaultFunctionsFileIfMissing(filePath) {
   const resolvedFilePath = extension ? filePath : `${filePath}.ts`;
 
   if (fs.existsSync(resolvedFilePath)) {
+    addDefaultErrorMessageIfMissing(resolvedFilePath);
     return resolvedFilePath;
   }
 
@@ -432,6 +440,8 @@ export function ${defaultErrorHandlerName}<T>(
 ): void | Promise<void> {
   // Add your default error handling here.
 }
+
+export const ${defaultErrorMessageName} = "An unknown error occurred.";
 `,
   );
 
@@ -442,6 +452,22 @@ export function ${defaultErrorHandlerName}<T>(
   return resolvedFilePath;
 }
 
+
+function addDefaultErrorMessageIfMissing(filePath) {
+  const source = fs.readFileSync(filePath, "utf8");
+  if (fileExportsName(source, defaultErrorMessageName)) return;
+
+  const separator = source.endsWith("\n") ? "\n" : "\n\n";
+  fs.appendFileSync(
+    filePath,
+    `${separator}export const ${defaultErrorMessageName} = "An unknown error occurred.";\n`,
+  );
+
+  console.log(
+    `Added default API error message to: ${path.relative(process.cwd(), filePath)}`,
+  );
+}
+
 function toRelativeImportPath(fromDirectory, filePath) {
   let relativePath = path.relative(fromDirectory, filePath);
 
@@ -508,11 +534,13 @@ function resolveDefaultHandlers() {
   const source = fs.readFileSync(defaultFunctionsFile, "utf8");
   const hasSuccessHandler = fileExportsName(source, defaultSuccessHandlerName);
   const hasErrorHandler = fileExportsName(source, defaultErrorHandlerName);
+  const hasErrorMessage = fileExportsName(source, defaultErrorMessageName);
 
-  if (!hasSuccessHandler || !hasErrorHandler) {
+  if (!hasSuccessHandler || !hasErrorHandler || !hasErrorMessage) {
     const missingNames = [
       ...(!hasSuccessHandler ? [defaultSuccessHandlerName] : []),
       ...(!hasErrorHandler ? [defaultErrorHandlerName] : []),
+      ...(!hasErrorMessage ? [defaultErrorMessageName] : []),
     ];
 
     console.warn(
@@ -529,6 +557,7 @@ function resolveDefaultHandlers() {
     path: toRelativeImportPath(methodsDir, defaultFunctionsFile),
     success: defaultSuccessHandlerName,
     error: defaultErrorHandlerName,
+    errorMessage: defaultErrorMessageName,
   };
 }
 

package/scripts/openapi-generator/index.mjs

@@ -1,4 +1,3 @@
-import crypto from "node:crypto";
 import fs from "node:fs";
 import os from "node:os";
 import path from "node:path";
@@ -11,7 +10,8 @@ import {
   methodFileNameForController,
 } from "./method-template.mjs";
 
-const MANAGED_TOP_LEVEL = ["generated", "methods", "index.ts", "typedapi.manifest.json"];
+const MANAGED_TOP_LEVEL = ["generated", "methods", "index.ts"];
+const LEGACY_MANAGED_TOP_LEVEL = ["typedapi.manifest.json"];
 
 export async function generateApi(options) {
   const inputPath = path.resolve(options.input);
@@ -73,34 +73,6 @@ export async function generateApi(options) {
     );
   }
 
-  const indexLines = [
-    'export * from "./generated/data-contracts";',
-    'export * from "./generated/http-client";',
-    ...controllerNames.map(
-      (controllerName) => `export * from "./methods/${methodFileNameForController(controllerName).replace(/\.ts$/, "")}";`,
-    ),
-  ];
-  files.set("index.ts", `${indexLines.join("\n")}\n`);
-
-  const schemaHash = crypto.createHash("sha256").update(source).digest("hex");
-  files.set(
-    "typedapi.manifest.json",
-    `${JSON.stringify(
-      {
-        contractVersion: 1,
-        generator: options.runtimePackageName ?? "typedapi-client-helpers",
-        generatorVersion: options.generatorVersion ?? "unknown",
-        schemaSha256: schemaHash,
-        producer: openApi["x-typedapi"] ?? null,
-        operationCount: operations.length,
-        methodNameStyle: normalizedOptions.methodNameStyle,
-        prefixMethodNamesWithController:
-          normalizedOptions.prefixMethodNamesWithController,
-      },
-      null,
-      2,
-    )}\n`,
-  );
 
   const changes = compareOutput(output, files);
   if (options.check) {
@@ -144,7 +116,7 @@ function compareOutput(output, files) {
 
 function listManagedFiles(output) {
   const result = [];
-  for (const topLevel of MANAGED_TOP_LEVEL) {
+  for (const topLevel of [...MANAGED_TOP_LEVEL, ...LEGACY_MANAGED_TOP_LEVEL]) {
     const target = path.join(output, topLevel);
     if (!fs.existsSync(target)) continue;
     if (fs.statSync(target).isFile()) {
@@ -165,7 +137,7 @@ function walk(directory, callback) {
 }
 
 function removeManagedOutput(root) {
-  for (const item of MANAGED_TOP_LEVEL) {
+  for (const item of [...MANAGED_TOP_LEVEL, ...LEGACY_MANAGED_TOP_LEVEL]) {
     fs.rmSync(path.join(root, item), { recursive: true, force: true });
   }
 }
@@ -253,14 +225,14 @@ function writeManagedOutputInPlace(output, staging) {
   const originallyPresent = new Set();
 
   try {
-    for (const item of MANAGED_TOP_LEVEL) {
+    for (const item of [...MANAGED_TOP_LEVEL, ...LEGACY_MANAGED_TOP_LEVEL]) {
       const current = path.join(output, item);
       if (!fs.existsSync(current)) continue;
       originallyPresent.add(item);
       syncPath(current, path.join(managedBackup, item));
     }
 
-    for (const item of MANAGED_TOP_LEVEL) {
+    for (const item of [...MANAGED_TOP_LEVEL, ...LEGACY_MANAGED_TOP_LEVEL]) {
       const source = path.join(staging, item);
       const target = path.join(output, item);
       if (fs.existsSync(source)) syncPath(source, target);
@@ -268,7 +240,7 @@ function writeManagedOutputInPlace(output, staging) {
     }
   } catch (error) {
     try {
-      for (const item of MANAGED_TOP_LEVEL) {
+      for (const item of [...MANAGED_TOP_LEVEL, ...LEGACY_MANAGED_TOP_LEVEL]) {
         const target = path.join(output, item);
         const saved = path.join(managedBackup, item);
         if (originallyPresent.has(item)) syncPath(saved, target);