@adland/data 0.11.0 → 0.13.0

package/dist/index.d.ts

@@ -165,6 +165,110 @@ type MiniAppAd = {
     metadata: MiniAppAdMetadata;
 };
 
+declare const tokenAd: AdDefinition<z.ZodObject<{
+    address: z.ZodString;
+    chainId: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    symbol: z.ZodOptional<z.ZodString>;
+    decimals: z.ZodOptional<z.ZodNumber>;
+    logoURI: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>> & {
+    process: (input: {
+        address: string;
+        chainId: number;
+    }) => Promise<{
+        data: {
+            address: string;
+            chainId: number;
+        };
+        metadata: {
+            name?: string | undefined;
+            symbol?: string | undefined;
+            decimals?: number | undefined;
+            logoURI?: string | undefined;
+        } | undefined;
+    }>;
+    safeProcess: (input: {
+        address: string;
+        chainId: number;
+    }) => Promise<{
+        success: boolean;
+        data?: {
+            address: string;
+            chainId: number;
+        } | undefined;
+        metadata?: {
+            name?: string | undefined;
+            symbol?: string | undefined;
+            decimals?: number | undefined;
+            logoURI?: string | undefined;
+        } | undefined;
+        error?: z.ZodError | string;
+    }>;
+};
+type TokenAdData = z.infer<typeof tokenAd.data>;
+type TokenAdMetadata = z.infer<NonNullable<typeof tokenAd.metadata>>;
+type TokenAd = {
+    type: "token";
+    data: TokenAdData;
+    metadata: TokenAdMetadata;
+};
+
+declare const farcasterProfileAd: AdDefinition<z.ZodObject<{
+    fid: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    pfpUrl: z.ZodOptional<z.ZodString>;
+    bio: z.ZodOptional<z.ZodString>;
+    username: z.ZodOptional<z.ZodString>;
+    displayName: z.ZodOptional<z.ZodString>;
+    followers: z.ZodOptional<z.ZodNumber>;
+    following: z.ZodOptional<z.ZodNumber>;
+    pro: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>> & {
+    process: (input: {
+        fid: string;
+    }) => Promise<{
+        data: {
+            fid: string;
+        };
+        metadata: {
+            pfpUrl?: string | undefined;
+            bio?: string | undefined;
+            username?: string | undefined;
+            displayName?: string | undefined;
+            followers?: number | undefined;
+            following?: number | undefined;
+            pro?: boolean | undefined;
+        } | undefined;
+    }>;
+    safeProcess: (input: {
+        fid: string;
+    }) => Promise<{
+        success: boolean;
+        data?: {
+            fid: string;
+        } | undefined;
+        metadata?: {
+            pfpUrl?: string | undefined;
+            bio?: string | undefined;
+            username?: string | undefined;
+            displayName?: string | undefined;
+            followers?: number | undefined;
+            following?: number | undefined;
+            pro?: boolean | undefined;
+        } | undefined;
+        error?: z.ZodError | string;
+    }>;
+};
+type FarcasterProfileAdData = z.infer<typeof farcasterProfileAd.data>;
+type FarcasterProfileAdMetadata = z.infer<NonNullable<typeof farcasterProfileAd.metadata>>;
+type FarcasterProfileAd = {
+    type: "farcasterProfile";
+    data: FarcasterProfileAdData;
+    metadata: FarcasterProfileAdMetadata;
+};
+
 /**
  * Ad Definition type
  * Represents a data contract + behavior for an ad type
@@ -248,7 +352,7 @@ declare function safeProcessAd<TData extends z.ZodTypeAny, TMetadata extends z.Z
 /**
  * Union type for all complete ad structures with type, data, and optional metadata
  */
-type AdData = CastAd | LinkAd | MiniAppAd;
+type AdData = CastAd | LinkAd | MiniAppAd | TokenAd | FarcasterProfileAd;
 /**
  * Registry of all ad definitions
  * Each entry is an AdDefinition object
@@ -365,8 +469,96 @@ declare const ads: {
             error?: z.ZodError | string;
         }>;
     };
+    readonly token: AdDefinition<z.ZodObject<{
+        address: z.ZodString;
+        chainId: z.ZodNumber;
+    }, z.core.$strip>, z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        symbol: z.ZodOptional<z.ZodString>;
+        decimals: z.ZodOptional<z.ZodNumber>;
+        logoURI: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>> & {
+        process: (input: {
+            address: string;
+            chainId: number;
+        }) => Promise<{
+            data: {
+                address: string;
+                chainId: number;
+            };
+            metadata: {
+                name?: string | undefined;
+                symbol?: string | undefined;
+                decimals?: number | undefined;
+                logoURI?: string | undefined;
+            } | undefined;
+        }>;
+        safeProcess: (input: {
+            address: string;
+            chainId: number;
+        }) => Promise<{
+            success: boolean;
+            data?: {
+                address: string;
+                chainId: number;
+            } | undefined;
+            metadata?: {
+                name?: string | undefined;
+                symbol?: string | undefined;
+                decimals?: number | undefined;
+                logoURI?: string | undefined;
+            } | undefined;
+            error?: z.ZodError | string;
+        }>;
+    };
+    readonly farcasterProfile: AdDefinition<z.ZodObject<{
+        fid: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        pfpUrl: z.ZodOptional<z.ZodString>;
+        bio: z.ZodOptional<z.ZodString>;
+        username: z.ZodOptional<z.ZodString>;
+        displayName: z.ZodOptional<z.ZodString>;
+        followers: z.ZodOptional<z.ZodNumber>;
+        following: z.ZodOptional<z.ZodNumber>;
+        pro: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>> & {
+        process: (input: {
+            fid: string;
+        }) => Promise<{
+            data: {
+                fid: string;
+            };
+            metadata: {
+                pfpUrl?: string | undefined;
+                bio?: string | undefined;
+                username?: string | undefined;
+                displayName?: string | undefined;
+                followers?: number | undefined;
+                following?: number | undefined;
+                pro?: boolean | undefined;
+            } | undefined;
+        }>;
+        safeProcess: (input: {
+            fid: string;
+        }) => Promise<{
+            success: boolean;
+            data?: {
+                fid: string;
+            } | undefined;
+            metadata?: {
+                pfpUrl?: string | undefined;
+                bio?: string | undefined;
+                username?: string | undefined;
+                displayName?: string | undefined;
+                followers?: number | undefined;
+                following?: number | undefined;
+                pro?: boolean | undefined;
+            } | undefined;
+            error?: z.ZodError | string;
+        }>;
+    };
 };
-declare const adTypes: readonly ["link", "cast", "miniapp"];
+declare const adTypes: readonly ["link", "cast", "miniapp", "token", "farcasterProfile"];
 /**
  * Type for ad definition keys
  */
@@ -482,6 +674,92 @@ declare function getAd(type: AdType): (AdDefinition<z.ZodObject<{
         } | undefined;
         error?: z.ZodError | string;
     }>;
+}) | (AdDefinition<z.ZodObject<{
+    address: z.ZodString;
+    chainId: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    symbol: z.ZodOptional<z.ZodString>;
+    decimals: z.ZodOptional<z.ZodNumber>;
+    logoURI: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>> & {
+    process: (input: {
+        address: string;
+        chainId: number;
+    }) => Promise<{
+        data: {
+            address: string;
+            chainId: number;
+        };
+        metadata: {
+            name?: string | undefined;
+            symbol?: string | undefined;
+            decimals?: number | undefined;
+            logoURI?: string | undefined;
+        } | undefined;
+    }>;
+    safeProcess: (input: {
+        address: string;
+        chainId: number;
+    }) => Promise<{
+        success: boolean;
+        data?: {
+            address: string;
+            chainId: number;
+        } | undefined;
+        metadata?: {
+            name?: string | undefined;
+            symbol?: string | undefined;
+            decimals?: number | undefined;
+            logoURI?: string | undefined;
+        } | undefined;
+        error?: z.ZodError | string;
+    }>;
+}) | (AdDefinition<z.ZodObject<{
+    fid: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    pfpUrl: z.ZodOptional<z.ZodString>;
+    bio: z.ZodOptional<z.ZodString>;
+    username: z.ZodOptional<z.ZodString>;
+    displayName: z.ZodOptional<z.ZodString>;
+    followers: z.ZodOptional<z.ZodNumber>;
+    following: z.ZodOptional<z.ZodNumber>;
+    pro: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>> & {
+    process: (input: {
+        fid: string;
+    }) => Promise<{
+        data: {
+            fid: string;
+        };
+        metadata: {
+            pfpUrl?: string | undefined;
+            bio?: string | undefined;
+            username?: string | undefined;
+            displayName?: string | undefined;
+            followers?: number | undefined;
+            following?: number | undefined;
+            pro?: boolean | undefined;
+        } | undefined;
+    }>;
+    safeProcess: (input: {
+        fid: string;
+    }) => Promise<{
+        success: boolean;
+        data?: {
+            fid: string;
+        } | undefined;
+        metadata?: {
+            pfpUrl?: string | undefined;
+            bio?: string | undefined;
+            username?: string | undefined;
+            displayName?: string | undefined;
+            followers?: number | undefined;
+            following?: number | undefined;
+            pro?: boolean | undefined;
+        } | undefined;
+        error?: z.ZodError | string;
+    }>;
 });
 /**
  * Validate ad data against any ad definition
@@ -607,6 +885,94 @@ declare const adDefinitions: {
             error?: z.ZodError | string;
         }>;
     };
+    readonly token: AdDefinition<z.ZodObject<{
+        address: z.ZodString;
+        chainId: z.ZodNumber;
+    }, z.core.$strip>, z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        symbol: z.ZodOptional<z.ZodString>;
+        decimals: z.ZodOptional<z.ZodNumber>;
+        logoURI: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>> & {
+        process: (input: {
+            address: string;
+            chainId: number;
+        }) => Promise<{
+            data: {
+                address: string;
+                chainId: number;
+            };
+            metadata: {
+                name?: string | undefined;
+                symbol?: string | undefined;
+                decimals?: number | undefined;
+                logoURI?: string | undefined;
+            } | undefined;
+        }>;
+        safeProcess: (input: {
+            address: string;
+            chainId: number;
+        }) => Promise<{
+            success: boolean;
+            data?: {
+                address: string;
+                chainId: number;
+            } | undefined;
+            metadata?: {
+                name?: string | undefined;
+                symbol?: string | undefined;
+                decimals?: number | undefined;
+                logoURI?: string | undefined;
+            } | undefined;
+            error?: z.ZodError | string;
+        }>;
+    };
+    readonly farcasterProfile: AdDefinition<z.ZodObject<{
+        fid: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        pfpUrl: z.ZodOptional<z.ZodString>;
+        bio: z.ZodOptional<z.ZodString>;
+        username: z.ZodOptional<z.ZodString>;
+        displayName: z.ZodOptional<z.ZodString>;
+        followers: z.ZodOptional<z.ZodNumber>;
+        following: z.ZodOptional<z.ZodNumber>;
+        pro: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>> & {
+        process: (input: {
+            fid: string;
+        }) => Promise<{
+            data: {
+                fid: string;
+            };
+            metadata: {
+                pfpUrl?: string | undefined;
+                bio?: string | undefined;
+                username?: string | undefined;
+                displayName?: string | undefined;
+                followers?: number | undefined;
+                following?: number | undefined;
+                pro?: boolean | undefined;
+            } | undefined;
+        }>;
+        safeProcess: (input: {
+            fid: string;
+        }) => Promise<{
+            success: boolean;
+            data?: {
+                fid: string;
+            } | undefined;
+            metadata?: {
+                pfpUrl?: string | undefined;
+                bio?: string | undefined;
+                username?: string | undefined;
+                displayName?: string | undefined;
+                followers?: number | undefined;
+                following?: number | undefined;
+                pro?: boolean | undefined;
+            } | undefined;
+            error?: z.ZodError | string;
+        }>;
+    };
 };
 declare const adModels: {
     readonly link: AdDefinition<z.ZodObject<{
@@ -720,6 +1086,94 @@ declare const adModels: {
             error?: z.ZodError | string;
         }>;
     };
+    readonly token: AdDefinition<z.ZodObject<{
+        address: z.ZodString;
+        chainId: z.ZodNumber;
+    }, z.core.$strip>, z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        symbol: z.ZodOptional<z.ZodString>;
+        decimals: z.ZodOptional<z.ZodNumber>;
+        logoURI: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>> & {
+        process: (input: {
+            address: string;
+            chainId: number;
+        }) => Promise<{
+            data: {
+                address: string;
+                chainId: number;
+            };
+            metadata: {
+                name?: string | undefined;
+                symbol?: string | undefined;
+                decimals?: number | undefined;
+                logoURI?: string | undefined;
+            } | undefined;
+        }>;
+        safeProcess: (input: {
+            address: string;
+            chainId: number;
+        }) => Promise<{
+            success: boolean;
+            data?: {
+                address: string;
+                chainId: number;
+            } | undefined;
+            metadata?: {
+                name?: string | undefined;
+                symbol?: string | undefined;
+                decimals?: number | undefined;
+                logoURI?: string | undefined;
+            } | undefined;
+            error?: z.ZodError | string;
+        }>;
+    };
+    readonly farcasterProfile: AdDefinition<z.ZodObject<{
+        fid: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        pfpUrl: z.ZodOptional<z.ZodString>;
+        bio: z.ZodOptional<z.ZodString>;
+        username: z.ZodOptional<z.ZodString>;
+        displayName: z.ZodOptional<z.ZodString>;
+        followers: z.ZodOptional<z.ZodNumber>;
+        following: z.ZodOptional<z.ZodNumber>;
+        pro: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>> & {
+        process: (input: {
+            fid: string;
+        }) => Promise<{
+            data: {
+                fid: string;
+            };
+            metadata: {
+                pfpUrl?: string | undefined;
+                bio?: string | undefined;
+                username?: string | undefined;
+                displayName?: string | undefined;
+                followers?: number | undefined;
+                following?: number | undefined;
+                pro?: boolean | undefined;
+            } | undefined;
+        }>;
+        safeProcess: (input: {
+            fid: string;
+        }) => Promise<{
+            success: boolean;
+            data?: {
+                fid: string;
+            } | undefined;
+            metadata?: {
+                pfpUrl?: string | undefined;
+                bio?: string | undefined;
+                username?: string | undefined;
+                displayName?: string | undefined;
+                followers?: number | undefined;
+                following?: number | undefined;
+                pro?: boolean | undefined;
+            } | undefined;
+            error?: z.ZodError | string;
+        }>;
+    };
 };
 
-export { type AdData, type AdDefinition, type AdType, type CastAd, type CastAdData, type CastAdMetadata, type LinkAd, type LinkAdData, type LinkAdMetadata, type MiniAppAd, type MiniAppAdData, type MiniAppAdMetadata, adDefinitions, adModels, adTypes, ads, castAd, defineAd, getAd, linkAd, miniappAd, processAd, safeProcessAd, validateAdData };
+export { type AdData, type AdDefinition, type AdType, type CastAd, type CastAdData, type CastAdMetadata, type FarcasterProfileAd, type FarcasterProfileAdData, type FarcasterProfileAdMetadata, type LinkAd, type LinkAdData, type LinkAdMetadata, type MiniAppAd, type MiniAppAdData, type MiniAppAdMetadata, type TokenAd, type TokenAdData, type TokenAdMetadata, adDefinitions, adModels, adTypes, ads, castAd, defineAd, farcasterProfileAd, getAd, linkAd, miniappAd, processAd, safeProcessAd, tokenAd, validateAdData };

package/dist/index.js

@@ -71,14 +71,37 @@ var AdlandAPI = class {
   async getMiniappMetadata({ url }) {
     return this.get(`${adlandApiUrl}/metadata/miniapp?url=${encodeURIComponent(url)}`);
   }
-  async getLinkMetadata({
-    url
-  }) {
+  async getLinkMetadata({ url }) {
     return this.get(`${adlandApiUrl}/metadata/link?url=${encodeURIComponent(url)}`);
   }
   async getCastMetadata({ hash }) {
     return this.get(`${adlandApiUrl}/metadata/cast?hash=${encodeURIComponent(hash)}`);
   }
+  async verifyFarcasterProfile({ fid }) {
+    return this.post(`${adlandApiUrl}/verify/profile`, {
+      fid
+    });
+  }
+  async getFarcasterProfile({ fid }) {
+    return this.get(`${adlandApiUrl}/metadata/profile?fid=${encodeURIComponent(fid)}`);
+  }
+  async verifyToken({
+    address,
+    chainId
+  }) {
+    return this.post(`${adlandApiUrl}/verify/token`, {
+      address,
+      chainId
+    });
+  }
+  async getTokenMetadata({
+    address,
+    chainId
+  }) {
+    return this.get(
+      `${adlandApiUrl}/metadata/token?address=${encodeURIComponent(address)}&chainId=${chainId}`
+    );
+  }
   async post(url, body) {
     return fetch(url, {
       method: "POST",
@@ -183,14 +206,83 @@ var miniappAd = defineAd({
     };
   }
 });
+var tokenAd = defineAd({
+  type: "token",
+  data: z.object({
+    address: z.string().nonempty("Address is required"),
+    chainId: z.number().int().positive("Chain ID is required").refine((chainId) => [8453].includes(chainId), "Invalid chain ID")
+  }),
+  metadata: z.object({
+    name: z.string().optional(),
+    symbol: z.string().optional(),
+    decimals: z.number().optional(),
+    logoURI: z.string().optional()
+  }),
+  async verify({ address, chainId }) {
+    const res = await adlandAPI.verifyToken({ address, chainId });
+    if (!res.verified) {
+      throw new Error("Token verification failed");
+    }
+  },
+  async getMetadata({ address, chainId }) {
+    const token = await adlandAPI.getTokenMetadata({ address, chainId });
+    return {
+      name: token.name,
+      symbol: token.symbol,
+      decimals: token.decimals,
+      logoURI: token.logoURI
+    };
+  }
+});
+var farcasterProfileAd = defineAd({
+  type: "farcasterProfile",
+  data: z.object({
+    fid: z.string().nonempty("Fid is required")
+  }),
+  metadata: z.object({
+    pfpUrl: z.string().optional(),
+    bio: z.string().optional(),
+    username: z.string().optional(),
+    displayName: z.string().optional(),
+    followers: z.number().optional(),
+    following: z.number().optional(),
+    pro: z.boolean().optional()
+  }),
+  async verify({ fid }) {
+    const res = await adlandAPI.verifyFarcasterProfile({ fid });
+    if (!res.verified) {
+      throw new Error("Farcaster profile verification failed");
+    }
+  },
+  async getMetadata({ fid }) {
+    const res = await adlandAPI.getFarcasterProfile({ fid });
+    return {
+      pfpUrl: res.pfpUrl,
+      bio: res.bio,
+      username: res.username,
+      displayName: res.displayName,
+      followers: res.followers,
+      following: res.following,
+      pro: res.pro
+    };
+  }
+});
 
 // src/index.ts
 var ads = {
   link: linkAd,
   cast: castAd,
-  miniapp: miniappAd
+  miniapp: miniappAd,
+  token: tokenAd,
+  farcasterProfile: farcasterProfileAd
 };
-var adTypes = ["link", "cast", "miniapp"];
+var adTypes = [
+  "link",
+  "cast",
+  "miniapp",
+  "token",
+  "farcasterProfile"
+];
 function getAd(type) {
   return ads[type];
 }
@@ -221,6 +313,6 @@ function validateAdData(data) {
 var adDefinitions = ads;
 var adModels = ads;
 
-export { adDefinitions, adModels, adTypes, ads, castAd, defineAd, getAd, linkAd, miniappAd, processAd, safeProcessAd, validateAdData };
+export { adDefinitions, adModels, adTypes, ads, castAd, defineAd, farcasterProfileAd, getAd, linkAd, miniappAd, processAd, safeProcessAd, tokenAd, validateAdData };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map