@scoreboardmax/api-types 1.0.20 → 1.0.22-next.0

package/dist/index.cjs

@@ -7,7 +7,7 @@
  *
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WrestlingStyle = exports.WrestlingPeriod = exports.WrestlingOvertimeType = exports.WrestlingMeetType = exports.WebsocketOperation = exports.WebsocketMessageType = exports.SoccerPeriod = exports.SoccerPenaltyCardType = exports.SoccerGamePeriods = exports.ScoreboardType = exports.ScoreboardCode = exports.PlanId = exports.OAuthProvider = exports.MetaMessageType = exports.MagicLinkType = exports.FootballPeriod = exports.FileType = exports.ExtraTimeLabel = exports.EventAction = exports.ErrorCode = exports.DownAndDistanceDisplay = exports.ContentType = exports.ClockType = exports.BasketballTimeoutAllocation = exports.BasketballPeriod = exports.BasketballGamePeriods = exports.BaseballInningSegment = exports.AuthType = exports.ApiResource = exports.ApiAction = exports.isWrestlingData = exports.isVolleyballData = exports.isSoccerData = exports.isFootballData = exports.isBasketballData = exports.isBaseballData = void 0;
+exports.WrestlingStyle = exports.WrestlingPeriod = exports.WrestlingOvertimeType = exports.WrestlingMeetType = exports.WebsocketOperation = exports.WebsocketMessageType = exports.TemplateUseCase = exports.SoccerPeriod = exports.SoccerPenaltyCardType = exports.SoccerGamePeriods = exports.ScoreboardType = exports.ScoreboardCode = exports.PlanId = exports.OAuthProvider = exports.MetaMessageType = exports.MagicLinkType = exports.FootballPeriod = exports.FileType = exports.ExtraTimeLabel = exports.EventAction = exports.ErrorCode = exports.DownAndDistanceDisplay = exports.ContentType = exports.ClockType = exports.BasketballTimeoutAllocation = exports.BasketballPeriod = exports.BasketballGamePeriods = exports.BaseballInningSegment = exports.AuthType = exports.AppType = exports.ApiResource = exports.ApiAction = exports.isWrestlingData = exports.isVolleyballData = exports.isSoccerData = exports.isFootballData = exports.isBasketballData = exports.isBaseballData = void 0;
 const isBaseballData = (data) => {
     return data.type === ScoreboardType.Baseball;
 };
@@ -45,6 +45,8 @@ var ApiResource;
     ApiResource["All"] = "*";
     ApiResource["Account"] = "account";
     ApiResource["AccountList"] = "accountList";
+    ApiResource["App"] = "app";
+    ApiResource["AppList"] = "appList";
     ApiResource["File"] = "file";
     ApiResource["FileList"] = "fileList";
     ApiResource["Auth"] = "auth";
@@ -72,6 +74,10 @@ var ApiResource;
     ApiResource["Preset"] = "preset";
     ApiResource["PresetList"] = "presetList";
 })(ApiResource || (exports.ApiResource = ApiResource = {}));
+var AppType;
+(function (AppType) {
+    AppType["Template"] = "template";
+})(AppType || (exports.AppType = AppType = {}));
 var AuthType;
 (function (AuthType) {
     AuthType["Session"] = "session";
@@ -123,6 +129,7 @@ var ContentType;
     ContentType["Avif"] = "image/avif";
     ContentType["Csv"] = "text/csv";
     ContentType["Xlsx"] = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
+    ContentType["Zip"] = "application/zip";
 })(ContentType || (exports.ContentType = ContentType = {}));
 var DownAndDistanceDisplay;
 (function (DownAndDistanceDisplay) {
@@ -150,6 +157,7 @@ var ErrorCode;
     ErrorCode["AccountStorageExceeded"] = "AccountStorageExceeded";
     ErrorCode["ActiveScoreboardsExceeded"] = "ActiveScoreboardsExceeded";
     ErrorCode["AccountFeatureNotEnabled"] = "AccountFeatureNotEnabled";
+    ErrorCode["AppNotEnabled"] = "AppNotEnabled";
     ErrorCode["ImageProcessingError"] = "ImageProcessingError";
     ErrorCode["RemoteServerError"] = "RemoteServerError";
     ErrorCode["RemoteServerTimeout"] = "RemoteServerTimeout";
@@ -253,11 +261,18 @@ var SoccerPeriod;
     SoccerPeriod["ExtraTime2"] = "ET 2";
     SoccerPeriod["Shootout"] = "shootout";
 })(SoccerPeriod || (exports.SoccerPeriod = SoccerPeriod = {}));
+var TemplateUseCase;
+(function (TemplateUseCase) {
+    TemplateUseCase["Embed"] = "embed";
+    TemplateUseCase["Display"] = "display";
+    TemplateUseCase["Direct"] = "direct";
+})(TemplateUseCase || (exports.TemplateUseCase = TemplateUseCase = {}));
 var WebsocketMessageType;
 (function (WebsocketMessageType) {
     WebsocketMessageType["Event"] = "event";
     WebsocketMessageType["Heartbeat"] = "heartbeat";
     WebsocketMessageType["ConnectionConfirmation"] = "connectionConfirmation";
+    WebsocketMessageType["SubscriptionConfirmation"] = "subscriptionConfirmation";
     WebsocketMessageType["Info"] = "info";
     WebsocketMessageType["Meta"] = "meta";
 })(WebsocketMessageType || (exports.WebsocketMessageType = WebsocketMessageType = {}));
@@ -265,6 +280,8 @@ var WebsocketOperation;
 (function (WebsocketOperation) {
     WebsocketOperation["SendHeartbeat"] = "sendHeartbeat";
     WebsocketOperation["GetConnectionId"] = "getConnectionId";
+    WebsocketOperation["SubscribeScoreboard"] = "subscribeScoreboard";
+    WebsocketOperation["UnsubscribeScoreboard"] = "unsubscribeScoreboard";
 })(WebsocketOperation || (exports.WebsocketOperation = WebsocketOperation = {}));
 var WrestlingMeetType;
 (function (WrestlingMeetType) {

package/dist/index.d.ts

@@ -22,6 +22,8 @@ export declare enum ApiResource {
     All = "*",
     Account = "account",
     AccountList = "accountList",
+    App = "app",
+    AppList = "appList",
     File = "file",
     FileList = "fileList",
     Auth = "auth",
@@ -49,6 +51,9 @@ export declare enum ApiResource {
     Preset = "preset",
     PresetList = "presetList"
 }
+export declare enum AppType {
+    Template = "template"
+}
 export declare enum AuthType {
     Session = "session",
     Api = "api",
@@ -92,7 +97,8 @@ export declare enum ContentType {
     Webp = "image/webp",
     Avif = "image/avif",
     Csv = "text/csv",
-    Xlsx = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
+    Xlsx = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+    Zip = "application/zip"
 }
 export declare enum DownAndDistanceDisplay {
     Both = "both",
@@ -118,6 +124,7 @@ export declare enum ErrorCode {
     AccountStorageExceeded = "AccountStorageExceeded",
     ActiveScoreboardsExceeded = "ActiveScoreboardsExceeded",
     AccountFeatureNotEnabled = "AccountFeatureNotEnabled",
+    AppNotEnabled = "AppNotEnabled",
     ImageProcessingError = "ImageProcessingError",
     RemoteServerError = "RemoteServerError",
     RemoteServerTimeout = "RemoteServerTimeout",
@@ -208,16 +215,24 @@ export declare enum SoccerPeriod {
     ExtraTime2 = "ET 2",
     Shootout = "shootout"
 }
+export declare enum TemplateUseCase {
+    Embed = "embed",
+    Display = "display",
+    Direct = "direct"
+}
 export declare enum WebsocketMessageType {
     Event = "event",
     Heartbeat = "heartbeat",
     ConnectionConfirmation = "connectionConfirmation",
+    SubscriptionConfirmation = "subscriptionConfirmation",
     Info = "info",
     Meta = "meta"
 }
 export declare enum WebsocketOperation {
     SendHeartbeat = "sendHeartbeat",
-    GetConnectionId = "getConnectionId"
+    GetConnectionId = "getConnectionId",
+    SubscribeScoreboard = "subscribeScoreboard",
+    UnsubscribeScoreboard = "unsubscribeScoreboard"
 }
 export declare enum WrestlingMeetType {
     Dual = "dual",
@@ -259,6 +274,36 @@ export interface AccountResponse {
     subscriptionId: string | null;
     token?: string;
 }
+export interface AppListResponse {
+    url: string;
+    uri: string;
+    pageNext: string | null;
+    data: AppResponse[];
+}
+export interface AppManifest {
+    type: AppType.Template;
+    manifestVersion: number;
+    name: string;
+    description: string;
+    version: string;
+    templates: TemplateDefinition[];
+}
+export interface AppRequest {
+    uploadId: string;
+}
+export interface AppResponse {
+    object: string;
+    url: string;
+    uri: string;
+    appId: string;
+    version: string;
+    name: string;
+    description: string;
+    type: AppType;
+    manifest: AppManifest;
+    accountId: string;
+    dateCreated: string;
+}
 export interface Auth {
     authId: string;
     mask: string;
@@ -377,6 +422,12 @@ export interface BaseballSettingsRequest extends BaseballSettings {
 }
 export interface BaseballSettingsResponse extends BaseballSettings {
 }
+export interface BaseInput {
+    type: string;
+    label: string;
+    description?: string;
+    default: any;
+}
 export interface BasketballDataRequest {
     period: BasketballPeriod;
     team1: BasketballScoreboardTeamRequest;
@@ -430,6 +481,10 @@ export interface BasketballSettingsRequest extends BasketballSettings {
 }
 export interface BasketballSettingsResponse extends BasketballSettings {
 }
+export interface BooleanInput extends BaseInput {
+    type: "boolean";
+    default: boolean;
+}
 export interface CheckoutSessionRequest {
     priceId: string;
     currency: string;
@@ -466,6 +521,10 @@ export interface ClockResponse extends Clock {
     display: string | null;
     nowTimestamp: number;
 }
+export interface ColorInput extends BaseInput {
+    type: "color";
+    default: string;
+}
 export interface DataExtractRequest {
     removeDuplicates?: boolean;
 }
@@ -512,6 +571,7 @@ export interface FileListResponse {
 }
 export interface FileRequest {
     uploadId: string;
+    type: FileType;
 }
 export interface FileResponse {
     object: string;
@@ -604,6 +664,13 @@ export interface NewAccountRequest {
     password: string;
     name?: string;
 }
+export interface NumberInput extends BaseInput {
+    type: "number";
+    default: number;
+    min?: number;
+    max?: number;
+    step?: number;
+}
 export interface OAuthBindingRequest {
     messageCipher: string;
 }
@@ -727,6 +794,13 @@ export interface PresetResponse {
     dateCreated: string;
     dateModified: string;
 }
+export interface RangeInput extends BaseInput {
+    type: "range";
+    default: number;
+    min: number;
+    max: number;
+    step?: number;
+}
 export interface RosterListResponse {
     url: string;
     uri: string;
@@ -783,6 +857,7 @@ export interface ScoreboardRequest {
     type: ScoreboardType;
     version: number;
     data: BasketballDataRequest | FootballDataRequest | VolleyballDataRequest | SoccerDataRequest | BaseballDataRequest | WrestlingDataRequest;
+    templates?: TemplateSelection[];
 }
 export interface ScoreboardResponse {
     object: string;
@@ -804,6 +879,7 @@ export interface ScoreboardResponse {
     clocks: ClockListResponse | string;
     overlay: OverlayResponse | string;
     version: number;
+    templates: TemplateSelection[];
 }
 export interface ScoreboardSettingsBase {
     clockAscending: boolean;
@@ -835,6 +911,14 @@ export interface ScoreboardTeamBaseResponse {
     roster: string | RosterResponse | null;
     reference: string;
 }
+export interface SelectInput extends BaseInput {
+    type: "select";
+    default: string;
+    options: Array<{
+        value: string;
+        label: string;
+    }>;
+}
 export interface ServerTime {
     now: string;
     nowTimestamp: number;
@@ -971,15 +1055,33 @@ export interface TeamResponse {
     dateCreated: string;
     dateModified: string;
 }
+export interface TemplateDefinition {
+    path: string;
+    name: string;
+    sport: string;
+    useCases: TemplateUseCase[];
+    thumbnail?: string;
+    settings?: Record<string, InputDefinition>;
+}
+export interface TemplateSelection {
+    path: string;
+    appId: string;
+    useCase: TemplateUseCase;
+    version?: string;
+    settings?: Record<string, InputSelection>;
+}
+export interface TextInput extends BaseInput {
+    type: "text";
+    default: string;
+    maxLength?: number;
+}
 export interface UploadSessionRequest {
     filename: string;
-    type: FileType;
     reference?: string;
 }
 export interface UploadSessionResponse {
     object: string;
     uploadId: string;
-    type: FileType;
     filename: string;
     reference?: string;
     contentType: ContentType;
@@ -1099,9 +1201,21 @@ export interface WebsocketMessage {
     message: string;
     data: Event | MetaMessage | WebsocketConnectionIdResponse | null;
 }
+export interface WebsocketScoreboardSubscriptionRequest {
+    action: "sendmessage";
+    operation: WebsocketOperation.SubscribeScoreboard | WebsocketOperation.UnsubscribeScoreboard;
+    scoreboardId: string;
+    sendInitialData?: boolean;
+    token: string;
+}
+export interface WebsocketScoreboardSubscriptionResponse {
+    operation: WebsocketOperation.SubscribeScoreboard | WebsocketOperation.UnsubscribeScoreboard;
+    scoreboardId: string;
+    error?: ErrorResponse;
+}
 export interface WebsocketSubscriptionRequest {
     connectionId: string;
-    triggerEvent?: boolean;
+    sendInitialData?: boolean;
 }
 export interface WebsocketSubscriptionResponse {
     connectionId: string;
@@ -1166,6 +1280,8 @@ export interface WrestlingSettingsRequest extends WrestlingSettings {
 }
 export interface WrestlingSettingsResponse extends WrestlingSettings {
 }
+export type InputDefinition = SelectInput | BooleanInput | ColorInput | TextInput | NumberInput | RangeInput;
+export type InputSelection = Record<string, string | number | boolean>;
 export type PermissionItem = {
     [uri: string]: ApiAction[];
 };

package/dist/index.mjs

@@ -36,6 +36,8 @@ export var ApiResource;
     ApiResource["All"] = "*";
     ApiResource["Account"] = "account";
     ApiResource["AccountList"] = "accountList";
+    ApiResource["App"] = "app";
+    ApiResource["AppList"] = "appList";
     ApiResource["File"] = "file";
     ApiResource["FileList"] = "fileList";
     ApiResource["Auth"] = "auth";
@@ -63,6 +65,10 @@ export var ApiResource;
     ApiResource["Preset"] = "preset";
     ApiResource["PresetList"] = "presetList";
 })(ApiResource || (ApiResource = {}));
+export var AppType;
+(function (AppType) {
+    AppType["Template"] = "template";
+})(AppType || (AppType = {}));
 export var AuthType;
 (function (AuthType) {
     AuthType["Session"] = "session";
@@ -114,6 +120,7 @@ export var ContentType;
     ContentType["Avif"] = "image/avif";
     ContentType["Csv"] = "text/csv";
     ContentType["Xlsx"] = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
+    ContentType["Zip"] = "application/zip";
 })(ContentType || (ContentType = {}));
 export var DownAndDistanceDisplay;
 (function (DownAndDistanceDisplay) {
@@ -141,6 +148,7 @@ export var ErrorCode;
     ErrorCode["AccountStorageExceeded"] = "AccountStorageExceeded";
     ErrorCode["ActiveScoreboardsExceeded"] = "ActiveScoreboardsExceeded";
     ErrorCode["AccountFeatureNotEnabled"] = "AccountFeatureNotEnabled";
+    ErrorCode["AppNotEnabled"] = "AppNotEnabled";
     ErrorCode["ImageProcessingError"] = "ImageProcessingError";
     ErrorCode["RemoteServerError"] = "RemoteServerError";
     ErrorCode["RemoteServerTimeout"] = "RemoteServerTimeout";
@@ -244,11 +252,18 @@ export var SoccerPeriod;
     SoccerPeriod["ExtraTime2"] = "ET 2";
     SoccerPeriod["Shootout"] = "shootout";
 })(SoccerPeriod || (SoccerPeriod = {}));
+export var TemplateUseCase;
+(function (TemplateUseCase) {
+    TemplateUseCase["Embed"] = "embed";
+    TemplateUseCase["Display"] = "display";
+    TemplateUseCase["Direct"] = "direct";
+})(TemplateUseCase || (TemplateUseCase = {}));
 export var WebsocketMessageType;
 (function (WebsocketMessageType) {
     WebsocketMessageType["Event"] = "event";
     WebsocketMessageType["Heartbeat"] = "heartbeat";
     WebsocketMessageType["ConnectionConfirmation"] = "connectionConfirmation";
+    WebsocketMessageType["SubscriptionConfirmation"] = "subscriptionConfirmation";
     WebsocketMessageType["Info"] = "info";
     WebsocketMessageType["Meta"] = "meta";
 })(WebsocketMessageType || (WebsocketMessageType = {}));
@@ -256,6 +271,8 @@ export var WebsocketOperation;
 (function (WebsocketOperation) {
     WebsocketOperation["SendHeartbeat"] = "sendHeartbeat";
     WebsocketOperation["GetConnectionId"] = "getConnectionId";
+    WebsocketOperation["SubscribeScoreboard"] = "subscribeScoreboard";
+    WebsocketOperation["UnsubscribeScoreboard"] = "unsubscribeScoreboard";
 })(WebsocketOperation || (WebsocketOperation = {}));
 export var WrestlingMeetType;
 (function (WrestlingMeetType) {

package/package.json

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