feat: Add script to check public API visibility

.changeset/silent-tools-beg.md

@@ -0,0 +1,6 @@
+---
+'@sap-ai-sdk/gen-ai-hub': minor
+'@sap-ai-sdk/core': minor
+---
+
+[New Functionality] Ensure that all external APIs are fully exported and any non-exported APIs are marked with `@internal`.

.github/workflows/build.yml

@@ -45,6 +45,8 @@ jobs:
       # - run: pnpm build # might be needed in the future
       - run: pnpm lint
       - run: pnpm compile:cjs
+      - run: pnpm check:public-api
+        name: Check public api
 
   dependabot:
     runs-on: ubuntu-latest

package.json

@@ -23,24 +23,29 @@
     "core": "pnpm -F=@sap-ai-sdk/core",
     "e2e-tests": "pnpm -F=@sap-ai-sdk/e2e-tests",
     "type-tests": "pnpm -F=@sap-ai-sdk/type-tests",
-    "smoke-tests": "pnpm -F=@sap-ai-sdk/smoke-tests"
+    "smoke-tests": "pnpm -F=@sap-ai-sdk/smoke-tests",
+    "check:public-api": "pnpm -r check:public-api"
   },
   "devDependencies": {
     "@changesets/cli": "^2.27.7",
     "@jest/globals": "^29.5.12",
     "@sap-cloud-sdk/eslint-config": "^3.20.0",
     "@sap-cloud-sdk/connectivity": "^3.20.0",
+    "@sap-cloud-sdk/generator-common": "^3.20.0",
     "@sap-cloud-sdk/http-client": "^3.20.0",
+    "@sap-cloud-sdk/util": "^3.20.0",
     "@sap-ai-sdk/ai-core": "workspace:^",
     "@sap-ai-sdk/core": "workspace:^",
     "@sap-ai-sdk/gen-ai-hub": "workspace:^",
     "@types/jest": "^29.5.12",
-    "@jest/globals": "^29.5.12",
     "@types/jsonwebtoken": "^9.0.2",
+    "@types/mock-fs": "^4.13.4",
     "@types/node": "^20.16.3",
     "eslint": "^9.9.1",
+    "glob": "^10.4.3",
     "jest": "^30.0.0-alpha.6",
     "jsonwebtoken": "^9.0.2",
+    "mock-fs": "^4.13.4",
     "nock": "^13.5.5",
     "prettier": "^3.3.3",
     "ts-jest": "^29.2.5",

packages/core/package.json

@@ -23,7 +23,8 @@
     "compile:cjs": "tsc -p tsconfig.cjs.json",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest",
     "lint": "eslint \"**/*.ts\" && prettier . --config ../../.prettierrc --ignore-path ../../.prettierignore -c",
-    "lint:fix": "eslint \"**/*.ts\" --fix && prettier . --config ../../.prettierrc --ignore-path ../../.prettierignore -w --log-level error"
+    "lint:fix": "eslint \"**/*.ts\" --fix && prettier . --config ../../.prettierrc --ignore-path ../../.prettierignore -w --log-level error",
+    "check:public-api": "node --loader ts-node/esm ../../scripts/check-public-api-cli.ts"
   },
   "dependencies": {
     "@sap-cloud-sdk/http-client": "^3.20.0",

packages/core/src/index.ts

@@ -1,9 +1,9 @@
-export {
-  executeRequest,
+export type {
   BaseLlmParametersWithDeploymentId,
   BaseLlmParameters,
   CustomRequestConfig,
   EndpointOptions
 } from './http-client.js';
+export { executeRequest } from './http-client.js';
 export { getAiCoreDestination } from './context.js';
 export { OpenApiRequestBuilder } from './openapi-request-builder.js';

packages/gen-ai-hub/package.json

@@ -27,7 +27,8 @@
     "lint": "eslint \"**/*.ts\" && prettier . --config ../../.prettierrc --ignore-path ../../.prettierignore -c",
     "lint:fix": "eslint \"**/*.ts\" --fix && prettier . --config ../../.prettierrc --ignore-path ../../.prettierignore -w --log-level error",
     "generate": "pnpm generate:orchestration",
-    "generate:orchestration": "openapi-generator --generateESM --clearOutputDir -i ./src/orchestration/spec/api.yaml -o ./src/orchestration/client && pnpm lint:fix"
+    "generate:orchestration": "openapi-generator --generateESM --clearOutputDir -i ./src/orchestration/spec/api.yaml -o ./src/orchestration/client && pnpm lint:fix",
+    "check:public-api": "node --loader ts-node/esm ../../scripts/check-public-api-cli.ts"
   },
   "dependencies": {
     "@sap-ai-sdk/core": "workspace:^",

packages/gen-ai-hub/src/client/openai/index.ts

@@ -0,0 +1,2 @@
+export * from './openai-types.js';
+export * from './openai-client.js';

packages/gen-ai-hub/src/index.ts

@@ -1,10 +1,76 @@
-export * from './client/index.js';
+export type {
+  OpenAiChatModel,
+  OpenAiEmbeddingModel,
+  OpenAiChatMessage,
+  OpenAiChatSystemMessage,
+  OpenAiChatUserMessage,
+  OpenAiChatAssistantMessage,
+  OpenAiChatToolMessage,
+  OpenAiChatFunctionMessage,
+  OpenAiChatCompletionFunction,
+  OpenAiChatCompletionTool,
+  OpenAiChatFunctionCall,
+  OpenAiChatToolCall,
+  OpenAiCompletionParameters,
+  OpenAiChatCompletionParameters,
+  OpenAiEmbeddingParameters,
+  OpenAiCompletionOutput,
+  OpenAiChatCompletionOutput,
+  OpenAiPromptFilterResult,
+  OpenAiContentFilterResultsBase,
+  OpenAiContentFilterPromptResults,
+  OpenAiContentFilterResultBase,
+  OpenAiContentFilterDetectedResult,
+  OpenAiContentFilterSeverityResult,
+  OpenAiEmbeddingOutput
+} from './client/index.js';
+export { OpenAiClient } from './client/index.js';
+
+export type {
+  ModelDeployment,
+  DeploymentIdConfiguration,
+  FoundationModel,
+  ModelConfiguration
+} from './utils/index.js';
 export {
-  OrchestrationClient,
+  isDeploymentIdConfiguration,
+  getDeploymentId,
+  resolveDeployment
+} from './utils/index.js';
+
+export type {
   OrchestrationCompletionParameters,
   CompletionPostResponse,
-  azureContentFilter,
   PromptConfig,
   LlmConfig,
-  ChatMessages
+  ChatMessages,
+  TokenUsage,
+  TemplatingModuleConfig,
+  OrchestrationConfig,
+  ModuleResults,
+  ModuleConfigs,
+  MaskingModuleConfig,
+  MaskingProviderConfig,
+  LLMModuleResult,
+  LLMModuleConfig,
+  LLMChoice,
+  GroundingModuleConfig,
+  GroundingFilter,
+  GenericModuleResult,
+  FilteringModuleConfig,
+  FilteringConfig,
+  FilterConfig,
+  ErrorResponse,
+  DPIEntities,
+  DPIEntityConfig,
+  DPIConfig,
+  CompletionPostRequest,
+  ChatMessage,
+  AzureThreshold,
+  AzureContentSafety,
+  AzureContentSafetyFilterConfig
+} from './orchestration/index.js';
+export {
+  OrchestrationClient,
+  azureContentFilter
 } from './orchestration/index.js';

packages/gen-ai-hub/src/internal.ts

@@ -1,2 +1,3 @@
 export * from './client/index.js';
 export * from './orchestration/index.js';
+export * from './utils/index.js';

packages/gen-ai-hub/src/utils/index.ts

@@ -0,0 +1 @@
+export * from './deployment-resolver.js';

scripts/check-public-api-cli.ts

@@ -0,0 +1,9 @@
+import { createLogger } from '@sap-cloud-sdk/util';
+import { checkApiOfPackage } from './check-public-api.js';
+
+const logger = createLogger('check-public-api');
+
+checkApiOfPackage(process.cwd()).catch(err => {
+  logger.error(err);
+  process.exit(1);
+});