@srating-io/types 2.0.3 → 2.1.0

package/dist/api/search.d.ts

@@ -12,12 +12,14 @@ export interface SearchTeamResult {
     code: string;
     name: string;
     alt_name: string | null;
+    slug: string | null;
     primary_color: string | null;
 }
 export interface SearchPlayerResult {
     player_id: string;
     first_name: string;
     last_name: string;
+    slug: string | null;
     begin: number;
     end: number;
     relevance_score: number;
@@ -26,6 +28,7 @@ export interface SearchCoachResult {
     coach_id: string;
     first_name: string;
     last_name: string;
+    slug: string | null;
     begin: number;
     end: number;
 }

package/dist/api/sitemap.d.ts

@@ -0,0 +1,38 @@
+/**
+ * The entity kinds that have a slug, and so a url worth putting in a sitemap.
+ */
+export type SlugType = 'team' | 'player' | 'coach' | 'conference' | 'game';
+export type getSlugsArguments = {
+    type: SlugType;
+    organization_id: string;
+    division_id: string;
+    /**
+     * Games only, and required there. A sitemap that reached back through every season would be
+     * mostly dead urls, so the caller names the seasons it wants.
+     */
+    seasons?: number[];
+    limit: number;
+    offset: number;
+};
+export type SlugRow = {
+    slug: string;
+    /**
+     * Feeds <lastmod>. Null on the tables that have no updated_at, which the caller then omits
+     * rather than guessing a date -- a wrong lastmod is worse than none.
+     */
+    updated_at: string | null;
+};
+export type getSlugsResults = SlugRow[];
+export type getCountsArguments = {
+    type: SlugType;
+    organization_id: string;
+    division_id: string;
+    seasons?: number[];
+};
+/**
+ * How many urls of this kind exist, so the sitemap knows how many shards to generate before it
+ * starts paging through them.
+ */
+export type getCountsResults = {
+    count: number;
+};

package/dist/basketball.d.ts

@@ -739,8 +739,16 @@ export type RankingTable = (StatisticRanking | PlayerStatisticRanking | Conferen
     committed?: boolean;
     committed_team_id?: string;
     committed_team_name?: string;
+    committed_team_slug?: string | null;
     committed_conference_id?: string;
     team_name?: string;
+    /**
+     * The slugs the table's links are built from. Decorations added by the ranking endpoint, not
+     * columns on the ranking row -- without them every link would point at an id url and 308.
+     */
+    slug?: string | null;
+    team_slug?: string | null;
+    conference_slug?: string | null;
     player?: Player;
     player_team_season?: PlayerTeamSeason;
 };

package/dist/football.d.ts

@@ -1404,8 +1404,16 @@ export type RankingTable = (StatisticRanking | PlayerStatisticRanking | Conferen
     committed?: boolean;
     committed_team_id?: string;
     committed_team_name?: string;
+    committed_team_slug?: string | null;
     committed_conference_id?: string;
     team_name?: string;
+    /**
+     * The slugs the table's links are built from. Decorations added by the ranking endpoint, not
+     * columns on the ranking row -- without them every link would point at an id url and 308.
+     */
+    slug?: string | null;
+    team_slug?: string | null;
+    conference_slug?: string | null;
     player?: Player;
     player_team_season?: PlayerTeamSeason;
 };

package/dist/general.d.ts

@@ -33,11 +33,32 @@ export interface Terminology {
 export type Terminologies = {
     [terminology_id: string]: Terminology;
 };
+/**
+ * A slug an entity used to answer to. A slug is immutable once assigned, so this only fills up
+ * from a game whose start_date moved and from a manual rename -- and a hit here is a 301, never a
+ * render.
+ */
+export interface SlugRedirect {
+    slug_redirect_id: string;
+    type: 'team' | 'player' | 'coach' | 'conference' | 'game';
+    /**
+     * Set for a game, null otherwise, matching how the slug itself is scoped.
+     */
+    organization_id: string | null;
+    slug: string;
+    entity_id: string;
+    guid: string;
+    deleted: number;
+}
+export type SlugRedirects = {
+    [slug_redirect_id: string]: SlugRedirect;
+};
 export interface Conference {
     conference_id: string;
     parent_conference_id: string;
     code: string;
     name: string;
+    slug: string;
     guid: string;
     inactive: number;
     deleted: number;
@@ -51,6 +72,7 @@ export interface Team {
     code: string;
     name: string;
     alt_name: string;
+    slug: string;
     primary_color: string;
     secondary_color: string;
     guid: string;
@@ -123,6 +145,7 @@ export interface Game {
     start_date: string;
     start_datetime: string;
     start_timestamp: number;
+    slug: string;
     attendance: number;
     neutral_site: number;
     is_conf_game: number;
@@ -137,6 +160,7 @@ export interface Coach {
     coach_id: string;
     first_name: string;
     last_name: string;
+    slug: string;
     deleted: number;
 }
 export type Coaches = {
@@ -204,6 +228,7 @@ export interface Player {
     player_id: string;
     first_name: string;
     last_name: string;
+    slug: string;
     position: string;
     height: string;
     weight: string;

package/dist/index.d.ts

@@ -28,6 +28,7 @@ export * as Ranking from './api/ranking.ts';
 export * as Search from './api/search.ts';
 export * as Secret from './api/secret.ts';
 export * as Session from './api/session.ts';
+export * as Sitemap from './api/sitemap.ts';
 export * as StatisticRanking from './api/statistic_ranking.ts';
 export * as Team from './api/team.ts';
 export * as User from './api/user.ts';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@srating-io/types",
   "private": false,
-  "version": "2.0.3",
+  "version": "2.1.0",
   "description": "srating.io shared TypeScript types for GUI and API",
   "type": "module",
   "main": "dist/index.js",