0.2.2 • Published 9 days ago

@divviup/common v0.2.2

Weekly downloads
-
License
MPL-2.0
Repository
-
Last release
9 days ago

DivviUp Typescript Client

Coverage Status CI

docs for main

Protocol Versions and Release Branches

The main branch is under continuous development and will usually be partway between DAP and VDAF drafts. divviup-ts uses stable release branches to maintain implementations of different draft versions. Artifacts for some draft version are published from a corresponding release/dap-draft-xy branch. Only supported release branches receive dependency updates and backports.

DAP

Package versionGit branchProtocol versionConforms to specification?Status
N/Arelease-dap-draft-02draft-ietf-ppm-dap-02YesUnmaintained
N/Arelease-dap-draft-03draft-ietf-ppm-dap-03YesUnmaintained as of May 22, 2023
@divviup/dap@0.1release-dap-draft-04draft-ietf-ppm-dap-04YesSupported
@divviup/dap@0.7release-dap-draft-07draft-ietf-ppm-dap-07YesSupported
@divviup/dap@0.9maindraft-ietf-ppm-dap-09YesSupported

VDAF and Prio3

VDAF PackagePrio3 PackageGit branchProtocol versionConforms to specification?Status
N/AN/Arelease/dap-draft-03draft-irtf-cfrg-vdaf-03YesUnmaintained as of May 22, 2023
@divviup/vdaf@0.1@divviup/prio3@0.1release/dap-draft-04draft-irtf-cfrg-vdaf-05YesSupported
@divviup/vdaf@0.7@divviup/prio3@0.7release/dap-draft-07draft-irtf-cfrg-vdaf-07YesSupported
@divviup/vdaf@0.8@divviup/prio3@0.8maindraft-irtf-cfrg-vdaf-08YesSupported

Bundling into an npm application

$ npm add @divviup/dap
import Task from "@divviup/dap";

const task = new Task({
  type: "sum",
  bits: 8,
  id: "3XTBHxTtUAtI516GeXZsVIKjBPYVNIYmF94vEBb4jcY",
  leader: "https://dap.api.divviup.org",
  helper: "https://dap.example.com",
  timePrecisionSeconds: 3600,
});

await task.sendMeasurement(42);

CDN URLs

DivviUp publishes bundled and minified builds suitable for use from a script tag. Task will be available on globalThis as divviup.dap.Task.

JsDelivr

<script
    src="https://cdn.jsdelivr.net/npm/@divviup/dap@0.7.0/dist/browser.js"
    crossorigin="anonymous"
    integrity="sha384-vDbUcIcXsbrWLhKwkF/wwM0cnW+5y9fiPA695EnPd58okNZwWuLsR0NF98zzyNkT">
</script>

UNPKG

<script
    src="https://unpkg.com/@divviup/dap@0.7.0/dist/browser.js"
    crossorigin="anonymous"
    integrity="sha384-vDbUcIcXsbrWLhKwkF/wwM0cnW+5y9fiPA695EnPd58okNZwWuLsR0NF98zzyNkT">
</script>