@datadog/flagging-core 0.1.0-alpha.7 → 0.1.0-alpha.8

package/cjs/configuration/configuration.d.ts

@@ -0,0 +1,46 @@
+import type { EvaluationContext, FlagValueType, JsonValue, ResolutionReason } from '@openfeature/web-sdk';
+/**
+ * Internal configuration for DatadogProvider.
+ */
+export type Configuration = {
+    /** @internal */
+    precomputed?: PrecomputedConfiguration;
+};
+/** @internal */
+export type PrecomputedConfiguration = {
+    response: PrecomputedConfigurationResponse;
+    context?: EvaluationContext;
+    fetchedAt?: UnixTimestamp;
+};
+/** @internal */
+export type FlagTypeToValue<T extends FlagValueType> = {
+    ['boolean']: boolean;
+    ['string']: string;
+    ['number']: number;
+    ['object']: JsonValue;
+}[T];
+/** @internal
+ * Timestamp in milliseconds since Unix Epoch.
+ */
+export type UnixTimestamp = number;
+/** @internal */
+export type PrecomputedConfigurationResponse = {
+    data: {
+        attributes: {
+            /** When configuration was generated. */
+            createdAt: number;
+            flags: Record<string, PrecomputedFlag>;
+        };
+    };
+};
+/** @internal */
+export type PrecomputedFlag<T extends FlagValueType = FlagValueType> = {
+    allocationKey: string;
+    variationKey: string;
+    variationType: T;
+    variationValue: FlagTypeToValue<T>;
+    reason: ResolutionReason;
+    doLog: boolean;
+    extraLogging: Record<string, unknown>;
+};
+//# sourceMappingURL=configuration.d.ts.map

package/cjs/configuration/configuration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configuration.d.ts","sourceRoot":"","sources":["../../src/configuration/configuration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,aAAa,EACb,SAAS,EACT,gBAAgB,EACjB,MAAM,sBAAsB,CAAA;AAE7B;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,gBAAgB;IAChB,WAAW,CAAC,EAAE,wBAAwB,CAAA;CACvC,CAAA;AAED,gBAAgB;AAChB,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,gCAAgC,CAAA;IAC1C,OAAO,CAAC,EAAE,iBAAiB,CAAA;IAC3B,SAAS,CAAC,EAAE,aAAa,CAAA;CAC1B,CAAA;AAGD,gBAAgB;AAChB,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,aAAa,IAAI;IACrD,CAAC,SAAS,CAAC,EAAE,OAAO,CAAA;IACpB,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAClB,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAClB,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAA;CACtB,CAAC,CAAC,CAAC,CAAA;AAEJ;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAElC,gBAAgB;AAChB,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE;QACJ,UAAU,EAAE;YACV,wCAAwC;YACxC,SAAS,EAAE,MAAM,CAAA;YACjB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;SACvC,CAAA;KACF,CAAA;CACF,CAAA;AAED,gBAAgB;AAChB,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa,IAAI;IACrE,aAAa,EAAE,MAAM,CAAA;IACrB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,CAAC,CAAA;IAChB,cAAc,EAAE,eAAe,CAAC,CAAC,CAAC,CAAA;IAClC,MAAM,EAAE,gBAAgB,CAAA;IACxB,KAAK,EAAE,OAAO,CAAA;IACd,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACtC,CAAA"}

package/cjs/configuration/configuration.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=configuration.js.map

package/cjs/configuration/configuration.js.map

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

package/cjs/configuration/index.d.ts

@@ -0,0 +1,3 @@
+export * from './configuration';
+export * from './wire';
+//# sourceMappingURL=index.d.ts.map

package/cjs/configuration/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/configuration/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,QAAQ,CAAA"}

package/cjs/configuration/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./configuration"), exports);
+__exportStar(require("./wire"), exports);
+//# sourceMappingURL=index.js.map

package/cjs/configuration/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/configuration/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAA+B;AAC/B,yCAAsB"}

package/cjs/configuration/wire.d.ts

@@ -0,0 +1,12 @@
+import type { Configuration } from './configuration';
+/**
+ * Create configuration from a string created with `configurationToString`.
+ */
+export declare function configurationFromString(s: string): Configuration;
+/**
+ * Serialize configuration to string that can be deserialized with
+ * `configurationFromString`. The serialized string format is
+ * unspecified.
+ */
+export declare function configurationToString(configuration: Configuration): string;
+//# sourceMappingURL=wire.d.ts.map

package/cjs/configuration/wire.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wire.d.ts","sourceRoot":"","sources":["../../src/configuration/wire.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAiB,MAAM,iBAAiB,CAAA;AAWnE;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,EAAE,MAAM,GAAG,aAAa,CAqBhE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAa1E"}

package/cjs/configuration/wire.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configurationFromString = configurationFromString;
+exports.configurationToString = configurationToString;
+/**
+ * Create configuration from a string created with `configurationToString`.
+ */
+function configurationFromString(s) {
+    try {
+        const wire = JSON.parse(s);
+        if (wire.version !== 1) {
+            // Unknown version
+            return {};
+        }
+        const configuration = {};
+        if (wire.precomputed) {
+            configuration.precomputed = {
+                ...wire.precomputed,
+                response: JSON.parse(wire.precomputed.response),
+            };
+        }
+        return configuration;
+    }
+    catch (_a) {
+        return {};
+    }
+}
+/**
+ * Serialize configuration to string that can be deserialized with
+ * `configurationFromString`. The serialized string format is
+ * unspecified.
+ */
+function configurationToString(configuration) {
+    const wire = {
+        version: 1,
+    };
+    if (configuration.precomputed) {
+        wire.precomputed = {
+            ...configuration.precomputed,
+            response: JSON.stringify(configuration.precomputed),
+        };
+    }
+    return JSON.stringify(wire);
+}
+//# sourceMappingURL=wire.js.map

package/cjs/configuration/wire.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wire.js","sourceRoot":"","sources":["../../src/configuration/wire.ts"],"names":[],"mappings":";;AAgBA,0DAqBC;AAOD,sDAaC;AA5CD;;GAEG;AACH,SAAgB,uBAAuB,CAAC,CAAS;IAC/C,IAAI,CAAC;QACH,MAAM,IAAI,GAAsB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAE7C,IAAI,IAAI,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;YACvB,kBAAkB;YAClB,OAAO,EAAE,CAAA;QACX,CAAC;QAED,MAAM,aAAa,GAAkB,EAAE,CAAA;QACvC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,aAAa,CAAC,WAAW,GAAG;gBAC1B,GAAG,IAAI,CAAC,WAAW;gBACnB,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC;aAChD,CAAA;QACH,CAAC;QAED,OAAO,aAAa,CAAA;IACtB,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,EAAE,CAAA;IACX,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAgB,qBAAqB,CAAC,aAA4B;IAChE,MAAM,IAAI,GAAsB;QAC9B,OAAO,EAAE,CAAC;KACX,CAAA;IAED,IAAI,aAAa,CAAC,WAAW,EAAE,CAAC;QAC9B,IAAI,CAAC,WAAW,GAAG;YACjB,GAAG,aAAa,CAAC,WAAW;YAC5B,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,WAAW,CAAC;SACpD,CAAA;IACH,CAAC;IAED,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;AAC7B,CAAC"}

package/cjs/index.d.ts

@@ -0,0 +1,2 @@
+export * from './configuration';
+//# sourceMappingURL=index.d.ts.map

package/cjs/index.d.ts.map

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

package/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAA+B;AAE/B,4CAA4C;AAC5C,MAAM,WAAW,GAAG,0BAA0B,CAAA"}

package/jest.config.js

@@ -0,0 +1,15 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.ts$': [
+      'ts-jest',
+      {
+        tsconfig: 'tsconfig.test.json',
+      },
+    ],
+  },
+  testMatch: ['**/*.spec.ts', '**/*.test.ts'],
+  moduleFileExtensions: ['ts', 'js', 'json'],
+  collectCoverageFrom: ['src/**/*.ts', '!src/**/*.d.ts'],
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datadog/flagging-core",
-  "version": "0.1.0-alpha.7",
+  "version": "0.1.0-alpha.8",
   "description": "Runtime-agnostic flag-evaluation logic for Datadog Flagging",
   "license": "MIT",
   "repository": {
@@ -12,9 +12,6 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "files": [
-    "dist"
-  ],
   "main": "cjs/index.js",
   "module": "esm/index.js",
   "types": "cjs/index.d.ts",

package/src/configuration/configuration.ts

@@ -0,0 +1,57 @@
+import type {
+  EvaluationContext,
+  FlagValueType,
+  JsonValue,
+  ResolutionReason,
+} from '@openfeature/web-sdk'
+
+/**
+ * Internal configuration for DatadogProvider.
+ */
+export type Configuration = {
+  /** @internal */
+  precomputed?: PrecomputedConfiguration
+}
+
+/** @internal */
+export type PrecomputedConfiguration = {
+  response: PrecomputedConfigurationResponse
+  context?: EvaluationContext
+  fetchedAt?: UnixTimestamp
+}
+
+// Fancy way to map FlagValueType to expected FlagValue.
+/** @internal */
+export type FlagTypeToValue<T extends FlagValueType> = {
+  ['boolean']: boolean
+  ['string']: string
+  ['number']: number
+  ['object']: JsonValue
+}[T]
+
+/** @internal
+ * Timestamp in milliseconds since Unix Epoch.
+ */
+export type UnixTimestamp = number
+
+/** @internal */
+export type PrecomputedConfigurationResponse = {
+  data: {
+    attributes: {
+      /** When configuration was generated. */
+      createdAt: number
+      flags: Record<string, PrecomputedFlag>
+    }
+  }
+}
+
+/** @internal */
+export type PrecomputedFlag<T extends FlagValueType = FlagValueType> = {
+  allocationKey: string
+  variationKey: string
+  variationType: T
+  variationValue: FlagTypeToValue<T>
+  reason: ResolutionReason
+  doLog: boolean
+  extraLogging: Record<string, unknown>
+}

package/src/configuration/index.ts

@@ -0,0 +1,2 @@
+export * from './configuration'
+export * from './wire'

package/src/configuration/wire.ts

@@ -0,0 +1,58 @@
+import type { EvaluationContext } from '@openfeature/web-sdk'
+
+import type { Configuration, UnixTimestamp } from './configuration'
+
+type ConfigurationWire = {
+  version: 1
+  precomputed?: {
+    context?: EvaluationContext
+    response: string
+    fetchedAt?: UnixTimestamp
+  }
+}
+
+/**
+ * Create configuration from a string created with `configurationToString`.
+ */
+export function configurationFromString(s: string): Configuration {
+  try {
+    const wire: ConfigurationWire = JSON.parse(s)
+
+    if (wire.version !== 1) {
+      // Unknown version
+      return {}
+    }
+
+    const configuration: Configuration = {}
+    if (wire.precomputed) {
+      configuration.precomputed = {
+        ...wire.precomputed,
+        response: JSON.parse(wire.precomputed.response),
+      }
+    }
+
+    return configuration
+  } catch {
+    return {}
+  }
+}
+
+/**
+ * Serialize configuration to string that can be deserialized with
+ * `configurationFromString`. The serialized string format is
+ * unspecified.
+ */
+export function configurationToString(configuration: Configuration): string {
+  const wire: ConfigurationWire = {
+    version: 1,
+  }
+
+  if (configuration.precomputed) {
+    wire.precomputed = {
+      ...configuration.precomputed,
+      response: JSON.stringify(configuration.precomputed),
+    }
+  }
+
+  return JSON.stringify(wire)
+}

package/src/global.d.ts

@@ -0,0 +1,3 @@
+// Build environment placeholders that will be replaced during build
+declare const __BUILD_ENV__SDK_VERSION__: string
+declare const __BUILD_ENV__SDK_SETUP__: string

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './configuration'
+
+// Build environment placeholder for testing
+const SDK_VERSION = __BUILD_ENV__SDK_VERSION__

package/tsconfig.cjs.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es2018",
+    "outDir": "cjs",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["**/*.test.ts", "**/*.spec.ts", "test/**/*"]
+}

package/tsconfig.esm.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "es2020",
+    "target": "es2018",
+    "outDir": "esm",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["**/*.test.ts", "**/*.spec.ts", "test/**/*"]
+}

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "declaration": true,
+    "rootDir": "./src/",
+    "outDir": "./dist/",
+    "types": ["jest", "node"]
+  },
+  "include": ["./src/**/*.ts", "./src/**/*.d.ts"],
+  "exclude": ["./src/**/*.spec.ts", "./src/**/*.specHelper.ts"]
+}

package/tsconfig.test.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.cjs.json",
+  "compilerOptions": {
+    "types": ["jest", "node"]
+  },
+  "include": ["./src/**/*.spec.ts", "./src/**/*.test.ts"],
+  "exclude": []
+}

package/webpack.config.js

@@ -0,0 +1,10 @@
+const path = require('path')
+
+const webpackBase = require('../../webpack.base')
+
+module.exports = (_env, argv) =>
+  webpackBase({
+    mode: argv.mode,
+    entry: path.resolve(__dirname, 'src/index.ts'),
+    filename: 'datadog-flagging-core.js',
+  })