{"id":22514754,"url":"https://github.com/cityssm/pdf-form-extract","last_synced_at":"2025-03-28T01:45:18.591Z","repository":{"id":65329804,"uuid":"588651672","full_name":"cityssm/pdf-form-extract","owner":"cityssm","description":"Extracts PDF form fields into a Javascript object","archived":false,"fork":false,"pushed_at":"2023-04-10T03:04:59.000Z","size":438,"stargazers_count":1,"open_issues_count":5,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-19T13:47:01.143Z","etag":null,"topics":["forms","pdf","pdf-extracting","pdf-forms"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@cityssm/pdf-form-extract","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/cityssm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-13T16:42:58.000Z","updated_at":"2023-01-16T19:52:12.000Z","dependencies_parsed_at":"2025-02-02T03:26:28.680Z","dependency_job_id":"5c01f21b-83fb-4b39-b9a3-4ed9f88ecdbf","html_url":"https://github.com/cityssm/pdf-form-extract","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cityssm%2Fpdf-form-extract","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cityssm%2Fpdf-form-extract/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cityssm%2Fpdf-form-extract/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cityssm%2Fpdf-form-extract/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cityssm","download_url":"https://codeload.github.com/cityssm/pdf-form-extract/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245954295,"owners_count":20699806,"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":["forms","pdf","pdf-extracting","pdf-forms"],"created_at":"2024-12-07T03:21:18.416Z","updated_at":"2025-03-28T01:45:18.572Z","avatar_url":"https://github.com/cityssm.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PDF Form Extract\n\n[![npm (scoped)](https://img.shields.io/npm/v/@cityssm/pdf-form-extract)](https://www.npmjs.com/package/@cityssm/pdf-form-extract)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/233ab487462d4133aa5313fa1a61660b)](https://www.codacy.com/gh/cityssm/pdf-form-extract/dashboard?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=cityssm/pdf-form-extract\u0026amp;utm_campaign=Badge_Grade)\n[![Maintainability](https://api.codeclimate.com/v1/badges/c4a35e18908c159ecb88/maintainability)](https://codeclimate.com/github/cityssm/pdf-form-extract/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/c4a35e18908c159ecb88/test_coverage)](https://codeclimate.com/github/cityssm/pdf-form-extract/test_coverage)\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cityssm/pdf-form-extract/coverage.yml)](https://github.com/cityssm/pdf-form-extract/actions/workflows/coverage.yml)\n[![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/cityssm/pdf-form-extract)](https://app.snyk.io/org/cityssm/project/78ebff99-06fc-4153-a2c8-ccededba162e)\n\nExtracts PDF form fields into a Javascript object.\n\n## Installation\n\n    npm install @cityssm/pdf-form-extract\n\n## Usage\n\n![PDF Screenshot](test/testForm.png)\n\n```javascript\nimport extractFormFields from \"@cityssm/pdf-form-extract\"\n\nconst data = await extractFormFields('test/testForm.pdf')\nconsole.log(data)\n\nconst dataWithOptions = await extractFormFields('test/testForm.pdf', { useFieldName: true })\n```\n\n```json\n{\n  \"Contractor Firm Name\": \"The City of Sault Ste. Marie\",\n  \"Address\": \"https://github.com/cityssm/pdf-form-extract\",\n  \"Contractor Representative Print Name\": \"Dan Gowans\",\n  \"Date\": \"2023-01-13\"\n}\n```\n\n### Optional Options\n\n**useFieldName**\u003cbr /\u003e\n_Default = false_\u003cbr /\u003e\nUses the field name (provided by the Form API) as the Object key\ninstead of the field key.\n\n## Notes\n\nFor the best results, the form fields in the PDF should be properly labelled.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcityssm%2Fpdf-form-extract","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcityssm%2Fpdf-form-extract","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcityssm%2Fpdf-form-extract/lists"}