sizebay-core-sdk 1.0.0

package/.github/pull_request_template.md

@@ -0,0 +1,24 @@
+## Descrição
+<!-- Descreva o que foi feito neste Pull Request. -->
+
+## Design Pattern
+<!-- Foi utilizado algum Design Pattern? Se sim, descreva qual e como foi aplicado. -->
+
+## Testes Unitários
+- [ ] Testes unitários foram aplicados.
+- [ ] A funcionalidade foi testada manualmente.
+- **Cobertura de Testes:**  
+  <!-- Anexar aqui imagens ou evidências de cobertura de testes. -->
+
+## Evidências de Funcionamento
+<!-- Anexar evidências como capturas de tela ou GIFs mostrando o funcionamento da funcionalidade implementada. -->
+
+## Link da História
+<!-- Adicione o link para a história no ClickUp ou ferramenta de gerenciamento de tarefas: -->
+[Link para a história no ClickUp](https://app.clickup.com/)
+
+## Checklist
+- [ ] A funcionalidade foi testada manualmente.
+- [ ] O código segue os padrões de formatação do projeto.
+- [ ] A documentação foi atualizada, se aplicável.
+- [ ] Os testes passaram localmente.

package/.github/workflows/publish.yml

@@ -0,0 +1,48 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+      - master
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 'lts/*'
+          registry-url: 'https://registry.npmjs.org/'
+
+      - name: Set up pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: '7'
+
+      - name: Install dependencies
+        run: pnpm i
+
+      - name: Run tests
+        run: pnpm test
+
+      - name: Build project
+        run: pnpm run build
+
+      - name: Test npm authentication
+        run: npm whoami --registry=https://registry.npmjs.org/
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      
+      - name: Run semantic-release
+        run: pnpm run release
+        env:
+          GITHUB_TOKEN: ${{ secrets.MY_GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/tests-on-pr.yml

@@ -0,0 +1,37 @@
+name: CI - Run Tests on PR
+
+on:
+  pull_request:
+    branches:
+      - main
+      - master
+      - develop
+    types:
+      - opened
+      - synchronize
+      - reopened
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install pnpm
+        run: npm install -g pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+      
+      - name: Build packages
+        run: pnpm run build
+
+      - name: Run tests
+        run: pnpm test:ci

package/.prettierrc

@@ -0,0 +1,7 @@
+{
+    "singleQuote": true,
+    "semi": true,
+    "tabWidth": 2,
+    "useTabs": false
+  }
+  

package/.releaserc.json

@@ -0,0 +1,32 @@
+{
+    "branches": ["master"],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits"
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits"
+        }
+      ],
+      [
+        "@semantic-release/changelog",
+        {
+          "changelogFile": "CHANGELOG.md"
+        }
+      ],
+      "@semantic-release/npm",
+      [
+        "@semantic-release/git",
+        {
+          "assets": ["package.json", "CHANGELOG.md"],
+          "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+        }
+      ]
+    ]
+  }
+  

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 1.0.0 (2025-03-31)
+
+### Features
+
+* add AI Image Service module ([2280302](https://github.com/sizebay/events-sdk/commit/228030292e3ab9d930a428f0f8dd46778b21ab7d))
+* add env-based endpoints and service-specific config overrides ([3c42273](https://github.com/sizebay/events-sdk/commit/3c4227350e36ee468fa86449b6a5f4ebe2016d32))
+* add module composition logic to client ([f486058](https://github.com/sizebay/events-sdk/commit/f486058e35ca9ebb1efb4ed00848d4dc438d0b03))
+* **ai-image-service:** add product size recommendation ([2cace2e](https://github.com/sizebay/events-sdk/commit/2cace2e7107672dcde3acd7a76f57973a4bba7c1))
+* initial project setup ([37f7e9f](https://github.com/sizebay/events-sdk/commit/37f7e9fd313e0770d527a3b898a5180910124a41))
+
+### Bug Fixes
+
+* remove `beforeAll` in test setup to avoid reference error ([ea06da4](https://github.com/sizebay/events-sdk/commit/ea06da4019f43eb084a556d3b04c2286b6ec2b84))

package/README.dev.md

@@ -0,0 +1,184 @@
+# Sizebay Core SDK - Development Guide
+
+This guide is intended to help developers understand the project structure, how to create and integrate new modules, run tests, and configure automated releases with Semantic Release.
+
+---
+
+## Project Structure
+
+The project is organized as follows:
+
+```
+📦src
+ ┣ 📂config
+ ┃ ┣ index.ts          // Configuration manager that handles endpoints and service-specific settings.
+ ┣ 📂core
+ ┃ ┣ client.ts          // Core logic for creating and aggregating modules.
+ ┣ 📂modules
+ ┃ ┣ tracker.ts         // Example module (Tracker).
+ ┃ ┣ ai-image-service.ts// Example module (AI Image Service).
+ ┃ ┗ index.ts           // Exports all modules (centralized import for the client).
+ ┣ 📂types
+ ┃ ┣ sdk.ts             // SDK configuration types.
+ ┃ ┣ tracker.ts         // Types related to the Tracker module.
+ ┃ ┣ ai-image-service.ts// Types related to the AI Image Service module.
+ ┃ ┗ index.ts           // Exports all public types.
+ ┣ index.ts             // Entry point of the SDK (exports public API).
+ ┗ 📂test
+   ┗ example.ts         // Example usage and tests for the SDK.
+```
+
+**Key Directories:**
+
+- **config**: Contains the configuration manager that loads endpoints (from `endpoints.ts`) and applies any service-specific overrides.
+- **core**: Houses the client creation logic that aggregates all modules.
+- **modules**: Each module provides a distinct functionality (e.g., event tracking, AI services). New modules should be added here.
+- **types**: Contains all TypeScript type definitions for both the core SDK and each module.
+- **test**: Provides examples and tests to verify the SDK functionality.
+
+---
+
+## Building the SDK
+
+To compile the TypeScript source into JavaScript, run:
+
+```bash
+npm run build
+```
+
+This command compiles the project and outputs the JavaScript files into the directory specified in your TypeScript configuration (usually `./dist`).
+
+---
+
+## Running Tests and Examples
+
+An example usage is provided in the `test/example.ts` file. To run tests or examples, execute:
+
+```bash
+npm run test:dev
+```
+
+> **Note:** The test script uses `ts-node` to run TypeScript examples directly.
+
+---
+
+## How to Create a New Module
+
+To add a new module to the SDK, follow these steps:
+
+1. **Create the Module File:**
+   - Add your new module in the `src/modules` directory. For instance, create a file named `new-module.ts`.
+
+2. **Define the Module Class:**
+   - The module class should accept an instance of `Config` in its constructor so it can retrieve its endpoint and other service-specific configurations.
+   - Expose only the public methods that should be part of the client’s API.
+
+   ```typescript
+   // src/modules/new-module.ts
+   import { Config } from '@src/config/config';
+
+   export class NewModule {
+     private endpoint: string;
+
+     constructor(config: Config) {
+       // Retrieve the endpoint configured for the new module.
+       this.endpoint = config.getEndpoint('newModule');
+     }
+
+     public async doSomething(params: any): Promise<any> {
+       // Module logic here.
+       // Use `this.endpoint` for requests.
+       return { success: true };
+     }
+   }
+   ```
+
+3. **Update Type Definitions:**
+   - Create a new type file in `src/types` (e.g., `new-module.ts`) for any interfaces or types related to your module.
+
+   ```typescript
+   // src/types/new-module.ts
+   export interface NewModuleParams {
+     param1: string;
+     param2?: number;
+   }
+
+   export interface NewModuleResponse {
+     success: boolean;
+     data?: any;
+   }
+   ```
+
+4. **Update the Modules Index:**
+   - In `src/modules/index.ts`, import and add your new module to the list of module classes.
+
+   ```typescript
+   // src/modules/index.ts
+   import { Tracker } from './tracker';
+   import { AIImageService } from './ai-image-service';
+   import { NewModule } from './new-module';
+
+   export const moduleClasses = [
+     Tracker,
+     AIImageService,
+     NewModule,
+     // Add new modules here as needed.
+   ];
+   ```
+
+---
+
+## Configuration & Endpoints
+
+The SDK manages endpoints based on the environment. Endpoints for each service are defined in a dedicated module (e.g., `src/config/endpoints.ts`). The `Config` class loads these endpoints based on the `env` option provided during client initialization. It also supports service-specific overrides that are passed via the SDK configuration options.
+
+Example configuration usage:
+
+```typescript
+import { createClient } from 'sizebay-core-sdk';
+
+const client = createClient({
+  env: 'development',
+  services: {
+    aiImageService: {
+      timeout: 15000, // Example: override default timeout for AI Image Service.
+    },
+  },
+});
+
+```
+
+---
+
+## Semantic Release & Automated Releases
+
+This project uses [Semantic Release](https://semantic-release.gitbook.io/semantic-release/) to automate versioning, changelog generation, and package publishing. Key dependencies include:
+
+- **@semantic-release/changelog**: Generates the changelog based on commit messages.
+- **@semantic-release/commit-analyzer**: Analyzes commit messages (following Conventional Commits) to determine the type of release (major, minor, patch).
+- **@semantic-release/git**: Commits and pushes version bumps and changelog updates.
+- **@semantic-release/npm**: Publishes the updated package to npm.
+- **@semantic-release/release-notes-generator**: Creates release notes from commit messages.
+- **@types/jest**: Provides TypeScript definitions for Jest if you are writing unit tests.
+
+### How It Works
+
+1. **Commit Conventions:**
+   - Follow the [Conventional Commits](https://www.conventionalcommits.org/) standard for your commit messages.
+   - The commit analyzer scans these messages to decide whether a new release should be a major, minor, or patch update.
+
+2. **Changelog Generation:**
+   - The release notes generator and changelog plugins automatically generate a changelog from the commits.
+
+3. **Publishing:**
+   - After generating the release notes, the Git plugin updates version numbers and changelog files in the repository.
+   - Finally, the npm plugin publishes the new version to npm.
+
+4. **Configuration:**
+   - Semantic Release settings are typically defined in a `.releaserc` file or within the `release` key in `package.json`. Refer to the Semantic Release documentation for customization options.
+
+---
+
+## Contributing
+
+Contributions are welcome! If you have ideas, bug fixes, or improvements, please open an issue or submit a pull request on GitHub. Make sure to follow the commit message guidelines and code style conventions.

package/README.md

@@ -0,0 +1,115 @@
+# Sizebay Core SDK
+
+A lightweight, modular, and extensible SDK designed for integrating multiple services (such as event tracking, AI services, etc.) into your application. This package includes environment-based endpoint management, async/await support, and full TypeScript definitions.
+
+## Installation
+
+Install the package via npm:
+
+```bash
+npm install sizebay-core-sdk
+```
+
+## API Reference
+
+### Client
+
+#### `createClient(options: SDKConfigOptions): ClientType`
+Creates a new instance of the SDK with the provided configuration.
+
+**Options**
+
+| Property | Type     | Required | Description                                                         |
+|----------|----------|----------|---------------------------------------------------------------------|
+| `env`    | `string` | No       | The environment to use (`'development'` or `'production'`). Defaults to `'development'`. |
+
+**Example**
+
+```typescript
+import { createClient } from 'sizebay-core-sdk';
+
+const client = createClient({
+  env: 'development',
+});
+```
+
+---
+
+### Tracker Module
+
+#### `track(eventName: string, payload: EventPayload): Promise<any>`
+Sends an event to the designated API endpoint.
+
+**Parameters**
+
+| Parameter    | Type           | Required | Description                                      |
+|--------------|----------------|----------|--------------------------------------------------|
+| `eventName`  | `string`       | Yes      | The name of the event (e.g., "ADD_TO_CART", "ORDER").     |
+| `payload`    | `EventPayload` | Yes      | An object containing event data.               |
+
+**Example**
+
+```typescript
+const eventPayload = {
+  sid: 'a0cf8559-926a-4a75-b4ca-7c4c13fed69c',
+  tenantId: 123,
+  eventName: 'ADD_TO_CART',
+  sessionId: 123,
+  permalink: 'https://www.example.com/2IC-7370',
+  properties: {
+    quantity: 1,
+    device: 'APP',
+    country: 'BR',
+  },
+};
+
+async function trackEvent() {
+  try {
+    const response = await client.track('ADD_TO_CART', eventPayload);
+    console.log('Event tracked successfully:', response);
+  } catch (error: any) {
+    console.error('Error tracking event:', error.message);
+  }
+}
+
+trackEvent();
+```
+
+---
+
+### AI Image Service Module
+
+#### `getSimilarProducts(params: GetSimilarProductsParams): Promise<GetSimilarProductsResponse>`
+Fetches similar products based on the provided image parameters.
+
+**Parameters**
+
+| Parameter | Type                       | Required | Description                                                |
+|-----------|----------------------------|----------|------------------------------------------------------------|
+| `params`  | `GetSimilarProductsParams` | Yes      | An object containing parameters for fetching similar products. |
+
+**Example**
+
+```typescript
+import { GetSimilarProductsParams } from 'sizebay-core-sdk/types/ai-image-service';
+
+const params: GetSimilarProductsParams = {
+  tenantId: 123,
+  permalink: 'https://example.com/product',
+  collectionName: 'summer-collection', // optional
+  sessionId: 456,                      // optional
+  page: 1,                             // optional
+  perPage: 10,                         // optional
+};
+
+async function fetchSimilarProducts() {
+  try {
+    const response = await client.getSimilarProducts(params);
+    console.log('Similar products:', response.data);
+  } catch (error: any) {
+    console.error('Error fetching similar products:', error.message);
+  }
+}
+
+fetchSimilarProducts();
+```

package/dist/sizebay-core-sdk.es.js

@@ -0,0 +1,124 @@
+const c = {
+  tracker: {
+    production: "https://data-event-service.internalsizebay.com/events",
+    development: "https://data-event-service.internalsizebay.com/events"
+  },
+  aiImageService: {
+    production: "https://ai-image-service.example.com/production",
+    development: "https://ai-image-service.example.com/development"
+  }
+  // Adicione outros serviços conforme necessário
+};
+class a {
+  constructor(r) {
+    const o = r.env || "development";
+    this.serviceOverrides = r.services || {}, this.endpoints = {};
+    for (const t in c)
+      if (Object.prototype.hasOwnProperty.call(c, t)) {
+        const i = c[t][o];
+        if (!i)
+          continue;
+        this.endpoints[t] = i;
+      }
+  }
+  getEndpoint(r) {
+    const o = this.endpoints[r];
+    if (!o)
+      throw new Error(
+        `Endpoint for service '${r}' is not configured.`
+      );
+    return o;
+  }
+  getServiceConfig(r) {
+    return this.serviceOverrides[r] || {};
+  }
+}
+class p {
+  constructor(r) {
+    this.endpoint = r.getEndpoint("tracker");
+  }
+  async track(r, o) {
+    const t = {
+      eventName: r,
+      ...o
+    };
+    try {
+      const e = await fetch(this.endpoint, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify(t)
+      });
+      if (!e.ok) {
+        const i = await e.text();
+        throw new Error(`Request error: ${e.status} - ${i}`);
+      }
+      return await e.json();
+    } catch (e) {
+      throw e;
+    }
+  }
+}
+class d {
+  constructor(r) {
+    this.endpoint = r.getEndpoint("aiImageService");
+  }
+  async getSimilarProducts(r) {
+    const o = new URL(`${this.endpoint}/recommendations/similar`);
+    Object.entries(r).forEach(([t, e]) => {
+      e !== void 0 && o.searchParams.append(t, String(e));
+    });
+    try {
+      const t = await fetch(o.toString(), {
+        method: "GET",
+        headers: {
+          "Content-Type": "application/json"
+        }
+      });
+      if (!t.ok) {
+        const e = await t.text();
+        throw new Error(`Request error: ${t.status} - ${e}`);
+      }
+      return await t.json();
+    } catch (t) {
+      throw new Error(`Error fetching similar products: ${t.message}`);
+    }
+  }
+  async getRecommendedProductSize(r) {
+    const o = new URL(`${this.endpoint}/recommendations/size-by-products`);
+    try {
+      const t = await fetch(o.toString(), {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify(r)
+      });
+      if (!t.ok) {
+        const e = await t.text();
+        throw new Error(`Request error: ${t.status} - ${e}`);
+      }
+      return await t.json();
+    } catch (t) {
+      throw new Error(`Error fetching recommended product size: ${t.message}`);
+    }
+  }
+}
+const h = [
+  p,
+  d
+];
+function f(s) {
+  const r = new a(s), o = h.map((e) => new e(r)), t = { config: r };
+  return o.forEach((e) => {
+    Object.getOwnPropertyNames(e).forEach((n) => {
+      typeof e[n] == "function" && (t[n] = e[n].bind(e));
+    });
+    const i = Object.getPrototypeOf(e);
+    Object.getOwnPropertyNames(i).forEach((n) => {
+      n !== "constructor" && typeof e[n] == "function" && (t[n] = e[n].bind(e));
+    });
+  }), t;
+}
+export {
+  f as createClient
+};

package/dist/sizebay-core-sdk.umd.js

@@ -0,0 +1 @@
+(function(s,i){typeof exports=="object"&&typeof module<"u"?i(exports):typeof define=="function"&&define.amd?define(["exports"],i):(s=typeof globalThis<"u"?globalThis:s||self,i(s["sizebay-core-sdk"]={}))})(this,function(s){"use strict";const i={tracker:{production:"https://data-event-service.internalsizebay.com/events",development:"https://data-event-service.internalsizebay.com/events"},aiImageService:{production:"https://ai-image-service.example.com/production",development:"https://ai-image-service.example.com/development"}};class p{constructor(r){const o=r.env||"development";this.serviceOverrides=r.services||{},this.endpoints={};for(const e in i)if(Object.prototype.hasOwnProperty.call(i,e)){const c=i[e][o];if(!c)continue;this.endpoints[e]=c}}getEndpoint(r){const o=this.endpoints[r];if(!o)throw new Error(`Endpoint for service '${r}' is not configured.`);return o}getServiceConfig(r){return this.serviceOverrides[r]||{}}}class d{constructor(r){this.endpoint=r.getEndpoint("tracker")}async track(r,o){const e={eventName:r,...o};try{const t=await fetch(this.endpoint,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(e)});if(!t.ok){const c=await t.text();throw new Error(`Request error: ${t.status} - ${c}`)}return await t.json()}catch(t){throw t}}}class f{constructor(r){this.endpoint=r.getEndpoint("aiImageService")}async getSimilarProducts(r){const o=new URL(`${this.endpoint}/recommendations/similar`);Object.entries(r).forEach(([e,t])=>{t!==void 0&&o.searchParams.append(e,String(t))});try{const e=await fetch(o.toString(),{method:"GET",headers:{"Content-Type":"application/json"}});if(!e.ok){const t=await e.text();throw new Error(`Request error: ${e.status} - ${t}`)}return await e.json()}catch(e){throw new Error(`Error fetching similar products: ${e.message}`)}}async getRecommendedProductSize(r){const o=new URL(`${this.endpoint}/recommendations/size-by-products`);try{const e=await fetch(o.toString(),{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(r)});if(!e.ok){const t=await e.text();throw new Error(`Request error: ${e.status} - ${t}`)}return await e.json()}catch(e){throw new Error(`Error fetching recommended product size: ${e.message}`)}}}const h=[d,f];function u(a){const r=new p(a),o=h.map(t=>new t(r)),e={config:r};return o.forEach(t=>{Object.getOwnPropertyNames(t).forEach(n=>{typeof t[n]=="function"&&(e[n]=t[n].bind(t))});const c=Object.getPrototypeOf(t);Object.getOwnPropertyNames(c).forEach(n=>{n!=="constructor"&&typeof t[n]=="function"&&(e[n]=t[n].bind(t))})}),e}s.createClient=u,Object.defineProperty(s,Symbol.toStringTag,{value:"Module"})});

package/dist/types/src/config/endpoints.d.ts

@@ -0,0 +1,2 @@
+import { EndpointDefinition } from '../types';
+export declare const endpoints: Record<string, EndpointDefinition>;

package/dist/types/src/config/index.d.ts

@@ -0,0 +1,10 @@
+import { SDKConfigOptions } from '../types';
+export declare class Config {
+    private endpoints;
+    private serviceOverrides;
+    constructor(options: SDKConfigOptions);
+    getEndpoint(serviceName: string): string;
+    getServiceConfig(serviceName: string): {
+        [key: string]: any;
+    };
+}

package/dist/types/src/core/client.d.ts

@@ -0,0 +1,2 @@
+import { ClientType, SDKConfigOptions } from '../types';
+export declare function createClient(options: SDKConfigOptions): ClientType;

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

@@ -0,0 +1,2 @@
+export { createClient } from './core/client';
+export * from './types';

package/dist/types/src/modules/ai-image-service.d.ts

@@ -0,0 +1,8 @@
+import { Config } from '../config';
+import { GetRecommendedProductSizeParams, GetRecommendedProductSizeResponse, GetSimilarProductsParams, GetSimilarProductsResponse } from '../types/ai-image-service.types';
+export declare class AIImageService {
+    private endpoint;
+    constructor(config: Config);
+    getSimilarProducts(params: GetSimilarProductsParams): Promise<GetSimilarProductsResponse>;
+    getRecommendedProductSize(payload: GetRecommendedProductSizeParams): Promise<GetRecommendedProductSizeResponse>;
+}

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

@@ -0,0 +1,3 @@
+import { Tracker } from './tracker';
+import { AIImageService } from './ai-image-service';
+export declare const moduleClasses: (typeof Tracker | typeof AIImageService)[];

package/dist/types/src/modules/tracker.d.ts

@@ -0,0 +1,7 @@
+import { TrackData } from '../types';
+import { Config } from '../config';
+export declare class Tracker {
+    private endpoint;
+    constructor(config: Config);
+    track(eventName: string, payload: TrackData): Promise<any>;
+}