Core: Add support for parameter assignment pattern (#38)

* do it * version bump
lucasavila00 · Sep 10, 2023 · 16daf54 · 16daf54
1 parent 6d0b071
commit 16daf54
Show file tree

Hide file tree

Showing 33 changed files with 446 additions and 184 deletions.
diff --git a/examples/minimal-react/CHANGELOG.md b/examples/minimal-react/CHANGELOG.md
@@ -1,5 +1,15 @@
 # @examples/minimal-react
 
+## 10.38.5
+
+### Patch Changes
+
+- Updated dependencies
+ - @beff/client@0.0.8
+ - @beff/hono@0.0.8
+ - @beff/cli@0.0.8
+ - @beff/react@0.0.8
+
 ## 10.38.4
 
 ### Patch Changes

diff --git a/examples/minimal-react/package.json b/examples/minimal-react/package.json
@@ -1,7 +1,7 @@
 {
  "name": "@examples/minimal-react",
  "private": true,
- "version": "10.38.4",
+ "version": "10.38.5",
  "workspaces": [
  "client",
  "server"
@@ -26,10 +26,10 @@
  "wait-port": "^1.0.1"
  },
  "dependencies": {
- "@beff/cli": "workspace:^0.0.7",
- "@beff/client": "workspace:^0.0.7",
- "@beff/hono": "workspace:^0.0.7",
- "@beff/react": "workspace:^0.0.7",
+ "@beff/cli": "workspace:^0.0.8",
+ "@beff/client": "workspace:^0.0.8",
+ "@beff/hono": "workspace:^0.0.8",
+ "@beff/react": "workspace:^0.0.8",
  "@hono/node-server": "^1.1.1",
  "@tanstack/react-query": "^4.33.0",
  "@types/node": "^20.5.7",

diff --git a/examples/node-server/CHANGELOG.md b/examples/node-server/CHANGELOG.md
@@ -1,5 +1,13 @@
 # node-server
 
+## 1.0.4
+
+### Patch Changes
+
+- Updated dependencies
+ - @beff/hono@0.0.8
+ - @beff/cli@0.0.8
+
 ## 1.0.3
 
 ### Patch Changes

diff --git a/examples/node-server/package.json b/examples/node-server/package.json
@@ -1,6 +1,6 @@
 {
  "name": "node-server",
- "version": "1.0.3",
+ "version": "1.0.4",
  "description": "",
  "main": "index.js",
  "scripts": {
@@ -12,8 +12,8 @@
  "author": "",
  "license": "ISC",
  "dependencies": {
- "@beff/cli": "workspace:^0.0.7",
- "@beff/hono": "workspace:^0.0.7",
+ "@beff/cli": "workspace:^0.0.8",
+ "@beff/hono": "workspace:^0.0.8",
  "@hono/node-server": "^1.1.1",
  "esbuild": "^0.19.2",
  "vitest": "^0.34.3"

diff --git a/examples/standalone-parser/CHANGELOG.md b/examples/standalone-parser/CHANGELOG.md
@@ -1,5 +1,12 @@
 # node-server
 
+## 1.0.5
+
+### Patch Changes
+
+- Updated dependencies
+ - @beff/cli@0.0.8
+
 ## 1.0.4
 
 ### Patch Changes

diff --git a/examples/standalone-parser/package.json b/examples/standalone-parser/package.json
@@ -1,6 +1,6 @@
 {
  "name": "standalone-parser",
- "version": "1.0.4",
+ "version": "1.0.5",
  "description": "",
  "main": "index.js",
  "scripts": {
@@ -11,7 +11,7 @@
  "author": "",
  "license": "ISC",
  "dependencies": {
- "@beff/cli": "workspace:^0.0.7",
+ "@beff/cli": "workspace:^0.0.8",
  "vitest": "^0.34.3"
  }
 }
diff --git a/packages/beff-cli/CHANGELOG.md b/packages/beff-cli/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @beff/cli
 
+## 0.0.8
+
+### Patch Changes
+
+- Support for optional parameters
+
 ## 0.0.7
 
 ### Patch Changes

diff --git a/packages/beff-cli/package.json b/packages/beff-cli/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@beff/cli",
- "version": "0.0.7",
+ "version": "0.0.8",
  "description": "",
  "bin": {
  "beff": "./bin/index.js"

diff --git a/packages/beff-client/CHANGELOG.md b/packages/beff-client/CHANGELOG.md
@@ -1,5 +1,13 @@
 # @beff/client
 
+## 0.0.8
+
+### Patch Changes
+
+- Support for optional parameters
+- Updated dependencies
+ - @beff/cli@0.0.8
+
 ## 0.0.7
 
 ### Patch Changes

diff --git a/packages/beff-client/package.json b/packages/beff-client/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@beff/client",
- "version": "0.0.7",
+ "version": "0.0.8",
  "description": "",
  "main": "dist/cjs/index.js",
  "scripts": {
@@ -18,7 +18,7 @@
  "author": "",
  "license": "ISC",
  "dependencies": {
- "@beff/cli": "workspace:^0.0.7"
+ "@beff/cli": "workspace:^0.0.8"
  },
  "devDependencies": {
  "typescript": "^5.2.2"

diff --git a/packages/beff-client/src/index.ts b/packages/beff-client/src/index.ts
@@ -72,17 +72,25 @@ export class BffRequest {
  break;
  }
  case "query": {
- if (!hasAddedQueryParams) {
- path += "?";
- hasAddedQueryParams = true;
- path += `${metadata.name}=${param}`;
+ if (!metadata.required && param == null) {
+ // skip optional query params
  } else {
- path += `&${metadata.name}=${param}`;
+ if (!hasAddedQueryParams) {
+ path += "?";
+ hasAddedQueryParams = true;
+ path += `${metadata.name}=${param}`;
+ } else {
+ path += `&${metadata.name}=${param}`;
+ }
  }
  break;
  }
  case "header": {
- init.headers[metadata.name] = String(param);
+ if (!metadata.required && param == null) {
+ // skip optional headers
+ } else {
+ init.headers[metadata.name] = String(param);
+ }
  break;
  }
  case "body": {

diff --git a/packages/beff-core/src/api_extractor.rs b/packages/beff-core/src/api_extractor.rs
@@ -61,6 +61,36 @@ pub enum HandlerParameter {
  Context(Span),
 }
 
+impl HandlerParameter {
+ pub fn make_optional(self: HandlerParameter) -> HandlerParameter {
+ match self {
+ HandlerParameter::PathOrQueryOrBody {
+ schema,
+ description,
+ span,
+ ..
+ } => HandlerParameter::PathOrQueryOrBody {
+ schema,
+ required: false,
+ description,
+ span,
+ },
+ HandlerParameter::Header {
+ span,
+ schema,
+ description,
+ ..
+ } => HandlerParameter::Header {
+ span,
+ schema,
+ required: false,
+ description,
+ },
+ HandlerParameter::Context(_) => self,
+ }
+ }
+}
+
 #[derive(Debug, Clone, Copy, Eq, PartialEq)]
 pub enum MethodKind {
  Get(Span),
@@ -477,7 +507,7 @@ impl<'a, R: FileManager> ExtractExportDefaultVisitor<'a, R> {
  &mut self,
  param: &Pat,
  parent_span: &Span,
- ) -> Result<Vec<(String, HandlerParameter)>> {
+ ) -> Result<(String, HandlerParameter)> {
  match param {
  Pat::Ident(BindingIdent { id, type_ann }) => {
  if type_ann.is_none() {
@@ -492,12 +522,15 @@ impl<'a, R: FileManager> ExtractExportDefaultVisitor<'a, R> {
  comments.and_then(|it| self.parse_description_comment(it, &id.span));
  let ty = self.assert_and_extract_type_from_ann(type_ann, &id.span);
  let param = self.parse_parameter_type(&ty, !id.optional, description, &id.span)?;
- Ok(vec![(id.sym.to_string(), param)])
+ Ok((id.sym.to_string(), param))
+ }
+ Pat::Assign(AssignPat { span, left, .. }) => {
+ let (name, ty) = self.parse_arrow_parameter(left, span)?;
+ Ok((name, ty.make_optional()))
  }
  Pat::Rest(RestPat { span, .. })
  | Pat::Array(ArrayPat { span, .. })
  | Pat::Object(ObjectPat { span, .. })
- | Pat::Assign(AssignPat { span, .. })
  | Pat::Invalid(Invalid { span, .. }) => {
  self.error(span, DiagnosticInfoMessage::ParameterPatternNotSupported)
  }
@@ -557,7 +590,6 @@ impl<'a, R: FileManager> ExtractExportDefaultVisitor<'a, R> {
  .iter()
  .map(|it| self.parse_arrow_parameter(&it.pat, parent_span))
  .collect::<Result<Vec<_>>>()?;
- let parameters = parameters.into_iter().flatten().collect();
  let e = FnHandler {
  method_kind: self.parse_method_kind(key)?,
  parameters,
@@ -625,7 +657,6 @@ impl<'a, R: FileManager> ExtractExportDefaultVisitor<'a, R> {
  .map(|it| self.parse_arrow_parameter(it, parent_span))
  .collect::<Result<Vec<_>>>()?
  .into_iter()
- .flatten()
  .collect(),
  summary: endpoint_comments.summary,
  description: endpoint_comments.description,

diff --git a/packages/beff-core/src/print/coercer.rs b/packages/beff-core/src/print/coercer.rs
@@ -1,4 +1,4 @@
-use crate::{swc_builder::SwcBuilder, ast::json_schema::JsonSchema};
+use crate::{ast::json_schema::JsonSchema, swc_builder::SwcBuilder};
 use swc_common::DUMMY_SP;
 use swc_ecma_ast::{
  BindingIdent, BlockStmt, CallExpr, Callee, Expr, ExprOrSpread, FnExpr, Function, Ident, Param,
@@ -25,11 +25,31 @@ fn coerce_primitive(value: Expr, p: &str) -> Expr {
  })
 }
 
+fn coercion_noop(value: Expr) -> Expr {
+ let decoder_ref_fn = Ident {
+ span: DUMMY_SP,
+ sym: format!("CoercionNoop").into(),
+ optional: false,
+ };
+ let callee = Callee::Expr(Expr::Ident(decoder_ref_fn).into());
+ Expr::Call(CallExpr {
+ span: DUMMY_SP,
+ callee: callee,
+ args: vec![ExprOrSpread {
+ spread: None,
+ expr: value.into(),
+ }],
+ type_args: None,
+ })
+}
+
 struct CoercerFnGenerator {}
 impl CoercerFnGenerator {
  fn coerce_schema(&mut self, schema: &JsonSchema, value_ref: &Expr, depth: usize) -> Expr {
  match schema {
- JsonSchema::Null | JsonSchema::Const(_) | JsonSchema::Any => value_ref.clone(),
+ JsonSchema::Null | JsonSchema::Const(_) | JsonSchema::Any => {
+ coercion_noop(value_ref.clone())
+ }
  JsonSchema::Boolean => coerce_primitive(value_ref.clone(), "boolean"),
  JsonSchema::String => coerce_primitive(value_ref.clone(), "string"),
  JsonSchema::StringWithFormat(_) => coerce_primitive(value_ref.clone(), "string"),
@@ -90,7 +110,7 @@ impl CoercerFnGenerator {
  let input = SwcBuilder::input_expr();
  let stmts = vec![Stmt::Return(ReturnStmt {
  span: DUMMY_SP,
- arg: Some(Box::new(self.coerce_schema(schema, &input, depth))),
+ arg: Some(self.coerce_schema(schema, &input, depth).into()),
  })];
 
  Function {

diff --git a/packages/beff-hono/CHANGELOG.md b/packages/beff-hono/CHANGELOG.md
@@ -1,5 +1,14 @@
 # @beff/hono
 
+## 0.0.8
+
+### Patch Changes
+
+- Support for optional parameters
+- Updated dependencies
+ - @beff/client@0.0.8
+ - @beff/cli@0.0.8
+
 ## 0.0.7
 
 ### Patch Changes

diff --git a/packages/beff-hono/package.json b/packages/beff-hono/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@beff/hono",
- "version": "0.0.7",
+ "version": "0.0.8",
  "description": "",
  "main": "dist/cjs/index.js",
  "scripts": {
@@ -18,8 +18,8 @@
  "author": "",
  "license": "ISC",
  "dependencies": {
- "@beff/cli": "workspace:^0.0.7",
- "@beff/client": "workspace:^0.0.7",
+ "@beff/cli": "workspace:^0.0.8",
+ "@beff/client": "workspace:^0.0.8",
  "hono": "^3.5.6",
  "vitest": "^0.34.3"
  },

diff --git a/packages/beff-hono/src/index.ts b/packages/beff-hono/src/index.ts
@@ -76,7 +76,7 @@ const redocTemplate = (baseUrl: string) => `
 `;
 
 const coerce = (coercer: any, value: any): any => {
- return coercer(value);
+ return coercer(value).data;
 };
 
 const toHonoPattern = (pattern: string): string => {
@@ -115,23 +115,7 @@ const prettyPrintErrorMessage = (it: DecodeError): string => {
  }
 };
 
-type CoercionFailure = {
- __isCoercionFailure: true;
- original: unknown;
-};
-
-const isCoercionFailure = (it: unknown): it is CoercionFailure => {
- return (
- typeof it === "object" &&
- it != null &&
- "__isCoercionFailure" in it &&
- Boolean(it?.__isCoercionFailure)
- );
-};
 const prettyPrintValue = (it: unknown): string => {
- if (isCoercionFailure(it)) {
- return prettyPrintValue(it.original);
- }
  if (typeof it === "string") {
  return `"${it}"`;
  }

diff --git a/packages/beff-react/CHANGELOG.md b/packages/beff-react/CHANGELOG.md
@@ -1,5 +1,13 @@
 # @beff/react
 
+## 0.0.8
+
+### Patch Changes
+
+- Support for optional parameters
+- Updated dependencies
+ - @beff/client@0.0.8
+
 ## 0.0.7
 
 ### Patch Changes