@useshortcut/client 2.3.0 → 3.0.0

package/README.md

@@ -78,3 +78,33 @@ You can play with it in your web browser with this live playground:
 [Documentation for this client](https://useshortcut.github.io/shortcut-client-js/).
 
 [Documentation for the REST API](https://developer.shortcut.com/api/rest/v3).
+
+## Publishing & Deployment
+
+This library uses GitHub Actions for CI/CD. The deployment process is fully automated.
+
+### Release Process
+
+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
+
+### Publishing to npm
+
+Publishing 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
+
+### Documentation Deployment
+
+API documentation is automatically deployed to GitHub Pages on every push to `main`:
+
+1. The `gh-pages.yml` workflow builds the documentation using TypeDoc
+2. Documentation is published to https://useshortcut.github.io/shortcut-client-js/

package/lib/ShortcutClient.d.mts

@@ -1,21 +1,9 @@
-import { SearchStories, StorySlim } from "./generated/data-contracts.mjs";
-import { ApiConfig, RequestParams } from "./generated/http-client.mjs";
+import { ApiConfig } from "./generated/http-client.mjs";
 import { Api } from "./generated/Api.mjs";
-import * as axios0 from "axios";
 
 //#region src/ShortcutClient.d.ts
 declare class ShortcutClient<SecurityDataType = unknown> extends Api<SecurityDataType> {
   constructor(apiToken: string, config?: ApiConfig<SecurityDataType>);
-  /**
-   * @deprecated Use queryStories instead.
-   * @description Search Stories (Old) lets you search Stories based on desired parameters.
-   *
-   * @name SearchStoriesOld
-   * @summary Search Stories (Old)
-   * @request POST:/api/v3/stories/search
-   * @secure
-   */
-  searchStoriesOld: (searchStories: SearchStories, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any>>;
 }
 //#endregion
 export { ShortcutClient };

package/lib/ShortcutClient.d.ts

@@ -1,21 +1,9 @@
-import { SearchStories, StorySlim } from "./generated/data-contracts.js";
-import { ApiConfig, RequestParams } from "./generated/http-client.js";
+import { ApiConfig } from "./generated/http-client.js";
 import { Api } from "./generated/Api.js";
-import * as axios0 from "axios";
 
 //#region src/ShortcutClient.d.ts
 declare class ShortcutClient<SecurityDataType = unknown> extends Api<SecurityDataType> {
   constructor(apiToken: string, config?: ApiConfig<SecurityDataType>);
-  /**
-   * @deprecated Use queryStories instead.
-   * @description Search Stories (Old) lets you search Stories based on desired parameters.
-   *
-   * @name SearchStoriesOld
-   * @summary Search Stories (Old)
-   * @request POST:/api/v3/stories/search
-   * @secure
-   */
-  searchStoriesOld: (searchStories: SearchStories, params?: RequestParams) => Promise<axios0.AxiosResponse<StorySlim[], any>>;
 }
 //#endregion
 export { ShortcutClient };

package/lib/ShortcutClient.js

@@ -1,4 +1,3 @@
-const require_http_client = require('./generated/http-client.js');
 const require_Api = require('./generated/Api.js');
 
 //#region src/ShortcutClient.ts
@@ -13,24 +12,6 @@ var ShortcutClient = class extends require_Api.Api {
 			...config
 		});
 	}
-	/**
-	* @deprecated Use queryStories instead.
-	* @description Search Stories (Old) lets you search Stories based on desired parameters.
-	*
-	* @name SearchStoriesOld
-	* @summary Search Stories (Old)
-	* @request POST:/api/v3/stories/search
-	* @secure
-	*/
-	searchStoriesOld = (searchStories, params = {}) => this.request({
-		path: `/api/v3/stories/search`,
-		method: "POST",
-		body: searchStories,
-		secure: true,
-		type: require_http_client.ContentType.Json,
-		format: "json",
-		...params
-	});
 };
 
 //#endregion

package/lib/ShortcutClient.mjs

@@ -1,4 +1,3 @@
-import { ContentType } from "./generated/http-client.mjs";
 import { Api } from "./generated/Api.mjs";
 
 //#region src/ShortcutClient.ts
@@ -13,24 +12,6 @@ var ShortcutClient = class extends Api {
 			...config
 		});
 	}
-	/**
-	* @deprecated Use queryStories instead.
-	* @description Search Stories (Old) lets you search Stories based on desired parameters.
-	*
-	* @name SearchStoriesOld
-	* @summary Search Stories (Old)
-	* @request POST:/api/v3/stories/search
-	* @secure
-	*/
-	searchStoriesOld = (searchStories, params = {}) => this.request({
-		path: `/api/v3/stories/search`,
-		method: "POST",
-		body: searchStories,
-		secure: true,
-		type: ContentType.Json,
-		format: "json",
-		...params
-	});
 };
 
 //#endregion