@targoninc/lyda-shared 0.0.29 → 0.0.30

package/dist/Enums/NotificationReferenceType.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Represents the different types of notification references. These are actually stored in the message.
+ */
 export declare enum NotificationReferenceType {
     user = "u",
     track = "t",

package/dist/Models/Likable.d.ts

@@ -1,6 +1,9 @@
 import { TrackLike } from "./db/lyda/TrackLike.ts";
 import { AlbumLike } from "./db/lyda/AlbumLike.ts";
 import { PlaylistLike } from "./db/lyda/PlaylistLike.ts";
+/**
+ * A generic interface for an entity that has an array of likes attached to it
+ */
 export interface Likable {
     likes?: (TrackLike | AlbumLike | PlaylistLike)[];
 }

package/dist/Models/ListTrack.d.ts

@@ -1,4 +1,7 @@
 import { Track } from "./db/lyda/Track.ts";
+/**
+ * A generic interface for tracks in lists (e.g. albums or playlists)
+ */
 export interface ListTrack {
     track_id: number;
     position: number;

package/dist/Models/NotifcationPart.d.ts

@@ -1,5 +1,8 @@
+/**
+ * Represents a part of a notification that can be displayed as a separate component
+ */
 export interface NotificationPart {
-    type: string;
+    type: "profile" | "track" | "album" | "playlist";
     text?: string;
     id?: number;
 }

package/dist/Models/NotificationReference.d.ts

@@ -1,4 +1,10 @@
 import { NotificationReferenceType } from "../Enums/NotificationReferenceType.ts";
+/**
+ * Represents a reference for a notification.
+ *
+ * This interface defines the structure of a notification reference object,
+ * which includes properties to identify and optionally associate an object with the notification.
+ */
 export interface NotificationReference {
     type: NotificationReferenceType;
     id: number;

package/dist/Models/PlayingFrom.d.ts

@@ -1,5 +1,8 @@
 import { Album } from "./db/lyda/Album.ts";
 import { Playlist } from "./db/lyda/Playlist.ts";
+/**
+ * Represents the source from where media is currently being played.
+ */
 export interface PlayingFrom {
     type: "album" | "playlist" | string;
     name: string;

package/dist/Models/db/lyda/User.d.ts

@@ -8,6 +8,13 @@ import { Permission } from "./Permission.js";
 import { Entity } from "@targoninc/ts-search";
 import { UserTotp } from "./UserTotp.ts";
 import { PublicKey } from "./PublicKey.ts";
+/**
+ * Represents a user entity with associated attributes and relationships.
+ *
+ * The `User` interface extends the `Entity` interface from our search library and defines additional properties
+ * related to the user, including information about permissions, subscriptions, settings, badges,
+ * security credentials, and activity logs.
+ */
 export interface User extends Entity {
     permissions?: Permission[];
     subscription?: Subscription;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@targoninc/lyda-shared",
   "type": "module",
-  "version": "0.0.29",
+  "version": "0.0.30",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [

package/src/Enums/NotificationReferenceType.ts

@@ -1,3 +1,6 @@
+/**
+ * Represents the different types of notification references. These are actually stored in the message.
+ */
 export enum NotificationReferenceType {
     user = "u",
     track = "t",

package/src/Models/Likable.ts

@@ -2,6 +2,9 @@ import {TrackLike} from "./db/lyda/TrackLike.ts";
 import {AlbumLike} from "./db/lyda/AlbumLike.ts";
 import {PlaylistLike} from "./db/lyda/PlaylistLike.ts";
 
+/**
+ * A generic interface for an entity that has an array of likes attached to it
+ */
 export interface Likable {
     likes?: (TrackLike | AlbumLike | PlaylistLike)[];
 }

package/src/Models/ListTrack.ts

@@ -1,5 +1,8 @@
 import {Track} from "./db/lyda/Track.ts";
 
+/**
+ * A generic interface for tracks in lists (e.g. albums or playlists)
+ */
 export interface ListTrack {
     track_id: number;
     position: number;

package/src/Models/NotifcationPart.ts

@@ -1,5 +1,8 @@
+/**
+ * Represents a part of a notification that can be displayed as a separate component
+ */
 export interface NotificationPart {
-    type: string,
+    type: "profile" | "track" | "album" | "playlist",
     text?: string,
     id?: number
 }

package/src/Models/NotificationReference.ts

@@ -1,5 +1,11 @@
 import {NotificationReferenceType} from "../Enums/NotificationReferenceType.ts";
 
+/**
+ * Represents a reference for a notification.
+ *
+ * This interface defines the structure of a notification reference object,
+ * which includes properties to identify and optionally associate an object with the notification.
+ */
 export interface NotificationReference {
     type: NotificationReferenceType;
     id: number;

package/src/Models/PlayingFrom.ts

@@ -1,6 +1,9 @@
 import {Album} from "./db/lyda/Album.ts";
 import {Playlist} from "./db/lyda/Playlist.ts";
 
+/**
+ * Represents the source from where media is currently being played.
+ */
 export interface PlayingFrom {
     type: "album" | "playlist" | string;
     name: string;

package/src/Models/db/lyda/User.ts

@@ -9,6 +9,13 @@ import {Entity} from "@targoninc/ts-search";
 import {UserTotp} from "./UserTotp.ts";
 import {PublicKey} from "./PublicKey.ts";
 
+/**
+ * Represents a user entity with associated attributes and relationships.
+ *
+ * The `User` interface extends the `Entity` interface from our search library and defines additional properties
+ * related to the user, including information about permissions, subscriptions, settings, badges,
+ * security credentials, and activity logs.
+ */
 export interface User extends Entity {
     permissions?: Permission[];
     subscription?: Subscription;