@adobe/aio-commerce-lib-app 1.5.0 → 1.7.0

package/dist/es/step-0eI2x4C9.d.mts

@@ -1,187 +0,0 @@
-/**
- * @license
- *
- * Copyright 2026 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import { n as CommerceAppConfigOutputModel } from "./app-DcY6dJiQ.mjs";
-import AioLogger from "@adobe/aio-lib-core-logging";
-import * as v from "valibot";
-import { RuntimeActionParams } from "@adobe/aio-commerce-lib-core/params";
-
-//#region source/management/installation/schema.d.ts
-/** Schema for validating Adobe I/O app credentials required for installation. */
-declare const AppDataSchema: v.ObjectSchema<{
-  readonly consumerOrgId: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.NonEmptyAction<string, `The value of "${string}" must not be empty`>]>;
-  readonly orgName: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.NonEmptyAction<string, `The value of "${string}" must not be empty`>]>;
-  readonly projectId: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.NonEmptyAction<string, `The value of "${string}" must not be empty`>]>;
-  readonly projectName: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.NonEmptyAction<string, `The value of "${string}" must not be empty`>]>;
-  readonly projectTitle: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.NonEmptyAction<string, `The value of "${string}" must not be empty`>]>;
-  readonly workspaceId: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.NonEmptyAction<string, `The value of "${string}" must not be empty`>]>;
-  readonly workspaceName: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.NonEmptyAction<string, `The value of "${string}" must not be empty`>]>;
-  readonly workspaceTitle: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.NonEmptyAction<string, `The value of "${string}" must not be empty`>]>;
-}, undefined>;
-/** Type for Adobe I/O app credentials. */
-type AppData = v.InferOutput<typeof AppDataSchema>;
-//#endregion
-//#region source/management/installation/workflow/step.d.ts
-/** Severity level of a validation issue. */
-type ValidationIssueSeverity = "error" | "warning" | "info";
-/** A single validation issue reported by a step's validate handler. */
-type ValidationIssue = {
-  /** Machine-readable code identifying the issue type. */code: string; /** Human-readable description of the issue. */
-  message: string; /** Severity of the issue. Only "error" severity blocks installation. */
-  severity: ValidationIssueSeverity; /** Optional additional context about the issue. */
-  details?: Record<string, unknown>;
-};
-/** Shared context available to all steps during installation. */
-type InstallationContext = {
-  /** The credentials of the app being installed */appData: AppData; /** The raw action parameters from the App Builder runtime action. */
-  params: RuntimeActionParams & {
-    AIO_COMMERCE_AUTH_IMS_CLIENT_ID: string;
-    AIO_COMMERCE_AUTH_IMS_CLIENT_SECRETS: string | string[];
-    AIO_COMMERCE_AUTH_IMS_TECHNICAL_ACCOUNT_ID: string;
-    AIO_COMMERCE_AUTH_IMS_TECHNICAL_ACCOUNT_EMAIL: string;
-    AIO_COMMERCE_AUTH_IMS_ORG_ID: string;
-    AIO_COMMERCE_AUTH_IMS_SCOPES: string | string[];
-  }; /** Logger instance for installation logging. */
-  logger: ReturnType<typeof AioLogger>; /** Custom scripts defined in the configuration (if any). */
-  customScripts?: Record<string, unknown>;
-};
-/** Factory function type for creating step-specific context. */
-type StepContextFactory<TStepCtx extends Record<string, unknown> = Record<string, unknown>> = (context: InstallationContext) => TStepCtx | Promise<TStepCtx>;
-/** The execution context passed to leaf step run handlers. */
-type ExecutionContext<TStepCtx extends Record<string, unknown> = Record<string, unknown>> = InstallationContext & TStepCtx;
-/**
- * A narrowed context available to step `validate` handlers.
- * Excludes `customScripts` — those only apply during installation, not pre-flight validation.
- */
-type ValidationContext = Omit<InstallationContext, "customScripts">;
-/** The context passed to step `validate` handlers (base validation context merged with step-level context). */
-type ValidationExecutionContext<TStepCtx extends Record<string, unknown> = Record<string, unknown>> = ValidationContext & TStepCtx;
-/** Metadata info for a step (used for UI display). */
-type StepMetaInfo = {
-  label: string;
-  description?: string;
-};
-/** Step metadata keyed by execution mode. */
-type StepMeta = {
-  install: StepMetaInfo;
-  uninstall?: StepMetaInfo;
-};
-/** Defines the base properties of a step. */
-type StepBase<TName extends string = string, TConfig extends CommerceAppConfigOutputModel = CommerceAppConfigOutputModel> = {
-  /** The name of this step. */name: TName; /** Metadata associated with the step, keyed by execution mode. */
-  meta: StepMeta; /** Whether the step should be taken into consideration. */
-  when?: (config: CommerceAppConfigOutputModel) => config is TConfig;
-};
-/** A leaf step that executes work (no children). */
-type LeafStep<TName extends string = string, TConfig extends CommerceAppConfigOutputModel = CommerceAppConfigOutputModel, TStepCtx extends Record<string, unknown> = Record<string, unknown>, TOutput = unknown> = StepBase<TName, TConfig> & {
-  type: "leaf"; /** The execution handler for the step. */
-  install: (config: TConfig, context: ExecutionContext<TStepCtx>) => TOutput | Promise<TOutput>;
-  /**
-   * Optional pre-installation validation handler.
-   * Called before installation begins to surface issues (errors or warnings).
-   * Returning an empty array means the step has no issues.
-   */
-  validate?: (config: TConfig, context: ValidationExecutionContext<TStepCtx>) => ValidationIssue[] | Promise<ValidationIssue[]>;
-  /**
-   * Optional uninstall handler for the step.
-   * Called during uninstallation to reverse the work done by `install`.
-   * If absent, the step is silently skipped during uninstallation.
-   */
-  uninstall?: (config: TConfig, context: ExecutionContext<TStepCtx>) => void | Promise<void>;
-};
-/** A branch step that contains children (no execution). */
-type BranchStep<TName extends string = string, TConfig extends CommerceAppConfigOutputModel = CommerceAppConfigOutputModel, TStepCtx extends Record<string, unknown> = Record<string, unknown>, TChildren extends AnyStep[] = AnyStep[]> = StepBase<TName, TConfig> & {
-  type: "branch"; /** An optional factory function to setup shared context for the children steps. */
-  context?: StepContextFactory<TStepCtx>; /** The children steps of this branch. */
-  children: TChildren;
-  /**
-   * Optional pre-installation validation handler for the branch itself.
-   * Called before children are validated. Returning an empty array means
-   * the branch has no issues at this level.
-   */
-  validate?: (config: TConfig, context: ValidationExecutionContext<TStepCtx>) => ValidationIssue[] | Promise<ValidationIssue[]>;
-};
-/** A step in the installation tree (discriminated union by `type`). */
-type Step<TName extends string = string, TConfig extends CommerceAppConfigOutputModel = CommerceAppConfigOutputModel, TStepCtx extends Record<string, unknown> = Record<string, unknown>, TOutput = unknown> = LeafStep<TName, TConfig, TStepCtx, TOutput> | BranchStep<TName, TConfig, TStepCtx>;
-/** Loosely-typed step for use in non type-safe contexts. */
-interface AnyStep {
-  children?: AnyStep[];
-  context?: (context: InstallationContext) => any;
-  install?: (config: any, context: any) => unknown | Promise<unknown>;
-  meta: StepMeta;
-  name: string;
-  type: "leaf" | "branch";
-  uninstall?: (config: any, context: any) => void | Promise<void>;
-  validate?: (config: any, context: any) => ValidationIssue[] | Promise<ValidationIssue[]>;
-  when?: (config: CommerceAppConfigOutputModel) => boolean;
-}
-/** Check if a step is a leaf step. */
-declare function isLeafStep(step: AnyStep): step is LeafStep;
-/** Check if a step is a branch step. */
-declare function isBranchStep(step: AnyStep): step is BranchStep;
-/** Options for defining a leaf step. */
-type LeafStepOptions<TName extends string, TConfig extends CommerceAppConfigOutputModel, TStepCtx extends Record<string, unknown> = Record<string, unknown>, TOutput = unknown> = Omit<LeafStep<TName, TConfig, TStepCtx, TOutput>, "type">;
-/** Options for defining a branch step. */
-type BranchStepOptions<TName extends string, TConfig extends CommerceAppConfigOutputModel, TStepCtx extends Record<string, unknown> = Record<string, unknown>, TChildren extends AnyStep[] = AnyStep[]> = Omit<BranchStep<TName, TConfig, TStepCtx, TChildren>, "type">;
-/**
- * Define a leaf step (executable, no children).
- *
- * @example
- * ```typescript
- * const createProviders = defineLeafStep({
- *   name: "providers",
- *   meta: { install: { label: "Create Providers", description: "Creates I/O Events providers" } },
- *   install: async ({ config, stepContext }) => {
- *     const { eventsClient } = stepContext;
- *     return eventsClient.createProvider(config.eventing);
- *   },
- * });
- * ```
- */
-declare function defineLeafStep<TName extends string, TConfig extends CommerceAppConfigOutputModel, TStepCtx extends Record<string, unknown> = Record<string, unknown>, TOutput = unknown>(options: LeafStepOptions<TName, TConfig, TStepCtx, TOutput>): {
-  type: "leaf";
-  name: TName;
-  meta: StepMeta;
-  when: ((config: CommerceAppConfigOutputModel) => config is TConfig) | undefined;
-  install: (config: TConfig, context: ExecutionContext<TStepCtx>) => TOutput | Promise<TOutput>;
-  uninstall: ((config: TConfig, context: ExecutionContext<TStepCtx>) => void | Promise<void>) | undefined;
-  validate: ((config: TConfig, context: ValidationExecutionContext<TStepCtx>) => ValidationIssue[] | Promise<ValidationIssue[]>) | undefined;
-};
-/**
- * Define a branch step (container with children, no runner).
- *
- * @example
- * ```typescript
- * const eventing = defineBranchStep({
- *   name: "eventing",
- *   meta: { install: { label: "Eventing", description: "Sets up I/O Events" } },
- *   when: hasEventing,
- *   context: async (ctx) => ({ eventsClient: await createEventsClient(ctx) }),
- *   children: [commerceEventsStep, externalEventsStep],
- * });
- * ```
- */
-declare function defineBranchStep<TName extends string, TConfig extends CommerceAppConfigOutputModel, TStepCtx extends Record<string, unknown> = Record<string, unknown>, const TChildren extends AnyStep[] = AnyStep[]>(options: BranchStepOptions<TName, TConfig, TStepCtx, TChildren>): {
-  type: "branch";
-  name: TName;
-  meta: StepMeta;
-  when: ((config: CommerceAppConfigOutputModel) => config is TConfig) | undefined;
-  context: StepContextFactory<TStepCtx> | undefined;
-  children: TChildren;
-  validate: ((config: TConfig, context: ValidationExecutionContext<TStepCtx>) => ValidationIssue[] | Promise<ValidationIssue[]>) | undefined;
-};
-/** Infer the output type from a leaf step. */
-type InferStepOutput<TStep> = TStep extends LeafStep<infer _TName, infer _TConfig, infer _TStepCtx, infer TOutput> ? Awaited<TOutput> : never;
-//#endregion
-export { defineBranchStep as _, InferStepOutput as a, isLeafStep as b, LeafStepOptions as c, StepMeta as d, StepMetaInfo as f, ValidationIssueSeverity as g, ValidationIssue as h, ExecutionContext as i, Step as l, ValidationExecutionContext as m, BranchStep as n, InstallationContext as o, ValidationContext as p, BranchStepOptions as r, LeafStep as s, AnyStep as t, StepContextFactory as u, defineLeafStep as v, isBranchStep as y };