creojs-dts

creojs-dts generates TypeScript declaration files (.d.ts) for the Creo.JS Toolkit used by Creo Parametric. Each run produces TypeScript declarations, an index.d.ts, and optional package metadata.

Requirements

• Node.js 18+

Build

npm install
npm run build

Generate Declarations

Copy from <CREO_PARAMETRIC>\Common Files\apps\creojs\otk_api_spec\OTK_model.json.zip\json\

• the idl/ folder into input/idl/ as pfc/
• the idl_wfc/ folder into input/idl/ as wfc/
• the idl_uifc/ folder into input/idl/ as uifc/

Run:

npm run generate

Generated files are written to creojs/.

Output

• splitBySourceFile: true
  • One .d.ts file per JSON source, written under creojs/<module>/<name>.d.ts
  • creojs/index.d.ts references each per-file declaration
• splitBySourceFile: false
  • One bundled .d.ts file per module prefix (creojs/pfc.d.ts, creojs/wfc.d.ts, creojs/uifc.d.ts, ...)
  • creojs/index.d.ts references each bundled module file
• Per-module extras: input/pfc.d.ts, input/wfc.d.ts, input/uifc.d.ts (if present) are appended to the corresponding generated module output
• Creo.JS global extras: input/creojs.d.ts is copied to creojs/creojs.d.ts and referenced from creojs/index.d.ts
• Package metadata: input/package.json is copied to creojs/
• The CLI reports the output location and number of processed files

Configuration

Only behavior settings are loaded from config.json. Input (input/) and output (creojs/) path are hardcoded

Example:

{
  "splitBySourceFile": false,
  "emitExports": false,
  "typesAsInterfaces": true,
  "docsDetail": "basic",
  "enumsAs": "class",
  "interfaceStaticsAs": "interface"
}

Settings

• splitBySourceFile – Generate one file per JSON source when true, or one bundled file per module prefix when false (default: true)
• emitExports – Add export keywords to generated declarations (default: false)
• typesAsInterfaces – Generate interfaces instead of classes (default: true)
• docsDetail – Documentation details: none, basic, or full (default: basic)
• enumsAs – Representation of IDL enums: enum (TypeScript enum) or class (class-based enum-like objects with string() and static readonly members, default: class)
• interfaceStaticsAs – Static method representation when typesAsInterfaces is true: interface (separate *Static interface plus const binding) or namespace (functions in a namespace with the same name as the interface, default: interface)

Project Structure

• src/app.ts – CLI entry point and orchestration
• src/generator.ts – Generates TypeScript declarations
• src/docs.ts – Documentation generation helpers
• input/idl/ – Source IDL JSON files
• input/pfc.d.ts, input/wfc.d.ts, input/uifc.d.ts – per-module custom declarations
• input/creojs.d.ts – Creo.JS declarations
• input/package.json – Package manifest
• creojs/ – Generated output