comic-vine-sdk 1.2.8 → 1.3.1

package/.gitattributes

@@ -1,4 +1,3 @@
-# ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen".
 
 /.eslintrc.json linguist-generated
 /.gitattributes linguist-generated
@@ -13,9 +12,6 @@
 /.npmrc linguist-generated
 /.prettierignore linguist-generated
 /.prettierrc.json linguist-generated
-/.projen/** linguist-generated
-/.projen/deps.json linguist-generated
-/.projen/files.json linguist-generated
 /.projen/tasks.json linguist-generated
 /LICENSE linguist-generated
 /package.json linguist-generated

package/.husky/pre-commit

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 npx lint-staged

package/.prettierignore

@@ -1,2 +1 @@
-# ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen".
 scripts/create-package-json.ts

package/.projen/tasks.json

@@ -0,0 +1,261 @@
+{
+  "tasks": {
+    "build": {
+      "name": "build",
+      "description": "Full release build",
+      "steps": [
+        {
+          "spawn": "default"
+        },
+        {
+          "spawn": "pre-compile"
+        },
+        {
+          "spawn": "compile"
+        },
+        {
+          "spawn": "post-compile"
+        },
+        {
+          "spawn": "test"
+        },
+        {
+          "spawn": "package"
+        }
+      ]
+    },
+    "bump": {
+      "name": "bump",
+      "description": "Bumps version based on latest git tag and generates a changelog entry",
+      "env": {
+        "OUTFILE": "package.json",
+        "CHANGELOG": "dist/changelog.md",
+        "BUMPFILE": "dist/version.txt",
+        "RELEASETAG": "dist/releasetag.txt",
+        "RELEASE_TAG_PREFIX": ""
+      },
+      "steps": [
+        {
+          "builtin": "release/bump-version"
+        }
+      ],
+      "condition": "! git log --oneline -1 | grep -q \"chore(release):\""
+    },
+    "clobber": {
+      "name": "clobber",
+      "description": "hard resets to HEAD of origin and cleans the local repo",
+      "env": {
+        "BRANCH": "$(git branch --show-current)"
+      },
+      "steps": [
+        {
+          "exec": "git checkout -b scratch",
+          "name": "save current HEAD in \"scratch\" branch"
+        },
+        {
+          "exec": "git checkout $BRANCH"
+        },
+        {
+          "exec": "git fetch origin",
+          "name": "fetch latest changes from origin"
+        },
+        {
+          "exec": "git reset --hard origin/$BRANCH",
+          "name": "hard reset to origin commit"
+        },
+        {
+          "exec": "git clean -fdx",
+          "name": "clean all untracked files"
+        },
+        {
+          "say": "ready to rock! (unpushed commits are under the \"scratch\" branch)"
+        }
+      ],
+      "condition": "git diff --exit-code > /dev/null"
+    },
+    "compile": {
+      "name": "compile",
+      "description": "Only compile",
+      "steps": [
+        {
+          "exec": "tsc --project tsconfig.build.esm.json"
+        },
+        {
+          "exec": "ts-node ./scripts/create-package-json.ts --moduleType=\"esm\" --packageJsonType=module"
+        },
+        {
+          "exec": "tsc --project tsconfig.build.cjs.json"
+        },
+        {
+          "exec": "ts-node ./scripts/create-package-json.ts --moduleType=\"cjs\" --packageJsonType=commonjs"
+        }
+      ]
+    },
+    "default": {
+      "name": "default",
+      "description": "Synthesize project files",
+      "steps": [
+        {
+          "exec": "ts-node --project tsconfig.dev.json .projenrc.ts"
+        }
+      ]
+    },
+    "eject": {
+      "name": "eject",
+      "description": "Remove projen from the project",
+      "env": {
+        "PROJEN_EJECTING": "true"
+      },
+      "steps": [
+        {
+          "spawn": "default"
+        }
+      ]
+    },
+    "eslint": {
+      "name": "eslint",
+      "description": "Runs eslint against the codebase",
+      "steps": [
+        {
+          "exec": "eslint --ext .ts,.tsx --fix --no-error-on-unmatched-pattern src test build-tools projenrc .projenrc.ts"
+        }
+      ]
+    },
+    "install": {
+      "name": "install",
+      "description": "Install project dependencies and update lockfile (non-frozen)",
+      "steps": [
+        {
+          "exec": "pnpm i --no-frozen-lockfile"
+        }
+      ]
+    },
+    "install:ci": {
+      "name": "install:ci",
+      "description": "Install project dependencies using frozen lockfile",
+      "steps": [
+        {
+          "exec": "pnpm i --frozen-lockfile"
+        }
+      ]
+    },
+    "package": {
+      "name": "package",
+      "description": "Creates the distribution package",
+      "steps": [
+        {
+          "exec": "mkdir -p dist/js"
+        },
+        {
+          "exec": "mv $(npm pack) dist/js/"
+        }
+      ]
+    },
+    "post-compile": {
+      "name": "post-compile",
+      "description": "Runs after successful compilation"
+    },
+    "post-upgrade": {
+      "name": "post-upgrade",
+      "description": "Runs after upgrading dependencies"
+    },
+    "pre-compile": {
+      "name": "pre-compile",
+      "description": "Prepare the project for compilation"
+    },
+    "release": {
+      "name": "release",
+      "description": "Prepare a release from \"main\" branch",
+      "env": {
+        "RELEASE": "true",
+        "MIN_MAJOR": "1"
+      },
+      "steps": [
+        {
+          "exec": "rm -fr dist"
+        },
+        {
+          "spawn": "bump"
+        },
+        {
+          "spawn": "build"
+        },
+        {
+          "spawn": "unbump"
+        },
+        {
+          "exec": "git diff --ignore-space-at-eol --exit-code"
+        }
+      ]
+    },
+    "test": {
+      "name": "test",
+      "description": "Run tests",
+      "steps": [
+        {
+          "exec": "vitest --dir=src",
+          "receiveArgs": true
+        },
+        {
+          "spawn": "eslint"
+        }
+      ]
+    },
+    "unbump": {
+      "name": "unbump",
+      "description": "Restores version to 0.0.0",
+      "env": {
+        "OUTFILE": "package.json",
+        "CHANGELOG": "dist/changelog.md",
+        "BUMPFILE": "dist/version.txt",
+        "RELEASETAG": "dist/releasetag.txt",
+        "RELEASE_TAG_PREFIX": ""
+      },
+      "steps": [
+        {
+          "builtin": "release/reset-version"
+        }
+      ]
+    },
+    "upgrade": {
+      "name": "upgrade",
+      "description": "upgrade dependencies",
+      "env": {
+        "CI": "0"
+      },
+      "steps": [
+        {
+          "exec": "pnpm update npm-check-updates"
+        },
+        {
+          "exec": "npm-check-updates --upgrade --target=minor --peer --dep=dev,peer,prod,optional --filter=@ally-murray/projen-modules,@types/node,@typescript-eslint/eslint-plugin,@typescript-eslint/parser,commander,commitizen,eslint-config-prettier,eslint-import-resolver-node,eslint-import-resolver-typescript,eslint-plugin-import,eslint-plugin-prettier,eslint,husky,lint-staged,nock,npm-check-updates,prettier,projen,rimraf,standard-version,ts-node,typescript,vitest,axios,zod"
+        },
+        {
+          "exec": "pnpm i --no-frozen-lockfile"
+        },
+        {
+          "exec": "pnpm update @ally-murray/projen-modules @types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser commander commitizen eslint-config-prettier eslint-import-resolver-node eslint-import-resolver-typescript eslint-plugin-import eslint-plugin-prettier eslint husky lint-staged nock npm-check-updates prettier projen rimraf standard-version ts-node typescript vitest axios zod"
+        },
+        {
+          "exec": "npx projen"
+        },
+        {
+          "spawn": "post-upgrade"
+        }
+      ]
+    },
+    "watch": {
+      "name": "watch",
+      "description": "Watch & compile in the background",
+      "steps": [
+        {
+          "exec": "tsc --build -w"
+        }
+      ]
+    }
+  },
+  "env": {
+    "PATH": "$(pnpm -c exec \"node --print process.env.PATH\")"
+  },
+  "//": "~~ Generated by projen. To modify, edit .projenrc.ts and run \"npx projen\"."
+}

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# 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.1](https://github.com/AllyMurray/comic-vine/compare/v1.3.0...v1.3.1) (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

package/CONTRIBUTING.md

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

@@ -1,4 +1,4 @@
-Copyright (c) 2023 Ally Murray
+Copyright (c) 2025 Ally Murray
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal