@walkeros/server-source-gcp 4.7.0-next-1790245733116 → 4.7.0

package/dist/walkerOS.json

@@ -1,7 +1,7 @@
 {
   "$meta": {
     "package": "@walkeros/server-source-gcp",
-    "version": "4.7.0-next-1790245733116",
+    "version": "4.7.0",
     "type": "source",
     "platform": [
       "server"
@@ -109,7 +109,7 @@
   },
   "examples": {
     "createTrigger": {
-      "$code": "async e=>{let t;return{get flow(){return t},trigger:()=>async o=>{if(!t){const o=await S(e);t={collector:o.collector,elb:o.elb}}const r=function(e){for(const t of Object.values(e.sources||{}))if(\"cloudfunction\"===t.type)return t}(t.collector);if(!r)throw new Error(\"CloudFunction source not found in collector — ensure it is configured in sources\");const s={...o.body};s.name&&!s.event&&(s.event=s.name,delete s.name);const i=o.headers||{\"content-type\":\"application/json\"},n={method:o.method,body:s,headers:i,get:e=>i[e.toLowerCase()]};let a,c=200;const l={status:e=>(c=e,l),json:e=>(a=e,l),send:e=>(a=e,l),set:()=>l};return await r.push(n,l),{status:c,body:a}}}}"
+      "$code": "async e=>{let t;return{get flow(){return t},trigger:()=>async o=>{if(!t){const o=await p(e);t={collector:o.collector,elb:o.elb}}const r=function(e){for(const t of Object.values(e.sources||{}))if(\"cloudfunction\"===t.type)return t}(t.collector);if(!r)throw new Error(\"CloudFunction source not found in collector — ensure it is configured in sources\");const s={...o.body};s.name&&!s.event&&(s.event=s.name,delete s.name);const i=o.headers||{\"content-type\":\"application/json\"},n={method:o.method,body:s,headers:i,get:e=>i[e.toLowerCase()]};let a,c=200;const l={status:e=>(c=e,l),json:e=>(a=e,l),send:e=>(a=e,l),set:()=>l};return await r.push(n,l),{status:c,body:a}}}}"
     },
     "env": {
       "push": {
@@ -142,7 +142,7 @@
             "$code": "()=>{}"
           },
           "scope": {
-            "$code": "()=>f"
+            "$code": "()=>n"
           }
         }
       }
@@ -255,5 +255,767 @@
         ]
       }
     }
+  },
+  "exportExamples": {
+    "sourceCloudFunction": {
+      "createTrigger": {
+        "$code": "async e=>{let t;return{get flow(){return t},trigger:()=>async o=>{if(!t){const o=await p(e);t={collector:o.collector,elb:o.elb}}const r=function(e){for(const t of Object.values(e.sources||{}))if(\"cloudfunction\"===t.type)return t}(t.collector);if(!r)throw new Error(\"CloudFunction source not found in collector — ensure it is configured in sources\");const s={...o.body};s.name&&!s.event&&(s.event=s.name,delete s.name);const i=o.headers||{\"content-type\":\"application/json\"},n={method:o.method,body:s,headers:i,get:e=>i[e.toLowerCase()]};let a,c=200;const l={status:e=>(c=e,l),json:e=>(a=e,l),send:e=>(a=e,l),set:()=>l};return await r.push(n,l),{status:c,body:a}}}}"
+      },
+      "env": {
+        "push": {
+          "push": {
+            "$code": "()=>Promise.resolve({ok:!0})"
+          },
+          "command": {
+            "$code": "()=>Promise.resolve({ok:!0})"
+          },
+          "elb": {
+            "$code": "()=>Promise.resolve({ok:!0})"
+          },
+          "logger": {
+            "error": {
+              "$code": "()=>{}"
+            },
+            "warn": {
+              "$code": "()=>{}"
+            },
+            "info": {
+              "$code": "()=>{}"
+            },
+            "debug": {
+              "$code": "()=>{}"
+            },
+            "throw": {
+              "$code": "e=>{throw\"string\"==typeof e?new Error(e):e}"
+            },
+            "json": {
+              "$code": "()=>{}"
+            },
+            "scope": {
+              "$code": "()=>n"
+            }
+          }
+        }
+      },
+      "step": {
+        "cloudFunctionPostForwardsSource": {
+          "title": "POST with provenance",
+          "description": "A POST body carrying a source map is forwarded in full, so release and trace provenance survive the crossing.",
+          "trigger": {
+            "type": "POST"
+          },
+          "in": {
+            "method": "POST",
+            "body": {
+              "name": "page view",
+              "data": {
+                "title": "Home"
+              },
+              "source": {
+                "release": {
+                  "web": "r1"
+                }
+              }
+            },
+            "headers": {
+              "content-type": "application/json"
+            }
+          },
+          "out": [
+            [
+              "elb",
+              {
+                "name": "page view",
+                "data": {
+                  "title": "Home"
+                },
+                "source": {
+                  "release": {
+                    "web": "r1"
+                  }
+                }
+              }
+            ]
+          ]
+        },
+        "orderEvent": {
+          "title": "Order POST",
+          "description": "A Cloud Function HTTP POST carrying an order payload becomes a walker order complete event.",
+          "trigger": {
+            "type": "POST"
+          },
+          "in": {
+            "method": "POST",
+            "body": {
+              "name": "order complete",
+              "data": {
+                "id": "ORD-700",
+                "total": 99.99,
+                "currency": "EUR"
+              }
+            },
+            "headers": {
+              "content-type": "application/json"
+            }
+          },
+          "out": [
+            [
+              "elb",
+              {
+                "name": "order complete",
+                "data": {
+                  "id": "ORD-700",
+                  "total": 99.99,
+                  "currency": "EUR"
+                }
+              }
+            ]
+          ]
+        },
+        "postEvent": {
+          "title": "POST event",
+          "description": "A GCP Cloud Function HTTP POST with a JSON body becomes a single walker elb event.",
+          "trigger": {
+            "type": "POST"
+          },
+          "in": {
+            "method": "POST",
+            "body": {
+              "name": "page view",
+              "data": {
+                "title": "Home",
+                "url": "https://example.com/"
+              }
+            },
+            "headers": {
+              "content-type": "application/json"
+            }
+          },
+          "out": [
+            [
+              "elb",
+              {
+                "name": "page view",
+                "data": {
+                  "title": "Home",
+                  "url": "https://example.com/"
+                }
+              }
+            ]
+          ]
+        }
+      }
+    },
+    "sourcePubSubPull": {
+      "createTrigger": {
+        "$code": "async e=>{let t;return{get flow(){return t},trigger:()=>async o=>{if(!t){const o=await C(e);t={collector:o.collector,elb:o.elb}}const r=function(e){for(const t of Object.values(e.sources??{}))if(A(t))return t}(t.collector);if(!r)throw new Error(\"pubsub-pull source not registered in collector — ensure it is configured in sources\");const s={id:o.id,data:Buffer.from(o.dataString,\"utf8\"),attributes:o.attributes,orderingKey:o.orderingKey},i=await r.push(s),n=[];return i&&\"object\"==typeof i&&(i.acked&&n.push([\"message.ack\",o.id]),i.nacked&&n.push([\"message.nack\",o.id])),n}}}"
+      },
+      "env": {
+        "moduleMockEnv": {
+          "push": {
+            "$code": "()=>Promise.resolve({ok:!0})"
+          },
+          "command": {
+            "$code": "()=>Promise.resolve({ok:!0})"
+          },
+          "elb": {
+            "$code": "()=>Promise.resolve({ok:!0})"
+          },
+          "logger": {
+            "error": {
+              "$code": "()=>{}"
+            },
+            "warn": {
+              "$code": "()=>{}"
+            },
+            "info": {
+              "$code": "()=>{}"
+            },
+            "debug": {
+              "$code": "()=>{}"
+            },
+            "throw": {
+              "$code": "e=>{throw\"string\"==typeof e?new Error(e):e}"
+            },
+            "json": {
+              "$code": "()=>{}"
+            },
+            "scope": {
+              "$code": "()=>h"
+            }
+          }
+        },
+        "push": {
+          "push": {
+            "$code": "()=>Promise.resolve({ok:!0})"
+          },
+          "command": {
+            "$code": "()=>Promise.resolve({ok:!0})"
+          },
+          "elb": {
+            "$code": "()=>Promise.resolve({ok:!0})"
+          },
+          "logger": {
+            "error": {
+              "$code": "()=>{}"
+            },
+            "warn": {
+              "$code": "()=>{}"
+            },
+            "info": {
+              "$code": "()=>{}"
+            },
+            "debug": {
+              "$code": "()=>{}"
+            },
+            "throw": {
+              "$code": "e=>{throw\"string\"==typeof e?new Error(e):e}"
+            },
+            "json": {
+              "$code": "()=>{}"
+            },
+            "scope": {
+              "$code": "()=>h"
+            }
+          },
+          "PubSub": {
+            "$code": "class{constructor(e){this.options=e}options;subscription(e,t){return new v(e,t)}async close(){}}"
+          }
+        },
+        "simulation": [
+          "call:PubSub.subscription"
+        ]
+      },
+      "step": {
+        "decoderText": {
+          "title": "Text decoder",
+          "description": "With decoder=text on the source settings, the message data is forwarded to the collector as a UTF-8 string and acked.",
+          "in": {
+            "id": "msg-3",
+            "dataString": "plain text payload",
+            "attributes": {}
+          },
+          "out": [
+            [
+              "message.ack",
+              "msg-3"
+            ]
+          ]
+        },
+        "malformedJson": {
+          "title": "Malformed JSON nack",
+          "description": "A non-JSON body with the default json decoder fails to decode; the message is nacked for redelivery.",
+          "in": {
+            "id": "msg-4",
+            "dataString": "not-json{",
+            "attributes": {}
+          },
+          "out": [
+            [
+              "message.nack",
+              "msg-4"
+            ]
+          ]
+        },
+        "malformedJsonAck": {
+          "title": "Malformed JSON ack-and-drop",
+          "description": "With onPushError=ack on the source settings, a malformed JSON message is acked-and-dropped instead of redelivered.",
+          "in": {
+            "id": "msg-5",
+            "dataString": "not-json{",
+            "attributes": {}
+          },
+          "out": [
+            [
+              "message.ack",
+              "msg-5"
+            ]
+          ]
+        },
+        "orderComplete": {
+          "title": "Order complete",
+          "description": "A JSON-encoded order event arrives and is acked after successful collector forwarding.",
+          "in": {
+            "id": "msg-2",
+            "dataString": "{\"name\":\"order complete\",\"data\":{\"id\":\"ORD-500\",\"total\":199.99,\"currency\":\"EUR\"}}",
+            "attributes": {
+              "entity": "order",
+              "action": "complete"
+            }
+          },
+          "out": [
+            [
+              "message.ack",
+              "msg-2"
+            ]
+          ]
+        },
+        "pageView": {
+          "title": "Page view",
+          "description": "A JSON-encoded page view event arrives on the subscription, decodes successfully, and is acked.",
+          "in": {
+            "id": "msg-1",
+            "dataString": "{\"name\":\"page view\",\"data\":{\"title\":\"Documentation\",\"url\":\"https://example.com/docs\"}}",
+            "attributes": {}
+          },
+          "out": [
+            [
+              "message.ack",
+              "msg-1"
+            ]
+          ]
+        }
+      }
+    },
+    "sourcePubSubPush": {
+      "createTrigger": {
+        "$code": "async e=>{let t;return{get flow(){return t},trigger:(o,r)=>async o=>{if(!t){const o=await K(e);t={collector:o.collector,elb:o.elb}}const s=(\"object\"==typeof r&&null!==r?r:{}).headers??{},i=function(e){for(const t of Object.values(e.sources??{}))if(V(t))return t}(t.collector);if(!i)throw new Error(\"pubsub-push source not registered\");const n={},a=function(e,t){return{method:\"POST\",body:e,headers:t,get:e=>t[e.toLowerCase()]??t[e]}}(o,s),c=function(e){const t={status:o=>(e.statusCode=o,t),json:o=>(e.body=o,t),send:o=>(e.body=o,t),set:()=>t};return t}(n);await i.push(a,c);return[[\"response\",n.statusCode??0,n.body??null]]}}}"
+      },
+      "env": {
+        "push": {
+          "push": {
+            "$code": "()=>Promise.resolve({ok:!0})"
+          },
+          "command": {
+            "$code": "()=>Promise.resolve({ok:!0})"
+          },
+          "elb": {
+            "$code": "()=>Promise.resolve({ok:!0})"
+          },
+          "logger": {
+            "error": {
+              "$code": "()=>{}"
+            },
+            "warn": {
+              "$code": "()=>{}"
+            },
+            "info": {
+              "$code": "()=>{}"
+            },
+            "debug": {
+              "$code": "()=>{}"
+            },
+            "throw": {
+              "$code": "e=>{throw\"string\"==typeof e?new Error(e):e}"
+            },
+            "json": {
+              "$code": "()=>{}"
+            },
+            "scope": {
+              "$code": "()=>I"
+            }
+          }
+        },
+        "simulation": []
+      },
+      "step": {
+        "malformedEnvelope": {
+          "title": "Malformed envelope",
+          "description": "A POST body lacking message.messageId returns 400 Bad Request without forwarding to the collector.",
+          "in": {
+            "not_a": "pubsub envelope"
+          },
+          "out": [
+            [
+              "response",
+              400,
+              {
+                "success": false,
+                "error": "Malformed Pub/Sub envelope (missing message.messageId)."
+              }
+            ]
+          ]
+        },
+        "orderEnvelope": {
+          "title": "Order envelope",
+          "description": "A push envelope carrying an order event is decoded and forwarded to the collector.",
+          "in": {
+            "message": {
+              "messageId": "push-2",
+              "data": "eyJuYW1lIjoib3JkZXIgY29tcGxldGUiLCJkYXRhIjp7ImlkIjoiT1JELTUwMCIsInRvdGFsIjoxOTkuOTksImN1cnJlbmN5IjoiRVVSIn19",
+              "attributes": {}
+            },
+            "subscription": "projects/test/subscriptions/events-sub"
+          },
+          "out": [
+            [
+              "response",
+              200,
+              {
+                "success": true,
+                "id": "push-2"
+              }
+            ]
+          ]
+        },
+        "validEnvelope": {
+          "title": "Valid push envelope",
+          "description": "A well-formed Pub/Sub push envelope decodes the base64 data, parses JSON, and forwards the event to the collector with a 200 response.",
+          "in": {
+            "message": {
+              "messageId": "push-1",
+              "data": "eyJuYW1lIjoicGFnZSB2aWV3IiwiZGF0YSI6eyJ0aXRsZSI6IkRvY3VtZW50YXRpb24iLCJ1cmwiOiJodHRwczovL2V4YW1wbGUuY29tL2RvY3MifX0=",
+              "attributes": {
+                "source": "analytics"
+              }
+            },
+            "subscription": "projects/test/subscriptions/events-sub"
+          },
+          "out": [
+            [
+              "response",
+              200,
+              {
+                "success": true,
+                "id": "push-1"
+              }
+            ]
+          ]
+        }
+      }
+    }
+  },
+  "exportSchemas": {
+    "sourceCloudFunction": {
+      "settings": {
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "type": "object",
+        "properties": {
+          "cors": {
+            "anyOf": [
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "origin": {
+                    "anyOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        }
+                      },
+                      {
+                        "type": "string",
+                        "const": "*"
+                      }
+                    ],
+                    "description": "Allowed origins (* for all, URL string, or array of URLs)"
+                  },
+                  "methods": {
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "enum": [
+                        "GET",
+                        "POST",
+                        "PUT",
+                        "PATCH",
+                        "DELETE",
+                        "OPTIONS",
+                        "HEAD"
+                      ]
+                    },
+                    "description": "Allowed HTTP methods"
+                  },
+                  "headers": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "description": "Allowed request headers"
+                  },
+                  "credentials": {
+                    "type": "boolean",
+                    "description": "Allow credentials (cookies, authorization headers)"
+                  },
+                  "maxAge": {
+                    "type": "integer",
+                    "exclusiveMinimum": 0,
+                    "maximum": 9007199254740991,
+                    "description": "Preflight cache duration in seconds"
+                  }
+                },
+                "additionalProperties": false
+              }
+            ],
+            "description": "CORS configuration: false = disabled, true = allow all origins, object = custom configuration"
+          },
+          "maxBatchSize": {
+            "default": 100,
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 9007199254740991,
+            "description": "Maximum number of events accepted in a single batch request"
+          },
+          "enablePixelTracking": {
+            "default": true,
+            "type": "boolean",
+            "description": "Serve a tracking pixel for GET requests"
+          },
+          "timeout": {
+            "type": "integer",
+            "exclusiveMinimum": 0,
+            "maximum": 540000,
+            "description": "Request timeout in milliseconds (max: 540000 for GCP)"
+          }
+        },
+        "required": [],
+        "additionalProperties": false
+      }
+    },
+    "sourcePubSubPull": {
+      "settings": {
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "type": "object",
+        "properties": {
+          "client": {
+            "description": "Pre-configured Google Cloud Pub/Sub client (like new PubSub({ projectId })). Bypasses credentials resolution when supplied."
+          },
+          "projectId": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Google Cloud Project ID (like my-gcp-project)."
+          },
+          "subscription": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Pub/Sub subscription short name (like events-sub). The full resource name projects/<projectId>/subscriptions/<subscription> is built by the SDK."
+          },
+          "topic": {
+            "type": "string",
+            "description": "Pub/Sub topic short name. Required when setup.createTopic is true; otherwise informational."
+          },
+          "credentials": {
+            "description": "Service account credentials as a JSON string or an object with client_email and private_key. Default: Application Default Credentials (ADC). (deprecated: use config.credentials)"
+          },
+          "apiEndpoint": {
+            "type": "string",
+            "description": "Override Pub/Sub API endpoint. Useful for the local emulator (like localhost:8085)."
+          },
+          "decoder": {
+            "type": "string",
+            "enum": [
+              "json",
+              "text",
+              "raw"
+            ],
+            "description": "Decoder for the message data field. json (default) parses JSON, text decodes UTF-8, raw forwards the Buffer."
+          },
+          "flowControl": {
+            "type": "object",
+            "properties": {
+              "maxMessages": {
+                "type": "number",
+                "description": "Maximum in-flight messages. Default: 100."
+              },
+              "maxBytes": {
+                "type": "number",
+                "description": "Maximum in-flight bytes. Default: 10485760 (10 MB)."
+              }
+            },
+            "additionalProperties": false,
+            "description": "Subscriber flow control. Tightens the SDK defaults.",
+            "title": "flowControl"
+          },
+          "ackDeadline": {
+            "type": "number",
+            "description": "Subscriber ack deadline in seconds. Default: 60."
+          },
+          "shutdownTimeoutMs": {
+            "type": "number",
+            "description": "Graceful shutdown timeout in milliseconds. Default: 30000. After this window, destroy() force-closes the subscriber."
+          },
+          "onPushError": {
+            "type": "string",
+            "enum": [
+              "nack",
+              "ack"
+            ],
+            "description": "Behavior when forwarding to the collector throws. nack (default) redelivers the message; ack drops it."
+          }
+        },
+        "required": [
+          "projectId",
+          "subscription"
+        ],
+        "additionalProperties": false
+      },
+      "setup": {
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "type": "object",
+        "properties": {
+          "createTopic": {
+            "type": "boolean",
+            "description": "Create the topic if it does not exist. Requires settings.topic. Default: false (require pre-existing topic)."
+          },
+          "ackDeadlineSeconds": {
+            "type": "number",
+            "description": "Subscription ack deadline in seconds. Default: 60."
+          },
+          "messageRetentionDuration": {
+            "type": "object",
+            "properties": {
+              "seconds": {
+                "type": "number",
+                "description": "Retention window in seconds. Default: project default."
+              }
+            },
+            "required": [
+              "seconds"
+            ],
+            "additionalProperties": false,
+            "description": "Subscription-level retention configuration.",
+            "title": "messageRetentionDuration"
+          },
+          "filter": {
+            "type": "string",
+            "description": "Subscription filter expression. Only messages matching this filter are delivered."
+          },
+          "deadLetterPolicy": {
+            "type": "object",
+            "properties": {
+              "deadLetterTopic": {
+                "type": "string",
+                "description": "Dead-letter topic short name."
+              },
+              "maxDeliveryAttempts": {
+                "type": "number",
+                "description": "Maximum delivery attempts before forwarding to the dead-letter topic."
+              },
+              "createDeadLetterTopic": {
+                "type": "boolean",
+                "description": "Auto-create the dead-letter topic if it does not exist. Default: false."
+              }
+            },
+            "required": [
+              "deadLetterTopic",
+              "maxDeliveryAttempts"
+            ],
+            "additionalProperties": false,
+            "description": "Dead-letter policy. Strongly recommended for production.",
+            "title": "deadLetterPolicy"
+          },
+          "retryPolicy": {
+            "type": "object",
+            "properties": {
+              "minimumBackoff": {
+                "type": "object",
+                "properties": {
+                  "seconds": {
+                    "type": "number",
+                    "description": "Minimum backoff in seconds."
+                  }
+                },
+                "required": [
+                  "seconds"
+                ],
+                "additionalProperties": false,
+                "title": "minimumBackoff"
+              },
+              "maximumBackoff": {
+                "type": "object",
+                "properties": {
+                  "seconds": {
+                    "type": "number",
+                    "description": "Maximum backoff in seconds."
+                  }
+                },
+                "required": [
+                  "seconds"
+                ],
+                "additionalProperties": false,
+                "title": "maximumBackoff"
+              }
+            },
+            "required": [
+              "minimumBackoff",
+              "maximumBackoff"
+            ],
+            "additionalProperties": false,
+            "description": "Subscription retry policy.",
+            "title": "retryPolicy"
+          },
+          "enableMessageOrdering": {
+            "type": "boolean",
+            "description": "Enable message ordering on the subscription. Default: false."
+          },
+          "labels": {
+            "type": "object",
+            "propertyNames": {
+              "type": "string"
+            },
+            "additionalProperties": {
+              "type": "string"
+            },
+            "description": "Subscription labels for organization and billing."
+          },
+          "expirationPolicy": {
+            "type": "object",
+            "properties": {
+              "ttl": {
+                "anyOf": [
+                  {
+                    "type": "object",
+                    "properties": {
+                      "seconds": {
+                        "type": "number",
+                        "description": "TTL in seconds. null means never expire."
+                      }
+                    },
+                    "required": [
+                      "seconds"
+                    ],
+                    "additionalProperties": false
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              }
+            },
+            "additionalProperties": false,
+            "description": "Subscription expiration policy.",
+            "title": "expirationPolicy"
+          }
+        },
+        "additionalProperties": false
+      }
+    },
+    "sourcePubSubPush": {
+      "settings": {
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "type": "object",
+        "properties": {
+          "projectId": {
+            "type": "string",
+            "description": "Google Cloud Project ID (informational, surfaced in error messages)."
+          },
+          "decoder": {
+            "type": "string",
+            "enum": [
+              "json",
+              "text",
+              "raw"
+            ],
+            "description": "Decoder for the message data field. json (default) parses JSON, text decodes UTF-8, raw forwards the Buffer."
+          },
+          "verifyOidc": {
+            "type": "boolean",
+            "description": "Verify the OIDC bearer token Pub/Sub attaches to push requests. Default: false."
+          },
+          "audience": {
+            "type": "string",
+            "description": "OIDC audience (your endpoint URL or a custom audience). Required when verifyOidc is true."
+          }
+        },
+        "additionalProperties": false
+      }
+    }
   }
 }