Skip to main content

uip vss generate

uip vss generate produces a TypeScript vss.gen.ts file from a Data Fabric schema (data_fabric_schema.json). It resolves choice sets into TypeScript unions and emits entity types the solution code can import. Run it after editing the entity schema or pulling a new schema export from uip df.

Synopsis​

uip vss generate [options]

Options​

FlagDescription
-s, --schema <path>Path to the Data Fabric schema JSON. Defaults to <target-path>/data_fabric_schema.json.
-t, --target-path <targetPath>Directory to write vss.gen.ts. Defaults to the current directory.

Examples​

# Generate using the schema at <target>/data_fabric_schema.json
uip vss generate

# Custom schema path and target directory
uip vss generate \
    --schema ./schemas/data_fabric_schema.json \
    --target-path ./src/generated

Data shape (--output json)​

{
  "Code": "TypesGenerated",
  "Data": {
    "Path": "/Users/alice/my-app/vss.gen.ts"
  }
}

See also​