@contractspec/lib.feature-flags 1.44.0

package/dist/events.d.ts

@@ -0,0 +1,628 @@
+import { FieldType } from "./schema/src/FieldType.js";
+import { SchemaModel } from "./schema/src/SchemaModel.js";
+import "./schema/src/index.js";
+import { EventSpec } from "./contracts/src/events.js";
+import "./contracts/src/index.js";
+
+//#region src/events.d.ts
+/**
+ * Emitted when a feature flag is created.
+ */
+declare const FlagCreatedEvent: EventSpec<SchemaModel<{
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  status: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  orgId: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  createdBy: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  createdAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>>;
+/**
+ * Emitted when a feature flag is updated.
+ */
+declare const FlagUpdatedEvent: EventSpec<SchemaModel<{
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  changes: {
+    type: FieldType<unknown, unknown>;
+    isOptional: false;
+  };
+  updatedBy: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  updatedAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>>;
+/**
+ * Emitted when a feature flag is deleted.
+ */
+declare const FlagDeletedEvent: EventSpec<SchemaModel<{
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  deletedBy: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  deletedAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>>;
+/**
+ * Emitted when a feature flag status is toggled.
+ */
+declare const FlagToggledEvent: EventSpec<SchemaModel<{
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  previousStatus: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  newStatus: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  toggledBy: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  toggledAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>>;
+/**
+ * Emitted when a targeting rule is created.
+ */
+declare const RuleCreatedEvent: EventSpec<SchemaModel<{
+  ruleId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  flagKey: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  attribute: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  operator: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  createdAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>>;
+/**
+ * Emitted when a targeting rule is deleted.
+ */
+declare const RuleDeletedEvent: EventSpec<SchemaModel<{
+  ruleId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  flagKey: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  deletedAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>>;
+/**
+ * Emitted when an experiment is created.
+ */
+declare const ExperimentCreatedEvent: EventSpec<SchemaModel<{
+  experimentId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  name: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  variants: {
+    type: FieldType<unknown, unknown>;
+    isOptional: false;
+  };
+  createdBy: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  createdAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>>;
+/**
+ * Emitted when an experiment starts.
+ */
+declare const ExperimentStartedEvent: EventSpec<SchemaModel<{
+  experimentId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  variants: {
+    type: FieldType<unknown, unknown>;
+    isOptional: false;
+  };
+  audiencePercentage: {
+    type: FieldType<number, number>;
+    isOptional: false;
+  };
+  startedBy: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  startedAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>>;
+/**
+ * Emitted when an experiment stops.
+ */
+declare const ExperimentStoppedEvent: EventSpec<SchemaModel<{
+  experimentId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  key: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  reason: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  winningVariant: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  stoppedBy: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  stoppedAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>>;
+/**
+ * Emitted when a flag is evaluated (for analytics).
+ */
+declare const FlagEvaluatedEvent: EventSpec<SchemaModel<{
+  flagId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  flagKey: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  subjectType: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  subjectId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  result: {
+    type: FieldType<boolean, boolean>;
+    isOptional: false;
+  };
+  variant: {
+    type: FieldType<string, string>;
+    isOptional: true;
+  };
+  reason: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  evaluatedAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>>;
+/**
+ * Emitted when a subject is assigned to an experiment variant.
+ */
+declare const VariantAssignedEvent: EventSpec<SchemaModel<{
+  experimentId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  experimentKey: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  subjectType: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  subjectId: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  variant: {
+    type: FieldType<string, string>;
+    isOptional: false;
+  };
+  bucket: {
+    type: FieldType<number, number>;
+    isOptional: false;
+  };
+  assignedAt: {
+    type: FieldType<Date, string>;
+    isOptional: false;
+  };
+}>>;
+/**
+ * All feature flag events.
+ */
+declare const FeatureFlagEvents: {
+  FlagCreatedEvent: EventSpec<SchemaModel<{
+    flagId: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    key: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    name: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    status: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    orgId: {
+      type: FieldType<string, string>;
+      isOptional: true;
+    };
+    createdBy: {
+      type: FieldType<string, string>;
+      isOptional: true;
+    };
+    createdAt: {
+      type: FieldType<Date, string>;
+      isOptional: false;
+    };
+  }>>;
+  FlagUpdatedEvent: EventSpec<SchemaModel<{
+    flagId: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    key: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    changes: {
+      type: FieldType<unknown, unknown>;
+      isOptional: false;
+    };
+    updatedBy: {
+      type: FieldType<string, string>;
+      isOptional: true;
+    };
+    updatedAt: {
+      type: FieldType<Date, string>;
+      isOptional: false;
+    };
+  }>>;
+  FlagDeletedEvent: EventSpec<SchemaModel<{
+    flagId: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    key: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    deletedBy: {
+      type: FieldType<string, string>;
+      isOptional: true;
+    };
+    deletedAt: {
+      type: FieldType<Date, string>;
+      isOptional: false;
+    };
+  }>>;
+  FlagToggledEvent: EventSpec<SchemaModel<{
+    flagId: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    key: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    previousStatus: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    newStatus: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    toggledBy: {
+      type: FieldType<string, string>;
+      isOptional: true;
+    };
+    toggledAt: {
+      type: FieldType<Date, string>;
+      isOptional: false;
+    };
+  }>>;
+  RuleCreatedEvent: EventSpec<SchemaModel<{
+    ruleId: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    flagId: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    flagKey: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    attribute: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    operator: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    createdAt: {
+      type: FieldType<Date, string>;
+      isOptional: false;
+    };
+  }>>;
+  RuleDeletedEvent: EventSpec<SchemaModel<{
+    ruleId: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    flagId: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    flagKey: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    deletedAt: {
+      type: FieldType<Date, string>;
+      isOptional: false;
+    };
+  }>>;
+  ExperimentCreatedEvent: EventSpec<SchemaModel<{
+    experimentId: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    key: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    name: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    flagId: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    variants: {
+      type: FieldType<unknown, unknown>;
+      isOptional: false;
+    };
+    createdBy: {
+      type: FieldType<string, string>;
+      isOptional: true;
+    };
+    createdAt: {
+      type: FieldType<Date, string>;
+      isOptional: false;
+    };
+  }>>;
+  ExperimentStartedEvent: EventSpec<SchemaModel<{
+    experimentId: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    key: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    flagId: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    variants: {
+      type: FieldType<unknown, unknown>;
+      isOptional: false;
+    };
+    audiencePercentage: {
+      type: FieldType<number, number>;
+      isOptional: false;
+    };
+    startedBy: {
+      type: FieldType<string, string>;
+      isOptional: true;
+    };
+    startedAt: {
+      type: FieldType<Date, string>;
+      isOptional: false;
+    };
+  }>>;
+  ExperimentStoppedEvent: EventSpec<SchemaModel<{
+    experimentId: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    key: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    reason: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    winningVariant: {
+      type: FieldType<string, string>;
+      isOptional: true;
+    };
+    stoppedBy: {
+      type: FieldType<string, string>;
+      isOptional: true;
+    };
+    stoppedAt: {
+      type: FieldType<Date, string>;
+      isOptional: false;
+    };
+  }>>;
+  FlagEvaluatedEvent: EventSpec<SchemaModel<{
+    flagId: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    flagKey: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    subjectType: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    subjectId: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    result: {
+      type: FieldType<boolean, boolean>;
+      isOptional: false;
+    };
+    variant: {
+      type: FieldType<string, string>;
+      isOptional: true;
+    };
+    reason: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    evaluatedAt: {
+      type: FieldType<Date, string>;
+      isOptional: false;
+    };
+  }>>;
+  VariantAssignedEvent: EventSpec<SchemaModel<{
+    experimentId: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    experimentKey: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    subjectType: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    subjectId: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    variant: {
+      type: FieldType<string, string>;
+      isOptional: false;
+    };
+    bucket: {
+      type: FieldType<number, number>;
+      isOptional: false;
+    };
+    assignedAt: {
+      type: FieldType<Date, string>;
+      isOptional: false;
+    };
+  }>>;
+};
+//#endregion
+export { ExperimentCreatedEvent, ExperimentStartedEvent, ExperimentStoppedEvent, FeatureFlagEvents, FlagCreatedEvent, FlagDeletedEvent, FlagEvaluatedEvent, FlagToggledEvent, FlagUpdatedEvent, RuleCreatedEvent, RuleDeletedEvent, VariantAssignedEvent };
+//# sourceMappingURL=events.d.ts.map

package/dist/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","names":[],"sources":["../src/events.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;cAsKa,kBAAgB;;UAU3B;;EAVW,CAAA;EAUX,GAAA,EAAA;;;;;;;;;IAV2B,IAAA,WAAA,CAAA,MAAA,EAAA,MAAA,CAAA;IAAA,UAAA,EAAA,KAAA;EAehB,CAAA;EAUX,KAAA,EAAA;;;;;;;EAV2B,CAAA;EAAA,SAAA,EAAA;IAehB,IAAA,WAUX,KAAA,EAAA,MAAA,CAAA;IAAA,UAAA,EAAA,KAAA;;;;;;AAV2B,cAfhB,gBAegB,EAfA,SAeA,YAAA,CAAA;EAAA,MAAA,EAAA;IAehB,IAAA,EApBX,SA8BA,CAAA,MAAA,EAAA,MAAA,CAAA;IAAA,UAAA,EAAA,KAAA;;;;;;;;IAV2B,UAAA,EAAA,KAAA;EAAA,CAAA;EAehB,SAAA,EAAA;IAUX,IAAA,WAAA,CAAA,MAAA,EAAA,MAAA,CAAA;;;;;;;;;;AAKF;AAUE,cAvDW,gBAuDX,EAvD2B,SAuD3B,YAAA,CAAA;;UA7CA;;;;IAmC2B,IAAA,WAAA,CAAA,MAAA,EAAA,MAAA,CAAA;IAAA,UAAA,EAAA,KAAA;EAehB,CAAA;EAUX,SAAA,EAAA;;;;;;;;;;;AAKF;AAUE,cAtEW,gBAsEX,EAtE2B,SAsE3B,YAAA,CAAA;;UA5DA;;;;;;;EAkDiC,cAAA,EAAA;IAAA,IAAA,WAAA,CAAA,MAAA,EAAA,MAAA,CAAA;IAetB,UAAA,EAAA,KAAA;EAUX,CAAA;;;;;;;;EAViC,CAAA;EAAA,SAAA,EAAA;IAetB,IAAA,WAUX,KAAA,EAAA,MAAA,CAAA;IAAA,UAAA,EAAA,KAAA;;;;;;cArFW,kBAAgB;;UAU3B;;EAiE6B,CAAA;EAAA,MAAA,EAAA;IAelB,IAAA,WAUX,CAAA,MAAA,EAAA,MAAA,CAAA;IAAA,UAAA,EAAA,KAAA;;;;;;;;;EAV+B,CAAA;EAAA,QAAA,EAAA;IAepB,IAAA,WAYZ,CAAA,MAAA,EAAA,MAAA,CAAA;IAAA,UAAA,EAAA,KAAA;;;;;;;;;;cAtGY,kBAAgB;;UAU3B;;;;;;;;;;;;;;;;;;;cAKW,wBAAsB;;UAUjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAKW,wBAAsB;;UAUjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAKW,wBAAsB;;UAUjC;;;;;;;;;;;;;;;;;;;;;;;;;;;cAKW,oBAAkB;;UAU7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAKW,sBAAoB;;UAU/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAKW;;;YAYZ"}