@adobe/aio-commerce-lib-admin-ui 0.2.0 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @adobe/aio-commerce-lib-admin-ui
 
+## 1.0.0
+
+### Major Changes
+
+- [#599](https://github.com/adobe/aio-commerce-sdk/pull/599) [`ac6c13b`](https://github.com/adobe/aio-commerce-sdk/commit/ac6c13b4124677820f8946c92e4cd63ab228eeae) Thanks [@obarcelonap](https://github.com/obarcelonap)! - Release the first stable version.
+
 ## 0.2.0
 
 ### Minor Changes

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

@@ -16,7 +16,6 @@ import { n as getAclResourceId, t as AdminUiEntity } from "../acl-resource-id-DB
 import { CommerceSdkErrorBase, CommerceSdkErrorOptions } from "@adobe/aio-commerce-lib-core/error";
 import { AdobeCommerceHttpClient, CommerceHttpClientParams } from "@adobe/aio-commerce-lib-api";
 import * as v from "valibot";
-
 //#region source/errors.d.ts
 /** Base error for Admin UI SDK permission helper failures. */
 declare class AdminUiPermissionError extends CommerceSdkErrorBase {}
@@ -48,14 +47,17 @@ type AdminUiApiClient = ReturnType<typeof createAdminUiApiClient>;
 //#region source/api/lib/permission-client.d.ts
 /** Options used to create an Admin UI SDK permission client. */
 type AdminUiPermissionClientOptions = {
-  /** The application's `metadata.id` value. When provided, `check()` and `require()` can be called with no resource argument. */appId?: string;
+  /** The application's `metadata.id` value. When provided, `check()` and `require()` can be called with no resource argument. */
+  appId?: string;
   /**
    * Milliseconds to cache a permission result. Default: 300_000 (5 minutes).
    * Set to 0 to disable result caching. Note: in-flight deduplication of concurrent identical
    * requests is independent of this setting and remains active even when caching is disabled.
    */
-  cacheTtlMs?: number; /** Return false instead of throwing when a network or parse error occurs. Default: true. */
-  denyOnError?: boolean; /** Commerce HTTP client used to call the Admin UI SDK permission endpoint. */
+  cacheTtlMs?: number;
+  /** Return false instead of throwing when a network or parse error occurs. Default: true. */
+  denyOnError?: boolean;
+  /** Commerce HTTP client used to call the Admin UI SDK permission endpoint. */
   httpClient: AdobeCommerceHttpClient;
 };
 /** Client for checking the current user's Admin UI SDK resource permissions. */

package/dist/cjs/grid-columns/index.d.cts

@@ -15,7 +15,6 @@
 import { t as AdminUiEntity } from "../acl-resource-id-DBlYU0DE.cjs";
 import * as v from "valibot";
 import { ErrorResponse, SuccessResponse } from "@adobe/aio-commerce-lib-core/responses";
-
 //#region source/grid-columns/acl-resource-id.d.ts
 /**
  * Derives the deterministic Commerce ACL resource id for a grid column.

package/dist/cjs/mass-actions/index.d.cts

@@ -15,7 +15,6 @@
 import { t as AdminUiEntity } from "../acl-resource-id-DBlYU0DE.cjs";
 import * as v from "valibot";
 import { ErrorResponse, SuccessResponse } from "@adobe/aio-commerce-lib-core/responses";
-
 //#region source/mass-actions/acl-resource-id.d.ts
 /**
  * Derives the deterministic Commerce ACL resource id for a mass action.

package/dist/cjs/order-view-buttons/index.d.cts

@@ -14,7 +14,6 @@
 
 import * as v from "valibot";
 import { ErrorResponse, SuccessResponse } from "@adobe/aio-commerce-lib-core/responses";
-
 //#region source/order-view-buttons/acl-resource-id.d.ts
 /**
  * Derives the deterministic Commerce ACL resource id for an order view button.

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

@@ -15,7 +15,6 @@
 import { ReactNode } from "react";
 import { attach } from "@adobe/uix-guest";
 import { NavigateOptions, ToOptions } from "@tanstack/react-router";
-
 //#region source/web/react/auth/types.d.ts
 /** The IMS credentials provided by the host (Commerce Admin or Experience Cloud shell). */
 type ImsContext = {
@@ -64,13 +63,18 @@ type GuestConnection = Awaited<ReturnType<typeof attach>>;
  * which are also available in the Experience Cloud shell.
  */
 type SharedContext = {
-  /** The extension ID of the app. */extensionId: string; /** The live `sharedContext` object provided by the host. */
-  sharedContext: NonNullable<GuestConnection["sharedContext"]>; /** The host proxy, used by `useHostConnection` to invoke host-frame actions (close/onError). */
+  /** The extension ID of the app. */
+  extensionId: string;
+  /** The live `sharedContext` object provided by the host. */
+  sharedContext: NonNullable<GuestConnection["sharedContext"]>;
+  /** The host proxy, used by `useHostConnection` to invoke host-frame actions (close/onError). */
   host: NonNullable<GuestConnection["host"]>;
 };
 /** Actions for closing the extension iframe and returning control to the Commerce Admin. */
 type HostConnection = {
-  /** Closes the iframe and navigates back to the originating grid or order. */close: () => Promise<void>; /** Closes the iframe and navigates back, flagging the originating page that an error occurred. */
+  /** Closes the iframe and navigates back to the originating grid or order. */
+  close: () => Promise<void>;
+  /** Closes the iframe and navigates back, flagging the originating page that an error occurred. */
   closeWithError: () => Promise<void>;
 };
 /** The context shared with mass-action extension points. */
@@ -108,7 +112,6 @@ declare function useSharedContext(): Result<SharedContext>;
 type CommerceData = {
   commerceHost: string;
 };
-/** Drops a failed Commerce host resolution for `extensionId`, so a later render retries it. */
 /**
  * Returns the host (domain) of the Commerce Admin the extension is embedded in, resolving it over
  * the guest connection.
@@ -161,18 +164,25 @@ declare module "@react-spectrum/s2/Provider" {
 }
 /** Defines a route that exists at a given path. */
 type ExtensionRoute = {
-  /** The path for the route. */path: string; /** The React element to render for the route. */
+  /** The path for the route. */
+  path: string;
+  /** The React element to render for the route. */
   element: ReactNode;
 };
 //#endregion
 //#region source/web/react/extension/create-app.d.ts
 /** Configuration options when instantiating an extension app. */
 type CreateExtensionAppOptions = {
-  /** General metadata about the extension app. */metadata: {
-    /** The unique identifier for the extension app. */extensionId: string;
-  }; /** The optional app page opened from the Commerce Admin menu and by default in Experience Cloud Shell. */
-  menu?: ReactNode; /** Optional root element where the app will be mounted. */
-  root?: HTMLElement; /** Additional path-based routes for the extension app. */
+  /** General metadata about the extension app. */
+  metadata: {
+    /** The unique identifier for the extension app. */
+    extensionId: string;
+  };
+  /** The optional app page opened from the Commerce Admin menu and by default in Experience Cloud Shell. */
+  menu?: ReactNode;
+  /** Optional root element where the app will be mounted. */
+  root?: HTMLElement;
+  /** Additional path-based routes for the extension app. */
   routes?: ExtensionRoute[];
 };
 /**
@@ -196,11 +206,6 @@ type CreateExtensionAppOptions = {
  * });
  * ```
  */
-declare function createExtensionApp({
-  menu,
-  metadata,
-  routes,
-  root: customRoot
-}: CreateExtensionAppOptions): void;
+declare function createExtensionApp({ menu, metadata, routes, root: customRoot }: CreateExtensionAppOptions): void;
 //#endregion
 export { type CreateExtensionAppOptions, type ExtensionRoute, type HostConnection, type ImsContext, type MassActionContext, type OrderViewButtonContext, type SharedContext, createExtensionApp, useCommerce, useHostConnection, useIms, useMassActionContext, useOrderViewButtonContext, useSharedContext };

package/dist/es/api/index.d.mts

@@ -16,7 +16,6 @@ import { n as getAclResourceId, t as AdminUiEntity } from "../acl-resource-id-DB
 import { CommerceSdkErrorBase, CommerceSdkErrorOptions } from "@adobe/aio-commerce-lib-core/error";
 import { AdobeCommerceHttpClient, CommerceHttpClientParams } from "@adobe/aio-commerce-lib-api";
 import * as v from "valibot";
-
 //#region source/errors.d.ts
 /** Base error for Admin UI SDK permission helper failures. */
 declare class AdminUiPermissionError extends CommerceSdkErrorBase {}
@@ -48,14 +47,17 @@ type AdminUiApiClient = ReturnType<typeof createAdminUiApiClient>;
 //#region source/api/lib/permission-client.d.ts
 /** Options used to create an Admin UI SDK permission client. */
 type AdminUiPermissionClientOptions = {
-  /** The application's `metadata.id` value. When provided, `check()` and `require()` can be called with no resource argument. */appId?: string;
+  /** The application's `metadata.id` value. When provided, `check()` and `require()` can be called with no resource argument. */
+  appId?: string;
   /**
    * Milliseconds to cache a permission result. Default: 300_000 (5 minutes).
    * Set to 0 to disable result caching. Note: in-flight deduplication of concurrent identical
    * requests is independent of this setting and remains active even when caching is disabled.
    */
-  cacheTtlMs?: number; /** Return false instead of throwing when a network or parse error occurs. Default: true. */
-  denyOnError?: boolean; /** Commerce HTTP client used to call the Admin UI SDK permission endpoint. */
+  cacheTtlMs?: number;
+  /** Return false instead of throwing when a network or parse error occurs. Default: true. */
+  denyOnError?: boolean;
+  /** Commerce HTTP client used to call the Admin UI SDK permission endpoint. */
   httpClient: AdobeCommerceHttpClient;
 };
 /** Client for checking the current user's Admin UI SDK resource permissions. */

package/dist/es/grid-columns/index.d.mts

@@ -15,7 +15,6 @@
 import { t as AdminUiEntity } from "../acl-resource-id-DBlYU0DE.mjs";
 import * as v from "valibot";
 import { ErrorResponse, SuccessResponse } from "@adobe/aio-commerce-lib-core/responses";
-
 //#region source/grid-columns/acl-resource-id.d.ts
 /**
  * Derives the deterministic Commerce ACL resource id for a grid column.

package/dist/es/mass-actions/index.d.mts

@@ -15,7 +15,6 @@
 import { t as AdminUiEntity } from "../acl-resource-id-DBlYU0DE.mjs";
 import * as v from "valibot";
 import { ErrorResponse, SuccessResponse } from "@adobe/aio-commerce-lib-core/responses";
-
 //#region source/mass-actions/acl-resource-id.d.ts
 /**
  * Derives the deterministic Commerce ACL resource id for a mass action.

package/dist/es/order-view-buttons/index.d.mts

@@ -14,7 +14,6 @@
 
 import * as v from "valibot";
 import { ErrorResponse, SuccessResponse } from "@adobe/aio-commerce-lib-core/responses";
-
 //#region source/order-view-buttons/acl-resource-id.d.ts
 /**
  * Derives the deterministic Commerce ACL resource id for an order view button.

package/dist/es/web/index.d.mts

@@ -15,7 +15,6 @@
 import { ReactNode } from "react";
 import { NavigateOptions, ToOptions } from "@tanstack/react-router";
 import { attach } from "@adobe/uix-guest";
-
 //#region source/web/react/auth/types.d.ts
 /** The IMS credentials provided by the host (Commerce Admin or Experience Cloud shell). */
 type ImsContext = {
@@ -64,13 +63,18 @@ type GuestConnection = Awaited<ReturnType<typeof attach>>;
  * which are also available in the Experience Cloud shell.
  */
 type SharedContext = {
-  /** The extension ID of the app. */extensionId: string; /** The live `sharedContext` object provided by the host. */
-  sharedContext: NonNullable<GuestConnection["sharedContext"]>; /** The host proxy, used by `useHostConnection` to invoke host-frame actions (close/onError). */
+  /** The extension ID of the app. */
+  extensionId: string;
+  /** The live `sharedContext` object provided by the host. */
+  sharedContext: NonNullable<GuestConnection["sharedContext"]>;
+  /** The host proxy, used by `useHostConnection` to invoke host-frame actions (close/onError). */
   host: NonNullable<GuestConnection["host"]>;
 };
 /** Actions for closing the extension iframe and returning control to the Commerce Admin. */
 type HostConnection = {
-  /** Closes the iframe and navigates back to the originating grid or order. */close: () => Promise<void>; /** Closes the iframe and navigates back, flagging the originating page that an error occurred. */
+  /** Closes the iframe and navigates back to the originating grid or order. */
+  close: () => Promise<void>;
+  /** Closes the iframe and navigates back, flagging the originating page that an error occurred. */
   closeWithError: () => Promise<void>;
 };
 /** The context shared with mass-action extension points. */
@@ -108,7 +112,6 @@ declare function useSharedContext(): Result<SharedContext>;
 type CommerceData = {
   commerceHost: string;
 };
-/** Drops a failed Commerce host resolution for `extensionId`, so a later render retries it. */
 /**
  * Returns the host (domain) of the Commerce Admin the extension is embedded in, resolving it over
  * the guest connection.
@@ -161,18 +164,25 @@ declare module "@react-spectrum/s2/Provider" {
 }
 /** Defines a route that exists at a given path. */
 type ExtensionRoute = {
-  /** The path for the route. */path: string; /** The React element to render for the route. */
+  /** The path for the route. */
+  path: string;
+  /** The React element to render for the route. */
   element: ReactNode;
 };
 //#endregion
 //#region source/web/react/extension/create-app.d.ts
 /** Configuration options when instantiating an extension app. */
 type CreateExtensionAppOptions = {
-  /** General metadata about the extension app. */metadata: {
-    /** The unique identifier for the extension app. */extensionId: string;
-  }; /** The optional app page opened from the Commerce Admin menu and by default in Experience Cloud Shell. */
-  menu?: ReactNode; /** Optional root element where the app will be mounted. */
-  root?: HTMLElement; /** Additional path-based routes for the extension app. */
+  /** General metadata about the extension app. */
+  metadata: {
+    /** The unique identifier for the extension app. */
+    extensionId: string;
+  };
+  /** The optional app page opened from the Commerce Admin menu and by default in Experience Cloud Shell. */
+  menu?: ReactNode;
+  /** Optional root element where the app will be mounted. */
+  root?: HTMLElement;
+  /** Additional path-based routes for the extension app. */
   routes?: ExtensionRoute[];
 };
 /**
@@ -196,11 +206,6 @@ type CreateExtensionAppOptions = {
  * });
  * ```
  */
-declare function createExtensionApp({
-  menu,
-  metadata,
-  routes,
-  root: customRoot
-}: CreateExtensionAppOptions): void;
+declare function createExtensionApp({ menu, metadata, routes, root: customRoot }: CreateExtensionAppOptions): void;
 //#endregion
 export { type CreateExtensionAppOptions, type ExtensionRoute, type HostConnection, type ImsContext, type MassActionContext, type OrderViewButtonContext, type SharedContext, createExtensionApp, useCommerce, useHostConnection, useIms, useMassActionContext, useOrderViewButtonContext, useSharedContext };

package/package.json

@@ -2,7 +2,7 @@
   "name": "@adobe/aio-commerce-lib-admin-ui",
   "type": "module",
   "author": "Adobe Inc.",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "private": false,
   "engines": {
     "node": ">=22 <=24"
@@ -142,10 +142,10 @@
     "@aio-commerce-sdk/common-utils": "0.2.6",
     "@aio-commerce-sdk/config-tsdown": "1.0.1",
     "@aio-commerce-sdk/config-typedoc": "1.0.0",
-    "@aio-commerce-sdk/config-typescript": "1.0.0",
     "@aio-commerce-sdk/config-vitest": "1.0.0",
     "@aio-commerce-sdk/scripting-utils": "0.3.4",
-    "@aio-commerce-sdk/scripts": "0.1.0"
+    "@aio-commerce-sdk/scripts": "0.1.0",
+    "@aio-commerce-sdk/config-typescript": "1.0.0"
   },
   "sideEffects": false,
   "scripts": {