@gcforms/types 0.0.1

package/dist/form-response-types.d.ts

@@ -0,0 +1,9 @@
+export type Responses = {
+    [key: string]: Response;
+};
+export type Response = string | string[] | number | Record<string, unknown>[] | FileInputResponse | FileInputResponse[] | Record<string, unknown>;
+export type FileInputResponse = {
+    name: string | null;
+    size: number | null;
+    based64EncodedFile: string | null;
+};

package/dist/form-response-types.js

@@ -0,0 +1 @@
+export {};

package/dist/form-types.d.ts

@@ -0,0 +1,165 @@
+export type TypeOmit<Type, Key extends PropertyKey> = {
+    [Property in keyof Type as Exclude<Property, Key>]: Type[Property];
+};
+export type FormChangeEvent = {
+    target: {
+        value: string | number | boolean | string[];
+        name?: string;
+        type?: string;
+        checked?: boolean;
+    };
+};
+export type Group = {
+    name: string;
+    titleEn: string;
+    titleFr: string;
+    nextAction?: string | NextActionRule[];
+    elements: string[];
+    autoFlow?: boolean;
+    exitUrlEn?: string;
+    exitUrlFr?: string;
+};
+export type GroupsType = Record<string, Group>;
+export type FormValues = Record<string, string | string[]>;
+export type ChoiceRule = {
+    elementId: string;
+    choiceId: string;
+};
+export type NextActionRule = {
+    groupId: string;
+    choiceId: string;
+};
+export type HTMLTextInputTypeAttribute = "text" | "email" | "name" | "number" | "password" | "search" | "tel" | "url";
+export declare enum FormElementTypes {
+    textField = "textField",
+    textArea = "textArea",
+    dropdown = "dropdown",
+    radio = "radio",
+    checkbox = "checkbox",
+    fileInput = "fileInput",
+    richText = "richText",
+    dynamicRow = "dynamicRow",
+    attestation = "attestation",
+    address = "address",
+    addressComplete = "addressComplete",
+    name = "name",
+    firstMiddleLastName = "firstMiddleLastName",
+    departments = "departments",
+    contact = "contact",
+    combobox = "combobox",
+    formattedDate = "formattedDate"
+}
+export type ConditionalRule = {
+    choiceId: string;
+};
+export interface ValidationProperties {
+    required: boolean;
+    type?: HTMLTextInputTypeAttribute;
+    regex?: string;
+    maxLength?: number;
+    descriptionEN?: string;
+    descriptionFR?: string;
+    [key: string]: unknown;
+}
+export interface PropertyChoices {
+    en: string;
+    fr: string;
+    [key: string]: string;
+}
+export type AddressComponents = {
+    canadianOnly?: boolean;
+    splitAddress?: boolean;
+};
+export interface DeliveryOption {
+    emailAddress: string;
+    emailSubjectEn?: string;
+    emailSubjectFr?: string;
+    [key: string]: string | undefined;
+}
+export interface ElementProperties {
+    titleEn: string;
+    titleFr: string;
+    placeholderEn?: string;
+    placeholderFr?: string;
+    descriptionEn?: string;
+    descriptionFr?: string;
+    validation?: ValidationProperties | undefined;
+    choices?: PropertyChoices[];
+    managedChoices?: string;
+    subElements?: FormElement[];
+    fileType?: string | undefined;
+    headingLevel?: string | undefined;
+    isSectional?: boolean;
+    maxNumberOfRows?: number;
+    autoComplete?: string;
+    dateFormat?: string;
+    conditionalRules?: ConditionalRule[];
+    full?: boolean;
+    addressComponents?: AddressComponents | undefined;
+    dynamicRow?: dynamicRowType;
+    [key: string]: string | number | boolean | Array<PropertyChoices> | Array<FormElement> | ValidationProperties | Array<ConditionalRule> | AddressComponents | dynamicRowType | undefined;
+}
+export interface BrandProperties {
+    name?: string;
+    logoEn: string;
+    logoFr: string;
+    logoTitleEn: string;
+    logoTitleFr: string;
+    urlEn?: string;
+    urlFr?: string;
+    disableGcBranding?: boolean;
+    [key: string]: string | boolean | undefined;
+}
+export interface FormElement {
+    id: number;
+    subId?: string;
+    type: FormElementTypes;
+    properties: ElementProperties;
+    onchange?: (event: FormChangeEvent) => void;
+    brand?: BrandProperties;
+}
+export interface FormProperties {
+    titleEn: string;
+    titleFr: string;
+    introduction?: Record<string, string>;
+    privacyPolicy?: Record<string, string>;
+    confirmation?: Record<string, string>;
+    closedMessage?: Record<string, string>;
+    layout: number[];
+    groups?: GroupsType;
+    groupsLayout?: string[];
+    elements: FormElement[];
+    lastGeneratedElementId?: number;
+    brand?: BrandProperties;
+    formPurpose?: string;
+    [key: string]: string | number | boolean | Array<string | number | FormElement> | Record<string, string> | BrandProperties | GroupsType | undefined;
+}
+export type dynamicRowType = {
+    rowTitleEn: string;
+    rowTitleFr: string;
+    addButtonTextEn: string;
+    removeButtonTextEn: string;
+    addButtonTextFr: string;
+    removeButtonTextFr: string;
+};
+export type FormRecord = {
+    id: string;
+    createdAt?: string;
+    updatedAt?: string;
+    name: string;
+    form: FormProperties;
+    isPublished: boolean;
+    deliveryOption?: DeliveryOption;
+    securityAttribute: SecurityAttribute;
+    closingDate?: string;
+    closedDetails?: ClosedDetails;
+    saveAndResume?: boolean;
+    [key: string]: string | boolean | FormProperties | DeliveryOption | ClosedDetails | undefined;
+};
+export type SecurityAttribute = "Unclassified" | "Protected A" | "Protected B";
+export type FormPurpose = "" | "admin" | "nonAdmin";
+export type ClosedDetails = {
+    messageEn?: string;
+    messageFr?: string;
+};
+export type PublicFormRecord = TypeOmit<FormRecord, "name" | "deliveryOption">;

package/dist/form-types.js

@@ -0,0 +1,21 @@
+// all the possible types of form elements
+export var FormElementTypes;
+(function (FormElementTypes) {
+    FormElementTypes["textField"] = "textField";
+    FormElementTypes["textArea"] = "textArea";
+    FormElementTypes["dropdown"] = "dropdown";
+    FormElementTypes["radio"] = "radio";
+    FormElementTypes["checkbox"] = "checkbox";
+    FormElementTypes["fileInput"] = "fileInput";
+    FormElementTypes["richText"] = "richText";
+    FormElementTypes["dynamicRow"] = "dynamicRow";
+    FormElementTypes["attestation"] = "attestation";
+    FormElementTypes["address"] = "address";
+    FormElementTypes["addressComplete"] = "addressComplete";
+    FormElementTypes["name"] = "name";
+    FormElementTypes["firstMiddleLastName"] = "firstMiddleLastName";
+    FormElementTypes["departments"] = "departments";
+    FormElementTypes["contact"] = "contact";
+    FormElementTypes["combobox"] = "combobox";
+    FormElementTypes["formattedDate"] = "formattedDate";
+})(FormElementTypes || (FormElementTypes = {}));

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import { dynamicRowType, FormElement, Group, FormElementTypes, ElementProperties, PropertyChoices, BrandProperties, DeliveryOption, ConditionalRule, FormRecord, SecurityAttribute, FormPurpose, PublicFormRecord, ValidationProperties, FormProperties, AddressComponents, ClosedDetails } from "./form-types";
+export type { Response, Responses, FileInputResponse } from "./form-response-types";
+export { type dynamicRowType };
+export type { FormElement };
+export { FormElementTypes };
+export type { Group };
+export type { ElementProperties };
+export type { PropertyChoices };
+export type { BrandProperties };
+export type { DeliveryOption };
+export type { ConditionalRule };
+export type { FormRecord };
+export type { SecurityAttribute };
+export type { FormPurpose };
+export type { PublicFormRecord };
+export type { ValidationProperties };
+export type { FormProperties };
+export type { AddressComponents };
+export type { ClosedDetails };

package/dist/index.js

@@ -0,0 +1,2 @@
+import { FormElementTypes, } from "./form-types";
+export { FormElementTypes };

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@gcforms/types",
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepare": "yarn && yarn build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^20.11.0",
+    "typescript": "^5.3.3"
+  }
+}