{"id":20389278,"url":"https://github.com/fflorent/poc-grist-codegen","last_synced_at":"2025-07-22T16:02:14.297Z","repository":{"id":178878858,"uuid":"662508885","full_name":"fflorent/poc-grist-codegen","owner":"fflorent","description":"POC for a Typescript Grist client","archived":false,"fork":false,"pushed_at":"2023-10-16T20:02:00.000Z","size":18,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-15T10:02:18.908Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fflorent.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-05T09:34:37.000Z","updated_at":"2024-08-23T23:05:09.000Z","dependencies_parsed_at":"2025-01-15T09:37:49.035Z","dependency_job_id":"c1905e5b-5a3b-4aa1-a993-80e53ad31a01","html_url":"https://github.com/fflorent/poc-grist-codegen","commit_stats":null,"previous_names":["fflorent/poc-grist-codegen"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fflorent%2Fpoc-grist-codegen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fflorent%2Fpoc-grist-codegen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fflorent%2Fpoc-grist-codegen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fflorent%2Fpoc-grist-codegen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fflorent","download_url":"https://codeload.github.com/fflorent/poc-grist-codegen/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241940539,"owners_count":20045878,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T03:17:07.790Z","updated_at":"2025-03-04T23:44:36.899Z","avatar_url":"https://github.com/fflorent.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# POC for a Typescript Grist client\n\nThis is a POC for a Typescript Grist API client.\n\nIt uses [openapi-typescript-codegen](https://github.com/ferdikoomen/openapi-typescript-codegen) to generate the API client and the [OpenAPI documentation of Grist](https://support.getgrist.com/api/) ([source code](https://github.com/gristlabs/grist-help/blob/master/api/grist.yml)).\n\n## What should I look at?\n\nWhat interest us is the process that generates the client (`./generate_client.sh`) and also the use of the client (`./cli-sample.ts`).\n\n## Quick start for the POC demo\n\nJust run the following commands:\n```bash\n$ npm install\n$ npm run generate-client\n$ ts-node ./cli-sample.ts --help\n```\n\nTo list the content of a table:\n```bash\n$ ts-node ./cli-sample.ts -b BEARER -d DOC_ID -t TABLE_ID -u http://localhost:8484/api\n```\n\nTo insert a record (replace the JSON by whatever you want to insert in the given table):\n```bash\n$ ts-node ./cli-sample.ts -b BEARER -d DOC_ID -t TABLE_ID -u http://localhost:8484/api --recordToAdd '{\"Name\": \"Some-Name\", \"Email\": \"foo@example.org\"}'\n```\n\n## How does this work?\n\nOpenapi-typescript-codegen parses the content of the yaml file and generates a client and the models to pass to the Client so it can handle the requests.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffflorent%2Fpoc-grist-codegen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffflorent%2Fpoc-grist-codegen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffflorent%2Fpoc-grist-codegen/lists"}