@commercelayer/app-elements 2.5.2 → 2.7.0

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.
@@ -0,0 +1,13 @@
1
+ import { Resource } from '@commercelayer/sdk';
2
+
3
+ export interface ResourceDetailsProps {
4
+ resource: Resource;
5
+ }
6
+ /**
7
+ * This component provides a listed visualization of details attributes of a given resource.
8
+ */
9
+ export declare const ResourceDetails: import('../../atoms/SkeletonTemplate').SkeletonTemplateComponent<{
10
+ resource: Resource;
11
+ delayMs?: number | undefined;
12
+ isLoading?: boolean | undefined;
13
+ }>;
@@ -0,0 +1 @@
1
+ export { ResourceDetails, type ResourceDetailsProps } from './ResourceDetails';
@@ -1,14 +1,7 @@
1
+ import { EditMetadataOverlayProps } from '../../../hooks/useEditMetadataOverlay';
1
2
  import { ListableResourceType } from '@commercelayer/sdk';
2
3
 
3
- export interface ResourceMetadataOverlay {
4
- /**
5
- * Title shown as first line in edit overlay heading
6
- */
7
- title: string;
8
- /**
9
- * Optional description shown as second line in edit overlay heading
10
- */
11
- description?: string;
4
+ interface MetadataOverlay extends Omit<EditMetadataOverlayProps, 'resourceId' | 'resourceType' | 'mode'> {
12
5
  }
13
6
  export type ResourceMetadataMode = 'simple' | 'advanced';
14
7
  export interface ResourceMetadataProps {
@@ -24,7 +17,7 @@ export interface ResourceMetadataProps {
24
17
  /**
25
18
  * Edit overlay configuration
26
19
  */
27
- overlay: ResourceMetadataOverlay;
20
+ overlay?: MetadataOverlay;
28
21
  }
29
22
  export declare const updatableTypes: readonly ["string", "number", "boolean"];
30
23
  export type UpdatableType = (typeof updatableTypes)[number];
@@ -41,7 +34,8 @@ export declare const ResourceMetadata: import('../../atoms/SkeletonTemplate').Sk
41
34
  * Edit overlay configuration
42
35
  */
43
36
  | undefined;
44
- overlay: ResourceMetadataOverlay;
37
+ overlay?: MetadataOverlay | undefined;
45
38
  delayMs?: number | undefined;
46
39
  isLoading?: boolean | undefined;
47
40
  }>;
41
+ export {};
@@ -1 +1 @@
1
- export { ResourceMetadata, type ResourceMetadataMode, type ResourceMetadataOverlay, type ResourceMetadataProps } from './ResourceMetadata';
1
+ export { ResourceMetadata, type ResourceMetadataMode, type ResourceMetadataProps } from './ResourceMetadata';
@@ -1,19 +1,8 @@
1
+ import { EditTagsOverlayProps } from '../../hooks/useEditTagsOverlay';
1
2
  import { ListableResourceType } from '@commercelayer/sdk';
2
3
 
3
4
  type TaggableResource = Extract<ListableResourceType, 'addresses' | 'bundles' | 'customers' | 'coupons' | 'gift_cards' | 'line_items' | 'orders' | 'returns' | 'sku_options' | 'skus' | 'shipments'>;
4
- interface TagsOverlay {
5
- /**
6
- * Title shown as first line in edit overlay heading
7
- */
8
- title: string;
9
- /**
10
- * Optional description shown as second line in edit overlay heading
11
- */
12
- description?: string;
13
- /**
14
- * Optional setting to define if tags app management link is to be shown in edit overlay heading
15
- */
16
- showManageAction?: boolean;
5
+ interface TagsOverlay extends Omit<EditTagsOverlayProps, 'resourceId' | 'resourceType'> {
17
6
  }
18
7
  export interface ResourceTagsProps {
19
8
  resourceType: TaggableResource;
@@ -21,7 +10,7 @@ export interface ResourceTagsProps {
21
10
  /**
22
11
  * Edit overlay configuration
23
12
  */
24
- overlay: TagsOverlay;
13
+ overlay?: TagsOverlay;
25
14
  /**
26
15
  * Optional onTagClick function to define the click behavior of single tag in visualization
27
16
  */
@@ -33,7 +22,11 @@ export interface ResourceTagsProps {
33
22
  export declare const ResourceTags: import('../atoms/SkeletonTemplate').SkeletonTemplateComponent<{
34
23
  resourceType: TaggableResource;
35
24
  resourceId: string;
36
- overlay: TagsOverlay;
25
+ overlay?: TagsOverlay
26
+ /**
27
+ * Optional onTagClick function to define the click behavior of single tag in visualization
28
+ */
29
+ | undefined;
37
30
  onTagClick?: ((tagId: string) => void) | undefined;
38
31
  delayMs?: number | undefined;
39
32
  isLoading?: boolean | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@commercelayer/app-elements",
3
- "version": "2.5.2",
3
+ "version": "2.7.0",
4
4
  "type": "module",
5
5
  "license": "MIT",
6
6
  "files": [