@voxgig/sdkgen 4.34.0 → 4.34.1

package/project/.sdk/src/cmp/lua/fragment/Entity.fragment.lua

@@ -44,8 +44,7 @@ end
 
 
 -- The entity serialises and prints as its data, as ts does: the instance
--- also holds the client, the utility and a match that can carry a query
--- credential.
+-- also holds the client and the utility.
 function EntyClass:to_record()
   local rec = self._utility.clean(self._entctx, vs.clone(self._data or {}))
   rec["voxgig$entity"] = self._name
@@ -173,53 +172,13 @@ function EntyClass:stream(action, args, callopts)
   end
 
   local co = coroutine.create(function()
-    utility.feature_hook(ctx, "PrePoint")
-    local point, err = utility.make_point(ctx)
-    ctx.out["point"] = point
-    if err ~= nil then
-      return
-    end
-
-    utility.feature_hook(ctx, "PreSpec")
-    local spec
-    spec, err = utility.make_spec(ctx)
-    ctx.out["spec"] = spec
-    if err ~= nil then
-      return
-    end
-
-    utility.feature_hook(ctx, "PreRequest")
-    local resp
-    resp, err = utility.make_request(ctx)
-    ctx.out["request"] = resp
-    if err ~= nil then
-      return
-    end
-
-    utility.feature_hook(ctx, "PreResponse")
-    local resp2
-    resp2, err = utility.make_response(ctx)
-    ctx.out["response"] = resp2
-    if err ~= nil then
-      return
-    end
-
-    utility.feature_hook(ctx, "PreResult")
-    local result
-    result, err = utility.make_result(ctx)
-    ctx.out["result"] = result
-    if err ~= nil then
-      return
-    end
-
-    utility.feature_hook(ctx, "PreDone")
-
-    result = ctx.result
+    local failed = self:_stream_steps(ctx)
+    local result = ctx.result
 
     -- Inbound: prefer the streaming feature's incremental iterator; else fall
     -- back to the materialised items so stream always yields.
     local stream_fn = nil
-    if result ~= nil then
+    if failed == nil and result ~= nil then
       stream_fn = result.stream
     end
     if type(stream_fn) == "function" then
@@ -232,7 +191,17 @@ function EntyClass:stream(action, args, callopts)
         coroutine.yield(item)
       end
     else
-      local data = utility.done(ctx)
+      -- A failed step leaves through make_error, as an operation's does,
+      -- and its error is handed to the iterator to raise.
+      local data, err
+      if failed == nil then
+        data, err = utility.done(ctx)
+      else
+        data, err = utility.make_error(ctx, failed)
+      end
+      if err ~= nil then
+        return err
+      end
       local items
       if vs.islist(data) then
         items = data
@@ -251,8 +220,7 @@ function EntyClass:stream(action, args, callopts)
   end)
 
   -- An error raised while the caller iterates leaves through the same catch
-  -- path as an operation's. A step's error ends the stream silently, so the
-  -- record is cleaned whenever the stream ends.
+  -- path as an operation's, and the record is cleaned whenever the stream ends.
   return function()
     if coroutine.status(co) == "dead" then
       return nil
@@ -261,9 +229,18 @@ function EntyClass:stream(action, args, callopts)
     if ok then
       if coroutine.status(co) == "dead" then
         utility.clean_explain(ctx)
+        if item ~= nil then
+          error(item, 0)
+        end
       end
       return item
     end
+
+    -- What a hook raises here must not escape the cleaning below.
+    local hookok, hookerr = pcall(utility.feature_hook, ctx, "PreUnexpected")
+    if not hookok then
+      item = hookerr
+    end
     local err = self:_unexpected(ctx, item)
     if err ~= nil then
       error(err, 0)
@@ -273,6 +250,55 @@ function EntyClass:stream(action, args, callopts)
 end
 
 
+-- The steps an operation runs, with their hooks; the first that fails hands
+-- back its error.
+function EntyClass:_stream_steps(ctx)
+  local utility = self._utility
+
+  utility.feature_hook(ctx, "PrePoint")
+  local point, err = utility.make_point(ctx)
+  ctx.out["point"] = point
+  if err ~= nil then
+    return err
+  end
+
+  utility.feature_hook(ctx, "PreSpec")
+  local spec
+  spec, err = utility.make_spec(ctx)
+  ctx.out["spec"] = spec
+  if err ~= nil then
+    return err
+  end
+
+  utility.feature_hook(ctx, "PreRequest")
+  local resp
+  resp, err = utility.make_request(ctx)
+  ctx.out["request"] = resp
+  if err ~= nil then
+    return err
+  end
+
+  utility.feature_hook(ctx, "PreResponse")
+  local resp2
+  resp2, err = utility.make_response(ctx)
+  ctx.out["response"] = resp2
+  if err ~= nil then
+    return err
+  end
+
+  utility.feature_hook(ctx, "PreResult")
+  local result
+  result, err = utility.make_result(ctx)
+  ctx.out["result"] = result
+  if err ~= nil then
+    return err
+  end
+
+  utility.feature_hook(ctx, "PreDone")
+  return nil
+end
+
+
 -- #LoadOp
 
 -- #ListOp
@@ -281,16 +307,27 @@ end
 
 -- #UpdateOp
 
+-- #PatchOp
+
 -- #RemoveOp
 
 
 -- A hook, fetcher or parser that raises never reaches make_error: its error
 -- leaves cleaned, and so does the explain record it interrupted.
 function EntyClass:_run_op(ctx, post_done)
+  local utility = self._utility
   local ok, out, err = pcall(self._run_steps, self, ctx, post_done)
   if ok then
     return out, err
   end
+
+  -- What a hook raises here must not escape the cleaning below.
+  local hookok, hookerr = pcall(function()
+    -- #PreUnexpected-Hook
+  end)
+  if not hookok then
+    out = hookerr
+  end
   return nil, self:_unexpected(ctx, out)
 end
 

package/project/.sdk/src/cmp/lua/fragment/EntityPatchOp.fragment.lua

@@ -0,0 +1,34 @@
+local vs = require("utility.struct.struct")
+local helpers = require("core.helpers")
+
+local entityPatchOp = {}
+
+-- EJECT-START
+
+---@param reqdata EntityNamePatchData
+---@param ctrl? table
+---@return EntityName
+---@return string? err
+function EntyClass:patch(reqdata, ctrl)
+  local utility = self._utility
+  local ctx = utility.make_context({
+    opname = "patch",
+    ctrl = ctrl,
+    match = self._match,
+    data = self._data,
+    reqdata = reqdata,
+  }, self._entctx)
+
+  return self:_run_op(ctx, function()
+    if ctx.result ~= nil then
+      if ctx.result.resmatch ~= nil then
+        self._match = ctx.result.resmatch
+      end
+      if ctx.result.resdata ~= nil then
+        self._data = helpers.to_map(vs.clone(ctx.result.resdata)) or {}
+      end
+    end
+  end)
+end
+
+-- EJECT-END

package/project/.sdk/src/cmp/lua/fragment/Main.fragment.lua

@@ -5,6 +5,7 @@ local vs = require("utility.struct.struct")
 local Utility = require("core.utility_type")
 local Spec = require("core.spec")
 local helpers = require("core.helpers")
+local unreadable_body = require("utility.unreadable_body")
 
 -- Load utility registration (populates Utility._registrar)
 require("utility.register")
@@ -192,7 +193,15 @@ function ProjectNameSDK:prepare(fetchargs)
   if type(path) ~= "string" then path = "" end
 
   local method = vs.getprop(fetchargs, "method") or "GET"
-  if type(method) ~= "string" then method = "GET" end
+  if type(method) ~= "string" or method == "" then method = "GET" end
+  method = string.upper(method)
+
+  local allow_method = vs.getpath(options, "allow.method")
+  if not helpers.allowed(allow_method, method) then
+    return nil, ctx:make_error("spec_method_allow",
+      'Method "' .. method ..
+      '" not allowed by SDK option allow.method value: "' .. tostring(allow_method or "") .. '"')
+  end
 
   local params = helpers.to_map(vs.getprop(fetchargs, "params")) or {}
   local query = helpers.to_map(vs.getprop(fetchargs, "query")) or {}
@@ -250,8 +259,7 @@ end
 
 -- Is this raw-access op permitted by the SDK's allow.op option?
 function ProjectNameSDK:_op_allowed(op)
-  local allow = vs.getpath(self.options, "allow.op")
-  return type(allow) == "string" and allow:find(op, 1, true) ~= nil
+  return helpers.allowed(vs.getpath(self.options, "allow.op"), op)
 end
 
 
@@ -313,6 +321,7 @@ function ProjectNameSDK:_raw_request(fetchargs)
     local no_body = status == 204 or status == 304 or tostring(content_length) == "0"
 
     local json_data = nil
+    local body_err = nil
     if not no_body then
       local jf = vs.getprop(fetched, "json")
       if type(jf) == "function" then
@@ -322,14 +331,27 @@ function ProjectNameSDK:_raw_request(fetchargs)
         end
         -- Non-JSON body: json_data stays nil, status/headers preserved.
       end
+      if vs.getprop(fetched, "unreadable") == true then
+        local failed = nil
+        if status < 200 or status >= 300 then
+          failed = ctx:make_error("request_status",
+            "request: " .. tostring(status) .. ": " .. tostring(vs.getprop(fetched, "statusText")))
+        end
+        body_err = unreadable_body(ctx, status, headers, vs.getprop(fetched, "body"),
+          fetchdef["headers"], failed)
+      end
     end
 
-    return {
-      ok = status >= 200 and status < 300,
+    local out = {
+      ok = body_err == nil and status >= 200 and status < 300,
       status = status,
       headers = headers,
       data = json_data,
-    }, nil
+    }
+    if body_err ~= nil then
+      out.err = utility.clean(ctx, body_err)
+    end
+    return out, nil
   end
 
   return {

package/project/.sdk/src/cmp/ocaml/EntityOperation_ocaml.ts

@@ -1,5 +1,5 @@
 
-import { ocamlString } from './utility_ocaml'
+import { ocamlOpField, ocamlString } from './utility_ocaml'
 
 
 // Emit the OCaml source for one entity CRUD operation, as an assignment to
@@ -8,11 +8,7 @@ import { ocamlString } from './utility_ocaml'
 // install a stub that errors at call time (so the entity_obj record is always
 // fully populated). Mirrors the rust/py Entity op fragments.
 function entityOp(opname: string, present: boolean, entityname: string): string {
-  const field =
-    'load' === opname ? 'e_load' :
-      'list' === opname ? 'e_list' :
-        'create' === opname ? 'e_create' :
-          'update' === opname ? 'e_update' : 'e_remove'
+  const field = ocamlOpField(opname)
 
   if (!present) {
     return `  ent.${field} <- (fun _ _ ->
@@ -21,13 +17,14 @@ function entityOp(opname: string, present: boolean, entityname: string): string
 `
   }
 
-  const inputField = ('create' === opname || 'update' === opname) ? 'cs_reqdata' : 'cs_reqmatch'
-  const arg = ('create' === opname || 'update' === opname) ? 'reqdata' : 'reqmatch'
+  const body = 'create' === opname || 'update' === opname || 'patch' === opname
+  const inputField = body ? 'cs_reqdata' : 'cs_reqmatch'
+  const arg = body ? 'reqdata' : 'reqmatch'
 
   // Writeback after a successful op (mirrors the py op fragments):
-  //   load/update/remove -> match + data ; list -> match ; create -> data
-  const writeMatch = ('list' === opname || 'load' === opname || 'update' === opname || 'remove' === opname)
-  const writeData = ('create' === opname || 'load' === opname || 'update' === opname || 'remove' === opname)
+  //   load/update/patch/remove -> match + data ; list -> match ; create -> data
+  const writeMatch = 'create' !== opname
+  const writeData = 'list' !== opname
 
   let post = ''
   if (writeMatch) {

package/project/.sdk/src/cmp/ocaml/Entity_ocaml.ts

@@ -22,7 +22,7 @@ const Entity = cmp(function Entity(props: any) {
 
   const opnames = Object.keys(entity.op || {})
 
-  const ops = ['load', 'list', 'create', 'update', 'remove']
+  const ops = ['load', 'list', 'create', 'update', 'patch', 'remove']
     .map((opname: string) => entityOp(opname, opnames.includes(opname), entity.name))
     .join('')
 
@@ -83,6 +83,7 @@ let rec make (client : sdk_client) (entopts_in : value) : entity_obj =
     e_list = (fun _ _ -> failwith "op not installed");
     e_create = (fun _ _ -> failwith "op not installed");
     e_update = (fun _ _ -> failwith "op not installed");
+    e_patch = (fun _ _ -> failwith "op not installed");
     e_remove = (fun _ _ -> failwith "op not installed");
     e_deleted = false;
     e_mark_deleted = (fun () -> ());
@@ -116,7 +117,11 @@ let rec make (client : sdk_client) (entopts_in : value) : entity_obj =
    * and signal (a 0-arity fn -> Bool; iteration stops when it returns true). *)
   ent.e_stream <- (fun action args callopts ->
       let callopts = match to_map callopts with Map _ as m -> m | _ -> empty_map () in
-      let ctrl = match to_map (getp callopts "ctrl") with Map _ as m -> m | _ -> empty_map () in
+      (* A copy: the caller's ctrl gains no key, and explain stays its own record. *)
+      let ctrl = empty_map () in
+      (match to_map (getp callopts "ctrl") with
+       | Map _ as given -> List.iter (fun k -> setp ctrl k (getp given k)) (keysof given)
+       | _ -> ());
       setp ctrl "stream" callopts;
       let reqmatch = match to_map args with Map _ as m -> m | _ -> empty_map () in
       let ctx = utility.u_make_context
@@ -142,7 +147,7 @@ let rec make (client : sdk_client) (entopts_in : value) : entity_obj =
             (match result.rt_stream with
              | Some fn -> fn ()
              | None -> (match result.rt_resdata with List r -> !r | v when is_nullish v -> [] | v -> [v]))
-          | None -> []) with e -> unexpected ctx e) in
+          | None -> []) with e -> ignore (unexpected ctx e); []) in
       let rec seq_of l () = match l with
         | [] -> Seq.Nil
         | x :: rest -> if aborted () then Seq.Nil else Seq.Cons (x, seq_of rest) in

package/project/.sdk/src/cmp/ocaml/Main_ocaml.ts

@@ -3,6 +3,7 @@ import {
   cmp, each,
   File, Content, Copy, Folder,
   entityClassName,
+  inactiveFeatureExcludes,
   pluginExcludes,
   targetFeatures,
 } from '@voxgig/sdkgen'
@@ -58,7 +59,7 @@ const Main = cmp(async function Main(props: any) {
     from: 'tm/' + target.name,
     exclude: [/src\//, /\.(cmi|cmo|cmx|cma|cmxa|o|a)$/, /a\.out$/,
       /run_sdk_test$/, /run_omni_smoke$/, /run_struct_corpus$/, /run_primary_corpus$/,
-      ...containerExcludes, ...pluginExcludes(model)],
+      ...containerExcludes, ...inactiveFeatureExcludes(props.ctx$, target), ...pluginExcludes(model)],
     replace: {
       ...props.ctx$.stdrep,
     }

package/project/.sdk/src/cmp/ocaml/Package_ocaml.ts

@@ -5,10 +5,11 @@ import {
   cmp,
   packageVersion,
   authorInfo,
+  repoInfo,
 } from '@voxgig/sdkgen'
 
 
-import { packageName } from './utility_ocaml'
+import { ocamlString, packageName } from './utility_ocaml'
 import { secretsBuild } from './Config_ocaml'
 
 
@@ -38,17 +39,18 @@ depexts: [
   const author = authorInfo(model, target.name)
 
   const pkg = packageName(model)
+  const { repoUrl, issuesUrl } = repoInfo(model)
 
   File({ name: pkg + '.opam' }, () => {
     Content(`opam-version: "2.0"
 name: "${pkg}"
 version: "${packageVersion(model, target.name)}"
 synopsis: "${model.const.Name} SDK for OCaml (generated by @voxgig/sdkgen)"
-maintainer: "${author.name}"
-authors: "${author.name}"
+maintainer: "${ocamlString(author.name)}"
+authors: "${ocamlString(author.name)}"
 license: "MIT"
-homepage: "https://voxgig.com"
-bug-reports: "https://voxgig.com"
+homepage: "${repoUrl}"
+bug-reports: "${issuesUrl}"
 # The generated SDK is dependency-free: it compiles with the stock ocamlc
 # (see the Makefile). No opam packages, no dune.
 depends: [

package/project/.sdk/src/cmp/ocaml/PrepareAuth_ocaml.ts

@@ -131,7 +131,7 @@ function renderHeader(spec: AuthSpec, head: string): string {
 let option_apikey = "apikey"
 ${spec.basic ? `let option_secret = "secret"
 ` : ''}let not_found = "__NOTFOUND__"
-
+${authName(true)}
 let prepare_auth_util (ctx : ctx) : (spec option * sdk_error option) =
   match ctx.c_spec with
   | None -> (None, Some (ctx_make_error ctx "auth_no_spec" "Expected context spec property to be defined."))
@@ -143,17 +143,20 @@ let prepare_auth_util (ctx : ctx) : (spec option * sdk_error option) =
       * needs no auth omits the block entirely. Both land here. *)
      | Noval | Null -> ignore (delprop headers (Str cred_name)); (Some spec, None)
      | _ ->
+       let name = auth_name options in
+       (* A credential left under the declared name would travel beside the renamed one. *)
+       if name <> cred_name then ignore (delprop headers (Str cred_name));
        let apikey = getprop ~alt:(Str not_found) options (Str option_apikey) in
        let is_notfound = (match apikey with Str s -> s = not_found | _ -> false) in
        let no_apikey = is_notfound || is_noval apikey || apikey = Str "" in
 ${spec.basic ? BASIC : ''}       if no_apikey then
-         ignore (delprop headers (Str cred_name))
+         ignore (delprop headers (Str name))
        else begin
          let auth_prefix = match getpath_s options "auth.prefix" with Str s -> s | _ -> "" in
          let apikey_val = match apikey with Str s -> s | _ -> "" in
          (* Empty prefix (a raw apiKey credential) must not add a leading space. *)
          let authval = if auth_prefix <> "" then auth_prefix ^ " " ^ apikey_val else apikey_val in
-         setp headers cred_name (Str authval)
+         setp headers name (Str authval)
        end;
        (Some spec, None))
 `
@@ -168,7 +171,7 @@ function renderQuery(spec: AuthSpec, head: string): string {
   return head + `
 let option_apikey = "apikey"
 let not_found = "__NOTFOUND__"
-
+${authName(false)}
 let prepare_auth_util (ctx : ctx) : (spec option * sdk_error option) =
   match ctx.c_spec with
   | None -> (None, Some (ctx_make_error ctx "auth_no_spec" "Expected context spec property to be defined."))
@@ -180,16 +183,19 @@ let prepare_auth_util (ctx : ctx) : (spec option * sdk_error option) =
       * needs no auth omits the block entirely. Both land here. *)
      | Noval | Null -> ignore (delprop query (Str cred_name)); (Some spec, None)
      | _ ->
+       let name = auth_name options in
+       (* A credential left under the declared name would travel beside the renamed one. *)
+       if name <> cred_name then ignore (delprop query (Str cred_name));
        let apikey = getprop ~alt:(Str not_found) options (Str option_apikey) in
        let is_notfound = (match apikey with Str s -> s = not_found | _ -> false) in
        if is_notfound || is_noval apikey || apikey = Str "" then
-         ignore (delprop query (Str cred_name))
+         ignore (delprop query (Str name))
        else begin
          (* NO PREFIX IN A QUERY STRING. \`?${spec.name}=Bearer%20abc\` is not a
           * thing any API reads: the prefix is a header-value convention, so
           * it is dropped here deliberately rather than concatenated. *)
          let apikey_val = match apikey with Str s -> s | _ -> "" in
-         setp query cred_name (Str apikey_val)
+         setp query name (Str apikey_val)
        end;
        (Some spec, None))
 `
@@ -201,30 +207,13 @@ function renderCookie(spec: AuthSpec, head: string): string {
 let cookie_header = "cookie"
 let option_apikey = "apikey"
 let not_found = "__NOTFOUND__"
-
-(* Strip ASCII spaces and tabs from both ends of one cookie pair. *)
-let cookie_trim (s : string) : string =
-  let n = String.length s in
-  let b = ref 0 and e = ref n in
-  while !b < !e && (s.[!b] = ' ' || s.[!b] = '\\t') do incr b done;
-  while !e > !b && (s.[!e - 1] = ' ' || s.[!e - 1] = '\\t') do decr e done;
-  String.sub s !b (!e - !b)
-
-(* True for OUR pair only: the bare name, or the name followed by '='. A
- * cookie called "${ocamlString(spec.name)}_backup" must survive. *)
-let cookie_is_cred (pair : string) : bool =
-  let n = String.length cred_name in
-  pair = cred_name
-  || (String.length pair > n && String.sub pair 0 (n + 1) = cred_name ^ "=")
-
-(* Rewrite the cookie header with our pair set (Some v) or removed (None),
- * every other cookie kept in order. *)
-let cookie_set (headers : value) (v : string option) : unit =
+${authName(false)}
+(* Rewrite the cookie header with the named pair set (Some v) or removed
+ * (None), every other cookie kept in order. *)
+let cookie_set (headers : value) (name : string) (v : string option) : unit =
   let existing = match getp headers cookie_header with Str s -> s | _ -> "" in
-  let kept =
-    List.filter (fun p -> p <> "" && not (cookie_is_cred p))
-      (List.map cookie_trim (String.split_on_char ';' existing)) in
-  let kept = match v with None -> kept | Some x -> kept @ [cred_name ^ "=" ^ x] in
+  let kept = cookie_keep existing [name] in
+  let kept = match v with None -> kept | Some x -> kept @ [name ^ "=" ^ x] in
   if [] = kept then ignore (delprop headers (Str cookie_header))
   else setp headers cookie_header (Str (String.concat "; " kept))
 
@@ -237,23 +226,39 @@ let prepare_auth_util (ctx : ctx) : (spec option * sdk_error option) =
     (match getp options "auth" with
      (* \`auth: null\` is the documented suppression, and a public API that
       * needs no auth omits the block entirely. Both land here. *)
-     | Noval | Null -> cookie_set headers None; (Some spec, None)
+     | Noval | Null -> cookie_set headers cred_name None; (Some spec, None)
      | _ ->
+       let name = auth_name options in
+       (* A credential left under the declared name would travel beside the renamed one. *)
+       if name <> cred_name then cookie_set headers cred_name None;
        let apikey = getprop ~alt:(Str not_found) options (Str option_apikey) in
        let is_notfound = (match apikey with Str s -> s = not_found | _ -> false) in
        if is_notfound || is_noval apikey || apikey = Str "" then
-         cookie_set headers None
+         cookie_set headers name None
        else begin
          (* NO PREFIX IN A COOKIE either - a cookie carries a bare
           * \`name=value\` pair, not a header's scheme-prefixed credential. *)
          let apikey_val = match apikey with Str s -> s | _ -> "" in
-         cookie_set headers (Some apikey_val)
+         cookie_set headers name (Some apikey_val)
        end;
        (Some spec, None))
 `
 }
 
 
+// The client's `auth.name` option, when set, replaces the declared name; a
+// header name travels lower-cased.
+function authName(header: boolean): string {
+  return `
+(* The client's auth.name option, when set, replaces the name the API declares. *)
+let auth_name (options : value) : string =
+  match getpath_s options "auth.name" with
+  | Str s when s <> "" -> ${header ? 'String.lowercase_ascii s' : 's'}
+  | _ -> cred_name
+`
+}
+
+
 const BASIC = `       if (match getpath_s options "auth.basic" with Bool b -> b | _ -> false) then begin
          (* True HTTP Basic Auth joins the two credentials, base64-encoded -
           * a single token in the header (the branch below) can never
@@ -266,7 +271,7 @@ const BASIC = `       if (match getpath_s options "auth.basic" with Bool b -> b
            (match secret with Str s -> s = not_found | _ -> false)
            || is_noval secret || secret = Str "" in
          if no_apikey then
-           ignore (delprop headers (Str cred_name))
+           ignore (delprop headers (Str name))
          else begin
            let auth_prefix = match getpath_s options "auth.prefix" with Str s -> s | _ -> "" in
            let apikey_val = match apikey with Str s -> s | _ -> "" in
@@ -275,7 +280,7 @@ const BASIC = `       if (match getpath_s options "auth.basic" with Bool b -> b
            (* The joined, encoded pair is a wire form neither credential's
             * own registration covers. base64_encode is Sdk_helpers'. *)
            (cu ctx).u_clean_add ctx joined;
-           setp headers cred_name
+           setp headers name
              (Str (if auth_prefix <> "" then auth_prefix ^ " " ^ joined else joined))
          end
        end

package/project/.sdk/src/cmp/ocaml/ReadmeEntity_ocaml.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content, canonKey, canonScalarKey, entityIdField, opRequestShape } from '@voxgig/sdkgen'
+import { cmp, each, Content, canonKey, canonScalarKey, entityIdField, opRequestShape, opNeedsAction } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -43,6 +43,7 @@ const OP_DESC: Record<string, { method: string, desc: string }> = {
   list:   { method: 'e_list reqmatch ctrl',   desc: 'List entities, optionally matching the given criteria. Resolves to one entity per record.' },
   create: { method: 'e_create reqdata ctrl',  desc: 'Create a new entity with the given data. Resolves to the entity.' },
   update: { method: 'e_update reqdata ctrl',  desc: 'Update an existing entity. Resolves to the entity.' },
+  patch:  { method: 'e_patch reqdata ctrl',   desc: 'Change part of an existing entity. Resolves to the entity.' },
   remove: { method: 'e_remove reqmatch ctrl', desc: 'Remove the matching entity. Resolves to the entity, marked deleted.' },
 }
 
@@ -68,6 +69,8 @@ const ReadmeEntity = cmp(function ReadmeEntity(props: any) {
 
   publishedEntities.map((entity: any) => {
     const opnames = Object.keys(entity.op || {})
+    // An op that needs an action has no plain call to show.
+    const callable = opnames.filter((o: string) => !opNeedsAction(entity.op[o]))
     const fields = Object.values(entity.fields || {})
     // Model-driven id key: null when this entity has no id-like field.
     const idF = entityIdField(entity)
@@ -123,7 +126,7 @@ const ReadmeEntity = cmp(function ReadmeEntity(props: any) {
 `)
     }
 
-    if (opnames.includes('load')) {
+    if (callable.includes('load')) {
       // The id key plus every REQUIRED match key (parent path params like
       // page_id) — the same shape the runtime resolves path params from.
       const loadItems = opRequestShape(entity, 'load').items
@@ -146,7 +149,7 @@ let ${fn}_data = ${fn}.e_data_get ()
 `)
     }
 
-    if (opnames.includes('list')) {
+    if (callable.includes('list')) {
       Content(`#### Example: List
 
 \`\`\`ocaml
@@ -158,7 +161,7 @@ let ${fn}_datas = List.map (fun e -> e.e_data_get ()) ${fn}s
 `)
     }
 
-    if (opnames.includes('create')) {
+    if (callable.includes('create')) {
       const createItems = opRequestShape(entity, 'create').items
         .filter((it: any) => !it.optional)
       Content(`#### Example: Create