Skip to content

Commit 8e559b2

Browse files
jdaltonjdalton
committed
Rename SocketSdkResultType
1 parent 8ee8d6a commit 8e559b2

File tree

1 file changed

+40
-42
lines changed

1 file changed

+40
-42
lines changed

‎src/index.ts

Lines changed: 40 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ import type {
2929

3030
export type Agent = HttpsAgent | HttpAgent | ClientHttp2Session
3131

32-
export type BatchPackageFetchResultType =
33-
SocketSdkResultType<'batchPackageFetch'>
32+
export type BatchPackageFetchResultType = SocketSdkResult<'batchPackageFetch'>
3433

3534
export type BatchPackageStreamOptions = {
3635
chunkSize: number
@@ -50,21 +49,20 @@ export type RequestOptions =
5049

5150
export type SocketSdkOperations = keyof operations
5251

53-
export type SocketSdkReturnType<T extends SocketSdkOperations> = OpReturnType<
54-
operations[T]
55-
>
52+
export type SocketSdkSuccessResult<T extends SocketSdkOperations> =
53+
OpReturnType<operations[T]>
5654

57-
export type SocketSdkErrorType<T extends SocketSdkOperations> = Omit<
55+
export type SocketSdkErrorResult<T extends SocketSdkOperations> = Omit<
5856
OpErrorType<operations[T]>,
5957
'error'
6058
> & {
6159
error: string
62-
cause?: unknown
60+
cause?: string | undefined
6361
}
6462

65-
export type SocketSdkResultType<T extends SocketSdkOperations> =
66-
| SocketSdkReturnType<T>
67-
| SocketSdkErrorType<T>
63+
export type SocketSdkResult<T extends SocketSdkOperations> =
64+
| SocketSdkSuccessResult<T>
65+
| SocketSdkErrorResult<T>
6866

6967
export interface SocketSdkOptions {
7068
agent?: Agent | GotOptions | undefined
@@ -541,7 +539,7 @@ export class SocketSdk {
541539

542540
async #handleApiError<T extends SocketSdkOperations>(
543541
error: unknown
544-
): Promise<SocketSdkErrorType<T>> {
542+
): Promise<SocketSdkErrorResult<T>> {
545543
if (!(error instanceof ResponseError)) {
546544
throw new Error('Unexpected Socket API error', {
547545
cause: error
@@ -568,21 +566,21 @@ export class SocketSdk {
568566
body = bodyStr
569567
}
570568
return {
571-
success: false as const,
569+
success: false,
572570
status: statusCode!,
573571
error: error.message ?? '',
574572
cause: body
575-
} as unknown as SocketSdkErrorType<T>
573+
} as SocketSdkErrorResult<T>
576574
}
577575

578576
#handleApiSuccess<T extends SocketSdkOperations>(
579577
data: unknown
580-
): SocketSdkReturnType<T> {
578+
): SocketSdkSuccessResult<T> {
581579
return {
582580
success: true,
583581
status: 200,
584-
data: data as SocketSdkReturnType<T>['data']
585-
} satisfies SocketSdkReturnType<T>
582+
data: data as SocketSdkSuccessResult<T>['data']
583+
} satisfies SocketSdkSuccessResult<T>
586584
}
587585

588586
async batchPackageFetch(
@@ -708,7 +706,7 @@ export class SocketSdk {
708706
params: Record<string, string>,
709707
filepaths: string[],
710708
pathsRelativeTo = '.'
711-
): Promise<SocketSdkResultType<'createDependenciesSnapshot'>> {
709+
): Promise<SocketSdkResult<'createDependenciesSnapshot'>> {
712710
const basePath = resolveBasePath(pathsRelativeTo)
713711
const absFilepaths = resolveAbsPaths(filepaths, basePath)
714712
try {
@@ -731,7 +729,7 @@ export class SocketSdk {
731729
queryParams: Record<string, string> | null | undefined,
732730
filepaths: string[],
733731
pathsRelativeTo: string = '.'
734-
): Promise<SocketSdkResultType<'CreateOrgFullScan'>> {
732+
): Promise<SocketSdkResult<'CreateOrgFullScan'>> {
735733
const basePath = resolveBasePath(pathsRelativeTo)
736734
const absFilepaths = resolveAbsPaths(filepaths, basePath)
737735
try {
@@ -752,7 +750,7 @@ export class SocketSdk {
752750
async createOrgRepo(
753751
orgSlug: string,
754752
params: Record<string, string>
755-
): Promise<SocketSdkResultType<'createOrgRepo'>> {
753+
): Promise<SocketSdkResult<'createOrgRepo'>> {
756754
try {
757755
const data = await getResponseJson(
758756
await createPostRequest(
@@ -772,7 +770,7 @@ export class SocketSdk {
772770
filepaths: string[],
773771
pathsRelativeTo: string = '.',
774772
issueRules?: Record<string, boolean>
775-
): Promise<SocketSdkResultType<'createReport'>> {
773+
): Promise<SocketSdkResult<'createReport'>> {
776774
const basePath = resolveBasePath(pathsRelativeTo)
777775
const absFilepaths = resolveAbsPaths(filepaths, basePath)
778776
try {
@@ -799,7 +797,7 @@ export class SocketSdk {
799797
async deleteOrgFullScan(
800798
orgSlug: string,
801799
fullScanId: string
802-
): Promise<SocketSdkResultType<'deleteOrgFullScan'>> {
800+
): Promise<SocketSdkResult<'deleteOrgFullScan'>> {
803801
try {
804802
const data = await getResponseJson(
805803
await createDeleteRequest(
@@ -817,7 +815,7 @@ export class SocketSdk {
817815
async deleteOrgRepo(
818816
orgSlug: string,
819817
repoSlug: string
820-
): Promise<SocketSdkResultType<'deleteOrgRepo'>> {
818+
): Promise<SocketSdkResult<'deleteOrgRepo'>> {
821819
try {
822820
const data = await getResponseJson(
823821
await createDeleteRequest(
@@ -835,7 +833,7 @@ export class SocketSdk {
835833
async getAuditLogEvents(
836834
orgSlug: string,
837835
queryParams?: Record<string, string> | null | undefined
838-
): Promise<SocketSdkResultType<'getAuditLogEvents'>> {
836+
): Promise<SocketSdkResult<'getAuditLogEvents'>> {
839837
try {
840838
const data = await getResponseJson(
841839
await createGetRequest(
@@ -853,7 +851,7 @@ export class SocketSdk {
853851
async getIssuesByNPMPackage(
854852
pkgName: string,
855853
version: string
856-
): Promise<SocketSdkResultType<'getIssuesByNPMPackage'>> {
854+
): Promise<SocketSdkResult<'getIssuesByNPMPackage'>> {
857855
try {
858856
const data = await getResponseJson(
859857
await createGetRequest(
@@ -870,7 +868,7 @@ export class SocketSdk {
870868

871869
async getOrgAnalytics(
872870
time: string
873-
): Promise<SocketSdkResultType<'getOrgAnalytics'>> {
871+
): Promise<SocketSdkResult<'getOrgAnalytics'>> {
874872
try {
875873
const data = await getResponseJson(
876874
await createGetRequest(
@@ -885,7 +883,7 @@ export class SocketSdk {
885883
}
886884
}
887885

888-
async getOrganizations(): Promise<SocketSdkResultType<'getOrganizations'>> {
886+
async getOrganizations(): Promise<SocketSdkResult<'getOrganizations'>> {
889887
try {
890888
const data = await getResponseJson(
891889
await createGetRequest(this.#baseUrl, 'organizations', this.#reqOptions)
@@ -900,7 +898,7 @@ export class SocketSdk {
900898
orgSlug: string,
901899
fullScanId: string,
902900
file?: string
903-
): Promise<SocketSdkResultType<'getOrgFullScan'>> {
901+
): Promise<SocketSdkResult<'getOrgFullScan'>> {
904902
try {
905903
const req = getHttpModule(this.#baseUrl)
906904
.request(
@@ -926,7 +924,7 @@ export class SocketSdk {
926924
async getOrgFullScanList(
927925
orgSlug: string,
928926
queryParams?: Record<string, string> | null | undefined
929-
): Promise<SocketSdkResultType<'getOrgFullScanList'>> {
927+
): Promise<SocketSdkResult<'getOrgFullScanList'>> {
930928
try {
931929
const data = await getResponseJson(
932930
await createGetRequest(
@@ -944,7 +942,7 @@ export class SocketSdk {
944942
async getOrgFullScanMetadata(
945943
orgSlug: string,
946944
fullScanId: string
947-
): Promise<SocketSdkResultType<'getOrgFullScanMetadata'>> {
945+
): Promise<SocketSdkResult<'getOrgFullScanMetadata'>> {
948946
try {
949947
const data = await getResponseJson(
950948
await createGetRequest(
@@ -961,7 +959,7 @@ export class SocketSdk {
961959

962960
async getOrgLicensePolicy(
963961
orgSlug: string
964-
): Promise<SocketSdkResultType<'getOrgLicensePolicy'>> {
962+
): Promise<SocketSdkResult<'getOrgLicensePolicy'>> {
965963
try {
966964
const data = await getResponseJson(
967965
await createGetRequest(
@@ -979,7 +977,7 @@ export class SocketSdk {
979977
async getOrgRepo(
980978
orgSlug: string,
981979
repoSlug: string
982-
): Promise<SocketSdkResultType<'getOrgRepo'>> {
980+
): Promise<SocketSdkResult<'getOrgRepo'>> {
983981
const orgSlugParam = encodeURIComponent(orgSlug)
984982
const repoSlugParam = encodeURIComponent(repoSlug)
985983

@@ -1000,7 +998,7 @@ export class SocketSdk {
1000998
async getOrgRepoList(
1001999
orgSlug: string,
10021000
queryParams?: Record<string, string> | null | undefined
1003-
): Promise<SocketSdkResultType<'getOrgRepoList'>> {
1001+
): Promise<SocketSdkResult<'getOrgRepoList'>> {
10041002
try {
10051003
const data = await getResponseJson(
10061004
await createGetRequest(
@@ -1017,7 +1015,7 @@ export class SocketSdk {
10171015

10181016
async getOrgSecurityPolicy(
10191017
orgSlug: string
1020-
): Promise<SocketSdkResultType<'getOrgSecurityPolicy'>> {
1018+
): Promise<SocketSdkResult<'getOrgSecurityPolicy'>> {
10211019
try {
10221020
const data = await getResponseJson(
10231021
await createGetRequest(
@@ -1032,7 +1030,7 @@ export class SocketSdk {
10321030
}
10331031
}
10341032

1035-
async getQuota(): Promise<SocketSdkResultType<'getQuota'>> {
1033+
async getQuota(): Promise<SocketSdkResult<'getQuota'>> {
10361034
try {
10371035
const data = await getResponseJson(
10381036
await createGetRequest(this.#baseUrl, 'quota', this.#reqOptions)
@@ -1046,7 +1044,7 @@ export class SocketSdk {
10461044
async getRepoAnalytics(
10471045
repo: string,
10481046
time: string
1049-
): Promise<SocketSdkResultType<'getRepoAnalytics'>> {
1047+
): Promise<SocketSdkResult<'getRepoAnalytics'>> {
10501048
try {
10511049
const data = await getResponseJson(
10521050
await createGetRequest(
@@ -1061,7 +1059,7 @@ export class SocketSdk {
10611059
}
10621060
}
10631061

1064-
async getScan(id: string): Promise<SocketSdkResultType<'getReport'>> {
1062+
async getScan(id: string): Promise<SocketSdkResult<'getReport'>> {
10651063
try {
10661064
const data = await getResponseJson(
10671065
await createGetRequest(
@@ -1076,7 +1074,7 @@ export class SocketSdk {
10761074
}
10771075
}
10781076

1079-
async getScanList(): Promise<SocketSdkResultType<'getReportList'>> {
1077+
async getScanList(): Promise<SocketSdkResult<'getReportList'>> {
10801078
try {
10811079
const data = await getResponseJson(
10821080
await createGetRequest(this.#baseUrl, 'report/list', this.#reqOptions)
@@ -1088,7 +1086,7 @@ export class SocketSdk {
10881086
}
10891087

10901088
async getSupportedScanFiles(): Promise<
1091-
SocketSdkResultType<'getReportSupportedFiles'>
1089+
SocketSdkResult<'getReportSupportedFiles'>
10921090
> {
10931091
try {
10941092
const data = await getResponseJson(
@@ -1107,7 +1105,7 @@ export class SocketSdk {
11071105
async getScoreByNpmPackage(
11081106
pkgName: string,
11091107
version: string
1110-
): Promise<SocketSdkResultType<'getScoreByNPMPackage'>> {
1108+
): Promise<SocketSdkResult<'getScoreByNPMPackage'>> {
11111109
try {
11121110
const data = await getResponseJson(
11131111
await createGetRequest(
@@ -1124,7 +1122,7 @@ export class SocketSdk {
11241122

11251123
async postSettings(
11261124
selectors: Array<{ organization?: string }>
1127-
): Promise<SocketSdkResultType<'postSettings'>> {
1125+
): Promise<SocketSdkResult<'postSettings'>> {
11281126
try {
11291127
const data = await getResponseJson(
11301128
await createPostRequest(
@@ -1142,7 +1140,7 @@ export class SocketSdk {
11421140

11431141
async searchDependencies(
11441142
params: Record<string, number>
1145-
): Promise<SocketSdkResultType<'searchDependencies'>> {
1143+
): Promise<SocketSdkResult<'searchDependencies'>> {
11461144
try {
11471145
const data = await getResponseJson(
11481146
await createPostRequest(
@@ -1162,7 +1160,7 @@ export class SocketSdk {
11621160
orgSlug: string,
11631161
repoSlug: string,
11641162
params: Record<string, string>
1165-
): Promise<SocketSdkResultType<'updateOrgRepo'>> {
1163+
): Promise<SocketSdkResult<'updateOrgRepo'>> {
11661164
try {
11671165
const data = await getResponseJson(
11681166
await createPostRequest(

0 commit comments

Comments
 (0)