@highfivve/ad-tag 5.5.4

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 highfivve.com GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,149 @@
+# Ad Tag Library
+
+This library provides a set of components to orchestrate Google Ad Manager (GAM), Prebid and Amazon TAM.
+
+## Building a bundle
+
+An ad tag bundle is a set of modules bundled together in a single javascript file. This file can be included in a website to display ads.
+In order to create a bundle you need
+
+1. A JSON configuration file that contains the modules that should be included. All modules are in [ad-tag/source/ts/bundle](ad-tag/source/ts/bundle).
+   You can find examples bundles in [bundles](bundles).
+2. This repository cloned and installed at the version you want to build.
+
+Then run
+
+```bash
+npm ci
+export NODE_ENV=production
+npx ts-node bundle.ts --output adtag.mjs --config <path-to-config.json>
+```
+
+This will generate an ES6 bundle.
+
+!! If you are using node.js 17+ you currently need to do this !!
+
+```bash
+export NODE_OPTIONS=--openssl-legacy-provider
+```
+
+See [https://stackoverflow.com/questions/69692842/error-message-error0308010cdigital-envelope-routinesunsupported](https://stackoverflow.com/questions/69692842/error-message-error0308010cdigital-envelope-routinesunsupported)
+
+### Authentication
+[See github docs on authentication](https://docs.github.com/en/free-pro-team@latest/packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages)
+
+Add the .npmrc file to publisher project, so that we can install the package from the github npm registry.
+As long as we have a private github repository we need to add the authToken (currently personal token).
+
+```
+@highfivve:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken={TOKEN}
+always-auth=true
+registry=https://registry.npmjs.org
+```
+
+I recommend putting this under `~/.npmrc` as described in the [npmrc documentation](https://docs.npmjs.com/cli/v6/configuring-npm/npmrc)
+
+# Developing
+
+You require `npm` for developing.
+
+```bash
+npm run setup
+```
+
+## Running tests
+
+You can run tests with
+
+```bash
+npm test
+```
+
+If you do run tests in your IDE, you need to make sure that those two parameters are added to the Mocha runner
+
+```
+--require ts-node/register --require tsconfig-paths/register
+```
+
+The [tsconfig-paths](https://www.npmjs.com/package/tsconfig-paths) package is necessary to support the `compilerOptions.paths` in the `tsconfig.json`,
+which allow for more concise imports.
+
+For intellij see [https://www.jetbrains.com/help/idea/running-unit-tests-on-typescript.html#mocha](https://www.jetbrains.com/help/idea/running-unit-tests-on-typescript.html#mocha)
+
+## Examples
+
+In order to run the examples you must create a production build of the modules.
+
+```bash
+npm run build:watch
+```
+
+### Testing with examples
+
+If you want to test code changes within the examples you have to start the module in watch mode.
+
+```bash
+# rebuild the module you change, e.g. ad-tag
+cd examples/esbuild
+npm start
+```
+
+## Styles
+
+The ad tag offers a set of styles that can be included in your project. You can build the styles with
+
+```bash
+# if you haven't run setup:dev before
+npm run setup:css:defaults
+npm run build:css
+```
+
+Styles will appear in the [dist](dist) folder.
+
+### Overriding styles
+
+You can override styles by changing the files
+
+- [ad-tag/source/css/publisher.vars.css](ad-tag/source/css/publisher.vars.css) for CSS variables
+- [ad-tag/source/css/publisher.media.json](ad-tag/source/css/publisher.media.json) for custom media properties
+
+The variables are split in different `:root` sections, so that [cssnano can deduplicate identical rules](https://cssnano.github.io/cssnano/docs/optimisations/discardduplicates/).
+
+You can create the default styles with
+
+```bash
+npm run setup:css:defaults
+```
+
+## Console
+
+You can build and test the console locally with
+
+```bash
+npm run build:console:watch
+```
+
+Then you can start the esbuild example with
+
+```bash
+cd examples/esbuild
+npm start
+```
+
+Open your browser at localhost:8080 , open your javascript console and run
+
+```javascript
+moli.openConsole('console.js');
+```
+
+# Release
+
+Releases are automatically prepared and publish via github actions. To trigger a release run
+
+```bash
+npm run release
+```
+
+There will always be a release draft on the [github release page](https://github.com/highfivve/moli-ad-tag/releases).
+Pick the version the release drafter suggests.

package/lib/ads/a9.js

@@ -0,0 +1,190 @@
+import { LOW_PRIORITY, mkConfigureStep, mkConfigureStepOnce, mkInitStep, mkPrepareRequestAdsStep, mkRequestBidsStep } from './adPipeline';
+import { AssetLoadMethod } from '../util/assetLoaderService';
+import { isSizeEqual } from '../util/sizes';
+import { SizeConfigService } from './sizeConfigService';
+import { tcfapi } from '../types/tcfapi';
+var TCPurpose = tcfapi.responses.TCPurpose;
+import * as adUnitPath from './adUnitPath';
+const isA9SlotDefinition = (slotDefinition) => {
+    return !!slotDefinition.moliSlot.a9;
+};
+const hasRequiredConsent = (tcData) => !tcData.gdprApplies ||
+    (tcData.vendor.consents['793'] &&
+        [
+            TCPurpose.STORE_INFORMATION_ON_DEVICE,
+            TCPurpose.SELECT_BASIC_ADS,
+            TCPurpose.CREATE_PERSONALISED_ADS_PROFILE,
+            TCPurpose.SELECT_PERSONALISED_ADS,
+            TCPurpose.MEASURE_AD_PERFORMANCE,
+            TCPurpose.APPLY_MARKET_RESEARCH,
+            TCPurpose.DEVELOP_IMPROVE_PRODUCTS
+        ].every(purpose => tcData.purpose.consents[purpose]));
+export const a9Init = (config, assetService) => mkInitStep('a9-init', (context) => new Promise(resolve => {
+    context.window__.apstag = context.window__.apstag || {
+        _Q: [],
+        init: function () {
+            context.window__.apstag._Q.push(['i', arguments]);
+        },
+        fetchBids: function () {
+            context.window__.apstag._Q.push(['f', arguments]);
+        },
+        setDisplayBids: function () {
+            return;
+        },
+        targetingKeys: function () {
+            return;
+        },
+        dpa: function () {
+            context.window__.apstag._Q.push(['di', arguments]);
+        },
+        rpa: function () {
+            context.window__.apstag._Q.push(['ri', arguments]);
+        },
+        upa: function () {
+            context.window__.apstag._Q.push(['ui', arguments]);
+        }
+    };
+    if (context.env__ !== 'test' && hasRequiredConsent(context.tcData__)) {
+        assetService
+            .loadScript({
+            name: 'A9',
+            loadMethod: AssetLoadMethod.TAG,
+            assetUrl: config.scriptUrl
+                ? config.scriptUrl
+                : '//c.amazon-adsystem.com/aax2/apstag.js'
+        })
+            .catch(error => context.logger__.error('failed to load apstag.js', error));
+    }
+    resolve();
+}));
+export const a9Configure = (config, schainConfig) => mkConfigureStep('a9-configure', (context, _slots) => {
+    return new Promise(resolve => {
+        const schainNodes = [schainConfig.supplyChainStartNode];
+        if (config.schainNode) {
+            schainNodes.push(config.schainNode);
+        }
+        context.window__.apstag.init({
+            pubID: config.pubID,
+            adServer: 'googletag',
+            bidTimeout: config.timeout,
+            gdpr: {
+                cmpTimeout: config.cmpTimeout
+            },
+            schain: {
+                complete: 1,
+                ver: '1.0',
+                nodes: schainNodes
+            }
+        });
+        resolve();
+    });
+});
+export const a9PublisherAudiences = (config) => mkConfigureStepOnce('a9-publisher-audiences', (context, _slots) => new Promise(resolve => {
+    const publisherAudience = config.publisherAudience;
+    if (publisherAudience && publisherAudience.enabled) {
+        const tokenConfig = {
+            hashedRecords: [
+                {
+                    type: 'email',
+                    record: publisherAudience.sha256Email
+                }
+            ]
+        };
+        context.logger__.debug('A9', 'Enable publisher audiences');
+        context.window__.apstag.rpa(tokenConfig);
+        if (context.window__.__tcfapi) {
+            let firstCall = true;
+            context.window__.__tcfapi('addEventListener', 2, tcdata => {
+                if (firstCall) {
+                    firstCall = false;
+                    return;
+                }
+                if (tcdata.eventStatus === tcfapi.status.EventStatus.USER_ACTION_COMPLETE) {
+                    context.logger__.debug('A9', 'Update publisher audience token');
+                    context.window__.apstag.upa(tokenConfig);
+                }
+            });
+        }
+    }
+    resolve();
+}));
+export const a9ClearTargetingStep = () => mkPrepareRequestAdsStep('a9-clear-targeting', LOW_PRIORITY, (context, slots) => {
+    if (context.requestId__ === 0) {
+        context.logger__.debug('A9', 'skip ad slot clearing for first pipeline run');
+        return Promise.resolve();
+    }
+    return new Promise(resolve => {
+        context.logger__.debug('A9', 'clear a9 targetings');
+        slots.forEach(({ adSlot }) => {
+            adSlot
+                .getTargetingKeys()
+                .filter(key => key === 'amznp' || key === 'amznsz' || key === 'amznbid')
+                .forEach(key => adSlot.clearTargeting(key));
+        });
+        resolve();
+    });
+});
+const resolveAdUnitPath = (path, slotDepth, variables) => {
+    const adUnitPathWithoutChildId = adUnitPath.removeChildId(path);
+    const truncated = slotDepth
+        ? adUnitPath.withDepth(adUnitPathWithoutChildId, slotDepth)
+        : adUnitPathWithoutChildId;
+    return adUnitPath.resolveAdUnitPath(truncated, variables);
+};
+export const a9RequestBids = (config) => mkRequestBidsStep('a9-fetch-bids', (context, slotDefinitions) => new Promise(resolve => {
+    if (!hasRequiredConsent(context.tcData__)) {
+        context.logger__.debug('A9', 'Skip any due to missing consent');
+        resolve();
+        return;
+    }
+    const slots = slotDefinitions
+        .filter(isA9SlotDefinition)
+        .filter(slot => !context.auction__.isSlotThrottled(slot.adSlot))
+        .filter(slot => {
+        const isVideo = slot.moliSlot.a9.mediaType === 'video';
+        const filterSlot = context.labelConfigService__.filterSlot(slot.moliSlot.a9);
+        const sizesNotEmpty = slot.filterSupportedSizes(slot.moliSlot.sizes).filter(SizeConfigService.isFixedSize)
+            .length > 0;
+        return filterSlot && (isVideo || sizesNotEmpty);
+    })
+        .map(({ moliSlot, priceRule, filterSupportedSizes }) => {
+        if (moliSlot.a9.mediaType === 'video') {
+            return {
+                slotID: moliSlot.domId,
+                mediaType: 'video'
+            };
+        }
+        else {
+            const enabledSizes = config.supportedSizes
+                ? moliSlot.sizes.filter(moliSize => config.supportedSizes?.some(supportedSize => isSizeEqual(supportedSize, moliSize)))
+                : moliSlot.sizes;
+            const adUnitPath = resolveAdUnitPath(moliSlot.adUnitPath, moliSlot.a9.slotNamePathDepth ?? config.slotNamePathDepth, context.adUnitPathVariables__);
+            return {
+                slotID: moliSlot.domId,
+                slotName: adUnitPath,
+                sizes: filterSupportedSizes(enabledSizes).filter(SizeConfigService.isFixedSize),
+                ...(config.enableFloorPrices && priceRule
+                    ?
+                        {
+                            floor: {
+                                value: Math.ceil(context.window__.pbjs?.convertCurrency
+                                    ? context.window__.pbjs.convertCurrency(priceRule.floorprice, 'EUR', config.floorPriceCurrency || 'USD') * 100
+                                    : priceRule.floorprice * 100 * 1.19),
+                                currency: config.floorPriceCurrency || 'USD'
+                            }
+                        }
+                    : {})
+            };
+        }
+    });
+    context.logger__.debug('A9', `Fetch '${slots.length}' A9 slots: ${slots.map(slot => `[slotID] ${slot.slotID}`)}`);
+    if (slots.length === 0) {
+        resolve();
+    }
+    else {
+        context.window__.apstag.fetchBids({ slots, ...(context.bucket__?.timeout && { bidTimeout: context.bucket__.timeout }) }, (_bids) => {
+            context.window__.apstag.setDisplayBids();
+            resolve();
+        });
+    }
+}));