@liquidcommercedev/rmn-sdk 1.4.1-beta.1 → 1.4.1-beta.3

package/dist/types/common/helpers/helpers.interface.d.ts

@@ -0,0 +1,14 @@
+export interface IObjectHelper {
+    merge<T>(target: Record<string, T>, ...sources: Array<Record<string, any>>): Record<string, any>;
+    values<T>(source: Record<string, T>): T[];
+    includes(source: Record<string, any>, key: string): boolean;
+    valuesIncludes(source: Record<string, any>, value: string): boolean;
+    hasAllValues(source: Record<string, any>, keys: string[]): boolean;
+    isArray(obj: any): boolean;
+}
+export interface IStringHelper {
+    includes(val: string | string[], search: string, start?: number): boolean;
+    split(val: string, delimiter: string): string[];
+    upperCase(val: string): string;
+    toString(val: unknown): string;
+}

package/dist/types/common/helpers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './object.helper';
+export * from './string.helper';

package/dist/types/common/helpers/object.helper.d.ts

@@ -0,0 +1,95 @@
+import type { IObjectHelper } from './helpers.interface';
+export declare class ObjectHelper implements IObjectHelper {
+    /**
+     * Returns an instance of the ObjectHelper class.
+     *
+     * @return {ObjectHelper} An instance of the ObjectHelper class.
+     */
+    static getInstance(): ObjectHelper;
+    /**
+     * Merges multiple source objects into a target object.
+     *
+     * @template T - The type of values in the target object.
+     * @param {Record<string, T>} target - The target object to merge into.
+     * @param {...Array<Record<string, any>>} sources - The source objects to merge.
+     * @returns {Record<string, any>} - The merged object.
+     */
+    merge<T>(target: Record<string, T>, ...sources: Array<Record<string, any>>): Record<string, any>;
+    /**
+     * Retrieves the values of an input object and returns them as an array.
+     *
+     * @param {Record<string, T>} source - The input object.
+     * @template T - The type of the values in the object.
+     * @return {T[]} - An array containing the values of the input object.
+     */
+    values<T>(source: Record<string, T>): T[];
+    /**
+     * Checks if a given key is present in a source object.
+     *
+     * @param {Record<string, any>} source - The object to search within.
+     * @param {string} key - The key to check for.
+     * @return {boolean} - True if the key is present in the source, false otherwise.
+     */
+    includes(source: Record<string, any>, key: string): boolean;
+    /**
+     * Checks if the given value is included in the values of a source object.
+     *
+     * @param {Record<string, any>} source - The source object to check the values from.
+     * @param {string} value - The value to search for in the source object values.
+     * @returns {boolean} - True if the value is found in the source object values, false otherwise.
+     */
+    valuesIncludes(source: Record<string, any>, value: string): boolean;
+    /**
+     * Checks if all keys from the given 'keys' array are present in the 'source' object.
+     *
+     * @param {Record<string, any>} source - The object to be checked.
+     * @param {string[]} keys - The array of keys to be checked in the 'source' object.
+     * @return {boolean} - Returns true if all keys are present in the 'source' object,
+     *                    false otherwise.
+     */
+    hasAllValues(source: Record<string, any>, keys: string[]): boolean;
+    /**
+     * Checks if the given object is an array.
+     *
+     * @param {any} obj - The object to check.
+     * @return {boolean} - Returns true if the object is an array, otherwise returns false.
+     */
+    isArray(obj: any): boolean;
+    /**
+     * Merges the value with the target value.
+     *
+     * @param {any[] | Record<string, T>} targetValue - The target value to merge with.
+     * @param {Record<string, any>} value - The value to merge.
+     * @returns {Record<string, any>} - The merged value.
+     */
+    private mergeValue;
+    /**
+     * Merges the values of an array or object with a given array of objects and returns the merged result as an object.
+     * If the targetValue is not an array, it returns a copy of the value array.
+     *
+     * @param targetValue - The target array or object to merge values into.
+     * @param value - The array of objects containing values to merge into the targetValue.
+     * @returns The merged result as an object.
+     */
+    private mergeArrayValues;
+    /**
+     * Merges the values of two objects or arrays into a single object.
+     * If the target value is an array or a record, the method merges the values into the target value.
+     * If the target value is not an array or a record, it returns the new value.
+     *
+     * @template T - The type of the values in the target object.
+     * @param {object[]|Record<string, T>} targetValue - The target object or array to merge the values into.
+     * @param {Record<string, any>} value - The new values to merge into the target object or array.
+     * @returns {Record<string, any>} - The merged object or array.
+     */
+    private mergeObjectValues;
+    /**
+     * Merges the properties of the source object into the target object.
+     *
+     * @param {Record<string, any>} target - The target object to merge the properties into.
+     * @param {Record<string, any>} source - The source object containing the properties to merge.
+     *
+     * @return {void} - This method does not return any value.
+     */
+    private innerMerge;
+}

package/dist/types/common/helpers/string.helper.d.ts

@@ -0,0 +1,39 @@
+import type { IStringHelper } from './helpers.interface';
+export declare class StringHelper implements IStringHelper {
+    /**
+     * Returns an instance of the StringHelper class.
+     * @return {StringHelper} An instance of the StringHelper class.
+     */
+    static getInstance(): StringHelper;
+    /**
+     * Checks whether a string or an array of strings includes a given search string.
+     *
+     * @param {string | string[]} val - The string or array of strings to search in.
+     * @param {string} search - The search string to look for in the value.
+     * @param {number} [start=0] - The optional starting index for the search.
+     * @return {boolean} - Returns true if the search string is found, otherwise false.
+     */
+    includes(val: string | string[], search: string, start?: number): boolean;
+    /**
+     * Splits a string into an array of substrings using a given delimiter.
+     *
+     * @param {string} val - The string to be split.
+     * @param {string} delimiter - The delimiter used to split the string.
+     * @return {string[]} - An array of substrings.
+     */
+    split(val: string, delimiter: string): string[];
+    /**
+     * Converts a given string to uppercase.
+     *
+     * @param {string} val - The string to be converted.
+     * @return {string} - The uppercase version of the input string.
+     */
+    upperCase(val: string): string;
+    /**
+     * Converts the specified value to a string representation.
+     *
+     * @param {unknown} val - The value to convert to a string.
+     * @return {string} - The string representation of the value.
+     */
+    toString(val: unknown): string;
+}

package/dist/types/common/http/api.constant.d.ts

@@ -0,0 +1,6 @@
+import type { IAuthConfigs } from '../../modules/auth';
+export declare const REQUEST_CLOUD_PROTECTED_KEY = "X-Liquid-Protected";
+export declare const REQUEST_CLOUD_PROTECTED_TIMESTAMP = "X-Liquid-Timestamp";
+export declare const REQUEST_CLOUD_API_KEY = "X-Liquid-Api-Key";
+export declare const REQUEST_CLOUD_API_ENV = "X-Liquid-Api-Env";
+export declare const SDK_CONFIG: IAuthConfigs;

package/dist/types/common/http/api.interface.d.ts

@@ -0,0 +1,39 @@
+import type { AxiosRequestConfig, AxiosResponse } from 'axios';
+import type { JWTVerifyResult } from 'jose';
+import type { IAuthCredentials } from '../../modules/auth';
+import type { ApiError } from './error.api';
+export type Result<T, E = Error> = {
+    isOk: true;
+    val: T;
+    isErr: false;
+} | {
+    isOk: false;
+    val: null;
+    isErr: E;
+};
+export interface IResponseMetadataDefault {
+    timestamp: number;
+    timezone: string;
+    requestId: string;
+    path: string;
+    version: string;
+    repoVersion: string;
+    [key: string]: any;
+}
+export interface IResponseDefault<T = Record<string, any>> {
+    statusCode?: number;
+    message?: string;
+    refresh: IAuthCredentials;
+    _metadata?: IResponseMetadataDefault;
+    data?: T;
+}
+export interface IEncryptedApi {
+    handleEncryption(data: Record<string, any>, LT: number): Promise<string | undefined>;
+    handleDecryption(data: string, LT: number): Promise<JWTVerifyResult>;
+}
+export declare abstract class BaseApiAbstract {
+    protected abstract getConfig(): AxiosRequestConfig | Record<string, any>;
+    protected abstract get<T>(path: string, configOverrides: AxiosRequestConfig): Promise<Result<T | null, ApiError>>;
+    protected abstract post<T>(path: string, data: Record<string, any>, configOverrides: AxiosRequestConfig): Promise<Result<T | null, ApiError>>;
+    protected abstract createRequest<T>(subPath: string | null, configOverrides: AxiosRequestConfig | null, requestFunction: (url: string, config: AxiosRequestConfig | undefined) => Promise<AxiosResponse | null>): Promise<Result<T | null, ApiError>>;
+}

package/dist/types/common/http/base.api.d.ts

@@ -0,0 +1,79 @@
+import type { AxiosRequestConfig, AxiosResponse, RawAxiosRequestHeaders } from 'axios';
+import type { IAuthCredentials } from '../../modules/auth';
+import type { Result } from './api.interface';
+import { BaseApiAbstract } from './api.interface';
+import { ApiError } from './error.api';
+export declare class BaseApi extends BaseApiAbstract {
+    readonly authInfo: IAuthCredentials;
+    private readonly baseUrl;
+    private readonly objectHelper;
+    private readonly encryptedApi;
+    private readonly client;
+    constructor(auth: IAuthCredentials);
+    /**
+     * Retrieve the configuration for making an Axios request.
+     *
+     * @param {RawAxiosRequestHeaders} [headers] - Optional headers to be included in the request.
+     * @return {AxiosRequestConfig|Record<string, any>} The configuration object containing the request headers.
+     */
+    protected getConfig(headers?: RawAxiosRequestHeaders): AxiosRequestConfig | Record<string, any>;
+    /**
+     * Retrieves data from the specified path using a GET request.
+     *
+     * @param {string} path - The path to retrieve data from.
+     * @param {AxiosRequestConfig} configOverrides - Additional configuration options for the request.
+     * @returns {Promise<Result<T | null, ApiError>>} A promise that resolves to the result, which can be either data of type T or null, or an error of type ApiError.
+     */
+    protected get<T>(path: string, configOverrides: AxiosRequestConfig): Promise<Result<T | null, ApiError>>;
+    /**
+     * Sends a POST request to the specified path with the given data and configuration overrides.
+     *
+     * @param {string} path - The path to send the POST request to.
+     * @param {Record<string, any>} data - The data to send with the request.
+     * @param {AxiosRequestConfig} configOverrides - The configuration overrides for the request.
+     *
+     * @returns {Promise<Result<T | null, ApiError>>} - A Promise that resolves to the result of the POST request.
+     */
+    protected post<T>(path: string, data: Record<string, any>, configOverrides: AxiosRequestConfig): Promise<Result<T | null, ApiError>>;
+    /**
+     * Create a request to the API server.
+     * @param {string | null} subPath - The subpath of the API endpoint, can be null if there is no subpath.
+     * @param {AxiosRequestConfig | null} configOverrides - The config overrides for the Axios request, can be null if there are no overrides.
+     * @param {function} requestFunction - The function to send the request, must accept the URL and config as parameters and return a promise of the Axios response or null.
+     * @returns {Promise<Result<T | null, ApiError>>} - A promise that resolves to a Result object containing the response data or null on success, or an ApiError object on failure.
+     */
+    protected createRequest<T>(subPath: string | null, configOverrides: AxiosRequestConfig | null, requestFunction: (url: string, config: AxiosRequestConfig | undefined) => Promise<AxiosResponse | null>): Promise<Result<T | null, ApiError>>;
+    /**
+     * Private method that creates a full Axios request configuration.
+     *
+     * @param {AxiosRequestConfig | null} configOverrides - The optional overrides for the Axios request configuration.
+     * @returns {AxiosRequestConfig} - The merged Axios request configuration.
+     */
+    private createFullConfig;
+    /**
+     * Sends a request to the specified URL with the given configuration.
+     *
+     * @param {string} url - The URL to send the request to.
+     * @param {AxiosRequestConfig} config - The configuration options for the request.
+     * @param {function} requestFunction - The function to use for sending the request.
+     *        It should have the following signature: (url: string, config: AxiosRequestConfig | undefined) => Promise<AxiosResponse | null>
+     * @return {Promise<AxiosResponse | null>} - A Promise that resolves with the response from the request function,
+     *         or null if the request was unsuccessful.
+     */
+    private sendRequest;
+    /**
+     * Gets the response from an Axios response object and handles decryption if necessary.
+     *
+     * @template T - The type of the response data.
+     * @param {AxiosResponse | null} response - The Axios response object.
+     * @returns {Promise<Result<T | null, ApiError>>} - A promise that resolves to a Result object containing the response data or an ApiError.
+     */
+    private getResponse;
+    /**
+     * Creates a URL by concatenating the base URL with the provided path.
+     *
+     * @param {string | null} path - The path to be appended to the base URL.
+     * @return {string} The concatenated URL.
+     */
+    private createURL;
+}

package/dist/types/common/http/encrypted.api.d.ts

@@ -0,0 +1,66 @@
+import type { JWTVerifyResult } from 'jose';
+import type { IEncryptedApi } from './api.interface';
+export declare class EncryptedApi implements IEncryptedApi {
+    private apiKey;
+    constructor(apiKey: string);
+    /**
+     * Returns an instance of the EncryptedAPI class.
+     *
+     * @returns {EncryptedApi} The instance of the EncryptedAPI class.
+     */
+    static getInstance(apiKey: string): EncryptedApi;
+    /**
+     * Encrypts the given data using the provided encryption key and LT value.
+     *
+     * @param {Record<string, any>} data - The data to be encrypted.
+     * @param {number} LT - The LT (Lifetime) value used for encryption.
+     * @returns {Promise<string | undefined>} - The encrypted data as a string, or undefined if encryption fails.
+     */
+    handleEncryption(data: Record<string, any>, LT: number): Promise<string | undefined>;
+    /**
+     * Decrypts the given data using a key generated based on LT.
+     *
+     * @param {string} data - The data to be decrypted.
+     * @param {number} LT - The LT value used to generate the decryption key.
+     * @return {Promise<JWTVerifyResult>} A promise that resolves with the decrypted data.
+     */
+    handleDecryption(data: string, LT: number): Promise<JWTVerifyResult>;
+    /**
+     * Returns the key based on the given LT value.
+     *
+     * @param {number} LT - The LT value used to retrieve the key.
+     * @returns {string} - The key retrieved from the credentials.
+     */
+    private getKey;
+    /**
+     * Moves the given timestamp forward by the specified number of minutes.
+     *
+     * @param {number} minutes - The number of minutes to move forward.
+     * @param {number} LT - The initial timestamp in milliseconds.
+     * @return {number} - The new timestamp after moving forward by the specified number of minutes.
+     */
+    private forwardInMinutes;
+    /**
+     * Decrypts the given data using the specified key and returns the result as a Promise of JWTVerifyResult.
+     *
+     * @param {string} data - The data to be decrypted.
+     * @param {string} key - The key used for decryption.
+     * @return {Promise<JWTVerifyResult>} A Promise that resolves to the decrypted JWT payload.
+     */
+    joseDecrypt(data: string, key: string): Promise<JWTVerifyResult>;
+    /**
+     * Encrypts and signs the given data using the JOSE encryption standard.
+     * @param {Record<string, any>} data - The data to encrypt and sign.
+     * @param {string} key - The encryption key.
+     * @param {Date | number} exp - The expiration time for the encrypted data.
+     * @returns {Promise<string>} - The encrypted and signed data as a string.
+     */
+    private joseEncrypt;
+    /**
+     * Handles the error by throwing an ApiError.
+     *
+     * @param {unknown} error - The error object to handle.
+     * @throws {ApiError} - The ApiError object.
+     */
+    private handleError;
+}

package/dist/types/common/http/error.api.d.ts

@@ -0,0 +1,5 @@
+export declare class ApiError {
+    cause: number;
+    errorMessage: string;
+    constructor(error?: unknown);
+}

package/dist/types/common/http/index.d.ts

@@ -0,0 +1,5 @@
+export * from './api.constant';
+export * from './api.interface';
+export * from './base.api';
+export * from './encrypted.api';
+export * from './error.api';

package/dist/types/common/singleton-manager/index.d.ts

@@ -0,0 +1 @@
+export * from './singleton-manager';

package/dist/types/common/singleton-manager/singleton-manager.d.ts

@@ -0,0 +1,12 @@
+export declare class SingletonManager {
+    private static instances;
+    /**
+     * Retrieves an instance of the specified class using the provided instance creator function.
+     *
+     * @template T The type of the instance.
+     * @param {string} className The name of the class.
+     * @param {() => T} instanceCreator The function that creates the instance.
+     * @returns {T} The instance of the specified class.
+     */
+    static getInstance<T>(className: string, instanceCreator: () => T): T;
+}

package/dist/types/enums.d.ts

@@ -0,0 +1,7 @@
+export * from './modules/spot/spot.enum';
+export declare enum RMN_ENV {
+    LOCAL = "local",
+    DEVELOPMENT = "development",
+    STAGING = "staging",
+    PRODUCTION = "production"
+}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './enums';
+export * from './rmn-client';
+export * from './types';

package/dist/types/index.umd.d.ts

@@ -0,0 +1,2 @@
+import { RmnClient, RmnCreateSpotElement } from './index';
+export { RmnClient, RmnCreateSpotElement };

package/dist/types/modules/auth/auth.constant.d.ts

@@ -0,0 +1 @@
+export declare const AUTH_API_PATH = "/auth";

package/dist/types/modules/auth/auth.interface.d.ts

@@ -0,0 +1,27 @@
+import type { RMN_ENV } from '../../enums';
+export interface IAuthCredentials {
+    authenticated: boolean;
+    token: string;
+    apiKey: string;
+    env: RMN_ENV;
+}
+export interface IAuthResponse {
+    statusCode: number;
+    message: string;
+    data: IAuthCredentials | Record<string, any>;
+}
+export interface IAuthUrls {
+    local: string;
+    development: string;
+    staging: string;
+    production: string;
+}
+export interface IAuthConfigs {
+    url: IAuthUrls;
+    apiHeader: string;
+    accessHeader: string;
+    credentials: IAuthCredentials;
+}
+export interface IAuthService {
+    initialize(): Promise<IAuthCredentials>;
+}

package/dist/types/modules/auth/auth.service.d.ts

@@ -0,0 +1,22 @@
+import { BaseApi } from '../../common/http';
+import type { RMN_ENV } from '../../enums';
+import type { IAuthCredentials, IAuthService } from './auth.interface';
+declare class AuthService extends BaseApi implements IAuthService {
+    private constructor();
+    /**
+     * Retrieves the singleton instance of the AuthService class.
+     *
+     * @param {string} apiKey - The API key used for authentication.
+     * @param {RMN_ENV} env - The environment enum value.
+     * @returns {AuthService} The singleton instance of the AuthService class.
+     */
+    static getInstance(apiKey: string, env: RMN_ENV): AuthService;
+    /**
+     * Initializes the authentication process.
+     *
+     * @returns {Promise<IAuthCredentials>} A Promise that resolves to the authenticated credentials.
+     * @throws {Error} If there is an error during authentication or the authentication response is unsuccessful.
+     */
+    initialize(): Promise<IAuthCredentials>;
+}
+export default AuthService;

package/dist/types/modules/auth/index.d.ts

@@ -0,0 +1,3 @@
+export * from './auth.constant';
+export * from './auth.interface';
+export * from './auth.service';

package/dist/types/modules/spot/html/index.d.ts

@@ -0,0 +1 @@
+export * from './spot.element.service';

package/dist/types/modules/spot/html/spot.element.service.d.ts

@@ -0,0 +1,7 @@
+import type { ISpot } from 'types';
+export interface ICustomSpotElement extends HTMLElement {
+    data?: ISpot;
+    customHtmlElement?: HTMLElement;
+}
+declare let SpotElement: new () => HTMLElement;
+export { SpotElement };

package/dist/types/modules/spot/html/spot.element.shadow-root.d.ts

@@ -0,0 +1,4 @@
+export declare const SPOT_ELEMENT_SHADOW_ROOT: (width: number, height: number, hasCustomHtmlElement: boolean) => {
+    style: HTMLStyleElement;
+    wrapper: HTMLDivElement;
+};

package/dist/types/modules/spot/html/templates/iab/billboard/billboard-v1.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function billboardV1Template(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/iab/billboard/billboard-v2.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function billboardV2Template(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/iab/billboard/billboard-v3.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function billboardV3Template(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/iab/billboard/index.d.ts

@@ -0,0 +1,3 @@
+export * from './billboard-v1.template';
+export * from './billboard-v2.template';
+export * from './billboard-v3.template';

package/dist/types/modules/spot/html/templates/iab/constants/fonts.constant.d.ts

@@ -0,0 +1,3 @@
+export declare const GFONT_PRECONNECT: () => string;
+export declare const GFONT_SOURCE_SANS_3: () => string;
+export declare const GFONT_CORMORANT: () => string;

package/dist/types/modules/spot/html/templates/iab/in-text/in-text-v1.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function inTextV1Template(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/iab/in-text/index.d.ts

@@ -0,0 +1 @@
+export * from './in-text-v1.template';

package/dist/types/modules/spot/html/templates/iab/index.d.ts

@@ -0,0 +1,7 @@
+export * from './billboard';
+export * from './in-text';
+export * from './large-leaderboard';
+export * from './large-rectangle';
+export * from './square';
+export * from './vertical-rectangle';
+export * from './wide-skyscraper';

package/dist/types/modules/spot/html/templates/iab/large-leaderboard/index.d.ts

@@ -0,0 +1,2 @@
+export * from './large-leaderboard-v1.template';
+export * from './large-leaderboard-v2.template';

package/dist/types/modules/spot/html/templates/iab/large-leaderboard/large-leaderboard-v1.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function largeLeaderboardV1Template(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/iab/large-leaderboard/large-leaderboard-v2.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function largeLeaderboardV2Template(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/iab/large-rectangle/index.d.ts

@@ -0,0 +1 @@
+export * from './large-rectangle-v1.template';

package/dist/types/modules/spot/html/templates/iab/large-rectangle/large-rectangle-v1.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function largeRectangleV1Template(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/iab/square/index.d.ts

@@ -0,0 +1,2 @@
+export * from './square-v1.template';
+export * from './square-v2.template';

package/dist/types/modules/spot/html/templates/iab/square/square-v1.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function squareV1Template(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/iab/square/square-v2.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function squareV2Template(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/iab/vertical-rectangle/index.d.ts

@@ -0,0 +1 @@
+export * from './vertical-rectangle-v1.template';

package/dist/types/modules/spot/html/templates/iab/vertical-rectangle/vertical-rectangle-v1.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function verticalRectangleV1Template(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/iab/wide-skyscraper/index.d.ts

@@ -0,0 +1 @@
+export * from './wide-skyscraper-v1.template';

package/dist/types/modules/spot/html/templates/iab/wide-skyscraper/wide-skyscraper-v1.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function wideSkyscraperV1Template(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/index.d.ts

@@ -0,0 +1 @@
+export * from './spot.template';

package/dist/types/modules/spot/html/templates/reservebar/collection-banner-without-text-block.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function rbCollectionBannerWithoutTextBlockTemplate(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/reservebar/homepage-hero-full-image.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function rbHomepageHeroFullImageTemplate(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/reservebar/homepage-hero-three-tile.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function rbHomepageHeroThreeTileTemplate(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/reservebar/homepage-hero-two-tile.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function rbHomepageHeroTwoTileTemplate(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/reservebar/index.d.ts

@@ -0,0 +1,8 @@
+export * from './collection-banner-without-text-block.template';
+export * from './homepage-hero-full-image.template';
+export * from './homepage-hero-three-tile.template';
+export * from './homepage-hero-two-tile.template';
+export * from './large-category-image-tout.template';
+export * from './navigation-banner.template';
+export * from './small-category-image-tout.template';
+export * from './small-discover-tout.template';

package/dist/types/modules/spot/html/templates/reservebar/large-category-image-tout.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function rbLargeCategoryImageToutTemplate(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/reservebar/navigation-banner.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function rbNavigationBannerTemplate(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/reservebar/small-category-image-tout.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function rbSmallCategoryImageToutTemplate(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/reservebar/small-discover-tout.template.d.ts

@@ -0,0 +1,2 @@
+import type { ISpot } from 'types';
+export declare function rbSmallDiscoverToutTemplate(spot: ISpot): string;

package/dist/types/modules/spot/html/templates/spot.template.d.ts

@@ -0,0 +1,21 @@
+import type { ISpot } from 'types';
+export declare enum ENUM_SPOT_ELEMENT_ATTRIBUTE {
+    WIDTH = "width",
+    HEIGHT = "height",
+    FLUID = "fluid",
+    REDIRECT_ON_CLICK = "redirect-on-click"
+}
+export interface ISpotHtmlAttribute {
+    [ENUM_SPOT_ELEMENT_ATTRIBUTE.WIDTH]: number;
+    [ENUM_SPOT_ELEMENT_ATTRIBUTE.HEIGHT]: number;
+    [ENUM_SPOT_ELEMENT_ATTRIBUTE.FLUID]: string;
+    [ENUM_SPOT_ELEMENT_ATTRIBUTE.REDIRECT_ON_CLICK]: string;
+}
+/**
+ * Creates the spot html string based on the provided spot data.
+ *
+ * @param {ISpot} data - The spot data.
+ *
+ * @return {string} - The spot html string.
+ */
+export declare const GET_SPOT_TEMPLATE_HTML_STRING: (data: ISpot) => string;