@scrobblr/types 0.1.0

package/README.md

@@ -0,0 +1,49 @@
+# @scrobblr/types
+
+Shared TypeScript types for Scrobblr, generated from the Rust API models
+(`crates/shared`) via [ts-rs]. This package is the **contract** between the
+backend and every TypeScript client (the browser extension in this repo, and
+the separate web app).
+
+## How it stays in sync
+
+The `.ts` files under `src/generated/` are produced by ts-rs: running
+`cargo test -p shared` at the repo root regenerates them (the export dir is set
+by `TS_RS_EXPORT_DIR` in `.cargo/config.toml`). **Never edit them by hand.**
+
+`src/generated/index.ts` is an auto-generated barrel — `bun run gen-index`
+(part of `bun run build`) rebuilds it from whatever files exist, so a new model
+can't be forgotten.
+
+## Consuming it
+
+Inside this monorepo it's a workspace dependency (`"@scrobblr/types": "workspace:*"`).
+
+Elsewhere (the web repo, contributors):
+
+```sh
+bun add @scrobblr/types
+```
+
+```ts
+import type { ScrobbleRich, UserProfile } from "@scrobblr/types";
+```
+
+## Publishing
+
+Published to the public npm registry by
+[`.github/workflows/types-release.yml`](../../.github/workflows/types-release.yml).
+
+1. Change a model in `crates/shared`, run `cargo test -p shared`, commit the
+   regenerated `src/generated/` files.
+2. Tag a release: `git tag types-v0.2.0 && git push origin types-v0.2.0`
+   (or run the workflow manually with a version).
+
+The workflow regenerates the bindings and **fails if the committed types are
+stale**, then builds and publishes. Bump the version following semver —
+removing or renaming a field is a breaking change for consumers.
+
+Requires an `NPM_TOKEN` repo secret (an npm automation/granular token with
+publish rights to the `@scrobblr` scope).
+
+[ts-rs]: https://github.com/Aleph-Alpha/ts-rs

package/dist/generated/ActivityDay.d.ts

@@ -0,0 +1,4 @@
+export type ActivityDay = {
+    day: string;
+    scrobble_count: number;
+};

package/dist/generated/ActivityDay.js

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/dist/generated/Album.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Album
+ */
+export type Album = {
+    id: number;
+    artist_id: number;
+    title: string;
+    title_normalized: string;
+    mbid: string | null;
+    image_url: string | null;
+    release_date: string | null;
+    scrobble_count: number;
+    created_at: string;
+};

package/dist/generated/Album.js

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/dist/generated/ApiToken.d.ts

@@ -0,0 +1,10 @@
+export type ApiToken = {
+    id: string;
+    user_id: number;
+    name: string;
+    token_hash: string;
+    scopes: Array<string>;
+    last_used_at: string | null;
+    created_at: string;
+    expires_at: string | null;
+};

package/dist/generated/ApiToken.js

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/dist/generated/Artist.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Artist
+ */
+export type Artist = {
+    id: number;
+    name: string;
+    name_normalized: string;
+    mbid: string | null;
+    image_url: string | null;
+    bio: string | null;
+    scrobble_count: number;
+    listener_count: number;
+    created_at: string;
+};

package/dist/generated/Artist.js

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/dist/generated/Comment.d.ts

@@ -0,0 +1,12 @@
+/**
+ * A user comment on a catalog entity, joined with the commenter's identity.
+ */
+export type Comment = {
+    id: number;
+    user_id: number;
+    username: string;
+    display_name: string | null;
+    image_url: string | null;
+    body: string;
+    created_at: string;
+};

package/dist/generated/Comment.js

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/dist/generated/ImageCandidate.d.ts

@@ -0,0 +1,21 @@
+/**
+ * A community-uploaded image candidate for an artist or album. Uploads add
+ * candidates rather than replacing the image; the most-liked candidate
+ * (once it clears the vote threshold) becomes the entity's displayed image.
+ */
+export type ImageCandidate = {
+    id: number;
+    url: string;
+    uploaded_by: string;
+    vote_count: number;
+    /**
+     * Whether the requesting user has liked this candidate (false when
+     * unauthenticated).
+     */
+    has_voted: boolean;
+    /**
+     * Whether this candidate is the entity's current displayed image.
+     */
+    is_default: boolean;
+    created_at: string;
+};

package/dist/generated/ImageCandidate.js

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/dist/generated/NowPlaying.d.ts

@@ -0,0 +1,12 @@
+/**
+ * NowPlaying
+ */
+export type NowPlaying = {
+    user_id: number;
+    track_id: number;
+    artist_id: number;
+    album_id: number | null;
+    started_at: string;
+    expires_at: string;
+    source: string;
+};

package/dist/generated/NowPlaying.js

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/dist/generated/NowPlayingRich.d.ts

@@ -0,0 +1,14 @@
+export type NowPlayingRich = {
+    track_title: string;
+    artist_name: string;
+    album_title: string | null;
+    album_image: string | null;
+    /**
+     * Fallback artwork for clients when the album has no cover (tracks have
+     * no artwork of their own — the album cover is the track's image).
+     */
+    artist_image: string | null;
+    started_at: string;
+    expires_at: string;
+    source: string;
+};

package/dist/generated/NowPlayingRich.js

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/dist/generated/Scrobble.d.ts

@@ -0,0 +1,13 @@
+/**
+ *  Scrobble
+ */
+export type Scrobble = {
+    id: number;
+    user_id: number;
+    track_id: number;
+    artist_id: number;
+    album_id: number | null;
+    played_at: string;
+    source: string;
+    duration_ms: number | null;
+};

package/dist/generated/Scrobble.js

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/dist/generated/ScrobbleRich.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Rich scrobble for API responses (joined data)
+ */
+export type ScrobbleRich = {
+    id: number;
+    played_at: string;
+    source: string;
+    track_id: number;
+    track_title: string;
+    artist_id: number;
+    artist_name: string;
+    album_id: number | null;
+    album_title: string | null;
+    album_image: string | null;
+    duration_ms: number | null;
+};

package/dist/generated/ScrobbleRich.js

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/dist/generated/TopArtist.d.ts

@@ -0,0 +1,6 @@
+export type TopArtist = {
+    artist_id: number;
+    artist_name: string;
+    image_url: string | null;
+    play_count: number;
+};

package/dist/generated/TopArtist.js

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/dist/generated/TopListener.d.ts

@@ -0,0 +1,11 @@
+/**
+ * A user who listens to a given artist or track, with their play count.
+ * Only public profiles are ever returned.
+ */
+export type TopListener = {
+    user_id: number;
+    username: string;
+    display_name: string | null;
+    image_url: string | null;
+    play_count: number;
+};

package/dist/generated/TopListener.js

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/dist/generated/TopTrack.d.ts

@@ -0,0 +1,8 @@
+export type TopTrack = {
+    track_id: number;
+    track_title: string;
+    artist_id: number;
+    artist_name: string;
+    album_image: string | null;
+    play_count: number;
+};

package/dist/generated/TopTrack.js

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/dist/generated/Track.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Track
+ */
+export type Track = {
+    id: number;
+    artist_id: number;
+    album_id: number | null;
+    title: string;
+    title_normalized: string;
+    mbid: string | null;
+    duration_ms: number | null;
+    scrobble_count: number;
+    created_at: string;
+};

package/dist/generated/Track.js

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/dist/generated/User.d.ts

@@ -0,0 +1,20 @@
+/**
+ * User
+ */
+export type User = {
+    id: number;
+    username: string;
+    email: string;
+    password_hash: string;
+    display_name: string | null;
+    bio: string | null;
+    image_url: string | null;
+    website_url: string | null;
+    country: string | null;
+    scrobble_count: number;
+    is_private: boolean;
+    is_verified: boolean;
+    last_seen_at: string | null;
+    created_at: string;
+    updated_at: string;
+};

package/dist/generated/User.js

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/dist/generated/UserProfile.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Public-facing profile (no sensitive fields)
+ */
+export type UserProfile = {
+    id: number;
+    username: string;
+    display_name: string | null;
+    bio: string | null;
+    image_url: string | null;
+    website_url: string | null;
+    country: string | null;
+    scrobble_count: number;
+    is_private: boolean;
+    is_verified: boolean;
+    last_seen_at: string | null;
+    created_at: string;
+};

package/dist/generated/UserProfile.js

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/dist/generated/UserSession.d.ts

@@ -0,0 +1,9 @@
+export type UserSession = {
+    id: string;
+    user_id: number;
+    ip_address: string | null;
+    user_agent: string | null;
+    created_at: string;
+    expires_at: string;
+    last_used_at: string;
+};

package/dist/generated/UserSession.js

@@ -0,0 +1,2 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+export {};

package/dist/generated/index.d.ts

@@ -0,0 +1,17 @@
+export * from "./ActivityDay.js";
+export * from "./Album.js";
+export * from "./ApiToken.js";
+export * from "./Artist.js";
+export * from "./Comment.js";
+export * from "./ImageCandidate.js";
+export * from "./NowPlaying.js";
+export * from "./NowPlayingRich.js";
+export * from "./Scrobble.js";
+export * from "./ScrobbleRich.js";
+export * from "./TopArtist.js";
+export * from "./TopListener.js";
+export * from "./TopTrack.js";
+export * from "./Track.js";
+export * from "./User.js";
+export * from "./UserProfile.js";
+export * from "./UserSession.js";

package/dist/generated/index.js

@@ -0,0 +1,19 @@
+// AUTO-GENERATED by scripts/gen-index.ts — do not edit.
+// Re-run with `bun run gen-index` (part of `bun run build`).
+export * from "./ActivityDay.js";
+export * from "./Album.js";
+export * from "./ApiToken.js";
+export * from "./Artist.js";
+export * from "./Comment.js";
+export * from "./ImageCandidate.js";
+export * from "./NowPlaying.js";
+export * from "./NowPlayingRich.js";
+export * from "./Scrobble.js";
+export * from "./ScrobbleRich.js";
+export * from "./TopArtist.js";
+export * from "./TopListener.js";
+export * from "./TopTrack.js";
+export * from "./Track.js";
+export * from "./User.js";
+export * from "./UserProfile.js";
+export * from "./UserSession.js";

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./generated/index.js";

package/dist/index.js

@@ -0,0 +1,4 @@
+// Public entrypoint for @scrobblr/types.
+// The barrel below is auto-generated from the ts-rs output; see
+// scripts/gen-index.ts. Add hand-written exports here, not in generated/.
+export * from "./generated/index.js";

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@scrobblr/types",
+  "version": "0.1.0",
+  "description": "Shared TypeScript types for Scrobblr, generated from the Rust API models via ts-rs.",
+  "license": "AGPL-3.0-only",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/scrobblrhq/scrobblr.git",
+    "directory": "packages/types"
+  },
+  "homepage": "https://github.com/scrobblrhq/scrobblr/tree/main/packages/types#readme",
+  "bugs": "https://github.com/scrobblrhq/scrobblr/issues",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "scripts": {
+    "gen-index": "bun run scripts/gen-index.ts",
+    "build": "bun run gen-index && tsc -p tsconfig.build.json",
+    "clean": "rm -rf dist",
+    "check": "tsc --noEmit",
+    "prepublishOnly": "bun run build"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5"
+  }
+}