@nonphoto/sanity-image 3.0.0 → 3.1.0

package/dist/index.d.ts

@@ -1,3 +1,51 @@
+interface SanityImageAssetLike {
+    _id: string;
+}
+declare function isSanityImageAssetLike(x: any): x is SanityImageAssetLike;
+
+interface SanityReference {
+    _ref: string;
+}
+declare function isSanityReference(x: any): x is SanityReference;
+
+interface SanityImageObject {
+    asset: SanityImageAssetLike | SanityReference;
+}
+declare function isSanityImageObject(x: any): x is SanityImageObject;
+
+interface SanityImagePaletteSwatch {
+    _type?: "sanity.imagePaletteSwatch" | null;
+    background?: string | null;
+    foreground?: string | null;
+    population?: number | null;
+    title?: string | null;
+}
+interface SanityImagePalette {
+    _type?: "sanity.imagePalette" | null;
+    darkMuted?: SanityImagePaletteSwatch | null;
+    darkVibrant?: SanityImagePaletteSwatch | null;
+    dominant?: SanityImagePaletteSwatch | null;
+    lightMuted?: SanityImagePaletteSwatch | null;
+    lightVibrant?: SanityImagePaletteSwatch | null;
+    muted?: SanityImagePaletteSwatch | null;
+    vibrant?: SanityImagePaletteSwatch | null;
+}
+interface SanityImageDimensions {
+    _type?: "sanity.imageDimensions" | null;
+    aspectRatio?: number | null;
+    width?: number | null;
+    height?: number | null;
+}
+interface SanityImageMetadata {
+    _type: "sanity.imageMetadata";
+    blurHash?: string | null;
+    dimensions?: SanityImageDimensions | null;
+    hasAlpha?: boolean | null;
+    isOpaque?: boolean | null;
+    lqip?: string | null;
+    palette?: SanityImagePalette | null;
+}
+
 type ImageFormat = "jpg" | "pjpg" | "png" | "webp";
 type FitMode = "clip" | "crop" | "fill" | "fillmax" | "max" | "scale" | "min";
 type CropMode = "top" | "bottom" | "left" | "right" | "center" | "focalpoint" | "entropy";
@@ -41,6 +89,7 @@ type SanityImageParams = {
 };
 declare function sanityImageParamsToSearchParamEntries({ auto, background, blur, crop, download, dpr, fit, flipHorizontal, flipVertical, focalPoint, format, frame, height, invert, maxHeight, maxWidth, minHeight, minWidth, orientation, pad, quality, rect, saturation, sharpen, width, }: SanityImageParams): string[][];
 
+type SanityImageSource = SanityImageObject | SanityReference | SanityImageAssetLike | string;
 interface SanityImageAssetStub {
     id: string;
     width: number;
@@ -49,8 +98,8 @@ interface SanityImageAssetStub {
     vanityName?: string;
 }
 declare function parseSanityImageAssetId(assetId: string): SanityImageAssetStub | undefined;
-declare function sanityImageAssetStub(source: unknown): SanityImageAssetStub | undefined;
-declare function sanityImageAssetId(source: unknown): string | undefined;
+declare function sanityImageAssetId(source: SanityImageSource): string;
+declare function sanityImageAssetStub(source: SanityImageSource): SanityImageAssetStub | undefined;
 
 declare const defaultSrcsetWidths: number[];
 interface SanityClientLike {
@@ -60,4 +109,4 @@ interface SanityClientLike {
 declare function sanityImageUrl(client: SanityClientLike, image: SanityImageAssetStub, params?: SanityImageParams): string;
 declare function sanityImageSrcset(client: SanityClientLike, image: SanityImageAssetStub, params?: Omit<SanityImageParams, "width">, widths?: number[]): string;
 
-export { type AutoMode, type CropMode, type Dpr, type FitMode, type ImageFormat, type Orientation, type SanityClientLike, type SanityImageAssetStub, type SanityImageParams, defaultSrcsetWidths, parseSanityImageAssetId, sanityImageAssetId, sanityImageAssetStub, sanityImageParamsToSearchParamEntries, sanityImageSrcset, sanityImageUrl };
+export { type AutoMode, type CropMode, type Dpr, type FitMode, type ImageFormat, type Orientation, type SanityClientLike, type SanityImageAssetLike, type SanityImageAssetStub, type SanityImageDimensions, type SanityImageMetadata, type SanityImageObject, type SanityImagePalette, type SanityImagePaletteSwatch, type SanityImageParams, type SanityImageSource, type SanityReference, defaultSrcsetWidths, isSanityImageAssetLike, isSanityImageObject, isSanityReference, parseSanityImageAssetId, sanityImageAssetId, sanityImageAssetStub, sanityImageParamsToSearchParamEntries, sanityImageSrcset, sanityImageUrl };

package/dist/index.js

@@ -1,3 +1,18 @@
+// src/asset.ts
+function isSanityImageAssetLike(x) {
+  return x != null && typeof x === "object" && "_id" in x && typeof x._id === "string";
+}
+
+// src/reference.ts
+function isSanityReference(x) {
+  return x != null && typeof x === "object" && "_ref" in x && typeof x._ref === "string";
+}
+
+// src/imageObject.ts
+function isSanityImageObject(x) {
+  return x != null && typeof x === "object" && "asset" in x && (isSanityImageAssetLike(x.asset) || isSanityReference(x.asset));
+}
+
 // src/params.ts
 function sanityImageParamsToSearchParamEntries({
   auto,
@@ -68,13 +83,13 @@ function parseSanityImageAssetId(assetId) {
     return { id, width: Number(width), height: Number(height), format };
   }
 }
+function sanityImageAssetId(source) {
+  return typeof source === "string" ? source : isSanityReference(source) ? source._ref : isSanityImageAssetLike(source) ? source._id : sanityImageAssetId(source.asset);
+}
 function sanityImageAssetStub(source) {
   const id = sanityImageAssetId(source);
   return id ? parseSanityImageAssetId(id) : void 0;
 }
-function sanityImageAssetId(source) {
-  return typeof source === "string" ? source : typeof source === "object" && source != null ? "_ref" in source && typeof source._ref === "string" ? source._ref : "_id" in source && typeof source._id === "string" ? source._id : "asset" in source ? sanityImageAssetId(source.asset) : void 0 : void 0;
-}
 
 // src/url.ts
 var defaultSrcsetWidths = [
@@ -142,6 +157,9 @@ function sanityImageSrcset(client, image, params, widths = defaultSrcsetWidths)
 }
 export {
   defaultSrcsetWidths,
+  isSanityImageAssetLike,
+  isSanityImageObject,
+  isSanityReference,
   parseSanityImageAssetId,
   sanityImageAssetId,
   sanityImageAssetStub,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nonphoto/sanity-image",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "author": "Jonas Luebbers <jonas@jonasluebbers.com> (https://www.jonasluebbers.com)",
   "license": "MIT",
   "type": "module",

package/src/asset.ts

@@ -0,0 +1,12 @@
+export interface SanityImageAssetLike {
+  _id: string;
+}
+
+export function isSanityImageAssetLike(x: any): x is SanityImageAssetLike {
+  return (
+    x != null &&
+    typeof x === "object" &&
+    "_id" in x &&
+    typeof x._id === "string"
+  );
+}

package/src/imageObject.ts

@@ -0,0 +1,15 @@
+import { isSanityImageAssetLike, SanityImageAssetLike } from "./asset";
+import { isSanityReference, SanityReference } from "./reference";
+
+export interface SanityImageObject {
+  asset: SanityImageAssetLike | SanityReference;
+}
+
+export function isSanityImageObject(x: any): x is SanityImageObject {
+  return (
+    x != null &&
+    typeof x === "object" &&
+    "asset" in x &&
+    (isSanityImageAssetLike(x.asset) || isSanityReference(x.asset))
+  );
+}

package/src/index.ts

@@ -1,3 +1,7 @@
+export * from "./asset";
+export * from "./imageObject";
+export * from "./metadata";
 export * from "./params";
+export * from "./reference";
 export * from "./stub";
 export * from "./url";

package/src/metadata.ts

@@ -0,0 +1,35 @@
+export interface SanityImagePaletteSwatch {
+  _type?: "sanity.imagePaletteSwatch" | null;
+  background?: string | null;
+  foreground?: string | null;
+  population?: number | null;
+  title?: string | null;
+}
+
+export interface SanityImagePalette {
+  _type?: "sanity.imagePalette" | null;
+  darkMuted?: SanityImagePaletteSwatch | null;
+  darkVibrant?: SanityImagePaletteSwatch | null;
+  dominant?: SanityImagePaletteSwatch | null;
+  lightMuted?: SanityImagePaletteSwatch | null;
+  lightVibrant?: SanityImagePaletteSwatch | null;
+  muted?: SanityImagePaletteSwatch | null;
+  vibrant?: SanityImagePaletteSwatch | null;
+}
+
+export interface SanityImageDimensions {
+  _type?: "sanity.imageDimensions" | null;
+  aspectRatio?: number | null;
+  width?: number | null;
+  height?: number | null;
+}
+
+export interface SanityImageMetadata {
+  _type: "sanity.imageMetadata";
+  blurHash?: string | null;
+  dimensions?: SanityImageDimensions | null;
+  hasAlpha?: boolean | null;
+  isOpaque?: boolean | null;
+  lqip?: string | null;
+  palette?: SanityImagePalette | null;
+}

package/src/reference.ts

@@ -0,0 +1,12 @@
+export interface SanityReference {
+  _ref: string;
+}
+
+export function isSanityReference(x: any): x is SanityReference {
+  return (
+    x != null &&
+    typeof x === "object" &&
+    "_ref" in x &&
+    typeof x._ref === "string"
+  );
+}

package/src/stub.ts

@@ -1,3 +1,13 @@
+import { isSanityImageAssetLike, SanityImageAssetLike } from "./asset";
+import { SanityImageObject } from "./imageObject";
+import { isSanityReference, SanityReference } from "./reference";
+
+export type SanityImageSource =
+  | SanityImageObject
+  | SanityReference
+  | SanityImageAssetLike
+  | string;
+
 export interface SanityImageAssetStub {
   id: string;
   width: number;
@@ -16,23 +26,19 @@ export function parseSanityImageAssetId(
   }
 }
 
+export function sanityImageAssetId(source: SanityImageSource): string {
+  return typeof source === "string"
+    ? source
+    : isSanityReference(source)
+    ? source._ref
+    : isSanityImageAssetLike(source)
+    ? source._id
+    : sanityImageAssetId(source.asset);
+}
+
 export function sanityImageAssetStub(
-  source: unknown
+  source: SanityImageSource
 ): SanityImageAssetStub | undefined {
   const id = sanityImageAssetId(source);
   return id ? parseSanityImageAssetId(id) : undefined;
 }
-
-export function sanityImageAssetId(source: unknown): string | undefined {
-  return typeof source === "string"
-    ? source
-    : typeof source === "object" && source != null
-    ? "_ref" in source && typeof source._ref === "string"
-      ? source._ref
-      : "_id" in source && typeof source._id === "string"
-      ? source._id
-      : "asset" in source
-      ? sanityImageAssetId(source.asset)
-      : undefined
-    : undefined;
-}