@nextad/auction 0.1.3 → 0.1.5

package/dist/index.d.mts

@@ -0,0 +1,57 @@
+import { Bid, BidResponse } from 'iab-openrtb/v26';
+
+type BidInformation = {
+    currency?: string;
+    seat?: string;
+    version: string;
+};
+interface CurrencyRates {
+    /** ISO 4217 Currency Code (Example: USD, JPY, EUR) */
+    [currency: string]: number;
+}
+interface ConversionRates {
+    /** convert rate of base currency */
+    [baseCurrency: string]: CurrencyRates;
+}
+interface CurrencyConversionData {
+    dataAsOf: string;
+    generatedAt: string;
+    conversions: ConversionRates;
+}
+
+type AuctionType = "open" | "closed";
+type AuctionOptions = {
+    lossProcessing?: boolean;
+    currencyConversionData?: CurrencyConversionData;
+};
+declare class Auction {
+    private losingBids;
+    private bids;
+    private itemIds;
+    private status;
+    private options;
+    private bidInformation;
+    constructor(itemOrImpressionIds: string | string[], options?: AuctionOptions);
+    getStatus(): AuctionType;
+    getLosingBids(): {
+        v26: Bid[];
+    };
+    getBidInformation(bid: Bid): BidInformation | undefined;
+    getBidInformations(): WeakMap<Bid, BidInformation>;
+    placeBidResponseV26(bidResponse: BidResponse): this;
+    end(): Bid;
+    private setLosingBids;
+    private handleLossBids;
+    private handleLossBid;
+}
+
+declare class BidNotFoundException {
+    name: string;
+    message: string;
+}
+declare class AlreadyEndedAuctionException {
+    name: string;
+    message: string;
+}
+
+export { AlreadyEndedAuctionException, Auction, BidNotFoundException };

package/dist/index.d.ts

@@ -0,0 +1,57 @@
+import { Bid, BidResponse } from 'iab-openrtb/v26';
+
+type BidInformation = {
+    currency?: string;
+    seat?: string;
+    version: string;
+};
+interface CurrencyRates {
+    /** ISO 4217 Currency Code (Example: USD, JPY, EUR) */
+    [currency: string]: number;
+}
+interface ConversionRates {
+    /** convert rate of base currency */
+    [baseCurrency: string]: CurrencyRates;
+}
+interface CurrencyConversionData {
+    dataAsOf: string;
+    generatedAt: string;
+    conversions: ConversionRates;
+}
+
+type AuctionType = "open" | "closed";
+type AuctionOptions = {
+    lossProcessing?: boolean;
+    currencyConversionData?: CurrencyConversionData;
+};
+declare class Auction {
+    private losingBids;
+    private bids;
+    private itemIds;
+    private status;
+    private options;
+    private bidInformation;
+    constructor(itemOrImpressionIds: string | string[], options?: AuctionOptions);
+    getStatus(): AuctionType;
+    getLosingBids(): {
+        v26: Bid[];
+    };
+    getBidInformation(bid: Bid): BidInformation | undefined;
+    getBidInformations(): WeakMap<Bid, BidInformation>;
+    placeBidResponseV26(bidResponse: BidResponse): this;
+    end(): Bid;
+    private setLosingBids;
+    private handleLossBids;
+    private handleLossBid;
+}
+
+declare class BidNotFoundException {
+    name: string;
+    message: string;
+}
+declare class AlreadyEndedAuctionException {
+    name: string;
+    message: string;
+}
+
+export { AlreadyEndedAuctionException, Auction, BidNotFoundException };

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";var u=Object.defineProperty;var h=Object.getOwnPropertyDescriptor;var l=Object.getOwnPropertyNames;var v=Object.prototype.hasOwnProperty;var f=(s,i)=>{for(var e in i)u(s,e,{get:i[e],enumerable:!0})},m=(s,i,e,r)=>{if(i&&typeof i=="object"||typeof i=="function")for(let t of l(i))!v.call(s,t)&&t!==e&&u(s,t,{get:()=>i[t],enumerable:!(r=h(i,t))||r.enumerable});return s};var g=s=>m(u({},"__esModule",{value:!0}),s);var y={};f(y,{AlreadyEndedAuctionException:()=>a,Auction:()=>B,BidNotFoundException:()=>o});module.exports=g(y);var c=class{static getHighestBidV26(i,e,r){return r?i.reduce((t,n)=>{let d=this.convertPrice(t,e,r);return this.convertPrice(n,e,r)>d?n:t}):i.reduce((t,n)=>{let d=t.price*100;return n.price*100>d?n:t})}static convertPrice(i,e,r){let t=i.price,n=r.conversions[e.get(i)?.currency||"USD"];if(!n)return t*100;let p=n["USD"];return t*(p||1)*100}};var o=class{name="BidNotFoundException";message="Bid is not found."},a=class{name="AlreadyEndedAuctionException";message="Auction is already ended."};var B=class{losingBids;bids;itemIds=[];status;options;bidInformation;constructor(i,e={}){this.options={lossProcessing:!0,...e},this.bids={v26:[]},this.losingBids={v26:[]},this.status="open",this.bidInformation=new WeakMap,typeof i=="string"?this.itemIds.push(i):this.itemIds.push(...i)}getStatus(){return this.status}getLosingBids(){return this.losingBids}getBidInformation(i){return this.bidInformation.get(i)}getBidInformations(){return this.bidInformation}placeBidResponseV26(i){if(i.seatbid){let e=i.seatbid.flatMap(r=>r.bid.map(t=>(this.bidInformation.set(t,{currency:i.cur,version:"2.6",seat:r.seat}),t)));this.bids.v26.push(...e)}return this}end(){if(this.status!=="open")throw new a;if(!this.bids.v26.length)throw new o;let i=c.getHighestBidV26(this.bids.v26,this.bidInformation,this.options.currencyConversionData);return this.setLosingBids(i),this.handleLossBids(),this.status="closed",i}setLosingBids(i){this.losingBids.v26.push(...this.bids.v26.filter(e=>e.id!==i.id))}handleLossBids(){this.losingBids.v26.forEach(i=>{this.handleLossBid(i)})}handleLossBid(i){this.options.lossProcessing&&i.lurl&&fetch(i.lurl,{keepalive:!0})}};0&&(module.exports={AlreadyEndedAuctionException,Auction,BidNotFoundException});

package/dist/index.mjs

@@ -0,0 +1 @@
+var o=class{static getHighestBidV26(i,e,s){return s?i.reduce((t,r)=>{let n=this.convertPrice(t,e,s);return this.convertPrice(r,e,s)>n?r:t}):i.reduce((t,r)=>{let n=t.price*100;return r.price*100>n?r:t})}static convertPrice(i,e,s){let t=i.price,r=s.conversions[e.get(i)?.currency||"USD"];if(!r)return t*100;let p=r["USD"];return t*(p||1)*100}};var a=class{name="BidNotFoundException";message="Bid is not found."},d=class{name="AlreadyEndedAuctionException";message="Auction is already ended."};var u=class{losingBids;bids;itemIds=[];status;options;bidInformation;constructor(i,e={}){this.options={lossProcessing:!0,...e},this.bids={v26:[]},this.losingBids={v26:[]},this.status="open",this.bidInformation=new WeakMap,typeof i=="string"?this.itemIds.push(i):this.itemIds.push(...i)}getStatus(){return this.status}getLosingBids(){return this.losingBids}getBidInformation(i){return this.bidInformation.get(i)}getBidInformations(){return this.bidInformation}placeBidResponseV26(i){if(i.seatbid){let e=i.seatbid.flatMap(s=>s.bid.map(t=>(this.bidInformation.set(t,{currency:i.cur,version:"2.6",seat:s.seat}),t)));this.bids.v26.push(...e)}return this}end(){if(this.status!=="open")throw new d;if(!this.bids.v26.length)throw new a;let i=o.getHighestBidV26(this.bids.v26,this.bidInformation,this.options.currencyConversionData);return this.setLosingBids(i),this.handleLossBids(),this.status="closed",i}setLosingBids(i){this.losingBids.v26.push(...this.bids.v26.filter(e=>e.id!==i.id))}handleLossBids(){this.losingBids.v26.forEach(i=>{this.handleLossBid(i)})}handleLossBid(i){this.options.lossProcessing&&i.lurl&&fetch(i.lurl,{keepalive:!0})}};export{d as AlreadyEndedAuctionException,u as Auction,a as BidNotFoundException};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nextad/auction",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "",
   "keywords": [],
   "author": "Kai Miyamoto",
@@ -25,6 +25,11 @@
     "import": "./dist/index.mjs",
     "require": "./dist/index.js"
   },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
   "scripts": {
     "test": "vitest",
     "build": "tsup"

package/src/Auction.ts

@@ -1,125 +0,0 @@
-import { BidComparator } from "./BidComparator";
-import {
-  AlreadyEndedAuctionException,
-  BidNotFoundException,
-} from "./exceptions";
-import type {
-  BidResponse as BaseBidResponseV26,
-  Bid as BidV26,
-} from "iab-openrtb/v26";
-import type { BidInformation, CurrencyConversionData } from "./types";
-
-type AuctionType = "open" | "closed";
-
-type AuctionOptions = {
-  lossProcessing?: boolean;
-  currencyConversionData?: CurrencyConversionData;
-};
-
-export class Auction {
-  private losingBids: {
-    v26: BidV26[];
-  };
-  private bids: {
-    v26: BidV26[];
-  };
-
-  private itemIds: string[] = [];
-  private status: AuctionType;
-  private options: AuctionOptions;
-  private bidInformation: WeakMap<BidV26, BidInformation>;
-
-  public constructor(
-    itemOrImpressionIds: string | string[],
-    options: AuctionOptions = {}
-  ) {
-    this.options = {
-      lossProcessing: true,
-      ...options,
-    };
-
-    this.bids = {
-      v26: [],
-    };
-    this.losingBids = {
-      v26: [],
-    };
-    this.status = "open";
-    this.bidInformation = new WeakMap();
-
-    if (typeof itemOrImpressionIds === "string") {
-      this.itemIds.push(itemOrImpressionIds);
-    } else {
-      this.itemIds.push(...itemOrImpressionIds);
-    }
-  }
-
-  public getStatus(): AuctionType {
-    return this.status;
-  }
-
-  public getLosingBids(): { v26: BidV26[] } {
-    return this.losingBids;
-  }
-
-  public placeBidResponseV26(bidResponse: BaseBidResponseV26): this {
-    if (bidResponse.seatbid) {
-      const bids: BidV26[] = bidResponse.seatbid.flatMap((seatbid) => {
-        return seatbid.bid.map((bid) => {
-          this.bidInformation.set(bid, {
-            currency: bidResponse.cur,
-            version: "2.6",
-            seat: seatbid.seat,
-          });
-          return bid;
-        });
-      });
-
-      this.bids.v26.push(...bids);
-    }
-
-    return this;
-  }
-
-  public end(): BidV26 {
-    if (this.status !== "open") {
-      throw new AlreadyEndedAuctionException();
-    }
-
-    if (!this.bids.v26.length) {
-      throw new BidNotFoundException();
-    }
-
-    const highestBid = BidComparator.getHighestBidV26(
-      this.bids.v26,
-      this.bidInformation,
-      this.options.currencyConversionData
-    );
-
-    this.setLosingBids(highestBid);
-    this.handleLossBids();
-    this.status = "closed";
-
-    return highestBid;
-  }
-
-  private setLosingBids(winningBid: BidV26): void {
-    this.losingBids.v26.push(
-      ...this.bids.v26.filter((bid) => bid.id !== winningBid.id)
-    );
-  }
-
-  private handleLossBids(): void {
-    this.losingBids.v26.forEach((bid) => {
-      this.handleLossBid(bid);
-    });
-  }
-
-  private handleLossBid(bid: BidV26): void {
-    if (this.options.lossProcessing && bid.lurl) {
-      fetch(bid.lurl, {
-        keepalive: true,
-      });
-    }
-  }
-}

package/src/BidComparator.ts

@@ -1,50 +0,0 @@
-import type { BidInformation, CurrencyConversionData } from "./types";
-import type { Bid as BidV26 } from "iab-openrtb/v26";
-
-export class BidComparator {
-  public static getHighestBidV26(
-    bids: BidV26[],
-    bidInformation: WeakMap<BidV26, BidInformation>,
-    currencyConversionData?: CurrencyConversionData
-  ): BidV26 {
-    if (!currencyConversionData) {
-      return bids.reduce((highest, current) => {
-        const highestPrice = highest.price * 100;
-        const currentPrice = current.price * 100;
-        return currentPrice > highestPrice ? current : highest;
-      });
-    }
-
-    return bids.reduce((highest, current) => {
-      const highestPrice = this.convertPrice(
-        highest,
-        bidInformation,
-        currencyConversionData
-      );
-      const currentPrice = this.convertPrice(
-        current,
-        bidInformation,
-        currencyConversionData
-      );
-      return currentPrice > highestPrice ? current : highest;
-    });
-  }
-
-  private static convertPrice(
-    bid: BidV26,
-    bidInformation: WeakMap<BidV26, BidInformation>,
-    conversionData: CurrencyConversionData
-  ): number {
-    const price = bid.price;
-    const rates =
-      conversionData.conversions[bidInformation.get(bid)?.currency || "USD"];
-
-    if (!rates) {
-      return price * 100;
-    }
-
-    const targetCurrency = "USD";
-    const rate = rates[targetCurrency];
-    return price * (rate || 1) * 100;
-  }
-}

package/src/exceptions/index.ts

@@ -1,9 +0,0 @@
-export class BidNotFoundException {
-  name = "BidNotFoundException";
-  message = "Bid is not found.";
-}
-
-export class AlreadyEndedAuctionException {
-    name = "AlreadyEndedAuctionException";
-    message = "Auction is already ended.";
-}

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from './Auction';
-export * from '@/exceptions';

package/src/types/index.ts

@@ -1,22 +0,0 @@
-export type BidInformation = {
-  currency?: string;
-  seat?: string;
-  version: string;
-};
-
-
-export interface CurrencyRates {
-  /** ISO 4217 Currency Code (Example: USD, JPY, EUR) */
-  [currency: string]: number;
-}
-
-interface ConversionRates {
-  /** convert rate of base currency */
-  [baseCurrency: string]: CurrencyRates;
-}
-
-export interface CurrencyConversionData {
-  dataAsOf: string;
-  generatedAt: string;
-  conversions: ConversionRates;
-}

package/test/tsconfig.json

@@ -1,12 +0,0 @@
-{
-  "extends": "../tsconfig.json",
-  "compilerOptions": {
-    "moduleResolution": "bundler",
-    "types": ["vitest/globals"],
-    "baseUrl": "..",
-    "paths": {
-      "@/*": ["src/*"]
-    }
-  },
-  "include": ["./**/*.ts"]
-}

package/test/units/Auction.test.ts

@@ -1,176 +0,0 @@
-import { openrtbFaker } from "@nextad/faker";
-import { Auction } from "@/Auction";
-import {
-  AlreadyEndedAuctionException,
-  BidNotFoundException,
-} from "@/exceptions";
-
-describe("Auction", () => {
-  it("returns highest bid from bids with specified item(impression) when auction ends", () => {
-    const sut = new Auction("impid-1");
-    const bidResponse = openrtbFaker.v26.bidResponse
-      .addBannerBid({ impid: "impid-1", price: 10 })
-      .make();
-    const bidResponse2 = openrtbFaker.v26.bidResponse
-      .addBannerBid({ impid: "impid-1", price: 20 })
-      .make();
-    sut.placeBidResponseV26(bidResponse);
-    sut.placeBidResponseV26(bidResponse2);
-
-    const result = sut.end();
-
-    expect(result.id).toBe(bidResponse2.seatbid![0].bid[0].id);
-  });
-
-  it("returns highest bid from bids with specified items(impressions) when auction ends", () => {
-    const sut = new Auction(["impid-1", "impid-2"]);
-    const bidResponse = openrtbFaker.v26.bidResponse
-      .addBannerBid({ impid: "impid-1", price: 10 })
-      .make();
-    const bidResponse2 = openrtbFaker.v26.bidResponse
-      .addBannerBid({ impid: "impid-1", price: 20 })
-      .addVideoBid({ impid: "impid-2", price: 30 })
-      .make();
-    sut.placeBidResponseV26(bidResponse);
-    sut.placeBidResponseV26(bidResponse2);
-
-    const result = sut.end();
-
-    expect(result.id).toBe(bidResponse2.seatbid![0].bid[1].id);
-  });
-
-  it("returns highest bid considering currency when auction ends", () => {
-    const sut = new Auction("impid-1", {
-      currencyConversionData: {
-        dataAsOf: "2021-01-01",
-        generatedAt: "2021-01-01",
-        conversions: {
-          JPY: {
-            USD: 0.09,
-          },
-        },
-      },
-    });
-    const bidResponse = openrtbFaker.v26.bidResponse
-      .withCurrency("JPY")
-      .addBannerBid({ impid: "impid-1", price: 10 })
-      .make();
-    const bidResponse2 = openrtbFaker.v26.bidResponse
-      .withCurrency("USD")
-      .addBannerBid({ impid: "impid-1", price: 5 })
-      .make();
-    sut.placeBidResponseV26(bidResponse);
-    sut.placeBidResponseV26(bidResponse2);
-
-    const result = sut.end();
-
-    expect(result.id).toBe(bidResponse2.seatbid![0].bid[0].id);
-  });
-
-  it("throws error when attempting to end auction without bids", () => {
-    const sut = new Auction("impid-1");
-
-    expect(() => sut.end()).toThrow(BidNotFoundException);
-  });
-  it("returns losing bids when auction ends", () => {
-    const sut = new Auction(["impid-1", "impid-2"]);
-    const bidResponse = openrtbFaker.v26.bidResponse
-      .addBannerBid({
-        impid: "impid-1",
-        price: 10,
-      })
-      .addBannerBid({
-        impid: "impid-2",
-        price: 20,
-      })
-      .make();
-    sut.placeBidResponseV26(bidResponse);
-
-    sut.end();
-
-    const losingBids = sut.getLosingBids();
-    expect(losingBids.v26.length).toBe(1);
-    expect(losingBids.v26[0].id).toBe(bidResponse.seatbid![0].bid[0].id);
-  });
-
-  it("throws error when attempting to already ended auction", () => {
-    const sut = new Auction("impid-1");
-    const bidResponse = openrtbFaker.v26.bidResponse
-      .addBannerBid({ impid: "impid-1", price: 10 })
-      .make();
-    sut.placeBidResponseV26(bidResponse);
-    sut.end();
-
-    expect(() => sut.end()).toThrow(AlreadyEndedAuctionException);
-  });
-
-  it("sends loss notification when bid contains loss notice url", () => {
-    const fetchMock = vi.fn();
-    vi.stubGlobal("fetch", fetchMock);
-    const sut = new Auction(["impid-1", "impid-2"]);
-    const bidResponse = openrtbFaker.v26.bidResponse
-      .addBannerBid({
-        impid: "impid-1",
-        price: 10,
-        lurl: "https://example.com/lurl",
-      })
-      .addBannerBid({
-        impid: "impid-2",
-        price: 20,
-      })
-      .make();
-    sut.placeBidResponseV26(bidResponse);
-
-    sut.end();
-
-    expect(fetchMock).toHaveBeenCalledOnce();
-    expect(fetchMock).toHaveBeenCalledWith("https://example.com/lurl", {
-      keepalive: true,
-    });
-  });
-
-  it("does not send loss notification when bid does not contain loss notice url", () => {
-    const fetchMock = vi.fn();
-    vi.stubGlobal("fetch", fetchMock);
-    const sut = new Auction(["impid-1", "impid-2"]);
-    const bidResponse = openrtbFaker.v26.bidResponse
-      .addBannerBid({
-        impid: "impid-1",
-        price: 10,
-      })
-      .addBannerBid({
-        impid: "impid-2",
-        price: 20,
-      })
-      .make();
-    sut.placeBidResponseV26(bidResponse);
-
-    sut.end();
-
-    expect(fetchMock).not.toHaveBeenCalled();
-  });
-
-  it("does not send loss notification when loss processing is specified as false", () => {
-    const fetchMock = vi.fn();
-    vi.stubGlobal("fetch", fetchMock);
-    const sut = new Auction(["impid-1", "impid-2"], {
-      lossProcessing: false,
-    });
-    const bidResponse = openrtbFaker.v26.bidResponse
-      .addBannerBid({
-        impid: "impid-1",
-        price: 10,
-        lurl: "https://example.com/lurl",
-      })
-      .addBannerBid({
-        impid: "impid-2",
-        price: 20,
-      })
-      .make();
-    sut.placeBidResponseV26(bidResponse);
-
-    sut.end();
-
-    expect(fetchMock).not.toHaveBeenCalled();
-  });
-});

package/tsconfig.json

@@ -1,29 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es2022",
-    "lib": ["es2022", "esnext.disposable", "dom"],
-
-    "module": "ESNext",
-    "moduleDetection": "force",
-    "allowJs": true,
-
-    "moduleResolution": "Bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "isolatedModules": true,
-    "preserveConstEnums": true,
-    "noEmit": true,
-
-    "skipLibCheck": true,
-    "strict": true,
-    "noFallthroughCasesInSwitch": true,
-    "forceConsistentCasingInFileNames": true,
-
-    "baseUrl": ".",
-    "paths": {
-      "@/*": ["src/*"]
-    }
-  },
-  "include": ["**/*.ts"],
-  "exclude": ["node_modules"]
-}

package/tsup.config.ts

@@ -1,9 +0,0 @@
-import { defineConfig } from "tsup";
-
-export default defineConfig({
-  format: ["esm", "cjs"],
-  clean: true,
-  minify: true,
-  dts: true,
-  entry: ["src/index.ts"],
-});

package/vitest.config.ts

@@ -1,14 +0,0 @@
-import { fileURLToPath } from "node:url";
-import path from "node:path";
-import { defineConfig } from "vitest/config";
-
-const __dirname = fileURLToPath(new URL(".", import.meta.url));
-
-export default defineConfig({
-  test: {
-    globals: true,
-    alias: {
-      "@": path.resolve(__dirname, "src"),
-    },
-  },
-});