@voxgig/create-sdkgen 0.0.3 → 0.0.6

package/bin/run-create-sdkgen.js

@@ -1,269 +0,0 @@
-#!/usr/bin/env node
-
-const Path = require('node:path')
-const { statSync } = require('node:fs')
-const { parseArgs } = require('node:util')
-
-const { Gubu, Fault } = require('gubu')
-
-const Pkg = require('../package.json')
-
-const { CreateSdkGen } = require('../dist/create-sdkgen.js') 
-
-// const { Root } = require('../dist/standard/Root')
-const rootpath = require.resolve('../dist/standard/Root')
-
-let DEBUG = false
-let CONSOLE = console
-
-
-try {
-  let options = resolveOptions()
-
-  if(options.debug) {
-    DEBUG = true
-  }
-
-  if(options.version) {
-    version()
-  }
-
-  if(options.help) {
-    help()
-  }
-
-  if(options.version || options.help) {
-    exit()
-  }
-
-  options = validateOptions(options)
-
-  generate(options)
-  
-}
-catch(err) {
-  handleError(err)
-}
-
-
-
-function exit(err) {
-  let code = 0
-  if(err) {
-    code = 1
-  }
-  process.exit(code)
-}
-
-
-function generate(options) {
-  const createSdkGen = CreateSdkGen({
-    folder: options.folder,
-    rootpath
-  })
-
-
-  // TODO: load model
-  
-  const model = {
-    name: options.name,
-    year: new Date().getFullYear(),
-    def: {
-      filepath: options.def || 'def.yml'
-    }
-  }
-
-  model.def.filename = Path.basename(model.def.filepath) 
-  
-  const spec = {
-    // TODO: move to CreateSdkGen options
-    spec: options.spec,
-    model,
-    // root: Root,
-  }
-  
-  if(options.watch) {
-    spec.watch = [
-      '../tm',
-      '../dist',
-    ]
-    createSdkGen.watch(spec)
-  }
-  else {
-    createSdkGen.generate(spec)
-  }
-
-}
-
-
-function resolveOptions() {
-
-  const args = parseArgs({
-    allowPositionals: true,
-    options: {
-      folder: {
-        type: 'string',
-        short: 'f',
-        default: '',
-      },
-      
-      def: {
-        type: 'string',
-        short: 'd',
-        default: '',
-      },
-      
-      model: {
-        type: 'string',
-        short: 'm',
-        default: '',
-      },
-      
-      watch: {
-        type: 'boolean',
-        short: 'w',
-      },
-      
-      debug: {
-        type: 'boolean',
-        short: 'g',
-      },
-      
-      help: {
-        type: 'boolean',
-        short: 'h',
-      },
-      
-      version: {
-        type: 'boolean',
-        short: 'v',
-      },
-      
-    }
-  })
-
-  const options = {
-    name: args.positionals[0],
-    folder: '' === args.values.folder ? args.positionals[0] : args.values.folder,
-    def: args.values.def,
-    model: args.values.model,
-    watch: !!args.values.watch,
-    debug: !!args.values.debug,
-    help: !!args.values.help,
-    version: !!args.values.version,
-  }
-
-  return options
-}
-
-
-function validateOptions(rawOptions) {
-  const optShape = Gubu({
-    name: Fault('The first argument should be the project name.', String),
-    folder: String,
-    def: '',
-    model: '',
-    watch: Boolean,
-    debug: Boolean,
-    help: Boolean,
-    version: Boolean,
-  })
-
-  const err = []
-  const options = optShape(rawOptions,{err})
-
-  if(err[0]) {
-    throw new Error(err[0].text)
-  }
-
-  if('' !== options.def) {
-    options.def = Path.resolve(options.def)
-    const stat = statSync(options.def, {throwIfNoEntry:false})
-    if(null == stat) {
-      throw new Error('Definition file not found: '+options.def)
-    }
-  }
-
-  if('' !== options.model) {
-    options.model = Path.resolve(options.model)
-    const stat = statSync(options.model, {throwIfNoEntry:false})
-    if(null == stat) {
-      throw new Error('Model file not found: '+options.model)
-    }
-  }
-
-  return options
-}
-
-
-function handleError(err) {
-  CONSOLE.log('Voxgig SDK Generator Error:')
-
-  if(DEBUG) {
-    CONSOLE.log(err)
-  }
-  else {
-    CONSOLE.log(err.message)
-  }
-  
-  exit(err)
-}
-
-
-function version() {
-  CONSOLE.log(Pkg.version)
-}
-
-
-function help() {
-  let s = `
-Create a Voxgig SDK Generator project.
-
-Usage: npm create @voxgig/sdkgen@latest <name> <args> 
-
-  where <name> is the name of the SDK project. This is also used to
-    create a project folder if one is not explictly defined using the -f
-    argument. If run against an existing folder generated files will be
-    overwritten.
-
-  <args> are the command arguments:
-
-    --folder <folder>      Specific the folder for the SDK project. Optional.
-    -f <folder>              Default: <name> in current folder.
-
-    --def <file>           Specify the API definition file (OpenAPI, Swagger, etc)
-    -d                       that defines the SDK. Optional.
-
-    --model <file>         Specify the SDK model file to customize the SDK. Optional.
-    -m                       
-
-    --watch                Run in watch mode. The SDK project will be updated if any of the
-    -w                       project inputs (such as the spec file) change.
-
-    --debug                Print verbose logging.
-    -d                       
-
-    --help                 Print this help message.
-    -h
-
-    --version              Print version number.
-    -v
-
-
-Examples:
-
-# Basic usage
-> npm create @voxgig/sdkgen@latest foo
-# Creates the SDK Project in the folder ./foo
-
-
-# Custom project folder
-> npm create @voxgig/sdkgen@latest foo -f ~/Projects/Foo
-# Creates the SDK Project in the folder ~/Projects/Foo
-
-
-See also: https://voxgig.com/sdkgen
-`
-
-  CONSOLE.log(s)
-}

package/bin/run-create-sdkgen.js~

@@ -1 +0,0 @@
-

package/src/standard/ModelSdk.ts~

@@ -1 +0,0 @@
-

package/src/standard/Root.ts~

@@ -1,3 +0,0 @@
-
-
-

package/src/utility.ts

@@ -1,8 +0,0 @@
-
-
-function foo() { }
-
-
-export {
-  foo
-}

package/tm/standard/.env.local

@@ -1,2 +0,0 @@
-$$NAME$$_ENDPOINT=https://api.example.com
-$$NAME$$_APIKEY=apikey

package/tm/standard/build/sdk.js

@@ -1,25 +0,0 @@
-
-const { SdkGen } = require('@voxgig/sdkgen')
-const { Root } = require('../dist/Root')
-
-
-try {
-  const config = {
-    folder: __dirname+'/../sdk',
-    def: __dirname+'/../def/$$def.filename$$',
-    meta: {
-      name: '$$name$$'
-    },
-    model: {
-      folder: __dirname+'/../model',
-      
-      entity: {}
-    },
-  }
-
-  module.exports = SdkGen.makeBuild(Root, config)
-
-}
-catch(e) {
-  console.log('SDK ERROR', e)
-}

package/tm/standard/def/DEFINITION.md

@@ -1,2 +0,0 @@
-# API Definition
- API definition (OpenAPI etc) files live here.

package/tm/standard/model/.model-config/model-config.jsonic

@@ -1,13 +0,0 @@
-
-
-@'@voxgig/model/model/.model-config/model-config.jsonic'
-
-sys: model: builders: {
-  sdk: load: 'build/sdk.js'
-}
-
-sys: model: watch: {
-  'build': {}
-  'dist': {}
-  'tm': {}
-}

package/tm/standard/model/go.jsonic

@@ -1,6 +0,0 @@
-
-title: Go
-
-module: name: '$ModuleName'
-
-options: $.main.sdk.options

package/tm/standard/model/js.jsonic

@@ -1,6 +0,0 @@
-
-title: JavaScript
-
-module: name: '$ModuleName'
-
-options: $.main.sdk.options

package/tm/standard/model/php.jsonic

@@ -1,6 +0,0 @@
-
-title: PHP
-
-module: name: '$ModuleName'
-
-options: $.main.sdk.options

package/tm/standard/model/py.jsonic

@@ -1,7 +0,0 @@
-title: Python
-
-extension: py
-
-module: name: '$ModuleName'
-
-options: $.main.sdk.options

package/tm/standard/model/rb.jsonic

@@ -1,6 +0,0 @@
-
-title: Ruby
-
-module: name: '$ModuleName'
-
-options: $.main.sdk.options

package/tm/standard/model/sdk.jsonic.off

@@ -1,60 +0,0 @@
-
-name: '$$name$$'
-
-@"api.jsonic"
-@"def.jsonic"
-
-main: sdk: build: &: { name: .$KEY }
-
-main: sdk: build: js: @"js.jsonic"
-
-main: sdk: build: rb: @"rb.jsonic"
-
-main: sdk: build: py: @"py.jsonic"
-
-main: sdk: build: php: @"php.jsonic"
-
-main: sdk: build: go: @"go.jsonic"
-
-
-
-main: sdk: test: quick: entity: name: $$test.quick.entity.name$$
-
-
-main: sdk: entity: $.main.api.entity
-
-
-main: sdk: entity: &: {
-  name: .$KEY
-  publish: *true | boolean
-}
-
-
-
-main: sdk: options: &: {
-   name: .$KEY
-   publish: *true | boolean
-}
-
-
-main: sdk: options: {
-
-  endpoint: {
-    kind: *String | string
-    short: "$$Name$$ API URL"
-  }
-
-  apikey: {
-    kind: *String | string
-    short: "$$Name$$ API Key"
-  }
-  
-  fetch: {
-    kind: *Any | string
-    publish: false
-  }
-}
-
-
-
-

package/tm/standard/package.json

@@ -1,30 +0,0 @@
-{
-  "name": "build-$$name$$-sdk",
-  "version": "0.0.1",
-  "description": "",
-  "main": "QQQindex.js",
-  "scripts": {
-    "model": "voxgig-model model/sdk.jsonic",
-    "watch": "tsc --build src -w",
-    "build": "tsc --build src",
-    "test": "echo no-test",
-    "clean": "rm -rf node_modules yarn.lock package-lock.json",
-    "reset": "npm run clean && npm i && npm run build && npm test",
-    "mock-server": "prism mock def/$DefinitionFile"
-  },
-  "author": "",
-  "license": "MIT",
-  "overrides": {
-    "@stoplight/prism-cli": {
-      "@stoplight/json": "3.21.0"
-    }
-  },
-  "devDependencies": {
-    "@voxgig/model": "^3.2.0",
-    "@voxgig/sdkgen": "^0.6.0",
-    "@voxgig/util": "^0.0.3",
-    "@types/node": "22.5.4",
-    "@stoplight/prism-cli": "^5.9.0",
-    "typescript": "^5.5.4"
-  }
-}

package/tm/standard/src/Root.ts

@@ -1,60 +0,0 @@
-
-import {
-  names,
-  cmp,
-  each,
-
-  Project,
-  Folder,
-
-  Main,
-  Entity,
-  Readme,
-
-} from '@voxgig/sdkgen'
-
-// import { Readme } from './Readme'
-// import { Main } from './Main'
-// import { Entity } from './Entity'
-
-
-const Root = cmp(function Root(props: any) {
-  const { model, ctx$ } = props
-
-  names(model, model.name)
-
-  // console.dir(model, { depth: null })
-
-  ctx$.model = model
-
-  const build = model.main.sdk.build
-  const entity = model.main.sdk.entity
-
-  Project({}, () => {
-
-    each(build, (build: any) => {
-      names(build, build.name)
-      // console.log('BUILD', build.name)
-
-      Folder({ name: build.name }, () => {
-
-        each(entity, (entity: any) => {
-          names(entity, entity.name)
-          // console.log('ENTITY', entity.name)
-
-          Entity({ build, entity })
-        })
-
-        Main({ build })
-
-        Readme({ build })
-      })
-    })
-  })
-})
-
-
-export {
-  Root
-}
-