/
.pubnub.yml
816 lines (816 loc) · 21.4 KB
/
.pubnub.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
---
version: v7.1.1
changelog:
- date: 2023-03-07
version: v7.1.1
changes:
- type: bug
text: "Undeprecate Grant Token methods."
- type: bug
text: "Bump dependencies to avoid vulnerabilities."
- date: 2022-08-09
version: v7.1.0
changes:
- type: feature
text: "Add support for spaces and users permissions in GrantToken."
- type: feature
text: "Add new Get/SetUserId and NewConfigWithUserId factory method for Config. Deprecate UUID."
- date: 2022-05-04
version: v7.0.3
changes:
- type: bug
text: "Set default limit for object calls with context."
- type: bug
text: "All channel groups management operations could double escape some characters which could cause signature problems."
- date: 2022-03-17
version: v7.0.2
changes:
- type: bug
text: "Send region on subscribe calls."
- type: bug
text: "Close idle connections to free up goroutines when closing PubNub."
- date: 2022-02-08
version: v7.0.1
changes:
- type: bug
text: "Omit empty optional parameters for UUID or channel metadata."
- date: 2022-01-06
version: v7.0.0
changes:
- type: improvement
text: "BREAKING CHANGES: UUID is not automatically generated by the SDK anymore. Please set it in the PNConfig before instantiating the PubNub object. If UUID is empty panic will occur."
- date: 2021-12-16
version: v6.1.0
changes:
- type: feature
text: "Add revoke token feature."
- date: 2021-11-24
version: v6.0.2
changes:
- type: bug
text: "Fix edge case in Fetch response when filesPayload message is nil."
-
changes:
-
text: "Using correct major version number in imports."
type: bug
date: 2021-10-13
version: v6.0.1
-
changes:
-
text: "Add grantToken functionality (PAMv3). Method grantToken has been added. It allows generation of signed token with permissions for channels and channel groups."
type: feature
-
text: "Acceptance tests plugged into CI pipeline."
type: feature
date: 2021-10-12
version: v6.0.0
-
changes:
-
text: "Bump version."
type: bug
date: 2021-06-01
version: v5.0.3
-
changes:
-
text: "Go mod file fix."
type: bug
date: 2021-05-27
version: v5.0.2
-
changes:
-
text: "Update Go SDK Metadata."
type: feature
-
text: "BREAKING CHANGE - IV used for encryption is now random by default."
type: improvement
-
text: "BREAKING CHANGE - The SDK now suppoorts Go Modules."
type: improvement
-
text: "Presence event occupancy field parsed incorrectly."
type: bug
date: 2021-05-27
version: v5.0.0
-
changes:
-
text: "Objects v2 PAM changes."
type: feature
-
text: "Fetch with 100 messages."
type: improvement
-
text: "Include timetoken in send file."
type: improvement
-
text: "Read Publish File Message retry count from config."
type: bug
date: 2020-11-02
version: v4.10.0
-
changes:
-
text: "Fix for a deadlock on destroy."
type: bug
-
text: "Fetch response nil check."
type: bug
date: 2020-10-01
version: v4.9.1
-
changes:
-
text: "History v3 with UUID and MessageType."
type: feature
-
text: "BREAKING CHANGE: PNPublishMessage struct changes, PublishFile enhancements."
type: improvement
date: 2020-08-11
version: v4.9.0
-
changes:
-
text: "Files: Allows users to upload and share files."
type: feature
-
text: "BREAKING CHANGE: EncryptString and DecryptString functions now accept a third param - bool, if true the IV is random and is sent along with the message. Default is false."
type: improvement
-
text: "BREAKING CHANGE: runes to string converion now returns string, this mostly affect the validation responses. This makes the SDK compatible with Go 1.15"
type: bug
date: 2020-07-24
version: v4.8.0
-
changes:
-
text: "BREAKING CHANGE: Object V2 (beta). This version does not support Objects v1 (beta)"
type: feature
date: 2020-06-10
version: v4.7.0
-
changes:
-
text: "Objects Sorting"
type: improvement
-
text: "Go 1.14+ crypto unit tests fixes"
type: improvement
date: 2020-03-26
version: v4.6.5
-
changes:
-
text: "Make publish/grant workers per instance"
type: bug
date: 2020-02-05
version: v4.6.4
-
changes:
-
text: "Fix data race"
type: bug
date: 2020-01-28
version: v4.6.3
-
changes:
-
text: "Make publish key optional on subscribe"
type: bug
date: 2020-01-24
version: v4.6.2
-
changes:
-
text: "Objects Filtering"
type: improvement
date: 2020-01-03
version: v4.6.1
-
changes:
-
text: "APNS2"
type: improvement
-
text: "Push payload helper class"
type: improvement
date: 2019-12-17
version: v4.6.0
-
changes:
-
text: "Heartbeat Manager and Listener Manager deadlock fixes"
type: bug
-
text: "Fixed a panic due to a closed channel when `Publish` requests context is cancelled and `Destroy` is called"
type: bug
date: 2019-11-27
version: v4.5.2
-
changes:
-
text: "UUID in Message Actions response"
type: improvement
date: 2019-10-16
version: v4.5.1
-
changes:
-
text: "WithMeta param is now IncludeMeta in History and Fetch"
type: improvement
-
text: "WithMessageActions param is now IncludeMessageActions in Fetch"
type: improvement
date: 2019-10-08
version: v4.5.0
-
changes:
-
text: "Message Actions"
type: improvement
-
text: "Grant Token validation for TTL"
type: improvement
-
text: "withMeta param in History and Fetch"
type: improvement
date: 2019-10-07
version: v4.4.0
-
changes:
-
text: "Publish method now sets the ShouldStore flag if it is set to false"
type: bug
date: 2019-10-02
version: v4.3.1
-
changes:
-
text: "PAM v3 and TMS for Objects"
type: improvement
-
text: "UUID improvements"
type: improvement
date: 2019-09-23
version: v4.3.0
-
changes:
-
text: "Objects API"
type: improvement
-
text: "Grant Optimizations"
type: improvement
date: 2019-08-28
version: v4.2.7
-
changes:
-
text: "Signals"
type: improvement
date: 2019-08-08
version: v4.2.6
-
changes:
-
text: "UUID param in Set and Get State"
type: improvement
date: 2019-08-01
version: v4.2.5
-
changes:
-
text: "Destroy now cleans up all goroutines opened by the SDK"
type: bug
date: 2019-06-20
version: v4.2.4
-
changes:
-
text: "Fix deadlock on destroy"
type: bug
-
text: "UUID dependency update"
type: improvement
date: 2019-06-13
version: v4.2.3
-
changes:
-
text: "Presence Timeout cannot be lower than 20"
type: improvement
date: 2019-05-27
version: v4.2.2
-
changes:
-
text: "History timetoken float64 to int64 conversion loss fix"
type: bug
date: 2019-03-21
version: v4.2.1
-
changes:
-
text: "Message Counts simplification (Breaking changes from the previous version)."
type: improvement
date: 2019-03-13
version: v4.2.0
-
changes:
-
text: "Implement history Message Counts"
type: improvement
-
text: "All request were secure (https), even when the Secure flag was false"
type: bug
date: 2019-03-05
version: v4.1.7
-
changes:
-
text: "Fixes for 32bit and armv7 systems"
type: improvement
-
text: "QueryParam and State in Presence Heartbeat"
type: improvement
date: 2019-01-15
version: v4.1.6
-
changes:
-
text: "Presence Heartbeat call delays itself when a Subscribe call precedes it"
type: improvement
-
text: "Heartbeats per channel"
type: feature
date: 2018-12-18
version: v4.1.5
-
changes:
-
text: "QueryParams in all API calls"
type: feature
-
text: "d in grant"
type: feature
-
text: "maxIdleConnsPerHost setting in config"
type: feature
-
text: "Max concurrent workers for Publish and Grant requests"
type: improvement
date: 2018-10-18
version: v4.1.4
-
changes:
-
text: "Multiple auth keys in grant fix"
type: bug
-
text: "Presence timetoken float64 fix"
type: bug
date: 2018-09-04
version: v4.1.3
-
changes:
-
text: "Optimizations"
type: improvement
-
text: "presence timetoken fix"
type: bug
-
text: "coverage improvements"
type: improvement
date: 2018-08-01
version: v4.1.2
-
changes:
-
text: "MessageQueueOverflowCount and PNRequestMessageCountExceededCategory"
type: improvement
-
text: "subscribeMessageWorker optimization"
type: improvement
-
text: "integration tests optimizations"
type: improvement
date: 2018-06-21
version: v4.1.1
-
changes:
-
text: "Some breaking changes from the previous v4's"
type: improvement
-
text: "config field UseHttp2 is now UseHTTP2"
type: improvement
-
text: "config field Uuid is now UUID"
type: improvement
-
text: "Get State/ WhereNow Uuid is now UUID"
type: improvement
-
text: "In Fire/Publish Ttl() is now TTL()"
type: improvement
-
text: "In Grant Ttl() is now TTL()"
type: improvement
-
text: "PNPAMEntityData Ttl is now TTL"
type: improvement
-
text: "PNAccessManagerKeyData Ttl is now TTL"
type: improvement
-
text: "TlsEnabled is now TLSEnabled in StatusResponse and ResponseInfo"
type: improvement
-
text: "Uuid is now UUID in StatusResponse and ResponseInfo"
type: improvement
date: 2018-06-18
version: v4.1.0
-
changes:
-
text: "optimizations and deadlock fixes in subscribe loop"
type: bug
-
text: "old channels got subscribed in new sub after reconnection"
type: bug
-
text: "close old subworker goroutine before starting new one"
type: improvement
-
text: "data race fixes"
type: bug
-
text: "stop tickers, state manager locks"
type: bug
date: 2018-06-08
version: v4.0.0-rc.5
-
changes:
-
text: "stop heartbeat requests after unsubscribe all"
type: bug
-
text: "multiple subscribe fixes"
type: bug
-
text: "data race fixes in context"
type: bug
-
text: "fix for subscribe listener on disconnect"
type: bug
-
text: "heartbeat fixes"
type: bug
-
text: "presence heartbeat fixes"
type: bug
-
text: "subscribe to presence only channel"
type: bug
-
text: "unsubscribe from presence only channel"
type: bug
date: 2018-05-03
version: v4.0.0-rc.4
-
changes:
-
text: "Reconnection fixes"
type: bug
date: 2018-05-31
version: v4.0.0-rc.3
-
changes:
-
text: "auth fix"
type: bug
-
text: "Signature does not match fix when both secret key and auth is set"
type: bug
-
text: cleanup
type: improvement
-
text: "integration tests fixes for the changes done on auth"
type: improvement
date: 2018-05-24
version: v4.0.0-rc.2
-
changes:
-
text: "set state refactor fix"
type: bug
date: 2018-05-21
version: v4.0.0-rc.1
-
changes:
-
text: "Subscribe with state"
type: improvement
date: 2018-05-18
version: v4.0.0-beta.8
-
changes:
-
text: "cipher improvements"
type: improvement
date: 2018-04-12
version: v4.0.0-beta.7
-
changes:
-
text: "Fire, Fetch, HereNowRequest"
type: improvement
date: 2018-04-05
version: v4.0.0-beta.6
-
changes:
-
text: "add subscribe builder"
type: improvement
date: 2018-01-10
version: v4.0.0-beta.5
-
changes:
-
text: "add Telemetry Manager"
type: improvement
date: 2018-01-03
version: v4.0.0-beta.4
-
changes:
-
text: "add Destroy() method"
type: improvement
date: 2017-12-20
version: v4.0.0-beta.3
-
changes:
-
text: "add reconnection manager"
type: improvement
-
text: "rename list, remove, add, delete channel of channel groups"
type: improvement
-
text: "fix comma encoding"
type: bug
-
text: "fix signature"
type: bug
date: 2017-11-07
version: v4.0.0-beta.2
-
changes:
-
text: "initial beta"
type: improvement
date: 2017-10-04
version: v4.0.0-beta
features:
access:
- ACCESS-GRANT
- ACCESS-GRANT-MANAGE
- ACCESS-GRANT-DELETE
- ACCESS-SECRET-KEY-ALL-ACCESS
- ACCESS-GRANT-V3
- ACCESS-GRANT-TOKEN
- ACCESS-PARSE-TOKEN
- ACCESS-SET-TOKEN
- ACCESS-REVOKE-TOKEN
channel-groups:
- CHANNEL-GROUPS-ADD-CHANNELS
- CHANNEL-GROUPS-REMOVE-CHANNELS
- CHANNEL-GROUPS-REMOVE-GROUPS
- CHANNEL-GROUPS-LIST-CHANNELS-IN-GROUP
presence:
- PRESENCE-HERE-NOW
- PRESENCE-WHERE-NOW
- PRESENCE-GET-STATE
- PRESENCE-SET-STATE
- PRESENCE-HEARTBEAT
- PRESENCE-HEARTBEAT-ON-DEMAND
- PRESENCE-HEARTBEAT-THROTTLED
- PRESENCE-HERE-NOW-REFRESH
publish:
- PUBLISH-STORE-FLAG
- PUBLISH-RAW-JSON
- PUBLISH-WITH-METADATA
- PUBLISH-GET
- PUBLISH-POST
- PUBLISH-FIRE
- PUBLISH-REPLICATION-FLAG
- PUBLISH-MESSAGE-TTL
- PUBLISH-FILE-MESSAGE
push:
- PUSH-ADD-DEVICE-TO-CHANNELS
- PUSH-REMOVE-DEVICE-FROM-CHANNELS
- PUSH-LIST-CHANNELS-FROM-DEVICE
- PUSH-REMOVE-DEVICE
- PUSH-TYPE-APNS
- PUSH-TYPE-APNS2
- PUSH-TYPE-FCM
storage:
- STORAGE-REVERSE
- STORAGE-INCLUDE-TIMETOKEN
- STORAGE-START-END
- STORAGE-COUNT
- STORAGE-DELETE-MESSAGES
- STORAGE-FETCH-MESSAGES
- STORAGE-MESSAGE-COUNT
- STORAGE-HISTORY-WITH-META
- STORAGE-FETCH-WITH-META
- STORAGE-FETCH-WITH-MESSAGE-ACTIONS
- STORAGE-FETCH-WITH-FILE
- STORAGE-FETCH-WITH-INCLUDE-MESSAGE-TYPE
- STORAGE-FETCH-WITH-INCLUDE-UUID
subscribe:
- SUBSCRIBE-CHANNELS
- SUBSCRIBE-CHANNEL-GROUPS
- SUBSCRIBE-PRESENCE-CHANNELS
- SUBSCRIBE-PRESENCE-CHANNELS-GROUPS
- SUBSCRIBE-WITH-TIMETOKEN
- SUBSCRIBE-WILDCARD
- SUBSCRIBE-FILTER-EXPRESSION
- SUBSCRIBE-PUBLISHER-UUID
- SUBSCRIBE-WITH-USERSTATE
- SUBSCRIBE-PUBSUB-V2
- SUBSCRIBE-SIGNAL-LISTENER
- SUBSCRIBE-MEMBERSHIP-LISTENER
- SUBSCRIBE-SPACE-LISTENER
- SUBSCRIBE-USER-LISTENER
- SUBSCRIBE-MESSAGE-ACTIONS-LISTENER
- SUBSCRIBE-FILE-LISTENER
objects:
- OBJECTS-FILTERING
- OBJECTS-SORTING
- OBJECTS-GET-ALL-UUID-METADATA
- OBJECTS-GET-UUID-METADATA
- OBJECTS-SET-UUID-METADATA
- OBJECTS-REMOVE-UUID-METADATA
- OBJECTS-GET-ALL-CHANNEL-METADATA
- OBJECTS-GET-CHANNEL-METADATA
- OBJECTS-SET-CHANNEL-METADATA
- OBJECTS-REMOVE-CHANNEL-METADATA
- OBJECTS-GET-MEMBERSHIPS-V2
- OBJECTS-SET-MEMBERSHIPS-V2
- OBJECTS-REMOVE-MEMBERSHIPS-V2
- OBJECTS-GET-CHANNEL-MEMBERS-V2
- OBJECTS-SET-CHANNEL-MEMBERS-V2
- OBJECTS-REMOVE-CHANNEL-MEMBERS-V2
- OBJECTS-MANAGE-MEMBERSHIPS-V2
- OBJECTS-MANAGE-CHANNEL-MEMBERS-V2
files:
- FILES-SEND-FILE
- FILES-LIST-FILES
- FILES-GET-FILE-URL
- FILES-DELETE-FILE
- FILES-DOWNLOAD-FILE
message-actions:
- MESSAGE-ACTIONS-GET
- MESSAGE-ACTIONS-ADD
- MESSAGE-ACTIONS-REMOVE
time:
- TIME-TIME
unsubscribe:
- UNSUBSCRIBE-ALL
- UNSUBSCRIBE-SUPPRESS-LEAVE-EVENTS
others:
- PN-OTHER-PROCESSING
- TELEMETRY
- QUERY-PARAM
- CREATE-PUSH-PAYLOAD
- RANDOM-INITIALIZATION-VECTOR
notify:
- REQUEST-MESSAGE-COUNT-EXCEEDED
signal:
- SIGNAL-SEND
name: go
schema: 1
scm: github.com/pubnub/go
supported-platforms:
-
editors:
- "1.14.6"
- "1.15.12"
- "1.16.4"
platforms:
- "FreeBSD 8-STABLE or later, amd64, 386"
- "Linux 2.6 or later, amd64, 386."
- "Mac OS X 10.8 or later, amd64"
- "Windows 7 or later, amd64, 386"
version: "PubNub Go SDK"
sdks:
-
full-name: PubNub Go SDK
short-name: Go
artifacts:
-
artifact-type: api-client
language: go
tier: 1
tags:
- Server
source-repository: https://github.com/pubnub/go
documentation: https://www.pubnub.com/docs/sdks/go
distributions:
-
distribution-type: package
distribution-repository: GitHub
package-name: Go
location: https://github.com/pubnub/go/releases/tag/v7.1.1
requires:
-
name: "Go"
min-version: "1.14.6"
max-version: "1.16.4"
license: "https://golang.org/doc/tos"
license-url: "https://golang.org/doc/tos"
location: "Should be installed on the computer"
is-required: "Required"
-
name: "github.com/brianolson/cbor_go"
min-version: "1.0.0"
license: "Apache License 2.0"
license-url: "https://github.com/brianolson/cbor_go/blob/master/LICENSE"
location: "Shipped within package"
is-required: "Required"
-
name: "github.com/davecgh/go-spew"
min-version: "1.1.1"
license: "ISC"
license-url: "https://github.com/davecgh/go-spew/blob/master/LICENSE"
location: "Transitive dependency"
is-required: "Required"
-
name: "github.com/google/uuid"
min-version: "1.1.1"
license: "BSD3"
license-url: "https://github.com/google/uuid/blob/master/LICENSE"
location: "Shipped within package"
is-required: "Required"
-
name: "github.com/pmezard/go-difflib"
min-version: "1.0.0"
license: "BSD3"
license-url: "https://github.com/pmezard/go-difflib/blob/master/LICENSE"
location: "Transitive dependency"
is-required: "Required"
-
name: "github.com/stretchr/testify"
min-version: "1.2.2"
license: "MIT"
license-url: "https://github.com/stretchr/testify/blob/master/LICENSE"
location: "Shipped within package"
is-required: "Required"
-
name: "golang.org/x/net"
min-version: "HEAD"
license: "BSD3"
license-url: "https://pkg.go.dev/golang.org/x/net?tab=licenses"
location: "Shipped within package"
is-required: "Required"
-
name: "golang.org/x/text"
min-version: "0.3.2"
license: "BSD3"
license-url: "https://pkg.go.dev/golang.org/x/text?tab=licenses"
location: "Transitive dependency"
is-required: "Required"
supported-platforms:
supported-operating-systems:
Windows:
target-architecture:
- i386
- amd64
minimum-os-version:
- Windows 7 Professional
- Windows 7 Enterprise
- Windows 7 Ultimate
maximum-os-version:
- Windows 10 Enterprise
Linux:
target-architecture:
- i386
- amd64
maximum-os-version:
- Ubuntu 20.04 LTS
minimum-os-version:
- Ubuntu 12.04
macOS:
target-architecture:
- x86-64
minimum-os-version:
- Mac OS X 10.8
maximum-os-version:
- macOS 11.3.1