@theholocron/netlify-client 1.58.0-alpha.2 → 1.58.0-alpha.4

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import "@theholocron/http-client";
 import { ErrorSink, Logger } from "@theholocron/observability/core";
+/** Options for `createNetlifyClient`. */
 interface NetlifyClientOptions {
   /** Netlify Personal Access Token. */
   token: string;
@@ -14,20 +15,33 @@ interface NetlifyClientOptions {
 }
 /** Netlify site — the subset of fields consumers read/write. */
 interface NetlifySite {
+  /** The site's id. */
   id: string;
+  /** The site's name. */
   name: string;
+  /** The site's URL. */
   url: string;
+  /** The site's HTTPS URL. */
   ssl_url: string;
+  /** The URL of the site's page in the Netlify admin UI. */
   admin_url: string;
+  /** The id of the account that owns the site. */
   account_id: string;
+  /** The slug of the account that owns the site. */
   account_slug?: string;
+  /** The site's custom domain, or `null` when none is set. */
   custom_domain?: string | null;
 }
+/** What to send to Netlify to create a site. */
 interface NetlifyCreateSiteInput {
+  /** The site's name. */
   name: string;
+  /** A custom domain to set on the site. */
   custom_domain?: string;
 }
+/** What to send to Netlify to update a site. */
 interface NetlifyUpdateSiteInput {
+  /** The custom domain to set. */
   custom_domain?: string;
 }
 /**
@@ -37,14 +51,23 @@ interface NetlifyUpdateSiteInput {
  * `error`, `retrying`, `current`.
  */
 interface NetlifyDeploy {
+  /** The deploy's id. */
   id: string;
+  /** The id of the site the deploy belongs to. */
   site_id: string;
+  /** The deploy's state, a free-form string. */
   state: string;
+  /** The site's URL. */
   url: string;
+  /** The site's HTTPS URL. */
   ssl_url: string;
+  /** The URL of this specific deploy. */
   deploy_url: string;
+  /** The branch the deploy was built from, or `null`. */
   branch: string | null;
+  /** Why the deploy failed, when it did. */
   error_message?: string | null;
+  /** When the deploy was created, as an ISO timestamp. */
   created_at: string;
 }
 /**
@@ -66,8 +89,10 @@ interface NetlifyDeployFunctionSpec {
   name: string;
   /** Lambda runtime: `"js"` (Node.js, zipped) or `"go"` (zipped binary). */
   runtime?: "js" | "go";
+  /** The function's zip archive. */
   zip: Uint8Array;
 }
+/** What to deploy with `create()`: static files, functions, or both. */
 interface NetlifyCreateDeployInput {
   /** Static files, plain text — served as-is, no build step. */
   files?: Record<string, string>;
@@ -78,25 +103,42 @@ interface NetlifyCreateDeployInput {
 }
 /** Raw transport details `create()` needs beyond the generic `RestClient` — file/function uploads send a binary body, which `RestClient.request()` can't carry (always JSON-encodes a given body). */
 interface NetlifyRawTransport {
+  /** The Netlify token used for the upload requests. */
   token: string;
+  /** Override base URL, as for the client. */
   baseUrl?: string;
+  /** Override fetch, as for the client. */
   fetch?: typeof fetch;
 }
+/** The deploy contexts an environment variable value can apply to. */
 type NetlifyEnvContext = "all" | "dev" | "dev-server" | "branch-deploy" | "deploy-preview" | "production" | "branch";
+/** One value of an environment variable, for one deploy context. */
 interface NetlifyEnvVarValue {
+  /** The value's id. */
   id?: string;
+  /** The variable's value in this context. */
   value: string;
+  /** The deploy context the value applies to. */
   context: NetlifyEnvContext;
+  /** The branch name, when `context` is `"branch"`. */
   context_parameter?: string | null;
 }
+/** An environment variable on a site, with its values per context. */
 interface NetlifyEnvVar {
+  /** The variable's name. */
   key: string;
+  /** Where the variable is available. */
   scopes?: Array<"builds" | "functions" | "runtime" | "post-processing">;
+  /** The variable's values, one per context. */
   values: NetlifyEnvVarValue[];
 }
+/** The user the token belongs to. */
 interface NetlifyUser {
+  /** The user's id. */
   id?: string;
+  /** The user's full name. */
   full_name?: string;
+  /** The user's email address. */
   email?: string;
 }
 /**
@@ -120,6 +162,7 @@ interface NetlifyUser {
  * function's own dependencies need).
  */
 export declare function buildZip(files: Record<string, string | Uint8Array>): Uint8Array;
+/** Creates a Netlify client with `sites`, `deploys`, `env` and `user` groups sharing one REST client. */
 export declare function createNetlifyClient(opts: NetlifyClientOptions): {
   sites: {
     list: () => Promise<NetlifySite[]>;
@@ -142,5 +185,6 @@ export declare function createNetlifyClient(opts: NetlifyClientOptions): {
     get: () => Promise<NetlifyUser>;
   };
 };
+/** The client `createNetlifyClient` returns. */
 export type NetlifyClient = ReturnType<typeof createNetlifyClient>;
 export type { NetlifyClientOptions, NetlifyCreateDeployInput, NetlifyCreateSiteInput, NetlifyDeploy, NetlifyDeployFunctionSpec, NetlifyEnvContext, NetlifyEnvVar, NetlifyEnvVarValue, NetlifyRawTransport, NetlifySite, NetlifyUpdateSiteInput, NetlifyUser };

package/dist/index.mjs

@@ -275,6 +275,7 @@ function buildZip(files) {
 	return total;
 }
 // src/index.ts
+/** Creates a Netlify client with `sites`, `deploys`, `env` and `user` groups sharing one REST client. */
 function createNetlifyClient(opts) {
 	const rest = createNetlifyRestClient(opts);
 	return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/netlify-client",
-  "version": "1.58.0-alpha.2",
+  "version": "1.58.0-alpha.4",
   "description": "A TypeScript client for the Netlify API",
   "keywords": [
     "netlify",
@@ -32,7 +32,7 @@
     "dist"
   ],
   "dependencies": {
-    "@theholocron/http-client": "^1.58.0-alpha.2",
+    "@theholocron/http-client": "^1.58.0-alpha.4",
     "@theholocron/observability": "^0.6.1-alpha.1"
   },
   "devDependencies": {
@@ -45,10 +45,10 @@
     "tsdown": "^0.23.3",
     "typescript": "^5.9.3",
     "vitest": "^5.0.5",
-    "@theholocron/eslint-config": "^8.9.0-alpha.3",
-    "@theholocron/tsconfig": "^8.9.0-alpha.3",
-    "@theholocron/vitest-config": "^8.9.0-alpha.3",
-    "@theholocron/tsdown-config": "^8.9.0-alpha.3"
+    "@theholocron/eslint-config": "^8.9.0-alpha.5",
+    "@theholocron/tsdown-config": "^8.9.0-alpha.5",
+    "@theholocron/vitest-config": "^8.9.0-alpha.5",
+    "@theholocron/tsconfig": "^8.9.0-alpha.5"
   },
   "engines": {
     "node": ">=22.0.0"