@featurevisor/types 2.10.0 → 2.12.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.12.0](https://github.com/featurevisor/featurevisor/compare/v2.11.0...v2.12.0) (2026-02-21)
+
+
+### Features
+
+* reusable schemas ([#390](https://github.com/featurevisor/featurevisor/issues/390)) ([fa32095](https://github.com/featurevisor/featurevisor/commit/fa3209554c08bdc2c7cc3dd8af8f8fc51213e7be))
+
+
+
+
+
 # [2.10.0](https://github.com/featurevisor/featurevisor/compare/v2.9.0...v2.10.0) (2026-02-15)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@featurevisor/types",
-  "version": "2.10.0",
+  "version": "2.12.0",
   "description": "Common Typescript types for Featurevisor",
   "main": "src/index.js",
   "module": "src/index.js",
@@ -47,5 +47,5 @@
     "url": "https://github.com/featurevisor/featurevisor/issues"
   },
   "license": "MIT",
-  "gitHead": "0cbe15fb45fd08ebd70125f1604ae7fe7e20756a"
+  "gitHead": "d7542c7da3615c821b031912e4d12ca4c81e5db2"
 }

package/src/datafile.d.ts

@@ -9,6 +9,7 @@ import type {
   Required,
   VariableKey,
   VariableSchema,
+  ResolvedVariableSchema,
   Variation,
   Force,
   VariationV1,
@@ -46,7 +47,7 @@ export interface Feature {
   hash?: string;
   deprecated?: boolean;
   required?: Required[];
-  variablesSchema?: Record<VariableKey, VariableSchema>;
+  variablesSchema?: Record<VariableKey, ResolvedVariableSchema>;
   disabledVariationValue?: VariationValue;
   variations?: Variation[];
   bucketBy: BucketBy;

package/src/feature.d.ts

@@ -1,12 +1,12 @@
 import type { BucketBy } from "./bucket";
 import type { Condition } from "./condition";
 import type { GroupSegment } from "./segment";
-import type { PropertyType, Value, PropertySchema } from "./property";
+import type { SchemaType, Value, Schema, SchemaKey } from "./schema";
 
 export type VariationValue = string;
 
 export type VariableKey = string;
-export type VariableType = PropertyType | "json";
+export type VariableType = SchemaType | "json";
 export type VariableValue =
   | Value
   // @TODO: consider removing below items
@@ -59,22 +59,69 @@ export interface Variation {
   };
 }
 
-export interface VariableSchema {
+/** Variable schema that references a reusable schema by key. No type/properties/required/items. */
+export interface VariableSchemaWithReference {
   deprecated?: boolean;
   key?: VariableKey; // @NOTE: remove
-  type: VariableType;
+  schema: SchemaKey;
+
+  defaultValue: VariableValue;
+  description?: string; // only available in YAML files
+  useDefaultWhenDisabled?: boolean;
+  disabledValue?: VariableValue;
+}
+
+/** Variable schema with inline type and optional structure. */
+export interface VariableSchemaWithInline {
+  deprecated?: boolean;
+  key?: VariableKey; // @NOTE: remove
+  type?: VariableType; // required when not using oneOf
+
+  properties?: Schema; // if type is object
+  required?: Schema["required"]; // if type is object
+  items?: Schema["items"]; // if type is array
+  oneOf?: Schema[]; // value must match exactly one of these (mutually exclusive with type at top level when used)
+  enum?: Value[];
+  const?: VariableValue;
+
+  // Numeric validation (when type is "integer" or "double")
+  minimum?: number;
+  maximum?: number;
 
-  properties?: PropertySchema; // if type is object
-  required?: PropertySchema["required"]; // if type is object
-  items?: PropertySchema["items"]; // if type is array
+  // String validation (when type is "string")
+  minLength?: number;
+  maxLength?: number;
+  pattern?: string;
+
+  // Array validation (when type is "array")
+  minItems?: number;
+  maxItems?: number;
+  uniqueItems?: boolean;
 
   defaultValue: VariableValue;
-  // nullable?: boolean; // @TODO: consider in future
   description?: string; // only available in YAML files
   useDefaultWhenDisabled?: boolean;
   disabledValue?: VariableValue;
 }
 
+/** Either a reference to a reusable schema or an inline variable schema. */
+export type VariableSchema = VariableSchemaWithReference | VariableSchemaWithInline;
+
+/**
+ * Variable schema as emitted in the datafile (schema refs resolved to type only).
+ * Used by SDK and datafile; only `type` is kept from the schema for datafile size.
+ */
+export interface ResolvedVariableSchema {
+  deprecated?: boolean;
+  key?: VariableKey;
+  type: VariableType;
+
+  defaultValue: VariableValue;
+  description?: string;
+  useDefaultWhenDisabled?: boolean;
+  disabledValue?: VariableValue;
+}
+
 export type FeatureKey = string;
 
 export interface RequiredWithVariation {

package/src/index.d.ts

@@ -9,4 +9,4 @@ export * from "./segment";
 export * from "./site";
 export * from "./state";
 export * from "./test";
-export * from "./property";
+export * from "./schema";

package/src/schema.d.ts

@@ -0,0 +1,59 @@
+export type SchemaKey = string;
+
+export type ObjectValue = { [key: string]: Value };
+export type Value =
+  | boolean
+  | string
+  | number // covers integer and double
+  // | Date // @TODO: support in future
+  | ObjectValue
+  | Value[];
+
+export type SchemaType =
+  | "boolean"
+  | "string"
+  | "integer"
+  | "double"
+  | "object"
+  // | "date" // @TODO: support in future
+  | "array";
+
+// adapted JSON Schema for Featurevisor
+export interface Schema {
+  // Basic metadata
+  description?: string;
+
+  // General validation keywords
+  type?: SchemaType;
+  enum?: Value[];
+  const?: Value;
+
+  // Numeric validation keywords (when type is "integer" or "double")
+  maximum?: number;
+  minimum?: number;
+
+  // String validation keywords (when type is "string")
+  maxLength?: number;
+  minLength?: number;
+  pattern?: string;
+
+  // Array validation keywords (when type is "array")
+  items?: Schema;
+  maxItems?: number;
+  minItems?: number;
+  uniqueItems?: boolean;
+
+  // Object validation keywords
+  required?: string[];
+  properties?: { [key: string]: Schema };
+
+  // Annotations
+  // default?: Value;
+  // examples?: Value[];
+
+  // when referencing another Schema by name
+  schema?: SchemaKey;
+
+  // oneOf: value must match exactly one of the given schemas (reusable Schema level only)
+  oneOf?: Schema[];
+}

package/src/site.d.ts

@@ -2,7 +2,7 @@ import type { Attribute } from "./attribute";
 import type { Segment, SegmentKey } from "./segment";
 import type { Tag, EnvironmentKey, FeatureKey, ParsedFeature } from "./feature";
 
-export type EntityType = "attribute" | "segment" | "feature" | "group" | "test";
+export type EntityType = "attribute" | "segment" | "feature" | "group" | "schema" | "test";
 
 export type CommitHash = string;
 

package/src/property.d.ts

@@ -1,55 +0,0 @@
-export type Schema = PropertySchema;
-
-export type ObjectValue = { [key: string]: Value };
-export type Value =
-  | boolean
-  | string
-  | number // covers integer and double
-  // | Date // @TODO: support in future
-  | ObjectValue
-  | Value[];
-
-export type PropertyType =
-  | "boolean"
-  | "string"
-  | "integer"
-  | "double"
-  | "object"
-  // | "date" // @TODO: support in future
-  // | "semver" // @TODO: consider in future
-  // | "url" // @TODO: consider in future
-  | "array";
-
-// adapted JSON Schema for Featurevisor
-export interface PropertySchema {
-  // Basic metadata
-  description?: string;
-
-  // General validation keywords
-  type?: PropertyType;
-  // enum?: Value[];
-  // const?: Value;
-
-  // Numeric validation keywords
-  // maximum?: number;
-  // minimum?: number;
-
-  // String validation keywords
-  // maxLength?: number;
-  // minLength?: number;
-  // pattern?: string;
-
-  // Array validation keywords
-  items?: PropertySchema; // @TODO: allow array of items in future | PropertySchema[];
-  // maxItems?: number;
-  // minItems?: number;
-  // uniqueItems?: boolean;
-
-  // Object validation keywords
-  required?: string[];
-  properties?: { [key: string]: PropertySchema };
-
-  // Annotations
-  // default?: Value;
-  // examples?: Value[];
-}