@voxgig/sdkgen 1.2.0 → 1.3.1

package/project/.sdk/src/cmp/go/Main_go.ts

@@ -22,6 +22,7 @@ import { Package } from './Package_go'
 import { Config } from './Config_go'
 import { Gitignore } from './Gitignore_go'
 import { MainEntity } from './MainEntity_go'
+import { EntityTypes } from './EntityTypes_go'
 
 
 const Main = cmp(async function Main(props: any) {
@@ -34,7 +35,7 @@ const Main = cmp(async function Main(props: any) {
 
   // Go module path == the repo path on GitHub (org from model.origin),
   // e.g. github.com/voxgig-sdk/<slug>-sdk. Used in go.mod and every import.
-  const gomodule = `github.com/${model.origin || 'voxgig-sdk'}/${model.name}-sdk`
+  const gomodule = `github.com/${model.origin || 'voxgig-sdk'}/${model.name}-sdk/go`
   // The root package name must be a plain Go identifier (can't be a path),
   // so it stays as the concatenated-lowercase form (e.g. voxgigdogsdk).
   const gopackage = (model.origin || 'voxgig-sdk').replace(/-sdk$/, '').replace(/[^a-z0-9]/gi, '') +
@@ -44,16 +45,27 @@ const Main = cmp(async function Main(props: any) {
 
   Gitignore({})
 
-  // Copy tm/go files with replacements
+  // Copy tm/go files with replacements.
+  //
+  // Rewrite the placeholder `github.com/voxgig/struct` import (used in the
+  // template since it's a self-contained module there) to its in-SDK path.
+  // The struct package is inlined under `<gomodule>/utility/struct` so the
+  // module is fully self-contained — no external go.mod required by
+  // downstream consumers.
   Copy({
     from: 'tm/' + target.name,
-    exclude: [/src\//],
+    exclude: [/src\//, /utility\/struct\/go\.mod$/],
     replace: {
       ...props.ctx$.stdrep,
       GOMODULE: gomodule,
+      '"github.com/voxgig/struct"': `"${gomodule}/utility/struct"`,
     }
   })
 
+  // Typed models: entity/types.go (package entity), emitted alongside the
+  // generated *_entity.go files so the typed accessors resolve without imports.
+  EntityTypes({ target })
+
   // Generate main SDK file in core/ folder
   Folder({ name: 'core' }, () => {
 
@@ -65,6 +77,7 @@ const Main = cmp(async function Main(props: any) {
           replace: {
             ...props.ctx$.stdrep,
             'ProjectNameModule': gomodule,
+            '"github.com/voxgig/struct"': `"${gomodule}/utility/struct"`,
 
             '#BuildFeatures': ({ indent }: any) => {
               each(feature, (feat: any) => {
@@ -190,6 +203,13 @@ var NewResult = core.NewResult
 var NewResponse = core.NewResponse
 var NewOperation = core.NewOperation
 var MakeConfig = core.MakeConfig
+
+// No-arg convenience constructors. Go has no default-argument syntax,
+// so these aliases let callers write \`sdk.New()\` / \`sdk.Test()\`
+// instead of \`sdk.New${model.const.Name}SDK(nil)\` / \`sdk.TestSDK(nil, nil)\`
+// for the common no-options case.
+func New() *${model.const.Name}SDK  { return New${model.const.Name}SDK(nil) }
+func Test() *${model.const.Name}SDK { return TestSDK(nil, nil) }
 `)
 
     // Feature constructor re-exports - base is always present

package/project/.sdk/src/cmp/go/Package_go.ts

@@ -20,7 +20,7 @@ const Package = cmp(async function Package(props: any) {
 
   // Module name: concatenated lowercase (e.g., voxgigsolardemosdk)
   // Go module path == repo path on GitHub (org from model.origin).
-  const gomodule = `github.com/${model.origin || 'voxgig-sdk'}/${model.name}-sdk`
+  const gomodule = `github.com/${model.origin || 'voxgig-sdk'}/${model.name}-sdk/go`
 
   File({ name: 'go.mod' }, () => {
     Content(`module ${gomodule}

package/project/.sdk/src/cmp/go/ReadmeEntity_go.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content } from '@voxgig/sdkgen'
+import { cmp, each, Content, canonToType, entityIdField, safeVarName } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -41,6 +41,10 @@ const ReadmeEntity = cmp(function ReadmeEntity(props: any) {
   publishedEntities.map((entity: any) => {
     const opnames = Object.keys(entity.op || {})
     const fields = entity.fields || []
+    // Model-driven id key: null when this entity has no id-like field.
+    const idF = entityIdField(entity)
+    // Variable-safe lowercase name (a `Type`/`Range` entity must not bind a Go keyword).
+    const eVar = safeVarName(entity.name, 'go')
 
     Content(`
 ### ${entity.Name}
@@ -53,7 +57,7 @@ const ReadmeEntity = cmp(function ReadmeEntity(props: any) {
 `)
     }
 
-    Content(`Create an instance: \`${entity.name} := client.${entity.Name}(nil)\`
+    Content(`Create an instance: \`${eVar} := client.${entity.Name}(nil)\`
 
 `)
 
@@ -84,7 +88,7 @@ const ReadmeEntity = cmp(function ReadmeEntity(props: any) {
 
       each(fields, (field: any) => {
         const desc = field.short || ''
-        Content(`| \`${field.name}\` | \`${field.type || 'any'}\` | ${desc} |
+        Content(`| \`${field.name}\` | \`${canonToType(field.type, target.name)}\` | ${desc} |
 `)
       })
 
@@ -96,7 +100,11 @@ const ReadmeEntity = cmp(function ReadmeEntity(props: any) {
       Content(`#### Example: Load
 
 \`\`\`go
-result, err := client.${entity.Name}(nil).Load(map[string]any{"id": "${entity.name}_id"}, nil)
+${eVar}, err := client.${entity.Name}(nil).Load(${idF ? `map[string]any{"${idF}": "${entity.name}_id"}` : 'nil'}, nil)
+if err != nil {
+    panic(err)
+}
+fmt.Println(${eVar}) // the loaded record
 \`\`\`
 
 `)
@@ -106,7 +114,11 @@ result, err := client.${entity.Name}(nil).Load(map[string]any{"id": "${entity.na
       Content(`#### Example: List
 
 \`\`\`go
-results, err := client.${entity.Name}(nil).List(nil, nil)
+${eVar}s, err := client.${entity.Name}(nil).List(nil, nil)
+if err != nil {
+    panic(err)
+}
+fmt.Println(${eVar}s) // the array of records
 \`\`\`
 
 `)
@@ -120,7 +132,7 @@ result, err := client.${entity.Name}(nil).Create(map[string]any{
 `)
       each(fields, (field: any) => {
         if ('id' !== field.name && field.req) {
-          Content(`    "${field.name}": /* ${field.type || 'value'} */,
+          Content(`    "${field.name}": /* ${canonToType(field.type, target.name)} */,
 `)
         }
       })