@xano/xanoscript-language-server 12.18.0 → 12.20.0

package/parser/policy/policyDocs.js

@@ -43,10 +43,39 @@ export function checkMarkdown(check, catalogue) {
   if (applicable.length) {
     lines.push("", `Scope fields: ${applicable.map(code).join(", ")}.`);
   }
+  const uses = useLines(check.uses);
+  if (uses.length) lines.push("", "Uses:", ...uses);
   if (check.fix_hint) lines.push("", `Fix: ${check.fix_hint}`);
   return lines.join("\n");
 }
 
+/**
+ * A check's `uses` as a list: each goal, then the `params = { ... }` line that achieves it, written
+ * as a rule writes it, then its note when it has one.
+ */
+function useLines(uses) {
+  if (!Array.isArray(uses)) return [];
+  return uses
+    .filter((use) => typeof use?.goal === "string" && use.goal !== "")
+    .flatMap((use) => [
+      `- ${use.goal}`,
+      `  ${code(`params = ${policyValue(Array.isArray(use.params) ? {} : (use.params ?? {}))}`)}`,
+      ...(typeof use.note === "string" && use.note !== "" ? [`  ${use.note}`] : []),
+    ]);
+}
+
+/** A value as a policy file writes it: `{ key: value }` with bare keys, JSON strings and lists. */
+function policyValue(value) {
+  if (Array.isArray(value)) return `[${value.map(policyValue).join(", ")}]`;
+  if (value && typeof value === "object") {
+    const entries = Object.entries(value);
+    if (!entries.length) return "{}";
+    const key = (name) => (/^[A-Za-z_][A-Za-z0-9_]*$/.test(name) ? name : JSON.stringify(name));
+    return `{ ${entries.map(([name, item]) => `${key(name)}: ${policyValue(item)}`).join(", ")} }`;
+  }
+  return JSON.stringify(value) ?? "null";
+}
+
 /**
  * @param {string} checkId
  * @param {string} path the param name, or `name.field` for a field of an object param

package/parser/policy/validatePolicyRule.js

@@ -124,6 +124,10 @@ function coerce(node, spec, checkId, name) {
       if (!whole || (minimum !== undefined && node.value < minimum)) {
         return fail(`be a whole number${minimum !== undefined ? ` of at least ${minimum}` : ""}`);
       }
+      // `Registry::INTEGER_MAX`: past 2^53 - 1 a whole number is no longer exact.
+      if (Math.abs(node.value) > Number.MAX_SAFE_INTEGER) {
+        return fail(`be a whole number no larger than ${Number.MAX_SAFE_INTEGER}`);
+      }
       return null;
     }
     case "number":
@@ -319,5 +323,19 @@ export function validatePolicyRule(rule, catalogue) {
     }
   }
 
+  // A param set for a value of the check's kind param it does not apply to (`applies_when` on the
+  // param: object.naming's version_required applies to name_kind endpoint_path only). The platform
+  // refuses it on save.
+  for (const [name, entry] of given) {
+    const conditions = Object.hasOwn(schema, name) ? schema[name]?.applies_when : null;
+    if (!conditions || catalogue.scopeFields?.has(name) || !provided(literal[name])) continue;
+    for (const [param, values] of Object.entries(conditions)) {
+      if (Array.isArray(values) && !values.includes(String(inForce(literal, schema, param) ?? ""))) {
+        advise(entry.keyToken, `check "${id}": ${name} applies only when ${param} is ${values.join(", ").replace(/, ([^,]*)$/, " or $1")}.`);
+        break;
+      }
+    }
+  }
+
   return out;
 }