showwhat 1.0.0 → 2.0.0

package/README.md

@@ -1,6 +1,8 @@
 # showwhat
 
-Feature flag resolution engine — the main entry point for **showwhat**, a lightweight, extensible feature flag library.
+Feature flags and config you own. Platform-agnostic.
+
+`showwhat` combines a YAML/JSON definition format with a schema-validated, extensible rule engine. Define flags and config as variations with conditions, evaluate them in your app, and store definitions wherever you want.
 
 ## Installation
 
@@ -27,25 +29,23 @@ const data = await MemoryData.fromObject({
   },
 });
 
-const result = await showwhat({
-  key: "checkout_v2",
+const results = await showwhat({
+  keys: ["checkout_v2"],
   context: { env: "prod" },
   options: { data },
 });
-console.log(result.value); // true
+console.log(results.checkout_v2.value); // true
 ```
 
 ## Features
 
-- `showwhat()` resolution engine with context validation
+- `showwhat()` resolution engine for flags and config values
 - Built-in condition evaluators: `string`, `number`, `datetime`, `bool`, `env`, `startAt`, `endAt`
 - Custom evaluators via `registerEvaluators()`
 - YAML and JSON parsing with schema validation
 - Pluggable data sources (`DefinitionReader` / `DefinitionWriter`)
 - Typed error hierarchy
 
-This package re-exports everything from `@showwhat/core`.
-
 ## Documentation
 
 - [Quick Start](https://showwhat.yeojz.dev/docs/) — installation and first definition

package/dist/index.d.ts

@@ -1,14 +1,16 @@
-import { ResolverOptions, DefinitionReader, ConditionEvaluators, BuiltinCondition, Context, Resolution } from '@showwhat/core';
+import { Resolution, ResolutionError, ResolverOptions, DefinitionReader, ConditionEvaluators, BuiltinCondition, ContextValue, Context, Dependencies } from '@showwhat/core';
 export * from '@showwhat/core';
 
 type ShowWhatOptions = ResolverOptions & {
     data: DefinitionReader;
 };
-declare function showwhat({ key, context, options, }: {
-    key: string;
-    context: Context;
+type Resolutions = Record<string, Resolution | ResolutionError>;
+declare function showwhat<T extends Record<string, ContextValue> = Record<string, ContextValue>, D extends Record<string, unknown> = Record<string, unknown>>({ keys, context, deps, options, }: {
+    keys?: string[];
+    context: Context<T>;
+    deps?: Dependencies<D>;
     options: ShowWhatOptions;
-}): Promise<Resolution>;
+}): Promise<Resolutions>;
 declare function registerEvaluators<T extends string>(extra: ConditionEvaluators<T>): ConditionEvaluators<BuiltinCondition["type"] | T>;
 
-export { type ShowWhatOptions, registerEvaluators, showwhat };
+export { type Resolutions, type ShowWhatOptions, registerEvaluators, showwhat };

package/dist/index.js

@@ -2,14 +2,35 @@
 import {
   ContextSchema,
   builtinEvaluators,
-  DefinitionNotFoundError,
   ValidationError,
+  DataError,
   resolve
 } from "@showwhat/core";
 export * from "@showwhat/core";
+async function fetchDefinitions(data, keys) {
+  if (!keys) {
+    try {
+      return await data.getAll();
+    } catch (err) {
+      throw new DataError("Failed to fetch definitions", err);
+    }
+  }
+  const definitions = {};
+  await Promise.all(
+    keys.map(async (key) => {
+      try {
+        definitions[key] = await data.get(key);
+      } catch (err) {
+        throw new DataError(`Failed to fetch definition "${key}"`, err);
+      }
+    })
+  );
+  return definitions;
+}
 async function showwhat({
-  key,
+  keys,
   context,
+  deps,
   options
 }) {
   const contextResult = ContextSchema.safeParse(context);
@@ -19,21 +40,15 @@ async function showwhat({
       "context"
     );
   }
-  const validatedContext = contextResult.data;
-  const def = await options.data.get(key);
-  if (!def) {
-    throw new DefinitionNotFoundError(key);
-  }
-  const result = await resolve({
-    definitions: { [key]: def },
-    context: validatedContext,
+  return resolve({
+    definitions: await fetchDefinitions(options.data, keys),
+    context: contextResult.data,
+    deps,
     options: {
-      evaluators: options.evaluators ?? builtinEvaluators,
-      fallback: options.fallback,
-      logger: options.logger
+      ...options,
+      evaluators: options.evaluators ?? builtinEvaluators
     }
   });
-  return result[key];
 }
 var COMPOSITE_TYPES = /* @__PURE__ */ new Set(["and", "or"]);
 function registerEvaluators(extra) {

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import {\n  ContextSchema,\n  builtinEvaluators,\n  DefinitionNotFoundError,\n  ValidationError,\n  resolve,\n} from \"@showwhat/core\";\nimport type {\n  BuiltinCondition,\n  ConditionEvaluators,\n  Context,\n  DefinitionReader,\n  Resolution,\n  ResolverOptions,\n} from \"@showwhat/core\";\n\nexport * from \"@showwhat/core\";\n\nexport type ShowWhatOptions = ResolverOptions & {\n  data: DefinitionReader;\n};\n\nexport async function showwhat({\n  key,\n  context,\n  options,\n}: {\n  key: string;\n  context: Context;\n  options: ShowWhatOptions;\n}): Promise<Resolution> {\n  const contextResult = ContextSchema.safeParse(context);\n  if (!contextResult.success) {\n    throw new ValidationError(\n      contextResult.error.issues.map((i) => `[${i.path.join(\".\")}] ${i.message}`).join(\"; \"),\n      \"context\",\n    );\n  }\n\n  const validatedContext = contextResult.data;\n  const def = await options.data.get(key);\n\n  if (!def) {\n    throw new DefinitionNotFoundError(key);\n  }\n\n  const result = await resolve({\n    definitions: { [key]: def },\n    context: validatedContext,\n    options: {\n      evaluators: options.evaluators ?? builtinEvaluators,\n      fallback: options.fallback,\n      logger: options.logger,\n    },\n  });\n\n  return result[key];\n}\n\nconst COMPOSITE_TYPES = new Set([\"and\", \"or\"]);\n\nexport function registerEvaluators<T extends string>(\n  extra: ConditionEvaluators<T>,\n): ConditionEvaluators<BuiltinCondition[\"type\"] | T> {\n  for (const key of Object.keys(extra)) {\n    if (COMPOSITE_TYPES.has(key)) {\n      throw new Error(`Cannot register reserved condition type \"${key}\"`);\n    }\n  }\n  return { ...builtinEvaluators, ...extra };\n}\n"],"mappings":";AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAUP,cAAc;AAMd,eAAsB,SAAS;AAAA,EAC7B;AAAA,EACA;AAAA,EACA;AACF,GAIwB;AACtB,QAAM,gBAAgB,cAAc,UAAU,OAAO;AACrD,MAAI,CAAC,cAAc,SAAS;AAC1B,UAAM,IAAI;AAAA,MACR,cAAc,MAAM,OAAO,IAAI,CAAC,MAAM,IAAI,EAAE,KAAK,KAAK,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,KAAK,IAAI;AAAA,MACrF;AAAA,IACF;AAAA,EACF;AAEA,QAAM,mBAAmB,cAAc;AACvC,QAAM,MAAM,MAAM,QAAQ,KAAK,IAAI,GAAG;AAEtC,MAAI,CAAC,KAAK;AACR,UAAM,IAAI,wBAAwB,GAAG;AAAA,EACvC;AAEA,QAAM,SAAS,MAAM,QAAQ;AAAA,IAC3B,aAAa,EAAE,CAAC,GAAG,GAAG,IAAI;AAAA,IAC1B,SAAS;AAAA,IACT,SAAS;AAAA,MACP,YAAY,QAAQ,cAAc;AAAA,MAClC,UAAU,QAAQ;AAAA,MAClB,QAAQ,QAAQ;AAAA,IAClB;AAAA,EACF,CAAC;AAED,SAAO,OAAO,GAAG;AACnB;AAEA,IAAM,kBAAkB,oBAAI,IAAI,CAAC,OAAO,IAAI,CAAC;AAEtC,SAAS,mBACd,OACmD;AACnD,aAAW,OAAO,OAAO,KAAK,KAAK,GAAG;AACpC,QAAI,gBAAgB,IAAI,GAAG,GAAG;AAC5B,YAAM,IAAI,MAAM,4CAA4C,GAAG,GAAG;AAAA,IACpE;AAAA,EACF;AACA,SAAO,EAAE,GAAG,mBAAmB,GAAG,MAAM;AAC1C;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import {\n  ContextSchema,\n  builtinEvaluators,\n  ValidationError,\n  DataError,\n  resolve,\n} from \"@showwhat/core\";\nimport type {\n  BuiltinCondition,\n  ConditionEvaluators,\n  Context,\n  ContextValue,\n  Definitions,\n  DefinitionReader,\n  Dependencies,\n  Resolution,\n  ResolutionError,\n  ResolverOptions,\n} from \"@showwhat/core\";\n\nexport * from \"@showwhat/core\";\n\nexport type ShowWhatOptions = ResolverOptions & {\n  data: DefinitionReader;\n};\n\nexport type Resolutions = Record<string, Resolution | ResolutionError>;\n\nasync function fetchDefinitions(data: DefinitionReader, keys?: string[]): Promise<Definitions> {\n  if (!keys) {\n    try {\n      return await data.getAll();\n    } catch (err) {\n      throw new DataError(\"Failed to fetch definitions\", err);\n    }\n  }\n\n  const definitions = {} as Record<string, Definitions[string] | null>;\n  await Promise.all(\n    keys.map(async (key) => {\n      try {\n        definitions[key] = await data.get(key);\n      } catch (err) {\n        throw new DataError(`Failed to fetch definition \"${key}\"`, err);\n      }\n    }),\n  );\n  return definitions as Definitions;\n}\n\nexport async function showwhat<\n  T extends Record<string, ContextValue> = Record<string, ContextValue>,\n  D extends Record<string, unknown> = Record<string, unknown>,\n>({\n  keys,\n  context,\n  deps,\n  options,\n}: {\n  keys?: string[];\n  context: Context<T>;\n  deps?: Dependencies<D>;\n  options: ShowWhatOptions;\n}): Promise<Resolutions> {\n  const contextResult = ContextSchema.safeParse(context);\n  if (!contextResult.success) {\n    throw new ValidationError(\n      contextResult.error.issues.map((i) => `[${i.path.join(\".\")}] ${i.message}`).join(\"; \"),\n      \"context\",\n    );\n  }\n\n  return resolve({\n    definitions: await fetchDefinitions(options.data, keys),\n    context: contextResult.data as Context<T>,\n    deps,\n    options: {\n      ...options,\n      evaluators: options.evaluators ?? builtinEvaluators,\n    },\n  });\n}\n\nconst COMPOSITE_TYPES = new Set([\"and\", \"or\"]);\n\nexport function registerEvaluators<T extends string>(\n  extra: ConditionEvaluators<T>,\n): ConditionEvaluators<BuiltinCondition[\"type\"] | T> {\n  for (const key of Object.keys(extra)) {\n    if (COMPOSITE_TYPES.has(key)) {\n      throw new Error(`Cannot register reserved condition type \"${key}\"`);\n    }\n  }\n  return { ...builtinEvaluators, ...extra };\n}\n"],"mappings":";AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAcP,cAAc;AAQd,eAAe,iBAAiB,MAAwB,MAAuC;AAC7F,MAAI,CAAC,MAAM;AACT,QAAI;AACF,aAAO,MAAM,KAAK,OAAO;AAAA,IAC3B,SAAS,KAAK;AACZ,YAAM,IAAI,UAAU,+BAA+B,GAAG;AAAA,IACxD;AAAA,EACF;AAEA,QAAM,cAAc,CAAC;AACrB,QAAM,QAAQ;AAAA,IACZ,KAAK,IAAI,OAAO,QAAQ;AACtB,UAAI;AACF,oBAAY,GAAG,IAAI,MAAM,KAAK,IAAI,GAAG;AAAA,MACvC,SAAS,KAAK;AACZ,cAAM,IAAI,UAAU,+BAA+B,GAAG,KAAK,GAAG;AAAA,MAChE;AAAA,IACF,CAAC;AAAA,EACH;AACA,SAAO;AACT;AAEA,eAAsB,SAGpB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAKyB;AACvB,QAAM,gBAAgB,cAAc,UAAU,OAAO;AACrD,MAAI,CAAC,cAAc,SAAS;AAC1B,UAAM,IAAI;AAAA,MACR,cAAc,MAAM,OAAO,IAAI,CAAC,MAAM,IAAI,EAAE,KAAK,KAAK,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,KAAK,IAAI;AAAA,MACrF;AAAA,IACF;AAAA,EACF;AAEA,SAAO,QAAQ;AAAA,IACb,aAAa,MAAM,iBAAiB,QAAQ,MAAM,IAAI;AAAA,IACtD,SAAS,cAAc;AAAA,IACvB;AAAA,IACA,SAAS;AAAA,MACP,GAAG;AAAA,MACH,YAAY,QAAQ,cAAc;AAAA,IACpC;AAAA,EACF,CAAC;AACH;AAEA,IAAM,kBAAkB,oBAAI,IAAI,CAAC,OAAO,IAAI,CAAC;AAEtC,SAAS,mBACd,OACmD;AACnD,aAAW,OAAO,OAAO,KAAK,KAAK,GAAG;AACpC,QAAI,gBAAgB,IAAI,GAAG,GAAG;AAC5B,YAAM,IAAI,MAAM,4CAA4C,GAAG,GAAG;AAAA,IACpE;AAAA,EACF;AACA,SAAO,EAAE,GAAG,mBAAmB,GAAG,MAAM;AAC1C;","names":[]}

package/package.json

@@ -1,13 +1,18 @@
 {
   "name": "showwhat",
-  "version": "1.0.0",
-  "description": "Feature flag resolution engine",
+  "version": "2.0.0",
+  "description": "A schema-based resolution engine for configuration and feature flags",
   "keywords": [
     "feature-flags",
     "feature-toggles",
     "feature-management",
+    "config-management",
     "flag-evaluation",
+    "resolution",
+    "engine",
     "targeting",
+    "schema",
+    "specification",
     "showwhat"
   ],
   "license": "MIT",
@@ -36,14 +41,14 @@
     "dist"
   ],
   "dependencies": {
-    "@showwhat/core": "1.0.0"
+    "@showwhat/core": "2.0.0"
   },
   "devDependencies": {
-    "@types/node": "^25.4.0",
-    "@vitest/coverage-v8": "^4.0.0",
-    "tsup": "^8.0.0",
-    "typescript": "^5.4.0",
-    "vitest": "^4.0.0"
+    "@types/node": "^25.5.0",
+    "@vitest/coverage-v8": "^4.1.2",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.2"
   },
   "scripts": {
     "build": "tsup",