@voxgig/sdkgen 1.3.14 → 1.3.17

package/project/.sdk/src/cmp/haskell/ReadmeQuick_haskell.ts

@@ -0,0 +1,237 @@
+
+import { cmp, Content, isAuthActive, envName, canonKey, opRequestShape, entityIdField, entityOps } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+  nom,
+} from '@voxgig/apidef'
+
+import { hsVarName } from './utility_haskell'
+
+
+// A type-correct Haskell `Value` literal for a param. List/object params fall
+// back to VNoval (they cannot be built as a pure literal inside `jo`); scalars
+// use the matching constructor.
+function hsLit(type: any, placeholder: string = 'example'): string {
+  const k = canonKey(type)
+  if ('INTEGER' === k || 'NUMBER' === k) return 'VNum 1'
+  if ('BOOLEAN' === k) return 'VBool True'
+  if ('ARRAY' === k || 'OBJECT' === k) return 'VNoval'
+  return `VStr "${placeholder}"`
+}
+
+
+const ReadmeQuick = cmp(function ReadmeQuick(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
+
+  // Find a nested entity if available: one with a parent chain
+  // (relations.ancestors), an active load op, and a required non-id load
+  // param to demonstrate (the parent key, e.g. page_id).
+  const nestedEntity = Object.values(entity).find((e: any) =>
+    e.active !== false &&
+    e.relations && e.relations.ancestors && 0 < e.relations.ancestors.length &&
+    entityOps(e).includes('load') &&
+    opRequestShape(e, 'load').items.some((it: any) =>
+      !it.optional && it.name !== entityIdField(e))
+  ) as any
+
+  const authActive = isAuthActive(model)
+
+  Content(`### 1. Create a client
+
+\`\`\`haskell
+`)
+  if (authActive) {
+    Content(`import System.Environment (lookupEnv)
+import qualified SdkClient as Sdk
+import VoxgigStruct (Value (..), emptyMap)
+import SdkHelpers (jo)
+
+main :: IO ()
+main = do
+  mkey <- lookupEnv "${envName(model)}_APIKEY"
+  opts <- jo [("apikey", maybe VNoval VStr mkey)]
+  sdk <- Sdk.newSdk opts
+`)
+  }
+  else {
+    Content(`import qualified SdkClient as Sdk
+import VoxgigStruct (Value (..), emptyMap)
+import SdkHelpers (jo)
+
+main :: IO ()
+main = do
+  sdk <- Sdk.newSdk0
+`)
+  }
+  Content(`\`\`\`
+
+Entity operations raise on error (via \`Control.Exception.throwIO\`) and
+return the bare result \`Value\`. Wrap a call in \`Control.Exception.try\`
+to recover from failures.
+
+`)
+
+  if (exampleEntity) {
+    const eName = nom(exampleEntity, 'Name')
+    const article = /^[aeiou]/i.test(eName) ? 'an' : 'a'
+    const eFn = hsVarName(exampleEntity.name)
+    const opnames = entityOps(exampleEntity)
+    // Model-driven id key: `idF` is the entity's id-like MATCH field name, or
+    // null when it has none. `dataIdF` is the id on the RETURNED record's data
+    // type.
+    const idF = entityIdField(exampleEntity)
+
+    if (opnames.includes('list')) {
+      Content(`### 2. List ${eName.toLowerCase()} records
+
+\`eList ent match ctrl\` returns a list \`Value\` and raises on error.
+
+\`\`\`haskell
+  ent <- Sdk.${eFn} sdk VNoval
+  match <- emptyMap
+  ctrl <- emptyMap
+  ${eFn}s <- Sdk.eList ent match ctrl
+  print ${eFn}s
+\`\`\`
+
+`)
+    }
+
+    if (nestedEntity) {
+      const neName = nom(nestedEntity, 'Name')
+      const neArticle = /^[aeiou]/i.test(neName) ? 'an' : 'a'
+      const neFn = hsVarName(nestedEntity.name)
+
+      const neIdF = entityIdField(nestedEntity)
+      const neRequired = opRequestShape(nestedEntity, 'load').items
+        .filter((it: any) => !it.optional)
+        .sort((a: any, b: any) =>
+          (a.name === neIdF ? 1 : 0) - (b.name === neIdF ? 1 : 0))
+      const parentItem = neRequired.find((it: any) => it.name !== neIdF) as any
+      const parentParam = parentItem && parentItem.name
+      const parentName = parentParam ? parentParam.replace(/_id$/, '') : 'its parent'
+      const neMatch = neRequired.map((it: any) =>
+        `("${it.name}", ${hsLit(it.type,
+          it.name === neIdF ? 'example_id' : 'example_' + it.name)})`)
+
+      Content(`### 3. Load ${neArticle} ${neName.toLowerCase()}
+
+${neName} is nested under ${parentName}, so provide the \`${parentParam}\`.
+\`eLoad\` returns the bare record and raises on error.
+
+\`\`\`haskell
+  ${neFn}Ent <- Sdk.${neFn} sdk VNoval
+  m <- jo [${neMatch.join(', ')}]
+  ctrl2 <- emptyMap
+  ${neFn} <- Sdk.eLoad ${neFn}Ent m ctrl2
+  print ${neFn}
+\`\`\`
+
+`)
+    }
+    else if (opnames.includes('load')) {
+      const loadRequired = opRequestShape(exampleEntity, 'load').items
+        .filter((it: any) => !it.optional || it.name === idF)
+        .sort((a: any, b: any) =>
+          (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+      const loadArg = 0 < loadRequired.length
+        ? `[${loadRequired.map((it: any) =>
+          `("${it.name}", ${hsLit(it.type,
+            it.name === idF ? 'example_id' : 'example_' + it.name)})`).join(', ')}]`
+        : '[]'
+
+      Content(`### 3. Load ${article} ${eName.toLowerCase()}
+
+\`eLoad ent match ctrl\` returns the bare record and raises on error.
+
+\`\`\`haskell
+  ent2 <- Sdk.${eFn} sdk VNoval
+  m <- jo ${loadArg}
+  ctrl2 <- emptyMap
+  ${eFn} <- Sdk.eLoad ent2 m ctrl2
+  print ${eFn}
+\`\`\`
+
+`)
+    }
+
+    // Model-driven example fields: derive the create/update body from the op
+    // shape so the docs reference REAL writable fields.
+    const examplePairs = (opname: string): string[] => {
+      const items = opRequestShape(exampleEntity, opname).items
+        .filter((it: any) => (it.name !== idF && it.name !== 'id') ||
+          ('create' === opname && !it.optional))
+      const required = items.filter((it: any) => !it.optional)
+      const optional = items.filter((it: any) => it.optional)
+      const chosen = 'create' === opname
+        ? (required.length ? required : items.slice(0, 2))
+        : required.concat(optional).slice(0, Math.max(2, required.length))
+      return chosen.map((it: any) => `("${it.name}", ${hsLit(it.type, 'example_' + it.name)})`)
+    }
+
+    const idParamType = (opname: string): any => {
+      const it = opRequestShape(exampleEntity, opname).items.find((x: any) => x.name === idF)
+      return it && it.type
+    }
+    const idValueFor = (opname: string): string =>
+      hsLit(idParamType(opname), 'example_id')
+
+    if (opnames.includes('create') || opnames.includes('update') || opnames.includes('remove')) {
+      Content(`### 4. Create, update, and remove
+
+`)
+      if (opnames.includes('create')) {
+        Content(`\`\`\`haskell
+  createEnt <- Sdk.${eFn} sdk VNoval
+  d <- jo [${examplePairs('create').join(', ')}]
+  cctrl <- emptyMap
+  created <- Sdk.eCreate createEnt d cctrl
+  print created
+\`\`\`
+
+`)
+      }
+      if (opnames.includes('update')) {
+        const updatePairs = (idF ? [`("${idF}", ${idValueFor('update')})`] : []).concat(examplePairs('update'))
+        Content(`\`\`\`haskell
+  updateEnt <- Sdk.${eFn} sdk VNoval
+  upd <- jo [${updatePairs.join(', ')}]
+  uctrl <- emptyMap
+  updated <- Sdk.eUpdate updateEnt upd uctrl
+  print updated
+\`\`\`
+
+`)
+      }
+      if (opnames.includes('remove')) {
+        const removePairs = opRequestShape(exampleEntity, 'remove').items
+          .filter((it: any) => !it.optional || it.name === idF)
+          .sort((a: any, b: any) =>
+            (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+          .map((it: any) => it.name === idF
+            ? `("${it.name}", ${idValueFor('remove')})`
+            : `("${it.name}", ${hsLit(it.type, 'example_' + it.name)})`)
+        Content(`\`\`\`haskell
+  removeEnt <- Sdk.${eFn} sdk VNoval
+  rm <- jo [${removePairs.length ? removePairs.join(', ') : ''}]
+  rctrl <- emptyMap
+  _ <- Sdk.eRemove removeEnt rm rctrl
+  return ()
+\`\`\`
+
+`)
+      }
+    }
+  }
+})
+
+
+export {
+  ReadmeQuick
+}

package/project/.sdk/src/cmp/haskell/ReadmeRef_haskell.ts

@@ -0,0 +1,405 @@
+
+import { cmp, each, Content, canonKey, File, isAuthActive, entityIdField, opRequestShape } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+import { hsVarName } from './utility_haskell'
+
+
+// A type-correct Haskell `Value` literal for a field's canonical type.
+function hsLit(type: any, placeholder: string = 'example'): string {
+  const k = canonKey(type)
+  if ('INTEGER' === k || 'NUMBER' === k) return 'VNum 1'
+  if ('BOOLEAN' === k) return 'VBool True'
+  if ('ARRAY' === k || 'OBJECT' === k) return 'VNoval'
+  return `VStr "${placeholder}"`
+}
+
+
+// A readable Haskell type name for a field's canonical type.
+function hsType(type: any): string {
+  const k = canonKey(type)
+  if ('STRING' === k) return 'String'
+  if ('INTEGER' === k) return 'Int'
+  if ('NUMBER' === k) return 'Double'
+  if ('BOOLEAN' === k) return 'Bool'
+  if ('ARRAY' === k) return '[Value]'
+  return 'Value'
+}
+
+
+const OP_SIGNATURES: Record<string, { sig: string, returns: string, desc: string }> = {
+  load: {
+    sig: 'eLoad ent match ctrl :: IO Value',
+    returns: 'the entity data',
+    desc: 'Load a single entity matching the given criteria. Returns the entity data and raises on error.',
+  },
+  list: {
+    sig: 'eList ent match ctrl :: IO Value',
+    returns: 'a list of entities',
+    desc: 'List entities matching the given criteria. The match is optional — pass an empty map to list all records. Returns a list `Value` and raises on error.',
+  },
+  create: {
+    sig: 'eCreate ent data ctrl :: IO Value',
+    returns: 'the created entity data',
+    desc: 'Create a new entity with the given data. Returns the created entity data and raises on error.',
+  },
+  update: {
+    sig: 'eUpdate ent data ctrl :: IO Value',
+    returns: 'the updated entity data',
+    desc: 'Update an existing entity. The data must include the entity `id`. Returns the updated entity data and raises on error.',
+  },
+  remove: {
+    sig: 'eRemove ent match ctrl :: IO Value',
+    returns: 'the removed entity data',
+    desc: 'Remove the entity matching the given criteria. Raises on error.',
+  },
+}
+
+
+const ReadmeRef = cmp(function ReadmeRef(props: any) {
+  const { target } = props
+  const { model } = props.ctx$
+
+  const entity = getModelPath(model, `main.${KIT}.entity`)
+  const feature = getModelPath(model, `main.${KIT}.feature`)
+
+  const publishedEntities = each(entity).filter((e: any) => e.active !== false)
+
+
+  File({ name: 'REFERENCE.md' }, () => {
+
+    Content(`# ${model.Name} ${target.title} SDK Reference
+
+Complete API reference for the ${model.Name} ${target.title} SDK.
+
+
+## Client
+
+### Constructors
+
+\`\`\`haskell
+import qualified SdkClient as Sdk
+import VoxgigStruct (Value (..))
+import SdkHelpers (jo)
+
+makeClient :: IO Sdk.Client
+makeClient = do
+  opts <- jo [("base", VStr "https://api.example.com")]
+  Sdk.newSdk opts
+\`\`\`
+
+Construct a live SDK client.
+
+**Functions:**
+
+| Function | Signature | Description |
+| --- | --- | --- |
+| \`newSdk\` | \`Value -> IO Client\` | Construct a client from an options map. |
+| \`newSdk0\` | \`IO Client\` | Construct a client with defaults. |
+
+**Options (map keys):**
+
+| Key | Type | Description |
+| --- | --- | --- |
+${isAuthActive(model) ? '| `apikey` | `String` | API key for authentication. |\n' : ''}| \`base\` | \`String\` | Base URL for API requests. |
+| \`prefix\` | \`String\` | URL prefix appended after base. |
+| \`suffix\` | \`String\` | URL suffix appended after path. |
+| \`headers\` | \`Value\` | Custom headers for all requests. |
+| \`feature\` | \`Value\` | Feature configuration. |
+| \`system\` | \`Value\` | System overrides (e.g. custom fetch). |
+
+
+### Test constructors
+
+\`\`\`haskell
+client <- Sdk.testSdk0
+\`\`\`
+
+\`testSdk :: Value -> Value -> IO Client\` constructs a test client with mock
+features active (\`testSdk0 :: IO Client\` for the no-argument form). Pass
+\`VNoval\` for defaults.
+
+
+### Entity accessors
+
+`)
+
+
+    // Entity factory functions
+    publishedEntities.map((ent: any) => {
+      const eFn = hsVarName(ent.name)
+      Content(`#### \`${eFn} :: Client -> Value -> IO Entity\`
+
+Construct a \`${ent.Name}\` entity bound to the client. Pass \`VNoval\` for no initial options.
+
+`)
+    })
+
+
+    Content(`### HTTP escape hatches
+
+#### \`direct :: Client -> Value -> IO Value\` (module \`SdkFeatures\`)
+
+Make a direct HTTP request to any API endpoint. Returns a result \`Value\` with
+\`ok\`, \`status\`, \`headers\`, and \`data\` (or \`err\` on failure). This escape
+hatch never raises — branch on \`getp result "ok"\`.
+
+**Argument (map keys):**
+
+| Key | Type | Description |
+| --- | --- | --- |
+| \`path\` | \`String\` | URL path with optional \`{param}\` placeholders. |
+| \`method\` | \`String\` | HTTP method (default: \`"GET"\`). |
+| \`params\` | \`Value\` | Path parameter values. |
+| \`query\` | \`Value\` | Query string parameters. |
+| \`headers\` | \`Value\` | Request headers (merged with defaults). |
+| \`body\` | \`Value\` | Request body (maps are JSON-serialized). |
+
+#### \`prepare :: Client -> Value -> IO Value\` (module \`SdkFeatures\`)
+
+Prepare a fetch definition without sending. Returns the \`fetchdef\` and raises on error.
+
+`)
+
+
+    // Entity reference sections
+    publishedEntities.map((ent: any) => {
+      const opnames = Object.keys(ent.op || {})
+      const fields = ent.fields || []
+      const idF = entityIdField(ent)
+      const eFn = hsVarName(ent.name)
+
+      Content(`
+---
+
+## ${ent.Name}
+
+`)
+
+      if (ent.short) {
+        Content(`${ent.short}
+
+`)
+      }
+
+      Content(`\`\`\`haskell
+  ent <- Sdk.${eFn} sdk VNoval
+\`\`\`
+
+`)
+
+
+      // Field schema
+      if (fields.length > 0) {
+        Content(`### Fields
+
+| Field | Type | Required | Description |
+| --- | --- | --- | --- |
+`)
+        each(fields, (field: any) => {
+          const req = field.req ? 'Yes' : 'No'
+          const desc = field.short || ''
+          Content(`| \`${field.name}\` | \`${hsType(field.type)}\` | ${req} | ${desc} |
+`)
+        })
+
+        Content(`
+`)
+
+        // Field operations breakdown
+        const hasFieldOps = fields.some((f: any) => f.op && Object.keys(f.op).length > 0)
+        if (hasFieldOps) {
+          const opcols = ['load', 'list', 'create', 'update', 'remove']
+            .filter((op: string) => opnames.includes(op) && ent.op[op]?.active !== false)
+          Content(`### Field Usage by Operation
+
+| Field | ${opcols.join(' | ')} |
+| --- | ${opcols.map(() => '---').join(' | ')} |
+`)
+          each(fields, (field: any) => {
+            const fops = field.op || {}
+            const cols = opcols.map((op: string) => {
+              const fop = fops[op]
+              if (null == fop) return '-'
+              if (fop.active === false) return '-'
+              return 'Yes'
+            })
+            Content(`| \`${field.name}\` | ${cols.join(' | ')} |
+`)
+          })
+
+          Content(`
+`)
+        }
+      }
+
+
+      // Operation details
+      if (opnames.length > 0) {
+        Content(`### Operations
+
+`)
+
+        opnames.map((opname: string) => {
+          const info = OP_SIGNATURES[opname]
+          if (!info) return
+
+          Content(`#### \`${info.sig}\`
+
+${info.desc}
+
+`)
+
+          if ('load' === opname || 'remove' === opname) {
+            const matchItems = opRequestShape(ent, opname).items
+              .filter((it: any) => !it.optional || it.name === idF)
+              .sort((a: any, b: any) =>
+                (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+            const arg = 0 < matchItems.length
+              ? `[${matchItems.map((it: any) =>
+                `("${it.name}", ${hsLit(it.type,
+                  it.name === idF ? ent.name + '_id' : it.name)})`).join(', ')}]`
+              : '[]'
+            Content(`\`\`\`haskell
+  ent <- Sdk.${eFn} sdk VNoval
+  match <- jo ${arg}
+  ctrl <- emptyMap
+  result <- Sdk.e${opname.charAt(0).toUpperCase() + opname.slice(1)} ent match ctrl
+\`\`\`
+
+`)
+          }
+          else if ('list' === opname) {
+            Content(`\`\`\`haskell
+  ent <- Sdk.${eFn} sdk VNoval
+  match <- emptyMap
+  ctrl <- emptyMap
+  results <- Sdk.eList ent match ctrl
+\`\`\`
+
+`)
+          }
+          else if ('create' === opname) {
+            const createItems = opRequestShape(ent, 'create').items
+              .filter((it: any) => !it.optional)
+            Content(`\`\`\`haskell
+  ent <- Sdk.${eFn} sdk VNoval
+  d <- jo
+    [`)
+            createItems.map((it: any, i: number) => {
+              const bracket = 0 === i ? ' ' : ', '
+              Content(`${bracket}("${it.name}", ${hsLit(it.type, 'example_' + it.name)})   -- ${hsType(it.type)}
+    `)
+            })
+            Content(`]
+  ctrl <- emptyMap
+  result <- Sdk.eCreate ent d ctrl
+\`\`\`
+
+`)
+          }
+          else if ('update' === opname) {
+            const updateItems = opRequestShape(ent, 'update').items
+              .filter((it: any) => !it.optional || it.name === idF)
+              .sort((a: any, b: any) =>
+                (a.name === idF ? 0 : 1) - (b.name === idF ? 0 : 1))
+            const updateLines = updateItems.map((it: any, i: number) => {
+              const bracket = 0 === i ? ' ' : ', '
+              return `${bracket}("${it.name}", ${hsLit(it.type,
+                it.name === idF ? ent.name + '_id' : it.name)})`
+            }).join('\n    ')
+            Content(`\`\`\`haskell
+  ent <- Sdk.${eFn} sdk VNoval
+  d <- jo
+    [${updateLines}
+    ]  -- fields to update
+  ctrl <- emptyMap
+  result <- Sdk.eUpdate ent d ctrl
+\`\`\`
+
+`)
+          }
+        })
+      }
+
+
+      // Common methods
+      Content(`### Common Fields
+
+#### \`eDataGet :: IO Value\`
+
+Get the entity data.
+
+#### \`eDataSet :: Value -> IO ()\`
+
+Set the entity data.
+
+#### \`eStream :: String -> Value -> Value -> IO [Value]\`
+
+Run an operation as a lazy stream of result items.
+
+#### \`eMake :: IO Entity\`
+
+Create a new \`${ent.Name}\` entity with the same options.
+
+#### \`eName :: String\`
+
+The entity name.
+
+`)
+    })
+
+
+    // Features section
+    const activeFeatures = each(feature).filter((f: any) => f.active)
+    if (activeFeatures.length > 0) {
+      Content(`
+---
+
+## Features
+
+| Feature | Version | Description |
+| --- | --- | --- |
+`)
+
+      activeFeatures.map((f: any) => {
+        Content(`| \`${f.name}\` | ${f.version || '0.0.1'} | ${f.title || ''} |
+`)
+      })
+
+      Content(`
+
+Features are activated via the \`feature\` option:
+
+`)
+
+      Content(`\`\`\`haskell
+  active <- jo [("active", VBool True)]
+  featureCfg <- jo
+    [`)
+      activeFeatures.map((f: any, i: number) => {
+        const bracket = 0 === i ? ' ' : ', '
+        Content(`${bracket}("${f.name}", active)
+    `)
+      })
+      Content(`]
+  opts <- jo [("feature", featureCfg)]
+  client <- Sdk.newSdk opts
+\`\`\`
+
+`)
+    }
+
+  })
+})
+
+
+
+
+export {
+  ReadmeRef
+}

package/project/.sdk/src/cmp/haskell/ReadmeTopHowto_haskell.ts

@@ -0,0 +1,31 @@
+
+import { cmp, Content } from '@voxgig/sdkgen'
+
+
+const ReadmeTopHowto = cmp(function ReadmeTopHowto(props: any) {
+  const { target } = props
+
+  Content(`**Haskell:**
+\`\`\`haskell
+import qualified SdkClient as Sdk
+import qualified SdkFeatures as F
+import VoxgigStruct (Value (..))
+import SdkHelpers (jo)
+
+main :: IO ()
+main = do
+  sdk <- Sdk.newSdk0
+  params <- jo [("id", VStr "example")]
+  args <- jo [("path", VStr "/api/resource/{id}"), ("method", VStr "GET"), ("params", params)]
+  result <- F.direct sdk args
+  print result
+\`\`\`
+
+`)
+
+})
+
+
+export {
+  ReadmeTopHowto
+}