nixparse 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,404 @@
+import { z } from 'zod';
+
+interface ParserDefinition<T> {
+    schema: z.ZodType<T>;
+    parse: (raw: string) => unknown;
+}
+type AnyParserDefinition = ParserDefinition<unknown>;
+declare class CommandNotFoundError extends Error {
+    readonly command: string;
+    constructor(command: string);
+}
+declare class UnknownParserError extends Error {
+    readonly name: string;
+    constructor(name: string);
+}
+
+declare const builtinParsers: Record<string, AnyParserDefinition>;
+declare function registerParser<T>(name: string, definition: AnyParserDefinition): void;
+type BuiltinCommandName = keyof typeof builtinParsers;
+
+declare const ProcessInfoSchema: z.ZodObject<{
+    user: z.ZodString;
+    pid: z.ZodNumber;
+    cpu: z.ZodNumber;
+    mem: z.ZodNumber;
+    vsz: z.ZodNumber;
+    rss: z.ZodNumber;
+    tty: z.ZodString;
+    stat: z.ZodString;
+    start: z.ZodString;
+    time: z.ZodString;
+    command: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    user: string;
+    pid: number;
+    cpu: number;
+    mem: number;
+    vsz: number;
+    rss: number;
+    tty: string;
+    stat: string;
+    start: string;
+    time: string;
+    command: string;
+}, {
+    user: string;
+    pid: number;
+    cpu: number;
+    mem: number;
+    vsz: number;
+    rss: number;
+    tty: string;
+    stat: string;
+    start: string;
+    time: string;
+    command: string;
+}>;
+type ProcessInfo = z.infer<typeof ProcessInfoSchema>;
+
+declare const DiskUsageSchema: z.ZodObject<{
+    filesystem: z.ZodString;
+    blocksKb: z.ZodNumber;
+    usedKb: z.ZodNumber;
+    availableKb: z.ZodNumber;
+    usePercent: z.ZodNumber;
+    mountedOn: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    filesystem: string;
+    blocksKb: number;
+    usedKb: number;
+    availableKb: number;
+    usePercent: number;
+    mountedOn: string;
+}, {
+    filesystem: string;
+    blocksKb: number;
+    usedKb: number;
+    availableKb: number;
+    usePercent: number;
+    mountedOn: string;
+}>;
+type DiskUsage = z.infer<typeof DiskUsageSchema>;
+
+declare const DirSizeSchema: z.ZodObject<{
+    sizeKb: z.ZodNumber;
+    path: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    path: string;
+    sizeKb: number;
+}, {
+    path: string;
+    sizeKb: number;
+}>;
+type DirSize = z.infer<typeof DirSizeSchema>;
+
+declare const MemoryInfoSchema: z.ZodObject<{
+    mem: z.ZodObject<{
+        total: z.ZodNumber;
+        used: z.ZodNumber;
+        free: z.ZodNumber;
+        shared: z.ZodNumber;
+        buffCache: z.ZodNumber;
+        available: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        free: number;
+        total: number;
+        used: number;
+        shared: number;
+        buffCache: number;
+        available: number;
+    }, {
+        free: number;
+        total: number;
+        used: number;
+        shared: number;
+        buffCache: number;
+        available: number;
+    }>;
+    swap: z.ZodObject<{
+        total: z.ZodNumber;
+        used: z.ZodNumber;
+        free: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        free: number;
+        total: number;
+        used: number;
+    }, {
+        free: number;
+        total: number;
+        used: number;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    mem: {
+        free: number;
+        total: number;
+        used: number;
+        shared: number;
+        buffCache: number;
+        available: number;
+    };
+    swap: {
+        free: number;
+        total: number;
+        used: number;
+    };
+}, {
+    mem: {
+        free: number;
+        total: number;
+        used: number;
+        shared: number;
+        buffCache: number;
+        available: number;
+    };
+    swap: {
+        free: number;
+        total: number;
+        used: number;
+    };
+}>;
+type MemoryInfo = z.infer<typeof MemoryInfoSchema>;
+
+declare const OpenFileSchema: z.ZodObject<{
+    pid: z.ZodNumber;
+    command: z.ZodString;
+    user: z.ZodString;
+    fd: z.ZodString;
+    type: z.ZodString;
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    user: string;
+    pid: number;
+    command: string;
+    type: string;
+    fd: string;
+    name: string;
+}, {
+    user: string;
+    pid: number;
+    command: string;
+    type: string;
+    fd: string;
+    name: string;
+}>;
+type OpenFile = z.infer<typeof OpenFileSchema>;
+
+declare const MountPointSchema: z.ZodObject<{
+    device: z.ZodString;
+    path: z.ZodString;
+    fsType: z.ZodString;
+    options: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    path: string;
+    options: string[];
+    device: string;
+    fsType: string;
+}, {
+    path: string;
+    options: string[];
+    device: string;
+    fsType: string;
+}>;
+type MountPoint = z.infer<typeof MountPointSchema>;
+
+declare const LoggedInUserSchema: z.ZodObject<{
+    user: z.ZodString;
+    tty: z.ZodString;
+    loginTime: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    user: string;
+    tty: string;
+    loginTime: string;
+}, {
+    user: string;
+    tty: string;
+    loginTime: string;
+}>;
+type LoggedInUser = z.infer<typeof LoggedInUserSchema>;
+
+declare const UptimeInfoSchema: z.ZodObject<{
+    currentTime: z.ZodString;
+    upDays: z.ZodNumber;
+    upHours: z.ZodNumber;
+    upMinutes: z.ZodNumber;
+    users: z.ZodNumber;
+    loadAverage1m: z.ZodNumber;
+    loadAverage5m: z.ZodNumber;
+    loadAverage15m: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    currentTime: string;
+    upDays: number;
+    upHours: number;
+    upMinutes: number;
+    users: number;
+    loadAverage1m: number;
+    loadAverage5m: number;
+    loadAverage15m: number;
+}, {
+    currentTime: string;
+    upDays: number;
+    upHours: number;
+    upMinutes: number;
+    users: number;
+    loadAverage1m: number;
+    loadAverage5m: number;
+    loadAverage15m: number;
+}>;
+type UptimeInfo = z.infer<typeof UptimeInfoSchema>;
+
+declare const NetworkInterfaceSchema: z.ZodObject<{
+    ifindex: z.ZodNumber;
+    ifname: z.ZodString;
+    flags: z.ZodArray<z.ZodString, "many">;
+    mtu: z.ZodNumber;
+    qdisc: z.ZodString;
+    operstate: z.ZodString;
+    group: z.ZodString;
+    txqlen: z.ZodOptional<z.ZodNumber>;
+    link_type: z.ZodString;
+    address: z.ZodString;
+    broadcast: z.ZodOptional<z.ZodString>;
+    addr_info: z.ZodArray<z.ZodObject<{
+        family: z.ZodString;
+        local: z.ZodString;
+        prefixlen: z.ZodNumber;
+        broadcast: z.ZodOptional<z.ZodString>;
+        scope: z.ZodString;
+        label: z.ZodOptional<z.ZodString>;
+        valid_life_time: z.ZodNumber;
+        preferred_life_time: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        family: string;
+        local: string;
+        prefixlen: number;
+        scope: string;
+        valid_life_time: number;
+        preferred_life_time: number;
+        broadcast?: string | undefined;
+        label?: string | undefined;
+    }, {
+        family: string;
+        local: string;
+        prefixlen: number;
+        scope: string;
+        valid_life_time: number;
+        preferred_life_time: number;
+        broadcast?: string | undefined;
+        label?: string | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    ifindex: number;
+    ifname: string;
+    flags: string[];
+    mtu: number;
+    qdisc: string;
+    operstate: string;
+    group: string;
+    link_type: string;
+    address: string;
+    addr_info: {
+        family: string;
+        local: string;
+        prefixlen: number;
+        scope: string;
+        valid_life_time: number;
+        preferred_life_time: number;
+        broadcast?: string | undefined;
+        label?: string | undefined;
+    }[];
+    broadcast?: string | undefined;
+    txqlen?: number | undefined;
+}, {
+    ifindex: number;
+    ifname: string;
+    flags: string[];
+    mtu: number;
+    qdisc: string;
+    operstate: string;
+    group: string;
+    link_type: string;
+    address: string;
+    addr_info: {
+        family: string;
+        local: string;
+        prefixlen: number;
+        scope: string;
+        valid_life_time: number;
+        preferred_life_time: number;
+        broadcast?: string | undefined;
+        label?: string | undefined;
+    }[];
+    broadcast?: string | undefined;
+    txqlen?: number | undefined;
+}>;
+type NetworkInterface = z.infer<typeof NetworkInterfaceSchema>;
+declare const RouteEntrySchema: z.ZodObject<{
+    dst: z.ZodString;
+    gateway: z.ZodOptional<z.ZodString>;
+    dev: z.ZodOptional<z.ZodString>;
+    protocol: z.ZodOptional<z.ZodString>;
+    scope: z.ZodOptional<z.ZodString>;
+    prefsrc: z.ZodOptional<z.ZodString>;
+    flags: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    flags: string[];
+    dst: string;
+    scope?: string | undefined;
+    gateway?: string | undefined;
+    dev?: string | undefined;
+    protocol?: string | undefined;
+    prefsrc?: string | undefined;
+}, {
+    flags: string[];
+    dst: string;
+    scope?: string | undefined;
+    gateway?: string | undefined;
+    dev?: string | undefined;
+    protocol?: string | undefined;
+    prefsrc?: string | undefined;
+}>;
+type RouteEntry = z.infer<typeof RouteEntrySchema>;
+
+declare const SocketSchema: z.ZodObject<{
+    state: z.ZodString;
+    recvQ: z.ZodNumber;
+    sendQ: z.ZodNumber;
+    localAddress: z.ZodString;
+    localPort: z.ZodString;
+    peerAddress: z.ZodString;
+    peerPort: z.ZodString;
+    process: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    state: string;
+    recvQ: number;
+    sendQ: number;
+    localAddress: string;
+    localPort: string;
+    peerAddress: string;
+    peerPort: string;
+    process?: string | undefined;
+}, {
+    state: string;
+    recvQ: number;
+    sendQ: number;
+    localAddress: string;
+    localPort: string;
+    peerAddress: string;
+    peerPort: string;
+    process?: string | undefined;
+}>;
+type Socket = z.infer<typeof SocketSchema>;
+
+/**
+ * 生のコマンド出力テキストをパースし、Zodで検証した結果を返す。
+ * コマンドの実行は行わない(エージェント等が既に取得した出力を渡すケースを想定)。
+ */
+declare function parse<T = unknown>(name: string, raw: string): T;
+/**
+ * 組み込みコマンドを実行し、その出力をパースして返す。
+ * 引数を省略すると各パーサーの想定するデフォルト引数(`ps aux`等)を使う。
+ */
+declare function run<T = unknown>(name: BuiltinCommandName, args?: string[]): Promise<T>;
+
+export { type BuiltinCommandName, CommandNotFoundError, type DirSize, type DiskUsage, type LoggedInUser, type MemoryInfo, type MountPoint, type NetworkInterface, type OpenFile, type ParserDefinition, type ProcessInfo, type RouteEntry, type Socket, UnknownParserError, type UptimeInfo, parse, registerParser, run };