pdf-lite 1.0.0 → 1.0.1-alpha.2

package/docs/security/types/README.md

@@ -0,0 +1,19 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / security/types
+
+# security/types
+
+## Type Aliases
+
+- [CryptFilterType](type-aliases/CryptFilterType.md)
+- [PdfCryptFilterDictionary](type-aliases/PdfCryptFilterDictionary.md)
+- [PdfEncryptionAlgorithmOptions](type-aliases/PdfEncryptionAlgorithmOptions.md)
+- [PdfEncryptionAlgorithmType](type-aliases/PdfEncryptionAlgorithmType.md)
+- [PdfEncryptionDictionary](type-aliases/PdfEncryptionDictionary.md)
+- [PdfEncryptionDictionaryObject](type-aliases/PdfEncryptionDictionaryObject.md)
+- [PdfEncryptionOptions](type-aliases/PdfEncryptionOptions.md)
+- [PdfEncryptionRecipient](type-aliases/PdfEncryptionRecipient.md)
+- [PdfId](type-aliases/PdfId.md)

package/docs/security/types/type-aliases/CryptFilterType.md

@@ -0,0 +1,15 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [security/types](../README.md) / CryptFilterType
+
+# Type Alias: CryptFilterType
+
+> **CryptFilterType** = `"string"` \| `"stream"` \| `"file"`
+
+Specifies the type of content being encrypted.
+
+- 'string': PDF string objects
+- 'stream': PDF stream objects
+- 'file': Embedded file streams

package/docs/security/types/type-aliases/PdfCryptFilterDictionary.md

@@ -0,0 +1,12 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [security/types](../README.md) / PdfCryptFilterDictionary
+
+# Type Alias: PdfCryptFilterDictionary
+
+> **PdfCryptFilterDictionary** = [`PdfDictionary`](../../../core/objects/pdf-dictionary/classes/PdfDictionary.md)\<\{ `AuthEvent`: [`PdfName`](../../../core/objects/pdf-name/classes/PdfName.md)\<`"DocOpen"` \| `"EFOpen"`\>; `CFM`: [`PdfName`](../../../core/objects/pdf-name/classes/PdfName.md)\<`"None"` \| `"V2"` \| `"AESV2"` \| `"AESV3"`\>; `Length?`: [`PdfNumber`](../../../core/objects/pdf-number/classes/PdfNumber.md); \}\>
+
+Dictionary defining a crypt filter for PDF encryption.
+Specifies the encryption method and authentication event trigger.

package/docs/security/types/type-aliases/PdfEncryptionAlgorithmOptions.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [security/types](../README.md) / PdfEncryptionAlgorithmOptions
+
+# Type Alias: PdfEncryptionAlgorithmOptions
+
+> **PdfEncryptionAlgorithmOptions** = `Rc40` \| `Rc128` \| `Aes128WithCryptFilters` \| `Aes256`
+
+Union of all encryption algorithm configuration options.

package/docs/security/types/type-aliases/PdfEncryptionAlgorithmType.md

@@ -0,0 +1,17 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [security/types](../README.md) / PdfEncryptionAlgorithmType
+
+# Type Alias: PdfEncryptionAlgorithmType
+
+> **PdfEncryptionAlgorithmType** = `"RC4-40"` \| `"RC4-128"` \| `"AES-128-CBC"` \| `"AES-256-CBC"` \| `"none"`
+
+Supported encryption algorithm types.
+
+- 'RC4-40': 40-bit RC4 encryption (weak, legacy)
+- 'RC4-128': 128-bit RC4 encryption (legacy)
+- 'AES-128-CBC': 128-bit AES in CBC mode
+- 'AES-256-CBC': 256-bit AES in CBC mode (recommended)
+- 'none': No encryption (identity filter)

package/docs/security/types/type-aliases/PdfEncryptionDictionary.md

@@ -0,0 +1,13 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [security/types](../README.md) / PdfEncryptionDictionary
+
+# Type Alias: PdfEncryptionDictionary
+
+> **PdfEncryptionDictionary** = [`PdfDictionary`](../../../core/objects/pdf-dictionary/classes/PdfDictionary.md)\<\{ `CF?`: [`PdfDictionary`](../../../core/objects/pdf-dictionary/classes/PdfDictionary.md)\<\{\[`key`: `string`\]: [`PdfCryptFilterDictionary`](PdfCryptFilterDictionary.md); \}\>; `EFF?`: [`PdfName`](../../../core/objects/pdf-name/classes/PdfName.md); `EncryptMetadata?`: [`PdfBoolean`](../../../core/objects/pdf-boolean/classes/PdfBoolean.md); `Filter`: [`PdfName`](../../../core/objects/pdf-name/classes/PdfName.md)\<`"Standard"` \| `"Adobe.PubSec"`\>; `ID?`: [`PdfArray`](../../../core/objects/pdf-array/classes/PdfArray.md)\<[`PdfHexadecimal`](../../../core/objects/pdf-hexadecimal/classes/PdfHexadecimal.md)\>; `Length`: [`PdfNumber`](../../../core/objects/pdf-number/classes/PdfNumber.md); `O`: [`PdfString`](../../../core/objects/pdf-string/classes/PdfString.md) \| [`PdfHexadecimal`](../../../core/objects/pdf-hexadecimal/classes/PdfHexadecimal.md); `OE?`: [`PdfString`](../../../core/objects/pdf-string/classes/PdfString.md) \| [`PdfHexadecimal`](../../../core/objects/pdf-hexadecimal/classes/PdfHexadecimal.md); `P`: [`PdfNumber`](../../../core/objects/pdf-number/classes/PdfNumber.md); `Perms?`: [`PdfString`](../../../core/objects/pdf-string/classes/PdfString.md) \| [`PdfHexadecimal`](../../../core/objects/pdf-hexadecimal/classes/PdfHexadecimal.md); `R`: [`PdfNumber`](../../../core/objects/pdf-number/classes/PdfNumber.md); `Recipients?`: [`PdfArray`](../../../core/objects/pdf-array/classes/PdfArray.md)\<[`PdfHexadecimal`](../../../core/objects/pdf-hexadecimal/classes/PdfHexadecimal.md)\>; `StmF?`: [`PdfName`](../../../core/objects/pdf-name/classes/PdfName.md); `StrF?`: [`PdfName`](../../../core/objects/pdf-name/classes/PdfName.md); `SubFilter?`: [`PdfName`](../../../core/objects/pdf-name/classes/PdfName.md)\<`"adbe.pkcs7.s3"` \| `"adbe.pkcs7.s4"` \| `"adbe.pkcs7.s5"`\>; `U`: [`PdfString`](../../../core/objects/pdf-string/classes/PdfString.md) \| [`PdfHexadecimal`](../../../core/objects/pdf-hexadecimal/classes/PdfHexadecimal.md); `UE?`: [`PdfString`](../../../core/objects/pdf-string/classes/PdfString.md) \| [`PdfHexadecimal`](../../../core/objects/pdf-hexadecimal/classes/PdfHexadecimal.md); `V`: [`PdfNumber`](../../../core/objects/pdf-number/classes/PdfNumber.md); \}\>
+
+The encryption dictionary stored in the PDF trailer.
+Contains all encryption parameters including filter type, version, revision,
+owner/user keys, permissions, and crypt filter configurations.

package/docs/security/types/type-aliases/PdfEncryptionDictionaryObject.md

@@ -0,0 +1,11 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [security/types](../README.md) / PdfEncryptionDictionaryObject
+
+# Type Alias: PdfEncryptionDictionaryObject
+
+> **PdfEncryptionDictionaryObject** = [`PdfIndirectObject`](../../../core/objects/pdf-indirect-object/classes/PdfIndirectObject.md)\<[`PdfEncryptionDictionary`](PdfEncryptionDictionary.md)\>
+
+An indirect object containing the encryption dictionary.

package/docs/security/types/type-aliases/PdfEncryptionOptions.md

@@ -0,0 +1,90 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [security/types](../README.md) / PdfEncryptionOptions
+
+# Type Alias: PdfEncryptionOptions
+
+> **PdfEncryptionOptions** = `object`
+
+Options for configuring PDF encryption.
+Includes encryption method, passwords, document ID, and permission settings.
+
+## Properties
+
+### documentId?
+
+> `optional` **documentId**: [`PdfId`](PdfId.md) \| [`ByteArray`](../../../types/type-aliases/ByteArray.md) \| `string`
+
+---
+
+### encryptMetadata?
+
+> `optional` **encryptMetadata**: `boolean`
+
+---
+
+### method?
+
+> `optional` **method**: [`PdfEncryptionAlgorithmOptions`](PdfEncryptionAlgorithmOptions.md)
+
+---
+
+### ownerPassword?
+
+> `optional` **ownerPassword**: [`ByteArray`](../../../types/type-aliases/ByteArray.md) \| `string`
+
+---
+
+### password?
+
+> `optional` **password**: [`ByteArray`](../../../types/type-aliases/ByteArray.md) \| `string`
+
+---
+
+### permissions?
+
+> `optional` **permissions**: `object`
+
+#### all?
+
+> `optional` **all**: `boolean`
+
+#### annotate?
+
+> `optional` **annotate**: `boolean`
+
+#### assemble?
+
+> `optional` **assemble**: `boolean`
+
+#### copy?
+
+> `optional` **copy**: `boolean`
+
+#### extract?
+
+> `optional` **extract**: `boolean`
+
+#### fill?
+
+> `optional` **fill**: `boolean`
+
+#### modify?
+
+> `optional` **modify**: `boolean`
+
+#### print?
+
+> `optional` **print**: `boolean`
+
+#### printHighQuality?
+
+> `optional` **printHighQuality**: `boolean`
+
+---
+
+### recipients?
+
+> `optional` **recipients**: [`PdfEncryptionRecipient`](PdfEncryptionRecipient.md)[]

package/docs/security/types/type-aliases/PdfEncryptionRecipient.md

@@ -0,0 +1,24 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [security/types](../README.md) / PdfEncryptionRecipient
+
+# Type Alias: PdfEncryptionRecipient
+
+> **PdfEncryptionRecipient** = `object`
+
+Recipient information for public key encryption.
+Contains the certificate for encryption and optional private key for decryption.
+
+## Properties
+
+### certificate?
+
+> `optional` **certificate**: [`ByteArray`](../../../types/type-aliases/ByteArray.md)
+
+---
+
+### privateKey?
+
+> `optional` **privateKey**: [`ByteArray`](../../../types/type-aliases/ByteArray.md)

package/docs/security/types/type-aliases/PdfId.md

@@ -0,0 +1,13 @@
+[**pdf-lite**](../../../README.md)
+
+---
+
+[pdf-lite](../../../README.md) / [security/types](../README.md) / PdfId
+
+# Type Alias: PdfId
+
+> **PdfId** = [`PdfArray`](../../../core/objects/pdf-array/classes/PdfArray.md)\<[`PdfHexadecimal`](../../../core/objects/pdf-hexadecimal/classes/PdfHexadecimal.md)\>
+
+Represents the PDF document ID array containing two hexadecimal identifiers.
+The first element is the permanent ID assigned when the document is created,
+and the second is updated when the document is modified.

package/docs/signing/README.md

@@ -0,0 +1,127 @@
+[**pdf-lite**](../README.md)
+
+---
+
+[pdf-lite](../README.md) / signing
+
+# signing
+
+## References
+
+### PdfAdbePkcs7DetachedSignatureObject
+
+Re-exports [PdfAdbePkcs7DetachedSignatureObject](signatures/adbe-pkcs7-detached/classes/PdfAdbePkcs7DetachedSignatureObject.md)
+
+---
+
+### PdfAdbePkcs7Sha1SignatureObject
+
+Re-exports [PdfAdbePkcs7Sha1SignatureObject](signatures/adbe-pkcs7-sha1/classes/PdfAdbePkcs7Sha1SignatureObject.md)
+
+---
+
+### PdfAdbePkcsX509RsaSha1SignatureObject
+
+Re-exports [PdfAdbePkcsX509RsaSha1SignatureObject](signatures/adbe-x509-rsa-sha1/classes/PdfAdbePkcsX509RsaSha1SignatureObject.md)
+
+---
+
+### PdfCertObject
+
+Re-exports [PdfCertObject](document-security-store/classes/PdfCertObject.md)
+
+---
+
+### PdfCrlObject
+
+Re-exports [PdfCrlObject](document-security-store/classes/PdfCrlObject.md)
+
+---
+
+### PdfDocumentSecurityStoreDictionary
+
+Re-exports [PdfDocumentSecurityStoreDictionary](document-security-store/classes/PdfDocumentSecurityStoreDictionary.md)
+
+---
+
+### PdfDocumentSecurityStoreObject
+
+Re-exports [PdfDocumentSecurityStoreObject](document-security-store/classes/PdfDocumentSecurityStoreObject.md)
+
+---
+
+### PdfEtsiCadesDetachedSignatureObject
+
+Re-exports [PdfEtsiCadesDetachedSignatureObject](signatures/etsi-cades-detached/classes/PdfEtsiCadesDetachedSignatureObject.md)
+
+---
+
+### PdfEtsiRfc3161SignatureObject
+
+Re-exports [PdfEtsiRfc3161SignatureObject](signatures/etsi-rfc3161/classes/PdfEtsiRfc3161SignatureObject.md)
+
+---
+
+### PdfOcspObject
+
+Re-exports [PdfOcspObject](document-security-store/classes/PdfOcspObject.md)
+
+---
+
+### PdfSignatureDictionary
+
+Re-exports [PdfSignatureDictionary](signatures/base/classes/PdfSignatureDictionary.md)
+
+---
+
+### PdfSignatureDictionaryEntries
+
+Re-exports [PdfSignatureDictionaryEntries](types/type-aliases/PdfSignatureDictionaryEntries.md)
+
+---
+
+### PdfSignatureObject
+
+Re-exports [PdfSignatureObject](signatures/base/classes/PdfSignatureObject.md)
+
+---
+
+### PdfSignatureSignOptions
+
+Re-exports [PdfSignatureSignOptions](signatures/base/type-aliases/PdfSignatureSignOptions.md)
+
+---
+
+### PdfSignatureSubType
+
+Re-exports [PdfSignatureSubType](types/type-aliases/PdfSignatureSubType.md)
+
+---
+
+### PdfSignatureType
+
+Re-exports [PdfSignatureType](types/type-aliases/PdfSignatureType.md)
+
+---
+
+### PdfVriObject
+
+Re-exports [PdfVriObject](document-security-store/type-aliases/PdfVriObject.md)
+
+---
+
+### RevocationInfo
+
+Re-exports [RevocationInfo](types/type-aliases/RevocationInfo.md)
+
+---
+
+### SignaturePolicyDocument
+
+Re-exports [SignaturePolicyDocument](types/type-aliases/SignaturePolicyDocument.md)
+
+---
+
+### TimeStampAuthority
+
+Re-exports [TimeStampAuthority](types/type-aliases/TimeStampAuthority.md)

package/docs/signing/document-security-store/README.md

@@ -0,0 +1,19 @@
+[**pdf-lite**](../../README.md)
+
+---
+
+[pdf-lite](../../README.md) / signing/document-security-store
+
+# signing/document-security-store
+
+## Classes
+
+- [PdfCertObject](classes/PdfCertObject.md)
+- [PdfCrlObject](classes/PdfCrlObject.md)
+- [PdfDocumentSecurityStoreDictionary](classes/PdfDocumentSecurityStoreDictionary.md)
+- [PdfDocumentSecurityStoreObject](classes/PdfDocumentSecurityStoreObject.md)
+- [PdfOcspObject](classes/PdfOcspObject.md)
+
+## Type Aliases
+
+- [PdfVriObject](type-aliases/PdfVriObject.md)