TypeScript Types

All types are exported from keysetapp:

TypeScriptCopy
import type {
  KeysetConfig,
  KeysetMode,
  KeysetResponse,
  ContentEntry,
  ContentType,
  DashboardContentEntry,
} from "keysetapp";

---

KeysetConfig

Configuration object passed to the Keyset constructor.

TypeScriptCopy
interface KeysetConfig {
  apiKey: string;
  cacheTTL: number;
  baseUrl?: string;
  timeout?: number;
  retries?: number;
  cache?: CacheConfig;
}

See Configuration for field descriptions.

---

CacheConfig

TypeScriptCopy
interface CacheConfig {
  enabled?: boolean;
  ttl?: number; // milliseconds
}

---

KeysetMode

The operating mode inferred from the API key prefix.

TypeScriptCopy
type KeysetMode = "public" | "secret";

• "public" — key starts with pkey_, read-only
• "secret" — key starts with skey_, read + write

---

ContentType

The supported types for a remote config entry value.

TypeScriptCopy
type ContentType = "string" | "number" | "boolean" | "json" | "url" | "image";

---

ContentEntry

Shape used when creating a new entry.

TypeScriptCopy
interface ContentEntry {
  key: string;
  value: unknown;
  type: ContentType;
}

Example

TypeScriptCopy
const entry: ContentEntry = {
  key: "maintenance_mode",
  value: false,
  type: "boolean",
};

---

TypedContentEntry

A single entry returned by the typed API (no key field — the key is the map key).

TypeScriptCopy
interface TypedContentEntry {
  value: unknown;
  type: ContentType;
}

---

TypedContentResponse

The shape returned by getAll({ typed: true }) and getTypedAll().

TypeScriptCopy
type TypedContentResponse = Record<string, TypedContentEntry>;

Example value

JSONCopy
{
  "hero_title":  { "value": "Welcome", "type": "string" },
  "show_banner": { "value": true,      "type": "boolean" },
  "max_results": { "value": 20,        "type": "number" }
}

---

KeysetResponse<T>

The envelope returned by every HTTP response. The SDK unwraps data for you in the typed getter methods; you receive KeysetResponse<T> directly from the write methods (create, update, delete, dashboardList).

TypeScriptCopy
interface KeysetResponse<T> {
  success: boolean;
  message?: string;
  data: T;
}

---

DashboardContentEntry

Full entry shape returned by dashboardList(), including server-generated metadata.

TypeScriptCopy
interface DashboardContentEntry {
  id: string;
  key: string;
  value: unknown;
  type: ContentType;
  createdAt: string; // ISO 8601
  updatedAt: string; // ISO 8601
}

---

HttpMethod

HTTP verbs used internally by the SDK.

TypeScriptCopy
type HttpMethod = "GET" | "POST" | "PUT" | "DELETE";

This type is exported for completeness but is not typically needed by consumers.