chieftl / types

SAM-types

Typescript interfaces for all types used to communicate between SAM client(s) and the SAM API

Conventions

Request/Response interfaces

TODO: Fill this out

Versioning

We use standard semantic versioning

Development

Dependencies

The project only has one dependency: Typescript

This is to have tsc available.

Compiling

To compile the index.d.ts file and the index.js file, run npm run tsc (or yarn tsc). This cleans all existing .js files and updates the index.d.ts file and the index.js file.

Adding new interfaces, types, and enums

Write your interface or type like you normally would. In order to export it, you need to add it to the index.ts file which holds all exported interfaces, types, and enums. The enums (for now) need to be put directly in the index.ts file. To fix this we need to setup some Webpack configuration etc.

Local development

Using npm

To use the types locally in an application, add the line below as a dependency in your package.json file:

"sam-types": "file:../SAM-types"

The path is the relative path to the SAM-types project.

Using yarn

To use the types locally you can use yarn link. See docs here.

cd to the SAM-types folder and type: yarn link

Then cd to your application and type yarn link "sam-types". Now your application uses your local SAM-types project (using a symlink). To unlink, type yarn unlink "sam-types"

This means that you do not have to change anything in your package.json file.

Regular dependency

To use SAM-types in a project, add the line below as a dependency in your package.json file:

"sam-types": "OmniCar/SAM-types#0.0.1"

If you need to target something other than a specific release, consider targeting a branch or a commit as shown below:

• "sam-types": "OmniCar/SAM-types#4727d357ea"
• "sam-types": "OmniCar/SAM-types#feature\/branch"

Releasing

Using GitHub

• Go to releases on GitHub
• Press "Create a new release"
• Set the "Tag version" to the appropriate version number (see versioning above)
• Set the "Release title" to "Version <version_number>"
• Describe the changes. What's new? are there any breaking changes? etc.
• If you want you can see the changes on master compared to a release (for example version 0.0.1) by typing: git diff tags/0.0.1 master
• Press "Publish release"

Using hub cli

If you have installed the hub cli (see link above), you can create a new release with the below command. Please note that it defaults to targeting the main (master) branch unless you use the -t option (more options here)

git release create -o -m "Release 0.0.2" "0.0.2"

If you did not set up the alias for git = hub you should write hub instead of git in the command above.