@gcforms/types 1.0.14 → 1.0.16

package/CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+## [1.0.16] - 2025-08-13
+
+- Add DateObject to Response definition
+
+## [1.0.15] - 2025-08-13
+
+### Changed
+
+- Update fileInputResponse to migrate from base64 to BufferArray
+
 ## [1.0.14] - 2025-07-10
 
 ### Changed

package/dist/index.d.mts

@@ -20,6 +20,7 @@ type Group = {
     exitUrlFr?: string;
 };
 type GroupsType = Record<string, Group>;
+type FormValues = Record<string, string | string[]>;
 type NextActionRule = {
     groupId: string;
     choiceId: string;
@@ -186,15 +187,107 @@ declare const NotificationsInterval: {
     readonly WEEK: 10080;
 };
 type NotificationsInterval = (typeof NotificationsInterval)[keyof typeof NotificationsInterval];
+type DateFormat = "YYYY-MM-DD" | "DD-MM-YYYY" | "MM-DD-YYYY";
+interface DateObject {
+    YYYY: number;
+    MM: number;
+    DD: number;
+}
+declare enum DatePart {
+    DD = "day",
+    MM = "month",
+    YYYY = "year"
+}
 
 type Responses = {
     [key: string]: Response;
 };
-type Response = string | string[] | number | Record<string, unknown>[] | FileInputResponse | FileInputResponse[] | Record<string, unknown>;
+type Response = string | string[] | number | Record<string, unknown>[] | FileInputResponse | FileInputResponse[] | DateObject | Record<string, unknown>;
 type FileInputResponse = {
     name: string | null;
     size: number | null;
     content: ArrayBuffer | null;
 };
 
-export { type AddressComponents, type BrandProperties, type ClosedDetails, type ConditionalRule, type DeliveryOption, type ElementProperties, type FileInputResponse, type FormElement, FormElementTypes, type FormProperties, type FormPurpose, type FormRecord, FormStatus, type Group, NotificationsInterval, NotificationsIntervalDefault, type PropertyChoices, type PublicFormRecord, type Response, type Responses, type SecurityAttribute, SortOption, type SortValue, type ValidationProperties, type dynamicRowType };
+interface InputFieldProps {
+    id?: string;
+    className?: string;
+    name: string;
+    label?: string;
+    required?: boolean;
+    disabled?: boolean;
+    ariaDescribedBy?: string;
+    lang?: string;
+}
+interface AddressCompleteChoice {
+    Id: string;
+    Text: string;
+    Highlight: string;
+    Cursor: number;
+    Description: string;
+    Next: AddressCompleNext;
+}
+declare enum AddressCompleNext {
+    Find = "Find",
+    Retrieve = "Retrieve"
+}
+interface AddressCompleteResult {
+    Id: string;
+    DomesticId: string;
+    Language: string;
+    LanguageAlternatives: string;
+    Department: string;
+    Company: string;
+    SubBuilding: string;
+    BuildingNumber: string;
+    BuildingName: string;
+    SecondaryStreet: string;
+    Street: string;
+    Block: string;
+    Neighbourhood: string;
+    District: string;
+    City: string;
+    Line1: string;
+    Line2: string;
+    Line3: string;
+    Line4: string;
+    Line5: string;
+    AdminAreaName: string;
+    AdminAreaCode: string;
+    Province: string;
+    ProvinceName: string;
+    ProvinceCode: string;
+    PostalCode: string;
+    CountryName: string;
+    CountryIso2: string;
+    CountryIso3: string;
+    CountryIsoNumber: number;
+    SortingNumber1: string;
+    SortingNumber2: string;
+    Barcode: string;
+    POBoxNumber: string;
+    Label: string;
+    DataLevel: string;
+}
+interface AddressCompleteProps extends InputFieldProps {
+    canadianOnly?: boolean;
+    splitAddress?: boolean;
+}
+interface AddressElements {
+    streetAddress: string;
+    city: string;
+    province: string;
+    postalCode: string;
+    country: string;
+}
+interface AddressCompleteLabels {
+    streetAddress: string;
+    city: string;
+    province: string;
+    postalCode: string;
+    provinceOrState: string;
+    postalCodeOrZip: string;
+    country: string;
+}
+
+export { AddressCompleNext, type AddressCompleteChoice, type AddressCompleteLabels, type AddressCompleteProps, type AddressCompleteResult, type AddressComponents, type AddressElements, type BrandProperties, type ClosedDetails, type ConditionalRule, type DateFormat, type DateObject, DatePart, type DeliveryOption, type ElementProperties, type FileInputResponse, type FormElement, FormElementTypes, type FormProperties, type FormPurpose, type FormRecord, FormStatus, type FormValues, type Group, type GroupsType, NotificationsInterval, NotificationsIntervalDefault, type PropertyChoices, type PublicFormRecord, type Response, type Responses, type SecurityAttribute, SortOption, type SortValue, type ValidationProperties, type dynamicRowType };

package/dist/index.d.ts

@@ -20,6 +20,7 @@ type Group = {
     exitUrlFr?: string;
 };
 type GroupsType = Record<string, Group>;
+type FormValues = Record<string, string | string[]>;
 type NextActionRule = {
     groupId: string;
     choiceId: string;
@@ -186,15 +187,107 @@ declare const NotificationsInterval: {
     readonly WEEK: 10080;
 };
 type NotificationsInterval = (typeof NotificationsInterval)[keyof typeof NotificationsInterval];
+type DateFormat = "YYYY-MM-DD" | "DD-MM-YYYY" | "MM-DD-YYYY";
+interface DateObject {
+    YYYY: number;
+    MM: number;
+    DD: number;
+}
+declare enum DatePart {
+    DD = "day",
+    MM = "month",
+    YYYY = "year"
+}
 
 type Responses = {
     [key: string]: Response;
 };
-type Response = string | string[] | number | Record<string, unknown>[] | FileInputResponse | FileInputResponse[] | Record<string, unknown>;
+type Response = string | string[] | number | Record<string, unknown>[] | FileInputResponse | FileInputResponse[] | DateObject | Record<string, unknown>;
 type FileInputResponse = {
     name: string | null;
     size: number | null;
     content: ArrayBuffer | null;
 };
 
-export { type AddressComponents, type BrandProperties, type ClosedDetails, type ConditionalRule, type DeliveryOption, type ElementProperties, type FileInputResponse, type FormElement, FormElementTypes, type FormProperties, type FormPurpose, type FormRecord, FormStatus, type Group, NotificationsInterval, NotificationsIntervalDefault, type PropertyChoices, type PublicFormRecord, type Response, type Responses, type SecurityAttribute, SortOption, type SortValue, type ValidationProperties, type dynamicRowType };
+interface InputFieldProps {
+    id?: string;
+    className?: string;
+    name: string;
+    label?: string;
+    required?: boolean;
+    disabled?: boolean;
+    ariaDescribedBy?: string;
+    lang?: string;
+}
+interface AddressCompleteChoice {
+    Id: string;
+    Text: string;
+    Highlight: string;
+    Cursor: number;
+    Description: string;
+    Next: AddressCompleNext;
+}
+declare enum AddressCompleNext {
+    Find = "Find",
+    Retrieve = "Retrieve"
+}
+interface AddressCompleteResult {
+    Id: string;
+    DomesticId: string;
+    Language: string;
+    LanguageAlternatives: string;
+    Department: string;
+    Company: string;
+    SubBuilding: string;
+    BuildingNumber: string;
+    BuildingName: string;
+    SecondaryStreet: string;
+    Street: string;
+    Block: string;
+    Neighbourhood: string;
+    District: string;
+    City: string;
+    Line1: string;
+    Line2: string;
+    Line3: string;
+    Line4: string;
+    Line5: string;
+    AdminAreaName: string;
+    AdminAreaCode: string;
+    Province: string;
+    ProvinceName: string;
+    ProvinceCode: string;
+    PostalCode: string;
+    CountryName: string;
+    CountryIso2: string;
+    CountryIso3: string;
+    CountryIsoNumber: number;
+    SortingNumber1: string;
+    SortingNumber2: string;
+    Barcode: string;
+    POBoxNumber: string;
+    Label: string;
+    DataLevel: string;
+}
+interface AddressCompleteProps extends InputFieldProps {
+    canadianOnly?: boolean;
+    splitAddress?: boolean;
+}
+interface AddressElements {
+    streetAddress: string;
+    city: string;
+    province: string;
+    postalCode: string;
+    country: string;
+}
+interface AddressCompleteLabels {
+    streetAddress: string;
+    city: string;
+    province: string;
+    postalCode: string;
+    provinceOrState: string;
+    postalCodeOrZip: string;
+    country: string;
+}
+
+export { AddressCompleNext, type AddressCompleteChoice, type AddressCompleteLabels, type AddressCompleteProps, type AddressCompleteResult, type AddressComponents, type AddressElements, type BrandProperties, type ClosedDetails, type ConditionalRule, type DateFormat, type DateObject, DatePart, type DeliveryOption, type ElementProperties, type FileInputResponse, type FormElement, FormElementTypes, type FormProperties, type FormPurpose, type FormRecord, FormStatus, type FormValues, type Group, type GroupsType, NotificationsInterval, NotificationsIntervalDefault, type PropertyChoices, type PublicFormRecord, type Response, type Responses, type SecurityAttribute, SortOption, type SortValue, type ValidationProperties, type dynamicRowType };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gcforms/types",
-  "version": "1.0.14",
+  "version": "1.0.16",
   "author": "Canadian Digital Service",
   "license": "MIT",
   "publishConfig": {