@cityssm/mpac-tools 0.1.0

package/CODE_OF_CONDUCT.md

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

@@ -0,0 +1,33 @@
+### 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/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2025 The City of Sault Ste. Marie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,59 @@
+# MPAC Tools for Node
+
+_This project is not endorsed by the [Municipal Property Assessment Corporation (MPAC)](https://www.mpac.ca)._
+
+_Lookups and utilities for working with MPAC data._
+
+## Installation
+
+```bash
+npm install @cityssm/mpac-tools
+```
+
+## Usage
+
+```javascript
+import * as mpacTools from '@cityssm/mpac-tools'
+
+/*
+ * Validate 15-digit roll numbers.
+ */
+
+console.log(mpacTools.validateRollNumber('123456789012345'))
+// => true
+
+/*
+ * Validate 19-digit roll numbers,
+ * ensuring the first four digits is a valid municipality.
+ */
+
+console.log(mpacTools.validateRollNumber('5761010000000000000'))
+// => true
+
+/*
+ * Parse a roll number into its parts.
+ */
+
+console.log(mpacTools.parseRollNumber('5761123456789012345'))
+/*
+  => {
+    county: '57',
+    municipality: '61',
+    mapArea: '12',
+    mapDivision: '3',
+    mapSubdivision: '456',
+    parcel: '789',
+    parcelSub: '01',
+    primarySubordinate: '2345'
+  }
+ */
+```
+
+## Related Projects
+
+[**MPAC Year-End Tax File (YETF) Parser**](https://www.npmjs.com/package/@cityssm/mpac-yetf)<br />
+Takes an MPAC Year End Tax File (YETF) and parses it into usable objects.
+
+🔒 **MPAC Web Services for Node**<br />
+An unofficial wrapper around MPAC Web Services.
+_Restricted by classified documentation._

package/SECURITY.md

@@ -0,0 +1,15 @@
+# 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.

package/index.d.ts

@@ -0,0 +1 @@
+export * from './rollNumbers/utilities.js';

package/index.js

@@ -0,0 +1 @@
+export * from './rollNumbers/utilities.js';

package/index.ts

@@ -0,0 +1 @@
+export * from './rollNumbers/utilities.js'

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@cityssm/mpac-tools",
+  "version": "0.1.0",
+  "description": "Lookups and utilities for working with MPAC data.",
+  "keywords": [
+    "mpac",
+    "ontario",
+    "government",
+    "property-assessment",
+    "roll-number"
+  ],
+  "homepage": "https://github.com/cityssm/node-mpac-tools#readme",
+  "bugs": {
+    "url": "https://github.com/cityssm/node-mpac-tools/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cityssm/node-mpac-tools.git"
+  },
+  "license": "MIT",
+  "author": "The Corporation of the City of Sault Ste. Marie",
+  "type": "module",
+  "exports": {
+    ".": "./index.js",
+    "./rollNumbers": "./rollNumbers/index.js"
+  },
+  "scripts": {
+    "test": "node --test"
+  },
+  "devDependencies": {
+    "@types/node": "^24.5.2",
+    "eslint-config-cityssm": "^29.1.1",
+    "prettier-config-cityssm": "^1.0.0"
+  }
+}

package/rollNumbers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lookups.js';
+export * from './utilities.js';

package/rollNumbers/index.js

@@ -0,0 +1,2 @@
+export * from './lookups.js';
+export * from './utilities.js';

package/rollNumbers/index.ts

@@ -0,0 +1,2 @@
+export * from './lookups.js'
+export * from './utilities.js'