rename from public to client

nicknisi · nicknisi · commit 9c1896ed20ea · 2025-09-03T14:16:16.000-05:00
diff --git a/package.json b/package.json
@@ -103,14 +103,14 @@
       "require": "./lib/cjs/index.cjs",
       "default": "./lib/esm/index.js"
     },
-    "./public": {
+    "./client": {
       "types": {
-        "require": "./lib/cjs/index.public.d.cts",
-        "import": "./lib/esm/index.public.d.ts"
+        "require": "./lib/cjs/index.client.d.cts",
+        "import": "./lib/esm/index.client.d.ts"
       },
-      "import": "./lib/esm/index.public.js",
-      "require": "./lib/cjs/index.public.cjs",
-      "default": "./lib/esm/index.public.js"
+      "import": "./lib/esm/index.client.js",
+      "require": "./lib/cjs/index.client.cjs",
+      "default": "./lib/esm/index.client.js"
     },
     "./worker": {
       "types": {
diff --git a/src/client/index.ts b/src/client/index.ts
@@ -1,11 +1,12 @@
 /**
- * Public methods that can be safely used without an API key.
+ * Client methods that can be used without a WorkOS API key.
+ * These are OAuth client operations suitable for PKCE flows.
  */
 
-// User Management public methods and types
+// User Management client methods and types
 export * as userManagement from './user-management';
 
-// SSO public methods and types
+// SSO client methods and types
 export * as sso from './sso';
 
 // Re-export specific types for convenience
diff --git a/src/client/sso.spec.ts b/src/client/sso.spec.ts
diff --git a/src/client/sso.ts b/src/client/sso.ts
@@ -15,7 +15,7 @@ export interface SSOAuthorizationURLOptions {
 
 /**
  * Generates the authorization URL for SSO authentication.
- * This method is safe to use in browser environments as it doesn't require an API key.
+ * Does not require an API key, suitable for OAuth client operations.
  *
  * @param options - SSO authorization URL options
  * @returns The authorization URL as a string
diff --git a/src/client/user-management.spec.ts b/src/client/user-management.spec.ts
diff --git a/src/client/user-management.ts b/src/client/user-management.ts
@@ -1,6 +1,6 @@
 import { toQueryString } from './utils';
 
-// Re-export necessary interfaces for public use
+// Re-export necessary interfaces for client use
 export interface AuthorizationURLOptions {
   clientId: string;
   codeChallenge?: string;
@@ -29,8 +29,8 @@ export interface LogoutURLOptions {
 }
 
 /**
- * Generates the authorization URL for user authentication.
- * This method is safe to use in browser environments as it doesn't require an API key.
+ * Generates the authorization URL for OAuth client authentication.
+ * Suitable for PKCE flows and other OAuth client operations that don't require an API key.
  *
  * @param options - Authorization URL options
  * @returns The authorization URL as a string
@@ -128,7 +128,7 @@ export function getLogoutUrl(
 
 /**
  * Gets the JWKS (JSON Web Key Set) URL for a given client ID.
- * This method is safe to use in browser environments as it doesn't require an API key.
+ * Does not require an API key, returns the public JWKS endpoint.
  *
  * @param clientId - The WorkOS client ID
  * @param baseURL - Optional base URL for the API (defaults to https://api.workos.com)
diff --git a/src/client/utils.ts b/src/client/utils.ts
diff --git a/src/index.client.spec.ts b/src/index.client.spec.ts
@@ -1,6 +1,6 @@
-import { userManagement, sso, webhooks, actions } from './index.public';
+import { userManagement, sso, webhooks, actions } from './index.client';
 
-describe('Public Exports', () => {
+describe('Client Exports', () => {
   describe('userManagement exports', () => {
     it('should generate authorization URLs correctly', () => {
       const url = userManagement.getAuthorizationUrl({
diff --git a/src/index.client.ts b/src/index.client.ts
@@ -1,11 +1,11 @@
 /**
- * Public methods that can be safely used without an API key.
- * These are primarily URL builders and cryptographic utilities.
+ * Client methods that can be used without a WorkOS API key.
+ * These are OAuth client operations, URL builders, and cryptographic utilities.
  */
 
-// Export public methods directly - this is the recommended approach
-export * as userManagement from './public/user-management';
-export * as sso from './public/sso';
+// Export client methods directly - this is the recommended approach
+export * as userManagement from './client/user-management';
+export * as sso from './client/sso';
 
 // Export webhooks and actions (these don't need API keys)
 import { Webhooks } from './webhooks/webhooks';
@@ -20,9 +20,9 @@ export const actions = new Actions(cryptoProvider);
 export type {
   AuthorizationURLOptions as UserManagementAuthorizationURLOptions,
   LogoutURLOptions,
-} from './public/user-management';
+} from './client/user-management';
 
-export type { SSOAuthorizationURLOptions } from './public/sso';
+export type { SSOAuthorizationURLOptions } from './client/sso';
 
 // Note: If you need authenticateWithCodeAndVerifier, use the full WorkOS SDK
 // as it requires server-side API key authentication
diff --git a/src/sso/sso.ts b/src/sso/sso.ts
@@ -1,4 +1,4 @@
-import * as publicSSO from '../public/sso';
+import * as clientSSO from '../client/sso';
 import { UnknownRecord } from '../common/interfaces/unknown-record.interface';
 import { fetchAndDeserialize } from '../common/utils/fetch-and-deserialize';
 import { AutoPaginatable } from '../common/utils/pagination';
@@ -51,8 +51,8 @@ export class SSO {
   }
 
   getAuthorizationUrl(options: SSOAuthorizationURLOptions): string {
-    // Delegate to public implementation
-    return publicSSO.getAuthorizationUrl({
+    // Delegate to client implementation
+    return clientSSO.getAuthorizationUrl({
       ...options,
       baseURL: this.workos.baseURL,
     });
diff --git a/src/user-management/user-management.ts b/src/user-management/user-management.ts
@@ -1,6 +1,6 @@
 import { sealData, unsealData } from 'iron-session';
 import { createRemoteJWKSet, decodeJwt, jwtVerify } from 'jose';
-import * as publicUserManagement from '../public/user-management';
+import * as clientUserManagement from '../client/user-management';
 import { PaginationOptions } from '../common/interfaces/pagination-options.interface';
 import { fetchAndDeserialize } from '../common/utils/fetch-and-deserialize';
 import { AutoPaginatable } from '../common/utils/pagination';
@@ -911,23 +911,23 @@ export class UserManagement {
   }
 
   getAuthorizationUrl(options: UserManagementAuthorizationURLOptions): string {
-    // Delegate to public implementation
-    return publicUserManagement.getAuthorizationUrl({
+    // Delegate to client implementation
+    return clientUserManagement.getAuthorizationUrl({
       ...options,
       baseURL: this.workos.baseURL,
     });
   }
 
-  getLogoutUrl(options: publicUserManagement.LogoutURLOptions): string {
-    // Delegate to public implementation
-    return publicUserManagement.getLogoutUrl({
+  getLogoutUrl(options: clientUserManagement.LogoutURLOptions): string {
+    // Delegate to client implementation
+    return clientUserManagement.getLogoutUrl({
       ...options,
       baseURL: this.workos.baseURL,
     });
   }
 
   getJwksUrl(clientId: string): string {
-    // Delegate to public implementation
-    return publicUserManagement.getJwksUrl(clientId, this.workos.baseURL);
+    // Delegate to client implementation
+    return clientUserManagement.getJwksUrl(clientId, this.workos.baseURL);
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ export interface SSOAuthorizationURLOptions {`
`15`	`15`
`16`	`16`	`/**`
`17`	`17`	`* Generates the authorization URL for SSO authentication.`
`18`		`- * This method is safe to use in browser environments as it doesn't require an API key.`
	`18`	`+ * Does not require an API key, suitable for OAuth client operations.`
`19`	`19`	`*`
`20`	`20`	`* @param options - SSO authorization URL options`
`21`	`21`	`* @returns The authorization URL as a string`