@postpeer/node 0.3.2 → 0.4.0

package/internal/utils/values.js

@@ -40,17 +40,17 @@ function isObj(obj) {
 }
 const ensurePresent = (value) => {
     if (value == null) {
-        throw new error_1.PostPeerError(`Expected a value to be given but received ${value} instead.`);
+        throw new error_1.PostpeerError(`Expected a value to be given but received ${value} instead.`);
     }
     return value;
 };
 exports.ensurePresent = ensurePresent;
 const validatePositiveInteger = (name, n) => {
     if (typeof n !== 'number' || !Number.isInteger(n)) {
-        throw new error_1.PostPeerError(`${name} must be an integer`);
+        throw new error_1.PostpeerError(`${name} must be an integer`);
     }
     if (n < 0) {
-        throw new error_1.PostPeerError(`${name} must be a positive integer`);
+        throw new error_1.PostpeerError(`${name} must be a positive integer`);
     }
     return n;
 };
@@ -60,7 +60,7 @@ const coerceInteger = (value) => {
         return Math.round(value);
     if (typeof value === 'string')
         return parseInt(value, 10);
-    throw new error_1.PostPeerError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+    throw new error_1.PostpeerError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
 };
 exports.coerceInteger = coerceInteger;
 const coerceFloat = (value) => {
@@ -68,7 +68,7 @@ const coerceFloat = (value) => {
         return value;
     if (typeof value === 'string')
         return parseFloat(value);
-    throw new error_1.PostPeerError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+    throw new error_1.PostpeerError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
 };
 exports.coerceFloat = coerceFloat;
 const coerceBoolean = (value) => {

package/internal/utils/values.mjs

@@ -1,5 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { PostPeerError } from "../../core/error.mjs";
+import { PostpeerError } from "../../core/error.mjs";
 // https://url.spec.whatwg.org/#url-scheme-string
 const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
 export const isAbsoluteURL = (url) => {
@@ -31,16 +31,16 @@ export function isObj(obj) {
 }
 export const ensurePresent = (value) => {
     if (value == null) {
-        throw new PostPeerError(`Expected a value to be given but received ${value} instead.`);
+        throw new PostpeerError(`Expected a value to be given but received ${value} instead.`);
     }
     return value;
 };
 export const validatePositiveInteger = (name, n) => {
     if (typeof n !== 'number' || !Number.isInteger(n)) {
-        throw new PostPeerError(`${name} must be an integer`);
+        throw new PostpeerError(`${name} must be an integer`);
     }
     if (n < 0) {
-        throw new PostPeerError(`${name} must be a positive integer`);
+        throw new PostpeerError(`${name} must be a positive integer`);
     }
     return n;
 };
@@ -49,14 +49,14 @@ export const coerceInteger = (value) => {
         return Math.round(value);
     if (typeof value === 'string')
         return parseInt(value, 10);
-    throw new PostPeerError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+    throw new PostpeerError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
 };
 export const coerceFloat = (value) => {
     if (typeof value === 'number')
         return value;
     if (typeof value === 'string')
         return parseFloat(value);
-    throw new PostPeerError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+    throw new PostpeerError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
 };
 export const coerceBoolean = (value) => {
     if (typeof value === 'boolean')

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@postpeer/node",
-  "version": "0.3.2",
-  "description": "The official TypeScript library for the Post Peer API",
-  "author": "Post Peer <>",
+  "version": "0.4.0",
+  "description": "The official TypeScript library for the Postpeer API",
+  "author": "Postpeer <>",
   "types": "./index.d.ts",
   "main": "./index.js",
   "type": "commonjs",
-  "repository": "github:PostPeer-API/postpeer-typescript",
+  "repository": "github:PostPeer-API/postpeer-node",
   "license": "Apache-2.0",
   "files": [
     "**/*"

package/src/client.ts

@@ -54,7 +54,7 @@ export interface ClientOptions {
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
    *
-   * Defaults to process.env['POST_PEER_BASE_URL'].
+   * Defaults to process.env['POSTPEER_BASE_URL'].
    */
   baseURL?: string | null | undefined;
 
@@ -108,7 +108,7 @@ export interface ClientOptions {
   /**
    * Set the log level.
    *
-   * Defaults to process.env['POST_PEER_LOG'] or 'warn' if it isn't set.
+   * Defaults to process.env['POSTPEER_LOG'] or 'warn' if it isn't set.
    */
   logLevel?: LogLevel | undefined;
 
@@ -121,9 +121,9 @@ export interface ClientOptions {
 }
 
 /**
- * API Client for interfacing with the Post Peer API.
+ * API Client for interfacing with the Postpeer API.
  */
-export class PostPeer {
+export class Postpeer {
   apiKey: string;
 
   baseURL: string;
@@ -139,10 +139,10 @@ export class PostPeer {
   private _options: ClientOptions;
 
   /**
-   * API Client for interfacing with the Post Peer API.
+   * API Client for interfacing with the Postpeer API.
    *
    * @param {string | undefined} [opts.apiKey=process.env['POSTPEER_API_KEY'] ?? undefined]
-   * @param {string} [opts.baseURL=process.env['POST_PEER_BASE_URL'] ?? https://api.example.com] - Override the default base URL for the API.
+   * @param {string} [opts.baseURL=process.env['POSTPEER_BASE_URL'] ?? https://api.example.com] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
    * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
@@ -151,13 +151,13 @@ export class PostPeer {
    * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
    */
   constructor({
-    baseURL = readEnv('POST_PEER_BASE_URL'),
+    baseURL = readEnv('POSTPEER_BASE_URL'),
     apiKey = readEnv('POSTPEER_API_KEY'),
     ...opts
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
-      throw new Errors.PostPeerError(
-        "The POSTPEER_API_KEY environment variable is missing or empty; either provide it, or instantiate the PostPeer client with an apiKey option, like new PostPeer({ apiKey: 'My API Key' }).",
+      throw new Errors.PostpeerError(
+        "The POSTPEER_API_KEY environment variable is missing or empty; either provide it, or instantiate the Postpeer client with an apiKey option, like new Postpeer({ apiKey: 'My API Key' }).",
       );
     }
 
@@ -168,14 +168,14 @@ export class PostPeer {
     };
 
     this.baseURL = options.baseURL!;
-    this.timeout = options.timeout ?? PostPeer.DEFAULT_TIMEOUT /* 1 minute */;
+    this.timeout = options.timeout ?? Postpeer.DEFAULT_TIMEOUT /* 1 minute */;
     this.logger = options.logger ?? console;
     const defaultLogLevel = 'warn';
     // Set default logLevel early so that we can log a warning in parseLogLevel.
     this.logLevel = defaultLogLevel;
     this.logLevel =
       parseLogLevel(options.logLevel, 'ClientOptions.logLevel', this) ??
-      parseLogLevel(readEnv('POST_PEER_LOG'), "process.env['POST_PEER_LOG']", this) ??
+      parseLogLevel(readEnv('POSTPEER_LOG'), "process.env['POSTPEER_LOG']", this) ??
       defaultLogLevel;
     this.fetchOptions = options.fetchOptions;
     this.maxRetries = options.maxRetries ?? 2;
@@ -710,10 +710,10 @@ export class PostPeer {
     }
   }
 
-  static PostPeer = this;
+  static Postpeer = this;
   static DEFAULT_TIMEOUT = 60000; // 1 minute
 
-  static PostPeerError = Errors.PostPeerError;
+  static PostpeerError = Errors.PostpeerError;
   static APIError = Errors.APIError;
   static APIConnectionError = Errors.APIConnectionError;
   static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
@@ -736,13 +736,13 @@ export class PostPeer {
   media: API.Media = new API.Media(this);
 }
 
-PostPeer.Health = Health;
-PostPeer.Connect = Connect;
-PostPeer.Platforms = Platforms;
-PostPeer.Posts = Posts;
-PostPeer.Media = Media;
+Postpeer.Health = Health;
+Postpeer.Connect = Connect;
+Postpeer.Platforms = Platforms;
+Postpeer.Posts = Posts;
+Postpeer.Media = Media;
 
-export declare namespace PostPeer {
+export declare namespace Postpeer {
   export type RequestOptions = Opts.RequestOptions;
 
   export {

package/src/core/api-promise.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { type PostPeer } from '../client';
+import { type Postpeer } from '../client';
 
 import { type PromiseOrValue } from '../internal/types';
 import { APIResponseProps, defaultParseResponse } from '../internal/parse';
@@ -11,13 +11,13 @@ import { APIResponseProps, defaultParseResponse } from '../internal/parse';
  */
 export class APIPromise<T> extends Promise<T> {
   private parsedPromise: Promise<T> | undefined;
-  #client: PostPeer;
+  #client: Postpeer;
 
   constructor(
-    client: PostPeer,
+    client: Postpeer,
     private responsePromise: Promise<APIResponseProps>,
     private parseResponse: (
-      client: PostPeer,
+      client: Postpeer,
       props: APIResponseProps,
     ) => PromiseOrValue<T> = defaultParseResponse,
   ) {

package/src/core/error.ts

@@ -2,13 +2,13 @@
 
 import { castToError } from '../internal/errors';
 
-export class PostPeerError extends Error {}
+export class PostpeerError extends Error {}
 
 export class APIError<
   TStatus extends number | undefined = number | undefined,
   THeaders extends Headers | undefined = Headers | undefined,
   TError extends Object | undefined = Object | undefined,
-> extends PostPeerError {
+> extends PostpeerError {
   /** HTTP status for the response that caused the error */
   readonly status: TStatus;
   /** HTTP headers for the response that caused the error */

package/src/core/resource.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import type { PostPeer } from '../client';
+import type { Postpeer } from '../client';
 
 export abstract class APIResource {
-  protected _client: PostPeer;
+  protected _client: Postpeer;
 
-  constructor(client: PostPeer) {
+  constructor(client: Postpeer) {
     this._client = client;
   }
 }

package/src/index.ts

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { PostPeer as default } from './client';
+export { Postpeer as default } from './client';
 
 export { type Uploadable, toFile } from './core/uploads';
 export { APIPromise } from './core/api-promise';
-export { PostPeer, type ClientOptions } from './client';
+export { Postpeer, type ClientOptions } from './client';
 export {
-  PostPeerError,
+  PostpeerError,
   APIError,
   APIConnectionError,
   APIConnectionTimeoutError,

package/src/internal/parse.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import type { FinalRequestOptions } from './request-options';
-import { type PostPeer } from '../client';
+import { type Postpeer } from '../client';
 import { formatRequestDetails, loggerFor } from './utils/log';
 
 export type APIResponseProps = {
@@ -13,7 +13,7 @@ export type APIResponseProps = {
   startTime: number;
 };
 
-export async function defaultParseResponse<T>(client: PostPeer, props: APIResponseProps): Promise<T> {
+export async function defaultParseResponse<T>(client: Postpeer, props: APIResponseProps): Promise<T> {
   const { response, requestLogID, retryOfRequestLogID, startTime } = props;
   const body = await (async () => {
     // fetch refuses to read the body when the status code is 204.

package/src/internal/shims.ts

@@ -16,7 +16,7 @@ export function getDefaultFetch(): Fetch {
   }
 
   throw new Error(
-    '`fetch` is not defined as a global; Either pass `fetch` to the client, `new PostPeer({ fetch })` or polyfill the global, `globalThis.fetch = fetch`',
+    '`fetch` is not defined as a global; Either pass `fetch` to the client, `new Postpeer({ fetch })` or polyfill the global, `globalThis.fetch = fetch`',
   );
 }
 

package/src/internal/uploads.ts

@@ -1,6 +1,6 @@
 import { type RequestOptions } from './request-options';
 import type { FilePropertyBag, Fetch } from './builtin-types';
-import type { PostPeer } from '../client';
+import type { Postpeer } from '../client';
 import { ReadableStreamFrom } from './shims';
 
 export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | DataView;
@@ -74,7 +74,7 @@ export const isAsyncIterable = (value: any): value is AsyncIterable<any> =>
  */
 export const maybeMultipartFormRequestOptions = async (
   opts: RequestOptions,
-  fetch: PostPeer | Fetch,
+  fetch: Postpeer | Fetch,
 ): Promise<RequestOptions> => {
   if (!hasUploadableValue(opts.body)) return opts;
 
@@ -85,7 +85,7 @@ type MultipartFormRequestOptions = Omit<RequestOptions, 'body'> & { body: unknow
 
 export const multipartFormRequestOptions = async (
   opts: MultipartFormRequestOptions,
-  fetch: PostPeer | Fetch,
+  fetch: Postpeer | Fetch,
 ): Promise<RequestOptions> => {
   return { ...opts, body: await createForm(opts.body, fetch) };
 };
@@ -98,7 +98,7 @@ const supportsFormDataMap = /* @__PURE__ */ new WeakMap<Fetch, Promise<boolean>>
  * This function detects if the fetch function provided supports the global FormData object to avoid
  * confusing error messages later on.
  */
-function supportsFormData(fetchObject: PostPeer | Fetch): Promise<boolean> {
+function supportsFormData(fetchObject: Postpeer | Fetch): Promise<boolean> {
   const fetch: Fetch = typeof fetchObject === 'function' ? fetchObject : (fetchObject as any).fetch;
   const cached = supportsFormDataMap.get(fetch);
   if (cached) return cached;
@@ -124,7 +124,7 @@ function supportsFormData(fetchObject: PostPeer | Fetch): Promise<boolean> {
 
 export const createForm = async <T = Record<string, unknown>>(
   body: T | undefined,
-  fetch: PostPeer | Fetch,
+  fetch: Postpeer | Fetch,
 ): Promise<FormData> => {
   if (!(await supportsFormData(fetch))) {
     throw new TypeError(

package/src/internal/utils/base64.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { PostPeerError } from '../../core/error';
+import { PostpeerError } from '../../core/error';
 import { encodeUTF8 } from './bytes';
 
 export const toBase64 = (data: string | Uint8Array | null | undefined): string => {
@@ -18,7 +18,7 @@ export const toBase64 = (data: string | Uint8Array | null | undefined): string =
     return btoa(String.fromCharCode.apply(null, data as any));
   }
 
-  throw new PostPeerError('Cannot generate base64 string; Expected `Buffer` or `btoa` to be defined');
+  throw new PostpeerError('Cannot generate base64 string; Expected `Buffer` or `btoa` to be defined');
 };
 
 export const fromBase64 = (str: string): Uint8Array => {
@@ -36,5 +36,5 @@ export const fromBase64 = (str: string): Uint8Array => {
     return buf;
   }
 
-  throw new PostPeerError('Cannot decode base64 string; Expected `Buffer` or `atob` to be defined');
+  throw new PostpeerError('Cannot decode base64 string; Expected `Buffer` or `atob` to be defined');
 };

package/src/internal/utils/log.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { hasOwn } from './values';
-import { type PostPeer } from '../../client';
+import { type Postpeer } from '../../client';
 import { RequestOptions } from '../request-options';
 
 type LogFn = (message: string, ...rest: unknown[]) => void;
@@ -24,7 +24,7 @@ const levelNumbers = {
 export const parseLogLevel = (
   maybeLevel: string | undefined,
   sourceName: string,
-  client: PostPeer,
+  client: Postpeer,
 ): LogLevel | undefined => {
   if (!maybeLevel) {
     return undefined;
@@ -60,7 +60,7 @@ const noopLogger = {
 
 let cachedLoggers = /* @__PURE__ */ new WeakMap<Logger, [LogLevel, Logger]>();
 
-export function loggerFor(client: PostPeer): Logger {
+export function loggerFor(client: Postpeer): Logger {
   const logger = client.logger;
   const logLevel = client.logLevel ?? 'off';
   if (!logger) {

package/src/internal/utils/path.ts

@@ -1,4 +1,4 @@
-import { PostPeerError } from '../../core/error';
+import { PostpeerError } from '../../core/error';
 
 /**
  * Percent-encode everything that isn't safe to have in a path without encoding safe chars.
@@ -72,7 +72,7 @@ export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
         return acc + spaces + arrows;
       }, '');
 
-      throw new PostPeerError(
+      throw new PostpeerError(
         `Path parameters result in path with invalid segments:\n${invalidSegments
           .map((e) => e.error)
           .join('\n')}\n${path}\n${underline}`,

package/src/internal/utils/values.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { PostPeerError } from '../../core/error';
+import { PostpeerError } from '../../core/error';
 
 // https://url.spec.whatwg.org/#url-scheme-string
 const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
@@ -39,7 +39,7 @@ export function isObj(obj: unknown): obj is Record<string, unknown> {
 
 export const ensurePresent = <T>(value: T | null | undefined): T => {
   if (value == null) {
-    throw new PostPeerError(`Expected a value to be given but received ${value} instead.`);
+    throw new PostpeerError(`Expected a value to be given but received ${value} instead.`);
   }
 
   return value;
@@ -47,10 +47,10 @@ export const ensurePresent = <T>(value: T | null | undefined): T => {
 
 export const validatePositiveInteger = (name: string, n: unknown): number => {
   if (typeof n !== 'number' || !Number.isInteger(n)) {
-    throw new PostPeerError(`${name} must be an integer`);
+    throw new PostpeerError(`${name} must be an integer`);
   }
   if (n < 0) {
-    throw new PostPeerError(`${name} must be a positive integer`);
+    throw new PostpeerError(`${name} must be a positive integer`);
   }
   return n;
 };
@@ -59,14 +59,14 @@ export const coerceInteger = (value: unknown): number => {
   if (typeof value === 'number') return Math.round(value);
   if (typeof value === 'string') return parseInt(value, 10);
 
-  throw new PostPeerError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+  throw new PostpeerError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
 };
 
 export const coerceFloat = (value: unknown): number => {
   if (typeof value === 'number') return value;
   if (typeof value === 'string') return parseFloat(value);
 
-  throw new PostPeerError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+  throw new PostpeerError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
 };
 
 export const coerceBoolean = (value: unknown): boolean => {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.3.2'; // x-release-please-version
+export const VERSION = '0.4.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.3.2";
+export declare const VERSION = "0.4.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.3.2";
+export declare const VERSION = "0.4.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.3.2'; // x-release-please-version
+exports.VERSION = '0.4.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.3.2'; // x-release-please-version
+export const VERSION = '0.4.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map