@or-sdk/sku-builder 2.1.0 → 2.1.1-beta.4012.0

package/dist/types/SkuBuilder.d.ts

@@ -1,89 +1,13 @@
 import { AxiosError, Base } from '@or-sdk/base';
 import { Mapping, Options, SkuBuilderConfig } from './types';
-/**
- * OneReach SkuBuilder service
- *  ## Installation:
- * ```
- * $ npm i @or-sdk/sku-builder
- * ```
- */
 export declare class SkuBuilder extends Base {
     private readonly userToken?;
     private readonly billingApiUrl?;
     private mapping;
     private withApiErrorLog;
-    /**
-     * @param {SkuBuilderConfig} [params]
-     * Configuration parameters for the SkuBuilder.
-     *
-     * @param {string} [params.token]
-     * The account token for authentication.
-     *
-     * @param {string} [params.billingApiUrl]
-     * The URL for the billing API.
-     *
-     * @param {string} [params.discoveryUrl]
-     * The URL for the discovery service.
-     *
-     * @param {Array<Mapping>} [params.mapping]
-     * Optional mapping configurations.
-     * In case this parameter empty SDK gets all mappings and apply it authomaticaly
-     *
-     * @param {boolean} [params.withApiErrorLog]
-     * Flag to enable API error logging.
-     *
-     * @example
-     * ```typescript
-     * import { SkuBuilder } from '@or-sdk/sku-builder'
-     * const skuBuilder = new SkuBuilder({
-     *  token: 'my-account-token-string',
-     *  billingApiUrl: 'https://billing.ops-dev.api.onereach.ai',
-     *  discoveryUrl: 'http://example.billing.ops-dev/endpoint',
-     *  mapping: 'array-of-mapping-collections'
-     * });
-     * ```
-     */
     constructor(params?: SkuBuilderConfig);
-    /**
-     * The method gets SKU mapping collections.
-     *
-     * @returns {Array<Mapping>} array of mapping collections
-     */
     getMapping(): Promise<Mapping[]>;
-    /**
-     * Generates SKUs for incoming events.
-     * This function processes an array of incoming event objects, all of which should belong to the same
-     * type (`type`). Based on the `type`, the function determines the appropriate SKU generation
-     * logic. It then extends each event object with generated SKU identifiers and associated amount properties.
-     *
-     * @param {Array<Object>} payload
-     * An array of incoming event objects. Each event should conform to the expected structure based on the `type`.
-     * All events in the array must belong to the same category or type as specified by `type`.
-     *
-     * @param {type} type
-     * A string representing the type or category of the events. This parameter dictates the SKU generation strategy.
-     * Examples might include `"flow-processing"`, `"executable"`, `"text-messaging"`, etc.
-     *
-     * @param {Object} [options={}]
-     * Optional parameters to control the flow processing behavior. These options can customize how SKUs are generated
-     * or how the events are processed. If not provided, default processing rules will apply.
-     *
-     * @property {boolean} [options.isProcessingSegment=false]
-     * Determines whether each SKU should be generated in segements. By defult each SKU are generating in minutes.
-     *
-     * @returns {Array<Object>}
-     * Returns a new array of event objects, each extended with the following additional properties:
-     *
-     * - `SKU` (string): The generated SKU identifier for the event.
-     * - `Amount` (number): The calculated amount associated with the SKU, based on event data and processing rules.
-     */
     makeSku<T extends Record<string, unknown>>(payload: T[], type: string, options?: Options): Promise<(Record<"SKU" | "Amount", unknown> & T)[]>;
-    /**
-     * Parses an AxiosError and returns a standardized Error object.
-     *
-     * @param {AxiosError} e - The AxiosError instance to be parsed.
-     * @returns {Error} A new Error object containing the error code, message, and stack trace.
-     */
     parseError(e: AxiosError): Error;
     private logApiError;
 }

package/dist/types/SkuBuilder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SkuBuilder.d.ts","sourceRoot":"","sources":["../../src/SkuBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,IAAI,EAAS,MAAM,cAAc,CAAC;AAKvD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAwB,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAInF;;;;;;GAMG;AACH,qBAAa,UAAW,SAAQ,IAAI;IAClC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAQ;IACnC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAS;IACxC,OAAO,CAAC,OAAO,CAAwB;IACvC,OAAO,CAAC,eAAe,CAAU;IAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;gBACS,MAAM,GAAE,gBAAqB;IAiBzC;;;;OAIG;IACU,UAAU,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IA+B7C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,OAAO,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpD,OAAO,EAAE,CAAC,EAAE,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,OAAO;IAanB;;;;;OAKG;IACI,UAAU,CAAC,CAAC,EAAE,UAAU,GAAG,KAAK;IAavC,OAAO,CAAC,WAAW;CAYpB"}
+{"version":3,"file":"SkuBuilder.d.ts","sourceRoot":"","sources":["../../src/SkuBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,IAAI,EAAS,MAAM,cAAc,CAAC;AAKvD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAwB,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAWnF,qBAAa,UAAW,SAAQ,IAAI;IAClC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAQ;IACnC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAS;IACxC,OAAO,CAAC,OAAO,CAAwB;IACvC,OAAO,CAAC,eAAe,CAAU;gBAiCrB,MAAM,GAAE,gBAAqB;IAsB5B,UAAU,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IA0DhC,OAAO,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpD,OAAO,EAAE,CAAC,EAAE,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,OAAO;IAmBZ,UAAU,CAAC,CAAC,EAAE,UAAU,GAAG,KAAK;IAavC,OAAO,CAAC,WAAW;CAYpB"}

package/dist/types/types.d.ts

@@ -8,26 +8,10 @@ export type Mapping = {
     metadata?: object;
 };
 export type SkuBuilderConfig = {
-    /**
-     * Token
-     */
     token?: Token;
-    /**
-     * URL of Billing Api
-     */
     billingApiUrl?: string;
-    /**
-     * Service discovery URL
-     */
     discoveryUrl?: string;
-    /**
-     * If true, the API error details like request url, params and body,
-     * will be outputted to console
-     */
     withApiErrorLog?: boolean;
-    /**
-     * SKU mapping
-     */
     mapping?: Array<Mapping>;
 };
 export type Options = {
@@ -48,9 +32,6 @@ export declare enum CategoryNamespace {
     STORAGE_GENERAL = "storage-general",
     STORAGE_WEAVIATE = "storage-weaviate"
 }
-/**
- * @deprecated use CategoryNamespace
- */
 export declare enum UsageQueryType {
     FLOW_PROCESSING = "processing-flow",
     VOICE_PROCESSING = "processing-voice",
@@ -63,16 +44,10 @@ export declare enum UsageQueryType {
     WEAVIATE_STORAGE = "storage-weaviate",
     GENERAL_STORAGE = "storage-general"
 }
-/**
- * @deprecated use CategoryNamespace
- */
 export declare enum UsageResourcesQueryType {
     USER = "user",
     IDENTIFIER = "identifier"
 }
-/**
- * @deprecated use CategoryNamespace
- */
 export type QueryType = UsageQueryType | UsageResourcesQueryType;
 export type PaginatedResponseDto<T> = {
     total: number;

package/dist/types/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IAAE,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAAE,CAAC;AAEzD,oBAAY,iBAAiB;IAC3B,eAAe,oBAAoB;IACnC,gBAAgB,qBAAqB;IACrC,kBAAkB,uBAAuB;IACzC,cAAc,mBAAmB;IACjC,MAAM,WAAW;IACjB,eAAe,oBAAoB;IACnC,cAAc,mBAAmB;IACjC,iBAAiB,qBAAqB;IACtC,WAAW,gBAAgB;IAC3B,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,eAAe,oBAAoB;IACnC,gBAAgB,qBAAqB;CACtC;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB,eAAe,oBAAoC;IACnD,gBAAgB,qBAAqC;IACrD,UAAU,uBAAuC;IACjD,MAAM,WAA2B;IACjC,eAAe,oBAAoC;IACnD,cAAc,mBAAmC;IACjD,iBAAiB,qBAAsC;IACvD,WAAW,gBAAgC;IAC3C,gBAAgB,qBAAqC;IACrD,eAAe,oBAAoC;CACpD;AAED;;GAEG;AACH,oBAAY,uBAAuB;IACjC,IAAI,SAAyB;IAC7B,UAAU,eAA+B;CAC1C;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,cAAc,GAAG,uBAAuB,CAAC;AAEjE,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAAI;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,CAAC,EAAE,CAAC;CACX,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAI7B,KAAK,CAAC,EAAE,KAAK,CAAC;IAId,aAAa,CAAC,EAAE,MAAM,CAAC;IAIvB,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,eAAe,CAAC,EAAE,OAAO,CAAC;IAI1B,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IAAE,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAAE,CAAC;AAEzD,oBAAY,iBAAiB;IAC3B,eAAe,oBAAoB;IACnC,gBAAgB,qBAAqB;IACrC,kBAAkB,uBAAuB;IACzC,cAAc,mBAAmB;IACjC,MAAM,WAAW;IACjB,eAAe,oBAAoB;IACnC,cAAc,mBAAmB;IACjC,iBAAiB,qBAAqB;IACtC,WAAW,gBAAgB;IAC3B,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,eAAe,oBAAoB;IACnC,gBAAgB,qBAAqB;CACtC;AAKD,oBAAY,cAAc;IACxB,eAAe,oBAAoC;IACnD,gBAAgB,qBAAqC;IACrD,UAAU,uBAAuC;IACjD,MAAM,WAA2B;IACjC,eAAe,oBAAoC;IACnD,cAAc,mBAAmC;IACjD,iBAAiB,qBAAsC;IACvD,WAAW,gBAAgC;IAC3C,gBAAgB,qBAAqC;IACrD,eAAe,oBAAoC;CACpD;AAKD,oBAAY,uBAAuB;IACjC,IAAI,SAAyB;IAC7B,UAAU,eAA+B;CAC1C;AAKD,MAAM,MAAM,SAAS,GAAG,cAAc,GAAG,uBAAuB,CAAC;AAEjE,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAAI;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,CAAC,EAAE,CAAC;CACX,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@or-sdk/sku-builder",
-  "version": "2.1.0",
+  "version": "2.1.1-beta.4012.0",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -21,7 +21,7 @@
     "test:watch": "vitest --watch"
   },
   "dependencies": {
-    "@or-sdk/base": "^0.43.0",
+    "@or-sdk/base": "^0.44.0-beta.4012.0",
     "lodash.clonedeep": "^4.5.0"
   },
   "devDependencies": {
@@ -32,6 +32,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "ce62679c119c54ef41fd0d8f7084c563c3b21b24"
+  }
 }