{"id":19122883,"url":"https://github.com/digitalbazaar/security-document-loader","last_synced_at":"2025-05-05T18:25:55.447Z","repository":{"id":38647559,"uuid":"360378962","full_name":"digitalbazaar/security-document-loader","owner":"digitalbazaar","description":"A JSON-LD documentLoader library pre-loaded with core commonly used contexts (suites, VC, DIDs).","archived":false,"fork":false,"pushed_at":"2025-03-07T23:48:29.000Z","size":35,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-05-05T18:25:41.989Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/digitalbazaar.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-04-22T03:20:31.000Z","updated_at":"2025-03-07T23:48:33.000Z","dependencies_parsed_at":"2025-04-17T07:33:14.125Z","dependency_job_id":"c1d67349-2a88-4b79-9b68-1bffbccb6560","html_url":"https://github.com/digitalbazaar/security-document-loader","commit_stats":{"total_commits":39,"total_committers":6,"mean_commits":6.5,"dds":0.5897435897435898,"last_synced_commit":"bab6e667716e49a59b06aebfec45fa35ca1c155f"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digitalbazaar%2Fsecurity-document-loader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digitalbazaar%2Fsecurity-document-loader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digitalbazaar%2Fsecurity-document-loader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digitalbazaar%2Fsecurity-document-loader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/digitalbazaar","download_url":"https://codeload.github.com/digitalbazaar/security-document-loader/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252551964,"owners_count":21766615,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T05:23:24.585Z","updated_at":"2025-05-05T18:25:55.424Z","avatar_url":"https://github.com/digitalbazaar.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Core JSON-LD securityLoader _(@digitalbazaar/security-document-loader)_\n\n[![Build Status](https://img.shields.io/github/actions/workflow/status/digitalbazaar/security-document-loader/main.yml)](https://github.com/digitalbazaar/security-document-loader/actions/workflows/main.yml)\n[![Coverage Status](https://img.shields.io/codecov/c/github/digitalbazaar/security-document-loader)](https://codecov.io/gh/digitalbazaar/security-document-loader)\n[![NPM Version](https://img.shields.io/npm/v/@digitalbazaar/security-document-loader.svg)](https://npm.im/@digitalbazaar/security-document-loader)\n\n\u003e A JSON-LD documentLoader library pre-loaded with commonly used security contexts (suites, VC, DIDs).\n\n## Table of Contents\n\n- [Background](#background)\n- [Security](#security)\n- [Install](#install)\n- [Usage](#usage)\n- [Contribute](#contribute)\n- [Commercial Support](#commercial-support)\n- [License](#license)\n\n## Background\n\nThis is useful for unit tests, in Node.js and the browser.\nIt includes several core contexts and DID resolvers that you might want when \ntesting applications involving Verifiable Credentials, `did:key` or Veres One\nDIDs, as well as Ed25519 signing and verifying.\n\nNote: This library plays a similar role to `bedrock-security-context`, but is\nintended for not just Bedrock style applications, but also for isomorphic libs,\netc.\n\nIncluded contexts:\n\n* `https://www.w3.org/ns/did/v1` DID Core Context v1\n* `https://w3id.org/veres-one/v1` Veres One DID Method Context v1\n* `https://www.w3.org/2018/credentials/v1` Verifiable Credentials v1\n* `https://w3id.org/security/suites/ed25519-2020/v1` Ed25519Signature2020 Crypto Suite\n* `https://w3id.org/security/suites/x25519-2020/v1` X25519VerificationKey2020 Crypto Suite\n\nIncluded DID Method drivers:\n\n* `did:key` (via [`@digitalbazaar/did-method-key`](https://github.com/digitalbazaar/did-method-key-js))\n\nOther required contexts and did drivers can easily be added (see Usage section\nbelow).\n\n## Security\n\nTBD\n\n## Install\n\n- Node.js 14+ is required.\n\n### NPM\n\nTo install via NPM:\n\n```\nnpm install --save @digitalbazaar/security-document-loader\n```\n\n### Development\n\nTo install locally (for development):\n\n```\ngit clone https://github.com/digitalbazaar/security-document-loader.git\ncd security-document-loader\nnpm install\n```\n\n## Usage\n\nThe core document loader is easily extensible. For example, to add more contexts:\n\n```js\nimport {securityLoader} from '@digitalbazaar/security-document-loader';\n\nimport secCtx from '@digitalbazaar/security-context';\nimport webkmsCtx from 'webkms-context';\nimport zcapCtx from 'zcap-context';\n\nconst loader = securityLoader()\nloader.addStatic(\n  secCtx.SECURITY_CONTEXT_V2_URL,\n  secCtx.contexts.get(secCtx.SECURITY_CONTEXT_V2_URL)\n);\nloader.addStatic(webkmsCtx.CONTEXT_URL, webkmsCtx.CONTEXT);\nloader.addStatic(zcapCtx.CONTEXT_URL, zcapCtx.CONTEXT);\n\nconst documentLoader = loader.build();\n```\n\n### Adding did resolvers\n\nBy default, `securityLoader` uses `did-io`'s CachedResolver as a harness for\nmultiple DID method drivers, and supports the `did-method-key` driver.\n\nTo add another did method driver to it:\n\n```js\n\nimport {securityLoader} from '@digitalbazaar/security-document-loader';\nconst loader = securityLoader()\n\nloader.protocolHandlers.get('did').use(didMethodDriver);\n```\n\n## Contribute\n\nSee [the contribute file](https://github.com/digitalbazaar/bedrock/blob/master/CONTRIBUTING.md)!\n\nPRs accepted.\n\nIf editing the Readme, please conform to the\n[standard-readme](https://github.com/RichardLitt/standard-readme) specification.\n\n## Commercial Support\n\nCommercial support for this library is available upon request from\nDigital Bazaar: support@digitalbazaar.com\n\n## License\n\n[New BSD License (3-clause)](LICENSE) © Digital Bazaar\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdigitalbazaar%2Fsecurity-document-loader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdigitalbazaar%2Fsecurity-document-loader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdigitalbazaar%2Fsecurity-document-loader/lists"}