@heroku/applink 1.0.0-ea.1 → 1.0.0-ea.2

package/CHANGELOG.md

@@ -20,3 +20,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [1.0.0-ea.1] - 2025-06-06
 - Remove dynamic UA.
+
+## [1.0.0-ea.2] - 2025-06-20
+- Update `HttpRequestUtil.request` documentation
+- Update license year
+- Add `X-Request-Id` header
+- Extract `User-Agent` header from package.json
+- Rename `HTTPResponseError` -> `HttpResponseError`
+- Add GitHub pull request template
+- Fix Java heap memory test issue

package/LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2024, Salesforce.com, Inc.
+Copyright (c) 2025, Salesforce.com, Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

package/README.md

@@ -14,7 +14,7 @@ And much more!
 For more information, see [API docs](docs/README.md).
 
 ## Example
-Example use of the Node.js SDK for Heroku AppLink provided as part of the [Heroku AppLink CLI Plugin's](https://github.com/heroku/heroku-cli-plugin-applnk) `applink:project` template:  
+Example use of the Node.js SDK for Heroku AppLink provided as part of the [Heroku AppLink CLI Plugin's](https://github.com/heroku/heroku-cli-plugin-applink) `applink:project` template:
 ```javascript
 fastify.get('/accounts', async function (request, reply) {
     const {event, context, logger} = request.sdk;

package/dist/add-ons/heroku-applink.js

@@ -38,7 +38,7 @@ async function getAuthorization(developerName, attachmentNameOrColorOrUrl = proc
         response = await HTTP_REQUEST.request(authUrl, opts);
     }
     catch (err) {
-        if (err instanceof request_1.HTTPResponseError) {
+        if (err instanceof request_1.HttpResponseError) {
             let errorResponse;
             try {
                 errorResponse = await err.response.json();

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { QueryOperation } from "jsforce/lib/api/bulk";
 import { getAuthorization } from "./add-ons/heroku-applink.js";
-import { HTTPResponseError } from "./utils/request.js";
+import { HttpResponseError } from "./utils/request.js";
 export declare function init(): {
     addons: {
         applink: {
@@ -20,7 +20,7 @@ export declare function parseRequest(headers: any, body: any, log: any): {
     logger: Logger;
 };
 export declare function parseDataActionEvent(payload: any): DataCloudActionEvent;
-export { HTTPResponseError };
+export { HttpResponseError };
 export interface InvocationEvent<A> {
     readonly data: A;
     readonly dataContentType?: string;

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HTTPResponseError = void 0;
+exports.HttpResponseError = void 0;
 exports.init = init;
 exports.parseRequest = parseRequest;
 exports.parseDataActionEvent = parseDataActionEvent;
@@ -9,7 +9,7 @@ const invocation_event_js_1 = require("./sdk/invocation-event.js");
 const logger_js_1 = require("./sdk/logger.js");
 const heroku_applink_js_1 = require("./add-ons/heroku-applink.js");
 const request_js_1 = require("./utils/request.js");
-Object.defineProperty(exports, "HTTPResponseError", { enumerable: true, get: function () { return request_js_1.HTTPResponseError; } });
+Object.defineProperty(exports, "HttpResponseError", { enumerable: true, get: function () { return request_js_1.HttpResponseError; } });
 const CONTENT_TYPE_HEADER = "Content-Type";
 const X_CLIENT_CONTEXT_HEADER = "x-client-context";
 function init() {

package/dist/utils/request.d.ts

@@ -1,7 +1,10 @@
-export declare class HTTPResponseError extends Error {
+export declare class HttpResponseError extends Error {
     response: any;
     constructor(response: Response);
 }
+export declare const uuidGenerator: {
+    generate: () => `${string}-${string}-${string}-${string}-${string}`;
+};
 export declare class HttpRequestUtil {
     request(url: string, opts: any, json?: boolean): Promise<any>;
 }

package/dist/utils/request.js

@@ -1,23 +1,34 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpRequestUtil = exports.HTTPResponseError = void 0;
-class HTTPResponseError extends Error {
+exports.HttpRequestUtil = exports.uuidGenerator = exports.HttpResponseError = void 0;
+const node_crypto_1 = require("node:crypto");
+const package_json_1 = __importDefault(require("../../package.json"));
+class HttpResponseError extends Error {
     constructor(response) {
         super(`HTTP Error Response: ${response.status}: ${response.statusText}`);
         this.response = response;
     }
 }
-exports.HTTPResponseError = HTTPResponseError;
+exports.HttpResponseError = HttpResponseError;
+exports.uuidGenerator = {
+    generate: () => (0, node_crypto_1.randomUUID)(),
+};
 class HttpRequestUtil {
     async request(url, opts, json = true) {
-        const defaultOpts = {
+        const mergedOpts = {
+            ...opts,
             headers: {
-                "User-Agent": `heroku-applink-node-sdk/1.0`,
+                "User-Agent": `${package_json_1.default.name}/${package_json_1.default.version}`,
+                "X-Request-Id": exports.uuidGenerator.generate(),
+                ...(opts?.headers ?? {}),
             },
         };
-        const response = await fetch(url, { ...defaultOpts, ...opts });
+        const response = await fetch(url, mergedOpts);
         if (!response.ok) {
-            throw new HTTPResponseError(response);
+            throw new HttpResponseError(response);
         }
         return json ? response.json() : response;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heroku/applink",
-  "version": "1.0.0-ea.1",
+  "version": "1.0.0-ea.2",
   "description": "Applink SDK for Heroku Apps.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -8,7 +8,7 @@
     "build": "tsc -b",
     "lint": "eslint . --ext .ts --max-warnings 0 --report-unused-disable-directives --format codeframe",
     "lint:fix": "npm run lint -- --fix",
-    "wiremock": "wiremock --port 8080 --bind-address 127.0.0.1 --disable-banner",
+    "wiremock": "JAVA_OPTS='-Xmx1536m -Xms768m' wiremock --port 8080 --bind-address 127.0.0.1 --disable-banner --disable-request-logging --no-request-journal",
     "mocha": "mocha",
     "test": "cross-env NODE_ENV=test TS_NODE_PROJECT=tsconfig.test.json concurrently -k -s first \"wiremock\" \"mocha\"",
     "test:coverage": "nyc --reporter=lcov --reporter=text-summary yarn test",