amp-ad-type-defs.js

/**
 * Copyright 2018 The AMP HTML Authors. All Rights Reserved.
 *
 * 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.
 */

/** @typedef {{
      width: string,
      height: string,
      layout: string,
    }} */
export let LayoutInfoDef;

/** @enum {string} */
export const FailureType = {
  REQUEST_ERROR: 'REQUEST_ERROR',
  INVALID_RESPONSE: 'INVALID_RESPONSE',
  EMPTY_RESPONSE: 'EMPTY_RESPONSE',
  VALIDATOR_ERROR: 'VALIDATOR_ERROR',
  RENDERER_ERROR: 'RENDERER_ERROR',
};

/** @enum {string} */
export const RecoveryModeType = {
  COLLAPSE: 'COLLAPSE',
  RETRY: 'RETRY',
};

/** @enum {string} */
export const ValidatorResult = {
  AMP: 'AMP',
  NON_AMP: 'NON_AMP',
};

/** @enum {string} */
export const AdResponseType = {
  CRYPTO: 'crypto',
  TEMPLATE: 'template',
};

/** @typedef {{
      type: !ValidatorResult,
      adResponseType: AdResponseType,
      creativeData: !Object,
    }} */
export let ValidatorOutput;

/** @typedef {{
      minifiedCreative: string,
      customElementExtensions: !Array<string>,
      customStylesheets: !Array<{href: string}>,
      images: (Array<string>|undefined),
    }} */
export let CreativeMetaDataDef;

/** @typedef {{
      templateUrl: string,
      data: (JsonObject|undefined),
      analytics: (JsonObject|undefined),
    }} */
export let AmpTemplateCreativeDef;

/** @typedef {{
      creative: (string|undefined),
      rawCreativeBytes: (!ArrayBuffer|undefined),
      sentinel: (string|undefined),
      additionalContextMetadata: (!JsonObject|undefined),
    }} */
export let CrossDomainDataDef;

/**
 * @abstract
 */
export class Validator {
  /**
   * @param {!Object} unusedContext
   * @param {!ArrayBuffer} unusedUnvalidatedBytes
   * @param {!Headers} unusedHeaders
   * @return {!Promise<!ValidatorOutput>}
   * @abstract
   */
  validate(unusedContext, unusedUnvalidatedBytes, unusedHeaders) {}
}

/**
 * @abstract
 */
export class Renderer {
  /**
   * @param {!Object} unusedContext
   * @param {!Element} unusedContainerElement
   * @param {!Object} unusedCreativeData Data passed from validator to renderer.
   *   This should only contain information generated by the validator; all
   *   other information should be put in context.
   * @return {!Promise}
   * @abstract
   */
  render(unusedContext, unusedContainerElement, unusedCreativeData) {}
}