@govuk-one-login/mobile-wallet-mdoc-builder 0.0.0 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 GOV.UK One Login
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,71 @@
+# Mobile Wallet mdoc Builder
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+## Overview
+
+A TypeScript library for building mdoc (ISO 18013-5) documents for use with GOV.UK Wallet. It provides a type-safe API
+for constructing and encoding mdoc-based credentials.
+
+## Tech stack
+
+Built with TypeScript and Node.js, published as a dual-format (ESM and CJS) npm package.
+
+## Prerequisites
+
+- [Node.js](https://nodejs.org/en) — we recommend managing versions with [nvm](https://github.com/nvm-sh/nvm)
+- [Pre-commit](https://pre-commit.com/)
+
+## Set up locally
+
+### Install
+
+```bash
+nvm use
+npm install
+```
+
+### Lint and format
+
+```bash
+npm run lint
+npm run format
+```
+
+### Type check
+
+```bash
+npm run typecheck
+```
+
+### Build
+
+```bash
+npm run build
+```
+
+## Contributing
+
+This project uses [pre-commit](https://pre-commit.com/) to enforce code quality and validate commit messages against [Conventional Commits](https://www.conventionalcommits.org/) standards. Non-conforming messages will be rejected.
+
+Ensure your branch is up to date and all hooks pass before opening a pull request. Avoid using the git `--no-verify` flag to skip these checks unless absolutely necessary.
+
+### Installing pre-commit hooks
+
+```bash
+brew install pre-commit
+```
+
+```bash
+pre-commit install --hook-type pre-commit --hook-type commit-msg
+```
+
+## Documentation
+
+- [Release process](docs/release-process.md)
+- [Component architecture](docs/component-architecture.md)
+- [CBOR test guide](docs/cbor-test-guide.md)
+
+## Licence
+
+[MIT License](LICENSE)

package/dist/index.cjs

@@ -0,0 +1,53 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/types/dateFormat.ts
+/**
+* Specifies the date encoding format for a data element.
+*
+* Used to indicate whether a Date value should be encoded as a full-date
+* (YYYY-MM-DD) or a date-time (ISO 8601 with time component) in the
+* resulting CBOR structure.
+*/
+let DateFormat = /* @__PURE__ */ function(DateFormat) {
+	/** Encode as a full-date (YYYY-MM-DD) per RFC 3339. */
+	DateFormat[DateFormat["FullDate"] = 0] = "FullDate";
+	/** Encode as a date-time (YYYY-MM-DDTHH:mm:ssZ) per RFC 3339. */
+	DateFormat[DateFormat["DateTime"] = 1] = "DateTime";
+	return DateFormat;
+}({});
+//#endregion
+//#region src/types/mdocBuilderError.ts
+/**
+* Error thrown by the mdoc builder when construction or signing fails.
+*
+* The error structure will be refined as implementation progresses
+* (e.g., aggregated validation errors may be added later).
+*/
+var MdocBuilderError = class extends Error {
+	constructor(message, options) {
+		super(message, options);
+		this.name = "MdocBuilderError";
+	}
+};
+//#endregion
+//#region src/index.ts
+/**
+* Builds an mdoc (ISO 18013-5) document from the provided input.
+*
+* @param input - The mdoc builder input containing document data and metadata.
+* @param sign - A signing function that will be called with the data to sign.
+* @returns A promise resolving to the built Mdoc document.
+* @throws {MdocBuilderError} Always throws until implementation is complete.
+*/
+function buildMdoc(input, sign) {
+	console.log("buildMdoc not implemented", {
+		input,
+		sign
+	});
+	return Promise.reject(new MdocBuilderError("not implemented"));
+}
+//#endregion
+exports.DateFormat = DateFormat;
+exports.MdocBuilderError = MdocBuilderError;
+exports.buildMdoc = buildMdoc;
+
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":[],"sources":["../src/types/dateFormat.ts","../src/types/mdocBuilderError.ts","../src/index.ts"],"sourcesContent":["/**\n * Specifies the date encoding format for a data element.\n *\n * Used to indicate whether a Date value should be encoded as a full-date\n * (YYYY-MM-DD) or a date-time (ISO 8601 with time component) in the\n * resulting CBOR structure.\n */\nexport enum DateFormat {\n  /** Encode as a full-date (YYYY-MM-DD) per RFC 3339. */\n  FullDate = 0,\n\n  /** Encode as a date-time (YYYY-MM-DDTHH:mm:ssZ) per RFC 3339. */\n  DateTime = 1,\n}\n","/**\n * Error thrown by the mdoc builder when construction or signing fails.\n *\n * The error structure will be refined as implementation progresses\n * (e.g., aggregated validation errors may be added later).\n */\nexport class MdocBuilderError extends Error {\n  constructor(message: string, options?: ErrorOptions) {\n    super(message, options);\n    this.name = \"MdocBuilderError\";\n  }\n}\n","export { DateFormat, MdocBuilderError } from \"./types\";\nexport type {\n  PrimitiveElementValue,\n  DataElementValue,\n  DataElement,\n  NameSpaces,\n  CredentialValidity,\n  StatusList,\n  MdocBuilderInput,\n  SigningFunction,\n  Mdoc,\n} from \"./types\";\nimport type { Mdoc, MdocBuilderInput, SigningFunction } from \"./types\";\nimport { MdocBuilderError } from \"./types\";\n\n/**\n * Builds an mdoc (ISO 18013-5) document from the provided input.\n *\n * @param input - The mdoc builder input containing document data and metadata.\n * @param sign - A signing function that will be called with the data to sign.\n * @returns A promise resolving to the built Mdoc document.\n * @throws {MdocBuilderError} Always throws until implementation is complete.\n */\nexport function buildMdoc(\n  input: MdocBuilderInput,\n  sign: SigningFunction,\n): Promise<Mdoc> {\n  console.log(\"buildMdoc not implemented\", { input, sign });\n  return Promise.reject(new MdocBuilderError(\"not implemented\"));\n}\n"],"mappings":";;;;;;;;;AAOA,IAAY,aAAL,yBAAA,YAAA;;CAEL,WAAA,WAAA,cAAA,KAAA;;CAGA,WAAA,WAAA,cAAA,KAAA;;AACF,EAAA,CAAA,CAAA;;;;;;;;;ACPA,IAAa,mBAAb,cAAsC,MAAM;CAC1C,YAAY,SAAiB,SAAwB;EACnD,MAAM,SAAS,OAAO;EACtB,KAAK,OAAO;CACd;AACF;;;;;;;;;;;ACYA,SAAgB,UACd,OACA,MACe;CACf,QAAQ,IAAI,6BAA6B;EAAE;EAAO;CAAK,CAAC;CACxD,OAAO,QAAQ,OAAO,IAAI,iBAAiB,iBAAiB,CAAC;AAC/D"}

package/dist/index.d.cts

@@ -0,0 +1,150 @@
+//#region src/types/dateFormat.d.ts
+/**
+ * Specifies the date encoding format for a data element.
+ *
+ * Used to indicate whether a Date value should be encoded as a full-date
+ * (YYYY-MM-DD) or a date-time (ISO 8601 with time component) in the
+ * resulting CBOR structure.
+ */
+declare enum DateFormat {
+  /** Encode as a full-date (YYYY-MM-DD) per RFC 3339. */
+  FullDate = 0,
+  /** Encode as a date-time (YYYY-MM-DDTHH:mm:ssZ) per RFC 3339. */
+  DateTime = 1,
+}
+//#endregion
+//#region src/types/dataElementValue.d.ts
+/**
+ * The union of permitted scalar types for a data element value.
+ *
+ * These map to the CBOR major types used in ISO 18013-5 mdoc documents.
+ */
+type PrimitiveElementValue = string | number | boolean | Date | Uint8Array;
+/**
+ * The union of all permitted data element value types.
+ *
+ * A data element value can be a single primitive, an array of primitives,
+ * a map of string keys to primitives, or an array of such maps.
+ */
+type DataElementValue = PrimitiveElementValue | PrimitiveElementValue[] | Map<string, PrimitiveElementValue> | Map<string, PrimitiveElementValue>[];
+//#endregion
+//#region src/types/dataElement.d.ts
+/**
+ * A single data element within a namespace.
+ *
+ * Represents an identifier–value pair as defined in ISO 18013-5,
+ * with an optional date format hint for Date values.
+ */
+interface DataElement {
+  /** The element identifier (e.g. "family_name", "birth_date"). */
+  elementIdentifier: string;
+  /** The element value. */
+  elementValue: DataElementValue;
+  /** Optional format for Date values. Defaults to DateTime (Tag 0, tdate) when not specified. */
+  dateFormat?: DateFormat;
+}
+//#endregion
+//#region src/types/nameSpaces.d.ts
+/**
+ * A map of namespace identifiers to their data elements.
+ *
+ * Each key is a namespace string (e.g. "org.iso.18013.5.1") and each value
+ * is the array of data elements within that namespace. Uses Map to preserve
+ * insertion order for deterministic CBOR encoding.
+ */
+type NameSpaces = Map<string, DataElement[]>;
+//#endregion
+//#region src/types/credentialValidity.d.ts
+/**
+ * Defines the validity period of a credential.
+ *
+ * Maps to the ValidityInfo structure in ISO 18013-5.
+ */
+interface CredentialValidity {
+  /** The earliest point in time from which the credential is valid. */
+  earliestValidFrom?: Date;
+  /** The point in time at which the credential expires. */
+  validUntil: Date;
+  /** The expected time at which the credential will be updated. */
+  expectedUpdate?: Date;
+}
+//#endregion
+//#region src/types/statusList.d.ts
+/**
+ * A reference to a status list entry for credential revocation checking.
+ */
+interface StatusList {
+  /** The index of this credential's entry in the status list. */
+  idx: number;
+  /** The URI of the status list. */
+  uri: string;
+}
+//#endregion
+//#region src/types/mdocBuilderInput.d.ts
+/**
+ * The top-level input for building a mdoc document.
+ */
+interface MdocBuilderInput {
+  /** The document type (e.g. "org.iso.18013.5.1.mDL"). */
+  documentType: string;
+  /** The namespaces and their data elements to include in the mdoc. */
+  nameSpaces: NameSpaces;
+  /** The SPKI-encoded holder public key. */
+  deviceKey: Uint8Array;
+  /** The validity period of the credential. */
+  credentialValidity: CredentialValidity;
+  /** A reference to a status list for revocation checking. */
+  statusList: StatusList;
+  /**
+   * Array of DER-encoded certificates. The library will use
+   * certificateChain[0] as the document signing certificate.
+   */
+  certificateChain: Uint8Array[];
+}
+//#endregion
+//#region src/types/signingFunction.d.ts
+/**
+ * A function that signs the provided data and returns the signature.
+ *
+ * @param toBeSigned - The bytes to be signed.
+ * @returns A promise resolving to the signature bytes.
+ */
+type SigningFunction = (toBeSigned: Uint8Array) => Promise<Uint8Array>;
+//#endregion
+//#region src/types/mdoc.d.ts
+/**
+ * A built mdoc document with multiple output format options.
+ */
+interface Mdoc {
+  /** Returns the mdoc encoded as a base64url string. */
+  asBase64Url(): string;
+  /** Returns the mdoc encoded as a hexadecimal string. */
+  asHex(): string;
+  /** Returns the mdoc as raw bytes. */
+  asBytes(): Uint8Array;
+}
+//#endregion
+//#region src/types/mdocBuilderError.d.ts
+/**
+ * Error thrown by the mdoc builder when construction or signing fails.
+ *
+ * The error structure will be refined as implementation progresses
+ * (e.g., aggregated validation errors may be added later).
+ */
+declare class MdocBuilderError extends Error {
+  constructor(message: string, options?: ErrorOptions);
+}
+//#endregion
+//#region src/index.d.ts
+/**
+ * Builds an mdoc (ISO 18013-5) document from the provided input.
+ *
+ * @param input - The mdoc builder input containing document data and metadata.
+ * @param sign - A signing function that will be called with the data to sign.
+ * @returns A promise resolving to the built Mdoc document.
+ * @throws {MdocBuilderError} Always throws until implementation is complete.
+ */
+declare function buildMdoc(input: MdocBuilderInput, sign: SigningFunction): Promise<Mdoc>;
+//#endregion
+export { type CredentialValidity, type DataElement, type DataElementValue, DateFormat, type Mdoc, MdocBuilderError, type MdocBuilderInput, type NameSpaces, type PrimitiveElementValue, type SigningFunction, type StatusList, buildMdoc };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -0,0 +1,150 @@
+//#region src/types/dateFormat.d.ts
+/**
+ * Specifies the date encoding format for a data element.
+ *
+ * Used to indicate whether a Date value should be encoded as a full-date
+ * (YYYY-MM-DD) or a date-time (ISO 8601 with time component) in the
+ * resulting CBOR structure.
+ */
+declare enum DateFormat {
+  /** Encode as a full-date (YYYY-MM-DD) per RFC 3339. */
+  FullDate = 0,
+  /** Encode as a date-time (YYYY-MM-DDTHH:mm:ssZ) per RFC 3339. */
+  DateTime = 1,
+}
+//#endregion
+//#region src/types/dataElementValue.d.ts
+/**
+ * The union of permitted scalar types for a data element value.
+ *
+ * These map to the CBOR major types used in ISO 18013-5 mdoc documents.
+ */
+type PrimitiveElementValue = string | number | boolean | Date | Uint8Array;
+/**
+ * The union of all permitted data element value types.
+ *
+ * A data element value can be a single primitive, an array of primitives,
+ * a map of string keys to primitives, or an array of such maps.
+ */
+type DataElementValue = PrimitiveElementValue | PrimitiveElementValue[] | Map<string, PrimitiveElementValue> | Map<string, PrimitiveElementValue>[];
+//#endregion
+//#region src/types/dataElement.d.ts
+/**
+ * A single data element within a namespace.
+ *
+ * Represents an identifier–value pair as defined in ISO 18013-5,
+ * with an optional date format hint for Date values.
+ */
+interface DataElement {
+  /** The element identifier (e.g. "family_name", "birth_date"). */
+  elementIdentifier: string;
+  /** The element value. */
+  elementValue: DataElementValue;
+  /** Optional format for Date values. Defaults to DateTime (Tag 0, tdate) when not specified. */
+  dateFormat?: DateFormat;
+}
+//#endregion
+//#region src/types/nameSpaces.d.ts
+/**
+ * A map of namespace identifiers to their data elements.
+ *
+ * Each key is a namespace string (e.g. "org.iso.18013.5.1") and each value
+ * is the array of data elements within that namespace. Uses Map to preserve
+ * insertion order for deterministic CBOR encoding.
+ */
+type NameSpaces = Map<string, DataElement[]>;
+//#endregion
+//#region src/types/credentialValidity.d.ts
+/**
+ * Defines the validity period of a credential.
+ *
+ * Maps to the ValidityInfo structure in ISO 18013-5.
+ */
+interface CredentialValidity {
+  /** The earliest point in time from which the credential is valid. */
+  earliestValidFrom?: Date;
+  /** The point in time at which the credential expires. */
+  validUntil: Date;
+  /** The expected time at which the credential will be updated. */
+  expectedUpdate?: Date;
+}
+//#endregion
+//#region src/types/statusList.d.ts
+/**
+ * A reference to a status list entry for credential revocation checking.
+ */
+interface StatusList {
+  /** The index of this credential's entry in the status list. */
+  idx: number;
+  /** The URI of the status list. */
+  uri: string;
+}
+//#endregion
+//#region src/types/mdocBuilderInput.d.ts
+/**
+ * The top-level input for building a mdoc document.
+ */
+interface MdocBuilderInput {
+  /** The document type (e.g. "org.iso.18013.5.1.mDL"). */
+  documentType: string;
+  /** The namespaces and their data elements to include in the mdoc. */
+  nameSpaces: NameSpaces;
+  /** The SPKI-encoded holder public key. */
+  deviceKey: Uint8Array;
+  /** The validity period of the credential. */
+  credentialValidity: CredentialValidity;
+  /** A reference to a status list for revocation checking. */
+  statusList: StatusList;
+  /**
+   * Array of DER-encoded certificates. The library will use
+   * certificateChain[0] as the document signing certificate.
+   */
+  certificateChain: Uint8Array[];
+}
+//#endregion
+//#region src/types/signingFunction.d.ts
+/**
+ * A function that signs the provided data and returns the signature.
+ *
+ * @param toBeSigned - The bytes to be signed.
+ * @returns A promise resolving to the signature bytes.
+ */
+type SigningFunction = (toBeSigned: Uint8Array) => Promise<Uint8Array>;
+//#endregion
+//#region src/types/mdoc.d.ts
+/**
+ * A built mdoc document with multiple output format options.
+ */
+interface Mdoc {
+  /** Returns the mdoc encoded as a base64url string. */
+  asBase64Url(): string;
+  /** Returns the mdoc encoded as a hexadecimal string. */
+  asHex(): string;
+  /** Returns the mdoc as raw bytes. */
+  asBytes(): Uint8Array;
+}
+//#endregion
+//#region src/types/mdocBuilderError.d.ts
+/**
+ * Error thrown by the mdoc builder when construction or signing fails.
+ *
+ * The error structure will be refined as implementation progresses
+ * (e.g., aggregated validation errors may be added later).
+ */
+declare class MdocBuilderError extends Error {
+  constructor(message: string, options?: ErrorOptions);
+}
+//#endregion
+//#region src/index.d.ts
+/**
+ * Builds an mdoc (ISO 18013-5) document from the provided input.
+ *
+ * @param input - The mdoc builder input containing document data and metadata.
+ * @param sign - A signing function that will be called with the data to sign.
+ * @returns A promise resolving to the built Mdoc document.
+ * @throws {MdocBuilderError} Always throws until implementation is complete.
+ */
+declare function buildMdoc(input: MdocBuilderInput, sign: SigningFunction): Promise<Mdoc>;
+//#endregion
+export { type CredentialValidity, type DataElement, type DataElementValue, DateFormat, type Mdoc, MdocBuilderError, type MdocBuilderInput, type NameSpaces, type PrimitiveElementValue, type SigningFunction, type StatusList, buildMdoc };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,50 @@
+//#region src/types/dateFormat.ts
+/**
+* Specifies the date encoding format for a data element.
+*
+* Used to indicate whether a Date value should be encoded as a full-date
+* (YYYY-MM-DD) or a date-time (ISO 8601 with time component) in the
+* resulting CBOR structure.
+*/
+let DateFormat = /* @__PURE__ */ function(DateFormat) {
+	/** Encode as a full-date (YYYY-MM-DD) per RFC 3339. */
+	DateFormat[DateFormat["FullDate"] = 0] = "FullDate";
+	/** Encode as a date-time (YYYY-MM-DDTHH:mm:ssZ) per RFC 3339. */
+	DateFormat[DateFormat["DateTime"] = 1] = "DateTime";
+	return DateFormat;
+}({});
+//#endregion
+//#region src/types/mdocBuilderError.ts
+/**
+* Error thrown by the mdoc builder when construction or signing fails.
+*
+* The error structure will be refined as implementation progresses
+* (e.g., aggregated validation errors may be added later).
+*/
+var MdocBuilderError = class extends Error {
+	constructor(message, options) {
+		super(message, options);
+		this.name = "MdocBuilderError";
+	}
+};
+//#endregion
+//#region src/index.ts
+/**
+* Builds an mdoc (ISO 18013-5) document from the provided input.
+*
+* @param input - The mdoc builder input containing document data and metadata.
+* @param sign - A signing function that will be called with the data to sign.
+* @returns A promise resolving to the built Mdoc document.
+* @throws {MdocBuilderError} Always throws until implementation is complete.
+*/
+function buildMdoc(input, sign) {
+	console.log("buildMdoc not implemented", {
+		input,
+		sign
+	});
+	return Promise.reject(new MdocBuilderError("not implemented"));
+}
+//#endregion
+export { DateFormat, MdocBuilderError, buildMdoc };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/types/dateFormat.ts","../src/types/mdocBuilderError.ts","../src/index.ts"],"sourcesContent":["/**\n * Specifies the date encoding format for a data element.\n *\n * Used to indicate whether a Date value should be encoded as a full-date\n * (YYYY-MM-DD) or a date-time (ISO 8601 with time component) in the\n * resulting CBOR structure.\n */\nexport enum DateFormat {\n  /** Encode as a full-date (YYYY-MM-DD) per RFC 3339. */\n  FullDate = 0,\n\n  /** Encode as a date-time (YYYY-MM-DDTHH:mm:ssZ) per RFC 3339. */\n  DateTime = 1,\n}\n","/**\n * Error thrown by the mdoc builder when construction or signing fails.\n *\n * The error structure will be refined as implementation progresses\n * (e.g., aggregated validation errors may be added later).\n */\nexport class MdocBuilderError extends Error {\n  constructor(message: string, options?: ErrorOptions) {\n    super(message, options);\n    this.name = \"MdocBuilderError\";\n  }\n}\n","export { DateFormat, MdocBuilderError } from \"./types\";\nexport type {\n  PrimitiveElementValue,\n  DataElementValue,\n  DataElement,\n  NameSpaces,\n  CredentialValidity,\n  StatusList,\n  MdocBuilderInput,\n  SigningFunction,\n  Mdoc,\n} from \"./types\";\nimport type { Mdoc, MdocBuilderInput, SigningFunction } from \"./types\";\nimport { MdocBuilderError } from \"./types\";\n\n/**\n * Builds an mdoc (ISO 18013-5) document from the provided input.\n *\n * @param input - The mdoc builder input containing document data and metadata.\n * @param sign - A signing function that will be called with the data to sign.\n * @returns A promise resolving to the built Mdoc document.\n * @throws {MdocBuilderError} Always throws until implementation is complete.\n */\nexport function buildMdoc(\n  input: MdocBuilderInput,\n  sign: SigningFunction,\n): Promise<Mdoc> {\n  console.log(\"buildMdoc not implemented\", { input, sign });\n  return Promise.reject(new MdocBuilderError(\"not implemented\"));\n}\n"],"mappings":";;;;;;;;AAOA,IAAY,aAAL,yBAAA,YAAA;;CAEL,WAAA,WAAA,cAAA,KAAA;;CAGA,WAAA,WAAA,cAAA,KAAA;;AACF,EAAA,CAAA,CAAA;;;;;;;;;ACPA,IAAa,mBAAb,cAAsC,MAAM;CAC1C,YAAY,SAAiB,SAAwB;EACnD,MAAM,SAAS,OAAO;EACtB,KAAK,OAAO;CACd;AACF;;;;;;;;;;;ACYA,SAAgB,UACd,OACA,MACe;CACf,QAAQ,IAAI,6BAA6B;EAAE;EAAO;CAAK,CAAC;CACxD,OAAO,QAAQ,OAAO,IAAI,iBAAiB,iBAAiB,CAAC;AAC/D"}

package/package.json

@@ -1,5 +1,54 @@
 {
   "name": "@govuk-one-login/mobile-wallet-mdoc-builder",
-  "version": "0.0.0"
+  "version": "0.1.0",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/govuk-one-login/mobile-wallet-mdoc-builder.git"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "test": "vitest run --coverage",
+    "test:component": "npm run build && vitest run --config vitest.config.component.ts",
+    "test:component:ci": "vitest run --config vitest.config.component.ts",
+    "publish-v0-to-npm": "./publish-v0-to-npm.sh"
+  },
+  "devDependencies": {
+    "@types/node": "^26.0.1",
+    "@vitest/coverage-v8": "^5.0.0",
+    "eslint": "^9.0.0",
+    "prettier": "^3.0.0",
+    "tsdown": "^0.12.0",
+    "typescript": "^5.0.0",
+    "typescript-eslint": "^8.0.0",
+    "vitest": "^5.0.0"
+  },
+  "dependencies": {
+    "cbor2": "2.3.0",
+    "zod": "4.4.3"
+  }
 }
-