@base44-preview/cli 0.1.32-pr.663.463d401 → 0.1.32-pr.663.60cadbf

package/README.md

@@ -45,8 +45,8 @@ The CLI will guide you through project setup. For step-by-step tutorials, see th
 | ------- | ----------- |
 | `api catalog [area]` | List the API's areas, or every operation in one area |
 | `api search <text>` | Search every public Base44 API operation by what it does |
-| `api grep <pattern>` | Search the raw API spec with a regular expression; `--area` narrows it to one area |
-| `api fetch <METHOD> <path>` | Call any public Base44 API operation, like curl; `--help` after a path prints its contract |
+| `api grep <pattern>` | Search the API spec with a regular expression, for when search misses |
+| `api fetch <METHOD> <path>` | Call any public Base44 API operation; `--help` after a path prints its contract |
 | [`create`](https://docs.base44.com/developers/references/cli/commands/create) | Create a new Base44 project from a template |
 | [`deploy`](https://docs.base44.com/developers/references/cli/commands/deploy) | Deploy all project resources and site to Base44 |
 | [`eject`](https://docs.base44.com/developers/references/cli/commands/eject) | Download the code for an existing Base44 project |

package/dist/cli/index.js

@@ -249102,23 +249102,30 @@ var wait = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
 var SPACE_OR_PUNCTUATION = /[\n\r\p{Z}\p{P}]+/u;
 
 // src/core/api-spec/search.ts
-var BOOST = { path: 8, summary: 5, description: 2, parameters: 0.5 };
+var BOOST = {
+  method: 1,
+  path: 8,
+  summary: 5,
+  description: 2,
+  parameters: 0.5
+};
 var MIN_RELATIVE_SCORE = 0.2;
 var TOKEN_SEPARATOR = /[\n\r\p{Z}\p{P}\p{S}]+/u;
-var STOPWORDS = new Set("a an and are at be by do does for from how i in is it its me my of on or our that the this to we what who with you your".split(" "));
+var STOPWORDS = new Set("a an and are at be by do does for from how i id in is it its me my of on or our that the this to we what who with you your".split(" "));
 function tokenize(text) {
-  return text.split(TOKEN_SEPARATOR).filter((word) => word && !STOPWORDS.has(word.toLowerCase()));
+  return text.split(TOKEN_SEPARATOR).filter((word) => word.length >= 2 && !STOPWORDS.has(word.toLowerCase()));
 }
 function toOperationSummary(op) {
   return { endpoint: op.endpoint, summary: op.summary };
 }
 function buildSearchIndex(operations) {
   const index = new MiniSearch({
-    fields: ["path", "summary", "description", "parameters"],
+    fields: ["method", "path", "summary", "description", "parameters"],
     tokenize
   });
   index.addAll(operations.map((op, id) => ({
     id,
+    method: op.method,
     path: op.path.replace(/\{[^}]*\}/g, ""),
     summary: op.summary,
     description: op.description,
@@ -249126,27 +249133,37 @@ function buildSearchIndex(operations) {
   })));
   return index;
 }
-function summaryCoverage(query, op) {
-  const terms = tokenize(query.toLowerCase());
-  if (!op || terms.length === 0) {
-    return 0;
-  }
-  const words = tokenize(op.summary.toLowerCase());
-  return terms.filter((term) => words.some((word) => word.startsWith(term))).length / terms.length;
+function summaryMatch(terms, op) {
+  const words = tokenize(op?.summary.toLowerCase() ?? "");
+  const named = (word) => terms.some((term) => word.startsWith(term));
+  return {
+    coverage: terms.filter((term) => words.some((word) => word.startsWith(term))).length / terms.length,
+    precision: words.length ? words.filter(named).length / words.length : 0
+  };
 }
+var readsFirst = (op) => op?.method === "GET" ? 0 : 1;
 function searchOperations(operations, query, options = {}) {
+  const terms = tokenize(query.toLowerCase());
+  if (terms.length === 0) {
+    return [];
+  }
   const index = buildSearchIndex(operations);
   const hits = index.search(query, {
     prefix: (term) => term.length >= 3,
     fuzzy: (term) => term.length >= 4 ? 0.2 : false,
     boost: BOOST,
     filter: options.readOnly ? (hit) => operations[hit.id]?.readOnly === true : undefined
-  }).map((hit) => ({
-    ...hit,
-    score: hit.score * (1 + summaryCoverage(query, operations[hit.id]))
-  })).sort((a, b) => b.score - a.score);
-  const baseline = (hits[0]?.score ?? 0) * MIN_RELATIVE_SCORE;
-  return hits.filter((hit) => hit.score >= baseline).slice(0, options.limit ?? 5).flatMap((hit) => {
+  }).map((hit) => {
+    const match = summaryMatch(terms, operations[hit.id]);
+    return {
+      ...hit,
+      ...match,
+      full: match.coverage === 1,
+      score: hit.score * (1 + match.coverage)
+    };
+  }).sort((a, b) => Number(b.full) - Number(a.full) || (a.full ? b.precision - a.precision || readsFirst(operations[a.id]) - readsFirst(operations[b.id]) : 0) || b.score - a.score);
+  const baseline = Math.max(0, ...hits.map((hit) => hit.score)) * MIN_RELATIVE_SCORE;
+  return hits.filter((hit) => hit.full || hit.score >= baseline).slice(0, options.limit ?? 5).flatMap((hit) => {
     const op = operations[hit.id];
     return op ? [toOperationSummary(op)] : [];
   });
@@ -249177,7 +249194,7 @@ function groupByArea(operations) {
   }
   return new Map([...areas].sort(([a], [b]) => byCodePoint(a, b)));
 }
-function readsFirst(ops) {
+function readsFirst2(ops) {
   const isRead = (op) => op.method === "GET" ? 0 : 1;
   return [...ops].sort((a, b) => isRead(a) - isRead(b));
 }
@@ -249185,7 +249202,7 @@ function catalogIndex(operations) {
   const areas = [...groupByArea(operations)].map(([area, ops]) => ops.length <= INLINE_AREA_MAX ? { area, operations: ops.map(toOperationSummary) } : {
     area,
     operationCount: ops.length,
-    sample: readsFirst(ops).slice(0, AREA_SAMPLE_MAX).map((op) => op.summary)
+    sample: readsFirst2(ops).slice(0, AREA_SAMPLE_MAX).map((op) => op.summary)
   });
   return { areas, total: operations.length };
 }
@@ -249197,44 +249214,6 @@ function areaListing(area, operations, max = AREA_OPERATIONS_MAX) {
     truncated: operations.length > max
   };
 }
-// src/core/api-spec/grep.ts
-var CONTEXT_CHARS = 40;
-var MAX_SNIPPETS = 3;
-var MAX_SNIPPET_CHARS = 200;
-function unescapeJson(snippet) {
-  return snippet.replace(/\\[nrt]/g, " ").replace(/\\"/g, '"');
-}
-function snippets(text, pattern) {
-  const found = [];
-  for (const match of text.matchAll(pattern)) {
-    const start = Math.max(0, match.index - CONTEXT_CHARS);
-    const end = match.index + match[0].length + CONTEXT_CHARS;
-    found.push(unescapeJson(text.slice(start, Math.min(end, start + MAX_SNIPPET_CHARS))));
-    if (found.length === MAX_SNIPPETS || match[0].length === 0) {
-      break;
-    }
-  }
-  return found;
-}
-function grepSpec(spec, operations, pattern, options = {}) {
-  const regex = new RegExp(pattern, options.ignoreCase ? "gi" : "g");
-  const hits = [];
-  for (const op of operations) {
-    const { summary, description, parameters, requestBody, responses } = op.operation;
-    const matches = snippets(`${op.endpoint} ${JSON.stringify({ summary, description, parameters, requestBody, responses })}`, regex);
-    if (matches.length > 0) {
-      hits.push({ ...toOperationSummary(op), matches });
-    }
-  }
-  const schemas = options.schemas === false ? {} : spec.components?.schemas;
-  for (const [schema, definition] of Object.entries(schemas ?? {})) {
-    const matches = snippets(JSON.stringify(definition), regex);
-    if (matches.length > 0) {
-      hits.push({ schema, matches });
-    }
-  }
-  return hits.slice(0, options.limit ?? 20);
-}
 // src/core/api-spec/schema.ts
 var HTTP_METHODS = [
   "get",
@@ -249422,9 +249401,50 @@ function leftoverRefs(node, schemas, found = new Map) {
   }
   return found;
 }
+var SCHEMA_DATA_KEYS = new Set([
+  "example",
+  "examples",
+  "default",
+  "enum",
+  "const"
+]);
+var DOCS_CALLOUT = /<(Info|Note|Tip|Check|Warning)>([\s\S]*?)<\/\1>/g;
+var RELATIVE_LINK = /\[([^\]]+)\]\(\/[^)]*\)/g;
+function cleanText(text) {
+  return text.replace(DOCS_CALLOUT, (_, kind, body) => kind === "Warning" ? `Warning: ${body}` : body).replace(RELATIVE_LINK, "$1");
+}
+function slimSchema(node, isPropertyMap = false) {
+  if (Array.isArray(node)) {
+    return node.map((item) => slimSchema(item));
+  }
+  if (node === null || typeof node !== "object") {
+    return node;
+  }
+  const entries = Object.entries(node);
+  if (isPropertyMap) {
+    return Object.fromEntries(entries.map(([name, value]) => [name, slimSchema(value)]));
+  }
+  const slim = {};
+  for (const [key, value] of entries) {
+    if (key === "title" && typeof value === "string") {
+      continue;
+    }
+    slim[key] = SCHEMA_DATA_KEYS.has(key) ? value : key === "properties" ? slimSchema(value, true) : key === "description" && typeof value === "string" ? cleanText(value) : slimSchema(value);
+  }
+  const { anyOf, ...rest } = slim;
+  const nullable = Array.isArray(anyOf) && anyOf.length === 2 ? nullableType(anyOf) : undefined;
+  return nullable ? { type: [nullable, "null"], ...rest } : slim;
+}
+function nullableType(variants) {
+  const types = variants.map((variant) => variant !== null && typeof variant === "object" && Object.keys(variant).length === 1 && typeof variant.type === "string" ? variant.type : undefined);
+  if (types.includes(undefined) || !types.includes("null")) {
+    return;
+  }
+  return types.find((type) => type !== "null");
+}
 function getOperationContract(spec, op) {
   const schemas = spec.components?.schemas ?? {};
-  const inline = (node) => node === undefined ? null : inlineRefs(node, schemas);
+  const inline = (node) => node === undefined ? null : slimSchema(inlineRefs(node, schemas));
   const responses = Object.entries(op.operation.responses ?? {}).flatMap(([status, response]) => {
     const parsed = ResponseObjectSchema.safeParse(response);
     return parsed.success ? [[status, parsed.data]] : [];
@@ -249437,7 +249457,7 @@ function getOperationContract(spec, op) {
     method: op.method,
     path: op.path,
     summary: op.summary,
-    description: op.description,
+    description: cleanText(op.description),
     parameters: (op.operation.parameters ?? []).flatMap((parameter) => {
       const parsed = ParameterSchema.safeParse(parameter);
       if (!parsed.success) {
@@ -249451,7 +249471,7 @@ function getOperationContract(spec, op) {
           in: location2,
           required: required ?? false,
           schema: inline(schema ?? {}),
-          ...description && !inSchema ? { description } : {},
+          ...description && !inSchema ? { description: cleanText(description) } : {},
           ..."example" in parsed.data ? { example: parsed.data.example } : {}
         }
       ];
@@ -249459,14 +249479,25 @@ function getOperationContract(spec, op) {
     ...requestBody.contentType && requestBody.contentType !== "application/json" ? { requestBodyContentType: requestBody.contentType } : {},
     requestBodySchema: inline(requestBody.schema),
     responseSchema: inline(success),
-    errors: Object.fromEntries(errors.map(([status, response]) => [status, response.description ?? ""]))
+    errors: Object.fromEntries(errors.map(([status, response]) => [
+      status,
+      cleanText(response.description ?? "")
+    ]))
   };
   const refs = leftoverRefs(contract, schemas);
   return {
     ...contract,
-    ...refs.size > 0 ? { refs: Object.fromEntries(refs) } : {}
+    ...refs.size > 0 ? {
+      refs: Object.fromEntries([...refs].map(([ref, schema]) => [ref, slimSchema(schema)]))
+    } : {}
   };
 }
+
+// src/core/api-spec/grep.ts
+function grepOperations(spec, operations, pattern, options = {}) {
+  const regex = new RegExp(pattern, options.ignoreCase ? "i" : "");
+  return operations.filter((op) => regex.test(JSON.stringify(getOperationContract(spec, op)))).slice(0, options.limit ?? 20).map(toOperationSummary);
+}
 // src/core/api-spec/request.ts
 var MAX_ERROR_BODY_CHARS = 4000;
 async function readBody(response) {
@@ -249493,7 +249524,8 @@ async function sendApiRequest(method, path, body) {
   } catch (error) {
     const apiError = await ApiError.fromHttpError(error, `calling ${method} ${path}`);
     const raw = error instanceof HTTPError ? await readBody(error.response) : undefined;
-    throw new ApiError(apiError.message, {
+    const message = raw && apiError.statusCode !== undefined ? `Error calling ${method} ${path}: HTTP ${apiError.statusCode}` : apiError.message;
+    throw new ApiError(message, {
       statusCode: apiError.statusCode,
       requestUrl: apiError.requestUrl,
       requestMethod: apiError.requestMethod,
@@ -249604,21 +249636,17 @@ function isPipedStdin() {
     return false;
   }
 }
-async function readRequestBody(method, flag) {
+async function readRequestBody(flag, log) {
   if (flag === "@-") {
     return readStdin("--body @-", { trim: false });
   }
   if (flag?.startsWith("@")) {
     return readTextFile(flag.slice(1));
   }
-  if (flag !== undefined) {
-    return flag;
+  if (flag === undefined && isPipedStdin()) {
+    log.warn("stdin is ignored; pass --body @- to send it as the body.");
   }
-  if (method === "GET" || method === "HEAD" || !isPipedStdin()) {
-    return;
-  }
-  const piped = await readStdin("--body", { trim: false });
-  return piped.trim() ? piped : undefined;
+  return flag;
 }
 
 // src/cli/commands/api/catalog.ts
@@ -249640,7 +249668,7 @@ function getApiCatalogCommand() {
 }
 
 // src/cli/commands/api/fetch.ts
-async function findOperation(ctx, method, path, refresh) {
+async function findOperation(ctx, method, path, { refresh, flag }) {
   const { spec } = await loadSpecTask(ctx, refresh);
   const op = matchOperation(listOperations(spec), method, path);
   if (!op) {
@@ -249648,7 +249676,7 @@ async function findOperation(ctx, method, path, refresh) {
       hints: [
         {
           message: "The cached spec may predate this route; fetch it again",
-          command: "base44 api fetch <METHOD> <path> --help --refresh"
+          command: `base44 api fetch ${method} ${path} ${flag} --refresh`
         },
         {
           message: "Find the operation and its path template",
@@ -249707,11 +249735,17 @@ async function fetchAction(ctx, methodArg, path, options, command) {
   }
   const method = methodArg.toUpperCase();
   if (options.help) {
-    const { spec, op } = await findOperation(ctx, method, path, options.refresh);
+    const { spec, op } = await findOperation(ctx, method, path, {
+      refresh: options.refresh,
+      flag: "--help"
+    });
     return { stdout: formatJson(getOperationContract(spec, op)) };
   }
   if (options.readOnly) {
-    const { op } = await findOperation(ctx, method, path, options.refresh);
+    const { op } = await findOperation(ctx, method, path, {
+      refresh: options.refresh,
+      flag: "--read-only"
+    });
     if (!op.readOnly) {
       throw new InvalidInputError(`Refused under --read-only: ${op.method} ${op.path} is not a read-only operation. Nothing was sent.`);
     }
@@ -249724,7 +249758,7 @@ async function fetchAction(ctx, methodArg, path, options, command) {
     }
   });
   await ensureAuth(ctx);
-  const body = await readRequestBody(method, options.body);
+  const body = await readRequestBody(options.body, ctx.log);
   const response = await ctx.runTask(`Calling ${method} ${path}`, () => sendApiRequest(method, path, body), {
     successMessage: `Called ${method} ${path}`,
     errorMessage: "Request failed"
@@ -249737,7 +249771,7 @@ function getApiFetchCommand() {
   return new Base44Command("fetch", {
     requireAuth: false,
     requireAppContext: false
-  }).description("Call a Base44 API operation, like curl; add --help after a path for its contract").helpOption(false).argument("[method]", "HTTP method, e.g. GET or POST").argument("[path]", 'Concrete path with any query string, e.g. "/api/apps/<app-id>/workflows/runs?status=failed"').option("--body <json>", "Request body: JSON, @file.json, or @- for stdin (piped stdin is read too)").option("--output <file>", "Save the response body to a file").option("--read-only", "Refuse, before sending, any operation the spec does not mark read-only").option("--refresh", REFRESH_OPTION_HELP).option("-h, --help", "With a method and path, print that operation's contract; otherwise this help").action(fetchAction);
+  }).description("Call a Base44 API operation; add --help after a path for its contract").helpOption(false).argument("[method]", "HTTP method, e.g. GET or POST").argument("[path]", 'Concrete path with any query string, e.g. "/api/apps/<app-id>/workflows/runs?status=failed"').option("--body <json>", "Request body: JSON, @file.json, or @- to read it from stdin").option("--output <file>", "Save the response body to a file").option("--read-only", "Refuse, before sending, any operation the spec does not mark read-only").option("--refresh", REFRESH_OPTION_HELP).option("-h, --help", "With a method and path, print that operation's contract; otherwise this help").action(fetchAction);
 }
 
 // src/cli/commands/api/grep.ts
@@ -249759,11 +249793,9 @@ async function grepAction(ctx, pattern, options) {
   if (options.readOnly) {
     operations = operations.filter((op) => op.readOnly);
   }
-  const narrowed = options.area !== undefined || options.readOnly === true;
-  const hits = grepSpec(spec, operations, pattern, {
+  const hits = grepOperations(spec, operations, pattern, {
     ignoreCase: options.ignoreCase,
-    limit,
-    schemas: !narrowed
+    limit
   });
   return { stdout: formatJson(hits) };
 }
@@ -249771,7 +249803,7 @@ function getApiGrepCommand() {
   return new Base44Command("grep", {
     requireAuth: false,
     requireAppContext: false
-  }).description("Search the raw API spec with a regular expression, for when search misses").argument("<pattern>", 'Regular expression, e.g. "runs.*status"').option("--area <area>", "Search only one area's operations (see base44 api catalog)").option("-i, --ignore-case", "Case-insensitive match").option("--limit <n>", "Most operations or schemas to return (default 20)").option("--read-only", READ_ONLY_FILTER_HELP).option("--refresh", REFRESH_OPTION_HELP).action(grepAction);
+  }).description("Search the API spec with a regular expression, for when search misses").argument("<pattern>", 'Regular expression, e.g. "runs.*status"').option("--area <area>", "Search only one area's operations (see base44 api catalog)").option("-i, --ignore-case", "Case-insensitive match").option("--limit <n>", "Most operations to return (default 20)").option("--read-only", READ_ONLY_FILTER_HELP).option("--refresh", REFRESH_OPTION_HELP).action(grepAction);
 }
 
 // src/cli/commands/api/search.ts
@@ -262331,7 +262363,7 @@ var nativeEnumType = ZodNativeEnum.create;
 var promiseType = ZodPromise.create;
 var effectsType = ZodEffects.create;
 var optionalType = ZodOptional2.create;
-var nullableType = ZodNullable2.create;
+var nullableType2 = ZodNullable2.create;
 var preprocessType = ZodEffects.createWithPreprocess;
 var pipelineType = ZodPipeline.create;
 // ../functions-compiler/src/contracts.ts
@@ -273333,4 +273365,4 @@ export {
   runCLI
 };
 
-//# debugId=CD2605865A84BE8564756E2164756E21
+//# debugId=34B2FE9173AAC44664756E2164756E21