comic-vine-sdk 1.3.2 → 2.0.0

package/.releaserc.json

@@ -1,17 +0,0 @@
-{
-  "branches": [
-    "+([0-9])?(.{+([0-9]),x}).x",
-    "main",
-    "next",
-    { "name": "alpha", "prerelease": true },
-    { "name": "beta", "prerelease": true }
-  ],
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    "@semantic-release/changelog",
-    "@semantic-release/npm",
-    "@semantic-release/github",
-    "@semantic-release/git"
-  ]
-}

package/CHANGELOG.md

@@ -1,97 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
-
-### [1.3.2](https://github.com/AllyMurray/comic-vine/compare/v1.3.1...v1.3.2) (2025-07-03)
-
-## [1.2.8] - 2024-01-01
-
-### Changed
-
-- Migrated from Projen to standard npm project structure
-- Updated GitHub Actions workflows to use artifact actions v4
-- Improved build process and release workflow
-
-## [1.2.5](https://github.com/AllyMurray/comic-vine/compare/v1.2.4...v1.2.5) (2023-03-18)
-
-### Bug Fixes
-
-- upgrade zod from 3.20.2 to 3.20.5 ([31755e7](https://github.com/AllyMurray/comic-vine/commit/31755e711b7a61fced6da6554461b45f4db43046))
-- upgrade zod from 3.20.5 to 3.20.6 ([4c32d5b](https://github.com/AllyMurray/comic-vine/commit/4c32d5b8f8d94da50a1a4c456f360dbe9d53beaf))
-
-## [1.2.4](https://github.com/AllyMurray/comic-vine/compare/v1.2.3...v1.2.4) (2023-01-31)
-
-### Bug Fixes
-
-- :package: publish typings to npm ([f132dd6](https://github.com/AllyMurray/comic-vine/commit/f132dd6e3d8a2983e5e8b20434c6d491123503e4))
-
-## [1.2.3](https://github.com/AllyMurray/comic-vine/compare/v1.2.2...v1.2.3) (2023-01-22)
-
-### Bug Fixes
-
-- upgrade zod from 3.19.1 to 3.20.2 ([4576f78](https://github.com/AllyMurray/comic-vine/commit/4576f78a34a5470274da2d384814bf8f85e977fe))
-
-## [1.2.2](https://github.com/AllyMurray/comic-vine/compare/v1.2.1...v1.2.2) (2022-12-04)
-
-### Bug Fixes
-
-- **typo in pagination example:** typo in pagination example ([3b3d3c5](https://github.com/AllyMurray/comic-vine/commit/3b3d3c5b30ce42672767f1a17d78b792a6dc3a0f))
-
-## [1.2.1](https://github.com/AllyMurray/comic-vine/compare/v1.2.0...v1.2.1) (2022-12-04)
-
-### Bug Fixes
-
-- **auto pagination example:** fixes the autopagination example so limit is set to 50 ([a198408](https://github.com/AllyMurray/comic-vine/commit/a19840857a67c71f8cd671f47335b8c7a6f28f4d))
-
-# [1.2.0](https://github.com/AllyMurray/comic-vine/compare/v1.1.1...v1.2.0) (2022-12-04)
-
-### Features
-
-- **auto pagination:** add auto pagination to list methods ([a5fa379](https://github.com/AllyMurray/comic-vine/commit/a5fa379e9cc267552741aa5f82c06b8242f55856))
-
-## [1.1.1](https://github.com/AllyMurray/comic-vine/compare/v1.1.0...v1.1.1) (2022-10-15)
-
-### Bug Fixes
-
-- **options docs:** add missing documentation for setting baseUrl ([6954695](https://github.com/AllyMurray/comic-vine/commit/6954695b6d3322fde38258fcc1f50fc6a83aa72e))
-
-# [1.1.0](https://github.com/AllyMurray/comic-vine/compare/v1.0.4...v1.1.0) (2022-10-15)
-
-### Features
-
-- **library options:** allow setting baseUrl when initializing the library ([07fe7e3](https://github.com/AllyMurray/comic-vine/commit/07fe7e3905bea006b8a15dc0b545a0ae1f53f084))
-
-## [1.0.4](https://github.com/AllyMurray/comic-vine/compare/v1.0.3...v1.0.4) (2022-10-08)
-
-### Bug Fixes
-
-- **typings:** improve the api response typings ([e5bf556](https://github.com/AllyMurray/comic-vine/commit/e5bf5561149e1cff6e0c538dacf3c8fc71b6c935))
-
-## [1.0.3](https://github.com/AllyMurray/comic-vine/compare/v1.0.2...v1.0.3) (2022-10-07)
-
-### Bug Fixes
-
-- **tsconfig.json:** remove comments so that the file can be parsed by snyk ([fe715f7](https://github.com/AllyMurray/comic-vine/commit/fe715f72840bce8247c0550c21fa45d555b7990f))
-
-## [1.0.2](https://github.com/AllyMurray/comic-vine/compare/v1.0.1...v1.0.2) (2022-10-07)
-
-### Bug Fixes
-
-- **character details typings:** birth can be null or string, change any arrays to SiteResource array ([5a69bd3](https://github.com/AllyMurray/comic-vine/commit/5a69bd3b6394b2a389cdf7c5b9b4713350788fb8))
-
-## [1.0.1](https://github.com/AllyMurray/comic-vine/compare/v1.0.0...v1.0.1) (2022-10-05)
-
-### Bug Fixes
-
-- **ts build:** update typescript typings to remove false positives in vscode problems window ([ece4080](https://github.com/AllyMurray/comic-vine/commit/ece4080370be2635712b1978f2e6d7f6c88ddc40))
-
-# [1.0.0](https://github.com/AllyMurray/comic-vine/compare/efa0a077ec5104451fc33ab773d888bb79f6438f...v1.0.0) (2022-09-30)
-
-### Bug Fixes
-
-- **npm publish:** rename npm package ([37eb3a1](https://github.com/AllyMurray/comic-vine/commit/37eb3a17b9b8cd1c58e09b2efcb1380e10124d14))
-- **npm publish:** rename npm package to comic-vine-sdk ([26fe0d8](https://github.com/AllyMurray/comic-vine/commit/26fe0d8321c7ed4df57664e5006a798e296b17dc))
-
-### Features
-
-- **gh workflow:** automate release to npm ([efa0a07](https://github.com/AllyMurray/comic-vine/commit/efa0a077ec5104451fc33ab773d888bb79f6438f))

package/CODE_OF_CONDUCT.md

@@ -1,128 +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, 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
-allymurray88@gmail.com.
-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.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -1,294 +0,0 @@
-# Contributing to Comic Vine SDK
-
-Thank you for your interest in contributing to the Comic Vine SDK! This document provides guidelines and information to help you contribute effectively to the project.
-
-## Table of Contents
-
-- [Code of Conduct](#code-of-conduct)
-- [Getting Started](#getting-started)
-- [Development Setup](#development-setup)
-- [Development Workflow](#development-workflow)
-- [Code Standards](#code-standards)
-- [Testing](#testing)
-- [Submitting Changes](#submitting-changes)
-- [Project Structure](#project-structure)
-- [Resources](#resources)
-
-## Code of Conduct
-
-This project adheres to a [Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [allymurray88@gmail.com](mailto:allymurray88@gmail.com).
-
-## Getting Started
-
-### Prerequisites
-
-Before you begin, ensure you have the following installed:
-
-- **Node.js**: Version 20.0.0 or higher
-- **pnpm**: Version 9.15.4+ (specified in package.json)
-  ```bash
-  npm install -g pnpm@9.15.4
-  ```
-
-### Development Setup
-
-1. **Fork and Clone**
-
-   ```bash
-   git clone https://github.com/your-username/comic-vine.git
-   cd comic-vine
-   ```
-
-2. **Install Dependencies**
-
-   ```bash
-   pnpm install
-   ```
-
-3. **Verify Setup**
-   ```bash
-   pnpm test
-   ```
-
-If all tests pass, you're ready to start developing!
-
-## Development Workflow
-
-### Creating a Branch
-
-1. Create a feature branch from `main`:
-
-   ```bash
-   git checkout -b feature/your-feature-name
-   # or
-   git checkout -b fix/issue-description
-   ```
-
-2. Use descriptive branch names:
-   - `feature/add-search-pagination`
-   - `fix/handle-rate-limiting`
-   - `docs/update-readme-examples`
-
-### Making Changes
-
-1. **Write Code**: Follow the [Code Standards](#code-standards) below
-2. **Add Tests**: Ensure new functionality has corresponding tests
-3. **Run Tests**: `pnpm test` to run tests and linting
-4. **Build**: `pnpm compile` to ensure your changes compile correctly
-
-### Commit Messages
-
-Follow conventional commit format:
-
-```
-type(scope): description
-
-[optional body]
-
-[optional footer]
-```
-
-**Types:**
-
-- `feat`: New feature
-- `fix`: Bug fix
-- `docs`: Documentation changes
-- `style`: Code style changes (formatting, etc.)
-- `refactor`: Code refactoring
-- `test`: Adding or updating tests
-- `chore`: Maintenance tasks
-
-**Examples:**
-
-```
-feat(resources): add pagination support to character list
-fix(http-client): handle network timeout errors
-docs(readme): update installation instructions
-```
-
-## Code Standards
-
-### TypeScript Guidelines
-
-- **Type Safety**: Prefer explicit types over `any`
-- **Interfaces**: Use interfaces for object shapes
-- **Generics**: Leverage generics for reusable components
-- **Strict Mode**: The project uses strict TypeScript settings
-
-### Code Style
-
-The project uses **ESLint** and **Prettier** for code formatting:
-
-```bash
-# Auto-fix linting issues and format code
-pnpm lint
-
-# Check linting without fixing
-npx eslint src --ext .ts
-```
-
-**Key Style Rules:**
-
-- Use camelCase for variables and functions
-- Use PascalCase for classes and interfaces
-- Prefer `const` over `let` when possible
-- Use meaningful variable names
-- Add JSDoc comments for public APIs
-
-### Import Organization
-
-Imports should be organized as follows:
-
-```typescript
-// 1. Built-in Node.js modules
-import { readFile } from 'fs/promises';
-
-// 2. External dependencies
-import axios from 'axios';
-import { z } from 'zod';
-
-// 3. Internal modules (ordered alphabetically)
-import { BaseResource } from './base-resource';
-import { HttpClient } from './http-client';
-```
-
-## Testing
-
-### Running Tests
-
-```bash
-# Run all tests with linting
-pnpm test
-
-# Run tests only (without linting)
-pnpm test:run
-
-# Run tests in watch mode
-npx vitest --dir=src
-```
-
-### Writing Tests
-
-1. **Location**: Place test files alongside source files with `.test.ts` extension
-2. **Naming**: Use descriptive test names that explain the behavior being tested
-3. **Structure**: Follow Arrange-Act-Assert pattern
-
-**Example Test:**
-
-```typescript
-import { describe, test, expect } from 'vitest';
-
-describe('ResourceName', () => {
-  test('should return correct data when field list is specified', async () => {
-    // Arrange
-    const expectedFields = ['id', 'name'];
-
-    // Act
-    const result = await resource.retrieve(123, { fieldList: expectedFields });
-
-    // Assert
-    expect(Object.keys(result)).toEqual(expectedFields);
-  });
-});
-```
-
-### Test Coverage
-
-- Write tests for all new functionality
-- Include both success and error scenarios
-- Mock external dependencies using **nock** for HTTP requests
-- Test files are located in `src/__mocks__/` for mock data
-
-## Submitting Changes
-
-### Pull Request Process
-
-1. **Update Documentation**: Ensure README, JSDoc, and other docs reflect your changes
-
-2. **Verify Quality Checks**: All checks must pass before merging
-
-   ```bash
-   pnpm test:run  # All tests pass
-   pnpm lint      # No linting errors
-   pnpm compile   # Code compiles successfully
-   ```
-
-3. **Create Pull Request**:
-   - Use a descriptive title
-   - Reference any related issues
-   - Provide clear description of changes
-   - Include examples if adding new features
-
-4. **Review Process**:
-   - Maintainers will review your PR
-   - Address any feedback promptly
-   - See [CODE_REVIEW.md](./CODE_REVIEW.md) for review criteria
-
-### Pre-commit Hooks
-
-The project uses **Husky** and **lint-staged** to ensure code quality:
-
-- **Auto-formatting**: Prettier formats code on commit
-- **Linting**: ESLint checks are enforced
-- **Type checking**: TypeScript compilation is verified
-
-If pre-commit hooks fail, fix the issues before committing:
-
-```bash
-pnpm lint  # Fix linting issues
-git add .  # Stage the fixes
-git commit # Try committing again
-```
-
-## Project Structure
-
-```
-src/
-├── comic-vine.ts              # Main SDK class
-├── errors/                    # Custom error classes
-├── http-client/               # HTTP client and URL builder
-├── options/                   # Configuration options
-├── resources/                 # API resource implementations
-│   ├── base-resource.ts       # Base class for all resources
-│   ├── character/             # Character-specific code
-│   ├── issue/                 # Issue-specific code
-│   └── ...                    # Other Comic Vine resources
-├── types/                     # TypeScript type definitions
-└── utils/                     # Utility functions
-```
-
-### Adding New Resources
-
-When adding support for a new Comic Vine API resource:
-
-1. Create a new directory under `src/resources/`
-2. Implement the resource class extending `BaseResource`
-3. Add TypeScript types in a `types/` subdirectory
-4. Write comprehensive tests
-5. Update the main `ComicVine` class to include the new resource
-6. Add mock data for testing
-
-## Resources
-
-### Documentation
-
-- [Comic Vine API Documentation](https://comicvine.gamespot.com/api/documentation)
-- [Project README](./README.md)
-- [Code Review Guidelines](./CODE_REVIEW.md)
-
-### Getting Help
-
-- **Issues**: [GitHub Issues](https://github.com/AllyMurray/comic-vine/issues)
-- **Discussions**: Use GitHub Discussions for questions
-
-### Development Tools
-
-- **Package Manager**: [pnpm](https://pnpm.io/)
-- **Testing**: [Vitest](https://vitest.dev/)
-- **Linting**: [ESLint](https://eslint.org/) + [TypeScript ESLint](https://typescript-eslint.io/)
-- **Formatting**: [Prettier](https://prettier.io/)
-- **Git Hooks**: [Husky](https://typicode.github.io/husky/)
-
----
-
-Thank you for contributing to Comic Vine SDK! Your contributions help make this library better for everyone. 🚀

package/eslint.config.js

@@ -1,168 +0,0 @@
-// @ts-check
-import eslint from '@eslint/js';
-import importPlugin from 'eslint-plugin-import';
-import prettierPlugin from 'eslint-plugin-prettier';
-import prettierConfig from 'eslint-config-prettier';
-import tseslint from 'typescript-eslint';
-import globals from 'globals';
-
-export default tseslint.config(
-  // Base ESLint recommended rules
-  eslint.configs.recommended,
-
-  // TypeScript ESLint recommended rules
-  ...tseslint.configs.recommended,
-
-  // Prettier config to disable formatting rules that conflict with Prettier
-  prettierConfig,
-
-  // Base configuration for all files
-  {
-    plugins: {
-      import: importPlugin,
-      prettier: prettierPlugin,
-    },
-
-    languageOptions: {
-      ecmaVersion: 2018,
-      sourceType: 'module',
-      globals: {
-        ...globals.node,
-      },
-    },
-
-    settings: {
-      'import/parsers': {
-        '@typescript-eslint/parser': ['.ts', '.tsx'],
-      },
-      'import/resolver': {
-        node: {},
-        typescript: {
-          project: './tsconfig.dev.json',
-          alwaysTryTypes: true,
-        },
-      },
-    },
-
-    rules: {
-      'prettier/prettier': ['error'],
-      'import/no-extraneous-dependencies': [
-        'error',
-        {
-          devDependencies: [
-            '**/test/**',
-            '**/build-tools/**',
-            '.projenrc.ts',
-            'projenrc/**/*.ts',
-          ],
-          optionalDependencies: false,
-          peerDependencies: true,
-        },
-      ],
-      'import/no-unresolved': ['error'],
-      'import/order': [
-        'warn',
-        {
-          groups: ['builtin', 'external'],
-          alphabetize: {
-            order: 'asc',
-            caseInsensitive: true,
-          },
-        },
-      ],
-      'no-duplicate-imports': ['error'],
-      'no-shadow': ['off'],
-      '@typescript-eslint/no-shadow': ['error'],
-      '@typescript-eslint/no-unused-vars': [
-        'error',
-        {
-          argsIgnorePattern: '^_',
-          varsIgnorePattern: '^_',
-          caughtErrorsIgnorePattern: '^_',
-        },
-      ],
-      'key-spacing': ['error'],
-      'no-multiple-empty-lines': ['error'],
-      '@typescript-eslint/no-floating-promises': ['error'],
-      'no-return-await': ['off'],
-      '@typescript-eslint/return-await': ['error'],
-      'no-trailing-spaces': ['error'],
-      'dot-notation': ['error'],
-      'no-bitwise': ['error'],
-      '@typescript-eslint/member-ordering': [
-        'error',
-        {
-          default: [
-            'public-static-field',
-            'public-static-method',
-            'protected-static-field',
-            'protected-static-method',
-            'private-static-field',
-            'private-static-method',
-            'field',
-            'constructor',
-            'method',
-          ],
-        },
-      ],
-    },
-  },
-
-  // Configuration for TypeScript files
-  {
-    files: ['**/*.ts', '**/*.tsx'],
-    languageOptions: {
-      parser: tseslint.parser,
-      parserOptions: {
-        ecmaVersion: 2018,
-        sourceType: 'module',
-        project: './tsconfig.dev.json',
-      },
-    },
-    rules: {
-      '@typescript-eslint/no-require-imports': ['error'],
-    },
-  },
-
-  // Configuration for test files
-  {
-    files: ['**/*.test.ts'],
-    languageOptions: {
-      globals: {
-        ...globals.vitest,
-      },
-    },
-    rules: {
-      'dot-notation': 'off',
-      'import/no-extraneous-dependencies': [
-        'error',
-        {
-          devDependencies: true,
-        },
-      ],
-    },
-  },
-
-  // Configuration for .projenrc.ts
-  {
-    files: ['.projenrc.ts'],
-    rules: {
-      '@typescript-eslint/no-require-imports': 'off',
-      'import/no-extraneous-dependencies': 'off',
-    },
-  },
-
-  // Global ignores
-  {
-    ignores: [
-      '*.js',
-      '*.d.ts',
-      'node_modules/',
-      '*.generated.ts',
-      'coverage',
-      'scripts/create-package-json.ts',
-      '!.projenrc.ts',
-      '!projenrc/**/*.ts',
-    ],
-  },
-);