feat(sdk): rename sdk classes, modules, and debug namespaces for consistency

Author: Convly

README.md

@@ -83,9 +83,9 @@ pnpm add @strapi/sdk-js
 To interact with your Strapi backend, initialize the SDK with your Strapi API base URL:
 
 ```typescript
-import { strapiSDK } from '@strapi/sdk-js';
+import { strapi } from '@strapi/sdk-js';
 
-const sdk = strapiSDK({ baseURL: 'http://localhost:1337/api' });
+const sdk = strapi({ baseURL: 'http://localhost:1337/api' });
 ```
 
 Alternatively, use a `<script>` tag in a browser environment:
@@ -94,7 +94,7 @@ Alternatively, use a `<script>` tag in a browser environment:
 <script src="https://cdn.jsdelivr.net/npm/@strapi/sdk-js"></script>
 
 <script>
-  const sdk = strapi.strapiSDK({ baseURL: 'http://localhost:1337/api' });
+  const sdk = strapi.strapi({ baseURL: 'http://localhost:1337/api' });
 </script>
 ```
 
@@ -107,7 +107,7 @@ The SDK supports multiple authentication strategies for accessing authenticated
 If your Strapi instance uses API tokens, configure the SDK like this:
 
 ```typescript
-const sdk = strapiSDK({
+const sdk = strapi({
   baseURL: 'http://localhost:1337/api',
   auth: {
     strategy: 'api-token',
@@ -230,25 +230,25 @@ For **browser environments**, debug capabilities are intentionally turned off to
 The `debug` tool allows you to control logs using wildcard patterns (`*`):
 
 - `*`: enable all logs.
-- `sdk:module`: enable logs for a specific module.
-- `sdk:module1,sdk:module2`: enable logs for multiple modules.
-- `sdk:*`: match all namespaces under `sdk`.
-- `sdk:*,-sdk:module2`: enable all logs except those from `sdk:module2`.
+- `strapi:module`: enable logs for a specific module.
+- `strapi:module1,sdk:module2`: enable logs for multiple modules.
+- `strapi:*`: match all namespaces under `strapi`.
+- `strapi:*,-strapi:module2`: enable all logs except those from `strapi:module2`.
 
 ### Namespaces
 
 Below is a list of available namespaces to use:
 
-| Namespace                             | Description                                                                               |
-|---------------------------------------|-------------------------------------------------------------------------------------------|
-| `sdk:core`                            | Logs SDK initialization, configuration validation, and HTTP client setup.                 |
-| `sdk:validators:sdk`                  | Logs details related to SDK configuration validation.                                     |
-| `sdk:validators:url`                  | Logs URL validation processes.                                                            |
-| `sdk:http`                            | Logs HTTP client setup, request processing, and response/error handling.                  |
-| `sdk:auth:factory`                    | Logs the registration and creation of authentication providers.                           |
-| `sdk:auth:manager`                    | Logs authentication lifecycle management.                                                 |
-| `sdk:auth:provider:api-token`         | Logs operations related to API token authentication.                                      |
-| `sdk:auth:provider:users-permissions` | Logs operations related to user and permissions-based authentication.                     |
-| `sdk:ct:collection`                   | Logs interactions with collection-type content managers.                                  |
-| `sdk:ct:single`                       | Logs interactions with single-type content managers.                                      |
-| `sdk:utils:url-helper`                | Logs URL helper utility operations (e.g., appending query parameters or formatting URLs). |
+| Namespace                                | Description                                                                               |
+|------------------------------------------|-------------------------------------------------------------------------------------------|
+| `strapi:core`                            | Logs SDK initialization, configuration validation, and HTTP client setup.                 |
+| `strapi:validators:config`               | Logs details related to SDK configuration validation.                                     |
+| `strapi:validators:url`                  | Logs URL validation processes.                                                            |
+| `strapi:http`                            | Logs HTTP client setup, request processing, and response/error handling.                  |
+| `strapi:auth:factory`                    | Logs the registration and creation of authentication providers.                           |
+| `strapi:auth:manager`                    | Logs authentication lifecycle management.                                                 |
+| `strapi:auth:provider:api-token`         | Logs operations related to API token authentication.                                      |
+| `strapi:auth:provider:users-permissions` | Logs operations related to user and permissions-based authentication.                     |
+| `strapi:ct:collection`                   | Logs interactions with collection-type content managers.                                  |
+| `strapi:ct:single`                       | Logs interactions with single-type content managers.                                      |
+| `strapi:utils:url-helper`                | Logs URL helper utility operations (e.g., appending query parameters or formatting URLs). |

index.js

@@ -0,0 +1,41 @@
+const { strapi } = require('./dist/bundle.cjs');
+
+const sdk = strapi({
+  baseURL: 'http://localhost:1337/api',
+  auth: {
+    strategy: 'api-token',
+    options: {
+      // identifier: 'bob@bob.com',
+      // password: 'Admin1Admin',
+      token:
+        'f45e93601ace4f1806b69ca2fa1567bd7f5bff5d608af870fa89664b149b05493fb030973e5628aa288878f6be01df430a4505fe32b5bd29632ebedba69b46b54e49d638aecd78cfb07ec02a9ad5867ecea215711949d43ed3ae3d8d8739aeab83f4b0e4ce23405a4328aba8ea5c1c06cbc7b2bdbdfb597f8033841e47671f79',
+    },
+  },
+});
+
+// global interceptors
+// per request interceptors
+
+const cats = sdk.collection('categories');
+
+cats
+  .find({
+    fields: ['name', 'locale'],
+    filters: { locale: 'en' },
+    sort: 'updatedAt:desc',
+  })
+  .then(({ data, meta }) => {
+    console.log('Categories:', data.slice(0, 2));
+    console.log('Pagination', meta.pagination);
+
+    return data.at(0);
+  })
+  .then(async (cat) => {
+    const x = await cats.findOne(cat.documentId);
+
+    console.log('Found one');
+    console.log(x);
+  })
+  .catch((error) => {
+    console.error('Error fetching categories:', error.name, error.message);
+  });

src/auth/factory/factory.ts

@@ -1,11 +1,11 @@
 import createDebug from 'debug';
 
-import { StrapiSDKError } from '../../errors';
+import { StrapiError } from '../../errors';
 
 import type { AuthProviderCreator, AuthProviderMap, CreateAuthProviderParams } from './types';
 import type { AuthProvider } from '../providers';
 
-const debug = createDebug('sdk:auth:factory');
+const debug = createDebug('strapi:auth:factory');
 
 /**
  * A factory class responsible for creating and managing authentication providers.
@@ -26,7 +26,7 @@ export class AuthProviderFactory<T_Providers extends AuthProviderMap = {}> {
    *
    * @returns An instance of an AuthProvider initialized with the given options.
    *
-   * @throws {StrapiSDKError} Throws an error if the specified strategy is not registered in the factory.
+   * @throws {StrapiError} Throws an error if the specified strategy is not registered in the factory.
    *
    * @example
    * ```typescript
@@ -48,7 +48,7 @@ export class AuthProviderFactory<T_Providers extends AuthProviderMap = {}> {
 
     if (!creator) {
       debug('the %o auth strategy is not registered, skipping', authStrategy);
-      throw new StrapiSDKError(`Auth strategy "${authStrategy}" is not supported.`);
+      throw new StrapiError(`Auth strategy "${authStrategy}" is not supported.`);
     }
 
     const instance = creator(options);

src/auth/manager.ts

@@ -11,7 +11,7 @@ import type {
   UsersPermissionsAuthProviderOptions,
 } from './providers';
 
-const debug = createDebug('sdk:auth:manager');
+const debug = createDebug('strapi:auth:manager');
 
 /**
  * Manages authentication by using different authentication providers and strategies.

src/auth/providers/abstract.ts

@@ -51,7 +51,7 @@ export abstract class AbstractAuthProvider<T = unknown> implements AuthProvider
    * It is called within the constructor to ensure that all required options adhere
    * to the expected format or values before proceeding with operational methods.
    *
-   * @throws {StrapiSDKValidationError} If the validation fails due to invalid or missing options.
+   * @throws {StrapiValidationError} If the validation fails due to invalid or missing options.
    */
   protected abstract preflightValidation(): void;
 

src/auth/providers/api-token.ts

@@ -1,10 +1,10 @@
 import createDebug from 'debug';
 
-import { StrapiSDKValidationError } from '../../errors';
+import { StrapiValidationError } from '../../errors';
 
 import { AbstractAuthProvider } from './abstract';
 
-const debug = createDebug('sdk:auth:provider:api-token');
+const debug = createDebug('strapi:auth:provider:api-token');
 
 const API_TOKEN_AUTH_STRATEGY_IDENTIFIER = 'api-token';
 
@@ -41,7 +41,7 @@ export class ApiTokenAuthProvider extends AbstractAuthProvider<ApiTokenAuthProvi
     if ((typeof this._token as unknown) !== 'string' || this._token.trim().length === 0) {
       debug('invalid api token provided: %o (%o)', this._token, typeof this._token);
 
-      throw new StrapiSDKValidationError(
+      throw new StrapiValidationError(
         `A valid API token is required when using the api-token auth strategy. Got "${this._token}"`
       );
     }

src/auth/providers/users-permissions.ts

@@ -1,11 +1,11 @@
 import createDebug from 'debug';
 
-import { StrapiSDKValidationError } from '../../errors';
+import { StrapiValidationError } from '../../errors';
 import { HttpClient } from '../../http';
 
 import { AbstractAuthProvider } from './abstract';
 
-const debug = createDebug('sdk:auth:provider:users-permissions');
+const debug = createDebug('strapi:auth:provider:users-permissions');
 
 const USERS_PERMISSIONS_AUTH_STRATEGY_IDENTIFIER = 'users-permissions';
 const LOCAL_AUTH_ENDPOINT = '/auth/local';
@@ -68,7 +68,7 @@ export class UsersPermissionsAuthProvider extends AbstractAuthProvider<UsersPerm
     ) {
       debug('invalid options provided: %s (%s)', this._options, typeof this._options);
 
-      throw new StrapiSDKValidationError(
+      throw new StrapiValidationError(
         'Missing valid options for initializing the Users & Permissions auth provider.'
       );
     }
@@ -78,15 +78,15 @@ export class UsersPermissionsAuthProvider extends AbstractAuthProvider<UsersPerm
     if ((typeof identifier as unknown) !== 'string') {
       debug('invalid identifier provided: %s (%s)', identifier, typeof identifier);
 
-      throw new StrapiSDKValidationError(
+      throw new StrapiValidationError(
         `The "identifier" option must be a string, but got "${typeof identifier}"`
       );
     }
 
     if ((typeof password as unknown) !== 'string') {
       debug('invalid password provided: %s (%s)', password, typeof password);
 
-      throw new StrapiSDKValidationError(
+      throw new StrapiValidationError(
         `The "password" option must be a string, but got "${typeof password}"`
       );
     }

src/content-types/collection/manager.ts

@@ -8,7 +8,7 @@ import {
 } from '../../types/content-api';
 import { URLHelper } from '../../utilities';
 
-const debug = createDebug('sdk:ct:collection');
+const debug = createDebug('strapi:ct:collection');
 
 /**
  * A service class designed for interacting with a collection-type resource in a Strapi app.

src/content-types/single/manager.ts

@@ -4,7 +4,7 @@ import { HttpClient } from '../../http';
 import { BaseQueryParams, GenericDocumentResponse } from '../../types/content-api';
 import { URLHelper } from '../../utilities';
 
-const debug = createDebug('sdk:ct:single');
+const debug = createDebug('strapi:ct:single');
 
 /**
  * A service class designed for interacting with a single-type resource in a Strapi app.

src/errors/index.ts

@@ -1,3 +1,3 @@
-export * from './sdk';
+export * from './strapi';
 export * from './url';
 export * from './http';

src/errors/sdk.ts renamed to src/errors/strapi.ts

@@ -1,4 +1,4 @@
-export class StrapiSDKError extends Error {
+export class StrapiError extends Error {
   constructor(
     cause: unknown = undefined,
     message: string = 'An error occurred in the Strapi SDK. Please check the logs for more information.'
@@ -9,7 +9,7 @@ export class StrapiSDKError extends Error {
   }
 }
 
-export class StrapiSDKValidationError extends StrapiSDKError {
+export class StrapiValidationError extends StrapiError {
   constructor(
     cause: unknown = undefined,
     message: string = 'Some of the provided values are not valid.'
@@ -18,7 +18,7 @@ export class StrapiSDKValidationError extends StrapiSDKError {
   }
 }
 
-export class StrapiSDKInitializationError extends StrapiSDKError {
+export class StrapiInitializationError extends StrapiError {
   constructor(cause: unknown = undefined, message: string = 'Could not initialize the Strapi SDK') {
     super(cause, message);
   }

src/http/client.ts

@@ -18,7 +18,7 @@ import { HttpInterceptorManager } from './interceptor-manager';
 
 import type { HttpClientConfig, InterceptorManagerMap } from './types';
 
-const debug = createDebug('sdk:http');
+const debug = createDebug('strapi:http');
 
 /**
  * Strapi SDK's HTTP Client

src/index.ts

@@ -1,7 +1,7 @@
-import { StrapiSDK } from './sdk';
-import { StrapiSDKValidator } from './validators';
+import { Strapi } from './sdk';
+import { StrapiConfigValidator } from './validators';
 
-import type { StrapiSDKConfig } from './sdk';
+import type { StrapiConfig } from './sdk';
 
 export * from './errors';
 
@@ -23,7 +23,7 @@ export * from './errors';
  * @example
  * ```typescript
  * // Basic configuration using API token auth
- * const sdkConfig = {
+ * const config = {
  *   baseURL: 'https://api.example.com',
  *   auth: {
  *     strategy: 'api-token',
@@ -32,25 +32,25 @@ export * from './errors';
  * };
  *
  * // Create the SDK instance
- * const strapiSDK = strapiSDK(sdkConfig);
+ * const sdk = strapi(config);
  *
  * // Using the SDK to fetch content from a custom endpoint
- * const response = await strapiSDK.fetch('/content-endpoint');
+ * const response = await sdk.fetch('/content-endpoint');
  * const data = await response.json();
  *
  * console.log(data);
  * ```
  *
- * @throws {StrapiSDKInitializationError} If the provided baseURL does not conform to a valid HTTP or HTTPS URL,
+ * @throws {StrapiInitializationError} If the provided baseURL doesn't conform to a valid HTTP or HTTPS URL,
  *                                        or if the auth configuration is invalid.
  */
-export const strapiSDK = (config: StrapiSDKConfig) => {
-  const sdkValidator = new StrapiSDKValidator();
+export const strapi = (config: StrapiConfig) => {
+  const configValidator = new StrapiConfigValidator();
 
-  return new StrapiSDK<typeof config>(
+  return new Strapi<typeof config>(
     // Properties
     config,
     // Dependencies
-    sdkValidator
+    configValidator
   );
 };