@studiometa/forge-sdk 0.0.1 → 0.2.0

package/dist/resources/ssh-keys.d.ts

@@ -0,0 +1,83 @@
+import type { CreateSshKeyData, ForgeSshKey, HttpClient } from "@studiometa/forge-api";
+import { BaseCollection } from "./base.ts";
+import { AsyncPaginatedIterator } from "../pagination.ts";
+/**
+ * Options for listing SSH keys.
+ */
+export interface SshKeyListOptions {
+    /** Page number to fetch (1-indexed). */
+    page?: number;
+}
+/**
+ * Collection of SSH keys on a server.
+ *
+ * Access via `forge.server(id).sshKeys`.
+ *
+ * @example
+ * ```ts
+ * const keys = await forge.server(123).sshKeys.list();
+ * ```
+ */
+export declare class SshKeysCollection extends BaseCollection {
+    private readonly serverId;
+    /** @internal */
+    constructor(client: HttpClient, serverId: number);
+    private get basePath();
+    /**
+     * List SSH keys on this server.
+     *
+     * @example
+     * ```ts
+     * const keys = await forge.server(123).sshKeys.list();
+     *
+     * // Fetch a specific page:
+     * const page2 = await forge.server(123).sshKeys.list({ page: 2 });
+     * ```
+     */
+    list(options?: SshKeyListOptions): Promise<ForgeSshKey[]>;
+    /**
+     * Iterate over all SSH keys across all pages.
+     *
+     * @example
+     * ```ts
+     * for await (const key of forge.server(123).sshKeys.all()) {
+     *   console.log(key);
+     * }
+     *
+     * // Or collect all at once:
+     * const keys = await forge.server(123).sshKeys.all().toArray();
+     * ```
+     */
+    all(options?: Omit<SshKeyListOptions, "page">): AsyncPaginatedIterator<ForgeSshKey>;
+    /**
+     * Get a specific SSH key.
+     *
+     * @example
+     * ```ts
+     * const key = await forge.server(123).sshKeys.get(789);
+     * ```
+     */
+    get(keyId: number): Promise<ForgeSshKey>;
+    /**
+     * Create a new SSH key.
+     *
+     * @example
+     * ```ts
+     * const key = await forge.server(123).sshKeys.create({
+     *   name: 'deploy-key',
+     *   key: 'ssh-rsa AAAA...',
+     * });
+     * ```
+     */
+    create(data: CreateSshKeyData): Promise<ForgeSshKey>;
+    /**
+     * Delete an SSH key.
+     *
+     * @example
+     * ```ts
+     * await forge.server(123).sshKeys.delete(789);
+     * ```
+     */
+    delete(keyId: number): Promise<void>;
+}
+//# sourceMappingURL=ssh-keys.d.ts.map

package/dist/resources/ssh-keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ssh-keys.d.ts","sourceRoot":"","sources":["../../src/resources/ssh-keys.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,WAAW,EACX,UAAU,EAGX,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;GASG;AACH,qBAAa,iBAAkB,SAAQ,cAAc;IAIjD,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAH3B,gBAAgB;gBAEd,MAAM,EAAE,UAAU,EACD,QAAQ,EAAE,MAAM;IAKnC,OAAO,KAAK,QAAQ,GAEnB;IAED;;;;;;;;;;OAUG;IACG,IAAI,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAMnE;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,OAAO,GAAE,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAM,GAAG,sBAAsB,CAAC,WAAW,CAAC;IAIvF;;;;;;;OAOG;IACG,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAK9C;;;;;;;;;;OAUG;IACG,MAAM,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,WAAW,CAAC;IAK1D;;;;;;;OAOG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAG3C"}

package/dist/test-utils.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Create a mock `fetch` function for use in SDK tests.
+ *
+ * The handler receives the request URL and init options, and should return
+ * the data to be serialised as JSON in the response body.
+ *
+ * @param handler A function that receives `(url, init)` and returns response data.
+ * @returns A vitest mock function compatible with the `fetch` signature.
+ *
+ * @example
+ * ```ts
+ * import { describe, it, expect } from 'vitest';
+ * import { Forge } from '@studiometa/forge-sdk';
+ * import { createMockFetch } from '@studiometa/forge-sdk/test-utils';
+ *
+ * describe('my feature', () => {
+ *   it('lists servers', async () => {
+ *     const mockFetch = createMockFetch(() => ({ servers: [] }));
+ *     const forge = new Forge('test-token', { fetch: mockFetch });
+ *     const servers = await forge.servers.list();
+ *     expect(servers).toEqual([]);
+ *   });
+ * });
+ * ```
+ */
+export declare function createMockFetch(handler: (url: string, init?: RequestInit) => unknown): typeof fetch;
+//# sourceMappingURL=test-utils.d.ts.map

package/dist/test-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-utils.d.ts","sourceRoot":"","sources":["../src/test-utils.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,eAAe,CAC7B,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,GACpD,OAAO,KAAK,CASd"}

package/dist/test-utils.js

@@ -0,0 +1,38 @@
+import { vi } from "vitest";
+/**
+* Create a mock `fetch` function for use in SDK tests.
+*
+* The handler receives the request URL and init options, and should return
+* the data to be serialised as JSON in the response body.
+*
+* @param handler A function that receives `(url, init)` and returns response data.
+* @returns A vitest mock function compatible with the `fetch` signature.
+*
+* @example
+* ```ts
+* import { describe, it, expect } from 'vitest';
+* import { Forge } from '@studiometa/forge-sdk';
+* import { createMockFetch } from '@studiometa/forge-sdk/test-utils';
+*
+* describe('my feature', () => {
+*   it('lists servers', async () => {
+*     const mockFetch = createMockFetch(() => ({ servers: [] }));
+*     const forge = new Forge('test-token', { fetch: mockFetch });
+*     const servers = await forge.servers.list();
+*     expect(servers).toEqual([]);
+*   });
+* });
+* ```
+*/
+function createMockFetch(handler) {
+	return vi.fn(async (url, init) => {
+		const data = handler(typeof url === "string" ? url : url instanceof URL ? url.toString() : url.url, init);
+		return new Response(JSON.stringify(data), {
+			status: 200,
+			headers: { "Content-Type": "application/json" }
+		});
+	});
+}
+export { createMockFetch };
+
+//# sourceMappingURL=test-utils.js.map

package/dist/test-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-utils.js","names":[],"sources":["../src/test-utils.ts"],"sourcesContent":["import { vi } from \"vitest\";\n\n/**\n * Create a mock `fetch` function for use in SDK tests.\n *\n * The handler receives the request URL and init options, and should return\n * the data to be serialised as JSON in the response body.\n *\n * @param handler A function that receives `(url, init)` and returns response data.\n * @returns A vitest mock function compatible with the `fetch` signature.\n *\n * @example\n * ```ts\n * import { describe, it, expect } from 'vitest';\n * import { Forge } from '@studiometa/forge-sdk';\n * import { createMockFetch } from '@studiometa/forge-sdk/test-utils';\n *\n * describe('my feature', () => {\n *   it('lists servers', async () => {\n *     const mockFetch = createMockFetch(() => ({ servers: [] }));\n *     const forge = new Forge('test-token', { fetch: mockFetch });\n *     const servers = await forge.servers.list();\n *     expect(servers).toEqual([]);\n *   });\n * });\n * ```\n */\nexport function createMockFetch(\n  handler: (url: string, init?: RequestInit) => unknown,\n): typeof fetch {\n  return vi.fn(async (url: string | URL | Request, init?: RequestInit) => {\n    const urlStr = typeof url === \"string\" ? url : url instanceof URL ? url.toString() : url.url;\n    const data = handler(urlStr, init);\n    return new Response(JSON.stringify(data), {\n      status: 200,\n      headers: { \"Content-Type\": \"application/json\" },\n    });\n  }) as unknown as typeof fetch;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,SAAgB,gBACd,SACc;AACd,QAAO,GAAG,GAAG,OAAO,KAA6B,SAAuB;EAEtE,MAAM,OAAO,QADE,OAAO,QAAQ,WAAW,MAAM,eAAe,MAAM,IAAI,UAAU,GAAG,IAAI,KAC5D,KAAK;AAClC,SAAO,IAAI,SAAS,KAAK,UAAU,KAAK,EAAE;GACxC,QAAQ;GACR,SAAS,EAAE,gBAAgB,oBAAoB;GAChD,CAAC;GACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studiometa/forge-sdk",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Laravel Forge TypeScript SDK — fluent, chainable, fully-typed API client",
   "keywords": [
     "api-client",
@@ -16,7 +16,43 @@
     "url": "https://github.com/studiometa/forge-tools",
     "directory": "packages/sdk"
   },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./test-utils": {
+      "types": "./dist/test-utils.d.ts",
+      "import": "./dist/test-utils.js"
+    }
+  },
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "dev": "vite build --watch",
+    "build": "vite build && tsc --emitDeclarationOnly",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:ci": "vitest run --coverage",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@studiometa/forge-api": "*"
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^4.1.0-beta.4",
+    "typescript": "^5.7.3",
+    "vite": "^8.0.0-beta.14",
+    "vitest": "^4.1.0-beta.4"
+  },
+  "engines": {
+    "node": ">=18.0.0"
   }
 }