{"id":22555861,"url":"https://github.com/inkdropapp/inkdrop-model","last_synced_at":"2025-04-10T05:20:36.369Z","repository":{"id":27571034,"uuid":"114448516","full_name":"inkdropapp/inkdrop-model","owner":"inkdropapp","description":"Inkdrop data model definitions in json-schema and flowtype","archived":false,"fork":false,"pushed_at":"2025-02-12T04:37:27.000Z","size":913,"stargazers_count":13,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T06:45:17.130Z","etag":null,"topics":["inkdrop","json-schema"],"latest_commit_sha":null,"homepage":"https://www.inkdrop.app/","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/inkdropapp.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":"2017-12-16T09:20:43.000Z","updated_at":"2025-02-12T04:37:31.000Z","dependencies_parsed_at":"2024-06-19T19:06:18.089Z","dependency_job_id":"6e1d2274-ba79-4fc3-bab1-4b17eb5272cd","html_url":"https://github.com/inkdropapp/inkdrop-model","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkdropapp%2Finkdrop-model","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkdropapp%2Finkdrop-model/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkdropapp%2Finkdrop-model/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkdropapp%2Finkdrop-model/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/inkdropapp","download_url":"https://codeload.github.com/inkdropapp/inkdrop-model/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247878022,"owners_count":21011158,"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":["inkdrop","json-schema"],"created_at":"2024-12-07T19:09:13.357Z","updated_at":"2025-04-10T05:20:36.346Z","avatar_url":"https://github.com/inkdropapp.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Inkdrop Model\n==================\n\nInkdrop data model definitions in json-schema and TypeScript\n\n## Documentations\n\nHuman readable definitions are [here](https://github.com/inkdropapp/inkdrop-model/tree/master/docs/schema.md).\n\n## Install\n\n```sh\nnpm install inkdrop-model\n```\n\n## Usage\n\n### TypeScript\n\n```typescript\nimport type { Note, Book, Tag, File } from 'inkdrop-model'\n```\n\n### Json Schema\n\n```javascript\nimport { NoteSchema, BookSchema, TagSchema, FileSchema } from 'inkdrop-model'\n```\n\nYou can validate data with json schemas.\nBelow example uses [ajv](https://github.com/epoberezkin/ajv) as a validator:\n\n```javascript\nimport { NoteSchema } from 'inkdrop-model'\nimport Ajv from 'ajv'\nconst ajv = new Ajv()\nconst validate = ajv.compile(NoteSchema)\n\nconst data = {\n  _id: 'note:BkgOZZUJzf',\n  title: 'link',\n  doctype: 'markdown',\n  updatedAt: 1513330812556,\n  createdAt: 1513214207639,\n  tags: [],\n  status: 'none',\n  share: 'private',\n  body: 'markdown note body',\n  bookId: 'book:first',\n  _rev: '38-636e505958d24f9c21614d95ea03b5a1'\n}\nconst valid = validate(data)\nconsole.log(valid) // =\u003e true\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finkdropapp%2Finkdrop-model","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finkdropapp%2Finkdrop-model","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finkdropapp%2Finkdrop-model/lists"}