@eventvisor/types 0.0.2

package/.eslintcache

@@ -0,0 +1 @@
+[{"/Users/fahad/Repos/featurevisor/packages/types/src/index.ts":"1"},{"size":10214,"mtime":1706909683928,"results":"2","hashOfConfig":"3"},{"filePath":"4","messages":"5","suppressedMessages":"6","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"i57tk5","/Users/fahad/Repos/featurevisor/packages/types/src/index.ts",[],[]]

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Fahad Heylaal (https://fahad19.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,9 @@
+# @eventvisor/types
+
+> Common TypeScript typings for Eventvisor packages
+
+Visit [https://eventvisor.org](https://eventvisor.org) for more information.
+
+## License
+
+MIT © [Fahad Heylaal](https://fahad19.com)

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@eventvisor/types",
+  "version": "0.0.2",
+  "description": "Common Typescript types for Eventvisor",
+  "main": "src/index.js",
+  "module": "src/index.js",
+  "types": "src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.js",
+      "require": "./src/index.js"
+    }
+  },
+  "scripts": {
+    "transpile": "echo 'Nothing to transpile'",
+    "dist": "echo 'Nothing to dist'",
+    "build": "tsc ./src/index.d.ts",
+    "test": "echo 'Nothing to test in types package'"
+  },
+  "author": {
+    "name": "Fahad Heylaal",
+    "url": "https://fahad19.com"
+  },
+  "homepage": "https://eventvisor.org",
+  "keywords": [],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/eventvisor/eventvisor.git"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "bugs": {
+    "url": "https://github.com/eventvisor/eventvisor/issues"
+  },
+  "license": "MIT",
+  "gitHead": "373d5c00cb6fa0d6f4baaa05a10e57e505474847"
+}

package/src/index.d.ts

@@ -0,0 +1,435 @@
+/**
+ * JSON Schema (subset)
+ */
+export type PrimitiveValue = string | number | boolean | null | undefined;
+export type ObjectValue = { [key: string]: Value };
+export type Value = PrimitiveValue | ObjectValue | Value[];
+
+export interface JSONSchema {
+  // Basic metadata
+  description?: string;
+
+  // General validation keywords
+  type?: "object" | "array" | "string" | "number" | "integer" | "boolean" | "null";
+  enum?: Value[];
+  const?: Value;
+
+  // Numeric validation keywords
+  maximum?: number;
+  minimum?: number;
+
+  // String validation keywords
+  maxLength?: number;
+  minLength?: number;
+  pattern?: string;
+
+  // Array validation keywords
+  items?: JSONSchema | JSONSchema[];
+  maxItems?: number;
+  minItems?: number;
+  uniqueItems?: boolean;
+
+  // Object validation keywords
+  required?: string[];
+  properties?: { [key: string]: JSONSchema };
+
+  // Annotations
+  default?: Value;
+  examples?: Value[];
+}
+
+/**
+ * Common aliases
+ */
+export type Percentage = number; // 0 to 100 (up to 3 decimal places)
+
+export type Tag = string;
+
+export type Inputs = Record<string, Value>;
+
+/**
+ * Persist
+ */
+export type StorageName = string;
+
+export type SimplePersist = StorageName;
+
+export interface ComplexPersist {
+  storage: StorageName;
+  conditions?: Condition | Condition[];
+}
+
+export type Persist = SimplePersist | ComplexPersist | Persist[];
+
+/**
+ * Source
+ */
+export type Source = string;
+
+export type SourceBase =
+  // longer dotted path
+  | { source: Source | Source[] }
+
+  // more specific sources
+  | { attribute: Source | Source[] } // can be dot-separated path
+  | { state: Source | Source[] } // internally in Effect's own transforms
+  | { effect: Source | Source[] }
+  | { payload: Source | Source[] } // @TODO: or more specific eventValue and attributeValue?
+  | { lookup: Source | Source[] };
+
+/**
+ * Conditions
+ */
+export type ConditionOperator =
+  | "equals"
+  | "notEquals"
+  | "exists"
+  | "notExists"
+
+  // numeric
+  | "greaterThan"
+  | "greaterThanOrEquals"
+  | "lessThan"
+  | "lessThanOrEquals"
+
+  // string
+  | "contains"
+  | "notContains"
+  | "startsWith"
+  | "endsWith"
+
+  // semver (string)
+  | "semverEquals"
+  | "semverNotEquals"
+  | "semverGreaterThan"
+  | "semverGreaterThanOrEquals"
+  | "semverLessThan"
+  | "semverLessThanOrEquals"
+
+  // date comparisons
+  | "before"
+  | "after"
+
+  // array of strings
+  | "includes"
+  | "notIncludes"
+
+  // regex
+  | "matches"
+  | "notMatches"
+
+  // array of strings
+  | "in"
+  | "notIn";
+
+export type PlainCondition = SourceBase & {
+  operator: ConditionOperator;
+  value?: Value;
+  regexFlags?: string;
+};
+
+export interface AndCondition {
+  and: Condition[];
+}
+
+export interface OrCondition {
+  or: Condition[];
+}
+
+export interface NotCondition {
+  not: Condition[];
+}
+
+export type Condition = PlainCondition | AndCondition | OrCondition | NotCondition | string;
+
+/**
+ * Sample
+ */
+export type SampleBySingle = Source | SourceBase;
+export type SampleByMultiple = SampleBySingle[];
+export interface SampleByOr {
+  or: SampleByMultiple;
+}
+export type SampleBy = SampleBySingle | SampleByMultiple | SampleByOr;
+
+export type SampleRange = [Percentage, Percentage];
+
+export interface Sample {
+  by: SampleBy;
+  conditions?: Condition | Condition[];
+
+  // either of them is required
+  percentage?: Percentage;
+  range?: SampleRange;
+}
+
+/**
+ * Transforms
+ */
+export type TransformType =
+  // mathematical
+  | "increment"
+  | "decrement"
+
+  // manipulations
+  | "concat" // @TODO: rename to `join`?
+  | "remove"
+  | "rename"
+  | "set"
+  | "trim"
+
+  // to
+  | "toInteger"
+  | "toDouble"
+  | "toString"
+  | "toBoolean"
+
+  // @TODO: consider later
+  // | "uppercase"
+  // | "lowercase"
+
+  // complex
+  | "spread"
+  | "append";
+
+export type Transform = Partial<SourceBase> & {
+  type: TransformType;
+  target?: string;
+  targetMap?: Record<string, string> | Record<string, string>[];
+
+  value?: Value;
+
+  // additional params for certain transform types
+  separator?: string;
+  [key: string]: any;
+};
+
+/**
+ * Attribute
+ */
+export type Attribute = JSONSchema & {
+  archived?: boolean;
+  deprecated?: boolean;
+  description?: string;
+  tags?: Tag[];
+
+  transforms?: Transform[];
+  persist?: Persist;
+};
+
+export type AttributeName = string;
+
+/**
+ * Event
+ */
+export type PlainDestinationOverride = boolean;
+
+export interface ComplexDestinationOverride {
+  conditions?: Condition | Condition[];
+  sample?: Sample | Sample[];
+  transforms?: Transform[];
+}
+
+export type DestinationOverride = PlainDestinationOverride | ComplexDestinationOverride;
+
+export type EventLevel = "fatal" | "error" | "warning" | "log" | "info" | "debug";
+
+export type Event = JSONSchema & {
+  archived?: boolean;
+  deprecated?: boolean;
+  description?: string;
+  tags?: Tag[];
+
+  // @TODO: meta
+
+  level?: EventLevel;
+  requiredAttributes?: string[];
+  conditions?: Condition | Condition[];
+  sample?: Sample | Sample[];
+  transforms?: Transform[];
+  destinations?: {
+    [key: string]: DestinationOverride;
+  };
+};
+
+export type EventName = string;
+
+/**
+ * Destination
+ */
+export interface Destination {
+  archived?: boolean;
+  description?: string;
+  tags?: Tag[];
+
+  transport: string;
+  conditions?: Condition | Condition[];
+  sample?: Sample | Sample[];
+  transforms?: Transform[];
+}
+
+export type DestinationName = string;
+
+/**
+ * Effect
+ */
+export type EffectOnType = "event_tracked" | "attribute_set";
+interface EffectOnRecord {
+  event_tracked?: EventName[];
+  attribute_set?: AttributeName[];
+}
+export type EffectOn = EffectOnType[] | EffectOnRecord;
+
+export interface Step {
+  description?: string;
+  handler?: string;
+  conditions?: Condition | Condition[];
+  params?: Record<string, any>;
+  transforms?: Transform[];
+  continueOnError?: boolean;
+}
+
+export interface Effect {
+  archived?: boolean;
+  description?: string;
+  tags?: Tag[];
+
+  on?: EffectOn;
+  state?: Value;
+  conditions?: Condition | Condition[];
+  steps?: Step[];
+  persist?: Persist;
+}
+
+export type EffectName = string;
+
+/**
+ * Datafile
+ */
+export interface DatafileContent {
+  schemaVersion: string;
+  revision: string;
+  attributes: {
+    [key: AttributeName]: Attribute;
+  };
+  events: {
+    [key: EventName]: Event;
+  };
+  destinations: {
+    [key: DestinationName]: Destination;
+  };
+  effects: {
+    [key: EffectName]: Effect;
+  };
+}
+
+/**
+ * Others
+ */
+export type EntityType = "attribute" | "event" | "destination" | "state" | "effect" | "test";
+
+/**
+ * Test
+ */
+export interface Action {
+  type: "track" | "setAttribute" | "removeAttribute";
+  name: EventName | AttributeName;
+  value?: Value;
+}
+
+export type WithLookups = Record<string, Value>; // key is "<moduleName>.<additionalKey>"
+
+// Attribute
+export interface AttributeAssertion {
+  description?: string;
+  setAttribute?: Value;
+  withLookups?: {
+    [key: string]: Value;
+  };
+
+  expectedToBeValid?: boolean;
+  expectedToBeSet?: boolean;
+  expectedAttribute?: Value;
+}
+
+export interface AttributeTest {
+  attribute: AttributeName;
+  assertions: AttributeAssertion[];
+}
+
+// Event
+export interface EventAssertion {
+  description?: string;
+  withAttributes?: {
+    [key: AttributeName]: Value;
+  };
+  withLookups?: WithLookups;
+  at?: Percentage; // @TODO: implement
+  track?: Value;
+  actions?: Action[];
+
+  expectedToBeValid?: boolean;
+  expectedToContinue?: boolean;
+  expectedEvent?: Value;
+  expectedDestinations?: DestinationName[];
+  expectedDestinationsByTag?: Record<Tag, DestinationName[]>;
+}
+
+export interface EventTest {
+  event: EventName;
+  assertions: EventAssertion[];
+}
+
+// Effect
+export interface EffectAssertion {
+  description?: string;
+  withAttributes?: {
+    [key: AttributeName]: Value;
+  };
+  withLookups?: WithLookups;
+
+  actions?: Action[];
+
+  expectedState?: Value;
+  expectedToBeHandled?: boolean;
+  expectedToBeCalled?: {
+    handler: string;
+    times?: number;
+  }[];
+}
+
+export interface EffectTest {
+  effect: EffectName;
+  assertions: EffectAssertion[];
+}
+
+// Destination
+export interface DestinationAssertion {
+  description?: string;
+  withAttributes?: {
+    [key: AttributeName]: Value;
+  };
+  withLookups?: {
+    [key: string]: Value;
+  };
+  actions?: Action[];
+  assertAfter?: number; // in ms
+
+  expectedToBeTransported?: boolean;
+  expectedBody?: Value;
+
+  // @TODO: batch
+  expectedBodies?: Value[];
+  expectedToBeBatched?: boolean;
+  expectedBatchedCount?: number;
+}
+
+export interface DestinationTest {
+  destination: DestinationName;
+  assertions: DestinationAssertion[];
+}
+
+// Combined
+export type Test = EventTest | AttributeTest | EffectTest | DestinationTest;
+
+export type TestName = string;

package/src/index.js

@@ -0,0 +1 @@
+// empty

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.esm.json",
+  "compilerOptions": {
+    "outDir": "./lib"
+  },
+  "include": ["./src/**/*.ts", "./src/**/*.d.ts"]
+}