Merge pull request #4 from sentdm/release-please--branches--main--cha…

…nges--next--components--node

release: 0.1.0-alpha.1

.github/workflows/publish-npm.yml

@@ -0,0 +1,32 @@
+# 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-node/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@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install dependencies
+        run: |
+          yarn install
+
+      - name: Publish to NPM
+        run: |
+          bash ./bin/publish-npm
+        env:
+          NPM_TOKEN: ${{ secrets.SENT_NPM_TOKEN || secrets.NPM_TOKEN }}

.github/workflows/release-doctor.yml

@@ -0,0 +1,22 @@
+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-node' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Check release environment
+        run: |
+          bash ./bin/check-release-environment
+        env:
+          NPM_TOKEN: ${{ secrets.SENT_NPM_TOKEN || secrets.NPM_TOKEN }}
+

.release-please-manifest.json

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

CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## 0.1.0-alpha.1 (2024-10-31)
+
+Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/sentdm/sent-node/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)
+
+### Features
+
+* **api:** update via SDK Studio ([e1371cc](https://github.com/sentdm/sent-node/commit/e1371cc5662176feb85abd05b4a2a37e3aaa0960))
+* **api:** update via SDK Studio ([28ff778](https://github.com/sentdm/sent-node/commit/28ff77860ad89c13f096c3c3d2007dce1f9bac65))
+
+
+### Chores
+
+* go live ([#1](https://github.com/sentdm/sent-node/issues/1)) ([9e7d1ac](https://github.com/sentdm/sent-node/commit/9e7d1ac28875aca0edda778691dfb9657669603c))
+* update SDK settings ([#3](https://github.com/sentdm/sent-node/issues/3)) ([637e824](https://github.com/sentdm/sent-node/commit/637e82433f081d79e7d8172aa8901731eec5a050))

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://[email protected]:stainless-sdks/sent-node.git
+$ npm install git+ssh://[email protected]:sentdm/sent-node.git
 ```
 
 Alternatively, to link a local copy of the repo:
 
 ```sh
 # Clone
-$ git clone https://www.github.com/stainless-sdks/sent-node
+$ git clone https://www.github.com/sentdm/sent-node
 $ cd sent-node
 
 # With yarn
 $ yarn link
 $ cd ../my-package
-$ yarn link sent
+$ yarn link @sent/node
 
 # With pnpm
 $ pnpm link --global
 $ cd ../my-package
-$ pnpm link -—global sent
+$ pnpm link -—global @sent/node
 ```
 
 ## Running tests
@@ -99,7 +99,7 @@ the changes aren't made through the automated pipeline, you may want to make rel
 
 ### Publish with a GitHub workflow
 
-You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/stainless-sdks/sent-node/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up.
+You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/sentdm/sent-node/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up.
 
 ### Publish manually
 

README.md

@@ -1,6 +1,6 @@
 # Sent Node API Library
 
-[![NPM version](https://img.shields.io/npm/v/sent.svg)](https://npmjs.org/package/sent) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/sent)
+[![NPM version](https://img.shields.io/npm/v/@sent/node.svg)](https://npmjs.org/package/@sent/node) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@sent/node)
 
 This library provides convenient access to the Sent REST API from server-side TypeScript or JavaScript.
 
@@ -11,19 +11,16 @@ It is generated with [Stainless](https://www.stainlessapi.com/).
 ## Installation
 
 ```sh
-npm install git+ssh://[email protected]:stainless-sdks/sent-node.git
+npm install @sent/node
 ```
 
-> [!NOTE]
-> Once this package is [published to npm](https://app.stainlessapi.com/docs/guides/publish), this will become: `npm install sent`
-
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
 
 <!-- prettier-ignore -->
 ```js
-import Sent from 'sent';
+import Sent from '@sent/node';
 
 const client = new Sent();
 
@@ -40,7 +37,7 @@ This library includes TypeScript definitions for all request params and response
 
 <!-- prettier-ignore -->
 ```ts
-import Sent from 'sent';
+import Sent from '@sent/node';
 
 const client = new Sent();
 
@@ -207,12 +204,12 @@ add the following import before your first import `from "Sent"`:
 ```ts
 // Tell TypeScript and the package to use the global web fetch instead of node-fetch.
 // Note, despite the name, this does not add any polyfills, but expects them to be provided if needed.
-import 'sent/shims/web';
-import Sent from 'sent';
+import '@sent/node/shims/web';
+import Sent from '@sent/node';
 ```
 
-To do the inverse, add `import "sent/shims/node"` (which does import polyfills).
-This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/stainless-sdks/sent-node/tree/main/src/_shims#readme)).
+To do the inverse, add `import "@sent/node/shims/node"` (which does import polyfills).
+This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/sentdm/sent-node/tree/main/src/_shims#readme)).
 
 ### Logging and middleware
 
@@ -221,7 +218,7 @@ which can be used to inspect or alter the `Request` or `Response` before/after e
 
 ```ts
 import { fetch } from 'undici'; // as one example
-import Sent from 'sent';
+import Sent from '@sent/node';
 
 const client = new Sent({
   fetch: async (url: RequestInfo, init?: RequestInit): Promise<Response> => {
@@ -268,7 +265,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-node/issues) with questions, bugs, or suggestions.
+We are keen for your feedback; please open an [issue](https://www.github.com/sentdm/sent-node/issues) with questions, bugs, or suggestions.
 
 ## Requirements
 

bin/check-release-environment

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+errors=()
+
+if [ -z "${NPM_TOKEN}" ]; then
+  errors+=("The SENT_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
+  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!"
+

jest.config.ts

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

package.json

@@ -1,12 +1,12 @@
 {
-  "name": "sent",
-  "version": "0.0.1-alpha.0",
+  "name": "@sent/node",
+  "version": "0.1.0-alpha.1",
   "description": "The official TypeScript library for the Sent API",
   "author": "Sent <[email protected]>",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "type": "commonjs",
-  "repository": "github:stainless-sdks/sent-node",
+  "repository": "github:sentdm/sent-node",
   "license": "Apache-2.0",
   "packageManager": "[email protected]",
   "files": [
@@ -60,8 +60,8 @@
     "./shims/web.mjs"
   ],
   "imports": {
-    "sent": ".",
-    "sent/*": "./src/*"
+    "@sent/node": ".",
+    "@sent/node/*": "./src/*"
   },
   "exports": {
     "./_shims/auto/*": {

release-please-config.json

@@ -0,0 +1,67 @@
+{
+  "packages": {
+    ".": {}
+  },
+  "$schema": "https://raw.githubusercontent.com/stainless-api/release-please/main/schemas/config.json",
+  "include-v-in-tag": true,
+  "include-component-in-tag": false,
+  "versioning": "prerelease",
+  "prerelease": true,
+  "bump-minor-pre-major": true,
+  "bump-patch-for-minor-pre-major": false,
+  "pull-request-header": "Automated Release PR",
+  "pull-request-title-pattern": "release: ${version}",
+  "changelog-sections": [
+    {
+      "type": "feat",
+      "section": "Features"
+    },
+    {
+      "type": "fix",
+      "section": "Bug Fixes"
+    },
+    {
+      "type": "perf",
+      "section": "Performance Improvements"
+    },
+    {
+      "type": "revert",
+      "section": "Reverts"
+    },
+    {
+      "type": "chore",
+      "section": "Chores"
+    },
+    {
+      "type": "docs",
+      "section": "Documentation"
+    },
+    {
+      "type": "style",
+      "section": "Styles"
+    },
+    {
+      "type": "refactor",
+      "section": "Refactors"
+    },
+    {
+      "type": "test",
+      "section": "Tests",
+      "hidden": true
+    },
+    {
+      "type": "build",
+      "section": "Build System"
+    },
+    {
+      "type": "ci",
+      "section": "Continuous Integration",
+      "hidden": true
+    }
+  ],
+  "release-type": "node",
+  "extra-files": [
+    "src/version.ts",
+    "README.md"
+  ]
+}

scripts/build

@@ -8,7 +8,7 @@ node scripts/utils/check-version.cjs
 
 # Build into dist and will publish the package from there,
 # so that src/resources/foo.ts becomes <package root>/resources/foo.js
-# This way importing from `"sent/resources/foo"` works
+# This way importing from `"@sent/node/resources/foo"` works
 # even with `"moduleResolution": "node"`
 
 rm -rf dist; mkdir dist
@@ -47,8 +47,8 @@ node scripts/utils/postprocess-files.cjs
 
 # make sure that nothing crashes when we require the output CJS or
 # import the output ESM
-(cd dist && node -e 'require("sent")')
-(cd dist && node -e 'import("sent")' --input-type=module)
+(cd dist && node -e 'require("@sent/node")')
+(cd dist && node -e 'import("@sent/node")' --input-type=module)
 
 if command -v deno &> /dev/null && [ -e ./scripts/build-deno ]
 then

scripts/utils/postprocess-files.cjs

@@ -2,7 +2,7 @@ const fs = require('fs');
 const path = require('path');
 const { parse } = require('@typescript-eslint/parser');
 
-const pkgImportPath = process.env['PKG_IMPORT_PATH'] ?? 'sent/';
+const pkgImportPath = process.env['PKG_IMPORT_PATH'] ?? '@sent/node/';
 
 const distDir =
   process.env['DIST_PATH'] ?
@@ -142,7 +142,7 @@ async function postprocess() {
 
     if (file.endsWith('.d.ts')) {
       // work around bad tsc behavior
-      // if we have `import { type Readable } from 'sent/_shims/index'`,
+      // if we have `import { type Readable } from '@sent/node/_shims/index'`,
       // tsc sometimes replaces `Readable` with `import("stream").Readable` inline
       // in the output .d.ts
       transformed = transformed.replace(/import\("stream"\).Readable/g, 'Readable');