@uptime.app/contracts 1.0.15-rc.0 → 1.0.15-rc.1

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.
Files changed (46) hide show
  1. package/dist/cjs/collection/collection-events.d.ts +18 -0
  2. package/dist/cjs/collection/collection-events.d.ts.map +1 -0
  3. package/dist/cjs/collection/collection-events.js +3 -0
  4. package/dist/cjs/collection/collection-events.js.map +1 -0
  5. package/dist/cjs/collection/collection.d.ts +48 -0
  6. package/dist/cjs/collection/collection.d.ts.map +1 -0
  7. package/dist/cjs/collection/collection.js +3 -0
  8. package/dist/cjs/collection/collection.js.map +1 -0
  9. package/dist/cjs/collection/enriched-collection-events.d.ts +18 -0
  10. package/dist/cjs/collection/enriched-collection-events.d.ts.map +1 -0
  11. package/dist/cjs/collection/enriched-collection-events.js +3 -0
  12. package/dist/cjs/collection/enriched-collection-events.js.map +1 -0
  13. package/dist/cjs/collection/enriched-collection.d.ts +56 -0
  14. package/dist/cjs/collection/enriched-collection.d.ts.map +1 -0
  15. package/dist/cjs/collection/enriched-collection.js +3 -0
  16. package/dist/cjs/collection/enriched-collection.js.map +1 -0
  17. package/dist/cjs/index.d.ts +4 -0
  18. package/dist/cjs/index.d.ts.map +1 -1
  19. package/dist/cjs/index.js +4 -0
  20. package/dist/cjs/index.js.map +1 -1
  21. package/dist/esm/collection/collection-events.d.ts +18 -0
  22. package/dist/esm/collection/collection-events.d.ts.map +1 -0
  23. package/dist/esm/collection/collection-events.js +2 -0
  24. package/dist/esm/collection/collection-events.js.map +1 -0
  25. package/dist/esm/collection/collection.d.ts +48 -0
  26. package/dist/esm/collection/collection.d.ts.map +1 -0
  27. package/dist/esm/collection/collection.js +2 -0
  28. package/dist/esm/collection/collection.js.map +1 -0
  29. package/dist/esm/collection/enriched-collection-events.d.ts +18 -0
  30. package/dist/esm/collection/enriched-collection-events.d.ts.map +1 -0
  31. package/dist/esm/collection/enriched-collection-events.js +2 -0
  32. package/dist/esm/collection/enriched-collection-events.js.map +1 -0
  33. package/dist/esm/collection/enriched-collection.d.ts +56 -0
  34. package/dist/esm/collection/enriched-collection.d.ts.map +1 -0
  35. package/dist/esm/collection/enriched-collection.js +2 -0
  36. package/dist/esm/collection/enriched-collection.js.map +1 -0
  37. package/dist/esm/index.d.ts +4 -0
  38. package/dist/esm/index.d.ts.map +1 -1
  39. package/dist/esm/index.js +4 -0
  40. package/dist/esm/index.js.map +1 -1
  41. package/package.json +2 -2
  42. package/src/collection/collection-events.ts +21 -0
  43. package/src/collection/collection.ts +58 -0
  44. package/src/collection/enriched-collection-events.ts +18 -0
  45. package/src/collection/enriched-collection.ts +64 -0
  46. package/src/index.ts +5 -0
@@ -0,0 +1,18 @@
1
+ import { Collection } from './collection';
2
+ export interface CollectionCreatedEvent {
3
+ id: string;
4
+ type: 'CollectionCreated';
5
+ payload: Collection;
6
+ }
7
+ export interface CollectionUpdatedEvent {
8
+ id: string;
9
+ type: 'CollectionUpdated';
10
+ payload: Collection;
11
+ }
12
+ export interface CollectionDeletedEvent {
13
+ id: string;
14
+ type: 'CollectionDeleted';
15
+ payload: Collection;
16
+ }
17
+ export type CollectionChangedEvent = CollectionCreatedEvent | CollectionUpdatedEvent | CollectionDeletedEvent;
18
+ //# sourceMappingURL=collection-events.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"collection-events.d.ts","sourceRoot":"","sources":["../../../src/collection/collection-events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,WAAW,sBAAsB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,UAAU,CAAC;CACvB;AAED,MAAM,WAAW,sBAAsB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,UAAU,CAAC;CACvB;AAED,MAAM,WAAW,sBAAsB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,UAAU,CAAC;CACvB;AAED,MAAM,MAAM,sBAAsB,GAAG,sBAAsB,GAAG,sBAAsB,GAAG,sBAAsB,CAAC"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=collection-events.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"collection-events.js","sourceRoot":"","sources":["../../../src/collection/collection-events.ts"],"names":[],"mappings":""}
@@ -0,0 +1,48 @@
1
+ export interface Collection {
2
+ id: string;
3
+ v: number;
4
+ createdAt: string;
5
+ updatedAt: string;
6
+ title: string;
7
+ /** added 21/02/2023 use @uptime.app/localisation-contracts SupportedLocale */
8
+ locale: string;
9
+ /** added 21/02/2023 */
10
+ baseLocaleCollectionId: string;
11
+ /** added May 2023. Only set on collections that are translations */
12
+ baseLocaleCollectionVersion?: number;
13
+ subtitle?: string;
14
+ iconUrl?: string;
15
+ coverUrl?: string;
16
+ backgroundColor?: string;
17
+ description: string;
18
+ isPublished: boolean;
19
+ visibility?: CollectionVisibility;
20
+ tags?: string[];
21
+ rank?: number;
22
+ notificationMessage?: string;
23
+ type: CollectionType;
24
+ backdrop?: BackdropMetadata;
25
+ /** Added on June 2022. Not all messages on the archive will have this property. */
26
+ collectionHacks: CollectionHack[];
27
+ owner?: string;
28
+ /**
29
+ * @deprecated you should use new 'collectionHacks' property
30
+ */
31
+ hackIds: string[];
32
+ }
33
+ export type CollectionType = 'collection' | 'backdrop';
34
+ export interface CollectionVisibility {
35
+ startDate: string;
36
+ endDate: string;
37
+ }
38
+ export interface CollectionHack {
39
+ hackId: string;
40
+ /**
41
+ * @maxLength 300
42
+ */
43
+ blurb?: string;
44
+ }
45
+ export interface BackdropMetadata {
46
+ backdropDate: string;
47
+ }
48
+ //# sourceMappingURL=collection.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../../src/collection/collection.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAElB,KAAK,EAAE,MAAM,CAAC;IACd,8EAA8E;IAC9E,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,oEAAoE;IACpE,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,oBAAoB,CAAC;IAClC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,IAAI,EAAE,cAAc,CAAC;IACrB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAE5B,mFAAmF;IACnF,eAAe,EAAE,cAAc,EAAE,CAAC;IAElC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,MAAM,cAAc,GAAG,YAAY,GAAG,UAAU,CAAC;AAEvD,MAAM,WAAW,oBAAoB;IAEjC,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAE7B,YAAY,EAAE,MAAM,CAAC;CACxB"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=collection.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"collection.js","sourceRoot":"","sources":["../../../src/collection/collection.ts"],"names":[],"mappings":""}
@@ -0,0 +1,18 @@
1
+ import { EnrichedCollection } from './enriched-collection';
2
+ export interface EnrichedCollectionCreatedEvent {
3
+ id: string;
4
+ type: 'EnrichedCollectionCreated';
5
+ payload: EnrichedCollection;
6
+ }
7
+ export interface EnrichedCollectionUpdatedEvent {
8
+ id: string;
9
+ type: 'EnrichedCollectionUpdated';
10
+ payload: EnrichedCollection;
11
+ }
12
+ export interface EnrichedCollectionDeletedEvent {
13
+ id: string;
14
+ type: 'EnrichedCollectionDeleted';
15
+ payload: EnrichedCollection;
16
+ }
17
+ export type EnrichedCollectionChangedEvent = EnrichedCollectionCreatedEvent | EnrichedCollectionUpdatedEvent | EnrichedCollectionDeletedEvent;
18
+ //# sourceMappingURL=enriched-collection-events.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enriched-collection-events.d.ts","sourceRoot":"","sources":["../../../src/collection/enriched-collection-events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE3D,MAAM,WAAW,8BAA8B;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AACD,MAAM,WAAW,8BAA8B;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AACD,MAAM,WAAW,8BAA8B;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AACD,MAAM,MAAM,8BAA8B,GAAG,8BAA8B,GAAG,8BAA8B,GAAG,8BAA8B,CAAC"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=enriched-collection-events.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enriched-collection-events.js","sourceRoot":"","sources":["../../../src/collection/enriched-collection-events.ts"],"names":[],"mappings":""}
@@ -0,0 +1,56 @@
1
+ import { AppHackMetadata } from '../app-hack/app-hack-metadata';
2
+ import { BackdropMetadata } from './collection';
3
+ export interface EnrichedCollection {
4
+ id: string;
5
+ v: number;
6
+ createdAt: string;
7
+ updatedAt: string;
8
+ locale: string;
9
+ language: string;
10
+ baseLocaleCollectionId: string;
11
+ title: string;
12
+ subtitle?: string;
13
+ coverUrl?: string;
14
+ iconUrl?: string;
15
+ backgroundColor?: string;
16
+ description: string;
17
+ tags: string[];
18
+ rank?: number;
19
+ acl: string[];
20
+ catalogues: string[];
21
+ isPublished: boolean;
22
+ owner?: string;
23
+ hacks: EnrichCollectionHack[];
24
+ backdrop?: BackdropMetadata;
25
+ isBackdrop: boolean;
26
+ profile: EnrichCollectionProfile;
27
+ notificationMessage?: string;
28
+ includeInEmailNotifications: boolean;
29
+ includeInPushNotifications: boolean;
30
+ includeInRecommendations: boolean;
31
+ includeInSearchResults: boolean;
32
+ includeInWebsite: boolean;
33
+ isHidden: boolean;
34
+ visibility?: Visibility;
35
+ }
36
+ export interface EnrichCollectionHack {
37
+ blurb?: string;
38
+ hack: AppHackMetadata;
39
+ }
40
+ export interface ExistingProfile {
41
+ id: string;
42
+ name: string;
43
+ avatarUrl: string;
44
+ handle: string;
45
+ }
46
+ export interface DeletedProfile {
47
+ deleted: boolean;
48
+ uptimeOwned: boolean;
49
+ avatarUrl: string;
50
+ }
51
+ export interface Visibility {
52
+ startDate: string;
53
+ endDate: string;
54
+ }
55
+ export type EnrichCollectionProfile = ExistingProfile | DeletedProfile;
56
+ //# sourceMappingURL=enriched-collection.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enriched-collection.d.ts","sourceRoot":"","sources":["../../../src/collection/enriched-collection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,MAAM,WAAW,kBAAkB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,oBAAoB,EAAE,CAAC;IAC9B,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,UAAU,EAAE,OAAO,CAAC;IACpB,OAAO,EAAE,uBAAuB,CAAC;IACjC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,2BAA2B,EAAE,OAAO,CAAC;IACrC,0BAA0B,EAAE,OAAO,CAAC;IACpC,wBAAwB,EAAE,OAAO,CAAC;IAClC,sBAAsB,EAAE,OAAO,CAAC;IAChC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,UAAU,CAAC;CAC3B;AAED,MAAM,WAAW,oBAAoB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,UAAU;IAEvB,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,MAAM,CAAC;CACnB;AAGD,MAAM,MAAM,uBAAuB,GAAG,eAAe,GAAG,cAAc,CAAC"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=enriched-collection.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enriched-collection.js","sourceRoot":"","sources":["../../../src/collection/enriched-collection.ts"],"names":[],"mappings":""}
@@ -9,6 +9,10 @@ export * from './b2b-organisation/b2b-organisation-member';
9
9
  export * from './b2b-organisation/b2b-organisation-member-events';
10
10
  export * from './brand/brand';
11
11
  export * from './brand/brand-events';
12
+ export * from './collection/collection';
13
+ export * from './collection/collection-events';
14
+ export * from './collection/enriched-collection';
15
+ export * from './collection/enriched-collection-events';
12
16
  export * from './distribution/distribution-events';
13
17
  export * from './distribution/hack-distribution';
14
18
  export * from './distribution/collection-distribution';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAE/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mDAAmD,CAAC;AAElE,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAE/C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,sDAAsD,CAAC;AAErE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,aAAa,CAAC;AAC5B,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAE9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AACnD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+CAA+C,CAAC;AAE9D,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AAEzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAElC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AAEnC,cAAc,yCAAyC,CAAC;AACxD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAE/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mDAAmD,CAAC;AAElE,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,yCAAyC,CAAC;AAExD,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAE/C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,sDAAsD,CAAC;AAErE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,aAAa,CAAC;AAC5B,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAE9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AACnD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+CAA+C,CAAC;AAE9D,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AAEzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAElC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AAEnC,cAAc,yCAAyC,CAAC;AACxD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC"}
package/dist/cjs/index.js CHANGED
@@ -25,6 +25,10 @@ __exportStar(require("./b2b-organisation/b2b-organisation-member"), exports);
25
25
  __exportStar(require("./b2b-organisation/b2b-organisation-member-events"), exports);
26
26
  __exportStar(require("./brand/brand"), exports);
27
27
  __exportStar(require("./brand/brand-events"), exports);
28
+ __exportStar(require("./collection/collection"), exports);
29
+ __exportStar(require("./collection/collection-events"), exports);
30
+ __exportStar(require("./collection/enriched-collection"), exports);
31
+ __exportStar(require("./collection/enriched-collection-events"), exports);
28
32
  __exportStar(require("./distribution/distribution-events"), exports);
29
33
  __exportStar(require("./distribution/hack-distribution"), exports);
30
34
  __exportStar(require("./distribution/collection-distribution"), exports);
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6EAA2D;AAC3D,uEAAqD;AAErD,2DAAyC;AACzC,+DAA6C;AAC7C,iEAA+C;AAE/C,sEAAoD;AACpD,6EAA2D;AAE3D,6EAA2D;AAC3D,oFAAkE;AAElE,gDAA8B;AAC9B,uDAAqC;AAErC,qEAAmD;AACnD,mEAAiD;AACjD,yEAAuD;AAEvD,0DAAwC;AACxC,iEAA+C;AAE/C,gFAA8D;AAC9D,uFAAqE;AAErE,gEAA8C;AAC9C,uEAAqD;AAErD,2DAAyC;AACzC,8CAA4B;AAC5B,yDAAuC;AACvC,qDAAmC;AACnC,gEAA8C;AAE9C,gEAA8C;AAC9C,uEAAqD;AAErD,sEAAoD;AACpD,6EAA2D;AAE3D,8DAA4C;AAC5C,iEAA+C;AAC/C,qEAAmD;AACnD,mEAAiD;AAEjD,8DAA4C;AAC5C,qEAAmD;AACnD,yEAAuD;AACvD,gFAA8D;AAE9D,oDAAkC;AAClC,+DAA6C;AAC7C,2DAAyC;AAEzC,+DAA6C;AAC7C,6DAA2C;AAC3C,oDAAkC;AAElC,8CAA4B;AAC5B,qDAAmC;AAEnC,0EAAwD;AACxD,yEAAuD;AACvD,gEAA8C;AAE9C,gDAA8B;AAC9B,uDAAqC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6EAA2D;AAC3D,uEAAqD;AAErD,2DAAyC;AACzC,+DAA6C;AAC7C,iEAA+C;AAE/C,sEAAoD;AACpD,6EAA2D;AAE3D,6EAA2D;AAC3D,oFAAkE;AAElE,gDAA8B;AAC9B,uDAAqC;AAErC,0DAAwC;AACxC,iEAA+C;AAC/C,mEAAiD;AACjD,0EAAwD;AAExD,qEAAmD;AACnD,mEAAiD;AACjD,yEAAuD;AAEvD,0DAAwC;AACxC,iEAA+C;AAE/C,gFAA8D;AAC9D,uFAAqE;AAErE,gEAA8C;AAC9C,uEAAqD;AAErD,2DAAyC;AACzC,8CAA4B;AAC5B,yDAAuC;AACvC,qDAAmC;AACnC,gEAA8C;AAE9C,gEAA8C;AAC9C,uEAAqD;AAErD,sEAAoD;AACpD,6EAA2D;AAE3D,8DAA4C;AAC5C,iEAA+C;AAC/C,qEAAmD;AACnD,mEAAiD;AAEjD,8DAA4C;AAC5C,qEAAmD;AACnD,yEAAuD;AACvD,gFAA8D;AAE9D,oDAAkC;AAClC,+DAA6C;AAC7C,2DAAyC;AAEzC,+DAA6C;AAC7C,6DAA2C;AAC3C,oDAAkC;AAElC,8CAA4B;AAC5B,qDAAmC;AAEnC,0EAAwD;AACxD,yEAAuD;AACvD,gEAA8C;AAE9C,gDAA8B;AAC9B,uDAAqC"}
@@ -0,0 +1,18 @@
1
+ import { Collection } from './collection';
2
+ export interface CollectionCreatedEvent {
3
+ id: string;
4
+ type: 'CollectionCreated';
5
+ payload: Collection;
6
+ }
7
+ export interface CollectionUpdatedEvent {
8
+ id: string;
9
+ type: 'CollectionUpdated';
10
+ payload: Collection;
11
+ }
12
+ export interface CollectionDeletedEvent {
13
+ id: string;
14
+ type: 'CollectionDeleted';
15
+ payload: Collection;
16
+ }
17
+ export type CollectionChangedEvent = CollectionCreatedEvent | CollectionUpdatedEvent | CollectionDeletedEvent;
18
+ //# sourceMappingURL=collection-events.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"collection-events.d.ts","sourceRoot":"","sources":["../../../src/collection/collection-events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,MAAM,WAAW,sBAAsB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,UAAU,CAAC;CACvB;AAED,MAAM,WAAW,sBAAsB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,UAAU,CAAC;CACvB;AAED,MAAM,WAAW,sBAAsB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,UAAU,CAAC;CACvB;AAED,MAAM,MAAM,sBAAsB,GAAG,sBAAsB,GAAG,sBAAsB,GAAG,sBAAsB,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=collection-events.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"collection-events.js","sourceRoot":"","sources":["../../../src/collection/collection-events.ts"],"names":[],"mappings":""}
@@ -0,0 +1,48 @@
1
+ export interface Collection {
2
+ id: string;
3
+ v: number;
4
+ createdAt: string;
5
+ updatedAt: string;
6
+ title: string;
7
+ /** added 21/02/2023 use @uptime.app/localisation-contracts SupportedLocale */
8
+ locale: string;
9
+ /** added 21/02/2023 */
10
+ baseLocaleCollectionId: string;
11
+ /** added May 2023. Only set on collections that are translations */
12
+ baseLocaleCollectionVersion?: number;
13
+ subtitle?: string;
14
+ iconUrl?: string;
15
+ coverUrl?: string;
16
+ backgroundColor?: string;
17
+ description: string;
18
+ isPublished: boolean;
19
+ visibility?: CollectionVisibility;
20
+ tags?: string[];
21
+ rank?: number;
22
+ notificationMessage?: string;
23
+ type: CollectionType;
24
+ backdrop?: BackdropMetadata;
25
+ /** Added on June 2022. Not all messages on the archive will have this property. */
26
+ collectionHacks: CollectionHack[];
27
+ owner?: string;
28
+ /**
29
+ * @deprecated you should use new 'collectionHacks' property
30
+ */
31
+ hackIds: string[];
32
+ }
33
+ export type CollectionType = 'collection' | 'backdrop';
34
+ export interface CollectionVisibility {
35
+ startDate: string;
36
+ endDate: string;
37
+ }
38
+ export interface CollectionHack {
39
+ hackId: string;
40
+ /**
41
+ * @maxLength 300
42
+ */
43
+ blurb?: string;
44
+ }
45
+ export interface BackdropMetadata {
46
+ backdropDate: string;
47
+ }
48
+ //# sourceMappingURL=collection.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../../src/collection/collection.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAElB,KAAK,EAAE,MAAM,CAAC;IACd,8EAA8E;IAC9E,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,oEAAoE;IACpE,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,oBAAoB,CAAC;IAClC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,IAAI,EAAE,cAAc,CAAC;IACrB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAE5B,mFAAmF;IACnF,eAAe,EAAE,cAAc,EAAE,CAAC;IAElC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,MAAM,cAAc,GAAG,YAAY,GAAG,UAAU,CAAC;AAEvD,MAAM,WAAW,oBAAoB;IAEjC,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAE7B,YAAY,EAAE,MAAM,CAAC;CACxB"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=collection.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"collection.js","sourceRoot":"","sources":["../../../src/collection/collection.ts"],"names":[],"mappings":""}
@@ -0,0 +1,18 @@
1
+ import { EnrichedCollection } from './enriched-collection';
2
+ export interface EnrichedCollectionCreatedEvent {
3
+ id: string;
4
+ type: 'EnrichedCollectionCreated';
5
+ payload: EnrichedCollection;
6
+ }
7
+ export interface EnrichedCollectionUpdatedEvent {
8
+ id: string;
9
+ type: 'EnrichedCollectionUpdated';
10
+ payload: EnrichedCollection;
11
+ }
12
+ export interface EnrichedCollectionDeletedEvent {
13
+ id: string;
14
+ type: 'EnrichedCollectionDeleted';
15
+ payload: EnrichedCollection;
16
+ }
17
+ export type EnrichedCollectionChangedEvent = EnrichedCollectionCreatedEvent | EnrichedCollectionUpdatedEvent | EnrichedCollectionDeletedEvent;
18
+ //# sourceMappingURL=enriched-collection-events.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enriched-collection-events.d.ts","sourceRoot":"","sources":["../../../src/collection/enriched-collection-events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE3D,MAAM,WAAW,8BAA8B;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AACD,MAAM,WAAW,8BAA8B;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AACD,MAAM,WAAW,8BAA8B;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AACD,MAAM,MAAM,8BAA8B,GAAG,8BAA8B,GAAG,8BAA8B,GAAG,8BAA8B,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=enriched-collection-events.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enriched-collection-events.js","sourceRoot":"","sources":["../../../src/collection/enriched-collection-events.ts"],"names":[],"mappings":""}
@@ -0,0 +1,56 @@
1
+ import { AppHackMetadata } from '../app-hack/app-hack-metadata';
2
+ import { BackdropMetadata } from './collection';
3
+ export interface EnrichedCollection {
4
+ id: string;
5
+ v: number;
6
+ createdAt: string;
7
+ updatedAt: string;
8
+ locale: string;
9
+ language: string;
10
+ baseLocaleCollectionId: string;
11
+ title: string;
12
+ subtitle?: string;
13
+ coverUrl?: string;
14
+ iconUrl?: string;
15
+ backgroundColor?: string;
16
+ description: string;
17
+ tags: string[];
18
+ rank?: number;
19
+ acl: string[];
20
+ catalogues: string[];
21
+ isPublished: boolean;
22
+ owner?: string;
23
+ hacks: EnrichCollectionHack[];
24
+ backdrop?: BackdropMetadata;
25
+ isBackdrop: boolean;
26
+ profile: EnrichCollectionProfile;
27
+ notificationMessage?: string;
28
+ includeInEmailNotifications: boolean;
29
+ includeInPushNotifications: boolean;
30
+ includeInRecommendations: boolean;
31
+ includeInSearchResults: boolean;
32
+ includeInWebsite: boolean;
33
+ isHidden: boolean;
34
+ visibility?: Visibility;
35
+ }
36
+ export interface EnrichCollectionHack {
37
+ blurb?: string;
38
+ hack: AppHackMetadata;
39
+ }
40
+ export interface ExistingProfile {
41
+ id: string;
42
+ name: string;
43
+ avatarUrl: string;
44
+ handle: string;
45
+ }
46
+ export interface DeletedProfile {
47
+ deleted: boolean;
48
+ uptimeOwned: boolean;
49
+ avatarUrl: string;
50
+ }
51
+ export interface Visibility {
52
+ startDate: string;
53
+ endDate: string;
54
+ }
55
+ export type EnrichCollectionProfile = ExistingProfile | DeletedProfile;
56
+ //# sourceMappingURL=enriched-collection.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enriched-collection.d.ts","sourceRoot":"","sources":["../../../src/collection/enriched-collection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,MAAM,WAAW,kBAAkB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,oBAAoB,EAAE,CAAC;IAC9B,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,UAAU,EAAE,OAAO,CAAC;IACpB,OAAO,EAAE,uBAAuB,CAAC;IACjC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,2BAA2B,EAAE,OAAO,CAAC;IACrC,0BAA0B,EAAE,OAAO,CAAC;IACpC,wBAAwB,EAAE,OAAO,CAAC;IAClC,sBAAsB,EAAE,OAAO,CAAC;IAChC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,UAAU,CAAC;CAC3B;AAED,MAAM,WAAW,oBAAoB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,UAAU;IAEvB,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,MAAM,CAAC;CACnB;AAGD,MAAM,MAAM,uBAAuB,GAAG,eAAe,GAAG,cAAc,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=enriched-collection.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enriched-collection.js","sourceRoot":"","sources":["../../../src/collection/enriched-collection.ts"],"names":[],"mappings":""}
@@ -9,6 +9,10 @@ export * from './b2b-organisation/b2b-organisation-member';
9
9
  export * from './b2b-organisation/b2b-organisation-member-events';
10
10
  export * from './brand/brand';
11
11
  export * from './brand/brand-events';
12
+ export * from './collection/collection';
13
+ export * from './collection/collection-events';
14
+ export * from './collection/enriched-collection';
15
+ export * from './collection/enriched-collection-events';
12
16
  export * from './distribution/distribution-events';
13
17
  export * from './distribution/hack-distribution';
14
18
  export * from './distribution/collection-distribution';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAE/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mDAAmD,CAAC;AAElE,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAE/C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,sDAAsD,CAAC;AAErE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,aAAa,CAAC;AAC5B,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAE9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AACnD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+CAA+C,CAAC;AAE9D,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AAEzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAElC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AAEnC,cAAc,yCAAyC,CAAC;AACxD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAE/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mDAAmD,CAAC;AAElE,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,yCAAyC,CAAC;AAExD,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAE/C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,sDAAsD,CAAC;AAErE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,aAAa,CAAC;AAC5B,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAE9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AACnD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+CAA+C,CAAC;AAE9D,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AAEzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAElC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AAEnC,cAAc,yCAAyC,CAAC;AACxD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC"}
package/dist/esm/index.js CHANGED
@@ -9,6 +9,10 @@ export * from './b2b-organisation/b2b-organisation-member';
9
9
  export * from './b2b-organisation/b2b-organisation-member-events';
10
10
  export * from './brand/brand';
11
11
  export * from './brand/brand-events';
12
+ export * from './collection/collection';
13
+ export * from './collection/collection-events';
14
+ export * from './collection/enriched-collection';
15
+ export * from './collection/enriched-collection-events';
12
16
  export * from './distribution/distribution-events';
13
17
  export * from './distribution/hack-distribution';
14
18
  export * from './distribution/collection-distribution';
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAE/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mDAAmD,CAAC;AAElE,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAE/C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,sDAAsD,CAAC;AAErE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,aAAa,CAAC;AAC5B,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAE9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AACnD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+CAA+C,CAAC;AAE9D,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AAEzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAElC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AAEnC,cAAc,yCAAyC,CAAC;AACxD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAE/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mDAAmD,CAAC;AAElE,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,yCAAyC,CAAC;AAExD,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAE/C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,sDAAsD,CAAC;AAErE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,aAAa,CAAC;AAC5B,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAE9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AACnD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+CAA+C,CAAC;AAE9D,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AAEzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAElC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AAEnC,cAAc,yCAAyC,CAAC;AACxD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uptime.app/contracts",
3
- "version": "1.0.15-rc.0",
3
+ "version": "1.0.15-rc.1",
4
4
  "license": "MIT",
5
5
  "types": "./dist/esm/index.d.ts",
6
6
  "main": "./dist/cjs/index.js",
@@ -13,5 +13,5 @@
13
13
  "devDependencies": {
14
14
  "typescript": "^5.4.3"
15
15
  },
16
- "gitHead": "a3f1cab9d3e5e9886a73308c2946d97fbf9e42c3"
16
+ "gitHead": "f821669e13b59c3515db4dbf26f1516f8cc86d1a"
17
17
  }
@@ -0,0 +1,21 @@
1
+ import { Collection } from './collection';
2
+
3
+ export interface CollectionCreatedEvent {
4
+ id: string;
5
+ type: 'CollectionCreated';
6
+ payload: Collection;
7
+ }
8
+
9
+ export interface CollectionUpdatedEvent {
10
+ id: string;
11
+ type: 'CollectionUpdated';
12
+ payload: Collection;
13
+ }
14
+
15
+ export interface CollectionDeletedEvent {
16
+ id: string;
17
+ type: 'CollectionDeleted';
18
+ payload: Collection;
19
+ }
20
+
21
+ export type CollectionChangedEvent = CollectionCreatedEvent | CollectionUpdatedEvent | CollectionDeletedEvent;
@@ -0,0 +1,58 @@
1
+ export interface Collection {
2
+ id: string;
3
+ v: number;
4
+ createdAt: string;
5
+ updatedAt: string;
6
+
7
+ title: string;
8
+ /** added 21/02/2023 use @uptime.app/localisation-contracts SupportedLocale */
9
+ locale: string;
10
+ /** added 21/02/2023 */
11
+ baseLocaleCollectionId: string;
12
+ /** added May 2023. Only set on collections that are translations */
13
+ baseLocaleCollectionVersion?: number;
14
+ subtitle?: string;
15
+ iconUrl?: string;
16
+ coverUrl?: string;
17
+ backgroundColor?: string;
18
+ description: string;
19
+ isPublished: boolean;
20
+ visibility?: CollectionVisibility;
21
+ tags?: string[];
22
+ rank?: number;
23
+ notificationMessage?: string;
24
+ type: CollectionType;
25
+ backdrop?: BackdropMetadata;
26
+
27
+ /** Added on June 2022. Not all messages on the archive will have this property. */
28
+ collectionHacks: CollectionHack[];
29
+ // concept we are exploring: https://d0.awsstatic.com/whitepapers/Multi_Tenant_SaaS_Storage_Strategies.pdf
30
+ owner?: string;
31
+
32
+ /**
33
+ * @deprecated you should use new 'collectionHacks' property
34
+ */
35
+ hackIds: string[];
36
+ }
37
+
38
+ export type CollectionType = 'collection' | 'backdrop';
39
+
40
+ export interface CollectionVisibility {
41
+ /* ISO date */
42
+ startDate: string;
43
+ /* ISO date */
44
+ endDate: string;
45
+ }
46
+
47
+ export interface CollectionHack {
48
+ hackId: string;
49
+ /**
50
+ * @maxLength 300
51
+ */
52
+ blurb?: string;
53
+ }
54
+
55
+ export interface BackdropMetadata {
56
+ /* e.g. "2022-02-09T10:00:00" */
57
+ backdropDate: string;
58
+ }
@@ -0,0 +1,18 @@
1
+ import { EnrichedCollection } from './enriched-collection';
2
+
3
+ export interface EnrichedCollectionCreatedEvent {
4
+ id: string;
5
+ type: 'EnrichedCollectionCreated';
6
+ payload: EnrichedCollection;
7
+ }
8
+ export interface EnrichedCollectionUpdatedEvent {
9
+ id: string;
10
+ type: 'EnrichedCollectionUpdated';
11
+ payload: EnrichedCollection;
12
+ }
13
+ export interface EnrichedCollectionDeletedEvent {
14
+ id: string;
15
+ type: 'EnrichedCollectionDeleted';
16
+ payload: EnrichedCollection;
17
+ }
18
+ export type EnrichedCollectionChangedEvent = EnrichedCollectionCreatedEvent | EnrichedCollectionUpdatedEvent | EnrichedCollectionDeletedEvent;
@@ -0,0 +1,64 @@
1
+ import { AppHackMetadata } from '../app-hack/app-hack-metadata';
2
+ import { BackdropMetadata } from './collection';
3
+
4
+ export interface EnrichedCollection {
5
+ id: string;
6
+ v: number;
7
+ createdAt: string;
8
+ updatedAt: string;
9
+ locale: string,
10
+ language: string;
11
+ baseLocaleCollectionId: string;
12
+ title: string;
13
+ subtitle?: string;
14
+ coverUrl?: string;
15
+ iconUrl?: string;
16
+ backgroundColor?: string;
17
+ description: string;
18
+ tags: string[];
19
+ rank?: number;
20
+ acl: string[];
21
+ catalogues: string[];
22
+ isPublished: boolean;
23
+ owner?: string;
24
+ hacks: EnrichCollectionHack[];
25
+ backdrop?: BackdropMetadata;
26
+ isBackdrop: boolean;
27
+ profile: EnrichCollectionProfile;
28
+ notificationMessage?: string;
29
+ includeInEmailNotifications: boolean;
30
+ includeInPushNotifications: boolean;
31
+ includeInRecommendations: boolean;
32
+ includeInSearchResults: boolean;
33
+ includeInWebsite: boolean;
34
+ isHidden: boolean;
35
+ visibility?: Visibility;
36
+ }
37
+
38
+ export interface EnrichCollectionHack {
39
+ blurb?: string;
40
+ hack: AppHackMetadata;
41
+ }
42
+
43
+ export interface ExistingProfile {
44
+ id: string;
45
+ name: string;
46
+ avatarUrl: string;
47
+ handle: string;
48
+ }
49
+
50
+ export interface DeletedProfile {
51
+ deleted: boolean;
52
+ uptimeOwned: boolean;
53
+ avatarUrl: string;
54
+ }
55
+
56
+ export interface Visibility {
57
+ /* ISO date */
58
+ startDate: string;
59
+ /* ISO date */
60
+ endDate: string;
61
+ }
62
+
63
+ // matches pattern found in the hack enrichment service where the EnrichedHackProfile may be an actual Profile or it may have been deleted
64
+ export type EnrichCollectionProfile = ExistingProfile | DeletedProfile;
package/src/index.ts CHANGED
@@ -14,6 +14,11 @@ export * from './b2b-organisation/b2b-organisation-member-events';
14
14
  export * from './brand/brand';
15
15
  export * from './brand/brand-events';
16
16
 
17
+ export * from './collection/collection';
18
+ export * from './collection/collection-events';
19
+ export * from './collection/enriched-collection';
20
+ export * from './collection/enriched-collection-events';
21
+
17
22
  export * from './distribution/distribution-events';
18
23
  export * from './distribution/hack-distribution';
19
24
  export * from './distribution/collection-distribution';