@meowpanel/api 0.1.0-alpha.10 → 1.0.0-beta.1

package/esm/src/resources/eggs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eggs.d.ts","sourceRoot":"","sources":["../../../src/src/resources/eggs.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,0DAA0D;AAC1D,MAAM,WAAW,WAAW;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACb;AAED,oDAAoD;AACpD,MAAM,WAAW,gBAAgB;IAChC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,gDAAgD;AAChD,MAAM,WAAW,YAAY;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,6DAA6D;AAC7D,UAAU,cAAc;IACvB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,IAAI,EAAE;QAAE,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IACpD,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,oBAAoB,EAAE,MAAM,CAAC;CAC7B;AAED,0CAA0C;AAC1C,MAAM,WAAW,OAAO;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACpC,OAAO,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAChC,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;IACxB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,OAAQ,SAAQ,gBAAgB;IAC5C,kCAAkC;IAClC,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,oDAAoD;IAC7C,IAAI,EAAE,MAAM,CAAC;IAEpB,gBAAgB;gBACG,IAAI,EAAE,WAAW;CAKpC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACxB,qCAAqC;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,wEAAwE;IACxE,KAAK,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,SAAS,EAAE,IAAI,CAAC;IAChB,wCAAwC;IACxC,SAAS,EAAE,IAAI,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,0BAA0B;IAC1B,IAAI,EAAE;QAAE,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IACpD,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,0BAA0B;IAC1B,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,2CAA2C;IAC3C,kBAAkB,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,qDAAqD;IACrD,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,iDAAiD;IACjD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,kCAAkC;IAClC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED;;;;;GAKG;AACH,qBAAa,GAAI,SAAQ,gBAAgB;IACxC,+BAA+B;IAC/B,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,2DAA2D;IACpD,IAAI,EAAE,MAAM,CAAC;IACpB,8BAA8B;IACvB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,+CAA+C;IACxC,IAAI,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IACxC;;;OAGG;IACI,cAAc,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACI,WAAW,EAAE,MAAM,CAAC;IAC3B,kFAAkF;IAC3E,eAAe,EAAE,OAAO,CAAC;IAChC,4CAA4C;IACrC,SAAS,EAAE,YAAY,GAAG,IAAI,GAAG,SAAS,CAAC;IAClD,sDAAsD;IAC/C,OAAO,EAAE,UAAU,GAAG,IAAI,GAAG,SAAS,CAAC;IAC9C,0CAA0C;IACnC,MAAM,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC;IACtC,iCAAiC;IAC1B,SAAS,EAAE,IAAI,CAAC;IACvB,sCAAsC;IAC/B,SAAS,EAAE,IAAI,CAAC;IAEvB,gBAAgB;gBACG,IAAI,EAAE,OAAO;CAmChC;AAED,qEAAqE;AACrE,MAAM,WAAW,gBAAgB;IAChC,wBAAwB;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qDAAqD;IACrD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,wBAAwB;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,uCAAuC;IACvC,SAAS,CAAC,EAAE;QACX,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,MAAM,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACF;AAED,4CAA4C;AAC5C,MAAM,MAAM,UAAU,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;AAE5D,kGAAkG;AAClG,UAAU,aAAa;IACtB,SAAS,EAAE;QAAE,SAAS,EAAE,YAAY,GAAG,IAAI,CAAA;KAAE,CAAC;IAC9C,OAAO,EAAE;QAAE,OAAO,EAAE,UAAU,GAAG,IAAI,CAAA;KAAE,CAAC;IACxC,MAAM,EAAE;QAAE,MAAM,EAAE,YAAY,EAAE,CAAA;KAAE,CAAC;CACnC;AAED,6EAA6E;AAC7E,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,SAAS,UAAU,EAAE,GAAG,EAAE,IAAI,YAAY,CACvE,GAAG,EACH,aAAa,EACb,CAAC,CACD,CAAC;AAEF,qDAAqD;AACrD,MAAM,WAAW,SAAS;IACzB,kDAAkD;IAClD,OAAO,EAAE,GAAG,CAAC;IACb,0EAA0E;IAC1E,OAAO,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,aAAc,SAAQ,iBAAiB,CAAC,GAAG,EAAE,SAAS,CAAC;IACnE,gBAAgB;gBACG,IAAI,EAAE,UAAU;IAInC;;;;OAIG;IACU,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,SAAS,UAAU,EAAE,GAAG,EAAE,EAC3D,IAAI,GACD;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GACpD,cAAc,CACf,UAAU,EACV,CAAC,CAK+B,GAChC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAWjC;;;;;OAKG;IACU,GAAG,CAAC,KAAK,CAAC,CAAC,SAAS,SAAS,UAAU,EAAE,GAAG,EAAE,EAC1D,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,cAAc,CAAC,UAAU,EAAE,CAAC,CAAM,GACtC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAQtB;;;;;OAKG;IACU,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC;IA+BxE;;;;OAIG;IACU,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAK9C"}

package/esm/src/resources/eggs.js

@@ -0,0 +1,187 @@
+import { ResourceNamespace } from '../namespace.js';
+import { ReactiveResource } from '../reactive.js';
+import { joinIncludes, toNanoID } from '../types.js';
+/**
+ * A category (nest) that groups related eggs.
+ */
+export class EggNest extends ReactiveResource {
+    /** Unique NanoID of this nest. */
+    id;
+    /** Display name of the nest, e.g. `"Minecraft"`. */
+    name;
+    /** @internal */
+    constructor(data) {
+        super();
+        this.id = toNanoID(data.id);
+        this.name = data.name;
+    }
+}
+/**
+ * An egg - a game or application configuration template that defines how a server
+ * is installed, started, and stopped.
+ *
+ * Retrieved via {@link EggsNamespace.get} or {@link EggsNamespace.list}.
+ */
+export class Egg extends ReactiveResource {
+    /** The egg's unique NanoID. */
+    id;
+    /** Display name of the egg, e.g. `"Vanilla Minecraft"`. */
+    name;
+    /** Description of the egg. */
+    description;
+    /** The nest (category) this egg belongs to. */
+    nest;
+    /**
+     * The startup command template, e.g.
+     * `"java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}"`.
+     */
+    startupCommand;
+    /**
+     * The stop command sent to the server to shut it down gracefully,
+     * e.g. `"stop"` or `"^C"`.
+     */
+    stopCommand;
+    /** When `true`, the server's outgoing IP is forced to match the allocation IP. */
+    forceOutgoingIp;
+    /** Installer configuration for this egg. */
+    installer;
+    /** Process configuration (startup, stop, logging). */
+    process;
+    /** Docker image variants for this egg. */
+    images;
+    /** When this egg was created. */
+    createdAt;
+    /** When this egg was last updated. */
+    updatedAt;
+    /** @internal */
+    constructor(data) {
+        super();
+        this.id = toNanoID(data.id);
+        this.name = data.name;
+        this.description = data.description;
+        this.nest = data.nest ? new EggNest(data.nest) : data.nest;
+        this.startupCommand = data.startup_command;
+        this.stopCommand = data.stop_command;
+        this.forceOutgoingIp = data.force_outgoing_ip;
+        this.installer = data.installer
+            ? {
+                image: data.installer.image,
+                entryCommand: data.installer.entry_command,
+                script: data.installer.script,
+            }
+            : data.installer;
+        this.process = data.process
+            ? {
+                startup: data.process.startup,
+                stop: data.process.stop,
+                logs: data.process.logs,
+                files: data.process.files,
+                fileBlacklistRegex: data.process.file_blacklist_regex,
+            }
+            : data.process;
+        this.images = data.images?.map((img) => ({
+            id: toNanoID(img.id),
+            name: img.name,
+            image: img.image,
+            createdAt: new Date(img.created_at),
+            updatedAt: new Date(img.updated_at),
+        }));
+        this.createdAt = new Date(data.created_at);
+        this.updatedAt = new Date(data.updated_at);
+    }
+}
+/**
+ * Namespace for egg management.
+ *
+ * Access via `api.eggs`.
+ *
+ * @example
+ * ```ts ignore
+ * const eggs = await api.eggs.list();
+ * const egg = await api.eggs.get(id);
+ * await api.eggs.update(id, { name: 'Paper Minecraft' });
+ * await api.eggs.delete(id);
+ * ```
+ */
+export class EggsNamespace extends ResourceNamespace {
+    /** @internal */
+    constructor(http) {
+        super(http);
+    }
+    /**
+     * Fetch a paginated list of eggs.
+     *
+     * @param opts Pagination, search, and include options.
+     */
+    async list(opts = {}) {
+        const extra = {};
+        const include = joinIncludes(opts);
+        if (include)
+            extra['include'] = include;
+        const result = await this.http.list('/eggs', opts, extra);
+        const eggs = result.data.map((d) => new Egg(d));
+        this.setCache(eggs);
+        return { ...result, data: eggs };
+    }
+    /**
+     * Fetch a single egg by ID.
+     *
+     * @param id   The egg's NanoID.
+     * @param opts Include options.
+     */
+    async get(id, opts = {}) {
+        const params = {};
+        const include = joinIncludes(opts);
+        if (include)
+            params['include'] = include;
+        const data = await this.http.get(`/eggs/${id}`, { params });
+        return new Egg(data);
+    }
+    /**
+     * Update an egg's configuration.
+     *
+     * @param id      The egg's NanoID.
+     * @param payload The fields to update.
+     */
+    async update(id, payload) {
+        const body = {};
+        if (payload.name !== undefined)
+            body['name'] = payload.name;
+        if (payload.description !== undefined) {
+            body['description'] = payload.description;
+        }
+        if (payload.nestId !== undefined)
+            body['nest_id'] = payload.nestId;
+        if (payload.startupCommand !== undefined) {
+            body['startup_command'] = payload.startupCommand;
+        }
+        if (payload.stopCommand !== undefined) {
+            body['stop_command'] = payload.stopCommand;
+        }
+        if (payload.forceOutgoingIp !== undefined) {
+            body['force_outgoing_ip'] = payload.forceOutgoingIp;
+        }
+        if (payload.installer) {
+            body['installer'] = {
+                image: payload.installer.image,
+                entry_command: payload.installer.entryCommand,
+                script: payload.installer.script,
+            };
+        }
+        const data = await this.http.patch(`/eggs/${id}`, body);
+        const egg = new Egg(data);
+        this.upsertCache(egg);
+        this.emit('updated', egg);
+        return egg;
+    }
+    /**
+     * Delete an egg permanently.
+     *
+     * @param id The egg's NanoID.
+     */
+    async delete(id) {
+        await this.http.delete(`/eggs/${id}`);
+        this.removeFromCache(id);
+        this.emit('deleted', id);
+    }
+}

package/esm/src/resources/hosts.d.ts

@@ -0,0 +1,62 @@
+import type { HttpClient } from '../http.js';
+import { ResourceNamespace } from '../namespace.js';
+import { ReactiveResource } from '../reactive.js';
+import { type ISODate, type NanoID, type Paginated } from '../types.js';
+/** Raw API shape for a physical host. @internal */
+export interface HostData {
+    id: string;
+    hostname: string;
+    name?: string | null;
+    color?: string | null;
+    notes?: string | null;
+    created_at: ISODate;
+    updated_at: ISODate;
+}
+/**
+ * A physical host machine on which nodes are deployed.
+ *
+ * Retrieved via {@link HostsNamespace.list}.
+ */
+export declare class Host extends ReactiveResource {
+    /** The host's unique NanoID. */
+    readonly id: NanoID;
+    /** The host's hostname, e.g. `"host.example.com"`. */
+    hostname: string;
+    /** Optional display name for the host. */
+    name: string | null | undefined;
+    /** Optional color used in the UI for grouping. */
+    color: string | null | undefined;
+    /** Internal notes. */
+    notes: string | null | undefined;
+    /** When this host was registered. */
+    createdAt: Date;
+    /** When this host was last updated. */
+    updatedAt: Date;
+    /** @internal */
+    constructor(data: HostData);
+}
+/**
+ * Namespace for host management.
+ *
+ * Access via `api.hosts`.
+ *
+ * @example
+ * ```ts ignore
+ * const hosts = await api.hosts.list();
+ * ```
+ */
+export declare class HostsNamespace extends ResourceNamespace<Host> {
+    /** @internal */
+    constructor(http: HttpClient);
+    /**
+     * Fetch a paginated list of physical hosts.
+     *
+     * @param opts Pagination and search options.
+     */
+    list(opts?: {
+        page?: number;
+        perPage?: number;
+        search?: string;
+    }): Promise<Paginated<Host>>;
+}
+//# sourceMappingURL=hosts.d.ts.map

package/esm/src/resources/hosts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hosts.d.ts","sourceRoot":"","sources":["../../../src/src/resources/hosts.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,EAAE,KAAK,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,SAAS,EAAY,MAAM,aAAa,CAAC;AAElF,mDAAmD;AACnD,MAAM,WAAW,QAAQ;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED;;;;GAIG;AACH,qBAAa,IAAK,SAAQ,gBAAgB;IACzC,gCAAgC;IAChC,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,sDAAsD;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACxB,0CAA0C;IACnC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACvC,kDAAkD;IAC3C,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACxC,sBAAsB;IACf,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;CAUjC;AAED;;;;;;;;;GASG;AACH,qBAAa,cAAe,SAAQ,iBAAiB,CAAC,IAAI,CAAC;IAC1D,gBAAgB;gBACG,IAAI,EAAE,UAAU;IAInC;;;;OAIG;IACU,IAAI,CAAC,IAAI,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;CAM5G"}

package/esm/src/resources/hosts.js

@@ -0,0 +1,62 @@
+import { ResourceNamespace } from '../namespace.js';
+import { ReactiveResource } from '../reactive.js';
+import { toNanoID } from '../types.js';
+/**
+ * A physical host machine on which nodes are deployed.
+ *
+ * Retrieved via {@link HostsNamespace.list}.
+ */
+export class Host extends ReactiveResource {
+    /** The host's unique NanoID. */
+    id;
+    /** The host's hostname, e.g. `"host.example.com"`. */
+    hostname;
+    /** Optional display name for the host. */
+    name;
+    /** Optional color used in the UI for grouping. */
+    color;
+    /** Internal notes. */
+    notes;
+    /** When this host was registered. */
+    createdAt;
+    /** When this host was last updated. */
+    updatedAt;
+    /** @internal */
+    constructor(data) {
+        super();
+        this.id = toNanoID(data.id);
+        this.hostname = data.hostname;
+        this.name = data.name;
+        this.color = data.color;
+        this.notes = data.notes;
+        this.createdAt = new Date(data.created_at);
+        this.updatedAt = new Date(data.updated_at);
+    }
+}
+/**
+ * Namespace for host management.
+ *
+ * Access via `api.hosts`.
+ *
+ * @example
+ * ```ts ignore
+ * const hosts = await api.hosts.list();
+ * ```
+ */
+export class HostsNamespace extends ResourceNamespace {
+    /** @internal */
+    constructor(http) {
+        super(http);
+    }
+    /**
+     * Fetch a paginated list of physical hosts.
+     *
+     * @param opts Pagination and search options.
+     */
+    async list(opts = {}) {
+        const result = await this.http.list('/hosts', opts);
+        const hosts = result.data.map((d) => new Host(d));
+        this.setCache(hosts);
+        return { ...result, data: hosts };
+    }
+}

package/esm/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/esm/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/esm/src/resources/members.js

@@ -0,0 +1,122 @@
+import { ResourceNamespace } from '../namespace.js';
+import { ReactiveResource } from '../reactive.js';
+import { joinIncludes, toNanoID } from '../types.js';
+/**
+ * A MeowPanel user account (member).
+ *
+ * Retrieved via {@link MembersNamespace.get} or {@link MembersNamespace.list}.
+ */
+export class Member extends 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 = 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();
+    }
+}
+/**
+ * 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 class MembersNamespace extends 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 = 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 = 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;
+    }
+}