{"id":20295694,"url":"https://github.com/imenesesl/scheme-adapter","last_synced_at":"2025-04-11T12:05:40.488Z","repository":{"id":54516586,"uuid":"338356551","full_name":"imenesesl/scheme-adapter","owner":"imenesesl","description":"scheme-adapter","archived":false,"fork":false,"pushed_at":"2021-02-13T20:33:23.000Z","size":35,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-08-08T15:18:20.646Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/imenesesl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-12T15:27:13.000Z","updated_at":"2021-10-12T15:05:24.000Z","dependencies_parsed_at":"2022-08-13T18:20:55.759Z","dependency_job_id":null,"html_url":"https://github.com/imenesesl/scheme-adapter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imenesesl%2Fscheme-adapter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imenesesl%2Fscheme-adapter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imenesesl%2Fscheme-adapter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imenesesl%2Fscheme-adapter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imenesesl","download_url":"https://codeload.github.com/imenesesl/scheme-adapter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224646619,"owners_count":17346404,"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-14T15:35:45.139Z","updated_at":"2024-11-14T15:35:45.922Z","avatar_url":"https://github.com/imenesesl.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# scheme-adapter\n\n#### `Super lightweight package to manage your models with schemes`\n\n- ## Scheme - adapter\n\n```ts\nexport declare type Scheme\u003cM\u003e = {\n  [P in keyof Required\u003cM\u003e]: M[P];\n};\n\nexport declare const adapter: \u003cM\u003e(item: any, schema: Scheme\u003cM\u003e) =\u003e M;\n```\n\nSet your default values using a base interface\n\n_The schema requires you to define all the properties_\n\n#### Example\n\n```ts\nimport { adapter, Scheme } from 'scheme-adapter';\n\nexport interface User {\n  name: string;\n  email: string;\n  isActive: boolean;\n}\n\nexport const UserScheme: Scheme\u003cUser\u003e = {\n  email: 'luismenesesep@gmail.com',\n  isActive: false,\n  name: '',\n};\n\nexport const userAdapter = (user: any): User =\u003e adapter\u003cUser\u003e(user, UserScheme);\n\n// in\nuserAdapter({ name: 'Luis Meneses' });\n\n// out\n{\n    email: 'luismenesesep@gmail.com',\n    isActive: false,\n    name: 'Luis Meneses',\n}\n```\n\n- ## SchemeTransform - transformAdapter\n\n```ts\nexport declare type Operators = '' | ' ' | 'and' | 'or' | 'join-array' | 'join-map' | 'sum' | 'rest' | 'divide' | 'multiply';\n\ninterface TransformPayload\u003cM, P extends keyof M\u003e {\n  value: M[P];\n  transforms: Array\u003cstring\u003e;\n  join?: Operators;\n}\n\nexport declare type SchemeTransform\u003cM\u003e = {\n  [P in keyof Required\u003cM\u003e]: TransformPayload\u003cM, P\u003e;\n};\n\nexport declare const transformAdapter: \u003cM\u003e(item: any, schema: SchemeTransform\u003cM\u003e) =\u003e M;\n```\n\nDefine their default values using a base interface and the different properties in a standard model\n\nEach property provide three options by TransformPayload where:\n\n- `value`: Default value\n- `transforms`: List of properties to join\n- `join`: Operator to join properties\n\n⚠️ Warning\n\nIn this version the `join` property only works to operations with booleans, numbers, arrays, maps and strings, if you need more operations, it is suggested that you perform these operations separately.\n\n_The schema requires you to define all the properties_\n\n#### Example #1 - strings\n\n```ts\nimport { SchemeTransform, transformAdapter } from 'scheme-adapter';\n\nexport interface User {\n  name: string;\n  email: string;\n  isActive: boolean;\n}\n\nexport const UserSchemaTransfrom: SchemeTransform\u003cUser\u003e = {\n  email: {\n    value: '',\n    transforms: ['personalEmail'],\n  },\n  isActive: {\n    transforms: ['status'],\n    value: false,\n  },\n  name: {\n    transforms: ['name', 'lastName'],\n    join: ' ',\n    value: '',\n  },\n};\n\nexport const userTransform = (user: any): User =\u003e transformAdapter\u003cUser\u003e(user, UserSchemaTransfrom);\n\n// in\nuserTransform({\n    personalEmail: 'luismenesesep@gmail.com',\n    name: 'Luis',\n    lastName: 'Meneses',\n  });\n\n// out\n{\n    email: 'luismenesesep@gmail.com',\n    isActive: false,\n    name: 'Luis Meneses',\n}\n```\n\n#### Example #2 - numbers\n\n```ts\nimport { SchemeTransform, transformAdapter } from 'scheme-adapter';\n\nexport interface MathOperations {\n  sum: number;\n  rest: number;\n  divided: number;\n  multiply: number;\n}\n\nexport const MathOperationsSchemeTranform: SchemeTransform\u003cMathOperations\u003e = {\n  divided: {\n    transforms: ['DaysPerYear', 'MonthsPerYear', 'HoursPerDay'],\n    join: 'divide',\n    value: 0,\n  },\n\n  rest: {\n    transforms: ['CurrentYear', 'BirthDate'],\n    join: 'rest',\n    value: 0,\n  },\n  sum: {\n    transforms: ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'],\n    join: 'sum',\n    value: 0,\n  },\n  multiply: {\n    transforms: ['DaysPerYear', 'HoursPerDay'],\n    join: 'multiply',\n    value: 0,\n  },\n};\n\nexport const mathOperationsTransform = (mathOperations: any): MathOperations =\u003e\n  transformAdapter\u003cMathOperations\u003e(mathOperations, MathOperationsSchemeTranform);\n\n// in\nmathOperationsTransform({\n    January: 31,\n    February: 28,\n    March: 31,\n    April: 30,\n    May: 31,\n    June: 30,\n    July: 31,\n    August: 31,\n    September: 30,\n    October: 31,\n    November: 30,\n    December: 31,\n    CurrentYear: 2021,\n    BirthDate: 1995,\n    DaysPerYear: 365,\n    MonthsPerYear: 12,\n    HoursPerDay: 24,\n  });\n\n// out\n{\n    divided: 1.2673611111111112,\n    rest: 26,\n    sum: 365,\n    multiply: 8760,\n}\n```\n\n#### Example #3 - booleans\n\n```ts\nimport { SchemeTransform, transformAdapter } from 'scheme-adapter';\n\nexport interface BooleanOperations {\n  isPremium: boolean;\n  isFreePremium: boolean;\n}\n\nexport const BooleanOperationsSchemeTranform: SchemeTransform\u003cBooleanOperations\u003e = {\n  isFreePremium: {\n    transforms: ['isActive', 'isCertificated'],\n    join: 'or',\n    value: false,\n  },\n  isPremium: {\n    transforms: ['isActive', 'isPremium', 'isCertificated'],\n    join: 'and',\n    value: false,\n  },\n};\n\nexport const booleanOperationsTransform = (booleanOperations: any): BooleanOperations =\u003e\n  transformAdapter\u003cBooleanOperations\u003e(booleanOperations, BooleanOperationsSchemeTranform);\n\n// in\nbooleanOperationsTransform({\n    isActive: true,\n    isPremium: false,\n    isCertificated: true,\n  });\n\n// out\n{\n    isFreePremium: true,\n    isPremium: false,\n}\n```\n\n#### Example #3 - maps\n\n```ts\nimport { SchemeTransform, transformAdapter } from 'scheme-adapter';\n\nexport interface MapOperations {\n  user: User;\n  contact: Contact;\n  owner: User;\n}\n\nexport const MapOperationsSchemeTranform: SchemeTransform\u003cMapOperations\u003e = {\n  contact: {\n    transforms: ['location', 'contact'],\n    join: 'join-map',\n    value: {\n      country: '',\n      phone: '',\n    },\n  },\n  user: {\n    transforms: ['status', 'user', 'contact'],\n    join: 'join-map',\n    value: {\n      email: '',\n      isActive: false,\n      name: '',\n    },\n  },\n  owner: {\n    transforms: ['provider'],\n    join: 'join-map',\n    value: {\n      email: '',\n      isActive: false,\n      name: '',\n    },\n  },\n};\n\nexport const mapOperationsTransform = (mapOperations: any): MapOperations =\u003e\n  transformAdapter\u003cMapOperations\u003e(mapOperations, MapOperationsSchemeTranform);\n\n// in\nmapOperationsTransform({\n    location: {\n      country: 'Colombia',\n      code: '+57',\n    },\n    contact: {\n      phone: '0000000000',\n      email: 'luismenesesep@gmail.com',\n    },\n    status: {\n      isActive: true,\n    },\n    user: {\n      name: 'Luis',\n      lastName: 'Meneses',\n    },\n    provider: {\n      email: 'org@gmail.com',\n      isActive: true,\n      name: 'ORG',\n    },\n  });\n\n// out\n{\n    contact: { country: 'Colombia', phone: '0000000000' },\n    user: { email: 'luismenesesep@gmail.com', isActive: true, name: 'Luis' },\n    owner: { email: 'org@gmail.com', isActive: true, name: 'ORG' },\n}\n```\n\n#### Example #3 - arrays\n\n```ts\nimport { SchemeTransform, transformAdapter } from 'scheme-adapter';\n\nexport interface ArrayOperations {\n  users: Array\u003cUser\u003e;\n}\n\nexport const ArrayOperationsSchemeTranform: SchemeTransform\u003cArrayOperations\u003e = {\n  users: {\n    transforms: ['premium', 'free', 'freemium'],\n    join: 'join-array',\n    value: [],\n  },\n};\n\nexport const arrayOperationsTransform = (arrayOperations: any): ArrayOperations =\u003e\n  transformAdapter\u003cArrayOperations\u003e(arrayOperations, ArrayOperationsSchemeTranform);\n\n// in\narrayOperationsTransform({\n    premium: Array.from(Array(10).keys()).map(user =\u003e userAdapter(user)),\n    free: Array.from(Array(10).keys()).map(user =\u003e userAdapter(user)),\n    freemium: Array.from(Array(10).keys()).map(user =\u003e userAdapter(user)),\n  });\n\n// out\n{\n    users: [ {...1}, {...2}, ..., {...30} ],\n}\n```\n\n## Get Started\n\n- Add the following in the dependencies of your package.json\n\n```bash\nnpm install scheme-adapter\n```\n\n- Ready to use\n\n```ts\nimport { adapter, Scheme, SchemeTransform, transformAdapter } from 'scheme-adapter';\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimenesesl%2Fscheme-adapter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimenesesl%2Fscheme-adapter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimenesesl%2Fscheme-adapter/lists"}