@guardian/commercial-core 7.1.0 → 27.1.0

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 {yyyy} {name of copyright owner}
+
+   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

@@ -1,56 +1,45 @@
 # @guardian/commercial-core
 
-[![npm (scoped)](https://img.shields.io/npm/v/@guardian/commercial-core)](https://www.npmjs.com/package/@guardian/commercial-core)
-[![ES version](https://badgen.net/badge/ES/2020/cyan)](https://tc39.es/ecma262/2020/)
-[![npm type definitions](https://img.shields.io/npm/types/@guardian/commercial-core)](https://www.typescriptlang.org/)
-
-> Guardian advertising business logic
-
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-## Table of contents
-
-- [Installation](#installation)
-  - [Bundling](#bundling)
-- [Development](#development)
-  - [Requirements](#requirements)
-  - [Releasing](#releasing)
-
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+This directory contains the modules that are published as the `@guardian/commercial-core` npm package.
 
 ## Installation
 
-[![Generic badge](https://img.shields.io/badge/google-chat-259082.svg)](https://chat.google.com/room/AAAAPL2MBvE)
+To install the npm package, install with your favourite package manager:
 
 ```bash
+pnpm i @guardian/commercial-core
 yarn add @guardian/commercial-core
+npm i @guardian/commercial-core
 ```
 
-### Bundling
-
-This package uses `ES2020`.
+## Development
 
-If your target environment does not support that, make sure you transpile this package when bundling your application.
+build the package with:
 
-## Development
+```bash
+pnpm build
+```
 
-### Requirements
+This will build the package into the `dist` directory, which is what is published to npm.
 
-1. [Node 16](https://nodejs.org/en/download/) ([fnm][] recommended)
-2. [Yarn](https://classic.yarnpkg.com/en/docs/install/)
+#### Beta Releases
+You can add the [beta] @guardian/commercial-core label to your pull request, this will release a beta version of the bundle to NPM, the exact version will be commented on your PR.
 
-[fnm]: https://github.com/Schniz/fnm
+In order to do this, run `pnpm changeset`. This will create a new changeset file in the .changeset directory. Commit this file with your PR.
 
-### Releasing
+Note: Once the beta version is released, the label will be removed from the PR, so you will need to add it again if you want to release subsequent new versions.
 
-Changes are automatically released to NPM.
+## Releasing to NPM
+This repository uses changesets for version management.
 
-The `main` branch on GitHub is analysed by [semantic-release](https://semantic-release.gitbook.io/) after every push.
+To release a new version with your changes, run:
 
-If a commit message follows the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0), semantic-release can determine what types of changes are included in that commit.
+```bash
+pnpm changeset add
+```
 
-If necessary, it will then automatically release a new, [semver](https://semver.org/)-compliant version of the package to NPM.
+and follow the prompts. This will create a new changeset file in the `.changeset` directory. Commit this file with your PR.
 
-#### Pull requests
+When your PR is merged, changeset will analyse the changes and create a PR to release the new version.
 
-Try to write PR titles in the conventional commit format, and [squash and merge](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges#squash-and-merge-your-pull-request-commits) when merging. That way your PR will trigger a release when you merge it (if necessary).
+if you are part of the `commercial` team, you can merge the changeset PR to release the new version. If you are not part of the `commercial` team, you will need to ask someone who is to merge the PR for you.

package/dist/cjs/ad-sizes.d.ts

@@ -1,4 +1,4 @@
-import type { Breakpoint } from './lib/breakpoint';
+import type { Breakpoint } from './breakpoint';
 type AdSizeString = 'fluid' | `${number},${number}`;
 /**
  * Store ad sizes in a way that is compatible with google-tag but also accessible via
@@ -27,9 +27,9 @@ declare class AdSize extends Array<number> {
     get width(): number;
     get height(): number;
 }
-type SizeKeys = '160x600' | '300x1050' | '300x250' | '300x600' | '728x90' | '970x250' | 'billboard' | 'cascade' | 'empty' | 'fabric' | 'fluid' | 'googleCard' | 'halfPage' | 'inlineMerchandising' | 'leaderboard' | 'merchandising' | 'merchandisingHigh' | 'merchandisingHighAdFeature' | 'mobilesticky' | 'mpu' | 'outOfPage' | 'outstreamDesktop' | 'outstreamGoogleDesktop' | 'outstreamMobile' | 'portrait' | 'portraitInterstitial' | 'skyscraper';
-type SlotName = 'carrot' | 'comments' | 'comments-expanded' | 'crossword-banner' | 'epic' | 'exclusion' | 'fronts-banner' | 'im' | 'inline' | 'merchandising-high-lucky' | 'merchandising-high' | 'merchandising' | 'mobile-sticky' | 'mostpop' | 'right' | 'survey' | 'top-above-nav';
-type SizeMapping = Partial<Record<Breakpoint, AdSize[]>>;
+type SizeKeys = '160x600' | '300x1050' | '300x250' | '300x600' | '728x90' | '970x250' | 'billboard' | 'cascade' | 'empty' | 'fabric' | 'fluid' | 'googleCard' | 'halfPage' | 'leaderboard' | 'merchandising' | 'merchandisingHigh' | 'merchandisingHighAdFeature' | 'mobilesticky' | 'mpu' | 'outOfPage' | 'outstreamDesktop' | 'outstreamGoogleDesktop' | 'outstreamMobile' | 'portrait' | 'portraitInterstitial' | 'pubmaticInterscroller' | 'skyscraper' | 'sponsorLogo';
+type SlotName = 'article-end' | 'carrot' | 'comments-expanded' | 'comments' | 'crossword-banner-mobile' | 'exclusion' | 'external' | 'fronts-banner' | 'inline' | 'liveblog-top' | 'merchandising-high' | 'merchandising' | 'mobile-sticky' | 'football-right' | 'mostpop' | 'right' | 'sponsor-logo' | 'survey' | 'top-above-nav' | 'interactive';
+type SizeMapping = Partial<Record<Breakpoint, readonly AdSize[]>>;
 type SlotSizeMappings = Record<SlotName, SizeMapping>;
 declare const createAdSize: (width: number, height: number) => AdSize;
 declare const standardAdSizes: {
@@ -45,16 +45,158 @@ declare const outstreamSizes: {
     outstreamGoogleDesktop: AdSize;
     outstreamMobile: AdSize;
 };
-declare const adSizes: Record<SizeKeys, AdSize>;
+declare const adSizes: {
+    readonly empty: AdSize;
+    readonly fabric: AdSize;
+    readonly merchandising: AdSize;
+    readonly merchandisingHigh: AdSize;
+    readonly merchandisingHighAdFeature: AdSize;
+    readonly sponsorLogo: AdSize;
+    readonly fluid: AdSize;
+    readonly googleCard: AdSize;
+    readonly outOfPage: AdSize;
+    readonly pubmaticInterscroller: AdSize;
+    readonly outstreamDesktop: AdSize;
+    readonly outstreamGoogleDesktop: AdSize;
+    readonly outstreamMobile: AdSize;
+    readonly '970x250': AdSize;
+    readonly '300x600': AdSize;
+    readonly '728x90': AdSize;
+    readonly '300x250': AdSize;
+    readonly '300x1050': AdSize;
+    readonly '160x600': AdSize;
+    readonly billboard: AdSize;
+    readonly halfPage: AdSize;
+    readonly leaderboard: AdSize;
+    readonly mobilesticky: AdSize;
+    readonly mpu: AdSize;
+    readonly portrait: AdSize;
+    readonly skyscraper: AdSize;
+    readonly cascade: AdSize;
+    readonly portraitInterstitial: AdSize;
+};
 /**
  * mark: 432b3a46-90c1-4573-90d3-2400b51af8d0
  * Some of these may or may not need to be synced for with the sizes in ./create-ad-slot.ts
  * these were originally from DCR, create-ad-slot.ts ones were in frontend.
+ *
+ * Note:
+ * If a breakpoint is not defined in a size mapping for a slot, that breakpoint will use the sizes
+ * of the next breakpoint down that has a size mapping. For example, if only "mobile" and "phablet" sizes
+ * are defined for a slot, all breakpoints larger than "phablet" will use the mapping for "phablet".
+ *
+ * In another example, if a slot has only "tablet" as a size mapping defined,
+ * then "desktop" will use the size mapping for "tablet". "mobile" and "phablet"
+ * will have no size mapping. This type of example may be used in cases where
+ * we only want the slot to appear on the "tablet" size or greater.
  **/
-declare const slotSizeMappings: SlotSizeMappings;
+declare const slotSizeMappings: {
+    readonly inline: {
+        readonly mobile: readonly [AdSize, AdSize, AdSize, AdSize, AdSize, AdSize];
+        readonly desktop: readonly [AdSize, AdSize, AdSize, AdSize, AdSize];
+    };
+    readonly right: {
+        readonly mobile: readonly [AdSize, AdSize, AdSize, AdSize, AdSize, AdSize];
+    };
+    readonly comments: {
+        readonly mobile: readonly [AdSize, AdSize, AdSize, AdSize, AdSize, AdSize];
+        readonly desktop: readonly [AdSize, AdSize, AdSize, AdSize, AdSize];
+    };
+    readonly 'comments-expanded': {
+        readonly mobile: readonly [AdSize, AdSize];
+        readonly desktop: readonly [AdSize, AdSize, AdSize, AdSize, AdSize, AdSize, AdSize];
+    };
+    readonly 'top-above-nav': {
+        readonly mobile: readonly [AdSize, AdSize, AdSize, AdSize, AdSize, AdSize];
+        readonly tablet: readonly [AdSize, AdSize, AdSize, AdSize, AdSize];
+        readonly desktop: readonly [AdSize, AdSize, AdSize, AdSize, AdSize, AdSize, AdSize, AdSize];
+    };
+    readonly 'fronts-banner': {
+        readonly tablet: readonly [AdSize, AdSize];
+        readonly desktop: readonly [AdSize, AdSize, AdSize, AdSize, AdSize];
+    };
+    readonly mostpop: {
+        readonly mobile: readonly [AdSize, AdSize, AdSize, AdSize, AdSize];
+        readonly phablet: readonly [AdSize, AdSize, AdSize, AdSize, AdSize, AdSize, AdSize];
+        readonly tablet: readonly [AdSize, AdSize, AdSize, AdSize, AdSize, AdSize];
+        readonly desktop: readonly [AdSize, AdSize, AdSize, AdSize, AdSize, AdSize];
+    };
+    readonly 'liveblog-top': {
+        readonly mobile: readonly [AdSize, AdSize, AdSize, AdSize];
+        readonly tablet: readonly [];
+        readonly desktop: readonly [];
+    };
+    readonly 'merchandising-high': {
+        readonly mobile: readonly [AdSize, AdSize, AdSize, AdSize, AdSize];
+        readonly tablet: readonly [AdSize, AdSize, AdSize, AdSize];
+        readonly desktop: readonly [AdSize, AdSize, AdSize, AdSize, AdSize];
+    };
+    readonly merchandising: {
+        readonly mobile: readonly [AdSize, AdSize, AdSize, AdSize, AdSize];
+        readonly tablet: readonly [AdSize, AdSize, AdSize, AdSize];
+        readonly desktop: readonly [AdSize, AdSize, AdSize, AdSize, AdSize];
+    };
+    readonly survey: {
+        readonly desktop: readonly [AdSize];
+    };
+    readonly carrot: {
+        readonly mobile: readonly [AdSize];
+    };
+    readonly 'mobile-sticky': {
+        readonly mobile: readonly [AdSize, AdSize, AdSize];
+    };
+    readonly 'crossword-banner-mobile': {
+        readonly mobile: readonly [AdSize];
+    };
+    readonly 'football-right': {
+        readonly desktop: readonly [AdSize, AdSize, AdSize, AdSize];
+    };
+    readonly 'article-end': {
+        readonly mobile: readonly [];
+    };
+    readonly exclusion: {
+        readonly mobile: readonly [AdSize];
+    };
+    /**
+     * @deprecated Use `slotSizeMappings['sponsor-logo']` instead
+     */
+    readonly external: {
+        readonly mobile: readonly [AdSize, AdSize, AdSize, AdSize];
+    };
+    readonly 'sponsor-logo': {
+        readonly mobile: readonly [AdSize, AdSize, AdSize, AdSize];
+    };
+    readonly interactive: {
+        readonly mobile: readonly [AdSize, AdSize];
+        readonly tablet: readonly [AdSize, AdSize];
+        readonly desktop: readonly [AdSize, AdSize];
+    };
+};
 declare const getAdSize: (size: SizeKeys) => AdSize;
+/**
+ * Finds the ad sizes that will be used for a breakpoint given a size mapping
+ *
+ * If ad sizes are defined in the size mapping for the specified breakpoint, we use that.
+ * If no sizes are defined for the breakpoint, use the next smallest breakpoint with defined ad sizes.
+ * If no smaller breakpoints have defined ad sizes, return an empty array
+ *
+ * Example:
+ * For the following slotSizeMappings:
+ *     inline: {
+ *         phablet: [adSizes.mpu],
+ *         desktop: [adSizes.billboard]
+ *     }
+ * the applied sizes for each breakpoint for the "inline" slot will be:
+ *     mobile: []
+ *     phablet: [adSizes.mpu]
+ *     tablet: [adSizes.mpu]
+ *     desktop: [adSizes.billboard]
+ *
+ * See ad-sizes.test.ts for more examples
+ */
+declare const findAppliedSizesForBreakpoint: (sizeMappings: SizeMapping, breakpoint: Breakpoint) => readonly AdSize[];
 export declare const _: {
     createAdSize: (width: number, height: number) => AdSize;
 };
-export type { AdSizeString, AdSize, SizeKeys, SizeMapping, SlotSizeMappings, SlotName, };
-export { adSizes, standardAdSizes, outstreamSizes, getAdSize, slotSizeMappings, createAdSize, };
+export type { AdSizeString, SizeKeys, SizeMapping, SlotSizeMappings, SlotName };
+export { AdSize, adSizes, standardAdSizes, outstreamSizes, getAdSize, slotSizeMappings, createAdSize, findAppliedSizesForBreakpoint, };