@cityssm/mpac-tools 0.1.0 → 0.2.0

package/rollNumbers/lookups.js

@@ -1,4 +1,7 @@
+// eslint-disable-next-line @eslint-community/eslint-comments/disable-enable-pair
+/* eslint-disable @cspell/spellchecker, max-lines, sonarjs/no-duplicate-string */
 export const rollNumberMunicipalities = Object.freeze({
+    // Prescott, Russell, Stormont Dundas & Glengarry Counties
     '0101': 'South Glengarry Township',
     '0111': 'North Glengarry Township',
     '0201': 'East Hawkesbury Township',
@@ -14,6 +17,7 @@ export const rollNumberMunicipalities = Object.freeze({
     '0411': 'North Stormont Township',
     '0506': 'South Dundas Township',
     '0511': 'North Dundas Township',
+    // Lanark, Leeds & Grenville Counties
     '0701': 'Edwardsburgh/Cardinal Township',
     '0706': 'Augusta Township',
     '0708': 'Prescott Town',
@@ -36,7 +40,9 @@ export const rollNumberMunicipalities = Object.freeze({
     '0928': 'Carleton Place Town',
     '0931': 'Mississippi Mills Town',
     '0940': 'Lanark Highlands Township',
+    // Regional Municipality of the City of Ottawa
     '0614': 'Ottawa City',
+    // Renfrew County
     '4701': 'Mcnab/Braeside Township',
     '4702': 'Arnprior Town',
     '4706': 'Greater Madawaska Township',
@@ -55,6 +61,7 @@ export const rollNumberMunicipalities = Object.freeze({
     '4792': 'Laurentian Hills Town',
     '4796': 'Deep River Town',
     '4798': 'Head Clara Maria Township',
+    // Frontenac, Lennox & Addington Counties
     '1001': 'Frontenac Islands Township',
     '1011': 'Corporation Of The City Of Kingston',
     '1029': 'South Frontenac Township',
@@ -64,6 +71,7 @@ export const rollNumberMunicipalities = Object.freeze({
     '1121': 'Greater Napanee Town',
     '1124': 'Stone Mills Township',
     '1134': 'Addington Highlands Township',
+    // Hastings, Northumberland, City of Prince Edward Counties
     '1201': 'Tyendinaga Township',
     '1202': 'Deseronto Town',
     '1204': 'Quinte West City',
@@ -88,6 +96,7 @@ export const rollNumberMunicipalities = Object.freeze({
     '1423': 'Port Hope Municipality',
     '1435': 'Trent Hills Municipality',
     '1450': 'Alnwick/Haldimand Township',
+    // Peterborough County, Kawartha Lakes County, Haliburton County
     '1501': 'Asphodel-norwood Township',
     '1506': 'Otonabee-south Monaghan Township',
     '1509': 'Cavan Monaghan Township',
@@ -102,7 +111,9 @@ export const rollNumberMunicipalities = Object.freeze({
     '4616': 'Minden Hills Township',
     '4621': 'Algonquin Highlands Township',
     '4624': 'Dysart Et Al Municipality',
+    // City of Toronto
     '1900': 'City Of Toronto',
+    // Regional Municipality of Durham
     '1801': 'Pickering City',
     '1805': 'Ajax Town',
     '1809': 'Whitby Town',
@@ -111,6 +122,7 @@ export const rollNumberMunicipalities = Object.freeze({
     '1820': 'Scugog Township',
     '1829': 'Uxbridge Township',
     '1839': 'Brock Township',
+    // Regional Municipality of York
     '1928': 'Vaughan City',
     '1936': 'Markham City',
     '1938': 'Richmond Hill Town',
@@ -120,6 +132,7 @@ export const rollNumberMunicipalities = Object.freeze({
     '1949': 'King Township',
     '1954': 'East Gwillimbury Town',
     '1970': 'Georgina Town',
+    // Regional Municipalities of Halton and Peel
     '2105': 'Mississauga City',
     '2110': 'Brampton City',
     '2124': 'Caledon Town',
@@ -127,6 +140,7 @@ export const rollNumberMunicipalities = Object.freeze({
     '2402': 'Burlington City',
     '2409': 'Milton Town',
     '2415': 'Halton Hills Town',
+    // Simcoe County
     '4301': 'Adjala-tosorontio Township',
     '4312': 'Bradford West Gwillimbury Town',
     '4316': 'Innisfil Town',
@@ -145,12 +159,14 @@ export const rollNumberMunicipalities = Object.freeze({
     '4368': 'Tiny Township',
     '4372': 'Penetanguishene Town',
     '4374': 'Midland Town',
+    // District Municipality of Muskoka
     '4402': 'Gravenhurst Town',
     '4418': 'Bracebridge Town',
     '4427': 'Lake Of Bays Township',
     '4442': 'Huntsville Town',
     '4453': 'Muskoka Lakes Township',
     '4465': 'Georgian Bay Township',
+    // Regional Municipality of Niagara
     '2602': 'West Lincoln Township',
     '2615': 'Grimsby Town',
     '2622': 'Lincoln Town',
@@ -163,11 +179,14 @@ export const rollNumberMunicipalities = Object.freeze({
     '2725': 'Niagara Falls City',
     '2731': 'Thorold City',
     '2732': 'Pelham Town',
+    // Regional Municipality of Hamilton
     '2518': 'Hamilton City',
+    // City of Brantford, Brant, Haldimand County and Norfolk Counties
     '2810': 'Haldimand County',
     '2906': 'Brantford City',
     '2920': 'County Of Brant',
     '3310': 'Norfolk County',
+    // Regional Municipality of Waterloo, the Counties of Dufferin and Wellington, and the City of Guelph
     '2201': 'East Garafraxa Township',
     '2204': 'Grand Valley Town',
     '2208': 'Amaranth Township',
@@ -191,6 +210,7 @@ export const rollNumberMunicipalities = Object.freeze({
     '3018': 'Wilmot Township',
     '3024': 'Wellesley Township',
     '3029': 'Woolwich Township',
+    // Elgin, Middlesex and Oxford Counties
     '3202': 'Norwich Township',
     '3204': 'Tillsonburg Town',
     '3211': 'South-west Oxford Township',
@@ -216,6 +236,7 @@ export const rollNumberMunicipalities = Object.freeze({
     '3946': 'Adelaide Metcalfe Township',
     '3954': 'North Middlesex Municipality',
     '3958': 'Lucan Biddulph Township',
+    // Huron and Perth Counties
     '3110': 'Perth East Township',
     '3111': 'Stratford City',
     '3116': 'St Marys Town',
@@ -231,6 +252,7 @@ export const rollNumberMunicipalities = Object.freeze({
     '4050': 'North Huron Township',
     '4060': 'Morris-turnberry Municipality',
     '4070': 'Ashfield-colborne-wawanosh Township',
+    // Bruce and Grey Counties
     '4102': 'South Bruce Peninsula Town',
     '4103': 'Arran-elderslie Municipality',
     '4104': 'Brockton Municipality',
@@ -248,6 +270,7 @@ export const rollNumberMunicipalities = Object.freeze({
     '4229': 'Hanover Town',
     '4242': 'Blue Mountains Town',
     '4259': 'Owen Sound City',
+    // Municipality of Chatham-Kent, Lambton County
     '3650': 'Chatham-kent Municipality',
     '3805': 'St Clair Township',
     '3806': 'Dawn-euphemia Township',
@@ -260,6 +283,7 @@ export const rollNumberMunicipalities = Object.freeze({
     '3835': 'Plympton-wyoming Town',
     '3841': 'Warwick Township',
     '3845': 'Lambton Shores Municipality',
+    // Essex County
     '3701': 'Peele Township',
     '3706': 'Leamington Municipality',
     '3711': 'Kingsville Town',
@@ -269,6 +293,7 @@ export const rollNumberMunicipalities = Object.freeze({
     '3744': 'Tecumseh Town',
     '3751': 'Lakeshore Town',
     '3754': 'Essex Town',
+    // Territorial Districts of Nipissing and Parry Sound
     '4801': 'South Algonquin Township',
     '4803': 'Province Of Ontario',
     '4816': 'Papineau-cameron Township',
@@ -307,6 +332,7 @@ export const rollNumberMunicipalities = Object.freeze({
     '4995': 'Province Of Ontario',
     '4998': 'Province Of Ontario',
     '4999': 'Province Of Ontario',
+    // Territorial Districts of Cochrane and Timiskaming
     '5401': 'Coleman Township',
     '5406': 'Latchford Town',
     '5408': 'Cobalt Town',
@@ -351,6 +377,7 @@ export const rollNumberMunicipalities = Object.freeze({
     '5676': 'Hearst Town',
     '5677': 'Mattice-val Cote Township',
     '5699': 'Province Of Ontario',
+    // Regional Municipality of Sudbury and the Territorial Districts of Sudbury and Manitoulin
     '5101': 'Tehkummah Township',
     '5102': 'Province Of Ontario',
     '5104': 'Central Manitoulin Municipality',
@@ -379,6 +406,7 @@ export const rollNumberMunicipalities = Object.freeze({
     '5298': 'Province Of Ontario',
     '5299': 'Province Of Ontario',
     '5307': 'Greater Sudbury City',
+    // Territorial District of Algoma
     '5701': 'Jocelyn Township',
     '5704': 'Hilton Township',
     '5706': 'Hilton Beach Village',
@@ -403,6 +431,7 @@ export const rollNumberMunicipalities = Object.freeze({
     '5791': 'White River Township',
     '5796': 'Hornepayne Township',
     '5799': 'Province Of Ontario',
+    // Territorials District of Kenora, Rainy River and Thunder Bay
     '5801': 'Neebing Municipality',
     '5803': 'Province Of Ontario',
     '5804': 'Thunder Bay City',

package/rollNumbers/utilities.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Validates a roll number.
+ * @param rollNumber - The roll number to validate
+ * @returns True if the roll number is valid, false otherwise
+ */
 export declare function validateRollNumber(rollNumber: string): boolean;
 export interface ParsedRollNumber {
     county?: string;
@@ -9,4 +14,9 @@ export interface ParsedRollNumber {
     parcelSub: string;
     primarySubordinate: string;
 }
+/**
+ * Parses a roll number into its component parts.
+ * @param rollNumber - The roll number to parse
+ * @returns An object containing the parsed roll number components
+ */
 export declare function parseRollNumber(rollNumber: string): ParsedRollNumber;

package/rollNumbers/utilities.js

@@ -1,9 +1,20 @@
+/* eslint-disable @typescript-eslint/no-magic-numbers */
 import { rollNumberMunicipalities } from './lookups.js';
+/**
+ * Validates a roll number.
+ * @param rollNumber - The roll number to validate
+ * @returns True if the roll number is valid, false otherwise
+ */
 export function validateRollNumber(rollNumber) {
     return (/^\d{15}$/.test(rollNumber) ||
         (/^\d{19}$/.test(rollNumber) &&
             Object.keys(rollNumberMunicipalities).includes(rollNumber.slice(0, 4))));
 }
+/**
+ * Parses a roll number into its component parts.
+ * @param rollNumber - The roll number to parse
+ * @returns An object containing the parsed roll number components
+ */
 export function parseRollNumber(rollNumber) {
     if (!validateRollNumber(rollNumber)) {
         throw new Error(`Invalid roll number: ${rollNumber}`);

package/rollNumbers/utilities.ts

@@ -1,4 +1,3 @@
-// eslint-disable-next-line @eslint-community/eslint-comments/disable-enable-pair
 /* eslint-disable @typescript-eslint/no-magic-numbers */
 
 import { rollNumberMunicipalities } from './lookups.js'

package/CODE_OF_CONDUCT.md

@@ -1,140 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual
-identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-- Demonstrating empathy and kindness toward other people
-
-- Being respectful of differing opinions, viewpoints, and experiences
-
-- Giving and gracefully accepting constructive feedback
-
-- Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-
-- Focusing on what is best not just for us as individuals, but for the overall
-  community
-
-Examples of unacceptable behavior include:
-
-- The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
-
-- Trolling, insulting or derogatory comments, and personal or political attacks
-
-- Public or private harassment
-
-- Publishing others' private information, such as a physical or email address,
-  without their explicit permission
-
-- Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-**corporateapps@cityssm.on.ca**.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of
-actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or permanent
-ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the
-community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][mozilla coc].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][faq]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[mozilla coc]: https://github.com/mozilla/diversity
-[faq]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

package/CONTRIBUTING.md

@@ -1,33 +0,0 @@
-### Thank you for your interest in making this project better!
-
-Together, we can build high quality software that meets the needs of municipalities,
-while remaining open and budget conscious.
-
-**Thank you for taking the time to read the contributing guidelines.**
-
-### All contributions are welcome
-
-Being a very small team, contributions are greatly appreciated. How can you contribute?
-
-- **Promote this project!**
-- Documentation and tutorials
-- Submit bug reports (or fix them!)
-- Request new features (or build them!)
-
-### Please Read the Code of Conduct
-
-The [Code of Conduct](CODE_OF_CONDUCT.md) document describes how we should act when working together.
-Be nice! :smile:
-
-### How to report a bug or suggest an enhancement
-
-**If you find a security vulnerability, do NOT open an issue. Email
-<corporateapps@cityssm.on.ca> instead.**
-
-For all other bug reports, feature requests, or enhancements,
-open an issue and use the closest template.
-
-### Thanks Again
-
-We are a very small team with big aspirations and limited resources.
-Thank you for helping with this project in any way you can!

package/SECURITY.md

@@ -1,15 +0,0 @@
-# Security Policy
-
-**Thank you for your interest in keeping this project safe for everyone.**
-
-## Supported Versions
-
-Due to limited resources, only the latest version is supported only for security updates.
-
-## Reporting a Vulnerability
-
-To report a security vulnerability,
-please email <corporateapps@cityssm.on.ca>.
-
-Every attempt will be made to resolve confirmed vulnerabilities
-in a timely manner.