@gcforms/types 0.0.8 → 0.0.10

package/dist/{types/form-types.d.ts → index.d.mts}

@@ -1,7 +1,7 @@
-export type TypeOmit<Type, Key extends PropertyKey> = {
+type TypeOmit<Type, Key extends PropertyKey> = {
     [Property in keyof Type as Exclude<Property, Key>]: Type[Property];
 };
-export type FormChangeEvent = {
+type FormChangeEvent = {
     target: {
         value: string | number | boolean | string[];
         name?: string;
@@ -9,7 +9,7 @@ export type FormChangeEvent = {
         checked?: boolean;
     };
 };
-export type Group = {
+type Group = {
     name: string;
     titleEn: string;
     titleFr: string;
@@ -19,18 +19,13 @@ export type Group = {
     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 = {
+type GroupsType = Record<string, Group>;
+type NextActionRule = {
     groupId: string;
     choiceId: string;
 };
-export type HTMLTextInputTypeAttribute = "text" | "email" | "name" | "number" | "password" | "search" | "tel" | "url";
-export declare enum FormElementTypes {
+type HTMLTextInputTypeAttribute = "text" | "email" | "name" | "number" | "password" | "search" | "tel" | "url";
+declare enum FormElementTypes {
     textField = "textField",
     textArea = "textArea",
     dropdown = "dropdown",
@@ -49,10 +44,10 @@ export declare enum FormElementTypes {
     combobox = "combobox",
     formattedDate = "formattedDate"
 }
-export type ConditionalRule = {
+type ConditionalRule = {
     choiceId: string;
 };
-export interface ValidationProperties {
+interface ValidationProperties {
     required: boolean;
     type?: HTMLTextInputTypeAttribute;
     regex?: string;
@@ -61,22 +56,22 @@ export interface ValidationProperties {
     descriptionFR?: string;
     [key: string]: unknown;
 }
-export interface PropertyChoices {
+interface PropertyChoices {
     en: string;
     fr: string;
     [key: string]: string;
 }
-export type AddressComponents = {
+type AddressComponents = {
     canadianOnly?: boolean;
     splitAddress?: boolean;
 };
-export interface DeliveryOption {
+interface DeliveryOption {
     emailAddress: string;
     emailSubjectEn?: string;
     emailSubjectFr?: string;
     [key: string]: string | undefined;
 }
-export interface ElementProperties {
+interface ElementProperties {
     titleEn: string;
     titleFr: string;
     placeholderEn?: string;
@@ -99,7 +94,7 @@ export interface ElementProperties {
     dynamicRow?: dynamicRowType;
     [key: string]: string | number | boolean | Array<PropertyChoices> | Array<FormElement> | ValidationProperties | Array<ConditionalRule> | AddressComponents | dynamicRowType | undefined;
 }
-export interface BrandProperties {
+interface BrandProperties {
     name?: string;
     logoEn: string;
     logoFr: string;
@@ -110,7 +105,7 @@ export interface BrandProperties {
     disableGcBranding?: boolean;
     [key: string]: string | boolean | undefined;
 }
-export interface FormElement {
+interface FormElement {
     id: number;
     subId?: string;
     type: FormElementTypes;
@@ -118,7 +113,7 @@ export interface FormElement {
     onchange?: (event: FormChangeEvent) => void;
     brand?: BrandProperties;
 }
-export interface FormProperties {
+interface FormProperties {
     titleEn: string;
     titleFr: string;
     introduction?: Record<string, string>;
@@ -134,7 +129,7 @@ export interface FormProperties {
     formPurpose?: string;
     [key: string]: string | number | boolean | Array<string | number | FormElement> | Record<string, string> | BrandProperties | GroupsType | undefined;
 }
-export type dynamicRowType = {
+type dynamicRowType = {
     rowTitleEn: string;
     rowTitleFr: string;
     addButtonTextEn: string;
@@ -142,7 +137,7 @@ export type dynamicRowType = {
     addButtonTextFr: string;
     removeButtonTextFr: string;
 };
-export type FormRecord = {
+type FormRecord = {
     id: string;
     createdAt?: string;
     updatedAt?: string;
@@ -156,10 +151,22 @@ export type FormRecord = {
     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 = {
+type SecurityAttribute = "Unclassified" | "Protected A" | "Protected B";
+type FormPurpose = "" | "admin" | "nonAdmin";
+type ClosedDetails = {
     messageEn?: string;
     messageFr?: string;
 };
-export type PublicFormRecord = TypeOmit<FormRecord, "name" | "deliveryOption">;
+type PublicFormRecord = TypeOmit<FormRecord, "name" | "deliveryOption">;
+
+type Responses = {
+    [key: string]: Response;
+};
+type Response = string | string[] | number | Record<string, unknown>[] | FileInputResponse | FileInputResponse[] | Record<string, unknown>;
+type FileInputResponse = {
+    name: string | null;
+    size: number | null;
+    based64EncodedFile: string | 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, type Group, type PropertyChoices, type PublicFormRecord, type Response, type Responses, type SecurityAttribute, type ValidationProperties, type dynamicRowType };

package/dist/index.d.ts

@@ -0,0 +1,172 @@
+type TypeOmit<Type, Key extends PropertyKey> = {
+    [Property in keyof Type as Exclude<Property, Key>]: Type[Property];
+};
+type FormChangeEvent = {
+    target: {
+        value: string | number | boolean | string[];
+        name?: string;
+        type?: string;
+        checked?: boolean;
+    };
+};
+type Group = {
+    name: string;
+    titleEn: string;
+    titleFr: string;
+    nextAction?: string | NextActionRule[];
+    elements: string[];
+    autoFlow?: boolean;
+    exitUrlEn?: string;
+    exitUrlFr?: string;
+};
+type GroupsType = Record<string, Group>;
+type NextActionRule = {
+    groupId: string;
+    choiceId: string;
+};
+type HTMLTextInputTypeAttribute = "text" | "email" | "name" | "number" | "password" | "search" | "tel" | "url";
+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"
+}
+type ConditionalRule = {
+    choiceId: string;
+};
+interface ValidationProperties {
+    required: boolean;
+    type?: HTMLTextInputTypeAttribute;
+    regex?: string;
+    maxLength?: number;
+    descriptionEN?: string;
+    descriptionFR?: string;
+    [key: string]: unknown;
+}
+interface PropertyChoices {
+    en: string;
+    fr: string;
+    [key: string]: string;
+}
+type AddressComponents = {
+    canadianOnly?: boolean;
+    splitAddress?: boolean;
+};
+interface DeliveryOption {
+    emailAddress: string;
+    emailSubjectEn?: string;
+    emailSubjectFr?: string;
+    [key: string]: string | undefined;
+}
+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;
+}
+interface BrandProperties {
+    name?: string;
+    logoEn: string;
+    logoFr: string;
+    logoTitleEn: string;
+    logoTitleFr: string;
+    urlEn?: string;
+    urlFr?: string;
+    disableGcBranding?: boolean;
+    [key: string]: string | boolean | undefined;
+}
+interface FormElement {
+    id: number;
+    subId?: string;
+    type: FormElementTypes;
+    properties: ElementProperties;
+    onchange?: (event: FormChangeEvent) => void;
+    brand?: BrandProperties;
+}
+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;
+}
+type dynamicRowType = {
+    rowTitleEn: string;
+    rowTitleFr: string;
+    addButtonTextEn: string;
+    removeButtonTextEn: string;
+    addButtonTextFr: string;
+    removeButtonTextFr: string;
+};
+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;
+};
+type SecurityAttribute = "Unclassified" | "Protected A" | "Protected B";
+type FormPurpose = "" | "admin" | "nonAdmin";
+type ClosedDetails = {
+    messageEn?: string;
+    messageFr?: string;
+};
+type PublicFormRecord = TypeOmit<FormRecord, "name" | "deliveryOption">;
+
+type Responses = {
+    [key: string]: Response;
+};
+type Response = string | string[] | number | Record<string, unknown>[] | FileInputResponse | FileInputResponse[] | Record<string, unknown>;
+type FileInputResponse = {
+    name: string | null;
+    size: number | null;
+    based64EncodedFile: string | 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, type Group, type PropertyChoices, type PublicFormRecord, type Response, type Responses, type SecurityAttribute, type ValidationProperties, type dynamicRowType };

package/dist/index.js

@@ -0,0 +1,51 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  FormElementTypes: () => FormElementTypes
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/form-types.ts
+var FormElementTypes = /* @__PURE__ */ ((FormElementTypes2) => {
+  FormElementTypes2["textField"] = "textField";
+  FormElementTypes2["textArea"] = "textArea";
+  FormElementTypes2["dropdown"] = "dropdown";
+  FormElementTypes2["radio"] = "radio";
+  FormElementTypes2["checkbox"] = "checkbox";
+  FormElementTypes2["fileInput"] = "fileInput";
+  FormElementTypes2["richText"] = "richText";
+  FormElementTypes2["dynamicRow"] = "dynamicRow";
+  FormElementTypes2["attestation"] = "attestation";
+  FormElementTypes2["address"] = "address";
+  FormElementTypes2["addressComplete"] = "addressComplete";
+  FormElementTypes2["name"] = "name";
+  FormElementTypes2["firstMiddleLastName"] = "firstMiddleLastName";
+  FormElementTypes2["departments"] = "departments";
+  FormElementTypes2["contact"] = "contact";
+  FormElementTypes2["combobox"] = "combobox";
+  FormElementTypes2["formattedDate"] = "formattedDate";
+  return FormElementTypes2;
+})(FormElementTypes || {});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FormElementTypes
+});

package/dist/index.mjs

@@ -0,0 +1,24 @@
+// src/form-types.ts
+var FormElementTypes = /* @__PURE__ */ ((FormElementTypes2) => {
+  FormElementTypes2["textField"] = "textField";
+  FormElementTypes2["textArea"] = "textArea";
+  FormElementTypes2["dropdown"] = "dropdown";
+  FormElementTypes2["radio"] = "radio";
+  FormElementTypes2["checkbox"] = "checkbox";
+  FormElementTypes2["fileInput"] = "fileInput";
+  FormElementTypes2["richText"] = "richText";
+  FormElementTypes2["dynamicRow"] = "dynamicRow";
+  FormElementTypes2["attestation"] = "attestation";
+  FormElementTypes2["address"] = "address";
+  FormElementTypes2["addressComplete"] = "addressComplete";
+  FormElementTypes2["name"] = "name";
+  FormElementTypes2["firstMiddleLastName"] = "firstMiddleLastName";
+  FormElementTypes2["departments"] = "departments";
+  FormElementTypes2["contact"] = "contact";
+  FormElementTypes2["combobox"] = "combobox";
+  FormElementTypes2["formattedDate"] = "formattedDate";
+  return FormElementTypes2;
+})(FormElementTypes || {});
+export {
+  FormElementTypes
+};

package/package.json

@@ -1,31 +1,31 @@
 {
   "name": "@gcforms/types",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "author": "Canadian Digital Service",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
   },
-  "type": "module",
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
-  "types": "./dist/types/index.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    }
+  },
   "files": [
-    "dist",
-    "package.json"
+    "dist"
   ],
   "scripts": {
-    "build:cjs": "tsc -p tsconfig.cjs.json",
-    "build:esm": "tsc -p tsconfig.esm.json",
-    "build": "rm -rf dist && yarn build:cjs && yarn build:esm",
-    "prepare": "yarn build"
-  },
-  "dependencies": {
-    "axios": "^1.7.9"
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "prepare": "yarn && yarn build"
   },
   "devDependencies": {
     "@types/node": "^20.11.0",
+    "tsup": "^8.3.6",
     "typescript": "^5.3.3"
-  },
-  "packageManager": "yarn@4.6.0"
+  }
 }

package/dist/cjs/form-response-types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/form-types.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FormElementTypes = void 0;
-// all the possible types of form elements
-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 || (exports.FormElementTypes = FormElementTypes = {}));

package/dist/cjs/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FormElementTypes = void 0;
-var form_types_js_1 = require("./form-types.js");
-Object.defineProperty(exports, "FormElementTypes", { enumerable: true, get: function () { return form_types_js_1.FormElementTypes; } });

package/dist/esm/form-response-types.js

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

package/dist/esm/form-types.js

@@ -1,21 +0,0 @@
-// 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/esm/index.js

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

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

@@ -1,9 +0,0 @@
-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/types/index.d.ts

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