@umbraco-deploy/backoffice 17.1.0-rc1 → 17.1.0-rc2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (183) hide show
  1. package/package.json +9 -4
  2. package/types/cms-augmentations.d.ts +22 -0
  3. package/types/components/environment-select/environment-select.element.d.ts +16 -0
  4. package/types/components/error/error-types/busy-error.element.d.ts +11 -0
  5. package/types/components/error/error-types/chunk-encoding-error.element.d.ts +11 -0
  6. package/types/components/error/error-types/collision-error.element.d.ts +11 -0
  7. package/types/components/error/error-types/content-type-changed-error.element.d.ts +11 -0
  8. package/types/components/error/error-types/dependency-error.element.d.ts +11 -0
  9. package/types/components/error/error-types/error-type-base.element.d.ts +9 -0
  10. package/types/components/error/error-types/generic-error.element.d.ts +11 -0
  11. package/types/components/error/error-types/import-artifacts-error.element.d.ts +13 -0
  12. package/types/components/error/error-types/import-artifacts-unhandled-error.element.d.ts +11 -0
  13. package/types/components/error/error-types/index.d.ts +16 -0
  14. package/types/components/error/error-types/invalid-path-error.element.d.ts +11 -0
  15. package/types/components/error/error-types/merge-conflict-error.element.d.ts +11 -0
  16. package/types/components/error/error-types/remote-api-timeout-error.element.d.ts +11 -0
  17. package/types/components/error/error-types/restore-schema-mismatch-error.element.d.ts +11 -0
  18. package/types/components/error/error-types/schema-mismatch-error.element.d.ts +11 -0
  19. package/types/components/error/error-types/unauthorized-client-error.element.d.ts +11 -0
  20. package/types/components/error/error-types/web-exception-error.element.d.ts +11 -0
  21. package/types/components/error/error.element.d.ts +28 -0
  22. package/types/components/error/index.d.ts +2 -0
  23. package/types/components/error-detail/error-detail.element.d.ts +18 -0
  24. package/types/components/export-complete.element.d.ts +17 -0
  25. package/types/components/index.d.ts +7 -0
  26. package/types/components/no-nodes.element.d.ts +23 -0
  27. package/types/components/work-complete/work-complete.element.d.ts +22 -0
  28. package/types/components/work-progress/work-progress.element.d.ts +18 -0
  29. package/types/context/deploy.context-token.d.ts +3 -0
  30. package/types/context/deploy.context.d.ts +20 -0
  31. package/types/context/index.d.ts +6 -0
  32. package/types/context/remote-tree.context-token.d.ts +3 -0
  33. package/types/context/remote-tree.context.d.ts +24 -0
  34. package/types/context/signalr.context-token.d.ts +3 -0
  35. package/types/context/signalr.context.d.ts +15 -0
  36. package/types/dashboards/cloud-dashboard-header.element.d.ts +19 -0
  37. package/types/dashboards/environments/components/content-flow/content-flow.element.d.ts +21 -0
  38. package/types/dashboards/environments/components/deploy-queue/deploy-queue.element.d.ts +24 -0
  39. package/types/dashboards/environments/components/environment/environment.element.d.ts +19 -0
  40. package/types/dashboards/environments/components/environment-add/environment-add.element.d.ts +13 -0
  41. package/types/dashboards/environments/components/environment-connect/environment-connect.element.d.ts +17 -0
  42. package/types/dashboards/environments/components/environment-deploy/environment-deploy.element.d.ts +17 -0
  43. package/types/dashboards/environments/components/environment-info/environment-info.element.d.ts +16 -0
  44. package/types/dashboards/environments/components/index.d.ts +7 -0
  45. package/types/dashboards/environments/environments-dashboard.element.d.ts +17 -0
  46. package/types/dashboards/environments/index.d.ts +2 -0
  47. package/types/dashboards/environments/manifests.d.ts +2 -0
  48. package/types/dashboards/index.d.ts +4 -0
  49. package/types/dashboards/management/components/configuration-details/configuration-details-notes-column-layout.element.d.ts +18 -0
  50. package/types/dashboards/management/components/configuration-details/configuration-details-setting-column-layout.element.d.ts +15 -0
  51. package/types/dashboards/management/components/configuration-details/configuration-details-value-column-layout.element.d.ts +14 -0
  52. package/types/dashboards/management/components/configuration-details/configuration-details.element.d.ts +20 -0
  53. package/types/dashboards/management/components/configuration-details/index.d.ts +4 -0
  54. package/types/dashboards/management/components/deploy-operations/deploy-operation.element.d.ts +26 -0
  55. package/types/dashboards/management/components/deploy-operations/deploy-operations.element.d.ts +14 -0
  56. package/types/dashboards/management/components/deploy-status/deploy-status.element.d.ts +20 -0
  57. package/types/dashboards/management/components/download-artifacts/download-artifacts.element.d.ts +13 -0
  58. package/types/dashboards/management/components/index.d.ts +6 -0
  59. package/types/dashboards/management/components/manifests.d.ts +2 -0
  60. package/types/dashboards/management/components/schema-comparison/index.d.ts +5 -0
  61. package/types/dashboards/management/components/schema-comparison/schema-comparison-boolean-column-layout.element.d.ts +15 -0
  62. package/types/dashboards/management/components/schema-comparison/schema-comparison-entityactions-column-layout.element.d.ts +22 -0
  63. package/types/dashboards/management/components/schema-comparison/schema-comparison.element.d.ts +18 -0
  64. package/types/dashboards/management/components/schema-comparison/schema-detail-modal.element.d.ts +22 -0
  65. package/types/dashboards/management/components/schema-comparison/schema-detail-modal.token.d.ts +9 -0
  66. package/types/dashboards/management/index.d.ts +5 -0
  67. package/types/dashboards/management/management-dashboard.element.d.ts +26 -0
  68. package/types/dashboards/management/management.repository.d.ts +19 -0
  69. package/types/dashboards/management/management.server.data.d.ts +15 -0
  70. package/types/dashboards/management/manifests.d.ts +4 -0
  71. package/types/dashboards/manifests.d.ts +1 -0
  72. package/types/dashboards/onprem-dashboard-header.element.d.ts +12 -0
  73. package/types/entities.d.ts +90 -0
  74. package/types/entity-actions/base.action.d.ts +19 -0
  75. package/types/entity-actions/base.condition.d.ts +22 -0
  76. package/types/entity-actions/compare/compare-table.element.d.ts +21 -0
  77. package/types/entity-actions/compare/compare.action.d.ts +4 -0
  78. package/types/entity-actions/compare/compare.condition.d.ts +21 -0
  79. package/types/entity-actions/compare/manifests.d.ts +4 -0
  80. package/types/entity-actions/compare/modal/compare-modal.element.d.ts +24 -0
  81. package/types/entity-actions/compare/modal/compare-modal.token.d.ts +9 -0
  82. package/types/entity-actions/conditions-manifests.d.ts +2 -0
  83. package/types/entity-actions/entity-action-registrar.manifest.d.ts +15 -0
  84. package/types/entity-actions/entity-type-mapping.manifest.d.ts +10 -0
  85. package/types/entity-actions/entity-type.condition.d.ts +22 -0
  86. package/types/entity-actions/export/environment/environment-export.action.d.ts +5 -0
  87. package/types/entity-actions/export/export-base.action.d.ts +7 -0
  88. package/types/entity-actions/export/manifests.d.ts +3 -0
  89. package/types/entity-actions/export/tree/tree-export.action.d.ts +4 -0
  90. package/types/entity-actions/export/tree/tree-export.condition.d.ts +19 -0
  91. package/types/entity-actions/import/import.action.d.ts +8 -0
  92. package/types/entity-actions/import/manifests.d.ts +3 -0
  93. package/types/entity-actions/import/modal/import-modal.element.d.ts +22 -0
  94. package/types/entity-actions/import/modal/import-modal.token.d.ts +10 -0
  95. package/types/entity-actions/index.d.ts +4 -0
  96. package/types/entity-actions/manifests.d.ts +2 -0
  97. package/types/entity-actions/permissions-manifests.d.ts +8 -0
  98. package/types/entity-actions/queue/manifests.d.ts +3 -0
  99. package/types/entity-actions/queue/queue.action.d.ts +8 -0
  100. package/types/entity-actions/queue/queue.condition.d.ts +19 -0
  101. package/types/entity-actions/restore/environment/environment-restore.action.d.ts +4 -0
  102. package/types/entity-actions/restore/environment/environment-restore.condition.d.ts +20 -0
  103. package/types/entity-actions/restore/manifests.d.ts +3 -0
  104. package/types/entity-actions/restore/partial/partial-restore.action.d.ts +4 -0
  105. package/types/entity-actions/restore/partial/partial-restore.condition.d.ts +19 -0
  106. package/types/entity-actions/restore/restore-base.action.d.ts +9 -0
  107. package/types/entity-actions/restore/tree/tree-restore.action.d.ts +4 -0
  108. package/types/entity-actions/restore/tree/tree-restore.condition.d.ts +19 -0
  109. package/types/entity-actions/transfer-now/manifests.d.ts +3 -0
  110. package/types/entity-actions/transfer-now/transfer-now.action.d.ts +7 -0
  111. package/types/entity-actions/transfer-now/transfer-now.condition.d.ts +19 -0
  112. package/types/exports.d.ts +31 -0
  113. package/types/generated/client/client.gen.d.ts +2 -0
  114. package/types/generated/client/index.d.ts +8 -0
  115. package/types/generated/client/types.gen.d.ts +120 -0
  116. package/types/generated/client/utils.gen.d.ts +37 -0
  117. package/types/generated/client.gen.d.ts +12 -0
  118. package/types/generated/core/auth.gen.d.ts +18 -0
  119. package/types/generated/core/bodySerializer.gen.d.ts +25 -0
  120. package/types/generated/core/params.gen.d.ts +43 -0
  121. package/types/generated/core/pathSerializer.gen.d.ts +33 -0
  122. package/types/generated/core/queryKeySerializer.gen.d.ts +18 -0
  123. package/types/generated/core/serverSentEvents.gen.d.ts +71 -0
  124. package/types/generated/core/types.gen.d.ts +78 -0
  125. package/types/generated/core/utils.gen.d.ts +19 -0
  126. package/types/generated/index.d.ts +3 -0
  127. package/types/generated/sdk.gen.d.ts +89 -0
  128. package/types/generated/types.gen.d.ts +1314 -0
  129. package/types/header-apps/environment-name-header-app.element.d.ts +21 -0
  130. package/types/header-apps/index.d.ts +1 -0
  131. package/types/header-apps/manifests.d.ts +2 -0
  132. package/types/index.d.ts +10 -0
  133. package/types/lang/en.d.ts +302 -0
  134. package/types/lang/en.dashboard-management-configuration-details.d.ts +89 -0
  135. package/types/lang/manifests.d.ts +2 -0
  136. package/types/modal/element/export-modal.element.d.ts +26 -0
  137. package/types/modal/element/index.d.ts +6 -0
  138. package/types/modal/element/no-nodes-modal.element.d.ts +12 -0
  139. package/types/modal/element/partial-restore-modal.element.d.ts +22 -0
  140. package/types/modal/element/progress-modal.element.d.ts +16 -0
  141. package/types/modal/element/queue-modal.element.d.ts +21 -0
  142. package/types/modal/element/restore-modal.element.d.ts +18 -0
  143. package/types/modal/index.d.ts +2 -0
  144. package/types/modal/manifests.d.ts +2 -0
  145. package/types/modal/styles.d.ts +1 -0
  146. package/types/modal/token/export-modal.token.d.ts +23 -0
  147. package/types/modal/token/index.d.ts +6 -0
  148. package/types/modal/token/no-nodes-modal.token.d.ts +4 -0
  149. package/types/modal/token/partial-restore-modal.token.d.ts +3 -0
  150. package/types/modal/token/progress-modal.token.d.ts +11 -0
  151. package/types/modal/token/queue-modal.token.d.ts +20 -0
  152. package/types/modal/token/restore-modal.token.d.ts +23 -0
  153. package/types/queue/index.d.ts +3 -0
  154. package/types/queue/transfer-queue-manager-context.token.d.ts +3 -0
  155. package/types/queue/transfer-queue-manager.context.d.ts +15 -0
  156. package/types/queue/transfer-queue.repository.d.ts +10 -0
  157. package/types/repository/base.repository.d.ts +16 -0
  158. package/types/repository/deploy.repository.d.ts +6 -0
  159. package/types/repository/entity.repository.d.ts +7 -0
  160. package/types/repository/export.repository.d.ts +9 -0
  161. package/types/repository/import.repository.d.ts +5 -0
  162. package/types/repository/index.d.ts +7 -0
  163. package/types/repository/manifests.d.ts +1 -0
  164. package/types/repository/remote-tree/document/index.d.ts +2 -0
  165. package/types/repository/remote-tree/document/manifests.d.ts +5 -0
  166. package/types/repository/remote-tree/document/remote-document-tree.repository.d.ts +11 -0
  167. package/types/repository/remote-tree/document/remote-document-tree.server.data-source.d.ts +7 -0
  168. package/types/repository/remote-tree/entity/index.d.ts +2 -0
  169. package/types/repository/remote-tree/entity/manifests.d.ts +5 -0
  170. package/types/repository/remote-tree/entity/remote-entity-tree.repository.d.ts +7 -0
  171. package/types/repository/remote-tree/entity/remote-entity-tree.server.data-source.d.ts +7 -0
  172. package/types/repository/remote-tree/index.d.ts +3 -0
  173. package/types/repository/remote-tree/manifests.d.ts +1 -0
  174. package/types/repository/remote-tree/media/index.d.ts +2 -0
  175. package/types/repository/remote-tree/media/manifests.d.ts +5 -0
  176. package/types/repository/remote-tree/media/remote-media-tree.repository.d.ts +11 -0
  177. package/types/repository/remote-tree/media/remote-media-tree.server.data-source.d.ts +7 -0
  178. package/types/repository/remote-tree/remote-tree-base.repository.d.ts +26 -0
  179. package/types/repository/remote-tree/remote-tree-server-data-source-base.d.ts +55 -0
  180. package/types/repository/restore.repository.d.ts +9 -0
  181. package/types/types.d.ts +3 -0
  182. package/types/util.d.ts +86 -0
  183. package/types/umbraco-deploy-public.d.ts +0 -386
@@ -0,0 +1,21 @@
1
+ import type { DeployExtensionCondition } from "../base.condition.js";
2
+ import { DeployConditionBase } from "../base.condition.js";
3
+ import type { UmbConditionConfigBase, UmbConditionControllerArguments } from "@umbraco-cms/backoffice/extension-api";
4
+ import type { UmbControllerHost } from "@umbraco-cms/backoffice/controller-api";
5
+ export declare const DEPLOY_COMPARE_CONDITION_ALIAS = "Deploy.Condition.Compare";
6
+ export type DeployCompareConditionConfig = UmbConditionConfigBase<typeof DEPLOY_COMPARE_CONDITION_ALIAS>;
7
+ /**
8
+ * Permitted is true when one of allowDeployOptions and allowRestore options is true.
9
+ * The user must also have permission to queue or partial restore,
10
+ * this is checked in the manifest condition based on the user permissions.
11
+ */
12
+ export declare class DeployCompareCondition extends DeployConditionBase<DeployCompareConditionConfig> implements DeployExtensionCondition {
13
+ constructor(host: UmbControllerHost, args: UmbConditionControllerArguments<DeployCompareConditionConfig>);
14
+ evaluate(): Promise<void>;
15
+ }
16
+ export default DeployCompareCondition;
17
+ declare global {
18
+ interface UmbExtensionConditionConfigMap {
19
+ DeployCompareConditionConfig: DeployCompareConditionConfig;
20
+ }
21
+ }
@@ -0,0 +1,4 @@
1
+ import type { ManifestCondition } from "@umbraco-cms/backoffice/extension-api";
2
+ import type { ManifestEntityAction } from "@umbraco-cms/backoffice/entity-action";
3
+ import type { ManifestModal } from "@umbraco-cms/backoffice/modal";
4
+ export declare const manifests: (ManifestCondition | ManifestEntityAction<import("@umbraco-cms/backoffice/entity-action").MetaEntityAction> | ManifestModal)[];
@@ -0,0 +1,24 @@
1
+ import type { DeployCompareModalData } from "./compare-modal.token.js";
2
+ import { UmbModalBaseElement } from "@umbraco-cms/backoffice/modal";
3
+ declare const elementName = "deploy-compare-modal";
4
+ export declare class DeployCompareModalElement extends UmbModalBaseElement<DeployCompareModalData> {
5
+ #private;
6
+ private _compareWorkspace?;
7
+ private _compareDocument?;
8
+ private _languages?;
9
+ private _comparableContent?;
10
+ private _loading;
11
+ private _comparableContentFound;
12
+ private _nonComparableContentMessage;
13
+ private _canTransfer;
14
+ private _canRestore;
15
+ connectedCallback(): Promise<void>;
16
+ render(): import("lit-html").TemplateResult<1>;
17
+ static styles: import("lit").CSSResult[];
18
+ }
19
+ export default DeployCompareModalElement;
20
+ declare global {
21
+ interface HTMLElementTagNameMap {
22
+ [elementName]: DeployCompareModalElement;
23
+ }
24
+ }
@@ -0,0 +1,9 @@
1
+ import { UmbModalToken } from "@umbraco-cms/backoffice/modal";
2
+ export interface DeployCompareModalData {
3
+ document: {
4
+ unique: string | null;
5
+ entityType: string | null;
6
+ isRoot: boolean;
7
+ };
8
+ }
9
+ export declare const DEPLOY_COMPARE_MODAL: UmbModalToken<DeployCompareModalData, unknown>;
@@ -0,0 +1,2 @@
1
+ import type { ManifestCondition } from "@umbraco-cms/backoffice/extension-api";
2
+ export declare const manifests: ManifestCondition[];
@@ -0,0 +1,15 @@
1
+ import type { ManifestBase } from "@umbraco-cms/backoffice/extension-api";
2
+ export type DeployEntityActionType = "Deploy.EntityAction.EnvironmentRestore" | "Deploy.EntityAction.TreeRestore" | "Deploy.EntityAction.PartialRestore" | "Deploy.EntityAction.Queue" | "Deploy.EntityAction.Compare" | "Deploy.EntityAction.EnvironmentExport" | "Deploy.EntityAction.Export" | "Deploy.EntityAction.Import";
3
+ export interface ManifestDeployEntityActionRegistrar extends ManifestBase {
4
+ type: "deployEntityActionRegistrar";
5
+ actionAlias: DeployEntityActionType;
6
+ forEntityTypes: Array<string | {
7
+ entityTypes: Array<string>;
8
+ conditions: Array<"default" | UmbExtensionConditionConfigMap[keyof UmbExtensionConditionConfigMap]>;
9
+ }>;
10
+ }
11
+ declare global {
12
+ interface UmbExtensionManifestMap {
13
+ deployEntityActionRegistrar: ManifestDeployEntityActionRegistrar;
14
+ }
15
+ }
@@ -0,0 +1,10 @@
1
+ import type { ManifestBase } from "@umbraco-cms/backoffice/extension-api";
2
+ export interface ManifestDeployEntityTypeMapping extends ManifestBase {
3
+ type: "deployEntityTypeMapping";
4
+ entityTypes: Record<string, string>;
5
+ }
6
+ declare global {
7
+ interface UmbExtensionManifestMap {
8
+ deployEntityTypeMapping: ManifestDeployEntityTypeMapping;
9
+ }
10
+ }
@@ -0,0 +1,22 @@
1
+ import type { UmbConditionConfigBase, UmbConditionControllerArguments, UmbExtensionCondition } from "@umbraco-cms/backoffice/extension-api";
2
+ import { UmbConditionBase } from "@umbraco-cms/backoffice/extension-registry";
3
+ import type { UmbControllerHost } from "@umbraco-cms/backoffice/controller-api";
4
+ export declare const DEPLOY_ENTITYTYPE_CONDITION_ALIAS = "Deploy.Condition.EntityType";
5
+ export type DeployEntityTypeConditionConfig = UmbConditionConfigBase<typeof DEPLOY_ENTITYTYPE_CONDITION_ALIAS> & {
6
+ forEntityTypes?: {
7
+ [key: string]: Array<"default" | UmbExtensionConditionConfigMap[keyof UmbExtensionConditionConfigMap]>;
8
+ };
9
+ default: Array<UmbExtensionConditionConfigMap[keyof UmbExtensionConditionConfigMap]>;
10
+ };
11
+ export declare class DeployEntityTypeCondition extends UmbConditionBase<DeployEntityTypeConditionConfig> implements UmbExtensionCondition {
12
+ #private;
13
+ constructor(host: UmbControllerHost, args: UmbConditionControllerArguments<DeployEntityTypeConditionConfig>);
14
+ evaluate(entityType: string | undefined, args: UmbConditionControllerArguments<DeployEntityTypeConditionConfig>): Promise<void>;
15
+ destroy(): void;
16
+ }
17
+ export default DeployEntityTypeCondition;
18
+ declare global {
19
+ interface UmbExtensionConditionConfigMap {
20
+ DeployEntityTypeConditionConfig: DeployEntityTypeConditionConfig;
21
+ }
22
+ }
@@ -0,0 +1,5 @@
1
+ import { DeployExportBaseEntityAction } from "../export-base.action.js";
2
+ export declare class DeployEnvironmentExportEntityAction extends DeployExportBaseEntityAction {
3
+ execute(): Promise<void>;
4
+ }
5
+ export default DeployEnvironmentExportEntityAction;
@@ -0,0 +1,7 @@
1
+ import type { DeployEntityActionWithWorkDescription } from "../index.js";
2
+ import { DeployEntityActionBase } from "../index.js";
3
+ import type { DeployWorkDescriptionModel } from "../../entities.js";
4
+ export declare class DeployExportBaseEntityAction extends DeployEntityActionBase implements DeployEntityActionWithWorkDescription {
5
+ readonly _progressModel: DeployWorkDescriptionModel;
6
+ readonly _completeModel: DeployWorkDescriptionModel;
7
+ }
@@ -0,0 +1,3 @@
1
+ import type { ManifestEntityAction } from "@umbraco-cms/backoffice/entity-action";
2
+ import type { ManifestCondition } from "@umbraco-cms/backoffice/extension-api";
3
+ export declare const manifests: (ManifestCondition | ManifestEntityAction<import("@umbraco-cms/backoffice/entity-action").MetaEntityAction>)[];
@@ -0,0 +1,4 @@
1
+ import { DeployExportBaseEntityAction } from "../export-base.action.js";
2
+ export default class DeployExportEntityAction extends DeployExportBaseEntityAction {
3
+ execute(): Promise<void>;
4
+ }
@@ -0,0 +1,19 @@
1
+ import type { DeployExtensionCondition } from "../../base.condition.js";
2
+ import { DeployConditionBase } from "../../base.condition.js";
3
+ import type { UmbConditionConfigBase, UmbConditionControllerArguments } from "@umbraco-cms/backoffice/extension-api";
4
+ import type { UmbControllerHost } from "@umbraco-cms/backoffice/controller-api";
5
+ export declare const DEPLOY_TREE_EXPORT_CONDITION_ALIAS = "Deploy.Condition.TreeExport";
6
+ export type DeployTreeExportConditionConfig = UmbConditionConfigBase<typeof DEPLOY_TREE_EXPORT_CONDITION_ALIAS>;
7
+ /**
8
+ * Permitted when the entity supports import/export actions.
9
+ */
10
+ export declare class DeployTreeExportCondition extends DeployConditionBase<DeployTreeExportConditionConfig> implements DeployExtensionCondition {
11
+ constructor(host: UmbControllerHost, args: UmbConditionControllerArguments<DeployTreeExportConditionConfig>);
12
+ evaluate(): Promise<void>;
13
+ }
14
+ export default DeployTreeExportCondition;
15
+ declare global {
16
+ interface UmbExtensionConditionConfigMap {
17
+ DeployTreeExportConditionConfig: DeployTreeExportConditionConfig;
18
+ }
19
+ }
@@ -0,0 +1,8 @@
1
+ import type { DeployEntityActionWithWorkDescription } from "../base.action.js";
2
+ import { DeployEntityActionBase } from "../base.action.js";
3
+ import type { DeployWorkDescriptionModel } from "../../entities.js";
4
+ export default class DeployImportEntityAction extends DeployEntityActionBase implements DeployEntityActionWithWorkDescription {
5
+ readonly _progressModel: DeployWorkDescriptionModel;
6
+ readonly _completeModel: DeployWorkDescriptionModel;
7
+ execute(): Promise<void>;
8
+ }
@@ -0,0 +1,3 @@
1
+ import type { ManifestEntityAction } from "@umbraco-cms/backoffice/entity-action";
2
+ import type { ManifestModal } from "@umbraco-cms/backoffice/modal";
3
+ export declare const manifests: (ManifestEntityAction<import("@umbraco-cms/backoffice/entity-action").MetaEntityAction> | ManifestModal)[];
@@ -0,0 +1,22 @@
1
+ import type { DeployImportModalValue } from "./import-modal.token.js";
2
+ import { UmbModalBaseElement } from "@umbraco-cms/backoffice/modal";
3
+ declare const elementName = "deploy-import-modal";
4
+ export declare class DeployImportModalElement extends UmbModalBaseElement<object, DeployImportModalValue> {
5
+ #private;
6
+ private _allowSchemaImport;
7
+ private _temporaryFileKey?;
8
+ private _warningsAsErrors;
9
+ private _includeContentEntityTypes;
10
+ private _includeContentFileEntityTypes;
11
+ private _includeSchemaEntityTypes;
12
+ private _includeSchemaFileEntityTypes;
13
+ constructor();
14
+ render(): import("lit-html").TemplateResult<1>;
15
+ static styles: import("lit").CSSResult[];
16
+ }
17
+ export default DeployImportModalElement;
18
+ declare global {
19
+ interface HTMLElementTagNameMap {
20
+ [elementName]: DeployImportModalElement;
21
+ }
22
+ }
@@ -0,0 +1,10 @@
1
+ import { UmbModalToken } from "@umbraco-cms/backoffice/modal";
2
+ export interface DeployImportModalValue {
3
+ fileKey: string;
4
+ warningsAsErrors: boolean;
5
+ includeContentEntityTypes: boolean;
6
+ includeSchemaEntityTypes: boolean;
7
+ includeContentFileEntityTypes: boolean;
8
+ includeSchemaFileEntityTypes: boolean;
9
+ }
10
+ export declare const DEPLOY_IMPORT_MODAL: UmbModalToken<object, DeployImportModalValue>;
@@ -0,0 +1,4 @@
1
+ export * from "./base.action.js";
2
+ export * from "./export/export-base.action.js";
3
+ export * from "./restore/restore-base.action.js";
4
+ export * from "./compare/compare-table.element.js";
@@ -0,0 +1,2 @@
1
+ import type { ManifestDeployEntityTypeMapping } from "./entity-type-mapping.manifest.js";
2
+ export declare const manifests: (ManifestDeployEntityTypeMapping | import("@umbraco-cms/backoffice/extension-api").ManifestCondition | import("@umbraco-cms/backoffice/workspace").ManifestWorkspaceActionMenuItem<import("@umbraco-cms/backoffice/workspace").MetaWorkspaceActionMenuItem> | import("@umbraco-cms/backoffice/entity-action").ManifestEntityAction<import("@umbraco-cms/backoffice/entity-action").MetaEntityAction> | import("@umbraco-cms/backoffice/modal").ManifestModal | import("@umbraco-cms/backoffice/user-permission").ManifestEntityUserPermission)[];
@@ -0,0 +1,8 @@
1
+ import type { ManifestEntityUserPermission } from "@umbraco-cms/backoffice/user-permission";
2
+ export declare const DEPLOY_USER_PERMISSION_ENVIRONMENT_RESTORE = "Deploy.EnvironmentRestore";
3
+ export declare const DEPLOY_USER_PERMISSION_TREE_RESTORE = "Deploy.TreeRestore";
4
+ export declare const DEPLOY_USER_PERMISSION_PARTIAL_RESTORE = "Deploy.PartialRestore";
5
+ export declare const DEPLOY_USER_PERMISSION_QUEUE_FOR_TRANSFER = "Deploy.QueueForTransfer";
6
+ export declare const DEPLOY_USER_PERMISSION_EXPORT = "Deploy.Export";
7
+ export declare const DEPLOY_USER_PERMISSION_IMPORT = "Deploy.Import";
8
+ export declare const manifests: ManifestEntityUserPermission[];
@@ -0,0 +1,3 @@
1
+ import type { ManifestCondition } from "@umbraco-cms/backoffice/extension-api";
2
+ import type { ManifestEntityAction } from "@umbraco-cms/backoffice/entity-action";
3
+ export declare const manifests: (ManifestCondition | ManifestEntityAction<import("@umbraco-cms/backoffice/entity-action").MetaEntityAction>)[];
@@ -0,0 +1,8 @@
1
+ import type { DeployEntityActionWithWorkDescription } from "../base.action.js";
2
+ import { DeployEntityActionBase } from "../base.action.js";
3
+ import type { DeployWorkDescriptionModel } from "../../entities.js";
4
+ export default class DeployQueueEntityAction extends DeployEntityActionBase implements DeployEntityActionWithWorkDescription {
5
+ readonly _progressModel: DeployWorkDescriptionModel;
6
+ readonly _completeModel: DeployWorkDescriptionModel;
7
+ execute(): Promise<void>;
8
+ }
@@ -0,0 +1,19 @@
1
+ import type { DeployExtensionCondition } from "../base.condition.js";
2
+ import { DeployConditionBase } from "../base.condition.js";
3
+ import type { UmbConditionConfigBase, UmbConditionControllerArguments } from "@umbraco-cms/backoffice/extension-api";
4
+ import type { UmbControllerHost } from "@umbraco-cms/backoffice/controller-api";
5
+ export declare const DEPLOY_QUEUE_CONDITION_ALIAS = "Deploy.Condition.Queue";
6
+ export type DeployQueueConditionConfig = UmbConditionConfigBase<typeof DEPLOY_QUEUE_CONDITION_ALIAS>;
7
+ /**
8
+ * Permitted when the environment allows deploy options and the entity supports queue for transfer.
9
+ */
10
+ export declare class DeployQueueCondition extends DeployConditionBase<DeployQueueConditionConfig> implements DeployExtensionCondition {
11
+ constructor(host: UmbControllerHost, args: UmbConditionControllerArguments<DeployQueueConditionConfig>);
12
+ evaluate(): Promise<void>;
13
+ }
14
+ export default DeployQueueCondition;
15
+ declare global {
16
+ interface UmbExtensionConditionConfigMap {
17
+ DeployQueueConditionConfig: DeployQueueConditionConfig;
18
+ }
19
+ }
@@ -0,0 +1,4 @@
1
+ import { DeployRestoreBaseEntityAction } from "../restore-base.action.js";
2
+ export default class DeployEnvironmentRestoreEntityAction extends DeployRestoreBaseEntityAction {
3
+ execute(): Promise<void>;
4
+ }
@@ -0,0 +1,20 @@
1
+ import type { DeployExtensionCondition } from "../../base.condition.js";
2
+ import { DeployConditionBase } from "../../base.condition.js";
3
+ import type { UmbConditionConfigBase, UmbConditionControllerArguments } from "@umbraco-cms/backoffice/extension-api";
4
+ import type { UmbControllerHost } from "@umbraco-cms/backoffice/controller-api";
5
+ export declare const DEPLOY_ENVIRONMENT_RESTORE_CONDITION_ALIAS = "Deploy.Condition.EnvironmentRestore";
6
+ export type DeployEnvironmentRestoreConditionConfig = UmbConditionConfigBase<typeof DEPLOY_ENVIRONMENT_RESTORE_CONDITION_ALIAS>;
7
+ /**
8
+ * Permitted is true when allowRestoreOptions is true, and the entity is content or media.
9
+ * Content or media check is managed by the manifest where we set the permitted entity types.
10
+ */
11
+ export declare class DeployEnvironmentRestoreCondition extends DeployConditionBase<DeployEnvironmentRestoreConditionConfig> implements DeployExtensionCondition {
12
+ constructor(host: UmbControllerHost, args: UmbConditionControllerArguments<DeployEnvironmentRestoreConditionConfig>);
13
+ evaluate(): Promise<void>;
14
+ }
15
+ export default DeployEnvironmentRestoreCondition;
16
+ declare global {
17
+ interface UmbExtensionConditionConfigMap {
18
+ DeployEnvironmentRestoreConditionConfig: DeployEnvironmentRestoreConditionConfig;
19
+ }
20
+ }
@@ -0,0 +1,3 @@
1
+ import type { ManifestEntityAction } from "@umbraco-cms/backoffice/entity-action";
2
+ import type { ManifestCondition } from "@umbraco-cms/backoffice/extension-api";
3
+ export declare const manifests: (ManifestCondition | ManifestEntityAction<import("@umbraco-cms/backoffice/entity-action").MetaEntityAction>)[];
@@ -0,0 +1,4 @@
1
+ import { DeployRestoreBaseEntityAction } from "../restore-base.action.js";
2
+ export default class DeployPartialRestoreEntityAction extends DeployRestoreBaseEntityAction {
3
+ execute(): Promise<void>;
4
+ }
@@ -0,0 +1,19 @@
1
+ import type { DeployExtensionCondition } from "../../base.condition.js";
2
+ import { DeployConditionBase } from "../../base.condition.js";
3
+ import type { UmbConditionConfigBase, UmbConditionControllerArguments } from "@umbraco-cms/backoffice/extension-api";
4
+ import type { UmbControllerHost } from "@umbraco-cms/backoffice/controller-api";
5
+ export declare const DEPLOY_PARTIAL_RESTORE_CONDITION_ALIAS = "Deploy.Condition.PartialRestore";
6
+ export type DeployPartialRestoreConditionConfig = UmbConditionConfigBase<typeof DEPLOY_PARTIAL_RESTORE_CONDITION_ALIAS>;
7
+ /**
8
+ * Permitted when the environment allows restore options and the entity supports partial restore.
9
+ */
10
+ export declare class DeployPartialRestoreCondition extends DeployConditionBase<DeployPartialRestoreConditionConfig> implements DeployExtensionCondition {
11
+ constructor(host: UmbControllerHost, args: UmbConditionControllerArguments<DeployPartialRestoreConditionConfig>);
12
+ evaluate(): Promise<void>;
13
+ }
14
+ export default DeployPartialRestoreCondition;
15
+ declare global {
16
+ interface UmbExtensionConditionConfigMap {
17
+ DeployPartialRestoreConditionConfig: DeployPartialRestoreConditionConfig;
18
+ }
19
+ }
@@ -0,0 +1,9 @@
1
+ import type { DeployEntityActionWithWorkDescription } from "../index.js";
2
+ import { DeployEntityActionBase } from "../index.js";
3
+ import type { DeployRestoreModalValue } from "../../modal/index.js";
4
+ import type { DeployWorkDescriptionModel } from "../../entities.js";
5
+ export declare class DeployRestoreBaseEntityAction extends DeployEntityActionBase implements DeployEntityActionWithWorkDescription {
6
+ protected _restoreModel?: void | DeployRestoreModalValue;
7
+ readonly _progressModel: DeployWorkDescriptionModel;
8
+ readonly _completeModel: DeployWorkDescriptionModel;
9
+ }
@@ -0,0 +1,4 @@
1
+ import { DeployRestoreBaseEntityAction } from "../restore-base.action.js";
2
+ export default class DeployTreeRestoreEntityAction extends DeployRestoreBaseEntityAction {
3
+ execute(): Promise<void>;
4
+ }
@@ -0,0 +1,19 @@
1
+ import type { DeployExtensionCondition } from "../../base.condition.js";
2
+ import { DeployConditionBase } from "../../base.condition.js";
3
+ import type { UmbConditionConfigBase, UmbConditionControllerArguments } from "@umbraco-cms/backoffice/extension-api";
4
+ import type { UmbControllerHost } from "@umbraco-cms/backoffice/controller-api";
5
+ export declare const DEPLOY_TREE_RESTORE_CONDITION_ALIAS = "Deploy.Condition.TreeRestore";
6
+ export type DeployTreeRestoreConditionConfig = UmbConditionConfigBase<typeof DEPLOY_TREE_RESTORE_CONDITION_ALIAS>;
7
+ /**
8
+ * Permitted when the environment allows restore options and the entity supports restore.
9
+ */
10
+ export declare class DeployTreeRestoreCondition extends DeployConditionBase<DeployTreeRestoreConditionConfig> implements DeployExtensionCondition {
11
+ constructor(host: UmbControllerHost, args: UmbConditionControllerArguments<DeployTreeRestoreConditionConfig>);
12
+ evaluate(): Promise<void>;
13
+ }
14
+ export default DeployTreeRestoreCondition;
15
+ declare global {
16
+ interface UmbExtensionConditionConfigMap {
17
+ DeployTreeRestoreConditionConfig: DeployTreeRestoreConditionConfig;
18
+ }
19
+ }
@@ -0,0 +1,3 @@
1
+ import type { ManifestCondition } from "@umbraco-cms/backoffice/extension-api";
2
+ import type { ManifestWorkspaceActionMenuItem } from "@umbraco-cms/backoffice/workspace";
3
+ export declare const manifests: (ManifestCondition | ManifestWorkspaceActionMenuItem<import("@umbraco-cms/backoffice/workspace").MetaWorkspaceActionMenuItem>)[];
@@ -0,0 +1,7 @@
1
+ import { DeployEntityActionBase, type DeployEntityActionWithWorkDescription } from "../base.action.js";
2
+ import type { DeployWorkDescriptionModel } from "../../entities.js";
3
+ export default class DeployTransferNowEntityAction extends DeployEntityActionBase implements DeployEntityActionWithWorkDescription {
4
+ readonly _progressModel: DeployWorkDescriptionModel;
5
+ readonly _completeModel: DeployWorkDescriptionModel;
6
+ execute(): Promise<void>;
7
+ }
@@ -0,0 +1,19 @@
1
+ import type { DeployExtensionCondition } from "../base.condition.js";
2
+ import { DeployConditionBase } from "../base.condition.js";
3
+ import type { UmbConditionConfigBase, UmbConditionControllerArguments } from "@umbraco-cms/backoffice/extension-api";
4
+ import type { UmbControllerHost } from "@umbraco-cms/backoffice/controller-api";
5
+ export declare const DEPLOY_TRANSFER_NOW_CONDITION_ALIAS = "Deploy.Condition.TransferNow";
6
+ export type DeployTransferNowConditionConfig = UmbConditionConfigBase<typeof DEPLOY_TRANSFER_NOW_CONDITION_ALIAS>;
7
+ /**
8
+ * Permitted when the environment allows deploy options and the entity supports queue for transfer.
9
+ */
10
+ export declare class DeployTransferNowCondition extends DeployConditionBase<DeployTransferNowConditionConfig> implements DeployExtensionCondition {
11
+ constructor(host: UmbControllerHost, args: UmbConditionControllerArguments<DeployTransferNowConditionConfig>);
12
+ evaluate(): Promise<void>;
13
+ }
14
+ export default DeployTransferNowCondition;
15
+ declare global {
16
+ interface UmbExtensionConditionConfigMap {
17
+ DeployTransferNowConditionConfig: DeployTransferNowConditionConfig;
18
+ }
19
+ }
@@ -0,0 +1,31 @@
1
+ export type { DeployEntityActionType, ManifestDeployEntityActionRegistrar, } from "./entity-actions/entity-action-registrar.manifest.js";
2
+ export type { ManifestDeployEntityTypeMapping } from "./entity-actions/entity-type-mapping.manifest.js";
3
+ export { DeployEntityActionBase, type DeployEntityActionWithWorkDescription, } from "./entity-actions/base.action.js";
4
+ export { DeployExportBaseEntityAction } from "./entity-actions/export/export-base.action.js";
5
+ export { DeployRestoreBaseEntityAction } from "./entity-actions/restore/restore-base.action.js";
6
+ export { DEPLOY_ENTITYTYPE_CONDITION_ALIAS, type DeployEntityTypeConditionConfig, } from "./entity-actions/entity-type.condition.js";
7
+ export { DEPLOY_COMPARE_CONDITION_ALIAS, type DeployCompareConditionConfig, } from "./entity-actions/compare/compare.condition.js";
8
+ export { DEPLOY_TREE_EXPORT_CONDITION_ALIAS, type DeployTreeExportConditionConfig, } from "./entity-actions/export/tree/tree-export.condition.js";
9
+ export { DEPLOY_QUEUE_CONDITION_ALIAS, type DeployQueueConditionConfig, } from "./entity-actions/queue/queue.condition.js";
10
+ export { DEPLOY_ENVIRONMENT_RESTORE_CONDITION_ALIAS, type DeployEnvironmentRestoreConditionConfig, } from "./entity-actions/restore/environment/environment-restore.condition.js";
11
+ export { DEPLOY_PARTIAL_RESTORE_CONDITION_ALIAS, type DeployPartialRestoreConditionConfig, } from "./entity-actions/restore/partial/partial-restore.condition.js";
12
+ export { DEPLOY_TREE_RESTORE_CONDITION_ALIAS, type DeployTreeRestoreConditionConfig, } from "./entity-actions/restore/tree/tree-restore.condition.js";
13
+ export { DEPLOY_TRANSFER_NOW_CONDITION_ALIAS, type DeployTransferNowConditionConfig, } from "./entity-actions/transfer-now/transfer-now.condition.js";
14
+ export { DEPLOY_CONTEXT } from "./context/deploy.context-token.js";
15
+ export type { DeployContext, DeployRegisteredEntity, } from "./context/deploy.context.js";
16
+ export { DEPLOY_SIGNALR_CONTEXT } from "./context/signalr.context-token.js";
17
+ export type { DeploySignalRContext } from "./context/signalr.context.js";
18
+ export { DEPLOY_TRANSFER_QUEUE_MANAGER } from "./queue/transfer-queue-manager-context.token.js";
19
+ export type { DeployTransferQueueManagerContext } from "./queue/transfer-queue-manager.context.js";
20
+ export { DEPLOY_EXPORT_MODAL, DeployExportType, type DeployExportModalData, type DeployExportModalValue, } from "./modal/token/export-modal.token.js";
21
+ export { DEPLOY_QUEUE_MODAL, type DeployQueueModalData, type DeployQueueModalValue, } from "./modal/token/queue-modal.token.js";
22
+ export { DEPLOY_RESTORE_MODAL, type DeployRestoreModalData, type DeployRestoreModalValue, } from "./modal/token/restore-modal.token.js";
23
+ export { DEPLOY_PARTIALRESTORE_MODAL } from "./modal/token/partial-restore-modal.token.js";
24
+ export { DEPLOY_PROGRESS_MODAL, type DeployProgressModalData, } from "./modal/token/progress-modal.token.js";
25
+ export { DEPLOY_COMPARE_MODAL, type DeployCompareModalData, } from "./entity-actions/compare/modal/compare-modal.token.js";
26
+ export { DEPLOY_IMPORT_MODAL, type DeployImportModalValue, } from "./entity-actions/import/modal/import-modal.token.js";
27
+ export { DEPLOY_USER_PERMISSION_ENVIRONMENT_RESTORE, DEPLOY_USER_PERMISSION_TREE_RESTORE, DEPLOY_USER_PERMISSION_PARTIAL_RESTORE, DEPLOY_USER_PERMISSION_QUEUE_FOR_TRANSFER, DEPLOY_USER_PERMISSION_EXPORT, DEPLOY_USER_PERMISSION_IMPORT, } from "./entity-actions/permissions-manifests.js";
28
+ export type { DeployWorkDescriptionModel, DeployProgressModel, DeployErrorModel, DeployExceptionModel, DeployQueueItemModel, DeployDependencyModel, DeployMismatchModel, DeployMismatchDiffModel, } from "./entities.js";
29
+ export type { DeployExceptionType, DeployEnvironmentInfoModel, } from "./types.js";
30
+ export type { AddToQueueModel, ConfigurationModel, ClientConfigurationModel, DeployItemModel, LicenseStatusResponseModel, DeployRegisteredEntityTypeDetailOptionsModel, WorkItemDetailModel, WorkspaceInfoModel, MismatchDetailsModel, } from "./generated/index.js";
31
+ export { WorkStatusModel } from "./generated/index.js";
@@ -0,0 +1,2 @@
1
+ import type { Client, Config } from './types.gen';
2
+ export declare const createClient: (config?: Config) => Client;
@@ -0,0 +1,8 @@
1
+ export type { Auth } from '../core/auth.gen';
2
+ export type { QuerySerializerOptions } from '../core/bodySerializer.gen';
3
+ export { formDataBodySerializer, jsonBodySerializer, urlSearchParamsBodySerializer, } from '../core/bodySerializer.gen';
4
+ export { buildClientParams } from '../core/params.gen';
5
+ export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen';
6
+ export { createClient } from './client.gen';
7
+ export type { Client, ClientOptions, Config, CreateClientConfig, Options, RequestOptions, RequestResult, ResolvedRequestOptions, ResponseStyle, TDataShape, } from './types.gen';
8
+ export { createConfig, mergeHeaders } from './utils.gen';
@@ -0,0 +1,120 @@
1
+ import type { Auth } from '../core/auth.gen';
2
+ import type { ServerSentEventsOptions, ServerSentEventsResult } from '../core/serverSentEvents.gen';
3
+ import type { Client as CoreClient, Config as CoreConfig } from '../core/types.gen';
4
+ import type { Middleware } from './utils.gen';
5
+ export type ResponseStyle = 'data' | 'fields';
6
+ export interface Config<T extends ClientOptions = ClientOptions> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, CoreConfig {
7
+ /**
8
+ * Base URL for all requests made by this client.
9
+ */
10
+ baseUrl?: T['baseUrl'];
11
+ /**
12
+ * Fetch API implementation. You can use this option to provide a custom
13
+ * fetch instance.
14
+ *
15
+ * @default globalThis.fetch
16
+ */
17
+ fetch?: typeof fetch;
18
+ /**
19
+ * Please don't use the Fetch client for Next.js applications. The `next`
20
+ * options won't have any effect.
21
+ *
22
+ * Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
23
+ */
24
+ next?: never;
25
+ /**
26
+ * Return the response data parsed in a specified format. By default, `auto`
27
+ * will infer the appropriate method from the `Content-Type` response header.
28
+ * You can override this behavior with any of the {@link Body} methods.
29
+ * Select `stream` if you don't want to parse response data at all.
30
+ *
31
+ * @default 'auto'
32
+ */
33
+ parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
34
+ /**
35
+ * Should we return only data or multiple fields (data, error, response, etc.)?
36
+ *
37
+ * @default 'fields'
38
+ */
39
+ responseStyle?: ResponseStyle;
40
+ /**
41
+ * Throw an error instead of returning it in the response?
42
+ *
43
+ * @default false
44
+ */
45
+ throwOnError?: T['throwOnError'];
46
+ }
47
+ export interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
48
+ responseStyle: TResponseStyle;
49
+ throwOnError: ThrowOnError;
50
+ }>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
51
+ /**
52
+ * Any body that you want to add to your request.
53
+ *
54
+ * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
55
+ */
56
+ body?: unknown;
57
+ path?: Record<string, unknown>;
58
+ query?: Record<string, unknown>;
59
+ /**
60
+ * Security mechanism(s) to use for the request.
61
+ */
62
+ security?: ReadonlyArray<Auth>;
63
+ url: Url;
64
+ }
65
+ export interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
66
+ headers: Headers;
67
+ serializedBody?: string;
68
+ }
69
+ export type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
70
+ data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
71
+ request: Request;
72
+ response: Response;
73
+ }> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
74
+ data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
75
+ error: undefined;
76
+ } | {
77
+ data: undefined;
78
+ error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
79
+ }) & {
80
+ /** request may be undefined, because error may be from building the request object itself */
81
+ request?: Request;
82
+ /** response may be undefined, because error may be from building the request object itself or from a network error */
83
+ response?: Response;
84
+ }>;
85
+ export interface ClientOptions {
86
+ baseUrl?: string;
87
+ responseStyle?: ResponseStyle;
88
+ throwOnError?: boolean;
89
+ }
90
+ type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
91
+ type SseFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
92
+ type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
93
+ type BuildUrlFn = <TData extends {
94
+ body?: unknown;
95
+ path?: Record<string, unknown>;
96
+ query?: Record<string, unknown>;
97
+ url: string;
98
+ }>(options: TData & Options<TData>) => string;
99
+ export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
100
+ interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
101
+ };
102
+ /**
103
+ * The `createClientConfig()` function will be called on client initialization
104
+ * and the returned object will become the client's initial configuration.
105
+ *
106
+ * You may want to initialize your client this way instead of calling
107
+ * `setConfig()`. This is useful for example if you're using Next.js
108
+ * to ensure your client always has the correct values.
109
+ */
110
+ export type CreateClientConfig<T extends ClientOptions = ClientOptions> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>;
111
+ export interface TDataShape {
112
+ body?: unknown;
113
+ headers?: unknown;
114
+ path?: unknown;
115
+ query?: unknown;
116
+ url: string;
117
+ }
118
+ type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
119
+ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
120
+ export {};
@@ -0,0 +1,37 @@
1
+ import type { QuerySerializerOptions } from '../core/bodySerializer.gen';
2
+ import type { Client, ClientOptions, Config, RequestOptions } from './types.gen';
3
+ export declare const createQuerySerializer: <T = unknown>({ parameters, ...args }?: QuerySerializerOptions) => (queryParams: T) => string;
4
+ /**
5
+ * Infers parseAs value from provided Content-Type header.
6
+ */
7
+ export declare const getParseAs: (contentType: string | null) => Exclude<Config["parseAs"], "auto">;
8
+ export declare const setAuthParams: ({ security, ...options }: Pick<Required<RequestOptions>, "security"> & Pick<RequestOptions, "auth" | "query"> & {
9
+ headers: Headers;
10
+ }) => Promise<void>;
11
+ export declare const buildUrl: Client['buildUrl'];
12
+ export declare const mergeConfigs: (a: Config, b: Config) => Config;
13
+ export declare const mergeHeaders: (...headers: Array<Required<Config>["headers"] | undefined>) => Headers;
14
+ type ErrInterceptor<Err, Res, Req, Options> = (error: Err,
15
+ /** response may be undefined due to a network error where no response object is produced */
16
+ response: Res | undefined,
17
+ /** request may be undefined, because error may be from building the request object itself */
18
+ request: Req | undefined, options: Options) => Err | Promise<Err>;
19
+ type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
20
+ type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
21
+ declare class Interceptors<Interceptor> {
22
+ fns: Array<Interceptor | null>;
23
+ clear(): void;
24
+ eject(id: number | Interceptor): void;
25
+ exists(id: number | Interceptor): boolean;
26
+ getInterceptorIndex(id: number | Interceptor): number;
27
+ update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
28
+ use(fn: Interceptor): number;
29
+ }
30
+ export interface Middleware<Req, Res, Err, Options> {
31
+ error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
32
+ request: Interceptors<ReqInterceptor<Req, Options>>;
33
+ response: Interceptors<ResInterceptor<Res, Req, Options>>;
34
+ }
35
+ export declare const createInterceptors: <Req, Res, Err, Options>() => Middleware<Req, Res, Err, Options>;
36
+ export declare const createConfig: <T extends ClientOptions = ClientOptions>(override?: Config<Omit<ClientOptions, keyof T> & T>) => Config<Omit<ClientOptions, keyof T> & T>;
37
+ export {};