@storyblok/management-api-client 0.5.1 → 0.6.1

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

@@ -1,348 +0,0 @@
-//#region src/generated/users/types.gen.d.ts
-/**
- * The User Object
- */
-type User = {
-  /**
-   * User ID
-   */
-  readonly id: number;
-  /**
-   * User's email address
-   */
-  email: string;
-  /**
-   * User's alternative email address
-   */
-  alt_email?: string;
-  /**
-   * User's first name
-   */
-  firstname?: string;
-  /**
-   * User's last name
-   */
-  lastname?: string;
-  /**
-   * User's username
-   */
-  username?: string;
-  /**
-   * User's avatar URL
-   */
-  avatar?: string;
-  /**
-   * User's preferred language
-   */
-  lang?: string;
-  /**
-   * User's timezone
-   */
-  timezone?: string;
-  /**
-   * User's phone number
-   */
-  phone?: string;
-  /**
-   * Whether user is an editor
-   */
-  is_editor?: boolean;
-  /**
-   * User's job role
-   */
-  job_role?: string;
-  /**
-   * User's job title
-   */
-  job_title?: string;
-  /**
-   * User's company name
-   */
-  company_name?: string;
-  /**
-   * User's company size
-   */
-  company_size?: string;
-  /**
-   * User's usage type
-   */
-  usage_type?: string;
-  /**
-   * Framework used by user
-   */
-  framework_used?: string;
-  /**
-   * Whether user is a beta user
-   */
-  beta_user?: boolean;
-  /**
-   * Whether user allows statistics tracking
-   */
-  track_statistics?: boolean;
-  /**
-   * User's favorite spaces
-   */
-  favourite_spaces?: Array<number>;
-  /**
-   * User's favorite ideas
-   */
-  favourite_ideas?: Array<number>;
-  /**
-   * User's notification preferences
-   */
-  notified?: Array<string>;
-  /**
-   * User's disclaimer IDs
-   */
-  disclaimer_ids?: Array<number>;
-  /**
-   * Whether the user belongs to an organization
-   */
-  has_org?: boolean;
-  /**
-   * Whether the user has an approved partner status
-   */
-  has_partner?: boolean;
-  /**
-   * Partner status (e.g., 'approved')
-   */
-  partner_status?: string;
-  /**
-   * User's role in the organization (admin, owner, member)
-   */
-  org_role?: string;
-  /**
-   * User's role as a partner (partner_owner, partner_member)
-   */
-  partner_role?: string;
-  /**
-   * Organization information
-   */
-  org?: {
-    /**
-     * Organization name
-     */
-    name?: string;
-    /**
-     * Organization status
-     */
-    status?: string;
-  };
-  /**
-   * User's system role (admin, normal, banned, sso, superuser, devops, marketer)
-   */
-  role?: string;
-  /**
-   * Whether the user uses SSO authentication
-   */
-  sso?: boolean;
-  /**
-   * Whether TOTP factor is verified
-   */
-  totp_factor_verified?: boolean;
-  /**
-   * Configured two-factor authentication options
-   */
-  configured_2fa_options?: Array<string>;
-  /**
-   * Whether live chat is enabled for the user
-   */
-  live_chat_enabled?: boolean;
-  /**
-   * User-friendly display name for the user, shown in interfaces or reports to identify the user in a readable way.
-   */
-  friendly_name?: string;
-  /**
-   * User creation date
-   */
-  created_at: string;
-  /**
-   * User last update date
-   */
-  updated_at: string;
-};
-/**
- * The User Object
- */
-type UserWritable = {
-  /**
-   * User's email address
-   */
-  email: string;
-  /**
-   * User's alternative email address
-   */
-  alt_email?: string;
-  /**
-   * User's first name
-   */
-  firstname?: string;
-  /**
-   * User's last name
-   */
-  lastname?: string;
-  /**
-   * User's username
-   */
-  username?: string;
-  /**
-   * User's avatar URL
-   */
-  avatar?: string;
-  /**
-   * User's preferred language
-   */
-  lang?: string;
-  /**
-   * User's timezone
-   */
-  timezone?: string;
-  /**
-   * User's phone number
-   */
-  phone?: string;
-  /**
-   * Whether user is an editor
-   */
-  is_editor?: boolean;
-  /**
-   * User's job role
-   */
-  job_role?: string;
-  /**
-   * User's job title
-   */
-  job_title?: string;
-  /**
-   * User's company name
-   */
-  company_name?: string;
-  /**
-   * User's company size
-   */
-  company_size?: string;
-  /**
-   * User's usage type
-   */
-  usage_type?: string;
-  /**
-   * Framework used by user
-   */
-  framework_used?: string;
-  /**
-   * Whether user is a beta user
-   */
-  beta_user?: boolean;
-  /**
-   * Whether user allows statistics tracking
-   */
-  track_statistics?: boolean;
-  /**
-   * User's favorite spaces
-   */
-  favourite_spaces?: Array<number>;
-  /**
-   * User's favorite ideas
-   */
-  favourite_ideas?: Array<number>;
-  /**
-   * User's notification preferences
-   */
-  notified?: Array<string>;
-  /**
-   * User's disclaimer IDs
-   */
-  disclaimer_ids?: Array<number>;
-  /**
-   * Whether the user belongs to an organization
-   */
-  has_org?: boolean;
-  /**
-   * Whether the user has an approved partner status
-   */
-  has_partner?: boolean;
-  /**
-   * Partner status (e.g., 'approved')
-   */
-  partner_status?: string;
-  /**
-   * User's role in the organization (admin, owner, member)
-   */
-  org_role?: string;
-  /**
-   * User's role as a partner (partner_owner, partner_member)
-   */
-  partner_role?: string;
-  /**
-   * Organization information
-   */
-  org?: {
-    /**
-     * Organization name
-     */
-    name?: string;
-    /**
-     * Organization status
-     */
-    status?: string;
-  };
-  /**
-   * User's system role (admin, normal, banned, sso, superuser, devops, marketer)
-   */
-  role?: string;
-  /**
-   * Whether the user uses SSO authentication
-   */
-  sso?: boolean;
-  /**
-   * Whether TOTP factor is verified
-   */
-  totp_factor_verified?: boolean;
-  /**
-   * Configured two-factor authentication options
-   */
-  configured_2fa_options?: Array<string>;
-  /**
-   * Whether live chat is enabled for the user
-   */
-  live_chat_enabled?: boolean;
-  /**
-   * User-friendly display name for the user, shown in interfaces or reports to identify the user in a readable way.
-   */
-  friendly_name?: string;
-  /**
-   * User creation date
-   */
-  created_at: string;
-  /**
-   * User last update date
-   */
-  updated_at: string;
-};
-type MeResponses = {
-  /**
-   * Current user details
-   */
-  200: {
-    user?: User;
-  };
-};
-type UpdateMeData = {
-  body: {
-    user: UserWritable;
-  };
-  path?: never;
-  query?: never;
-  url: '/v1/users/me';
-};
-type UpdateMeResponses = {
-  /**
-   * User updated
-   */
-  200: {
-    user?: User;
-  };
-};
-//#endregion
-export { MeResponses, UpdateMeData, UpdateMeResponses, User };
-//# sourceMappingURL=types.gen.d.mts.map

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","names":["createThrottleManager","createClient","createConfig","ClientError","createAssetFoldersResource","createAssetsResource","createComponentFoldersResource","createComponentsResource","createDatasourceEntriesResource","createDatasourcesResource","createExperimentsResource","createInternalTagsResource","createPresetsResource","createSharedAssetFoldersResource","createSharedAssetsResource","createSharedInternalTagsResource","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 { createSharedAssetFoldersResource } from './resources/shared-asset-folders';\nimport { createSharedAssetsResource } from './resources/shared-assets';\nimport { createSharedInternalTagsResource } from './resources/shared-internal-tags';\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    sharedAssetFolders: createSharedAssetFoldersResource(deps),\n    sharedAssets: createSharedAssetsResource(deps),\n    sharedInternalTags: createSharedInternalTagsResource(deps),\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 { AccessLevel, AssetFolderAccess, SharedAssetFolder, SharedAssetFolderCreate, SharedAssetFolderGetResponse, SharedAssetFolderListResponse, SharedAssetFolderUpdate } from './resources/shared-asset-folders';\nexport type { SharedAssetCreate, SharedAssetListQuery, SharedAssetListResponse, SharedAssetUploadRequest } from './resources/shared-assets';\nexport type { SharedInternalTag, SharedInternalTagCreate, SharedInternalTagListQuery, SharedInternalTagListResponse, SharedInternalTagMutateResponse, SharedInternalTagObjectType } from './resources/shared-internal-tags';\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":";;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,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,oBAAoBC,8DAAiC,KAAK;EAC1D,cAAcC,iDAA2B,KAAK;EAC9C,oBAAoBC,8DAAiC,KAAK;EAC1D,QAAQC,oCAAqB,KAAK;EAClC,SAASC,sCAAsB,KAAK;EACpC,OAAOC,kCAAoB;GAAE;GAAQ;GAAa,CAAC;EACpD"}

package/dist/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.mjs","names":[],"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 { createSharedAssetFoldersResource } from './resources/shared-asset-folders';\nimport { createSharedAssetsResource } from './resources/shared-assets';\nimport { createSharedInternalTagsResource } from './resources/shared-internal-tags';\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    sharedAssetFolders: createSharedAssetFoldersResource(deps),\n    sharedAssets: createSharedAssetsResource(deps),\n    sharedInternalTags: createSharedInternalTagsResource(deps),\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 { AccessLevel, AssetFolderAccess, SharedAssetFolder, SharedAssetFolderCreate, SharedAssetFolderGetResponse, SharedAssetFolderListResponse, SharedAssetFolderUpdate } from './resources/shared-asset-folders';\nexport type { SharedAssetCreate, SharedAssetListQuery, SharedAssetListResponse, SharedAssetUploadRequest } from './resources/shared-assets';\nexport type { SharedInternalTag, SharedInternalTagCreate, SharedInternalTagListQuery, SharedInternalTagListResponse, SharedInternalTagMutateResponse, SharedInternalTagObjectType } from './resources/shared-internal-tags';\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":";;;;;;;;;;;;;;;;;;;;;;;;AA8BA,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,kBAAkB,sBAAsB,aAAa,EAAE,CAAC;CAC9D,MAAM,aAAa,uBAAuB,OAAO;CAEjD,MAAM,SAAiB,aACrB,aAAa;EACX,SAAS,WAAW,qBAAqB,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,IAAI,YAAY,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,cAAc,2BAA2B,KAAK;EAC9C,QAAQ,qBAAqB,KAAK;EAClC,kBAAkB,+BAA+B,KAAK;EACtD,YAAY,yBAAyB,KAAK;EAC1C,mBAAmB,gCAAgC,KAAK;EACxD,aAAa,0BAA0B,KAAK;EAC5C,aAAa,0BAA0B,KAAK;EAC5C,QAAQ;EACR,KAAK;EACL,OAAO;EACP,cAAc,OAAO;EACrB,cAAc,2BAA2B,KAAK;EAC9C,MAAM;EACN,SAAS,sBAAsB,KAAK;EACpC,KAAK;EACL,oBAAoB,iCAAiC,KAAK;EAC1D,cAAc,2BAA2B,KAAK;EAC9C,oBAAoB,iCAAiC,KAAK;EAC1D,QAAQ,qBAAqB,KAAK;EAClC,SAAS,sBAAsB,KAAK;EACpC,OAAO,oBAAoB;GAAE;GAAQ;GAAa,CAAC;EACpD"}

package/dist/types.d.cts

@@ -1,130 +0,0 @@
-import { AssetFolder, AssetFolderCreate, AssetFolderUpdate } from "./generated/asset_folders/types.gen.cjs";
-import { Asset, AssetSignRequest, AssetUpdate, AssetUpdateRequest, ListData, SignedResponseObject } from "./generated/assets/types.gen.cjs";
-import { AssetField, ListData as ListData$1, MultilinkField, PluginField, RichtextField, StoryAlternate, StoryContent, StoryCreate, StoryLocalizedPath, StoryMapi, StoryTranslatedSlug, StoryUpdate, TableField } from "./generated/stories/types.gen.cjs";
-import { Client, RetryOptions } from "./generated/shared/client/types.gen.cjs";
-import { ClientError } from "./error.cjs";
-import { RateLimitConfig } from "./utils/rate-limit.cjs";
-import { ComponentFolder } from "./generated/component_folders/types.gen.cjs";
-import { Component, ComponentCreate, ComponentSchemaField, ComponentUpdate } from "./generated/components/types.gen.cjs";
-import { DatasourceEntry, DatasourceEntryCreate, DatasourceEntryUpdate } from "./generated/datasource_entries/types.gen.cjs";
-import { Datasource, DatasourceCreate, DatasourceUpdate } from "./generated/datasources/types.gen.cjs";
-import { InternalTag } from "./generated/internal_tags/types.gen.cjs";
-import { Preset } from "./generated/presets/types.gen.cjs";
-import { Space, SpaceCreate, SpaceUpdate } from "./generated/spaces/types.gen.cjs";
-import { User } from "./generated/users/types.gen.cjs";
-import { AssetCreate, AssetUploadRequest } from "./resources/assets.cjs";
-import { Region } from "@storyblok/region-helper";
-
-//#region src/types.d.ts
-type Prettify<T> = { [K in keyof T]: T[K] } & {};
-type ApiResponse<T, ThrowOnError extends boolean = false> = ThrowOnError extends true ? {
-  data: T;
-  response: Response;
-  request: Request;
-} : {
-  data: T;
-  error: undefined;
-  response: Response;
-  request: Request;
-} | {
-  data: undefined;
-  error: ClientError;
-  response: Response;
-  request: Request;
-};
-interface RequestConfigOverrides {
-  throwOnError?: boolean;
-}
-/**
- * Arbitrary options forwarded to the underlying `fetch()` call.
- *
- * Standard `RequestInit` properties (`cache`, `credentials`, `mode`, …) and
- * non-standard, vendor-specific properties (Next.js `next`, Cloudflare `cf`, …)
- * are both supported.
- *
- * @example
- * ```ts
- * client.stories.get(123, {
- *   fetchOptions: {
- *     cache: 'no-store',
- *     next: { revalidate: 60 },
- *   },
- * })
- * ```
- */
-type FetchOptions = Record<string, unknown>;
-interface HttpRequestOptions {
-  query?: Record<string, unknown>;
-  body?: unknown;
-  headers?: Record<string, string>;
-  signal?: AbortSignal;
-  throwOnError?: RequestConfigOverrides['throwOnError'];
-  fetchOptions?: FetchOptions;
-}
-/**
- * Dependencies injected into every resource factory.
- */
-interface MapiResourceDeps {
-  client: Client;
-  spaceId?: number;
-  wrapRequest: <TData, ThrowOnError extends boolean = false>(fn: () => Promise<unknown>, throwOnError?: ThrowOnError) => Promise<ApiResponse<TData, ThrowOnError>>;
-}
-interface ManagementApiClientConfig {
-  /**
-   * Personal access token for authentication.
-   * Provide either `personalAccessToken` or `oauthToken`.
-   */
-  personalAccessToken?: string;
-  /**
-   * OAuth bearer token for authentication.
-   * Provide either `personalAccessToken` or `oauthToken`.
-   */
-  oauthToken?: string;
-  /**
-   * The Storyblok space ID. Used as the default for space-scoped endpoints.
-   * You can also override it per request via `path.space_id`.
-   */
-  spaceId?: number;
-  /**
-   * Storyblok region. Determines the base URL.
-   * @default 'eu'
-   */
-  region?: Region;
-  /**
-   * Override the base URL entirely (e.g. for testing).
-   */
-  baseUrl?: string;
-  /**
-   * Additional request headers.
-   */
-  headers?: Record<string, string>;
-  /**
-   * Throw on HTTP errors instead of returning them.
-   * @default false
-   */
-  throwOnError?: boolean;
-  /**
-   * Retry configuration for failed requests.
-   */
-  retry?: RetryOptions;
-  /**
-   * Request timeout in milliseconds.
-   * @default 30_000
-   */
-  timeout?: number;
-  /**
-   * Rate limiting to avoid hitting the Storyblok Management API throttle (6 req/s paid, 3 req/s free).
-   *
-   * - `undefined` (default): 6 requests per second.
-   * - `number`: N requests per second.
-   * - `{ requestsPerSecond?: number }`: full config object.
-   * - `false`: disable rate limiting entirely.
-   */
-  rateLimit?: RateLimitConfig | number | false;
-}
-type AssetListQuery = NonNullable<ListData['query']>;
-type Story = Prettify<StoryMapi>;
-type StoryListQuery = NonNullable<ListData$1['query']>;
-//#endregion
-export { ApiResponse, AssetListQuery, FetchOptions, HttpRequestOptions, ManagementApiClientConfig, MapiResourceDeps, RequestConfigOverrides, Story, StoryListQuery };
-//# sourceMappingURL=types.d.cts.map

package/dist/types.d.mts

@@ -1,130 +0,0 @@
-import { AssetFolder, AssetFolderCreate, AssetFolderUpdate } from "./generated/asset_folders/types.gen.mjs";
-import { Asset, AssetSignRequest, AssetUpdate, AssetUpdateRequest, ListData, SignedResponseObject } from "./generated/assets/types.gen.mjs";
-import { AssetField, ListData as ListData$1, MultilinkField, PluginField, RichtextField, StoryAlternate, StoryContent, StoryCreate, StoryLocalizedPath, StoryMapi, StoryTranslatedSlug, StoryUpdate, TableField } from "./generated/stories/types.gen.mjs";
-import { Client, RetryOptions } from "./generated/shared/client/types.gen.mjs";
-import { ClientError } from "./error.mjs";
-import { RateLimitConfig } from "./utils/rate-limit.mjs";
-import { ComponentFolder } from "./generated/component_folders/types.gen.mjs";
-import { Component, ComponentCreate, ComponentSchemaField, ComponentUpdate } from "./generated/components/types.gen.mjs";
-import { DatasourceEntry, DatasourceEntryCreate, DatasourceEntryUpdate } from "./generated/datasource_entries/types.gen.mjs";
-import { Datasource, DatasourceCreate, DatasourceUpdate } from "./generated/datasources/types.gen.mjs";
-import { InternalTag } from "./generated/internal_tags/types.gen.mjs";
-import { Preset } from "./generated/presets/types.gen.mjs";
-import { Space, SpaceCreate, SpaceUpdate } from "./generated/spaces/types.gen.mjs";
-import { User } from "./generated/users/types.gen.mjs";
-import { AssetCreate, AssetUploadRequest } from "./resources/assets.mjs";
-import { Region } from "@storyblok/region-helper";
-
-//#region src/types.d.ts
-type Prettify<T> = { [K in keyof T]: T[K] } & {};
-type ApiResponse<T, ThrowOnError extends boolean = false> = ThrowOnError extends true ? {
-  data: T;
-  response: Response;
-  request: Request;
-} : {
-  data: T;
-  error: undefined;
-  response: Response;
-  request: Request;
-} | {
-  data: undefined;
-  error: ClientError;
-  response: Response;
-  request: Request;
-};
-interface RequestConfigOverrides {
-  throwOnError?: boolean;
-}
-/**
- * Arbitrary options forwarded to the underlying `fetch()` call.
- *
- * Standard `RequestInit` properties (`cache`, `credentials`, `mode`, …) and
- * non-standard, vendor-specific properties (Next.js `next`, Cloudflare `cf`, …)
- * are both supported.
- *
- * @example
- * ```ts
- * client.stories.get(123, {
- *   fetchOptions: {
- *     cache: 'no-store',
- *     next: { revalidate: 60 },
- *   },
- * })
- * ```
- */
-type FetchOptions = Record<string, unknown>;
-interface HttpRequestOptions {
-  query?: Record<string, unknown>;
-  body?: unknown;
-  headers?: Record<string, string>;
-  signal?: AbortSignal;
-  throwOnError?: RequestConfigOverrides['throwOnError'];
-  fetchOptions?: FetchOptions;
-}
-/**
- * Dependencies injected into every resource factory.
- */
-interface MapiResourceDeps {
-  client: Client;
-  spaceId?: number;
-  wrapRequest: <TData, ThrowOnError extends boolean = false>(fn: () => Promise<unknown>, throwOnError?: ThrowOnError) => Promise<ApiResponse<TData, ThrowOnError>>;
-}
-interface ManagementApiClientConfig {
-  /**
-   * Personal access token for authentication.
-   * Provide either `personalAccessToken` or `oauthToken`.
-   */
-  personalAccessToken?: string;
-  /**
-   * OAuth bearer token for authentication.
-   * Provide either `personalAccessToken` or `oauthToken`.
-   */
-  oauthToken?: string;
-  /**
-   * The Storyblok space ID. Used as the default for space-scoped endpoints.
-   * You can also override it per request via `path.space_id`.
-   */
-  spaceId?: number;
-  /**
-   * Storyblok region. Determines the base URL.
-   * @default 'eu'
-   */
-  region?: Region;
-  /**
-   * Override the base URL entirely (e.g. for testing).
-   */
-  baseUrl?: string;
-  /**
-   * Additional request headers.
-   */
-  headers?: Record<string, string>;
-  /**
-   * Throw on HTTP errors instead of returning them.
-   * @default false
-   */
-  throwOnError?: boolean;
-  /**
-   * Retry configuration for failed requests.
-   */
-  retry?: RetryOptions;
-  /**
-   * Request timeout in milliseconds.
-   * @default 30_000
-   */
-  timeout?: number;
-  /**
-   * Rate limiting to avoid hitting the Storyblok Management API throttle (6 req/s paid, 3 req/s free).
-   *
-   * - `undefined` (default): 6 requests per second.
-   * - `number`: N requests per second.
-   * - `{ requestsPerSecond?: number }`: full config object.
-   * - `false`: disable rate limiting entirely.
-   */
-  rateLimit?: RateLimitConfig | number | false;
-}
-type AssetListQuery = NonNullable<ListData['query']>;
-type Story = Prettify<StoryMapi>;
-type StoryListQuery = NonNullable<ListData$1['query']>;
-//#endregion
-export { ApiResponse, AssetListQuery, FetchOptions, HttpRequestOptions, ManagementApiClientConfig, MapiResourceDeps, RequestConfigOverrides, Story, StoryListQuery };
-//# sourceMappingURL=types.d.mts.map