Move vendors in a dedicated package
Signed-off-by: Bryan Frimin <bryan@getprobo.com>
This commit is contained in:
@@ -9,7 +9,7 @@
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"inlineSources": false,
|
||||
"isolatedModules": true,
|
||||
"moduleResolution": "node",
|
||||
"moduleResolution": "bundler",
|
||||
"noUnusedLocals": false,
|
||||
"noUnusedParameters": false,
|
||||
"preserveWatchOutput": true,
|
||||
|
||||
24
packages/vendors/LICENSE.md
vendored
Normal file
24
packages/vendors/LICENSE.md
vendored
Normal file
@@ -0,0 +1,24 @@
|
||||
# Vendors
|
||||
|
||||
The [vendors.json](vendors.json) file and derived files contains data about various vendors and their security certifications. This data is licensed under the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.
|
||||
|
||||
## License Requirements
|
||||
|
||||
When using this data, you must:
|
||||
|
||||
1. **Give appropriate credit** - Provide attribution to Probo Inc. and include a link to this license
|
||||
2. **Indicate if changes were made** - If you modify the data, you must indicate that changes were made
|
||||
3. **Share under the same license** - If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original
|
||||
|
||||
## Attribution Example
|
||||
|
||||
When using this data, please include the following attribution:
|
||||
|
||||
```
|
||||
Data sourced from Probo Inc. (https://www.getprobo.com) under CC BY-SA 4.0 license
|
||||
```
|
||||
|
||||
## More Information
|
||||
|
||||
For more information about the CC BY-SA 4.0 license, please visit:
|
||||
https://creativecommons.org/licenses/by-sa/4.0/
|
||||
37
packages/vendors/README.md
vendored
Normal file
37
packages/vendors/README.md
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
# Vendors library
|
||||
|
||||
A curated collection of software vendor information for use in vendor management and compliance activities.
|
||||
|
||||
## Overview
|
||||
|
||||
This package provides a structured dataset of software vendors and service providers with comprehensive metadata including:
|
||||
|
||||
- Basic vendor information (name, website, description)
|
||||
- Legal documentation URLs (privacy policy, terms of service, etc.)
|
||||
- Compliance certifications
|
||||
- Security information
|
||||
|
||||
## Data Structure
|
||||
|
||||
Each vendor entry follows the structure defined in `data.d.ts`, including fields for:
|
||||
|
||||
- `name`: Display name of the vendor
|
||||
- `legalName`: Legal business name
|
||||
- `websiteUrl`: Vendor's website
|
||||
- `privacyPolicyUrl`: URL to privacy policy
|
||||
- `termsOfServiceUrl`: URL to terms of service
|
||||
- And many more compliance-related URLs and metadata
|
||||
|
||||
See `data.d.ts` for the complete type definition.
|
||||
|
||||
### Building the Markdown Documentation
|
||||
|
||||
To generate the VENDORS.md documentation file from the data:
|
||||
|
||||
```bash
|
||||
npm run build:md
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
CC BY-SA 4.0 - See LICENSE.md for details.
|
||||
3333
packages/vendors/VENDORS.md
vendored
Normal file
3333
packages/vendors/VENDORS.md
vendored
Normal file
File diff suppressed because it is too large
Load Diff
72
packages/vendors/data.d.ts
vendored
Normal file
72
packages/vendors/data.d.ts
vendored
Normal file
@@ -0,0 +1,72 @@
|
||||
/**
|
||||
* Type definitions for vendor data
|
||||
*/
|
||||
|
||||
/**
|
||||
* Represents a software vendor or service provider with associated metadata
|
||||
*/
|
||||
export interface Vendor {
|
||||
/** Display name of the vendor */
|
||||
name: string;
|
||||
|
||||
/** Legal business name of the vendor */
|
||||
legalName?: string;
|
||||
|
||||
/** Physical headquarters address */
|
||||
headquarterAddress?: string;
|
||||
|
||||
/** Vendor's website URL */
|
||||
websiteUrl: string;
|
||||
|
||||
/** URL to vendor's privacy policy */
|
||||
privacyPolicyUrl?: string;
|
||||
|
||||
/** URL to vendor's terms of service */
|
||||
termsOfServiceUrl?: string;
|
||||
|
||||
/** URL to vendor's service level agreement */
|
||||
serviceLevelAgreementUrl?: string;
|
||||
|
||||
/** URL to service software agreement */
|
||||
serviceSoftwareAgreementUrl?: string;
|
||||
|
||||
/** URL to vendor's data processing agreement */
|
||||
dataProcessingAgreementUrl?: string;
|
||||
|
||||
/** URL to vendor's list of subprocessors */
|
||||
subprocessorsListUrl?: string;
|
||||
|
||||
/** URL to vendor's business associate agreement */
|
||||
businessAssociateAgreementUrl?: string;
|
||||
|
||||
/** Short description of the vendor/service */
|
||||
description?: string;
|
||||
|
||||
/** Primary category for the vendor */
|
||||
category?: string;
|
||||
|
||||
/** Security or compliance certifications held by the vendor */
|
||||
certifications?: string[];
|
||||
|
||||
/** URL to vendor's security page */
|
||||
securityPageUrl?: string;
|
||||
|
||||
/** URL to vendor's trust page */
|
||||
trustPageUrl?: string;
|
||||
|
||||
/** URL to vendor's status page */
|
||||
statusPageUrl?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Array of vendor data
|
||||
*/
|
||||
export type Vendors = Vendor[];
|
||||
|
||||
|
||||
/**
|
||||
* Default export representing the entire vendor dataset
|
||||
*/
|
||||
declare const data: Vendors;
|
||||
|
||||
export default data;
|
||||
2293
packages/vendors/data.json
vendored
Normal file
2293
packages/vendors/data.json
vendored
Normal file
File diff suppressed because it is too large
Load Diff
21
packages/vendors/package.json
vendored
Normal file
21
packages/vendors/package.json
vendored
Normal file
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"name": "@probo/vendors",
|
||||
"version": "0.0.1",
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
"files": [
|
||||
"data.json",
|
||||
"LICENSE.md"
|
||||
],
|
||||
"scripts": {
|
||||
"build:md": "node scripts/build-md.mjs"
|
||||
},
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./data.d.ts",
|
||||
"default": "./data.json"
|
||||
}
|
||||
},
|
||||
"license": "CC BY-SA 4.0"
|
||||
}
|
||||
107
packages/vendors/scripts/build-md.mjs
vendored
Normal file
107
packages/vendors/scripts/build-md.mjs
vendored
Normal file
@@ -0,0 +1,107 @@
|
||||
import { readFile, writeFile } from "node:fs/promises";
|
||||
import { createWriteStream } from "node:fs";
|
||||
import path from "node:path";
|
||||
|
||||
const data = await readFile(path.join(import.meta.dirname, '../data.json'), 'utf8');
|
||||
const vendors = JSON.parse(data);
|
||||
|
||||
const output = path.join(import.meta.dirname, '../VENDORS.md')
|
||||
const file = createWriteStream(output);
|
||||
|
||||
const formatAsList = (array) => {
|
||||
if (!array || array.length === 0) return '';
|
||||
if (typeof array === 'string') {
|
||||
return array.split(',').map(item => `- ${item.trim()}`).join('\n');
|
||||
}
|
||||
return array.map(item => `- ${item}`).join('\n');
|
||||
};
|
||||
|
||||
file.write('# Vendors\n\n');
|
||||
|
||||
for (const vendor of vendors) {
|
||||
// Vendor name and description
|
||||
file.write(`## ${vendor.name}\n\n`);
|
||||
if (vendor.description) {
|
||||
file.write(`${vendor.description}\n\n`);
|
||||
}
|
||||
|
||||
if (vendor.legalName) {
|
||||
file.write(`**Legal Name:** ${vendor.legalName}\n\n`);
|
||||
}
|
||||
|
||||
if (vendor.headquarterAddress) {
|
||||
file.write(`**Headquarters:** ${vendor.headquarterAddress}\n\n`);
|
||||
}
|
||||
|
||||
file.write('### Links\n\n');
|
||||
file.write('| Resource | Link |\n');
|
||||
file.write('|----------|------|\n');
|
||||
|
||||
if (vendor.websiteUrl) {
|
||||
file.write(`| Website | [Link](${vendor.websiteUrl}) |\n`);
|
||||
}
|
||||
|
||||
if (vendor.privacyPolicyUrl) {
|
||||
file.write(`| Privacy Policy | [Link](${vendor.privacyPolicyUrl}) |\n`);
|
||||
}
|
||||
|
||||
if (vendor.termsOfServiceUrl && vendor.termsOfServiceUrl !== 'undefined') {
|
||||
file.write(`| Terms of Service | [Link](${vendor.termsOfServiceUrl}) |\n`);
|
||||
}
|
||||
|
||||
if (vendor.serviceLevelAgreementUrl && vendor.serviceLevelAgreementUrl !== 'undefined') {
|
||||
file.write(`| Service Level Agreement | [Link](${vendor.serviceLevelAgreementUrl}) |\n`);
|
||||
}
|
||||
|
||||
if (vendor.securityPageUrl && vendor.securityPageUrl !== 'undefined') {
|
||||
file.write(`| Security Page | [Link](${vendor.securityPageUrl}) |\n`);
|
||||
}
|
||||
|
||||
if (vendor.trustPageUrl && vendor.trustPageUrl !== 'undefined') {
|
||||
file.write(`| Trust Page | [Link](${vendor.trustPageUrl}) |\n`);
|
||||
}
|
||||
|
||||
if (vendor.statusPageUrl && vendor.statusPageUrl !== 'undefined') {
|
||||
file.write(`| Status Page | [Link](${vendor.statusPageUrl}) |\n`);
|
||||
}
|
||||
|
||||
if (vendor.dataProcessingAgreementUrl && vendor.dataProcessingAgreementUrl !== 'undefined') {
|
||||
file.write(`| Data Processing Agreement | [Link](${vendor.dataProcessingAgreementUrl}) |\n`);
|
||||
}
|
||||
|
||||
if (vendor.businessAssociateAgreementUrl && vendor.businessAssociateAgreementUrl !== 'undefined') {
|
||||
file.write(`| Business Associate Agreement | [Link](${vendor.businessAssociateAgreementUrl}) |\n`);
|
||||
}
|
||||
|
||||
if (vendor.serviceSoftwareAgreementUrl && vendor.serviceSoftwareAgreementUrl !== 'undefined') {
|
||||
file.write(`| Service Software Agreement | [Link](${vendor.serviceSoftwareAgreementUrl}) |\n`);
|
||||
}
|
||||
|
||||
if (vendor.subprocessorsListUrl && vendor.subprocessorsListUrl !== 'undefined') {
|
||||
file.write(`| Subprocessors List | [Link](${vendor.subprocessorsListUrl}) |\n`);
|
||||
}
|
||||
|
||||
file.write('\n');
|
||||
|
||||
if (vendor.categories && vendor.categories !== 'undefined') {
|
||||
file.write(`**Categories:** ${vendor.categories}\n\n`);
|
||||
} else if (vendor.category && vendor.category !== 'undefined') {
|
||||
file.write(`**Category:** ${vendor.category}\n\n`);
|
||||
}
|
||||
|
||||
if (vendor.certifications && vendor.certifications !== 'undefined') {
|
||||
file.write('### Certifications\n\n');
|
||||
file.write(formatAsList(vendor.certifications));
|
||||
file.write('\n\n');
|
||||
}
|
||||
|
||||
if (vendor.subprocessors && vendor.subprocessors !== 'undefined') {
|
||||
file.write('### Subprocessors\n\n');
|
||||
file.write(formatAsList(vendor.subprocessors));
|
||||
file.write('\n\n');
|
||||
}
|
||||
|
||||
file.write('---\n\n');
|
||||
}
|
||||
|
||||
file.end();
|
||||
Reference in New Issue
Block a user