@schematichq/schematic-typescript-node 1.1.9 → 1.1.11

package/serialization/types/WebhookEventDetailResponseData.js

@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebhookEventDetailResponseData = void 0;
 const core = __importStar(require("../../core"));

package/serialization/types/WebhookEventResponseData.js

@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebhookEventResponseData = void 0;
 const core = __importStar(require("../../core"));

package/serialization/types/WebhookResponseData.d.ts

@@ -4,13 +4,16 @@
 import * as serializers from "../index";
 import * as Schematic from "../../api/index";
 import * as core from "../../core";
+import { EntitlementTriggerConfig } from "./EntitlementTriggerConfig";
 export declare const WebhookResponseData: core.serialization.ObjectSchema<serializers.WebhookResponseData.Raw, Schematic.WebhookResponseData>;
 export declare namespace WebhookResponseData {
     interface Raw {
         created_at: string;
+        entitlement_trigger_configs?: EntitlementTriggerConfig.Raw[] | null;
         id: string;
         name: string;
         request_types: string[];
+        secret: string;
         status: string;
         updated_at: string;
         url: string;

package/serialization/types/WebhookResponseData.js

@@ -18,21 +18,34 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebhookResponseData = void 0;
 const core = __importStar(require("../../core"));
+const EntitlementTriggerConfig_1 = require("./EntitlementTriggerConfig");
 exports.WebhookResponseData = core.serialization.object({
     createdAt: core.serialization.property("created_at", core.serialization.date()),
+    entitlementTriggerConfigs: core.serialization.property("entitlement_trigger_configs", core.serialization.list(EntitlementTriggerConfig_1.EntitlementTriggerConfig).optional()),
     id: core.serialization.string(),
     name: core.serialization.string(),
     requestTypes: core.serialization.property("request_types", core.serialization.list(core.serialization.string())),
+    secret: core.serialization.string(),
     status: core.serialization.string(),
     updatedAt: core.serialization.property("updated_at", core.serialization.date()),
     url: core.serialization.string(),

package/serialization/types/index.d.ts

@@ -15,6 +15,8 @@ export * from "./BillingProductDetailResponseData";
 export * from "./BillingProductForSubscriptionResponseData";
 export * from "./BillingProductPlanResponseData";
 export * from "./BillingProductPriceResponseData";
+export * from "./BillingProductPriceTierResponseData";
+export * from "./BillingProductPricingUsageType";
 export * from "./BillingProductPricing";
 export * from "./BillingProductResponseData";
 export * from "./BillingSubscriptionDiscount";
@@ -43,6 +45,7 @@ export * from "./ComponentPreviewResponseData";
 export * from "./ComponentResponseData";
 export * from "./CountResponse";
 export * from "./CouponRequestBody";
+export * from "./CreateBillingPriceTierRequestBody";
 export * from "./CreateEntitlementReqCommonMetricPeriod";
 export * from "./CreateEntitlementReqCommonMetricPeriodMonthReset";
 export * from "./CreateEntitlementReqCommonValueType";
@@ -68,8 +71,13 @@ export * from "./CrmDealLineItem";
 export * from "./CrmDealResponseData";
 export * from "./CrmLineItemResponseData";
 export * from "./CrmProductResponseData";
+export * from "./CustomPlanConfig";
+export * from "./CustomPlanViewConfigResponseData";
+export * from "./DataExportResponseData";
 export * from "./Decimal";
 export * from "./DeleteResponse";
+export * from "./EntitlementTriggerConfig";
+export * from "./EntitlementsInPlan";
 export * from "./EntityKeyDefinitionResponseData";
 export * from "./EntityKeyDetailResponseData";
 export * from "./EntityKeyResponseData";
@@ -99,6 +107,7 @@ export * from "./InvoiceResponseData";
 export * from "./IssueTemporaryAccessTokenResponseData";
 export * from "./KeysRequestBody";
 export * from "./MeterRequestBody";
+export * from "./OrderedPlansInGroup";
 export * from "./PaginationFilter";
 export * from "./PaymentMethodRequestBody";
 export * from "./PaymentMethodResponseData";
@@ -106,13 +115,19 @@ export * from "./PlanAudienceDetailResponseData";
 export * from "./PlanAudienceResponseData";
 export * from "./PlanDetailResponseData";
 export * from "./PlanEntitlementResponseData";
+export * from "./PlanEntitlementsOrder";
 export * from "./PlanGroupDetailResponseData";
 export * from "./PlanGroupPlanDetailResponseData";
+export * from "./PlanGroupPlanEntitlementsOrder";
 export * from "./PlanGroupResponseData";
 export * from "./PlanResponseData";
+export * from "./PlanTraitResponseData";
 export * from "./PreviewObject";
 export * from "./PreviewObjectResponseData";
 export * from "./PreviewSubscriptionChangeResponseData";
+export * from "./PreviewSubscriptionFinanceResponseData";
+export * from "./PreviewSubscriptionUpcomingInvoiceLineItems";
+export * from "./QuickstartResp";
 export * from "./RawEventBatchResponseData";
 export * from "./RawEventResponseData";
 export * from "./RuleConditionDetailResponseData";

package/serialization/types/index.js

@@ -31,6 +31,8 @@ __exportStar(require("./BillingProductDetailResponseData"), exports);
 __exportStar(require("./BillingProductForSubscriptionResponseData"), exports);
 __exportStar(require("./BillingProductPlanResponseData"), exports);
 __exportStar(require("./BillingProductPriceResponseData"), exports);
+__exportStar(require("./BillingProductPriceTierResponseData"), exports);
+__exportStar(require("./BillingProductPricingUsageType"), exports);
 __exportStar(require("./BillingProductPricing"), exports);
 __exportStar(require("./BillingProductResponseData"), exports);
 __exportStar(require("./BillingSubscriptionDiscount"), exports);
@@ -59,6 +61,7 @@ __exportStar(require("./ComponentPreviewResponseData"), exports);
 __exportStar(require("./ComponentResponseData"), exports);
 __exportStar(require("./CountResponse"), exports);
 __exportStar(require("./CouponRequestBody"), exports);
+__exportStar(require("./CreateBillingPriceTierRequestBody"), exports);
 __exportStar(require("./CreateEntitlementReqCommonMetricPeriod"), exports);
 __exportStar(require("./CreateEntitlementReqCommonMetricPeriodMonthReset"), exports);
 __exportStar(require("./CreateEntitlementReqCommonValueType"), exports);
@@ -84,8 +87,13 @@ __exportStar(require("./CrmDealLineItem"), exports);
 __exportStar(require("./CrmDealResponseData"), exports);
 __exportStar(require("./CrmLineItemResponseData"), exports);
 __exportStar(require("./CrmProductResponseData"), exports);
+__exportStar(require("./CustomPlanConfig"), exports);
+__exportStar(require("./CustomPlanViewConfigResponseData"), exports);
+__exportStar(require("./DataExportResponseData"), exports);
 __exportStar(require("./Decimal"), exports);
 __exportStar(require("./DeleteResponse"), exports);
+__exportStar(require("./EntitlementTriggerConfig"), exports);
+__exportStar(require("./EntitlementsInPlan"), exports);
 __exportStar(require("./EntityKeyDefinitionResponseData"), exports);
 __exportStar(require("./EntityKeyDetailResponseData"), exports);
 __exportStar(require("./EntityKeyResponseData"), exports);
@@ -115,6 +123,7 @@ __exportStar(require("./InvoiceResponseData"), exports);
 __exportStar(require("./IssueTemporaryAccessTokenResponseData"), exports);
 __exportStar(require("./KeysRequestBody"), exports);
 __exportStar(require("./MeterRequestBody"), exports);
+__exportStar(require("./OrderedPlansInGroup"), exports);
 __exportStar(require("./PaginationFilter"), exports);
 __exportStar(require("./PaymentMethodRequestBody"), exports);
 __exportStar(require("./PaymentMethodResponseData"), exports);
@@ -122,13 +131,19 @@ __exportStar(require("./PlanAudienceDetailResponseData"), exports);
 __exportStar(require("./PlanAudienceResponseData"), exports);
 __exportStar(require("./PlanDetailResponseData"), exports);
 __exportStar(require("./PlanEntitlementResponseData"), exports);
+__exportStar(require("./PlanEntitlementsOrder"), exports);
 __exportStar(require("./PlanGroupDetailResponseData"), exports);
 __exportStar(require("./PlanGroupPlanDetailResponseData"), exports);
+__exportStar(require("./PlanGroupPlanEntitlementsOrder"), exports);
 __exportStar(require("./PlanGroupResponseData"), exports);
 __exportStar(require("./PlanResponseData"), exports);
+__exportStar(require("./PlanTraitResponseData"), exports);
 __exportStar(require("./PreviewObject"), exports);
 __exportStar(require("./PreviewObjectResponseData"), exports);
 __exportStar(require("./PreviewSubscriptionChangeResponseData"), exports);
+__exportStar(require("./PreviewSubscriptionFinanceResponseData"), exports);
+__exportStar(require("./PreviewSubscriptionUpcomingInvoiceLineItems"), exports);
+__exportStar(require("./QuickstartResp"), exports);
 __exportStar(require("./RawEventBatchResponseData"), exports);
 __exportStar(require("./RawEventResponseData"), exports);
 __exportStar(require("./RuleConditionDetailResponseData"), exports);

package/webhooks.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Webhook verification utilities for verifying webhooks from Schematic.
+ */
+import { IncomingMessage } from "http";
+/**
+ * HTTP header containing the webhook signature.
+ */
+export declare const WEBHOOK_SIGNATURE_HEADER = "X-Schematic-Webhook-Signature";
+/**
+ * HTTP header containing the webhook timestamp.
+ */
+export declare const WEBHOOK_TIMESTAMP_HEADER = "X-Schematic-Webhook-Timestamp";
+/**
+ * Error class for invalid webhook signatures.
+ */
+export declare class WebhookSignatureError extends Error {
+    constructor(message: string);
+    static missingSignature(): WebhookSignatureError;
+    static missingTimestamp(): WebhookSignatureError;
+    static invalidSignature(): WebhookSignatureError;
+}
+/**
+ * Computes the HMAC-SHA256 signature for a webhook payload.
+ * @param body - The request body.
+ * @param timestamp - The timestamp from the webhook request.
+ * @param secret - The webhook secret.
+ * @returns The computed signature as a Buffer.
+ */
+export declare function computeSignature(body: Buffer | string, timestamp: string, secret: string): Buffer;
+/**
+ * Computes and hex-encodes the HMAC-SHA256 signature for a webhook payload.
+ * @param body - The request body.
+ * @param timestamp - The timestamp from the webhook request.
+ * @param secret - The webhook secret.
+ * @returns The computed signature as a hex-encoded string.
+ */
+export declare function computeHexSignature(body: Buffer | string, timestamp: string, secret: string): string;
+/**
+ * Verifies a webhook signature against the payload and timestamp.
+ * @param payload - The request body.
+ * @param signature - The signature from the webhook request.
+ * @param timestamp - The timestamp from the webhook request.
+ * @param secret - The webhook secret.
+ * @throws {WebhookSignatureError} If the signature is invalid or headers are missing.
+ */
+export declare function verifySignature(payload: Buffer | string, signature: string, timestamp: string, secret: string): void;
+/**
+ * Options for webhook verification.
+ */
+interface VerifyWebhookSignatureOptions {
+    /**
+     * Custom signature header name. Defaults to 'X-Schematic-Webhook-Signature'.
+     */
+    signatureHeader?: string;
+    /**
+     * Custom timestamp header name. Defaults to 'X-Schematic-Webhook-Timestamp'.
+     */
+    timestampHeader?: string;
+}
+/**
+ * Represents a request object with headers and optional raw body.
+ */
+export type WebhookRequest = IncomingMessage | {
+    headers: Record<string, string | string[] | undefined>;
+    rawBody?: Buffer | string;
+};
+/**
+ * Verifies the signature of a webhook request.
+ * @param req - The request object.
+ * @param secret - The webhook secret.
+ * @param body - The raw request body. Required when using frameworks that parse the body beforehand.
+ * @param options - Optional configuration for header names.
+ * @throws {WebhookSignatureError} If the signature is invalid or headers are missing.
+ */
+export declare function verifyWebhookSignature(req: WebhookRequest, secret: string, body?: Buffer | string, options?: VerifyWebhookSignatureOptions): void;
+export {};

package/webhooks.js

@@ -0,0 +1,170 @@
+"use strict";
+/**
+ * Webhook verification utilities for verifying webhooks from Schematic.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookSignatureError = exports.WEBHOOK_TIMESTAMP_HEADER = exports.WEBHOOK_SIGNATURE_HEADER = void 0;
+exports.computeSignature = computeSignature;
+exports.computeHexSignature = computeHexSignature;
+exports.verifySignature = verifySignature;
+exports.verifyWebhookSignature = verifyWebhookSignature;
+const crypto = __importStar(require("crypto"));
+/**
+ * HTTP header containing the webhook signature.
+ */
+exports.WEBHOOK_SIGNATURE_HEADER = "X-Schematic-Webhook-Signature";
+/**
+ * HTTP header containing the webhook timestamp.
+ */
+exports.WEBHOOK_TIMESTAMP_HEADER = "X-Schematic-Webhook-Timestamp";
+/**
+ * Error class for invalid webhook signatures.
+ */
+class WebhookSignatureError extends Error {
+    constructor(message) {
+        super(message);
+        Object.setPrototypeOf(this, WebhookSignatureError.prototype);
+        this.name = "WebhookSignatureError";
+    }
+    static missingSignature() {
+        return new WebhookSignatureError("Missing webhook signature header");
+    }
+    static missingTimestamp() {
+        return new WebhookSignatureError("Missing webhook timestamp header");
+    }
+    static invalidSignature() {
+        return new WebhookSignatureError("Invalid webhook signature");
+    }
+}
+exports.WebhookSignatureError = WebhookSignatureError;
+/**
+ * Computes the HMAC-SHA256 signature for a webhook payload.
+ * @param body - The request body.
+ * @param timestamp - The timestamp from the webhook request.
+ * @param secret - The webhook secret.
+ * @returns The computed signature as a Buffer.
+ */
+function computeSignature(body, timestamp, secret) {
+    const bodyBuffer = Buffer.isBuffer(body) ? body : Buffer.from(body);
+    // Compute signature: HMAC(body + "+" + timestamp, secret)
+    const signatureContent = Buffer.concat([bodyBuffer, Buffer.from(`+${timestamp}`)]);
+    const hmac = crypto.createHmac("sha256", secret);
+    hmac.update(signatureContent);
+    return hmac.digest();
+}
+/**
+ * Computes and hex-encodes the HMAC-SHA256 signature for a webhook payload.
+ * @param body - The request body.
+ * @param timestamp - The timestamp from the webhook request.
+ * @param secret - The webhook secret.
+ * @returns The computed signature as a hex-encoded string.
+ */
+function computeHexSignature(body, timestamp, secret) {
+    return computeSignature(body, timestamp, secret).toString("hex");
+}
+/**
+ * Verifies a webhook signature against the payload and timestamp.
+ * @param payload - The request body.
+ * @param signature - The signature from the webhook request.
+ * @param timestamp - The timestamp from the webhook request.
+ * @param secret - The webhook secret.
+ * @throws {WebhookSignatureError} If the signature is invalid or headers are missing.
+ */
+function verifySignature(payload, signature, timestamp, secret) {
+    if (!signature) {
+        throw WebhookSignatureError.missingSignature();
+    }
+    if (!timestamp) {
+        throw WebhookSignatureError.missingTimestamp();
+    }
+    // Decode signature
+    let decodedSignature;
+    try {
+        decodedSignature = Buffer.from(signature, "hex");
+    }
+    catch (err) {
+        throw new WebhookSignatureError(`Invalid signature format: ${(err === null || err === void 0 ? void 0 : err.message) || "Unknown error"}`);
+    }
+    // Compute expected signature
+    const expectedSignature = computeSignature(payload, timestamp, secret);
+    // Compare signatures using constant-time comparison
+    // First check lengths to avoid RangeError from timingSafeEqual
+    if (decodedSignature.length !== expectedSignature.length) {
+        throw WebhookSignatureError.invalidSignature();
+    }
+    if (!crypto.timingSafeEqual(decodedSignature, expectedSignature)) {
+        throw WebhookSignatureError.invalidSignature();
+    }
+}
+/**
+ * Verifies the signature of a webhook request.
+ * @param req - The request object.
+ * @param secret - The webhook secret.
+ * @param body - The raw request body. Required when using frameworks that parse the body beforehand.
+ * @param options - Optional configuration for header names.
+ * @throws {WebhookSignatureError} If the signature is invalid or headers are missing.
+ */
+function verifyWebhookSignature(req, secret, body, options = {}) {
+    // Get headers
+    const headers = req.headers;
+    const signatureHeaderName = options.signatureHeader || exports.WEBHOOK_SIGNATURE_HEADER;
+    const timestampHeaderName = options.timestampHeader || exports.WEBHOOK_TIMESTAMP_HEADER;
+    const signature = getHeader(headers, signatureHeaderName);
+    const timestamp = getHeader(headers, timestampHeaderName);
+    // Use provided body or check for rawBody on request
+    let payload;
+    if (body !== undefined) {
+        payload = body;
+    }
+    else if ("rawBody" in req && req.rawBody) {
+        payload = req.rawBody;
+    }
+    else {
+        throw new WebhookSignatureError("Request body is not available. Provide the body as a parameter or ensure req.rawBody exists.");
+    }
+    // Verify the signature
+    verifySignature(payload, signature, timestamp, secret);
+}
+/**
+ * Helper function to get a header value as a string.
+ */
+function getHeader(headers, headerName) {
+    const headerValue = headers[headerName] || headers[headerName.toLowerCase()];
+    if (Array.isArray(headerValue)) {
+        return headerValue[0] || "";
+    }
+    return headerValue || "";
+}