@featurevisor/types 0.0.3

package/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [0.0.3](https://github.com/fahad19/featurevisor/compare/v0.0.2...v0.0.3) (2023-03-05)
+
+
+### Bug Fixes
+
+* publish access ([ea5cd7c](https://github.com/fahad19/featurevisor/commit/ea5cd7cd8554e2def5fdcc1d3488598a08e99bfa))
+
+
+
+
+
+## [0.0.2](https://github.com/fahad19/featurevisor/compare/v0.0.1...v0.0.2) (2023-03-05)
+
+**Note:** Version bump only for package @featurevisor/types
+
+
+
+
+
+## 0.0.1 (2023-03-05)
+
+
+### Bug Fixes
+
+* linting ([230bfa0](https://github.com/fahad19/featurevisor/commit/230bfa0824f79181581585ccc37c2e78c5aeac42))

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 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,15 @@
+# @featurevisor/types
+
+Common TypeScript typings for Featurevisor packages.
+
+Visit [https://featurevisor.com](https://featurevisor.com) for more information.
+
+## Installation
+
+```
+$ npm install --save @featurevisor/types
+```
+
+## License
+
+MIT © [Fahad Heylaal](https://fahad19.com)

package/dist/index.js

@@ -0,0 +1,2 @@
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports.FeaturevisorTypes=t():e.FeaturevisorTypes=t()}(this,(()=>(()=>{"use strict";var e={};return(()=>{var t=e;Object.defineProperty(t,"__esModule",{value:!0})})(),e})()));
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","mappings":"CAAA,SAA2CA,EAAMC,GAC1B,iBAAZC,SAA0C,iBAAXC,OACxCA,OAAOD,QAAUD,IACQ,mBAAXG,QAAyBA,OAAOC,IAC9CD,OAAO,GAAIH,GACe,iBAAZC,QACdA,QAA2B,kBAAID,IAE/BD,EAAwB,kBAAIC,GAC7B,CATD,CASGK,MAAM,I","sources":["webpack://FeaturevisorTypes/webpack/universalModuleDefinition"],"sourcesContent":["(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"FeaturevisorTypes\"] = factory();\n\telse\n\t\troot[\"FeaturevisorTypes\"] = factory();\n})(this, () => {\nreturn "],"names":["root","factory","exports","module","define","amd","this"],"sourceRoot":""}

package/lib/index.d.ts

@@ -0,0 +1,170 @@
+export type AttributeKey = string;
+export type AttributeValue = string | number | boolean | null | undefined;
+export interface Attributes {
+    [key: AttributeKey]: AttributeValue;
+}
+export interface Attribute {
+    archived?: boolean;
+    key: AttributeKey;
+    type: AttributeValue;
+    capture?: boolean;
+}
+export type Operator = "equals" | "notEquals" | "greaterThan" | "greaterThanOrEquals" | "lessThan" | "lessThanOrEquals" | "contains" | "notContains" | "startsWith" | "endsWith" | "in" | "notIn";
+export type ConditionValue = string | number | boolean | null | undefined | string[];
+export interface PlainCondition {
+    attribute: AttributeKey;
+    operator: Operator;
+    value: ConditionValue;
+}
+export interface AndCondition {
+    and: Condition[];
+}
+export interface OrCondition {
+    or: Condition[];
+}
+export type AndOrCondition = AndCondition | OrCondition;
+export type Condition = PlainCondition | AndOrCondition;
+export type SegmentKey = string;
+export interface Segment {
+    archived?: boolean;
+    key: SegmentKey;
+    conditions: Condition | Condition[] | string;
+}
+export type PlainGroupSegment = SegmentKey;
+export interface AndGroupSegment {
+    and: GroupSegment[];
+}
+export interface OrGroupSegment {
+    or: GroupSegment[];
+}
+export type AndOrGroupSegment = AndGroupSegment | OrGroupSegment;
+export type GroupSegment = PlainGroupSegment | AndOrGroupSegment;
+export type VariationType = "boolean" | "string" | "integer" | "double";
+export type VariationValue = boolean | string | number | null | undefined;
+export type VariableKey = string;
+export type VariableType = "boolean" | "string" | "integer" | "double" | "array";
+export type VariableValue = boolean | string | number | string[] | null | undefined;
+export interface VariableOverrideSegments {
+    segments: GroupSegment | GroupSegment[];
+}
+export interface VariableOverrideConditions {
+    conditions: Condition | Condition[];
+}
+export interface VariableOverrideBase {
+    value: VariableValue;
+}
+export type VariableOverrideSegmentsOrConditions = VariableOverrideSegments | VariableOverrideConditions;
+export interface VariableOverride {
+    value: VariableValue;
+    conditions?: Condition | Condition[];
+    segments?: GroupSegment | GroupSegment[];
+}
+export interface Variable {
+    key: VariableKey;
+    value: VariableValue;
+    overrides?: VariableOverride[];
+}
+export interface Variation {
+    type: VariationType;
+    value: VariationValue;
+    weight?: Weight;
+    variables?: Variable[];
+}
+export interface VariableSchema {
+    key: VariableKey;
+    type: VariableType;
+    defaultValue: VariableValue;
+}
+export type FeatureKey = string;
+export interface Force {
+    conditions?: Condition | Condition[];
+    segments?: GroupSegment | GroupSegment[];
+    variation: VariationValue;
+    variables?: {
+        [key: string]: VariableValue;
+    };
+}
+export type BucketKey = string;
+export type BucketValue = number;
+/**
+ * Datafile-only types
+ */
+export type Percentage = number;
+export interface Allocation {
+    variation: VariationValue;
+    percentage: Percentage;
+}
+export interface Traffic {
+    key: RuleKey;
+    segments: GroupSegment | GroupSegment[] | "*";
+    percentage: Percentage;
+    allocation: Allocation[];
+}
+export type BucketBy = AttributeKey | AttributeKey[];
+export interface Feature {
+    key: FeatureKey;
+    defaultVariation: VariationValue;
+    variablesSchema?: VariableSchema[];
+    variations: Variation[];
+    bucketBy: BucketBy;
+    traffic: Traffic[];
+    force?: Force[];
+}
+export interface DatafileContent {
+    schemaVersion: string;
+    revision: string;
+    attributes: Attribute[];
+    segments: Segment[];
+    features: Feature[];
+}
+/**
+ * YAML-only type
+ */
+export type Weight = number;
+export type EnvironmentKey = string;
+export type RuleKey = string;
+export interface Rule {
+    key: RuleKey;
+    segments: GroupSegment | GroupSegment[];
+    percentage: Weight;
+}
+export interface Environment {
+    expose?: boolean;
+    rules: Rule[];
+    force?: Force[];
+}
+export interface ParsedFeature {
+    key: FeatureKey;
+    archived: boolean;
+    description: string;
+    tags: string[];
+    bucketBy?: AttributeKey | AttributeKey[];
+    defaultVariation: VariationValue;
+    variablesSchema?: VariableSchema[];
+    variations: Variation[];
+    environments: {
+        [key: EnvironmentKey]: Environment;
+    };
+}
+/**
+ * For maintaining old allocations info,
+ * allowing for gradual rollout of new allocations
+ * with consistent bucketing
+ */
+export interface ExistingFeature {
+    variations: {
+        value: VariationValue;
+        weight: Weight;
+    }[];
+    traffic: {
+        key: RuleKey;
+        percentage: Percentage;
+        allocation: Allocation[];
+    }[];
+}
+export interface ExistingFeatures {
+    [key: FeatureKey]: ExistingFeature;
+}
+export interface ExistingState {
+    features: ExistingFeatures;
+}

package/lib/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@featurevisor/types",
+  "version": "0.0.3",
+  "description": "Common Typescript types for Featurevisor",
+  "main": "dist/index.js",
+  "module": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "lint": "echo 'not linting in this package yet'",
+    "transpile": "rimraf lib && tsc --project tsconfig.esm.json",
+    "dist": "webpack --config ./webpack.config.js",
+    "build": "npm run transpile && npm run dist",
+    "test": "echo 'Nothing to test in types package'"
+  },
+  "author": {
+    "name": "Fahad Heylaal",
+    "url": "https://fahad19.com"
+  },
+  "homepage": "https://featurevisor.com",
+  "keywords": [
+    "featurevisor",
+    "feature",
+    "features",
+    "flags",
+    "feature flags",
+    "feature toggles",
+    "feature management",
+    "experimentation",
+    "experiment",
+    "experiments"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/fahad19/featurevisor.git"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "bugs": {
+    "url": "https://github.com/fahad19/featurevisor/issues"
+  },
+  "license": "MIT",
+  "gitHead": "303aca84f7c32163cb1079513d799296bd892e72"
+}

package/src/index.ts

@@ -0,0 +1,251 @@
+export type AttributeKey = string;
+
+export type AttributeValue = string | number | boolean | null | undefined;
+
+export interface Attributes {
+  [key: AttributeKey]: AttributeValue;
+}
+
+export interface Attribute {
+  archived?: boolean; // only available in YAML
+  key: AttributeKey;
+  type: AttributeValue;
+  capture?: boolean;
+}
+
+export type Operator =
+  | "equals"
+  | "notEquals"
+
+  // numeric
+  | "greaterThan"
+  | "greaterThanOrEquals"
+  | "lessThan"
+  | "lessThanOrEquals"
+
+  // string
+  | "contains"
+  | "notContains"
+  | "startsWith"
+  | "endsWith"
+
+  // array of strings
+  | "in"
+  | "notIn";
+
+export type ConditionValue = string | number | boolean | null | undefined | string[];
+
+export interface PlainCondition {
+  attribute: AttributeKey;
+  operator: Operator;
+  value: ConditionValue;
+}
+
+export interface AndCondition {
+  and: Condition[];
+}
+
+export interface OrCondition {
+  or: Condition[];
+}
+
+export type AndOrCondition = AndCondition | OrCondition;
+
+export type Condition = PlainCondition | AndOrCondition;
+
+export type SegmentKey = string;
+
+export interface Segment {
+  archived?: boolean; // only available in YAML
+  key: SegmentKey;
+  conditions: Condition | Condition[] | string; // string only when stringified for datafile
+}
+
+export type PlainGroupSegment = SegmentKey;
+
+export interface AndGroupSegment {
+  and: GroupSegment[];
+}
+
+export interface OrGroupSegment {
+  or: GroupSegment[];
+}
+
+export type AndOrGroupSegment = AndGroupSegment | OrGroupSegment;
+
+// group of segment keys with and/or conditions, or just string
+export type GroupSegment = PlainGroupSegment | AndOrGroupSegment;
+
+export type VariationType = "boolean" | "string" | "integer" | "double";
+export type VariationValue = boolean | string | number | null | undefined;
+
+export type VariableKey = string;
+export type VariableType = "boolean" | "string" | "integer" | "double" | "array";
+export type VariableValue = boolean | string | number | string[] | null | undefined;
+
+export interface VariableOverrideSegments {
+  segments: GroupSegment | GroupSegment[];
+}
+
+export interface VariableOverrideConditions {
+  conditions: Condition | Condition[];
+}
+
+export interface VariableOverrideBase {
+  value: VariableValue;
+}
+
+export type VariableOverrideSegmentsOrConditions =
+  | VariableOverrideSegments
+  | VariableOverrideConditions;
+
+// export type VariableOverride = VariableOverrideBase & VariableOverrideSegmentsOrConditions;
+
+export interface VariableOverride {
+  value: VariableValue;
+
+  // one of the below must be present in YAML
+  // @TODO: try with above commented out TypeScript later
+  conditions?: Condition | Condition[];
+  segments?: GroupSegment | GroupSegment[];
+}
+
+export interface Variable {
+  key: VariableKey;
+  value: VariableValue;
+  overrides?: VariableOverride[];
+}
+
+export interface Variation {
+  type: VariationType;
+  value: VariationValue;
+  weight?: Weight; // 0 to 100 (available from parsed YAML, but not in datafile)
+  variables?: Variable[];
+}
+
+export interface VariableSchema {
+  key: VariableKey;
+  type: VariableType;
+  defaultValue: VariableValue;
+}
+
+export type FeatureKey = string;
+
+export interface Force {
+  // one of the below must be present in YAML
+  // @TODO: make it better with TypeScript
+  conditions?: Condition | Condition[];
+  segments?: GroupSegment | GroupSegment[];
+
+  variation: VariationValue;
+  variables?: {
+    [key: string]: VariableValue;
+  };
+}
+
+export type BucketKey = string;
+export type BucketValue = number; // 0 to 100,000 (100% * 1000 to include three decimal places in same integer)
+
+/**
+ * Datafile-only types
+ */
+export type Percentage = number; // 0 to 100,000 (100% * 1000 to include three decimal places in same integer)
+
+export interface Allocation {
+  variation: VariationValue;
+  percentage: Percentage;
+}
+
+export interface Traffic {
+  key: RuleKey;
+  segments: GroupSegment | GroupSegment[] | "*";
+  percentage: Percentage;
+  allocation: Allocation[];
+}
+
+export type BucketBy = AttributeKey | AttributeKey[]; // @TODO: have first available attribute as well?
+export interface Feature {
+  key: FeatureKey;
+  // @TODO: introduce new `parent` key?
+  // @TODO: introduce `type` for distinguishing between feature flags and experiments?
+  defaultVariation: VariationValue;
+  variablesSchema?: VariableSchema[];
+  variations: Variation[];
+  bucketBy: BucketBy;
+  traffic: Traffic[];
+  force?: Force[];
+}
+
+export interface DatafileContent {
+  schemaVersion: string;
+  revision: string;
+  attributes: Attribute[];
+  segments: Segment[];
+  features: Feature[];
+}
+
+/**
+ * YAML-only type
+ */
+export type Weight = number; // 0 to 100
+
+export type EnvironmentKey = string; // ideally "production", "staging", "testing", or "development" only
+
+export type RuleKey = string;
+
+export interface Rule {
+  key: RuleKey;
+  segments: GroupSegment | GroupSegment[];
+  percentage: Weight;
+}
+
+export interface Environment {
+  expose?: boolean;
+  rules: Rule[];
+  force?: Force[];
+}
+
+export interface ParsedFeature {
+  key: FeatureKey;
+
+  archived: boolean;
+  description: string;
+  tags: string[];
+
+  bucketBy?: AttributeKey | AttributeKey[]; // @TODO: have first available attribute as well?
+
+  defaultVariation: VariationValue;
+  variablesSchema?: VariableSchema[];
+  variations: Variation[];
+
+  environments: {
+    [key: EnvironmentKey]: Environment;
+  };
+}
+
+/**
+ * For maintaining old allocations info,
+ * allowing for gradual rollout of new allocations
+ * with consistent bucketing
+ */
+export interface ExistingFeature {
+  variations: {
+    // @TODO: use Exclude with Variation?
+    value: VariationValue;
+    weight: Weight;
+  }[];
+  traffic: {
+    // @TODO: use Exclude with Traffic?
+    key: RuleKey;
+    percentage: Percentage;
+    allocation: Allocation[];
+  }[];
+}
+
+export interface ExistingFeatures {
+  [key: FeatureKey]: ExistingFeature;
+}
+
+export interface ExistingState {
+  features: ExistingFeatures;
+}

package/tsconfig.cjs.json

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

package/tsconfig.esm.json

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

package/webpack.config.js

@@ -0,0 +1,13 @@
+const path = require("path");
+
+const getWebpackConfig = require("../../tools/getWebpackConfig");
+
+const wepbackConfig = getWebpackConfig({
+  entryFilePath: path.join(__dirname, "src", "index.ts"),
+  entryKey: "index",
+  outputDirectoryPath: path.join(__dirname, "dist"),
+  outputLibrary: "FeaturevisorTypes",
+  tsConfigFilePath: path.join(__dirname, "tsconfig.cjs.json"),
+});
+
+module.exports = wepbackConfig;