@contentful/experience-design-system-client 2.26.1

package/dist/src/generated/core/types.gen.d.ts

@@ -0,0 +1,78 @@
+import type { Auth, AuthToken } from './auth.gen.js';
+import type { BodySerializer, QuerySerializer, QuerySerializerOptions } from './bodySerializer.gen.js';
+export interface Client<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never> {
+    /**
+     * Returns the final request URL.
+     */
+    buildUrl: BuildUrlFn;
+    connect: MethodFn;
+    delete: MethodFn;
+    get: MethodFn;
+    getConfig: () => Config;
+    head: MethodFn;
+    options: MethodFn;
+    patch: MethodFn;
+    post: MethodFn;
+    put: MethodFn;
+    request: RequestFn;
+    setConfig: (config: Config) => Config;
+    trace: MethodFn;
+}
+export interface Config {
+    /**
+     * Auth token or a function returning auth token. The resolved value will be
+     * added to the request payload as defined by its `security` array.
+     */
+    auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
+    /**
+     * A function for serializing request body parameter. By default,
+     * {@link JSON.stringify()} will be used.
+     */
+    bodySerializer?: BodySerializer | null;
+    /**
+     * An object containing any HTTP headers that you want to pre-populate your
+     * `Headers` object with.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
+     */
+    headers?: RequestInit['headers'] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
+    /**
+     * The request method.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
+     */
+    method?: 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';
+    /**
+     * A function for serializing request query parameters. By default, arrays
+     * will be exploded in form style, objects will be exploded in deepObject
+     * style, and reserved characters are percent-encoded.
+     *
+     * This method will have no effect if the native `paramsSerializer()` Axios
+     * API function is used.
+     *
+     * {@link https://swagger.io/docs/specification/serialization/#query View examples}
+     */
+    querySerializer?: QuerySerializer | QuerySerializerOptions;
+    /**
+     * A function validating request data. This is useful if you want to ensure
+     * the request conforms to the desired shape, so it can be safely sent to
+     * the server.
+     */
+    requestValidator?: (data: unknown) => Promise<unknown>;
+    /**
+     * A function transforming response data before it's returned. This is useful
+     * for post-processing data, e.g. converting ISO strings into Date objects.
+     */
+    responseTransformer?: (data: unknown) => Promise<unknown>;
+    /**
+     * A function validating response data. This is useful if you want to ensure
+     * the response conforms to the desired shape, so it can be safely passed to
+     * the transformers and returned to the user.
+     */
+    responseValidator?: (data: unknown) => Promise<unknown>;
+}
+type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never] ? true : [T] extends [never | undefined] ? [undefined] extends [T] ? false : true : false;
+export type OmitNever<T extends Record<string, unknown>> = {
+    [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true ? never : K]: T[K];
+};
+export {};

package/dist/src/generated/core/types.gen.js

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export {};

package/dist/src/generated/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types.gen.js';
+export * from './sdk.gen.js';

package/dist/src/generated/index.js

@@ -0,0 +1,3 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen.js';
+export * from './sdk.gen.js';

package/dist/src/generated/sdk.gen.d.ts

@@ -0,0 +1,83 @@
+import type { Options as ClientOptions, TDataShape, Client } from './client/index.js';
+import type { DesignSystemSourceDeleteData, DesignSystemSourceDeleteResponses, DesignSystemSourceDeleteErrors, DesignSystemSourceReadData, DesignSystemSourceReadResponses, DesignSystemSourceReadErrors, DesignSystemSourceUpsertData, DesignSystemSourceUpsertResponses, DesignSystemSourceUpsertErrors, DesignSystemSourceListData, DesignSystemSourceListResponses, DesignSystemSourceListErrors, DesignSystemSourceDisconnectData, DesignSystemSourceDisconnectResponses, DesignSystemSourceDisconnectErrors, DesignSystemSourceReconnectData, DesignSystemSourceReconnectResponses, DesignSystemSourceReconnectErrors, DesignSystemImportCreateData, DesignSystemImportCreateResponses, DesignSystemImportCreateErrors, DesignSystemImportSourcelessPreviewData, DesignSystemImportSourcelessPreviewResponses, DesignSystemImportSourcelessPreviewErrors, DesignSystemImportApplyData, DesignSystemImportApplyResponses, DesignSystemImportApplyErrors, DesignSystemImportGetOperationData, DesignSystemImportGetOperationResponses, DesignSystemImportGetOperationErrors, DesignSystemImportPreflightData, DesignSystemImportPreflightResponses, DesignSystemImportPreflightErrors, GitHubInstallationsGenerateData, GitHubInstallationsGenerateResponses, GitHubInstallationsGenerateErrors, GitHubInstallationsListData, GitHubInstallationsListResponses, GitHubInstallationsListErrors, GitHubInstallationsExchangeData, GitHubInstallationsExchangeResponses, GitHubInstallationsExchangeErrors, GitHubInstallationRepositoriesListData, GitHubInstallationRepositoriesListResponses, GitHubInstallationRepositoriesListErrors, GitHubRepositoryBranchesListData, GitHubRepositoryBranchesListResponses, GitHubRepositoryBranchesListErrors, GitHubInstallationStatusReadData, GitHubInstallationStatusReadResponses, GitHubInstallationStatusReadErrors } from './types.gen.js';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+/**
+ * Delete a design system source
+ */
+export declare const designSystemSourceDelete: <ThrowOnError extends boolean = false>(options: Options<DesignSystemSourceDeleteData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DesignSystemSourceDeleteResponses, DesignSystemSourceDeleteErrors, ThrowOnError, "fields">;
+/**
+ * Get a design system source
+ */
+export declare const designSystemSourceRead: <ThrowOnError extends boolean = false>(options: Options<DesignSystemSourceReadData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DesignSystemSourceReadResponses, DesignSystemSourceReadErrors, ThrowOnError, "fields">;
+/**
+ * Create or update a design system source
+ */
+export declare const designSystemSourceUpsert: <ThrowOnError extends boolean = false>(options: Options<DesignSystemSourceUpsertData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DesignSystemSourceUpsertResponses, DesignSystemSourceUpsertErrors, ThrowOnError, "fields">;
+/**
+ * List design system sources
+ */
+export declare const designSystemSourceList: <ThrowOnError extends boolean = false>(options: Options<DesignSystemSourceListData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DesignSystemSourceListResponses, DesignSystemSourceListErrors, ThrowOnError, "fields">;
+/**
+ * Soft-disconnect a design system source (space-scoped; never touches GitHub)
+ */
+export declare const designSystemSourceDisconnect: <ThrowOnError extends boolean = false>(options: Options<DesignSystemSourceDisconnectData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DesignSystemSourceDisconnectResponses, DesignSystemSourceDisconnectErrors, ThrowOnError, "fields">;
+/**
+ * Reconnect a design system source after a fresh liveness re-check
+ */
+export declare const designSystemSourceReconnect: <ThrowOnError extends boolean = false>(options: Options<DesignSystemSourceReconnectData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DesignSystemSourceReconnectResponses, DesignSystemSourceReconnectErrors, ThrowOnError, "fields">;
+/**
+ * Preview the import diff from a design system source
+ */
+export declare const designSystemImportCreate: <ThrowOnError extends boolean = false>(options: Options<DesignSystemImportCreateData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DesignSystemImportCreateResponses, DesignSystemImportCreateErrors, ThrowOnError, "fields">;
+/**
+ * Preview import diff from a manifest payload (no source required)
+ */
+export declare const designSystemImportSourcelessPreview: <ThrowOnError extends boolean = false>(options: Options<DesignSystemImportSourcelessPreviewData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DesignSystemImportSourcelessPreviewResponses, DesignSystemImportSourcelessPreviewErrors, ThrowOnError, "fields">;
+/**
+ * Submit selected import changes for asynchronous apply
+ */
+export declare const designSystemImportApply: <ThrowOnError extends boolean = false>(options: Options<DesignSystemImportApplyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DesignSystemImportApplyResponses, DesignSystemImportApplyErrors, ThrowOnError, "fields">;
+/**
+ * Get the current status of an async apply operation
+ */
+export declare const designSystemImportGetOperation: <ThrowOnError extends boolean = false>(options: Options<DesignSystemImportGetOperationData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DesignSystemImportGetOperationResponses, DesignSystemImportGetOperationErrors, ThrowOnError, "fields">;
+/**
+ * Check whether the caller can preview or apply design system imports
+ */
+export declare const designSystemImportPreflight: <ThrowOnError extends boolean = false>(options: Options<DesignSystemImportPreflightData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DesignSystemImportPreflightResponses, DesignSystemImportPreflightErrors, ThrowOnError, "fields">;
+/**
+ * Generate a GitHub App installation URL
+ */
+export declare const gitHubInstallationsGenerate: <ThrowOnError extends boolean = false>(options: Options<GitHubInstallationsGenerateData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<GitHubInstallationsGenerateResponses, GitHubInstallationsGenerateErrors, ThrowOnError, "fields">;
+/**
+ * List GitHub App installations visible to the service
+ */
+export declare const gitHubInstallationsList: <ThrowOnError extends boolean = false>(options: Options<GitHubInstallationsListData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<GitHubInstallationsListResponses, GitHubInstallationsListErrors, ThrowOnError, "fields">;
+/**
+ * Finalize a GitHub install callback into validated provider metadata
+ */
+export declare const gitHubInstallationsExchange: <ThrowOnError extends boolean = false>(options: Options<GitHubInstallationsExchangeData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<GitHubInstallationsExchangeResponses, GitHubInstallationsExchangeErrors, ThrowOnError, "fields">;
+/**
+ * List repositories accessible to a GitHub App installation
+ */
+export declare const gitHubInstallationRepositoriesList: <ThrowOnError extends boolean = false>(options: Options<GitHubInstallationRepositoriesListData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<GitHubInstallationRepositoriesListResponses, GitHubInstallationRepositoriesListErrors, ThrowOnError, "fields">;
+/**
+ * List branches for a repository accessible to an installation
+ */
+export declare const gitHubRepositoryBranchesList: <ThrowOnError extends boolean = false>(options: Options<GitHubRepositoryBranchesListData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<GitHubRepositoryBranchesListResponses, GitHubRepositoryBranchesListErrors, ThrowOnError, "fields">;
+/**
+ * Read the current GitHub App installation status for an organization
+ */
+export declare const gitHubInstallationStatusRead: <ThrowOnError extends boolean = false>(options: Options<GitHubInstallationStatusReadData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<GitHubInstallationStatusReadResponses, GitHubInstallationStatusReadErrors, ThrowOnError, "fields">;

package/dist/src/generated/sdk.gen.js

@@ -0,0 +1,179 @@
+// This file is auto-generated by @hey-api/openapi-ts
+import { client as _heyApiClient } from './client.gen.js';
+/**
+ * Delete a design system source
+ */
+export const designSystemSourceDelete = (options) => {
+    return (options.client ?? _heyApiClient).delete({
+        url: '/spaces/{spaceId}/environments/{environmentId}/design_systems/sources/{sourceId}',
+        ...options
+    });
+};
+/**
+ * Get a design system source
+ */
+export const designSystemSourceRead = (options) => {
+    return (options.client ?? _heyApiClient).get({
+        url: '/spaces/{spaceId}/environments/{environmentId}/design_systems/sources/{sourceId}',
+        ...options
+    });
+};
+/**
+ * Create or update a design system source
+ */
+export const designSystemSourceUpsert = (options) => {
+    return (options.client ?? _heyApiClient).put({
+        url: '/spaces/{spaceId}/environments/{environmentId}/design_systems/sources/{sourceId}',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};
+/**
+ * List design system sources
+ */
+export const designSystemSourceList = (options) => {
+    return (options.client ?? _heyApiClient).get({
+        url: '/spaces/{spaceId}/environments/{environmentId}/design_systems/sources',
+        ...options
+    });
+};
+/**
+ * Soft-disconnect a design system source (space-scoped; never touches GitHub)
+ */
+export const designSystemSourceDisconnect = (options) => {
+    return (options.client ?? _heyApiClient).post({
+        url: '/spaces/{spaceId}/environments/{environmentId}/design_systems/sources/{sourceId}/disconnect',
+        ...options
+    });
+};
+/**
+ * Reconnect a design system source after a fresh liveness re-check
+ */
+export const designSystemSourceReconnect = (options) => {
+    return (options.client ?? _heyApiClient).post({
+        url: '/spaces/{spaceId}/environments/{environmentId}/design_systems/sources/{sourceId}/reconnect',
+        ...options
+    });
+};
+/**
+ * Preview the import diff from a design system source
+ */
+export const designSystemImportCreate = (options) => {
+    return (options.client ?? _heyApiClient).post({
+        url: '/spaces/{spaceId}/environments/{environmentId}/design_systems/sources/{sourceId}/preview',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};
+/**
+ * Preview import diff from a manifest payload (no source required)
+ */
+export const designSystemImportSourcelessPreview = (options) => {
+    return (options.client ?? _heyApiClient).post({
+        url: '/spaces/{spaceId}/environments/{environmentId}/design_systems/imports/preview',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};
+/**
+ * Submit selected import changes for asynchronous apply
+ */
+export const designSystemImportApply = (options) => {
+    return (options.client ?? _heyApiClient).post({
+        url: '/spaces/{spaceId}/environments/{environmentId}/design_systems/imports/apply',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};
+/**
+ * Get the current status of an async apply operation
+ */
+export const designSystemImportGetOperation = (options) => {
+    return (options.client ?? _heyApiClient).get({
+        url: '/spaces/{spaceId}/environments/{environmentId}/design_systems/imports/apply/{operationId}',
+        ...options
+    });
+};
+/**
+ * Check whether the caller can preview or apply design system imports
+ */
+export const designSystemImportPreflight = (options) => {
+    return (options.client ?? _heyApiClient).get({
+        url: '/spaces/{spaceId}/environments/{environmentId}/design_systems/preflight',
+        ...options
+    });
+};
+/**
+ * Generate a GitHub App installation URL
+ */
+export const gitHubInstallationsGenerate = (options) => {
+    return (options.client ?? _heyApiClient).post({
+        url: '/spaces/{spaceId}/environments/{environmentId}/design_systems/providers/github/installations/url',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};
+/**
+ * List GitHub App installations visible to the service
+ */
+export const gitHubInstallationsList = (options) => {
+    return (options.client ?? _heyApiClient).get({
+        url: '/spaces/{spaceId}/environments/{environmentId}/design_systems/providers/github/installations',
+        ...options
+    });
+};
+/**
+ * Finalize a GitHub install callback into validated provider metadata
+ */
+export const gitHubInstallationsExchange = (options) => {
+    return (options.client ?? _heyApiClient).post({
+        url: '/spaces/{spaceId}/environments/{environmentId}/design_systems/providers/github/callbacks/install/exchange',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};
+/**
+ * List repositories accessible to a GitHub App installation
+ */
+export const gitHubInstallationRepositoriesList = (options) => {
+    return (options.client ?? _heyApiClient).get({
+        url: '/spaces/{spaceId}/environments/{environmentId}/design_systems/providers/github/installations/{installationId}/repositories',
+        ...options
+    });
+};
+/**
+ * List branches for a repository accessible to an installation
+ */
+export const gitHubRepositoryBranchesList = (options) => {
+    return (options.client ?? _heyApiClient).get({
+        url: '/spaces/{spaceId}/environments/{environmentId}/design_systems/providers/github/installations/{installationId}/repositories/{owner}/{repo}/branches',
+        ...options
+    });
+};
+/**
+ * Read the current GitHub App installation status for an organization
+ */
+export const gitHubInstallationStatusRead = (options) => {
+    return (options.client ?? _heyApiClient).get({
+        url: '/organizations/{orgId}/design_systems/providers/github/installations/status',
+        ...options
+    });
+};