anz-legislation 1.2.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,23 @@
+# ANZ Legislation
+
+This package publishes the ANZ-first install path for the **ANZ Legislation**
+product while preserving the same runtime payload as `nz-legislation-tool`.
+
+## Install
+
+```bash
+npm install -g anz-legislation
+```
+
+## Binaries
+
+- `anzlegislation`
+- `anzlegislation-mcp`
+- `nzlegislation`
+- `nzlegislation-mcp`
+
+The legacy binary names remain available during the compatibility window.
+
+## Repository
+
+Current repository: https://github.com/edithatogo/anz-legislation.git

package/dist/cli.d.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+/**
+ * ANZ Legislation CLI
+ * Command-line interface for searching and retrieving legislation data
+ */
+export {};

package/dist/cli.js

@@ -0,0 +1,198 @@
+#!/usr/bin/env node
+/**
+ * ANZ Legislation CLI
+ * Command-line interface for searching and retrieving legislation data
+ */
+import chalk from 'chalk';
+import { Command } from 'commander';
+import { batchCommand } from './commands/batch.js';
+import { cacheCommand } from './commands/cache.js';
+import { citeCommand } from './commands/cite.js';
+import { configCommand } from './commands/config.js';
+import { exportCommand } from './commands/export.js';
+import { createGenerateCommand } from './commands/generate.js';
+import { getCommand } from './commands/get.js';
+import { createInteractiveHelpCommand, createContextualHelpCommand } from './commands/help.js';
+import { searchCommand } from './commands/search.js';
+import { streamCommand } from './commands/stream.js';
+import { getConfig } from './config.js';
+import { ApplicationError, ErrorCode, getUserFriendlyMessage } from './errors.js';
+import { initializeProviders } from './providers/index.js';
+import { detectCliBinaryName, getAlternateCliBinaryName } from './utils/invocation.js';
+import { logger } from './utils/logger.js';
+import { buildCliHelpFooter } from './utils/presentation.js';
+// Get package version from package.json
+const pkg = await import('../package.json', { with: { type: 'json' } });
+// Initialize providers with config
+initializeProviders({
+    commonwealthApiKey: process.env.COMMONWEALTH_API_KEY,
+    queenslandApiKey: process.env.QUEENSLAND_API_KEY,
+});
+// Create main CLI program
+const program = new Command();
+const invokedCliName = detectCliBinaryName();
+const alternateCliName = getAlternateCliBinaryName(invokedCliName);
+program
+    .name(invokedCliName)
+    .description('Search and retrieve legislation data across jurisdictions')
+    .version(pkg.default.version)
+    .configureHelp({
+    sortOptions: true,
+    sortSubcommands: true,
+})
+    .addHelpText('after', buildCliHelpFooter(invokedCliName, alternateCliName));
+// Add global options
+program
+    .option('--verbose', 'Enable verbose output')
+    .option('--quiet', 'Suppress non-essential output')
+    .option('-j, --jurisdiction <id>', 'Jurisdiction identifier (nz, au-comm, au-qld)', 'nz');
+// Add commands
+program
+    .addCommand(searchCommand)
+    .addCommand(getCommand)
+    .addCommand(exportCommand)
+    .addCommand(citeCommand)
+    .addCommand(configCommand)
+    .addCommand(cacheCommand)
+    .addCommand(batchCommand)
+    .addCommand(streamCommand)
+    .addCommand(createInteractiveHelpCommand())
+    .addCommand(createContextualHelpCommand())
+    .addCommand(createGenerateCommand());
+// Pre-command hook to check configuration
+program.hook('preAction', (thisCommand, actionCommand) => {
+    // Skip config check for config command itself
+    if (actionCommand.name() === 'config') {
+        return;
+    }
+    const config = getConfig();
+    if (!config.apiKey || config.apiKey === 'your_api_key_here') {
+        logger.warn('API key not configured.');
+        logger.warn(`Run "${invokedCliName} config" to set up your API key.\n`);
+    }
+    // Apply global options
+    if (thisCommand.opts().verbose) {
+        logger.setVerbose(true);
+        config.verbose = true;
+    }
+});
+/**
+ * Global error boundary - catches all unhandled errors
+ */
+function handleError(error) {
+    logger.clearOldLogs(7);
+    if (error instanceof ApplicationError) {
+        logger.error(getUserFriendlyMessage(error), error);
+        displayErrorWithSuggestions(error);
+        process.exit(getExitCode(error.code));
+    }
+    if (error instanceof Error) {
+        logger.error('An unexpected error occurred', error);
+        console.error(chalk.red('\n💥 Unexpected error:'), error.message);
+        console.error(chalk.yellow('\nSuggestions:'));
+        console.error(chalk.white('  1. Run with --verbose for more details'));
+        console.error(chalk.white('  2. Check the log file:'), chalk.gray(logger.getLogFile()));
+        console.error(chalk.white('  3. If the issue persists, report it on GitHub'));
+        process.exit(1);
+    }
+    logger.error('An unknown error occurred');
+    console.error(chalk.red('\n💥 An unknown error occurred'));
+    process.exit(1);
+}
+/**
+ * Display error with actionable suggestions based on error type
+ */
+function displayErrorWithSuggestions(error) {
+    console.error(chalk.red(`\n❌ ${error.message}\n`));
+    console.error(chalk.yellow('Suggestions:'));
+    switch (error.code) {
+        case ErrorCode.CONFIG_API_KEY_MISSING:
+        case ErrorCode.CONFIG_NOT_FOUND:
+            console.error(chalk.white('  1. Run ') +
+                chalk.cyan(`${invokedCliName} config`) +
+                chalk.white(' to set up your API key'));
+            console.error(chalk.white('  2. Or set environment variable ') + chalk.cyan('NZ_LEGISLATION_API_KEY'));
+            console.error(chalk.white('  3. Get your API key from https://api.legislation.govt.nz'));
+            break;
+        case ErrorCode.API_AUTHENTICATION_FAILED:
+            console.error(chalk.white('  1. Check your API key is correct'));
+            console.error(chalk.white('  2. Run ') +
+                chalk.cyan(`${invokedCliName} config --show`) +
+                chalk.white(' to verify'));
+            console.error(chalk.white('  3. Contact API support if the issue persists'));
+            break;
+        case ErrorCode.API_NOT_FOUND:
+            console.error(chalk.white('  1. Check the work ID is correct'));
+            console.error(chalk.white('  2. Use ') +
+                chalk.cyan(`${invokedCliName} search`) +
+                chalk.white(' to find the correct ID'));
+            console.error(chalk.white('  3. Verify the legislation exists on the NZ Legislation website'));
+            break;
+        case ErrorCode.API_RATE_LIMIT_EXCEEDED:
+            console.error(chalk.white('  1. Wait a few minutes before trying again'));
+            console.error(chalk.white('  2. Reduce the frequency of your requests'));
+            console.error(chalk.white('  3. Consider using the --limit flag to batch requests'));
+            break;
+        case ErrorCode.API_TIMEOUT:
+        case ErrorCode.NETWORK_OFFLINE:
+        case ErrorCode.NETWORK_CONNECTION_REFUSED:
+            console.error(chalk.white('  1. Check your internet connection'));
+            console.error(chalk.white('  2. Verify the API is accessible at ') +
+                chalk.cyan('https://api.legislation.govt.nz'));
+            console.error(chalk.white('  3. Try again in a few moments'));
+            break;
+        case ErrorCode.FILE_WRITE_FAILED:
+        case ErrorCode.FILE_NOT_FOUND:
+            console.error(chalk.white('  1. Check the file path is correct'));
+            console.error(chalk.white('  2. Verify you have write permissions'));
+            console.error(chalk.white('  3. Ensure the output directory exists'));
+            break;
+        case ErrorCode.VALIDATION_FAILED:
+        case ErrorCode.VALIDATION_INVALID_ID:
+            console.error(chalk.white('  1. Check the format of your input'));
+            console.error(chalk.white('  2. Use ') + chalk.cyan('--help') + chalk.white(' to see valid options'));
+            console.error(chalk.white('  3. Example: ') +
+                chalk.cyan(`${invokedCliName} get "act_public_1989_18"`));
+            break;
+        default:
+            console.error(chalk.white('  1. Run with ') + chalk.cyan('--verbose') + chalk.white(' for more details'));
+            console.error(chalk.white('  2. Check the log file: ') + chalk.gray(logger.getLogFile()));
+            console.error(chalk.white('  3. Report the issue on GitHub with the error details'));
+            break;
+    }
+    console.error(chalk.gray(`\nError Code: ${ErrorCode[error.code]} (${error.code})`));
+    console.error(chalk.gray(`Log File: ${logger.getLogFile()}`));
+}
+/**
+ * Get exit code based on error type
+ */
+function getExitCode(code) {
+    if (code >= ErrorCode.API_AUTHENTICATION_FAILED && code < ErrorCode.CONFIG_NOT_FOUND) {
+        return 1; // API errors (1000-1999)
+    }
+    if (code >= ErrorCode.CONFIG_NOT_FOUND && code < ErrorCode.VALIDATION_FAILED) {
+        return 2; // Config errors (2000-2999)
+    }
+    if (code >= ErrorCode.VALIDATION_FAILED && code < ErrorCode.FILE_NOT_FOUND) {
+        return 3; // Validation errors (3000-3999)
+    }
+    if (code >= ErrorCode.FILE_NOT_FOUND && code < ErrorCode.NETWORK_OFFLINE) {
+        return 4; // File system errors (4000-4999)
+    }
+    if (code >= ErrorCode.NETWORK_OFFLINE && code < ErrorCode.UNKNOWN) {
+        return 5; // Network errors (5000-5999)
+    }
+    return 1; // Default
+}
+// Set up global error handler
+process.on('uncaughtException', handleError);
+process.on('unhandledRejection', reason => {
+    handleError(reason instanceof Error ? reason : new Error(String(reason)));
+});
+// Parse command line arguments
+program.parse();
+// Show help if no command provided
+if (!process.argv.slice(2).length) {
+    program.outputHelp();
+    process.exit(0);
+}

package/dist/client.d.ts

@@ -0,0 +1,84 @@
+/**
+ * API Client for NZ Legislation API
+ * Handles HTTP requests, authentication, rate limiting, and caching
+ */
+import { type LegislationVersion, type SearchResults, type Version, type Work } from '@models';
+/**
+ * Cache metrics for observability
+ */
+interface CacheMetrics {
+    hits: number;
+    misses: number;
+    evictions: number;
+    sets: number;
+}
+declare const cacheMetrics: CacheMetrics;
+interface HttpResponseLike {
+    json(): Promise<unknown>;
+}
+interface HttpClientLike {
+    get(url: string, options?: Record<string, unknown>): HttpResponseLike;
+}
+type HttpClientFactory = () => HttpClientLike;
+/**
+ * Clear cache (optionally by pattern)
+ */
+export declare function clearCache(pattern?: string): void;
+/**
+ * Get cache statistics
+ */
+export declare function getCacheStats(): {
+    size: number;
+    maxSize: number;
+    metrics: typeof cacheMetrics;
+    hitRate: string;
+    keys: string[];
+};
+/**
+ * Reset cache metrics (for testing)
+ */
+export declare function resetCacheMetrics(): void;
+export declare function setHttpClientFactoryForTesting(factory?: HttpClientFactory): void;
+/**
+ * Search for legislation works
+ */
+export declare function searchWorks(params: {
+    query?: string;
+    type?: string;
+    status?: string;
+    from?: string;
+    to?: string;
+    limit?: number;
+    offset?: number;
+}): Promise<SearchResults>;
+/**
+ * Get a specific work by ID
+ */
+export declare function getWork(workId: string): Promise<Work>;
+/**
+ * Get all versions of a work
+ */
+export declare function getWorkVersions(workId: string): Promise<Version[]>;
+/**
+ * Get a specific version of a work
+ */
+export declare function getVersion(versionId: string): Promise<LegislationVersion>;
+/**
+ * Get rate limit status
+ */
+export declare function getRateLimitStatus(): {
+    remaining: number;
+    resetTime: Date;
+    burstRemaining: number;
+    burstResetTime: Date;
+};
+/**
+ * Get cache metrics
+ */
+export declare function getCacheMetrics(): {
+    hits: number;
+    misses: number;
+    evictions: number;
+    sets: number;
+};
+export {};