node-signpdf 3.0.0 - deprecation release

CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## [3.0.0]
+
+**node-signpdf is DEPRECATAED**
+
+It is being replaced by the `@signpdf` scoped packages which introduces:
+
+* Split the helpers into separate packages `@signpdf/placeholder-pdfkit010` and `@signpdf/placeholder-plain`;
+* Decoupled the signing algorythm and the PDF signing process. Now `@signpdf/signpdf` understands PDFs and `@signpdf/signer-p12` understands P12 and `node-forge`;
+* sign() is now async to allow for hooking different signers;
+* Introduced examples in `packages/examples`;
+* Introduced more types declarations through TS and JSDoc;
+
+It keeps the same [GitHub repo](https://github.com/vbuch/node-signpdf) but is published differently **[in npm](https://www.npmjs.com/search?q=%40signpdf)**.
+
 ## [2.0.0]
 
 * Only publish dist files into npm (see https://bit.ly/46rykd7 on why this requires a major version);

CONTRIBUTING.md

@@ -1,10 +1,6 @@
-# Contributing
+# **node-signpdf is DEPRECATAED**
 
-* All PRs are welcome in the `develop` branch.
-* Please, stick to the repo's defined [Purpose](README.md#purpose) and try to write your code as readable as possible.
-* We do code reviews and may ask you to change things before we merge code.
-* This is a git-flow repo. We use the default git flow with a `v` version prefix. You shouldn't care much while writeing a feature but good to know.
-* Note that [gitmoji](https://gitmoji.carloscuesta.me/) is used in the commit messages. That's not a must but we think it's nice.
+You are still welcome to contribute to [@signpdf](https://github.com/vbuch/node-signpdf).
 
 ## Contributors
 

README.md

@@ -1,10 +1,10 @@
-# ![node-signpdf](https://raw.githubusercontent.com/vbuch/node-signpdf/master/resources/logo-horizontal.svg?sanitize=true)
+# **node-signpdf is DEPRECATAED**
 
-[![npm version](https://badge.fury.io/js/node-signpdf.svg)](https://badge.fury.io/js/node-signpdf)
-[![Coverage Status](https://coveralls.io/repos/github/vbuch/node-signpdf/badge.svg?branch=master)](https://coveralls.io/github/vbuch/node-signpdf?branch=master)
-[![Known Vulnerabilities](https://snyk.io/test/npm/node-signpdf/badge.svg)](https://snyk.io/test/npm/node-signpdf)
-[![Donate to this project using Buy Me A Coffee](https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg)](https://buymeacoffee.com/vbuch)
-![GitHub last commit](https://img.shields.io/github/last-commit/vbuch/node-signpdf?color=red)
+It is being replaced by [@signpdf](https://github.com/vbuch/node-signpdf).
+
+_________________________________
+
+![Deprecated since Oct 2023](https://img.shields.io/badge/deprecated-since_Oct_2023-red) [![Replaced by @signpdf/signpdf](https://img.shields.io/badge/replaced_by-@signpdf/signpdf-green)](https://github.com/vbuch/node-signpdf)
 
 Simple signing of PDFs in node.
 
@@ -26,6 +26,8 @@ The purpose of this package is not as much to be used as a dependendency, althou
 
 ## Usage
 
+![Deprecated since Oct 2023](https://img.shields.io/badge/deprecated-since_Oct_2023-red) [![Replaced by @signpdf/signpdf](https://img.shields.io/badge/replaced_by-@signpdf/signpdf-green)](https://github.com/vbuch/node-signpdf)
+
 Install with  `npm i -S node-signpdf node-forge`.
 
 In practice we expect that most people will just read through the code we've written in the testing part of this package and figure it out themselves. If that's your case, you should read the [[Signing PDF in simple steps]](#signing-pdf-in-simple-steps) section.
@@ -55,6 +57,8 @@ const signedPdf = signer.sign(
 
 ## Notes
 
+![Deprecated since Oct 2023](https://img.shields.io/badge/deprecated-since_Oct_2023-red) [![Replaced by @signpdf/signpdf](https://img.shields.io/badge/replaced_by-@signpdf/signpdf-green)](https://github.com/vbuch/node-signpdf)
+
 * The process of signing a document is described in the [Digital Signatures in PDF](https://www.adobe.com/devnet-docs/etk_deprecated/tools/DigSig/Acrobat_DigitalSignatures_in_PDF.pdf) document. As Adobe's files are deprecated, [here is the standard as defined by ETSI](<https://ec.europa.eu/digital-building-blocks/wikis/display/DIGITAL/Standards+and+specifications#Standardsandspecifications-PAdES(PDFAdvancedElectronicSignature)BaselineProfile>).
 * This lib:
   * requires the [signature placeholder](#append-a-signature-placeholder) to already be in the document (There are helpers included that can try to add it);
@@ -111,6 +115,4 @@ That's where the Signer kicks in. Given a PDF and a P12 certificate a signature
 * [node-forge](https://github.com/digitalbazaar/forge) is an awesome package written in pure JavaScript and [supports signing in detached mode](https://github.com/digitalbazaar/forge/pull/605). Many thanks to all the guys who wrote and maintain it.
 * Thanks to the guys of [PDFKit](https://github.com/foliojs/pdfkit) as well. They've made PDF generation incredibly easy.
 
-## [Contributing](CONTRIBUTING.md)
-
-## [Changelog](CHANGELOG.md)
+## `node-signpdf` is ![deprecated since Oct 2023](https://img.shields.io/badge/deprecated-since_Oct_2023-red) and is being [![replaced by @signpdf/signpdf](https://img.shields.io/badge/replaced_by-@signpdf/signpdf-green)](https://github.com/vbuch/node-signpdf)

RELEASE-CHECKLIST.md

@@ -1,5 +1,5 @@
 # RELEASE CHECKLIST
 
-[ ] yarn build
-[ ] Update CHANGELOG
-[ ] Update version in package.json
+**node-signpdf is DEPRECATAED**
+
+Further releases will happen in [@signpdf](https://github.com/vbuch/node-signpdf).

package.json

@@ -1,7 +1,7 @@
 {
     "name": "node-signpdf",
-    "version": "2.0.0",
-    "description": "Simple signing of PDFs in node.",
+    "version": "3.0.0",
+    "description": "DEPRECATED. Have a look at @signpdf/signpdf instead.",
     "repository": {
         "type": "git",
         "url": "https://github.com/vbuch/node-signpdf"
@@ -67,4 +67,4 @@
         "pdfkit": "^0.10.0",
         "typescript": "^5.2.2"
     }
-}
+}