@stackone/olap 0.1.0

package/README.md

@@ -0,0 +1,50 @@
+# @stackone/olap
+
+## Description
+
+This package contains the olap logs functionality for stackone projects.
+
+This package uses the tech stack provided by the **Connect Monorepo** global setup. Please check the [root README](../../README.md) for more information.
+
+## Requirements
+
+Please check the [root README](../../README.md) for requirements.
+
+## Installation
+
+```bash
+# install dependencies
+$ npm run install
+```
+
+## Available commands
+
+```bash
+# clean build output
+$ npm run clean
+```
+
+```bash
+# build package
+$ npm run build
+```
+
+```bash
+# run tests
+$ npm run test
+```
+
+```bash
+# run tests on watch mode
+$ npm run test:watch
+```
+
+```bash
+# run linter
+$ npm run lint
+```
+
+```bash
+# run linter and try to fix any error
+$ npm run lint:fix
+```

package/dist/index.d.mts

@@ -0,0 +1,108 @@
+//#region ../logger/src/types.d.ts
+interface ILogger {
+  debug({
+    category,
+    message,
+    traceId,
+    context
+  }: {
+    category?: string;
+    message: string;
+    traceId?: string;
+    context?: Record<string, unknown>;
+  }): void;
+  info({
+    category,
+    message,
+    traceId,
+    context
+  }: {
+    category?: string;
+    message: string;
+    traceId?: string;
+    context?: Record<string, unknown>;
+  }): void;
+  warning({
+    category,
+    message,
+    traceId,
+    error,
+    code,
+    context
+  }: {
+    category?: string;
+    message: string;
+    traceId?: string;
+    error?: LogError;
+    code?: string;
+    context?: Record<string, unknown>;
+  }): void;
+  error({
+    category,
+    message,
+    traceId,
+    error,
+    code,
+    context
+  }: {
+    category?: string;
+    message: string;
+    traceId?: string;
+    error?: LogError;
+    code: string;
+    context?: Record<string, unknown>;
+  }): void;
+}
+type LogError = Error & {
+  response?: {
+    data?: unknown;
+  };
+  context?: Record<string, unknown>;
+  url?: string;
+};
+//#endregion
+//#region src/olap/olapOptions.d.ts
+type OlapOptions = {
+  olap?: boolean;
+  advanced?: boolean;
+};
+//#endregion
+//#region src/types.d.ts
+interface IKafkaSink {
+  send(topic: string, payload: unknown): Promise<void>;
+}
+interface IS3Sink {
+  send(bucket: string, payload: unknown): Promise<void>;
+}
+interface IOlapClient {
+  recordAction(ActionResult: ActionResult, options?: OlapOptions): void;
+  recordStep(stepResult: StepResult, options?: OlapOptions): void;
+}
+type ActionResult = {
+  status: string;
+  message: string | undefined;
+  outputs: unknown;
+};
+type StepResult = {
+  stepId: string;
+  status: string;
+};
+//#endregion
+//#region src/olap/olapClient.d.ts
+declare class OlapClient implements IOlapClient {
+  #private;
+  name: string;
+  constructor({
+    KafkaSink,
+    S3Sink,
+    logger
+  }?: {
+    KafkaSink?: IKafkaSink;
+    S3Sink?: IS3Sink;
+    logger?: ILogger;
+  });
+  recordAction(actionResult: ActionResult, options?: OlapOptions): Promise<void>;
+  recordStep(stepResult: StepResult, options?: OlapOptions): Promise<void>;
+}
+//#endregion
+export { type ActionResult, type IOlapClient, OlapClient, type OlapOptions, type StepResult };

package/dist/index.d.ts

@@ -0,0 +1,108 @@
+//#region ../logger/src/types.d.ts
+interface ILogger {
+  debug({
+    category,
+    message,
+    traceId,
+    context
+  }: {
+    category?: string;
+    message: string;
+    traceId?: string;
+    context?: Record<string, unknown>;
+  }): void;
+  info({
+    category,
+    message,
+    traceId,
+    context
+  }: {
+    category?: string;
+    message: string;
+    traceId?: string;
+    context?: Record<string, unknown>;
+  }): void;
+  warning({
+    category,
+    message,
+    traceId,
+    error,
+    code,
+    context
+  }: {
+    category?: string;
+    message: string;
+    traceId?: string;
+    error?: LogError;
+    code?: string;
+    context?: Record<string, unknown>;
+  }): void;
+  error({
+    category,
+    message,
+    traceId,
+    error,
+    code,
+    context
+  }: {
+    category?: string;
+    message: string;
+    traceId?: string;
+    error?: LogError;
+    code: string;
+    context?: Record<string, unknown>;
+  }): void;
+}
+type LogError = Error & {
+  response?: {
+    data?: unknown;
+  };
+  context?: Record<string, unknown>;
+  url?: string;
+};
+//#endregion
+//#region src/olap/olapOptions.d.ts
+type OlapOptions = {
+  olap?: boolean;
+  advanced?: boolean;
+};
+//#endregion
+//#region src/types.d.ts
+interface IKafkaSink {
+  send(topic: string, payload: unknown): Promise<void>;
+}
+interface IS3Sink {
+  send(bucket: string, payload: unknown): Promise<void>;
+}
+interface IOlapClient {
+  recordAction(ActionResult: ActionResult, options?: OlapOptions): void;
+  recordStep(stepResult: StepResult, options?: OlapOptions): void;
+}
+type ActionResult = {
+  status: string;
+  message: string | undefined;
+  outputs: unknown;
+};
+type StepResult = {
+  stepId: string;
+  status: string;
+};
+//#endregion
+//#region src/olap/olapClient.d.ts
+declare class OlapClient implements IOlapClient {
+  #private;
+  name: string;
+  constructor({
+    KafkaSink,
+    S3Sink,
+    logger
+  }?: {
+    KafkaSink?: IKafkaSink;
+    S3Sink?: IS3Sink;
+    logger?: ILogger;
+  });
+  recordAction(actionResult: ActionResult, options?: OlapOptions): Promise<void>;
+  recordStep(stepResult: StepResult, options?: OlapOptions): Promise<void>;
+}
+//#endregion
+export { type ActionResult, type IOlapClient, OlapClient, type OlapOptions, type StepResult };

package/dist/index.js

@@ -0,0 +1 @@
+function e(e){return new t(e)}var t=class{#logger;constructor(e){this.#logger=e}async send(e,t){let n=(()=>{try{return JSON.stringify(t)}catch{return`[Unserializable payload]`}})();this.#logger?.info({message:`[Kafka] Sent to topic ${e}: ${n}`,context:{topic:e,payload:t},category:`KafkaSink`}),await Promise.resolve()}};const n={olap:!0,advanced:!1};function r(e){return{...n,...e}}function i(e){return new a(e)}var a=class{#logger;constructor(e){this.#logger=e}async send(e,t){let n=(()=>{try{return JSON.stringify(t)}catch{return`[Unserializable payload]`}})();this.#logger?.info({message:`[S3] Sent to bucket ${e}: ${n}`,context:{bucket:e,payload:t},category:`S3Sink`}),await Promise.resolve()}},o=class{#KafkaSink;#S3Sink;#logger;name=`OlapClient`;constructor({KafkaSink:t=e(),S3Sink:n=i(),logger:r}={}){this.#KafkaSink=t,this.#S3Sink=n,this.#logger=r}async recordAction(e,t){let n=r(t);if(n.olap)try{await this.#KafkaSink?.send(`actions`,e)}catch(e){this.#logger?.warning({message:`[OlapClient] Error sending to Kafka: ${e.message}`,category:`OlapClient`,error:e})}if(n.advanced)try{await this.#S3Sink?.send(`actions`,e)}catch(e){this.#logger?.warning({message:`[OlapClient] Error sending to S3: ${e.message}`,category:`OlapClient`,error:e})}}async recordStep(e,t){let n=r(t);n.olap&&await this.#KafkaSink?.send(`steps`,e),n.advanced&&await this.#S3Sink?.send(`steps`,e)}};exports.OlapClient=o;

package/dist/index.mjs

@@ -0,0 +1 @@
+function e(e){return new t(e)}var t=class{#logger;constructor(e){this.#logger=e}async send(e,t){let n=(()=>{try{return JSON.stringify(t)}catch{return`[Unserializable payload]`}})();this.#logger?.info({message:`[Kafka] Sent to topic ${e}: ${n}`,context:{topic:e,payload:t},category:`KafkaSink`}),await Promise.resolve()}};const n={olap:!0,advanced:!1};function r(e){return{...n,...e}}function i(e){return new a(e)}var a=class{#logger;constructor(e){this.#logger=e}async send(e,t){let n=(()=>{try{return JSON.stringify(t)}catch{return`[Unserializable payload]`}})();this.#logger?.info({message:`[S3] Sent to bucket ${e}: ${n}`,context:{bucket:e,payload:t},category:`S3Sink`}),await Promise.resolve()}},o=class{#KafkaSink;#S3Sink;#logger;name=`OlapClient`;constructor({KafkaSink:t=e(),S3Sink:n=i(),logger:r}={}){this.#KafkaSink=t,this.#S3Sink=n,this.#logger=r}async recordAction(e,t){let n=r(t);if(n.olap)try{await this.#KafkaSink?.send(`actions`,e)}catch(e){this.#logger?.warning({message:`[OlapClient] Error sending to Kafka: ${e.message}`,category:`OlapClient`,error:e})}if(n.advanced)try{await this.#S3Sink?.send(`actions`,e)}catch(e){this.#logger?.warning({message:`[OlapClient] Error sending to S3: ${e.message}`,category:`OlapClient`,error:e})}}async recordStep(e,t){let n=r(t);n.olap&&await this.#KafkaSink?.send(`steps`,e),n.advanced&&await this.#S3Sink?.send(`steps`,e)}};export{o as OlapClient};

package/package.json

@@ -0,0 +1,54 @@
+{
+    "name": "@stackone/olap",
+    "version": "0.1.0",
+    "description": "",
+    "main": "dist/index.js",
+    "module": "dist/index.mjs",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist",
+        "package.json",
+        "README.md"
+    ],
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.mjs",
+            "require": "./dist/index.js"
+        },
+        "./package.json": "./package.json"
+    },
+    "scripts": {
+        "clean": "rimraf dist",
+        "prebuild": "npm run clean",
+        "build": "tsdown --env.NODE_ENV=production --minify",
+        "prebuild:dev": "npm run clean",
+        "build:dev": "tsdown --env.NODE_ENV=development",
+        "code:format": "biome format ./src ./*.mjs",
+        "code:format:fix": "biome format --write ./src ./*.mjs",
+        "code:lint": "biome lint --error-on-warnings ./src ./*.mjs",
+        "code:lint:fix": "biome lint --write ./src ./*.mjs",
+        "code:check": "biome check ./src ./*.mjs",
+        "code:check:fix": "biome check --write ./src ./*.mjs",
+        "lint": "npm run code:check",
+        "lint:fix": "npm run code:check:fix",
+        "test": "FORCE_COLOR=1 vitest run",
+        "test:watch": "FORCE_COLOR=1 vitest watch --silent",
+        "test:typecheck": "tsc --noEmit --project tsconfig.tests.json",
+        "publish-release": "npm publish --access=public"
+    },
+    "keywords": [],
+    "author": "StackOne",
+    "license": "ISC",
+    "dependencies": {},
+    "devDependencies": {
+        "tsdown": "^0.12.9"
+    },
+    "tsdown": {
+        "dts": true,
+        "format": [
+            "esm",
+            "cjs"
+        ]
+    }
+}