{"id":25308165,"url":"https://github.com/alenap93/kysely-crypto","last_synced_at":"2025-04-07T07:55:50.567Z","repository":{"id":276279683,"uuid":"925721264","full_name":"alenap93/kysely-crypto","owner":"alenap93","description":"Crypto plugin for kysely","archived":false,"fork":false,"pushed_at":"2025-04-05T06:42:06.000Z","size":284,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-05T07:27:21.523Z","etag":null,"topics":["crypto","database","kysely","query-builder","sql"],"latest_commit_sha":null,"homepage":"","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/alenap93.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":"2025-02-01T15:31:41.000Z","updated_at":"2025-04-05T06:42:07.000Z","dependencies_parsed_at":"2025-03-29T06:34:49.905Z","dependency_job_id":null,"html_url":"https://github.com/alenap93/kysely-crypto","commit_stats":null,"previous_names":["alenap93/kysely-crypto"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alenap93%2Fkysely-crypto","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alenap93%2Fkysely-crypto/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alenap93%2Fkysely-crypto/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alenap93%2Fkysely-crypto/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alenap93","download_url":"https://codeload.github.com/alenap93/kysely-crypto/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247305904,"owners_count":20917201,"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":["crypto","database","kysely","query-builder","sql"],"created_at":"2025-02-13T11:57:33.716Z","updated_at":"2025-04-07T07:55:50.561Z","avatar_url":"https://github.com/alenap93.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n  \n\n# kysely-crypto\n\n  \n\n[![CI](https://github.com/alenap93/kysely-crypto/actions/workflows/test.yml/badge.svg)](https://github.com/alenap93/kysely-crypto/actions/workflows/test.yml)\n\n[![NPM version](https://img.shields.io/npm/v/kysely-crypto.svg?style=flat)](https://www.npmjs.com/package/kysely-crypto)\n\n[![NPM downloads](https://img.shields.io/npm/dm/kysely-crypto.svg?style=flat)](https://www.npmjs.com/package/kysely-crypto)\n\n[![js-prettier-style](https://img.shields.io/badge/code%20style-prettier-brightgreen.svg?style=flat)](https://prettier.io/)\n\n  \n\nCrypto plugin for kysely, fully typed, developed for Node.js but also runs on Deno and Bun; with this plugin you can encrypt or decrypt fields using crypto-js library.\n\n\n\n## Install\n\n```\nnpm i kysely kysely-crypto\n```\n\n## Usage\n\n**Options**\n\n* fieldsToDecrypt: *field to decrypt in result (use alias if it is used)*\n\n* fieldsToEncrypt: *field to encrypt during insert and update, or in '=' and '!=' where condition (use alias if it is used)*\n\n* cryptoParameters: *encryption options*\n\n    * cryptoAlgorithm: *cipher algorithm*\n\n    * secretKey: *custom secretKey*\n\n    * iv: *custom iv in hex to be converted in word array (using CryptoJS.enc.Hex.parse(iv))*\n\n    * mode: *block mode, default: CBC*\n\n    * padding: *block padding, default: Pkcs7*\n\n\n**How to use**\n\n***WARNING: fields must be of string types***\n\n    const kyselyInstance = new Kysely\u003cDatabase\u003e({\n        dialect: new SqliteDialect({\n            database: new Database(':memory:'),\n        }),    \n    })\n    \n    await kyselyInstance.schema\n    .createTable('person')\n    .ifNotExists()\n    .addColumn('id', 'integer', (col) =\u003e col.primaryKey())\n    .addColumn('first_name', 'varchar(255)')\n    .addColumn('last_name', 'varchar(255)')\n    .addColumn('gender', 'varchar(255)')\n    .execute()\n    \n    await kyselyInstance\n    .insertInto('person')\n    .values([\n        {   \n            first_name: 'Max',\n            last_name: 'Jack',\n            gender: 'man',\n        },\n        {\n            first_name: 'George',\n            last_name: 'Rossi',\n            gender: 'man',\n        },\n    ])\n    .withPlugin(\n        new KyselyCryptoPlugin\u003cDatabase\u003e({\n            fieldsToEncrypt: ['last_name'],\n            fieldsToDecrypt: [],\n            cryptoParameters: {\n                cryptoAlgorithm: 'AES',\n                secretKey: '996bf1b118a02007ea2c7001d92e0f91',\n                iv: 'df77b550164054c9e671ebbf2f9976b0',\n            },\n        }),\n    )\n    .execute()\n    \n    const selectDecrypted = await kyselyInstance\n    .selectFrom('person')\n    .selectAll()\n    .where('last_name', '=', 'Jack')    \n    .withPlugin(\n        new KyselyCryptoPlugin\u003cDatabase\u003e({\n            fieldsToEncrypt: ['last_name'],\n            fieldsToDecrypt: ['last_name'],\n            cryptoParameters: {\n                cryptoAlgorithm: 'AES',\n                secretKey: '996bf1b118a02007ea2c7001d92e0f91',\n                iv: 'df77b550164054c9e671ebbf2f9976b0',\n            }\n        }),\n    )\n    .executeTakeFirst()  \n\n## License\n\n  \n\nLicensed under [MIT](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falenap93%2Fkysely-crypto","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falenap93%2Fkysely-crypto","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falenap93%2Fkysely-crypto/lists"}