@devorash/core 0.1.0 → 0.1.1

package/README.md

@@ -41,14 +41,9 @@ console.log(DEVORA_ENDPOINTS.TERMINATE) // "/impersonate/:id/terminate"
 ### Security Utilities
 
 ```typescript
-import {
-	validateTimestamp,
-	extractSecurityHeaders,
-	timingSafeEqual,
-	isWriteMethod,
-} from "@devorash/core"
+import { validateTimestamp, isWriteMethod } from "@devorash/core"
 
-// Validate request timestamp
+// Validate a request timestamp (Unix seconds) against a tolerance (default 300 s)
 const { valid, error } = validateTimestamp(requestTimestamp)
 
 // Check if HTTP method is a write operation (blocked in read-only mode)
@@ -57,6 +52,11 @@ if (isWriteMethod("POST")) {
 }
 ```
 
+Request signing (v3) helpers such as `buildCanonicalString`,
+`parseSignatureHeaders` and `SIGNED_HEADER_PATTERNS` are exported too; see
+[SIGNING.md](https://github.com/getdevora/devora-sdks/blob/main/SIGNING.md).
+`@devorash/node` builds on them to sign and verify requests.
+
 ### Utility Functions
 
 ```typescript
@@ -76,16 +76,16 @@ console.log(params) // { id: "user123" }
 const success = createSuccessResponse({ users: [] })
 const error = createErrorResponse("Not found", "NOT_FOUND")
 
-// Validate API key format
+// Check the shape of a public key ID
 const validation = validateApiKeyFormat("pk_server_live_abc123")
-console.log(validation) // { valid: true, type: "server", environment: "live" }
+console.log(validation) // { valid: true, type: "server" }
 ```
 
 ## Exports
 
 ### Subpath Exports
 
-This package supports subpath exports for tree-shaking:
+Besides the root export, types and constants have their own entry points:
 
 ```typescript
 // Import only types
@@ -93,12 +93,6 @@ import type { DevoraRequest } from "@devorash/core/types"
 
 // Import only constants
 import { DEVORA_ENDPOINTS } from "@devorash/core/constants"
-
-// Import only security utilities
-import { validateTimestamp } from "@devorash/core/security"
-
-// Import only utility functions
-import { matchPath } from "@devorash/core/utils"
 ```
 
 ## API Reference
@@ -128,13 +122,12 @@ import { matchPath } from "@devorash/core/utils"
 
 ### Security Functions
 
-| Function                    | Description                           |
-| --------------------------- | ------------------------------------- |
-| `validateTimestamp()`       | Validate request timestamp            |
-| `extractSecurityHeaders()`  | Extract security headers from request |
-| `validateSecurityHeaders()` | Full security validation              |
-| `timingSafeEqual()`         | Timing-safe string comparison         |
-| `isWriteMethod()`           | Check if method is a write operation  |
+| Function                   | Description                                        |
+| -------------------------- | -------------------------------------------------- |
+| `validateTimestamp()`      | Validate a request timestamp against a tolerance   |
+| `parseSignatureHeaders()`  | Parse and validate the v3 signature headers        |
+| `buildCanonicalString()`   | Build the v3 canonical string that is signed       |
+| `isWriteMethod()`          | Check if method is a write operation               |
 
 ### Utility Functions
 
@@ -143,7 +136,7 @@ import { matchPath } from "@devorash/core/utils"
 | `matchPath()`             | Match path pattern with parameters |
 | `createSuccessResponse()` | Create success response            |
 | `createErrorResponse()`   | Create error response              |
-| `validateApiKeyFormat()`  | Validate API key format            |
+| `validateApiKeyFormat()`  | Check the shape of a public key ID |
 
 ### Logger Service
 
@@ -157,30 +150,31 @@ configureLogger({
 	level: LogLevel.DEBUG, // DEBUG, INFO, WARN, ERROR, SILENT
 	enabled: true, // Override auto-detection
 	includeTimestamp: true, // Add timestamps to log messages
+	// handler: { debug, info, warn, error } routes output to your own logger
 })
 
 // Create a logger instance
 const logger = createLogger("MyComponent")
 
-logger.debug("Verbose debugging info") // Only in development
+logger.debug("Verbose debugging info") // Only if level <= DEBUG
 logger.info("General information") // Only if level <= INFO
 logger.warn("Warning message") // Only if level <= WARN
-logger.error("Error message") // Always logged (unless disabled)
+logger.error("Error message") // Logged at every level unless enabled: false
 ```
 
 **Environment Auto-Detection:**
 
-- Development: `NODE_ENV=development` or running on `localhost`
-- Production: All other cases (logging disabled by default)
+- Development: `NODE_ENV=development` (or `dev`), or a browser page on `localhost`, `127.0.0.1` or `*.local`
+- Production: All other cases (logging disabled by default, except errors)
 
 **Log Levels:**
 | Level | Value | Description |
 |-------|-------|-------------|
-| `DEBUG` | 0 | Verbose debugging (dev only) |
+| `DEBUG` | 0 | Verbose debugging (default in dev) |
 | `INFO` | 1 | General information |
-| `WARN` | 2 | Warnings (default in dev) |
-| `ERROR` | 3 | Errors only (default in prod) |
-| `SILENT` | 4 | No logging |
+| `WARN` | 2 | Warnings (default level in prod) |
+| `ERROR` | 3 | Errors only |
+| `SILENT` | 4 | Nothing except `error()`; `enabled: false` silences errors too |
 
 ## License
 

package/dist/constants/index.d.ts

@@ -159,7 +159,7 @@ export declare const SDK_PACKAGES: {
 /**
  * Current SDK version (synced across all packages)
  */
-export declare const SDK_VERSION = "0.1.0";
+export declare const SDK_VERSION = "0.1.1";
 /**
  * SDK error codes
  */

package/dist/constants/index.js

@@ -181,7 +181,7 @@ export const SDK_PACKAGES = {
 /**
  * Current SDK version (synced across all packages)
  */
-export const SDK_VERSION = "0.1.0";
+export const SDK_VERSION = "0.1.1";
 // ============================================================================
 // Error Codes
 // ============================================================================

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devorash/core",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Core utilities, types, and constants for Devora SDKs",
   "keywords": [
     "customer-support",