ps99-api 1.0.0

package/.github/workflows/release-on-main.yml

@@ -0,0 +1,29 @@
+name: Semantic Release
+
+on:
+  push:
+    branches:
+      - main
+
+
+permissions:
+  contents: write # to be able to publish a GitHub release
+  issues: write # to be able to comment on released issues
+  pull-requests: write # to be able to comment on released pull requests
+  id-token: write # to enable use of OIDC for npm provenance
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm run test
+      - run: npm run build
+      - env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/node-ps99-api.iml" filepath="$PROJECT_DIR$/.idea/node-ps99-api.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/node-ps99-api.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/.release.rc

@@ -0,0 +1,8 @@
+{
+    "branches": ["main"],
+    "plugins": [
+        "@semantic-release/commit-analyzer",
+        "@semantic-release/npm",
+        "@semantic-release/git"
+    ]
+}

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Joseph Lawson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,25 @@
+# ps99-api
+
+Pet Simulator Public API wrapper written in Typescript.
+
+## Installation
+
+`npm install ps99-api` or `yarn add ps99-api`
+
+## Usage
+
+```typescript
+import {PetSimulator99API} from 'ps99-api';
+
+const ps99api = new PetSimulator99API()
+await ps99api.getClan('CAT');
+```
+
+## Notes
+
+1. `{{URL}}/api/exists` seems to only return pets for now.
+
+## Links
+
+* [ps99-public-api-docs](https://github.com/BIG-Games-LLC/ps99-public-api-docs)
+* [Pet Simulator Public API](https://docs.biggamesapi.io/)

package/dist/__tests__/ps99-api.js

@@ -0,0 +1,150 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const globals_1 = require("@jest/globals");
+const axios_1 = __importDefault(require("axios"));
+const ps99_api_1 = require("../ps99-api");
+const axios_2 = require("../request-client/axios");
+globals_1.jest.mock("axios");
+let api;
+const mockedAxios = axios_1.default;
+(0, globals_1.beforeEach)(() => {
+    mockedAxios.mockClear();
+    mockedAxios.mockReturnValue(Promise.resolve({ data: {} }));
+    api = new ps99_api_1.PetSimulator99API({ requestClient: (0, axios_2.getAxiosRequest)(mockedAxios) });
+});
+(0, globals_1.describe)("Pet Simulator Public API Tests", () => {
+    (0, globals_1.test)("get Collections", async () => {
+        await api.getCollections();
+        (0, globals_1.expect)(axios_1.default).toBeCalledWith({
+            method: "GET",
+            params: {},
+            responseEncoding: "utf8",
+            responseType: "json",
+            url: "https://biggamesapi.io/api/collections",
+        });
+    });
+    (0, globals_1.test)("get Collection Achievements", async () => {
+        await api.getCollection("Achievements");
+        (0, globals_1.expect)(axios_1.default).toBeCalledWith({
+            method: "GET",
+            params: {},
+            responseEncoding: "utf8",
+            responseType: "json",
+            url: "https://biggamesapi.io/api/collection/Achievements",
+        });
+    });
+    (0, globals_1.describe)("get Clans", () => {
+        (0, globals_1.test)("defaults", async () => {
+            await api.getClans();
+            (0, globals_1.expect)(axios_1.default).toBeCalledWith({
+                method: "GET",
+                params: {
+                    page: 1,
+                    pageSize: 10,
+                    sort: "Points",
+                    sortOrder: "desc",
+                },
+                responseEncoding: "utf8",
+                responseType: "json",
+                url: "https://biggamesapi.io/api/clans",
+            });
+        });
+        (0, globals_1.test)("different options", async () => {
+            await api.getClans({
+                page: 1,
+                pageSize: 10,
+                sort: "Created",
+                sortOrder: "desc",
+            });
+            (0, globals_1.expect)(axios_1.default).toBeCalledWith({
+                method: "GET",
+                params: {
+                    page: 1,
+                    pageSize: 10,
+                    sort: "Created",
+                    sortOrder: "desc",
+                },
+                responseEncoding: "utf8",
+                responseType: "json",
+                url: "https://biggamesapi.io/api/clans",
+            });
+            await api.getClans({
+                page: 2,
+                sortOrder: "desc",
+            });
+            (0, globals_1.expect)(axios_1.default).toBeCalledWith({
+                method: "GET",
+                params: {
+                    page: 2,
+                    pageSize: 10,
+                    sort: "Points",
+                    sortOrder: "desc",
+                },
+                responseEncoding: "utf8",
+                responseType: "json",
+                url: "https://biggamesapi.io/api/clans",
+            });
+        });
+    });
+    (0, globals_1.test)("get Clan", async () => {
+        await api.getClan("CAT");
+        (0, globals_1.expect)(axios_1.default).toBeCalledWith({
+            method: "GET",
+            params: {},
+            responseEncoding: "utf8",
+            responseType: "json",
+            url: "https://biggamesapi.io/api/clan/CAT",
+        });
+    });
+    (0, globals_1.test)("get Exists", async () => {
+        await api.getExists();
+        (0, globals_1.expect)(axios_1.default).toBeCalledWith({
+            method: "GET",
+            params: {},
+            responseEncoding: "utf8",
+            responseType: "json",
+            url: "https://biggamesapi.io/api/exists",
+        });
+    });
+    (0, globals_1.test)("get RAP", async () => {
+        await api.getRAP();
+        (0, globals_1.expect)(axios_1.default).toBeCalledWith({
+            method: "GET",
+            params: {},
+            responseEncoding: "utf8",
+            responseType: "json",
+            url: "https://biggamesapi.io/api/rap",
+        });
+    });
+    (0, globals_1.test)("get ActiveClanBattle", async () => {
+        await api.getActiveClanBattle();
+        (0, globals_1.expect)(axios_1.default).toBeCalledWith({
+            method: "GET",
+            params: {},
+            responseEncoding: "utf8",
+            responseType: "json",
+            url: "https://biggamesapi.io/api/activeClanBattle",
+        });
+    });
+    (0, globals_1.test)("get Image", async () => {
+        await api.getImage("14615650278");
+        (0, globals_1.expect)(axios_1.default).toBeCalledWith({
+            method: "GET",
+            params: {},
+            responseEncoding: "BINARY",
+            responseType: "arraybuffer",
+            url: "https://biggamesapi.io/api/image/14615650278",
+        });
+        await api.getImage("rbxassetid://14976576332");
+        (0, globals_1.expect)(axios_1.default).toBeCalledWith({
+            method: "GET",
+            params: {},
+            responseEncoding: "BINARY",
+            responseType: "arraybuffer",
+            url: "https://biggamesapi.io/api/image/14976576332",
+        });
+    });
+});

package/dist/common.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ps99-api"), exports);

package/dist/params/clans.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/ps99-api.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PetSimulator99API = void 0;
+const axios_1 = require("./request-client/axios");
+class PetSimulator99API {
+    requestClient;
+    constructor(params) {
+        this.requestClient =
+            params && params.requestClient ? params.requestClient : (0, axios_1.getAxiosRequest)();
+    }
+    request(path, { params, responseType, responseEncoding, } = {
+        params: {},
+        responseType: "json",
+        responseEncoding: "utf8",
+    }) {
+        params = params || {};
+        responseType = responseType || "json";
+        responseEncoding = responseEncoding || "utf8";
+        return this.requestClient.send({
+            method: "GET",
+            url: `https://biggamesapi.io${path}`,
+            params,
+            responseType,
+            responseEncoding,
+        });
+    }
+    getCollections() {
+        return this.request("/api/collections");
+    }
+    getCollection(collection) {
+        return this.request(`/api/collection/${collection}`);
+    }
+    getClans(params) {
+        let page;
+        let pageSize;
+        let sort;
+        let sortOrder;
+        if (params) {
+            ({ page, pageSize, sort, sortOrder } = params);
+        }
+        params = {
+            page: page || 1,
+            pageSize: pageSize || 10,
+            sort: sort || "Points",
+            sortOrder: sortOrder || "desc",
+        };
+        return this.request("/api/clans", { params });
+    }
+    getClan(name) {
+        return this.request(`/api/clan/${name}`);
+    }
+    getExists() {
+        return this.request(`/api/exists`);
+    }
+    getRAP() {
+        return this.request(`/api/rap`);
+    }
+    getActiveClanBattle() {
+        return this.request(`/api/activeClanBattle`);
+    }
+    getImage(rbxassetid) {
+        if (rbxassetid.startsWith("rbxassetid://")) {
+            rbxassetid = rbxassetid.slice(13);
+        }
+        return this.request(`/api/image/${rbxassetid}`, {
+            responseType: "arraybuffer",
+            responseEncoding: "BINARY",
+        });
+    }
+}
+exports.PetSimulator99API = PetSimulator99API;

package/dist/request-client/axios.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAxiosRequest = void 0;
+const axios_1 = __importDefault(require("axios"));
+function getAxiosRequest(instance) {
+    return {
+        async send(options) {
+            try {
+                const { data } = await (instance ? instance(options) : (0, axios_1.default)(options));
+                return data;
+            }
+            catch (e) {
+                if (isAxiosError(e)) {
+                    const message = e?.response?.data?.message || e.message;
+                    throw new Error(`${options.method} ${options.url}: ${message}`);
+                }
+                throw e;
+            }
+        },
+    };
+}
+exports.getAxiosRequest = getAxiosRequest;
+function isAxiosError(err) {
+    return Object.prototype.hasOwnProperty.call(err, "isAxiosError");
+}

package/dist/request-client/common.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/responses/activeClanBattle.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/responses/clan.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/responses/clans.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/responses/collection.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/responses/collections.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/responses/exists.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/responses/rap.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "ps99-api",
+  "version": "1.0.0",
+  "description": "Pet Simulator Public API wrapper written in Typescript.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "joekiller",
+  "license": "MIT",
+  "scripts": {
+    "test": "npx jest",
+    "build": "npx tsc --project tsconfig.build.json",
+    "semantic-release": "npx semantic-release",
+    "format": "npx prettier --write \"src/**/*.ts\""
+  },
+  "keywords": [
+    "pet simulator 99"
+  ],
+  "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "@semantic-release/git": "^10.0.1",
+    "@tsconfig/node20": "^20.1.3",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.0.0",
+    "cz-conventional-changelog": "^3.3.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.2.5",
+    "semantic-release": "^23.0.6",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.4.3"
+  },
+  "dependencies": {
+    "axios": "^1.6.8"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/joekiller/node-ps99-api.git"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "release": {
+    "branches": [
+      "main"
+    ]
+  }
+}

package/src/__tests__/ps99-api.ts

@@ -0,0 +1,159 @@
+import { beforeEach, describe, expect, jest, test } from "@jest/globals";
+import axios from "axios";
+import { PetSimulator99API } from "../ps99-api";
+import { getAxiosRequest } from "../request-client/axios";
+
+jest.mock("axios");
+
+let api: PetSimulator99API;
+
+const mockedAxios = axios as jest.Mocked<typeof axios>;
+
+beforeEach(() => {
+  mockedAxios.mockClear();
+  mockedAxios.mockReturnValue(Promise.resolve({ data: {} }));
+  api = new PetSimulator99API({ requestClient: getAxiosRequest(mockedAxios) });
+});
+
+describe("Pet Simulator Public API Tests", () => {
+  test("get Collections", async () => {
+    await api.getCollections();
+    expect(axios).toBeCalledWith({
+      method: "GET",
+      params: {},
+      responseEncoding: "utf8",
+      responseType: "json",
+      url: "https://biggamesapi.io/api/collections",
+    });
+  });
+
+  test("get Collection Achievements", async () => {
+    await api.getCollection("Achievements");
+    expect(axios).toBeCalledWith({
+      method: "GET",
+      params: {},
+      responseEncoding: "utf8",
+      responseType: "json",
+      url: "https://biggamesapi.io/api/collection/Achievements",
+    });
+  });
+
+  describe("get Clans", () => {
+    test("defaults", async () => {
+      await api.getClans();
+      expect(axios).toBeCalledWith({
+        method: "GET",
+        params: {
+          page: 1,
+          pageSize: 10,
+          sort: "Points",
+          sortOrder: "desc",
+        },
+        responseEncoding: "utf8",
+        responseType: "json",
+        url: "https://biggamesapi.io/api/clans",
+      });
+    });
+
+    test("different options", async () => {
+      await api.getClans({
+        page: 1,
+        pageSize: 10,
+        sort: "Created",
+        sortOrder: "desc",
+      });
+      expect(axios).toBeCalledWith({
+        method: "GET",
+        params: {
+          page: 1,
+          pageSize: 10,
+          sort: "Created",
+          sortOrder: "desc",
+        },
+        responseEncoding: "utf8",
+        responseType: "json",
+        url: "https://biggamesapi.io/api/clans",
+      });
+
+      await api.getClans({
+        page: 2,
+        sortOrder: "desc",
+      });
+      expect(axios).toBeCalledWith({
+        method: "GET",
+        params: {
+          page: 2,
+          pageSize: 10,
+          sort: "Points",
+          sortOrder: "desc",
+        },
+        responseEncoding: "utf8",
+        responseType: "json",
+        url: "https://biggamesapi.io/api/clans",
+      });
+    });
+  });
+
+  test("get Clan", async () => {
+    await api.getClan("CAT");
+    expect(axios).toBeCalledWith({
+      method: "GET",
+      params: {},
+      responseEncoding: "utf8",
+      responseType: "json",
+      url: "https://biggamesapi.io/api/clan/CAT",
+    });
+  });
+
+  test("get Exists", async () => {
+    await api.getExists();
+    expect(axios).toBeCalledWith({
+      method: "GET",
+      params: {},
+      responseEncoding: "utf8",
+      responseType: "json",
+      url: "https://biggamesapi.io/api/exists",
+    });
+  });
+
+  test("get RAP", async () => {
+    await api.getRAP();
+    expect(axios).toBeCalledWith({
+      method: "GET",
+      params: {},
+      responseEncoding: "utf8",
+      responseType: "json",
+      url: "https://biggamesapi.io/api/rap",
+    });
+  });
+
+  test("get ActiveClanBattle", async () => {
+    await api.getActiveClanBattle();
+    expect(axios).toBeCalledWith({
+      method: "GET",
+      params: {},
+      responseEncoding: "utf8",
+      responseType: "json",
+      url: "https://biggamesapi.io/api/activeClanBattle",
+    });
+  });
+
+  test("get Image", async () => {
+    await api.getImage("14615650278");
+    expect(axios).toBeCalledWith({
+      method: "GET",
+      params: {},
+      responseEncoding: "BINARY",
+      responseType: "arraybuffer",
+      url: "https://biggamesapi.io/api/image/14615650278",
+    });
+    await api.getImage("rbxassetid://14976576332");
+    expect(axios).toBeCalledWith({
+      method: "GET",
+      params: {},
+      responseEncoding: "BINARY",
+      responseType: "arraybuffer",
+      url: "https://biggamesapi.io/api/image/14976576332",
+    });
+  });
+});

package/src/common.ts

@@ -0,0 +1,2 @@
+export type Collection<T = string> = T;
+export type ClanName = string;

package/src/index.ts

@@ -0,0 +1 @@
+export * from "./ps99-api";

package/src/params/clans.ts

@@ -0,0 +1,9 @@
+export type ClansSort = "DepositedDiamonds" | "Points" | "Created";
+export type SortOrder = "asc" | "desc";
+
+export type GetClansParams = {
+  page?: number;
+  pageSize?: number;
+  sort?: ClansSort;
+  sortOrder?: SortOrder;
+};