@hubspot/local-dev-lib 5.7.1 → 5.8.0

package/api/appLogs.d.ts

@@ -0,0 +1,4 @@
+import { HubSpotPromise } from '../types/Http.js';
+import { AppLogDetailsResponse, SearchLogsRequest, SearchLogsResponse, SystemType } from '../types/AppLogs.js';
+export declare function searchAppLogs(accountId: number, appId: number, requestBody: SearchLogsRequest): HubSpotPromise<SearchLogsResponse>;
+export declare function getAppLogDetails(accountId: number, appId: number, systemType: SystemType, uuid: string): HubSpotPromise<AppLogDetailsResponse>;

package/api/appLogs.js

@@ -0,0 +1,13 @@
+import { http } from '../http/index.js';
+const APP_LOGS_API_PATH = 'developers/logs';
+export function searchAppLogs(accountId, appId, requestBody) {
+    return http.post(accountId, {
+        url: `${APP_LOGS_API_PATH}/search/${appId}`,
+        data: requestBody,
+    });
+}
+export function getAppLogDetails(accountId, appId, systemType, uuid) {
+    return http.get(accountId, {
+        url: `${APP_LOGS_API_PATH}/details/${appId}/${systemType}/${uuid}`,
+    });
+}

package/lib/personalAccessKey.js

@@ -17,6 +17,7 @@ export async function getAccessToken(personalAccessKey, env = ENVIRONMENTS.PROD,
     const response = axiosResponse.data;
     return {
         portalId: response.hubId,
+        userId: response.userId,
         accessToken: response.oauthAccessToken,
         expiresAt: moment(response.expiresAtMillis).toISOString(),
         scopeGroups: response.scopeGroups,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hubspot/local-dev-lib",
-    "version": "5.7.1",
+    "version": "5.8.0",
     "type": "module",
     "description": "Provides library functionality for HubSpot local development tooling, including the HubSpot CLI",
     "files": [

package/types/Accounts.d.ts

@@ -82,6 +82,7 @@ export type EnabledFeaturesResponse = {
 };
 export type AccessToken = {
     portalId: number;
+    userId?: number;
     accessToken: string;
     expiresAt: string;
     scopeGroups: Array<string>;

package/types/AppLogs.d.ts

@@ -0,0 +1,80 @@
+export type SystemType = 'CRM_LEGACY_CARD' | 'CRM_EXTENSIBILITY_CARD' | 'WEBHOOKS' | 'API_CALL' | 'APP_SETTINGS' | 'SERVERLESS_EXECUTION' | 'PROXY_EXECUTION' | 'EXTENSION_RENDER' | 'EXTENSION_LOG' | 'SERVERLESS_GATEWAY_EXECUTION' | 'ACCEPTANCE_TEST' | 'OAUTH_AUTHORIZATION';
+export type ResultsOrder = 'ASC' | 'DESC';
+export type LogSearchQuery = {
+    loggingSystemType: SystemType;
+    logId?: string;
+    limit: number;
+    offset: number;
+    startTime?: number;
+    endTime?: number;
+    errorTypes: string[];
+    resultsOrder: ResultsOrder;
+    portalId?: number;
+    correlationGroupId?: string;
+    traceId?: string;
+    label?: string;
+};
+export type SearchLogsRequest = {
+    query: LogSearchQuery;
+    after?: string;
+    limit: number;
+};
+export type NextPage = {
+    after: string;
+    link?: string;
+};
+export type ForwardPaging = {
+    next?: NextPage;
+};
+export type AppLogEntry = {
+    id: string;
+    loggingSystemType: string;
+    requestExecutionTimestamp: number;
+    portalId: number;
+    traceId: string;
+    parentId: string;
+    label: string;
+    responseReceivedTimestamp: number;
+    duration: number;
+    errorType?: string;
+    appId: number;
+    [key: string]: unknown;
+};
+export type SearchLogsResponse = {
+    results: AppLogEntry[];
+    paging?: ForwardPaging;
+};
+export type AppLogDetails = {
+    loggingSystemType: string;
+    id: string;
+    requestExecutionTimestamp: number;
+    portalId?: number;
+    traceId?: string;
+    parentId?: string;
+    label?: string;
+    traceparentId?: string;
+    correlationGroupId?: string;
+    parentLogId?: string;
+    responseReceivedTimestamp?: number;
+    duration?: number;
+    errorType?: string;
+    appId: number;
+    serverlessFunction?: string;
+    location?: string;
+    userId?: number;
+    requestBody?: string;
+    responseBody?: string;
+    validatedResponse?: string;
+    extraInfo?: Record<string, string>;
+    errorMessage?: string;
+    cardId?: number;
+    objectTypeId?: string;
+    objectId?: number;
+    cardName?: string;
+    traceRoot?: boolean;
+    [key: string]: unknown;
+};
+export type AppLogDetailsResponse = {
+    log: AppLogDetails;
+    consoleOutput?: string;
+};

package/types/AppLogs.js

@@ -0,0 +1 @@
+export {};