serialstation 1.0.0

package/dist/types/index.d.ts

@@ -0,0 +1,23 @@
+export { O as OrderDirection, P as PagedTitleIDSchema, T as TitleIDFilterParams, a as TitleIDGameSchema, b as TitleIDOrderFields, c as TitleIDSchema } from '../types-KwGU8D6g.js';
+export { C as ContentIDFilterParams, a as ContentIDOrderFields, b as ContentIDSchema, P as PagedContentIDSchema } from '../types-BnaHEIcd.js';
+export { G as GameCompanySchema, a as GameFilterParams, b as GameFranchiseSchema, c as GameOrderFields, d as GameSchema, P as PagedGameSchema } from '../types-Dv-1DNPu.js';
+export { F as FranchiseFilterParams, a as FranchiseSchema, P as PagedFranchiseSchema } from '../types-axGWx6HR.js';
+export { C as CompanyFilterParams, a as CompanySchema, P as PagedCompanySchema } from '../types-BjzcHkoc.js';
+
+/**
+ * Console values supported by the API (PlayStation platforms).
+ */
+type Console = 'PS1' | 'PS2' | 'PS3' | 'PS4' | 'PS5' | 'PSP' | 'PSV' | 'PSM';
+/**
+ * Generic paginated response structure.
+ *
+ * @template T - The type of items in the response
+ */
+interface PagedResponse<T> {
+    /** Array of items in the current page */
+    items: T[];
+    /** Total count of items across all pages */
+    count: number;
+}
+
+export type { Console, PagedResponse };

package/dist/types/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/types/index.ts
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/index.ts"],"sourcesContent":["/**\r\n * Console values supported by the API (PlayStation platforms).\r\n */\r\nexport type Console = 'PS1' | 'PS2' | 'PS3' | 'PS4' | 'PS5' | 'PSP' | 'PSV' | 'PSM';\r\n\r\n/**\r\n * Generic paginated response structure.\r\n *\r\n * @template T - The type of items in the response\r\n */\r\nexport interface PagedResponse<T> {\r\n  /** Array of items in the current page */\r\n  items: T[];\r\n  /** Total count of items across all pages */\r\n  count: number;\r\n}\r\n\r\nexport * from '../api/title-ids/types';\r\nexport * from '../api/content-ids/types';\r\nexport * from '../api/games/types';\r\nexport * from '../api/franchises/types';\r\nexport * from '../api/companies/types';\r\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/types/index.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=index.mjs.map

package/dist/types/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types-BjzcHkoc.d.mts

@@ -0,0 +1,25 @@
+/**
+ * Parameters for filtering companies with pagination.
+ */
+interface CompanyFilterParams {
+    /** Maximum number of results (1-100, default 100) */
+    limit?: number;
+    /** Number of results to skip for pagination */
+    offset?: number;
+}
+/**
+ * Schema representing a company entry (developer/publisher).
+ */
+interface CompanySchema {
+    id: string | null;
+    name: string;
+}
+/**
+ * Paginated response containing company schemas.
+ */
+interface PagedCompanySchema {
+    items: CompanySchema[];
+    count: number;
+}
+
+export type { CompanyFilterParams as C, PagedCompanySchema as P, CompanySchema as a };

package/dist/types-BjzcHkoc.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Parameters for filtering companies with pagination.
+ */
+interface CompanyFilterParams {
+    /** Maximum number of results (1-100, default 100) */
+    limit?: number;
+    /** Number of results to skip for pagination */
+    offset?: number;
+}
+/**
+ * Schema representing a company entry (developer/publisher).
+ */
+interface CompanySchema {
+    id: string | null;
+    name: string;
+}
+/**
+ * Paginated response containing company schemas.
+ */
+interface PagedCompanySchema {
+    items: CompanySchema[];
+    count: number;
+}
+
+export type { CompanyFilterParams as C, PagedCompanySchema as P, CompanySchema as a };

package/dist/types-BnaHEIcd.d.mts

@@ -0,0 +1,41 @@
+/**
+ * Order fields for content ID list.
+ */
+type ContentIDOrderFields = 'content_id' | 'name';
+/**
+ * Parameters for filtering content IDs with pagination.
+ */
+interface ContentIDFilterParams {
+    /** Filter by title ID (9 characters) */
+    title_id?: string;
+    /** Filter by name (partial match) */
+    name?: string;
+    /** Order by field */
+    order_by?: ContentIDOrderFields;
+    /** Sort direction */
+    order_direction?: 'asc' | 'desc';
+    /** Maximum number of results (1-100, default 100) */
+    limit?: number;
+    /** Number of results to skip for pagination */
+    offset?: number;
+}
+/**
+ * Schema representing a content ID entry.
+ */
+interface ContentIDSchema {
+    /** Unique content ID (36 characters) */
+    content_id: string;
+    /** Associated title ID (9 characters) */
+    title_id: string;
+    /** Content name */
+    name: string;
+}
+/**
+ * Paginated response containing content ID schemas.
+ */
+interface PagedContentIDSchema {
+    items: ContentIDSchema[];
+    count: number;
+}
+
+export type { ContentIDFilterParams as C, PagedContentIDSchema as P, ContentIDOrderFields as a, ContentIDSchema as b };

package/dist/types-BnaHEIcd.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Order fields for content ID list.
+ */
+type ContentIDOrderFields = 'content_id' | 'name';
+/**
+ * Parameters for filtering content IDs with pagination.
+ */
+interface ContentIDFilterParams {
+    /** Filter by title ID (9 characters) */
+    title_id?: string;
+    /** Filter by name (partial match) */
+    name?: string;
+    /** Order by field */
+    order_by?: ContentIDOrderFields;
+    /** Sort direction */
+    order_direction?: 'asc' | 'desc';
+    /** Maximum number of results (1-100, default 100) */
+    limit?: number;
+    /** Number of results to skip for pagination */
+    offset?: number;
+}
+/**
+ * Schema representing a content ID entry.
+ */
+interface ContentIDSchema {
+    /** Unique content ID (36 characters) */
+    content_id: string;
+    /** Associated title ID (9 characters) */
+    title_id: string;
+    /** Content name */
+    name: string;
+}
+/**
+ * Paginated response containing content ID schemas.
+ */
+interface PagedContentIDSchema {
+    items: ContentIDSchema[];
+    count: number;
+}
+
+export type { ContentIDFilterParams as C, PagedContentIDSchema as P, ContentIDOrderFields as a, ContentIDSchema as b };

package/dist/types-Dv-1DNPu.d.mts

@@ -0,0 +1,60 @@
+/**
+ * Order fields for game list.
+ */
+type GameOrderFields = 'name';
+/**
+ * Parameters for filtering games with pagination.
+ */
+interface GameFilterParams {
+    /** Filter by game name (partial match) */
+    name?: string;
+    /** Filter by franchise UUID */
+    franchise?: string;
+    /** Filter by developer company UUID */
+    developer?: string;
+    /** Filter by publisher company UUID */
+    publisher?: string;
+    /** Order by field */
+    order_by?: GameOrderFields;
+    /** Sort direction */
+    order_direction?: 'asc' | 'desc';
+    /** Maximum number of results (1-100, default 100) */
+    limit?: number;
+    /** Number of results to skip for pagination */
+    offset?: number;
+}
+/**
+ * Company schema (developer/publisher) - same structure as companies API.
+ */
+interface GameCompanySchema {
+    id: string | null;
+    name: string;
+}
+/**
+ * Franchise schema - same structure as franchises API.
+ */
+interface GameFranchiseSchema {
+    id: string | null;
+    name: string;
+}
+/**
+ * Schema representing a game entry.
+ */
+interface GameSchema {
+    id: string;
+    name: string;
+    title_ids: string[];
+    concept_ids: number[] | null;
+    franchises: GameFranchiseSchema[] | null;
+    developers: GameCompanySchema[] | null;
+    publishers: GameCompanySchema[] | null;
+}
+/**
+ * Paginated response containing game schemas.
+ */
+interface PagedGameSchema {
+    items: GameSchema[];
+    count: number;
+}
+
+export type { GameCompanySchema as G, PagedGameSchema as P, GameFilterParams as a, GameFranchiseSchema as b, GameOrderFields as c, GameSchema as d };

package/dist/types-Dv-1DNPu.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Order fields for game list.
+ */
+type GameOrderFields = 'name';
+/**
+ * Parameters for filtering games with pagination.
+ */
+interface GameFilterParams {
+    /** Filter by game name (partial match) */
+    name?: string;
+    /** Filter by franchise UUID */
+    franchise?: string;
+    /** Filter by developer company UUID */
+    developer?: string;
+    /** Filter by publisher company UUID */
+    publisher?: string;
+    /** Order by field */
+    order_by?: GameOrderFields;
+    /** Sort direction */
+    order_direction?: 'asc' | 'desc';
+    /** Maximum number of results (1-100, default 100) */
+    limit?: number;
+    /** Number of results to skip for pagination */
+    offset?: number;
+}
+/**
+ * Company schema (developer/publisher) - same structure as companies API.
+ */
+interface GameCompanySchema {
+    id: string | null;
+    name: string;
+}
+/**
+ * Franchise schema - same structure as franchises API.
+ */
+interface GameFranchiseSchema {
+    id: string | null;
+    name: string;
+}
+/**
+ * Schema representing a game entry.
+ */
+interface GameSchema {
+    id: string;
+    name: string;
+    title_ids: string[];
+    concept_ids: number[] | null;
+    franchises: GameFranchiseSchema[] | null;
+    developers: GameCompanySchema[] | null;
+    publishers: GameCompanySchema[] | null;
+}
+/**
+ * Paginated response containing game schemas.
+ */
+interface PagedGameSchema {
+    items: GameSchema[];
+    count: number;
+}
+
+export type { GameCompanySchema as G, PagedGameSchema as P, GameFilterParams as a, GameFranchiseSchema as b, GameOrderFields as c, GameSchema as d };

package/dist/types-KwGU8D6g.d.mts

@@ -0,0 +1,66 @@
+/**
+ * Console values supported by the API (PlayStation platforms).
+ */
+type Console = 'PS1' | 'PS2' | 'PS3' | 'PS4' | 'PS5' | 'PSP' | 'PSV' | 'PSM';
+/**
+ * Order fields for title ID list.
+ */
+type TitleIDOrderFields = 'title_id' | 'name';
+/**
+ * Order direction for list results.
+ */
+type OrderDirection = 'asc' | 'desc';
+/**
+ * Parameters for filtering title IDs with pagination.
+ */
+interface TitleIDFilterParams {
+    /** Filter by title ID type (e.g. CUSA, BLUS) */
+    title_id_type?: string;
+    /** Filter by console/system */
+    system?: Console;
+    /** Filter by title name (partial match) */
+    name?: string;
+    /** Order by field */
+    order_by?: TitleIDOrderFields;
+    /** Sort direction */
+    order_direction?: OrderDirection;
+    /** Maximum number of results (1-100, default 100) */
+    limit?: number;
+    /** Number of results to skip for pagination */
+    offset?: number;
+}
+/**
+ * Game reference in a title ID response.
+ */
+interface TitleIDGameSchema {
+    id: string;
+    name: string;
+}
+/**
+ * Schema representing a title ID entry.
+ */
+interface TitleIDSchema {
+    /** Unique title ID (9 characters) */
+    title_id: string;
+    /** Title ID type prefix (4 chars, e.g. CUSA) */
+    title_id_type: string;
+    /** Title ID number (5 chars) */
+    title_id_number: string;
+    /** Title name */
+    name: string;
+    /** Content type */
+    content_type: string;
+    /** Array of systems this title ID is associated with */
+    systems: string[];
+    /** Associated games */
+    games: TitleIDGameSchema[];
+}
+/**
+ * Paginated response containing title ID schemas.
+ */
+interface PagedTitleIDSchema {
+    items: TitleIDSchema[];
+    count: number;
+}
+
+export type { Console as C, OrderDirection as O, PagedTitleIDSchema as P, TitleIDFilterParams as T, TitleIDGameSchema as a, TitleIDOrderFields as b, TitleIDSchema as c };

package/dist/types-KwGU8D6g.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Console values supported by the API (PlayStation platforms).
+ */
+type Console = 'PS1' | 'PS2' | 'PS3' | 'PS4' | 'PS5' | 'PSP' | 'PSV' | 'PSM';
+/**
+ * Order fields for title ID list.
+ */
+type TitleIDOrderFields = 'title_id' | 'name';
+/**
+ * Order direction for list results.
+ */
+type OrderDirection = 'asc' | 'desc';
+/**
+ * Parameters for filtering title IDs with pagination.
+ */
+interface TitleIDFilterParams {
+    /** Filter by title ID type (e.g. CUSA, BLUS) */
+    title_id_type?: string;
+    /** Filter by console/system */
+    system?: Console;
+    /** Filter by title name (partial match) */
+    name?: string;
+    /** Order by field */
+    order_by?: TitleIDOrderFields;
+    /** Sort direction */
+    order_direction?: OrderDirection;
+    /** Maximum number of results (1-100, default 100) */
+    limit?: number;
+    /** Number of results to skip for pagination */
+    offset?: number;
+}
+/**
+ * Game reference in a title ID response.
+ */
+interface TitleIDGameSchema {
+    id: string;
+    name: string;
+}
+/**
+ * Schema representing a title ID entry.
+ */
+interface TitleIDSchema {
+    /** Unique title ID (9 characters) */
+    title_id: string;
+    /** Title ID type prefix (4 chars, e.g. CUSA) */
+    title_id_type: string;
+    /** Title ID number (5 chars) */
+    title_id_number: string;
+    /** Title name */
+    name: string;
+    /** Content type */
+    content_type: string;
+    /** Array of systems this title ID is associated with */
+    systems: string[];
+    /** Associated games */
+    games: TitleIDGameSchema[];
+}
+/**
+ * Paginated response containing title ID schemas.
+ */
+interface PagedTitleIDSchema {
+    items: TitleIDSchema[];
+    count: number;
+}
+
+export type { Console as C, OrderDirection as O, PagedTitleIDSchema as P, TitleIDFilterParams as T, TitleIDGameSchema as a, TitleIDOrderFields as b, TitleIDSchema as c };

package/dist/types-axGWx6HR.d.mts

@@ -0,0 +1,25 @@
+/**
+ * Parameters for filtering franchises with pagination.
+ */
+interface FranchiseFilterParams {
+    /** Maximum number of results (1-100, default 100) */
+    limit?: number;
+    /** Number of results to skip for pagination */
+    offset?: number;
+}
+/**
+ * Schema representing a franchise entry.
+ */
+interface FranchiseSchema {
+    id: string | null;
+    name: string;
+}
+/**
+ * Paginated response containing franchise schemas.
+ */
+interface PagedFranchiseSchema {
+    items: FranchiseSchema[];
+    count: number;
+}
+
+export type { FranchiseFilterParams as F, PagedFranchiseSchema as P, FranchiseSchema as a };

package/dist/types-axGWx6HR.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Parameters for filtering franchises with pagination.
+ */
+interface FranchiseFilterParams {
+    /** Maximum number of results (1-100, default 100) */
+    limit?: number;
+    /** Number of results to skip for pagination */
+    offset?: number;
+}
+/**
+ * Schema representing a franchise entry.
+ */
+interface FranchiseSchema {
+    id: string | null;
+    name: string;
+}
+/**
+ * Paginated response containing franchise schemas.
+ */
+interface PagedFranchiseSchema {
+    items: FranchiseSchema[];
+    count: number;
+}
+
+export type { FranchiseFilterParams as F, PagedFranchiseSchema as P, FranchiseSchema as a };

package/package.json

@@ -0,0 +1,103 @@
+{
+  "name": "serialstation",
+  "version": "1.0.0",
+  "description": "An npm package enabling integration with the SerialStation API (https://api.serialstation.com/v1/openapi.json)",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "module": "dist/index.mjs",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./client": {
+      "types": "./dist/client/BaseClient.d.ts",
+      "import": "./dist/client/BaseClient.mjs",
+      "require": "./dist/client/BaseClient.js"
+    },
+    "./title-ids": {
+      "types": "./dist/api/title-ids/index.d.ts",
+      "import": "./dist/api/title-ids/index.mjs",
+      "require": "./dist/api/title-ids/index.js"
+    },
+    "./content-ids": {
+      "types": "./dist/api/content-ids/index.d.ts",
+      "import": "./dist/api/content-ids/index.mjs",
+      "require": "./dist/api/content-ids/index.js"
+    },
+    "./games": {
+      "types": "./dist/api/games/index.d.ts",
+      "import": "./dist/api/games/index.mjs",
+      "require": "./dist/api/games/index.js"
+    },
+    "./franchises": {
+      "types": "./dist/api/franchises/index.d.ts",
+      "import": "./dist/api/franchises/index.mjs",
+      "require": "./dist/api/franchises/index.js"
+    },
+    "./companies": {
+      "types": "./dist/api/companies/index.d.ts",
+      "import": "./dist/api/companies/index.mjs",
+      "require": "./dist/api/companies/index.js"
+    },
+    "./types": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/types/index.mjs",
+      "require": "./dist/types/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsup src/index.ts src/client/BaseClient.ts src/api/**/index.ts src/types/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts src/client/BaseClient.ts src/api/**/index.ts src/types/index.ts --format cjs,esm --dts --watch",
+    "test": "vitest",
+    "type-check": "tsc --noEmit",
+    "lint": "eslint src --ext .ts",
+    "format": "prettier --write src/**/*.ts",
+    "clean": "rimraf dist",
+    "prepublish": "npm run clean && npm run build && npm run type-check && npm pack",
+    "release": "npm version patch && npm publish"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Tazhys/serialstation.git"
+  },
+  "keywords": [
+    "serialstation",
+    "api-client",
+    "typescript",
+    "psn",
+    "playstation",
+    "vita",
+    "ps3",
+    "ps4"
+  ],
+  "author": "Tazhys",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Tazhys/serialstation/issues"
+  },
+  "homepage": "https://github.com/Tazhys/serialstation#readme",
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "dependencies": {
+    "axios": "^1.6.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.45.0",
+    "prettier": "^3.0.0",
+    "rimraf": "^6.1.2",
+    "tsup": "^8.0.0",
+    "typescript": "^5.9.3",
+    "vitest": "^1.0.0"
+  }
+}