Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jvilk/MakeTypes
Make TypeScript types and proxy objects from example JSON objects. Can use proxy objects to dynamically type check JSON at runtime.
https://github.com/jvilk/MakeTypes
Last synced: 17 days ago
JSON representation
Make TypeScript types and proxy objects from example JSON objects. Can use proxy objects to dynamically type check JSON at runtime.
- Host: GitHub
- URL: https://github.com/jvilk/MakeTypes
- Owner: jvilk
- Created: 2016-12-15T21:07:53.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-08T02:05:22.000Z (over 1 year ago)
- Last Synced: 2024-10-14T18:48:07.907Z (about 1 month ago)
- Language: TypeScript
- Size: 1.24 MB
- Stars: 454
- Watchers: 9
- Forks: 44
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MakeTypes 1.1.2
> Generate TypeScript types and proxy classes from example JSON objects. Type check JSON objects at runtime!
[](http://badge.fury.io/js/maketypes)
[](https://travis-ci.org/jvilk/MakeTypes)
[](https://coveralls.io/github/jvilk/MakeTypes?branch=master)
With MakeTypes, you can interact with REST endpoints and other sources of JSON with confidence that
your program receives the data you expect. **All you need is a file containing representative sample JSON objects.**
[Try the web demo](http://jvilk.com/MakeTypes/)!
Features:
* **Type-checked JSON.parse.** Proxy classes generated with MakeTypes will parse your JSON and check that it matches the expected type during runtime.
* **Statically type-check code that interacts with JSON objects.** Proxy objects generated with MakeTypes are expressed as TypeScript classes, so you can statically type check that your code is appropriately accessing fields on the JSON object.
* **Generate TypeScript interfaces to describe JSON types.** Don't want the overhead of runtime type checking, and trust that your samples are representative? You can opt to generate TypeScript interfaces instead, which describe the expected structure of the JSON object and facilitate type checking.
## Install
npm i -g maketypes
## Build
npm install
## Usage
First, write a file called `samples.json` that contains JSON samples for a particular object type, such as the value returned from a web service. It can either contain a single sample or an array of samples.
Then, run:
make_types -i interfaces.ts -p proxies.ts samples.json RootName
...where:
* `interfaces.ts` will hold interface definitions for the JSON (optional)
* `proxies.ts` will hold proxy class definitions that you can use to dynamically type check JSON objects at runtime (optional)
* `RootName` specifies the name to use for the type that describes the JSON object
MakeTypes will use simple heuristics to determine the names of nested sub-types.
### Using Proxies
MakeTypes generates proxy classes that dynamically check that runtime JSON objects match the expected static type.
They also standardize optional/nullable fields to contain `null` rather than `null` or `undefined`, which simplifies
your code.
Example `samples.json`:
```json
[
{
"foo": "lalala"
},
{
"foo": "hello",
"baz": 32
}
]
```
Generation command:
make_types -p proxies.ts samples.json RootName
Proxy generated from example:
```typescript
export class RootNameProxy {
public readonly foo: string;
public readonly baz: number | null;
public static Parse(d: string): RootNameProxy {
return RootNameProxy.Create(JSON.parse(d));
}
public static Create(d: any): RootNameProxy {
if (d === null || d === undefined) {
throwNull2NonNull("RootName");
} else if (typeof(d) !== 'object') {
throwNotObject("RootName");
} else if (Array.isArray(d)) {
throwIsArray("RootName");
}
return new RootNameProxy(d);
}
private constructor(d: any) {
checkString(d.foo, false);
this.foo = d.foo;
checkNumber(d.baz, true);
if (d.baz === undefined) {
d.baz = null;
}
this.baz = d.baz;
}
}
```
Example TypeScript code using proxy class:
```typescript
import {RootNameProxy} from './proxies';
// RootName.Create will throw an exception if rawJson does not match the type of RootName.
const proxyObject = RootNameProxy.Parse('{"foo": "bar"}');
// Now, you can access all of the properties of the JSON object with confidence that they
// actually exist.
let foo = proxyObject.foo; // TypeScript knows foo is a string
// If one of the properties on the proxy is optional, then it will have a null value.
let baz = proxyObject.baz; // TypeScript knows baz is number | null. In this case, it will be null.
```
### Using Interfaces
For a lighterweighter option that provides no runtime guarantees, MakeTypes can also generate TypeScript interfaces that describe the expected structure of
JSON objects. You can use these interfaces to typecheck code that interacts with JSON objects, but they cannot check if the JSON objects obey the static
type at runtime.
Interfaces also succinctly express the static type that MakeTypes is inferring from your samples, so this feature can be a good debugging mechanism.
Example `samples.json`:
```json
[
{
"foo": "lalala"
},
{
"foo": "hello",
"baz": 32
}
]
```
Generation command:
make_types -i interfaces.ts samples.json RootName
Interface generated from example:
```typescript
export interface RootName {
foo: string;
baz?: number | null;
}
```
Example TypeScript code using interfaces:
```typescript
import {RootName} from './interfaces';
const rawJson = JSON.parse('{"foo": "bar"}');
let foo = rawJson.foo; // TypeScript knows foo i a string
let baz = rawJson.baz; // TypeScript knows that baz is an optional field that may not be there.
```
## Inspiration / Technique
MakeTypes uses the Common Preferred Shape Relation from Petricek et al.'s PLDI 2016 paper, ["Types from Data: Making Structured Data First-Class Citizens in F#"](https://dl.acm.org/citation.cfm?id=2908115).
Since JavaScript/TypeScript lacks a distinction between integer and floating point types, we merge the `float` and `int` types into a `number` type.