@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.2

package/data/script-api/dw.experience.ComponentScriptContext.md

@@ -0,0 +1,148 @@
+<!-- prettier-ignore-start -->
+# Class ComponentScriptContext
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.experience.ComponentScriptContext](dw.experience.ComponentScriptContext.md)
+
+This is the context that is handed over to the `render` and `serialize` function of the respective component type
+script.
+
+```
+    String : render( [ComponentScriptContext](dw.experience.ComponentScriptContext.md) context)
+    Object : serialize( [ComponentScriptContext](dw.experience.ComponentScriptContext.md) context)
+```
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [component](#component): [Component](dw.experience.Component.md) `(read-only)` | Returns the component for which the corresponding component type script is currently executed. |
+| [componentRenderSettings](#componentrendersettings): [ComponentRenderSettings](dw.experience.ComponentRenderSettings.md) `(read-only)` | As components are implicitly rendered as part of their hosting region via  [PageMgr.renderRegion(Region, RegionRenderSettings)](dw.experience.PageMgr.md#renderregionregion-regionrendersettings) there is the possibility  to define render settings for the region itself but also for its contained components. |
+| [content](#content): [Map](dw.util.Map.md) `(read-only)` | Returns the processed version of the underlying unprocessed raw values (also see [Component.getAttribute(String)](dw.experience.Component.md#getattributestring))  of this component's attributes which you can use in your respective component type `render` and `serialize` function  implementing your business and rendering/serialization functionality. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getComponent](dw.experience.ComponentScriptContext.md#getcomponent)() | Returns the component for which the corresponding component type script is currently executed. |
+| [getComponentRenderSettings](dw.experience.ComponentScriptContext.md#getcomponentrendersettings)() | As components are implicitly rendered as part of their hosting region via  [PageMgr.renderRegion(Region, RegionRenderSettings)](dw.experience.PageMgr.md#renderregionregion-regionrendersettings) there is the possibility  to define render settings for the region itself but also for its contained components. |
+| [getContent](dw.experience.ComponentScriptContext.md#getcontent)() | Returns the processed version of the underlying unprocessed raw values (also see [Component.getAttribute(String)](dw.experience.Component.md#getattributestring))  of this component's attributes which you can use in your respective component type `render` and `serialize` function  implementing your business and rendering/serialization functionality. |
+
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Property Details
+
+### component
+- component: [Component](dw.experience.Component.md) `(read-only)`
+  - : Returns the component for which the corresponding component type script is currently executed.
+
+
+---
+
+### componentRenderSettings
+- componentRenderSettings: [ComponentRenderSettings](dw.experience.ComponentRenderSettings.md) `(read-only)`
+  - : As components are implicitly rendered as part of their hosting region via
+      [PageMgr.renderRegion(Region, RegionRenderSettings)](dw.experience.PageMgr.md#renderregionregion-regionrendersettings) there is the possibility
+      to define render settings for the region itself but also for its contained components.
+      The latter will be provided here so you further set or refine them for your component
+      as part of the `render` function, i.e. to drive the shape of the
+      component wrapper element.
+
+
+
+---
+
+### content
+- content: [Map](dw.util.Map.md) `(read-only)`
+  - : Returns the processed version of the underlying unprocessed raw values (also see [Component.getAttribute(String)](dw.experience.Component.md#getattributestring))
+      of this component's attributes which you can use in your respective component type `render` and `serialize` function
+      implementing your business and rendering/serialization functionality. Processing the raw value is comprised of **expansion**
+      and **conversion**, in this order.
+      
+      1. **expansion**- dynamic placeholders are transformed into actual values, for example url/link placeholders in       markup text are resolved to real URLs
+      2. **conversion**- the raw value (see [Component.getAttribute(String)](dw.experience.Component.md#getattributestring)) is resolved into an actual       DWScript object depending on the type of the attribute as specified in its respective attribute definition        
+         - `boolean`-> boolean
+         - `category`-> [Category](dw.catalog.Category.md)
+         - `custom`-> [Map](dw.util.Map.md)
+         - `cms_record`-> [CMSRecord](dw.experience.cms.CMSRecord.md)
+         - `enum`-> either string or integer 
+         - `file`-> [MediaFile](dw.content.MediaFile.md)
+         - `image`-> [Image](dw.experience.image.Image.md)
+         - `integer`-> integer
+         - `markup`-> string
+         - `page`-> string
+         - `product`-> [Product](dw.catalog.Product.md)
+         - `string`-> string
+         - `text`-> string
+         - `url`-> string
+
+
+
+---
+
+## Method Details
+
+### getComponent()
+- getComponent(): [Component](dw.experience.Component.md)
+  - : Returns the component for which the corresponding component type script is currently executed.
+
+    **Returns:**
+    - the currently rendered component
+
+
+---
+
+### getComponentRenderSettings()
+- getComponentRenderSettings(): [ComponentRenderSettings](dw.experience.ComponentRenderSettings.md)
+  - : As components are implicitly rendered as part of their hosting region via
+      [PageMgr.renderRegion(Region, RegionRenderSettings)](dw.experience.PageMgr.md#renderregionregion-regionrendersettings) there is the possibility
+      to define render settings for the region itself but also for its contained components.
+      The latter will be provided here so you further set or refine them for your component
+      as part of the `render` function, i.e. to drive the shape of the
+      component wrapper element.
+
+
+    **Returns:**
+    - the component render settings
+
+
+---
+
+### getContent()
+- getContent(): [Map](dw.util.Map.md)
+  - : Returns the processed version of the underlying unprocessed raw values (also see [Component.getAttribute(String)](dw.experience.Component.md#getattributestring))
+      of this component's attributes which you can use in your respective component type `render` and `serialize` function
+      implementing your business and rendering/serialization functionality. Processing the raw value is comprised of **expansion**
+      and **conversion**, in this order.
+      
+      1. **expansion**- dynamic placeholders are transformed into actual values, for example url/link placeholders in       markup text are resolved to real URLs
+      2. **conversion**- the raw value (see [Component.getAttribute(String)](dw.experience.Component.md#getattributestring)) is resolved into an actual       DWScript object depending on the type of the attribute as specified in its respective attribute definition        
+         - `boolean`-> boolean
+         - `category`-> [Category](dw.catalog.Category.md)
+         - `custom`-> [Map](dw.util.Map.md)
+         - `cms_record`-> [CMSRecord](dw.experience.cms.CMSRecord.md)
+         - `enum`-> either string or integer 
+         - `file`-> [MediaFile](dw.content.MediaFile.md)
+         - `image`-> [Image](dw.experience.image.Image.md)
+         - `integer`-> integer
+         - `markup`-> string
+         - `page`-> string
+         - `product`-> [Product](dw.catalog.Product.md)
+         - `string`-> string
+         - `text`-> string
+         - `url`-> string
+
+
+    **Returns:**
+    - processed content attributes of the component
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.experience.CustomEditor.md

@@ -0,0 +1,146 @@
+<!-- prettier-ignore-start -->
+# Class CustomEditor
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.experience.CustomEditor](dw.experience.CustomEditor.md)
+
+This class represents a custom editor for component attributes of type `custom`. It is instantiated
+by Page Designer and is subsequently used there for editing of such attributes by the merchant in a visual manner.
+It therefore serves the Page Designer with all information required by such UI. What exactly
+this information will be is up to the developer of the respective custom editor UI, i.e. depends on the respective
+json and js files written for both the attribute definition as well as the custom editor type. Currently a configuration can be
+served (basically values passed to Page Designer so that it can bootstrap the custom editor UI on the client side).
+Furthermore resources can be served, which are URLs to scripts and styles required by the same UI (you will
+likely require your own Javascript and CSS there).
+
+
+You can access the aforementioned configuration as provided through the editor definition of the respective attribute
+definition, which you can also adjust in the `init` function (see corresponding js file of your custom editor
+type) that is called during initialization of the custom editor, i.e. right before it is passed to the Page Designer UI.
+The same applies for the script and style resources which you specified as part of your custom editor type and which you
+can refine with the `init` function as needed.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [configuration](#configuration): [Map](dw.util.Map.md) `(read-only)` | Returns the configuration of the custom editor. |
+| [dependencies](#dependencies): [Map](dw.util.Map.md) `(read-only)` | <p>  Returns the dependencies to other custom editors, e.g. |
+| [resources](#resources): [CustomEditorResources](dw.experience.CustomEditorResources.md) `(read-only)` | Returns the resources of the custom editor. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getConfiguration](dw.experience.CustomEditor.md#getconfiguration)() | Returns the configuration of the custom editor. |
+| [getDependencies](dw.experience.CustomEditor.md#getdependencies)() | <p>  Returns the dependencies to other custom editors, e.g. |
+| [getResources](dw.experience.CustomEditor.md#getresources)() | Returns the resources of the custom editor. |
+
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Property Details
+
+### configuration
+- configuration: [Map](dw.util.Map.md) `(read-only)`
+  - : Returns the configuration of the custom editor. This is initialized with the values as provided
+      through the editor definition of the respective attribute definition of type `custom`.
+      Be aware that this configuration will have to be serializable to JSON itself as it will be passed
+      to Page Designer for processing in the UI. So you must not add any values in this map that are not
+      properly serializable. Do not use complex DWScript classes that do not support JSON serialization
+      like for instance [Product](dw.catalog.Product.md).
+
+
+
+---
+
+### dependencies
+- dependencies: [Map](dw.util.Map.md) `(read-only)`
+  - : 
+      
+      Returns the dependencies to other custom editors, e.g. used as breakout elements. You can use
+      this mapping to add more custom editor dependencies as needed. For this purpose you want to create
+      a [CustomEditor](dw.experience.CustomEditor.md) instance via [PageMgr.getCustomEditor(String, Map)](dw.experience.PageMgr.md#getcustomeditorstring-map)) and then add it
+      to the dependencies mapping with an ID of your choice. In the client side logic of Page Designer
+      you will then be able to access these dependencies again by using the corresponding ID.
+      
+      
+      
+      
+      This is especially helpful if your custom editor for an attribute requires to open a breakout panel,
+      e.g. for a separate picker required by your custom editor. This picker could be another custom editor,
+      i.e. the one you declare as dependency here.
+
+
+
+---
+
+### resources
+- resources: [CustomEditorResources](dw.experience.CustomEditorResources.md) `(read-only)`
+  - : Returns the resources of the custom editor. This is initialized with the values as specified
+      by the custom editor type json (see the respective styles and scripts section).
+
+
+
+---
+
+## Method Details
+
+### getConfiguration()
+- getConfiguration(): [Map](dw.util.Map.md)
+  - : Returns the configuration of the custom editor. This is initialized with the values as provided
+      through the editor definition of the respective attribute definition of type `custom`.
+      Be aware that this configuration will have to be serializable to JSON itself as it will be passed
+      to Page Designer for processing in the UI. So you must not add any values in this map that are not
+      properly serializable. Do not use complex DWScript classes that do not support JSON serialization
+      like for instance [Product](dw.catalog.Product.md).
+
+
+    **Returns:**
+    - the configuration of the custom editor
+
+
+---
+
+### getDependencies()
+- getDependencies(): [Map](dw.util.Map.md)
+  - : 
+      
+      Returns the dependencies to other custom editors, e.g. used as breakout elements. You can use
+      this mapping to add more custom editor dependencies as needed. For this purpose you want to create
+      a [CustomEditor](dw.experience.CustomEditor.md) instance via [PageMgr.getCustomEditor(String, Map)](dw.experience.PageMgr.md#getcustomeditorstring-map)) and then add it
+      to the dependencies mapping with an ID of your choice. In the client side logic of Page Designer
+      you will then be able to access these dependencies again by using the corresponding ID.
+      
+      
+      
+      
+      This is especially helpful if your custom editor for an attribute requires to open a breakout panel,
+      e.g. for a separate picker required by your custom editor. This picker could be another custom editor,
+      i.e. the one you declare as dependency here.
+
+
+    **Returns:**
+    - an ID to [CustomEditor](dw.experience.CustomEditor.md) mapping
+
+
+---
+
+### getResources()
+- getResources(): [CustomEditorResources](dw.experience.CustomEditorResources.md)
+  - : Returns the resources of the custom editor. This is initialized with the values as specified
+      by the custom editor type json (see the respective styles and scripts section).
+
+
+    **Returns:**
+    - the custom editor resources, will never be `null`
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.experience.CustomEditorResources.md

@@ -0,0 +1,100 @@
+<!-- prettier-ignore-start -->
+# Class CustomEditorResources
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.experience.CustomEditorResources](dw.experience.CustomEditorResources.md)
+
+This class represents the resources of a custom editor, i.e. URLs to scripts and styles which are required for
+client side functionality in Page Designer in context of the corresponding custom attribute UI. These resources
+are initially specified as part of your custom editor type (i.e. the respective json file). If needed you can
+revise and refine them as part of the `init` function that is called during initialization of the
+[CustomEditor](dw.experience.CustomEditor.md), i.e. is subject to your implementation of the respective custom editor type js file.
+
+
+**See Also:**
+- [CustomEditor](dw.experience.CustomEditor.md)
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [scripts](#scripts): [List](dw.util.List.md) `(read-only)` | Returns the specified script resource URLs. |
+| [styles](#styles): [List](dw.util.List.md) `(read-only)` | Returns the specified style URLs. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getScripts](dw.experience.CustomEditorResources.md#getscripts)() | Returns the specified script resource URLs. |
+| [getStyles](dw.experience.CustomEditorResources.md#getstyles)() | Returns the specified style URLs. |
+
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Property Details
+
+### scripts
+- scripts: [List](dw.util.List.md) `(read-only)`
+  - : Returns the specified script resource URLs. You can further modify this list
+      at runtime of your `init` function to add more required scripts.
+      Absolute URLs will be retained, relative paths will be resolved to absolute
+      ones based on the cartridge path for static resources (e.g. similar to
+      what [URLUtils.httpStatic(String)](dw.web.URLUtils.md#httpstaticstring) or
+      [URLUtils.httpsStatic(String)](dw.web.URLUtils.md#httpsstaticstring)) does.
+
+
+
+---
+
+### styles
+- styles: [List](dw.util.List.md) `(read-only)`
+  - : Returns the specified style URLs. You can further modify this list
+      at runtime of your `init` function to add more required styles.
+      Absolute URLs will be retained, relative paths will be resolved to absolute
+      ones based on the cartridge path for static resources (e.g. similar to
+      what [URLUtils.httpStatic(String)](dw.web.URLUtils.md#httpstaticstring) or
+      [URLUtils.httpsStatic(String)](dw.web.URLUtils.md#httpsstaticstring)) does.
+
+
+
+---
+
+## Method Details
+
+### getScripts()
+- getScripts(): [List](dw.util.List.md)
+  - : Returns the specified script resource URLs. You can further modify this list
+      at runtime of your `init` function to add more required scripts.
+      Absolute URLs will be retained, relative paths will be resolved to absolute
+      ones based on the cartridge path for static resources (e.g. similar to
+      what [URLUtils.httpStatic(String)](dw.web.URLUtils.md#httpstaticstring) or
+      [URLUtils.httpsStatic(String)](dw.web.URLUtils.md#httpsstaticstring)) does.
+
+
+    **Returns:**
+    - the script resources, will never be `null`
+
+
+---
+
+### getStyles()
+- getStyles(): [List](dw.util.List.md)
+  - : Returns the specified style URLs. You can further modify this list
+      at runtime of your `init` function to add more required styles.
+      Absolute URLs will be retained, relative paths will be resolved to absolute
+      ones based on the cartridge path for static resources (e.g. similar to
+      what [URLUtils.httpStatic(String)](dw.web.URLUtils.md#httpstaticstring) or
+      [URLUtils.httpsStatic(String)](dw.web.URLUtils.md#httpsstaticstring)) does.
+
+
+    **Returns:**
+    - the style resources, will never be `null`
+
+
+---
+
+<!-- prettier-ignore-end -->