@storyblok/management-api-client 0.2.4 → 1.0.0-alpha.1

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;
-  /**
-   * Preventive rate limiting to avoid hitting the Storyblok Management API rate limits.
-   *
-   * - `undefined` (default): single bucket at maxConcurrency: 6.
-   * - `number`: fixed max concurrent requests per second.
-   * - `{ maxConcurrency?: number; adaptToServerHeaders?: boolean }`: full config.
-   * - `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;
-  /**
-   * Preventive rate limiting to avoid hitting the Storyblok Management API rate limits.
-   *
-   * - `undefined` (default): single bucket at maxConcurrency: 6.
-   * - `number`: fixed max concurrent requests per second.
-   * - `{ maxConcurrency?: number; adaptToServerHeaders?: boolean }`: full config.
-   * - `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