@gcforms/types 0.0.8 → 0.0.9

package/package.json

@@ -1,31 +1,28 @@
 {
   "name": "@gcforms/types",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "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",
-  "files": [
-    "dist",
-    "package.json"
-  ],
-  "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"
+  "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"
+    }
   },
-  "dependencies": {
-    "axios": "^1.7.9"
+  "scripts": {
+    "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/src/form-response-types.ts

@@ -0,0 +1,18 @@
+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/src/form-types.ts

@@ -0,0 +1,216 @@
+// Utility type creator
+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[]; // NOTE: these are elementIds
+  autoFlow?: boolean;
+  exitUrlEn?: string; // Used when a nextAction is set to "exit"
+  exitUrlFr?: string; // Used when a nextAction is set to "exit"
+};
+
+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";
+
+// all the possible types of form elements
+export 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;
+};
+
+// used to define attributes on the validation object which controls form validation for
+// individual field
+export interface ValidationProperties {
+  required: boolean;
+  type?: HTMLTextInputTypeAttribute;
+  regex?: string;
+  maxLength?: number;
+  descriptionEN?: string;
+  descriptionFR?: string;
+  [key: string]: unknown;
+}
+
+// the choices available for fields with multiple options like dropdowns or radio buttons
+export interface PropertyChoices {
+  en: string;
+  fr: string;
+  [key: string]: string;
+}
+
+export type AddressComponents = {
+  canadianOnly?: boolean;
+  splitAddress?: boolean;
+};
+
+// defines the fields in the object that controls how form submissions are delivered
+export interface DeliveryOption {
+  emailAddress: string;
+  emailSubjectEn?: string;
+  emailSubjectFr?: string;
+  [key: string]: string | undefined;
+}
+
+// used to define attributes for the properties of an element in the form
+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;
+}
+
+// defines the fields in the object that controls form branding
+export interface BrandProperties {
+  name?: string;
+  logoEn: string;
+  logoFr: string;
+  logoTitleEn: string;
+  logoTitleFr: string;
+  urlEn?: string;
+  urlFr?: string;
+  // if set to true the GC branding will be removed from the footer
+  disableGcBranding?: boolean;
+  [key: string]: string | boolean | undefined;
+}
+
+// used to define attributes for a form element or field
+export interface FormElement {
+  id: number;
+  subId?: string;
+  type: FormElementTypes;
+  properties: ElementProperties;
+  onchange?: (event: FormChangeEvent) => void;
+  brand?: BrandProperties;
+}
+
+// defines the fields for the main form configuration object
+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;
+};
+
+// defines the fields for the form record that is available in authenticated spaces and backend processes
+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;
+};
+
+// defines the fields for the form record that is available to unauthenticated users
+export type PublicFormRecord = TypeOmit<FormRecord, "name" | "deliveryOption">;

package/src/index.ts

@@ -0,0 +1,39 @@
+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/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "downlevelIteration": true,
+    "module": "esnext",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": false,
+    "typeRoots": ["./src/@types"]
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist"]
+}

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/form-types.d.ts

@@ -1,165 +0,0 @@
-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/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";