Merge branch 'main' of https://github.com/Battlefield6/API

Author: Bizarrus

.claude/settings.local.json

@@ -0,0 +1,58 @@
+name: Build Documentation
+
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout main repository
+        uses: actions/checkout@v4
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '24.1.0'
+      
+      - name: Cache protoc
+        id: cache-protoc
+        uses: actions/cache@v4
+        with:
+          path: |
+            /usr/bin/protoc
+            /usr/include/google
+          key: ${{ runner.os }}-protoc-3
+      
+      - name: Install Protocol Buffers Compiler
+        if: steps.cache-protoc.outputs.cache-hit != 'true'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y protobuf-compiler
+      
+      - name: Verify protoc installation
+        run: protoc --version
+      
+      - name: Checkout Wiki repository
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ github.repository }}.wiki
+          path: .wiki
+          token: ${{ secrets.GITHUB_TOKEN }}
+      
+      - name: Install dependencies
+        run: npm install
+      
+      - name: Generate documentation
+        run: npm run docs
+      
+      - name: Commit and push wiki changes
+        run: |
+          cd .wiki
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add .
+          git diff --quiet && git diff --staged --quiet || (git commit -m "Automatical update Wiki" && git push)

.github/workflows/documentation.yml

@@ -3,11 +3,33 @@
  * @since       1.0.0
  */
 
+/**
+* Represents the type of an creator.
+*/
 const enum CreatorType {
+    /**
+     * Unknown creator type.
+     */
     UNKNOWN,
+
+    /**
+     * Represents a player creator (for example, a normal user)
+     */
     PLAYER,
+
+    /**
+     * Represents an internal creator (for sample DICE, EA,..)
+     */
     INTERNAL,
+
+    /**
+     * Represents an external creator (for example, a third-party company working for DICE, EA...)
+     */
     EXTERNAL,
+
+    /**
+     * Represents a trusted creator (for example, a verified content creator)
+     */
     TRUSTED
 }
 

src/enums/CreatorType.ts

@@ -9,38 +9,84 @@ export default class Creator {
     private type: CreatorType = CreatorType.UNKNOWN;
     private data: any = null;
 
+    /**
+     * Gets the type of the creator.
+     * 
+     * @returns The type of the creator.
+     */
     public getType(): CreatorType {
         return this.type;
     }
 
+    /**
+     * Sets the type of the creator.
+     * 
+     * @param type The type of the creator.
+     */
     public setType(type: CreatorType): void {
         this.type = type;
     }
 
+    /**
+     * Gets the data of the creator.
+     * 
+     * @returns The data of the creator.
+     */
     public getData(): any {
         return this.data;
     }
 
+    /**
+     * Sets the data of the creator.
+     * 
+     * @param data The data of the creator.
+     */
     public setData(data: any): void {
         this.data = data;
     }
 
+    /**
+     * Checks if the creator is a player.
+     * 
+     * @returns True if the creator is a player, false otherwise.
+     */
     public isPlayer(): boolean {
         return this.type === CreatorType.PLAYER;
     }
 
+    /**
+     * Checks if the creator is an internal creator.
+     * 
+     * @returns True if the creator is an internal creator, false otherwise.
+     */
     public isInternal(): boolean {
         return this.type === CreatorType.INTERNAL;
     }
 
+    /**
+     * Checks if the creator is an external creator.
+     * 
+     * @returns True if the creator is an external creator, false otherwise.
+     */
     public isExternal(): boolean {
         return this.type === CreatorType.EXTERNAL;
     }
 
+    /**
+     * Checks if the creator is a trusted creator.
+     * 
+     * @returns True if the creator is a trusted creator, false otherwise.
+     */
     public isTrusted(): boolean {
         return this.type === CreatorType.TRUSTED;
     }
 
+    /**
+     * Populates the creator from a JSON object.
+     * 
+     * @param json The JSON object.
+     * @returns The populated creator.
+     */
     public fromJSON(json: any): Creator {
         if(json.playerCreator) {
             this.type = CreatorType.PLAYER;
@@ -59,6 +105,11 @@ export default class Creator {
         return this;
     }
 
+    /**
+     * Converts the creator to a JSON object.
+     * 
+     * @returns The JSON object.
+     */
     public toJSON(): any {
         const result: any = {};