@launchdarkly/mcp-server
Version:
The local [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server for [LaunchDarkly](https://launchdarkly.com/) federal and European Union (EU) environments.
313 lines • 11.7 kB
JavaScript
;
/*
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.experimentsPatch = experimentsPatch;
const encodings_js_1 = require("../lib/encodings.js");
const M = __importStar(require("../lib/matchers.js"));
const primitives_js_1 = require("../lib/primitives.js");
const schemas_js_1 = require("../lib/schemas.js");
const security_js_1 = require("../lib/security.js");
const url_js_1 = require("../lib/url.js");
const components = __importStar(require("../models/components/index.js"));
const errors = __importStar(require("../models/errors/index.js"));
const operations = __importStar(require("../models/operations/index.js"));
const async_js_1 = require("../types/async.js");
/**
* Patch experiment
*
* @remarks
* Update an experiment. Updating an experiment uses the semantic patch format.
*
* To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch).
*
* ### Instructions
*
* Semantic patch requests support the following `kind` instructions for updating experiments.
*
* #### updateName
*
* > **Deprecated**: `updateName` will be removed in a future version. Use `updateExperimentFields` instead.
*
* Updates the experiment name.
*
* ##### Parameters
*
* - `value`: The new name.
*
* Here's an example:
*
* ```json
* {
* "instructions": [{
* "kind": "updateName",
* "value": "Example updated experiment name"
* }]
* }
* ```
*
* #### updateDescription
*
* > **Deprecated**: `updateDescription` will be removed in a future version. Use `updateExperimentFields` instead.
*
* Updates the experiment description.
*
* ##### Parameters
*
* - `value`: The new description.
*
* Here's an example:
*
* ```json
* {
* "instructions": [{
* "kind": "updateDescription",
* "value": "Example updated description"
* }]
* }
* ```
*
* #### updateExperimentFields
*
* Updates one or more fields on an experiment or its current iteration. Each field update specifies an operation (`add`, `update`, or `remove`) and an optional value.
*
* Which fields are mutable depends on the current iteration status. To discover which fields and operations are allowed, expand `mutableFieldsByStatus` on the [Get experiment](https://launchdarkly.com/docs/api/experiments/get-experiment) response.
*
* ##### Parameters
*
* - `value`: An object mapping field names to field updates. Each field update has the following properties:
* - `operation`: The operation to perform. One of `add`, `update`, or `remove`.
* - `value`: The new value for the field. Required for `add` and `update` operations.
*
* To find which fields are supported and which operations are allowed for each iteration status, expand `mutableFieldsByStatus` on the [Get experiment](https://launchdarkly.com/docs/api/experiments/get-experiment) response.
*
* Here's an example:
*
* ```json
* {
* "instructions": [{
* "kind": "updateExperimentFields",
* "value": {
* "name": {
* "operation": "update",
* "value": "Updated experiment name"
* },
* "tags": {
* "operation": "add",
* "value": ["tag1", "tag2"]
* }
* }
* }]
* }
* ```
*
* #### saveAndStartNewIteration
*
* Stops the current running iteration, creates a new iteration from it, optionally applies field updates, and starts the new iteration. This is a convenience instruction that combines stopping, updating, and starting in a single operation.
*
* ##### Parameters
*
* - `changeJustification`: (Optional) The reason for stopping and starting a new iteration.
* - `value`: (Optional) An object mapping field names to field updates, using the same format as `updateExperimentFields`. These updates are applied to the new iteration before it is started.
*
* Here's an example:
*
* ```json
* {
* "instructions": [{
* "kind": "saveAndStartNewIteration",
* "changeJustification": "Adjusting hypothesis based on early results",
* "value": {
* "hypothesis": {
* "operation": "update",
* "value": "Updated hypothesis text"
* }
* }
* }]
* }
* ```
*
* #### startIteration
*
* Starts a new iteration for this experiment. You must [create a new iteration](https://launchdarkly.com/docs/api/experiments/create-iteration) before calling this instruction.
*
* An iteration may not be started until it meets the following criteria:
*
* * Its associated flag is toggled on and is not archived
* * Its `randomizationUnit` is set
* * At least one of its `treatments` has a non-zero `allocationPercent`
*
* ##### Parameters
*
* - `changeJustification`: The reason for starting a new iteration. Required when you call `startIteration` on an already running experiment, otherwise optional.
*
* Here's an example:
*
* ```json
* {
* "instructions": [{
* "kind": "startIteration",
* "changeJustification": "It's time to start a new iteration"
* }]
* }
* ```
*
* #### stopIteration
*
* Stops the current iteration for this experiment.
*
* ##### Parameters
*
* - `winningTreatmentId`: The ID of the winning treatment. Treatment IDs are returned as part of the [Get experiment](https://launchdarkly.com/docs/api/experiments/get-experiment) response. They are the `_id` of each element in the `treatments` array.
* - `winningReason`: The reason for the winner
*
* Here's an example:
*
* ```json
* {
* "instructions": [{
* "kind": "stopIteration",
* "winningTreatmentId": "3a548ec2-72ac-4e59-8518-5c24f5609ccf",
* "winningReason": "Example reason to stop the iteration"
* }]
* }
* ```
*
* #### archiveExperiment
*
* Archives this experiment. Archived experiments are hidden by default in the LaunchDarkly user interface. You cannot start new iterations for archived experiments.
*
* Here's an example:
*
* ```json
* {
* "instructions": [{ "kind": "archiveExperiment" }]
* }
* ```
*
* #### restoreExperiment
*
* Restores an archived experiment. After restoring an experiment, you can start new iterations for it again.
*
* Here's an example:
*
* ```json
* {
* "instructions": [{ "kind": "restoreExperiment" }]
* }
* ```
*/
function experimentsPatch(client, request, options) {
return new async_js_1.APIPromise($do(client, request, options));
}
async function $do(client, request, options) {
const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.PatchExperimentRequest$outboundSchema.parse(value), "Input validation failed");
if (!parsed.ok) {
return [parsed, { status: "invalid" }];
}
const payload = parsed.value;
const body = (0, encodings_js_1.encodeJSON)("body", payload.ExperimentPatchInput, {
explode: true,
});
const pathParams = {
environmentKey: (0, encodings_js_1.encodeSimple)("environmentKey", payload.environmentKey, {
explode: false,
charEncoding: "percent",
}),
experimentKey: (0, encodings_js_1.encodeSimple)("experimentKey", payload.experimentKey, {
explode: false,
charEncoding: "percent",
}),
projectKey: (0, encodings_js_1.encodeSimple)("projectKey", payload.projectKey, {
explode: false,
charEncoding: "percent",
}),
};
const path = (0, url_js_1.pathToFunc)("/api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}")(pathParams);
const headers = new Headers((0, primitives_js_1.compactMap)({
"Content-Type": "application/json",
Accept: "application/json",
}));
const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey);
const securityInput = secConfig == null ? {} : { apiKey: secConfig };
const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput);
const context = {
options: client._options,
baseURL: options?.serverURL ?? client._baseURL ?? "",
operationID: "patchExperiment",
oAuth2Scopes: null,
resolvedSecurity: requestSecurity,
securitySource: client._options.apiKey,
retryConfig: options?.retries
|| client._options.retryConfig
|| { strategy: "none" },
retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
};
const requestRes = client._createRequest(context, {
security: requestSecurity,
method: "PATCH",
baseURL: options?.serverURL,
path: path,
headers: headers,
body: body,
userAgent: client._options.userAgent,
timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
}, options);
if (!requestRes.ok) {
return [requestRes, { status: "invalid" }];
}
const req = requestRes.value;
const doResult = await client._do(req, {
context,
errorCodes: ["400", "401", "403", "404", "409", "422", "429", "4XX", "5XX"],
retryConfig: context.retryConfig,
retryCodes: context.retryCodes,
});
if (!doResult.ok) {
return [doResult, { status: "request-error", request: req }];
}
const response = doResult.value;
const responseFields = {
HttpMeta: { Response: response, Request: req },
};
const [result] = await M.match(M.json(200, components.Experiment$inboundSchema), M.jsonErr(400, errors.InvalidRequestErrorRep$inboundSchema), M.jsonErr(401, errors.UnauthorizedErrorRep$inboundSchema), M.jsonErr(403, errors.ForbiddenErrorRep$inboundSchema), M.jsonErr(404, errors.NotFoundErrorRep$inboundSchema), M.jsonErr(409, errors.StatusConflictErrorRep$inboundSchema), M.jsonErr(422, errors.PatchFailedErrorRep$inboundSchema), M.jsonErr(429, errors.RateLimitedErrorRep$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
if (!result.ok) {
return [result, { status: "complete", request: req, response }];
}
return [result, { status: "complete", request: req, response }];
}
//# sourceMappingURL=experimentsPatch.js.map