Merge pull request #2 from ZoriHQ/release-please--branches--main--changes--next--components--zorihq

le-vlad · web-flow · commit f1d8a4114167 · 2025-10-05T14:24:26.000+02:00
release: 0.0.3
diff --git a/.github/workflows/publish-npm.yml b/.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/ZoriHQ/typescript-api-sdk/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: '20'
+
+      - name: Install dependencies
+        run: |
+          yarn install
+
+      - name: Publish to NPM
+        run: |
+          bash ./bin/publish-npm
+        env:
+          NPM_TOKEN: ${{ secrets.ZORIAPI_NPM_TOKEN || secrets.NPM_TOKEN }}
diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml
@@ -18,4 +18,5 @@ jobs:
         run: |
           bash ./bin/check-release-environment
         env:
+          NPM_TOKEN: ${{ secrets.ZORIAPI_NPM_TOKEN || secrets.NPM_TOKEN }}
 
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "0.0.2"
+  ".": "0.0.3"
 }
diff --git a/.stats.yml b/.stats.yml
@@ -1,4 +1,4 @@
 configured_endpoints: 6
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/zorihq%2Fzoriapi-38511cdba7b2c6eb603810bf857ac41f35d3fc2de66778c1145dfd89bc2fab1c.yml
 openapi_spec_hash: ea2c1947c7ff031dd1a35f1d7d7f711c
-config_hash: 998fdbdb4a444a085ed4faab91006787
+config_hash: 257877294672d7b8ae6868ea3eed6e0c
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.0.3 (2025-10-05)
+
+Full Changelog: [v0.0.2...v0.0.3](https://github.com/ZoriHQ/typescript-api-sdk/compare/v0.0.2...v0.0.3)
+
+### Chores
+
+* update SDK settings ([2883221](https://github.com/ZoriHQ/typescript-api-sdk/commit/2883221b67a8a506fa310a25e237b2ec0833ea10))
+
 ## 0.0.2 (2025-10-05)
 
 Full Changelog: [v0.0.1...v0.0.2](https://github.com/ZoriHQ/typescript-api-sdk/compare/v0.0.1...v0.0.2)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -55,12 +55,12 @@ $ cd typescript-api-sdk
 # With yarn
 $ yarn link
 $ cd ../my-package
-$ yarn link zoriapi
+$ yarn link zorihq
 
 # With pnpm
 $ pnpm link --global
 $ cd ../my-package
-$ pnpm link -—global zoriapi
+$ pnpm link -—global zorihq
 ```
 
 ## Running tests
@@ -91,3 +91,17 @@ To format and fix all lint issues automatically:
 ```sh
 $ yarn 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/ZoriHQ/typescript-api-sdk/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.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Zoriapi TypeScript API Library
 
-[![NPM version](<https://img.shields.io/npm/v/zoriapi.svg?label=npm%20(stable)>)](https://npmjs.org/package/zoriapi) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/zoriapi)
+[![NPM version](<https://img.shields.io/npm/v/zorihq.svg?label=npm%20(stable)>)](https://npmjs.org/package/zorihq) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/zorihq)
 
 This library provides convenient access to the Zoriapi 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:ZoriHQ/typescript-api-sdk.git
+npm install zorihq
 ```
 
-> [!NOTE]
-> Once this package is [published to npm](https://www.stainless.com/docs/guides/publish), this will become: `npm install zoriapi`
-
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
 
 <!-- prettier-ignore -->
 ```js
-import Zoriapi from 'zoriapi';
+import Zoriapi from 'zorihq';
 
 const client = new Zoriapi({
   apiKey: process.env['ZORIAPI_API_KEY'], // This is the default and can be omitted
@@ -43,7 +40,7 @@ This library includes TypeScript definitions for all request params and response
 
 <!-- prettier-ignore -->
 ```ts
-import Zoriapi from 'zoriapi';
+import Zoriapi from 'zorihq';
 
 const client = new Zoriapi({
   apiKey: process.env['ZORIAPI_API_KEY'], // This is the default and can be omitted
@@ -172,7 +169,7 @@ The log level can be configured in two ways:
 2. Using the `logLevel` client option (overrides the environment variable if set)
 
 ```ts
-import Zoriapi from 'zoriapi';
+import Zoriapi from 'zorihq';
 
 const client = new Zoriapi({
   logLevel: 'debug', // Show all log messages
@@ -200,7 +197,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 Zoriapi from 'zoriapi';
+import Zoriapi from 'zorihq';
 import pino from 'pino';
 
 const logger = pino();
@@ -269,7 +266,7 @@ globalThis.fetch = fetch;
 Or pass it to the client:
 
 ```ts
-import Zoriapi from 'zoriapi';
+import Zoriapi from 'zorihq';
 import fetch from 'my-fetch';
 
 const client = new Zoriapi({ fetch });
@@ -280,7 +277,7 @@ const client = new Zoriapi({ 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 Zoriapi from 'zoriapi';
+import Zoriapi from 'zorihq';
 
 const client = new Zoriapi({
   fetchOptions: {
@@ -297,7 +294,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 Zoriapi from 'zoriapi';
+import Zoriapi from 'zorihq';
 import * as undici from 'undici';
 
 const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
@@ -311,7 +308,7 @@ const client = new Zoriapi({
 <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 Zoriapi from 'zoriapi';
+import Zoriapi from 'zorihq';
 
 const client = new Zoriapi({
   fetchOptions: {
@@ -323,7 +320,7 @@ const client = new Zoriapi({
 <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 Zoriapi from 'npm:zoriapi';
+import Zoriapi from 'npm:zorihq';
 
 const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
 const client = new Zoriapi({
diff --git a/bin/check-release-environment b/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
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -25,7 +25,7 @@ export default tseslint.config(
         {
           patterns: [
             {
-              regex: '^zoriapi(/.*)?',
+              regex: '^zorihq(/.*)?',
               message: 'Use a relative import, not a package import.',
             },
           ],
diff --git a/jest.config.ts b/jest.config.ts
@@ -7,8 +7,8 @@ const config: JestConfigWithTsJest = {
     '^.+\\.(t|j)sx?$': ['@swc/jest', { sourceMaps: 'inline' }],
   },
   moduleNameMapper: {
-    '^zoriapi$': '<rootDir>/src/index.ts',
-    '^zoriapi/(.*)$': '<rootDir>/src/$1',
+    '^zorihq$': '<rootDir>/src/index.ts',
+    '^zorihq/(.*)$': '<rootDir>/src/$1',
   },
   modulePathIgnorePatterns: [
     '<rootDir>/ecosystem-tests/',
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
-  "name": "zoriapi",
-  "version": "0.0.2",
+  "name": "zorihq",
+  "version": "0.0.3",
   "description": "The official TypeScript library for the Zoriapi API",
   "author": "Zoriapi <support@zorihq.com>",
   "types": "dist/index.d.ts",
diff --git a/scripts/build b/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 `"zoriapi/resources/foo"` works
+# This way importing from `"zorihq/resources/foo"` works
 # even with `"moduleResolution": "node"`
 
 rm -rf dist; mkdir dist
@@ -42,8 +42,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("zoriapi")')
-(cd dist && node -e 'import("zoriapi")' --input-type=module)
+(cd dist && node -e 'require("zorihq")')
+(cd dist && node -e 'import("zorihq")' --input-type=module)
 
 if [ -e ./scripts/build-deno ]
 then
diff --git a/src/version.ts b/src/version.ts
@@ -1 +1 @@
-export const VERSION = '0.0.2'; // x-release-please-version
+export const VERSION = '0.0.3'; // x-release-please-version
diff --git a/tests/api-resources/v1/auth.test.ts b/tests/api-resources/v1/auth.test.ts
@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import Zoriapi from 'zoriapi';
+import Zoriapi from 'zorihq';
 
 const client = new Zoriapi({
   apiKey: 'My API Key',
diff --git a/tests/base64.test.ts b/tests/base64.test.ts
@@ -1,4 +1,4 @@
-import { fromBase64, toBase64 } from 'zoriapi/internal/utils/base64';
+import { fromBase64, toBase64 } from 'zorihq/internal/utils/base64';
 
 describe.each(['Buffer', 'atob'])('with %s', (mode) => {
   let originalBuffer: BufferConstructor;
diff --git a/tests/buildHeaders.test.ts b/tests/buildHeaders.test.ts
@@ -1,5 +1,5 @@
 import { inspect } from 'node:util';
-import { buildHeaders, type HeadersLike, type NullableHeaders } from 'zoriapi/internal/headers';
+import { buildHeaders, type HeadersLike, type NullableHeaders } from 'zorihq/internal/headers';
 
 function inspectNullableHeaders(headers: NullableHeaders) {
   return `NullableHeaders {${[
diff --git a/tests/form.test.ts b/tests/form.test.ts
@@ -1,5 +1,5 @@
-import { multipartFormRequestOptions, createForm } from 'zoriapi/internal/uploads';
-import { toFile } from 'zoriapi/core/uploads';
+import { multipartFormRequestOptions, createForm } from 'zorihq/internal/uploads';
+import { toFile } from 'zorihq/core/uploads';
 
 describe('form data validation', () => {
   test('valid values do not error', async () => {
diff --git a/tests/index.test.ts b/tests/index.test.ts
@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIPromise } from 'zoriapi/core/api-promise';
+import { APIPromise } from 'zorihq/core/api-promise';
 
 import util from 'node:util';
-import Zoriapi from 'zoriapi';
-import { APIUserAbortError } from 'zoriapi';
+import Zoriapi from 'zorihq';
+import { APIUserAbortError } from 'zorihq';
 const defaultFetch = fetch;
 
 describe('instantiate client', () => {
diff --git a/tests/path.test.ts b/tests/path.test.ts
@@ -1,4 +1,4 @@
-import { createPathTagFunction, encodeURIPath } from 'zoriapi/internal/utils/path';
+import { createPathTagFunction, encodeURIPath } from 'zorihq/internal/utils/path';
 import { inspect } from 'node:util';
 import { runInNewContext } from 'node:vm';
 
diff --git a/tests/stringifyQuery.test.ts b/tests/stringifyQuery.test.ts
@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { Zoriapi } from 'zoriapi';
+import { Zoriapi } from 'zorihq';
 
 const { stringifyQuery } = Zoriapi.prototype as any;
 
diff --git a/tests/uploads.test.ts b/tests/uploads.test.ts
@@ -1,6 +1,6 @@
 import fs from 'fs';
-import type { ResponseLike } from 'zoriapi/internal/to-file';
-import { toFile } from 'zoriapi/core/uploads';
+import type { ResponseLike } from 'zorihq/internal/to-file';
+import { toFile } from 'zorihq/core/uploads';
 import { File } from 'node:buffer';
 
 class MyClass {
@@ -97,7 +97,7 @@ describe('missing File error message', () => {
   });
 
   test('is thrown', async () => {
-    const uploads = await import('zoriapi/core/uploads');
+    const uploads = await import('zorihq/core/uploads');
     await expect(
       uploads.toFile(mockResponse({ url: 'https://example.com/my/audio.mp3' })),
     ).rejects.toMatchInlineSnapshot(
diff --git a/tsconfig.build.json b/tsconfig.build.json
@@ -5,8 +5,8 @@
   "compilerOptions": {
     "rootDir": "./dist/src",
     "paths": {
-      "zoriapi/*": ["./dist/src/*"],
-      "zoriapi": ["./dist/src/index.ts"]
+      "zorihq/*": ["./dist/src/*"],
+      "zorihq": ["./dist/src/index.ts"]
     },
     "noEmit": false,
     "declaration": true,
diff --git a/tsconfig.json b/tsconfig.json
@@ -8,8 +8,8 @@
     "moduleResolution": "node",
     "esModuleInterop": true,
     "paths": {
-      "zoriapi/*": ["./src/*"],
-      "zoriapi": ["./src/index.ts"]
+      "zorihq/*": ["./src/*"],
+      "zorihq": ["./src/index.ts"]
     },
     "noEmit": true,
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- ".": "0.0.2"`
	`2`	`+ ".": "0.0.3"`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ export default tseslint.config(`
`25`	`25`	`{`
`26`	`26`	`patterns: [`
`27`	`27`	`{`
`28`		`- regex: '^zoriapi(/.*)?',`
	`28`	`+ regex: '^zorihq(/.*)?',`
`29`	`29`	`message: 'Use a relative import, not a package import.',`
`30`	`30`	`},`
`31`	`31`	`],`