@rushstack/debug-certificate-manager 1.1.69 → 1.1.70

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/tsdoc-metadata.json +1 -1
  2. package/package.json +3 -4
package/dist/tsdoc-metadata.json CHANGED
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.29.4"
8
+ "packageVersion": "7.29.5"
9
9
  }
10
10
  ]
11
11
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rushstack/debug-certificate-manager",
3
- "version": "1.1.69",
3
+ "version": "1.1.70",
4
4
  "description": "Cross-platform functionality to create debug ssl certificates.",
5
5
  "main": "lib/index.js",
6
6
  "typings": "dist/debug-certificate-manager.d.ts",
@@ -18,7 +18,7 @@
18
18
  "devDependencies": {
19
19
  "@rushstack/eslint-config": "3.0.0",
20
20
  "@rushstack/heft": "0.47.5",
21
- "@rushstack/heft-node-rig": "1.10.5",
21
+ "@rushstack/heft-node-rig": "1.10.6",
22
22
  "@types/heft-jest": "1.0.1",
23
23
  "@types/node": "12.20.24",
24
24
  "@types/node-forge": "1.0.4"
@@ -26,6 +26,5 @@
26
26
  "scripts": {
27
27
  "build": "heft build --clean",
28
28
  "_phase:build": "heft build --clean"
29
- },
30
- "readme": "# @rushstack/debug-certificate-manager\n\n## Installation\n\n`npm install @rushstack/debug-certificate-manager --save-dev`\n\n## Overview\n\nThis library contains utilities for managing debug certificates in a development server environment. It provides functions to generate, self-sign, trust, and untrust .pem certificates for both Windows and Mac OS. It will also generate self-signed certificates on other OS's, but the user must manually trust and untrust them.\n\n[![npm version](https://badge.fury.io/js/%40rushstack%2Fdebug-certificate-manager.svg)](https://badge.fury.io/js/%40rushstack%2Fdebug-certificate-manager)\n\n\n## `CertificateStore`\n\nThe `CertificateStore` class provides accessors and mutators for the debug certificate data stored in `.rushstack`.\n\nRetrive certificate data from the store:\n```typescript\nconst certificateStore: CertificateStore = new CertificateStore();\nreturn {\n pemCertificate: certificateStore.certificateData,\n pemKey: certificateStore.keyData\n};\n```\nSet data using the same property names `certificateData: string | undefined` and `keyData: string | undefined`.\n\n## `ensureCertificate`\n\nGet a development certificate from the store, or optionally, generate a new one and trust it if one does not exist in the store. Returns a certificate object following the `ICertificate` interface.\n\n```typescript\nexport interface ICertificate {\n pemCertificate: string | undefined;\n pemKey: string | undefined;\n}\n```\n\n## `untrustCertificate`\n\nAttempts to locate a previously generated debug certificate and untrust it. Returns a `boolean` value to denote success.\n\n## Links\n\n- [CHANGELOG.md](\n https://github.com/microsoft/rushstack/blob/main/libraries/debug-certificate-manager/CHANGELOG.md) - Find\n out what's new in the latest version\n- [API Reference](https://rushstack.io/pages/api/debug-certificate-manager/)\n\n**@rushstack/debug-certificate-manager** is part of the [Rush Stack](https://rushstack.io/) family of projects.\n"
29
+ }
31
30
  }