@abgov/web-components 1.37.1-alpha.2 → 1.37.1-alpha.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abgov/web-components",
-  "version": "1.37.1-alpha.2",
+  "version": "1.37.1-alpha.3",
   "license": "Apache-2.0",
   "description": "Government of Alberta - UI Web components",
   "bugs": {

package/types/relay-types.d.ts

@@ -0,0 +1,150 @@
+export type FormStatus = "not-started" | "cannot-start-yet" | "in-progress" | "submitted" | "update-needed" | "complete";
+export type FormState = {
+    uuid: string;
+    form: Record<string, Fieldset>;
+    history: string[];
+    editting: string;
+    lastModified?: Date;
+    status: FormStatus;
+};
+export type Fieldset = {
+    heading?: string;
+    data?: FieldsetData;
+};
+export type FieldsetData = {
+    type: "details";
+    fieldsets: Record<string, FieldsetItemState>;
+} | {
+    type: "list";
+    items: FormState[];
+};
+export declare const StateChangeEvent = "_stateChange";
+export type StateChangeRelayDetail = {
+    type: "details";
+    data: FormState;
+} | {
+    id: string;
+    type: "list";
+    data: FormState[];
+};
+export declare const FormResetErrorsMsg = "form::reset:errors";
+export declare const FormResetFormMsg = "form::reset:form";
+export declare const FormBindMsg = "form::bind";
+export type FormBindRelayDetail = {
+    id: string;
+    el: HTMLElement;
+};
+export declare const FormToggleActiveMsg = "form::toggle:active";
+export type FormToggleActiveRelayDetail = {
+    active: boolean;
+};
+export declare const FormSetFieldsetMsg = "form::set:fieldset";
+export type FormSetFieldsetRelayDetail = {
+    name: string;
+    value: FieldsetData;
+};
+export declare const FormDispatchStateMsg = "form::dispatch:state";
+export type FormDispatchStateRelayDetail = FormState;
+export type FormDispatchStateRelayDetailList = FormState[];
+export declare const FormDispatchEditMsg = "form::edit";
+export type FormDispatchEditRelayDetail = {
+    id: string;
+};
+export declare const SubFormBindMsg = "subform::bind";
+export type SubFormBindRelayDetail = {
+    el: HTMLElement;
+};
+export declare const SubFormIndexContinueToParentMsg = "subform::indexContinueToParent";
+export declare const SubFormIndexContinueToSubFormMsg = "subform::indexContinueToSubForm";
+export declare const FieldsetResetErrorsMsg = "fieldset::reset:errors";
+export declare const FieldsetResetFieldsMsg = "fieldset::reset:fields";
+export declare const FieldsetCompleteMsg = "fieldset::submit";
+export declare const FormPageContinueMsg = "form-page:continue";
+export type FormPageContinueRelayDetail = {
+    cancelled: boolean;
+};
+export declare const FormPageBackMsg = "form-page:back";
+export declare const FormPageBindMsg = "form=page::bind";
+export type FormPageBindRelayDetail = {
+    id: string;
+    heading: string;
+    el: HTMLElement;
+};
+export declare const FieldsetBindMsg = "fieldset::bind";
+export type FieldsetBindRelayDetail = {
+    id: string;
+    el: HTMLElement;
+    cb?: (id: string) => void;
+};
+export declare const FieldsetSetErrorMsg = "fieldset::set:error";
+export type FieldsetErrorRelayDetail = {
+    error: string;
+};
+export declare const FieldsetChangeMsg = "fieldset::change";
+export type FieldsetChangeRelayDetail = {
+    id: string;
+    state: {
+        heading?: string;
+        data: Record<string, FieldsetItemState>;
+    };
+    dispatchOn: "change" | "continue";
+};
+export type FieldsetItemState = {
+    name: string;
+    label: string;
+    value: string | number | Date;
+    order: number;
+    valueLabel?: string;
+};
+export type FieldsetValidationRelayDetail = {
+    el: HTMLElement;
+    state: Record<string, FieldsetItemState>;
+    cancelled: boolean;
+};
+export declare const FieldsetSetValueMsg = "fieldset::set:value";
+export type FieldsetSetValueRelayDetail = {
+    name: string;
+    value: string | number | Date;
+};
+export declare const FormItemMountMsg = "form-item::bind";
+export type FormItemMountRelayDetail = {
+    id: string;
+    label: string;
+    el: HTMLElement;
+    order: number;
+};
+export declare const ExternalAlterDataMsg = "external::alter:state";
+export type ExternalAlterDataRelayDetail = {
+    id: string;
+    operation: "remove";
+    index: number;
+} | {
+    id: string;
+    operation: "edit";
+    index: number;
+};
+export declare const ExternalContinueMsg = "external::continue";
+export type ExternalContinueRelayDetail = {
+    next: string;
+};
+export declare const ExternalSetErrorMsg = "external::set:error";
+export type ExternalErrorRelayDetail = {
+    name: string;
+    msg: string;
+    grouped: boolean;
+};
+export declare const ExternalInitStateMsg = "external::init:state";
+export type ExternalInitStateDetail = FormState | string;
+export declare const FormFieldMountMsg = "form-field::bind";
+export type FormFieldMountRelayDetail = {
+    name: string;
+    el: HTMLElement;
+};
+export declare const FormSummaryBindMsg = "form-summary::bind";
+export type FormSummaryBindRelayDetail = {
+    el: HTMLElement;
+};
+export declare const FormSummaryEditPageMsg = "form-summary::edit:page";
+export type FormSummaryEditPageRelayDetail = {
+    id: string;
+};