{"id":15363167,"url":"https://github.com/techquery/datascheme","last_synced_at":"2025-04-15T09:25:32.605Z","repository":{"id":98205615,"uuid":"150697457","full_name":"TechQuery/DataScheme","owner":"TechQuery","description":"Data Model framework based on ECMAScript Decorator proposal","archived":false,"fork":false,"pushed_at":"2019-03-13T15:45:26.000Z","size":535,"stargazers_count":9,"open_issues_count":0,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-24T16:09:58.106Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://tech-query.me/DataScheme/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TechQuery.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":"2018-09-28T06:46:47.000Z","updated_at":"2022-10-06T05:52:07.000Z","dependencies_parsed_at":"2023-05-18T15:01:07.142Z","dependency_job_id":null,"html_url":"https://github.com/TechQuery/DataScheme","commit_stats":{"total_commits":10,"total_committers":2,"mean_commits":5.0,"dds":0.09999999999999998,"last_synced_commit":"9f7902bc6ab0e1e4646c3154195f98760b654eac"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TechQuery%2FDataScheme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TechQuery%2FDataScheme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TechQuery%2FDataScheme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TechQuery%2FDataScheme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TechQuery","download_url":"https://codeload.github.com/TechQuery/DataScheme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249041475,"owners_count":21203106,"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-10-01T13:04:58.501Z","updated_at":"2025-04-15T09:25:32.579Z","avatar_url":"https://github.com/TechQuery.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Data Scheme\n\n**Data Model** framework based on [ECMAScript Decorator proposal](https://github.com/tc39/proposal-decorators)\n\n[![NPM Dependency](https://david-dm.org/TechQuery/DataScheme.svg)](https://david-dm.org/TechQuery/DataScheme)\n[![Build Status](https://travis-ci.com/TechQuery/DataScheme.svg?branch=master)](https://travis-ci.com/TechQuery/DataScheme)\n[![](https://data.jsdelivr.com/v1/package/npm/data-scheme/badge?style=rounded)](https://www.jsdelivr.com/package/npm/data-scheme)\n\n[![NPM](https://nodei.co/npm/data-scheme.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/data-scheme/)\n\n\n\n## Basic Example\n\n[`User.js`](https://tech-query.me/DataScheme/test-file/test/source/User.js.html)\n\n```JavaScript\nimport Model, { mapGetter, is, Range, Email, Phone, URL } from 'data-scheme';\n\n\n@mapGetter\nexport default  class User extends Model {\n\n    @is(/^[\\w-]{3,20}$/, '')\n    set name(value) {  this.set('name', value);  }\n\n    @is(Email, '')\n    set email(value) {  this.set('email', value);  }\n\n    @is( Phone )\n    set phone(value) {  this.set('phone', value);  }\n\n    @is([0, 1, 2],  2)\n    set gender(value) {  this.set('gender', value);  }\n\n    @is(Range( 1900 ))\n    set birthYear(value) {  this.set('birthYear', value);  }\n\n    @is(URL, 'http://example.com/test.jpg')\n    set avatar(value) {  this.set('avatar', value);  }\n\n    @is( URL )\n    set URL(value) {  this.set('URL', value);  }\n\n    @is( String )\n    set description(value) {  this.set('description', value);  }\n}\n```\n\n`index.js`\n\n```JavaScript\nimport User from './User';\n\nconst user = new User({\n    name:   'test',\n    email:  'test@example.com'\n});\n\nuser.phone = '+86-028-88888888';\n\nconsole.log( user.valueOf() );\n```\n\n**Console output**\n\n```JSON\n{\n    \"name\": \"test\",\n    \"email\": \"test@example.com\",\n    \"gender\": 2,\n    \"avatar\": \"http://example.com/test.jpg\",\n    \"phone\": \"+86-028-88888888\"\n}\n```\n\n\n## Installation\n\n```Shell\nnpm install data-scheme @babel/polyfill\n\nnpm install -D \\\n    @babel/cli \\\n    @babel/core \\\n    @babel/preset-env \\\n    @babel/plugin-proposal-decorators\n```\n\n`.babelrc`\n\n```JSON\n{\n    \"presets\": [\n        \"@babel/preset-env\"\n    ],\n    \"plugins\": [\n        [\n            \"@babel/plugin-proposal-decorators\",\n            {\n                \"decoratorsBeforeExport\": true\n            }\n        ]\n    ]\n}\n```\n\n\n## Advanced usage\n\n - [Scheme Helper](https://tech-query.me/DataScheme/file/source/scheme.js.html)\n\n - [Inherited \u0026 Nested Model](https://tech-query.me/DataScheme/test-file/test/source/User.js.html#lineNumber33)\n\n\n### Observe Values changing\n\n```JavaScript\nimport User from './User';\n\nconst user = new User({\n    name:   'test',\n    email:  'test@example.com'\n});\n\nuser.observe({\n    name(value, oldValue) {\n\n        console.log(value, oldValue);    //  'example' 'test'\n    }\n});\n\nuser.name = 'example';\n```\n\n### Decorator hook\n\n`hook.js`\n\n```JavaScript\nimport { listen } from 'data-scheme';\n\nlisten('HTTP',  ({Class, method, path, contentType}) =\u003e\n    console.log(Class, method, path, contentType)\n);\n```\n\n`User.js`\n\n```JavaScript\nimport Model, { mapGetter, HTTP } from 'data-scheme';\n\n@HTTP('POST', '/user')\n@HTTP('GET', '/user')\n@mapGetter\nexport default  class User extends Model {\n    //  Field defination\n}\n```\n\n`index.js`\n\n```JavaScript\nimport './hook';\n\nimport User from './User';\n```\n\n\n## Learn more\n\n 1. [Meta programming](https://github.com/tc39/proposal-decorators/blob/master/METAPROGRAMMING.md)\n\n 2. [Decorator API (Stage-2)](https://github.com/tc39/proposal-decorators/blob/master/TAXONOMY.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechquery%2Fdatascheme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftechquery%2Fdatascheme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechquery%2Fdatascheme/lists"}