@shipeasy/openapi 1.2.0 → 1.4.0

package/dist/schemas/gates.js

@@ -26,12 +26,14 @@ var gateRuleSchema = z2.object({
     "semver_gt",
     "semver_gte",
     "semver_lt",
-    "semver_lte"
+    "semver_lte",
+    "gate_pass",
+    "exp_in"
   ]).describe(
-    "Comparison operator. Equality: `eq`/`neq`. Set membership: `in`/`not_in` (value is an array). Numeric order: `gt`/`gte`/`lt`/`lte`. Semver order: `semver_gt`/`semver_gte`/`semver_lt`/`semver_lte` (value is a dotted version like `4.2.0`). String: `contains` (substring), `regex` (JS-flavour pattern, value is the pattern string)."
+    'Comparison operator. Equality: `eq`/`neq`. Set membership: `in`/`not_in` (value is an array). Numeric order: `gt`/`gte`/`lt`/`lte`. Semver order: `semver_gt`/`semver_gte`/`semver_lt`/`semver_lte` (value is a dotted version like `4.2.0`). String: `contains` (substring), `regex` (JS-flavour pattern, value is the pattern string). Cross-resource references (evaluated only on the worker hot path, where both KV blobs load): `gate_pass` (`value` is another gate\'s name \u2014 true when that gate passes for the same caller); `exp_in` (`attr` is a running experiment\'s name, `value` is a group name, `"$holdout"`, or `"$any"` \u2014 true when the caller is in that variant / the universe holdout / any variant).'
   ),
   value: z2.unknown().describe(
-    "Operand. Shape depends on `op`: scalar for `eq/neq/gt/gte/lt/lte/contains/semver_*`; array of scalars for `in/not_in`; string pattern for `regex`."
+    'Operand. Shape depends on `op`: scalar for `eq/neq/gt/gte/lt/lte/contains/semver_*`; array of scalars for `in/not_in`; string pattern for `regex`; referenced gate name for `gate_pass`; group name / `"$holdout"` / `"$any"` for `exp_in`.'
   )
 }).describe(
   "Single targeting predicate. A gate's `rules` array is evaluated with AND semantics; use the gatekeeper `stack` for OR / fall-through logic."
@@ -42,9 +44,17 @@ var gateNameSchema = z2.string().regex(
 ).max(128).describe(
   "Stable gate key used by SDKs (`Shipeasy.checkGate(user, '<name>')`). Single segment or `folder.name`. Lowercase letters, digits, `_` or `-`; max 128 chars. Immutable after create \u2014 rename = delete + recreate."
 );
+var rampSchema = z2.object({
+  from: z2.number().int().min(0).max(1e4).describe("Start of the ramp in basis points (0\u201310000)."),
+  to: z2.number().int().min(0).max(1e4).describe("End of the ramp in basis points (0\u201310000)."),
+  startAt: z2.number().int().nonnegative().describe("Ramp start, epoch milliseconds (UTC)."),
+  durationMs: z2.number().int().positive().describe("Ramp length in milliseconds.")
+}).describe(
+  "Linear rollout ramp. The effective rollout % interpolates `from`\u2192`to` over `[startAt, startAt+durationMs]`, clamped outside that window, evaluated against the wall-clock at eval time. Overrides the entry's static `rolloutPct` while present."
+);
 var stackedConditionSchema = z2.object({
   id: z2.string().min(1).describe(
-    "Client-supplied stable id for the stack entry (used for React keys, audit diffs)."
+    "Client-supplied stable id for the stack entry (used for React keys, audit diffs, and as the default per-condition rollout salt)."
   ),
   type: z2.literal("condition").describe("Discriminator. `condition` = rule-based predicate sub-gate."),
   name: z2.string().optional().describe("Human label shown in the dashboard."),
@@ -53,9 +63,15 @@ var stackedConditionSchema = z2.object({
   ),
   pass: z2.enum(["all", "any"]).optional().describe("Combinator across `rules`. `all` = AND (default), `any` = OR."),
   rules: z2.array(gateRuleSchema).default([]).describe("Predicates evaluated under `pass`. Empty array = match nothing."),
+  rolloutPct: z2.number().int().min(0).max(1e4).optional().describe(
+    "Per-condition rollout in basis points. After the rules match, the caller is bucketed at this %; in-bucket \u2192 gate `true`, otherwise fall through to the next entry. Absent \u21D2 10000 (100%, every matching caller passes)."
+  ),
+  bucketBy: z2.string().optional().describe("Attribute used to hash the caller into the per-condition bucket. Default `userID`."),
+  salt: z2.string().optional().describe("Per-condition hash salt. Defaults to the entry `id`, then the gate salt."),
+  ramp: rampSchema.optional(),
   locked: z2.boolean().optional().describe("If `true`, dashboard hides edit controls (e.g. the trailing public-floor entry).")
 }).describe(
-  "Rule-based sub-gate. When matched, evaluation short-circuits and the gate returns `true` for the current caller."
+  "Rule-based sub-gate. When the rules match and the caller falls in the per-condition rollout bucket, evaluation short-circuits and the gate returns `true`; otherwise it falls through to the next entry."
 );
 var stackedRolloutSchema = z2.object({
   id: z2.string().min(1).describe("Client-supplied stable id for the stack entry."),
@@ -71,9 +87,10 @@ var stackedRolloutSchema = z2.object({
   salt: z2.string().optional().describe(
     "Per-entry hash salt. Defaults to the gate's salt. Set explicitly to keep two rollouts independent or correlated across gates."
   ),
+  ramp: rampSchema.optional(),
   locked: z2.boolean().optional().describe("If `true`, dashboard hides edit controls.")
 }).describe(
-  "Percentage-rollout sub-gate. Hashes `bucketBy` (default `userID`) with `salt` and returns `true` for `rolloutPct/10000` fraction of callers."
+  "Percentage-rollout sub-gate. Hashes `bucketBy` (default `userID`) with `salt` and returns `true` for `rolloutPct/10000` fraction of callers (or the ramp's effective % when `ramp` is set)."
 );
 var stackedGateEntrySchema = z2.discriminatedUnion("type", [stackedConditionSchema, stackedRolloutSchema]).describe(
   "One entry in the ordered gatekeeper stack. Evaluated top-to-bottom; first matching entry decides. Mix `condition` and `rollout` entries to express `internal-only` + `1% beta` + `50% public` in a single gate."
@@ -168,5 +185,6 @@ export {
   gateToggleResponseSchema,
   gateUpdateResponseSchema,
   gateUpdateSchema,
+  rampSchema,
   stackedGateEntrySchema
 };

package/dist/schemas/index.d.ts

@@ -3,7 +3,7 @@ export { CursorParts, DEFAULT_PAGE_SIZE, MAX_PAGE_SIZE, Page, PageQuery, decodeC
 export { FolderInput, folderSchema } from './folder.js';
 export { metricNameSchema } from './metric-name.js';
 export { ConfigCreateInput, ConfigDraftUpsertInput, ConfigPublishInput, ConfigSchemaUpdateInput, ConfigUpdateInput, JsonSchemaInput, configActivityEntrySchema, configActivityResponseSchema, configCreateResponseSchema, configCreateSchema, configDeleteResponseSchema, configDraftDiscardResponseSchema, configDraftSaveResponseSchema, configDraftUpsertSchema, configEnvSchema, configKindSchema, configNameSchema, configPublishResponseSchema, configPublishSchema, configResponseSchema, configSchemaUpdateSchema, configUpdateResponseSchema, configUpdateSchema, jsonSchemaSchema } from './configs.js';
-export { GateCreateInput, GateUpdateInput, StackedGateEntryInput, gateCreateResponseSchema, gateCreateSchema, gateDeleteResponseSchema, gateMetadataPatchSchema, gateNameSchema, gateResponseSchema, gateRuleSchema, gateToggleResponseSchema, gateUpdateResponseSchema, gateUpdateSchema, stackedGateEntrySchema } from './gates.js';
+export { GateCreateInput, GateUpdateInput, StackedGateEntryInput, gateCreateResponseSchema, gateCreateSchema, gateDeleteResponseSchema, gateMetadataPatchSchema, gateNameSchema, gateResponseSchema, gateRuleSchema, gateToggleResponseSchema, gateUpdateResponseSchema, gateUpdateSchema, rampSchema, stackedGateEntrySchema } from './gates.js';
 export { KillswitchCreateInput, KillswitchSwitchSetInput, KillswitchSwitchUnsetInput, KillswitchUpdateInput, KillswitchValue, KillswitchValueSetInput, SWITCH_KEY_RE, killswitchCreateResponseSchema, killswitchCreateSchema, killswitchDeleteResponseSchema, killswitchResponseSchema, killswitchSwitchSetResponseSchema, killswitchSwitchSetSchema, killswitchSwitchUnsetResponseSchema, killswitchSwitchUnsetSchema, killswitchUpdateResponseSchema, killswitchUpdateSchema, killswitchValueSchema, killswitchValueSetSchema, switchKeySchema } from './killswitches.js';
 export { UniverseCreateInput, UniverseUpdateInput, holdoutRangeSchema, universeCreateResponseSchema, universeCreateSchema, universeDeleteResponseSchema, universeNameSchema, universeResponseSchema, universeUpdateResponseSchema, universeUpdateSchema } from './universes.js';
 export { ExperimentCreateInput, ExperimentInlineMetric, ExperimentUpdateInput, bucketBySchema, experimentCreateResponseSchema, experimentCreateSchema, experimentDeleteResponseSchema, experimentGroupSchema, experimentInlineMetricSchema, experimentMetricsResponseSchema, experimentMetricsUpdateSchema, experimentNameSchema, experimentReanalyzeResponseSchema, experimentResponseSchema, experimentResultsResponseSchema, experimentStatusResponseSchema, experimentStatusUpdateSchema, experimentTimeseriesResponseSchema, experimentUpdateResponseSchema, experimentUpdateSchema, paramSchemaSchema } from './experiments.js';

package/dist/schemas/index.js

@@ -173,12 +173,14 @@ var gateRuleSchema = z5.object({
     "semver_gt",
     "semver_gte",
     "semver_lt",
-    "semver_lte"
+    "semver_lte",
+    "gate_pass",
+    "exp_in"
   ]).describe(
-    "Comparison operator. Equality: `eq`/`neq`. Set membership: `in`/`not_in` (value is an array). Numeric order: `gt`/`gte`/`lt`/`lte`. Semver order: `semver_gt`/`semver_gte`/`semver_lt`/`semver_lte` (value is a dotted version like `4.2.0`). String: `contains` (substring), `regex` (JS-flavour pattern, value is the pattern string)."
+    'Comparison operator. Equality: `eq`/`neq`. Set membership: `in`/`not_in` (value is an array). Numeric order: `gt`/`gte`/`lt`/`lte`. Semver order: `semver_gt`/`semver_gte`/`semver_lt`/`semver_lte` (value is a dotted version like `4.2.0`). String: `contains` (substring), `regex` (JS-flavour pattern, value is the pattern string). Cross-resource references (evaluated only on the worker hot path, where both KV blobs load): `gate_pass` (`value` is another gate\'s name \u2014 true when that gate passes for the same caller); `exp_in` (`attr` is a running experiment\'s name, `value` is a group name, `"$holdout"`, or `"$any"` \u2014 true when the caller is in that variant / the universe holdout / any variant).'
   ),
   value: z5.unknown().describe(
-    "Operand. Shape depends on `op`: scalar for `eq/neq/gt/gte/lt/lte/contains/semver_*`; array of scalars for `in/not_in`; string pattern for `regex`."
+    'Operand. Shape depends on `op`: scalar for `eq/neq/gt/gte/lt/lte/contains/semver_*`; array of scalars for `in/not_in`; string pattern for `regex`; referenced gate name for `gate_pass`; group name / `"$holdout"` / `"$any"` for `exp_in`.'
   )
 }).describe(
   "Single targeting predicate. A gate's `rules` array is evaluated with AND semantics; use the gatekeeper `stack` for OR / fall-through logic."
@@ -189,9 +191,17 @@ var gateNameSchema = z5.string().regex(
 ).max(128).describe(
   "Stable gate key used by SDKs (`Shipeasy.checkGate(user, '<name>')`). Single segment or `folder.name`. Lowercase letters, digits, `_` or `-`; max 128 chars. Immutable after create \u2014 rename = delete + recreate."
 );
+var rampSchema = z5.object({
+  from: z5.number().int().min(0).max(1e4).describe("Start of the ramp in basis points (0\u201310000)."),
+  to: z5.number().int().min(0).max(1e4).describe("End of the ramp in basis points (0\u201310000)."),
+  startAt: z5.number().int().nonnegative().describe("Ramp start, epoch milliseconds (UTC)."),
+  durationMs: z5.number().int().positive().describe("Ramp length in milliseconds.")
+}).describe(
+  "Linear rollout ramp. The effective rollout % interpolates `from`\u2192`to` over `[startAt, startAt+durationMs]`, clamped outside that window, evaluated against the wall-clock at eval time. Overrides the entry's static `rolloutPct` while present."
+);
 var stackedConditionSchema = z5.object({
   id: z5.string().min(1).describe(
-    "Client-supplied stable id for the stack entry (used for React keys, audit diffs)."
+    "Client-supplied stable id for the stack entry (used for React keys, audit diffs, and as the default per-condition rollout salt)."
   ),
   type: z5.literal("condition").describe("Discriminator. `condition` = rule-based predicate sub-gate."),
   name: z5.string().optional().describe("Human label shown in the dashboard."),
@@ -200,9 +210,15 @@ var stackedConditionSchema = z5.object({
   ),
   pass: z5.enum(["all", "any"]).optional().describe("Combinator across `rules`. `all` = AND (default), `any` = OR."),
   rules: z5.array(gateRuleSchema).default([]).describe("Predicates evaluated under `pass`. Empty array = match nothing."),
+  rolloutPct: z5.number().int().min(0).max(1e4).optional().describe(
+    "Per-condition rollout in basis points. After the rules match, the caller is bucketed at this %; in-bucket \u2192 gate `true`, otherwise fall through to the next entry. Absent \u21D2 10000 (100%, every matching caller passes)."
+  ),
+  bucketBy: z5.string().optional().describe("Attribute used to hash the caller into the per-condition bucket. Default `userID`."),
+  salt: z5.string().optional().describe("Per-condition hash salt. Defaults to the entry `id`, then the gate salt."),
+  ramp: rampSchema.optional(),
   locked: z5.boolean().optional().describe("If `true`, dashboard hides edit controls (e.g. the trailing public-floor entry).")
 }).describe(
-  "Rule-based sub-gate. When matched, evaluation short-circuits and the gate returns `true` for the current caller."
+  "Rule-based sub-gate. When the rules match and the caller falls in the per-condition rollout bucket, evaluation short-circuits and the gate returns `true`; otherwise it falls through to the next entry."
 );
 var stackedRolloutSchema = z5.object({
   id: z5.string().min(1).describe("Client-supplied stable id for the stack entry."),
@@ -218,9 +234,10 @@ var stackedRolloutSchema = z5.object({
   salt: z5.string().optional().describe(
     "Per-entry hash salt. Defaults to the gate's salt. Set explicitly to keep two rollouts independent or correlated across gates."
   ),
+  ramp: rampSchema.optional(),
   locked: z5.boolean().optional().describe("If `true`, dashboard hides edit controls.")
 }).describe(
-  "Percentage-rollout sub-gate. Hashes `bucketBy` (default `userID`) with `salt` and returns `true` for `rolloutPct/10000` fraction of callers."
+  "Percentage-rollout sub-gate. Hashes `bucketBy` (default `userID`) with `salt` and returns `true` for `rolloutPct/10000` fraction of callers (or the ramp's effective % when `ramp` is set)."
 );
 var stackedGateEntrySchema = z5.discriminatedUnion("type", [stackedConditionSchema, stackedRolloutSchema]).describe(
   "One entry in the ordered gatekeeper stack. Evaluated top-to-bottom; first matching entry decides. Mix `condition` and `rollout` entries to express `internal-only` + `1% beta` + `50% public` in a single gate."
@@ -458,7 +475,12 @@ var experimentGroupSchema = z8.object({
 var paramSchemaSchema = z8.record(z8.string(), z8.enum(["string", "bool", "number"])).describe(
   "Map of param-name \u2192 scalar type. Defines the shape of `groups[].params`. Example: `{ headline: 'string', show_cta: 'bool' }`."
 );
-var bucketBySchema = z8.enum(["user_id", "session_id", "device_id"]).describe("Identifier used as the bucketing key. `user_id` is sticky across sessions.");
+var bucketBySchema = z8.string().min(1).max(128).regex(
+  /^[a-zA-Z_][a-zA-Z0-9_]*$/,
+  "Must be a user-attribute name (letters, digits, underscore; not starting with a digit)."
+).describe(
+  "User-attribute name used as the bucketing key \u2014 e.g. `user_id` (default), `session_id`, `device_id`, or a custom attribute like `company_id` to keep a whole org on one variant. Defaults to `user_id` when omitted."
+);
 var experimentCreateSchema = z8.object({
   name: experimentNameSchema,
   description: z8.string().max(2e3).nullable().default(null).describe("Free-form description. Max 2000 chars, markdown rendered in the dashboard."),
@@ -717,6 +739,7 @@ export {
   metricNameSchema,
   pageQuerySchema,
   paramSchemaSchema,
+  rampSchema,
   stackedGateEntrySchema,
   switchKeySchema,
   universeCreateResponseSchema,