Upgrade typings for v0.4.0-unstable.3 release, misc. fixes

Author: auguwu

.api-server-version

@@ -1 +1 @@
-0.4.0-unstable.2
+0.4.0-unstable.3

.sdk-version

@@ -1 +1 @@
-0.1.0-unstable
+0.2.0-unstable

packages/sdk/package.json

@@ -28,6 +28,8 @@
         "defu": "6.1.2"
     },
     "devDependencies": {
-        "@types/node": "18.16.14"
+        "@types/node": "18.16.14",
+        "testcontainers": "9.8.0",
+        "vitest": "0.31.2"
     }
 }

packages/sdk/src/client.ts

@@ -25,15 +25,14 @@ import type {
     responses
 } from '@ncharts/types';
 
+import { hasOwnProperty, isBrowser, isObject, type Ctor } from '@noelware/utils';
 import { DEFAULT_API_VERSION, DEFAULT_BASE_URL } from './constants';
-import { hasOwnProperty, isBrowser, isObject } from '@noelware/utils';
-import { transformJSON, transformYaml } from './internal';
+import { transformJSON, transformYaml, assert } from './internal';
 import type { AbstractAuthStrategy } from './auth';
 import { OrganizationContainer } from './containers/organizations';
 import { ApiKeysContainer } from './containers/apikeys';
 import { UserContainer } from './containers/users';
 import { HTTPError } from './errors/HTTPError';
-import assert from 'assert';
 import defu from 'defu';
 
 export type HTTPMethod = 'get' | 'put' | 'head' | 'post' | 'patch' | 'delete';
@@ -42,7 +41,7 @@ export const Methods: readonly HTTPMethod[] = ['get', 'put', 'head', 'post', 'pa
 /**
  * Fetch implementation blue-print.
  */
-export type Fetch = (input: RequestInit | URL, init?: RequestInit) => Promise<Response>;
+export type Fetch = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
 
 /**
  * FormData implementation blue-print
@@ -80,7 +79,7 @@ export interface ClientOptions {
      * To avoid any errors when requesting data, you will need to install the [form-data](https://npm.im/form-data)
      * Node.js package to send form data.
      */
-    FormData?: { new (...args: any[]): FormData };
+    FormData?: Ctor<FormData>;
 
     /**
      * Base URL to send requests to
@@ -158,7 +157,9 @@ export interface RequestOptions<R extends Route, Method extends HTTPMethod, Body
 const kClientOptions = {
     apiVersion: DEFAULT_API_VERSION,
     baseURL: DEFAULT_BASE_URL,
-    headers: {}
+    headers: {
+        'User-Agent': 'Noelware/charted-sdk-js (+https://github.com/charted-dev/js-sdk)'
+    }
 } satisfies ClientOptions;
 
 export class Client {
@@ -570,7 +571,7 @@ export class Client {
 
         if (url.match(/{([\w\.]+)}/g) && options !== undefined && hasOwnProperty(options, 'pathParameters')) {
             const params = options.pathParameters as Record<string, unknown>;
-            formedUrl = formedUrl.replaceAll(/([\w\.]+)}/g, (_, key) => {
+            formedUrl = formedUrl.replaceAll(/{([\w\.]+)}/g, (_, key) => {
                 if (hasOwnProperty(params, key)) {
                     return String(params[key]);
                 }
@@ -596,6 +597,6 @@ export class Client {
             }
         }
 
-        return formedUrl;
+        return formedUrl.replace(/\/+$/, '');
     }
 }

packages/sdk/src/containers/repositories.ts

@@ -28,7 +28,8 @@ export class RepositoryContainer {
     ) {}
 
     /**
-     * Retrives a list of all the repositories available
+     * Fetch all the available user or organization repositories
+     * @param options Request options object to override.
      */
     all(
         options?: RequestOptions<'/users/{idOrName}/repositories', 'get', unknown>
@@ -55,6 +56,12 @@ export class RepositoryContainer {
         );
     }
 
+    /**
+     * Returns a single repository from a user or organization.
+     * @param idOrName The snowflake or the name of the repository to fetch from
+     * @param options Request options
+     * @returns A single repository, if it was found.
+     */
     get(
         idOrName: NameOrSnowflake,
         options?: RequestOptions<'/users/{idOrName}/repositories/{repoIdOrName}', 'get', unknown>
@@ -86,6 +93,10 @@ export class RepositoryContainer {
         payload: payloads.repositories.CreateRepositoryPayload,
         options?: RequestOptions<'/users/{idOrName}/repositories', 'put', unknown>
     ): Promise<ApiResponse<responses.repositories.Create>> {
+        if (this.type === 'user' && this.owner !== '@me') {
+            throw new Error('You must use <client>.me.repositories.create() to create a repository on your account.');
+        }
+
         return new Promise((resolve, reject) =>
             this.client
                 .put(

packages/sdk/src/errors/HTTPError.ts

@@ -15,21 +15,33 @@
  * limitations under the License.
  */
 
+import { hasOwnProperty, isObject } from '@noelware/utils';
+import { STATUS_CODES } from 'http';
 import { ApiError } from '@ncharts/types';
-import { isObject } from '@noelware/utils';
+
+const isFatalError = (value: unknown) => isObject<Record<string, unknown>>(value) && hasOwnProperty(value, 'class');
 
 /**
  * {@link Error} that represents an HTTP error.
  */
 export class HTTPError extends Error {
     constructor(public readonly statusCode: number, errors: ApiError<unknown>[] = []) {
-        super(`Received status code [${statusCode}] with errors\n${HTTPError._formatErrors(errors)}`.trim());
+        super(
+            `Received status code ${statusCode} (${
+                STATUS_CODES[statusCode] || 'Unknown'
+            }) with errors\n${HTTPError._formatErrors(errors)}`.trim()
+        );
     }
 
     private static _formatErrors(errors: ApiError<unknown>[]) {
         let buf = '';
         for (let i = 0; i < errors.length; i++) {
             const error = errors[i];
+            if (isFatalError(error)) {
+                const details = error.detail as Record<string, unknown>;
+                console.log(details);
+            }
+
             buf += `[${error.code}]: ${error.message}${
                 error.detail !== undefined
                     ? `\n${

packages/sdk/src/index.ts

@@ -20,6 +20,7 @@ import { Client, type ClientOptions } from './client';
 export * as constants from './constants';
 export type * from './client';
 export * from './errors';
+export * from './auth';
 
 /**
  * Creates a new {@link Client} instance.

packages/sdk/src/internal.ts

@@ -22,9 +22,28 @@ interface YAML {
     load(text: string, ...args: any[]): unknown;
 }
 
+export const assert = (condition: boolean, message: string) => {
+    if (!condition) {
+        throw new Error(message);
+    }
+};
+
 export const transformJSON = async <T>(resp: Response) => {
     if (!resp.ok) {
-        const data = await resp.json().catch(() => ({}));
+        const data = await resp.json().catch((ex) => ({
+            success: false,
+            errors: [
+                {
+                    code: 'SDK_ERROR',
+                    message: ex instanceof Error ? ex.message : 'Unknown error',
+                    details: {
+                        sdk: true,
+                        error: ex
+                    }
+                }
+            ]
+        }));
+
         throw new HTTPError(resp.status, hasOwnProperty(data, 'errors') ? data.errors : []);
     }
 

packages/sdk/tsconfig.json

@@ -5,8 +5,8 @@
         "removeComments": false,
         "types": ["node"],
         "baseUrl": ".",
-        "noEmit": true // tsup does this for us=
+        "noEmit": true
     },
     "exclude": ["node_modules"],
-    "include": ["**/*.ts"]
+    "include": ["**/*.ts", "vite.config.ts"]
 }