@meowpanel/api 0.3.0 → 0.5.0

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

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