ps99-api 1.0.0 → 1.1.0

package/.github/actions/test/action.yml

@@ -0,0 +1,27 @@
+name: 'Test'
+description: 'Test the library'
+runs:
+  using: 'composite'
+  steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: "lts/*"
+    - name: Install dependencies
+      shell: bash
+      run: |
+        npm install -g npm@latest
+        npm ci
+    - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
+      shell: bash
+      run: npm audit signatures
+    - name: Test
+      shell: bash
+      run: npm run test
+    - name: Compile
+      shell: bash
+      run: npm run build

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

@@ -16,14 +16,14 @@ jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - name: Checkout
+        uses: actions/checkout@v4
         with:
-          node-version: 20
-      - run: npm ci
-      - run: npm run test
-      - run: npm run build
-      - env:
+          fetch-depth: 0
+      - name: Test
+        uses: ./.github/actions/test
+      - name: Release
+        env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: npx semantic-release

package/.github/workflows/test-on-branch.yml

@@ -0,0 +1,18 @@
+name: Test on Branch
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - '!main'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Test
+        uses: ./.github/actions/test

package/.idea/jsLibraryMappings.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="JavaScriptLibraryMappings">
+    <includedPredefinedLibrary name="Node.js Core" />
+  </component>
+</project>

package/README.md

@@ -21,5 +21,6 @@ await ps99api.getClan('CAT');
 
 ## 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/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./ps99-api";
+export * from "./request-client/common";
+export * from "./request-client/axios";
+export * from "./responses/collections";
+export * from "./responses/clan";
+export * from "./responses/clans";
+export * from "./params/clans";
+export * from "./responses/exists";
+export * from "./responses/rap";
+export * from "./responses/activeClanBattle";
+export * from "./responses/collection";

package/dist/index.js

@@ -15,3 +15,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ps99-api"), exports);
+__exportStar(require("./request-client/common"), exports);
+__exportStar(require("./request-client/axios"), exports);
+__exportStar(require("./responses/collections"), exports);
+__exportStar(require("./responses/clan"), exports);
+__exportStar(require("./responses/clans"), exports);
+__exportStar(require("./params/clans"), exports);
+__exportStar(require("./responses/exists"), exports);
+__exportStar(require("./responses/rap"), exports);
+__exportStar(require("./responses/activeClanBattle"), exports);
+__exportStar(require("./responses/collection"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,0DAAwC;AACxC,yDAAuC;AACvC,0DAAwC;AACxC,mDAAiC;AACjC,oDAAkC;AAClC,iDAA+B;AAC/B,qDAAmC;AACnC,kDAAgC;AAChC,+DAA6C;AAC7C,yDAAuC"}

package/dist/params/clans.d.ts

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

package/dist/params/clans.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=clans.js.map

package/dist/params/clans.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clans.js","sourceRoot":"","sources":["../../src/params/clans.ts"],"names":[],"mappings":""}

package/dist/ps99-api.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="node" />
+import { RequestClient } from "./request-client/common";
+import { CollectionsResponseBody } from "./responses/collections";
+import { Collection, GetCollectionResponse } from "./responses/collection";
+import { ClanResponseBody } from "./responses/clan";
+import { ClansResponseBody } from "./responses/clans";
+import { GetClansParams } from "./params/clans";
+import { ExistsResponseBody } from "./responses/exists";
+import { RAPResponseBody } from "./responses/rap";
+import { ActiveClanBattleResponseBody } from "./responses/activeClanBattle";
+export type PetSimulator99APIOptions = {
+    requestClient?: RequestClient;
+};
+export declare class PetSimulator99API {
+    requestClient: RequestClient;
+    constructor(params?: PetSimulator99APIOptions);
+    private request;
+    getCollections(): Promise<CollectionsResponseBody>;
+    getCollection<C extends Collection>(collection: C): Promise<GetCollectionResponse<C>>;
+    getClans(params?: GetClansParams): Promise<ClansResponseBody>;
+    getClan(name: string): Promise<ClanResponseBody>;
+    getExists(): Promise<ExistsResponseBody>;
+    getRAP(): Promise<RAPResponseBody>;
+    getActiveClanBattle(): Promise<ActiveClanBattleResponseBody>;
+    getImage(rbxassetid: string): Promise<Blob>;
+}

package/dist/ps99-api.js

@@ -69,3 +69,4 @@ class PetSimulator99API {
     }
 }
 exports.PetSimulator99API = PetSimulator99API;
+//# sourceMappingURL=ps99-api.js.map

package/dist/ps99-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ps99-api.js","sourceRoot":"","sources":["../src/ps99-api.ts"],"names":[],"mappings":";;;AACA,kDAAyD;AAazD,MAAa,iBAAiB;IACrB,aAAa,CAAgB;IAEpC,YAAY,MAAiC;QAC3C,IAAI,CAAC,aAAa;YAChB,MAAM,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAA,uBAAe,GAAE,CAAC;IAC9E,CAAC;IAEO,OAAO,CACb,IAAY,EACZ,EACE,MAAM,EACN,YAAY,EACZ,gBAAgB,MAKd;QACF,MAAM,EAAE,EAAE;QACV,YAAY,EAAE,MAAM;QACpB,gBAAgB,EAAE,MAAM;KACzB;QAED,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;QACtB,YAAY,GAAG,YAAY,IAAI,MAAM,CAAC;QACtC,gBAAgB,GAAG,gBAAgB,IAAI,MAAM,CAAC;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAI;YAChC,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,yBAAyB,IAAI,EAAE;YACpC,MAAM;YACN,YAAY;YACZ,gBAAgB;SACjB,CAAC,CAAC;IACL,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,OAAO,CAA0B,kBAAkB,CAAC,CAAC;IACnE,CAAC;IAED,aAAa,CAAuB,UAAa;QAC/C,OAAO,IAAI,CAAC,OAAO,CACjB,mBAAmB,UAAU,EAAE,CAChC,CAAC;IACJ,CAAC;IAED,QAAQ,CAAC,MAAuB;QAC9B,IAAI,IAAwB,CAAC;QAC7B,IAAI,QAA4B,CAAC;QACjC,IAAI,IAA2B,CAAC;QAChC,IAAI,SAAgC,CAAC;QACrC,IAAI,MAAM,EAAE,CAAC;YACX,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,GAAG;YACP,IAAI,EAAE,IAAI,IAAI,CAAC;YACf,QAAQ,EAAE,QAAQ,IAAI,EAAE;YACxB,IAAI,EAAE,IAAI,IAAI,QAAQ;YACtB,SAAS,EAAE,SAAS,IAAI,MAAM;SAC/B,CAAC;QACF,OAAO,IAAI,CAAC,OAAO,CAAoB,YAAY,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,OAAO,CAAC,IAAY;QAClB,OAAO,IAAI,CAAC,OAAO,CAAmB,aAAa,IAAI,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAqB,aAAa,CAAC,CAAC;IACzD,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,OAAO,CAAkB,UAAU,CAAC,CAAC;IACnD,CAAC;IAED,mBAAmB;QACjB,OAAO,IAAI,CAAC,OAAO,CAA+B,uBAAuB,CAAC,CAAC;IAC7E,CAAC;IAED,QAAQ,CAAC,UAAkB;QACzB,IAAI,UAAU,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;YAC3C,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAO,cAAc,UAAU,EAAE,EAAE;YACpD,YAAY,EAAE,aAAa;YAC3B,gBAAgB,EAAE,QAAQ;SAC3B,CAAC,CAAC;IACL,CAAC;CACF;AAxFD,8CAwFC"}

package/dist/request-client/axios.d.ts

@@ -0,0 +1,3 @@
+import { AxiosInstance } from "axios";
+import { RequestClient } from "./common";
+export declare function getAxiosRequest(instance?: AxiosInstance): RequestClient;

package/dist/request-client/axios.js

@@ -26,3 +26,4 @@ exports.getAxiosRequest = getAxiosRequest;
 function isAxiosError(err) {
     return Object.prototype.hasOwnProperty.call(err, "isAxiosError");
 }
+//# sourceMappingURL=axios.js.map

package/dist/request-client/axios.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"axios.js","sourceRoot":"","sources":["../../src/request-client/axios.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAyD;AAGzD,SAAgB,eAAe,CAAC,QAAwB;IACtD,OAAO;QACL,KAAK,CAAC,IAAI,CAAI,OAAyB;YACrC,IAAI,CAAC;gBACH,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAA,eAAK,EAAC,OAAO,CAAC,CAAC,CAAC;gBAEvE,OAAO,IAAS,CAAC;YACnB,CAAC;YAAC,OAAO,CAAU,EAAE,CAAC;gBACpB,IAAI,YAAY,CAAuB,CAAC,CAAC,EAAE,CAAC;oBAC1C,MAAM,OAAO,GAAW,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC;oBAChE,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,GAAG,KAAK,OAAO,EAAE,CAAC,CAAC;gBAClE,CAAC;gBAED,MAAM,CAAC,CAAC;YACV,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAjBD,0CAiBC;AAED,SAAS,YAAY,CACnB,GAAoC;IAEpC,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;AACnE,CAAC"}

package/dist/request-client/common.d.ts

@@ -0,0 +1,18 @@
+export type ApiRequestParams = {
+    method: "GET" | "POST" | "DELETE" | "PATCH";
+    url: string;
+    params?: {
+        [key: string]: any;
+    };
+    data?: {
+        [key: string]: any;
+    };
+    headers?: {
+        [key: string]: any;
+    };
+    responseType?: "json" | "arraybuffer";
+    responseEncoding?: "utf8" | "BINARY";
+};
+export type RequestClient = {
+    send<T>(options: ApiRequestParams): Promise<T>;
+};

package/dist/request-client/common.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=common.js.map

package/dist/request-client/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/request-client/common.ts"],"names":[],"mappings":""}

package/dist/responses/activeClanBattle.d.ts

@@ -0,0 +1,37 @@
+export type ActiveBattleData = {
+    _id: string;
+    category: string;
+    configData: ActiveBattleConfigData;
+    configName: string;
+};
+export type ActiveBattleConfigData = {
+    FinishTime: number;
+    PlacementRewards: ActiveBattlePlacementReward[];
+    Rewards: ActiveBattleRewards;
+    StartTime: number;
+    Title: string;
+    _id: string;
+    _script: any;
+};
+export type ActiveBattlePlacementReward = {
+    Best: number;
+    Item: ActiveBattleItem;
+    Worst: number;
+};
+export type ActiveBattleItem = {
+    _data: ActiveBattleItemData;
+};
+export type ActiveBattleItemData = {
+    id: string;
+    pt?: number;
+};
+export type ActiveBattleRewards = {
+    Bronze: any[];
+    Gold: any[];
+    Good: any[];
+    Silver: any[];
+};
+export type ActiveClanBattleResponseBody = {
+    status: string;
+    data: ActiveBattleData;
+};

package/dist/responses/activeClanBattle.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=activeClanBattle.js.map

package/dist/responses/activeClanBattle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"activeClanBattle.js","sourceRoot":"","sources":["../../src/responses/activeClanBattle.ts"],"names":[],"mappings":""}

package/dist/responses/clan.d.ts

@@ -0,0 +1,83 @@
+export type ClanResponseBody = {
+    Battles: Battles;
+    BronzeMedals: number;
+    CountryCode: string;
+    Created: number;
+    DepositedDiamonds: number;
+    Desc: string;
+    DiamondContributions: DiamondContributions;
+    GoodMedals: number;
+    GuildLevel: number;
+    Icon: string;
+    LastKickTimestamp: number;
+    MemberCapacity: number;
+    Members: Member[];
+    Name: string;
+    OfficerCapacity: number;
+    Owner: number;
+    SilverMedals: number;
+    Status: string;
+    StatusTimestamp: number;
+    StatusUsername: string;
+};
+export type Battles = {
+    [key: string]: PointsBattle | GoalBattle;
+};
+export type PointsBattle = {
+    AwardUserIDs: number[];
+    BattleID: string;
+    EarnedMedal?: string;
+    Place?: number;
+    PointContributions: PointContribution[];
+    Points: number;
+    ProcessedAwards: boolean;
+};
+export type PointContribution = {
+    Points: number;
+    UserID: number;
+};
+export type GoalBattle = {
+    AwardUserIDs: any[];
+    BattleID: string;
+    EarnedMedal?: string;
+    Goals: Goal[];
+    Place?: number;
+    PointContributions: PointContribution[];
+    Points: number;
+    ProcessedAwards: boolean;
+};
+export type Goal = {
+    Amount: number;
+    Contributions: Contributions;
+    Progress: number;
+    Stars: number;
+    Tier: number;
+    Type: number;
+};
+export type Contributions = {
+    [key: string]: number;
+};
+export type HackerBattle = {
+    AwardUserIDs: any[];
+    BattleID: string;
+    Place: number;
+    PointContributions: PointContribution[];
+    Points: number;
+    ProcessedAwards: boolean;
+};
+export type DiamondContributions = {
+    AllTime: AllTime;
+};
+export type AllTime = {
+    Data: Daum[];
+    Sum: number;
+};
+export type Daum = {
+    Diamonds: number;
+    UserID: number;
+};
+export type Member = {
+    JoinTime: number;
+    PermissionLevel: number;
+    UserID: number;
+};

package/dist/responses/clan.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=clan.js.map

package/dist/responses/clan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clan.js","sourceRoot":"","sources":["../../src/responses/clan.ts"],"names":[],"mappings":""}

package/dist/responses/clans.d.ts

@@ -0,0 +1,14 @@
+export type ClansData = {
+    CountryCode: string;
+    Created: number;
+    DepositedDiamonds: number;
+    Icon: string;
+    MemberCapacity: number;
+    Members: number;
+    Name: string;
+    Points: number;
+};
+export type ClansResponseBody = {
+    status: string;
+    data: ClansData[];
+};

package/dist/responses/clans.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=clans.js.map

package/dist/responses/clans.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clans.js","sourceRoot":"","sources":["../../src/responses/clans.ts"],"names":[],"mappings":""}