Merge branch 'main' into Quests

.github/workflows/publish.yaml

@@ -5,7 +5,8 @@ on:
 permissions:
   id-token: write
 jobs:
-  publish:
+  npm:
+    name: npm
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -27,3 +28,21 @@ jobs:
         run: pnpm publish --provenance --no-git-checks
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_ACCESS_TOKEN }}
+  jsr:
+    name: JSR
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install dependencies
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9.14.2
+          run_install: |
+            - args: [--frozen-lockfile]
+
+      - name: Publish package
+        run: pnpm dlx jsr publish

jsr.json

@@ -1,5 +1,9 @@
 {
+	"$schema": "https://jsr.io/schema/config-file.v1.json",
 	"name": "@runescape/runescape",
-	"version": "0.9.0",
-	"exports": "./source/index.ts"
+	"version": "0.10.5",
+	"exports": "./source/index.ts",
+	"publish": {
+		"include": ["source/", "README.md"]
+	}
 }

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "runescape",
-	"version": "0.10.4",
+	"version": "0.10.5",
 	"description": "A library to interact with the non-existent RuneScape API.",
 	"keywords": ["RuneScape", "Jagex", "RS3"],
 	"repository": {

source/hi-scores.ts

@@ -483,17 +483,17 @@ export interface GroupIronmanHiScoreOptions {
 	/**
 	 * The size of the page.
 	 */
-	size?: number;
+	size?: number | undefined;
 	/**
 	 * The page number.
 	 *
 	 * @remarks The page number is 0-indexed.
 	 */
-	page?: number;
+	page?: number | undefined;
 	/**
 	 * Whether the group is competitive.
 	 */
-	isCompetitive?: boolean;
+	isCompetitive?: boolean | undefined;
 	/**
 	 * The abort signal for the fetch.
 	 */

source/miscellaneous.ts

@@ -15,13 +15,13 @@ export interface AvatarOptions {
 	 *
 	 * @remarks 100 is the maximum number the width abides by.
 	 */
-	width?: number;
+	width?: number | undefined;
 	/**
 	 * The desired height.
 	 *
 	 * @remarks 100 is the maximum number the height abides by.
 	 */
-	height?: number;
+	height?: number | undefined;
 }
 
 /**
@@ -33,11 +33,11 @@ export interface AvatarOptions {
 export function avatar({ name, width, height }: AvatarOptions): string {
 	const urlSearchParams = new URLSearchParams();
 
-	if (typeof width === "number") {
+	if (width !== undefined) {
 		urlSearchParams.set("w", String(width));
 	}
 
-	if (typeof height === "number") {
+	if (height !== undefined) {
 		urlSearchParams.set("h", String(height));
 	}
 

source/rune-metrics.ts

@@ -227,7 +227,7 @@ export interface ProfileOptions {
 	 *
 	 * @remarks 20 is the maximum number this limit abides by.
 	 */
-	activities?: number;
+	activities?: number | undefined;
 	/**
 	 * The abort signal for the fetch.
 	 */
@@ -246,7 +246,7 @@ export async function profile({ name, activities, abortSignal }: ProfileOptions)
 	const urlSearchParams = new URLSearchParams();
 	urlSearchParams.set("user", name);
 
-	if (typeof activities === "number") {
+	if (activities !== undefined) {
 		urlSearchParams.set("activities", String(activities));
 	}
 

source/utility/make-request.ts

@@ -1,4 +1,4 @@
-export function makeRequest(url: string, abortSignal?: AbortSignal) {
+export function makeRequest(url: string, abortSignal: AbortSignal | undefined) {
 	const options: RequestInit = {};
 
 	if (abortSignal) {

source/wilderness-warbands.ts

@@ -6,7 +6,7 @@
  * @returns Whether a Wilderness Warbands camp is set up.
  * @see {@link https://runescape.wiki/w/Wilderness_Warbands}
  */
-export function wildernessWarbands(timestamp: number) {
+export function wildernessWarbands(timestamp: number): boolean {
 	const date = new Date(timestamp);
 	const start = new Date(date);
 	start.setUTCDate(date.getUTCDate() - ((date.getUTCDay() + 6) % 7));