@aurodesignsystem-dev/auro-datetime 0.0.0-pr71.1 → 0.0.0-pr71.3

package/demo/api.md

@@ -1,25 +1,27 @@
 <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/api.md) -->
 <!-- The below content is automatically added from ./../docs/api.md -->
 
-# auro-datetime
+# auro-datetime
+
+The `auro-datetime` custom element is for the purposes of providing an easy to use date and time API.
 
 ### Properties & Attributes
 
 | Properties | Attributes | Modifiers | Type                                                                                             | Default | Description                                                                                       |
 | ---------- | ---------- | --------- | ------------------------------------------------------------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------- |
 | cap        | cap        |           | boolean                                                                                          |         | Capitalize AM or PM designation                                                                   |
-| month      | month      |           | string                                                                                           | `short` | Defines format of month                                                                           |
+| month      | month      |           | `short` \| `long`                                                                                | `short` | Defines format of month                                                                           |
 | setDate    | setDate    |           | string                                                                                           |         | Pass in string to set date                                                                        |
 | timeZone   | timeZone   |           | string                                                                                           |         | Pass in string to define [timeZone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) |
 | type       | type       |           | `date` \| `time` \| `year` \| `month` \| `weekday` \| `day` \| `numeric` \| `tzDate` \| `tzTime` |         | Defines type of data to render                                                                    |
 | utc        | utc        |           | string                                                                                           |         | Pass in ISO 8601 UTC formatted time code                                                          |
-| weekday    | weekday    |           | string                                                                                           | `short` | Defines format of weekday                                                                         |
+| weekday    | weekday    |           | `short` \| `long`                                                                                | `short` | Defines format of weekday                                                                         |
 
 ### Methods
 
-| Name     | Parameters                                                          | Return | Description                                       |
-| -------- | ------------------------------------------------------------------- | ------ | ------------------------------------------------- |
-| register | `name` (string) - The name of element that you want to register to. |        | This will register this element with the browser. |
+| Name     | Parameters                                                           | Return | Description                                       |
+| -------- | -------------------------------------------------------------------- | ------ | ------------------------------------------------- |
+| register | `name` (string) - The name of the element that you want to register. |        | This will register this element with the browser. |
 
 ### Slots
 

package/demo/auro-datetime.min.js

@@ -113,6 +113,7 @@ const t=globalThis,i$1=t.trustedTypes,s$1=i$1?i$1.createPolicy("lit-html",{creat
 
 // See https://git.io/JJ6SJ for "How to document your components using JSDoc"
 /**
+ * The `auro-datetime` custom element is for the purposes of providing an easy to use date and time API.
  * @customElement auro-datetime
  *
  * @slot pre - Content that comes before the `post` content
@@ -124,8 +125,7 @@ class AuroDatetime extends i {
   constructor() {
     super();
 
-    this.weekday = "short";
-    this.month = "short";
+    this.privateDefaults();
 
     /**
      * @private
@@ -133,6 +133,11 @@ class AuroDatetime extends i {
     this.runtimeUtils = new AuroLibraryRuntimeUtils();
   }
 
+  privateDefaults() {
+    this.weekday = "short";
+    this.month = "short";
+  }
+
   connectedCallback() {
     super.connectedCallback();
 
@@ -165,7 +170,7 @@ class AuroDatetime extends i {
       /**
        * Defines format of month
        * @type {'short' | 'long'}
-       * @default {'short'}
+       * @default 'short'
        */
       month: { type: String },
 
@@ -193,7 +198,7 @@ class AuroDatetime extends i {
       /**
        * Defines format of weekday
        * @type {'short' | 'long'}
-       * @default {'short'}
+       * @default 'short'
        */
       weekday: { type: String },
     };
@@ -201,7 +206,7 @@ class AuroDatetime extends i {
 
   /**
    * This will register this element with the browser.
-   * @param {string} [name="auro-datetime"] - The name of element that you want to register to.
+   * @param {string} [name="auro-datetime"] - The name of the element that you want to register.
    *
    * @example
    * AuroDatetime.register("custom-datetime") // this will register this element to <custom-datetime/>

package/dist/auro-datetime-C2O0ACdc.js

@@ -0,0 +1,6 @@
+import{LitElement as e,html as t}from"lit";class a{registerComponent(e,t){customElements.get(e)||customElements.define(e,class extends t{})}closestElement(e,t=this,a=(t,s=t&&t.closest(e))=>t&&t!==document&&t!==window?s||a(t.getRootNode().host):null){return a(t)}handleComponentTagRename(e,t){const a=t.toLowerCase();e.tagName.toLowerCase()!==a&&e.setAttribute(a,!0)}elementMatch(e,t){const a=t.toLowerCase();return e.tagName.toLowerCase()===a||e.hasAttribute(a)}getSlotText(e,t){const a=e.shadowRoot?.querySelector(`slot[name="${t}"]`);return(a?.assignedNodes({flatten:!0})||[]).map(e=>e.textContent?.trim()).join(" ").trim()||null}}class s extends e{constructor(){super(),this.privateDefaults(),this.runtimeUtils=new a}privateDefaults(){this.weekday="short",this.month="short"}connectedCallback(){super.connectedCallback(),this.dateTemplate={weekday:this.weekday,year:"numeric",month:this.month,day:"numeric"},this.timeTemplate={hour:"2-digit",minute:"2-digit",timeZone:this.timeZone},this.template={}}static get properties(){return{cap:{type:Boolean},month:{type:String},setDate:{type:String},timeZone:{type:String},type:{type:String},utc:{type:String},weekday:{type:String}}}static register(e="auro-datetime"){a.prototype.registerComponent(e,s)}firstUpdated(){this.runtimeUtils.handleComponentTagRename(this,"auro-datetime")}humanDate(){let e=new Date;return this.utc?(this.dateTemplate.timeZone="UTC",e=new Date(this.utc)):this.setDate&&(e=new Date(this.setDate)),e.toLocaleString("en-us",this.dateTemplate)}humanDateConversion(){let e=new Date;switch(this.utc?(this.template.timeZone="UTC",e=new Date(this.utc)):this.setDate&&(e=new Date(this.setDate)),this.type){case"day":this.template.day="numeric";break;case"month":this.template.month=this.month;break;case"year":this.template.year="numeric";break;case"weekday":this.template.weekday=this.weekday;break;default:this.template.weekday=this.template}return e.toLocaleString("en-us",this.template)}numericDate(){this.dateTemplate.month="numeric",Reflect.deleteProperty(this.dateTemplate,"weekday");let e=new Date;return this.utc?(this.dateTemplate.timeZone="UTC",e=new Date(this.utc)):this.setDate&&(e=new Date(this.setDate)),e.toLocaleString("en-us",this.dateTemplate)}humanTime(){let e=new Date;return this.utc?(this.timeTemplate.timeZone="UTC",e=new Date(this.utc)):this.setDate&&(e=new Date(this.setDate)),this.cap?e.toLocaleString("en-us",this.timeTemplate).replace(/^0+/u,""):e.toLocaleString("en-us",this.timeTemplate).replace(/^0+/u,"").toLowerCase()}tzTime(e){const t=this.setDate.slice(0,-6),a=new Date(t);return this.cap?a.toLocaleString("en-us",e).replace(/^0+/u,""):a.toLocaleString("en-us",e).replace(/^0+/u,"").replace("AM","am").replace("PM","pm")}whichDate(){let e="";switch(this.type){case"date":e=this.humanDate();break;case"tzDate":e=this.tzTime(this.dateTemplate);break;case"tzTime":e=this.tzTime(this.timeTemplate);break;case"time":e=this.humanTime();break;case"year":case"month":case"weekday":case"day":e=this.humanDateConversion();break;case"numeric":e=this.numericDate();break;default:this.humanDate()}return this.setDate&&!this.type||this.utc&&!this.type?this.humanDate():e}render(){return t`
+      <slot name="pre"></slot>
+      <span class="yield">${this.whichDate()}</span>
+      <slot name="post"></slot>
+      <slot></slot>
+    `}}export{s as A};

package/dist/index.d.ts

@@ -103,7 +103,7 @@ export type AuroDatetimeProps = {
 
 
   /**
-     * 
+     * The `auro-datetime` custom element is for the purposes of providing an easy to use date and time API.
  * 
  * ## Attributes & Properties
  * 
@@ -128,6 +128,7 @@ export type AuroDatetimeProps = {
  * 
  * Methods that can be called to access component functionality.
  * 
+ * - `privateDefaults() => void`: undefined
  * - `register(name?: string = "auro-datetime") => void`: This will register this element with the browser.
   */
     "auro-datetime": Partial<AuroDatetimeProps & BaseProps<AuroDatetime> & BaseEvents>;

package/dist/index.js

@@ -1 +1 @@
-export{A as AuroDatetime}from"./auro-datetime-Dzbnt26-.js";import"lit";
+export{A as AuroDatetime}from"./auro-datetime-C2O0ACdc.js";import"lit";

package/dist/registered.js

@@ -1 +1 @@
-import{A as r}from"./auro-datetime-Dzbnt26-.js";import"lit";r.register();
+import{A as r}from"./auro-datetime-C2O0ACdc.js";import"lit";r.register();

package/package.json

@@ -7,7 +7,7 @@
     "================================================================================"
   ],
   "name": "@aurodesignsystem-dev/auro-datetime",
-  "version": "0.0.0-pr71.1",
+  "version": "0.0.0-pr71.3",
   "description": "auro-datetime HTML custom element",
   "repository": {
     "type": "git",
@@ -24,7 +24,7 @@
     "lit": "^3.3.1"
   },
   "devDependencies": {
-    "@aurodesignsystem/auro-cli": "^3.4.1",
+    "@aurodesignsystem/auro-cli": "^3.4.2",
     "@aurodesignsystem/auro-config": "^1.3.1",
     "@aurodesignsystem/auro-library": "^5.5.4",
     "husky": "^9.1.7"

package/dist/auro-datetime-Dzbnt26-.js

@@ -1,6 +0,0 @@
-import{LitElement as e,html as t}from"lit";class a{registerComponent(e,t){customElements.get(e)||customElements.define(e,class extends t{})}closestElement(e,t=this,a=(t,s=t&&t.closest(e))=>t&&t!==document&&t!==window?s||a(t.getRootNode().host):null){return a(t)}handleComponentTagRename(e,t){const a=t.toLowerCase();e.tagName.toLowerCase()!==a&&e.setAttribute(a,!0)}elementMatch(e,t){const a=t.toLowerCase();return e.tagName.toLowerCase()===a||e.hasAttribute(a)}getSlotText(e,t){const a=e.shadowRoot?.querySelector(`slot[name="${t}"]`);return(a?.assignedNodes({flatten:!0})||[]).map(e=>e.textContent?.trim()).join(" ").trim()||null}}class s extends e{constructor(){super(),this.weekday="short",this.month="short",this.runtimeUtils=new a}connectedCallback(){super.connectedCallback(),this.dateTemplate={weekday:this.weekday,year:"numeric",month:this.month,day:"numeric"},this.timeTemplate={hour:"2-digit",minute:"2-digit",timeZone:this.timeZone},this.template={}}static get properties(){return{cap:{type:Boolean},month:{type:String},setDate:{type:String},timeZone:{type:String},type:{type:String},utc:{type:String},weekday:{type:String}}}static register(e="auro-datetime"){a.prototype.registerComponent(e,s)}firstUpdated(){this.runtimeUtils.handleComponentTagRename(this,"auro-datetime")}humanDate(){let e=new Date;return this.utc?(this.dateTemplate.timeZone="UTC",e=new Date(this.utc)):this.setDate&&(e=new Date(this.setDate)),e.toLocaleString("en-us",this.dateTemplate)}humanDateConversion(){let e=new Date;switch(this.utc?(this.template.timeZone="UTC",e=new Date(this.utc)):this.setDate&&(e=new Date(this.setDate)),this.type){case"day":this.template.day="numeric";break;case"month":this.template.month=this.month;break;case"year":this.template.year="numeric";break;case"weekday":this.template.weekday=this.weekday;break;default:this.template.weekday=this.template}return e.toLocaleString("en-us",this.template)}numericDate(){this.dateTemplate.month="numeric",Reflect.deleteProperty(this.dateTemplate,"weekday");let e=new Date;return this.utc?(this.dateTemplate.timeZone="UTC",e=new Date(this.utc)):this.setDate&&(e=new Date(this.setDate)),e.toLocaleString("en-us",this.dateTemplate)}humanTime(){let e=new Date;return this.utc?(this.timeTemplate.timeZone="UTC",e=new Date(this.utc)):this.setDate&&(e=new Date(this.setDate)),this.cap?e.toLocaleString("en-us",this.timeTemplate).replace(/^0+/u,""):e.toLocaleString("en-us",this.timeTemplate).replace(/^0+/u,"").toLowerCase()}tzTime(e){const t=this.setDate.slice(0,-6),a=new Date(t);return this.cap?a.toLocaleString("en-us",e).replace(/^0+/u,""):a.toLocaleString("en-us",e).replace(/^0+/u,"").replace("AM","am").replace("PM","pm")}whichDate(){let e="";switch(this.type){case"date":e=this.humanDate();break;case"tzDate":e=this.tzTime(this.dateTemplate);break;case"tzTime":e=this.tzTime(this.timeTemplate);break;case"time":e=this.humanTime();break;case"year":case"month":case"weekday":case"day":e=this.humanDateConversion();break;case"numeric":e=this.numericDate();break;default:this.humanDate()}return this.setDate&&!this.type||this.utc&&!this.type?this.humanDate():e}render(){return t`
-      <slot name="pre"></slot>
-      <span class="yield">${this.whichDate()}</span>
-      <slot name="post"></slot>
-      <slot></slot>
-    `}}export{s as A};