@jaypie/mcp 0.7.34 → 0.7.35

package/dist/suites/docs/index.js

@@ -9,7 +9,7 @@ import { gt } from 'semver';
 /**
  * Docs Suite - Documentation services (skill, version, release_notes)
  */
-const BUILD_VERSION_STRING = "@jaypie/mcp@0.7.34#4de9b6a9"
+const BUILD_VERSION_STRING = "@jaypie/mcp@0.7.35#689b7398"
     ;
 const __filename$1 = fileURLToPath(import.meta.url);
 const __dirname$1 = path.dirname(__filename$1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jaypie/mcp",
-  "version": "0.7.34",
+  "version": "0.7.35",
   "description": "Jaypie MCP",
   "repository": {
     "type": "git",

package/release-notes/jaypie/1.2.19.md

@@ -0,0 +1,9 @@
+---
+version: 1.2.19
+date: 2026-03-13
+summary: Update kit dependency for flexible API key generation and validation
+---
+
+## Changes
+
+- Updated `@jaypie/kit` to 1.2.3 with optional prefix/checksum in API key functions

package/release-notes/kit/1.2.3.md

@@ -0,0 +1,13 @@
+---
+version: 1.2.3
+date: 2026-03-13
+summary: Make API key prefix and checksum optional, accept both _ and - separators
+---
+
+## Changes
+
+- `generateJaypieKey` now supports `prefix: ""` (omit prefix) and `checksum: 0` (omit checksum)
+- `validateJaypieKey` no longer requires prefix or checksum — keys without them are valid
+- Checksum separator is optional in validation — `body_checksum` and `bodychecksum` both validate
+- Validator accepts both `_` and `-` as separators in prefix matter
+- Changed example issuer from `jpi` to `jaypie` to encourage explicit naming

package/release-notes/mcp/0.7.35.md

@@ -0,0 +1,10 @@
+---
+version: 0.7.35
+date: 2026-03-13
+summary: Add ~apikey skill for API key generation, validation, and hashing
+---
+
+## Changes
+
+- Added `apikey` skill documenting `generateJaypieKey`, `validateJaypieKey`, and `hashJaypieKey`
+- Updated development category and skill index to include `apikey`

package/release-notes/testkit/1.2.25.md

@@ -0,0 +1,9 @@
+---
+version: 1.2.25
+date: 2026-03-13
+summary: Update generateJaypieKey mock to match new format with checksum separator
+---
+
+## Changes
+
+- Updated `generateJaypieKey` mock return value to include separator before checksum (`sk_MOCK...000_abcd`)

package/skills/agents.md

@@ -33,7 +33,7 @@ Complete stack styles, techniques, and traditions.
 `mcp__jaypie__skill(alias: String)`
 
 Contents: index, releasenotes
-Development: documentation, errors, llm, logs, mocks, monorepo, style, subpackages, tests
+Development: apikey, documentation, errors, llm, logs, mocks, monorepo, style, subpackages, tests
 Infrastructure: aws, cdk, cicd, datadog, dns, dynamodb, express, lambda, secrets, streaming, variables, websockets
 Patterns: fabric, handlers, models, services, vocabulary
 Meta: issues, jaypie, skills, tools

package/skills/apikey.md

@@ -0,0 +1,178 @@
+---
+description: API key generation, validation, and hashing with Jaypie keys
+related: secrets, style, tests
+---
+
+# API Keys
+
+Jaypie provides three functions for working with API keys: `generateJaypieKey`, `validateJaypieKey`, and `hashJaypieKey`. Available from `jaypie` or `@jaypie/kit`.
+
+## Generate
+
+```typescript
+import { generateJaypieKey } from "jaypie";
+
+const key = generateJaypieKey();
+// "sk_A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6_Xq7R"
+//  ^^ prefix    ^^ 32-char base62 body   ^^ 4-char checksum
+```
+
+### With Issuer
+
+Use `issuer` to namespace keys by application or service. Prefer explicit naming:
+
+```typescript
+const key = generateJaypieKey({ issuer: "jaypie" });
+// "sk_jaypie_A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6_Xq7R"
+```
+
+### Without Prefix or Checksum
+
+Prefix and checksum are optional. Pass `prefix: ""` or `checksum: 0` to omit:
+
+```typescript
+generateJaypieKey({ prefix: "" });
+// "A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6_Xq7R"
+
+generateJaypieKey({ prefix: "", checksum: 0 });
+// "A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6"
+
+generateJaypieKey({ prefix: "", issuer: "jaypie" });
+// "jaypie_A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6_Xq7R"
+```
+
+### Options
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `checksum` | `4` | Checksum character count (0 to omit) |
+| `issuer` | (none) | Namespace segment after prefix |
+| `length` | `32` | Random body length |
+| `pool` | base62 (`0-9A-Za-z`) | Character pool for body |
+| `prefix` | `"sk"` | Key prefix (`""` to omit) |
+| `separator` | `"_"` | Delimiter between segments |
+
+All options are optional. Zero-param call produces `sk_<32 base62>_<4 checksum>`.
+
+### Valid Formats
+
+All of the following are valid key formats:
+
+| Format | Example |
+|--------|---------|
+| `sk_issuer_body_checksum` | `sk_jaypie_A1b2...p6_Xq7R` |
+| `sk_issuer_bodychecksum` | `sk_jaypie_A1b2...p6Xq7R` |
+| `sk_body_checksum` | `sk_A1b2...p6_Xq7R` |
+| `issuer_bodychecksum` | `jaypie_A1b2...p6Xq7R` |
+| `body_checksum` | `A1b2...p6_Xq7R` |
+| `body` | `A1b2...p6` |
+
+Both `_` and `-` are accepted as separators in prefix matter.
+
+## Validate
+
+Checks format, character pool, and checksum (when present). Prefix and checksum are **not required** — a key without them is still valid. Pass `issuer` when the key was generated with one:
+
+```typescript
+import { validateJaypieKey } from "jaypie";
+
+validateJaypieKey(key);                             // true
+validateJaypieKey(key, { issuer: "jaypie" });        // true (if generated with issuer)
+validateJaypieKey("tampered" + key);                 // false
+validateJaypieKey(key, { issuer: "wrong" });         // false
+```
+
+Keys without a prefix validate with default options:
+
+```typescript
+const bare = generateJaypieKey({ prefix: "" });
+validateJaypieKey(bare);  // true — prefix is not required
+```
+
+Keys without checksum validate with default options:
+
+```typescript
+const noCheck = generateJaypieKey({ checksum: 0 });
+validateJaypieKey(noCheck);  // true — checksum is not required
+```
+
+Checksum separator is also optional — `body_checksum` and `bodychecksum` both validate.
+
+Validation does **not** check revocation or authorization — only structural validity.
+
+## Hash
+
+Store hashed keys instead of plaintext. Uses HMAC-SHA256 when salted, SHA-256 otherwise:
+
+```typescript
+import { hashJaypieKey } from "jaypie";
+
+// With explicit salt
+const hash = hashJaypieKey(key, { salt: "my-secret-salt" });
+
+// Falls back to process.env.PROJECT_SALT
+const hash = hashJaypieKey(key);
+```
+
+Returns a 64-character hex string. Deterministic — same key and salt always produce the same hash.
+
+### Salt Resolution
+
+1. Explicit `{ salt }` parameter (highest priority)
+2. `process.env.PROJECT_SALT` environment variable
+3. No salt — plain SHA-256 (logs a warning)
+
+## Typical Workflow
+
+1. **Generate** a key and return it to the user (only time plaintext is visible)
+2. **Hash** the key and store the hash in the database
+3. On subsequent requests, **validate** the key format, then **hash** and compare against stored hash
+
+```typescript
+import { generateJaypieKey, hashJaypieKey, validateJaypieKey } from "jaypie";
+
+// Provisioning
+const key = generateJaypieKey({ issuer: "jaypie" });
+const hash = hashJaypieKey(key);
+await db.storeApiKeyHash(userId, hash);
+// Return key to user
+
+// Authentication
+function authenticate(presentedKey: string) {
+  if (!validateJaypieKey(presentedKey, { issuer: "jaypie" })) {
+    return false; // Malformed
+  }
+  const hash = hashJaypieKey(presentedKey);
+  return db.findByApiKeyHash(hash);
+}
+```
+
+## Testing
+
+Mocked in `@jaypie/testkit`:
+
+```typescript
+import { generateJaypieKey, hashJaypieKey, validateJaypieKey } from "@jaypie/testkit/mock";
+```
+
+- `generateJaypieKey` returns `"sk_MOCK00000000000000000000000000_abcd"`
+- `hashJaypieKey` returns `"0".repeat(64)` (64 zeroes)
+- `validateJaypieKey` returns `true`
+
+## Infrastructure
+
+Use with the generated secrets pattern for `PROJECT_SALT`:
+
+```typescript
+// CDK
+new JaypieEnvSecret(this, "ProjectSalt", {
+  envKey: "PROJECT_SALT",
+  generateSecretString: {
+    excludePunctuation: true,
+    includeSpace: false,
+    passwordLength: 64,
+  },
+});
+```
+
+See `~secrets` for the full secrets management pattern.

package/skills/development.md

@@ -1,6 +1,6 @@
 ---
 description: Coding standards, testing, and documentation
-related: documentation, errors, logs, mocks, monorepo, style, subpackage, tests
+related: apikey, documentation, errors, logs, mocks, monorepo, style, subpackage, tests
 ---
 
 # Development
@@ -11,6 +11,7 @@ Coding standards and practices for Jaypie projects.
 
 | Alias | Description |
 |-------|-------------|
+| `apikey` | API key generation, validation, and hashing |
 | `documentation` | Writing style and documentation |
 | `errors` | Error handling with @jaypie/errors |
 | `logs` | Logging patterns and conventions |

package/skills/skills.md

@@ -16,7 +16,7 @@ Look up skills by alias: `mcp__jaypie__skill(alias)`
 | Category | Skills |
 |----------|--------|
 | contents | index, releasenotes |
-| development | documentation, errors, llm, logs, mocks, monorepo, style, subpackages, tests |
+| development | apikey, documentation, errors, llm, logs, mocks, monorepo, style, subpackages, tests |
 | infrastructure | aws, cdk, cicd, datadog, dns, dynamodb, express, lambda, secrets, streaming, variables, websockets |
 | patterns | fabric, handlers, models, services, vocabulary |
 | meta | issues, jaypie, skills, tools |