@antelopejs/dms 0.13.1 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## v0.14.0
+
+[compare changes](https://github.com/AntelopeJS/dms/compare/v0.13.1...v0.14.0)
+
+### 💅 Refactors
+
+- **frontend:** ⚠️  Remove API error migration helpers ([#638](https://github.com/AntelopeJS/dms/pull/638))
+
+#### ⚠️ Breaking Changes
+
+- **frontend:** ⚠️  Remove API error migration helpers ([#638](https://github.com/AntelopeJS/dms/pull/638))
+
+### ❤️ Contributors
+
+- Antony Rizzitelli ([@Upd4ting](http://github.com/Upd4ting))
+
 ## v0.13.1
 
 [compare changes](https://github.com/AntelopeJS/dms/compare/v0.13.0...v0.13.1)

package/frontend-vue/layers/dms-auth/app/build/composables/useAuthFormError.ts

@@ -4,7 +4,7 @@ import {
   type FieldErrorCode,
   resolveFieldErrors,
 } from "#dms-core/app/composables/useFieldErrors";
-import { resolveApiErrorMessage } from "#dms-core/app/composables/useApiError";
+import { resolveApiErrorMessage } from "#dms-core/app/composables/resolveApiError";
 
 export interface AuthFormError {
   title: string;

package/frontend-vue/layers/dms-auth/app/custom-pages/auth/signup.vue

@@ -15,7 +15,7 @@ import {
   useLiveFormErrors,
   useLocalizedSchema,
 } from "#dms-core/app/composables/useFormValidation";
-import { resolveApiErrorMessage } from "#dms-core/app/composables/useApiError";
+import { resolveApiErrorMessage } from "#dms-core/app/composables/resolveApiError";
 import { isString } from "#dms-core/app/utils/type-check";
 
 const MIN_NAME_LENGTH = 2;

package/frontend-vue/layers/dms-core/app/composables/{useApiError.ts → resolveApiError.ts}

@@ -1,11 +1,5 @@
 import { isObject, isString } from "../utils/type-check";
 
-interface Options {
-  context?: string;
-  title?: string;
-  description?: string;
-}
-
 interface ApiError {
   statusCode?: number;
   status?: number;
@@ -68,13 +62,3 @@ export function resolveApiErrorMessage(
 ): string {
   return isApiError(error) ? resolveDescription(error) : FALLBACK_ERROR_KEY;
 }
-
-/** @deprecated Capture useApiErrorPresenter during setup instead. */
-export function useApiError(
-  error: Parameters<typeof resolveApiErrorTitle>[0],
-  options?: Options,
-) {
-  useApiErrorPresenter().presentError(error, {
-    fallbackKey: options?.description || options?.title || FALLBACK_ERROR_KEY,
-  });
-}

package/frontend-vue/layers/dms-core/app/composables/useFieldErrors.ts

@@ -1,6 +1,6 @@
 import { nextTick, reactive } from "vue";
 import { type I18nTranslate } from "./translation/useTranslation";
-import { resolveApiErrorMessage } from "./useApiError";
+import { resolveApiErrorMessage } from "./resolveApiError";
 import { isBoolean, isNumber, isObject, isString } from "../utils/type-check";
 
 /**

package/frontend-vue/layers/dms-ui/app/build/composables/actions/useActionTargets.ts

@@ -25,10 +25,7 @@ export interface ActionTargetsConfig {
   /** Called once a target changed something (an API call, a closed form). */
   refreshCallback?: () => void;
   /** Toasts a failure no dialog shows. */
-  handleApiError: (
-    error: Parameters<typeof useApiError>[0],
-    title?: string,
-  ) => void;
+  handleApiError: (error: unknown, title?: string) => void;
   /** The rows a drawer or modal opened on a row steps through (J / K). */
   rowNavigation?: RowNavigationSource;
   /** Where a `deepLink` action writes the row it has open in the URL. */

package/frontend-vue/scripts/test-api-error-presentation.mjs

@@ -11,12 +11,7 @@ import { tmpdir } from "node:os";
 import { join } from "node:path";
 import { fileURLToPath } from "node:url";
 import ts from "typescript";
-import {
-  analyzeApiErrorScript,
-  apiErrorScripts,
-} from "./check-api-error-presentation.mjs";
-import { migrateApiErrorSource } from "./codemods/api-error-presenter.mjs";
-import { parse } from "vue/compiler-sfc";
+import { analyzeApiErrorScript } from "./check-api-error-presentation.mjs";
 
 const rejected = [
   `try { await save() } catch (error) { toast.add({ title: t('save.failed'), color: 'error' }) }`,
@@ -49,58 +44,6 @@ for (const source of allowed)
     source,
   );
 
-const vue = `<script setup lang="ts">
-const toast = useToast();
-async function save() {
-  try { await write() } catch (failure) { toast.add({ title: t("save.failed"), color: "error" }); }
-}
-</script><template><button @click="save">Save</button></template>`;
-const migrated = migrateApiErrorSource("fixture.vue", vue);
-assert.ok(migrated.rewritten);
-assert.deepEqual(migrated.manual, []);
-assert.ok(
-  migrated.output.includes(
-    'presentError(failure, { fallbackKey: "save.failed" })',
-  ),
-);
-assert.equal(
-  migrateApiErrorSource("fixture.vue", migrated.output).rewritten,
-  false,
-);
-for (const script of apiErrorScripts("fixture.vue", migrated.output, { parse }))
-  assert.equal(
-    analyzeApiErrorScript(script.source, "fixture.vue", ts).length,
-    0,
-  );
-
-const composable = `export function useSave() { return async () => { try { await save() } catch (error) { toast.add({ title: t('save.failed'), color: 'error' }); } } }`;
-const converted = migrateApiErrorSource("fixture.ts", composable);
-assert.ok(
-  converted.output.indexOf("const { presentError }") <
-    converted.output.indexOf("return async"),
-);
-assert.ok(converted.output.includes("import { useApiErrorPresenter }"));
-
-for (const source of [
-  `async function save() { try {} catch (error) { toast.add({ title: t('save.failed'), color: 'error' }); } }`,
-  `export function useSave() { try {} catch { toast.add({ title: t('save.failed'), color: 'error' }); } }`,
-  `export function useSave() { try {} catch (error) { toast.update(id, { title: t('save.failed'), color: 'error' }); } }`,
-  `export function useSave() { try {} catch (error) { toast.add({ title: t(dynamic), color: 'error' }); } }`,
-  `export function useSave() { try {} catch (error) { toast.add({ title: t('save.failed'), color: color() }); } }`,
-  `export function useSave() { try {} catch (error) { toast.add({ title: t('save.failed'), icon: icon(), color: 'error' }); } }`,
-  `<script>try {} catch (error) { toast.add({ title: t('save.failed'), color: 'error' }); }</script>`,
-]) {
-  const file = source.startsWith("<script") ? "manual.vue" : "manual.ts";
-  const result = migrateApiErrorSource(file, source);
-  assert.equal(result.output, source);
-  assert.deepEqual(Object.keys(result.manual[0]), [
-    "file",
-    "line",
-    "reason",
-    "expression",
-  ]);
-  assert.equal(result.manual[0].reason, "manual-error-presentation");
-}
 const linkRoot = mkdtempSync(join(tmpdir(), "dms-api-error-cli-"));
 const appRoot = mkdtempSync(
   fileURLToPath(new URL("../.api-error-cli-", import.meta.url)),
@@ -120,15 +63,8 @@ try {
     { encoding: "utf8" },
   );
   assert.notEqual(checker.status, 0, "checker fails through a symlinked path");
-  const codemod = spawnSync(
-    process.execPath,
-    [join(scripts, "codemods", "api-error-presenter.mjs"), join(appRoot, "app")],
-    { encoding: "utf8", cwd: appRoot },
-  );
-  assert.equal(codemod.status, 0, codemod.stderr);
-  assert.match(codemod.stdout, /"reason":"manual-error-presentation"/);
 } finally {
   rmSync(linkRoot, { recursive: true, force: true });
   rmSync(appRoot, { recursive: true, force: true });
 }
-console.log("PASS API error invariant and codemod fixtures");
+console.log("PASS API error invariant fixtures");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antelopejs/dms",
-  "version": "0.13.1",
+  "version": "0.14.0",
   "description": "AntelopeJS DMS. Plug in your PostgreSQL, MongoDB or RethinkDB database and your coding agent builds a back office and analytics dashboard as typed TypeScript. Real-time updates on the data the DMS manages.",
   "keywords": [
     "antelopejs",
@@ -124,7 +124,6 @@
     },
     "./package.json": "./package.json",
     "./checks/api-error-presentation": "./frontend-vue/scripts/check-api-error-presentation.mjs",
-    "./codemods/api-error-presenter": "./frontend-vue/scripts/codemods/api-error-presenter.mjs",
     "./interfaces/*": null
   },
   "publishConfig": {

package/frontend-vue/scripts/codemods/api-error-presenter.mjs

@@ -1,196 +0,0 @@
-import { readFileSync, realpathSync, writeFileSync } from "node:fs";
-import { createRequire } from "node:module";
-import { resolve } from "node:path";
-import { fileURLToPath } from "node:url";
-import {
-  apiErrorSources,
-  apiErrorScripts,
-  analyzeApiErrorScript,
-} from "../check-api-error-presentation.mjs";
-
-const require = createRequire(resolve(process.cwd(), "package.json"));
-const tools = {
-  ts: require("typescript"),
-  parse: require("vue/compiler-sfc").parse,
-};
-const { ts } = tools;
-
-function translatedKey(expression) {
-  if (
-    !expression ||
-    !ts.isCallExpression(expression) ||
-    !["t", "processI18n"].includes(expression.expression.getText())
-  )
-    return null;
-  const key = expression.arguments[0];
-  return expression.arguments.length === 1 && key && ts.isStringLiteral(key)
-    ? key.text
-    : null;
-}
-
-function literalKey(payload) {
-  if (!payload || !ts.isObjectLiteralExpression(payload)) return null;
-  const allowed = new Set(["title", "description", "color", "icon"]);
-  if (
-    payload.properties.some(
-      (property) =>
-        !ts.isPropertyAssignment(property) ||
-        !allowed.has(property.name.getText()) ||
-        (["title", "description"].includes(property.name.getText())
-          ? translatedKey(property.initializer) === null
-          : !(
-              ts.isStringLiteral(property.initializer) ||
-              (property.name.getText() === "color" &&
-                /^Color\.(error|warning|info)$/.test(
-                  property.initializer.getText(),
-                ))
-            )),
-    )
-  )
-    return null;
-  const title =
-    payload.properties.find(
-      (property) => property.name.getText() === "description",
-    )?.initializer ??
-    payload.properties.find((property) => property.name.getText() === "title")
-      ?.initializer;
-  return translatedKey(title);
-}
-
-function composableScope(node) {
-  let outer = null;
-  for (let parent = node.parent; parent; parent = parent.parent) {
-    if (
-      (ts.isFunctionDeclaration(parent) ||
-        ts.isFunctionExpression(parent) ||
-        ts.isArrowFunction(parent)) &&
-      ts.isBlock(parent.body)
-    )
-      outer = parent;
-  }
-  const name = outer?.name ?? outer?.parent?.name;
-  return name && ts.isIdentifier(name) && /^use[A-Z]/.test(name.text)
-    ? outer.body
-    : null;
-}
-
-/** Rewrites supported setup/composable catches and returns unsupported cases. */
-export function migrateApiErrorSource(file, source) {
-  const edits = [];
-  const manual = [];
-  for (const script of apiErrorScripts(file, source, tools)) {
-    const calls = analyzeApiErrorScript(script.source, file, ts);
-    let capture = false;
-    for (const call of calls) {
-      const fallbackKey = literalKey(call.payload);
-      const standalone = ts.isExpressionStatement(call.node.parent);
-      const safeCatch = call.failure && /^[A-Za-z_$][\w$]*$/.test(call.failure);
-      const collision = /\b(?:presentError|useApiErrorPresenter)\b/.test(
-        script.source,
-      );
-      const hasSetup = file.endsWith(".vue")
-        ? script.isSetup
-        : composableScope(call.node);
-      if (
-        fallbackKey &&
-        standalone &&
-        safeCatch &&
-        hasSetup &&
-        call.method === "add" &&
-        !collision
-      ) {
-        edits.push({
-          start: script.offset + call.node.getStart(),
-          end: script.offset + call.node.end,
-          text: `presentError(${call.failure}, { fallbackKey: ${JSON.stringify(fallbackKey)} })`,
-        });
-        capture = true;
-      } else {
-        manual.push({
-          file,
-          line: source
-            .slice(0, script.offset + call.node.getStart())
-            .split("\n").length,
-          reason: "manual-error-presentation",
-          expression: call.node.getText(call.tree),
-        });
-      }
-    }
-    if (capture) {
-      const tree = ts.createSourceFile(
-        file,
-        script.source,
-        ts.ScriptTarget.Latest,
-        true,
-      );
-      const imports = tree.statements.filter(ts.isImportDeclaration);
-      const offset = imports.at(-1)?.end ?? 0;
-      const declaration = file.endsWith(".vue")
-        ? "\nconst { presentError } = useApiErrorPresenter();\n"
-        : `\nimport { useApiErrorPresenter } from "#dms-core/app/composables/useApiErrorPresenter";\n`;
-      if (file.endsWith(".vue"))
-        edits.push({
-          start: script.offset + offset,
-          end: script.offset + offset,
-          text: declaration,
-        });
-      else {
-        const scopes = new Set();
-        for (const call of calls) {
-          if (
-            !edits.some(
-              (edit) => edit.start === script.offset + call.node.getStart(),
-            )
-          )
-            continue;
-          const outer = composableScope(call.node);
-          if (outer) scopes.add(outer.getStart() + 1);
-        }
-        for (const start of scopes)
-          edits.push({
-            start: script.offset + start,
-            end: script.offset + start,
-            text: "\nconst { presentError } = useApiErrorPresenter();\n",
-          });
-        edits.push({
-          start: script.offset + offset,
-          end: script.offset + offset,
-          text: declaration,
-        });
-      }
-    }
-  }
-  let output = source;
-  for (const edit of edits.sort((a, b) => b.start - a.start))
-    output = output.slice(0, edit.start) + edit.text + output.slice(edit.end);
-  return { output, rewritten: output !== source, manual };
-}
-
-/** Dry-run by default; writes only source cases accepted by the bounded migration. */
-export function migrateApiErrorFile(file, write = false) {
-  const result = migrateApiErrorSource(file, readFileSync(file, "utf8"));
-  if (write && result.rewritten) writeFileSync(file, result.output);
-  return result;
-}
-
-if (
-  process.argv[1] &&
-  realpathSync(process.argv[1]) === realpathSync(fileURLToPath(import.meta.url))
-) {
-  const roots = process.argv
-    .slice(2)
-    .filter((argument) => argument !== "--write");
-  if (!roots.length)
-    throw new Error(
-      "Pass app directories. Add --write to apply safe rewrites. Manual cases are JSONL on stdout.",
-    );
-  for (const file of roots.flatMap(apiErrorSources)) {
-    const result = migrateApiErrorFile(file, process.argv.includes("--write"));
-    for (const entry of result.manual)
-      process.stdout.write(`${JSON.stringify(entry)}\n`);
-    if (result.rewritten)
-      process.stderr.write(
-        `${process.argv.includes("--write") ? "rewrote" : "would rewrite"} ${file}\n`,
-      );
-  }
-}