@tolinax/ayoune-interfaces 2025.16.24 → 2026.2.3

package/README.md

@@ -1,132 +1,132 @@
-# aYOUne Interfaces
-
-A comprehensive TypeScript interfaces library for the aYOUne platform - a modular business as a Service platform.
-
-[![npm version](https://badge.fury.io/js/@tolinax%2Fayoune-interfaces.svg)](https://badge.fury.io/js/@tolinax%2Fayoune-interfaces)
-[![License: LGPL-3.0](https://img.shields.io/badge/License-LGPL-yellow.svg)](https://opensource.org/license/lgpl-3-0)
-
-## Overview
-
-This library provides TypeScript type definitions and data exports for the aYOUne platform, which includes modules for:
-
-- **AI** - Artificial Intelligence services
-- **CRM** - Customer Relationship Management  
-- **CMS** - Content Management System
-- **Marketing** - Marketing automation and campaigns
-- **Automation** - Business process automation
-- **PM** - Project Management
-- **E-commerce** - Online store management
-- And many more specialized modules
-
-## Installation
-
-```bash
-npm install @tolinax/ayoune-interfaces
-```
-
-## Usage
-
-### Importing Interfaces
-
-```typescript
-import { IAPI, ITicket, IaYOUneUser } from '@tolinax/ayoune-interfaces';
-
-// Use interfaces for type safety
-const api: IAPI = {
-  _customerID: "customer123",
-  _clientID: [],
-  _subID: [],
-  _user: "user456",
-  name: "My API",
-  callback_url: "https://example.com/callback",
-  access_token: "token123",
-  access_token_key: "key456",
-  active: true,
-  scopes: [{ key: "read" }],
-  limit: false,
-  rateLimit: 1000
-};
-```
-
-### Importing Data and Enums
-
-```typescript
-import { aYOUneServices, aYOUneModules, aMN } from '@tolinax/ayoune-interfaces';
-
-// Access service definitions
-console.log(aYOUneServices); // Array of all aYOUne services with hosts
-
-// Access module definitions  
-console.log(aYOUneModules); // Array of platform modules
-
-// Use model names enum
-const collectionName = aMN.AIConversations; // "AIConversations"
-```
-
-## API Reference
-
-### Core Interfaces
-
-All interfaces extend `IDefaultFields` which provides common MongoDB document fields:
-
-- `_id`: ObjectId
-- `created`: Date
-- `updated`: Date
-- Other standard database fields
-
-### Data Exports
-
-#### Services (`aYOUneServices`)
-Array of service definitions with:
-- `label`: Human-readable service name
-- `module`: Associated platform module  
-- `host`: Service hostname
-
-#### Modules (`aYOUneModules`)
-Array of platform modules with:
-- `label`: Module display name
-- `module`: Module identifier
-- `host`: Module hostname
-
-#### Model Names (`aMN`)
-Enum containing all MongoDB collection names used across the platform.
-
-## Development
-
-### Building
-
-```bash
-npm run build
-```
-
-### Release
-
-This project uses conventional commits and automated releases:
-
-```bash
-npm run release
-```
-
-## Platform Architecture
-
-The aYOUne platform consists of multiple specialized services:
-
-- **Global Services**: Middleware, Datatables, Barcodes, Scripts
-- **AI Services**: Text/Image/Video Generation, Text-to-Speech  
-- **CMS Services**: Media, Content Snippets, Dynamic Content
-- **Business Services**: CRM, PM, Marketing, Automation
-- **Analytics**: Statistics, Monitoring, Reporting
-- **E-commerce**: Sales, Purchase, Accounting
-
-Each service is independently deployable and communicates through well-defined interfaces provided by this library.
-
-## Contributing
-
-1. Follow conventional commit format (`feat:`, `fix:`, `docs:`, etc.)
-2. All interfaces should extend `IDefaultFields` when appropriate
-3. Use consistent naming: interfaces start with `I`, data exports use descriptive names
-4. Update CHANGELOG.md entries are generated automatically
-
-## License
-
-LGPL-3.0 © tolinax
+# aYOUne Interfaces
+
+A comprehensive TypeScript interfaces library for the aYOUne platform - a modular business as a Service platform.
+
+[![npm version](https://badge.fury.io/js/@tolinax%2Fayoune-interfaces.svg)](https://badge.fury.io/js/@tolinax%2Fayoune-interfaces)
+[![License: LGPL-3.0](https://img.shields.io/badge/License-LGPL-yellow.svg)](https://opensource.org/license/lgpl-3-0)
+
+## Overview
+
+This library provides TypeScript type definitions and data exports for the aYOUne platform, which includes modules for:
+
+- **AI** - Artificial Intelligence services
+- **CRM** - Customer Relationship Management  
+- **CMS** - Content Management System
+- **Marketing** - Marketing automation and campaigns
+- **Automation** - Business process automation
+- **PM** - Project Management
+- **E-commerce** - Online store management
+- And many more specialized modules
+
+## Installation
+
+```bash
+npm install @tolinax/ayoune-interfaces
+```
+
+## Usage
+
+### Importing Interfaces
+
+```typescript
+import { IAPI, ITicket, IaYOUneUser } from '@tolinax/ayoune-interfaces';
+
+// Use interfaces for type safety
+const api: IAPI = {
+  _customerID: "customer123",
+  _clientID: [],
+  _subID: [],
+  _user: "user456",
+  name: "My API",
+  callback_url: "https://example.com/callback",
+  access_token: "token123",
+  access_token_key: "key456",
+  active: true,
+  scopes: [{ key: "read" }],
+  limit: false,
+  rateLimit: 1000
+};
+```
+
+### Importing Data and Enums
+
+```typescript
+import { aYOUneServices, aYOUneModules, aMN } from '@tolinax/ayoune-interfaces';
+
+// Access service definitions
+console.log(aYOUneServices); // Array of all aYOUne services with hosts
+
+// Access module definitions  
+console.log(aYOUneModules); // Array of platform modules
+
+// Use model names enum
+const collectionName = aMN.AIConversations; // "AIConversations"
+```
+
+## API Reference
+
+### Core Interfaces
+
+All interfaces extend `IDefaultFields` which provides common MongoDB document fields:
+
+- `_id`: ObjectId
+- `created`: Date
+- `updated`: Date
+- Other standard database fields
+
+### Data Exports
+
+#### Services (`aYOUneServices`)
+Array of service definitions with:
+- `label`: Human-readable service name
+- `module`: Associated platform module  
+- `host`: Service hostname
+
+#### Modules (`aYOUneModules`)
+Array of platform modules with:
+- `label`: Module display name
+- `module`: Module identifier
+- `host`: Module hostname
+
+#### Model Names (`aMN`)
+Enum containing all MongoDB collection names used across the platform.
+
+## Development
+
+### Building
+
+```bash
+npm run build
+```
+
+### Release
+
+This project uses conventional commits and automated releases:
+
+```bash
+npm run release
+```
+
+## Platform Architecture
+
+The aYOUne platform consists of multiple specialized services:
+
+- **Global Services**: Middleware, Datatables, Barcodes, Scripts
+- **AI Services**: Text/Image/Video Generation, Text-to-Speech  
+- **CMS Services**: Media, Content Snippets, Dynamic Content
+- **Business Services**: CRM, PM, Marketing, Automation
+- **Analytics**: Statistics, Monitoring, Reporting
+- **E-commerce**: Sales, Purchase, Accounting
+
+Each service is independently deployable and communicates through well-defined interfaces provided by this library.
+
+## Contributing
+
+1. Follow conventional commit format (`feat:`, `fix:`, `docs:`, etc.)
+2. All interfaces should extend `IDefaultFields` when appropriate
+3. Use consistent naming: interfaces start with `I`, data exports use descriptive names
+4. Update CHANGELOG.md entries are generated automatically
+
+## License
+
+LGPL-3.0 © tolinax

package/api/IResponseLocals.d.ts

@@ -28,40 +28,88 @@ export interface IResponseCursor {
     limit: number;
     [key: string]: any;
 }
+export interface IResponsePage {
+    current?: number;
+    total?: number;
+    size?: number;
+    [key: string]: any;
+}
 export interface IResponseRateLimit {
     limit: string;
     remaining: string;
     reset: string;
     resetDate: string;
 }
-export interface IResponseLocals {
+export interface IResponseIdentity {
     id?: string;
     ids?: string[];
-    errors?: any[];
+    apiId?: string;
+    patId?: string;
+    debugId?: string;
+}
+export interface IResponseAuth {
     user?: IaYOUneUser | IConsumer;
     _consumer?: IConsumer;
-    options?: IaYOUneExpressOptions;
-    middlewareFlow?: string[];
-    startHrTime?: [number, number];
-    isValid?: boolean;
-    type?: string;
+    isAPI?: boolean;
+    apiObject?: any;
+}
+export interface IResponseRights {
+    requiredRights?: string[];
+    userRights?: string[];
+    customerRights?: string[];
+}
+export interface IResponseQuery {
+    query?: any;
+    parsedQuery?: any;
+    dbQuery?: any;
+    fields?: any;
+    cursor?: IResponseCursor;
+    page?: IResponsePage;
+}
+export type ResponseMode = "default" | "redirect";
+export type ResponseType = "application/json" | "text/csv" | "application/xml" | "text/yaml" | string;
+export interface IResponseConfig {
     status?: number;
+    type?: ResponseType;
+    responseData?: any;
+    responseMode?: ResponseMode;
+    redirectUrl?: string;
+    plain?: boolean;
+    yaml?: boolean;
+}
+export interface IResponseClient {
     ip?: string;
     location?: IResponseLocationInfo;
-    ayouneParams?: Record<string, string>;
-    inbound?: IResponseInboundTraffic;
     device?: IResponseDevice;
-    responseData?: any;
-    debugId?: string;
+    device_type?: string;
+    inbound?: IResponseInboundTraffic;
+}
+export interface IResponseMeta {
+    model?: string;
     module?: string;
     space?: string;
     fn?: string;
-    cursor?: IResponseCursor;
-    query?: any;
-    fields?: any;
-    plain?: boolean;
-    yaml?: boolean;
-    rateLimit?: IResponseRateLimit;
+    ayouneParams?: Record<string, string>;
+}
+export interface IResponseHypermedia {
+    actions?: any[];
     links?: IAPILink[];
+    paths?: string[];
+}
+export interface IResponseAudit {
+    audit?: any;
+    debug?: boolean;
+    errors?: any[];
+    middlewareFlow?: string[];
+    startHrTime?: [number, number];
+}
+export interface IResponseFieldManagement {
+    removedFields?: string[];
+    updateMode?: "replace" | "merge" | string;
+}
+export interface IResponseLocals extends IResponseIdentity, IResponseAuth, IResponseRights, IResponseQuery, IResponseConfig, IResponseClient, IResponseMeta, IResponseHypermedia, IResponseAudit, IResponseFieldManagement {
+    options?: IaYOUneExpressOptions;
+    isValid?: boolean;
+    rateLimit?: IResponseRateLimit;
     [key: string]: any;
 }

package/data/modelNames.d.ts

@@ -272,6 +272,7 @@ export declare enum aMN {
     GlobalSettings = "GlobalSettings",
     Glossaries = "Glossaries",
     Goals = "Goals",
+    GratifyLoopViews = "GratifyLoopViews",
     GoodsReceipts = "GoodsReceipts",
     GoogleAssistantIntents = "GoogleAssistantIntents",
     HashTags = "HashTags",

package/data/modelNames.js

@@ -276,6 +276,7 @@ var aMN;
     aMN["GlobalSettings"] = "GlobalSettings";
     aMN["Glossaries"] = "Glossaries";
     aMN["Goals"] = "Goals";
+    aMN["GratifyLoopViews"] = "GratifyLoopViews";
     aMN["GoodsReceipts"] = "GoodsReceipts";
     aMN["GoogleAssistantIntents"] = "GoogleAssistantIntents";
     aMN["HashTags"] = "HashTags";

package/data/modelsAndRights.js

@@ -2950,6 +2950,16 @@ const modelsAndRights = [
         allowDuplicate: true,
         updateBy: "_id",
     },
+    {
+        plural: "GratifyLoopViews",
+        singular: "GratifyLoopView",
+        module: "general",
+        right: "general.gratifyloopviews",
+        readOnly: true,
+        importable: false,
+        allowDuplicate: false,
+        updateBy: "_id",
+    },
     {
         plural: "GoodsReceipts",
         singular: "GoodsReceipt",

package/interfaces/CostBucketResult.d.ts

@@ -0,0 +1,40 @@
+import { IDefaultFields } from "./IDefaultFields";
+export interface ICostBucketResult extends IDefaultFields {
+    lab: boolean;
+    environment: "production" | "lab" | "all";
+    _customerID: ObjectId;
+    _research: ObjectId;
+    date?: Date;
+    numKeywords?: number;
+    bid?: number;
+    maxCPC?: number;
+    avgCPC?: number;
+    minCPC?: number;
+    maxCost?: number;
+    avgCost?: number;
+    minCost?: number;
+    maxClicks?: number;
+    avgClicks?: number;
+    minClicks?: number;
+    maxImpressions?: number;
+    avgImpressions?: number;
+    minImpressions?: number;
+    maxConversions?: number;
+    avgConversions?: number;
+    minConversions?: number;
+    maxConversionRate?: number;
+    avgConversionRate?: number;
+    minConversionRate?: number;
+    maxCTR?: number;
+    avgCTR?: number;
+    minCTR?: number;
+    maxCPA?: number;
+    avgCPA?: number;
+    minCPA?: number;
+    maxAds?: number;
+    breakPointMin?: number;
+    breakPointMax?: number;
+    breakPointAvg?: number;
+    market?: string;
+    category?: string;
+}

package/interfaces/IAdvertiserDomainKPI.d.ts

@@ -0,0 +1,9 @@
+import { IDefaultFields } from "./IDefaultFields";
+export interface IAdvertiserWeeklyDomainKPI extends IDefaultFields {
+    _customerID?: ObjectId;
+    domain?: string;
+    device?: string;
+    iab?: string;
+    iabLabel?: string;
+    benchmark?: string;
+}

package/interfaces/IAdvertiserDomainKPI.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/IGeoIPLocation.d.ts

@@ -0,0 +1,17 @@
+export interface IGeoIPLocationTracking {
+    ip?: string;
+    range?: number[];
+    country?: string;
+    region?: string;
+    eu?: string;
+    timezone?: string;
+    city?: string;
+    ll?: number[];
+    metro?: number;
+    area?: number;
+    device?: string;
+    query?: string;
+    url?: string;
+    fingerprint?: string;
+    referrer?: string;
+}

package/interfaces/IGeoIPLocation.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/IGoogleAdsAccount.d.ts

@@ -0,0 +1,19 @@
+import { IDefaultFields } from "./IDefaultFields";
+export interface IGoogleAdsAccount extends IDefaultFields {
+    name: string;
+    meta: {
+        active: boolean;
+        oAuthLink: string;
+        keyGenLink: string;
+    };
+    googleAdsClient: {
+        client_id: string;
+        client_secret: string;
+        developer_token: string;
+    };
+    customerClient: {
+        customer_id: string;
+        login_customer_id: string;
+        refresh_token: string;
+    };
+}

package/interfaces/IGoogleAdsAccount.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/IGratifyLoopView.d.ts

@@ -0,0 +1,8 @@
+import { IDefaultFields } from "./IDefaultFields";
+import { IaYOUneTrackingParams } from "./IaYOUneTrackingParams";
+import { IGeoIPLocationTracking } from "./IGeoIPLocationTracking";
+export interface IGratifyLoopView extends IaYOUneTrackingParams, IGeoIPLocationTracking, IDefaultFields {
+    fingerprint_view?: string;
+    fingerprint?: string;
+    fingerprint_raw?: any;
+}

package/interfaces/IGratifyLoopView.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/IIABCategoryMappings.d.ts

@@ -0,0 +1,11 @@
+import { IDefaultFields } from "./IDefaultFields";
+interface Mapping {
+    IABCategory: string;
+    label: string;
+}
+export interface IIABCategoryMapping extends IDefaultFields {
+    _id?: ObjectId;
+    _customerID?: ObjectId;
+    mappings: Mapping[];
+}
+export {};

package/interfaces/IIABCategoryMappings.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/IIndustryBudget.d.ts

@@ -0,0 +1,22 @@
+import { IDefaultFields } from "./IDefaultFields";
+export interface IMarketBudget extends IDefaultFields {
+    lab: boolean;
+    environment: "production" | "lab" | "all";
+    _industry: ObjectId;
+    _company: ObjectId;
+    date: Date;
+    domain?: string;
+    host?: string;
+    ads: number;
+    avgPosition: number;
+    avgMonthlySearches: number;
+    avgCPC: number;
+    impressions: number;
+    deliveryRate: number;
+    termsCount: number;
+    terms: any[];
+    budget: number;
+    market?: string;
+    region?: string;
+    device?: string;
+}

package/interfaces/IIndustryBudget.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/IIndustryKPIs.d.ts

@@ -0,0 +1,20 @@
+import { IDefaultFields } from "./IDefaultFields";
+export interface IIndustryKPI extends IDefaultFields {
+    lab: boolean;
+    environment: "production" | "lab" | "all";
+    _industry: ObjectId;
+    date: Date;
+    host?: string;
+    ads: number;
+    avgPosition: number;
+    avgMonthlySearches: number;
+    avgCPC: number;
+    impressions: number;
+    deliveryRate: number;
+    termsCount: number;
+    terms: any[];
+    budget: number;
+    market?: string;
+    region?: string;
+    device?: string;
+}

package/interfaces/IIndustryKPIs.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/IModel.d.ts

@@ -0,0 +1,3 @@
+export interface IModel<T extends Document> {
+    dataTable?(query?: any, options?: any): Promise<any>;
+}

package/interfaces/IModel.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/IStreamPart.js

@@ -0,0 +1 @@
+"use strict";

package/interfaces/IValues.d.ts

@@ -0,0 +1,3 @@
+export interface ILabels {
+    [key: string]: string;
+}

package/interfaces/IValues.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/IaYOUneAdvertisementLocation.d.ts

@@ -0,0 +1,12 @@
+import { IDefaultFields } from "./IDefaultFields";
+import { IAddress } from "./IAddress";
+export interface IaYOUneAdvertisementLocation extends IDefaultFields {
+    _customerID?: ObjectId;
+    name?: string;
+    note?: string;
+    address?: IAddress;
+    prioritizeOwnAds?: boolean;
+    ratio?: number;
+    mediaTypes?: string[];
+    locale?: string;
+}

package/interfaces/IaYOUneAdvertisementLocation.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/IaYOUneDomainMeta.d.ts

@@ -0,0 +1,6 @@
+import { IDefaultFields } from "./IDefaultFields";
+export interface IAdvertiserDomainMeta extends IDefaultFields {
+    _customerID?: ObjectId;
+    domain?: string;
+    category?: string;
+}

package/interfaces/IaYOUneDomainMeta.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });