musora-content-services 2.105.0 → 2.106.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [2.106.0](https://github.com/railroadmedia/musora-content-services/compare/v2.105.0...v2.106.0) (2025-12-18)
+
+
+### Features
+
+* Add some validators prior to writing to watermelon ([#663](https://github.com/railroadmedia/musora-content-services/issues/663)) ([9eeedac](https://github.com/railroadmedia/musora-content-services/commit/9eeedac5a3cf8b4eedd091fcb8252ffd5bae6c85))
+
 ## [2.105.0](https://github.com/railroadmedia/musora-content-services/compare/v2.104.9...v2.105.0) (2025-12-17)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musora-content-services",
-  "version": "2.105.0",
+  "version": "2.106.0",
   "description": "A package for Musoras content services ",
   "main": "src/index.js",
   "type": "module",

package/src/services/sync/errors/index.ts

@@ -47,3 +47,11 @@ export class SyncUnexpectedError extends SyncError {
     Object.setPrototypeOf(this, new.target.prototype)
   }
 }
+
+export class SyncValidationError extends SyncError {
+  constructor(message: string, value: any, expected: any) {
+    super('validationError', { message: message, value: value, expected: expected })
+    this.name = 'SyncValidationError'
+    Object.setPrototypeOf(this, new.target.prototype)
+  }
+}

package/src/services/sync/errors/validators.ts

@@ -0,0 +1,42 @@
+import { SyncValidationError } from './index'
+
+
+export function throwIfNotNumber(val: any) {
+  // note: this will accept decimal values
+  if (typeof val !== 'number') throw new SyncValidationError('Sync value is not a number: ' + val, typeof val, 'number');
+  return val
+}
+
+export function throwIfNotString(val: any) {
+  if (typeof val !== 'string') throw new SyncValidationError('Sync value is not a string: ' + val, typeof val, 'string');
+  return val
+}
+
+export function throwIfNotBoolean(val: any) {
+  if (typeof val !== 'boolean') throw new SyncValidationError('Sync value is not a boolean: ' + val, typeof val, 'boolean');
+  return val
+}
+
+export function throwIfNotNullableNumber(val: any) {
+  return val === null ? val : throwIfNotNumber(val)
+}
+
+export function throwIfNotNullableString(val: any) {
+  return val === null ? val : throwIfNotString(val)
+}
+
+export function throwIfOutsideRange(val: number, minimum?: number, maximum?: number) {
+  if (minimum !== undefined && val < minimum) throw new SyncValidationError('Sync value is less than minimum value ' + minimum + ': ' + val, val, null);
+  if (maximum !== undefined && val > maximum) throw new SyncValidationError('Sync value is greater than maximum value ' + maximum + ': ' + val, val, null);
+  return val
+}
+
+export function throwIfMaxLengthExceeded(val: string, maximum: number) {
+  if (val.length > maximum) throw new SyncValidationError('Sync value exceeds the maximum length ' + maximum + ': ' + val, val, null);
+  return val
+}
+
+export function throwIfInvalidEnumValue(val: string, enumClass: any) {
+  if (!Object.values(enumClass).includes(val)) throw new SyncValidationError('Sync value is invalid enum value: ' + val, val, enumClass);
+  return val
+}

package/src/services/sync/fetch.ts

@@ -34,7 +34,7 @@ type SyncPushFetchFailureResponse = SyncResponseBase & {
   failureType: 'fetch'
   isRetryable: boolean
 }
-type SyncPushFailureResponse = SyncResponseBase & {
+export type SyncPushFailureResponse = SyncResponseBase & {
   ok: false,
   failureType: 'error'
   originalError: Error

package/src/services/sync/models/ContentLike.ts

@@ -1,5 +1,6 @@
 import { SYNC_TABLES } from '../schema'
 import BaseModel from './Base'
+import { throwIfNotNumber } from '../errors/validators'
 
 export default class ContentLike extends BaseModel<{
   content_id: number
@@ -11,6 +12,6 @@ export default class ContentLike extends BaseModel<{
   }
 
   set content_id(value: number) {
-    this._setRaw('content_id', value)
+    this._setRaw('content_id', throwIfNotNumber(value))
   }
 }

package/src/services/sync/models/ContentProgress.ts

@@ -1,5 +1,12 @@
 import BaseModel from './Base'
 import { SYNC_TABLES } from '../schema'
+import {
+  throwIfInvalidEnumValue,
+  throwIfNotNullableNumber,
+  throwIfNotNullableString,
+  throwIfNotNumber,
+  throwIfOutsideRange,
+} from '../errors/validators'
 
 export enum COLLECTION_TYPE {
   SELF = 'self',
@@ -16,6 +23,7 @@ export enum STATE {
 
 export default class ContentProgress extends BaseModel<{
   content_id: number
+  content_brand: string | null
   collection_type: COLLECTION_TYPE
   collection_id: number
   state: STATE
@@ -28,7 +36,7 @@ export default class ContentProgress extends BaseModel<{
     return this._getRaw('content_id') as number
   }
   get content_brand() {
-    return this._getRaw('content_brand') as string
+    return this._getRaw('content_brand') as string | null
   }
   get state() {
     return this._getRaw('state') as STATE
@@ -47,28 +55,37 @@ export default class ContentProgress extends BaseModel<{
   }
 
   set content_id(value: number) {
-    this._setRaw('content_id', value)
+    // unsigned int
+    throwIfNotNumber(value)
+    this._setRaw('content_id', throwIfOutsideRange(value, 0))
   }
-  set content_brand(value: string) {
-    this._setRaw('content_brand', value)
+  set content_brand(value: string |  null) {
+    this._setRaw('content_brand', throwIfNotNullableString(value))
   }
   // IMPORTANT: progress percent only moves forward and is clamped between 0 and 100
   // also has implications for last-write-wins sync strategy
   set progress_percent(value: number) {
-    const normalizedValue = Math.min(100, Math.max(0, value))
-    const percent = normalizedValue === 0 ? 0 : Math.max(normalizedValue, this.progress_percent)
+    // tinyint unsigned
+    throwIfNotNumber(value)
+    throwIfOutsideRange(value, 0, 100)
+    const percent = value === 0 ? 0 : Math.max(value, this.progress_percent)
 
     this._setRaw('progress_percent', percent)
     this._setRaw('state', percent === 100 ? STATE.COMPLETED : STATE.STARTED)
   }
   set collection_type(value: COLLECTION_TYPE) {
-    this._setRaw('collection_type', value)
+    // enum collection_type
+    this._setRaw('collection_type', throwIfInvalidEnumValue(value, COLLECTION_TYPE))
   }
   set collection_id(value: number) {
-    this._setRaw('collection_id', value)
+    // unsigned mediumint 16777215
+    throwIfNotNumber(value)
+    this._setRaw('collection_id', throwIfOutsideRange(value, 0, 16777215))
   }
   set resume_time_seconds(value: number | null) {
-    this._setRaw('resume_time_seconds', value !== null ? Math.max(0, value) : null)
+    // smallint unsigned
+    throwIfNotNullableNumber(value)
+    this._setRaw('resume_time_seconds', value !== null ? throwIfOutsideRange(value, 0, 65535) : value)
   }
 
 }

package/src/services/sync/models/Practice.ts

@@ -1,5 +1,14 @@
 import { SYNC_TABLES } from '../schema'
 import BaseModel from './Base'
+import {
+  throwIfMaxLengthExceeded,
+  throwIfNotBoolean,
+  throwIfNotNullableNumber,
+  throwIfNotNullableString,
+  throwIfNotNumber,
+  throwIfNotString,
+  throwIfOutsideRange,
+} from '../errors/validators'
 
 export default class Practice extends BaseModel<{
   manual_id: string | null
@@ -43,30 +52,44 @@ export default class Practice extends BaseModel<{
   }
 
   set manual_id(value: string | null) {
-    this._setRaw('manual_id', value)
+    // char(26)
+    throwIfNotNullableString(value)
+    this._setRaw('manual_id', value !== null ? throwIfMaxLengthExceeded(value, 26) : value)
   }
   set content_id(value: number | null) {
-    this._setRaw('content_id', value)
+    // int unsigned
+    throwIfNotNullableNumber(value)
+    this._setRaw('content_id', value !== null ? throwIfOutsideRange(value, 0) : value)
   }
   set date(value: string) {
-    this._setRaw('date', value)
+    this._setRaw('date', throwIfNotString(value))
   }
   set auto(value: boolean) {
-    this._setRaw('auto', value)
+    // tinyint(1)
+    this._setRaw('auto', throwIfNotBoolean(value))
   }
   set duration_seconds(value: number) {
-    this._setRaw('duration_seconds', value)
+    throwIfNotNumber(value)
+    this._setRaw('duration_seconds', throwIfOutsideRange(value, 0, 59999))
   }
   set title(value: string | null) {
-    this._setRaw('title', value)
+    // varchar(64)
+    throwIfNotNullableString(value)
+    this._setRaw('title', value !== null ? throwIfMaxLengthExceeded(value, 64) : value)
   }
   set thumbnail_url(value: string | null) {
-    this._setRaw('thumbnail_url', value)
+    // varchar(255)
+    throwIfNotNullableString(value)
+    this._setRaw('thumbnail_url', value !== null ? throwIfMaxLengthExceeded(value, 255) : value)
   }
   set category_id(value: number | null) {
-    this._setRaw('category_id', value)
+    // tinyint unsigned
+    throwIfNotNullableNumber(value)
+    this._setRaw('category_id', value !== null ? throwIfOutsideRange(value, 0, 255) : value)
   }
   set instrument_id(value: number | null) {
-    this._setRaw('instrument_id', value)
+    // tinyint unsigned
+    throwIfNotNullableNumber(value)
+    this._setRaw('instrument_id', value !== null ? throwIfOutsideRange(value, 0, 255) : value)
   }
 }

package/src/services/sync/models/PracticeDayNote.ts

@@ -1,5 +1,6 @@
 import { SYNC_TABLES } from '../schema'
 import BaseModel from './Base'
+import { throwIfMaxLengthExceeded, throwIfNotString } from '../errors/validators'
 
 export default class PracticeDayNote extends BaseModel<{
   date: string
@@ -15,9 +16,10 @@ export default class PracticeDayNote extends BaseModel<{
   }
 
   set date(value: string) {
-    this._setRaw('date', value)
+    this._setRaw('date', throwIfNotString(value))
   }
   set notes(value: string) {
-    this._setRaw('notes', value)
+    throwIfNotString(value)
+    this._setRaw('notes', throwIfMaxLengthExceeded(value, 3000))
   }
 }

package/src/services/sync/models/UserAwardProgress.ts

@@ -1,6 +1,13 @@
 import BaseModel from './Base'
 import { SYNC_TABLES } from '../schema'
 import type { CompletionData } from '../../awards/types'
+import {
+  throwIfMaxLengthExceeded,
+  throwIfNotNullableString,
+  throwIfNotNumber,
+  throwIfNotString,
+  throwIfOutsideRange,
+} from '../errors/validators'
 
 export default class UserAwardProgress extends BaseModel<{
   award_id: string
@@ -34,15 +41,19 @@ export default class UserAwardProgress extends BaseModel<{
   }
 
   set award_id(value: string) {
-    this._setRaw('award_id', value)
+    // varchar(255)
+    throwIfNotString(value)
+    this._setRaw('award_id', throwIfMaxLengthExceeded(value, 255))
   }
 
   set progress_percentage(value: number) {
-    this._setRaw('progress_percentage', value)
+    // int
+    throwIfNotNumber(value)
+    this._setRaw('progress_percentage', throwIfOutsideRange(value, 0, 100))
   }
 
   set completed_at(value: string | null) {
-    this._setRaw('completed_at', value)
+    this._setRaw('completed_at', throwIfNotNullableString(value))
   }
 
   set progress_data(value: any) {

package/src/services/sync/schema/index.ts

@@ -21,8 +21,8 @@ const contentProgressTable = tableSchema({
   columns: [
     { name: 'content_id', type: 'number', isIndexed: true },
     { name: 'content_brand', type: 'string', isOptional: true, isIndexed: true },
-    { name: 'collection_type', type: 'string', isOptional: true, isIndexed: true },
-    { name: 'collection_id', type: 'number', isOptional: true, isIndexed: true },
+    { name: 'collection_type', type: 'string', isIndexed: true },
+    { name: 'collection_id', type: 'number', isIndexed: true },
     { name: 'state', type: 'string', isIndexed: true },
     { name: 'progress_percent', type: 'number' },
     { name: 'resume_time_seconds', type: 'number', isOptional: true },

package/.claude/settings.local.json

@@ -1,18 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(find:*)",
-      "Bash(docker exec:*)",
-      "Bash(npm test:*)",
-      "WebSearch",
-      "WebFetch(domain:watermelondb.dev)",
-      "WebFetch(domain:github.com)",
-      "Bash(git checkout:*)",
-      "Bash(npm run doc:*)",
-      "Bash(cat:*)",
-      "Bash(tr:*)"
-    ],
-    "deny": [],
-    "ask": []
-  }
-}