@octaviaflow/telemetry-config-schema 1.1.1 → 1.1.2

package/dist/main/config-schema.d.ts

@@ -1,50 +1,175 @@
+/**
+ * Copyright OctaviaFlow
+ * Author: Vishal Kumar
+ * Created: 11/November/2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * Configuration outline for metrics collection using octaviaflow telemetry.
+ */
 export interface ConfigSchema {
+    /**
+     * Current schema version.
+     */
     version: 1;
+    /**
+     * Unique identifier assigned on a per-project basis.
+     */
     projectId: string;
+    /**
+     * Telemetry configuration for OctaviaFlow Telemetry.
+     */
     name?: string;
+    /**
+     * Storage configuration for telemetry data.
+     */
     storage: StorageConfig;
+    /**
+     * The keys under `collect` represent the various types of data that Telemetry is capable of collecting (i.e. `scopes`).
+     */
     collect: CollectConfig;
 }
+/**
+ * Storage configuration options
+ */
 export interface StorageConfig {
+    /**
+     * Storage type - currently supports 'file' with future MongoDB support
+     */
     type: 'file' | 'mongodb';
+    /**
+     * Configuration specific to file storage
+     */
     file?: FileStorageConfig;
+    /**
+     * Configuration specific to MongoDB storage (future use)
+     */
     mongodb?: MongoDBStorageConfig;
 }
+/**
+ * File storage configuration
+ */
 export interface FileStorageConfig {
+    /**
+     * Directory path where telemetry files will be stored
+     */
     directory: string;
+    /**
+     * File name pattern for telemetry logs
+     * @default "octaviaflow-telemetry-{timestamp}.json"
+     */
     fileNamePattern?: string;
+    /**
+     * Maximum file size in MB before rotating to a new file
+     * @default 10
+     */
     maxFileSizeMB?: number;
+    /**
+     * Whether to compress old files
+     * @default false
+     */
     compress?: boolean;
 }
+/**
+ * MongoDB storage configuration (for future use)
+ */
 export interface MongoDBStorageConfig {
+    /**
+     * MongoDB connection string
+     */
     connectionString: string;
+    /**
+     * Database name
+     */
     database: string;
+    /**
+     * Collection name for telemetry data
+     */
     collection: string;
 }
+/**
+ * Collection configuration
+ */
 export interface CollectConfig {
+    /**
+     * Configuration for collecting telemetry data from an npm environment.
+     */
     npm?: NpmScopeConfig;
+    /**
+     * Configuration for collecting telemetry data from JSX files.
+     */
     jsx?: JsxScopeConfig;
+    /**
+     * Configuration for collecting telemetry data for tokens and functions.
+     */
     js?: JsScopeConfig;
+    /**
+     * Configuration for collecting telemetry data from HTML and JSX files.
+     */
     wc?: WcScopeConfig;
 }
+/**
+ * NPM scope configuration
+ */
 export interface NpmScopeConfig {
+    /**
+     * Enable telemetry data collection for NPM dependencies.
+     */
     dependencies?: null;
 }
+/**
+ * JSX scope configuration
+ */
 export interface JsxScopeConfig {
+    /**
+     * Enable telemetry data collection for JSX elements.
+     */
     elements?: ElementsConfig;
 }
+/**
+ * JavaScript scope configuration
+ */
 export interface JsScopeConfig {
+    /**
+     * Enable telemetry data collection for JS tokens.
+     */
     tokens?: null;
+    /**
+     * Enable telemetry data collection for JS functions.
+     */
     functions?: FunctionsConfig;
 }
+/**
+ * Web Components scope configuration
+ */
 export interface WcScopeConfig {
+    /**
+     * Enable telemetry data collection for Web Component elements.
+     */
     elements?: ElementsConfig;
 }
+/**
+ * Elements configuration for JSX and WC scopes
+ */
 export interface ElementsConfig {
+    /**
+     * Enable telemetry data collection for specific attribute names.
+     */
     allowedAttributeNames?: string[];
+    /**
+     * Enable telemetry data collection for specific attribute string values.
+     */
     allowedAttributeStringValues?: string[];
 }
+/**
+ * Functions configuration for JS scope
+ */
 export interface FunctionsConfig {
+    /**
+     * Enable telemetry data collection for specific string function argument values.
+     */
     allowedArgumentStringValues?: string[];
 }
 //# sourceMappingURL=config-schema.d.ts.map

package/dist/main/config-schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config-schema.d.ts","sourceRoot":"","sources":["../../src/main/config-schema.ts"],"names":[],"mappings":"AAmBA,MAAM,WAAW,YAAY;IAI3B,OAAO,EAAE,CAAC,CAAC;IAKX,SAAS,EAAE,MAAM,CAAC;IAKlB,IAAI,CAAC,EAAE,MAAM,CAAC;IAKd,OAAO,EAAE,aAAa,CAAC;IAKvB,OAAO,EAAE,aAAa,CAAC;CACxB;AAKD,MAAM,WAAW,aAAa;IAI5B,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAKzB,IAAI,CAAC,EAAE,iBAAiB,CAAC;IAKzB,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC;AAKD,MAAM,WAAW,iBAAiB;IAIhC,SAAS,EAAE,MAAM,CAAC;IAMlB,eAAe,CAAC,EAAE,MAAM,CAAC;IAMzB,aAAa,CAAC,EAAE,MAAM,CAAC;IAMvB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAKD,MAAM,WAAW,oBAAoB;IAInC,gBAAgB,EAAE,MAAM,CAAC;IAKzB,QAAQ,EAAE,MAAM,CAAC;IAKjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAKD,MAAM,WAAW,aAAa;IAI5B,GAAG,CAAC,EAAE,cAAc,CAAC;IAKrB,GAAG,CAAC,EAAE,cAAc,CAAC;IAKrB,EAAE,CAAC,EAAE,aAAa,CAAC;IAKnB,EAAE,CAAC,EAAE,aAAa,CAAC;CACpB;AAKD,MAAM,WAAW,cAAc;IAI7B,YAAY,CAAC,EAAE,IAAI,CAAC;CACrB;AAKD,MAAM,WAAW,cAAc;IAI7B,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAKD,MAAM,WAAW,aAAa;IAI5B,MAAM,CAAC,EAAE,IAAI,CAAC;IAKd,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B;AAKD,MAAM,WAAW,aAAa;IAI5B,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAKD,MAAM,WAAW,cAAc;IAI7B,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAKjC,4BAA4B,CAAC,EAAE,MAAM,EAAE,CAAC;CACzC;AAKD,MAAM,WAAW,eAAe;IAI9B,2BAA2B,CAAC,EAAE,MAAM,EAAE,CAAC;CACxC"}
+{"version":3,"file":"config-schema.d.ts","sourceRoot":"","sources":["../../src/main/config-schema.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AASH;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,aAAa,CAAC;IAEvB;;OAEG;IACH,OAAO,EAAE,aAAa,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,GAAG,CAAC,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,GAAG,CAAC,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAC;IAEnB;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;OAEG;IACH,4BAA4B,CAAC,EAAE,MAAM,EAAE,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,EAAE,CAAC;CACxC"}

package/dist/main/config-schema.js

@@ -1,2 +1,10 @@
+/**
+ * Copyright OctaviaFlow
+ * Author: Vishal Kumar
+ * Created: 11/November/2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
 export {};
 //# sourceMappingURL=config-schema.js.map

package/dist/main/config-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"config-schema.js","sourceRoot":"","sources":["../../src/main/config-schema.ts"],"names":[],"mappings":""}
+{"version":3,"file":"config-schema.js","sourceRoot":"","sources":["../../src/main/config-schema.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@octaviaflow/telemetry-config-schema",
   "description": "Telemetry config schema for OctaviaFlow Telemetry",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "license": "Apache-2.0",
   "author": "OctaviaFlow",
   "keywords": [
@@ -15,14 +15,12 @@
   "publishConfig": {
     "access": "public"
   },
-  "homepage": "https://github.com/OctaviaFlow/OctaviaFlow-Design-System#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/OctaviaFlow/OctaviaFlow-Design-System.git"
-  },
-  "bugs": {
-    "url": "https://github.com/OctaviaFlow/OctaviaFlow-Design-System/issues"
+    "url": "https://github.com/octaviaflow-design-system.git",
+    "directory": "packages/telemetry-config-schema"
   },
+  "bugs": "https://github.com/octaviaflow-design-system/issues",
   "type": "module",
   "exports": {
     ".": {
@@ -40,8 +38,8 @@
     "clean": "rimraf dist",
     "lint": "eslint src --ext .ts,.js",
     "lint:fix": "eslint src --ext .ts,.js --fix",
-    "format": "prettier --write src/**/*.{ts,js,json}",
-    "format:check": "prettier --check src/**/*.{ts,js,json}",
+    "format": "prettier --write 'src/**/*.ts'",
+    "format:check": "prettier --check 'src/**/*.ts'",
     "test": "jest",
     "test:watch": "jest --watch",
     "prepare": "husky"
@@ -49,7 +47,10 @@
   "devDependencies": {
     "@commitlint/cli": "^19.8.1",
     "@commitlint/config-conventional": "^19.8.1",
+    "@eslint/js": "^9.39.1",
     "@types/node": "^20.19.8",
+    "@typescript-eslint/eslint-plugin": "^8.26.1",
+    "@typescript-eslint/parser": "^8.26.1",
     "eslint": "^9.39.1",
     "eslint-config-octaviaflow": "^2.0.0",
     "husky": "^9.1.7",