{"_id":"@telus/colophon-schema","_rev":"56-6a5a7f4a6d0b3973cdc32e0a68df00c4","name":"@telus/colophon-schema","dist-tags":{"latest":"3.0.2"},"versions":{"3.0.0":{"version":"3.0.0","name":"@telus/colophon-schema","description":"Fork of Schema & Validator for https://colophon.id","author":{"name":"Ahmad Nassri","email":"ahmad@ahmadnassri.com","url":"https://www.ahmadnassri.com/"},"homepage":"https://colophon.telus.digital","repository":{"type":"git","url":"git+https://github.com/telus/dsc-colophon-schema.git"},"license":"MIT","main":"index.js","keywords":["colophon","schema"],"engines":{"node":">=8"},"bugs":{"url":"https://github.com/telus/dsc-colophon-schema/issues"},"scripts":{"lint:audit":"npm audit","lint:deps":"npx updated","lint:ec":"npx editorconfig-checker .","lint:js":"eslint .","lint:md":"npx remark-cli --quiet --frail .","lint":"run-p lint:*","open:coverage":"opener coverage/lcov-report/index.html","release:dryrun":"npx semantic-release --dry-run --branch $(git describe --contains --all HEAD)","release":"npx semantic-release","test":"tap test --100 --coverage-report=lcov --no-browser"},"dependencies":{"ajv":"^6.10.1","js-yaml":"^3.13.1"},"devDependencies":{"@ahmadnassri/eslint-config":"^1.1.4","@ahmadnassri/remark-config":"^1.0.2","@ahmadnassri/semantic-release-config":"^1.0.8","eslint":"^6.0.1","eslint-config-standard":"^12.0.0","eslint-plugin-import":"^2.18.0","eslint-plugin-node":"^9.1.0","eslint-plugin-promise":"^4.2.1","eslint-plugin-standard":"^4.0.0","npm-run-all":"^4.1.5","tap":"^14.4.1"},"gitHead":"1a429e45886475798141e4193ce7655f6bde389f","_id":"@telus/colophon-schema@3.0.0","_nodeVersion":"10.16.0","_npmVersion":"6.10.0","dist":{"integrity":"sha512-BxURwLN3Bg4ZfezgST8eJg5OlsGX/JiDFXABTeTPXZk5W4t70DODpNBn8R/O6TiSbCVWapndbz5mRDmM1e/l4A==","shasum":"f64b8de3bc85454c2d98b52c7914295919b289ce","tarball":"https://registry.npmjs.org/@telus/colophon-schema/-/colophon-schema-3.0.0.tgz","fileCount":18,"unpackedSize":61649,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdJPXZCRA9TVsSAnZWagAANoIP/jv4vPVD/kF43wPoXPA3\nE+Hd3Wo8sDxxE1ROMurPtdC/m9sf/gXeH2mKcnXkWZcNik9jHoCZKSi91Ejd\ncrR0va/QIzH3mh+YM+7p8iX1NIcY4KBbgGulYBykTA99er/kHvyTj7/M9SRy\nRe9JKOsiqQAAVUww/8NDLdfNFT5WX1mDfv4PkFIVmFr2wc7goM70KX5EIHgO\nXVerXIqJ2VhaWOsmhMWznrTgqoF+2fCCYfH1dD9mfSjinmKp1htEm6gB+uoZ\nCIP5vAnJ9y9up5t5/Qo8/11hqstko+pGCdkS7HRhmkFNTa0wWTfNQTVBFSZ5\nMzO4O7idqcGCvVHdOYQqeP5a3C1kTyP0owGbl8hQC45x2CwBRPBbr7dRQblw\nn+5/oMEx0iNdKFSpUiSK1i8kvWyOuDb2KyB/8WCgQIUc8R7FnSpu6kph8xyN\nfRGchcZXu09A6PnXs624p+gWPk6vX6fdHXppBZgAbhpvXX0QqPu/n7kZMpfS\noS/t6I/ih2HwC0d53YcRdlyrNcvELSMmMK/6rVYAsTQKovKoUo/bkCEpEN4D\nFw+GL9GEKf0tqUDaoySIa11kNPFYy5TEFVU5Doxve88nLlbrE5GnfIN8uXXb\n5a/xs12t53yGocxgw2UfCi3tBrYsDdG5bvWqyugZlWLjKKL81Gg3WzxOq4PW\nSjid\r\n=hq74\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHSZHal0UyMFugt+NXRNZ32PQRJwQTJv1iJlj043KTscAiEApjbQTC2KFFgLdDCqxzAhZ6Lzse4ty2YvZVzYw4RZ1lg="}]},"maintainers":[{"name":"gu3st","email":"gu3st@dustindawes.com"},{"name":"rob.brander","email":"rob.brander@gmail.com"},{"name":"ksbvale","email":"karlasamantha@gmail.com"},{"name":"maumercado","email":"mau@maumercado.com"},{"name":"telusdigitaldelivery","email":"rpabot.digitaldelivery@telus.com"},{"name":"chris-brelski","email":"chris.brelski@telus.com"},{"name":"skalfyfan","email":"psaumets@gmail.com"},{"name":"agorovyi","email":"agorovyi@gmail.com"},{"name":"billli","email":"me@bill.li"},{"name":"randybitelus","email":"randy.bi@telus.com"},{"name":"benzilla","email":"ben.chen@telus.com"},{"name":"pdufault","email":"phil@dufault.info"},{"name":"brendanpowershifter","email":"brendan@powershifter.com"},{"name":"sang19","email":"sangeetha_kamath@yahoo.ca"},{"name":"etrain","email":"enrico.npm@theetrain.ca"},{"name":"marcod1419","email":"marcod1419@gmail.com"},{"name":"robfe11","email":"rob@techsamurais.com"},{"name":"mattcan","email":"gh@matthewcantelon.ca"},{"name":"samtel","email":"sam.eslamdoust@telus.com"},{"name":"rtong","email":"royston.tong@telus.com"},{"name":"telusdigital-dev","email":"digitalcloudoperations@telus.com"},{"name":"telusdigital-admin","email":"digitalcloudoperations@telus.com"},{"name":"ruxandrafed","email":"ruxandra.fediuc@gmail.com"}],"_npmUser":{"name":"telusdigital-dev","email":"digitalcloudoperations@telus.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/colophon-schema_3.0.0_1562703320899_0.5862339766777735"},"_hasShrinkwrap":false},"3.0.1":{"version":"3.0.1","name":"@telus/colophon-schema","description":"Fork of Schema & Validator for https://colophon.id","author":{"name":"Ahmad Nassri","email":"ahmad@ahmadnassri.com","url":"https://www.ahmadnassri.com/"},"homepage":"https://colophon.telus.digital","repository":{"type":"git","url":"git+https://github.com/telus/dsc-colophon-schema.git"},"license":"MIT","main":"index.js","keywords":["colophon","schema"],"engines":{"node":">=8"},"bugs":{"url":"https://github.com/telus/dsc-colophon-schema/issues"},"scripts":{"lint:audit":"npm audit","lint:deps":"npx updated","lint:ec":"npx editorconfig-checker .","lint:js":"eslint .","lint:md":"npx remark-cli --quiet --frail .","lint":"run-p lint:*","open:coverage":"opener coverage/lcov-report/index.html","release:dryrun":"npx semantic-release --dry-run --branch $(git describe --contains --all HEAD)","release":"npx semantic-release","test":"tap test --100 --coverage-report=lcov --no-browser"},"dependencies":{"ajv":"^6.10.2","js-yaml":"^3.13.1"},"devDependencies":{"@ahmadnassri/eslint-config":"^1.1.4","@ahmadnassri/remark-config":"^1.0.2","@ahmadnassri/semantic-release-config":"^1.0.8","eslint":"^6.0.1","eslint-config-standard":"^13.0.1","eslint-plugin-import":"^2.18.0","eslint-plugin-node":"^9.1.0","eslint-plugin-promise":"^4.2.1","eslint-plugin-standard":"^4.0.0","npm-run-all":"^4.1.5","tap":"^14.4.1"},"gitHead":"9982b812857e2c7b4e948af62071614dab680c10","_id":"@telus/colophon-schema@3.0.1","_nodeVersion":"10.16.0","_npmVersion":"6.10.0","dist":{"integrity":"sha512-bg8W2w79L+Q2pwAcOWzg8/aUI1ogbWJmyjoLf/JQNf1r6XCzQZCyjZlTMFBhlpws/H1plPYO/95FD6ovgmb+BQ==","shasum":"afa680d1dad2136731e3ad52d41b47f1e2c08a87","tarball":"https://registry.npmjs.org/@telus/colophon-schema/-/colophon-schema-3.0.1.tgz","fileCount":18,"unpackedSize":61864,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdLSZdCRA9TVsSAnZWagAAAbMP/1w9NJSfy0kMRDhSA5i4\nBuu6e+rNLT/77k1l2XA5XsgJMI9kjIZXjs3hybRYqa/VA/aqDlCd0ffGkZBu\n9SlbKayIPLmFqUKTHTGls7TDXU9Uj1B5EmvQWplw2WK8Kbez2emEECO4wdUI\nmrq2zc0yWY8Ae5nSAP6xUAR6UeyHioq+pzmBqZsY3VbdAJMai/TsmKndtTwT\nUwQ6wRwqQ0fMniUiLqDTINs/bEVdsAURCISX5xgGCBoXkcO8KVjQJUXywcO7\nTK8J83rLM5l+LgdHrso8oUW5czNO8Sc6qsKyPdqLKMypE3SY9PLVot34ZdPU\nWV8ktrgyV+rGja7rFxYnTDqYI3PWEx+XQmeE/QOQdpeEFsKq50QXTIJnAUtx\nIl68UxHDOrlVLZ+vz+I6la0xOwvUbnMncbNNlliFRJqfkTX+Aec8TnoPEF9q\nkJGxkKj4uK40MN6a5Y86AVtrnCVnFyos4jbhbxfNQKvkVB11v9AY0pfILmxH\nQ/OcH9VXLOZp8n7WFIUoC/foiNfnx9Esec4OAi8+rTU47WZxUnkGi1o4Rqcb\nuYeFvmcOh64OptwnuiKOBHnayATzlKSnZ/pC4do++smCvxsjLNlReaHMc5fm\n1WGGYqmTmHKKH+k6oIPN0JbVW7PU5PjdfeQqAcIJBVuY8QLLJWN29lIGfUKC\nZtaa\r\n=kAP6\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCnonOjaDqhOOjagK+1PEF5bxIDxhdn+dN2hk0U1J1kJwIhAIpiV65Zy+gd0f0X8DO9ZslMkU9q1Dsi1jH8pHR9DsV3"}]},"maintainers":[{"name":"agorovyi","email":"agorovyi@gmail.com"},{"name":"benzilla","email":"ben.chen@telus.com"},{"name":"billli","email":"me@bill.li"},{"name":"brendanpowershifter","email":"brendan@powershifter.com"},{"name":"chris-brelski","email":"chris.brelski@telus.com"},{"name":"etrain","email":"enrico.npm@theetrain.ca"},{"name":"gu3st","email":"gu3st@dustindawes.com"},{"name":"ksbvale","email":"karlasamantha@gmail.com"},{"name":"marcod1419","email":"marcod1419@gmail.com"},{"name":"mattcan","email":"gh@matthewcantelon.ca"},{"name":"maumercado","email":"mau@maumercado.com"},{"name":"pdufault","email":"phil@dufault.info"},{"name":"randybitelus","email":"randy.bi@telus.com"},{"name":"rob.brander","email":"rob.brander@gmail.com"},{"name":"robfe11","email":"rob@techsamurais.com"},{"name":"rtong","email":"royston.tong@telus.com"},{"name":"ruxandrafed","email":"ruxandra.fediuc@gmail.com"},{"name":"samtel","email":"sam.eslamdoust@telus.com"},{"name":"sang19","email":"sangeetha_kamath@yahoo.ca"},{"name":"skalfyfan","email":"psaumets@gmail.com"},{"name":"telusdigital-admin","email":"digitalcloudoperations@telus.com"},{"name":"telusdigital-dev","email":"digitalcloudoperations@telus.com"},{"name":"telusdigitaldelivery","email":"rpabot.digitaldelivery@telus.com"}],"_npmUser":{"name":"telusdigital-dev","email":"digitalcloudoperations@telus.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/colophon-schema_3.0.1_1563240028351_0.6573260686933393"},"_hasShrinkwrap":false},"3.0.2":{"version":"3.0.2","name":"@telus/colophon-schema","description":"Fork of Schema & Validator for https://colophon.id","author":{"name":"Ahmad Nassri","email":"ahmad@ahmadnassri.com","url":"https://www.ahmadnassri.com/"},"homepage":"https://colophon.telus.digital","repository":{"type":"git","url":"git+https://github.com/telus/dsc-colophon-schema.git"},"license":"MIT","main":"index.js","keywords":["colophon","schema"],"engines":{"node":">=8"},"bugs":{"url":"https://github.com/telus/dsc-colophon-schema/issues"},"scripts":{"lint:audit":"npm audit","lint:js":"eslint .","lint:md":"npx remark-cli --quiet --frail .","lint":"run-p lint:*","open:coverage":"opener coverage/lcov-report/index.html","release:dryrun":"npx semantic-release --dry-run --branch $(git describe --contains --all HEAD)","release":"npx semantic-release","test":"tap test --100 --coverage-report=lcov --no-browser"},"dependencies":{"ajv":"^6.11.0","js-yaml":"^3.13.1"},"devDependencies":{"@ahmadnassri/eslint-config":"^1.1.4","@ahmadnassri/remark-config":"^1.0.2","@ahmadnassri/semantic-release-config":"^1.0.8","eslint":"^6.8.0","eslint-config-standard":"^14.1.0","eslint-plugin-import":"^2.20.0","eslint-plugin-node":"^11.0.0","eslint-plugin-promise":"^4.2.1","eslint-plugin-standard":"^4.0.1","npm-run-all":"^4.1.5","tap":"^14.10.6"},"gitHead":"83729e1ce94493943149594a7292ecff727af40f","_id":"@telus/colophon-schema@3.0.2","_nodeVersion":"10.18.1","_npmVersion":"6.13.7","dist":{"integrity":"sha512-g9EMM4TteiXll8hOQPvzv/bkyQAPhDKE9EcK85pyWQ11U2xqG1AL+bB1lhCvsi8OJwWhmPzQa6bLbwuM+mQmQg==","shasum":"6b124803656bee8f6cd72dda08bae2ebe2f158d4","tarball":"https://registry.npmjs.org/@telus/colophon-schema/-/colophon-schema-3.0.2.tgz","fileCount":18,"unpackedSize":61845,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeNI+8CRA9TVsSAnZWagAAtc4QAJS+oO9vksCTn0LPFvQc\n1z2aNgssEcj/CD1DMT7aZfXQEn04Y3V89lxJLIHQLVxWOEfl1rz+JIzKA1Hn\n0B4FhOA/FDzeTIeAB9NyOtFyTp9PVyyA5LNLgjtgG4B17Kr06rSlh82uGdvR\nkKkBAPmhtmZY91N3vWAeVCW/VyE2rvyRaCax+MPGMIbCZB8+upctBXHexNuK\nkLRRTDN8DqIAm/gDSVQsHUpthBktc6RJPrWCLKOkxWUveieZy1UJFdVVTsWa\nOiev25tzWMY3e23XIP1TD6sVZQQvvS2uJT+FG2VGMtYQ+yoFFd6FLddfhPD+\nFpVED26GeIbe8zuTnK2+OxH+DR5NLDda9jJcvNRc7gMXvw0il/mAXZl2UrTa\n/QsiZwgyDSe9evL1r5CCIVAzEQ96gsCKHIlX/pMfdedXvR2fnnwkPspMVkrr\nBFzWNNz7jb9IupP0O/npSeh5xOxJ3YPkiD5gX2yozhMRbryDhBoW8oJ08I/Z\nb/SzHcLHcQFDEOWVx1aL3fkFsMesvfjJvxT/BDWezWeWXUZY9gvjY2t/9iaZ\nD4uu094v9gohoFPqI8/TzE1+UG4ktQbeDFkd/c7PLZvnz/kA7bO9iAd2mTUa\ndosct01uWQP6rCwBMqoqLCScn6dIIC47Qeo1Uti87u9G/1VzDnSUD+UyM8ov\nxr9p\r\n=XiHK\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGwxluqd0tkUfOOl4VI8S70OnKRNCLy4t/a835CCPrcHAiEAhEXdgHaSqxqoQXqE0NlbdDNJ5Fc7g3nN/XEzYBPT6qY="}]},"maintainers":[{"email":"hello@aaronfagan.ca","name":"aaronfagan"},{"email":"agorovyi@gmail.com","name":"agorovyi"},{"email":"ben.chen@telus.com","name":"benzilla"},{"email":"chris.brelski@telus.com","name":"chris-brelski"},{"email":"npmjs@crimeminister.org","name":"crimeminister"},{"email":"edward.ning@telus.com","name":"ening-telus"},{"email":"enrico.npm@theetrain.ca","name":"etrain"},{"email":"gu3st@dustindawes.com","name":"gu3st"},{"email":"luca.maraschi@gmail.com","name":"lucamaraschi"},{"email":"marcod1419@gmail.com","name":"marcod1419"},{"email":"gh@matthewcantelon.ca","name":"mattcan"},{"email":"mau@maumercado.com","name":"maumercado"},{"email":"phil@dufault.info","name":"pdufault"},{"email":"randy.bi@telus.com","name":"randybitelus"},{"email":"rob.brander@gmail.com","name":"rob.brander"},{"email":"rob@techsamurais.com","name":"robfe11"},{"email":"royston.tong@telus.com","name":"rtong"},{"email":"sangeetha_kamath@yahoo.ca","name":"sang19"},{"email":"sebastien.savard@telus.com","name":"sebastsavard"},{"email":"psaumets@gmail.com","name":"skalfyfan"},{"email":"steve.tannock@telus.com","name":"stv-telus"},{"email":"rpabot.digitaldelivery@telus.com","name":"telusdigitaldelivery"}],"_npmUser":{"name":"telusdigitaldelivery","email":"rpabot.digitaldelivery@telus.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/colophon-schema_3.0.2_1580502971805_0.20525038966580422"},"_hasShrinkwrap":false}},"time":{"created":"2019-07-09T20:15:20.717Z","3.0.0":"2019-07-09T20:15:20.999Z","modified":"2024-02-15T18:45:16.425Z","3.0.1":"2019-07-16T01:20:28.582Z","3.0.2":"2020-01-31T20:36:12.188Z"},"maintainers":[{"email":"phil@dufault.info","name":"pdufault"},{"email":"rpabot.digitaldelivery@telus.com","name":"telusdigitaldelivery"},{"email":"steve.tannock@telus.com","name":"stv-telus"}],"description":"Fork of Schema & Validator for https://colophon.id","homepage":"https://colophon.telus.digital","keywords":["colophon","schema"],"repository":{"type":"git","url":"git+https://github.com/telus/dsc-colophon-schema.git"},"author":{"name":"Ahmad Nassri","email":"ahmad@ahmadnassri.com","url":"https://www.ahmadnassri.com/"},"bugs":{"url":"https://github.com/telus/dsc-colophon-schema/issues"},"license":"MIT","readme":"# Colophon Schema\n\n[![License][license-image]][license-url] [![version][npm-image]][npm-url] [![Build Status][circle-image]][circle-url]\n\n> Schema & Validator for [Colophon][colophon-id]\n\n## Schema Specification\n\n### Versions\n\n| \\#                   | status        |\n| -------------------- | ------------- |\n| [`3.0`](schema/3.0/) | **stable**    |\n| [`2.0`](schema/2.0/) | **stable**    |\n|                      |               |\n| [`1.1`](schema/1.1/) | _deprecated_  |\n| [`1.0`](schema/1.0/) | _deprecated_  |\n\n> _see an example of this repo's own [`.colophon.yml`](./.colophon.yml)..._\n\n## Install\n\nAvailable as an `npm` package for validation purposes, exposes validation helper, and the schema itself _(compatible with any [JSON Schema][] validation tool)_\n\n```bash\nnpm install @colophon/schema\n```\n\n## Usage\n\n```js\nconst parser = require('@colophon/schema')\nconst { schema, regex } = require('@colophon/schema/versions/latest')\n```\n\n### Referencing older versions\n\n```js\nconst schemas = require('@colophon/schema/versions')\n\nconst { schema, regex } = schemas['1.0']\n```\n\n## API\n\n### _`parser(colophon: String | Object): Promise<Object>`_\n\n> Resolves with `content` as a valid JavaScript Colophon Object\n> Rejects with [`ColophonError`](./error.js) on invalid schema test\n\n###### Example: Valid Colophon\n\n```js\nconst parser = require('@colophon/schema')\n\nconst valid = { ... } // supply an Object or YAML String\n\nconst colophon = await parser(valid)\n// colophon is a JavaScript Object (parsed from YAML string, or returned as is)\n```\n\n###### Example: Invalid Colophon\n\n```js\nconst parser = require('@colophon/schema')\n\n// invalid\nconst invalid = `\nversion: 2.0 // or version 3.0\n\nid: my-app\n`\n\nparser(invalid)\n  .then(colophon)\n  .catch(err => console.error(err.message, err.errors))\n    // invalid colophon content\n    // \"err.errors\" object contains schema errors\n    // e.g. \"err.errors\": [ { message: \"should have required property 'contacts'\" } ]\n    // see https://github.com/epoberezkin/ajv#validation-errors for details\n}\n```\n\n## Credits\n\n- Original Idea: _[@crimeminister](https://github.com/crimeminister)_\n- Name: _[@andrewkumar](https://github.com/andrewkumar)_\n\n---\n> Author: [Ahmad Nassri](https://www.ahmadnassri.com) &bull; \n> Github: [@project-colophon](https://github.com/project-colophon) &bull; \n> Twitter: [@ColophonID](https://twitter.com/ColophonID)\n\n[license-url]: LICENSE\n[license-image]: https://img.shields.io/github/license/project-colophon/schema.svg?style=for-the-badge&logo=circleci\n\n[circle-url]: https://circleci.com/gh/project-colophon/schema\n[circle-image]: https://img.shields.io/circleci/project/github/project-colophon/schema/master.svg?style=for-the-badge&logo=circleci\n\n[npm-url]: https://www.npmjs.com/package/@colophon/schema\n[npm-image]: https://img.shields.io/npm/v/@colophon/schema.svg?style=for-the-badge&logo=npm\n\n[json schema]: http://json-schema.org\n[colophon-id]: https://colophon.id\n","readmeFilename":"README.md"}