@scoreboardmax/api-types 1.0.11 → 1.0.13

package/README.md

@@ -1,6 +1,6 @@
-# ScoreboardMax API Type Definitions
+# ScoreboardMax API Types & Constants
 
-This package provides TypeScript type definitions for developers integrating with the ScoreboardMax API. All types are automatically generated from the official ScoreboardMax API source code to ensure accuracy and consistency.
+This package provides TypeScript types and runtime constants for developers integrating with the ScoreboardMax API. All definitions are automatically generated from the official ScoreboardMax API source code to ensure accuracy and consistency.
 
 **API Documentation:** [https://scoreboardmax.com/api/docs](https://scoreboardmax.com/api/docs)
 
@@ -24,18 +24,55 @@ bun add @scoreboardmax/api-types
 
 ## Usage
 
-### Basic Import
+### TypeScript
 ```typescript
-import { ScoreboardRequest, ScoreboardResponse } from "@scoreboardmax/api-types";
+// Import types for API requests and responses
+import { ScoreboardRequest, ScoreboardResponse, ScoreboardType } from "@scoreboardmax/api-types";
+
+// Import runtime constants and enums
+import { WebsocketOperation, WebsocketMessageType } from "@scoreboardmax/api-types";
+
+// Use in your application
+const request: ScoreboardRequest = {
+  name: "Varsity Football",
+  type: ScoreboardType.Basketball,
+  data: { /* ... */ }
+};
+
+// Runtime constants work in conditionals
+if (operation === WebsocketOperation.SendHeartbeat) {
+  // Handle heartbeat
+}
 ```
 
+### JavaScript
+```javascript
+// CommonJS
+const { WebsocketOperation, ScoreboardType } = require("@scoreboardmax/api-types");
+
+// ES6 modules
+import { WebsocketOperation, ScoreboardType } from "@scoreboardmax/api-types";
+
+// Use runtime constants
+if (body.operation === WebsocketOperation.GetConnectionId) {
+  // Handle connection request
+}
+```
+
+## What's Included
+
+- **TypeScript Types**: Interfaces for API requests and responses
+- **Runtime Constants**: Enums for operations, message types, and scoreboard types
+- **Full Type Safety**: Complete IntelliSense support for TypeScript projects
+- **Universal Compatibility**: Works with both CommonJS and ES6 module systems
+
 ## Contributing
 
 This package is automatically generated from the ScoreboardMax API schema. If you find issues with the types:
 
 1. Check if the issue exists in the API documentation
 2. Report issues at: [GitHub Issues](https://github.com/scoreboardmax/api-types/issues)
-3. For API-related issues, [contact ScoreboardMax support ](https://scoreboardmax.com/#contact)
+3. For API-related issues, [contact ScoreboardMax support](https://scoreboardmax.com/#contact)
 
 ## License
 

package/dist/index.d.ts

@@ -463,6 +463,13 @@ export interface DataExtractResponse {
 }
 export interface DataRow extends Array<string> {
 }
+export interface ErrorResponse {
+    error: boolean;
+    code: ErrorCode;
+    statusCode: number;
+    reference: string;
+    message: string;
+}
 export interface Event {
     eventId: string;
     accountId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scoreboardmax/api-types",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "description": "TypeScript definitions for ScoreboardMax API",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",