feat(api): manual updates

Author: stainless-app[bot]

.github/workflows/publish-npm.yml

@@ -0,0 +1,36 @@
+# This workflow is triggered when a GitHub release is created.
+# It can also be run manually to re-publish to NPM in case it failed for some reason.
+# You can run this workflow by navigating to https://www.github.com/sentdm/sent-dm-typescript/actions/workflows/publish-npm.yml
+name: Publish NPM
+on:
+  workflow_dispatch:
+
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    name: publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+
+      - name: Set up pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Install dependencies
+        run: |
+          pnpm install
+
+      - name: Publish to NPM
+        run: |
+          bash ./bin/publish-npm

.github/workflows/release-doctor.yml

@@ -0,0 +1,20 @@
+name: Release Doctor
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  release_doctor:
+    name: release doctor
+    runs-on: ubuntu-latest
+    if: github.repository == 'sentdm/sent-dm-typescript' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Check release environment
+        run: |
+          bash ./bin/check-release-environment
+

.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.7.2"
+}

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 44
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/sent%2Fsent-dm-433bfd8c688a6b6d2d4f964bb59121d692798f4e2bb6cb47f6110c4f0e1f638d.yml
 openapi_spec_hash: 5378295d401c8c1152c1946cc7dbd69f
-config_hash: 64ada5a5574e037e7ada612d3df30ae8
+config_hash: 338e3f4d5c4c5320b6c1cd97b26baa6a

CONTRIBUTING.md

@@ -42,25 +42,25 @@ If you’d like to use the repository from source, you can either install from g
 To install via git:
 
 ```sh
-$ npm install git+ssh://git@github.com:stainless-sdks/sent-dm-typescript.git
+$ npm install git+ssh://git@github.com:sentdm/sent-dm-typescript.git
 ```
 
 Alternatively, to link a local copy of the repo:
 
 ```sh
 # Clone
-$ git clone https://www.github.com/stainless-sdks/sent-dm-typescript
+$ git clone https://www.github.com/sentdm/sent-dm-typescript
 $ cd sent-dm-typescript
 
 # With yarn
 $ yarn link
 $ cd ../my-package
-$ yarn link sent-dm
+$ yarn link @sentdm/sentdm
 
 # With pnpm
 $ pnpm link --global
 $ cd ../my-package
-$ pnpm link -—global sent-dm
+$ pnpm link -—global @sentdm/sentdm
 ```
 
 ## Running tests
@@ -91,3 +91,17 @@ To format and fix all lint issues automatically:
 ```sh
 $ pnpm fix
 ```
+
+## Publishing and releases
+
+Changes made to this repository via the automated release PR pipeline should publish to npm automatically. If
+the changes aren't made through the automated pipeline, you may want to make releases manually.
+
+### Publish with a GitHub workflow
+
+You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/sentdm/sent-dm-typescript/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up.
+
+### Publish manually
+
+If you need to manually release a package, you can run the `bin/publish-npm` script with an `NPM_TOKEN` set on
+the environment.

README.md

@@ -1,6 +1,6 @@
 # Sent Dm TypeScript API Library
 
-[![NPM version](<https://img.shields.io/npm/v/sent-dm.svg?label=npm%20(stable)>)](https://npmjs.org/package/sent-dm) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/sent-dm)
+[![NPM version](<https://img.shields.io/npm/v/@sentdm/sentdm.svg?label=npm%20(stable)>)](https://npmjs.org/package/@sentdm/sentdm) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@sentdm/sentdm)
 
 This library provides convenient access to the Sent Dm REST API from server-side TypeScript or JavaScript.
 
@@ -11,19 +11,16 @@ It is generated with [Stainless](https://www.stainless.com/).
 ## Installation
 
 ```sh
-npm install git+ssh://git@github.com:stainless-sdks/sent-dm-typescript.git
+npm install @sentdm/sentdm
 ```
 
-> [!NOTE]
-> Once this package is [published to npm](https://www.stainless.com/docs/guides/publish), this will become: `npm install sent-dm`
-
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
 
 <!-- prettier-ignore -->
 ```js
-import SentDm from 'sent-dm';
+import SentDm from '@sentdm/sentdm';
 
 const client = new SentDm({
   apiKey: process.env['SENT_DM_API_KEY'], // This is the default and can be omitted
@@ -48,7 +45,7 @@ This library includes TypeScript definitions for all request params and response
 
 <!-- prettier-ignore -->
 ```ts
-import SentDm from 'sent-dm';
+import SentDm from '@sentdm/sentdm';
 
 const client = new SentDm({
   apiKey: process.env['SENT_DM_API_KEY'], // This is the default and can be omitted
@@ -225,7 +222,7 @@ The log level can be configured in two ways:
 2. Using the `logLevel` client option (overrides the environment variable if set)
 
 ```ts
-import SentDm from 'sent-dm';
+import SentDm from '@sentdm/sentdm';
 
 const client = new SentDm({
   logLevel: 'debug', // Show all log messages
@@ -253,7 +250,7 @@ When providing a custom logger, the `logLevel` option still controls which messa
 below the configured level will not be sent to your logger.
 
 ```ts
-import SentDm from 'sent-dm';
+import SentDm from '@sentdm/sentdm';
 import pino from 'pino';
 
 const logger = pino();
@@ -322,7 +319,7 @@ globalThis.fetch = fetch;
 Or pass it to the client:
 
 ```ts
-import SentDm from 'sent-dm';
+import SentDm from '@sentdm/sentdm';
 import fetch from 'my-fetch';
 
 const client = new SentDm({ fetch });
@@ -333,7 +330,7 @@ const client = new SentDm({ fetch });
 If you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)
 
 ```ts
-import SentDm from 'sent-dm';
+import SentDm from '@sentdm/sentdm';
 
 const client = new SentDm({
   fetchOptions: {
@@ -350,7 +347,7 @@ options to requests:
 <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg" align="top" width="18" height="21"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>
 
 ```ts
-import SentDm from 'sent-dm';
+import SentDm from '@sentdm/sentdm';
 import * as undici from 'undici';
 
 const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
@@ -364,7 +361,7 @@ const client = new SentDm({
 <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg" align="top" width="18" height="21"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>
 
 ```ts
-import SentDm from 'sent-dm';
+import SentDm from '@sentdm/sentdm';
 
 const client = new SentDm({
   fetchOptions: {
@@ -376,7 +373,7 @@ const client = new SentDm({
 <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg" align="top" width="18" height="21"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>
 
 ```ts
-import SentDm from 'npm:sent-dm';
+import SentDm from 'npm:@sentdm/sentdm';
 
 const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
 const client = new SentDm({
@@ -398,7 +395,7 @@ This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) con
 
 We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
 
-We are keen for your feedback; please open an [issue](https://www.github.com/stainless-sdks/sent-dm-typescript/issues) with questions, bugs, or suggestions.
+We are keen for your feedback; please open an [issue](https://www.github.com/sentdm/sent-dm-typescript/issues) with questions, bugs, or suggestions.
 
 ## Requirements
 

bin/check-release-environment

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+errors=()
+
+lenErrors=${#errors[@]}
+
+if [[ lenErrors -gt 0 ]]; then
+  echo -e "Found the following errors in the release environment:\n"
+
+  for error in "${errors[@]}"; do
+    echo -e "- $error\n"
+  done
+
+  exit 1
+fi
+
+echo "The environment is ready to push releases!"
+

bin/publish-npm

@@ -2,7 +2,12 @@
 
 set -eux
 
-npm config set '//registry.npmjs.org/:_authToken' "$NPM_TOKEN"
+if [[ ${NPM_TOKEN:-} ]]; then
+  npm config set '//registry.npmjs.org/:_authToken' "$NPM_TOKEN"
+elif [[ ! ${ACTIONS_ID_TOKEN_REQUEST_TOKEN:-} ]]; then
+  echo "ERROR: NPM_TOKEN must be set if not running in a Github Action with id-token permission"
+  exit 1
+fi
 
 pnpm build
 cd dist
@@ -57,5 +62,8 @@ else
   TAG="latest"
 fi
 
+# Install OIDC compatible npm version
+npm install --prefix ../oidc/ npm@11.6.2
+
 # Publish with the appropriate tag
-pnpm publish --no-git-checks --tag "$TAG"
+pnpm publish --npm-path "$(cd ../ && pwd)/oidc/node_modules/.bin/npm" --no-git-checks --tag "$TAG"

eslint.config.mjs

@@ -25,7 +25,7 @@ export default tseslint.config(
         {
           patterns: [
             {
-              regex: '^sent-dm(/.*)?',
+              regex: '^@sentdm/sentdm(/.*)?',
               message: 'Use a relative import, not a package import.',
             },
           ],

jest.config.ts

@@ -7,8 +7,8 @@ const config: JestConfigWithTsJest = {
     '^.+\\.(t|j)sx?$': ['@swc/jest', { sourceMaps: 'inline' }],
   },
   moduleNameMapper: {
-    '^sent-dm$': '<rootDir>/src/index.ts',
-    '^sent-dm/(.*)$': '<rootDir>/src/$1',
+    '^@sentdm/sentdm$': '<rootDir>/src/index.ts',
+    '^@sentdm/sentdm/(.*)$': '<rootDir>/src/$1',
   },
   modulePathIgnorePatterns: [
     '<rootDir>/ecosystem-tests/',