showwhat 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Gerald Yeo
+
+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,59 @@
+# showwhat
+
+Feature flag resolution engine — the main entry point for **showwhat**, a lightweight, extensible feature flag library.
+
+## Installation
+
+```bash
+npm install showwhat
+pnpm add showwhat
+yarn add showwhat
+
+# Other runtimes
+bun add showwhat
+deno install npm:showwhat
+```
+
+## Quick start
+
+```ts
+import { MemoryData, showwhat } from "showwhat";
+
+const data = await MemoryData.fromObject({
+  definitions: {
+    checkout_v2: {
+      variations: [{ value: true, conditions: [{ type: "env", value: "prod" }] }, { value: false }],
+    },
+  },
+});
+
+const result = await showwhat({
+  key: "checkout_v2",
+  context: { env: "prod" },
+  options: { data },
+});
+console.log(result.value); // true
+```
+
+## Features
+
+- `showwhat()` resolution engine with context validation
+- 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
+- [Conditions](https://showwhat.yeojz.dev/docs/conditions) — built-in condition types and usage
+- [Context](https://showwhat.yeojz.dev/docs/context) — runtime context object
+- [Definitions](https://showwhat.yeojz.dev/docs/definitions) — definition structure and variations
+- [Core API](https://showwhat.yeojz.dev/docs/core) — `showwhat()`, `resolve()`, parsing, and more
+- [Errors](https://showwhat.yeojz.dev/docs/errors) — error types and when they are thrown
+- [Custom Conditions](https://showwhat.yeojz.dev/docs/custom-conditions) — writing your own evaluators
+- [Custom Data Sources](https://showwhat.yeojz.dev/docs/custom-data-sources) — implementing `DefinitionReader`
+- [MemoryData](https://showwhat.yeojz.dev/docs/memory) — in-memory data source

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,51 @@
+// src/index.ts
+import {
+  ContextSchema,
+  builtinEvaluators,
+  DefinitionNotFoundError,
+  ValidationError,
+  resolve
+} from "@showwhat/core";
+export * from "@showwhat/core";
+async function showwhat({
+  key,
+  context,
+  options
+}) {
+  const contextResult = ContextSchema.safeParse(context);
+  if (!contextResult.success) {
+    throw new ValidationError(
+      contextResult.error.issues.map((i) => `[${i.path.join(".")}] ${i.message}`).join("; "),
+      "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,
+    options: {
+      evaluators: options.evaluators ?? builtinEvaluators,
+      fallback: options.fallback,
+      logger: options.logger
+    }
+  });
+  return result[key];
+}
+var COMPOSITE_TYPES = /* @__PURE__ */ new Set(["and", "or"]);
+function registerEvaluators(extra) {
+  for (const key of Object.keys(extra)) {
+    if (COMPOSITE_TYPES.has(key)) {
+      throw new Error(`Cannot register reserved condition type "${key}"`);
+    }
+  }
+  return { ...builtinEvaluators, ...extra };
+}
+export {
+  registerEvaluators,
+  showwhat
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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":[]}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "showwhat",
+  "version": "1.0.0",
+  "description": "Feature flag resolution engine",
+  "keywords": [
+    "feature-flags",
+    "feature-toggles",
+    "feature-management",
+    "flag-evaluation",
+    "targeting",
+    "showwhat"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/yeojz/showwhat.git",
+    "directory": "packages/showwhat"
+  },
+  "homepage": "https://showwhat.yeojz.dev",
+  "bugs": {
+    "url": "https://github.com/yeojz/showwhat/issues"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@showwhat/core": "1.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"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "rm -rf dist .tsbuildinfo",
+    "lint": "eslint src",
+    "typecheck": "tsc --noEmit"
+  }
+}