@meowpanel/api 0.3.0 → 0.5.0

package/script/src/resources/users.js

@@ -0,0 +1,287 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UsersNamespace = exports.UserPermissionsManager = exports.UserRolesManager = exports.User = void 0;
+const namespace_js_1 = require("../namespace.js");
+const reactive_js_1 = require("../reactive.js");
+const types_js_1 = require("../types.js");
+const permissions_js_1 = require("./permissions.js");
+/**
+ * A MeowPanel user account.
+ *
+ * Retrieved via {@link UsersNamespace.get} or {@link UsersNamespace.list}.
+ */
+class User extends reactive_js_1.ReactiveResource {
+    /** The user's unique NanoID. */
+    id;
+    /** The issuer type, `'user'` for user accounts. */
+    issuerType;
+    /** The user's login email address. */
+    email;
+    /** When the user verified their email, or `null` if unverified. */
+    emailVerifiedAt;
+    /** The user's display nickname. */
+    nickname;
+    /** URL of the user's avatar image, or `null` if no avatar is set. */
+    avatarUri;
+    /** When the user account was disabled, or `null` if active. */
+    disabledAt;
+    /** Display and locale preferences. Requires `?include=preferences`. */
+    preferences;
+    /** The user's assigned permission scopes. Requires `?include=permissions`. */
+    permissions;
+    /** The user's external identifiers. Requires `?include=identifiers`. */
+    identifiers;
+    /** When this user account was created. */
+    createdAt;
+    /** When this user account was last updated. */
+    updatedAt;
+    /** @internal */
+    constructor(data) {
+        super();
+        this.id = data.ref_id ? (0, types_js_1.toNanoID)(data.ref_id) : (0, types_js_1.parseIssuerRef)(data.id).id;
+        this.applyData(data);
+    }
+    /**
+     * Apply raw API data to this user instance, updating all mutable fields.
+     *
+     * Called by the constructor and by {@link UsersNamespace.update} to update the instance in-place.
+     */
+    applyData(data) {
+        this.issuerType = data.type ?? 'user';
+        this.email = data.email;
+        this.emailVerifiedAt = data.email_verified_at ? new Date(data.email_verified_at) : null;
+        this.nickname = data.nickname;
+        this.avatarUri = data.avatar_uri;
+        this.disabledAt = data.disabled_at ? new Date(data.disabled_at) : null;
+        this.preferences = data.preferences ?? undefined;
+        this.permissions = data.permissions;
+        this.identifiers = data.identifiers ? parseIdentifiers(data.identifiers) : undefined;
+        this.createdAt = new Date(data.created_at);
+        this.updatedAt = new Date(data.updated_at);
+        this.notify();
+    }
+}
+exports.User = User;
+function parseIdentifiers(data) {
+    return {
+        password: data.password
+            ? {
+                createdAt: new Date(data.password.created_at),
+                lastUsedAt: data.password.last_used_at ? new Date(data.password.last_used_at) : null,
+            }
+            : null,
+        whmcs: data.whmcs
+            ? {
+                whmcsId: data.whmcs.whmcs_id,
+                email: data.whmcs.email,
+                name: data.whmcs.name,
+                syncEmail: data.whmcs.sync_email,
+                syncNickname: data.whmcs.sync_nickname,
+                lastUsedAt: data.whmcs.last_used_at ? new Date(data.whmcs.last_used_at) : null,
+                createdAt: new Date(data.whmcs.created_at),
+                updatedAt: new Date(data.whmcs.updated_at),
+            }
+            : null,
+    };
+}
+/**
+ * Manages a user's role assignments.
+ *
+ * Access via `api.users.roles(userId)`.
+ */
+class UserRolesManager {
+    userId;
+    http;
+    /** @internal */
+    constructor(userId, http) {
+        this.userId = userId;
+        this.http = http;
+    }
+    /** List the roles assigned to the user. */
+    async list() {
+        const data = await this.http.get(`/users/${this.userId}/roles`);
+        return data.map((d) => ({
+            id: (0, types_js_1.toNanoID)(d.id),
+            title: d.title,
+            description: d.description,
+            color: d.color,
+            order: d.order,
+            scope: d.scope,
+        }));
+    }
+    /** Assign one or more roles to the user. */
+    async assign(roles) {
+        const body = (Array.isArray(roles) ? roles : [roles]).map((r) => ({
+            role_id: r.roleId,
+            scope: r.scope,
+            order: r.order,
+        }));
+        await this.http.post(`/users/${this.userId}/roles`, body);
+    }
+    /** Remove a role from the user. */
+    async remove(roleId) {
+        await this.http.delete(`/users/${this.userId}/roles/${roleId}`);
+    }
+    /** Change a role assignment's sort order. */
+    async setOrder(roleId, order) {
+        await this.http.patch(`/users/${this.userId}/roles/${roleId}`, { order });
+    }
+}
+exports.UserRolesManager = UserRolesManager;
+/**
+ * Manages a user's direct permission grants.
+ *
+ * Access via `api.users.permissions(userId)`.
+ */
+class UserPermissionsManager {
+    userId;
+    http;
+    /** @internal */
+    constructor(userId, http) {
+        this.userId = userId;
+        this.http = http;
+    }
+    /** List the user's direct permission grants. */
+    async list() {
+        const data = await this.http.get(`/users/${this.userId}/permissions`);
+        return data.map(permissions_js_1.parseGrant);
+    }
+    /**
+     * Grant one or more permissions to the user.
+     *
+     * You cannot grant a permission you do not hold yourself at the target scope.
+     */
+    async grant(grants) {
+        await this.http.post(`/users/${this.userId}/permissions`, (0, permissions_js_1.grantsToBody)(grants));
+    }
+    /**
+     * Revoke a permission from the user.
+     *
+     * @param permission The permission name to revoke.
+     * @param scope      The namespaced scope (`"<type>:<id>"`) to revoke at, or omit for the global grant.
+     */
+    async revoke(permission, scope) {
+        const params = scope ? { scope } : undefined;
+        await this.http.delete(`/users/${this.userId}/permissions/${encodeURIComponent(permission)}`, { params });
+    }
+}
+exports.UserPermissionsManager = UserPermissionsManager;
+/**
+ * Namespace for user management.
+ *
+ * Access via `api.users`.
+ *
+ * @example
+ * ```ts ignore
+ * const users = await api.users.list();
+ * const user = await api.users.get(id);
+ * await api.users.update(id, { nickname: 'newname' });
+ * ```
+ */
+class UsersNamespace extends namespace_js_1.ResourceNamespace {
+    /** @internal */
+    constructor(http) {
+        super(http);
+    }
+    /**
+     * Fetch a paginated list of all users.
+     *
+     * @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('/users', opts, extra);
+        const users = result.data.map((d) => new User(d));
+        this.setCache(users);
+        return { ...result, data: users };
+    }
+    /**
+     * Fetch a single user by ID.
+     *
+     * @param id   The user'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(`/users/${id}`, { params });
+        return new User(data);
+    }
+    /** Create a user. */
+    async create(payload) {
+        const body = {
+            email: payload.email,
+            nickname: payload.nickname,
+            email_verified: payload.emailVerified,
+            identifiers: payload.whmcs ? { whmcs: { id: payload.whmcs.id, name: payload.whmcs.name } } : undefined,
+        };
+        const data = await this.http.post('/users', body);
+        const user = new User(data);
+        this.addToCache(user);
+        this.emit('created', user);
+        return user;
+    }
+    /**
+     * Update a user's profile fields.
+     *
+     * @param id      The user's NanoID.
+     * @param payload The fields to update.
+     */
+    async update(id, payload) {
+        const data = await this.http.patch(`/users/${id}`, payload);
+        const existing = this.cache.find((u) => u.id === id);
+        if (existing) {
+            existing.applyData(data);
+            this.upsertCache(existing);
+            this.emit('updated', existing);
+            return existing;
+        }
+        const user = new User(data);
+        this.upsertCache(user);
+        this.emit('updated', user);
+        return user;
+    }
+    /** Disable a user, blocking them from authenticating. */
+    async disable(id) {
+        await this.http.post(`/users/${id}/disable`);
+    }
+    /** Re-enable a disabled user. */
+    async enable(id) {
+        await this.http.post(`/users/${id}/enable`);
+    }
+    /**
+     * Propagate WHMCS-sourced changes to the linked user.
+     *
+     * @param whmcsId The linked WHMCS client UUID.
+     * @param payload The WHMCS-side email and/or name.
+     */
+    async syncWhmcs(whmcsId, payload) {
+        const data = await this.http.patch(`/users/whmcs/${encodeURIComponent(whmcsId)}`, payload);
+        return { user: new User(data.user), skipped: data.skipped };
+    }
+    /**
+     * Unlink a WHMCS-linked user.
+     *
+     * @param whmcsId The linked WHMCS client UUID.
+     * @param opts    `unlink: true` only removes the link; otherwise the user is also disabled.
+     */
+    async unlinkWhmcs(whmcsId, opts = {}) {
+        const params = opts.unlink ? { unlink: 'true' } : undefined;
+        const data = await this.http.delete(`/users/whmcs/${encodeURIComponent(whmcsId)}`, { params });
+        return new User(data);
+    }
+    /** Manage a user's role assignments. */
+    roles(userId) {
+        return new UserRolesManager(userId, this.http);
+    }
+    /** Manage a user's direct permission grants. */
+    permissions(userId) {
+        return new UserPermissionsManager(userId, this.http);
+    }
+}
+exports.UsersNamespace = UsersNamespace;

package/script/src/types.d.ts

@@ -22,6 +22,23 @@ export type NanoID = string & {
 export declare function toNanoID(raw: string): NanoID;
 /** ISO 8601 date-time string as returned by the MeowPanel API, e.g. `"2024-01-15T12:00:00.000Z"`. */
 export type ISODate = string;
+/** A UI color label used for visual grouping (hosts, roles). */
+export type ResourceColor = 'red' | 'orange' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'brown' | 'black' | 'white';
+/** A namespaced issuer reference, e.g. `"user:abc123def456"`. */
+export type IssuerRef = string;
+/** The parsed parts of an {@link IssuerRef}. */
+export interface ParsedIssuer {
+    /** The issuer type token, e.g. `"user"`, `"system"`, `"api_key"`, `"node"`. */
+    type: string;
+    /** The bare resource NanoID. */
+    id: NanoID;
+}
+/**
+ * Split a namespaced issuer reference (`"<type>:<id>"`) into its type and bare id.
+ *
+ * A bare id with no prefix yields an empty `type`.
+ */
+export declare function parseIssuerRef(ref: string): ParsedIssuer;
 /** Options for paginated list requests. */
 export interface ListOptions {
     /** Page number (1-based). Defaults to 1. */
@@ -122,5 +139,5 @@ export type ServerRestrictedState = 'installing' | 'install_failed' | 'restoring
 /**
  * An SFTP permission scope that can be assigned to a path pattern for an SFTP user.
  */
-export type SftpPermission = 'sftp.content.list' | 'sftp.content.read' | 'sftp.content.create' | 'sftp.content.manage' | 'sftp.content.delete';
+export type SftpPermission = 'server.file.list' | 'server.file.read' | 'server.file.create' | 'server.file.manage' | 'server.file.delete';
 //# sourceMappingURL=types.d.ts.map

package/script/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,QAAQ,EAAE,OAAO,MAAM,CAAA;CAAE,CAAC;AAEnE;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED,qGAAqG;AACrG,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B,2CAA2C;AAC3C,MAAM,WAAW,WAAW;IAC3B,4CAA4C;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gEAAgE;IAChE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC;IAC3B,qCAAqC;IACrC,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,qEAAqE;IACrE,KAAK,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,wEAAwE;AACxE,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,OAAO,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,IAAI,GAAG,CAAC,GAC/G,KAAK,CAAC;AAET;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,YAAY,CACvB,CAAC,EACD,UAAU,EACV,CAAC,SAAS,SAAS,CAAC,MAAM,UAAU,CAAC,EAAE,GAAG,EAAE,IAE1C,CAAC,GACD,mBAAmB,CACpB,CAAC,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,KAAK,CACtF,CAAC;AAEH;;;;;GAKG;AACH,MAAM,WAAW,cAAc,CAAC,OAAO,SAAS,MAAM,EAAE,CAAC,SAAS,SAAS,OAAO,EAAE,GAAG,EAAE;IACxF;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC;IACZ;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE;IAAE,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG,MAAM,GAAG,SAAS,CAG7G;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,CAAC;AAEhE;;;;;;;;;GASG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,OAAO,GAAG,YAAY,CAAC;AAEjG;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAC9B,YAAY,GACZ,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,cAAc,GACd,YAAY,GACZ,SAAS,GACT,SAAS,GACT,IAAI,CAAC;AAER;;GAEG;AACH,MAAM,MAAM,cAAc,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,qBAAqB,GACrB,qBAAqB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,QAAQ,EAAE,OAAO,MAAM,CAAA;CAAE,CAAC;AAEnE;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED,qGAAqG;AACrG,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B,gEAAgE;AAChE,MAAM,MAAM,aAAa,GACtB,KAAK,GACL,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,MAAM,GACN,QAAQ,GACR,MAAM,GACN,OAAO,GACP,OAAO,GACP,OAAO,CAAC;AAEX,iEAAiE;AACjE,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B,gDAAgD;AAChD,MAAM,WAAW,YAAY;IAC5B,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAIxD;AAED,2CAA2C;AAC3C,MAAM,WAAW,WAAW;IAC3B,4CAA4C;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gEAAgE;IAChE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC;IAC3B,qCAAqC;IACrC,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,qEAAqE;IACrE,KAAK,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,wEAAwE;AACxE,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,OAAO,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,IAAI,GAAG,CAAC,GAC/G,KAAK,CAAC;AAET;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,YAAY,CACvB,CAAC,EACD,UAAU,EACV,CAAC,SAAS,SAAS,CAAC,MAAM,UAAU,CAAC,EAAE,GAAG,EAAE,IAE1C,CAAC,GACD,mBAAmB,CACpB,CAAC,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,KAAK,CACtF,CAAC;AAEH;;;;;GAKG;AACH,MAAM,WAAW,cAAc,CAAC,OAAO,SAAS,MAAM,EAAE,CAAC,SAAS,SAAS,OAAO,EAAE,GAAG,EAAE;IACxF;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC;IACZ;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE;IAAE,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG,MAAM,GAAG,SAAS,CAG7G;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,CAAC;AAEhE;;;;;;;;;GASG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,OAAO,GAAG,YAAY,CAAC;AAEjG;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAC9B,YAAY,GACZ,gBAAgB,GAChB,kBAAkB,GAClB,aAAa,GACb,cAAc,GACd,YAAY,GACZ,SAAS,GACT,SAAS,GACT,IAAI,CAAC;AAER;;GAEG;AACH,MAAM,MAAM,cAAc,GACvB,kBAAkB,GAClB,kBAAkB,GAClB,oBAAoB,GACpB,oBAAoB,GACpB,oBAAoB,CAAC"}

package/script/src/types.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toNanoID = toNanoID;
+exports.parseIssuerRef = parseIssuerRef;
 exports.joinIncludes = joinIncludes;
 /**
  * Cast a raw string from the API to a {@link NanoID}.
@@ -13,6 +14,17 @@ exports.joinIncludes = joinIncludes;
 function toNanoID(raw) {
     return raw;
 }
+/**
+ * Split a namespaced issuer reference (`"<type>:<id>"`) into its type and bare id.
+ *
+ * A bare id with no prefix yields an empty `type`.
+ */
+function parseIssuerRef(ref) {
+    const sep = ref.indexOf(':');
+    if (sep === -1)
+        return { type: '', id: toNanoID(ref) };
+    return { type: ref.slice(0, sep), id: toNanoID(ref.slice(sep + 1)) };
+}
 /**
  * Joins the `include` and `rawInclude` arrays into a single comma-separated string
  * suitable for the `?include=` query parameter.

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

@@ -1,138 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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

@@ -1,122 +0,0 @@
-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;
-    }
-}