@depup/contentful 11.10.7-depup.0

package/dist/types/contentful.d.ts

@@ -0,0 +1,150 @@
+/**
+ * Contentful Delivery API SDK. Allows you to create instances of a client
+ * with access to the Contentful Content Delivery API.
+ */
+import type { AxiosAdapter, AxiosRequestConfig, AxiosResponse } from 'axios';
+import type { ContentfulClientApi } from './types/client.js';
+import type { TimelinePreview } from './types/timeline-preview.js';
+/**
+ * @category Client
+ */
+export type ClientLogLevel = 'error' | 'warning' | 'info' | string;
+/**
+ * Client initialization parameters
+ * @category Client
+ */
+export interface CreateClientParams {
+    /**
+     * Space ID
+     */
+    space: string;
+    /**
+     * Contentful CDA Access Token
+     */
+    accessToken: string;
+    /**
+     * Contentful Environment ID
+     * @defaultValue "master"
+     */
+    environment?: string;
+    /**
+     * Requests will be made over http instead of the default https
+     * @defaultValue true
+     */
+    insecure?: boolean;
+    /**
+     * API host. Also usable with preview.contentful.com.
+     * @defaultValue "cdn.contentful.com"
+     */
+    host?: string;
+    /**
+     * Path appended to the host to support gateways/proxies with custom urls
+     */
+    basePath?: string;
+    /**
+     * Optional Node.js HTTP agent for proxying
+     * (see <a href="https://nodejs.org/api/http.html#http_class_http_agent">Node.js docs</a>
+     * and <a href="https://www.npmjs.com/package/https-proxy-agent">https-proxy-agent</a>)
+     */
+    httpAgent?: AxiosRequestConfig['httpAgent'];
+    /**
+     * Optional Node.js HTTP agent for proxying
+     * (see <a href="https://nodejs.org/api/http.html#http_class_http_agent">Node.js docs</a>
+     * and <a href="https://www.npmjs.com/package/https-proxy-agent">https-proxy-agent</a>)
+     */
+    httpsAgent?: AxiosRequestConfig['httpsAgent'];
+    /**
+     * Optional Axios proxy (see <a href="https://github.com/mzabriskie/axios#request-config"> axios docs </a>)
+     */
+    proxy?: AxiosRequestConfig['proxy'];
+    /**
+     * Optional additional headers
+     */
+    headers?: Record<string, string>;
+    /**
+     * Optional axios request adapter (see <a href="https://github.com/mzabriskie/axios#request-config"> axios docs </a>)
+     */
+    adapter?: AxiosAdapter;
+    /**
+     * Application name and version e.g myApp/version
+     */
+    application?: string;
+    /**
+     * Integration name and version e.g react/version
+     */
+    integration?: string;
+    /**
+     * If we should retry on errors and 429 rate limit exceptions
+     * @defaultValue true
+     */
+    retryOnError?: boolean;
+    /**
+     * A log handler function to process given log messages and errors.
+     * (The default can be found at: https://github.com/contentful/contentful-sdk-core/blob/master/src/create-http-client.ts)
+     * @param level - Log level, e.g. error, warning, or info
+     * @param data - Log data
+     */
+    logHandler?: (level: ClientLogLevel, data?: Record<string, any> | string) => void;
+    /**
+     * connection timeout in milliseconds (default:30000)
+     */
+    timeout?: number;
+    /**
+     * Optional number of retries before failure.
+     * @defaultValue 5
+     */
+    retryLimit?: number;
+    /**
+     * Interceptor called on every request. Takes Axios request config as an arg.
+     */
+    requestLogger?: (request: AxiosRequestConfig | Error) => unknown;
+    /**
+     * Interceptor called on every response. Takes Axios response object as an arg.
+     */
+    responseLogger?: (response: AxiosResponse<any> | Error) => unknown;
+    /**
+     * Enable Content Source Maps.
+     * @remarks
+     * This feature is only available when using the Content Preview API.
+     */
+    includeContentSourceMaps?: boolean;
+    /**
+     * Enable Timeline Preview.
+     *
+     * @remarks
+     * This feature is only available when using the Content Preview API.
+     */
+    timelinePreview?: TimelinePreview;
+    /**
+     * Enable alpha features.
+     */
+    alphaFeatures?: {
+        /**
+         * @deprecated Use the `includeContentSourceMaps` option directly instead.
+         */
+        includeContentSourceMaps?: boolean;
+        /**
+         * Enable Timeline Preview.
+         *
+         * @remarks
+         * This feature is only available when using the Content Preview API.
+         *
+         * @deprecated Use the `timelinePreview` option directly instead.
+         */
+        timelinePreview?: TimelinePreview;
+    };
+}
+/**
+ * Create a client instance
+ * @param params - Client initialization parameters
+ * @category Client
+ * @example
+ * ```typescript
+ * const contentful = require('contentful')
+ * const client = contentful.createClient({
+ *   accessToken: 'myAccessToken',
+ *   space: 'mySpaceId'
+ * })
+ * ```
+ */
+export declare function createClient(params: CreateClientParams): ContentfulClientApi<undefined>;

package/dist/types/create-contentful-api.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Contentful Delivery API Client. Contains methods which allow access to the
+ * different kinds of entities present in Contentful (Entries, Assets, etc).
+ */
+import type { AxiosInstance } from 'contentful-sdk-core';
+import type { GetGlobalOptions } from './create-global-options.js';
+import type { ContentfulClientApi } from './types/index.js';
+import type { ChainOptions } from './utils/client-helpers.js';
+export interface CreateContentfulApiParams {
+    http: AxiosInstance;
+    getGlobalOptions: GetGlobalOptions;
+}
+export default function createContentfulApi<OptionType extends ChainOptions>({ http, getGlobalOptions }: CreateContentfulApiParams, options?: OptionType): ContentfulClientApi<undefined>;

package/dist/types/create-global-options.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @category Client
+ */
+export interface GlobalOptionsParams {
+    environment?: string;
+    space?: string;
+    spaceBaseUrl?: string;
+    environmentBaseUrl?: string;
+}
+/**
+ * @category Client
+ */
+export type GetGlobalOptions = (globalOptions?: GlobalOptionsParams) => Required<GlobalOptionsParams>;
+/**
+ * @param globalSettings - Global library settings
+ * @returns getGlobalSettings - Method returning client settings
+ * @category Client
+ */
+export declare function createGlobalOptions(globalSettings: Required<GlobalOptionsParams>): GetGlobalOptions;

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from './contentful.js';
+export * from './create-global-options.js';
+export * from './mixins/stringify-safe.js';
+export * from './utils/normalize-select.js';
+export * from './utils/resolve-circular.js';
+export * from './types/index.js';

package/dist/types/make-client.d.ts

@@ -0,0 +1,3 @@
+import type { CreateContentfulApiParams } from './create-contentful-api.js';
+import type { ContentfulClientApi } from './types/index.js';
+export declare const makeClient: ({ http, getGlobalOptions, }: CreateContentfulApiParams) => ContentfulClientApi<undefined>;

package/dist/types/mixins/stringify-safe.d.ts

@@ -0,0 +1 @@
+export default function mixinStringifySafe(data: any): any;

package/dist/types/paged-sync.d.ts

@@ -0,0 +1,7 @@
+import type { AxiosInstance } from 'contentful-sdk-core';
+import type { SyncCollection, SyncOptions, SyncQuery, LocaleCode, EntrySkeletonType } from './types/index.js';
+import type { ChainOptions, ModifiersFromOptions } from './utils/client-helpers.js';
+/**
+ * Retrieves all the available pages for a sync operation
+ */
+export default function pagedSync<EntrySkeleton extends EntrySkeletonType, Locales extends LocaleCode, Options extends ChainOptions>(http: AxiosInstance, query: SyncQuery, options?: SyncOptions | ChainOptions): Promise<SyncCollection<EntrySkeleton, ModifiersFromOptions<Options>, Locales>>;

package/dist/types/types/asset-key.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @category Asset
+ */
+export type AssetKey = {
+    secret: string;
+    policy: string;
+};

package/dist/types/types/asset.d.ts

@@ -0,0 +1,79 @@
+import type { ContentfulCollection, CursorPaginatedCollection } from './collection.js';
+import type { LocaleCode } from './locale.js';
+import type { Metadata } from './metadata.js';
+import type { EntitySys } from './sys.js';
+import type { ChainModifiers } from './client.js';
+/**
+ * @category Asset
+ */
+export interface AssetDetails {
+    size: number;
+    image?: {
+        width: number;
+        height: number;
+    };
+}
+/**
+ * @category Asset
+ */
+export interface AssetFile {
+    url: string;
+    details: AssetDetails;
+    fileName: string;
+    contentType: string;
+}
+/**
+ * @category Asset
+ */
+export interface AssetFields {
+    title?: string;
+    description?: string;
+    file?: AssetFile;
+}
+/**
+ * Assets are binary files in a Contentful space
+ * @category Asset
+ * @typeParam Modifiers - The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+ * @typeParam Locales - If provided for a client using `allLocales` modifier, response type defines locale keys for asset field values.
+ * @see {@link https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/assets | Documentation}
+ */
+export interface Asset<Modifiers extends ChainModifiers = ChainModifiers, Locales extends LocaleCode = LocaleCode> {
+    sys: AssetSys;
+    fields: ChainModifiers extends Modifiers ? {
+        [FieldName in keyof AssetFields]: {
+            [LocaleName in Locales]?: AssetFields[FieldName];
+        };
+    } | AssetFields : 'WITH_ALL_LOCALES' extends Modifiers ? {
+        [FieldName in keyof AssetFields]: {
+            [LocaleName in Locales]?: AssetFields[FieldName];
+        };
+    } : AssetFields;
+    metadata: Metadata;
+}
+/**
+ * @category Asset
+ */
+export type AssetMimeType = 'attachment' | 'plaintext' | 'image' | 'audio' | 'video' | 'richtext' | 'presentation' | 'spreadsheet' | 'pdfdocument' | 'archive' | 'code' | 'markup';
+/**
+ * A collection of assets
+ * @category Asset
+ * @typeParam Modifiers - The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+ * @typeParam Locales - If provided for a client using `allLocales` modifier, response type defines locale keys for asset field values.
+ * @see {@link https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/assets | Documentation}
+ */
+export type AssetCollection<Modifiers extends ChainModifiers = ChainModifiers, Locales extends LocaleCode = LocaleCode> = ContentfulCollection<Asset<Modifiers, Locales>>;
+/**
+ * A cursor paginated collection of assets
+ * @category Asset
+ * @typeParam Modifiers - The chain modifiers used to configure the client. They’re set automatically when using the client chain modifiers.
+ * @typeParam Locales - If provided for a client using `allLocales` modifier, response type defines locale keys for asset field values.
+ * @see {@link https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/assets | Documentation}
+ */
+export type AssetCursorPaginatedCollection<Modifiers extends ChainModifiers = ChainModifiers, Locales extends LocaleCode = LocaleCode> = CursorPaginatedCollection<Asset<Modifiers, Locales>>;
+/**
+ * System managed metadata for assets
+ * @category Asset
+ */
+export type AssetSys = EntitySys & {
+    type: 'Asset';
+};