@alis-build/alis-open-pubsub-v1 1.14.0 → 1.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,20 @@
1
- // @generated by protoc-gen-es v2.13.0 with parameter "target=js+dts,import_extension=js,json_types=true"
1
+ // @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js,json_types=true"
2
2
  // @generated from file alis/open/pubsub/v1/pubsub.proto (package alis.open.pubsub.v1, syntax proto3)
3
3
  /* eslint-disable */
4
4
 
5
+ // The request body that a Pub/Sub push subscription delivers, so services can
6
+ // receive Pub/Sub events through an ordinary RPC.
7
+ //
8
+ // `PubSubMessage` models the push body: the published `Message` (data,
9
+ // attributes, message ID, publish time and ordering key) and the name of the
10
+ // subscription that delivered it. Event-handling RPCs take it as their
11
+ // request, for example `HandleEvent` and `HandleDeadLetter` on
12
+ // `alis.open.flows.v1.FlowsService`.
13
+ //
14
+ // Push deliveries carry the message ID and publish time under both camelCase
15
+ // and snake_case keys, so `Message` has the extra fields `message_id1` and
16
+ // `publish_time1` to hold the duplicates.
17
+
5
18
  import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
6
19
  import type { Message } from "@bufbuild/protobuf";
7
20
  import type { Timestamp, TimestampJson } from "@bufbuild/protobuf/wkt";
@@ -12,30 +25,56 @@ import type { Timestamp, TimestampJson } from "@bufbuild/protobuf/wkt";
12
25
  export declare const file_alis_open_pubsub_v1_pubsub: GenFile;
13
26
 
14
27
  /**
28
+ * PubSubMessage is the body/payload/data attribute from a Pub/Sub push HTTP request.
29
+ * As we are using Pub/Sub for many of our events, we declare this message in
30
+ * this shared package.
31
+ *
15
32
  * @generated from message alis.open.pubsub.v1.PubSubMessage
16
33
  */
17
34
  export declare type PubSubMessage = Message<"alis.open.pubsub.v1.PubSubMessage"> & {
18
35
  /**
36
+ * A message that is published by publishers and consumed by subscribers. The
37
+ * message must contain either a non-empty data field or at least one attribute.
38
+ * Note that client libraries represent this object differently
39
+ * depending on the language. See the corresponding [client library documentation](https://cloud.google.com/pubsub/docs/reference/libraries) for
40
+ * more information. See [quotas and limits](https://cloud.google.com/pubsub/quotas)
41
+ * for more information about message limits.
42
+ *
19
43
  * @generated from field: alis.open.pubsub.v1.PubSubMessage.Message message = 1;
20
44
  */
21
45
  message?: PubSubMessage_Message | undefined;
22
46
 
23
47
  /**
48
+ * Pub/Sub subscription resource name
49
+ *
24
50
  * @generated from field: string subscription = 2;
25
51
  */
26
52
  subscription: string;
27
53
  };
28
54
 
29
55
  /**
56
+ * PubSubMessage is the body/payload/data attribute from a Pub/Sub push HTTP request.
57
+ * As we are using Pub/Sub for many of our events, we declare this message in
58
+ * this shared package.
59
+ *
30
60
  * @generated from message alis.open.pubsub.v1.PubSubMessage
31
61
  */
32
62
  export declare type PubSubMessageJson = {
33
63
  /**
64
+ * A message that is published by publishers and consumed by subscribers. The
65
+ * message must contain either a non-empty data field or at least one attribute.
66
+ * Note that client libraries represent this object differently
67
+ * depending on the language. See the corresponding [client library documentation](https://cloud.google.com/pubsub/docs/reference/libraries) for
68
+ * more information. See [quotas and limits](https://cloud.google.com/pubsub/quotas)
69
+ * for more information about message limits.
70
+ *
34
71
  * @generated from field: alis.open.pubsub.v1.PubSubMessage.Message message = 1;
35
72
  */
36
73
  message?: PubSubMessage_MessageJson;
37
74
 
38
75
  /**
76
+ * Pub/Sub subscription resource name
77
+ *
39
78
  * @generated from field: string subscription = 2;
40
79
  */
41
80
  subscription?: string;
@@ -48,80 +87,142 @@ export declare type PubSubMessageJson = {
48
87
  export declare const PubSubMessageSchema: GenMessage<PubSubMessage, {jsonType: PubSubMessageJson}>;
49
88
 
50
89
  /**
90
+ * The Body of a Pub/Sub push subscription.
91
+ *
51
92
  * @generated from message alis.open.pubsub.v1.PubSubMessage.Message
52
93
  */
53
94
  export declare type PubSubMessage_Message = Message<"alis.open.pubsub.v1.PubSubMessage.Message"> & {
54
95
  /**
96
+ * The message data field. If this field is empty, the message must contain
97
+ * at least one attribute.
98
+ *
55
99
  * @generated from field: bytes data = 1;
56
100
  */
57
101
  data: Uint8Array;
58
102
 
59
103
  /**
104
+ * Attributes for this message. If this field is empty, the message must
105
+ * contain non-empty data. This can be used to filter messages on the
106
+ * subscription.
107
+ *
60
108
  * @generated from field: map<string, string> attributes = 2;
61
109
  */
62
110
  attributes: { [key: string]: string };
63
111
 
64
112
  /**
113
+ * ID of this message, assigned by the server when the message is published.
114
+ * Guaranteed to be unique within the topic. This value may be read by a
115
+ * subscriber that receives a `PubsubMessage` via a `Pull` call or a push
116
+ * delivery. It must not be populated by the publisher in a `Publish` call.
117
+ *
65
118
  * @generated from field: string message_id = 3;
66
119
  */
67
120
  messageId: string;
68
121
 
69
122
  /**
123
+ * The time at which the message was published, populated by the server when
124
+ * it receives the `Publish` call. It must not be populated by the
125
+ * publisher in a `Publish` call.
126
+ *
70
127
  * @generated from field: google.protobuf.Timestamp publish_time = 4;
71
128
  */
72
129
  publishTime?: Timestamp | undefined;
73
130
 
74
131
  /**
132
+ * If non-empty, identifies related messages for which publish order should be
133
+ * respected. If a `Subscription` has `enable_message_ordering` set to `true`,
134
+ * messages published with the same non-empty `ordering_key` value will be
135
+ * delivered to subscribers in the order in which they are received by the
136
+ * Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest`
137
+ * must specify the same `ordering_key` value.
138
+ *
75
139
  * @generated from field: string ordering_key = 5;
76
140
  */
77
141
  orderingKey: string;
78
142
 
79
143
  /**
144
+ * A temporary fix - pubsub push delivers both messageId and message_id
145
+ * attributes, which is seen as a duplicate in the proto world.
146
+ *
80
147
  * @generated from field: string message_id1 = 6;
81
148
  */
82
149
  messageId1: string;
83
150
 
84
151
  /**
152
+ * A temporary fix - pubsub push delivers both publishTime and publish_time
153
+ * attributes, which is seen as a duplicate in the proto world.
154
+ *
85
155
  * @generated from field: google.protobuf.Timestamp publish_time1 = 7;
86
156
  */
87
157
  publishTime1?: Timestamp | undefined;
88
158
  };
89
159
 
90
160
  /**
161
+ * The Body of a Pub/Sub push subscription.
162
+ *
91
163
  * @generated from message alis.open.pubsub.v1.PubSubMessage.Message
92
164
  */
93
165
  export declare type PubSubMessage_MessageJson = {
94
166
  /**
167
+ * The message data field. If this field is empty, the message must contain
168
+ * at least one attribute.
169
+ *
95
170
  * @generated from field: bytes data = 1;
96
171
  */
97
172
  data?: string;
98
173
 
99
174
  /**
175
+ * Attributes for this message. If this field is empty, the message must
176
+ * contain non-empty data. This can be used to filter messages on the
177
+ * subscription.
178
+ *
100
179
  * @generated from field: map<string, string> attributes = 2;
101
180
  */
102
181
  attributes?: { [key: string]: string };
103
182
 
104
183
  /**
184
+ * ID of this message, assigned by the server when the message is published.
185
+ * Guaranteed to be unique within the topic. This value may be read by a
186
+ * subscriber that receives a `PubsubMessage` via a `Pull` call or a push
187
+ * delivery. It must not be populated by the publisher in a `Publish` call.
188
+ *
105
189
  * @generated from field: string message_id = 3;
106
190
  */
107
191
  messageId?: string;
108
192
 
109
193
  /**
194
+ * The time at which the message was published, populated by the server when
195
+ * it receives the `Publish` call. It must not be populated by the
196
+ * publisher in a `Publish` call.
197
+ *
110
198
  * @generated from field: google.protobuf.Timestamp publish_time = 4;
111
199
  */
112
200
  publishTime?: TimestampJson;
113
201
 
114
202
  /**
203
+ * If non-empty, identifies related messages for which publish order should be
204
+ * respected. If a `Subscription` has `enable_message_ordering` set to `true`,
205
+ * messages published with the same non-empty `ordering_key` value will be
206
+ * delivered to subscribers in the order in which they are received by the
207
+ * Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest`
208
+ * must specify the same `ordering_key` value.
209
+ *
115
210
  * @generated from field: string ordering_key = 5;
116
211
  */
117
212
  orderingKey?: string;
118
213
 
119
214
  /**
215
+ * A temporary fix - pubsub push delivers both messageId and message_id
216
+ * attributes, which is seen as a duplicate in the proto world.
217
+ *
120
218
  * @generated from field: string message_id1 = 6;
121
219
  */
122
220
  messageId1?: string;
123
221
 
124
222
  /**
223
+ * A temporary fix - pubsub push delivers both publishTime and publish_time
224
+ * attributes, which is seen as a duplicate in the proto world.
225
+ *
125
226
  * @generated from field: google.protobuf.Timestamp publish_time1 = 7;
126
227
  */
127
228
  publishTime1?: TimestampJson;
@@ -1,7 +1,20 @@
1
- // @generated by protoc-gen-es v2.13.0 with parameter "target=js+dts,import_extension=js,json_types=true"
1
+ // @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js,json_types=true"
2
2
  // @generated from file alis/open/pubsub/v1/pubsub.proto (package alis.open.pubsub.v1, syntax proto3)
3
3
  /* eslint-disable */
4
4
 
5
+ // The request body that a Pub/Sub push subscription delivers, so services can
6
+ // receive Pub/Sub events through an ordinary RPC.
7
+ //
8
+ // `PubSubMessage` models the push body: the published `Message` (data,
9
+ // attributes, message ID, publish time and ordering key) and the name of the
10
+ // subscription that delivered it. Event-handling RPCs take it as their
11
+ // request, for example `HandleEvent` and `HandleDeadLetter` on
12
+ // `alis.open.flows.v1.FlowsService`.
13
+ //
14
+ // Push deliveries carry the message ID and publish time under both camelCase
15
+ // and snake_case keys, so `Message` has the extra fields `message_id1` and
16
+ // `publish_time1` to hold the duplicates.
17
+
5
18
  import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
6
19
  import { file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
7
20
 
package/package.json CHANGED
@@ -23,5 +23,5 @@
23
23
  },
24
24
  "type": "module",
25
25
  "types": "./index.d.ts",
26
- "version": "1.14.0"
26
+ "version": "1.15.0"
27
27
  }