{"id":13880999,"url":"https://github.com/mayflower/postgraphile-audit-plugin","last_synced_at":"2026-02-13T23:57:18.897Z","repository":{"id":44008582,"uuid":"236195030","full_name":"mayflower/postgraphile-audit-plugin","owner":"mayflower","description":"  This plugin adds functionality to access pgMemento's audit data on an entity level from a postgraphile graphql api.","archived":false,"fork":false,"pushed_at":"2023-01-05T05:43:09.000Z","size":1367,"stargazers_count":11,"open_issues_count":16,"forks_count":2,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-07-06T22:08:17.760Z","etag":null,"topics":["audit","graphql","pgmemento","postgraphile"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/postgraphile-audit-plugin","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/mayflower.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}},"created_at":"2020-01-25T16:21:17.000Z","updated_at":"2023-03-17T20:55:21.000Z","dependencies_parsed_at":"2023-02-03T14:01:42.939Z","dependency_job_id":null,"html_url":"https://github.com/mayflower/postgraphile-audit-plugin","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/mayflower/postgraphile-audit-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mayflower%2Fpostgraphile-audit-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mayflower%2Fpostgraphile-audit-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mayflower%2Fpostgraphile-audit-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mayflower%2Fpostgraphile-audit-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mayflower","download_url":"https://codeload.github.com/mayflower/postgraphile-audit-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mayflower%2Fpostgraphile-audit-plugin/sbom","scorecard":{"id":630374,"data":{"date":"2025-08-11","repo":{"name":"github.com/mayflower/postgraphile-audit-plugin","commit":"b91ec923be98b2557f89847adde4c6185251caa5"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 1/27 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 4 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"51 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-6chw-6frg-f759","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3","Warn: Project is vulnerable to: MAL-2023-462","Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-8cf7-32gw-wr33","Warn: Project is vulnerable to: GHSA-hjrf-2m68-5959","Warn: Project is vulnerable to: GHSA-qwph-4952-7xr6","Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-21T07:44:54.215Z","repository_id":44008582,"created_at":"2025-08-21T07:44:54.216Z","updated_at":"2025-08-21T07:44:54.216Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29424262,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-13T22:20:51.549Z","status":"ssl_error","status_checked_at":"2026-02-13T22:20:49.838Z","response_time":78,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["audit","graphql","pgmemento","postgraphile"],"created_at":"2024-08-06T08:03:45.469Z","updated_at":"2026-02-13T23:57:18.881Z","avatar_url":"https://github.com/mayflower.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Motivation\n\nThis plugin adds functionality to access [pgMemento](https://github.com/pgMemento/pgMemento)'s audit data on an entity level from a [postgraphile](https://www.graphile.org/postgraphile/) graphql api.\n\nEach Entity for an audited table can be extended automatically with the following properties:\n\n```graphql\ninterface Audited {\n  firstAuditEvent: AuditEvent!\n  lastAuditEvent: AuditEvent!\n  createdAt: String!\n  lastModifiedAt: String!\n  createdBy: String!\n  lastModifiedBy: String!\n  auditEvents(\n    first: Int\n    last: Int\n    offset: Int\n    before: Cursor\n    after: Cursor\n  ): AuditEventsConnection!\n}\n\ninterface AuditEvent {\n  id: BigInt\n  auditId: BigInt\n  eventId: Int\n  transactionId: Int\n  userName: String\n  stmtDate: Datetime\n  sessionInfo: JSON\n  valuesBefore: JSON\n  valuesAfter: JSON\n}\n```\n\nProperties can be renamed using inflection and their presence can be configured.\n\n# Installation\n\n```sh\nnpm install postgraphile-audit-plugin\n# this will ask you for a target schema and then create the `AuditEvent` type and `get_audit_information` function.\npsql -h host -p 5432 -U user -d database -f Setup.sql\n```\n\n# Usage\n\nThe plugin comes preconfigured out of the box. It can be configured using a `.postgraphilerc.js`:\n\n```js\n/**\n * @type {import(\"./src\").AuditPluginOptions}\n */\nconst auditPlugin = {\n  /**\n   * name of the schema that contains the `get_audit_information` function\n   */\n  auditFunctionSchema: \"public\",\n\n  /**\n   * include \"auditEvents\" connection on audited types\n   */\n  auditEventConnection: true,\n\n  /**\n   * include \"firstAuditEvent\" and \"lastAuditEvent\" field on audited types\n   */\n  firstLastAuditEvent: true,\n\n  /**\n   * include \"createdAt\" and \"lastModifiedAt\" field on audited types\n   */\n  dateProps: true,\n\n  /**\n   * include \"createdBy\" and \"lastModifiedBy\" on audited types\n   */\n  nameProps: true,\n\n  /**\n   * define how \"name\" properties should be filled - either with the transaction's \"user_name\", or with a value from the \"session_info\" JSON\n   * can be \"user_name\" or \"session_info\";\n   */\n  nameSource: \"session_info\",\n\n  /**\n   * if `nameSource` is \"session_info\", this describes the path to the username within the JSON\n   * e.g. \"{name}\" or \"{nested,user,name}\" (see the #\u003e\u003e notation described in https://www.postgresql.org/docs/9.3/functions-json.html)\n   */\n  nameSessionInfoJsonPath: \"{nested,name}\",\n\n  /**\n   * if name cannot be filled (because it is null or undefined), fall back to this value\n   */\n  nameFallback: \"unknown user\",\n};\n\nmodule.exports = {\n  options: {\n    graphileBuildOptions: {\n      auditPlugin,\n    },\n  },\n};\n```\n\n# Extracting the user name from a JWT and writing it to `session_info`\n\nYou can return an object contining the key `pgmemento.session_info` from a callback provided to the `pgSettings` option.\nAt this point, postgraphile will already have validated the JWT against the `jwtSecret` option, so you can trust the claims without additional validation. A basic usage could look like this (e.g. in your `.postgraphilerc.js`):\n\n```js\nmodule.exports = {\n  options: {\n    async pgSettings(req) {\n      const claims = getClaimsFromRequest(req);\n      return {\n        \"pgmemento.session_info\": JSON.stringify({\n          userId: claims.name,\n        }),\n      };\n    },\n    jwtSecret: \"my-jwt-secret\",\n  },\n};\n\nfunction getClaimsFromRequest(req) {\n  try {\n    const { authorization } = req.headers;\n    const [, token] = /^\\s*bearer\\s+(.*?)\\s*$/i.exec(authorization);\n    const [, claims] = token.split(\".\");\n    return JSON.parse(Buffer.from(claims, \"base64\").toString());\n  } catch {\n    return {};\n  }\n}\n```\n\n# License\n\nMIT. See [LICENSE](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmayflower%2Fpostgraphile-audit-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmayflower%2Fpostgraphile-audit-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmayflower%2Fpostgraphile-audit-plugin/lists"}