@pintahub/database-schemas 5.7.1 → 5.8.0

package/README.md

@@ -103,7 +103,7 @@ StoreEvent, LatestEvent, RecentView, SearchTerm, FavoriteItem, TrackPage, Market
 ShortUrl, ShortDomain, ShortLog, LogURL
 
 ### Jobs & Events
-ExportJob, TransferJob, WebhookEvent
+ExportJob, TransferJob, WebhookEvent, ShopifyAPIRequest
 
 ### Settings & Config
 StoreSetting, BlockedLocation, Publication, ShopifyObject

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pintahub/database-schemas",
-  "version": "5.7.1",
+  "version": "5.8.0",
   "description": "",
   "main": "index.js",
   "scripts": {

package/schemas/ShopifyAPIRequest.js

@@ -0,0 +1,79 @@
+const {Schema} = require('mongoose')
+
+/** Outbound Shopify GraphQL Admin API request log — paired with WebhookEvent (which captures inbound). TTL: 3 hours. */
+const ShopifyAPIRequest = new Schema({
+    /** @ref Store */
+    store: {
+        type: Schema.Types.ObjectId,
+        ref: 'Store',
+        index: true,
+        required: true,
+    },
+
+    /** Shopify API version, e.g. '2025-01' */
+    api_version: {
+        type: String,
+        trim: true,
+    },
+
+    /** GraphQL operation name */
+    graphql_operation_name: {
+        type: String,
+        trim: true,
+    },
+
+    /** HTTP response status code */
+    response_status: {
+        type: Number,
+        index: true,
+    },
+
+    /** Wall-clock request latency in milliseconds */
+    duration_ms: {
+        type: Number,
+    },
+
+    /** Rate-limit / throttle signals from Shopify GraphQL */
+    rate_limit: {
+        /** extensions.cost.actualQueryCost */
+        actual_cost: {type: Number},
+
+        /** extensions.cost.requestedQueryCost */
+        requested_cost: {type: Number},
+
+        /** extensions.cost.throttleStatus.currentlyAvailable */
+        throttle_available: {type: Number},
+
+        /** extensions.cost.throttleStatus.maximumAvailable */
+        throttle_max: {type: Number},
+    },
+
+    /**
+     * Request outcome:
+     * - success: non-error response (2xx, no GraphQL errors)
+     * - failed: network error, non-2xx, or GraphQL errors present
+     */
+    status: {
+        type: String,
+        enum: ['success', 'failed'],
+        default: 'success',
+        index: true,
+    },
+
+    /** Error message when status='failed' */
+    error_message: {
+        type: String,
+        trim: true,
+    },
+
+    /** TTL: auto-expires after 3 hours */
+    created_at: {
+        type: Date,
+        default: Date.now,
+        expires: 3_600 * 3,
+    },
+})
+
+ShopifyAPIRequest.index({store: 1, status: 1, created_at: -1})
+
+module.exports = ShopifyAPIRequest