Skip to content

fix: wire publicPolicy config through SDK #540

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
John-David Dalton (jdalton) merged 1 commit into from
Apr 2, 2026
Merged

fix: wire publicPolicy config through SDK #540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions src/http-client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ import { debugLog } from '@socketsecurity/lib/debug'
import { jsonParse } from '@socketsecurity/lib/json/parse'
import { perfTimer } from '@socketsecurity/lib/performance'

import { MAX_RESPONSE_SIZE, publicPolicy } from './constants'
import {
MAX_RESPONSE_SIZE,
publicPolicy as defaultPublicPolicy,
} from './constants'
import { sanitizeHeaders } from './utils/header-sanitization'

import type {
Expand Down Expand Up @@ -600,13 +603,19 @@ export function isResponseOk(response: IncomingMessage): boolean {
*/
export function reshapeArtifactForPublicPolicy<
T extends Record<string, unknown>,
>(data: T, isAuthenticated: boolean, actions?: string | undefined): T {
>(
data: T,
isAuthenticated: boolean,
actions?: string | undefined,
policy?: Map<string, string> | undefined,
): T {
/* c8 ignore start - Public policy artifact reshaping for unauthenticated users, difficult to test edge cases. */
// If user is not authenticated, provide a different response structure
// optimized for the public free-tier experience.
if (!isAuthenticated) {
// Parse actions parameter for alert filtering.
const allowedActions = actions?.trim() ? actions.split(',') : undefined
const resolvedPolicy = policy ?? defaultPublicPolicy

const reshapeArtifact = (artifact: SocketArtifactWithExtras) => ({
name: artifact.name,
Expand All @@ -621,8 +630,8 @@ export function reshapeArtifactForPublicPolicy<
// requests.
alerts: artifact.alerts
?.filter((alert: SocketArtifactAlert) => {
// Derive action from publicPolicy instead of trusting server value.
const action = publicPolicy.get(alert.type)
// Derive action from policy instead of trusting server value.
const action = resolvedPolicy.get(alert.type)
// Filter by severity (remove low severity alerts).
if (alert.severity === 'low') {
return false
Expand All @@ -634,7 +643,7 @@ export function reshapeArtifactForPublicPolicy<
return true
})
.map((alert: SocketArtifactAlert) => ({
action: publicPolicy.get(alert.type),
action: resolvedPolicy.get(alert.type),
key: alert.key,
severity: alert.severity,
type: alert.type,
Expand Down
6 changes: 4 additions & 2 deletions src/socket-sdk-class.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,12 +267,13 @@ export class SocketSdk {
: /* c8 ignore next - Empty line handling in batch streaming response parsing. */ null
if (isObjectObject(artifact)) {
yield this.#handleApiSuccess<'batchPackageFetch'>(
/* c8 ignore next 7 - Public token artifact reshaping branch for policy compliance. */
/* c8 ignore next 8 - Public token artifact reshaping branch for policy compliance. */
isPublicToken
? reshapeArtifactForPublicPolicy(
artifact!,
false,
queryParams?.['actions'] as string,
publicPolicy,
)
: artifact!,
)
Expand Down Expand Up @@ -842,12 +843,13 @@ export class SocketSdk {
: /* c8 ignore next - Empty line handling in batch parsing. */ null
if (isObjectObject(artifact)) {
results.push(
/* c8 ignore next 7 - Public token artifact reshaping for policy compliance. */
/* c8 ignore next 8 - Public token artifact reshaping for policy compliance. */
isPublicToken
? reshapeArtifactForPublicPolicy(
artifact!,
false,
queryParams?.['actions'] as string,
publicPolicy,
)
: artifact!,
)
Expand Down