chore: update SDK settings

Author: stainless-app[bot]

.github/workflows/publish-npm.yml

@@ -0,0 +1,35 @@
+# 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
+
+    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
+        env:
+          NPM_TOKEN: ${{ secrets.SENT_DM_NPM_TOKEN || secrets.NPM_TOKEN }}

.github/workflows/release-doctor.yml

@@ -17,4 +17,6 @@ jobs:
       - name: Check release environment
         run: |
           bash ./bin/check-release-environment
+        env:
+          NPM_TOKEN: ${{ secrets.SENT_DM_NPM_TOKEN || secrets.NPM_TOKEN }}
 

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 19
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/sent%2Fsent-dm-67fa00cfa520b681534cdcfc26f133783e4c796b1dbc5bd18b91daf4e7c8a3f2.yml
 openapi_spec_hash: 23cf4045a307cd8ebae6c6162a7f4902
-config_hash: d39935e88fd43becb8680e5e543f6f29
+config_hash: d4dca0d79cdc2d51014761274600b34f

CONTRIBUTING.md

@@ -55,12 +55,12 @@ $ cd sent-dm-typescript
 # With yarn
 $ yarn link
 $ cd ../my-package
-$ yarn link sent-dm
+$ yarn link sentdm
 
 # With pnpm
 $ pnpm link --global
 $ cd ../my-package
-$ pnpm link -—global sent-dm
+$ pnpm link -—global 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.svg?label=npm%20(stable)>)](https://npmjs.org/package/sentdm) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/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:sentdm/sent-dm-typescript.git
+npm install 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';
 
 const client = new SentDm({
   apiKey: process.env['SENT_DM_API_KEY'], // This is the default and can be omitted
@@ -42,7 +39,7 @@ This library includes TypeScript definitions for all request params and response
 
 <!-- prettier-ignore -->
 ```ts
-import SentDm from 'sent-dm';
+import SentDm from 'sentdm';
 
 const client = new SentDm({
   apiKey: process.env['SENT_DM_API_KEY'], // This is the default and can be omitted
@@ -175,7 +172,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';
 
 const client = new SentDm({
   logLevel: 'debug', // Show all log messages
@@ -203,7 +200,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';
 import pino from 'pino';
 
 const logger = pino();
@@ -272,7 +269,7 @@ globalThis.fetch = fetch;
 Or pass it to the client:
 
 ```ts
-import SentDm from 'sent-dm';
+import SentDm from 'sentdm';
 import fetch from 'my-fetch';
 
 const client = new SentDm({ fetch });
@@ -283,7 +280,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';
 
 const client = new SentDm({
   fetchOptions: {
@@ -300,7 +297,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';
 import * as undici from 'undici';
 
 const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
@@ -314,7 +311,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';
 
 const client = new SentDm({
   fetchOptions: {
@@ -326,7 +323,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';
 
 const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
 const client = new SentDm({

bin/check-release-environment

@@ -2,6 +2,10 @@
 
 errors=()
 
+if [ -z "${NPM_TOKEN}" ]; then
+  errors+=("The NPM_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets")
+fi
+
 lenErrors=${#errors[@]}
 
 if [[ lenErrors -gt 0 ]]; then

eslint.config.mjs

@@ -25,7 +25,7 @@ export default tseslint.config(
         {
           patterns: [
             {
-              regex: '^sent-dm(/.*)?',
+              regex: '^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$': '<rootDir>/src/index.ts',
+    '^sentdm/(.*)$': '<rootDir>/src/$1',
   },
   modulePathIgnorePatterns: [
     '<rootDir>/ecosystem-tests/',

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "sent-dm",
+  "name": "sentdm",
   "version": "0.0.2",
   "description": "The official TypeScript library for the Sent Dm API",
   "author": "Sent Dm <>",

pnpm-workspace.yaml

@@ -2,4 +2,4 @@ onlyBuiltDependencies:
   - '@swc/core'
 minimumReleaseAge: 1440
 minimumReleaseAgeExclude:
-  - sent-dm
+  - sentdm