@vercel/kms 0.0.0 → 0.1.0

package/docs/interfaces/SignMessageOptions.md

@@ -0,0 +1,71 @@
+[**@vercel/kms**](../README.md)
+
+---
+
+# Interface: SignMessageOptions
+
+Defined in: [packages/kms/src/sign-message.ts:7](https://github.com/vercel/vercel-internal/blob/main/packages/kms/src/sign-message.ts#L7)
+
+Options for [signMessage](../functions/signMessage.md).
+
+## Properties
+
+### baseUrl?
+
+> `optional` **baseUrl?**: `string`
+
+Defined in: [packages/kms/src/sign-message.ts:32](https://github.com/vercel/vercel-internal/blob/main/packages/kms/src/sign-message.ts#L32)
+
+Override the API base URL. Takes precedence over `region`.
+
+#### Default
+
+```ts
+"https://api-<region>.vercel.com/v1" or "https://api.vercel.com/v1"
+```
+
+---
+
+### issuerId
+
+> **issuerId**: `string`
+
+Defined in: [packages/kms/src/sign-message.ts:9](https://github.com/vercel/vercel-internal/blob/main/packages/kms/src/sign-message.ts#L9)
+
+The ID of the issuer whose signing key should sign the message.
+
+---
+
+### message
+
+> **message**: `string` \| [`Uint8Array`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)\<`ArrayBufferLike`\>
+
+Defined in: [packages/kms/src/sign-message.ts:15](https://github.com/vercel/vercel-internal/blob/main/packages/kms/src/sign-message.ts#L15)
+
+The message to sign. Provide raw bytes as a `Uint8Array`, or a `string`
+which is treated as UTF-8 text. The value is base64-encoded internally
+before being sent to the KMS API.
+
+---
+
+### region?
+
+> `optional` **region?**: `string`
+
+Defined in: [packages/kms/src/sign-message.ts:27](https://github.com/vercel/vercel-internal/blob/main/packages/kms/src/sign-message.ts#L27)
+
+Region for the regional KMS API host, e.g. `sfo1`, producing
+`https://api-<region>.vercel.com/v1`. Defaults to the `VERCEL_REGION`
+environment variable, falling back to the global `api.vercel.com` host.
+Ignored when `baseUrl` is provided.
+
+---
+
+### token?
+
+> `optional` **token?**: `string`
+
+Defined in: [packages/kms/src/sign-message.ts:20](https://github.com/vercel/vercel-internal/blob/main/packages/kms/src/sign-message.ts#L20)
+
+An explicit Vercel OIDC token to authenticate with. When omitted, the
+function's OIDC token is fetched automatically via `@vercel/oidc`.

package/docs/interfaces/SignTokenOptions.md

@@ -0,0 +1,89 @@
+[**@vercel/kms**](../README.md)
+
+---
+
+# Interface: SignTokenOptions
+
+Defined in: [packages/kms/src/sign-token.ts:7](https://github.com/vercel/vercel-internal/blob/main/packages/kms/src/sign-token.ts#L7)
+
+Options for [signToken](../functions/signToken.md).
+
+## Properties
+
+### baseUrl?
+
+> `optional` **baseUrl?**: `string`
+
+Defined in: [packages/kms/src/sign-token.ts:32](https://github.com/vercel/vercel-internal/blob/main/packages/kms/src/sign-token.ts#L32)
+
+Override the API base URL. Takes precedence over `region`.
+
+#### Default
+
+```ts
+"https://api-<region>.vercel.com/v1" or "https://api.vercel.com/v1"
+```
+
+---
+
+### claims?
+
+> `optional` **claims?**: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `unknown`\>
+
+Defined in: [packages/kms/src/sign-token.ts:11](https://github.com/vercel/vercel-internal/blob/main/packages/kms/src/sign-token.ts#L11)
+
+The claims to include in the token.
+
+---
+
+### headers?
+
+> `optional` **headers?**: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `unknown`\>
+
+Defined in: [packages/kms/src/sign-token.ts:13](https://github.com/vercel/vercel-internal/blob/main/packages/kms/src/sign-token.ts#L13)
+
+Additional headers to include in the token.
+
+---
+
+### issuerId
+
+> **issuerId**: `string`
+
+Defined in: [packages/kms/src/sign-token.ts:9](https://github.com/vercel/vercel-internal/blob/main/packages/kms/src/sign-token.ts#L9)
+
+The ID of the issuer whose signing key should sign the token.
+
+---
+
+### region?
+
+> `optional` **region?**: `string`
+
+Defined in: [packages/kms/src/sign-token.ts:27](https://github.com/vercel/vercel-internal/blob/main/packages/kms/src/sign-token.ts#L27)
+
+Region for the regional KMS API host, e.g. `sfo1`, producing
+`https://api-<region>.vercel.com/v1`. Defaults to the `VERCEL_REGION`
+environment variable, falling back to the global `api.vercel.com` host.
+Ignored when `baseUrl` is provided.
+
+---
+
+### token?
+
+> `optional` **token?**: `string`
+
+Defined in: [packages/kms/src/sign-token.ts:20](https://github.com/vercel/vercel-internal/blob/main/packages/kms/src/sign-token.ts#L20)
+
+An explicit Vercel OIDC token to authenticate with. When omitted, the
+function's OIDC token is fetched automatically via `@vercel/oidc`.
+
+---
+
+### ttl?
+
+> `optional` **ttl?**: `number` \| `null`
+
+Defined in: [packages/kms/src/sign-token.ts:15](https://github.com/vercel/vercel-internal/blob/main/packages/kms/src/sign-token.ts#L15)
+
+The time-to-live for the token, in seconds. Defaults to 300.

package/package.json

@@ -1,18 +1,53 @@
 {
   "name": "@vercel/kms",
-  "version": "0.0.0",
-  "description": "KMS package",
-  "license": "MIT",
-  "type": "module",
-  "main": "./index.js",
-  "exports": {
-    ".": "./index.js"
-  },
+  "description": "Runtime KMS signing helpers intended for use with Vercel Functions",
+  "homepage": "https://vercel.com",
   "files": [
-    "index.js",
-    "README.md"
+    "**/*.js",
+    "**/*.d.ts",
+    "**/*.md"
   ],
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "version": "0.1.0",
+  "repository": {
+    "directory": "packages/kms",
+    "type": "git",
+    "url": "git+https://github.com/vercel/vercel.git"
+  },
+  "bugs": {
+    "url": "https://github.com/vercel/vercel/issues"
+  },
+  "dependencies": {
+    "@vercel/oidc": "3.8.4"
+  },
+  "devDependencies": {
+    "prettier": "3.8.3",
+    "tinyspawn": "1.3.1",
+    "typedoc": "0.28.19",
+    "typedoc-plugin-markdown": "4.11.0",
+    "typedoc-plugin-mdn-links": "5.1.1",
+    "vitest": "4.1.10"
+  },
+  "peerDependenciesMeta": {},
+  "engines": {
+    "node": ">= 20"
+  },
+  "license": "Apache-2.0",
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "pretest": "pnpm run build:code",
+    "test": "vitest",
+    "vitest-unit": "glob --absolute 'src/**/*.test.ts'",
+    "build": "pnpm run build:code && pnpm run build:docs",
+    "build:code": "node build.mjs",
+    "build:docs": "typedoc && prettier --write docs/**/*.md docs/*.md"
   }
-}
+}