{"_id":"@cafebazaar/ad-sdk","_rev":"3-6b8c5e233af20eb478522ed920d211a8","name":"@cafebazaar/ad-sdk","dist-tags":{"latest":"0.0.5"},"versions":{"0.0.1":{"name":"@cafebazaar/ad-sdk","description":"CafeBazaar Advertisement SDK for Web","version":"0.0.1","main":"dist/ad-sdk.js","module":"dist/ad-sdk.mjs","types":"dist/ad-sdk.d.ts","author":{"name":"Amir Momenian","email":"nainemom@gmail.com"},"build":{"entry":"src/main.ts","fileName":"ad-sdk","outDir":"dist","libraryName":"BazaarAd","config":{"apiBaseUrl":"https://paxt.ir/api"}},"publishConfig":{"access":"public"},"scripts":{"build":"tsc && vite build --mode production","dev":"tsc && vite build --mode development","prepublishOnly":"npm run build"},"devDependencies":{"@types/express":"^4.17.21","express":"^4.18.2","typescript":"^5.0.2","vite":"^4.4.5","vite-plugin-dts":"^3.7.3"},"gitHead":"97bec0efeef335c1d1a89a0cb1f5448affcd853a","_id":"@cafebazaar/ad-sdk@0.0.1","_nodeVersion":"16.20.2","_npmVersion":"8.10.0","dist":{"integrity":"sha512-ctXUUUCBZQJ9ol6mSSeD0PSrXa5afNhWR2//HBB6EBFjfxtK/ElwJXJq29WaZy2NdXlPkvMRlhuHvYxF243aJQ==","shasum":"4f207b2660a56fb9ddf0266acaec7428a42d0140","tarball":"https://registry.npmjs.org/@cafebazaar/ad-sdk/-/ad-sdk-0.0.1.tgz","fileCount":7,"unpackedSize":22732,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICvGI0iu2ISsNhZY7fgK2iMtGDwN5usoughX/HFfgKTUAiEAoXjW0I/jOa0Qk6RLR2Ozi2DEXFWoqkHcqeoLNi0XXGg="}]},"_npmUser":{"name":"nainemom","email":"nainemom@gmail.com"},"directories":{},"maintainers":[{"name":"_mahdude","email":"MMahmoudiMehrizi@gmail.com"},{"name":"amir_mousavi","email":"amirhossein.mousavi@cafebazaar.ir"},{"name":"nainemom","email":"nainemom@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ad-sdk_0.0.1_1709630567533_0.6125290233039566"},"_hasShrinkwrap":false},"0.0.3":{"name":"@cafebazaar/ad-sdk","description":"CafeBazaar Advertisement SDK for Web","version":"0.0.3","main":"dist/ad-sdk.js","module":"dist/ad-sdk.mjs","browser":"dist/ad-sdk.iife.js","types":"dist/ad-sdk.d.ts","author":{"name":"Amir Momenian","email":"nainemom@gmail.com"},"build":{"entry":"src/main.ts","fileName":"ad-sdk","outDir":"dist","libraryName":"BazaarAd","config":{"apiBaseUrl":"https://paxt.ir/api"}},"publishConfig":{"access":"public"},"scripts":{"build":"tsc && vite build --mode production","dev":"tsc && vite build --mode development","prepublishOnly":"npm run build"},"devDependencies":{"@types/express":"^4.17.21","express":"^4.18.2","typescript":"^5.0.2","vite":"^4.4.5","vite-plugin-dts":"^3.7.3"},"gitHead":"4aace4cace24443d403f97e114d1a02df943c402","_id":"@cafebazaar/ad-sdk@0.0.3","_nodeVersion":"16.20.2","_npmVersion":"8.10.0","dist":{"integrity":"sha512-LraK6UlBK+mvRWh2hEZRmONyq1DVHFFNwOuT61xNU+Ad+tyXCxRPPjMcZhV5m5Rtf8ighYqgCORDj/yX8QMyyw==","shasum":"3f54c22fceb4f457e8cc136af9ca45fd4e461f8e","tarball":"https://registry.npmjs.org/@cafebazaar/ad-sdk/-/ad-sdk-0.0.3.tgz","fileCount":7,"unpackedSize":22175,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCGaZ3sCLaY5L68m9KdOrpleJkE62N4Q+lf04JVmWjmKAIhAJAOT1dvP2b/CIo2p53MfOpvIBvenBCZoBKdvGZ80gKM"}]},"_npmUser":{"name":"nainemom","email":"nainemom@gmail.com"},"directories":{},"maintainers":[{"name":"_mahdude","email":"MMahmoudiMehrizi@gmail.com"},{"name":"amir_mousavi","email":"amirhossein.mousavi@cafebazaar.ir"},{"name":"nainemom","email":"nainemom@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ad-sdk_0.0.3_1709630902432_0.9767300635314098"},"_hasShrinkwrap":false},"0.0.4":{"name":"@cafebazaar/ad-sdk","description":"CafeBazaar Advertisement SDK for Web","version":"0.0.4","main":"dist/ad-sdk.js","module":"dist/ad-sdk.mjs","browser":"dist/ad-sdk.iife.js","types":"dist/ad-sdk.d.ts","author":{"name":"Amir Momenian","email":"nainemom@gmail.com"},"build":{"entry":"src/main.ts","fileName":"ad-sdk","outDir":"dist","libraryName":"BazaarAd","config":{"apiBaseUrl":"https://paxt.ir/api"}},"publishConfig":{"access":"public"},"scripts":{"build":"tsc && vite build --mode production","dev":"tsc && vite build --mode development","prepublishOnly":"npm run build"},"devDependencies":{"@types/express":"^4.17.21","express":"^4.18.2","typescript":"^5.0.2","vite":"^4.4.5","vite-plugin-dts":"^3.7.3"},"gitHead":"78665f5160fa3348b05d87ae4d922ccd654fc841","_id":"@cafebazaar/ad-sdk@0.0.4","_nodeVersion":"16.20.2","_npmVersion":"8.10.0","dist":{"integrity":"sha512-ZqP0mKKsRFhBvgqdzxV5lrJBOY/enL1VR8fdOU2wDXZYY4cr8XOxYzvFKD56tQrZN52dRKc9evquhXwS5cShkQ==","shasum":"aa6d04f2808634c8e7bb0130d8a9cde49264f76e","tarball":"https://registry.npmjs.org/@cafebazaar/ad-sdk/-/ad-sdk-0.0.4.tgz","fileCount":7,"unpackedSize":22269,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGiGmD1tTW/uCKgQdlIdRhxjKKzI3iozDDx6SjMAS1TsAiA55mTgBUMdNEvXIk19Q1SX8rXF83ABANvPfCtOpv6BUw=="}]},"_npmUser":{"name":"nainemom","email":"nainemom@gmail.com"},"directories":{},"maintainers":[{"name":"_mahdude","email":"MMahmoudiMehrizi@gmail.com"},{"name":"amir_mousavi","email":"amirhossein.mousavi@cafebazaar.ir"},{"name":"nainemom","email":"nainemom@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ad-sdk_0.0.4_1709632653058_0.1420699143958486"},"_hasShrinkwrap":false},"0.0.5":{"name":"@cafebazaar/ad-sdk","description":"CafeBazaar Advertisement SDK for Web","version":"0.0.5","main":"dist/ad-sdk.js","module":"dist/ad-sdk.mjs","browser":"dist/ad-sdk.iife.js","types":"dist/ad-sdk.d.ts","author":{"name":"Amir Momenian","email":"nainemom@gmail.com"},"build":{"entry":"src/main.ts","fileName":"ad-sdk","outDir":"dist","libraryName":"BazaarAd","config":{"apiBaseUrl":"https://paxt.ir/api"}},"publishConfig":{"access":"public"},"scripts":{"build":"tsc && vite build --mode production","dev":"vite --mode development","prepublishOnly":"npm run build"},"devDependencies":{"typescript":"^5.0.2","vite":"^4.4.5","vite-plugin-dts":"^3.7.3"},"gitHead":"75e5f53db481f321425455cd716786066ff997de","_id":"@cafebazaar/ad-sdk@0.0.5","_nodeVersion":"16.20.2","_npmVersion":"8.10.0","dist":{"integrity":"sha512-CSNoVdPRdcst7q+bgAJJueL/mrx0HNLKBfXSwobMzfe2f+klY/14Zkhqjxe2tGNm/VTemR+p4J+4/RksQpZ9lA==","shasum":"5975af870b711ae3d4c2aa758d94bbb715ff4f85","tarball":"https://registry.npmjs.org/@cafebazaar/ad-sdk/-/ad-sdk-0.0.5.tgz","fileCount":9,"unpackedSize":24599,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICd+xrwANT6ht5BxQYpi2LB2iADZJZOIYELbKJWtBXsyAiAu9Rp4rtvWy74fqaaccliGSiGMU1oNH9R6P4D3n1+VuA=="}]},"_npmUser":{"name":"nainemom","email":"nainemom@gmail.com"},"directories":{},"maintainers":[{"name":"_mahdude","email":"MMahmoudiMehrizi@gmail.com"},{"name":"amir_mousavi","email":"amirhossein.mousavi@cafebazaar.ir"},{"name":"nainemom","email":"nainemom@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ad-sdk_0.0.5_1709642076681_0.7916335005279616"},"_hasShrinkwrap":false}},"time":{"created":"2024-03-05T09:22:47.380Z","0.0.1":"2024-03-05T09:22:47.666Z","modified":"2024-03-05T12:34:37.286Z","0.0.3":"2024-03-05T09:28:22.567Z","0.0.4":"2024-03-05T09:57:33.215Z","0.0.5":"2024-03-05T12:34:36.834Z"},"maintainers":[{"name":"_mahdude","email":"MMahmoudiMehrizi@gmail.com"},{"name":"amir_mousavi","email":"amirhossein.mousavi@cafebazaar.ir"},{"name":"nainemom","email":"nainemom@gmail.com"}],"description":"CafeBazaar Advertisement SDK for Web","author":{"name":"Amir Momenian","email":"nainemom@gmail.com"},"readme":"# Bazaar Advertisement Sdk\n\nThis is CafeBazaar Advertisement Sdk for Minigames. The main job of this library is to show an ad when requested. \n\n\n## Installation\n\n### ESM/CJS\nIf you are using modern bundling libraries and you've access to esm/cjs modules, you can install the library via package-managers:\n```bash\nnpm i @cafebazaar/ad-sdk\n# or\nyarn add @cafebazaar/ad-sdk\n# or\npnpm add @cafebazaar/ad-sdk\n```\nAnd then import it:\n```js\n// esm\nimport BazaarAd from '@cafebazaar/ad-sdk';\n// cjs\nconst BazaarAd = require('@cafebazaar/ad-sdk');\n```\nNote that the `BazaarAd` is a default exported module and you can't import part of it like this:\n```js\nimport { x } from '@cafebazaar/ad-sdk'; // 🚫 Will throw an error\n```\n\n### IIFE\nIf you are on jquery era or you dont want to deal with javascript package managers, simply add an `<script>` tag in your `<head>` and set the src:\n\n```html\n# index.html\n<html>\n  <head>\n    <!-- ... -->\n    <script src=\"https://www.unpkg.com/@cafebazaar/ad-sdk\"></script>\n  </head>\n  <!-- ... -->\n</html>\n```\nAfter this the `BazaarAd` object is available on `globalThis`. \n\n## How to use?\n### Step 1: Initializae\n\nAt the very begining of app, call the `initialize` method to setup the sdk:\n```js\nBazaarAd.init('MY_APP_ID'); // void\n```\n\n### Step 2: Preload Ads\nIt's a common way to preload the ad before trying to show to speed up the process. However this is step is up to you and it's optional. In order to preload ads, just call the `preload` method in your app initializing step:\n```js\nBazaarAd.preload(); // Promise<void>\n```\n\n### Step 3: Show an Ad\nAfter initializing the sdk, now it's time to show an ad. The activation time is up to you and your application logic. This method will open a full viewport size dialog and load the proper ad in the screen:\n```js\nBazaarAd.show(); // Promise<void>\n```\n\n\n## Advanced Using\n\n### Getting Current State\nThere is a method called `getState` that you can get current state of ad sdk with it.\n```js\nconst currentState = BazaarAd.getState(); /* object */\n```\nThe object fields described bellow:\n- `isInited`: is sdk initialized?\n- `canPreload`: is it ok to `preload`?\n- `canShow:` is it ok to call `show` method? (is there an ad already on screen?)\n- `preloadedAdsLength`: the number of ads that preloaded and ready to show.\nFor example if your'e unsure that you can show an ad, just check the `canShow` state before calling `show` method.\n- `appId`: current app id (that setted up with `init` method)\n\n### Getting SDK version and name\nAlso there are `name` and `version` fields in the root of `window.BazaarAd` object that you may want to use.\n```js\nBazaarAd.version; /* `${number}.${number}.${number}` */\nBazaarAd.name; /* string */\n```\n","readmeFilename":"Readme.md"}