@storyblok/management-api-client 0.3.0 → 0.4.0

package/dist/generated/experiments/types.gen.d.mts

@@ -0,0 +1,522 @@
+//#region src/generated/experiments/types.gen.d.ts
+/**
+ * An A/B testing experiment
+ */
+type Experiment = {
+  /**
+   * Numeric ID of the experiment
+   */
+  id: number;
+  /**
+   * Internal name (lowercase letters, numbers, underscores)
+   */
+  name: string;
+  /**
+   * Human-readable display name
+   */
+  display_name: string;
+  /**
+   * Optional description of the experiment
+   */
+  description?: string | null;
+  /**
+   * Current status of the experiment
+   */
+  status: 'draft' | 'running' | 'paused' | 'completed';
+  /**
+   * Timestamp when the experiment was first activated
+   */
+  started_at?: string | null;
+  /**
+   * Timestamp when the experiment was completed
+   */
+  ended_at?: string | null;
+  /**
+   * Creation timestamp
+   */
+  created_at: string;
+  /**
+   * Last update timestamp
+   */
+  updated_at: string;
+  /**
+   * IDs of original stories assigned to this experiment
+   */
+  story_ids: Array<number>;
+  /**
+   * ID of the winning variant (set when completed with a winner)
+   */
+  winning_variant_id?: number | null;
+};
+/**
+ * Mapping between an original story and its variant copy
+ */
+type StoryMapping = {
+  /**
+   * ID of the variant this mapping belongs to
+   */
+  experiment_variant_id?: number;
+  /**
+   * ID of the original story
+   */
+  original_story_id?: number;
+  /**
+   * ID of the variant story copy
+   */
+  variant_story_id?: number | null;
+  /**
+   * Full slug of the original story
+   */
+  original_slug?: string | null;
+  /**
+   * Full slug of the variant story copy
+   */
+  variant_slug?: string | null;
+  /**
+   * The variant story object, when expanded
+   */
+  variant_story?: {
+    [key: string]: unknown;
+  } | null;
+};
+/**
+ * A variant within an experiment
+ */
+type ExperimentVariant = {
+  /**
+   * Numeric ID of the variant
+   */
+  id: number;
+  /**
+   * Internal name (lowercase, numbers, underscores)
+   */
+  name: string;
+  /**
+   * Human-readable display name
+   */
+  display_name: string;
+  /**
+   * Public identifier used for stable bucketing
+   */
+  public_id: string;
+  /**
+   * Traffic weight percentage (0-100)
+   */
+  weight: number;
+  /**
+   * Whether this is the control variant
+   */
+  is_control: boolean;
+  /**
+   * Story-level variant mappings
+   */
+  story_mappings: Array<StoryMapping>;
+};
+type ExperimentDetail = Experiment & {
+  /**
+   * Variants belonging to this experiment
+   */
+  experiment_variants: Array<ExperimentVariant>;
+  /**
+   * Metrics assigned to this experiment
+   */
+  experiment_assigned_metrics?: Array<{
+    [key: string]: unknown;
+  }>;
+};
+/**
+ * Input for creating an experiment
+ */
+type ExperimentCreate = {
+  /**
+   * Internal name (lowercase letters, numbers, underscores only)
+   */
+  name: string;
+  /**
+   * Human-readable display name
+   */
+  display_name: string;
+  /**
+   * Optional description of the experiment
+   */
+  description?: string;
+  /**
+   * IDs of stories to assign to this experiment
+   */
+  story_ids?: Array<number>;
+  /**
+   * Variants to create with the experiment
+   */
+  experiment_variants_attributes?: Array<{
+    name: string;
+    display_name: string;
+    weight?: number;
+    is_control?: boolean;
+  }>;
+};
+/**
+ * Input for updating an experiment
+ */
+type ExperimentUpdate = {
+  display_name?: string;
+  description?: string;
+  story_ids?: Array<number>;
+  /**
+   * Variants to add, update, or remove
+   */
+  experiment_variants_attributes?: Array<{
+    /**
+     * ID of an existing variant (required for update or delete)
+     */
+    id?: number;
+    name?: string;
+    display_name?: string;
+    weight?: number;
+    is_control?: boolean;
+    /**
+     * Set to true to remove this variant
+     */
+    _destroy?: boolean;
+  }>;
+};
+/**
+ * Bar chart with variant comparison data
+ */
+type BarChart = {
+  kind: 'bar';
+  title?: string | null;
+  xLabel?: string | null;
+  yLabel?: string | null;
+  labels: Array<string>;
+  series: Array<ChartSeries>;
+};
+/**
+ * Line chart for time-series data
+ */
+type LineChart = {
+  kind: 'line';
+  title?: string | null;
+  xLabel?: string | null;
+  yLabel?: string | null;
+  labels: Array<string>;
+  series: Array<ChartSeries>;
+};
+/**
+ * Text-only block for insights or summary copy
+ */
+type TextChart = {
+  kind: 'text';
+  title?: string | null;
+  /**
+   * Insight text content
+   */
+  body: string;
+};
+type ChartSeries = {
+  /**
+   * Series label
+   */
+  label: string;
+  /**
+   * Numeric data points aligned with labels
+   */
+  data: Array<number>;
+};
+/**
+ * A result chart. The kind field determines the chart type.
+ */
+type Chart = BarChart | LineChart | TextChart;
+/**
+ * Pre-computed result charts for an experiment
+ */
+type ExperimentResult = {
+  id: number;
+  experiment_id: number;
+  charts: Array<Chart>;
+  pushed_at: string;
+  created_at: string;
+  updated_at: string;
+};
+type ListData = {
+  body?: never;
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+  };
+  query?: {
+    /**
+     * Filter experiments by status
+     */
+    by_status?: 'draft' | 'running' | 'paused' | 'completed';
+    /**
+     * Filter experiments that include the given original story id
+     */
+    by_story_id?: number;
+    /**
+     * Filter experiments that include the given variant story id
+     */
+    by_variant_story_id?: number;
+    /**
+     * Page number for pagination
+     */
+    page?: number;
+    /**
+     * Number of experiments per page
+     */
+    per_page?: number;
+  };
+  url: '/v1/spaces/{space_id}/experiments';
+};
+type ListResponses = {
+  /**
+   * List of experiments
+   */
+  200: {
+    experiments: Array<ExperimentDetail>;
+  };
+};
+type CreateData = {
+  body: {
+    experiment: ExperimentCreate;
+  };
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+  };
+  query?: never;
+  url: '/v1/spaces/{space_id}/experiments';
+};
+type CreateResponses = {
+  /**
+   * Experiment created
+   */
+  201: {
+    experiment: ExperimentDetail;
+  };
+};
+type DeleteResponses = {
+  /**
+   * Experiment deleted
+   */
+  204: void;
+};
+type GetResponses = {
+  /**
+   * Experiment details
+   */
+  200: {
+    experiment: ExperimentDetail;
+  };
+};
+type UpdateData = {
+  body: {
+    experiment: ExperimentUpdate;
+  };
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+    /**
+     * The numeric ID of the experiment
+     */
+    experiment_id: number | string;
+  };
+  query?: never;
+  url: '/v1/spaces/{space_id}/experiments/{experiment_id}';
+};
+type UpdateResponses = {
+  /**
+   * Experiment updated
+   */
+  200: {
+    experiment: ExperimentDetail;
+  };
+};
+type ActivateData = {
+  body?: never;
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+    /**
+     * The numeric ID of the experiment
+     */
+    experiment_id: number | string;
+  };
+  query?: {
+    /**
+     * Optional scheduled end date for the experiment (ISO 8601)
+     */
+    end_date?: string;
+  };
+  url: '/v1/spaces/{space_id}/experiments/{experiment_id}/activate';
+};
+type ActivateResponses = {
+  /**
+   * Experiment details
+   */
+  200: {
+    experiment: ExperimentDetail;
+  };
+};
+type PauseResponses = {
+  /**
+   * Experiment details
+   */
+  200: {
+    experiment: ExperimentDetail;
+  };
+};
+type CompleteResponses = {
+  /**
+   * Experiment details
+   */
+  200: {
+    experiment: ExperimentDetail;
+  };
+};
+type CompleteWithWinnerResponses = {
+  /**
+   * Experiment details
+   */
+  200: {
+    experiment: ExperimentDetail;
+  };
+};
+type SelectWinnerResponses = {
+  /**
+   * Experiment details
+   */
+  200: {
+    experiment: ExperimentDetail;
+  };
+};
+type CreateExperimentStoryData = {
+  body: {
+    experiment_story: {
+      /**
+       * ID of the story to link
+       */
+      story_id: number;
+    };
+  };
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+    /**
+     * The numeric ID of the experiment
+     */
+    experiment_id: number | string;
+  };
+  query?: never;
+  url: '/v1/spaces/{space_id}/experiments/{experiment_id}/stories';
+};
+type CreateExperimentStoryResponses = {
+  /**
+   * Story linked
+   */
+  201: {
+    experiment: ExperimentDetail;
+  };
+};
+type DeleteExperimentStoryResponses = {
+  /**
+   * Story unlinked
+   */
+  204: void;
+};
+type CreateStoryMappingData = {
+  body: {
+    story_mapping: {
+      /**
+       * ID of the original story to map
+       */
+      original_story_id: number;
+      /**
+       * ID of an existing story to link as the variant. Omit to duplicate the original.
+       */
+      variant_story_id?: number | null;
+    };
+  };
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+    /**
+     * The numeric ID of the experiment
+     */
+    experiment_id: number | string;
+    /**
+     * The numeric ID of the experiment variant
+     */
+    variant_id: number | string;
+  };
+  query?: never;
+  url: '/v1/spaces/{space_id}/experiments/{experiment_id}/variants/{variant_id}/story_mappings';
+};
+type CreateStoryMappingResponses = {
+  /**
+   * Story mapping created
+   */
+  201: {
+    story_mapping: StoryMapping;
+  };
+};
+type DeleteStoryMappingResponses = {
+  /**
+   * Story mapping deleted
+   */
+  204: void;
+};
+type GetResultsResponses = {
+  /**
+   * Experiment results
+   */
+  200: {
+    experiment_result: ExperimentResult;
+  };
+  /**
+   * No results have been pushed yet
+   */
+  204: void;
+};
+type PushResultsData = {
+  body: {
+    /**
+     * Pre-computed chart snapshots (max 20)
+     */
+    charts: Array<Chart>;
+  };
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+    /**
+     * The numeric ID of the experiment
+     */
+    experiment_id: number | string;
+  };
+  query?: never;
+  url: '/v1/spaces/{space_id}/experiments/{experiment_id}/results';
+};
+type PushResultsResponses = {
+  /**
+   * Experiment results stored
+   */
+  200: {
+    experiment_result: ExperimentResult;
+  };
+};
+//#endregion
+export { ActivateData, ActivateResponses, CompleteResponses, CompleteWithWinnerResponses, CreateData, CreateExperimentStoryData, CreateExperimentStoryResponses, CreateResponses, CreateStoryMappingData, CreateStoryMappingResponses, DeleteExperimentStoryResponses, DeleteResponses, DeleteStoryMappingResponses, GetResponses, GetResultsResponses, ListData, ListResponses, PauseResponses, PushResultsData, PushResultsResponses, SelectWinnerResponses, UpdateData, UpdateResponses };
+//# sourceMappingURL=types.gen.d.mts.map

package/dist/index.cjs

@@ -11,6 +11,7 @@ const require_component_folders = require('./resources/component-folders.cjs');
 const require_components = require('./resources/components.cjs');
 const require_datasource_entries = require('./resources/datasource-entries.cjs');
 const require_datasources = require('./resources/datasources.cjs');
+const require_experiments = require('./resources/experiments.cjs');
 const require_internal_tags = require('./resources/internal-tags.cjs');
 const require_presets = require('./resources/presets.cjs');
 const require_spaces = require('./resources/spaces.cjs');
@@ -154,6 +155,7 @@ const createManagementApiClient = (config) => {
 		components: require_components.createComponentsResource(deps),
 		datasourceEntries: require_datasource_entries.createDatasourceEntriesResource(deps),
 		datasources: require_datasources.createDatasourcesResource(deps),
+		experiments: require_experiments.createExperimentsResource(deps),
 		delete: httpDelete,
 		get: httpGet,
 		patch: httpPatch,

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["createThrottleManager","createClient","createConfig","ClientError","createAssetFoldersResource","createAssetsResource","createComponentFoldersResource","createComponentsResource","createDatasourceEntriesResource","createDatasourcesResource","createInternalTagsResource","createPresetsResource","createSpacesResource","createStoriesResource","createUsersResource"],"sources":["../src/index.ts"],"sourcesContent":["import type { Client, ResolvedRequestOptions } from './generated/shared/client';\nimport type { Middleware } from './generated/shared/client/utils.gen';\nimport { createClient, createConfig } from './generated/shared/client';\nimport { getManagementBaseUrl } from '@storyblok/region-helper';\nimport { ClientError } from './error';\nimport { createThrottleManager } from './utils/rate-limit';\nimport { createAssetFoldersResource } from './resources/asset-folders';\nimport { createAssetsResource } from './resources/assets';\nimport { createComponentFoldersResource } from './resources/component-folders';\nimport { createComponentsResource } from './resources/components';\nimport { createDatasourceEntriesResource } from './resources/datasource-entries';\nimport { createDatasourcesResource } from './resources/datasources';\nimport { createInternalTagsResource } from './resources/internal-tags';\nimport { createPresetsResource } from './resources/presets';\nimport { createSpacesResource } from './resources/spaces';\nimport { createStoriesResource } from './resources/stories';\nimport { createUsersResource } from './resources/users';\nimport type {\n  ApiResponse,\n  HttpRequestOptions,\n  ManagementApiClientConfig,\n  MapiResourceDeps,\n} from './types';\n\nexport { ClientError } from './error';\n\nfunction getAuthorizationHeader(config: ManagementApiClientConfig): string | undefined {\n  if (config.personalAccessToken) {\n    return config.personalAccessToken;\n  }\n  if (config.oauthToken) {\n    return `Bearer ${config.oauthToken.replace(/^Bearer\\s+/i, '')}`;\n  }\n  return undefined;\n}\n\nexport const createManagementApiClient = (config: ManagementApiClientConfig) => {\n  const {\n    spaceId,\n    region = 'eu',\n    baseUrl,\n    headers = {},\n    throwOnError = false,\n    retry = {\n      limit: 12,\n      backoffLimit: 20_000,\n      methods: ['get', 'post', 'put', 'delete', 'patch', 'head', 'options', 'trace'],\n      statusCodes: [429],\n    },\n    timeout = 30_000,\n    rateLimit,\n  } = config;\n\n  const throttleManager = createThrottleManager(rateLimit ?? {});\n  const authHeader = getAuthorizationHeader(config);\n\n  const client: Client = createClient(\n    createConfig({\n      baseUrl: baseUrl || getManagementBaseUrl(region),\n      headers: {\n        ...(authHeader ? { Authorization: authHeader } : {}),\n        ...headers,\n      },\n      throwOnError,\n      kyOptions: {\n        throwHttpErrors: true,\n        timeout,\n        retry,\n      },\n    }),\n  );\n\n  client.interceptors.error.use(\n    (error: unknown, response: Response) =>\n      new ClientError(response?.statusText || 'API request failed', {\n        status: response?.status ?? 0,\n        statusText: response?.statusText ?? '',\n        data: error,\n      }),\n  );\n\n  /**\n   * Wraps an SDK call with throttling.\n   * When throwOnError is true, errors throw and data is guaranteed non-null.\n   */\n  function wrapRequest<TData, ThrowOnError extends boolean = false>(\n    fn: () => Promise<unknown>,\n    _throwOnError?: ThrowOnError,\n  ): Promise<ApiResponse<TData, ThrowOnError>> {\n    return throttleManager.execute(\n      () => fn() as Promise<ApiResponse<TData, ThrowOnError>>,\n    );\n  }\n\n  const deps: MapiResourceDeps = { client, spaceId, wrapRequest };\n\n  /**\n   * Escape hatch: send a GET request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpGet = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData>> => {\n    const { fetchOptions, ...rest } = options;\n    return wrapRequest<TData>(() =>\n      client.get({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  /**\n   * Escape hatch: send a POST request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpPost = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData>> => {\n    const { fetchOptions, ...rest } = options;\n    return wrapRequest<TData>(() =>\n      client.post({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  /**\n   * Escape hatch: send a PUT request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpPut = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData>> => {\n    const { fetchOptions, ...rest } = options;\n    return wrapRequest<TData>(() =>\n      client.put({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  /**\n   * Escape hatch: send a PATCH request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpPatch = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData>> => {\n    const { fetchOptions, ...rest } = options;\n    return wrapRequest<TData>(() =>\n      client.patch({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  /**\n   * Escape hatch: send a DELETE request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpDelete = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData>> => {\n    const { fetchOptions, ...rest } = options;\n    return wrapRequest<TData>(() =>\n      client.delete({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  return {\n    assetFolders: createAssetFoldersResource(deps),\n    assets: createAssetsResource(deps),\n    componentFolders: createComponentFoldersResource(deps),\n    components: createComponentsResource(deps),\n    datasourceEntries: createDatasourceEntriesResource(deps),\n    datasources: createDatasourcesResource(deps),\n    delete: httpDelete,\n    get: httpGet,\n    patch: httpPatch,\n    interceptors: client.interceptors as Middleware<Request, Response, unknown, ResolvedRequestOptions>,\n    internalTags: createInternalTagsResource(deps),\n    post: httpPost,\n    presets: createPresetsResource(deps),\n    put: httpPut,\n    spaces: createSpacesResource(deps),\n    stories: createStoriesResource(deps),\n    users: createUsersResource({ client, wrapRequest }),\n  };\n};\n\nexport type ManagementApiClient = ReturnType<typeof createManagementApiClient>;\n\nexport type {\n  ApiResponse,\n  Asset,\n  AssetCreate,\n  AssetField,\n  AssetFolder,\n  AssetFolderCreate,\n  AssetFolderUpdate,\n  AssetListQuery,\n  AssetSignRequest,\n  AssetUpdate,\n  AssetUpdateRequest,\n  AssetUploadRequest,\n  Component,\n  ComponentCreate,\n  ComponentFolder,\n  ComponentSchemaField,\n  ComponentUpdate,\n  Datasource,\n  DatasourceCreate,\n  DatasourceEntry,\n  DatasourceEntryCreate,\n  DatasourceEntryUpdate,\n  DatasourceUpdate,\n  FetchOptions,\n  HttpRequestOptions,\n  InternalTag,\n  ManagementApiClientConfig,\n  MapiResourceDeps,\n  MultilinkField,\n  PluginField,\n  Preset,\n  RateLimitConfig,\n  RequestConfigOverrides,\n  RichtextField,\n  SignedResponseObject,\n  Space,\n  SpaceCreate,\n  SpaceUpdate,\n  Story,\n  StoryAlternate,\n  StoryContent,\n  StoryCreate,\n  StoryListQuery,\n  StoryLocalizedPath,\n  StoryTranslatedSlug,\n  StoryUpdate,\n  TableField,\n  User,\n} from './types';\nexport { normalizeAssetUrl } from './utils/normalize-asset-url';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AA0BA,SAAS,uBAAuB,QAAuD;AACrF,KAAI,OAAO,oBACT,QAAO,OAAO;AAEhB,KAAI,OAAO,WACT,QAAO,UAAU,OAAO,WAAW,QAAQ,eAAe,GAAG;;AAKjE,MAAa,6BAA6B,WAAsC;CAC9E,MAAM,EACJ,SACA,SAAS,MACT,SACA,UAAU,EAAE,EACZ,eAAe,OACf,QAAQ;EACN,OAAO;EACP,cAAc;EACd,SAAS;GAAC;GAAO;GAAQ;GAAO;GAAU;GAAS;GAAQ;GAAW;GAAQ;EAC9E,aAAa,CAAC,IAAI;EACnB,EACD,UAAU,KACV,cACE;CAEJ,MAAM,kBAAkBA,yCAAsB,aAAa,EAAE,CAAC;CAC9D,MAAM,aAAa,uBAAuB,OAAO;CAEjD,MAAM,SAAiBC,gCACrBC,+BAAa;EACX,SAAS,8DAAgC,OAAO;EAChD,SAAS;GACP,GAAI,aAAa,EAAE,eAAe,YAAY,GAAG,EAAE;GACnD,GAAG;GACJ;EACD;EACA,WAAW;GACT,iBAAiB;GACjB;GACA;GACD;EACF,CAAC,CACH;AAED,QAAO,aAAa,MAAM,KACvB,OAAgB,aACf,IAAIC,0BAAY,UAAU,cAAc,sBAAsB;EAC5D,QAAQ,UAAU,UAAU;EAC5B,YAAY,UAAU,cAAc;EACpC,MAAM;EACP,CAAC,CACL;;;;;CAMD,SAAS,YACP,IACA,eAC2C;AAC3C,SAAO,gBAAgB,cACf,IAAI,CACX;;CAGH,MAAM,OAAyB;EAAE;EAAQ;EAAS;EAAa;;;;;CAM/D,MAAM,WACJ,MACA,UAA8B,EAAE,KACA;EAChC,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,kBACL,OAAO,IAAI;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CACjI;;;;;;CAOH,MAAM,YACJ,MACA,UAA8B,EAAE,KACA;EAChC,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,kBACL,OAAO,KAAK;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CAClI;;;;;;CAOH,MAAM,WACJ,MACA,UAA8B,EAAE,KACA;EAChC,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,kBACL,OAAO,IAAI;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CACjI;;;;;;CAOH,MAAM,aACJ,MACA,UAA8B,EAAE,KACA;EAChC,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,kBACL,OAAO,MAAM;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CACnI;;;;;;CAOH,MAAM,cACJ,MACA,UAA8B,EAAE,KACA;EAChC,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,kBACL,OAAO,OAAO;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CACpI;;AAGH,QAAO;EACL,cAAcC,iDAA2B,KAAK;EAC9C,QAAQC,oCAAqB,KAAK;EAClC,kBAAkBC,yDAA+B,KAAK;EACtD,YAAYC,4CAAyB,KAAK;EAC1C,mBAAmBC,2DAAgC,KAAK;EACxD,aAAaC,8CAA0B,KAAK;EAC5C,QAAQ;EACR,KAAK;EACL,OAAO;EACP,cAAc,OAAO;EACrB,cAAcC,iDAA2B,KAAK;EAC9C,MAAM;EACN,SAASC,sCAAsB,KAAK;EACpC,KAAK;EACL,QAAQC,oCAAqB,KAAK;EAClC,SAASC,sCAAsB,KAAK;EACpC,OAAOC,kCAAoB;GAAE;GAAQ;GAAa,CAAC;EACpD"}
+{"version":3,"file":"index.cjs","names":["createThrottleManager","createClient","createConfig","ClientError","createAssetFoldersResource","createAssetsResource","createComponentFoldersResource","createComponentsResource","createDatasourceEntriesResource","createDatasourcesResource","createExperimentsResource","createInternalTagsResource","createPresetsResource","createSpacesResource","createStoriesResource","createUsersResource"],"sources":["../src/index.ts"],"sourcesContent":["import type { Client, ResolvedRequestOptions } from './generated/shared/client';\nimport type { Middleware } from './generated/shared/client/utils.gen';\nimport { createClient, createConfig } from './generated/shared/client';\nimport { getManagementBaseUrl } from '@storyblok/region-helper';\nimport { ClientError } from './error';\nimport { createThrottleManager } from './utils/rate-limit';\nimport { createAssetFoldersResource } from './resources/asset-folders';\nimport { createAssetsResource } from './resources/assets';\nimport { createComponentFoldersResource } from './resources/component-folders';\nimport { createComponentsResource } from './resources/components';\nimport { createDatasourceEntriesResource } from './resources/datasource-entries';\nimport { createDatasourcesResource } from './resources/datasources';\nimport { createExperimentsResource } from './resources/experiments';\nimport { createInternalTagsResource } from './resources/internal-tags';\nimport { createPresetsResource } from './resources/presets';\nimport { createSpacesResource } from './resources/spaces';\nimport { createStoriesResource } from './resources/stories';\nimport { createUsersResource } from './resources/users';\nimport type {\n  ApiResponse,\n  HttpRequestOptions,\n  ManagementApiClientConfig,\n  MapiResourceDeps,\n} from './types';\n\nexport { ClientError } from './error';\n\nfunction getAuthorizationHeader(config: ManagementApiClientConfig): string | undefined {\n  if (config.personalAccessToken) {\n    return config.personalAccessToken;\n  }\n  if (config.oauthToken) {\n    return `Bearer ${config.oauthToken.replace(/^Bearer\\s+/i, '')}`;\n  }\n  return undefined;\n}\n\nexport const createManagementApiClient = (config: ManagementApiClientConfig) => {\n  const {\n    spaceId,\n    region = 'eu',\n    baseUrl,\n    headers = {},\n    throwOnError = false,\n    retry = {\n      limit: 12,\n      backoffLimit: 20_000,\n      methods: ['get', 'post', 'put', 'delete', 'patch', 'head', 'options', 'trace'],\n      statusCodes: [429],\n    },\n    timeout = 30_000,\n    rateLimit,\n  } = config;\n\n  const throttleManager = createThrottleManager(rateLimit ?? {});\n  const authHeader = getAuthorizationHeader(config);\n\n  const client: Client = createClient(\n    createConfig({\n      baseUrl: baseUrl || getManagementBaseUrl(region),\n      headers: {\n        ...(authHeader ? { Authorization: authHeader } : {}),\n        ...headers,\n      },\n      throwOnError,\n      kyOptions: {\n        throwHttpErrors: true,\n        timeout,\n        retry,\n      },\n    }),\n  );\n\n  client.interceptors.error.use(\n    (error: unknown, response: Response) =>\n      new ClientError(response?.statusText || 'API request failed', {\n        status: response?.status ?? 0,\n        statusText: response?.statusText ?? '',\n        data: error,\n      }),\n  );\n\n  /**\n   * Wraps an SDK call with throttling.\n   * When throwOnError is true, errors throw and data is guaranteed non-null.\n   */\n  function wrapRequest<TData, ThrowOnError extends boolean = false>(\n    fn: () => Promise<unknown>,\n    _throwOnError?: ThrowOnError,\n  ): Promise<ApiResponse<TData, ThrowOnError>> {\n    return throttleManager.execute(\n      () => fn() as Promise<ApiResponse<TData, ThrowOnError>>,\n    );\n  }\n\n  const deps: MapiResourceDeps = { client, spaceId, wrapRequest };\n\n  /**\n   * Escape hatch: send a GET request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpGet = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData>> => {\n    const { fetchOptions, ...rest } = options;\n    return wrapRequest<TData>(() =>\n      client.get({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  /**\n   * Escape hatch: send a POST request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpPost = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData>> => {\n    const { fetchOptions, ...rest } = options;\n    return wrapRequest<TData>(() =>\n      client.post({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  /**\n   * Escape hatch: send a PUT request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpPut = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData>> => {\n    const { fetchOptions, ...rest } = options;\n    return wrapRequest<TData>(() =>\n      client.put({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  /**\n   * Escape hatch: send a PATCH request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpPatch = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData>> => {\n    const { fetchOptions, ...rest } = options;\n    return wrapRequest<TData>(() =>\n      client.patch({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  /**\n   * Escape hatch: send a DELETE request to any MAPI endpoint not yet wrapped\n   * in a dedicated resource method.\n   */\n  const httpDelete = <TData = unknown>(\n    path: string,\n    options: HttpRequestOptions = {},\n  ): Promise<ApiResponse<TData>> => {\n    const { fetchOptions, ...rest } = options;\n    return wrapRequest<TData>(() =>\n      client.delete({ url: path, ...rest, ...(fetchOptions ? { kyOptions: { ...client.getConfig().kyOptions, ...fetchOptions } } : {}) }),\n    );\n  };\n\n  return {\n    assetFolders: createAssetFoldersResource(deps),\n    assets: createAssetsResource(deps),\n    componentFolders: createComponentFoldersResource(deps),\n    components: createComponentsResource(deps),\n    datasourceEntries: createDatasourceEntriesResource(deps),\n    datasources: createDatasourcesResource(deps),\n    experiments: createExperimentsResource(deps),\n    delete: httpDelete,\n    get: httpGet,\n    patch: httpPatch,\n    interceptors: client.interceptors as Middleware<Request, Response, unknown, ResolvedRequestOptions>,\n    internalTags: createInternalTagsResource(deps),\n    post: httpPost,\n    presets: createPresetsResource(deps),\n    put: httpPut,\n    spaces: createSpacesResource(deps),\n    stories: createStoriesResource(deps),\n    users: createUsersResource({ client, wrapRequest }),\n  };\n};\n\nexport type ManagementApiClient = ReturnType<typeof createManagementApiClient>;\n\nexport type {\n  ApiResponse,\n  Asset,\n  AssetCreate,\n  AssetField,\n  AssetFolder,\n  AssetFolderCreate,\n  AssetFolderUpdate,\n  AssetListQuery,\n  AssetSignRequest,\n  AssetUpdate,\n  AssetUpdateRequest,\n  AssetUploadRequest,\n  Component,\n  ComponentCreate,\n  ComponentFolder,\n  ComponentSchemaField,\n  ComponentUpdate,\n  Datasource,\n  DatasourceCreate,\n  DatasourceEntry,\n  DatasourceEntryCreate,\n  DatasourceEntryUpdate,\n  DatasourceUpdate,\n  FetchOptions,\n  HttpRequestOptions,\n  InternalTag,\n  ManagementApiClientConfig,\n  MapiResourceDeps,\n  MultilinkField,\n  PluginField,\n  Preset,\n  RateLimitConfig,\n  RequestConfigOverrides,\n  RichtextField,\n  SignedResponseObject,\n  Space,\n  SpaceCreate,\n  SpaceUpdate,\n  Story,\n  StoryAlternate,\n  StoryContent,\n  StoryCreate,\n  StoryListQuery,\n  StoryLocalizedPath,\n  StoryTranslatedSlug,\n  StoryUpdate,\n  TableField,\n  User,\n} from './types';\nexport { normalizeAssetUrl } from './utils/normalize-asset-url';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AA2BA,SAAS,uBAAuB,QAAuD;AACrF,KAAI,OAAO,oBACT,QAAO,OAAO;AAEhB,KAAI,OAAO,WACT,QAAO,UAAU,OAAO,WAAW,QAAQ,eAAe,GAAG;;AAKjE,MAAa,6BAA6B,WAAsC;CAC9E,MAAM,EACJ,SACA,SAAS,MACT,SACA,UAAU,EAAE,EACZ,eAAe,OACf,QAAQ;EACN,OAAO;EACP,cAAc;EACd,SAAS;GAAC;GAAO;GAAQ;GAAO;GAAU;GAAS;GAAQ;GAAW;GAAQ;EAC9E,aAAa,CAAC,IAAI;EACnB,EACD,UAAU,KACV,cACE;CAEJ,MAAM,kBAAkBA,yCAAsB,aAAa,EAAE,CAAC;CAC9D,MAAM,aAAa,uBAAuB,OAAO;CAEjD,MAAM,SAAiBC,gCACrBC,+BAAa;EACX,SAAS,8DAAgC,OAAO;EAChD,SAAS;GACP,GAAI,aAAa,EAAE,eAAe,YAAY,GAAG,EAAE;GACnD,GAAG;GACJ;EACD;EACA,WAAW;GACT,iBAAiB;GACjB;GACA;GACD;EACF,CAAC,CACH;AAED,QAAO,aAAa,MAAM,KACvB,OAAgB,aACf,IAAIC,0BAAY,UAAU,cAAc,sBAAsB;EAC5D,QAAQ,UAAU,UAAU;EAC5B,YAAY,UAAU,cAAc;EACpC,MAAM;EACP,CAAC,CACL;;;;;CAMD,SAAS,YACP,IACA,eAC2C;AAC3C,SAAO,gBAAgB,cACf,IAAI,CACX;;CAGH,MAAM,OAAyB;EAAE;EAAQ;EAAS;EAAa;;;;;CAM/D,MAAM,WACJ,MACA,UAA8B,EAAE,KACA;EAChC,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,kBACL,OAAO,IAAI;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CACjI;;;;;;CAOH,MAAM,YACJ,MACA,UAA8B,EAAE,KACA;EAChC,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,kBACL,OAAO,KAAK;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CAClI;;;;;;CAOH,MAAM,WACJ,MACA,UAA8B,EAAE,KACA;EAChC,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,kBACL,OAAO,IAAI;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CACjI;;;;;;CAOH,MAAM,aACJ,MACA,UAA8B,EAAE,KACA;EAChC,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,kBACL,OAAO,MAAM;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CACnI;;;;;;CAOH,MAAM,cACJ,MACA,UAA8B,EAAE,KACA;EAChC,MAAM,EAAE,cAAc,GAAG,SAAS;AAClC,SAAO,kBACL,OAAO,OAAO;GAAE,KAAK;GAAM,GAAG;GAAM,GAAI,eAAe,EAAE,WAAW;IAAE,GAAG,OAAO,WAAW,CAAC;IAAW,GAAG;IAAc,EAAE,GAAG,EAAE;GAAG,CAAC,CACpI;;AAGH,QAAO;EACL,cAAcC,iDAA2B,KAAK;EAC9C,QAAQC,oCAAqB,KAAK;EAClC,kBAAkBC,yDAA+B,KAAK;EACtD,YAAYC,4CAAyB,KAAK;EAC1C,mBAAmBC,2DAAgC,KAAK;EACxD,aAAaC,8CAA0B,KAAK;EAC5C,aAAaC,8CAA0B,KAAK;EAC5C,QAAQ;EACR,KAAK;EACL,OAAO;EACP,cAAc,OAAO;EACrB,cAAcC,iDAA2B,KAAK;EAC9C,MAAM;EACN,SAASC,sCAAsB,KAAK;EACpC,KAAK;EACL,QAAQC,oCAAqB,KAAK;EAClC,SAASC,sCAAsB,KAAK;EACpC,OAAOC,kCAAoB;GAAE;GAAQ;GAAa,CAAC;EACpD"}

package/dist/index.d.cts

@@ -16,6 +16,7 @@ import { MeResponses, UpdateMeData, UpdateMeResponses, User } from "./generated/
 import { SpaceIdPathOverride } from "./resources/shared.cjs";
 import { AssetCreate, AssetUploadRequest } from "./resources/assets.cjs";
 import { ApiResponse, AssetListQuery, FetchOptions, HttpRequestOptions, ManagementApiClientConfig, MapiResourceDeps, RequestConfigOverrides, Story, StoryListQuery } from "./types.cjs";
+import { ActivateData, ActivateResponses, CompleteResponses, CompleteWithWinnerResponses, CreateData as CreateData$9, CreateExperimentStoryData, CreateExperimentStoryResponses, CreateResponses as CreateResponses$9, CreateStoryMappingData, CreateStoryMappingResponses, DeleteExperimentStoryResponses, DeleteResponses as DeleteResponses$5, DeleteStoryMappingResponses, GetResponses as GetResponses$9, GetResultsResponses, ListData as ListData$10, ListResponses as ListResponses$10, PauseResponses, PushResultsData, PushResultsResponses, SelectWinnerResponses, UpdateData as UpdateData$10, UpdateResponses as UpdateResponses$7 } from "./generated/experiments/types.gen.cjs";
 import { normalizeAssetUrl } from "./utils/normalize-asset-url.cjs";
 
 //#region src/index.d.ts
@@ -272,6 +273,101 @@ declare const createManagementApiClient: (config: ManagementApiClientConfig) =>
       fetchOptions?: FetchOptions;
     } & SpaceIdPathOverride): Promise<ApiResponse<void, ThrowOnError>>;
   };
+  experiments: {
+    list<ThrowOnError extends boolean = false>(options?: {
+      query?: ListData$10["query"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError;
+      fetchOptions?: FetchOptions;
+    } & SpaceIdPathOverride): Promise<ApiResponse<ListResponses$10[200], ThrowOnError>>;
+    get<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError;
+      fetchOptions?: FetchOptions;
+    } & SpaceIdPathOverride): Promise<ApiResponse<GetResponses$9[200], ThrowOnError>>;
+    create<ThrowOnError extends boolean = false>(options: {
+      body: CreateData$9["body"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError;
+      fetchOptions?: FetchOptions;
+    } & SpaceIdPathOverride): Promise<ApiResponse<CreateResponses$9[201], ThrowOnError>>;
+    update<ThrowOnError extends boolean = false>(experimentId: number | string, options: {
+      body: UpdateData$10["body"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError;
+      fetchOptions?: FetchOptions;
+    } & SpaceIdPathOverride): Promise<ApiResponse<UpdateResponses$7[200], ThrowOnError>>;
+    delete<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError;
+      fetchOptions?: FetchOptions;
+    } & SpaceIdPathOverride): Promise<ApiResponse<DeleteResponses$5[204], ThrowOnError>>;
+    activate<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
+      query?: ActivateData["query"];
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError;
+      fetchOptions?: FetchOptions;
+    } & SpaceIdPathOverride): Promise<ApiResponse<ActivateResponses[200], ThrowOnError>>;
+    pause<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError;
+      fetchOptions?: FetchOptions;
+    } & SpaceIdPathOverride): Promise<ApiResponse<PauseResponses[200], ThrowOnError>>;
+    complete<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError;
+      fetchOptions?: FetchOptions;
+    } & SpaceIdPathOverride): Promise<ApiResponse<CompleteResponses[200], ThrowOnError>>;
+    completeWithWinner<ThrowOnError extends boolean = false>(experimentId: number | string, variantId: number, options?: {
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError;
+      fetchOptions?: FetchOptions;
+    } & SpaceIdPathOverride): Promise<ApiResponse<CompleteWithWinnerResponses[200], ThrowOnError>>;
+    selectWinner<ThrowOnError extends boolean = false>(experimentId: number | string, variantId: number, options?: {
+      signal?: AbortSignal;
+      throwOnError?: ThrowOnError;
+      fetchOptions?: FetchOptions;
+    } & SpaceIdPathOverride): Promise<ApiResponse<SelectWinnerResponses[200], ThrowOnError>>;
+    stories: {
+      create<ThrowOnError extends boolean = false>(experimentId: number | string, options: {
+        body: CreateExperimentStoryData["body"];
+        signal?: AbortSignal;
+        throwOnError?: ThrowOnError;
+        fetchOptions?: FetchOptions;
+      } & SpaceIdPathOverride): Promise<ApiResponse<CreateExperimentStoryResponses[201], ThrowOnError>>;
+      delete<ThrowOnError extends boolean = false>(experimentId: number | string, storyId: number | string, options?: {
+        signal?: AbortSignal;
+        throwOnError?: ThrowOnError;
+        fetchOptions?: FetchOptions;
+      } & SpaceIdPathOverride): Promise<ApiResponse<DeleteExperimentStoryResponses[204], ThrowOnError>>;
+    };
+    storyMappings: {
+      create<ThrowOnError extends boolean = false>(experimentId: number | string, variantId: number | string, options: {
+        body: CreateStoryMappingData["body"];
+        signal?: AbortSignal;
+        throwOnError?: ThrowOnError;
+        fetchOptions?: FetchOptions;
+      } & SpaceIdPathOverride): Promise<ApiResponse<CreateStoryMappingResponses[201], ThrowOnError>>;
+      delete<ThrowOnError extends boolean = false>(experimentId: number | string, variantId: number | string, originalStoryId: number | string, options?: {
+        signal?: AbortSignal;
+        throwOnError?: ThrowOnError;
+        fetchOptions?: FetchOptions;
+      } & SpaceIdPathOverride): Promise<ApiResponse<DeleteStoryMappingResponses[204], ThrowOnError>>;
+    };
+    results: {
+      get<ThrowOnError extends boolean = false>(experimentId: number | string, options?: {
+        signal?: AbortSignal;
+        throwOnError?: ThrowOnError;
+        fetchOptions?: FetchOptions;
+      } & SpaceIdPathOverride): Promise<ApiResponse<GetResultsResponses[200], ThrowOnError>>;
+      push<ThrowOnError extends boolean = false>(experimentId: number | string, options: {
+        body: PushResultsData["body"];
+        signal?: AbortSignal;
+        throwOnError?: ThrowOnError;
+        fetchOptions?: FetchOptions;
+      } & SpaceIdPathOverride): Promise<ApiResponse<PushResultsResponses[200], ThrowOnError>>;
+    };
+  };
   delete: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData>>;
   get: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData>>;
   patch: <TData = unknown>(path: string, options?: HttpRequestOptions) => Promise<ApiResponse<TData>>;