@nitida/sdk 0.20.0 → 0.21.0

package/src/index.ts

@@ -10,9 +10,9 @@
  *
  * Usage:
  *
- *   import { AquienpzClient } from "@nitida/sdk";
+ *   import { NitidaClient } from "@nitida/sdk";
  *
- *   const aq = new AquienpzClient({
+ *   const aq = new NitidaClient({
  *     endpoint: "https://aquienpz-asset-manager-xxx.run.app",
  *     apiKey:   process.env.ASSET_MANAGER_RUNTIME_KEY!,
  *     tenantCode: "realtyone-cr",
@@ -65,7 +65,7 @@ import {
 // ---------------------------------------------------------------------------
 
 /**
- * Permissive constructor options for the root `AquienpzClient`.
+ * Permissive constructor options for the root `NitidaClient`.
  *
  * App code should NOT import this type directly — prefer the strict
  * variants from the subpaths:
@@ -76,7 +76,7 @@ import {
  * This root type is the union both modes resolve to; the underlying class
  * accepts both shapes so subpath wrappers can extend without duplication.
  */
-export type AquienpzClientOptions = {
+export type NitidaClientOptions = {
   /**
    * Base URL of the aquienpz asset-manager (Cloud Run service URL).
    *
@@ -135,7 +135,7 @@ export type AquienpzClientOptions = {
  * site in the SDK must go through this helper instead of `new URL(...)`.
  */
 function endpointUrl(
-  opts: Pick<AquienpzClientOptions, "endpoint">,
+  opts: Pick<NitidaClientOptions, "endpoint">,
   path: string,
   searchParams?: Record<string, string | number | boolean | undefined>,
 ): URL {
@@ -165,7 +165,7 @@ function endpointUrl(
 
 /** Build a request URL as a plain string (no search params). */
 function endpointHref(
-  opts: Pick<AquienpzClientOptions, "endpoint">,
+  opts: Pick<NitidaClientOptions, "endpoint">,
   path: string,
 ): string {
   return endpointUrl(opts, path).toString();
@@ -176,7 +176,7 @@ function endpointHref(
  * `apiKey` is present. In BFF-proxy mode (browser via `/web`) the
  * proxy injects the real bearer header, so we omit it here.
  */
-function authHeaders(opts: AquienpzClientOptions): Record<string, string> {
+function authHeaders(opts: NitidaClientOptions): Record<string, string> {
   const h: Record<string, string> = {
     // Caller-supplied headers first; `X-Tenant-Code` stays authoritative below.
     ...opts.headers,
@@ -227,7 +227,7 @@ export {
 // ---------------------------------------------------------------------------
 
 class SlotsApi {
-  constructor(private readonly opts: AquienpzClientOptions) {}
+  constructor(private readonly opts: NitidaClientOptions) {}
 
   /** Resolve one slot — returns `{slot, preset, url}` or `{slot: null, url: null}` when unbound. */
   resolve(
@@ -477,7 +477,7 @@ export type ComposeMarketingResult = {
 };
 
 class AssetsApi {
-  constructor(private readonly opts: AquienpzClientOptions) {}
+  constructor(private readonly opts: NitidaClientOptions) {}
 
   /** Look up an asset by full sha256 (64 hex). Returns null on 404. */
   async byHash(sha256: string): Promise<AssetDTO | null> {
@@ -1020,7 +1020,7 @@ export type UsagePerKey = {
 };
 
 class UsageApi {
-  constructor(private readonly opts: AquienpzClientOptions) {}
+  constructor(private readonly opts: NitidaClientOptions) {}
 
   /** Snapshot for the active tenant — storage + today + last 30 days totals. */
   async snapshot(): Promise<UsageSnapshot> {
@@ -1070,7 +1070,7 @@ class UsageApi {
   }
 }
 
-export class AquienpzClient {
+export class NitidaClient {
   readonly slots: SlotsApi;
   readonly assets: AssetsApi;
   readonly usage: UsageApi;
@@ -1079,9 +1079,9 @@ export class AquienpzClient {
    * subpaths can inherit endpoint / apiKey / tenant scope from the
    * configured client without re-passing them per call site.
    */
-  readonly opts: AquienpzClientOptions;
+  readonly opts: NitidaClientOptions;
 
-  constructor(opts: AquienpzClientOptions) {
+  constructor(opts: NitidaClientOptions) {
     this.opts = opts;
     const cdn = opts.cdnBase ?? "https://8ok.uk";
     setCdnBase(cdn);
@@ -1168,7 +1168,7 @@ export class AquienpzClient {
     }
     if (!this.opts.signingKey) {
       throw new Error(
-        "aq.transform({ sign: true }) requires `signingKey` in AquienpzClientOptions. " +
+        "aq.transform({ sign: true }) requires `signingKey` in NitidaClientOptions. " +
           "Pull the tenant's signing key from /admin/tenants/:id and pass it to the SDK constructor on a SERVER-side instance only.",
       );
     }
@@ -1207,7 +1207,7 @@ export class AquienpzClient {
     if (!signOpts?.sign) return getTransformSrcSet(asset, widths, extraOpts);
     if (!this.opts.signingKey) {
       throw new Error(
-        "aq.transformSrcSet({ sign: true }) requires `signingKey` in AquienpzClientOptions.",
+        "aq.transformSrcSet({ sign: true }) requires `signingKey` in NitidaClientOptions.",
       );
     }
     const key = this.opts.signingKey;
@@ -1312,9 +1312,9 @@ export class AquienpzClient {
    *
    * @example Deliver an image on a site (the responsive ladder)
    * ```ts
-   * import { AquienpzClient } from "@nitida/sdk/server";
+   * import { NitidaClient } from "@nitida/sdk/server";
    *
-   * const aq = new AquienpzClient({ endpoint, apiKey, tenantCode, tenantId });
+   * const aq = new NitidaClient({ endpoint, apiKey, tenantCode, tenantId });
    * const { assetId, sha256 } = await aq.upload(file, {
    *   fileName: file.name,
    *   presets: ["thumb", "sm", "md", "lg"],
@@ -1560,3 +1560,16 @@ export class AquienpzClient {
     );
   }
 }
+
+// ---------------------------------------------------------------------------
+// Legacy names (pre-`nitida` rename, 2026-08-16)
+// ---------------------------------------------------------------------------
+
+export type { NitidaClientOptions as AquienpzClientOptions };
+/**
+ * @deprecated Renamed to `Nitida*`. These aliases keep code written against the
+ * old `@aquienpz/*` packages compiling unchanged — same class, same instance,
+ * just a second name. They are not going away on a schedule, but new code
+ * should use the `Nitida*` names.
+ */
+export { NitidaClient as AquienpzClient };

package/src/react/index.ts

@@ -4,9 +4,9 @@
  * Kept in a subpath so the SSR-safe core (`@nitida/sdk`) stays
  * dependency-free of react. Import only what you need:
  *
- *   import { useSlot, useSlots, AquienpzProvider } from "@nitida/sdk/react";
+ *   import { useSlot, useSlots, NitidaProvider } from "@nitida/sdk/react";
  *
- * Pattern: wrap your app in `<AquienpzProvider client={…}>` once at
+ * Pattern: wrap your app in `<NitidaProvider client={…}>` once at
  * the root; hooks read the client from context. No prop-drilling.
  * @module @nitida/sdk/react
  */
@@ -20,16 +20,16 @@ import {
   useMemo,
   useState,
 } from "react";
-import type { AquienpzClient, ResolveSlotOptions, SlotResolution } from "..";
+import type { NitidaClient, ResolveSlotOptions, SlotResolution } from "..";
 
 // ---------------------------------------------------------------------------
 // Provider
 // ---------------------------------------------------------------------------
 
-const ClientContext = createContext<AquienpzClient | null>(null);
+const ClientContext = createContext<NitidaClient | null>(null);
 
-export function AquienpzProvider(props: {
-  client: AquienpzClient;
+export function NitidaProvider(props: {
+  client: NitidaClient;
   children: ReactNode;
 }): ReactNode {
   return createElement(
@@ -39,11 +39,11 @@ export function AquienpzProvider(props: {
   );
 }
 
-export function useAquienpzClient(): AquienpzClient {
+export function useNitidaClient(): NitidaClient {
   const client = useContext(ClientContext);
   if (!client) {
     throw new Error(
-      "useAquienpzClient: wrap your app in <AquienpzProvider client={…}>.",
+      "useNitidaClient: wrap your app in <NitidaProvider client={…}>.",
     );
   }
   return client;
@@ -77,7 +77,7 @@ export function useSlot(
   slotKey: string,
   options: ResolveSlotOptions = {},
 ): SlotState {
-  const client = useAquienpzClient();
+  const client = useNitidaClient();
   const [state, setState] = useState<SlotState>(emptyState);
 
   // Stabilize options across renders so the effect only refires on the
@@ -129,7 +129,7 @@ export function useSlots(
   isLoading: boolean;
   error: Error | null;
 } {
-  const client = useAquienpzClient();
+  const client = useNitidaClient();
   const keysHash = useMemo(() => slotKeys.join("|"), [slotKeys]);
   const presetKey = options.preset ?? "";
   const ttlMs = options.ttlMs ?? 60_000;
@@ -167,3 +167,18 @@ export function useSlots(
 
   return state;
 }
+
+// ---------------------------------------------------------------------------
+// Legacy names (pre-`nitida` rename, 2026-08-16)
+// ---------------------------------------------------------------------------
+
+/**
+ * @deprecated Renamed to `Nitida*`. These aliases keep code written against the
+ * old `@aquienpz/*` packages compiling unchanged — same class, same instance,
+ * just a second name. They are not going away on a schedule, but new code
+ * should use the `Nitida*` names.
+ */
+export {
+  NitidaProvider as AquienpzProvider,
+  useNitidaClient as useAquienpzClient,
+};

package/src/server/index.ts

@@ -7,9 +7,9 @@
  * bundle. The constructor REQUIRES `apiKey`; the type from `/web` omits
  * it, so the two modes never confuse each other.
  *
- *   import { AquienpzClient } from "@nitida/sdk/server";
+ *   import { NitidaClient } from "@nitida/sdk/server";
  *
- *   const aq = new AquienpzClient({
+ *   const aq = new NitidaClient({
  *     endpoint:   process.env.ASSET_MANAGER_URL!,
  *     apiKey:     process.env.ASSET_MANAGER_API_KEY!,   // <- required
  *     tenantCode: "realtyone-cr",
@@ -25,7 +25,7 @@
  *   // and your route handler forwards here with the real API key.
  *
  * What you get:
- *   - `AquienpzClient` (slots/assets/usage APIs over plain fetch)
+ *   - `NitidaClient` (slots/assets/usage APIs over plain fetch)
  *   - URL builders: `getAssetUrl`, `getTransformUrl`, `getTransformSrcSet`,
  *     `getHlsStreamingUrl`, `extractAssetSha`, `signTransformUrl`
  *   - `aq.upload(bytes)` works with `Uint8Array` (Node 18+ / Bun ship Blob
@@ -43,17 +43,14 @@
  * @module @nitida/sdk/server
  */
 
-import {
-  type AquienpzClientOptions,
-  AquienpzClient as BaseAquienpzClient,
-} from "..";
+import { NitidaClient as BaseNitidaClient, type NitidaClientOptions } from "..";
 
 /**
  * Server-side constructor options — `apiKey` is REQUIRED here. Use this
  * type whenever you build a client behind a process boundary (Node, Bun,
  * Cloud Run, Vercel Functions, edge runtimes, BFFs).
  *
- *   const aq = new AquienpzClient({
+ *   const aq = new NitidaClient({
  *     endpoint:   process.env.ASSET_MANAGER_URL!,
  *     apiKey:     process.env.ASSET_MANAGER_API_KEY!,
  *     tenantCode: "realtyone-cr",
@@ -61,23 +58,22 @@ import {
  *   });
  */
 export type ServerClientOptions = Required<
-  Pick<AquienpzClientOptions, "endpoint" | "apiKey" | "tenantCode" | "tenantId">
+  Pick<NitidaClientOptions, "endpoint" | "apiKey" | "tenantCode" | "tenantId">
 > &
-  Pick<AquienpzClientOptions, "cdnBase" | "signingKey">;
+  Pick<NitidaClientOptions, "cdnBase" | "signingKey">;
 
 /**
- * Server-safe `AquienpzClient` — same runtime as the root class, but the
+ * Server-safe `NitidaClient` — same runtime as the root class, but the
  * constructor type enforces `apiKey` so misconfiguration is a TS build
  * error, not a runtime 401.
  */
-export class AquienpzClient extends BaseAquienpzClient {
+export class NitidaClient extends BaseNitidaClient {
   constructor(opts: ServerClientOptions) {
     super(opts);
   }
 }
 
 export {
-  type AquienpzClientOptions,
   type AssetDTO,
   type AssetVariant,
   type ComposeMarketingComposition,
@@ -98,6 +94,7 @@ export {
   getTransformUrl,
   getVideoTransformUrl,
   hasPreset,
+  type NitidaClientOptions,
   type PresignUploadUrlOptions,
   type RegenerateResult,
   type ResolveSlotOptions,
@@ -122,3 +119,15 @@ export {
   type UsageWindow,
   type VariantPreset,
 } from "..";
+
+// ---------------------------------------------------------------------------
+// Legacy names (pre-`nitida` rename, 2026-08-16)
+// ---------------------------------------------------------------------------
+
+/**
+ * @deprecated Renamed to `Nitida*`. These aliases keep code written against the
+ * old `@aquienpz/*` packages compiling unchanged — same class, same instance,
+ * just a second name. They are not going away on a schedule, but new code
+ * should use the `Nitida*` names.
+ */
+export { NitidaClient as AquienpzClient };

package/src/web/index.ts

@@ -3,13 +3,13 @@
  *
  * Use this subpath from any browser context (Next.js client components,
  * Vite/CRA SPAs, browser extensions, web workers — anywhere `window`
- * exists). Bundles the core `AquienpzClient` PLUS browser-only helpers
+ * exists). Bundles the core `NitidaClient` PLUS browser-only helpers
  * (client-side image compression).
  *
  *   // 1. In a client component (browser):
- *   import { AquienpzClient } from "@nitida/sdk/web";
+ *   import { NitidaClient } from "@nitida/sdk/web";
  *
- *   const aq = new AquienpzClient({
+ *   const aq = new NitidaClient({
  *     // Point at your BFF route — the SDK calls
  *     // `${endpoint}/assets/by-hash/...`, `${endpoint}/slots/...`, etc.
  *     endpoint:   "/api/am",          // relative ⇒ same-origin proxy
@@ -51,21 +51,18 @@
  * @module @nitida/sdk/web
  */
 
-import {
-  type AquienpzClientOptions,
-  AquienpzClient as BaseAquienpzClient,
-} from "..";
+import { NitidaClient as BaseNitidaClient, type NitidaClientOptions } from "..";
 
 /**
  * Browser-safe constructor options for `@nitida/sdk/web`.
  *
- * Identical to the root `AquienpzClientOptions` except `apiKey` and
+ * Identical to the root `NitidaClientOptions` except `apiKey` and
  * `signingKey` are **physically absent** — passing them is a TypeScript
  * build error, not a runtime warning. In BFF-proxy mode your route
  * handler injects the bearer header server-side; the browser never
  * sees the long-lived key.
  *
- *   const aq = new AquienpzClient({
+ *   const aq = new NitidaClient({
  *     endpoint:   "/api/am",          // OK: relative → same-origin BFF
  *     tenantCode: "realtyone-cr",
  *     tenantId:   1,
@@ -73,21 +70,21 @@ import {
  *   });
  */
 export type WebClientOptions = Omit<
-  AquienpzClientOptions,
+  NitidaClientOptions,
   "apiKey" | "signingKey"
 >;
 
 /**
- * Browser-safe `AquienpzClient` — same runtime as the root class, but
+ * Browser-safe `NitidaClient` — same runtime as the root class, but
  * the constructor's type rejects `apiKey` / `signingKey`. Calls go
  * through your BFF (typically a same-origin route like `/api/am/...`).
  *
  * For server-side instantiation (Node/Bun/edge), import from
  * `@nitida/sdk/server` instead.
  */
-export class AquienpzClient extends BaseAquienpzClient {
+export class NitidaClient extends BaseNitidaClient {
   constructor(opts: WebClientOptions) {
-    super(opts as AquienpzClientOptions);
+    super(opts as NitidaClientOptions);
   }
 }
 
@@ -332,3 +329,15 @@ export async function compressImages(
   }
   return results;
 }
+
+// ---------------------------------------------------------------------------
+// Legacy names (pre-`nitida` rename, 2026-08-16)
+// ---------------------------------------------------------------------------
+
+/**
+ * @deprecated Renamed to `Nitida*`. These aliases keep code written against the
+ * old `@aquienpz/*` packages compiling unchanged — same class, same instance,
+ * just a second name. They are not going away on a schedule, but new code
+ * should use the `Nitida*` names.
+ */
+export { NitidaClient as AquienpzClient };