@meowpanel/api 0.2.0 → 0.4.0

package/script/src/resources/servers/sub-users.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerUserManager = exports.ServerUser = void 0;
+const users_js_1 = require("../users.js");
+/**
+ * A user granted access to a server (or server group), with their scoped grants.
+ *
+ * Retrieved via {@link ServerUserManager.list} or {@link ServerUserManager.get}.
+ */
+class ServerUser {
+    /** The underlying user. */
+    user;
+    /** The permissions granted to this user at the resource scope. */
+    permissions;
+    /** How this user is attached. See {@link ServerUserKind}. */
+    kind;
+    /** @internal */
+    constructor(data) {
+        this.user = new users_js_1.User(data.user);
+        this.permissions = data.permissions.map((g) => ({
+            name: g.name,
+            grantedAt: new Date(g.granted_at),
+            expiresAt: g.expires_at ? new Date(g.expires_at) : null,
+        }));
+        this.kind = data.kind;
+    }
+}
+exports.ServerUser = ServerUser;
+function expiresAtBody(expiresAt) {
+    if (expiresAt === undefined)
+        return undefined;
+    return expiresAt === null ? null : expiresAt.toISOString();
+}
+/**
+ * Manages the sub-users of a server or server group.
+ *
+ * Access via `server.subUsers`.
+ *
+ * @example
+ * ```ts ignore
+ * await server.subUsers.add({ email: 'teammate@example.com', permissions: ['server.console.read'] });
+ * const subUsers = await server.subUsers.list();
+ * ```
+ */
+class ServerUserManager {
+    basePath;
+    http;
+    /** @internal */
+    constructor(basePath, http) {
+        this.basePath = basePath;
+        this.http = http;
+    }
+    /** List the resource's sub-users. */
+    async list() {
+        const data = await this.http.get(`${this.basePath}/users`);
+        return data.map((d) => new ServerUser(d));
+    }
+    /** Fetch a single sub-user by user ID. */
+    async get(userId) {
+        const data = await this.http.get(`${this.basePath}/users/${userId}`);
+        return new ServerUser(data);
+    }
+    /**
+     * Add a sub-user, or add permissions to an existing one.
+     *
+     * Identify the user by `userId`, or by `email` (an unknown email invites a new user,
+     * which requires `user.manage` and a configured email transport). Existing grants are kept.
+     */
+    async add(input) {
+        const body = {
+            permissions: input.permissions,
+            expires_at: expiresAtBody(input.expiresAt),
+        };
+        if ('userId' in input)
+            body['user_id'] = input.userId;
+        else
+            body['email'] = input.email;
+        const data = await this.http.post(`${this.basePath}/users`, body);
+        return new ServerUser(data);
+    }
+    /**
+     * Replace a sub-user's permission set. Grants not listed are revoked.
+     *
+     * @param userId  The sub-user's NanoID.
+     * @param payload The exact permission set to grant, and an optional expiry.
+     */
+    async update(userId, payload) {
+        const data = await this.http.patch(`${this.basePath}/users/${userId}`, {
+            permissions: payload.permissions,
+            expires_at: expiresAtBody(payload.expiresAt),
+        });
+        return new ServerUser(data);
+    }
+    /** Remove a sub-user, revoking all their grants at the resource scope. */
+    async remove(userId) {
+        await this.http.delete(`${this.basePath}/users/${userId}`);
+    }
+}
+exports.ServerUserManager = ServerUserManager;

package/script/src/resources/servers/types.d.ts

@@ -1,6 +1,6 @@
 import type { ISODate, NanoID, PowerState, ServerRestrictedState, SftpPermission } from '../../types.js';
 import type { EggData } from '../eggs.js';
-import type { MemberData } from '../members.js';
+import type { UserData } from '../users.js';
 import type { ServerGroupData } from '../server-groups.js';
 /** A single egg environment variable and its value for a server. @internal */
 export interface StartupVariableData {
@@ -22,7 +22,7 @@ export interface ServerStatusData {
             rx_bytes: number;
             tx_bytes: number;
         };
-        uptime_ms: number;
+        uptime: number;
         disk_bytes: number;
     } | null;
 }
@@ -46,7 +46,7 @@ export interface ServerBuildData {
 export interface ServerAllocationPortData {
     id: string;
     description?: string | null;
-    port_id?: string;
+    meta_id?: string;
     meta?: {
         id: string;
         ip: string;
@@ -73,6 +73,21 @@ export interface ServerProfileData {
     name: string;
     description?: string | null;
     notes?: string | null;
+    /** Requires `server.egg.read`. Populated with `?include=egg`. */
+    egg_id?: string;
+    egg?: EggData;
+    egg_image_id?: string;
+    egg_image?: {
+        id: string;
+        image: string;
+    };
+    egg_image_override?: string | null;
+    skip_install_scripts?: boolean;
+    /** Requires `server.startup.read`. Populated with `?include=startup`. */
+    startup?: {
+        command: string;
+        variables: Record<string, StartupVariableData>;
+    } | null;
     folder?: string | null;
     is_active: boolean;
     created_at: ISODate;
@@ -80,7 +95,7 @@ export interface ServerProfileData {
 }
 /** Raw API shape for an activity log job log entry. @internal */
 export interface ActivityJobLogData {
-    type: string;
+    event: string;
     metadata: Record<string, unknown>;
     created_at: ISODate;
 }
@@ -99,8 +114,14 @@ export interface ActivityLogData {
     event: string;
     server_id?: string | null;
     node_id?: string | null;
+    group_id?: string | null;
+    host_id?: string | null;
     issuer_id?: string | null;
-    issuer?: MemberData | null;
+    issuer?: UserData | null;
+    /** The user an action was performed on, when applicable. */
+    subject_id?: string | null;
+    subject?: UserData | null;
+    /** Requires `application.activities.ip.read`. */
     ip?: string | null;
     metadata: Record<string, unknown>;
     job_id?: string | null;
@@ -116,7 +137,7 @@ export interface SftpUserData {
     password?: string;
     paths: Record<string, SftpPermission[]>;
     owner_id: string;
-    owner?: MemberData | null;
+    owner?: UserData | null;
     last_login_at: ISODate | null;
     created_at: ISODate;
     updated_at: ISODate;
@@ -157,20 +178,8 @@ export interface ServerData {
     restricted_state: ServerRestrictedState;
     group_id: string;
     group?: ServerGroupData;
-    egg_id: string;
-    egg?: EggData;
-    egg_image_id?: string;
-    egg_image?: {
-        id: string;
-        image: string;
-    };
-    egg_image_override?: string | null;
     status?: ServerStatusData | null;
     build?: ServerBuildData | null;
-    startup?: {
-        command: string;
-        variables: Record<string, StartupVariableData>;
-    } | null;
     allocations?: ServerAllocationsData | null;
     profiles?: ServerProfileData[] | null;
     created_at: ISODate;
@@ -189,13 +198,6 @@ export interface UpdateServerPayload {
         ip: string;
         port: number;
     };
-    /** Update startup command and/or environment variables. */
-    startup?: {
-        /** New startup command override, or `null` to reset to the egg default. */
-        command?: string | null;
-        /** Map of env variable keys to new values (or `null` to reset to default). */
-        variables?: Record<string, string | null>;
-    };
 }
 export type { ISODate, NanoID, PowerState, ServerRestrictedState, SftpPermission };
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/src/resources/servers/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACzG,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAE3D,8EAA8E;AAC9E,MAAM,WAAW,mBAAmB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;CACd;AAED,2EAA2E;AAC3E,MAAM,WAAW,gBAAgB;IAChC,KAAK,EAAE,UAAU,CAAC;IAClB,WAAW,CAAC,EAAE;QACb,YAAY,EAAE,MAAM,CAAC;QACrB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,YAAY,EAAE,MAAM,CAAC;QACrB,OAAO,EAAE;YACR,QAAQ,EAAE,MAAM,CAAC;YACjB,QAAQ,EAAE,MAAM,CAAC;SACjB,CAAC;QACF,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;KACnB,GAAG,IAAI,CAAC;CACT;AAED,8DAA8D;AAC9D,MAAM,WAAW,eAAe;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,MAAM,CAAC,EAAE;QACR,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB,GAAG,IAAI,CAAC;CACT;AAED,mEAAmE;AACnE,MAAM,WAAW,wBAAwB;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE;QACN,EAAE,EAAE,MAAM,CAAC;QACX,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;QAC3B,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACtB,UAAU,EAAE,OAAO,CAAC;QACpB,UAAU,EAAE,OAAO,CAAC;KACpB,GAAG,IAAI,CAAC;IACT,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,8DAA8D;AAC9D,MAAM,WAAW,qBAAqB;IACrC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,EAAE,wBAAwB,EAAE,CAAC;CAClC;AAED,oDAAoD;AACpD,MAAM,WAAW,iBAAiB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,iEAAiE;AACjE,MAAM,WAAW,kBAAkB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,mDAAmD;AACnD,MAAM,WAAW,eAAe;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,aAAa,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC/C,IAAI,EAAE,kBAAkB,EAAE,CAAC;IAC3B,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7B,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,yDAAyD;AACzD,MAAM,WAAW,eAAe;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAC3B,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,GAAG,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAC7B,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,gDAAgD;AAChD,MAAM,WAAW,YAAY;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAC1B,aAAa,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9B,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,qEAAqE;AACrE,MAAM,WAAW,eAAe;IAC/B,UAAU,EAAE;QACX,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;KACb,CAAC;IACF,KAAK,EAAE,YAAY,EAAE,CAAC;CACtB;AAED,mFAAmF;AACnF,MAAM,WAAW,aAAa;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,aAAa,EAAE,CAAC;AAEnD,4CAA4C;AAC5C,MAAM,WAAW,UAAU;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,gBAAgB,EAAE,qBAAqB,CAAC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1C,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,MAAM,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACjC,KAAK,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAC/B,OAAO,CAAC,EAAE;QACT,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;KAC/C,GAAG,IAAI,CAAC;IACT,WAAW,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC3C,QAAQ,CAAC,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;IACtC,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,wEAAwE;AACxE,MAAM,WAAW,mBAAmB;IACnC,wBAAwB;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,4CAA4C;IAC5C,iBAAiB,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACjD,2DAA2D;IAC3D,OAAO,CAAC,EAAE;QACT,2EAA2E;QAC3E,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,8EAA8E;QAC9E,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;KAC1C,CAAC;CACF;AAED,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,qBAAqB,EAAE,cAAc,EAAE,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/src/resources/servers/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACzG,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAE3D,8EAA8E;AAC9E,MAAM,WAAW,mBAAmB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;CACd;AAED,2EAA2E;AAC3E,MAAM,WAAW,gBAAgB;IAChC,KAAK,EAAE,UAAU,CAAC;IAClB,WAAW,CAAC,EAAE;QACb,YAAY,EAAE,MAAM,CAAC;QACrB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,YAAY,EAAE,MAAM,CAAC;QACrB,OAAO,EAAE;YACR,QAAQ,EAAE,MAAM,CAAC;YACjB,QAAQ,EAAE,MAAM,CAAC;SACjB,CAAC;QACF,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;KACnB,GAAG,IAAI,CAAC;CACT;AAED,8DAA8D;AAC9D,MAAM,WAAW,eAAe;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,MAAM,CAAC,EAAE;QACR,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB,GAAG,IAAI,CAAC;CACT;AAED,mEAAmE;AACnE,MAAM,WAAW,wBAAwB;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE;QACN,EAAE,EAAE,MAAM,CAAC;QACX,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;QAC3B,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACtB,UAAU,EAAE,OAAO,CAAC;QACpB,UAAU,EAAE,OAAO,CAAC;KACpB,GAAG,IAAI,CAAC;IACT,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,8DAA8D;AAC9D,MAAM,WAAW,qBAAqB;IACrC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,EAAE,wBAAwB,EAAE,CAAC;CAClC;AAED,oDAAoD;AACpD,MAAM,WAAW,iBAAiB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,iEAAiE;IACjE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1C,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,yEAAyE;IACzE,OAAO,CAAC,EAAE;QACT,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;KAC/C,GAAG,IAAI,CAAC;IACT,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,iEAAiE;AACjE,MAAM,WAAW,kBAAkB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,mDAAmD;AACnD,MAAM,WAAW,eAAe;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,aAAa,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC/C,IAAI,EAAE,kBAAkB,EAAE,CAAC;IAC3B,YAAY,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7B,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,yDAAyD;AACzD,MAAM,WAAW,eAAe;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IACzB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC1B,iDAAiD;IACjD,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,GAAG,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAC7B,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,gDAAgD;AAChD,MAAM,WAAW,YAAY;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IACxB,aAAa,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9B,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,qEAAqE;AACrE,MAAM,WAAW,eAAe;IAC/B,UAAU,EAAE;QACX,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;KACb,CAAC;IACF,KAAK,EAAE,YAAY,EAAE,CAAC;CACtB;AAED,mFAAmF;AACnF,MAAM,WAAW,aAAa;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,aAAa,EAAE,CAAC;AAEnD,4CAA4C;AAC5C,MAAM,WAAW,UAAU;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,gBAAgB,EAAE,qBAAqB,CAAC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,MAAM,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACjC,KAAK,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAC/B,WAAW,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC3C,QAAQ,CAAC,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC;IACtC,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED,wEAAwE;AACxE,MAAM,WAAW,mBAAmB;IACnC,wBAAwB;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,4CAA4C;IAC5C,iBAAiB,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CACjD;AAED,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,qBAAqB,EAAE,cAAc,EAAE,CAAC"}

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

@@ -0,0 +1,124 @@
+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';
+import { ApiKey, type CreateApiKeyPayload } from './api-keys.js';
+/** Raw API shape for a system. @internal */
+export interface SystemData {
+    id: string;
+    name: string;
+    description: string | null;
+    permissions?: string[];
+    created_at: ISODate;
+    updated_at: ISODate;
+}
+/**
+ * A non-user identity (bootstrap or automation) that owns API keys.
+ *
+ * API keys owned by a system inherit the system's permissions.
+ *
+ * Retrieved via {@link SystemsNamespace.get} or {@link SystemsNamespace.list}.
+ */
+export declare class System extends ReactiveResource {
+    /** The system's unique NanoID. */
+    readonly id: NanoID;
+    /** Display name. */
+    name: string;
+    /** Optional description. */
+    description: string | null;
+    /** The system's permission scopes. Requires `?include=permissions`. */
+    permissions: string[] | undefined;
+    /** When this system was created. */
+    createdAt: Date;
+    /** When this system was last updated. */
+    updatedAt: Date;
+    /** @internal */
+    constructor(data: SystemData);
+    /** Apply raw API data to this system instance, updating all mutable fields. */
+    applyData(data: SystemData): void;
+}
+/** Valid include keys for system endpoints. */
+export type SystemInclude = 'permissions';
+/** Fields accepted when creating a system. */
+export interface CreateSystemPayload {
+    name: string;
+    description?: string;
+}
+/** Fields accepted when updating a system. All optional. */
+export interface UpdateSystemPayload {
+    name?: string;
+    description?: string;
+}
+/** The one-time result of creating a system API key. */
+export interface SystemApiKeyResult {
+    name: string;
+    description: string | null;
+    /** The one-time bearer token. Returned only here. */
+    token: string;
+}
+/** Typed events emitted by {@link SystemsNamespace}. */
+export interface SystemEvents {
+    created: System;
+    updated: System;
+    deleted: NanoID;
+}
+/**
+ * Manages the API keys owned by a specific system.
+ *
+ * Access via `api.systems.keys(systemId)`.
+ */
+export declare class SystemKeysManager {
+    private readonly systemId;
+    private readonly http;
+    /** @internal */
+    constructor(systemId: NanoID, http: HttpClient);
+    /** List the system's active API keys. */
+    list(): Promise<ApiKey[]>;
+    /**
+     * Create an API key owned by the system.
+     *
+     * The returned `token` is the only time the bearer token is available. Store it securely.
+     */
+    create(payload: CreateApiKeyPayload): Promise<SystemApiKeyResult>;
+    /** Revoke a system API key. */
+    revoke(keyId: NanoID): Promise<void>;
+}
+/**
+ * Namespace for system (non-user identity) management.
+ *
+ * Access via `api.systems`.
+ *
+ * @example
+ * ```ts ignore
+ * const system = await api.systems.create({ name: 'CI deploy' });
+ * const { token } = await api.systems.keys(system.id).create({ name: 'pipeline', permissions: ['server.read'] });
+ * ```
+ */
+export declare class SystemsNamespace extends ResourceNamespace<System, SystemEvents> {
+    /** @internal */
+    constructor(http: HttpClient);
+    /**
+     * Fetch a paginated list of systems.
+     *
+     * @param opts Pagination, search, and include options.
+     */
+    list(opts?: {
+        page?: number;
+        perPage?: number;
+        search?: string;
+        include?: SystemInclude[];
+    }): Promise<Paginated<System>>;
+    /** Fetch a single system by ID. */
+    get(id: NanoID, opts?: {
+        include?: SystemInclude[];
+    }): Promise<System>;
+    /** Create a new system. */
+    create(payload: CreateSystemPayload): Promise<System>;
+    /** Update a system's name or description. */
+    update(id: NanoID, payload: UpdateSystemPayload): Promise<System>;
+    /** Delete a system. Fails if it still owns active API keys. */
+    delete(id: NanoID): Promise<void>;
+    /** Manage the API keys owned by a system. */
+    keys(systemId: NanoID): SystemKeysManager;
+}
+//# sourceMappingURL=systems.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"systems.d.ts","sourceRoot":"","sources":["../../../src/src/resources/systems.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,EAAgB,KAAK,MAAM,EAAE,KAAK,SAAS,EAAY,MAAM,aAAa,CAAC;AAChG,OAAO,EAAE,MAAM,EAAmB,KAAK,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAElF,4CAA4C;AAC5C,MAAM,WAAW,UAAU;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;GAMG;AACH,qBAAa,MAAO,SAAQ,gBAAgB;IAC3C,kCAAkC;IAClC,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,oBAAoB;IACb,IAAI,EAAG,MAAM,CAAC;IACrB,4BAA4B;IACrB,WAAW,EAAG,MAAM,GAAG,IAAI,CAAC;IACnC,uEAAuE;IAChE,WAAW,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACzC,oCAAoC;IAC7B,SAAS,EAAG,IAAI,CAAC;IACxB,yCAAyC;IAClC,SAAS,EAAG,IAAI,CAAC;IAExB,gBAAgB;gBACG,IAAI,EAAE,UAAU;IAMnC,+EAA+E;IACxE,SAAS,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI;CAQxC;AAED,+CAA+C;AAC/C,MAAM,MAAM,aAAa,GAAG,aAAa,CAAC;AAE1C,8CAA8C;AAC9C,MAAM,WAAW,mBAAmB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,4DAA4D;AAC5D,MAAM,WAAW,mBAAmB;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,wDAAwD;AACxD,MAAM,WAAW,kBAAkB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,qDAAqD;IACrD,KAAK,EAAE,MAAM,CAAC;CACd;AAED,wDAAwD;AACxD,MAAM,WAAW,YAAY;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,qBAAa,iBAAiB;IAG5B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,IAAI;IAHtB,gBAAgB;gBAEE,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,UAAU;IAGlC,yCAAyC;IAC5B,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAKtC;;;;OAIG;IACU,MAAM,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAQ9E,+BAA+B;IAClB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGjD;AAED;;;;;;;;;;GAUG;AACH,qBAAa,gBAAiB,SAAQ,iBAAiB,CAAC,MAAM,EAAE,YAAY,CAAC;IAC5E,gBAAgB;gBACG,IAAI,EAAE,UAAU;IAInC;;;;OAIG;IACU,IAAI,CAChB,IAAI,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,aAAa,EAAE,CAAA;KAAO,GACxF,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAW7B,mCAAmC;IACtB,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,GAAE;QAAE,OAAO,CAAC,EAAE,aAAa,EAAE,CAAA;KAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAQvF,2BAA2B;IACd,MAAM,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;IAQlE,6CAA6C;IAChC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;IAQ9E,+DAA+D;IAClD,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM9C,6CAA6C;IACtC,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,iBAAiB;CAGhD"}

package/script/src/resources/systems.js

@@ -0,0 +1,145 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SystemsNamespace = exports.SystemKeysManager = exports.System = void 0;
+const namespace_js_1 = require("../namespace.js");
+const reactive_js_1 = require("../reactive.js");
+const types_js_1 = require("../types.js");
+const api_keys_js_1 = require("./api-keys.js");
+/**
+ * A non-user identity (bootstrap or automation) that owns API keys.
+ *
+ * API keys owned by a system inherit the system's permissions.
+ *
+ * Retrieved via {@link SystemsNamespace.get} or {@link SystemsNamespace.list}.
+ */
+class System extends reactive_js_1.ReactiveResource {
+    /** The system's unique NanoID. */
+    id;
+    /** Display name. */
+    name;
+    /** Optional description. */
+    description;
+    /** The system's permission scopes. Requires `?include=permissions`. */
+    permissions;
+    /** When this system was created. */
+    createdAt;
+    /** When this system was last updated. */
+    updatedAt;
+    /** @internal */
+    constructor(data) {
+        super();
+        this.id = (0, types_js_1.toNanoID)(data.id);
+        this.applyData(data);
+    }
+    /** Apply raw API data to this system instance, updating all mutable fields. */
+    applyData(data) {
+        this.name = data.name;
+        this.description = data.description;
+        this.permissions = data.permissions;
+        this.createdAt = new Date(data.created_at);
+        this.updatedAt = new Date(data.updated_at);
+        this.notify();
+    }
+}
+exports.System = System;
+/**
+ * Manages the API keys owned by a specific system.
+ *
+ * Access via `api.systems.keys(systemId)`.
+ */
+class SystemKeysManager {
+    systemId;
+    http;
+    /** @internal */
+    constructor(systemId, http) {
+        this.systemId = systemId;
+        this.http = http;
+    }
+    /** List the system's active API keys. */
+    async list() {
+        const data = await this.http.get(`/systems/${this.systemId}/api-keys`);
+        return data.map((d) => new api_keys_js_1.ApiKey(d));
+    }
+    /**
+     * Create an API key owned by the system.
+     *
+     * The returned `token` is the only time the bearer token is available. Store it securely.
+     */
+    async create(payload) {
+        const data = await this.http.post(`/systems/${this.systemId}/api-keys`, payload);
+        return { name: data.name, description: data.description, token: data.key };
+    }
+    /** Revoke a system API key. */
+    async revoke(keyId) {
+        await this.http.delete(`/systems/${this.systemId}/api-keys/${keyId}`);
+    }
+}
+exports.SystemKeysManager = SystemKeysManager;
+/**
+ * Namespace for system (non-user identity) management.
+ *
+ * Access via `api.systems`.
+ *
+ * @example
+ * ```ts ignore
+ * const system = await api.systems.create({ name: 'CI deploy' });
+ * const { token } = await api.systems.keys(system.id).create({ name: 'pipeline', permissions: ['server.read'] });
+ * ```
+ */
+class SystemsNamespace extends namespace_js_1.ResourceNamespace {
+    /** @internal */
+    constructor(http) {
+        super(http);
+    }
+    /**
+     * Fetch a paginated list of systems.
+     *
+     * @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('/systems', opts, extra);
+        const systems = result.data.map((d) => new System(d));
+        this.setCache(systems);
+        return { ...result, data: systems };
+    }
+    /** Fetch a single system by ID. */
+    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(`/systems/${id}`, { params });
+        return new System(data);
+    }
+    /** Create a new system. */
+    async create(payload) {
+        const data = await this.http.post('/systems', payload);
+        const system = new System(data);
+        this.addToCache(system);
+        this.emit('created', system);
+        return system;
+    }
+    /** Update a system's name or description. */
+    async update(id, payload) {
+        const data = await this.http.patch(`/systems/${id}`, payload);
+        const system = new System(data);
+        this.upsertCache(system);
+        this.emit('updated', system);
+        return system;
+    }
+    /** Delete a system. Fails if it still owns active API keys. */
+    async delete(id) {
+        await this.http.delete(`/systems/${id}`);
+        this.removeFromCache(id);
+        this.emit('deleted', id);
+    }
+    /** Manage the API keys owned by a system. */
+    keys(systemId) {
+        return new SystemKeysManager(systemId, this.http);
+    }
+}
+exports.SystemsNamespace = SystemsNamespace;