@supersoniks/concorde 3.2.1 → 3.2.3

package/docs/src/core/components/functional/sdui/sdui.md

@@ -1,356 +0,0 @@
-# SDUI
-
-## What is SDUI?
-
-SDUI stands for `Server Driven User Interfaces`.
-Basically, it generates a user interface based on a JSON SDUI Descriptor.
-
-### Subscriber extension:
-
-SDUI extends the mixin [Subscriber](#docs/_core-concept/subscriber.md/subscriber).
-This means that you must set a dataProvider with an id pointing to the publisher that will hold your SDUI Descriptor.
-This also means that it has a reactive property named `props` that you can set with the JSON SDUI Descriptor in order to configure it.
-
-### Fetcher extension:
-
-SDUI extends the mixin Fetcher as [Fetch](#core/components/functional/fetch/fetch.md/fetch) and [List](#core/components/functional/list/list.md/list).
-
-In this case, it will parse the JSON coming from the request.
-The JSON must comply with the SDUI descriptor format.
-
-As a fetcher, invalidating the publisher or updating the endpoint will trigger a new fetch and update accordingly.
-
-### Rendering:
-
-It has no shadowdom, and its display style is set to `contents`, so an empty SDUI has the fewest impact on the layout.
-
-## SDUI descriptor
-
-### TypeScript definition:
-<sonic-code language="typescript">
-  <template>
-    export type SDUIDescriptor = {
-      js?: Array&lt;string&gt;;
-      css?: Array&lt;string&gt;;
-      library?: Record&lt;string, SDUINode&gt;;
-      nodes?: Array&lt;SDUINode&gt;;
-    };
-  </template>
-</sonic-code>
-
-### Meaning of the keys:
-
-* **js**: An array of URLs pointing to JavaScript files to load.
-* **css**: An array of URLs pointing to CSS files to load.
-* **library**: A record of SDUINode definitions intended to be used as a model for other nodes. The keys of the record can be used as the libraryKey of the node. This node will then specialize the model with its own descriptor.
-* **nodes**: An array of SDUINode descriptors. Each SDUINode will result in an HTMLElement added to the root of the component.
-
-## SDUINode
-
-### Descriptor
-
-An SDUINode represents an HTMLElement.
-
-TypeScript definition:
-
-<sonic-code language="typescript">
-  <template>
-    export type SDUINode = {
-      markup?: string;
-      tagName?: string;
-      attributes?: Record&lt;string, string&gt;;
-      nodes?: Array&lt;SDUINode&gt;;
-      innerHTML?: string;
-      prefix?: string;
-      suffix?: string;
-      libraryKey?: string;
-      contentElementSelector?: string;
-      parentElementSelector?: string;
-    };
-  </template>
-</sonic-code>
-
-Summary of properties:
-* **markup**: Use it if you prefer to define your node entirely using an HTML string.
-* **tagName**: The tag name of the HTML element.
-* **attributes**: A string key/value pair storing each attribute name/value of the HTML element created.
-* **nodes**: An array of SDUINode descriptors. The children of the HTMLElement are created this way.
-* **innerHTML**: The inner HTML of the current node is defined here if needed.
-* **prefix**: Use it if you want to wrap the component with some HTML string in conjunction with the suffix.
-* **suffix**: Use it if you want to wrap the component with some HTML string in conjunction with the prefix.
-* **libraryKey**: An identifier that points to an SDUINode to be used as a model for this node.
-* **contentElementSelector**: For SDUINodes defined in the library only. It is a CSS selector that defines where child nodes are added.
-* **parentElementSelector**: If the current node, as a future child, has a `parentElementSelector` attribute, it is added to the node corresponding to the associated CSS selector rather than directly to the element.
-
-### Markup
-Use it if you prefer to define your node entirely using an HTML string.
-
-<sonic-code>
-  <template>
-    <sonic-sdui 
-      dataProvider="sdui-markup-example" 
-      props='{
-          "nodes":[
-            {
-              "markup":"keep shouting <sonic-badge>foo</sonic-badge> <sonic-badge>bar</sonic-badge> !"
-            }
-          ]}'
-    ></sonic-sdui>
-  </template>
-</sonic-code>
-
-### Tag name
-Here we use the field `tagName` of SDUINode to create an element with tag name `sonic-input`.
-
-<sonic-code>
-  <template>
-    <sonic-sdui 
-      dataProvider="sdui-tagName-example" 
-      props='{
-          "nodes":[
-            {
-              "tagName":"sonic-input"
-            }
-          ]}'
-    ></sonic-sdui>
-  </template>
-</sonic-code>
-
-### Attributes
-A string key/value pair storing each attribute name/value of the HTML element created.
-As no tag name is defined, a div element is created.
-Here we define the style attribute to create a tiny red square.
-
-<sonic-code>
-  <template>
-    <sonic-sdui 
-      dataProvider="sdui-attributes-example" 
-      props='{
-        "nodes":[{
-          "attributes":{
-            "style":"width:50px;height:10px;background:red;"
-          }
-        }]
-      }'
-    ></sonic-sdui>
-  </template>
-</sonic-code>
-
-### Nodes
-Children of the current node can be added using the field `nodes` recursively.
-
-<sonic-code>
-  <template>
-    <sonic-sdui 
-      dataProvider="sdui-nodes-example" 
-      props='{
-        "nodes":[{
-          "nodes":[
-            {"innerHTML":"A"},
-            {
-              "prefix":"B",
-              "nodes":[
-                {"innerHTML":"👉 B.1"},
-                {"innerHTML":"👉 B.2"}
-              ]
-            }
-          ]
-        }]
-      }'
-    ></sonic-sdui>
-  </template>
-</sonic-code>
-
-### InnerHTML
-As no tag name is defined, a div element is created, and then we use `innerHTML` to add content to it.
-
-<sonic-code>
-  <template>
-    <sonic-sdui 
-      dataProvider="sdui-html-example" 
-      props='{
-        "nodes":[{
-          "innerHTML":"keep shouting <sonic-badge>foo</sonic-badge> <sonic-badge>bar</sonic-badge> !"
-        }]
-      }'
-    ></sonic-sdui>
-  </template>
-</sonic-code>
-
-### Prefix and suffix
-Use them if you want to wrap the component with some HTML string.
-
-<sonic-code>
-  <template>
-    <sonic-sdui 
-      dataProvider="sdui-prefixSuffix-example" 
-      props='{
-        "nodes":[{
-          "prefix":"👇",
-          "suffix":"☝️",
-          "innerHTML":"The node content"
-        }]
-      }'
-    ></sonic-sdui>
-  </template>
-</sonic-code>
-
-### Library key and contentElementSelector
-The libraryKey of SDUINode is an identifier that points to an SDUINode description in the library to be used as a model for this node.
-
-Note that the SDUI has a default library containing some basic component definitions useful for form declaration (see default-library.json).
-
-This example uses the library key `submit` which points to a `sonic-submit` containing a button also coming from the library.
-
-The element named `button` in the library is a `sonic-button` of type `success` containing a check icon as a prefix.
-
-Since the `submit` library element contains an attribute `contentElementSelector` with the value `sonic-button`, the "injected content" is put inside the button.
-
-We used `innerHTML` for the sake of simplicity, but you can use nodes to add any complex content.
-
-<sonic-code>
-  <template>
-    <sonic-sdui dataProvider="sdui-library-example" props='
-          {
-            "nodes":[
-              {
-                "libraryKey":"submit",
-                "innerHTML":"Injected content"
-              }
-            ]
-          }
-    '></sonic-sdui>
-  </template>
-</sonic-code>
-
-### parentElementSelector
-
-This special field lets you inject the content at any place in the HTML flow already set inside the parent SDUI component by using a CSS selector.
-
-⚠️ Note that it doesn't work with top-level nodes.
-
-<sonic-code>
-  <template>
-    <sonic-sdui dataProvider="sdui-parentElementSelector-example" props='
-          {
-            "nodes":[
-              {
-                "nodes":[
-                  {
-                    "prefix":"👇 Selected parent element",
-                    "suffix":"☝️ End of selected parent element",
-                    "tagName":"span"
-                  },
-                  {
-                    "parentElementSelector":"span",
-                    "innerHTML":"Content having a parentElementSelector attribute"
-                  }
-                ]
-              }
-            ]
-          }
-    '></sonic-sdui>
-  </template>
-</sonic-code>
-
-### Fetch example:
-
-<sonic-code>
-  <template>
-    <sonic-sdui dataProvider="sdui-fetch-example" endPoint="/src/core/components/functional/sdui/example.json"></sonic-sdui>
-  </template>
-</sonic-code>
-
-## Transformers:
-
-The transformers let you transform the structure of the SDUI Descriptor into a new one before parsing and rendering it.
-
-To enable it, you must fill the `transformation` attribute of the component with a URL pointing to a Transform descriptor.
-
-<sonic-code language="typescript">
-  <template>
-  export type SDUITransformDescription = {
-    library?: Record&lt;string, SDUINode&gt;;
-    transforms: Array&lt;SDUITransformAction&gt;;
-  };
-  </template>
-</sonic-code>
-
-### The library:
-
-Each key of the library will be merged with the current library in the SDUI Descriptor, by replacing or creating items library key by key.
-
-### The transform actions:
-
-Each transform represents an action that will be done on the SDUI descriptor before the creation of the entire UI.
-
-<sonic-code language="typescript">
-  <template>
-export type SDUITransformAction = {
-  action: SDUITransformActionName;
-  patterns?: Array&lt;SDUINode&gt;;
-  after?: SDUINode;
-  before?: SDUINode;
-  in?: SDUINode;
-  ui?: SDUINode;
-};
-  </template>
-</sonic-code>
-
-The action that will be done is a verb:
-
-<sonic-code language="typescript">
-  <template>
-export type SDUITransformActionName = "remap" | "unwrap" | "wrap" | "delete" | "insert" | "move";
-  </template>
-</sonic-code>
-
-* **remap**: The properties (tagName, innerHTML, etc.) of the targeted SDUINode will be created/changed according to their presence in the `ui` (SDUINode) property of the transformAction.
-* **unwrap**: Replaces the targeted SDUINode in place with its children.
-* **wrap**: Groups all SDUINodes targeted by the patterns into the new SDUINode described in the `ui` prop of the transformAction.
-* **delete**: Deletes the targeted item.
-* **insert**: Inserts a new SDUINode described by the `ui` prop into the flow. The position of insertion depends on the presence of the attributes `before`, `after`, `in`, which is a pattern to target an existing SDUINode.
-
-## Misc Tricks:
-
-### sduiKey
-
-This is an HTML attribute to set on the component if needed. In this case, the component will not treat its props value directly as an SDUI descriptor. Internally, it will basically extract the SDUIDescriptor by doing something like this: `const sduiDescriptor = this.props[this.sduikey]`.
-
-### messageKey
-
-This is an HTML attribute to set on the component if needed. In this case, the component will automatically create a `sonic-toast-message-subscriber` component. The data found in `props[messageKey]` will be treated as the data expected by the `sonic-toast-message-subscriber`. So, by respecting the format of data supported by this component, you will be able to show multiple toasts in the result of a request.
-
-Example of JSON with `messageKey`=`messages`:
-<sonic-code language="typescript">
-  <template>
-{
-  "messages": [{
-    "content": "The product has been added to your cart", 
-    "status": "success", 
-    "type": "public"
-  }]
-}
-  </template>
-</sonic-code>
-
-### library
-
-This is an HTML attribute to set on the component if needed. You can set a URL pointing to a JSON describing a library with the same structure as the library in the SDUIDescriptor. The component will simply override its library with the given one.
-
-## Playground
-
-Here is a little playground to let you test some simple tricks.
-
-<sonic-code>
-  <template>
-    <sonic-textarea 
-    rows="10" 
-    onChange="SonicPublisherManager.get('sdui-playground').set(JSON.parse(this.value))" 
-    value='{"nodes":[{"tagName":"div", "innerHTML":"test"}]}'
-    >
-    </sonic-textarea>
-    <sonic-sdui dataProvider="sdui-playground" props='{"nodes":[{"tagName":"div", "innerHTML":"test"}]}'>
-    </sonic-sdui>
-  </template>
-</sonic-code>

package/docs/src/core/components/functional/states/states.md

@@ -1,87 +0,0 @@
-# States
-
- ### sonic-states displays different states depending on the value of a sub-property of its dataProvider (data-path attribute in dot notation):
- * It loops over its child templates and tests if the regexp contained in the *data-value* attribute matches the value of the property
- * If so, the content of the corresponding template is displayed as a state.
- * If the attribute dataProviderExpression is provided the content is surrounded by a div:
- * The "dataProvider" attribute of this div is the result of calling the replace function on the property value with the regexp and dataproviderExpression as parameters.
- * The subscribers/fetch... of the template will refer to this dataProvider
- * You can also use url-pattern expressions for the route parameters, see the examples
- *
- **Examples**
- * With ma.property= 2 :
- * RegExp data-value = (\d+) and dataproviderExpression = /user/$1 the dataProvider attribute will be "/user/2"
- * url-pattern data-value = :id and dataproviderExpression = /user/:id the dataProvider attribute will be "/user/2
-
-## Basic
-
-<sonic-code>
-  <template>
-    <div class="flex gap-2 items-center" formDataProvider="states-basic-example">
-      <sonic-button radio name="selection" value="#home" checked size="xs">Home</sonic-button>
-      <sonic-button radio name="selection" value="#about" size="xs">About</sonic-button>
-      <sonic-button radio name="selection" value="#work" size="xs">Work</sonic-button>
-      <sonic-button radio name="selection" value="#contact" size="xs">Contact</sonic-button>
-    </div>
-    <div class="text-center text-neutral-700 border rounded text-4xl  my-6 p-3 ">
-    <sonic-states dataProvider="states-basic-example" data-path="selection">
-      <template data-value="#home">Home</template>
-      <template data-value="#about">About</template>
-      <template data-value="#work">Work</template>
-      <template data-value="#contact">Contact</template>
-    </sonic-states>
-    </div>
-  </template>
-</sonic-code>
-
-## Regexp
-
-When using **capturing groups ()** the stored values are accessible via the **dataProviderExpression**  
-**e.g.**, data-value="#couleur_<b class="text-danger">(\d+)</b>" => dataProviderExpression="api/unknown/<b class="text-danger">$1</b>"
-
-<sonic-code>
-  <template>
-    <div  serviceURL="https://reqres.in">
-      <sonic-list formDataProvider="states-regexp-example" fetch dataProvider="api/unknown" key="data" class="flex gap-2 items-center" >
-        <template>
-          <sonic-button radio size="xs" name="selection" data-bind ::value="#couleur_$id">
-            <span data-bind ::inner-html="ucFirst|$name"></span>
-          </sonic-button>
-        </template>
-      </sonic-list>
-      <sonic-states dataProvider="states-regexp-example" data-path="selection">
-        <template data-value="#couleur_(\d+)" dataProviderExpression="api/unknown/$1">
-          <sonic-fetch>
-            <input type="color" disabled data-bind ::value="$data.color" class=" w-full h-10 my-3" />
-          </sonic-fetch>
-        </template>
-      </sonic-states>
-    </div>
-  </template>
-</sonic-code>
-
-## Url-pattern
-
-Same as RegExp but using <a href="https://www.npmjs.com/package/url-pattern" target="_blank">url patterns</a>  
-**e.g.**, data-value="#couleur_<b class="text-danger">:id</b>" => dataProviderExpression="api/unknown/<b class="text-danger">:id</b>"
-
-<sonic-code>
-  <template>
-    <div serviceURL="https://reqres.in">
-      <sonic-list formDataProvider="states-regexp-example" fetch dataProvider="api/unknown" key="data" class="flex gap-2 items-center" >
-        <template>
-          <sonic-button radio size="xs" name="selection" data-bind ::value="#couleur_$id">
-            <span data-bind ::inner-html="ucFirst|$name"></span>
-          </sonic-button>
-        </template>
-      </sonic-list>
-      <sonic-states dataProvider="states-regexp-example" data-path="selection">
-        <template data-value="#couleur_:id" dataProviderExpression="api/unknown/:id">
-          <sonic-fetch>
-            <input type="color" disabled data-bind ::value="$data.color" class=" w-full h-10 my-3" />
-          </sonic-fetch>
-        </template>
-      </sonic-states>
-    </div>
-  </template>
-</sonic-code>

package/docs/src/core/components/functional/submit/submit.md

@@ -1,83 +0,0 @@
-# Submit
-
-## The submit element is used to send data to a rest service
- * The api is set up like a [fetcher](#core/components/functional/fetch/fetch.md/fetch).
- * The *formDataProvider* attribute points to the adress where the data is held by a publisher.
- * This attribute is also used by form elements such as *sonic-input*, or *sonic-select*, which fill this publisher with their *value* attribute according to their *name* attribute
- * The *method* attribute allows you to choose the sending method: *put/delete/post*, *post* being the default method.
- * If the *onClick* attribute is present, the data is sent when the content is clicked on
- * If the *onEnterKey* attribute is present, data is sent when the enter key of an element contained in the *sonic-submit* with focus is pressed
- * During sending, *sonic-submit* elements with the same *dataProvider* attribute have the *disabled="disabled "* property, which has the effect of disabling their content
- * The *clearedDataOnSuccess* attribute can be used to clear the data from the corresponding dataProvider when the call to the api has provided a result.
-
-## Form example
-<sonic-code>
-  <template>
-  <sonic-scope
-        serviceURL="https://reqres.in" dataProvider="api/register"
-        formDataProvider="submit-example" submitResultDataProvider="submit-example-result"
-        method="post"
-        class="max-w-lg block"
-      >
-        <sonic-submit onEnterKey>
-          <div class="grid grid-cols-2 gap-4 mb-4 ">
-            <sonic-input required name="email" type="email" value="eve.holt@reqres.in"></sonic-input>
-            <sonic-input required type="password" name="password" value="pistol"></sonic-input>
-          </div>
-        </sonic-submit>
-        <sonic-submit onClick>
-          <sonic-button type="success" class="w-full">Submit</sonic-button>
-        </sonic-submit>
-    </sonic-scope>
-  </template>
-</sonic-code>
-
-
-
-
-
-## Result handling example
-
-Result will show when something has been submit because the **dataprovider** used in this example is the same as the **submitResultDataProvider** used in the previous form.
-<sonic-code>
-  <template>
-      <div dataProvider="submit-example-result">
-        <div>Id : <span data-bind ::inner-html="$id"></span></div>
-        <div>Token : <span data-bind ::inner-html="$token"></span></div>
-        <div data-bind ::inner-html="$error"></div>
-      </div>
-  </template>
-</sonic-code>
-
-
-## dot notation
-
-You can write the folowing code where the name attribute is written in dot notation.
-
-<sonic-code>
-  <template>
-  <sonic-scope formDataProvider="submit-example-dot-notation">
-     <div class="grid grid-cols-2 gap-4 mb-4 ">
-        <sonic-input required name="email.value" type="email" value="eve.holt@reqres.in"></sonic-input>
-        <sonic-input required type="password" name="details.password.value" value="pistol"></sonic-input>
-      </div>
-    </sonic-scope>
-  </template>
-</sonic-code>
-
-The data will be stored in the following format:
-
- <sonic-code language="typescript">
-  <template>
-  {
-    email: {
-      value: "eve.holt@reqres.in",
-    },
-    details: {
-      password: {
-        value: "pistol",
-      },
-    },
-  }
-  </template>
-</sonic-code>

package/docs/src/core/components/functional/subscriber/subscriber.md

@@ -1,91 +0,0 @@
-# Subscriber
-
-La mixin Subscriber permet lier un composant à un publisher.
-La liaison à un publisher se fait via l'attribut *dataProvider* du composant qui représente ce que l'on obtient en appellant PublisherManager.get(dataProvider).
-
-Les propriétés du composant sont automatiquement remplies avec les propriétés du même nom dans les données du publisher.
-
-Le composant est automatiquement mis à jour lorsque les données du publisher sont mises à jour.
-
-## DataProvider
-
-**Id** of the dataProvider that the component will **subscribe** to
-
-<sonic-code>
-  <template>
-    <sonic-subscriber dataProvider="id_that_the_subsriber_will_subscribe_to" debug>
-      <sonic-button> custom dataProvider id</sonic-button>
-    </sonic-subscriber>
-    <sonic-subscriber debug>
-      <sonic-button> default id : pageHTML</sonic-button>
-    </sonic-subscriber>
-  </template>
-</sonic-code>
-
-## Props
-
-Data object (json) that will be passed to the dataProvider
-
-<sonic-code>
-  <template>
-    <sonic-subscriber props='{"data":"Hello world"}' debug>
-      <sonic-button> Hover to see the data</sonic-button>
-    </sonic-subscriber>
-  </template>
-</sonic-code>
-
-
-## Debug
-
-**Helper**, display the data held by the dataProvider in a floating div
-
-<sonic-code>
-  <template>
-    <sonic-subscriber debug>
-      <sonic-button> see the dataProvider'data </sonic-button>
-    </sonic-subscriber>
-  </template>
-</sonic-code>
-
-
-## NoAutofill
-
-<sonic-alert status="info">Docs coming soon</sonic-alert>
-
-## PropertyMap
-
-<sonic-alert status="info">Docs coming soon</sonic-alert>
-
-Permet de mapper un nom de propriété de donnée source vers une propriété du subscriber à la volée
-
-## BindPublisher
-
-<sonic-alert status="info">Docs coming soon</sonic-alert>
-
-On peut utiliser cette fonction pour lier un publisher spécifique au composant si besoin.
-
-## instanceCounter
-
-<sonic-alert status="info">Docs coming soon</sonic-alert>
-
-## Publisher
-
-<sonic-alert status="info">Docs coming soon</sonic-alert>
-
-## Args
-
-<sonic-alert status="info">Docs coming soon</sonic-alert>
- 
-## NoShadowDom
-
-Par défaut on crée un shadow dom mais on peut demander à ne pas en avoir via cette propriété et un attribut associé.  
-Cela se fait à l'initialisation uniquement et n'est pas modifiable lors de la vie du composant.
-
-
-## Other attributes gathered from subscriber.stories.ts
-
-styles ??  
-title ??  
-_props ??  
-onAssign ??  
-defferedDebug ??

package/docs/src/core/components/functional/value/value.md

@@ -1,35 +0,0 @@
-# Value
-
-Simply shows a value from a data provider.
-You can target sub data value using dot syntax.
-The value reacts to changes.
-
-* Below is a form that helps you to set a value for the field "preference" in the data target with id "value-example"
-<sonic-code>
-  <template>
-    <div formDataProvider="value-example">
-      which one do you prefer  ?
-      <sonic-radio name="preference" checked value="dogs"> Dogs</sonic-radio>
-      <sonic-radio name="preference" value="cats"> Cats</sonic-radio>
-    </div>
-  </template>
-</sonic-code>
-* Then you can see live value of the preference using this code :
-<sonic-code>
-  <template>
-  I prefer <sonic-value dataProvider="value-example" key="preference"></sonic-value> 
-  </template>
-</sonic-code>
-* If you have more complex data like this
-<sonic-code>
-  <template>
-    <sonic-subscriber dataProvider="value-example-2" props='{"my":{"complex":[{"data":"👋 Hi There"}]}}'></sonic-subscriber> 
-  </template>
-</sonic-code>
-* You can target it with the dot syntax
-<sonic-code>
-  <template>
-  <sonic-value dataProvider="value-example-2" key="my.complex.0.data"></sonic-value> 
-  </template>
-</sonic-code>
-