@meowpanel/api 0.1.0-alpha.11 → 1.0.0-beta.2

package/script/src/resources/members.d.ts

@@ -0,0 +1,138 @@
+import type { HttpClient } from '../http.js';
+import { ResourceNamespace } from '../namespace.js';
+import { ReactiveResource } from '../reactive.js';
+import type { IncludeOptions, ResourceWith } from '../types.js';
+import { type ISODate, type NanoID, type Paginated } from '../types.js';
+/** Raw API response shape for a member (user). @internal */
+export interface MemberData {
+    id: string;
+    issuer_type: 'user';
+    email: string;
+    nickname: string | null;
+    avatar_uri: string | null;
+    display?: {
+        language: string | null;
+        theme: string | null;
+    } | null;
+    permissions?: string[];
+    created_at: ISODate;
+    updated_at: ISODate;
+}
+/** Display preferences for a member. */
+export interface MemberDisplay {
+    /** The member's preferred UI language code. */
+    language: string | null;
+    /** The member's preferred UI theme identifier. */
+    theme: string | null;
+}
+/**
+ * A MeowPanel user account (member).
+ *
+ * Retrieved via {@link MembersNamespace.get} or {@link MembersNamespace.list}.
+ */
+export declare class Member extends ReactiveResource {
+    /** The member's unique NanoID. */
+    readonly id: NanoID;
+    /** Always `'user'` for member accounts. */
+    issuerType: 'user';
+    /** The member's login email address. */
+    email: string;
+    /** The member's display nickname. */
+    nickname: string | null;
+    /** URL of the member's avatar image, or `null` if no avatar is set. */
+    avatarUri: string | null;
+    /** Display preferences (language and theme). */
+    display: MemberDisplay | null | undefined;
+    /** The member's assigned permission scopes. */
+    permissions: string[] | undefined;
+    /** When this member account was created. */
+    createdAt: Date;
+    /** When this member account was last updated. */
+    updatedAt: Date;
+    /** @internal */
+    constructor(data: MemberData);
+    /**
+     * Apply raw API data to this member instance, updating all mutable fields.
+     *
+     * Called by the constructor and by {@link MembersNamespace.update} to update the instance in-place.
+     */
+    applyData(data: MemberData): void;
+}
+/** Fields that can be updated on a member. All fields are optional. */
+export interface UpdateMemberPayload {
+    /** New email address for the member. */
+    email?: string;
+    /** New display nickname. */
+    nickname?: string;
+    /** Display preference updates. */
+    display?: {
+        /** UI language code, or `null` to clear. */
+        language?: string | null;
+        /** UI theme identifier, or `null` to clear. */
+        theme?: string | null;
+    };
+}
+/** Valid include keys for member endpoints. */
+export type MemberInclude = 'display' | 'permissions';
+/** Maps each {@link MemberInclude} key to the field(s) it guarantees on the {@link Member} instance. */
+interface MemberIncludeMap {
+    display: {
+        display: MemberDisplay | null;
+    };
+    permissions: {
+        permissions: string[];
+    };
+}
+/** A {@link Member} with specific include fields guaranteed to be populated. */
+export type MemberWith<I extends readonly MemberInclude[] = []> = ResourceWith<Member, MemberIncludeMap, I>;
+/** Typed events emitted by {@link MembersNamespace}. */
+export interface MemberEvents {
+    /** Fired after a member is successfully updated. */
+    updated: Member;
+}
+/**
+ * Namespace for member (user) management.
+ *
+ * Access via `api.members`.
+ *
+ * @example
+ * ```ts ignore
+ * // Reactive store
+ * // {#each $api.members as member} ... {/each}
+ *
+ * // Imperative
+ * const members = await api.members.list();
+ * const member = await api.members.get(id);
+ * await api.members.update(id, { nickname: 'newname' });
+ * ```
+ */
+export declare class MembersNamespace extends ResourceNamespace<Member, MemberEvents> {
+    /** @internal */
+    constructor(http: HttpClient);
+    /**
+     * Fetch a paginated list of all members.
+     *
+     * @param opts Pagination, search, and include options.
+     */
+    list<const I extends readonly MemberInclude[] = []>(opts?: {
+        page?: number;
+        perPage?: number;
+        search?: string;
+    } & IncludeOptions<MemberInclude, I>): Promise<Paginated<MemberWith<I>>>;
+    /**
+     * Fetch a single member by ID.
+     *
+     * @param id   The member's NanoID.
+     * @param opts Include options.
+     */
+    get<const I extends readonly MemberInclude[] = []>(id: NanoID, opts?: IncludeOptions<MemberInclude, I>): Promise<MemberWith<I>>;
+    /**
+     * Update a member's profile fields.
+     *
+     * @param id      The member's NanoID.
+     * @param payload The fields to update.
+     */
+    update(id: NanoID, payload: UpdateMemberPayload): Promise<Member>;
+}
+export {};
+//# sourceMappingURL=members.d.ts.map

package/script/src/resources/members.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"members.d.ts","sourceRoot":"","sources":["../../../src/src/resources/members.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EAAE,KAAK,OAAO,EAAgB,KAAK,MAAM,EAAE,KAAK,SAAS,EAAY,MAAM,aAAa,CAAC;AAEhG,4DAA4D;AAC5D,MAAM,WAAW,UAAU;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,OAAO,CAAC,EAAE;QACT,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KACrB,GAAG,IAAI,CAAC;IACT,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,wCAAwC;AACxC,MAAM,WAAW,aAAa;IAC7B,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,kDAAkD;IAClD,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED;;;;GAIG;AACH,qBAAa,MAAO,SAAQ,gBAAgB;IAC3C,kCAAkC;IAClC,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,2CAA2C;IACpC,UAAU,EAAG,MAAM,CAAC;IAC3B,wCAAwC;IACjC,KAAK,EAAG,MAAM,CAAC;IACtB,qCAAqC;IAC9B,QAAQ,EAAG,MAAM,GAAG,IAAI,CAAC;IAChC,uEAAuE;IAChE,SAAS,EAAG,MAAM,GAAG,IAAI,CAAC;IACjC,gDAAgD;IACzC,OAAO,EAAE,aAAa,GAAG,IAAI,GAAG,SAAS,CAAC;IACjD,+CAA+C;IACxC,WAAW,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACzC,4CAA4C;IACrC,SAAS,EAAG,IAAI,CAAC;IACxB,iDAAiD;IAC1C,SAAS,EAAG,IAAI,CAAC;IAExB,gBAAgB;gBACG,IAAI,EAAE,UAAU;IAOnC;;;;OAIG;IACI,SAAS,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI;CAWxC;AAED,uEAAuE;AACvE,MAAM,WAAW,mBAAmB;IACnC,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,OAAO,CAAC,EAAE;QACT,4CAA4C;QAC5C,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB,CAAC;CACF;AAED,+CAA+C;AAC/C,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,aAAa,CAAC;AAEtD,wGAAwG;AACxG,UAAU,gBAAgB;IACzB,OAAO,EAAE;QAAE,OAAO,EAAE,aAAa,GAAG,IAAI,CAAA;KAAE,CAAC;IAC3C,WAAW,EAAE;QAAE,WAAW,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;CACvC;AAED,gFAAgF;AAChF,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,SAAS,aAAa,EAAE,GAAG,EAAE,IAAI,YAAY,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAE5G,wDAAwD;AACxD,MAAM,WAAW,YAAY;IAC5B,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,gBAAiB,SAAQ,iBAAiB,CAAC,MAAM,EAAE,YAAY,CAAC;IAC5E,gBAAgB;gBACG,IAAI,EAAE,UAAU;IAInC;;;;OAIG;IACU,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,SAAS,aAAa,EAAE,GAAG,EAAE,EAC9D,IAAI,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,cAAc,CAAC,aAAa,EAAE,CAAC,CAIxD,GAClC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IAWpC;;;;;OAKG;IACU,GAAG,CAAC,KAAK,CAAC,CAAC,SAAS,SAAS,aAAa,EAAE,GAAG,EAAE,EAC7D,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,cAAc,CAAC,aAAa,EAAE,CAAC,CAAM,GACzC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAQzB;;;;;OAKG;IACU,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;CAc9E"}

package/script/src/resources/members.js

@@ -0,0 +1,127 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MembersNamespace = exports.Member = void 0;
+const namespace_js_1 = require("../namespace.js");
+const reactive_js_1 = require("../reactive.js");
+const types_js_1 = require("../types.js");
+/**
+ * A MeowPanel user account (member).
+ *
+ * Retrieved via {@link MembersNamespace.get} or {@link MembersNamespace.list}.
+ */
+class Member extends reactive_js_1.ReactiveResource {
+    /** The member's unique NanoID. */
+    id;
+    /** Always `'user'` for member accounts. */
+    issuerType;
+    /** The member's login email address. */
+    email;
+    /** The member's display nickname. */
+    nickname;
+    /** URL of the member's avatar image, or `null` if no avatar is set. */
+    avatarUri;
+    /** Display preferences (language and theme). */
+    display;
+    /** The member's assigned permission scopes. */
+    permissions;
+    /** When this member account was created. */
+    createdAt;
+    /** When this member account was last updated. */
+    updatedAt;
+    /** @internal */
+    constructor(data) {
+        super();
+        this.id = (0, types_js_1.toNanoID)(data.id);
+        this.issuerType = data.issuer_type;
+        this.applyData(data);
+    }
+    /**
+     * Apply raw API data to this member instance, updating all mutable fields.
+     *
+     * Called by the constructor and by {@link MembersNamespace.update} to update the instance in-place.
+     */
+    applyData(data) {
+        this.issuerType = data.issuer_type;
+        this.email = data.email;
+        this.nickname = data.nickname;
+        this.avatarUri = data.avatar_uri;
+        this.display = data.display ?? undefined;
+        this.permissions = data.permissions;
+        this.createdAt = new Date(data.created_at);
+        this.updatedAt = new Date(data.updated_at);
+        this.notify();
+    }
+}
+exports.Member = Member;
+/**
+ * Namespace for member (user) management.
+ *
+ * Access via `api.members`.
+ *
+ * @example
+ * ```ts ignore
+ * // Reactive store
+ * // {#each $api.members as member} ... {/each}
+ *
+ * // Imperative
+ * const members = await api.members.list();
+ * const member = await api.members.get(id);
+ * await api.members.update(id, { nickname: 'newname' });
+ * ```
+ */
+class MembersNamespace extends namespace_js_1.ResourceNamespace {
+    /** @internal */
+    constructor(http) {
+        super(http);
+    }
+    /**
+     * Fetch a paginated list of all members.
+     *
+     * @param opts Pagination, search, and include options.
+     */
+    async list(opts = {}) {
+        const extra = {};
+        const include = (0, types_js_1.joinIncludes)(opts);
+        if (include)
+            extra['include'] = include;
+        const result = await this.http.list('/members', opts, extra);
+        const members = result.data.map((d) => new Member(d));
+        this.setCache(members);
+        return { ...result, data: members };
+    }
+    /**
+     * Fetch a single member by ID.
+     *
+     * @param id   The member's NanoID.
+     * @param opts Include options.
+     */
+    async get(id, opts = {}) {
+        const params = {};
+        const include = (0, types_js_1.joinIncludes)(opts);
+        if (include)
+            params['include'] = include;
+        const data = await this.http.get(`/members/${id}`, { params });
+        return new Member(data);
+    }
+    /**
+     * Update a member's profile fields.
+     *
+     * @param id      The member's NanoID.
+     * @param payload The fields to update.
+     */
+    async update(id, payload) {
+        const data = await this.http.patch(`/members/${id}`, payload);
+        const existing = this.cache.find((m) => m.id === id);
+        if (existing) {
+            existing.applyData(data);
+            this.upsertCache(existing);
+            this.emit('updated', existing);
+            return existing;
+        }
+        const member = new Member(data);
+        this.upsertCache(member);
+        this.emit('updated', member);
+        return member;
+    }
+}
+exports.MembersNamespace = MembersNamespace;

package/script/src/resources/nodes.d.ts

@@ -0,0 +1,397 @@
+import type { HttpClient } from '../http.js';
+import { ResourceNamespace } from '../namespace.js';
+import { ReactiveResource } from '../reactive.js';
+import type { IncludeOptions, ResourceWith } from '../types.js';
+import { type ISODate, type NanoID, type Paginated } from '../types.js';
+import type { MemberData } from './members.js';
+import { Member } from './members.js';
+import type { ActivityLogData } from './servers/types.js';
+import { ActivityLog } from './servers/activity.js';
+/** Raw API response for a node location. @internal */
+export interface NodeLocationData {
+    id: string;
+    name: string;
+    short: string;
+    notes?: string | null;
+    owner?: MemberData;
+    created_at: ISODate;
+    updated_at: ISODate;
+}
+/** Raw API response for a node type (classification). @internal */
+export interface NodeTypeData {
+    id: string;
+    name: string;
+    short: string;
+    notes?: string | null;
+    owner?: MemberData;
+    created_at: ISODate;
+    updated_at: ISODate;
+}
+/** Raw API response for a physical host. @internal */
+export interface NodeHostData {
+    id: string;
+    hostname: string;
+    name?: string;
+    color?: string;
+    notes?: string | null;
+    owner?: MemberData;
+    created_at: ISODate;
+    updated_at: ISODate;
+}
+/** Raw API response for a node. @internal */
+export interface NodeData {
+    id: string;
+    name: string;
+    description: string | null;
+    owner?: MemberData;
+    location: NodeLocationData;
+    type: NodeTypeData;
+    num: number;
+    limits: {
+        memory_mb: number;
+        memory_overallocate_mb: number;
+        disk_mb: number;
+        disk_overallocate_mb: number;
+        upload_size_mb: number;
+    };
+    /** @see NodeConnection */
+    connection?: {
+        url: string;
+        scheme: string;
+        fqdn: string;
+        port: number;
+    } | null;
+    is_maintenance_mode: boolean;
+    can_auto_deploy: boolean;
+    is_behind_proxy: boolean;
+    notes?: string | null;
+    created_at: ISODate;
+    updated_at: ISODate;
+}
+/** Raw API response for a node allocation port. @internal */
+export interface NodeAllocationPortData {
+    id: string;
+    ip: string;
+    port: number;
+    ready_protocols: Array<'tcp' | 'udp'>;
+    is_in_use: boolean;
+    notes?: string | null;
+    created_at: ISODate;
+    updated_at: ISODate;
+}
+/** Raw API response for a node allocation IP. @internal */
+export interface NodeAllocationIpData {
+    id: string;
+    ip: string;
+    ipAlias?: string | null;
+    ports: NodeAllocationPortData[];
+    node: NodeData;
+    notes?: string | null;
+    created_at: ISODate;
+    updated_at: ISODate;
+}
+/**
+ * A geographic location associated with one or more nodes.
+ */
+export declare class NodeLocation extends ReactiveResource {
+    /** Unique NanoID of this location. */
+    readonly id: NanoID;
+    /** Full display name of the location, e.g. `"US East"`. */
+    name: string;
+    /** Short code used in node name generation, e.g. `"use"`. */
+    short: string;
+    /** Internal notes. */
+    notes: string | null | undefined;
+    /** Owner of this location record. */
+    owner: Member | undefined;
+    /** When this location was created. */
+    createdAt: Date;
+    /** When this location was last updated. */
+    updatedAt: Date;
+    /** @internal */
+    constructor(data: NodeLocationData);
+}
+/**
+ * A classification type for nodes (e.g. `"Apex"`, `"Shared"`).
+ */
+export declare class NodeType extends ReactiveResource {
+    /** Unique NanoID of this node type. */
+    readonly id: NanoID;
+    /** Full display name of the node type, e.g. `"Apex"`. */
+    name: string;
+    /** Short code used in node name generation, e.g. `"a"`. */
+    short: string;
+    /** Internal notes. */
+    notes: string | null | undefined;
+    /** Owner of this type record. */
+    owner: Member | undefined;
+    /** When this type was created. */
+    createdAt: Date;
+    /** When this type was last updated. */
+    updatedAt: Date;
+    /** @internal */
+    constructor(data: NodeTypeData);
+}
+/** Direct connection details for a node's daemon API. */
+export interface NodeConnection {
+    /** Full URL to the node daemon API, e.g. `"http://1.2.3.4:8080"`. */
+    url: string;
+    /** URL scheme: `"http"` or `"https"`. */
+    scheme: string;
+    /** Fully qualified domain name or IP of the node. */
+    fqdn: string;
+    /** Port number of the node daemon API. */
+    port: number;
+}
+/**
+ * Resource limits configured for a node.
+ */
+export interface NodeLimits {
+    /** Total memory available on this node, in megabytes. */
+    memoryMb: number;
+    /** Allowed memory overallocation, in megabytes. */
+    memoryOverallocateMb: number;
+    /** Total disk space available on this node, in megabytes. */
+    diskMb: number;
+    /** Allowed disk overallocation, in megabytes. */
+    diskOverallocateMb: number;
+    /** Maximum upload size for file operations, in megabytes. */
+    uploadSizeMb: number;
+}
+/**
+ * A single port on a node allocation IP.
+ */
+export declare class NodeAllocationPort extends ReactiveResource {
+    readonly id: NanoID;
+    ip: string;
+    port: number;
+    readyProtocols: Array<'tcp' | 'udp'>;
+    isInUse: boolean;
+    notes: string | null | undefined;
+    createdAt: Date;
+    updatedAt: Date;
+    /** @internal */
+    constructor(data: NodeAllocationPortData);
+}
+/**
+ * An allocation IP assigned to a node, including its available ports.
+ */
+export declare class NodeAllocationIp extends ReactiveResource {
+    readonly id: NanoID;
+    ip: string;
+    ipAlias: string | null | undefined;
+    ports: NodeAllocationPort[];
+    node: Node;
+    notes: string | null | undefined;
+    createdAt: Date;
+    updatedAt: Date;
+    /** @internal */
+    constructor(data: NodeAllocationIpData);
+}
+/**
+ * A MeowPanel daemon node (physical or virtual server hosting game servers).
+ *
+ * Retrieved via {@link NodesNamespace.get} or {@link NodesNamespace.list}.
+ */
+export declare class Node extends ReactiveResource {
+    /** The node's unique NanoID. */
+    readonly id: NanoID;
+    /**
+     * Auto-generated display name in the format `{type}{num}{location}.{hostname}`,
+     * e.g. `"a001use.host.example.com"`.
+     */
+    name: string;
+    /** Optional description of the node. */
+    description: string | null;
+    /** Owner of this node record. */
+    owner: Member | undefined;
+    /** Geographic location of this node. */
+    location: NodeLocation;
+    /** Classification type of this node. */
+    type: NodeType;
+    /** Sequential number of this node within its type and location. */
+    num: number;
+    /** Resource limits configured for this node. */
+    limits: NodeLimits;
+    /**
+    /** Direct connection details for the node daemon API. */
+    connection: NodeConnection | null | undefined;
+    /** `true` when the node is in maintenance mode (no new servers will be started). */
+    isMaintenanceMode: boolean;
+    /** `true` when the node can be auto-deployed to. */
+    canAutoDeploy: boolean;
+    /** `true` when the node is behind a reverse proxy. */
+    isBehindProxy: boolean;
+    /** Internal notes visible to administrators. */
+    notes: string | null | undefined;
+    /** When this node was registered. */
+    createdAt: Date;
+    /** When this node was last updated. */
+    updatedAt: Date;
+    /** @internal */
+    constructor(data: NodeData);
+}
+/** Payload for creating a new node. */
+export interface CreateNodePayload {
+    /** Fully qualified domain name or IP of the node. */
+    fqdn: string;
+    /** URL scheme: `"http"` or `"https"`. */
+    scheme: 'http' | 'https';
+    /** Port number of the node daemon API. */
+    apiPort: number;
+    /** Port number of the node SFTP server. */
+    sftpPort: number;
+    /** ID of the host this node belongs to. */
+    hostId: NanoID;
+    /** ID of the location this node belongs to. */
+    locationId: NanoID;
+    /** ID of the node type. */
+    typeId: NanoID;
+    /** Optional description. */
+    description?: string;
+    /** Optional internal notes. */
+    notes?: string;
+    /** Explicit node number override. */
+    num?: number;
+    /** Whether the node should start in maintenance mode. */
+    isMaintenanceMode?: boolean;
+    /** Whether the node can be auto-deployed to. */
+    canAutoDeploy?: boolean;
+    /** Whether the node is behind a reverse proxy. */
+    isBehindProxy?: boolean;
+    /** Resource limits for the node. */
+    limits: {
+        memoryMb: number;
+        memoryOverallocateMb: number;
+        diskMb: number;
+        diskOverallocateMb: number;
+        uploadSizeMb: number;
+    };
+}
+/** Payload for creating a node allocation IP. */
+export interface CreateNodeAllocationIpPayload {
+    ip: string;
+    ipAlias?: string;
+    notes?: string;
+}
+/** Payload for updating a node allocation IP. */
+export interface UpdateNodeAllocationIpPayload {
+    ipAlias?: string;
+    notes?: string;
+}
+/** Payload for creating one or more allocation ports. */
+export interface CreateNodeAllocationPortsPayload {
+    port: number;
+    type?: Array<'tcp' | 'udp'>;
+}
+/** Payload for updating a node allocation port. */
+export interface UpdateNodeAllocationPortPayload {
+    type?: Array<'tcp' | 'udp'>;
+}
+/** Payload for logging node-originated activity into Nexus. */
+export interface LogNodeActivityPayload {
+    userId: string;
+    serverId: string;
+    event: string;
+    metadata: Record<string, unknown>;
+    ip: string;
+    timestamp: string | Date;
+}
+/** Valid include keys for node endpoints. */
+export type NodeInclude = 'connection';
+/** Maps each {@link NodeInclude} key to the field(s) it guarantees on the {@link Node} instance. */
+interface NodeIncludeMap {
+    connection: {
+        connection: NodeConnection;
+    };
+}
+/** A {@link Node} with specific include fields guaranteed to be populated. */
+export type NodeWith<I extends readonly NodeInclude[] = []> = ResourceWith<Node, NodeIncludeMap, I>;
+/** Typed events emitted by {@link NodesNamespace}. */
+export interface NodeEvents {
+    /** Fired after a node is created. */
+    created: Node;
+}
+/**
+ * Manage allocation IPs and ports on a specific node.
+ */
+export declare class NodeAllocationsManager {
+    private readonly nodeId;
+    private readonly http;
+    /** @internal */
+    constructor(nodeId: NanoID, http: HttpClient);
+    list(): Promise<NodeAllocationIp[]>;
+    get(allocationIp: string): Promise<NodeAllocationIp>;
+    create(payload: CreateNodeAllocationIpPayload): Promise<NodeAllocationIp>;
+    update(allocationIp: string, payload: UpdateNodeAllocationIpPayload): Promise<NodeAllocationIp>;
+    delete(allocationIp: string): Promise<void>;
+    createPorts(allocationIp: string, payload: CreateNodeAllocationPortsPayload[]): Promise<NodeAllocationIp>;
+    updatePort(allocationIp: string, port: number, payload: UpdateNodeAllocationPortPayload): Promise<NodeAllocationIp>;
+    deletePort(allocationIp: string, port: number): Promise<void>;
+}
+/**
+ * Namespace for node management.
+ *
+ * Access via `api.nodes`.
+ *
+ * @example
+ * ```ts ignore
+ * const nodes = await api.nodes.list();
+ * const node = await api.nodes.get(id, { includeConnection: true });
+ * console.log(node.connection?.url); // "http://1.2.3.4:8080"
+ * ```
+ */
+export declare class NodesNamespace extends ResourceNamespace<Node, NodeEvents> {
+    /** @internal */
+    constructor(http: HttpClient);
+    /**
+     * Fetch a paginated list of nodes.
+     *
+     * @param opts Pagination, search, and include options.
+     */
+    list<const I extends readonly NodeInclude[] = []>(opts?: {
+        page?: number;
+        perPage?: number;
+        search?: string;
+    } & IncludeOptions<NodeInclude, I>): Promise<Paginated<NodeWith<I>>>;
+    /**
+     * Fetch a single node by ID.
+     *
+     * @param id   The node's NanoID.
+     * @param opts Include options (e.g. `{ include: ['connection'] }`).
+     */
+    get<const I extends readonly NodeInclude[] = []>(id: NanoID, opts?: IncludeOptions<NodeInclude, I>): Promise<NodeWith<I>>;
+    /**
+     * Create a new node.
+     *
+     * @param payload Node creation parameters.
+     */
+    create(payload: CreateNodePayload): Promise<Node>;
+    /**
+     * Fetch all servers deployed on a specific node.
+     *
+     * @param id The node's NanoID.
+     * @returns An array of minimal server data. Use `api.servers.get()` to fetch full server details.
+     */
+    servers(id: NanoID): Promise<Array<{
+        id: NanoID;
+    }>>;
+    /**
+     * Access allocation management for a specific node.
+     */
+    allocations(id: NanoID): NodeAllocationsManager;
+    /**
+     * Log activity on behalf of a node daemon.
+     *
+     * This endpoint is intended for node-authenticated clients.
+     */
+    logActivity(entries: LogNodeActivityPayload[]): Promise<void>;
+    /**
+     * Create an activity log model from a raw payload.
+     *
+     * Useful when consuming activity data returned from other endpoints.
+     */
+    toActivityLog(data: ActivityLogData): ActivityLog;
+}
+export {};
+//# sourceMappingURL=nodes.d.ts.map

package/script/src/resources/nodes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodes.d.ts","sourceRoot":"","sources":["../../../src/src/resources/nodes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EAAE,KAAK,OAAO,EAAgB,KAAK,MAAM,EAAE,KAAK,SAAS,EAAY,MAAM,aAAa,CAAC;AAChG,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpD,sDAAsD;AACtD,MAAM,WAAW,gBAAgB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,mEAAmE;AACnE,MAAM,WAAW,YAAY;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,sDAAsD;AACtD,MAAM,WAAW,YAAY;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,6CAA6C;AAC7C,MAAM,WAAW,QAAQ;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,IAAI,EAAE,YAAY,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QACP,SAAS,EAAE,MAAM,CAAC;QAClB,sBAAsB,EAAE,MAAM,CAAC;QAC/B,OAAO,EAAE,MAAM,CAAC;QAChB,oBAAoB,EAAE,MAAM,CAAC;QAC7B,cAAc,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,0BAA0B;IAC1B,UAAU,CAAC,EAAE;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;KACb,GAAG,IAAI,CAAC;IACT,mBAAmB,EAAE,OAAO,CAAC;IAC7B,eAAe,EAAE,OAAO,CAAC;IACzB,eAAe,EAAE,OAAO,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,6DAA6D;AAC7D,MAAM,WAAW,sBAAsB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC;IACtC,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,2DAA2D;AAC3D,MAAM,WAAW,oBAAoB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,KAAK,EAAE,sBAAsB,EAAE,CAAC;IAChC,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;IACjD,sCAAsC;IACtC,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,2DAA2D;IACpD,IAAI,EAAE,MAAM,CAAC;IACpB,6DAA6D;IACtD,KAAK,EAAE,MAAM,CAAC;IACrB,sBAAsB;IACf,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACxC,qCAAqC;IAC9B,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,sCAAsC;IAC/B,SAAS,EAAE,IAAI,CAAC;IACvB,2CAA2C;IACpC,SAAS,EAAE,IAAI,CAAC;IAEvB,gBAAgB;gBACG,IAAI,EAAE,gBAAgB;CAUzC;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,gBAAgB;IAC7C,uCAAuC;IACvC,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,yDAAyD;IAClD,IAAI,EAAE,MAAM,CAAC;IACpB,2DAA2D;IACpD,KAAK,EAAE,MAAM,CAAC;IACrB,sBAAsB;IACf,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACxC,iCAAiC;IAC1B,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,kCAAkC;IAC3B,SAAS,EAAE,IAAI,CAAC;IACvB,uCAAuC;IAChC,SAAS,EAAE,IAAI,CAAC;IAEvB,gBAAgB;gBACG,IAAI,EAAE,YAAY;CAUrC;AAED,yDAAyD;AACzD,MAAM,WAAW,cAAc;IAC9B,qEAAqE;IACrE,GAAG,EAAE,MAAM,CAAC;IACZ,yCAAyC;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B,yDAAyD;IACzD,QAAQ,EAAE,MAAM,CAAC;IACjB,mDAAmD;IACnD,oBAAoB,EAAE,MAAM,CAAC;IAC7B,6DAA6D;IAC7D,MAAM,EAAE,MAAM,CAAC;IACf,iDAAiD;IACjD,kBAAkB,EAAE,MAAM,CAAC;IAC3B,6DAA6D;IAC7D,YAAY,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,gBAAgB;IACvD,SAAgB,EAAE,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC;IACrC,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACjC,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAEvB,gBAAgB;gBACG,IAAI,EAAE,sBAAsB;CAW/C;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,gBAAgB;IACrD,SAAgB,EAAE,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACnC,KAAK,EAAE,kBAAkB,EAAE,CAAC;IAC5B,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACjC,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAEvB,gBAAgB;gBACG,IAAI,EAAE,oBAAoB;CAW7C;AAED;;;;GAIG;AACH,qBAAa,IAAK,SAAQ,gBAAgB;IACzC,gCAAgC;IAChC,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACI,IAAI,EAAE,MAAM,CAAC;IACpB,wCAAwC;IACjC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,iCAAiC;IAC1B,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,wCAAwC;IACjC,QAAQ,EAAE,YAAY,CAAC;IAC9B,wCAAwC;IACjC,IAAI,EAAE,QAAQ,CAAC;IACtB,mEAAmE;IAC5D,GAAG,EAAE,MAAM,CAAC;IACnB,gDAAgD;IACzC,MAAM,EAAE,UAAU,CAAC;IAC1B;6DACyD;IAClD,UAAU,EAAE,cAAc,GAAG,IAAI,GAAG,SAAS,CAAC;IACrD,oFAAoF;IAC7E,iBAAiB,EAAE,OAAO,CAAC;IAClC,oDAAoD;IAC7C,aAAa,EAAE,OAAO,CAAC;IAC9B,sDAAsD;IAC/C,aAAa,EAAE,OAAO,CAAC;IAC9B,gDAAgD;IACzC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACxC,qCAAqC;IAC9B,SAAS,EAAE,IAAI,CAAC;IACvB,uCAAuC;IAChC,SAAS,EAAE,IAAI,CAAC;IAEvB,gBAAgB;gBACG,IAAI,EAAE,QAAQ;CAwBjC;AAED,uCAAuC;AACvC,MAAM,WAAW,iBAAiB;IACjC,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IACzB,0CAA0C;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,QAAQ,EAAE,MAAM,CAAC;IACjB,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAC;IACnB,2BAA2B;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,yDAAyD;IACzD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gDAAgD;IAChD,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,kDAAkD;IAClD,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,oCAAoC;IACpC,MAAM,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC;QACjB,oBAAoB,EAAE,MAAM,CAAC;QAC7B,MAAM,EAAE,MAAM,CAAC;QACf,kBAAkB,EAAE,MAAM,CAAC;QAC3B,YAAY,EAAE,MAAM,CAAC;KACrB,CAAC;CACF;AAED,iDAAiD;AACjD,MAAM,WAAW,6BAA6B;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED,iDAAiD;AACjD,MAAM,WAAW,6BAA6B;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yDAAyD;AACzD,MAAM,WAAW,gCAAgC;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC;CAC5B;AAED,mDAAmD;AACnD,MAAM,WAAW,+BAA+B;IAC/C,IAAI,CAAC,EAAE,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC;CAC5B;AAED,+DAA+D;AAC/D,MAAM,WAAW,sBAAsB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,6CAA6C;AAC7C,MAAM,MAAM,WAAW,GAAG,YAAY,CAAC;AAEvC,oGAAoG;AACpG,UAAU,cAAc;IACvB,UAAU,EAAE;QAAE,UAAU,EAAE,cAAc,CAAA;KAAE,CAAC;CAC3C;AAED,8EAA8E;AAC9E,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,SAAS,WAAW,EAAE,GAAG,EAAE,IAAI,YAAY,CACzE,IAAI,EACJ,cAAc,EACd,CAAC,CACD,CAAC;AAEF,sDAAsD;AACtD,MAAM,WAAW,UAAU;IAC1B,qCAAqC;IACrC,OAAO,EAAE,IAAI,CAAC;CACd;AAED;;GAEG;AACH,qBAAa,sBAAsB;IAGjC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,IAAI;IAHtB,gBAAgB;gBAEE,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,UAAU;IAGrB,IAAI,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAOnC,GAAG,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAOpD,MAAM,CAClB,OAAO,EAAE,6BAA6B,GACpC,OAAO,CAAC,gBAAgB,CAAC;IAYf,MAAM,CAClB,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,6BAA6B,GACpC,OAAO,CAAC,gBAAgB,CAAC;IAWf,MAAM,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM3C,WAAW,CACvB,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,gCAAgC,EAAE,GACzC,OAAO,CAAC,gBAAgB,CAAC;IAQf,UAAU,CACtB,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,+BAA+B,GACtC,OAAO,CAAC,gBAAgB,CAAC;IAQf,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAK1E;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,cAAe,SAAQ,iBAAiB,CAAC,IAAI,EAAE,UAAU,CAAC;IACtE,gBAAgB;gBACG,IAAI,EAAE,UAAU;IAInC;;;;OAIG;IACU,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,SAAS,WAAW,EAAE,GAAG,EAAE,EAC5D,IAAI,GACD;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GACpD,cAAc,CACf,WAAW,EACX,CAAC,CAKgC,GACjC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAWlC;;;;;OAKG;IACU,GAAG,CAAC,KAAK,CAAC,CAAC,SAAS,SAAS,WAAW,EAAE,GAAG,EAAE,EAC3D,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,cAAc,CAAC,WAAW,EAAE,CAAC,CAAM,GACvC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAQvB;;;;OAIG;IACU,MAAM,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IA8B9D;;;;;OAKG;IACU,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAOhE;;OAEG;IACI,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,sBAAsB;IAItD;;;;OAIG;IACU,WAAW,CAAC,OAAO,EAAE,sBAAsB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAa1E;;;;OAIG;IACI,aAAa,CAAC,IAAI,EAAE,eAAe,GAAG,WAAW;CAGxD"}