@pikku/inspector 0.12.74 → 0.12.81

package/src/utils/contract-hashes.ts

@@ -1,387 +0,0 @@
-import type { FunctionsMeta } from '@pikku/core/services'
-import type { JSONValue } from '@pikku/core/utils'
-import { parseVersionedId } from '@pikku/core/utils'
-import type { TypesMap } from '../types-map.js'
-import { ErrorCode } from '../error-codes.js'
-import { canonicalJSON, hashString } from './hash.js'
-
-export type ContractEntry = {
-  functionKey: string
-  version: number
-  contractHash: string
-  inputHash: string
-  outputHash: string
-}
-
-export type VersionValidateError = {
-  code: ErrorCode
-  message: string
-  functionKey?: string
-  version?: number
-  previousHash?: string
-  currentHash?: string
-  previousInputHash?: string
-  currentInputHash?: string
-  previousOutputHash?: string
-  currentOutputHash?: string
-  nextVersion?: number
-  latestVersion?: number
-  expectedNextVersion?: number
-}
-
-export type VersionHashEntry = {
-  inputHash: string
-  outputHash: string
-}
-
-export type VersionManifestEntry = {
-  latest: number
-  versions: Record<string, string | VersionHashEntry>
-}
-
-export type VersionManifest = {
-  manifestVersion: 1
-  contracts: Record<string, VersionManifestEntry>
-}
-
-function isHashEntry(v: string | VersionHashEntry): v is VersionHashEntry {
-  return typeof v === 'object'
-}
-
-export function createEmptyManifest(): VersionManifest {
-  return {
-    manifestVersion: 1,
-    contracts: {},
-  }
-}
-
-export function serializeManifest(manifest: VersionManifest): string {
-  const sortedContracts: Record<string, VersionManifestEntry> = {}
-
-  for (const key of Object.keys(manifest.contracts).sort()) {
-    const entry = manifest.contracts[key]
-    const sortedVersions: Record<string, string | VersionHashEntry> = {}
-    const numericKeys = Object.keys(entry.versions)
-      .map(Number)
-      .sort((a, b) => a - b)
-    for (const vk of numericKeys) {
-      sortedVersions[String(vk)] = entry.versions[String(vk)]
-    }
-    sortedContracts[key] = {
-      latest: entry.latest,
-      versions: sortedVersions,
-    }
-  }
-
-  const sorted: VersionManifest = {
-    manifestVersion: manifest.manifestVersion,
-    contracts: sortedContracts,
-  }
-
-  return JSON.stringify(sorted, null, 2) + '\n'
-}
-
-export function computeContractHash(data: {
-  functionKey: string
-  inputSchema: unknown
-  outputSchema: unknown
-}): string {
-  return hashString(canonicalJSON(data), 16)
-}
-
-function computeInputHash(functionKey: string, inputSchema: unknown): string {
-  return hashString(canonicalJSON({ functionKey, inputSchema }), 8)
-}
-
-function computeOutputHash(functionKey: string, outputSchema: unknown): string {
-  return hashString(canonicalJSON({ functionKey, outputSchema }), 8)
-}
-
-function resolveSchema(
-  typeNames: string[] | null | undefined,
-  allSchemas: Record<string, JSONValue>,
-  typesMap: TypesMap
-): unknown {
-  if (!typeNames) {
-    return null
-  }
-  const filtered = typeNames.filter((n) => n !== 'void')
-  if (filtered.length === 0) {
-    return null
-  }
-  const parts: unknown[] = []
-  for (const name of filtered) {
-    let key: string
-    try {
-      key = typesMap.getUniqueName(name)
-    } catch {
-      key = name
-    }
-    const schema = allSchemas[key]
-    if (schema) {
-      parts.push(schema)
-    }
-  }
-  if (parts.length === 0) {
-    return null
-  }
-  return parts.length === 1 ? parts[0] : parts
-}
-
-export function buildCurrentContracts(
-  functionsMeta: FunctionsMeta,
-  allSchemas: Record<string, JSONValue>,
-  typesMap: TypesMap
-): Map<string, ContractEntry> {
-  const result = new Map<string, ContractEntry>()
-
-  for (const [funcId, meta] of Object.entries(functionsMeta)) {
-    if (meta.remote === true) {
-      continue
-    }
-
-    const parsed = parseVersionedId(funcId)
-    const functionKey = parsed.baseName
-    const version = parsed.version ?? meta.version ?? 1
-
-    const inputSchema = resolveSchema(meta.inputs, allSchemas, typesMap)
-    const outputSchema = resolveSchema(meta.outputs, allSchemas, typesMap)
-
-    const contractHash = computeContractHash({
-      functionKey,
-      inputSchema,
-      outputSchema,
-    })
-    const inputHash = computeInputHash(functionKey, inputSchema)
-    const outputHash = computeOutputHash(functionKey, outputSchema)
-
-    result.set(funcId, {
-      functionKey,
-      version,
-      contractHash,
-      inputHash,
-      outputHash,
-    })
-  }
-
-  return result
-}
-
-export function computeContractHashes(
-  allSchemas: Record<string, JSONValue>,
-  typesMap: TypesMap,
-  functionsMeta: FunctionsMeta
-): Map<string, ContractEntry> {
-  const contracts = buildCurrentContracts(functionsMeta, allSchemas, typesMap)
-
-  for (const [funcId, entry] of contracts) {
-    const meta = functionsMeta[funcId]
-    if (meta) {
-      meta.contractHash = entry.contractHash
-      meta.inputHash = entry.inputHash
-      meta.outputHash = entry.outputHash
-    }
-  }
-
-  return contracts
-}
-
-function groupByFunctionKey(
-  contracts: Map<string, ContractEntry>
-): Map<string, ContractEntry[]> {
-  const grouped = new Map<string, ContractEntry[]>()
-  for (const entry of contracts.values()) {
-    const existing = grouped.get(entry.functionKey) ?? []
-    existing.push(entry)
-    grouped.set(entry.functionKey, existing)
-  }
-  return grouped
-}
-
-function entryChanged(
-  existing: string | VersionHashEntry,
-  current: ContractEntry
-): boolean {
-  if (isHashEntry(existing)) {
-    return (
-      existing.inputHash !== current.inputHash ||
-      existing.outputHash !== current.outputHash
-    )
-  }
-  return existing !== current.contractHash
-}
-
-export function validateContracts(
-  manifest: VersionManifest,
-  currentContracts: Map<string, ContractEntry>
-): { valid: boolean; errors: VersionValidateError[] } {
-  const errors: VersionValidateError[] = []
-  const grouped = groupByFunctionKey(currentContracts)
-  const reportedKeys = new Set<string>()
-
-  for (const [functionKey, entries] of grouped) {
-    const manifestEntry = manifest.contracts[functionKey]
-    if (!manifestEntry) {
-      continue
-    }
-
-    for (const current of entries) {
-      const { version, contractHash, inputHash, outputHash } = current
-      const existingEntry = manifestEntry.versions[String(version)]
-
-      if (existingEntry !== undefined) {
-        if (entryChanged(existingEntry, current)) {
-          reportedKeys.add(`${functionKey}@${version}`)
-          const prevInputHash = isHashEntry(existingEntry)
-            ? existingEntry.inputHash
-            : existingEntry
-          const prevOutputHash = isHashEntry(existingEntry)
-            ? existingEntry.outputHash
-            : existingEntry
-          errors.push({
-            code: ErrorCode.FUNCTION_VERSION_MODIFIED,
-            message: `Contract for ${functionKey}@v${version} has changed (recorded: ${isHashEntry(existingEntry) ? `${existingEntry.inputHash}/${existingEntry.outputHash}` : existingEntry}, current: ${contractHash}). Existing versions are immutable.`,
-            functionKey,
-            version,
-            previousHash: isHashEntry(existingEntry)
-              ? existingEntry.inputHash
-              : existingEntry,
-            currentHash: contractHash,
-            previousInputHash: prevInputHash,
-            currentInputHash: inputHash,
-            previousOutputHash: prevOutputHash,
-            currentOutputHash: outputHash,
-          })
-        }
-      } else {
-        if (version <= manifestEntry.latest) {
-          errors.push({
-            code: ErrorCode.VERSION_REGRESSION_OR_CONFLICT,
-            message: `Version ${version} for ${functionKey} is <= latest (${manifestEntry.latest}) but not recorded. Possible merge conflict.`,
-            functionKey,
-            version,
-            latestVersion: manifestEntry.latest,
-          })
-        } else if (version > manifestEntry.latest + 1) {
-          errors.push({
-            code: ErrorCode.VERSION_GAP_NOT_ALLOWED,
-            message: `Version ${version} for ${functionKey} skips versions. Latest is ${manifestEntry.latest}, next must be ${manifestEntry.latest + 1}.`,
-            functionKey,
-            version,
-            latestVersion: manifestEntry.latest,
-            expectedNextVersion: manifestEntry.latest + 1,
-          })
-        }
-      }
-    }
-  }
-
-  for (const [functionKey, manifestEntry] of Object.entries(
-    manifest.contracts
-  )) {
-    const latestEntry = manifestEntry.versions[String(manifestEntry.latest)]
-    const currentEntries = grouped.get(functionKey)
-    if (!currentEntries) {
-      continue
-    }
-
-    const currentLatest = currentEntries.find(
-      (e) => e.version === manifestEntry.latest
-    )
-    if (
-      currentLatest &&
-      entryChanged(latestEntry, currentLatest) &&
-      !reportedKeys.has(`${functionKey}@${manifestEntry.latest}`)
-    ) {
-      const prevInputHash = isHashEntry(latestEntry)
-        ? latestEntry.inputHash
-        : undefined
-      const prevOutputHash = isHashEntry(latestEntry)
-        ? latestEntry.outputHash
-        : undefined
-      errors.push({
-        code: ErrorCode.CONTRACT_CHANGED_REQUIRES_BUMP,
-        message: `Contract for ${functionKey} changed. Set \`version: ${manifestEntry.latest + 1}\` on the function or run 'pikku versions update'.`,
-        functionKey,
-        previousInputHash: prevInputHash,
-        currentInputHash: currentLatest.inputHash,
-        previousOutputHash: prevOutputHash,
-        currentOutputHash: currentLatest.outputHash,
-        nextVersion: manifestEntry.latest + 1,
-      })
-    }
-  }
-
-  for (const [functionKey, manifestEntry] of Object.entries(
-    manifest.contracts
-  )) {
-    const numericKeys = Object.keys(manifestEntry.versions).map(Number)
-    if (numericKeys.length === 0) {
-      continue
-    }
-    const maxVersion = Math.max(...numericKeys)
-    if (manifestEntry.latest !== maxVersion) {
-      errors.push({
-        code: ErrorCode.MANIFEST_INTEGRITY_ERROR,
-        message: `Manifest integrity error for ${functionKey}: latest field (${manifestEntry.latest}) inconsistent with version keys (max: ${maxVersion}).`,
-        functionKey,
-        latestVersion: manifestEntry.latest,
-        expectedNextVersion: maxVersion,
-      })
-    }
-  }
-
-  return { valid: errors.length === 0, errors }
-}
-
-export function updateManifest(
-  existing: VersionManifest,
-  currentContracts: Map<string, ContractEntry>
-): VersionManifest {
-  const manifest: VersionManifest = {
-    manifestVersion: existing.manifestVersion,
-    contracts: JSON.parse(JSON.stringify(existing.contracts)),
-  }
-
-  const grouped = groupByFunctionKey(currentContracts)
-
-  for (const [functionKey, entries] of grouped) {
-    if (!manifest.contracts[functionKey]) {
-      manifest.contracts[functionKey] = { latest: 0, versions: {} }
-    }
-
-    const entry = manifest.contracts[functionKey]
-    for (const { version, inputHash, outputHash } of entries) {
-      entry.versions[String(version)] = { inputHash, outputHash }
-      entry.latest = Math.max(entry.latest, version)
-    }
-  }
-
-  return manifest
-}
-
-export function extractContractsFromMeta(
-  functionsMeta: FunctionsMeta
-): Map<string, ContractEntry> {
-  const result = new Map<string, ContractEntry>()
-
-  for (const [funcId, meta] of Object.entries(functionsMeta)) {
-    if (meta.remote === true || !meta.contractHash) {
-      continue
-    }
-
-    const parsed = parseVersionedId(funcId)
-    const functionKey = parsed.baseName
-    const version = parsed.version ?? meta.version ?? 1
-
-    result.set(funcId, {
-      functionKey,
-      version,
-      contractHash: meta.contractHash,
-      inputHash: meta.inputHash ?? '',
-      outputHash: meta.outputHash ?? '',
-    })
-  }
-
-  return result
-}

package/src/utils/custom-types-generator.test.ts

@@ -1,124 +0,0 @@
-import { test, describe } from 'node:test'
-import { strict as assert } from 'node:assert'
-import {
-  generateCustomTypes,
-  sanitizeTypeName,
-} from './custom-types-generator.js'
-import { TypesMap } from '../types-map.js'
-
-function makeTypesMap(
-  entries: Record<string, { type: string; references: string[] }>
-): TypesMap {
-  const tm = new TypesMap()
-  for (const [name, { type, references }] of Object.entries(entries)) {
-    tm.addCustomType(name, type, references)
-  }
-  return tm
-}
-
-describe('generateCustomTypes — classification wrapper stripping', () => {
-  test('strips Private<T> wrapper from type alias', () => {
-    const tm = makeTypesMap({
-      UserEmail: { type: 'Private<string>', references: ['Private'] },
-    })
-    const result = generateCustomTypes(tm, new Set())
-    assert.match(result, /UserEmail/, 'should emit UserEmail alias')
-    assert.match(
-      result,
-      /= string/,
-      'Private<string> should be stripped to string'
-    )
-    assert.doesNotMatch(result, /Private/, 'Private wrapper must be removed')
-  })
-
-  test('strips Secret<T> wrapper from type alias', () => {
-    const tm = makeTypesMap({
-      HashedPw: { type: 'Secret<string>', references: ['Secret'] },
-    })
-    const result = generateCustomTypes(tm, new Set())
-    assert.match(result, /HashedPw/)
-    assert.match(
-      result,
-      /= string/,
-      'Secret<string> should be stripped to string'
-    )
-    assert.doesNotMatch(result, /Secret/, 'Secret wrapper must be removed')
-  })
-
-  test('strips Pii<T> wrapper from type alias', () => {
-    const tm = makeTypesMap({
-      UserPhone: { type: 'Pii<string>', references: ['Pii'] },
-    })
-    const result = generateCustomTypes(tm, new Set())
-    assert.match(result, /UserPhone/)
-    assert.match(result, /= string/, 'Pii<string> should be stripped to string')
-    assert.doesNotMatch(result, /Pii/, 'Pii wrapper must be removed')
-  })
-
-  test('strips nested classification wrappers', () => {
-    const tm = makeTypesMap({
-      Combo: {
-        type: 'Private<Secret<string>>',
-        references: ['Private', 'Secret'],
-      },
-    })
-    const result = generateCustomTypes(tm, new Set())
-    assert.match(result, /Combo/)
-    assert.match(
-      result,
-      /= string/,
-      'nested wrappers should resolve to inner type'
-    )
-    assert.doesNotMatch(
-      result,
-      /Private|Secret/,
-      'all wrappers must be removed'
-    )
-  })
-
-  test('does not strip non-classification type names', () => {
-    const tm = makeTypesMap({
-      MyType: { type: 'SomeOtherType', references: ['SomeOtherType'] },
-    })
-    const required = new Set<string>()
-    generateCustomTypes(tm, required)
-    assert.ok(
-      required.has('SomeOtherType'),
-      'non-classification references must remain in requiredTypes'
-    )
-  })
-
-  test('classification wrapper references are not added to requiredTypes', () => {
-    const tm = makeTypesMap({
-      SensitiveField: { type: 'Private<string>', references: ['Private'] },
-    })
-    const required = new Set<string>()
-    generateCustomTypes(tm, required)
-    assert.ok(
-      !required.has('Private'),
-      'Private must not be added to requiredTypes'
-    )
-  })
-})
-
-describe('sanitizeTypeName — valid JS identifier', () => {
-  test('replaces disallowed characters with underscores', () => {
-    assert.equal(
-      sanitizeTypeName('Add Beehiiv subscribers'),
-      'Add_Beehiiv_subscribers'
-    )
-  })
-
-  test('prefixes an underscore when the name starts with a digit', () => {
-    // A name like "2. Add Beehiiv newsletter subscribers" otherwise produces
-    // `2__Add_...`, an invalid JS identifier that breaks the generated
-    // `import <ident> from ...` in pikku-workflow-wirings-meta.gen.ts.
-    const id = sanitizeTypeName('2. Add Beehiiv newsletter subscribers')
-    assert.equal(id, '_2__Add_Beehiiv_newsletter_subscribers')
-    assert.match(id, /^[A-Za-z_$]/, 'must start with a valid identifier char')
-  })
-
-  test('leaves an already-valid identifier unchanged', () => {
-    assert.equal(sanitizeTypeName('UserEmail'), 'UserEmail')
-  })
-})

package/src/utils/custom-types-generator.ts

@@ -1,150 +0,0 @@
-import type { TypesMap } from '../types-map.js'
-
-/**
- * NOTE: Code generation normally belongs in @pikku/cli, not the inspector.
- * This is here because the schema generator needs the custom types content
- * as a virtual TypeScript source file (in-memory, no disk write) so that
- * ts-json-schema-generator can discover inline/custom types from typesMap.
- */
-
-export function sanitizeTypeName(name: string): string {
-  const sanitized = name.replace(/[^a-zA-Z0-9_$]/g, '_')
-  return /^[0-9]/.test(sanitized) ? `_${sanitized}` : sanitized
-}
-
-const CLASSIFICATION_WRAPPERS = new Set(['Private', 'Pii', 'Secret'])
-
-function findMatchingAngleBracket(type: string, startIndex: number): number {
-  let depth = 0
-  for (let i = startIndex; i < type.length; i += 1) {
-    const char = type[i]
-    if (char === '<') {
-      depth += 1
-      continue
-    }
-    if (char === '>' && (i === 0 || type[i - 1] !== '=')) {
-      depth -= 1
-      if (depth === 0) {
-        return i
-      }
-    }
-  }
-  return -1
-}
-
-function stripClassificationWrappers(type: string): string {
-  let output = ''
-  let index = 0
-
-  while (index < type.length) {
-    const char = type[index]
-    if (!/[A-Za-z_$]/.test(char)) {
-      output += char
-      index += 1
-      continue
-    }
-
-    let end = index + 1
-    while (end < type.length && /[A-Za-z0-9_$]/.test(type[end])) {
-      end += 1
-    }
-
-    const identifier = type.slice(index, end)
-    if (CLASSIFICATION_WRAPPERS.has(identifier) && type[end] === '<') {
-      const closingIndex = findMatchingAngleBracket(type, end)
-      if (closingIndex !== -1) {
-        const inner = type.slice(end + 1, closingIndex)
-        output += stripClassificationWrappers(inner)
-        index = closingIndex + 1
-        continue
-      }
-    }
-
-    output += identifier
-    index = end
-  }
-
-  return output
-}
-
-export function generateCustomTypes(
-  typesMap: TypesMap,
-  requiredTypes: Set<string>
-) {
-  const typeDeclarations = Array.from(typesMap.customTypes.entries())
-    .sort(([a], [b]) => a.localeCompare(b))
-    .filter(([_name, { type }]) => {
-      const hasUndefinedGeneric =
-        /\b(Name|In|Out|Key)\b/.test(type) && /\[.*\]/.test(type)
-      return !hasUndefinedGeneric
-    })
-    .map(([originalName, { type, references }]) => {
-      const name = sanitizeTypeName(originalName)
-      references.forEach((refName) => {
-        if (
-          refName !== '__object' &&
-          !refName.startsWith('__object_') &&
-          !CLASSIFICATION_WRAPPERS.has(refName)
-        ) {
-          requiredTypes.add(refName)
-        }
-      })
-
-      const typeString = stripClassificationWrappers(type)
-      const typeNameRegex = /\b[A-Z][a-zA-Z0-9]*\b/g
-      const potentialTypes = typeString.match(typeNameRegex) || []
-
-      potentialTypes.forEach((typeName) => {
-        if (
-          typeString.includes(`"${typeName}"`) ||
-          [
-            'Pick',
-            'Omit',
-            'Partial',
-            'Required',
-            'Record',
-            'Readonly',
-          ].includes(typeName)
-        ) {
-          return
-        }
-
-        try {
-          const typeMeta = typesMap.getTypeMeta(typeName)
-          if (typeMeta.path) {
-            requiredTypes.add(typeMeta.originalName)
-          }
-        } catch {
-          // Type not found in map (ambient/builtin type)
-        }
-      })
-
-      if (name === typeString) return null
-      return `export type ${name} = ${typeString}`
-    })
-
-  const importsByPath = new Map<string, Set<string>>()
-  for (const typeName of requiredTypes) {
-    if (CLASSIFICATION_WRAPPERS.has(typeName)) continue
-    try {
-      const typeMeta = typesMap.getTypeMeta(typeName)
-      if (typeMeta.path) {
-        if (!importsByPath.has(typeMeta.path)) {
-          importsByPath.set(typeMeta.path, new Set())
-        }
-        importsByPath.get(typeMeta.path)!.add(typeMeta.originalName)
-      }
-    } catch {
-      // Type not found in map
-    }
-  }
-
-  const importLines = Array.from(importsByPath.entries())
-    .map(
-      ([path, types]) =>
-        `import type { ${Array.from(types).join(', ')} } from '${path}'`
-    )
-    .join('\n')
-
-  return `${importLines}\n\n${typeDeclarations.filter(Boolean).join('\n')}`
-}