release(v2.1.1-beta): add latest type declarations

* chore(api): update models and methods for latest openapi.json changes

* automate manual fixes for auto-generated type errors with diff patch file in pre-commit hook

Author: spencerlepine

.github/PULL_REQUEST_TEMPLATE.md

@@ -12,7 +12,7 @@
 - [ ] My code follows the code style of this project.
 - [ ] I have tested this code.
 - [ ] I have performed a self-review of my own code.
-- [ ] I have made corresponding changes to the documentation if needed.
+- [ ] (optional) I have made corresponding changes to the documentation
 
 ## Screenshots (if applicable)
 

.github/workflows/deploy-docs.yml

@@ -20,9 +20,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+
+      - name: Read Node version for CI from package.json
+        id: node-version
+        run: |
+          NODE_VERSION=$(jq -r '.ci.node' package.json)
+          echo "node_version=$NODE_VERSION" >> $GITHUB_OUTPUT
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: ${{ steps.node-version.outputs.node_version }}
 
       - name: Cache Yarn packages
         uses: actions/cache@v4
@@ -50,4 +58,4 @@ jobs:
         id: deployment
         uses: actions/deploy-pages@v4
         with:
-          folder: docs
+          folder: docs

.github/workflows/npm-publish.yml

@@ -13,17 +13,27 @@ on:
 env:
   RELEASE_NODE_VERSION: "18.x" # https://nodejs.dev/en/about/releases
 
+permissions:
+  contents: read
+
 jobs:
   publish-dry-run:
     runs-on: ubuntu-latest
     environment: release
 
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+
+      - name: Read Node version for CI from package.json
+        id: node-version
+        run: |
+          NODE_VERSION=$(jq -r '.ci.node' package.json)
+          echo "node_version=$NODE_VERSION" >> $GITHUB_OUTPUT
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
         with:
-          node-version: ${{ env.RELEASE_NODE_VERSION }}
-          registry-url: "https://registry.npmjs.org"
+          node-version: ${{ steps.node-version.outputs.node_version }}
 
       - name: Cache Yarn packages
         uses: actions/cache@v4

CONTRIBUTING.md

@@ -77,8 +77,12 @@ $ yarn run generate-sdk
 $ yarn run release
 ```
 
-If any TypeScript errors occur, make manual edits:
+You may run into type errors after generating `src` code with `openapi-typescript-codegen`. To resolve this, we created `overrides.patch` wich will force apply changes during pre-commit and build.
 
+1. Make manual changes to fix Typescript errors
+2. Create a patch diff `git diff src/index.ts >> overrides.patch && git commit overrides.patch`
+
+Example:
 ```diff
 // index.ts
 export { Placement } from './models/Placement';

README.md

@@ -2,7 +2,7 @@
 
 [![NPM Version](https://img.shields.io/npm/v/printful-sdk-js-v2)](https://www.npmjs.com/package/printful-sdk-js-v2)
 ![MIT license](https://img.shields.io/badge/License-MIT-blue.svg) ![TypeScript](https://img.shields.io/badge/TypeScript-Ready-green.svg)
-![package size](https://img.shields.io/bundlephobia/minzip/printful-sdk-js-v2) [![Socket.dev Vulnerabilities](https://img.shields.io/badge/Security-Socket.dev%20Scan-brightgreen?logo=socket&logoColor=white)](https://socket.dev/npm/package/printful-sdk-js-v2)
+![package size](https://img.shields.io/bundlephobia/minzip/printful-sdk-js-v2) [![Socket Badge](https://socket.dev//api/badge/npm/package/printful-sdk-js-v2/2.0.0-beta)](https://socket.dev//npm/package/printful-sdk-js-v2/overview/2.0.0-beta)
 
 A lightweight SDK for interacting with the Printful RESTful API, written in TypeScript. Designed for server-side use in Node.js environments.
 

overrides.patch

@@ -0,0 +1,13 @@
+diff --git a/src/index.ts b/src/index.ts
+index 826809d..fd8bf7a 100644
+--- a/src/index.ts
++++ b/src/index.ts
+@@ -108,7 +108,7 @@ export type { PackingSlipReadonly } from './models/PackingSlipReadonly';
+ export type { Paging } from './models/Paging';
+ export type { ParameterSource } from './models/ParameterSource';
+ export type { PathStoreId } from './models/PathStoreId';
+-export { Placement } from './models/Placement';
++// export { Placement } from './models/Placement';
+ export type { Placement } from './models/Placement';
+ export { Placement_2 } from './models/Placement_2';
+ export type { PlacementList } from './models/PlacementList';

package.json

@@ -1,6 +1,6 @@
 {
   "name": "printful-sdk-js-v2",
-  "version": "2.1.0-beta",
+  "version": "2.1.1-beta",
   "description": "Printful SDK for Node.js / TypeScript. A wrapper for the Printful REST API (v2)",
   "author": "Spencer Lepine <spencer.sayhello@gmail.com>",
   "license": "MIT",
@@ -49,10 +49,12 @@
   "scripts": {
     "test": "jest",
     "bundle": "rollup -c",
+    "apply-overrides": "git apply overrides.patch && git add src",
     "generate-sdk": "openapi --input ./openapi.json --output ./src --name PrintfulClient",
     "generate-docs": "typedoc src/index.ts",
-    "release": "npm run bundle && npm run generate-docs",
-    "audit:fix": "npm_config_yes=true npx yarn-audit-fix"
+    "release": "npm run generate-sdk && npm run apply-overrides && npm run bundle && npm run generate-docs",
+    "audit:fix": "npm_config_yes=true npx yarn-audit-fix",
+    "pre-commit": "lint-staged && npm run release"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^26.0.1",
@@ -85,7 +87,7 @@
   },
   "husky": {
     "hooks": {
-      "pre-commit": "lint-staged && npm run release"
+      "pre-commit": "npm run pre-commit"
     }
   },
   "lint-staged": {

src/index.ts

@@ -43,6 +43,7 @@ export type { DateFrom } from './models/DateFrom';
 export type { DateTo } from './models/DateTo';
 export type { DefaultEventConfigurationRequest } from './models/DefaultEventConfigurationRequest';
 export type { DesignPlacement } from './models/DesignPlacement';
+export type { DestinationCountry } from './models/DestinationCountry';
 export { dPuffOption } from './models/dPuffOption';
 export type { Error } from './models/Error';
 export type { EstimationAddress } from './models/EstimationAddress';
@@ -64,6 +65,7 @@ export type { Item } from './models/Item';
 export type { ItemExternalId } from './models/ItemExternalId';
 export type { ItemId } from './models/ItemId';
 export type { ItemReadonly } from './models/ItemReadonly';
+export type { ItemWithoutPlacements } from './models/ItemWithoutPlacements';
 export type { ItemWithoutPlacementsReadonly } from './models/ItemWithoutPlacementsReadonly';
 export { KnitwearBaseColor } from './models/KnitwearBaseColor';
 export { KnitwearColorReductionMode } from './models/KnitwearColorReductionMode';
@@ -106,8 +108,10 @@ export type { PackingSlipReadonly } from './models/PackingSlipReadonly';
 export type { Paging } from './models/Paging';
 export type { ParameterSource } from './models/ParameterSource';
 export type { PathStoreId } from './models/PathStoreId';
-export { Placement } from './models/Placement';
-export type { PlacementFilter } from './models/PlacementFilter';
+// export { Placement } from './models/Placement';
+export type { Placement } from './models/Placement';
+export { Placement_2 } from './models/Placement_2';
+export type { PlacementList } from './models/PlacementList';
 export type { PlacementOptions } from './models/PlacementOptions';
 export type { PlacementsFilter } from './models/PlacementsFilter';
 export type { PlacementsList } from './models/PlacementsList';
@@ -125,6 +129,7 @@ export type { ProductPrices } from './models/ProductPrices';
 export type { ProductSizeGuide } from './models/ProductSizeGuide';
 export type { ProductsLinks } from './models/ProductsLinks';
 export type { ProductsParam } from './models/ProductsParam';
+export { ProductTemplateItem } from './models/ProductTemplateItem';
 export type { Profit } from './models/Profit';
 export { ReportTypes } from './models/ReportTypes';
 export type { Response200 } from './models/Response200';
@@ -141,6 +146,7 @@ export { Shipment } from './models/Shipment';
 export type { Shipment_2 } from './models/Shipment_2';
 export type { ShipmentItem } from './models/ShipmentItem';
 export type { ShipmentItem_2 } from './models/ShipmentItem_2';
+export type { ShippingCountry } from './models/ShippingCountry';
 export type { ShippingRatesAddress } from './models/ShippingRatesAddress';
 export type { ShowExpired } from './models/ShowExpired';
 export { SizeTable } from './models/SizeTable';

src/models/BaseMockupProduct.ts

@@ -16,6 +16,6 @@ export type BaseMockupProduct = {
      * Available mockup styles for catalog product can be found under _[Retrieve catalog product mockup styles](#operation/retrieveMockupStylesByProductId)_.
      *
      */
-    mockup_style_ids: Array<number>;
+    mockup_style_ids?: Array<number>;
 };
 

src/models/CatalogShippingRateItem.ts

@@ -2,6 +2,8 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
+import type { PlacementList } from './PlacementList';
+import type { ProductOptions } from './ProductOptions';
 export type CatalogShippingRateItem = {
     /**
      * Catalog source
@@ -15,6 +17,8 @@ export type CatalogShippingRateItem = {
      * ID of catalog variant
      */
     catalog_variant_id: number;
+    placements?: PlacementList;
+    product_options?: ProductOptions;
 };
 export namespace CatalogShippingRateItem {
     /**