@voxgig/sdkgen 0.35.2 → 0.36.0

package/project/.sdk/src/cmp/ts/ReadmeQuick_ts.ts

@@ -14,10 +14,14 @@ const ReadmeQuick = cmp(function ReadmeQuick(props: any) {
   const entity = getModelPath(model, `main.${KIT}.entity`)
 
   // Find the first published entity for examples
-  const exampleEntity = Object.values(entity).find((e: any) => e.publish) as any
+  const exampleEntity = Object.values(entity).find((e: any) => e.active !== false) as any
 
-  Content(`
-### Create a Client
+  // Find a nested entity if available
+  const nestedEntity = Object.values(entity).find((e: any) =>
+    e.active !== false && e.ancestors && e.ancestors.length > 0
+  ) as any
+
+  Content(`### 1. Create a client
 
 \`\`\`ts
 import { ${model.const.Name}SDK } from '${target.module.name}'
@@ -26,6 +30,7 @@ const client = new ${model.const.Name}SDK({
   apikey: process.env.${model.NAME}_APIKEY,
 })
 \`\`\`
+
 `)
 
 
@@ -33,85 +38,95 @@ const client = new ${model.const.Name}SDK({
     const eName = nom(exampleEntity, 'Name')
     const opnames = Object.keys(exampleEntity.op || {})
 
-    if (opnames.includes('load')) {
-      Content(`
-### Load a ${eName}
+    if (opnames.includes('list')) {
+      Content(`### 2. List ${eName.toLowerCase()}s
 
 \`\`\`ts
-const ${exampleEntity.name} = await client.${eName}().load({ id: '${exampleEntity.name}_id' })
-console.log(${exampleEntity.name})
+const result = await client.${eName}().list()
+
+if (result.ok) {
+  for (const item of result.data) {
+    console.log(item.id, item.name)
+  }
+}
 \`\`\`
+
 `)
     }
 
-    if (opnames.includes('list')) {
-      Content(`
-### List ${eName} Records
+    if (nestedEntity) {
+      const neName = nom(nestedEntity, 'Name')
+      const parentFields = (nestedEntity.fields || [])
+        .filter((f: any) => f.name !== 'id' && f.name.endsWith('_id'))
+      const parentParam = parentFields.length > 0 ? parentFields[0].name : 'parent_id'
 
-\`\`\`ts
-const ${exampleEntity.name}s = await client.${eName}().list()
-console.log(${exampleEntity.name}s)
-\`\`\`
-`)
-    }
+      Content(`### 3. Load a ${neName.toLowerCase()}
 
-    if (opnames.includes('create')) {
-      Content(`
-### Create a ${eName}
+${neName} is nested under ${eName}, so provide the \`${parentParam}\`:
 
 \`\`\`ts
-const created = await client.${eName}().create({
-  // Provide ${exampleEntity.name} fields
+const ${neName.toLowerCase()} = client.${neName}()
+const result = await ${neName.toLowerCase()}.load({
+  ${parentParam}: 'example',
+  id: 'example_id',
 })
-console.log(created)
+
+if (result.ok) {
+  console.log(result.data)
+}
 \`\`\`
+
 `)
     }
-
-    if (opnames.includes('update')) {
-      Content(`
-### Update a ${eName}
+    else if (opnames.includes('load')) {
+      Content(`### 3. Load a ${eName.toLowerCase()}
 
 \`\`\`ts
-const updated = await client.${eName}().update({
-  id: '${exampleEntity.name}_id',
-  // Fields to update
-})
-console.log(updated)
+const result = await client.${eName}().load({ id: 'example_id' })
+
+if (result.ok) {
+  console.log(result.data)
+}
 \`\`\`
+
 `)
     }
 
-    if (opnames.includes('remove')) {
-      Content(`
-### Remove a ${eName}
+    // CRUD operations
+    if (opnames.includes('create') || opnames.includes('update') || opnames.includes('remove')) {
+      Content(`### 4. Create, update, and remove
 
 \`\`\`ts
-await client.${eName}().remove({ id: '${exampleEntity.name}_id' })
-\`\`\`
 `)
-    }
-  }
-
-
-  Content(`
-### Direct API Access
-
-Use \`client.direct()\` to call any API endpoint directly:
+      if (opnames.includes('create')) {
+        Content(`// Create
+const created = await client.${eName}().create({
+  name: 'Example',
+})
 
-\`\`\`ts
-const result = await client.direct({
-  path: '/custom/endpoint/{id}',
-  method: 'GET',
-  params: { id: 'abc123' },
+`)
+      }
+      if (opnames.includes('update')) {
+        Content(`// Update
+const updated = await client.${eName}().update({
+  id: created.data.id,
+  name: 'Example-Renamed',
 })
 
-if (result.ok) {
-  console.log(result.data)
-}
-\`\`\`
+`)
+      }
+      if (opnames.includes('remove')) {
+        Content(`// Remove
+const removed = await client.${eName}().remove({
+  id: created.data.id,
+})
+`)
+      }
+      Content(`\`\`\`
 
 `)
+    }
+  }
 
 })
 

package/project/.sdk/src/cmp/ts/ReadmeTopHowto_ts.ts

@@ -0,0 +1,25 @@
+
+import { cmp, Content } from '@voxgig/sdkgen'
+
+
+const ReadmeTopHowto = cmp(function ReadmeTopHowto(props: any) {
+  const { target } = props
+
+  Content(`**TypeScript:**
+\`\`\`ts
+const result = await client.direct({
+  path: '/api/resource/{id}',
+  method: 'GET',
+  params: { id: 'example' },
+})
+console.log(result.data)
+\`\`\`
+
+`)
+
+})
+
+
+export {
+  ReadmeTopHowto
+}

package/project/.sdk/src/cmp/ts/ReadmeTopQuick_ts.ts

@@ -0,0 +1,65 @@
+
+import { cmp, Content } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+  nom,
+} from '@voxgig/apidef'
+
+
+const ReadmeTopQuick = cmp(function ReadmeTopQuick(props: any) {
+  const { target, ctx$: { model } } = props
+
+  const entity = getModelPath(model, `main.${KIT}.entity`)
+  const exampleEntity = Object.values(entity).find((e: any) => e.active !== false) as any
+
+  Content(`\`\`\`ts
+import { ${model.const.Name}SDK } from '${target.module.name}'
+
+const client = new ${model.const.Name}SDK({
+  apikey: process.env.${model.NAME}_APIKEY,
+})
+
+`)
+
+  if (exampleEntity) {
+    const eName = nom(exampleEntity, 'Name')
+    const opnames = Object.keys(exampleEntity.op || {})
+
+    if (opnames.includes('list')) {
+      Content(`// List all ${eName.toLowerCase()}s
+const ${eName.toLowerCase()}s = await client.${eName}().list()
+`)
+    }
+
+    // Find a nested entity for a more interesting example
+    const nestedEntity = Object.values(entity).find((e: any) =>
+      e.active !== false && e.ancestors && e.ancestors.length > 0
+    ) as any
+
+    if (nestedEntity && opnames.includes('load')) {
+      const neName = nom(nestedEntity, 'Name')
+      const parentFields = (nestedEntity.fields || [])
+        .filter((f: any) => f.name !== 'id' && f.name.endsWith('_id'))
+      const parentParam = parentFields.length > 0 ? parentFields[0].name : 'parent_id'
+
+      Content(`
+// Load a specific ${neName.toLowerCase()}
+const ${neName.toLowerCase()} = await client.${neName}().load({
+  ${parentParam}: 'example',
+  id: 'example_id',
+})
+`)
+    }
+  }
+
+  Content(`\`\`\`
+`)
+
+})
+
+
+export {
+  ReadmeTopQuick
+}

package/project/.sdk/src/cmp/ts/ReadmeTopTest_ts.ts

@@ -0,0 +1,36 @@
+
+import { cmp, Content } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+  nom,
+} from '@voxgig/apidef'
+
+
+const ReadmeTopTest = cmp(function ReadmeTopTest(props: any) {
+  const { target, ctx$: { model } } = props
+
+  const entity = getModelPath(model, `main.${KIT}.entity`)
+  const exampleEntity = Object.values(entity).find((e: any) => e.active !== false) as any
+
+  Content(`\`\`\`ts
+const client = ${model.const.Name}SDK.test()
+`)
+
+  if (exampleEntity) {
+    const eName = nom(exampleEntity, 'Name')
+    Content(`const result = await client.${eName}().load({ id: 'test01' })
+// result.ok === true, result.data contains mock data
+`)
+  }
+
+  Content(`\`\`\`
+`)
+
+})
+
+
+export {
+  ReadmeTopTest
+}

package/project/.sdk/tm/go/feature/log_feature.go

@@ -0,0 +1,133 @@
+package feature
+
+import (
+	"log/slog"
+	"os"
+
+	"GOMODULE/core"
+)
+
+type LogFeature struct {
+	BaseFeature
+	client  *core.ProjectNameSDK
+	options map[string]any
+	logger  *slog.Logger
+}
+
+func NewLogFeature() *LogFeature {
+	return &LogFeature{
+		BaseFeature: BaseFeature{
+			Version: "0.0.1",
+			Name:    "log",
+			Active:  true,
+		},
+	}
+}
+
+func (f *LogFeature) Init(ctx *core.Context, options map[string]any) {
+	f.client = ctx.Client
+	f.options = options
+
+	if active, ok := options["active"].(bool); ok {
+		f.Active = active
+	}
+
+	if f.Active {
+		if logger, ok := options["logger"].(*slog.Logger); ok && logger != nil {
+			f.logger = logger
+		} else {
+			level := slog.LevelInfo
+			if lvl, ok := options["level"].(string); ok {
+				switch lvl {
+				case "debug":
+					level = slog.LevelDebug
+				case "warn":
+					level = slog.LevelWarn
+				case "error":
+					level = slog.LevelError
+				}
+			}
+
+			f.logger = slog.New(slog.NewTextHandler(os.Stderr, &slog.HandlerOptions{
+				Level: level,
+			})).With("name", "log")
+		}
+	}
+}
+
+func (f *LogFeature) PostConstruct(ctx *core.Context) {
+	f.loghook("PostConstruct", ctx, "")
+}
+
+func (f *LogFeature) PostConstructEntity(ctx *core.Context) {
+	f.loghook("PostConstructEntity", ctx, "")
+}
+
+func (f *LogFeature) SetData(ctx *core.Context) {
+	f.loghook("SetData", ctx, "")
+}
+
+func (f *LogFeature) GetData(ctx *core.Context) {
+	f.loghook("GetData", ctx, "")
+}
+
+func (f *LogFeature) SetMatch(ctx *core.Context) {
+	f.loghook("SetMatch", ctx, "")
+}
+
+func (f *LogFeature) GetMatch(ctx *core.Context) {
+	f.loghook("GetMatch", ctx, "")
+}
+
+func (f *LogFeature) PrePoint(ctx *core.Context) {
+	f.loghook("PrePoint", ctx, "")
+}
+
+func (f *LogFeature) PreSpec(ctx *core.Context) {
+	f.loghook("PreSpec", ctx, "")
+}
+
+func (f *LogFeature) PreRequest(ctx *core.Context) {
+	f.loghook("PreRequest", ctx, "")
+}
+
+func (f *LogFeature) PreResponse(ctx *core.Context) {
+	f.loghook("PreResponse", ctx, "")
+}
+
+func (f *LogFeature) PreResult(ctx *core.Context) {
+	f.loghook("PreResult", ctx, "")
+}
+
+func (f *LogFeature) loghook(hook string, ctx *core.Context, level string) {
+	if f.logger == nil {
+		return
+	}
+
+	if level == "" {
+		level = "info"
+	}
+
+	attrs := []any{
+		"hook", hook,
+	}
+
+	if ctx.Op != nil {
+		attrs = append(attrs, "op", ctx.Op.Name)
+	}
+
+	if ctx.Spec != nil {
+		attrs = append(attrs, "spec", ctx.Spec.Name)
+	}
+
+	switch level {
+	case "debug":
+		f.logger.Debug("hook", attrs...)
+	case "warn":
+		f.logger.Warn("hook", attrs...)
+	case "error":
+		f.logger.Error("hook", attrs...)
+	default:
+		f.logger.Info("hook", attrs...)
+	}
+}

package/project/.sdk/tm/lua/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) $$const.year$$ $$const.Name$$
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/project/.sdk/tm/lua/Makefile

@@ -0,0 +1,10 @@
+.PHONY: test build clean
+
+test:
+	busted test/
+
+build:
+	@echo "No build step for Lua"
+
+clean:
+	@echo "No clean step for Lua"

package/project/.sdk/tm/lua/core/context.lua

@@ -0,0 +1,208 @@
+-- ProjectName SDK context
+
+local vs = require("utility.struct.struct")
+local Control = require("core.control")
+local Operation = require("core.operation")
+local Spec = require("core.spec")
+local Result = require("core.result")
+local Response = require("core.response")
+local ProjectNameError = require("core.error")
+local helpers = require("core.helpers")
+
+local Context = {}
+Context.__index = Context
+
+
+function Context.new(ctxmap, basectx)
+  local self = setmetatable({}, Context)
+
+  self.id = "C" .. tostring(math.random(10000000, 99999999))
+  self.out = {}
+
+  ctxmap = ctxmap or {}
+
+  -- Client
+  local c = helpers.get_ctx_prop(ctxmap, "client")
+  if c ~= nil then
+    self.client = c
+  elseif basectx ~= nil then
+    self.client = basectx.client
+  end
+
+  -- Utility
+  local u = helpers.get_ctx_prop(ctxmap, "utility")
+  if u ~= nil then
+    self.utility = u
+  elseif basectx ~= nil then
+    self.utility = basectx.utility
+  end
+
+  -- Ctrl
+  self.ctrl = Control.new()
+  local ctrl_raw = helpers.get_ctx_prop(ctxmap, "ctrl")
+  if type(ctrl_raw) == "table" then
+    if ctrl_raw.throw_err ~= nil then
+      self.ctrl.throw_err = ctrl_raw.throw_err
+    elseif type(ctrl_raw["throw"]) == "boolean" then
+      self.ctrl.throw_err = ctrl_raw["throw"]
+    end
+    if type(ctrl_raw.explain) == "table" then
+      self.ctrl.explain = ctrl_raw.explain
+    end
+  elseif basectx ~= nil and basectx.ctrl ~= nil then
+    self.ctrl = basectx.ctrl
+  end
+
+  -- Meta
+  self.meta = {}
+  local m = helpers.get_ctx_prop(ctxmap, "meta")
+  if type(m) == "table" then
+    self.meta = m
+  elseif basectx ~= nil and basectx.meta ~= nil then
+    self.meta = basectx.meta
+  end
+
+  -- Config
+  local cfg = helpers.get_ctx_prop(ctxmap, "config")
+  if type(cfg) == "table" then
+    self.config = cfg
+  elseif basectx ~= nil then
+    self.config = basectx.config
+  end
+
+  -- Entopts
+  local eo = helpers.get_ctx_prop(ctxmap, "entopts")
+  if type(eo) == "table" then
+    self.entopts = eo
+  elseif basectx ~= nil then
+    self.entopts = basectx.entopts
+  end
+
+  -- Options
+  local o = helpers.get_ctx_prop(ctxmap, "options")
+  if type(o) == "table" then
+    self.options = o
+  elseif basectx ~= nil then
+    self.options = basectx.options
+  end
+
+  -- Entity
+  local e = helpers.get_ctx_prop(ctxmap, "entity")
+  if e ~= nil then
+    self.entity = e
+  elseif basectx ~= nil then
+    self.entity = basectx.entity
+  end
+
+  -- Shared
+  local s = helpers.get_ctx_prop(ctxmap, "shared")
+  if type(s) == "table" then
+    self.shared = s
+  elseif basectx ~= nil then
+    self.shared = basectx.shared
+  end
+
+  -- Opmap
+  local om = helpers.get_ctx_prop(ctxmap, "opmap")
+  if type(om) == "table" then
+    self.opmap = om
+  elseif basectx ~= nil then
+    self.opmap = basectx.opmap
+  end
+  if self.opmap == nil then
+    self.opmap = {}
+  end
+
+  -- Data
+  self.data = helpers.to_map(helpers.get_ctx_prop(ctxmap, "data")) or {}
+  self.reqdata = helpers.to_map(helpers.get_ctx_prop(ctxmap, "reqdata")) or {}
+  self.match = helpers.to_map(helpers.get_ctx_prop(ctxmap, "match")) or {}
+  self.reqmatch = helpers.to_map(helpers.get_ctx_prop(ctxmap, "reqmatch")) or {}
+
+  -- Point
+  local pt = helpers.get_ctx_prop(ctxmap, "point")
+  if type(pt) == "table" then
+    self.point = pt
+  elseif basectx ~= nil then
+    self.point = basectx.point
+  end
+
+  -- Spec
+  local sp = helpers.get_ctx_prop(ctxmap, "spec")
+  if sp ~= nil and getmetatable(sp) == Spec then
+    self.spec = sp
+  elseif basectx ~= nil then
+    self.spec = basectx.spec
+  end
+
+  -- Result
+  local r = helpers.get_ctx_prop(ctxmap, "result")
+  if r ~= nil and getmetatable(r) == Result then
+    self.result = r
+  elseif basectx ~= nil then
+    self.result = basectx.result
+  end
+
+  -- Response
+  local rp = helpers.get_ctx_prop(ctxmap, "response")
+  if rp ~= nil and getmetatable(rp) == Response then
+    self.response = rp
+  elseif basectx ~= nil then
+    self.response = basectx.response
+  end
+
+  -- Resolve operation
+  local opname = helpers.get_ctx_prop(ctxmap, "opname") or ""
+  self.op = self:resolve_op(opname)
+
+  return self
+end
+
+
+function Context:resolve_op(opname)
+  if self.opmap[opname] ~= nil then
+    return self.opmap[opname]
+  end
+
+  if opname == "" then
+    return Operation.new({})
+  end
+
+  local entname = "_"
+  if self.entity ~= nil and type(self.entity.get_name) == "function" then
+    entname = self.entity:get_name()
+  end
+
+  local opcfg = vs.getpath(self.config, "entity." .. entname .. ".op." .. opname)
+
+  local input = "match"
+  if opname == "update" or opname == "create" then
+    input = "data"
+  end
+
+  local points = {}
+  if type(opcfg) == "table" then
+    local t = vs.getprop(opcfg, "points")
+    if type(t) == "table" then
+      points = t
+    end
+  end
+
+  local op = Operation.new({
+    entity = entname,
+    name = opname,
+    input = input,
+    points = points,
+  })
+
+  self.opmap[opname] = op
+  return op
+end
+
+
+function Context:make_error(code, msg)
+  return ProjectNameError.new(code, msg, self)
+end
+
+
+return Context

package/project/.sdk/tm/lua/core/control.lua

@@ -0,0 +1,17 @@
+-- ProjectName SDK control
+
+local Control = {}
+Control.__index = Control
+
+
+function Control.new(opts)
+  opts = opts or {}
+  local self = setmetatable({}, Control)
+  self.throw_err = opts.throw_err
+  self.err = nil
+  self.explain = opts.explain
+  return self
+end
+
+
+return Control