@gcforms/types 0.0.9 → 0.0.10

package/dist/index.d.mts

@@ -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.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,6 +1,6 @@
 {
   "name": "@gcforms/types",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "author": "Canadian Digital Service",
   "license": "MIT",
   "publishConfig": {
@@ -16,6 +16,9 @@
       "import": "./dist/index.mjs"
     }
   },
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsup src/index.ts --format cjs,esm --dts --clean",
     "prepare": "yarn && yarn build"

package/src/form-response-types.ts

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

@@ -1,216 +0,0 @@
-// 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

@@ -1,39 +0,0 @@
-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

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