@private.me/xbind 1.2.16 → 1.2.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +34 -8
  2. package/package.json +1 -1
  3. package/share1.dat +0 -0
package/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  # @private.me/xbind
2
2
 
3
3
  ![npm version](https://img.shields.io/npm/v/@private.me/xbind)
4
- ![version](https://img.shields.io/badge/version-1.2.16-blue)
4
+ ![version](https://img.shields.io/badge/version-1.2.17-blue)
5
5
  ![tests](https://img.shields.io/badge/tests-1245%20passing-brightgreen)
6
6
  ![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue)
7
7
  ![license](https://img.shields.io/badge/license-Proprietary-blue)
@@ -12,7 +12,7 @@ Build AI agents that communicate securely using ML-DSA-65 DID identity, ML-KEM-7
12
12
 
13
13
  Part of the **Private.Me** platform—where APIs have keys, but ACIs have identity.
14
14
 
15
- **Version 1.2.16** — **AWS/gRPC/HTTP Error Mappings:** All 49 error codes now include protocol-specific mappings (aws, grpc, http fields) for cross-platform error translation. Previous v1.2.15: JITR Fix - POST /registry/register accepts all cryptographic keys (X25519, ML-KEM-768, ML-DSA-65), fixes KEY_AGREEMENT_FAILED errors. Agent.fromSeed() JITR now registers full identity with encryption keys.
15
+ **Version 1.2.17** — **Documentation:** Generic pricing language per Gold Package Requirement #18 (removed specific operation counts). Previous v1.2.16: AWS/gRPC/HTTP Error Mappings - All 49 error codes now include protocol-specific mappings (aws, grpc, http fields) for cross-platform error translation.
16
16
 
17
17
  ## Install
18
18
 
@@ -126,22 +126,38 @@ See [Configuration Guide](./docs/configuration.md) for complete setup instructio
126
126
 
127
127
  ## Pricing
128
128
 
129
- **3-month free trial** — No credit card required.
129
+ **Free tier available** — No credit card required.
130
130
 
131
- **Tiers:** Free, Pro, and Enterprise plans available. Free tier includes generous limits. Pro tier provides usage-based billing. Enterprise tier offers volume discounts and dedicated support.
132
-
133
- See [pricing details](../../docs/pricing-reference.md) for current rates and complete tier comparison.
131
+ See [pricing details](../../docs/pricing-reference.md) for current rates and tier comparison.
134
132
 
135
133
  [Subscribe now](https://private.me/subscribe?product=xbind)
136
134
 
137
135
  ## Quick Start
138
136
 
139
- **15 seconds to setup:**
137
+ **Complete setup in under 2 minutes:**
138
+
139
+ ### Step 1: Email Verification (Required)
140
+
141
+ **ALL API calls are blocked until you verify your email address.** This links your usage to a verified contact for security notifications and billing.
142
+
143
+ ```bash
144
+ npx xbind setup
145
+ ```
146
+
147
+ **What happens:**
148
+ 1. Enter your email address
149
+ 2. Receive 6-digit verification code (check spam folder)
150
+ 3. Enter code to activate account
151
+ 4. DeploymentID generated (persistent economic identity)
152
+
153
+ **Note:** Disposable email services (Mailinator, Guerrilla Mail, etc.) are blocked. Use a real email address.
154
+
155
+ ### Step 2: Create Agent & Send Messages
140
156
 
141
157
  ```typescript
142
158
  import { Agent } from '@private.me/xbind';
143
159
 
144
- // Create agent (auto-generates identity)
160
+ // Create agent (auto-generates cryptographic identity)
145
161
  const agent = await Agent.lazy({ name: 'my-service' });
146
162
 
147
163
  // Send authenticated message
@@ -160,6 +176,16 @@ console.log('Message sent with cryptographic identity');
160
176
  console.log('Agent DID:', agent.did);
161
177
  ```
162
178
 
179
+ ### Step 3: Understand Your Free Tier
180
+
181
+ - **100,000 operations/month** (free tier)
182
+ - **120,000 hard cap** (20% grace buffer)
183
+ - **Monthly reset:** 1st of each month at 00:00 UTC
184
+ - **Milestone emails:** Sent at 50%, 80%, 100%, 120% usage
185
+
186
+ **At 100K operations:** Email verification enforced (if not already verified)
187
+ **At 120K operations:** Hard cap reached. Upgrade to Pro for unlimited operations.
188
+
163
189
  **Prerequisites:** The `FULL_CONTROL_MASTER_KEY` environment variable is required for Share 2 operations in production but optional for basic testing. See [Environment Variables](#environment-variables) for setup.
164
190
 
165
191
  **JITR (Just-in-Time Registration):** Agents created with `Agent.fromSeed()` automatically register with the trust registry on first use. No manual registration scripts required. Includes all encryption keys (Ed25519, X25519, ML-KEM, ML-DSA) for zero-config encrypted messaging.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@private.me/xbind",
3
- "version": "1.2.16",
3
+ "version": "1.2.17",
4
4
  "description": "Identity-based M2M authentication (Contains encryption - export restrictions apply)",
5
5
  "license": "Proprietary",
6
6
  "author": "Private.Me Contributors",
package/share1.dat CHANGED
Binary file