@adobe/aio-commerce-lib-app 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @adobe/aio-commerce-lib-app
 
+## 1.2.0
+
+### Minor Changes
+
+- [#351](https://github.com/adobe/aio-commerce-sdk/pull/351) [`8af56e1`](https://github.com/adobe/aio-commerce-sdk/commit/8af56e142179b4d15249ce385bda23117003c133) Thanks [@oshmyheliuk](https://github.com/oshmyheliuk)! - Add workspace ID to the event provider instance ID to ensure uniqueness within the IMS org.
+
+- [#372](https://github.com/adobe/aio-commerce-sdk/pull/372) [`a04ee2b`](https://github.com/adobe/aio-commerce-sdk/commit/a04ee2b511aa7169e9fcc827f8eddab6192f00ba) Thanks [@asalloum5](https://github.com/asalloum5)! - Added Admin UI SDK installation step to correctly configure extensions in Adobe Commerce instance.
+
+### Patch Changes
+
+- [#370](https://github.com/adobe/aio-commerce-sdk/pull/370) [`a627efc`](https://github.com/adobe/aio-commerce-sdk/commit/a627efc95d8176ff20a4506f9cadd828c9886d84) Thanks [@iivvaannxx](https://github.com/iivvaannxx)! - Only configure the Commerce Eventing Module when it doesn't have a default provider or a workspace configuration.
+
+- Updated dependencies [[`fe79660`](https://github.com/adobe/aio-commerce-sdk/commit/fe79660a9f010b5651f36e4e9d85bb11fc856296), [`fe79660`](https://github.com/adobe/aio-commerce-sdk/commit/fe79660a9f010b5651f36e4e9d85bb11fc856296), [`eeef589`](https://github.com/adobe/aio-commerce-sdk/commit/eeef589461f9bd684ed1fcf23ff97dfeba88723e), [`3e4b765`](https://github.com/adobe/aio-commerce-sdk/commit/3e4b7657cd34ff45317d29067846a4a113a3d37f)]:
+  - @adobe/aio-commerce-lib-config@1.1.0
+
 ## 1.1.0
 
 ### Minor Changes

package/dist/cjs/actions/app-config.cjs

@@ -15,7 +15,7 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_schemas = require('../schemas-nkIxa8sL.cjs');
 const require_router = require('../router-KeQRduO3.cjs');
-const require_validate = require('../validate-CwwYD8aC.cjs');
+const require_validate = require('../validate-CeUCT_7k.cjs');
 let _adobe_aio_commerce_lib_core_responses = require("@adobe/aio-commerce-lib-core/responses");
 
 //#region source/actions/app-config.ts

package/dist/cjs/actions/app-config.d.cts

@@ -12,8 +12,8 @@
  * governing permissions and limitations under the License.
  */
 
-import { n as CommerceAppConfigOutputModel } from "../app-lymFcs59.cjs";
-import * as _adobe_aio_commerce_lib_core_responses0 from "@adobe/aio-commerce-lib-core/responses";
+import { n as CommerceAppConfigOutputModel } from "../app-DcQMhW2N.cjs";
+import * as _$_adobe_aio_commerce_lib_core_responses0 from "@adobe/aio-commerce-lib-core/responses";
 import { RuntimeActionParams } from "@adobe/aio-commerce-lib-core/params";
 
 //#region source/actions/app-config.d.ts
@@ -24,6 +24,6 @@ type RuntimeActionFactoryArgs = {
 /** Factory to create the route handler for the `app-config` action. */
 declare const appConfigRuntimeAction: ({
   appConfig
-}: RuntimeActionFactoryArgs) => (params: RuntimeActionParams) => Promise<_adobe_aio_commerce_lib_core_responses0.ActionResponse>;
+}: RuntimeActionFactoryArgs) => (params: RuntimeActionParams) => Promise<_$_adobe_aio_commerce_lib_core_responses0.ActionResponse>;
 //#endregion
 export { appConfigRuntimeAction };

package/dist/cjs/actions/config.cjs

@@ -15,7 +15,7 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_schemas = require('../schemas-nkIxa8sL.cjs');
 const require_router = require('../router-KeQRduO3.cjs');
-const require_validate = require('../validate-CwwYD8aC.cjs');
+const require_validate = require('../validate-CeUCT_7k.cjs');
 let _adobe_aio_commerce_lib_core_responses = require("@adobe/aio-commerce-lib-core/responses");
 let valibot = require("valibot");
 valibot = require_schemas.__toESM(valibot);

package/dist/cjs/actions/config.d.cts

@@ -12,7 +12,7 @@
  * governing permissions and limitations under the License.
  */
 
-import * as _adobe_aio_commerce_lib_core_responses0 from "@adobe/aio-commerce-lib-core/responses";
+import * as _$_adobe_aio_commerce_lib_core_responses0 from "@adobe/aio-commerce-lib-core/responses";
 import { RuntimeActionParams } from "@adobe/aio-commerce-lib-core/params";
 import { BusinessConfigSchema } from "@adobe/aio-commerce-lib-config";
 
@@ -24,6 +24,6 @@ type ConfigActionFactoryArgs = {
 /** Factory to create the route handler for the `config` action. */
 declare const configRuntimeAction: ({
   configSchema
-}: ConfigActionFactoryArgs) => (params: RuntimeActionParams) => Promise<_adobe_aio_commerce_lib_core_responses0.ActionResponse>;
+}: ConfigActionFactoryArgs) => (params: RuntimeActionParams) => Promise<_$_adobe_aio_commerce_lib_core_responses0.ActionResponse>;
 //#endregion
 export { configRuntimeAction };

package/dist/cjs/actions/installation.cjs

@@ -15,7 +15,7 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_schemas = require('../schemas-nkIxa8sL.cjs');
 const require_router = require('../router-KeQRduO3.cjs');
-const require_management = require('../management-PZtLe4Ji.cjs');
+const require_management = require('../management-iLQubQ7K.cjs');
 let _adobe_aio_commerce_lib_core_responses = require("@adobe/aio-commerce-lib-core/responses");
 let valibot = require("valibot");
 valibot = require_schemas.__toESM(valibot);

package/dist/cjs/actions/installation.d.cts

@@ -12,9 +12,9 @@
  * governing permissions and limitations under the License.
  */
 
-import { n as CommerceAppConfigOutputModel } from "../app-lymFcs59.cjs";
-import { V as InstallationContext } from "../index-DRhLtRrX.cjs";
-import * as _adobe_aio_commerce_lib_core_responses0 from "@adobe/aio-commerce-lib-core/responses";
+import { n as CommerceAppConfigOutputModel } from "../app-DcQMhW2N.cjs";
+import { V as InstallationContext } from "../index-DZxladgt.cjs";
+import * as _$_adobe_aio_commerce_lib_core_responses0 from "@adobe/aio-commerce-lib-core/responses";
 import { RuntimeActionParams } from "@adobe/aio-commerce-lib-core/params";
 
 //#region source/actions/installation.d.ts
@@ -28,6 +28,6 @@ type RuntimeActionFactoryArgs = {
 declare const installationRuntimeAction: ({
   appConfig,
   customScriptsLoader
-}: RuntimeActionFactoryArgs) => (params: RuntimeActionParams) => Promise<_adobe_aio_commerce_lib_core_responses0.ActionResponse>;
+}: RuntimeActionFactoryArgs) => (params: RuntimeActionParams) => Promise<_$_adobe_aio_commerce_lib_core_responses0.ActionResponse>;
 //#endregion
 export { installationRuntimeAction };

package/dist/cjs/actions/scope-tree.d.cts

@@ -12,11 +12,11 @@
  * governing permissions and limitations under the License.
  */
 
-import * as _adobe_aio_commerce_lib_core_responses0 from "@adobe/aio-commerce-lib-core/responses";
-import * as _adobe_aio_commerce_lib_core_params0 from "@adobe/aio-commerce-lib-core/params";
+import * as _$_adobe_aio_commerce_lib_core_responses0 from "@adobe/aio-commerce-lib-core/responses";
+import * as _$_adobe_aio_commerce_lib_core_params0 from "@adobe/aio-commerce-lib-core/params";
 
 //#region source/actions/scope-tree.d.ts
 /** The handler method for the `scope-tree` action. */
-declare const scopeTreeRuntimeAction: (args: _adobe_aio_commerce_lib_core_params0.RuntimeActionParams) => Promise<_adobe_aio_commerce_lib_core_responses0.ActionResponse>;
+declare const scopeTreeRuntimeAction: (args: _$_adobe_aio_commerce_lib_core_params0.RuntimeActionParams) => Promise<_$_adobe_aio_commerce_lib_core_responses0.ActionResponse>;
 //#endregion
 export { scopeTreeRuntimeAction };

package/dist/cjs/{app-lymFcs59.d.cts → app-DcQMhW2N.d.cts}

@@ -18,7 +18,7 @@ import * as v from "valibot";
 /** The schema used to validate the commerce app config file. */
 declare const CommerceAppConfigSchema: v.LooseObjectSchema<{
   readonly metadata: v.ObjectSchema<{
-    readonly id: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.RegexAction<string, `Only alphanumeric characters and hyphens are allowed in string value of "${string}"${string}`>]>;
+    readonly id: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.RegexAction<string, `Only alphanumeric characters and hyphens are allowed in string value of "${string}"${string}`>]>, v.MaxLengthAction<string, 100, "The application id must not be longer than 100 characters">]>;
     readonly displayName: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for the ${string}`>, v.NonEmptyAction<string, `The ${string} must not be empty`>]>, v.MaxLengthAction<string, 50, "The application display name must not be longer than 50 characters">]>;
     readonly description: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for the ${string}`>, v.NonEmptyAction<string, `The ${string} must not be empty`>]>, v.MaxLengthAction<string, 255, "The metadata description must not be longer than 255 characters">]>;
     readonly version: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for the ${string}`>, v.NonEmptyAction<string, `The ${string} must not be empty`>]>, v.RegexAction<string, "The version must follow semantic versioning (semver) format: Major.Minor.Patch (e.g., '1.0.0', '2.3.1')">]>;
@@ -171,6 +171,18 @@ declare const CommerceAppConfigSchema: v.LooseObjectSchema<{
       }, undefined>, "Expected an array of external events">;
     }, undefined>, "Expected an array of external event sources">, undefined>;
   }, undefined>, undefined>;
+  readonly adminUiSdk: v.OptionalSchema<v.ObjectSchema<{
+    readonly registration: v.ObjectSchema<{
+      readonly menuItems: v.ArraySchema<v.ObjectSchema<{
+        readonly id: v.StringSchema<undefined>;
+        readonly title: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        readonly parent: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        readonly sortOrder: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+        readonly sandbox: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        readonly isSection: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
+      }, undefined>, undefined>;
+    }, undefined>;
+  }, undefined>, undefined>;
   readonly installation: v.OptionalSchema<v.ObjectSchema<{
     readonly messages: v.OptionalSchema<v.ObjectSchema<{
       readonly preInstallation: v.OptionalSchema<v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.NonEmptyAction<string, `The value of "${string}" must not be empty`>]>, v.MaxLengthAction<string, 1000, "The preInstallation message must not be longer than 1000 characters">]>, undefined>;

package/dist/cjs/commands/index.cjs

@@ -14,9 +14,9 @@
  */
 
 const require_schemas = require('../schemas-nkIxa8sL.cjs');
-const require_validate = require('../validate-CwwYD8aC.cjs');
-const require_webhooks = require('../webhooks-CbZpv9y_.cjs');
-const require_config = require('../config-YEeaEqzi.cjs');
+const require_webhooks = require('../webhooks-CLtDxwMa.cjs');
+const require_validate = require('../validate-CeUCT_7k.cjs');
+const require_config = require('../config-BppBKCFj.cjs');
 const require_error = require('../error-Dn7ool6k.cjs');
 const require_logging = require('../logging-4s36JTiN.cjs');
 let _adobe_aio_commerce_lib_core_error = require("@adobe/aio-commerce-lib-core/error");

package/dist/cjs/config/index.cjs

@@ -13,9 +13,9 @@
  */
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_validate = require('../validate-CwwYD8aC.cjs');
-const require_webhooks = require('../webhooks-CbZpv9y_.cjs');
-const require_config = require('../config-YEeaEqzi.cjs');
+const require_webhooks = require('../webhooks-CLtDxwMa.cjs');
+const require_validate = require('../validate-CeUCT_7k.cjs');
+const require_config = require('../config-BppBKCFj.cjs');
 
 exports.CommerceAppConfigSchemas = require_validate.CommerceAppConfigSchemas;
 exports.defineConfig = require_config.defineConfig;

package/dist/cjs/config/index.d.cts

@@ -12,7 +12,7 @@
  * governing permissions and limitations under the License.
  */
 
-import { n as CommerceAppConfigOutputModel, t as CommerceAppConfig } from "../app-lymFcs59.cjs";
+import { n as CommerceAppConfigOutputModel, t as CommerceAppConfig } from "../app-DcQMhW2N.cjs";
 import * as v from "valibot";
 import { Get, SetRequiredDeep } from "type-fest";
 
@@ -134,6 +134,18 @@ declare function defineConfig(config: CommerceAppConfig): {
       }[];
     }[] | undefined;
   } | undefined;
+  adminUiSdk?: {
+    registration: {
+      menuItems: {
+        id: string;
+        title?: string | undefined;
+        parent?: string | undefined;
+        sortOrder?: number | undefined;
+        sandbox?: string | undefined;
+        isSection?: boolean | undefined;
+      }[];
+    };
+  } | undefined;
   installation?: {
     messages?: {
       preInstallation?: string | undefined;
@@ -355,6 +367,18 @@ declare function parseCommerceAppConfig(cwd?: string): Promise<{
       }[];
     }[] | undefined;
   } | undefined;
+  adminUiSdk?: {
+    registration: {
+      menuItems: {
+        id: string;
+        title?: string | undefined;
+        parent?: string | undefined;
+        sortOrder?: number | undefined;
+        sandbox?: string | undefined;
+        isSection?: boolean | undefined;
+      }[];
+    };
+  } | undefined;
   installation?: {
     messages?: {
       preInstallation?: string | undefined;
@@ -440,7 +464,7 @@ declare function parseCommerceAppConfig(cwd?: string): Promise<{
 /** The individual validatable domains of the app config. */
 declare const CommerceAppConfigSchemas: {
   readonly metadata: v.ObjectSchema<{
-    readonly id: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.RegexAction<string, `Only alphanumeric characters and hyphens are allowed in string value of "${string}"${string}`>]>;
+    readonly id: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.RegexAction<string, `Only alphanumeric characters and hyphens are allowed in string value of "${string}"${string}`>]>, v.MaxLengthAction<string, 100, "The application id must not be longer than 100 characters">]>;
     readonly displayName: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for the ${string}`>, v.NonEmptyAction<string, `The ${string} must not be empty`>]>, v.MaxLengthAction<string, 50, "The application display name must not be longer than 50 characters">]>;
     readonly description: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for the ${string}`>, v.NonEmptyAction<string, `The ${string} must not be empty`>]>, v.MaxLengthAction<string, 255, "The metadata description must not be longer than 255 characters">]>;
     readonly version: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for the ${string}`>, v.NonEmptyAction<string, `The ${string} must not be empty`>]>, v.RegexAction<string, "The version must follow semantic versioning (semver) format: Major.Minor.Patch (e.g., '1.0.0', '2.3.1')">]>;
@@ -888,6 +912,18 @@ declare const CommerceAppConfigSchemas: {
     readonly name: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.NonEmptyAction<string, `The value of "${string}" must not be empty`>]>, v.MaxLengthAction<string, 255, "The step name must not be longer than 255 characters">]>;
     readonly description: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.NonEmptyAction<string, `The value of "${string}" must not be empty`>]>, v.MaxLengthAction<string, 255, "The step description must not be longer than 255 characters">]>;
   }, undefined>, "Expected an array of custom installation steps">;
+  readonly adminUiSdk: v.ObjectSchema<{
+    readonly registration: v.ObjectSchema<{
+      readonly menuItems: v.ArraySchema<v.ObjectSchema<{
+        readonly id: v.StringSchema<undefined>;
+        readonly title: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        readonly parent: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        readonly sortOrder: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+        readonly sandbox: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        readonly isSection: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
+      }, undefined>, undefined>;
+    }, undefined>;
+  }, undefined>;
 };
 /** Individual validatable domains of the commerce app config. */
 type CommerceAppConfigDomain = keyof typeof CommerceAppConfigSchemas;
@@ -1169,7 +1205,7 @@ declare function hasCustomInstallationSteps(config: CommerceAppConfigOutputModel
 //#region source/config/schema/metadata.d.ts
 /** The schema for the metadata of the application. */
 declare const MetadataSchema: v.ObjectSchema<{
-  readonly id: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.RegexAction<string, `Only alphanumeric characters and hyphens are allowed in string value of "${string}"${string}`>]>;
+  readonly id: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for '${string}'`>, v.RegexAction<string, `Only alphanumeric characters and hyphens are allowed in string value of "${string}"${string}`>]>, v.MaxLengthAction<string, 100, "The application id must not be longer than 100 characters">]>;
   readonly displayName: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for the ${string}`>, v.NonEmptyAction<string, `The ${string} must not be empty`>]>, v.MaxLengthAction<string, 50, "The application display name must not be longer than 50 characters">]>;
   readonly description: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for the ${string}`>, v.NonEmptyAction<string, `The ${string} must not be empty`>]>, v.MaxLengthAction<string, 255, "The metadata description must not be longer than 255 characters">]>;
   readonly version: v.SchemaWithPipe<readonly [v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for the ${string}`>, v.NonEmptyAction<string, `The ${string} must not be empty`>]>, v.RegexAction<string, "The version must follow semantic versioning (semver) format: Major.Minor.Patch (e.g., '1.0.0', '2.3.1')">]>;

package/dist/cjs/{config-YEeaEqzi.cjs → config-BppBKCFj.cjs}

@@ -13,7 +13,7 @@
  */
 
 const require_schemas = require('./schemas-nkIxa8sL.cjs');
-const require_validate = require('./validate-CwwYD8aC.cjs');
+const require_validate = require('./validate-CeUCT_7k.cjs');
 const require_error = require('./error-Dn7ool6k.cjs');
 let path = require("path");
 let fs = require("fs");

package/dist/{es/index-D33OCH0D.d.mts → cjs/index-DZxladgt.d.cts}

@@ -12,10 +12,10 @@
  * governing permissions and limitations under the License.
  */
 
-import { n as CommerceAppConfigOutputModel } from "./app-Ct7Y0NP8.mjs";
-import AioLogger from "@adobe/aio-lib-core-logging";
-import * as v from "valibot";
+import { n as CommerceAppConfigOutputModel } from "./app-DcQMhW2N.cjs";
 import { RuntimeActionParams } from "@adobe/aio-commerce-lib-core/params";
+import * as v from "valibot";
+import AioLogger from "@adobe/aio-lib-core-logging";
 
 //#region source/management/installation/schema.d.ts
 /** Schema for validating Adobe I/O app credentials required for installation. */
@@ -90,10 +90,10 @@ type LeafStep<TName extends string = string, TConfig extends CommerceAppConfigOu
   validate?: (config: TConfig, context: ValidationExecutionContext<TStepCtx>) => ValidationIssue[] | Promise<ValidationIssue[]>;
 };
 /** 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>> = StepBase<TName, TConfig> & {
+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: AnyStep[];
+  children: TChildren;
   /**
    * Optional pre-installation validation handler for the branch itself.
    * Called before children are validated. Returning an empty array means
@@ -121,7 +121,7 @@ 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>> = Omit<BranchStep<TName, TConfig, TStepCtx>, "type">;
+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).
  *
@@ -137,7 +137,14 @@ type BranchStepOptions<TName extends string, TConfig extends CommerceAppConfigOu
  * });
  * ```
  */
-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>): LeafStep<TName, TConfig, TStepCtx, TOutput>;
+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;
+  run: (config: TConfig, context: ExecutionContext<TStepCtx>) => TOutput | Promise<TOutput>;
+  validate: ((config: TConfig, context: ValidationExecutionContext<TStepCtx>) => ValidationIssue[] | Promise<ValidationIssue[]>) | undefined;
+};
 /**
  * Define a branch step (container with children, no runner).
  *
@@ -152,7 +159,15 @@ declare function defineLeafStep<TName extends string, TConfig extends CommerceAp
  * });
  * ```
  */
-declare function defineBranchStep<TName extends string, TConfig extends CommerceAppConfigOutputModel, TStepCtx extends Record<string, unknown> = Record<string, unknown>>(options: BranchStepOptions<TName, TConfig, TStepCtx>): BranchStep<TName, TConfig, TStepCtx>;
+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

package/dist/cjs/management/index.cjs

@@ -13,7 +13,7 @@
  */
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_management = require('../management-PZtLe4Ji.cjs');
+const require_management = require('../management-iLQubQ7K.cjs');
 
 exports.createInitialInstallationState = require_management.createInitialInstallationState;
 exports.defineCustomInstallationStep = require_management.defineCustomInstallationStep;

package/dist/cjs/management/index.d.cts

@@ -12,5 +12,5 @@
  * governing permissions and limitations under the License.
  */
 
-import { $ as isBranchStep, A as StepStatus, B as InferStepOutput, C as ExecutionStatus, D as InstallationError, E as InstallationData, F as isSucceededState, G as StepContextFactory, H as LeafStep, I as AnyStep, J as ValidationExecutionContext, K as StepMeta, L as BranchStep, M as isCompletedState, N as isFailedState, O as InstallationState, P as isInProgressState, Q as defineLeafStep, R as BranchStepOptions, S as StepSucceededEvent, T as InProgressInstallationState, U as LeafStepOptions, V as InstallationContext, W as Step, X as ValidationIssueSeverity, Y as ValidationIssue, Z as defineBranchStep, _ as executeWorkflow, a as runInstallation, b as StepFailedEvent, c as defineCustomInstallationStep, d as ValidationResult, et as isLeafStep, f as ValidationSummary, g as createInitialState, h as ExecuteWorkflowOptions, i as createInitialInstallationState, j as SucceededInstallationState, k as InstallationStatus, l as StepValidationResult, m as CreateInitialStateOptions, n as RunInstallationOptions, o as runValidation, p as validateStepTree, q as ValidationContext, r as RunValidationOptions, s as CustomInstallationStepHandler, t as CreateInitialInstallationStateOptions, u as ValidateStepTreeOptions, v as InstallationHooks, w as FailedInstallationState, x as StepStartedEvent, y as StepEvent, z as ExecutionContext } from "../index-DRhLtRrX.cjs";
+import { $ as isBranchStep, A as StepStatus, B as InferStepOutput, C as ExecutionStatus, D as InstallationError, E as InstallationData, F as isSucceededState, G as StepContextFactory, H as LeafStep, I as AnyStep, J as ValidationExecutionContext, K as StepMeta, L as BranchStep, M as isCompletedState, N as isFailedState, O as InstallationState, P as isInProgressState, Q as defineLeafStep, R as BranchStepOptions, S as StepSucceededEvent, T as InProgressInstallationState, U as LeafStepOptions, V as InstallationContext, W as Step, X as ValidationIssueSeverity, Y as ValidationIssue, Z as defineBranchStep, _ as executeWorkflow, a as runInstallation, b as StepFailedEvent, c as defineCustomInstallationStep, d as ValidationResult, et as isLeafStep, f as ValidationSummary, g as createInitialState, h as ExecuteWorkflowOptions, i as createInitialInstallationState, j as SucceededInstallationState, k as InstallationStatus, l as StepValidationResult, m as CreateInitialStateOptions, n as RunInstallationOptions, o as runValidation, p as validateStepTree, q as ValidationContext, r as RunValidationOptions, s as CustomInstallationStepHandler, t as CreateInitialInstallationStateOptions, u as ValidateStepTreeOptions, v as InstallationHooks, w as FailedInstallationState, x as StepStartedEvent, y as StepEvent, z as ExecutionContext } from "../index-DZxladgt.cjs";
 export { AnyStep, BranchStep, BranchStepOptions, CreateInitialInstallationStateOptions, CreateInitialStateOptions, CustomInstallationStepHandler, ExecuteWorkflowOptions, ExecutionContext, ExecutionStatus, FailedInstallationState, InProgressInstallationState, InferStepOutput, InstallationContext, InstallationData, InstallationError, InstallationHooks, InstallationState, InstallationStatus, LeafStep, LeafStepOptions, RunInstallationOptions, RunValidationOptions, Step, StepContextFactory, StepEvent, StepFailedEvent, StepMeta, StepStartedEvent, StepStatus, StepSucceededEvent, StepValidationResult, SucceededInstallationState, ValidateStepTreeOptions, ValidationContext, ValidationExecutionContext, ValidationIssue, ValidationIssueSeverity, ValidationResult, ValidationSummary, createInitialInstallationState, createInitialState, defineBranchStep, defineCustomInstallationStep, defineLeafStep, executeWorkflow, isBranchStep, isCompletedState, isFailedState, isInProgressState, isLeafStep, isSucceededState, runInstallation, runValidation, validateStepTree };

package/dist/cjs/{management-PZtLe4Ji.cjs → management-iLQubQ7K.cjs}

@@ -13,13 +13,13 @@
  */
 
 const require_schemas = require('./schemas-nkIxa8sL.cjs');
-const require_webhooks = require('./webhooks-CbZpv9y_.cjs');
+const require_webhooks = require('./webhooks-CLtDxwMa.cjs');
 const require_error = require('./error-Dn7ool6k.cjs');
 const require_logging = require('./logging-4s36JTiN.cjs');
 let camelcase = require("camelcase");
 camelcase = require_schemas.__toESM(camelcase);
-let _adobe_aio_commerce_lib_auth = require("@adobe/aio-commerce-lib-auth");
 let _adobe_aio_commerce_lib_api = require("@adobe/aio-commerce-lib-api");
+let _adobe_aio_commerce_lib_auth = require("@adobe/aio-commerce-lib-auth");
 let _adobe_aio_commerce_lib_events_commerce = require("@adobe/aio-commerce-lib-events/commerce");
 let _adobe_aio_commerce_lib_events_io_events = require("@adobe/aio-commerce-lib-events/io-events");
 let _adobe_aio_commerce_lib_webhooks_api = require("@adobe/aio-commerce-lib-webhooks/api");
@@ -511,6 +511,62 @@ function defineCustomInstallationStep(handler) {
 	return handler;
 }
 
+//#endregion
+//#region source/management/installation/admin-ui-sdk/helpers.ts
+/**
+* Registers the extension with Commerce via POST /V1/adminuisdk/extension.
+*
+* @param context - The execution context providing the Commerce HTTP client and logger.
+* @returns The response from the Commerce API.
+*/
+async function registerExtension(context) {
+	const { commerceClient, appData, logger } = context;
+	logger.info(`Registering Admin UI SDK extension: ${appData.projectName}`);
+	const response = await commerceClient.post("adminuisdk/extension", { json: { extension: {
+		extensionName: process.env.__OW_NAMESPACE,
+		extensionTitle: appData.projectTitle,
+		extensionUrl: `https://${process.env.__OW_NAMESPACE}.adobeio-static.net/index.html`,
+		extensionWorkspace: appData.workspaceName
+	} } }).json();
+	logger.info(`Admin UI SDK extension registered successfully: ${response.extensionId}`);
+	return response;
+}
+
+//#endregion
+//#region source/management/installation/admin-ui-sdk/utils.ts
+/** Creates the Admin UI SDK step context with a lazy-initialized Commerce HTTP client. */
+const createAdminUiSdkStepContext = (installation) => {
+	const { params } = installation;
+	let commerceClient = null;
+	return { get commerceClient() {
+		if (commerceClient === null) commerceClient = new _adobe_aio_commerce_lib_api.AdobeCommerceHttpClient((0, _adobe_aio_commerce_lib_api.resolveCommerceHttpClientParams)(params, { tryForwardAuthProvider: true }));
+		return commerceClient;
+	} };
+};
+
+//#endregion
+//#region source/management/installation/admin-ui-sdk/branch.ts
+/** Leaf step that calls POST /V1/adminuisdk/extension to register the extension. */
+const registerExtensionStep = defineLeafStep({
+	name: "register-extension",
+	meta: {
+		label: "Register Extension",
+		description: "Registers the Admin UI SDK extension in Adobe Commerce"
+	},
+	run: (_, context) => registerExtension(context)
+});
+/** Branch step for setting up the Admin UI SDK extension registration. */
+const adminUiSdkStep = defineBranchStep({
+	name: "admin-ui-sdk",
+	meta: {
+		label: "Admin UI SDK",
+		description: "Registers the extension with Adobe Commerce Admin UI SDK"
+	},
+	when: require_webhooks.hasAdminUiSdk,
+	context: createAdminUiSdkStepContext,
+	children: [registerExtensionStep]
+});
+
 //#endregion
 //#region source/management/installation/events/utils.ts
 const COMMERCE_PROVIDER_TYPE = "dx_commerce_events";
@@ -519,14 +575,20 @@ const PROVIDER_TYPE_TO_LABEL = {
 	[COMMERCE_PROVIDER_TYPE]: "Commerce",
 	[EXTERNAL_PROVIDER_TYPE]: "External"
 };
+/** Max characters taken from `metadata.id` in the I/O Events provider `instance_id`. */
+const METADATA_ID_MAX_LENGTH_FOR_INSTANCE_ID = 100;
 /**
-* Generates a unique instance ID for the given event provider within the context of the provided config.
+* Generates a unique instance ID for I/O Events for this app deployment.
+* Uses `{metadata.id (first 100 chars)}-{providerKeyOrSlug}-{workspaceId}` (lowercased).
+*
 * @param metadata - The metadata of the application
-* @param provider - The event provider for which to generate the instance ID
+* @param provider - The event provider (optional `key`, else label is slugified)
+* @param workspaceId - Adobe I/O Developer Console workspace ID for this deployment
 */
-function generateInstanceId(metadata, provider) {
+function generateInstanceId(metadata, provider, workspaceId) {
+	const appId = metadata.id.slice(0, METADATA_ID_MAX_LENGTH_FOR_INSTANCE_ID);
 	const slugLabel = provider.label.toLowerCase().replace(/\s+/g, "-");
-	return `${metadata.id}-${provider.key ?? slugLabel}`.toLowerCase();
+	return `${appId}-${provider.key ?? slugLabel}-${workspaceId}`.toLowerCase();
 }
 /**
 * Find an existing event provider by its instance ID.
@@ -545,7 +607,6 @@ function findExistingProviderMetadata(allMetadata, eventName) {
 	return allMetadata.find((meta) => meta.event_code === eventName) ?? null;
 }
 /**
-<<<<<<< HEAD
 * Find existing event registrations by client ID and name.
 * @param allRegistrations - The list of all existing event registrations.
 * @param clientId - The client ID of the workspace where the registration was created.
@@ -576,7 +637,7 @@ function getIoEventCode(name, providerType) {
 * @param runtimeAction - The runtime action this registration points to.
 */
 function getRegistrationName(provider, runtimeAction) {
-	const providerLabel = PROVIDER_TYPE_TO_LABEL[provider.provider_metadata] ?? "Unknown";
+	const providerLabel = PROVIDER_TYPE_TO_LABEL[provider.provider_metadata];
 	const [packageName, actionName] = runtimeAction.split("/").map(kebabToTitleCase);
 	return `${providerLabel} Event Registration: ${actionName} (${packageName})`;
 }
@@ -700,8 +761,11 @@ async function getCommerceEventingExistingData(context) {
 	const { commerceEventsClient } = context;
 	const existingProviders = await commerceEventsClient.getAllEventProviders();
 	const existingSubscriptions = await commerceEventsClient.getAllEventSubscriptions();
+	const defaultProvider = existingProviders.find((provider) => !("id" in provider)) ?? null;
+	const isDefaultProviderConfigured = defaultProvider !== null;
 	return {
-		isDefaultWorkspaceConfigurationEmpty: existingProviders.some((provider) => !("id" in provider) && !provider.workspace_configuration?.trim()),
+		isDefaultProviderConfigured,
+		isDefaultWorkspaceConfigurationEmpty: isDefaultProviderConfigured ? !defaultProvider.workspace_configuration?.trim() : true,
 		providers: existingProviders,
 		subscriptions: new Map(existingSubscriptions.map((subscription) => [subscription.name, subscription]))
 	};
@@ -862,22 +926,30 @@ async function createOrGetIoEventRegistration(params, registrations) {
 async function configureCommerceEventing(params, existingData) {
 	const { context, config } = params;
 	const { commerceEventsClient, logger } = context;
+	const { isDefaultProviderConfigured, isDefaultWorkspaceConfigurationEmpty } = existingData;
 	logger.info("Starting configuration of the Commerce Eventing Module");
-	let updateParams = {
-		...config,
-		enabled: true
-	};
-	if (existingData.isDefaultWorkspaceConfigurationEmpty) {
-		if (!config.workspace_configuration) {
+	if (isDefaultProviderConfigured && !isDefaultWorkspaceConfigurationEmpty) {
+		logger.info("Commerce Eventing Module is already configured, skipping configuration step.");
+		return;
+	}
+	const { workspace_configuration, ...configWithoutWorkspace } = config;
+	let updateParams = { enabled: true };
+	if (isDefaultWorkspaceConfigurationEmpty) {
+		if (!workspace_configuration) {
 			const message = "Workspace configuration is required to enable Commerce Eventing when there is not an existing one.";
 			logger.error(message);
 			throw new Error(message);
 		}
-		logger.info("Default provider workspace configuration already present, it will not be overriden");
-		const { workspace_configuration, ...rest } = updateParams;
-		updateParams = rest;
+		updateParams.workspace_configuration = workspace_configuration;
+		logger.info("Adding workspace configuration to Commerce Eventing configuration as it has not been set up yet.");
+	}
+	if (!isDefaultProviderConfigured) {
+		logger.info("Default provider not configured, it will be created with the provided configuration.");
+		updateParams = {
+			...updateParams,
+			...configWithoutWorkspace
+		};
 	}
-	logger.info("Updating Commerce Eventing configuration with provided workspace configuration.");
 	return commerceEventsClient.updateEventingConfiguration(updateParams).then((success) => {
 		if (success) {
 			logger.info("Commerce Eventing Module configured successfully.");
@@ -976,7 +1048,7 @@ async function createOrGetCommerceEventSubscription(params, existingData) {
 async function onboardIoEvents(params, existingData) {
 	const { providersWithMetadata, registrations } = existingData;
 	const { context, metadata, provider, providerType, events } = params;
-	const instanceId = generateInstanceId(metadata, provider);
+	const instanceId = generateInstanceId(metadata, provider, context.appData.workspaceId);
 	const providerData = await createOrGetIoEventProvider({
 		context,
 		provider: {
@@ -1469,6 +1541,7 @@ function createDefaultChildSteps(config) {
 	return [
 		eventingStep,
 		webhooksStep,
+		adminUiSdkStep,
 		createCustomInstallationStep(config)
 	];
 }

package/dist/cjs/{validate-CwwYD8aC.cjs → validate-CeUCT_7k.cjs}

@@ -13,7 +13,7 @@
  */
 
 const require_schemas = require('./schemas-nkIxa8sL.cjs');
-const require_webhooks = require('./webhooks-CbZpv9y_.cjs');
+const require_webhooks = require('./webhooks-CLtDxwMa.cjs');
 let _adobe_aio_commerce_lib_core_error = require("@adobe/aio-commerce-lib-core/error");
 let valibot = require("valibot");
 valibot = require_schemas.__toESM(valibot);
@@ -37,6 +37,7 @@ function hasBusinessConfigSchema(config) {
 
 //#endregion
 //#region source/config/schema/metadata.ts
+const MAX_ID_LENGTH = 100;
 const MAX_DESCRIPTION_LENGTH = 255;
 const MAX_DISPLAY_NAME_LENGTH = 50;
 const NUMERIC_IDENTIFIER = "(0|[1-9]\\d*)";
@@ -46,7 +47,7 @@ function nonEmptyString(fieldName) {
 }
 /** The schema for the metadata of the application. */
 const MetadataSchema = valibot.object({
-	id: require_schemas.alphaNumericOrHyphenSchema("application id (metadata.id)"),
+	id: valibot.pipe(require_schemas.alphaNumericOrHyphenSchema("application id (metadata.id)"), valibot.maxLength(MAX_ID_LENGTH, `The application id must not be longer than ${MAX_ID_LENGTH} characters`)),
 	displayName: valibot.pipe(nonEmptyString("application display name"), valibot.maxLength(MAX_DISPLAY_NAME_LENGTH, `The application display name must not be longer than ${MAX_DISPLAY_NAME_LENGTH} characters`)),
 	description: valibot.pipe(nonEmptyString("metadata description"), valibot.maxLength(MAX_DESCRIPTION_LENGTH, `The metadata description must not be longer than ${MAX_DESCRIPTION_LENGTH} characters`)),
 	version: valibot.pipe(nonEmptyString("version"), valibot.regex(SEMVER_REGEX, "The version must follow semantic versioning (semver) format: Major.Minor.Patch (e.g., '1.0.0', '2.3.1')"))
@@ -67,6 +68,7 @@ const CommerceAppConfigSchema = valibot.looseObject({
 	metadata: MetadataSchema,
 	businessConfig: valibot.optional(_adobe_aio_commerce_lib_config.SchemaBusinessConfig),
 	eventing: valibot.optional(require_webhooks.EventingSchema),
+	adminUiSdk: valibot.optional(require_webhooks.AdminUiSdkSchema),
 	installation: valibot.optional(require_webhooks.InstallationSchema),
 	webhooks: valibot.optional(require_webhooks.WebhooksSchema)
 });
@@ -83,7 +85,8 @@ const CommerceAppConfigSchemas = {
 	"businessConfig.schema": valibot.unwrap(_adobe_aio_commerce_lib_config.SchemaBusinessConfig.entries.schema),
 	"eventing.commerce": valibot.unwrap(require_webhooks.EventingSchema.entries.commerce),
 	"eventing.external": valibot.unwrap(require_webhooks.EventingSchema.entries.external),
-	"installation.customInstallationSteps": valibot.unwrap(require_webhooks.InstallationSchema.entries.customInstallationSteps)
+	"installation.customInstallationSteps": valibot.unwrap(require_webhooks.InstallationSchema.entries.customInstallationSteps),
+	adminUiSdk: require_webhooks.AdminUiSdkSchema
 };
 /**
 * Get the config domains that are present in the config.
@@ -98,6 +101,7 @@ function getConfigDomains(config) {
 		eventing: withCommerceEvents || withExternalEvents,
 		installation: require_webhooks.hasCustomInstallation(config),
 		webhooks: require_webhooks.hasWebhooks(config),
+		adminUiSdk: require_webhooks.hasAdminUiSdk(config),
 		"businessConfig.schema": hasBusinessConfigSchema(config),
 		"eventing.commerce": withCommerceEvents,
 		"eventing.external": withExternalEvents,