@voxgig/sdkgen 1.3.4 → 1.3.5

package/src/helpers/opShape.ts

@@ -238,6 +238,93 @@ function entityPrimaryOp(ent: any): string | null {
 }
 
 
+// Collision-free target-language CLASS name for an entity. The natural
+// class name is `<Name>Entity`, but that can equal another entity's
+// canonical DATA-type name `<Name'>` when Name' === Name + 'Entity' (e.g.
+// GitLab's `project` -> class `ProjectEntity` collides with `project_entity`
+// -> data type `ProjectEntity`), which redeclares a type in Go and merges/
+// shadows it in ts/py/rb. This assigns each entity a class name that is
+// unique across ALL emitted top-level type names (every entity's data type
+// and per-op Match/Data types, plus already-assigned class names): the
+// natural `<Name>Entity` when free, else `<Name>EntityClient`, `...Client2`,
+// … The DATA type keeps its canonical `<Name>` — only the suffixed class
+// yields. Deterministic (sorted-key iteration) and stable across runs.
+//
+// Memoised per entity-collection object so the O(n) assignment runs once.
+const _classNameCache = new WeakMap<object, Record<string, string>>()
+
+function entityClassNames(entityColl: any): Record<string, string> {
+  const cached = _classNameCache.get(entityColl)
+  if (null != cached) {
+    return cached
+  }
+
+  const ents = each(entityColl).filter((e: any) => e && e.active !== false)
+
+  // 1. Every top-level DATA-type name the target emits.
+  const taken: Record<string, boolean> = {}
+  ents.forEach((e: any) => {
+    taken[e.Name] = true
+    for (const op of ['load', 'list', 'create', 'update', 'remove']) {
+      if (e.op && e.op[op]) {
+        taken[opTypeName(e.Name, op)] = true
+      }
+    }
+  })
+
+  // 2. Assign each class name, avoiding all data types and prior classes.
+  const out: Record<string, string> = {}
+  ents.forEach((e: any) => {
+    let name = e.Name + 'Entity'
+    if (taken[name]) {
+      const base = name + 'Client'
+      name = base
+      let n = 1
+      while (taken[name]) {
+        n++
+        name = base + n
+      }
+    }
+    taken[name] = true
+    out[e.name] = name
+  })
+
+  _classNameCache.set(entityColl, out)
+  return out
+}
+
+
+// The collision-free class name for one entity (see entityClassNames).
+// `entityColl` is main.<KIT>.entity (the collection the entity belongs to).
+function entityClassName(ent: any, entityColl: any): string {
+  if (null == ent) {
+    return ''
+  }
+  const map = entityClassNames(entityColl)
+  return map[ent.name] || (ent.Name + 'Entity')
+}
+
+
+// Pick a representative entity for a single illustrative snippet (e.g. the
+// README's test-mode example): the first ACTIVE entity that exposes a read
+// op (list/load) so the snippet is meaningful, else the first with ANY
+// active op, else the first active entity. Returns { entity, primaryOp }
+// where primaryOp is null only when NO entity has an op — so callers never
+// fabricate an op the entity lacks (the cause of `.load()` on an op-less
+// entity like Cloudsmith's `Abort`). Entities iterate in sorted-key order
+// for deterministic output.
+function pickExampleEntity(entity: any): { entity: any, primaryOp: string | null } {
+  const actives = each(entity).filter((e: any) => e && e.active !== false)
+  const readable = actives.find((e: any) => {
+    const op = entityPrimaryOp(e)
+    return 'list' === op || 'load' === op
+  })
+  const withOp = actives.find((e: any) => null != entityPrimaryOp(e))
+  const chosen = readable || withOp || actives[0] || null
+  return { entity: chosen, primaryOp: null == chosen ? null : entityPrimaryOp(chosen) }
+}
+
+
 // The id field on the entity's DATA type (its fields[]), or null. DISTINCT from
 // entityIdField (the load-MATCH key): an API can model a load match that carries
 // an `id` param while the response entity itself has no `id` field, so `.id`
@@ -267,6 +354,8 @@ export {
   entityDataIdField,
   entityOps,
   entityPrimaryOp,
+  pickExampleEntity,
+  entityClassName,
 }
 
 export type {

package/src/sdkgen.ts

@@ -48,7 +48,7 @@ import { getMatchEntries } from './helpers/getMatchEntries'
 import { collectDeps } from './helpers/collectDeps'
 import type { DepEntry } from './helpers/collectDeps'
 import { canonToType, canonKey } from './helpers/canonType'
-import { OP_SUFFIX, opTypeName, opParams, opRequestShape, entityIdField, entityDataIdField, entityOps, entityPrimaryOp } from './helpers/opShape'
+import { OP_SUFFIX, opTypeName, opParams, opRequestShape, entityIdField, entityDataIdField, entityOps, entityPrimaryOp, pickExampleEntity, entityClassName } from './helpers/opShape'
 import { isReservedName, safeVarName } from './helpers/naming'
 import {
   packageName,
@@ -448,6 +448,8 @@ export {
   entityDataIdField,
   entityOps,
   entityPrimaryOp,
+  pickExampleEntity,
+  entityClassName,
   isReservedName,
   safeVarName,