@communityox/ox_core 1.5.3

package/package/types/index.d.ts

@@ -0,0 +1,178 @@
+export type Dict<T> = {
+    [key: string]: T;
+};
+export interface Character {
+    charId: number;
+    stateId: string;
+    firstName: string;
+    lastName: string;
+    gender: string;
+    x?: number;
+    y?: number;
+    z?: number;
+    heading?: number;
+    lastPlayed?: string;
+    health?: number;
+    armour?: number;
+    isNew?: boolean;
+}
+export interface NewCharacter {
+    firstName: string;
+    lastName: string;
+    gender: string;
+    date: number;
+}
+export interface PlayerMetadata {
+    name: string;
+    firstName: string;
+    lastName: string;
+    gender: string;
+    dateOfBirth: string;
+    phoneNumber: string;
+    activeGroup?: string;
+}
+export interface CharacterLicense {
+    issued: number;
+    suspended?: [number, number];
+    [key: string]: any;
+}
+export type Vehicles = Dict<VehicleData>;
+export type VehicleCategories = 'air' | 'land' | 'sea';
+export type TopVehicleStats = Record<VehicleCategories, VehicleStats>;
+export interface VehicleStats {
+    acceleration: number;
+    braking: number;
+    handling: number;
+    speed: number;
+    traction: number;
+}
+export declare enum VehicleClasses {
+    COMPACT = 0,
+    SEDAN = 1,
+    SUV = 2,
+    COUPE = 3,
+    MUSCLE = 4,
+    SPORTS_CLASSIC = 5,
+    SPORTS = 6,
+    SUPER = 7,
+    MOTORCYCLE = 8,
+    OFFROAD = 9,
+    INDUSTRIAL = 10,
+    UTILITY = 11,
+    VANS = 12,
+    CYCLES = 13,
+    BOATS = 14,
+    HELICOPTERS = 15,
+    PLANES = 16,
+    SERVICE = 17,
+    EMERGENCY = 18,
+    MILITARY = 19,
+    COMMERCIAL = 20,
+    TRAINS = 21,
+    OPEN_WHEEL = 22
+}
+export type VehicleTypes = 'amphibious_automobile' | 'amphibious_quadbike' | 'automobile' | 'bicycle' | 'bike' | 'blimp' | 'boat' | 'heli' | 'plane' | 'quadbike' | 'submarine' | 'submarinecar' | 'trailer' | 'train';
+export interface VehicleData extends VehicleStats {
+    class: VehicleClasses;
+    doors: number;
+    make: string;
+    name: string;
+    price: number;
+    seats: number;
+    type: VehicleTypes;
+    category: VehicleCategories;
+    weapons?: true;
+    [key: string]: unknown;
+}
+export interface OxLicense {
+    name?: string;
+    label?: string;
+}
+export interface OxStatus {
+    name: string;
+    default: number;
+    onTick: number;
+}
+export interface OxAccountMetadata {
+    id: number;
+    balance: number;
+    isDefault: boolean;
+    label: string;
+    type: 'personal' | 'shared' | 'group';
+    owner?: number;
+    group?: string;
+}
+export interface OxAccountUserMetadata extends OxAccountMetadata {
+    role: OxAccountRole;
+    ownerName: string;
+}
+export interface DbGroup {
+    name: string;
+    label: string;
+    grades: string[];
+    accountRoles: Dict<OxAccountRole>;
+    type?: string;
+    colour?: number;
+    hasAccount: boolean;
+}
+export interface OxGroup extends DbGroup {
+    grades: string[];
+    principal: string;
+}
+export interface CreateGroupProperties {
+    name: string;
+    label: string;
+    grades: {
+        label: string;
+        accountRole?: OxAccountRole;
+    }[];
+    type?: string;
+    colour?: number;
+    hasAccount?: boolean;
+}
+export interface OxGroupPermissions {
+    [grade: string]: {
+        [permission: string]: boolean;
+    };
+}
+export type OxAccountRole = 'viewer' | 'contributor' | 'manager' | 'owner';
+export interface OxAccountPermissions {
+    deposit: boolean;
+    withdraw: boolean;
+    addUser: boolean;
+    removeUser: boolean;
+    manageUser: boolean;
+    transferOwnership: boolean;
+    viewHistory: boolean;
+    manageAccount: boolean;
+    closeAccount: boolean;
+    sendInvoice: boolean;
+    payInvoice: boolean;
+}
+export interface OxAccountInvoice {
+    id: number;
+    actorId?: number;
+    payerId?: number;
+    fromAccount: number;
+    toAccount: number;
+    amount: number;
+    message?: string;
+    sentAt: number;
+    dueDate: number;
+    paidAt?: number;
+}
+export interface OxCreateInvoice {
+    actorId?: number;
+    fromAccount: number;
+    toAccount: number;
+    amount: number;
+    message: string;
+    dueDate: string;
+}
+export interface BanDetails {
+    userId: number;
+    token?: string;
+    reason?: string;
+    banned_at: number;
+    unban_at?: number;
+}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@communityox/ox_core",
+  "author": "Overextended",
+  "version": "1.5.3",
+  "license": "LGPL-3.0-or-later",
+  "description": "A modern FiveM framework.",
+  "type": "module",
+  "files": [
+    "./tsconfig.json",
+    "./package/**/*.js",
+    "./package/**/*.d.ts"
+  ],
+  "exports": {
+    ".": "./package/lib/index.js",
+    "./client": "./package/lib/client/index.js",
+    "./server": "./package/lib/server/index.js"
+  },
+  "scripts": {
+    "build": "node build.js",
+    "watch": "node build.js --watch",
+    "format": "pnpm biome format --write",
+    "lint": "pnpm biome lint --write"
+  },
+  "keywords": [
+    "fivem",
+    "ox_core",
+    "ox",
+    "overextended",
+    "communityox"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/communityox/ox_core.git"
+  },
+  "bugs": "https://github.com/communityox/ox_core/issues",
+  "devDependencies": {
+    "@citizenfx/client": "latest",
+    "@citizenfx/server": "latest",
+    "@communityox/fx-utils": "^0.0.4",
+    "@types/node": "^22.13.10",
+    "esbuild": "^0.23.1",
+    "tsc-alias": "^1.8.11",
+    "typescript": "^5.8.2"
+  },
+  "dependencies": {
+    "@biomejs/biome": "^1.9.4",
+    "@nativewrappers/fivem": "^0.0.86",
+    "@nativewrappers/server": "^0.0.86",
+    "@communityox/ox_lib": "^3.29.0",
+    "mariadb": "^3.4.1"
+  },
+  "engines": {
+    "node": ">=22.9.0"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": ".",
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "module": "es2022",
+    "target": "es2023",
+    "lib": ["es2023", "esnext.disposable"],
+    "types": ["@citizenfx/client", "@citizenfx/server"],
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "allowUnreachableCode": false,
+    "strictFunctionTypes": true,
+    "moduleResolution": "bundler",
+    "noImplicitThis": true,
+    "noUnusedLocals": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "noEmit": false,
+    "emitDeclarationOnly": true,
+    "removeComments": true,
+    "outDir": "./package/"
+  },
+  "include": ["./", "./types/"],
+  "references": [{ "path": "./lib" }]
+}