graphql-engine/metadata-api-types/typescript/package.json
Jesse Hallett 885681da9a server: commit Metadata OpenAPI spec with CI check, add Typescript client scaffolding
## Description

Adds `metadata.openapi.json` to version control. Adds a Buildkite job that verifies the spec is up-to-date on server changes, and fails the CI pipeline if not.

Adds scaffolding for a new Typescript project that consumes that OpenAPI spec, and produces Typescript types. This is adapted from the similar existing data connectors project in `dc-agents/dc-api-types/`. Generated code is *not* committed to version control. Instead there is a script to generate code on-demand at publishing time. There are plans to incorporate publishing the generated project to NPM using a forthcoming pipeline that the Console team is working on.

For the moment the Typescript project is under `metadata-api-types/typescript/`. The plan is to move the project in a future PR to the frontend sub-monorepo.

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7525
GitOrigin-RevId: dc27a807e52af117636f3aa6c2c289a0be87ade1
2023-02-15 18:38:38 +00:00

40 lines
1012 B
JSON

{
"name": "@hasura/metadata-api",
"version": "0.1.0-prerelease.2",
"description": "Hasura GraphQL Engine Metadata API types",
"author": "Hasura (https://github.com/hasura/graphql-engine)",
"license": "Apache-2.0",
"repository": {
"type": "git",
"url": "git+https://github.com/hasura/graphql-engine.git"
},
"bugs": {
"url": "https://github.com/hasura/graphql-engine/issues"
},
"homepage": "https://github.com/hasura/graphql-engine/tree/master/metadata-api-types/typescript#readme",
"keywords": [
"hasura",
"metadata",
"configuration"
],
"exports": {
".": "./dist/index.js"
},
"main": "./dist/index.js",
"types": "./dist/index.js",
"files": [
"./dist",
"./README.md"
],
"scripts": {
"build": "tsc",
"typecheck": "tsc --noEmit",
"test": "echo \"Error: no test specified\" && exit 1"
},
"devDependencies": {
"@tsconfig/recommended": "^1.0.1",
"openapi-typescript-codegen": "^0.23.0",
"typescript": "^4.9.4"
}
}