@voxgig/sdkgen 3.5.1 → 3.6.0

package/project/.sdk/src/cmp/js/Test_js.ts

@@ -1,14 +1,9 @@
 
-import {
-  KIT,
-  getModelPath
-} from '@voxgig/apidef'
-
 import type {
   ModelEntity
 } from '@voxgig/apidef'
 
-import { cmp, each, Folder } from '@voxgig/sdkgen'
+import { cmp, each, Folder, entityCollection } from '@voxgig/sdkgen'
 
 
 import { TestDirect } from './TestDirect_js'
@@ -22,7 +17,9 @@ const Test = cmp(function Test(props: any) {
   Folder({ name: 'test' }, () => {
 
     Folder({ name: 'entity' }, () => {
-      each(model.main[KIT].entity, (entity: ModelEntity) => {
+      const entity = each(entityCollection(model))
+        .filter((e: any) => false !== e.active)
+      each(entity, (entity: ModelEntity) => {
         TestEntity({ target, entity })
         TestDirect({ target, entity })
       })

package/project/.sdk/src/cmp/kotlin/Test_kotlin.ts

@@ -1,14 +1,9 @@
 
-import {
-  KIT,
-  getModelPath
-} from '@voxgig/apidef'
-
 import type {
   ModelEntity
 } from '@voxgig/apidef'
 
-import { cmp, each, Folder } from '@voxgig/sdkgen'
+import { cmp, each, Folder, entityCollection } from '@voxgig/sdkgen'
 
 
 import { TestEntity } from './TestEntity_kotlin'
@@ -30,7 +25,9 @@ const Test = cmp(function Test(props: any) {
     // CustomUtilityTest, StructRunner/StructCorpusTest, ExistsTest and
     // sdk-test-control.json) ships as templates in tm/kotlin/test/ and is
     // copied by Main_kotlin. Here we generate only the API-specific tests.
-    each(model.main[KIT].entity, (entity: ModelEntity) => {
+    const entity = each(entityCollection(model))
+      .filter((e: any) => false !== e.active)
+    each(entity, (entity: ModelEntity) => {
       TestEntity({ target, entity, kotlinpackage })
       TestDirect({ target, entity, kotlinpackage })
     })

package/project/.sdk/src/cmp/lean/Test_lean.ts

@@ -4,12 +4,11 @@ import {
   Folder,
   cmp,
   each,
+  entityCollection,
 } from '@voxgig/sdkgen'
 
 import {
-  KIT,
   Model,
-  getModelPath,
 } from '@voxgig/apidef'
 
 
@@ -70,7 +69,8 @@ const Test = cmp(async function Test(props: any) {
   const target = props.target
   const model: Model = ctx$.model
 
-  const entity = getModelPath(model, `main.${KIT}.entity`)
+  const entity = each(entityCollection(model))
+    .filter((e: any) => false !== e.active)
 
   // Per-entity OFFLINE (test-mode) blocks: seeded store, no server.
   let offline = ''

package/project/.sdk/src/cmp/lua/Package_lua.ts

@@ -27,7 +27,7 @@ const Package = cmp(async function Package(props: any) {
   // (`${model.name}_sdk`) used by `require` is unchanged.
   const ns = model.origin || 'voxgig-sdk'
   const pkgBase = ns.endsWith('-sdk') ? model.name : `${model.name}-sdk`
-  const rockName = packageName(model, 'lua')
+  const rockName = packageName(model, target.name)
   const { repoUrl, issuesUrl } = repoInfo(model)
   const labels = keywords(model).map((k) => `"${k}"`).join(', ')
 
@@ -46,7 +46,7 @@ source = {
   dir = "${model.name}-sdk/lua"
 }
 description = {
-  summary = "${pkgDescription(model, 'lua')}",
+  summary = "${pkgDescription(model, target.name)}",
   homepage = "${repoUrl}",
   issues_url = "${issuesUrl}",
   license = "MIT",

package/project/.sdk/src/cmp/lua/Test_lua.ts

@@ -1,14 +1,9 @@
 
-import {
-  KIT,
-  getModelPath
-} from '@voxgig/apidef'
-
 import type {
   ModelEntity
 } from '@voxgig/apidef'
 
-import { cmp, each, Folder, File, Content } from '@voxgig/sdkgen'
+import { cmp, each, Folder, File, Content, entityCollection } from '@voxgig/sdkgen'
 
 
 import { TestEntity } from './TestEntity_lua'
@@ -37,7 +32,10 @@ end)
 `)
     })
 
-    each(model.main[KIT].entity, (entity: ModelEntity) => {
+    const entity = each(entityCollection(model))
+      .filter((e: any) => false !== e.active)
+
+    each(entity, (entity: ModelEntity) => {
       TestEntity({ target, entity })
       TestDirect({ target, entity })
     })

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

@@ -1,14 +1,9 @@
 
-import {
-  KIT,
-  getModelPath,
-} from '@voxgig/apidef'
-
 import type {
   ModelEntity
 } from '@voxgig/apidef'
 
-import { cmp, each, Folder } from '@voxgig/sdkgen'
+import { cmp, each, Folder, entityCollection } from '@voxgig/sdkgen'
 
 
 import { TestEntity } from './TestEntity_ocaml'
@@ -20,7 +15,8 @@ const Test = cmp(function Test(props: any) {
   const { model } = props.ctx$
   const { target } = props
 
-  const entity = getModelPath(model, `main.${KIT}.entity`)
+  const entity = each(entityCollection(model))
+    .filter((e: any) => false !== e.active)
 
   Folder({ name: 'test' }, () => {
     each(entity, (entity: ModelEntity) => {

package/project/.sdk/src/cmp/perl/Package_perl.ts

@@ -48,7 +48,7 @@ use ExtUtils::MakeMaker;
 WriteMakefile(
     NAME             => '${Name}SDK',
     VERSION_FROM     => 'lib/${Name}SDK.pm',
-    ABSTRACT         => '${pkgDescription(model, 'perl')}',
+    ABSTRACT         => '${pkgDescription(model, target.name)}',
     AUTHOR           => 'Voxgig',
     LICENSE          => 'mit',
     MIN_PERL_VERSION => '5.018',

package/project/.sdk/src/cmp/perl/Test_perl.ts

@@ -1,14 +1,9 @@
 
-import {
-  KIT,
-  getModelPath
-} from '@voxgig/apidef'
-
 import type {
   ModelEntity
 } from '@voxgig/apidef'
 
-import { cmp, each, Folder, File, Content } from '@voxgig/sdkgen'
+import { cmp, each, Folder, File, Content, entityCollection } from '@voxgig/sdkgen'
 
 
 import { TestEntity } from './TestEntity_perl'
@@ -42,7 +37,10 @@ done_testing();
 `)
     })
 
-    each(model.main[KIT].entity, (entity: ModelEntity) => {
+    const entity = each(entityCollection(model))
+      .filter((e: any) => false !== e.active)
+
+    each(entity, (entity: ModelEntity) => {
       TestEntity({ target, entity })
       TestDirect({ target, entity })
     })

package/project/.sdk/src/cmp/php/EntityTypes_php.ts

@@ -29,7 +29,7 @@ import {
   File, Content, Folder,
 } from '@voxgig/sdkgen'
 
-import { canonToType, opTypeName, opRequestShape, warnEntityTypeCollisions , deriveEntityNames } from '@voxgig/sdkgen'
+import { canonToType, opTypeName, opRequestShape, warnEntityTypeCollisions , deriveEntityNames, phpSafeTypeName } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -114,9 +114,20 @@ declare(strict_types=1);
         const fields = (ent.fields ? each(ent.fields) : [])
           .filter((f: any) => f.active !== false && validName(f.name))
 
+        // PHP refuses a reserved word where a class name is expected, and the
+        // check is CASE-INSENSITIVE — an entity named `Namespace` emitted
+        // `class Namespace`, which does not parse, and took the whole types
+        // file with it (issue #64). phpSafeTypeName appends `Type` on a real
+        // collision and leaves every other name untouched.
+        //
+        // Only the bare data class needs it: the per-op names below already
+        // carry a suffix no reserved word matches, and the entity accessor is
+        // a method, which PHP resolves separately.
+        const TypeName = phpSafeTypeName(Name)
+
         // Entity data model: one typed property per field (`req:false` -> nullable).
         Content(`/** ${Name} entity data model. */
-class ${Name}
+class ${TypeName}
 {
 `)
         fields.forEach((f: any) => {

package/project/.sdk/src/cmp/php/Package_php.ts

@@ -39,8 +39,8 @@ const Package = cmp(async function Package(props: any) {
   // Generate composer.json
   File({ name: 'composer.json' }, () => {
     Content(`{
-  "name": "${packageName(model, 'php')}",
-  "description": "${pkgDescription(model, 'php')}",
+  "name": "${packageName(model, target.name)}",
+  "description": "${pkgDescription(model, target.name)}",
   "type": "library",
   "keywords": [${kw}],
   "homepage": "${repoUrl}",

package/project/.sdk/src/cmp/php/Test_php.ts

@@ -1,14 +1,9 @@
 
-import {
-  KIT,
-  getModelPath
-} from '@voxgig/apidef'
-
 import type {
   ModelEntity
 } from '@voxgig/apidef'
 
-import { cmp, each, Folder, File, Content } from '@voxgig/sdkgen'
+import { cmp, each, Folder, File, Content, entityCollection } from '@voxgig/sdkgen'
 
 
 import { TestEntity } from './TestEntity_php'
@@ -44,7 +39,10 @@ class ExistsTest extends TestCase
 `)
     })
 
-    each(model.main[KIT].entity, (entity: ModelEntity) => {
+    const entity = each(entityCollection(model))
+      .filter((e: any) => false !== e.active)
+
+    each(entity, (entity: ModelEntity) => {
       TestEntity({ target, entity })
       TestDirect({ target, entity })
     })

package/project/.sdk/src/cmp/py/Package_py.ts

@@ -27,7 +27,7 @@ const Package = cmp(async function Package(props: any) {
   // package (the `${model.name}_sdk/` dir) is unchanged.
   const ns = model.origin || 'voxgig-sdk'
   const pkgBase = ns.endsWith('-sdk') ? model.name : `${model.name}-sdk`
-  const distName = packageName(model, 'py')
+  const distName = packageName(model, target.name)
   const { repoUrl, issuesUrl } = repoInfo(model)
   const kw = keywords(model).map((k) => `"${k}"`).join(', ')
 
@@ -39,7 +39,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "${distName}"
 version = "${packageVersion(model, target.name)}"
-description = "${pkgDescription(model, 'py')}"
+description = "${pkgDescription(model, target.name)}"
 readme = "README.md"
 license = "MIT"
 requires-python = ">=3.8"

package/project/.sdk/src/cmp/py/Test_py.ts

@@ -1,14 +1,9 @@
 
-import {
-  KIT,
-  getModelPath
-} from '@voxgig/apidef'
-
 import type {
   ModelEntity
 } from '@voxgig/apidef'
 
-import { cmp, each, Folder, File, Content } from '@voxgig/sdkgen'
+import { cmp, each, Folder, File, Content, entityCollection } from '@voxgig/sdkgen'
 
 
 import { TestEntity } from './TestEntity_py'
@@ -46,7 +41,10 @@ class TestExists:
 `)
     })
 
-    each(model.main[KIT].entity, (entity: ModelEntity) => {
+    const entity = each(entityCollection(model))
+      .filter((e: any) => false !== e.active)
+
+    each(entity, (entity: ModelEntity) => {
       TestEntity({ target, entity })
       TestDirect({ target, entity })
     })

package/project/.sdk/src/cmp/py-data/Main_py-data.ts

@@ -111,9 +111,9 @@ const Main = cmp(function Main(props: any) {
   Gitignore({})
   Package({ target, model, lower, dataModule })
   EntityFramesTest({ frameEnts, seriesEnts, lower, sdkModule, sdkClass, dataModule })
-  Readme({ model, name, lower, ENV, dataModule, frameEnts, seriesEnts, needsBase, svars })
+  Readme({ target, model, name, lower, ENV, dataModule, frameEnts, seriesEnts, needsBase, svars })
   AgentGuide({ model, name, lower, ENV, dataModule, frameEnts, seriesEnts, needsBase })
-  Quickstart({ model, name, lower, ENV, dataModule, frameEnts, needsBase })
+  Quickstart({ target, model, name, lower, ENV, dataModule, frameEnts, needsBase })
 })
 
 
@@ -136,6 +136,8 @@ const Package = cmp(function Package(props: any) {
   const ns = model.origin || 'voxgig-sdk'
   const pkgBase = ns.endsWith('-sdk') ? model.name : `${model.name}-sdk`
   const distName = `${ns}-${pkgBase}-data`
+  // The `py` SDK this package WRAPS — a different target, so it keeps its
+  // own name and does not follow this target's alias.
   const sdkDist = packageName(model, 'py')
   const { repoUrl, issuesUrl } = repoInfo(model)
   const kw = keywords(model).concat(['pandas', 'dataframe', 'notebook', 'colab'])
@@ -149,7 +151,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "${distName}"
 version = "${packageVersion(model, target.name)}"
-description = "${pkgDescription(model, 'py-data')}"
+description = "${pkgDescription(model, target.name)}"
 readme = "README.md"
 license = "MIT"
 requires-python = ">=3.9"
@@ -599,18 +601,18 @@ class TestFramesAgainstTestMode:
 // ---------------------------------------------------------------------------
 
 const Readme = cmp(function Readme(props: any) {
-  const { model, name, ENV, dataModule, frameEnts, seriesEnts, needsBase } = props
+  const { target, model, name, ENV, dataModule, frameEnts, seriesEnts, needsBase } = props
   const ctx$ = props.ctx$
 
-  const distName = pyDistName(model)
+  const distName = packageName(model, target.name)
   const sdkDist = packageName(model, 'py')
-  const pending = 'active' !== registryState(model, 'py-data')
+  const pending = 'active' !== registryState(model, target.name)
   const { repoUrl, releasesUrl } = repoInfo(model)
 
   const install = pending
     ? `# Not yet on PyPI — install both packages from this repo:
 !pip install "git+${repoUrl}#subdirectory=py" \\
-             "git+${repoUrl}#subdirectory=py-data"`
+             "git+${repoUrl}#subdirectory=${target.name}"`
     : `!pip install ${distName}`
 
   const first = frameEnts[0]
@@ -666,7 +668,7 @@ from the repo — in a notebook, prefix with \`!\`:
 
 \`\`\`sh
 pip install "git+${repoUrl}#subdirectory=py" \\
-            "git+${repoUrl}#subdirectory=py-data"
+            "git+${repoUrl}#subdirectory=${target.name}"
 \`\`\`
 
 Released versions are tagged at ${releasesUrl}.`
@@ -841,15 +843,15 @@ are overwritten. Change the model and regenerate.
 // A runnable Colab notebook. .ipynb is just JSON; keeping outputs empty means
 // the file is diffable and CI can execute it as a smoke test.
 const Quickstart = cmp(function Quickstart(props: any) {
-  const { model, name, ENV, dataModule, frameEnts, needsBase } = props
+  const { target, model, name, ENV, dataModule, frameEnts, needsBase } = props
 
   const { repoUrl } = repoInfo(model)
-  const pending = 'active' !== registryState(model, 'py-data')
-  const distName = pyDistName(model)
+  const pending = 'active' !== registryState(model, target.name)
+  const distName = packageName(model, target.name)
 
   const installCode = pending
     ? [`!pip install -q "git+${repoUrl}#subdirectory=py" \\`,
-    `                "git+${repoUrl}#subdirectory=py-data"`]
+    `                "git+${repoUrl}#subdirectory=${target.name}"`]
     : [`!pip install -q ${distName}`]
 
   const first = frameEnts[0]
@@ -976,13 +978,6 @@ function exampleGroupField(fields: { name: string, dtype: string, req: boolean }
 }
 
 
-function pyDistName(model: any): string {
-  const ns = model.origin || 'voxgig-sdk'
-  const pkgBase = ns.endsWith('-sdk') ? model.name : `${model.name}-sdk`
-  return `${ns}-${pkgBase}-data`
-}
-
-
 export {
   Main,
 }

package/project/.sdk/src/cmp/rb/Package_rb.ts

@@ -33,7 +33,7 @@ const Package = cmp(async function Package(props: any) {
   // path (`${model.name}_sdk`) is unchanged.
   const ns = model.origin || 'voxgig-sdk'
   const pkgBase = ns.endsWith('-sdk') ? model.name : `${model.name}-sdk`
-  const gemName = packageName(model, 'rb')
+  const gemName = packageName(model, target.name)
   const { repoUrl, issuesUrl, changelogUrl } = repoInfo(model)
 
   const versionOf = (d: { version: string; source: 'feature' | 'target' }) =>
@@ -66,8 +66,8 @@ gemspec
   spec.name          = "${gemName}"
   spec.version       = "${packageVersion(model, target.name)}"
   spec.authors       = ["${author.name}"]
-  spec.summary       = "${pkgDescription(model, 'rb')}"
-  spec.description   = "${pkgDescription(model, 'rb')}"
+  spec.summary       = "${pkgDescription(model, target.name)}"
+  spec.description   = "${pkgDescription(model, target.name)}"
   spec.license       = "MIT"
   spec.homepage      = "${repoUrl}"
   spec.metadata      = {

package/project/.sdk/src/cmp/rb/ReadmeInstall_rb.ts

@@ -14,7 +14,7 @@ ${installCommand(model, target.name)}
 Or add to your \`Gemfile\`:
 
 \`\`\`ruby
-gem "${packageName(model, 'gem')}"
+gem "${packageName(model, target.name)}"
 \`\`\`
 
 Then run:

package/project/.sdk/src/cmp/rb/Test_rb.ts

@@ -1,14 +1,9 @@
 
-import {
-  KIT,
-  getModelPath
-} from '@voxgig/apidef'
-
 import type {
   ModelEntity
 } from '@voxgig/apidef'
 
-import { cmp, each, Folder, File, Content } from '@voxgig/sdkgen'
+import { cmp, each, Folder, File, Content, entityCollection } from '@voxgig/sdkgen'
 
 
 import { TestEntity } from './TestEntity_rb'
@@ -38,7 +33,10 @@ end
 `)
     })
 
-    each(model.main[KIT].entity, (entity: ModelEntity) => {
+    const entity = each(entityCollection(model))
+      .filter((e: any) => false !== e.active)
+
+    each(entity, (entity: ModelEntity) => {
       TestEntity({ target, entity })
       TestDirect({ target, entity })
     })

package/project/.sdk/src/cmp/rust/Test_rust.ts

@@ -1,14 +1,9 @@
 
-import {
-  KIT,
-  getModelPath
-} from '@voxgig/apidef'
-
 import type {
   ModelEntity
 } from '@voxgig/apidef'
 
-import { cmp, each, Folder, File, Content } from '@voxgig/sdkgen'
+import { cmp, each, Folder, File, Content, entityCollection } from '@voxgig/sdkgen'
 
 
 import { TestEntity } from './TestEntity_rust'
@@ -39,7 +34,10 @@ fn exists_test_mode() {
 `)
     })
 
-    each(model.main[KIT].entity, (entity: ModelEntity) => {
+    const entity = each(entityCollection(model))
+      .filter((e: any) => false !== e.active)
+
+    each(entity, (entity: ModelEntity) => {
       TestEntity({ target, entity, rustcrate })
       TestDirect({ target, entity, rustcrate })
     })

package/project/.sdk/src/cmp/scala/Test_scala.ts

@@ -9,7 +9,7 @@ import type {
   ModelEntity
 } from '@voxgig/apidef'
 
-import { cmp, each, Folder, File, Content } from '@voxgig/sdkgen'
+import { cmp, each, Folder, File, Content, entityCollection } from '@voxgig/sdkgen'
 
 
 import { TestEntity } from './TestEntity_scala'
@@ -33,7 +33,10 @@ const Test = cmp(function Test(props: any) {
 
     const entities: { Name: string; entity: boolean; direct: boolean }[] = []
 
-    each(model.main[KIT].entity, (entity: ModelEntity) => {
+    const entity = each(entityCollection(model))
+      .filter((e: any) => false !== e.active)
+
+    each(entity, (entity: ModelEntity) => {
       const EntityName = nom(entity, 'Name')
 
       const basicflow: any =

package/project/.sdk/src/cmp/seneca-provider/Gitignore_seneca-provider.ts

@@ -0,0 +1,161 @@
+// The provider repo's `.gitignore` — GENERATED, not templated, and it has
+// to be.
+//
+// npm NEVER publishes a file named `.gitignore`. It sits on npm's own
+// always-excluded list, and naming the parent directory in package.json
+// `files` does not override it: `npm pack --dry-run` on this package omits
+// `project/.sdk/tm/seneca-provider/.gitignore` while shipping every sibling
+// in that folder. So the template worked from a checkout and reached NOBODY
+// who installed @voxgig/sdkgen from the registry — their generated provider
+// had no ignore file, and the very first regeneration left the repo dirty
+// with the `.jostraca/` output duplicate this content exists to hide.
+//
+// Every one of the 23 language targets already emits its `.gitignore` from a
+// `Gitignore_<lang>.ts` for this same reason. seneca-provider was the only
+// target still doing it with a template, and the only one npm could break.
+//
+// `packaging.test.ts` asks npm directly whether every shipped file survives
+// packing, so the next dotfile added to the scaffold cannot repeat this.
+//
+// The content below is the template's, byte for byte. It carried no
+// placeholder, so nothing about `stdrep` substitution changes by moving it.
+
+import {
+  Content,
+  File,
+  cmp,
+} from '@voxgig/sdkgen'
+
+
+const Gitignore = cmp(async function Gitignore(_props: any) {
+  File({ name: '.gitignore' }, () => {
+    Content(`# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+*~
+
+package-lock.json
+yarn.lock
+
+test/local-config.js
+test/local-env.js
+# TypeScript build info
+*.tsbuildinfo
+.tsbuildinfo/
+
+# Generator bookkeeping. This package is GENERATED into this repo by
+# @voxgig/sdkgen from the SDK project, and jostraca drops its meta log plus a
+# full duplicate of the last generated output here on every run. The SDK repo
+# commits its own copy; this repo has no reason to, and without this line
+# every regeneration leaves the provider repo dirty with hundreds of
+# untracked files.
+.jostraca/
+`)
+  })
+})
+
+
+export {
+  Gitignore
+}