extension-data-viewer

Name: extension-data-viewer
Author: caffeinelabs

0stars0forks

How to install extension-data-viewer?

caffeinelabs/skills/extension-data-viewer

$npx -y skills add caffeinelabs/skills --skill extension-data-viewer

Installs into the current project.

Summary

Admin-only paginated viewer for stable canister state. Use whenever the user asks for a viewer, dashboard, debug panel, or admin browse over backend data — users, items, orders, logs, or any stable Map/Set/Array/VarArray/List/Stack/Queue. Pre-installed in every Caffeine app via t

Files · 1

View on GitHub

SKILL.md

1	# Data Viewer
2
3	Admin-only data inspection extension for [Caffeine AI](https://caffeine.ai?utm_source=caffeine-skill&utm_medium=referral).
4
5	## Overview
6
7	Every Caffeine app ships with the `caffeineai-data-viewer` mops package and the moc `--generate-view-queries` flag enabled. Together with `include MixinViews()` in the actor, the compiler auto-exposes a controller-only `__<var>` query for every stable variable of a supported type:
8
9	- `Map.Map<K, V>` — `(?K, ?Nat) -> [(K, V)]`
10	- `Set.Set<K>` — `(?K, ?Nat) -> [K]`
11	- `[V]`, `[var V]`, `List.List<V>`, `Stack.Stack<V>`, `Queue.Queue<V>` — `(?Nat, ?Nat) -> [V]`
12
13	A `null` cursor starts at the beginning; a `null` count returns everything from the cursor. Each generated query traps on any non-controller caller — they exist for admin dashboards and debug viewers, not user-facing endpoints.
14
15	# Backend
16
17	The package and `include` are already wired into the template. You don't need to add or edit anything for the viewer to work — declare a stable variable of a supported type and the `__<var>` query appears automatically.
18
19	```motoko filepath=src/backend/main.mo
20	import Map "mo:core/Map";
21	import Principal "mo:core/Principal";
22	import MixinViews "mo:caffeineai-data-viewer/MixinViews";
23
24	actor {
25	include MixinViews();
26
27	let users = Map.empty<Principal, Text>();
28
29	// Generated automatically: __users : (ko : ?Principal, count : ?Nat) -> [(Principal, Text)] query
30	};
31	```
32
33	Lintoko rule `include-mixin-views` (shipped with the package) errors if the actor body is missing `include MixinViews();`. Keep the include — removing it disables every auto-generated viewer.
34
35	## Rules
36
37	- NEVER use the generated `__<var>` queries as a substitute for user-facing endpoints — they trap for any non-controller caller. Public list/feed/search methods still need to be written normally with `public query func listX(...)`.
38	- NEVER declare an actor member whose name starts with `__` — it either collides with an auto-generated query or hits a reserved prefix.
39	- Pure (immutable) collections (`pure/Map`, `pure/Set`, `pure/List`, `pure/Queue`) are not supported. The viewer is mutable-only by design; pure collection field access is a deprecated pattern in Caffeine projects anyway.

People who liked this also viewed

6 picks

Type

extension-data-viewer

0stars0forks

View on GitHub

How to install extension-data-viewer?

caffeinelabs/skills/extension-data-viewer

$npx -y skills add caffeinelabs/skills --skill extension-data-viewer

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# Data Viewer
2
3	Admin-only data inspection extension for [Caffeine AI](https://caffeine.ai?utm_source=caffeine-skill&utm_medium=referral).
4
5	## Overview
6
7	Every Caffeine app ships with the `caffeineai-data-viewer` mops package and the moc `--generate-view-queries` flag enabled. Together with `include MixinViews()` in the actor, the compiler auto-exposes a controller-only `__<var>` query for every stable variable of a supported type:
8
9	- `Map.Map<K, V>` — `(?K, ?Nat) -> [(K, V)]`
10	- `Set.Set<K>` — `(?K, ?Nat) -> [K]`
11	- `[V]`, `[var V]`, `List.List<V>`, `Stack.Stack<V>`, `Queue.Queue<V>` — `(?Nat, ?Nat) -> [V]`
12
13	A `null` cursor starts at the beginning; a `null` count returns everything from the cursor. Each generated query traps on any non-controller caller — they exist for admin dashboards and debug viewers, not user-facing endpoints.
14
15	# Backend
16
17	The package and `include` are already wired into the template. You don't need to add or edit anything for the viewer to work — declare a stable variable of a supported type and the `__<var>` query appears automatically.
18
19	```motoko filepath=src/backend/main.mo
20	import Map "mo:core/Map";
21	import Principal "mo:core/Principal";
22	import MixinViews "mo:caffeineai-data-viewer/MixinViews";
23
24	actor {
25	include MixinViews();
26
27	let users = Map.empty<Principal, Text>();
28
29	// Generated automatically: __users : (ko : ?Principal, count : ?Nat) -> [(Principal, Text)] query
30	};
31	```
32
33	Lintoko rule `include-mixin-views` (shipped with the package) errors if the actor body is missing `include MixinViews();`. Keep the include — removing it disables every auto-generated viewer.
34
35	## Rules
36
37	- NEVER use the generated `__<var>` queries as a substitute for user-facing endpoints — they trap for any non-controller caller. Public list/feed/search methods still need to be written normally with `public query func listX(...)`.
38	- NEVER declare an actor member whose name starts with `__` — it either collides with an auto-generated query or hits a reserved prefix.
39	- Pure (immutable) collections (`pure/Map`, `pure/Set`, `pure/List`, `pure/Queue`) are not supported. The viewer is mutable-only by design; pure collection field access is a deprecated pattern in Caffeine projects anyway.

People who liked this also viewed

6 picks

Type