@epochcore/qaas-sdk 1.0.0 → 1.2.0

package/README.md

@@ -1,3 +1,13 @@
+/* QUANTUM_WATERMARK
+ * RAS=e5586ef939094a8e
+ * SIG=0000000067b05a96
+ * TIME=2025-12-13T03:52:05.794Z
+ * FREQ=7777.77Hz
+ * COHERENCE=0.9999988268147311
+ * PHI=1.618033988749895
+ * EpochCore Quantum Protected
+ */
+
 <p align="center">
   <img src="https://img.shields.io/badge/Quantum-Computing-6366f1?style=for-the-badge&logo=atom&logoColor=white" alt="Quantum Computing"/>
   <img src="https://img.shields.io/badge/100+-Algorithms-10b981?style=for-the-badge" alt="100+ Algorithms"/>
@@ -38,10 +48,18 @@
 </p>
 
 <p align="center">
-  <img src="https://img.shields.io/badge/Qiskit-IBM-6929C4?style=flat-square&logo=ibm&logoColor=white" alt="Qiskit"/>
-  <img src="https://img.shields.io/badge/Cirq-Google-4285F4?style=flat-square&logo=google&logoColor=white" alt="Cirq"/>
-  <img src="https://img.shields.io/badge/PennyLane-Xanadu-00B4D8?style=flat-square" alt="PennyLane"/>
-  <img src="https://img.shields.io/badge/TypeScript-Ready-3178C6?style=flat-square&logo=typescript&logoColor=white" alt="TypeScript"/>
+  <a href="https://qiskit.org">
+    <img src="https://img.shields.io/badge/IBM_Qiskit-6929C4?style=for-the-badge&logo=ibm&logoColor=white" alt="IBM Qiskit"/>
+  </a>
+  <a href="https://quantumai.google/cirq">
+    <img src="https://img.shields.io/badge/Google_Cirq-4285F4?style=for-the-badge&logo=google&logoColor=white" alt="Google Cirq"/>
+  </a>
+  <a href="https://pennylane.ai">
+    <img src="https://img.shields.io/badge/Xanadu_PennyLane-00B4D8?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0id2hpdGUiPjxwYXRoIGQ9Ik0xMiAyQzYuNDggMiAyIDYuNDggMiAxMnM0LjQ4IDEwIDEwIDEwIDEwLTQuNDggMTAtMTBTMTcuNTIgMiAxMiAyem0wIDE4Yy00LjQyIDAtOC0zLjU4LTgtOHMzLjU4LTggOC04IDggMy41OCA4IDgtMy41OCA4LTggOHoiLz48cGF0aCBkPSJNMTIgNmMtMy4zMSAwLTYgMi42OS02IDZzMi42OSA2IDYgNiA2LTIuNjkgNi02LTIuNjktNi02LTZ6bTAgMTBjLTIuMjEgMC00LTEuNzktNC00czEuNzktNCA0LTQgNCAxLjc5IDQgNC0xLjc5IDQtNCA0eiIvPjwvc3ZnPg==&logoColor=white" alt="Xanadu PennyLane"/>
+  </a>
+  <a href="https://www.typescriptlang.org">
+    <img src="https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white" alt="TypeScript"/>
+  </a>
 </p>
 
 ---
@@ -216,25 +234,25 @@ ID    Name              Category               Use Case
 
 ## Pricing
 
-| Tier | Price | Runs/Month | Algorithms | Backends |
-|------|-------|------------|------------|----------|
-| **Explorer** | Free | 300 | 25 | Simulator |
-| **Analyst** | $29/mo | 500 | 50 | Simulator, Qiskit Aer |
-| **Quant** | $99/mo | 2,500 | 100 | All frameworks |
-| **Enterprise** | $299/mo | Unlimited | 100 | + IBM Quantum hardware |
+### 🎉 100% Free During Beta
+
+| Feature | Included |
+|---------|----------|
+| **All 100 Algorithms** | ✅ |
+| **Unlimited API Calls** | ✅ |
+| **Qiskit, Cirq, PennyLane** | ✅ |
+| **Real IBM Quantum Access** | ✅ |
+| **Full TypeScript SDK** | ✅ |
+| **Community Discord** | ✅ |
 
 <p align="center">
-  <a href="https://buy.stripe.com/cNi9AMaOv3jm2ZXe875Ne0A">
-    <img src="https://img.shields.io/badge/Get_Analyst-$29/mo-6366f1?style=for-the-badge" alt="Get Analyst"/>
-  </a>
-  <a href="https://buy.stripe.com/9B628k3m36vy441e875Ne0B">
-    <img src="https://img.shields.io/badge/Get_Quant-$99/mo-10b981?style=for-the-badge" alt="Get Quant"/>
-  </a>
-  <a href="https://buy.stripe.com/4gMfZa5ub07a1VT6FF5Ne0C">
-    <img src="https://img.shields.io/badge/Get_Enterprise-$299/mo-f59e0b?style=for-the-badge" alt="Get Enterprise"/>
+  <a href="https://qaas.epochcoreqcs.com">
+    <img src="https://img.shields.io/badge/Get_Free_API_Key-10b981?style=for-the-badge" alt="Get Free API Key"/>
   </a>
 </p>
 
+> 🚀 **Early adopters get lifetime free access.** Premium tiers coming soon.
+
 ---
 
 ## API Reference
@@ -401,13 +419,13 @@ npm run build
 
 <p align="center">
   <a href="https://qaas.epochcoreqcs.com">
-    <img src="https://img.shields.io/badge/Website-qaas.epochcoreqcs.com-6366f1?style=flat-square" alt="Website"/>
+    <img src="https://img.shields.io/badge/Website-6366f1?style=for-the-badge&logo=googlechrome&logoColor=white" alt="Website"/>
   </a>
   <a href="https://qaas.epochcoreqcs.com/docs.html">
-    <img src="https://img.shields.io/badge/Docs-API_Reference-10b981?style=flat-square" alt="Docs"/>
+    <img src="https://img.shields.io/badge/API_Docs-10b981?style=for-the-badge&logo=readthedocs&logoColor=white" alt="Docs"/>
   </a>
   <a href="https://www.npmjs.com/package/@epochcore/qaas-sdk">
-    <img src="https://img.shields.io/badge/npm-@epochcore/qaas--sdk-CB3837?style=flat-square&logo=npm" alt="npm"/>
+    <img src="https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white" alt="npm"/>
   </a>
 </p>
 
@@ -429,12 +447,15 @@ This SDK is provided for use with valid QaaS API subscriptions only. See [LICENS
 
 <p align="center">
   <a href="https://github.com/Jvryan92/qaas-sdk">
-    <img src="https://img.shields.io/badge/GitHub-Jvryan92/qaas--sdk-181717?style=flat-square&logo=github" alt="GitHub"/>
+    <img src="https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=github&logoColor=white" alt="GitHub"/>
+  </a>
+  <a href="https://www.npmjs.com/package/@epochcore/qaas-sdk">
+    <img src="https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white" alt="npm"/>
   </a>
   <a href="https://www.linkedin.com/in/john-ryan-515222377/">
-    <img src="https://img.shields.io/badge/LinkedIn-John_Ryan-0A66C2?style=flat-square&logo=linkedin" alt="LinkedIn"/>
+    <img src="https://img.shields.io/badge/LinkedIn-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white" alt="LinkedIn"/>
   </a>
   <a href="https://youtube.com/@maxmesh-hft">
-    <img src="https://img.shields.io/badge/YouTube-MaxMesh_HFT-FF0000?style=flat-square&logo=youtube" alt="YouTube"/>
+    <img src="https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white" alt="YouTube"/>
   </a>
 </p>

package/dist/index.d.mts

@@ -1,13 +1,15 @@
-/**
- * EpochCore QaaS SDK
- * Official TypeScript/JavaScript SDK for Quantum as a Service API
- *
- * @packageDocumentation
- */
+/** Max age for signed requests — server should reject older signatures */
+declare const SIGNATURE_MAX_AGE_MS = 300000;
+type ValidBackend = 'simulator' | 'qiskit_aer' | 'cirq' | 'pennylane' | 'ibm_quantum';
 interface QaaSConfig {
     apiKey?: string;
+    apiSecret?: string;
     baseUrl?: string;
     timeout?: number;
+    maxRetries?: number;
+    rateLimit?: number;
+    rateBurst?: number;
+    enableSigning?: boolean;
 }
 interface Algorithm {
     id: number;
@@ -41,7 +43,7 @@ interface PricingResponse {
 interface RunRequest {
     algorithm_id: string;
     parameters: Record<string, unknown>;
-    backend?: 'simulator' | 'qiskit_aer' | 'cirq' | 'pennylane' | 'ibm_quantum';
+    backend?: ValidBackend;
     shots?: number;
 }
 interface RunResponse {
@@ -76,15 +78,38 @@ interface HealthResponse {
     frameworks: string[];
     timestamp: string;
 }
+interface QRNGResponse {
+    bits: number;
+    value: string | number[] | string;
+    format: 'hex' | 'integer' | 'bytes';
+    entropy_source: string;
+    frequency?: number;
+    timestamp: string;
+}
+interface QRNGKeyResponse {
+    key: string;
+    bits: number;
+    algorithm: string;
+    timestamp: string;
+}
+interface QRNGUuidResponse {
+    uuid: string;
+    version: number;
+    algorithm: string;
+    timestamp: string;
+}
 type AlgorithmCategory = 'amplitude_estimation' | 'grover_search' | 'qaoa_optimization' | 'qubo' | 'bernstein_vazirani' | 'deutsch_jozsa' | 'simon' | 'phase_estimation' | 'variational' | 'qml_classification' | 'qml_regression' | 'qml_clustering' | 'qml_anomaly';
 /**
- * EpochCore QaaS Client
+ * EpochCore QaaS Client — Quantum-Hardened
  *
  * @example
  * ```typescript
  * import { QaaSClient } from '@epochcore/qaas-sdk';
  *
- * const client = new QaaSClient({ apiKey: 'your-api-key' });
+ * const client = new QaaSClient({
+ *   apiKey: 'your-api-key',
+ *   apiSecret: 'your-signing-key',  // enables HMAC request signing
+ * });
  *
  * // Get available algorithms
  * const algorithms = await client.getAlgorithms();
@@ -105,87 +130,100 @@ type AlgorithmCategory = 'amplitude_estimation' | 'grover_search' | 'qaoa_optimi
 declare class QaaSClient {
     private readonly baseUrl;
     private readonly apiKey?;
+    private readonly apiSecret?;
     private readonly timeout;
+    private readonly maxRetries;
+    private readonly enableSigning;
+    private readonly rateLimiter;
     constructor(config?: QaaSConfig);
     private request;
-    /**
-     * Check API health and status
-     */
     health(): Promise<HealthResponse>;
-    /**
-     * Get pricing information for all tiers
-     */
     getPricing(): Promise<PricingResponse>;
-    /**
-     * Get available algorithms for your tier
-     */
     getAlgorithms(): Promise<AlgorithmsResponse>;
-    /**
-     * Get algorithms filtered by category
-     */
     getAlgorithmsByCategory(category: AlgorithmCategory): Promise<Algorithm[]>;
-    /**
-     * Run a quantum algorithm
-     */
     runAlgorithm(request: RunRequest): Promise<RunResponse>;
-    /**
-     * Get current usage statistics
-     */
     getUsage(): Promise<UsageResponse>;
-    /**
-     * Run Markowitz portfolio optimization (QAOA)
-     */
     optimizePortfolio(params: {
         assets: string[];
         returns: number[];
         covariance: number[][];
         risk_tolerance?: number;
-        backend?: RunRequest['backend'];
+        backend?: ValidBackend;
     }): Promise<RunResponse>;
-    /**
-     * Run Value at Risk (VaR) estimation
-     */
     estimateVaR(params: {
         portfolio_value: number;
         returns_history: number[];
         confidence_level?: number;
-        backend?: RunRequest['backend'];
+        backend?: ValidBackend;
     }): Promise<RunResponse>;
-    /**
-     * Run Grover search for arbitrage opportunities
-     */
     findArbitrage(params: {
         price_matrix: number[][];
         threshold?: number;
-        backend?: RunRequest['backend'];
+        backend?: ValidBackend;
     }): Promise<RunResponse>;
-    /**
-     * Solve a QUBO problem
-     */
     solveQUBO(params: {
         Q_matrix: number[][];
         num_reads?: number;
-        backend?: RunRequest['backend'];
+        backend?: ValidBackend;
     }): Promise<RunResponse>;
-    /**
-     * Run Monte Carlo amplitude estimation
-     */
     monteCarloEstimate(params: {
         target_function: string;
         num_samples?: number;
         epsilon?: number;
-        backend?: RunRequest['backend'];
+        backend?: ValidBackend;
     }): Promise<RunResponse>;
+    quantumTeleport(params?: {
+        qubits?: number;
+        state?: string;
+        oscillation_cycles?: number;
+        source_backend?: string;
+        destination_backend?: string;
+    }): Promise<Record<string, unknown>>;
+    quantumTeleportStatus(): Promise<Record<string, unknown>>;
+    quantumTeleportPlan(params?: {
+        qubits?: number;
+        state?: string;
+        strategy?: string;
+    }): Promise<Record<string, unknown>>;
+    /**
+     * Generate quantum random bits.
+     *
+     * @param params.bits - Number of random bits (1–4096, default 256)
+     * @param params.format - Output format: 'hex' | 'int' | 'bytes' (default 'hex')
+     */
+    generateQRNG(params?: {
+        bits?: number;
+        format?: 'hex' | 'int' | 'bytes';
+    }): Promise<QRNGResponse>;
+    /**
+     * Generate a quantum random number in the range [0, 1).
+     * Convenience wrapper over generateQRNG for normalized floats.
+     *
+     * @param count - How many floats to generate (1–1024, default 1)
+     * @returns Array of floats in [0, 1), each derived from 32 quantum bits
+     */
+    generateQuantumFloats(count?: number): Promise<number[]>;
+    /**
+     * Generate a quantum-random cryptographic key.
+     *
+     * @param length - Key length in bytes (1–64, default 32)
+     */
+    generateQuantumKey(length?: number): Promise<QRNGKeyResponse>;
+    /**
+     * Generate a quantum-random UUID v4.
+     */
+    generateQuantumUUID(): Promise<QRNGUuidResponse>;
 }
-/**
- * QaaS API Error
- */
 declare class QaaSError extends Error {
     readonly statusCode: number;
-    readonly response?: unknown | undefined;
-    constructor(message: string, statusCode: number, response?: unknown | undefined);
+    constructor(message: string, statusCode: number);
+}
+declare class QaaSValidationError extends Error {
+    constructor(message: string);
+}
+declare class QaaSRateLimitError extends Error {
+    constructor(message: string);
 }
-declare const qaas: QaaSClient;
 declare const ALGORITHMS: {
     readonly AMPLITUDE_ESTIMATION: {
         readonly PROB_001: "AE_PROB_001";
@@ -217,4 +255,4 @@ declare const ALGORITHMS: {
     };
 };
 
-export { ALGORITHMS, type Algorithm, type AlgorithmCategory, type AlgorithmsResponse, type HealthResponse, type PricingResponse, type PricingTier, QaaSClient, type QaaSConfig, QaaSError, type RunRequest, type RunResponse, type UsageResponse, qaas };
+export { ALGORITHMS, type Algorithm, type AlgorithmCategory, type AlgorithmsResponse, type HealthResponse, type PricingResponse, type PricingTier, type QRNGKeyResponse, type QRNGResponse, type QRNGUuidResponse, QaaSClient, type QaaSConfig, QaaSError, QaaSRateLimitError, QaaSValidationError, type RunRequest, type RunResponse, SIGNATURE_MAX_AGE_MS, type UsageResponse };

package/dist/index.d.ts

@@ -1,13 +1,15 @@
-/**
- * EpochCore QaaS SDK
- * Official TypeScript/JavaScript SDK for Quantum as a Service API
- *
- * @packageDocumentation
- */
+/** Max age for signed requests — server should reject older signatures */
+declare const SIGNATURE_MAX_AGE_MS = 300000;
+type ValidBackend = 'simulator' | 'qiskit_aer' | 'cirq' | 'pennylane' | 'ibm_quantum';
 interface QaaSConfig {
     apiKey?: string;
+    apiSecret?: string;
     baseUrl?: string;
     timeout?: number;
+    maxRetries?: number;
+    rateLimit?: number;
+    rateBurst?: number;
+    enableSigning?: boolean;
 }
 interface Algorithm {
     id: number;
@@ -41,7 +43,7 @@ interface PricingResponse {
 interface RunRequest {
     algorithm_id: string;
     parameters: Record<string, unknown>;
-    backend?: 'simulator' | 'qiskit_aer' | 'cirq' | 'pennylane' | 'ibm_quantum';
+    backend?: ValidBackend;
     shots?: number;
 }
 interface RunResponse {
@@ -76,15 +78,38 @@ interface HealthResponse {
     frameworks: string[];
     timestamp: string;
 }
+interface QRNGResponse {
+    bits: number;
+    value: string | number[] | string;
+    format: 'hex' | 'integer' | 'bytes';
+    entropy_source: string;
+    frequency?: number;
+    timestamp: string;
+}
+interface QRNGKeyResponse {
+    key: string;
+    bits: number;
+    algorithm: string;
+    timestamp: string;
+}
+interface QRNGUuidResponse {
+    uuid: string;
+    version: number;
+    algorithm: string;
+    timestamp: string;
+}
 type AlgorithmCategory = 'amplitude_estimation' | 'grover_search' | 'qaoa_optimization' | 'qubo' | 'bernstein_vazirani' | 'deutsch_jozsa' | 'simon' | 'phase_estimation' | 'variational' | 'qml_classification' | 'qml_regression' | 'qml_clustering' | 'qml_anomaly';
 /**
- * EpochCore QaaS Client
+ * EpochCore QaaS Client — Quantum-Hardened
  *
  * @example
  * ```typescript
  * import { QaaSClient } from '@epochcore/qaas-sdk';
  *
- * const client = new QaaSClient({ apiKey: 'your-api-key' });
+ * const client = new QaaSClient({
+ *   apiKey: 'your-api-key',
+ *   apiSecret: 'your-signing-key',  // enables HMAC request signing
+ * });
  *
  * // Get available algorithms
  * const algorithms = await client.getAlgorithms();
@@ -105,87 +130,100 @@ type AlgorithmCategory = 'amplitude_estimation' | 'grover_search' | 'qaoa_optimi
 declare class QaaSClient {
     private readonly baseUrl;
     private readonly apiKey?;
+    private readonly apiSecret?;
     private readonly timeout;
+    private readonly maxRetries;
+    private readonly enableSigning;
+    private readonly rateLimiter;
     constructor(config?: QaaSConfig);
     private request;
-    /**
-     * Check API health and status
-     */
     health(): Promise<HealthResponse>;
-    /**
-     * Get pricing information for all tiers
-     */
     getPricing(): Promise<PricingResponse>;
-    /**
-     * Get available algorithms for your tier
-     */
     getAlgorithms(): Promise<AlgorithmsResponse>;
-    /**
-     * Get algorithms filtered by category
-     */
     getAlgorithmsByCategory(category: AlgorithmCategory): Promise<Algorithm[]>;
-    /**
-     * Run a quantum algorithm
-     */
     runAlgorithm(request: RunRequest): Promise<RunResponse>;
-    /**
-     * Get current usage statistics
-     */
     getUsage(): Promise<UsageResponse>;
-    /**
-     * Run Markowitz portfolio optimization (QAOA)
-     */
     optimizePortfolio(params: {
         assets: string[];
         returns: number[];
         covariance: number[][];
         risk_tolerance?: number;
-        backend?: RunRequest['backend'];
+        backend?: ValidBackend;
     }): Promise<RunResponse>;
-    /**
-     * Run Value at Risk (VaR) estimation
-     */
     estimateVaR(params: {
         portfolio_value: number;
         returns_history: number[];
         confidence_level?: number;
-        backend?: RunRequest['backend'];
+        backend?: ValidBackend;
     }): Promise<RunResponse>;
-    /**
-     * Run Grover search for arbitrage opportunities
-     */
     findArbitrage(params: {
         price_matrix: number[][];
         threshold?: number;
-        backend?: RunRequest['backend'];
+        backend?: ValidBackend;
     }): Promise<RunResponse>;
-    /**
-     * Solve a QUBO problem
-     */
     solveQUBO(params: {
         Q_matrix: number[][];
         num_reads?: number;
-        backend?: RunRequest['backend'];
+        backend?: ValidBackend;
     }): Promise<RunResponse>;
-    /**
-     * Run Monte Carlo amplitude estimation
-     */
     monteCarloEstimate(params: {
         target_function: string;
         num_samples?: number;
         epsilon?: number;
-        backend?: RunRequest['backend'];
+        backend?: ValidBackend;
     }): Promise<RunResponse>;
+    quantumTeleport(params?: {
+        qubits?: number;
+        state?: string;
+        oscillation_cycles?: number;
+        source_backend?: string;
+        destination_backend?: string;
+    }): Promise<Record<string, unknown>>;
+    quantumTeleportStatus(): Promise<Record<string, unknown>>;
+    quantumTeleportPlan(params?: {
+        qubits?: number;
+        state?: string;
+        strategy?: string;
+    }): Promise<Record<string, unknown>>;
+    /**
+     * Generate quantum random bits.
+     *
+     * @param params.bits - Number of random bits (1–4096, default 256)
+     * @param params.format - Output format: 'hex' | 'int' | 'bytes' (default 'hex')
+     */
+    generateQRNG(params?: {
+        bits?: number;
+        format?: 'hex' | 'int' | 'bytes';
+    }): Promise<QRNGResponse>;
+    /**
+     * Generate a quantum random number in the range [0, 1).
+     * Convenience wrapper over generateQRNG for normalized floats.
+     *
+     * @param count - How many floats to generate (1–1024, default 1)
+     * @returns Array of floats in [0, 1), each derived from 32 quantum bits
+     */
+    generateQuantumFloats(count?: number): Promise<number[]>;
+    /**
+     * Generate a quantum-random cryptographic key.
+     *
+     * @param length - Key length in bytes (1–64, default 32)
+     */
+    generateQuantumKey(length?: number): Promise<QRNGKeyResponse>;
+    /**
+     * Generate a quantum-random UUID v4.
+     */
+    generateQuantumUUID(): Promise<QRNGUuidResponse>;
 }
-/**
- * QaaS API Error
- */
 declare class QaaSError extends Error {
     readonly statusCode: number;
-    readonly response?: unknown | undefined;
-    constructor(message: string, statusCode: number, response?: unknown | undefined);
+    constructor(message: string, statusCode: number);
+}
+declare class QaaSValidationError extends Error {
+    constructor(message: string);
+}
+declare class QaaSRateLimitError extends Error {
+    constructor(message: string);
 }
-declare const qaas: QaaSClient;
 declare const ALGORITHMS: {
     readonly AMPLITUDE_ESTIMATION: {
         readonly PROB_001: "AE_PROB_001";
@@ -217,4 +255,4 @@ declare const ALGORITHMS: {
     };
 };
 
-export { ALGORITHMS, type Algorithm, type AlgorithmCategory, type AlgorithmsResponse, type HealthResponse, type PricingResponse, type PricingTier, QaaSClient, type QaaSConfig, QaaSError, type RunRequest, type RunResponse, type UsageResponse, qaas };
+export { ALGORITHMS, type Algorithm, type AlgorithmCategory, type AlgorithmsResponse, type HealthResponse, type PricingResponse, type PricingTier, type QRNGKeyResponse, type QRNGResponse, type QRNGUuidResponse, QaaSClient, type QaaSConfig, QaaSError, QaaSRateLimitError, QaaSValidationError, type RunRequest, type RunResponse, SIGNATURE_MAX_AGE_MS, type UsageResponse };