@useshortcut/client 3.2.1 → 3.2.3

package/README.md

@@ -81,7 +81,7 @@ You can play with it in your web browser with this live playground:
 
 ## Publishing & Deployment
 
-This library uses GitHub Actions for CI/CD. The deployment process is fully automated.
+This library uses GitHub Actions for CI/CD. npm releases are staged automatically, then approved manually in npm.
 
 ### Release Process
 
@@ -90,17 +90,19 @@ To publish a new version:
 1. Update the version in `package.json`
 2. Commit and push to `main`
 3. Create a GitHub Release with a version tag (e.g., `v2.4.0`)
-4. The publish workflow will automatically build and publish to npm
+4. The publish workflow will automatically build and stage the package versions on npm
+5. Review and approve both staged packages in npm to publish them live
 
-### Publishing to npm
+### Staged Publishing to npm
 
-Publishing is triggered automatically when a **GitHub Release is created**:
+Staging is triggered automatically when a **GitHub Release is created**:
 
 1. **Create a GitHub Release**: Go to the repository's Releases page and create a new release with a version tag (e.g., `v2.4.0`)
-2. The `publish.yml` workflow will:
-   - Build the package (`yarn build` via `prepublishOnly`)
-   - Publish to npm under `@shortcut/client`
-   - Also publish under the legacy `@useshortcut/client` namespace for backwards compatibility
+2. The `publish.yml` workflow will stage `@shortcut/client`, then stage the same built package under the legacy `@useshortcut/client` namespace
+3. Review the staged packages in npm using `npm stage list`, `npm stage view <stage-id>`, or the npmjs.com **Staged Packages** tab
+4. Approve both staged packages with 2FA using `npm stage approve <stage-id>` or the npmjs.com approval flow
+
+The npm trusted publisher for this repository must allow `npm stage publish` for `.github/workflows/publish.yml`. Trusted publishing from GitHub Actions automatically generates provenance for public packages from public repositories. Staged publishing requires npm CLI `11.15.0` or later and Node.js `22.14.0` or later.
 
 ### Documentation Deployment
 

package/lib/{ShortcutClient.js → ShortcutClient.cjs}

@@ -1,5 +1,4 @@
-const require_Api = require('./generated/Api.js');
-
+const require_Api = require("./generated/Api.cjs");
 //#region src/ShortcutClient.ts
 var ShortcutClient = class extends require_Api.Api {
 	constructor(apiToken, config = {}) {
@@ -13,6 +12,5 @@ var ShortcutClient = class extends require_Api.Api {
 		});
 	}
 };
-
 //#endregion
-exports.ShortcutClient = ShortcutClient;
+exports.ShortcutClient = ShortcutClient;

package/lib/{ShortcutClient.d.ts → ShortcutClient.d.cts}

@@ -1,5 +1,5 @@
-import { ApiConfig } from "./generated/http-client.js";
-import { Api } from "./generated/Api.js";
+import { ApiConfig } from "./generated/http-client.cjs";
+import { Api } from "./generated/Api.cjs";
 
 //#region src/ShortcutClient.d.ts
 declare class ShortcutClient<SecurityDataType = unknown> extends Api<SecurityDataType> {

package/lib/ShortcutClient.mjs

@@ -1,5 +1,4 @@
 import { Api } from "./generated/Api.mjs";
-
 //#region src/ShortcutClient.ts
 var ShortcutClient = class extends Api {
 	constructor(apiToken, config = {}) {
@@ -13,6 +12,5 @@ var ShortcutClient = class extends Api {
 		});
 	}
 };
-
 //#endregion
-export { ShortcutClient };
+export { ShortcutClient };

package/lib/_virtual/{rolldown_runtime.js → _rolldown/runtime.cjs}

@@ -1,4 +1,4 @@
-//#region rolldown:runtime
+//#region \0rolldown/runtime.js
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -19,12 +19,5 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 	value: mod,
 	enumerable: true
 }) : target, mod));
-
 //#endregion
-
-Object.defineProperty(exports, '__toESM', {
-  enumerable: true,
-  get: function () {
-    return __toESM;
-  }
-});
+exports.__toESM = __toESM;

package/lib/generated/{Api.js → Api.cjs}

@@ -1,5 +1,4 @@
-const require_http_client = require('./http-client.js');
-
+const require_http_client = require("./http-client.cjs");
 //#region src/generated/Api.ts
 /** 
 * Please don't use this class directly, instead use the `ShortcutClient` class we provided which is extending this class to add headers for authorization. * @internal
@@ -34,7 +33,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateCategory,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -66,7 +65,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateCategory,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -157,7 +156,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateCustomField,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -203,7 +202,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateDoc,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -236,7 +235,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateDoc,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -253,7 +252,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "DELETE",
 		body: GetDoc,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		...params
 	});
 	/**
@@ -327,7 +326,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateEntityTemplate,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -387,7 +386,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateEntityTemplate,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -449,7 +448,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateEpic,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -497,7 +496,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateEpic,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -543,7 +542,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateEpicComment,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -560,7 +559,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateCommentComment,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -592,7 +591,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateComment,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -653,7 +652,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateEpicHealth,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -746,7 +745,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: data,
 		secure: true,
-		type: require_http_client.ContentType.FormData,
+		type: "multipart/form-data",
 		format: "json",
 		...params
 	});
@@ -778,7 +777,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateFile,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -825,7 +824,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateGroup,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -857,7 +856,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateGroup,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -890,7 +889,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateHealth,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -907,7 +906,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateGenericIntegration,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		...params
 	});
 	/**
@@ -966,7 +965,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateIteration,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1026,7 +1025,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateIteration,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1088,7 +1087,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateKeyResult,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1121,7 +1120,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateLabelParams,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1153,7 +1152,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateLabel,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1230,7 +1229,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateLinkedFile,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1262,7 +1261,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateLinkedFile,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1355,7 +1354,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateMilestone,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1387,7 +1386,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateMilestone,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1448,7 +1447,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateObjective,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1480,7 +1479,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateObjective,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1541,7 +1540,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateProject,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1573,7 +1572,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateProject,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1762,7 +1761,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateStoryParams,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1779,7 +1778,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateStories,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1796,7 +1795,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateStories,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1813,7 +1812,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "DELETE",
 		body: DeleteStories,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		...params
 	});
 	/**
@@ -1829,7 +1828,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateStoryFromTemplateParams,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1846,7 +1845,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: SearchStories,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1878,7 +1877,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateStory,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1924,7 +1923,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateStoryComment,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1956,7 +1955,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateStoryComment,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -1987,7 +1986,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateOrDeleteStoryReaction,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -2004,7 +2003,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "DELETE",
 		body: CreateOrDeleteStoryReaction,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		...params
 	});
 	/**
@@ -2065,7 +2064,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateTask,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -2097,7 +2096,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateTask,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -2128,7 +2127,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "POST",
 		body: CreateStoryLink,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -2160,7 +2159,7 @@ var Api = class extends require_http_client.HttpClient {
 		method: "PUT",
 		body: UpdateStoryLink,
 		secure: true,
-		type: require_http_client.ContentType.Json,
+		type: "application/json",
 		format: "json",
 		...params
 	});
@@ -2209,6 +2208,5 @@ var Api = class extends require_http_client.HttpClient {
 		...params
 	});
 };
-
 //#endregion
-exports.Api = Api;
+exports.Api = Api;