@unispechq/unispec-schema 0.4.0 → 0.4.2

package/examples/valid/websocket-complete.json

@@ -0,0 +1,471 @@
+{
+	"unispecVersion": "0.1.0",
+	"service": {
+		"name": "chat-websocket-api",
+		"description": "Real-time chat WebSocket API with multiple channels",
+		"version": "1.0.0",
+		"baseUrl": "https://chat.example.com",
+		"contact": {
+			"name": "Chat Support",
+			"email": "support@example.com"
+		},
+		"tags": ["chat", "websocket", "real-time"],
+		"securitySchemes": {
+			"jwtAuth": {
+				"type": "jwt",
+				"issuer": "https://auth.example.com",
+				"audience": ["chat.example.com"],
+				"algorithms": ["HS256", "RS256"],
+				"description": "JWT authentication for WebSocket connections"
+			}
+		},
+		"protocols": {
+			"websocket": {
+				"url": "/ws",
+				"headers": [
+					{
+						"name": "Authorization",
+						"description": "JWT token for authentication",
+						"required": true
+					},
+					{
+						"name": "X-Client-ID",
+						"description": "Unique client identifier",
+						"required": true
+					}
+				],
+				"channels": [
+					{
+						"name": "global",
+						"description": "Global chat channel for all users",
+						"namespace": "chat",
+						"direction": "both",
+						"tags": ["public", "general"],
+						"reconnectStrategy": {
+							"maxAttempts": 10,
+							"delay": 2000,
+							"backoffMultiplier": 1.5
+						},
+						"security": [
+							{
+								"jwtAuth": []
+							}
+						],
+						"messages": [
+							{
+								"name": "chatMessage",
+								"description": "Chat message sent by users",
+								"direction": "publish",
+								"schemaRef": "ChatMessage"
+							},
+							{
+								"name": "userJoined",
+								"description": "Notification when user joins channel",
+								"direction": "subscribe",
+								"schemaRef": "UserJoinedEvent"
+							},
+							{
+								"name": "userLeft",
+								"description": "Notification when user leaves channel",
+								"direction": "subscribe",
+								"schemaRef": "UserLeftEvent"
+							},
+							{
+								"name": "typingIndicator",
+								"description": "User typing indicator",
+								"direction": "publish",
+								"schemaRef": "TypingIndicator"
+							}
+						]
+					},
+					{
+						"name": "private",
+						"description": "Private chat channels between users",
+						"namespace": "chat",
+						"direction": "both",
+						"tags": ["private", "direct"],
+						"connectionParams": {
+							"userId": {
+								"description": "ID of the user initiating connection"
+							},
+							"targetUserId": {
+								"description": "ID of the target user for private chat"
+							}
+						},
+						"reconnectStrategy": {
+							"maxAttempts": 5,
+							"delay": 1000,
+							"backoffMultiplier": 2
+						},
+						"security": [
+							{
+								"jwtAuth": []
+							}
+						],
+						"messages": [
+							{
+								"name": "privateMessage",
+								"description": "Private message between users",
+								"direction": "both",
+								"schemaRef": "PrivateMessage"
+							},
+							{
+								"name": "messageRead",
+								"description": "Message read receipt",
+								"direction": "publish",
+								"schemaRef": "MessageReadEvent"
+							},
+							{
+								"name": "messageDelivered",
+								"description": "Message delivery confirmation",
+								"direction": "subscribe",
+								"schemaRef": "MessageDeliveredEvent"
+							}
+						]
+					},
+					{
+						"name": "notifications",
+						"description": "Real-time notifications for users",
+						"namespace": "system",
+						"direction": "subscribe",
+						"tags": ["notifications", "system"],
+						"connectionParams": {
+							"userId": {
+								"description": "User ID for personalized notifications"
+							}
+						},
+						"reconnectStrategy": {
+							"maxAttempts": 3,
+							"delay": 5000,
+							"backoffMultiplier": 2
+						},
+						"security": [
+							{
+								"jwtAuth": []
+							}
+						],
+						"messages": [
+							{
+								"name": "newNotification",
+								"description": "New system notification",
+								"direction": "subscribe",
+								"schemaRef": "Notification"
+							},
+							{
+								"name": "notificationRead",
+								"description": "Notification read confirmation",
+								"direction": "publish",
+								"schemaRef": "NotificationReadEvent"
+							}
+						]
+					},
+					{
+						"name": "presence",
+						"description": "User presence and status updates",
+						"namespace": "system",
+						"direction": "both",
+						"tags": ["presence", "status"],
+						"reconnectStrategy": {
+							"maxAttempts": 20,
+							"delay": 1000,
+							"backoffMultiplier": 1.2
+						},
+						"security": [
+							{
+								"jwtAuth": []
+							}
+						],
+						"messages": [
+							{
+								"name": "userOnline",
+								"description": "User comes online",
+								"direction": "subscribe",
+								"schemaRef": "UserPresenceEvent"
+							},
+							{
+								"name": "userOffline",
+								"description": "User goes offline",
+								"direction": "subscribe",
+								"schemaRef": "UserPresenceEvent"
+							},
+							{
+								"name": "statusUpdate",
+								"description": "User status change (away, busy, etc.)",
+								"direction": "both",
+								"schemaRef": "UserStatusUpdate"
+							},
+							{
+								"name": "heartbeat",
+								"description": "Keep-alive heartbeat message",
+								"direction": "publish",
+								"schemaRef": "Heartbeat"
+							}
+						]
+					}
+				]
+			}
+		},
+		"schemas": {
+			"ChatMessage": {
+				"type": "object",
+				"required": ["id", "userId", "username", "content", "timestamp"],
+				"properties": {
+					"id": {
+						"type": "string",
+						"description": "Unique message ID"
+					},
+					"userId": {
+						"type": "string",
+						"description": "Sender user ID"
+					},
+					"username": {
+						"type": "string",
+						"description": "Sender username"
+					},
+					"content": {
+						"type": "string",
+						"minLength": 1,
+						"maxLength": 2000,
+						"description": "Message content"
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time",
+						"description": "Message timestamp"
+					},
+					"messageType": {
+						"type": "string",
+						"enum": ["text", "image", "file", "emoji"],
+						"default": "text",
+						"description": "Type of message"
+					},
+					"metadata": {
+						"type": "object",
+						"description": "Additional message metadata"
+					}
+				}
+			},
+			"UserJoinedEvent": {
+				"type": "object",
+				"required": ["userId", "username", "timestamp"],
+				"properties": {
+					"userId": {
+						"type": "string"
+					},
+					"username": {
+						"type": "string"
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			},
+			"UserLeftEvent": {
+				"type": "object",
+				"required": ["userId", "username", "timestamp"],
+				"properties": {
+					"userId": {
+						"type": "string"
+					},
+					"username": {
+						"type": "string"
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			},
+			"TypingIndicator": {
+				"type": "object",
+				"required": ["userId", "username", "isTyping", "timestamp"],
+				"properties": {
+					"userId": {
+						"type": "string"
+					},
+					"username": {
+						"type": "string"
+					},
+					"isTyping": {
+						"type": "boolean"
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			},
+			"PrivateMessage": {
+				"type": "object",
+				"required": ["id", "fromUserId", "toUserId", "content", "timestamp"],
+				"properties": {
+					"id": {
+						"type": "string"
+					},
+					"fromUserId": {
+						"type": "string"
+					},
+					"toUserId": {
+						"type": "string"
+					},
+					"content": {
+						"type": "string",
+						"minLength": 1,
+						"maxLength": 2000
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					},
+					"encrypted": {
+						"type": "boolean",
+						"default": false,
+						"description": "Whether message is end-to-end encrypted"
+					}
+				}
+			},
+			"MessageReadEvent": {
+				"type": "object",
+				"required": ["messageId", "userId", "timestamp"],
+				"properties": {
+					"messageId": {
+						"type": "string"
+					},
+					"userId": {
+						"type": "string"
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			},
+			"MessageDeliveredEvent": {
+				"type": "object",
+				"required": ["messageId", "userId", "timestamp"],
+				"properties": {
+					"messageId": {
+						"type": "string"
+					},
+					"userId": {
+						"type": "string"
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			},
+			"Notification": {
+				"type": "object",
+				"required": ["id", "userId", "type", "title", "message", "timestamp"],
+				"properties": {
+					"id": {
+						"type": "string"
+					},
+					"userId": {
+						"type": "string"
+					},
+					"type": {
+						"type": "string",
+						"enum": ["info", "warning", "error", "success", "system"]
+					},
+					"title": {
+						"type": "string",
+						"maxLength": 100
+					},
+					"message": {
+						"type": "string",
+						"maxLength": 500
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					},
+					"priority": {
+						"type": "string",
+						"enum": ["low", "medium", "high", "urgent"],
+						"default": "medium"
+					},
+					"actionUrl": {
+						"type": "string",
+						"format": "uri",
+						"description": "Optional action URL for notification"
+					}
+				}
+			},
+			"NotificationReadEvent": {
+				"type": "object",
+				"required": ["notificationId", "userId", "timestamp"],
+				"properties": {
+					"notificationId": {
+						"type": "string"
+					},
+					"userId": {
+						"type": "string"
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			},
+			"UserPresenceEvent": {
+				"type": "object",
+				"required": ["userId", "username", "status", "timestamp"],
+				"properties": {
+					"userId": {
+						"type": "string"
+					},
+					"username": {
+						"type": "string"
+					},
+					"status": {
+						"type": "string",
+						"enum": ["online", "offline"]
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			},
+			"UserStatusUpdate": {
+				"type": "object",
+				"required": ["userId", "status", "timestamp"],
+				"properties": {
+					"userId": {
+						"type": "string"
+					},
+					"status": {
+						"type": "string",
+						"enum": ["available", "away", "busy", "invisible"]
+					},
+					"message": {
+						"type": "string",
+						"maxLength": 100,
+						"description": "Optional status message"
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			},
+			"Heartbeat": {
+				"type": "object",
+				"required": ["userId", "timestamp"],
+				"properties": {
+					"userId": {
+						"type": "string"
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			}
+		}
+	}
+}

package/examples/valid/websocket-simple.json

@@ -0,0 +1,116 @@
+{
+	"unispecVersion": "0.1.0",
+	"service": {
+		"name": "simple-websocket-api",
+		"description": "Simple WebSocket API for real-time notifications",
+		"version": "1.0.0",
+		"tags": ["notifications", "websocket"],
+		"protocols": {
+			"websocket": {
+				"url": "/ws",
+				"channels": [
+					{
+						"name": "notifications",
+						"description": "Real-time notification channel",
+						"direction": "subscribe",
+						"messages": [
+							{
+								"name": "notification",
+								"description": "New notification message",
+								"direction": "subscribe",
+								"schemaRef": "NotificationMessage"
+							},
+							{
+								"name": "notificationRead",
+								"description": "Notification read confirmation",
+								"direction": "publish",
+								"schemaRef": "NotificationRead"
+							}
+						]
+					},
+					{
+						"name": "status",
+						"description": "System status updates",
+						"direction": "both",
+						"messages": [
+							{
+								"name": "systemStatus",
+								"description": "Current system status",
+								"direction": "subscribe",
+								"schemaRef": "SystemStatus"
+							},
+							{
+								"name": "heartbeat",
+								"description": "Client heartbeat",
+								"direction": "publish",
+								"schemaRef": "HeartbeatMessage"
+							}
+						]
+					}
+				]
+			}
+		},
+		"schemas": {
+			"NotificationMessage": {
+				"type": "object",
+				"required": ["id", "type", "message", "timestamp"],
+				"properties": {
+					"id": {
+						"type": "string"
+					},
+					"type": {
+						"type": "string",
+						"enum": ["info", "warning", "error"]
+					},
+					"message": {
+						"type": "string"
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			},
+			"NotificationRead": {
+				"type": "object",
+				"required": ["notificationId", "timestamp"],
+				"properties": {
+					"notificationId": {
+						"type": "string"
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			},
+			"SystemStatus": {
+				"type": "object",
+				"required": ["status", "timestamp"],
+				"properties": {
+					"status": {
+						"type": "string",
+						"enum": ["healthy", "degraded", "down"]
+					},
+					"message": {
+						"type": "string"
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			},
+			"HeartbeatMessage": {
+				"type": "object",
+				"required": ["timestamp"],
+				"properties": {
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			}
+		}
+	}
+}

package/index.cjs

@@ -1,7 +1,7 @@
-const unispec = require("./schema/unispec.schema.json");
-const manifest = require("./schema/index.json");
-
-module.exports = {
-  unispec,
-  manifest,
-};
+const unispec = require("./schema/unispec.schema.json");
+const manifest = require("./schema/index.json");
+
+module.exports = {
+	unispec,
+	manifest,
+};

package/index.d.ts

@@ -1,9 +1,9 @@
-export const unispec: Record<string, any>;
-export const manifest: Record<string, any>;
-
-declare const _default: {
-  unispec: typeof unispec;
-  manifest: typeof manifest;
-};
-
-export default _default;
+export declare const unispec: Record<string, unknown>;
+export declare const manifest: Record<string, unknown>;
+
+declare const _default: {
+	unispec: typeof unispec;
+	manifest: typeof manifest;
+};
+
+export default _default;

package/index.mjs

@@ -1,9 +1,9 @@
-import { createRequire } from "module";
-
-const require = createRequire(import.meta.url);
-
-const unispec = require("./schema/unispec.schema.json");
-const manifest = require("./schema/index.json");
-
-export { unispec, manifest };
-export default { unispec, manifest };
+import { createRequire } from "node:module";
+
+const require = createRequire(import.meta.url);
+
+const unispec = require("./schema/unispec.schema.json");
+const manifest = require("./schema/index.json");
+
+export { unispec, manifest };
+export default { unispec, manifest };

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@unispechq/unispec-schema",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "Official UniSpec JSON Schemas",
   "type": "module",
   "main": "index.cjs",
   "module": "index.mjs",
   "types": "index.d.ts",
   "scripts": {
+    "lint": "pnpm run biome check --write --unsafe",
     "release:patch": "node scripts/release.js patch",
     "release:minor": "node scripts/release.js minor",
     "release:major": "node scripts/release.js major"
@@ -17,13 +18,12 @@
       "require": "./index.cjs",
       "types": "./index.d.ts"
     },
-    "./schema": "./schema/index.json",
-    "./schema/unispec.schema.json": "./schema/unispec.schema.json",
-    "./schema/unispec-tests.schema.json": "./schema/unispec-tests.schema.json",
-    "./schema/unispec-config.schema.json": "./schema/unispec-config.schema.json"
+    "./schema": "./schema/",
+    "./examples": "./examples/"
   },
   "files": [
     "schema/",
+    "examples/",
     "index.cjs",
     "index.mjs",
     "index.d.ts"
@@ -41,12 +41,21 @@
     "unispec",
     "api",
     "json-schema",
-    "specification"
+    "specification",
+    "examples",
+    "testing",
+    "rest",
+    "graphql",
+    "websocket",
+    "validation"
   ],
   "engines": {
     "node": ">=18"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.3.11"
   }
 }