@fluxcontrolsdk/js-sdk 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,94 @@
+/**
+ * Context for feature flag evaluation.
+ */
+export interface Context {
+    userId?: string;
+    sessionId?: string;
+    attributes?: Record<string, any>;
+}
+/**
+ * SDK configuration options.
+ */
+export interface Config {
+    apiUrl?: string;
+    pollingIntervalMs?: number;
+    eventFlushIntervalMs?: number;
+    eventQueueSize?: number;
+    offlineMode?: boolean;
+    cacheFilePath?: string;
+    timeout?: number;
+}
+/**
+ * Evaluation result.
+ */
+export interface EvaluationResult {
+    value: any;
+    variationKey?: string;
+    reason: string;
+}
+/**
+ * Ruleset structure.
+ */
+export interface Ruleset {
+    environment: string;
+    version: string;
+    flags: Record<string, FlagConfig>;
+    segments: Record<string, SegmentConfig>;
+}
+export interface FlagConfig {
+    id: string;
+    key?: string;
+    name?: string;
+    type?: string;
+    enabled: boolean;
+    variations: Variation[];
+    defaultVariationId: string;
+    rules: TargetingRule[];
+    salt?: string;
+}
+export interface Variation {
+    id: string;
+    key?: string;
+    name?: string;
+    value: any;
+}
+export interface TargetingRule {
+    id: string;
+    description?: string;
+    priority: number;
+    conditions: Condition[];
+    variationId?: string;
+    rollout?: {
+        on: number;
+    };
+}
+export interface Condition {
+    attribute: string;
+    operator: string;
+    value?: any;
+    values?: any[];
+    segment_key?: string;
+}
+export interface PercentageRollout {
+    variations: Array<{
+        variation: Variation;
+        weight: number;
+    }>;
+}
+export interface SegmentConfig {
+    key: string;
+    name: string;
+    conditions: Condition[];
+}
+export interface Event {
+    type: 'exposure' | 'custom';
+    timestamp: string;
+    flagKey?: string;
+    variationKey?: string;
+    variationValue?: any;
+    eventName?: string;
+    context: Context;
+    properties?: Record<string, any>;
+    value?: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,OAAO;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,GAAG,CAAC;IACX,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAClC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CAC3C;AAED,MAAM,WAAW,UAAU;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,SAAS;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,GAAG,CAAC;CACd;AAED,MAAM,WAAW,aAAa;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC;CAC5B;AAED,MAAM,WAAW,SAAS;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAC9B,UAAU,EAAE,KAAK,CAAC;QACd,SAAS,EAAE,SAAS,CAAC;QACrB,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC,CAAC;CACN;AAED,MAAM,WAAW,aAAa;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,SAAS,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,KAAK;IAClB,IAAI,EAAE,UAAU,GAAG,QAAQ,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/package.json

@@ -0,0 +1,66 @@
+{
+    "name": "@fluxcontrolsdk/js-sdk",
+    "version": "0.1.0",
+    "description": "FluxControl JavaScript SDK for feature flags and experimentation",
+    "main": "dist/index.js",
+    "module": "dist/index.esm.js",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "build": "rollup -c",
+        "dev": "rollup -c -w",
+        "test": "jest",
+        "test:watch": "jest --watch",
+        "lint": "eslint src --ext .ts,.tsx",
+        "format": "prettier --write \"src/**/*.{ts,tsx}\"",
+        "prepublishOnly": "npm run build"
+    },
+    "keywords": [
+        "feature-flags",
+        "feature-toggles",
+        "ab-testing",
+        "experimentation",
+        "fluxcontrol"
+    ],
+    "author": "FluxControl Team",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/manojsu/ubiquitous-spork.git",
+        "directory": "apps/flux-control-platform/data-plane/sdks/javascript"
+    },
+    "bugs": {
+        "url": "https://github.com/manojsu/ubiquitous-spork/issues"
+    },
+    "homepage": "https://github.com/manojsu/ubiquitous-spork#readme",
+    "publishConfig": {
+        "access": "public"
+    },
+    "devDependencies": {
+        "@rollup/plugin-commonjs": "^25.0.7",
+        "@rollup/plugin-node-resolve": "^15.2.3",
+        "@rollup/plugin-typescript": "^11.1.6",
+        "@types/jest": "^29.5.11",
+        "@types/node": "^20.10.6",
+        "@typescript-eslint/eslint-plugin": "^6.17.0",
+        "@typescript-eslint/parser": "^6.17.0",
+        "eslint": "^8.56.0",
+        "jest": "^29.7.0",
+        "prettier": "^3.1.1",
+        "rollup": "^4.9.2",
+        "ts-jest": "^29.1.1",
+        "tslib": "^2.6.2",
+        "typescript": "^5.3.3"
+    },
+    "dependencies": {},
+    "peerDependencies": {
+        "react": "^16.8.0 || ^17.0.0 || ^18.0.0"
+    },
+    "peerDependenciesMeta": {
+        "react": {
+            "optional": true
+        }
+    }
+}