@akross/artemis-ads-sdk 3.7.0 → 3.7.1

package/CHANGELOG.md

@@ -0,0 +1,46 @@
+# Changelog
+
+Todas as mudanças notáveis do projeto são documentadas neste arquivo.
+
+O formato é baseado em [Keep a Changelog](https://keepachangelog.com/pt-BR/1.0.0/),
+e este projeto adere ao [Versionamento Semântico](https://semver.org/lang/pt-BR/).
+
+## [3.7.1] - 2025-01-29
+
+- Republicação: 3.7.0 foi deprecated no npm; esta versão substitui o release final.
+
+---
+
+## [3.7.0] - 2025-01-29
+
+Esta versão consolida três branches mergeadas: **Kwai (Lumina)**, **external_redirect** e **proxyExternalScripts**.
+
+### Kwai / Lumina (Rewarded Video)
+
+- **Lumina Rewarded Video**: Integração com Kwai Lumina Ad SDK para anúncios recompensados no waterfall programático.
+- **LuminaRewardedVideoWrapper**: Wrapper para exibição de RV via Lumina (tagId + token).
+- **`luminaToken` em `SDKConfig`**: Nova opção para uso do Lumina RV.
+- **Pré-carregamento do Lumina**: `AAManager` pré-carrega o script do Lumina quando `luminaToken` está configurado.
+- **Waterfall programático**: Suporte a step `LUMINA_RV` no waterfall de rewarded video (junto com GAM_RV).
+- **ExternalJsLoader**: método `loadLuminaScript` e interface `LuminaScriptConfig`.
+
+### Tipo de mídia external_redirect
+
+- **Novo tipo de mídia `external_redirect`**: Redirecionamento externo sem interface própria; o SDK retorna resultado e o cliente implementa o redirecionamento.
+- **AAExternalRedirect**: Módulo que trata o tipo `external_redirect`; envia apenas evento de clique (sem impressão), retorna `AAMediaPlayResult.EXTERNAL_REDIRECT`.
+- **Dois formatos de conteúdo**: Suporte a `content.externalRedirect` (novo) e campos em `content` (compatibilidade).
+
+### proxyExternalScripts
+
+- **`proxyExternalScripts` em `SDKConfig`**: Nova opção para carregar scripts externos (GPT, IMA, Lumina) via proxy quando necessário.
+- **ExternalJsLoader**: Suporte a carregamento via proxy nos scripts externos.
+
+### Documentação
+
+- README atualizado: estrutura do projeto, remoção de APIs inexistentes (webViewBridge, loadAd, etc.), `SDKConfig` alinhado ao código.
+
+---
+
+## [Versões anteriores]
+
+Para histórico de versões anteriores a 3.7.1, consulte as tags e releases no repositório.

package/README.md

@@ -7,7 +7,6 @@ SDK JavaScript para o AdServer Akross Artemis - Carregamento de banners e mídia
 - **TypeScript Vanilla**: Sem dependências de frameworks
 - **Múltiplos Builds**: UMD (NPM), IIFE (CDN) e ESM (sites modernos)
 - **API Global**: `window.AkrossAds` para uso em Flutter Web/WebView
-- **WebView Bridge**: Comunicação automática via `window.Akross.postMessage`
 - **Banner Loader**: Carregamento otimizado de banners com fit inteligente
 - **Sample Interativa**: Interface web para testes locais
 
@@ -24,16 +23,18 @@ npm install @akross/artemis-ads-sdk
 ```javascript
 import { init, ArtemisAdsBannerLoader } from '@akross/artemis-ads-sdk';
 
-// Configuração do SDK
-const sdkConfig = {
-  baseUrl: 'https://api.akross.com.br',
-  appId: 'seu-app-id',
-  appVersion: '1.0.0',
-  debug: true
+const SDK_CONFIG = {
+  baseUrl: 'https://ads.timfun.com.br/adserver/',
+  debug: true,
+  timeout: 10000,
+  appId: 'com.example.myapp',           // ID da aplicação (equivalente ao package name do Android)
+  appVersion: '1.0.0',                  // Versão da aplicação
+  artemisAdsAppId: 'akross-app-123',    // ID do app Artemis Ads
+  primaryColor: '#ff0000',               // Cor primária do projeto (formato hexadecimal)
+  luminaToken: 'QQDCYMdFh2AJqwP'        // Token do Lumina SDK (opcional - usa valor padrão se não fornecido)
 };
 
-// Inicializar SDK
-const sdk = await init(sdkConfig);
+const sdk = await init(SDK_CONFIG);
 ```
 
 ### Carregamento de Banner
@@ -114,22 +115,23 @@ export default function BannerAd({ zoneId }) {
 ```html
 <script src="https://cdn.akross.com/sdk/akross-ads-sdk.iife.js"></script>
 <script>
-  // Inicializa o SDK
-  const sdk = window.AkrossAds.init({
-    baseUrl: 'https://api.akross.com/ads',
-    debug: true,
-    webViewBridge: {
-      enabled: true
-    }
-  });
-
-  // Carrega um anúncio
-  sdk.loadAd(document.getElementById('ad-container'), {
-    adId: 'my-ad',
-    slotId: 'banner-slot',
-    adServerUrl: 'https://api.akross.com/ads',
-    dimensions: { width: 300, height: 250 }
-  });
+  (async function() {
+    const SDK_CONFIG = {
+      baseUrl: 'https://ads.timfun.com.br/adserver/',
+      debug: true,
+      timeout: 10000,
+      appId: 'com.example.myapp',
+      appVersion: '1.0.0',
+      artemisAdsAppId: 'akross-app-123',
+      primaryColor: '#ff0000',
+      luminaToken: 'QQDCYMdFh2AJqwP'
+    };
+    const sdk = await window.AkrossAds.init(SDK_CONFIG);
+
+    // Banner: usar ArtemisAdsBannerLoader
+    const bannerLoader = new window.AkrossAds.ArtemisAdsBannerLoader('#ad-container');
+    await bannerLoader.loadZone('sua-zone-id');
+  })();
 </script>
 ```
 
@@ -138,12 +140,18 @@ export default function BannerAd({ zoneId }) {
 ```javascript
 import { init } from '@akross/artemis-ads-sdk';
 
-const sdk = init({
-  baseUrl: 'https://api.akross.com/ads',
-  debug: true
-});
+const SDK_CONFIG = {
+  baseUrl: 'https://ads.timfun.com.br/adserver/',
+  debug: true,
+  timeout: 10000,
+  appId: 'com.example.myapp',
+  appVersion: '1.0.0',
+  artemisAdsAppId: 'akross-app-123',
+  primaryColor: '#ff0000',
+  luminaToken: 'QQDCYMdFh2AJqwP'
+};
 
-// Usar o SDK...
+const sdk = await init(SDK_CONFIG);
 ```
 
 ### Via CommonJS/UMD
@@ -151,9 +159,18 @@ const sdk = init({
 ```javascript
 const { init } = require('@akross/artemis-ads-sdk');
 
-const sdk = init({
-  baseUrl: 'https://api.akross.com/ads'
-});
+const SDK_CONFIG = {
+  baseUrl: 'https://ads.timfun.com.br/adserver/',
+  debug: true,
+  timeout: 10000,
+  appId: 'com.example.myapp',
+  appVersion: '1.0.0',
+  artemisAdsAppId: 'akross-app-123',
+  primaryColor: '#ff0000',
+  luminaToken: 'QQDCYMdFh2AJqwP'
+};
+
+const sdk = await init(SDK_CONFIG);
 ```
 
 ## 📚 API Reference
@@ -190,66 +207,77 @@ interface ArtemisAdsBannerLoaderClickListener {
 #### Inicialização
 
 ```javascript
-const sdk = window.AkrossAds.init({
-  baseUrl: 'https://api.akross.com/ads',    // URL base do servidor
-  timeout: 10000,                          // Timeout em ms
-  debug: false,                            // Modo debug
-  webViewBridge: {                         // Configurações do WebView
-    enabled: true,
-    targetOrigin: '*'                      // Origem permitida
-  }
-});
+const SDK_CONFIG = {
+  baseUrl: 'https://ads.timfun.com.br/adserver/',
+  debug: true,
+  timeout: 10000,
+  appId: 'com.example.myapp',           // ID da aplicação (equivalente ao package name do Android)
+  appVersion: '1.0.0',                  // Versão da aplicação
+  artemisAdsAppId: 'akross-app-123',    // ID do app Artemis Ads
+  primaryColor: '#ff0000',               // Cor primária do projeto (formato hexadecimal)
+  luminaToken: 'QQDCYMdFh2AJqwP'        // Token do Lumina SDK (opcional - usa valor padrão se não fornecido)
+};
+
+const sdk = await window.AkrossAds.init(SDK_CONFIG);
 ```
 
-#### Carregar Anúncio
+#### Campanhas e Banner
 
 ```javascript
-const response = await sdk.loadAd(element, {
-  adId: 'unique-ad-id',
-  slotId: 'slot-identifier',
-  adServerUrl: 'https://api.akross.com/ads',
-  dimensions: { width: 300, height: 250 },
-  options: { /* parâmetros adicionais */ }
-});
+// Solicitar campanhas por zone
+const response = await sdk.requestCampaign('sua-zone-id', 1);
+
+// Banner: usar ArtemisAdsBannerLoader
+const bannerLoader = new window.AkrossAds.ArtemisAdsBannerLoader('#container');
+await bannerLoader.loadZone('sua-zone-id');
 ```
 
-#### Gerenciar Anúncios
+#### Rewarded Video e mídias
 
 ```javascript
-// Criar instância de anúncio
-const adInstance = sdk.createAd(config);
-
-// Carregar anúncio
-await adInstance.load();
+// Mídias (VAST, programático, survey, etc.) são executadas via AAMedia.click()
+// O fluxo típico: requestCampaign -> escolher mídia -> media.click()
+const campaigns = await sdk.requestCampaign('zone-rv', 1);
+const media = campaigns?.zones?.[0]?.campaigns?.[0]?.content;
+if (media) {
+  const result = await media.click();
+}
+```
 
-// Atualizar anúncio
-await adInstance.refresh();
+## 🔧 Configuração
 
-// Destruir anúncio
-adInstance.destroy();
+### Configuração do SDK
 
-// Obter anúncios ativos
-const activeAds = sdk.getActiveAds();
+Exemplo de configuração (como no sample e na inicialização real):
 
-// Destruir todos os anúncios
-sdk.destroyAll();
+```javascript
+const SDK_CONFIG = {
+  baseUrl: 'https://ads.timfun.com.br/adserver/',
+  debug: true,
+  timeout: 10000,
+  appId: 'com.example.myapp',           // ID da aplicação (equivalente ao package name do Android)
+  appVersion: '1.0.0',                   // Versão da aplicação
+  artemisAdsAppId: 'akross-app-123',     // ID do app Artemis Ads
+  primaryColor: '#ff0000',                // Cor primária do projeto (formato hexadecimal)
+  luminaToken: 'QQDCYMdFh2AJqwP',         // Token do Lumina SDK (opcional - usa valor padrão se não fornecido)
+  proxyExternalScripts: false            // Carregar scripts externos (GPT, IMA, Lumina) via proxy (opcional)
+};
 ```
 
-## 🔧 Configuração
-
-### Configuração do SDK
+Interface TypeScript:
 
 ```typescript
 interface SDKConfig {
   baseUrl: string;
-  appId: string;
-  appVersion: string;
-  debug?: boolean;
   timeout?: number;
-  webViewBridge?: {
-    enabled: boolean;
-    targetOrigin?: string;
-  };
+  debug?: boolean;
+  appId?: string;
+  appVersion?: string;
+  artemisAdsAppId?: string;
+  primaryColor?: string;
+  luminaToken?: string;
+  proxyExternalScripts?: boolean;
+  cdnBaseUrl?: string;
 }
 ```
 
@@ -411,27 +439,6 @@ if (result.result === AAMediaPlayResult.EXTERNAL_REDIRECT) {
 }
 ```
 
-## 🌐 WebView Integration
-
-O SDK detecta automaticamente quando está rodando em um WebView e configura o bridge de comunicação:
-
-```javascript
-// Verifica se está em WebView
-if (sdk.isWebView()) {
-  console.log('Executando em WebView');
-}
-
-// Obtém informações do WebView
-const webViewInfo = sdk.getWebViewInfo();
-console.log(webViewInfo);
-
-// Envia mensagem para o WebView
-sdk.sendToWebView('ad_click', {
-  adId: 'my-ad',
-  timestamp: Date.now()
-});
-```
-
 ## 🏗️ Builds Disponíveis
 
 ### 📦 Formatos de Build
@@ -566,14 +573,15 @@ sample/
 O sample usa configurações padrão que podem ser alteradas em `demo.js`:
 
 ```javascript
-const sdkConfig = {
-    baseUrl: 'https://ads.timfun.com.br/adserver/',
-    debug: true,
-    timeout: 10000,
-    appId: 'com.example.myapp',
-    appVersion: '1.0.0',
-    artemisAdsAppId: 'akross-app-123',
-    primaryColor: '#ff0000'
+const SDK_CONFIG = {
+  baseUrl: 'https://ads.timfun.com.br/adserver/',
+  debug: true,
+  timeout: 10000,
+  appId: 'com.example.myapp',           // ID da aplicação (equivalente ao package name do Android)
+  appVersion: '1.0.0',                   // Versão da aplicação
+  artemisAdsAppId: 'akross-app-123',     // ID do app Artemis Ads
+  primaryColor: '#ff0000',                // Cor primária do projeto (formato hexadecimal)
+  luminaToken: 'QQDCYMdFh2AJqwP'         // Token do Lumina SDK (opcional - usa valor padrão se não fornecido)
 };
 ```
 
@@ -636,22 +644,6 @@ npm run publish:major
 npm pack
 ```
 
-## 🔄 WebView Bridge
-
-O SDK implementa comunicação bidirecional com WebView:
-
-### Mensagens Enviadas para WebView:
-- `ad_request` - Requisição de anúncio
-- `ad_response` - Resposta do anúncio
-- `ad_error` - Erro no carregamento
-- `ad_click` - Clique no anúncio
-- `ad_impression` - Impressão do anúncio
-
-### Mensagens Recebidas do WebView:
-- `ad_request` - Solicitação de anúncio
-- `ad_error` - Erro reportado
-- `ad_click` - Clique reportado
-
 ## 🛠️ Estrutura do Projeto
 
 ### 📁 Estrutura Principal
@@ -660,24 +652,29 @@ O SDK implementa comunicação bidirecional com WebView:
 src/
 ├── ads-core/                    # Core do sistema de anúncios
 │   ├── AdsManager.ts           # Gerenciador principal de anúncios
-│   ├── network/                # Camada de rede
-│   │   ├── ApiFactory.ts       # Factory para APIs
-│   │   ├── ServicesAds.ts      # Serviços de anúncios
-│   │   └── interceptor/         # Interceptadores HTTP
+│   ├── index.ts
 │   └── util/                   # Utilitários do core
-│       └── AAMediaTypeValidator.ts
+│       ├── AADeviceContextHelper.ts
+│       └── index.ts
 ├── core/
-│   └── AAManager.ts            # Gerenciador principal do SDK
+│   ├── AAManager.ts            # Gerenciador principal do SDK
+│   └── network/                # Camada de rede
+│       ├── ApiFactory.ts       # Factory para APIs
+│       ├── ServicesAds.ts      # Serviços de anúncios
+│       └── interceptor/        # Interceptadores HTTP
 ├── events/
 │   └── AAEventsCallbackHelper.ts # Helper para eventos
 ├── modules/                    # Módulos específicos
 │   ├── image/                  # Banner Loader
 │   │   └── ArtemisAdsBannerLoader.ts
 │   ├── rv/                     # Rewarded Video
-│   │   ├── programmatic/       # Anúncios programáticos
+│   │   ├── programmatic/       # Anúncios programáticos (waterfall)
 │   │   │   ├── AARewardedVideo.ts
-│   │   │   └── GAMRewardedVideoWrapper.ts
-│   │   └── vast/              # Player VAST
+│   │   │   ├── GAMRewardedVideoWrapper.ts
+│   │   │   ├── LuminaRewardedVideoWrapper.ts  # Kwai Lumina RV
+│   │   │   └── utils/
+│   │   │       └── WaterfallResultHelper.ts
+│   │   └── vast/               # Player VAST
 │   │       ├── AAVastPlayer.ts
 │   │       └── AAVastPlayerUI.ts
 │   ├── poll/                   # Survey V2
@@ -692,9 +689,13 @@ src/
 │       └── ... (outros modelos)
 ├── utils/                      # Utilitários gerais
 │   ├── AAMediaResultHelper.ts  # Helper para resultados
-│   ├── AAReportHelper.ts       # Helper para relatórios
+│   ├── DeviceUtil.ts
+│   ├── ExternalJsLoader.ts     # Carregamento de scripts (GPT, IMA, Lumina)
+│   ├── GlobalLoadingOverlay.ts
 │   ├── logger.ts               # Sistema de logging
-│   └── ... (outros utils)
+│   ├── PreferencesUtil.ts
+│   ├── version.ts
+│   └── index.ts
 └── index.ts                    # Ponto de entrada principal
 ```
 
@@ -760,10 +761,13 @@ interface SDKConfig {
   baseUrl: string;
   timeout?: number;
   debug?: boolean;
-  webViewBridge?: {
-    enabled: boolean;
-    targetOrigin?: string;
-  };
+  appId?: string;
+  appVersion?: string;
+  artemisAdsAppId?: string;
+  primaryColor?: string;
+  luminaToken?: string;
+  proxyExternalScripts?: boolean;
+  cdnBaseUrl?: string;
 }
 ```