feat: type-safe .riv schema system

.github/actions/setup/action.yml

@@ -9,6 +9,9 @@ runs:
       with:
         node-version-file: .nvmrc
 
+    - name: Setup Bun
+      uses: oven-sh/setup-bun@v2
+
     - name: Restore dependencies
       id: yarn-cache
       uses: actions/cache/restore@v4

.github/workflows/ci.yml

@@ -54,6 +54,14 @@ jobs:
             exit 1
           fi
 
+      - name: Validate .riv schema files
+        run: |
+          yarn rive-gen-types --all example/assets/rive
+          if ! git diff --exit-code 'example/assets/rive/*.riv.d.ts'; then
+            echo "Error: .riv.d.ts files are out of date. Please run 'yarn rive-gen-types --all example/assets/rive' and commit the changes."
+            exit 1
+          fi
+
       - name: Typecheck files
         run: yarn typecheck
 

eslint.config.mjs

@@ -54,6 +54,8 @@ export default defineConfig([
       'node_modules/',
       'lib/',
       '**/.expo/',
+      '**/*.test-d.ts',
+      '**/*.riv.d.ts',
     ],
   },
 ]);

example/assets/rive/GradientBorder.riv.d.ts

@@ -0,0 +1,17 @@
+// Generated by rive-gen-types — do not edit manually. @generated
+// eslint-disable
+// Source: GradientBorder.riv
+import type { RiveAsset } from '@rive-app/react-native';
+declare const asset: RiveAsset<{
+  artboards: 'Layout';
+  defaultArtboard: 'Layout';
+  stateMachines: {
+    Layout: 'State';
+  };
+  viewModels: {
+    ViewModel: {
+      isFocused: 'boolean';
+    };
+  };
+}>;
+export default asset;

example/assets/rive/artboard_db_test.riv.d.ts

@@ -0,0 +1,21 @@
+// Generated by rive-gen-types — do not edit manually. @generated
+// eslint-disable
+// Source: artboard_db_test.riv
+import type { RiveAsset } from '@rive-app/react-native';
+declare const asset: RiveAsset<{
+  artboards: 'Main' | 'ArtboardGreen' | 'ArtboardBlue' | 'ArtboardRed';
+  defaultArtboard: 'Main';
+  stateMachines: {
+    Main: 'State Machine 1';
+    ArtboardGreen: 'State Machine 1';
+    ArtboardBlue: 'State Machine 1';
+    ArtboardRed: 'State Machine 1';
+  };
+  viewModels: {
+    MainViewModel: {
+      artboard_1: 'artboard';
+      artboard_2: 'artboard';
+    };
+  };
+}>;
+export default asset;

example/assets/rive/blinko.riv.d.ts

@@ -0,0 +1,97 @@
+// Generated by rive-gen-types — do not edit manually. @generated
+// eslint-disable
+// Source: blinko.riv
+import type { RiveAsset } from '@rive-app/react-native';
+declare const asset: RiveAsset<{
+  artboards: 'Main' | 'StoreItem' | 'Token' | 'Indicator' | 'Puck' | 'StoreIcon' | 'Peg' | 'scoreBox';
+  defaultArtboard: 'Main';
+  stateMachines: {
+    Main: 'State Machine 1';
+    StoreItem: 'State Machine 1';
+    Token: 'State Machine 1';
+    Indicator: 'State Machine 1';
+    Puck: 'State Machine 1';
+    StoreIcon: 'State Machine 1';
+    Peg: 'State Machine 1';
+    scoreBox: 'State Machine 1';
+  };
+  viewModels: {
+    IndicatorVM: {
+      purchased: 'boolean';
+    };
+    StoreItemVM: {
+      tokenCount: 'number';
+      height: 'number';
+      itemHover: 'boolean';
+      cost: 'number';
+      description: 'string';
+      id: 'string';
+      itemType: 'string';
+      maxPurchases: 'number';
+      name: 'string';
+      purchase: 'trigger';
+      purchaseCount: 'number';
+    };
+    storeIconVM: {
+      storeiconClick: 'trigger';
+      iconHovered: 'boolean';
+    };
+    storeVM: {
+      'xbuttonClick': 'trigger';
+      'xbuttonHover': 'boolean';
+      'items': 'list';
+      'storeOpen': 'boolean';
+      'property of pegVM': 'viewModel:pegVM';
+      'multiplierValue': 'number';
+      'extraTokenSlotActive': 'boolean';
+      'extraTokenSlotCost': 'number';
+      'extraTokenSlotCount': 'number';
+      'purchaseExtraTokenSlot': 'trigger';
+      'purchaseSuperMultiplier': 'trigger';
+      'superMultiplierActive': 'boolean';
+      'superMultiplierCost': 'number';
+      'superMultiplierCount': 'number';
+    };
+    TokenVM: {
+      spinToken: 'boolean';
+    };
+    pegVM: {
+      blink: 'trigger';
+      multiplierValue: 'number';
+      pegType: 'enum:normal|multiplier';
+      pegBounced: 'trigger';
+    };
+    gameLogicVM: {
+      turnTokens: 'number';
+      turnScore: 'number';
+      buttonLabel: 'string';
+      message: 'string';
+      startTurn: 'trigger';
+      turnEnded: 'trigger';
+      gameEnded: 'boolean';
+      tokenCount: 'number';
+      scoreTotal: 'number';
+    };
+    scoreBox: {
+      Token: 'viewModel:TokenVM';
+      slotType: 'enum:addToken|normal';
+      landed: 'trigger';
+      scoreValue: 'number';
+    };
+    PuckVM: {
+      puckBounce: 'trigger';
+      puckRotation: 'number';
+    };
+    main: {
+      'PuckVM': 'viewModel:PuckVM';
+      'storeItemVM': 'viewModel:StoreItemVM';
+      'storeIconVM': 'viewModel:storeIconVM';
+      'pegVM': 'viewModel:pegVM';
+      'storeVM': 'viewModel:storeVM';
+      'buttonHover': 'boolean';
+      'tokenVM': 'viewModel:TokenVM';
+      'property of gameLogicVM': 'viewModel:gameLogicVM';
+    };
+  };
+}>;
+export default asset;

example/assets/rive/bouncing_ball.riv.d.ts

@@ -0,0 +1,17 @@
+// Generated by rive-gen-types — do not edit manually. @generated
+// eslint-disable
+// Source: bouncing_ball.riv
+import type { RiveAsset } from '@rive-app/react-native';
+declare const asset: RiveAsset<{
+  artboards: 'Artboard';
+  defaultArtboard: 'Artboard';
+  stateMachines: {
+    Artboard: 'State Machine 1';
+  };
+  viewModels: {
+    vm: {
+      ypos: 'number';
+    };
+  };
+}>;
+export default asset;

example/assets/rive/counter.riv.d.ts

@@ -0,0 +1,17 @@
+// Generated by rive-gen-types — do not edit manually. @generated
+// eslint-disable
+// Source: counter.riv
+import type { RiveAsset } from '@rive-app/react-native';
+declare const asset: RiveAsset<{
+  artboards: 'Artboard';
+  defaultArtboard: 'Artboard';
+  stateMachines: {
+    Artboard: 'State Machine 1';
+  };
+  viewModels: {
+    ViewModel1: {
+      cnt: 'number';
+    };
+  };
+}>;
+export default asset;

example/assets/rive/databinding.riv.d.ts

@@ -0,0 +1,28 @@
+// Generated by rive-gen-types — do not edit manually. @generated
+// eslint-disable
+// Source: databinding.riv
+import type { RiveAsset } from '@rive-app/react-native';
+declare const asset: RiveAsset<{
+  artboards: 'Artboard';
+  defaultArtboard: 'Artboard';
+  stateMachines: {
+    Artboard: 'State Machine 1';
+  };
+  viewModels: {
+    Person: {
+      pet: 'viewModel:Pet';
+      jump: 'trigger';
+      likes_popcorn: 'boolean';
+      favourite_pet: 'enum:chipmunk|rat|frog|owl|cat|dog';
+      favourite_color: 'color';
+      age: 'number';
+      website: 'string';
+      name: 'string';
+    };
+    Pet: {
+      type: 'enum:chipmunk|rat|frog|owl|cat|dog';
+      name: 'string';
+    };
+  };
+}>;
+export default asset;

example/assets/rive/databinding_images.riv.d.ts

@@ -0,0 +1,17 @@
+// Generated by rive-gen-types — do not edit manually. @generated
+// eslint-disable
+// Source: databinding_images.riv
+import type { RiveAsset } from '@rive-app/react-native';
+declare const asset: RiveAsset<{
+  artboards: 'Artboard';
+  defaultArtboard: 'Artboard';
+  stateMachines: {
+    Artboard: 'State Machine 1';
+  };
+  viewModels: {
+    MyViewModel: {
+      bound_image: 'image';
+    };
+  };
+}>;
+export default asset;

example/assets/rive/databinding_lists.riv.d.ts

@@ -0,0 +1,20 @@
+// Generated by rive-gen-types — do not edit manually. @generated
+// eslint-disable
+// Source: databinding_lists.riv
+import type { RiveAsset } from '@rive-app/react-native';
+declare const asset: RiveAsset<{
+  artboards: 'Artboard';
+  defaultArtboard: 'Artboard';
+  stateMachines: {
+    Artboard: 'State Machine 1';
+  };
+  viewModels: {
+    Person: {
+      name: 'string';
+    };
+    DevRel: {
+      team: 'list';
+    };
+  };
+}>;
+export default asset;

example/assets/rive/fallback_fonts.riv.d.ts

@@ -0,0 +1,12 @@
+// Generated by rive-gen-types — do not edit manually. @generated
+// eslint-disable
+// Source: fallback_fonts.riv
+import type { RiveAsset } from '@rive-app/react-native';
+declare const asset: RiveAsset<{
+  artboards: 'Artboard';
+  defaultArtboard: 'Artboard';
+  stateMachines: {
+    Artboard: 'State Machine 1';
+  };
+}>;
+export default asset;

example/assets/rive/font_fallback.riv.d.ts

@@ -0,0 +1,17 @@
+// Generated by rive-gen-types — do not edit manually. @generated
+// eslint-disable
+// Source: font_fallback.riv
+import type { RiveAsset } from '@rive-app/react-native';
+declare const asset: RiveAsset<{
+  artboards: 'Artboard';
+  defaultArtboard: 'Artboard';
+  stateMachines: {
+    Artboard: 'State Machine 1';
+  };
+  viewModels: {
+    ViewModel: {
+      text: 'string';
+    };
+  };
+}>;
+export default asset;

example/assets/rive/hello_world_text.riv.d.ts

@@ -0,0 +1,12 @@
+// Generated by rive-gen-types — do not edit manually. @generated
+// eslint-disable
+// Source: hello_world_text.riv
+import type { RiveAsset } from '@rive-app/react-native';
+declare const asset: RiveAsset<{
+  artboards: 'New Artboard';
+  defaultArtboard: 'New Artboard';
+  stateMachines: {
+    'New Artboard': 'State Machine 1';
+  };
+}>;
+export default asset;

example/assets/rive/inputglow.riv.d.ts

@@ -0,0 +1,17 @@
+// Generated by rive-gen-types — do not edit manually. @generated
+// eslint-disable
+// Source: inputglow.riv
+import type { RiveAsset } from '@rive-app/react-native';
+declare const asset: RiveAsset<{
+  artboards: 'Layout';
+  defaultArtboard: 'Layout';
+  stateMachines: {
+    Layout: 'State';
+  };
+  viewModels: {
+    ViewModel: {
+      isFocused: 'boolean';
+    };
+  };
+}>;
+export default asset;

example/assets/rive/ios_android_layouts_demo_v01.riv.d.ts

@@ -0,0 +1,12 @@
+// Generated by rive-gen-types — do not edit manually. @generated
+// eslint-disable
+// Source: ios_android_layouts_demo_v01.riv
+import type { RiveAsset } from '@rive-app/react-native';
+declare const asset: RiveAsset<{
+  artboards: 'iOS_Android_Layouts_demo_v01';
+  defaultArtboard: 'iOS_Android_Layouts_demo_v01';
+  stateMachines: {
+    iOS_Android_Layouts_demo_v01: 'State Machine 1';
+  };
+}>;
+export default asset;

example/assets/rive/layout_test.riv.d.ts

@@ -0,0 +1,17 @@
+// Generated by rive-gen-types — do not edit manually. @generated
+// eslint-disable
+// Source: layout_test.riv
+import type { RiveAsset } from '@rive-app/react-native';
+declare const asset: RiveAsset<{
+  artboards: 'Artboard';
+  defaultArtboard: 'Artboard';
+  stateMachines: {
+    Artboard: 'State Machine 1';
+  };
+  viewModels: {
+    ViewModel1: {
+
+    };
+  };
+}>;
+export default asset;

example/assets/rive/layouts_demo.riv.d.ts

@@ -0,0 +1,12 @@
+// Generated by rive-gen-types — do not edit manually. @generated
+// eslint-disable
+// Source: layouts_demo.riv
+import type { RiveAsset } from '@rive-app/react-native';
+declare const asset: RiveAsset<{
+  artboards: 'iOS_Android_Layouts_demo_v01';
+  defaultArtboard: 'iOS_Android_Layouts_demo_v01';
+  stateMachines: {
+    iOS_Android_Layouts_demo_v01: 'State Machine 1';
+  };
+}>;
+export default asset;