@gr4vy/sdk 2.3.0 → 2.3.1

package/README.md

@@ -170,6 +170,44 @@ run();
 > **Note:** This will only create a token once. Use `withToken` to dynamically generate a token
 > for every request.
 
+### Attaching a checkout session automatically
+
+For Embed, it is recommended to attach a checkout session to every transaction. The
+`getEmbedTokenWithCheckoutSession` helper creates a checkout session using your SDK client and
+returns an Embed token with the resulting `checkout_session_id` already pinned, in a single call.
+
+```js
+import fs from "node:fs";
+import { Gr4vy, getEmbedTokenWithCheckoutSession, withToken } from "@gr4vy/sdk";
+
+async function run() {
+    const privateKey = fs.readFileSync("private_key.pem", "utf8")
+
+    const gr4vy = new Gr4vy({
+        server: "sandbox",
+        id: "example",
+        bearerAuth: withToken({ privateKey }),
+    });
+
+    const token = await getEmbedTokenWithCheckoutSession({
+      client: gr4vy,
+      privateKey,
+      embedParams: {
+        amount: 1299,
+        currency: 'USD',
+        buyerExternalIdentifier: 'user-1234',
+      }
+    });
+
+    console.log(token);
+}
+
+run();
+```
+
+You can optionally pass a `checkoutSession` body to seed the session (for example with cart items
+or metadata), and a `merchantAccountId` to override the client's configured merchant account.
+
 ## Merchant account ID selection
 
 Depending on the key used, you might need to explicitly define a merchant account ID to use. In our API, 

package/index.d.ts

@@ -1,6 +1,6 @@
 export * from "./lib/config";
 export * from "./sdk";
-export { getEmbedToken, getToken, JWTScope, updateToken, withToken } from "./lib/auth";
+export { getEmbedToken, getEmbedTokenWithCheckoutSession, getToken, JWTScope, updateToken, withToken } from "./lib/auth";
 export type { EmbedParams } from "./lib/auth";
 export { verifyWebhook } from "./lib/webhooks";
 //# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAIA,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AAEtB,OAAO,EACH,aAAa,EACb,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,SAAS,EACZ,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAIA,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AAEtB,OAAO,EACH,aAAa,EACb,gCAAgC,EAChC,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,SAAS,EACZ,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC"}

package/index.js

@@ -17,11 +17,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyWebhook = exports.withToken = exports.updateToken = exports.JWTScope = exports.getToken = exports.getEmbedToken = void 0;
+exports.verifyWebhook = exports.withToken = exports.updateToken = exports.JWTScope = exports.getToken = exports.getEmbedTokenWithCheckoutSession = exports.getEmbedToken = void 0;
 __exportStar(require("./lib/config"), exports);
 __exportStar(require("./sdk"), exports);
 var auth_1 = require("./lib/auth");
 Object.defineProperty(exports, "getEmbedToken", { enumerable: true, get: function () { return auth_1.getEmbedToken; } });
+Object.defineProperty(exports, "getEmbedTokenWithCheckoutSession", { enumerable: true, get: function () { return auth_1.getEmbedTokenWithCheckoutSession; } });
 Object.defineProperty(exports, "getToken", { enumerable: true, get: function () { return auth_1.getToken; } });
 Object.defineProperty(exports, "JWTScope", { enumerable: true, get: function () { return auth_1.JWTScope; } });
 Object.defineProperty(exports, "updateToken", { enumerable: true, get: function () { return auth_1.updateToken; } });

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;AAEH,+CAA6B;AAC7B,wCAAsB;AAEtB,mCAMoB;AALhB,qGAAA,aAAa,OAAA;AACb,gGAAA,QAAQ,OAAA;AACR,gGAAA,QAAQ,OAAA;AACR,mGAAA,WAAW,OAAA;AACX,iGAAA,SAAS,OAAA;AAGb,2CAA+C;AAAtC,yGAAA,aAAa,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;AAEH,+CAA6B;AAC7B,wCAAsB;AAEtB,mCAOoB;AANhB,qGAAA,aAAa,OAAA;AACb,wHAAA,gCAAgC,OAAA;AAChC,gGAAA,QAAQ,OAAA;AACR,gGAAA,QAAQ,OAAA;AACR,mGAAA,WAAW,OAAA;AACX,iGAAA,SAAS,OAAA;AAGb,2CAA+C;AAAtC,yGAAA,aAAa,OAAA"}

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@gr4vy/sdk",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/lib/auth.d.ts

@@ -1,5 +1,6 @@
 import type { StringValue } from "ms";
-import { CartItem } from "../models/components";
+import { CartItem, CheckoutSessionCreate } from "../models/components";
+import type { Gr4vy } from "../sdk/sdk";
 /**
  * Helper method for generating a bearer token for use with the SDK
  */
@@ -34,6 +35,24 @@ export declare const getEmbedToken: (options: {
     embedParams?: EmbedParams;
     checkoutSessionId?: string;
 }) => Promise<string>;
+/**
+ * Helper method that creates a checkout session and returns an Embed token with
+ * the new checkout session ID baked in.
+ *
+ * This is a convenience wrapper around `getEmbedToken` for the common Embed flow
+ * where every transaction should be tied to a checkout session. It uses the
+ * provided (already authenticated) SDK client to create the checkout session,
+ * then signs an Embed token that pins the resulting `checkout_session_id`.
+ */
+export declare const getEmbedTokenWithCheckoutSession: (options: {
+    client: Gr4vy;
+    privateKey: string;
+    embedParams?: EmbedParams;
+    /** Optional checkout session body to seed cart items, metadata, and so on. */
+    checkoutSession?: CheckoutSessionCreate;
+    /** Optional merchant account ID override. Defaults to the client's configured one. */
+    merchantAccountId?: string;
+}) => Promise<string>;
 /**
  * Short hands for scopes. Strings can be used as well.
  */

package/lib/auth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/lib/auth.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAGtC,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAIhD;;GAEG;AACH,eAAO,MAAM,SAAS,GAAI,SAAS;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;IAC/B,SAAS,CAAC,EAAE,WAAW,CAAC;CACzB,KAAG,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,CAezB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,GAAU,SAAS;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,WAAW,CAAC;IACxB,MAAM,CAAC,EAAE,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;IAC/B,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,KAAG,OAAO,CAAC,MAAM,CA+BjB,CAAC;AAEF,eAAO,MAAM,WAAW,GAAU,SAAS;IACzC,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,WAAW,CAAC;IACxB,MAAM,CAAC,EAAE,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;IAC/B,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,KAAG,OAAO,CAAC,MAAM,CAuBjB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,aAAa,GAAU,SAAS;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,KAAG,OAAO,CAAC,MAAM,CAMjB,CAAA;AAED;;GAEG;AACH,oBAAY,QAAQ;IAClB,OAAO,WAAW;IAClB,QAAQ,YAAY;IACpB,KAAK,UAAU;IACf,+BAA+B,wCAAwC;IACvE,gCAAgC,yCAAyC;IACzE,qBAAqB,6BAA6B;IAClD,sBAAsB,8BAA8B;IACpD,WAAW,kBAAkB;IAC7B,YAAY,mBAAmB;IAC/B,wBAAwB,gCAAgC;IACxD,yBAAyB,iCAAiC;IAC1D,aAAa,oBAAoB;IACjC,cAAc,qBAAqB;IACnC,UAAU,gBAAgB;IAC1B,WAAW,iBAAiB;IAC5B,wBAAwB,gCAAgC;IACxD,yBAAyB,iCAAiC;IAC1D,yBAAyB,iCAAiC;IAC1D,0BAA0B,kCAAkC;IAC5D,oBAAoB,2BAA2B;IAC/C,qBAAqB,4BAA4B;IACjD,eAAe,qBAAqB;IACpC,gBAAgB,sBAAsB;IACtC,kBAAkB,yBAAyB;IAC3C,mBAAmB,0BAA0B;IAC7C,SAAS,eAAe;IACxB,UAAU,gBAAgB;IAC1B,8BAA8B,uCAAuC;IACrE,+BAA+B,wCAAwC;IACvE,oBAAoB,4BAA4B;IAChD,qBAAqB,6BAA6B;IAClD,aAAa,oBAAoB;IACjC,cAAc,qBAAqB;IACnC,oBAAoB,2BAA2B;IAC/C,qBAAqB,4BAA4B;IACjD,gBAAgB,uBAAuB;IACvC,iBAAiB,wBAAwB;IACzC,4BAA4B,oCAAoC;IAChE,6BAA6B,qCAAqC;IAClE,kBAAkB,yBAAyB;IAC3C,mBAAmB,0BAA0B;IAC7C,kBAAkB,yBAAyB;IAC3C,mBAAmB,0BAA0B;IAC7C,6BAA6B,qCAAqC;IAClE,8BAA8B,sCAAsC;IACpE,mBAAmB,0BAA0B;IAC7C,oBAAoB,2BAA2B;IAC/C,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAC9B,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAC9B,SAAS,eAAe;IACxB,UAAU,gBAAgB;IAC1B,gBAAgB,sBAAsB;IACtC,iBAAiB,uBAAuB;IACxC,WAAW,kBAAkB;IAC7B,YAAY,mBAAmB;IAC/B,gBAAgB,uBAAuB;IACvC,iBAAiB,wBAAwB;IACzC,+BAA+B,uCAAuC;IACtE,gCAAgC,wCAAwC;IACxE,uBAAuB,+BAA+B;IACtD,wBAAwB,gCAAgC;IACxD,2BAA2B,mCAAmC;IAC9D,4BAA4B,oCAAoC;IAChE,wBAAwB,+BAA+B;IACvD,yBAAyB,gCAAgC;CAC1D;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,SAAS,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACzC,CAAC"}
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/lib/auth.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAGtC,OAAO,EAAE,QAAQ,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAIvE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,SAAS,GAAI,SAAS;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;IAC/B,SAAS,CAAC,EAAE,WAAW,CAAC;CACzB,KAAG,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,CAezB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ,GAAU,SAAS;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,WAAW,CAAC;IACxB,MAAM,CAAC,EAAE,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;IAC/B,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,KAAG,OAAO,CAAC,MAAM,CA+BjB,CAAC;AAEF,eAAO,MAAM,WAAW,GAAU,SAAS;IACzC,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,WAAW,CAAC;IACxB,MAAM,CAAC,EAAE,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;IAC/B,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,KAAG,OAAO,CAAC,MAAM,CAuBjB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,aAAa,GAAU,SAAS;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,KAAG,OAAO,CAAC,MAAM,CAMjB,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,gCAAgC,GAAU,SAAS;IAC9D,MAAM,EAAE,KAAK,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,8EAA8E;IAC9E,eAAe,CAAC,EAAE,qBAAqB,CAAC;IACxC,sFAAsF;IACtF,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,KAAG,OAAO,CAAC,MAAM,CAcjB,CAAC;AAEF;;GAEG;AACH,oBAAY,QAAQ;IAClB,OAAO,WAAW;IAClB,QAAQ,YAAY;IACpB,KAAK,UAAU;IACf,+BAA+B,wCAAwC;IACvE,gCAAgC,yCAAyC;IACzE,qBAAqB,6BAA6B;IAClD,sBAAsB,8BAA8B;IACpD,WAAW,kBAAkB;IAC7B,YAAY,mBAAmB;IAC/B,wBAAwB,gCAAgC;IACxD,yBAAyB,iCAAiC;IAC1D,aAAa,oBAAoB;IACjC,cAAc,qBAAqB;IACnC,UAAU,gBAAgB;IAC1B,WAAW,iBAAiB;IAC5B,wBAAwB,gCAAgC;IACxD,yBAAyB,iCAAiC;IAC1D,yBAAyB,iCAAiC;IAC1D,0BAA0B,kCAAkC;IAC5D,oBAAoB,2BAA2B;IAC/C,qBAAqB,4BAA4B;IACjD,eAAe,qBAAqB;IACpC,gBAAgB,sBAAsB;IACtC,kBAAkB,yBAAyB;IAC3C,mBAAmB,0BAA0B;IAC7C,SAAS,eAAe;IACxB,UAAU,gBAAgB;IAC1B,8BAA8B,uCAAuC;IACrE,+BAA+B,wCAAwC;IACvE,oBAAoB,4BAA4B;IAChD,qBAAqB,6BAA6B;IAClD,aAAa,oBAAoB;IACjC,cAAc,qBAAqB;IACnC,oBAAoB,2BAA2B;IAC/C,qBAAqB,4BAA4B;IACjD,gBAAgB,uBAAuB;IACvC,iBAAiB,wBAAwB;IACzC,4BAA4B,oCAAoC;IAChE,6BAA6B,qCAAqC;IAClE,kBAAkB,yBAAyB;IAC3C,mBAAmB,0BAA0B;IAC7C,kBAAkB,yBAAyB;IAC3C,mBAAmB,0BAA0B;IAC7C,6BAA6B,qCAAqC;IAClE,8BAA8B,sCAAsC;IACpE,mBAAmB,0BAA0B;IAC7C,oBAAoB,2BAA2B;IAC/C,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAC9B,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAC9B,SAAS,eAAe;IACxB,UAAU,gBAAgB;IAC1B,gBAAgB,sBAAsB;IACtC,iBAAiB,uBAAuB;IACxC,WAAW,kBAAkB;IAC7B,YAAY,mBAAmB;IAC/B,gBAAgB,uBAAuB;IACvC,iBAAiB,wBAAwB;IACzC,+BAA+B,uCAAuC;IACtE,gCAAgC,wCAAwC;IACxE,uBAAuB,+BAA+B;IACtD,wBAAwB,gCAAgC;IACxD,2BAA2B,mCAAmC;IAC9D,4BAA4B,oCAAoC;IAChE,wBAAwB,+BAA+B;IACvD,yBAAyB,gCAAgC;CAC1D;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,SAAS,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACzC,CAAC"}

package/lib/auth.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.JWTScope = exports.getEmbedToken = exports.updateToken = exports.getToken = exports.withToken = void 0;
+exports.JWTScope = exports.getEmbedTokenWithCheckoutSession = exports.getEmbedToken = exports.updateToken = exports.getToken = exports.withToken = void 0;
 const node_crypto_1 = require("node:crypto");
 const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
 const snakecase_keys_1 = __importDefault(require("snakecase-keys"));
@@ -74,6 +74,25 @@ const getEmbedToken = async (options) => {
     });
 };
 exports.getEmbedToken = getEmbedToken;
+/**
+ * Helper method that creates a checkout session and returns an Embed token with
+ * the new checkout session ID baked in.
+ *
+ * This is a convenience wrapper around `getEmbedToken` for the common Embed flow
+ * where every transaction should be tied to a checkout session. It uses the
+ * provided (already authenticated) SDK client to create the checkout session,
+ * then signs an Embed token that pins the resulting `checkout_session_id`.
+ */
+const getEmbedTokenWithCheckoutSession = async (options) => {
+    const { client, privateKey, embedParams, checkoutSession, merchantAccountId } = options;
+    const session = await client.checkoutSessions.create(checkoutSession, merchantAccountId);
+    return (0, exports.getEmbedToken)({
+        privateKey,
+        ...(embedParams ? { embedParams } : {}),
+        checkoutSessionId: session.id,
+    });
+};
+exports.getEmbedTokenWithCheckoutSession = getEmbedTokenWithCheckoutSession;
 /**
  * Short hands for scopes. Strings can be used as well.
  */

package/lib/auth.js.map

@@ -1 +1 @@
-{"version":3,"file":"auth.js","sourceRoot":"","sources":["../src/lib/auth.ts"],"names":[],"mappings":";;;;;;AAAA,6CAAyC;AACzC,gEAA+C;AAE/C,oEAA2C;AAG3C,qCAAwC;AACxC,uCAAqC;AAErC;;GAEG;AACI,MAAM,SAAS,GAAG,CAAC,OAIzB,EAA2B,EAAE;IAC5B,MAAM,EACJ,UAAU,EACV,MAAM,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAC9C,SAAS,GAAG,KAAK,GAClB,GAAG,OAAO,CAAC;IAEZ,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,KAAK,IAAqB,EAAE;QACjC,MAAM,UAAU,GAAG,MAAM,IAAA,gBAAQ,EAAC,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QACrE,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC,CAAC;AAnBW,QAAA,SAAS,aAmBpB;AAEF;;GAEG;AACI,MAAM,QAAQ,GAAG,KAAK,EAAE,OAM9B,EAAmB,EAAE;IACpB,MAAM,EACJ,UAAU,EACV,iBAAiB,EACjB,WAAW,EACX,MAAM,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAC9C,SAAS,GAAG,KAAK,GAClB,GAAG,OAAO,CAAC;IAEZ,MAAM,KAAK,GAAG,MAAM,IAAA,kBAAQ,EAAC,UAAU,CAAC,CAAC;IACzC,MAAM,MAAM,GAAW,EAAE,MAAM,EAAE,CAAC;IAElC,IAAI,iBAAiB,EAAE,CAAC;QACtB,MAAM,CAAC,qBAAqB,CAAC,GAAG,iBAAiB,CAAC;IACpD,CAAC;IAED,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,WAAW,EAAE,CAAC;QACnD,MAAM,WAAW,GACf,WAAW,CAAC,iBAAiB,IAAI,WAAW,CAAC,mBAAmB,CAAC,CAAC;QACpE,MAAM,CAAC,OAAO,CAAC,GAAG,IAAA,wBAAa,EAAC,WAAW,EAAE,EAAE,OAAO,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACxE,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,GAAG,WAAW,CAAC;IACtD,CAAC;IAED,OAAO,sBAAG,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE;QAClC,SAAS,EAAE,OAAO;QAClB,KAAK;QACL,KAAK,EAAE,IAAA,wBAAU,GAAE;QACnB,SAAS,EAAE,SAAS;QACpB,SAAS,EAAE,IAAI;QACf,MAAM,EAAE,qBAAY,CAAC,SAAS;KAC/B,CAAC,CAAC;AACL,CAAC,CAAC;AArCW,QAAA,QAAQ,YAqCnB;AAEK,MAAM,WAAW,GAAG,KAAK,EAAE,OAOjC,EAAmB,EAAE;IACpB,MAAM,EACJ,KAAK,EACL,UAAU,EACV,MAAM,EACN,iBAAiB,EACjB,WAAW,EACX,SAAS,GAAG,KAAK,GAClB,GAAG,OAAO,CAAC;IAEZ,MAAM,OAAO,GAAG,sBAAG,CAAC,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE;QAC5C,UAAU,EAAE,CAAC,OAAO,CAAC;QACrB,gBAAgB,EAAE,IAAI;KACvB,CAAwB,CAAA;IAGzB,OAAO,IAAA,gBAAQ,EAAC;QACd,UAAU;QACV,MAAM,EAAE,MAAM,IAAI,OAAO,CAAC,MAAM;QAChC,SAAS;QACT,WAAW,EAAE,WAAW,IAAI,OAAO,CAAC,KAAK;QACzC,iBAAiB,EAAE,iBAAiB,IAAI,OAAO,CAAC,mBAAmB;KACpE,CAAC,CAAA;AACJ,CAAC,CAAA;AA9BY,QAAA,WAAW,eA8BvB;AAED;;GAEG;AACI,MAAM,aAAa,GAAG,KAAK,EAAE,OAInC,EAAmB,EAAE;IACpB,OAAO,IAAA,gBAAQ,EAAC;QACd,GAAG,OAAO;QACV,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;QACxB,SAAS,EAAE,IAAI;KACf,CAAC,CAAA;AACL,CAAC,CAAA;AAVY,QAAA,aAAa,iBAUzB;AAED;;GAEG;AACH,IAAY,QAoEX;AApED,WAAY,QAAQ;IAClB,8BAAkB,CAAA;IAClB,gCAAoB,CAAA;IACpB,2BAAe,CAAA;IACf,mFAAuE,CAAA;IACvE,qFAAyE,CAAA;IACzE,8DAAkD,CAAA;IAClD,gEAAoD,CAAA;IACpD,yCAA6B,CAAA;IAC7B,2CAA+B,CAAA;IAC/B,oEAAwD,CAAA;IACxD,sEAA0D,CAAA;IAC1D,6CAAiC,CAAA;IACjC,+CAAmC,CAAA;IACnC,sCAA0B,CAAA;IAC1B,wCAA4B,CAAA;IAC5B,oEAAwD,CAAA;IACxD,sEAA0D,CAAA;IAC1D,sEAA0D,CAAA;IAC1D,wEAA4D,CAAA;IAC5D,2DAA+C,CAAA;IAC/C,6DAAiD,CAAA;IACjD,gDAAoC,CAAA;IACpC,kDAAsC,CAAA;IACtC,uDAA2C,CAAA;IAC3C,yDAA6C,CAAA;IAC7C,oCAAwB,CAAA;IACxB,sCAA0B,CAAA;IAC1B,iFAAqE,CAAA;IACrE,mFAAuE,CAAA;IACvE,4DAAgD,CAAA;IAChD,8DAAkD,CAAA;IAClD,6CAAiC,CAAA;IACjC,+CAAmC,CAAA;IACnC,2DAA+C,CAAA;IAC/C,6DAAiD,CAAA;IACjD,mDAAuC,CAAA;IACvC,qDAAyC,CAAA;IACzC,4EAAgE,CAAA;IAChE,8EAAkE,CAAA;IAClE,uDAA2C,CAAA;IAC3C,yDAA6C,CAAA;IAC7C,uDAA2C,CAAA;IAC3C,yDAA6C,CAAA;IAC7C,8EAAkE,CAAA;IAClE,gFAAoE,CAAA;IACpE,yDAA6C,CAAA;IAC7C,2DAA+C,CAAA;IAC/C,wCAA4B,CAAA;IAC5B,0CAA8B,CAAA;IAC9B,wCAA4B,CAAA;IAC5B,0CAA8B,CAAA;IAC9B,oCAAwB,CAAA;IACxB,sCAA0B,CAAA;IAC1B,kDAAsC,CAAA;IACtC,oDAAwC,CAAA;IACxC,yCAA6B,CAAA;IAC7B,2CAA+B,CAAA;IAC/B,mDAAuC,CAAA;IACvC,qDAAyC,CAAA;IACzC,kFAAsE,CAAA;IACtE,oFAAwE,CAAA;IACxE,kEAAsD,CAAA;IACtD,oEAAwD,CAAA;IACxD,0EAA8D,CAAA;IAC9D,4EAAgE,CAAA;IAChE,mEAAuD,CAAA;IACvD,qEAAyD,CAAA;AAC3D,CAAC,EApEW,QAAQ,wBAAR,QAAQ,QAoEnB"}
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../src/lib/auth.ts"],"names":[],"mappings":";;;;;;AAAA,6CAAyC;AACzC,gEAA+C;AAE/C,oEAA2C;AAG3C,qCAAwC;AACxC,uCAAqC;AAIrC;;GAEG;AACI,MAAM,SAAS,GAAG,CAAC,OAIzB,EAA2B,EAAE;IAC5B,MAAM,EACJ,UAAU,EACV,MAAM,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAC9C,SAAS,GAAG,KAAK,GAClB,GAAG,OAAO,CAAC;IAEZ,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,KAAK,IAAqB,EAAE;QACjC,MAAM,UAAU,GAAG,MAAM,IAAA,gBAAQ,EAAC,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QACrE,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC,CAAC;AAnBW,QAAA,SAAS,aAmBpB;AAEF;;GAEG;AACI,MAAM,QAAQ,GAAG,KAAK,EAAE,OAM9B,EAAmB,EAAE;IACpB,MAAM,EACJ,UAAU,EACV,iBAAiB,EACjB,WAAW,EACX,MAAM,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAC9C,SAAS,GAAG,KAAK,GAClB,GAAG,OAAO,CAAC;IAEZ,MAAM,KAAK,GAAG,MAAM,IAAA,kBAAQ,EAAC,UAAU,CAAC,CAAC;IACzC,MAAM,MAAM,GAAW,EAAE,MAAM,EAAE,CAAC;IAElC,IAAI,iBAAiB,EAAE,CAAC;QACtB,MAAM,CAAC,qBAAqB,CAAC,GAAG,iBAAiB,CAAC;IACpD,CAAC;IAED,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,WAAW,EAAE,CAAC;QACnD,MAAM,WAAW,GACf,WAAW,CAAC,iBAAiB,IAAI,WAAW,CAAC,mBAAmB,CAAC,CAAC;QACpE,MAAM,CAAC,OAAO,CAAC,GAAG,IAAA,wBAAa,EAAC,WAAW,EAAE,EAAE,OAAO,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACxE,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,GAAG,WAAW,CAAC;IACtD,CAAC;IAED,OAAO,sBAAG,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE;QAClC,SAAS,EAAE,OAAO;QAClB,KAAK;QACL,KAAK,EAAE,IAAA,wBAAU,GAAE;QACnB,SAAS,EAAE,SAAS;QACpB,SAAS,EAAE,IAAI;QACf,MAAM,EAAE,qBAAY,CAAC,SAAS;KAC/B,CAAC,CAAC;AACL,CAAC,CAAC;AArCW,QAAA,QAAQ,YAqCnB;AAEK,MAAM,WAAW,GAAG,KAAK,EAAE,OAOjC,EAAmB,EAAE;IACpB,MAAM,EACJ,KAAK,EACL,UAAU,EACV,MAAM,EACN,iBAAiB,EACjB,WAAW,EACX,SAAS,GAAG,KAAK,GAClB,GAAG,OAAO,CAAC;IAEZ,MAAM,OAAO,GAAG,sBAAG,CAAC,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE;QAC5C,UAAU,EAAE,CAAC,OAAO,CAAC;QACrB,gBAAgB,EAAE,IAAI;KACvB,CAAwB,CAAA;IAGzB,OAAO,IAAA,gBAAQ,EAAC;QACd,UAAU;QACV,MAAM,EAAE,MAAM,IAAI,OAAO,CAAC,MAAM;QAChC,SAAS;QACT,WAAW,EAAE,WAAW,IAAI,OAAO,CAAC,KAAK;QACzC,iBAAiB,EAAE,iBAAiB,IAAI,OAAO,CAAC,mBAAmB;KACpE,CAAC,CAAA;AACJ,CAAC,CAAA;AA9BY,QAAA,WAAW,eA8BvB;AAED;;GAEG;AACI,MAAM,aAAa,GAAG,KAAK,EAAE,OAInC,EAAmB,EAAE;IACpB,OAAO,IAAA,gBAAQ,EAAC;QACd,GAAG,OAAO;QACV,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;QACxB,SAAS,EAAE,IAAI;KACf,CAAC,CAAA;AACL,CAAC,CAAA;AAVY,QAAA,aAAa,iBAUzB;AAED;;;;;;;;GAQG;AACI,MAAM,gCAAgC,GAAG,KAAK,EAAE,OAQtD,EAAmB,EAAE;IACpB,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,eAAe,EAAE,iBAAiB,EAAE,GAC3E,OAAO,CAAC;IAEV,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAClD,eAAe,EACf,iBAAiB,CAClB,CAAC;IAEF,OAAO,IAAA,qBAAa,EAAC;QACnB,UAAU;QACV,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvC,iBAAiB,EAAE,OAAO,CAAC,EAAE;KAC9B,CAAC,CAAC;AACL,CAAC,CAAC;AAtBW,QAAA,gCAAgC,oCAsB3C;AAEF;;GAEG;AACH,IAAY,QAoEX;AApED,WAAY,QAAQ;IAClB,8BAAkB,CAAA;IAClB,gCAAoB,CAAA;IACpB,2BAAe,CAAA;IACf,mFAAuE,CAAA;IACvE,qFAAyE,CAAA;IACzE,8DAAkD,CAAA;IAClD,gEAAoD,CAAA;IACpD,yCAA6B,CAAA;IAC7B,2CAA+B,CAAA;IAC/B,oEAAwD,CAAA;IACxD,sEAA0D,CAAA;IAC1D,6CAAiC,CAAA;IACjC,+CAAmC,CAAA;IACnC,sCAA0B,CAAA;IAC1B,wCAA4B,CAAA;IAC5B,oEAAwD,CAAA;IACxD,sEAA0D,CAAA;IAC1D,sEAA0D,CAAA;IAC1D,wEAA4D,CAAA;IAC5D,2DAA+C,CAAA;IAC/C,6DAAiD,CAAA;IACjD,gDAAoC,CAAA;IACpC,kDAAsC,CAAA;IACtC,uDAA2C,CAAA;IAC3C,yDAA6C,CAAA;IAC7C,oCAAwB,CAAA;IACxB,sCAA0B,CAAA;IAC1B,iFAAqE,CAAA;IACrE,mFAAuE,CAAA;IACvE,4DAAgD,CAAA;IAChD,8DAAkD,CAAA;IAClD,6CAAiC,CAAA;IACjC,+CAAmC,CAAA;IACnC,2DAA+C,CAAA;IAC/C,6DAAiD,CAAA;IACjD,mDAAuC,CAAA;IACvC,qDAAyC,CAAA;IACzC,4EAAgE,CAAA;IAChE,8EAAkE,CAAA;IAClE,uDAA2C,CAAA;IAC3C,yDAA6C,CAAA;IAC7C,uDAA2C,CAAA;IAC3C,yDAA6C,CAAA;IAC7C,8EAAkE,CAAA;IAClE,gFAAoE,CAAA;IACpE,yDAA6C,CAAA;IAC7C,2DAA+C,CAAA;IAC/C,wCAA4B,CAAA;IAC5B,0CAA8B,CAAA;IAC9B,wCAA4B,CAAA;IAC5B,0CAA8B,CAAA;IAC9B,oCAAwB,CAAA;IACxB,sCAA0B,CAAA;IAC1B,kDAAsC,CAAA;IACtC,oDAAwC,CAAA;IACxC,yCAA6B,CAAA;IAC7B,2CAA+B,CAAA;IAC/B,mDAAuC,CAAA;IACvC,qDAAyC,CAAA;IACzC,kFAAsE,CAAA;IACtE,oFAAwE,CAAA;IACxE,kEAAsD,CAAA;IACtD,oEAAwD,CAAA;IACxD,0EAA8D,CAAA;IAC9D,4EAAgE,CAAA;IAChE,mEAAuD,CAAA;IACvD,qEAAyD,CAAA;AAC3D,CAAC,EApEW,QAAQ,wBAAR,QAAQ,QAoEnB"}

package/lib/config.d.ts

@@ -44,8 +44,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
     readonly openapiDocVersion: "1.0.0";
-    readonly sdkVersion: "2.3.0";
-    readonly genVersion: "2.903.2";
-    readonly userAgent: "speakeasy-sdk/typescript 2.3.0 2.903.2 1.0.0 @gr4vy/sdk";
+    readonly sdkVersion: "2.3.1";
+    readonly genVersion: "2.904.2";
+    readonly userAgent: "speakeasy-sdk/typescript 2.3.1 2.904.2 1.0.0 @gr4vy/sdk";
 };
 //# sourceMappingURL=config.d.ts.map

package/lib/config.js

@@ -37,8 +37,8 @@ function serverURLFromOptions(options) {
 exports.SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "1.0.0",
-    sdkVersion: "2.3.0",
-    genVersion: "2.903.2",
-    userAgent: "speakeasy-sdk/typescript 2.3.0 2.903.2 1.0.0 @gr4vy/sdk",
+    sdkVersion: "2.3.1",
+    genVersion: "2.904.2",
+    userAgent: "speakeasy-sdk/typescript 2.3.1 2.904.2 1.0.0 @gr4vy/sdk",
 };
 //# sourceMappingURL=config.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gr4vy/sdk",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "author": "Gr4vy",
   "main": "./index.js",
   "sideEffects": false,

package/src/index.ts

@@ -7,6 +7,7 @@ export * from "./sdk";
 
 export {
     getEmbedToken,
+    getEmbedTokenWithCheckoutSession,
     getToken,
     JWTScope,
     updateToken,

package/src/lib/auth.ts

@@ -3,10 +3,12 @@ import jwt, { JwtPayload } from "jsonwebtoken";
 import type { StringValue } from "ms";
 import snakeCaseKeys from "snakecase-keys";
 
-import { CartItem } from "../models/components";
+import { CartItem, CheckoutSessionCreate } from "../models/components";
 import { SDK_METADATA } from "./config";
 import { getKeyId } from "./helpers";
 
+import type { Gr4vy } from "../sdk/sdk";
+
 /**
  * Helper method for generating a bearer token for use with the SDK
  */
@@ -120,6 +122,39 @@ export const getEmbedToken = async (options: {
    })
 }
 
+/**
+ * Helper method that creates a checkout session and returns an Embed token with
+ * the new checkout session ID baked in.
+ *
+ * This is a convenience wrapper around `getEmbedToken` for the common Embed flow
+ * where every transaction should be tied to a checkout session. It uses the
+ * provided (already authenticated) SDK client to create the checkout session,
+ * then signs an Embed token that pins the resulting `checkout_session_id`.
+ */
+export const getEmbedTokenWithCheckoutSession = async (options: {
+  client: Gr4vy;
+  privateKey: string;
+  embedParams?: EmbedParams;
+  /** Optional checkout session body to seed cart items, metadata, and so on. */
+  checkoutSession?: CheckoutSessionCreate;
+  /** Optional merchant account ID override. Defaults to the client's configured one. */
+  merchantAccountId?: string;
+}): Promise<string> => {
+  const { client, privateKey, embedParams, checkoutSession, merchantAccountId } =
+    options;
+
+  const session = await client.checkoutSessions.create(
+    checkoutSession,
+    merchantAccountId,
+  );
+
+  return getEmbedToken({
+    privateKey,
+    ...(embedParams ? { embedParams } : {}),
+    checkoutSessionId: session.id,
+  });
+};
+
 /**
  * Short hands for scopes. Strings can be used as well.
  */

package/src/lib/config.ts

@@ -77,7 +77,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "2.3.0",
-  genVersion: "2.903.2",
-  userAgent: "speakeasy-sdk/typescript 2.3.0 2.903.2 1.0.0 @gr4vy/sdk",
+  sdkVersion: "2.3.1",
+  genVersion: "2.904.2",
+  userAgent: "speakeasy-sdk/typescript 2.3.1 2.904.2 1.0.0 @gr4vy/sdk",
 } as const;

package/tests/auth.test.js

@@ -1,9 +1,9 @@
 import jwt from "jsonwebtoken";
 import snakecaseKeys from "snakecase-keys";
 import timekeeper from "timekeeper";
-import { describe, expect, test } from "vitest";
+import { describe, expect, test, vi } from "vitest";
 import { version } from "../package.json";
-import { getEmbedToken, getToken, JWTScope, updateToken, SDK_METADATA } from "../src";
+import { getEmbedToken, getEmbedTokenWithCheckoutSession, getToken, JWTScope, updateToken, SDK_METADATA } from "../src";
 
 const privateKey = `-----BEGIN PRIVATE KEY-----
 MIHuAgEAMBAGByqGSM49AgEGBSuBBAAjBIHWMIHTAgEBBEIBABM9jQu+HT87oIik
@@ -142,6 +142,50 @@ describe(".getEmbedToken", () => {
   });
 });
 
+describe(".getEmbedTokenWithCheckoutSession", () => {
+  test("should create a checkout session and pin its ID in the Embed token", async () => {
+    const create = vi.fn().mockResolvedValue({ id: checkoutSessionId });
+    const client = { checkoutSessions: { create } };
+
+    const token = await getEmbedTokenWithCheckoutSession({
+      client,
+      privateKey,
+      embedParams,
+    });
+
+    const decoded = jwt.verify(token, privateKey, {
+      algorithms: ["ES512"],
+      complete: true,
+    });
+
+    expect(create).toHaveBeenCalledTimes(1);
+    expect(decoded.payload.scopes).toEqual(["embed"]);
+    expect(decoded.payload.checkout_session_id).toEqual(checkoutSessionId);
+
+    const connOptions =
+      embedParams.connectionOptions || embedParams["connection_options"];
+    const expected = snakecaseKeys(embedParams, { exclude: ["metadata"] });
+    expected["connection_options"] = connOptions;
+    expect(decoded.payload.embed).toEqual(expected);
+  });
+
+  test("should forward the checkout session body and merchant account ID", async () => {
+    const create = vi.fn().mockResolvedValue({ id: checkoutSessionId });
+    const client = { checkoutSessions: { create } };
+
+    const checkoutSession = { metadata: { order: "123" } };
+
+    await getEmbedTokenWithCheckoutSession({
+      client,
+      privateKey,
+      checkoutSession,
+      merchantAccountId: "default",
+    });
+
+    expect(create).toHaveBeenCalledWith(checkoutSession, "default");
+  });
+});
+
 describe(".updateToken", () => {
   test("should resign a token with a new signature and expiration", async () => {
     timekeeper.freeze(Date.now());

package/tests/flows/transaction-lifecycle.test.ts

@@ -84,6 +84,36 @@ describe("Transaction lifecycle", () => {
     expect(topLevel.id).toBe(firstRefundId);
   });
 
+  test("authorize → capture → read captures back via list and get", async () => {
+    const transaction = await authorize(4500);
+    expect(transaction.status).toBe("authorization_succeeded");
+
+    unwrapTransaction(
+      await gr4vy.transactions.capture({
+        transactionId: transaction.id,
+        transactionCaptureCreate: { amount: 4500 },
+      })
+    );
+
+    // Wait until the capture is recorded against the transaction.
+    await pollUntil(
+      () => gr4vy.transactions.get(transaction.id),
+      (t) => t.status === "capture_succeeded",
+      { description: "capture to succeed" }
+    );
+
+    // List captures, then read one back by id.
+    const captures = await gr4vy.transactions.captures.list(transaction.id);
+    expect(captures.items.length).toBeGreaterThanOrEqual(1);
+
+    const captureId = captures.items[0]!.id;
+    const fetched = await gr4vy.transactions.captures.get(
+      transaction.id,
+      captureId
+    );
+    expect(fetched.id).toBe(captureId);
+  });
+
   test("authorize → void releases the authorization", async () => {
     const transaction = await authorize(3300);
     expect(transaction.status).toBe("authorization_succeeded");