@voxgig/apidef 2.4.1 → 3.1.0

package/src/transform/select.ts

@@ -0,0 +1,119 @@
+
+
+import { each } from 'jostraca'
+
+import type { TransformResult, Transform } from '../transform'
+
+
+import { KIT } from '../types'
+
+import type {
+  KitModel,
+  Guide,
+} from '../types'
+
+import type {
+  PathDef,
+} from '../def'
+
+import type {
+  OpName,
+  ModelOp,
+  ModelEntity,
+  ModelAlt,
+  ModelArg,
+} from '../model'
+
+
+
+const selectTransform: Transform = async function(
+  ctx: any,
+): Promise<TransformResult> {
+  const { apimodel, def, guide } = ctx
+  const kit: KitModel = apimodel.main[KIT]
+
+  let msg = 'select '
+
+  each(kit.entity, (ment: ModelEntity, _entname: string) => {
+    each(ment.op, (mop: ModelOp, _opname: OpName) => {
+      each(mop.alts, (malt: ModelAlt) => {
+        const pdef: PathDef = def.paths[malt.orig]
+        resolveSelect(guide, ment, mop, malt, pdef)
+      })
+      if (null != mop.alts && 0 < mop.alts.length) {
+        sortAlts(guide, ment, mop)
+      }
+    })
+
+    msg += ment.name + ' '
+  })
+
+  return { ok: true, msg }
+}
+
+
+function resolveSelect(
+  guide: Guide,
+  ment: ModelEntity,
+  _mop: ModelOp,
+  malt: ModelAlt,
+  _pdef: PathDef
+) {
+  const select: any = malt.select
+  const margs: any = malt.args
+
+  const argkinds = ['param', 'query', 'header', 'cookie']
+
+  argkinds.map((kind: string) => {
+    each(margs[kind], (marg: ModelArg) => {
+      if (!select.exist.includes(marg.name)) {
+        select.exist.push(marg.name)
+      }
+    })
+  })
+
+  select.exist.sort()
+
+  const gent = guide.entity[ment.name]
+  const gpath = gent.path[malt.orig]
+
+  if (gpath.action) {
+    const actname = Object.keys(gpath.action)[0]
+
+    if (null != actname) {
+      select.$action = actname
+    }
+  }
+
+}
+
+
+function sortAlts(
+  _guide: Guide,
+  _ment: ModelEntity,
+  mop: ModelOp,
+) {
+  mop.alts.sort((a: ModelAlt, b: ModelAlt) => {
+    // longest exist len first
+    let order = b.select.exist.length - a.select.exist.length
+    if (0 === order) {
+      if (null != a.select.$action && null != b.select.$action) {
+        order = a.select.$action < b.select.$action ? -1 :
+          a.select.$action > b.select.$action ? 1 : 0
+      }
+
+      if (0 === order) {
+        const a_exist_str = a.select.exist.join('\t')
+        const b_exist_str = b.select.exist.join('\t')
+        order = a_exist_str < b_exist_str ? -1 :
+          a_exist_str > b_exist_str ? 1 : 0
+      }
+    }
+
+    return order
+  })
+}
+
+export {
+  selectTransform,
+}

package/src/transform/top.ts

@@ -1,18 +1,55 @@
 
-import { each, getx } from 'jostraca'
+import { joinurl } from '@voxgig/struct'
+
+import { KIT } from '../types'
 
 import type { TransformResult } from '../transform'
 
-import { fixName } from '../transform'
+import type {
+  KitModel,
+} from '../types'
+
+import type {
+  // GuidePath,
+  PathDesc,
+  OpDesc,
+} from '../desc'
+
+import type {
+  OpName,
+} from '../model'
+
+
+// Guide* => from guide model
+// *Desc => internal working descriptiuon
+// *Def => API spec definition
+// Model* => Generated SDK Model
+
+
+// type GuideEntity = {
+//   name: string,
+//   path: Record<string, GuidePath>
+
+//   paths$: PathDesc[]
+//   opm$: Record<OpName, OpDesc>
+// }
 
 
 const topTransform = async function(
   ctx: any,
 ): Promise<TransformResult> {
   const { apimodel, def } = ctx
+  const kit: KitModel = apimodel.main[KIT]
+
+  kit.info = def.info
+  kit.info.servers = def.servers ?? []
 
-  apimodel.main.def.info = def.info
-  apimodel.main.def.servers = def.servers
+  // Swagger 2.0
+  if (def.host) {
+    kit.info.servers.push({
+      url: (def.schemes?.[0] ?? 'https') + '://' + joinurl([def.host, def.basePath])
+    })
+  }
 
   return { ok: true, msg: 'top' }
 }
@@ -21,3 +58,8 @@ const topTransform = async function(
 export {
   topTransform
 }
+
+
+// export type {
+//   GuideEntity,
+// }

package/src/transform.ts

@@ -10,6 +10,8 @@ import { Gubu, Child, Exact } from 'gubu'
 import { topTransform } from './transform/top'
 import { entityTransform } from './transform/entity'
 import { operationTransform } from './transform/operation'
+import { argsTransform } from './transform/args'
+import { selectTransform } from './transform/select'
 import { fieldTransform } from './transform/field'
 // import { manualTransform } from './transform/manual'
 
@@ -37,10 +39,10 @@ type TransformResult = {
 
 type Transform = (
   ctx: TransformCtx,
-  guide: Guide,
-  tspec: TransformSpec,
-  apimodel: any,
-  def: any,
+  // guide: Guide,
+  // tspec: TransformSpec,
+  // apimodel: any,
+  // def: any,
 ) => Promise<TransformResult>
 
 type ProcessResult = {
@@ -54,6 +56,8 @@ const TRANSFORM: Record<string, Transform> = {
   top: topTransform,
   entity: entityTransform,
   operation: operationTransform,
+  args: argsTransform,
+  select: selectTransform,
   field: fieldTransform,
   // manual: manualTransform,
 }

package/src/types.ts

@@ -6,10 +6,24 @@ import { Pino, prettyPino } from '@voxgig/util'
 import { Gubu, Open, Any } from 'gubu'
 
 
+const KIT = 'kit'
+
+
 type FsUtil = typeof Fs
 type Log = ReturnType<typeof prettyPino>
 
 
+type TypeName =
+  'String' |
+  'Number' |
+  'Integer' |
+  'Boolean' |
+  'Null' |
+  'Array' |
+  'Object' |
+  'Any'
+
+
 type ApiDefOptions = {
   def?: string
   fs?: any
@@ -19,6 +33,9 @@ type ApiDefOptions = {
   meta?: Record<string, any>
   outprefix?: string
   strategy?: string
+  why?: {
+    show?: boolean
+  }
 }
 
 const ControlShape = Gubu({
@@ -40,7 +57,7 @@ const ModelShape = Gubu({
   name: String,
   def: String,
   main: {
-    sdk: {},
+    [KIT]: {},
     def: {},
     api: {
       guide: {},
@@ -80,21 +97,31 @@ type Build = ReturnType<typeof BuildShape>
 
 type ApiModel = {
   main: {
-    api: {
+    kit: {
+      info: Record<string, any>
       entity: Record<string, any>
+      flow: Record<string, any>
     }
-    def: Record<string, any>
   }
 }
 
 
+type KitModel = {
+  info: Record<string, any>
+  entity: Record<string, any>
+  flow: Record<string, any>
+}
+
+
+
+
 type ApiDefResult = {
   ok: boolean
   start: number
   end: number
   steps: string[]
-  ctrl: Control
-
+  err?: any
+  ctrl?: Control
   guide?: any
   apimodel?: any
   ctx?: any
@@ -102,7 +129,118 @@ type ApiDefResult = {
 }
 
 
+type Metrics = {
+  count: {
+    path: number
+    method: number
+    origcmprefs: Record<string, number>,
+    cmp: number
+    tag: number
+    entity: number
+  }
+  found: {
+    cmp: Record<string, any>,
+    tag: Record<string, any>,
+  }
+}
+
+
+
+type ApiDefContext = {
+  fs: any,
+  log: any,
+  spec: any,
+  opts: any,
+  util: any,
+  defpath: string,
+  model: any,
+  apimodel: any,
+  guide: any,
+  def: any,
+  note: any,
+  warn: any,
+  metrics: Metrics,
+  work: Record<string, any>
+}
+
+
+type Warner = {
+  history: ({ point: string, when: number } & Record<string, any>)[],
+  point: string,
+} & ((details: Record<string, any>) => void)
+
+
+import type {
+  CmpDesc,
+  BasicMethodDesc,
+} from './desc'
+
+type MethodName = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS' | ''
+
+
+
+type Guide = {
+  metrics: GuideMetrics
+  entity: Record<string, GuideEntity>
+  control: GuideControl
+}
+
+type GuideControl = {}
+
+type GuideMetrics = {
+  count: {
+    path: number
+    method: number
+    entity: number
+    tag: number
+    cmp: number
+    origcmprefs: Record<string, number>
+  },
+  found: {
+    tag: Record<string, string>
+    cmp: Record<string, string>
+  }
+}
+
+
+type GuideEntity = {
+  name: string
+  orig: string
+  path: Record<string, GuidePath>
+}
+
+type GuidePath = {
+  why_path: string[]
+  action: Record<string, GuidePathAction>
+  rename: {
+    param: Record<string, GuideRenameParam>
+  }
+  op: Record<string, GuidePathOp>
+}
+
+type GuidePathAction = {
+  kind: string
+  why_action: string[]
+}
+
+type GuideRenameParam = {
+  target: string
+  why_rename: string[]
+}
+
+type GuidePathOp = {
+  method: string
+  why_op: string[]
+  transform: {
+    req: any
+    res: any
+  }
+}
+
+
 export {
+  KIT,
+
   OpenControlShape,
   OpenModelShape,
   OpenBuildShape,
@@ -110,6 +248,18 @@ export {
 
 
 export type {
+  Guide,
+  GuideMetrics,
+  GuideEntity,
+  GuidePath,
+  GuidePathAction,
+  GuideRenameParam,
+  GuidePathOp,
+
+  KitModel,
+
+  MethodName,
+  TypeName,
   Log,
   FsUtil,
   ApiDefOptions,
@@ -118,5 +268,31 @@ export type {
   Model,
   Build,
   ApiModel,
+  ApiDefContext,
+  Warner,
+  Metrics,
 }
 
+export type {
+  CmpDesc,
+  BasicMethodDesc,
+  MethodDesc,
+  MethodEntityDesc,
+  EntityDesc,
+  EntityPathDesc,
+  PathDesc,
+  OpDesc,
+} from './desc'
+
+export type {
+  OpName,
+  ModelEntityRelations,
+  ModelOpMap,
+  ModelFieldOp,
+  ModelField,
+  ModelArg,
+  ModelAlt,
+  ModelOp,
+  ModelEntity,
+} from './model'
+