@uptime.app/contracts 3.0.39 → 3.0.41

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 (11) hide show
  1. package/dist/cjs/brand/brand.d.ts +19 -0
  2. package/dist/cjs/brand/brand.d.ts.map +1 -1
  3. package/dist/cjs/learn-upon/learn-upon-commands.d.ts +1 -0
  4. package/dist/cjs/learn-upon/learn-upon-commands.d.ts.map +1 -1
  5. package/dist/esm/brand/brand.d.ts +19 -0
  6. package/dist/esm/brand/brand.d.ts.map +1 -1
  7. package/dist/esm/learn-upon/learn-upon-commands.d.ts +1 -0
  8. package/dist/esm/learn-upon/learn-upon-commands.d.ts.map +1 -1
  9. package/package.json +2 -2
  10. package/src/brand/brand.ts +34 -0
  11. package/src/learn-upon/learn-upon-commands.ts +1 -0
package/dist/cjs/brand/brand.d.ts CHANGED
@@ -21,7 +21,26 @@ export interface Brand {
21
21
  };
22
22
  /** added Jan 2026 and backfilled */
23
23
  defaultTab: 'discover' | 'custom';
24
+ /** added Feb 2026. Max 5 links. */
25
+ links?: BrandLink[];
24
26
  }
27
+ export interface BrandLink {
28
+ imageUrl?: string;
29
+ title: {
30
+ [K in SupportedLocale]?: string;
31
+ };
32
+ description: {
33
+ [K in SupportedLocale]?: string;
34
+ };
35
+ destination: BrandLinkDestination;
36
+ cta: BrandLinkCta;
37
+ }
38
+ export type BrandLinkCta = 'view' | 'open' | 'launch' | 'get-started' | 'start-now' | 'gain-access' | 'learn-more' | 'find-out-more' | 'watch-video' | 'read' | 'explore-here' | 'get-support';
39
+ export type BrandLinkDestination = {
40
+ type: 'external' | 'internal' | 'hack' | 'collection' | 'course';
41
+ /** Can be a URL or an ID depending on the type */
42
+ target: string;
43
+ };
25
44
  export interface WelcomeHack {
26
45
  hackId: string;
27
46
  }
package/dist/cjs/brand/brand.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"brand.d.ts","sourceRoot":"","sources":["../../../src/brand/brand.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AAEpE,MAAM,WAAW,KAAK;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE;SACL,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAC;IACF,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,iBAAiB,CAAC,EAAE;SACf,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAC;IACF,kBAAkB,CAAC,EAAE;SAChB,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAC;IACF,oCAAoC;IACpC,UAAU,EAAE,UAAU,GAAG,QAAQ,CAAC;CACrC;AAGD,MAAM,WAAW,WAAW;IACxB,MAAM,EAAE,MAAM,CAAC;CAClB"}
1
+ {"version":3,"file":"brand.d.ts","sourceRoot":"","sources":["../../../src/brand/brand.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AAEpE,MAAM,WAAW,KAAK;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE;SACL,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAC;IACF,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,iBAAiB,CAAC,EAAE;SACf,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAC;IACF,kBAAkB,CAAC,EAAE;SAChB,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAC;IACF,oCAAoC;IACpC,UAAU,EAAE,UAAU,GAAG,QAAQ,CAAC;IAClC,mCAAmC;IACnC,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,SAAS;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE;SACF,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAC;IACF,WAAW,EAAE;SACR,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAC;IACF,WAAW,EAAE,oBAAoB,CAAC;IAClC,GAAG,EAAE,YAAY,CAAC;CACrB;AAED,MAAM,MAAM,YAAY,GAClB,MAAM,GACN,MAAM,GACN,QAAQ,GACR,aAAa,GACb,WAAW,GACX,aAAa,GACb,YAAY,GACZ,eAAe,GACf,aAAa,GACb,MAAM,GACN,cAAc,GACd,aAAa,CAAC;AAEpB,MAAM,MAAM,oBAAoB,GAAG;IAC/B,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,YAAY,GAAG,QAAQ,CAAC;IACjE,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAGF,MAAM,WAAW,WAAW;IACxB,MAAM,EAAE,MAAM,CAAC;CAClB"}
package/dist/cjs/learn-upon/learn-upon-commands.d.ts CHANGED
@@ -5,6 +5,7 @@ export interface SyncLearnUponUserCommandBody {
5
5
  userId: string;
6
6
  userType: 'learner' | 'instructor' | 'manager' | 'admin';
7
7
  uptimeLearnUponPortalId: string;
8
+ disabled?: boolean;
8
9
  organisationDisplayName?: string;
9
10
  brandAppName?: {
10
11
  [K in SupportedLocale]?: string;
package/dist/cjs/learn-upon/learn-upon-commands.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"learn-upon-commands.d.ts","sourceRoot":"","sources":["../../../src/learn-upon/learn-upon-commands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AAEpE,MAAM,WAAW,4BAA4B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,SAAS,GAAG,YAAY,GAAG,SAAS,GAAG,OAAO,CAAC;IACzD,uBAAuB,EAAE,MAAM,CAAC;IAChC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,YAAY,CAAC,EAAE;SACV,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAA;CACJ;AAED,MAAM,WAAW,wBAAwB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,4BAA4B,CAAC;CACzC;AAED,MAAM,WAAW,6BAA6B;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,oBAAoB,CAAC;IAC3B,OAAO,EAAE,6BAA6B,CAAC;CAC1C"}
1
+ {"version":3,"file":"learn-upon-commands.d.ts","sourceRoot":"","sources":["../../../src/learn-upon/learn-upon-commands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AAEpE,MAAM,WAAW,4BAA4B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,SAAS,GAAG,YAAY,GAAG,SAAS,GAAG,OAAO,CAAC;IACzD,uBAAuB,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,YAAY,CAAC,EAAE;SACV,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAA;CACJ;AAED,MAAM,WAAW,wBAAwB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,4BAA4B,CAAC;CACzC;AAED,MAAM,WAAW,6BAA6B;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,oBAAoB,CAAC;IAC3B,OAAO,EAAE,6BAA6B,CAAC;CAC1C"}
package/dist/esm/brand/brand.d.ts CHANGED
@@ -21,7 +21,26 @@ export interface Brand {
21
21
  };
22
22
  /** added Jan 2026 and backfilled */
23
23
  defaultTab: 'discover' | 'custom';
24
+ /** added Feb 2026. Max 5 links. */
25
+ links?: BrandLink[];
24
26
  }
27
+ export interface BrandLink {
28
+ imageUrl?: string;
29
+ title: {
30
+ [K in SupportedLocale]?: string;
31
+ };
32
+ description: {
33
+ [K in SupportedLocale]?: string;
34
+ };
35
+ destination: BrandLinkDestination;
36
+ cta: BrandLinkCta;
37
+ }
38
+ export type BrandLinkCta = 'view' | 'open' | 'launch' | 'get-started' | 'start-now' | 'gain-access' | 'learn-more' | 'find-out-more' | 'watch-video' | 'read' | 'explore-here' | 'get-support';
39
+ export type BrandLinkDestination = {
40
+ type: 'external' | 'internal' | 'hack' | 'collection' | 'course';
41
+ /** Can be a URL or an ID depending on the type */
42
+ target: string;
43
+ };
25
44
  export interface WelcomeHack {
26
45
  hackId: string;
27
46
  }
package/dist/esm/brand/brand.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"brand.d.ts","sourceRoot":"","sources":["../../../src/brand/brand.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AAEpE,MAAM,WAAW,KAAK;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE;SACL,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAC;IACF,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,iBAAiB,CAAC,EAAE;SACf,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAC;IACF,kBAAkB,CAAC,EAAE;SAChB,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAC;IACF,oCAAoC;IACpC,UAAU,EAAE,UAAU,GAAG,QAAQ,CAAC;CACrC;AAGD,MAAM,WAAW,WAAW;IACxB,MAAM,EAAE,MAAM,CAAC;CAClB"}
1
+ {"version":3,"file":"brand.d.ts","sourceRoot":"","sources":["../../../src/brand/brand.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AAEpE,MAAM,WAAW,KAAK;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE;SACL,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAC;IACF,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,iBAAiB,CAAC,EAAE;SACf,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAC;IACF,kBAAkB,CAAC,EAAE;SAChB,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAC;IACF,oCAAoC;IACpC,UAAU,EAAE,UAAU,GAAG,QAAQ,CAAC;IAClC,mCAAmC;IACnC,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,SAAS;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE;SACF,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAC;IACF,WAAW,EAAE;SACR,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAC;IACF,WAAW,EAAE,oBAAoB,CAAC;IAClC,GAAG,EAAE,YAAY,CAAC;CACrB;AAED,MAAM,MAAM,YAAY,GAClB,MAAM,GACN,MAAM,GACN,QAAQ,GACR,aAAa,GACb,WAAW,GACX,aAAa,GACb,YAAY,GACZ,eAAe,GACf,aAAa,GACb,MAAM,GACN,cAAc,GACd,aAAa,CAAC;AAEpB,MAAM,MAAM,oBAAoB,GAAG;IAC/B,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,YAAY,GAAG,QAAQ,CAAC;IACjE,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAGF,MAAM,WAAW,WAAW;IACxB,MAAM,EAAE,MAAM,CAAC;CAClB"}
package/dist/esm/learn-upon/learn-upon-commands.d.ts CHANGED
@@ -5,6 +5,7 @@ export interface SyncLearnUponUserCommandBody {
5
5
  userId: string;
6
6
  userType: 'learner' | 'instructor' | 'manager' | 'admin';
7
7
  uptimeLearnUponPortalId: string;
8
+ disabled?: boolean;
8
9
  organisationDisplayName?: string;
9
10
  brandAppName?: {
10
11
  [K in SupportedLocale]?: string;
package/dist/esm/learn-upon/learn-upon-commands.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"learn-upon-commands.d.ts","sourceRoot":"","sources":["../../../src/learn-upon/learn-upon-commands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AAEpE,MAAM,WAAW,4BAA4B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,SAAS,GAAG,YAAY,GAAG,SAAS,GAAG,OAAO,CAAC;IACzD,uBAAuB,EAAE,MAAM,CAAC;IAChC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,YAAY,CAAC,EAAE;SACV,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAA;CACJ;AAED,MAAM,WAAW,wBAAwB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,4BAA4B,CAAC;CACzC;AAED,MAAM,WAAW,6BAA6B;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,oBAAoB,CAAC;IAC3B,OAAO,EAAE,6BAA6B,CAAC;CAC1C"}
1
+ {"version":3,"file":"learn-upon-commands.d.ts","sourceRoot":"","sources":["../../../src/learn-upon/learn-upon-commands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AAEpE,MAAM,WAAW,4BAA4B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,SAAS,GAAG,YAAY,GAAG,SAAS,GAAG,OAAO,CAAC;IACzD,uBAAuB,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,YAAY,CAAC,EAAE;SACV,CAAC,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM;KAClC,CAAA;CACJ;AAED,MAAM,WAAW,wBAAwB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,4BAA4B,CAAC;CACzC;AAED,MAAM,WAAW,6BAA6B;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,oBAAoB,CAAC;IAC3B,OAAO,EAAE,6BAA6B,CAAC;CAC1C"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uptime.app/contracts",
3
- "version": "3.0.39",
3
+ "version": "3.0.41",
4
4
  "license": "MIT",
5
5
  "types": "./dist/esm/index.d.ts",
6
6
  "main": "./dist/cjs/index.js",
@@ -14,5 +14,5 @@
14
14
  "devDependencies": {
15
15
  "typescript": "^5.4.3"
16
16
  },
17
- "gitHead": "23d3d539714d8ab5b5d3bc2a77a868cfd1b82559"
17
+ "gitHead": "bf38510c4267f5a3a541b636039f271189fa7d97"
18
18
  }
package/src/brand/brand.ts CHANGED
@@ -22,8 +22,42 @@ export interface Brand {
22
22
  };
23
23
  /** added Jan 2026 and backfilled */
24
24
  defaultTab: 'discover' | 'custom';
25
+ /** added Feb 2026. Max 5 links. */
26
+ links?: BrandLink[];
25
27
  }
26
28
 
29
+ export interface BrandLink {
30
+ imageUrl?: string;
31
+ title: {
32
+ [K in SupportedLocale]?: string
33
+ };
34
+ description: {
35
+ [K in SupportedLocale]?: string
36
+ };
37
+ destination: BrandLinkDestination;
38
+ cta: BrandLinkCta;
39
+ }
40
+
41
+ export type BrandLinkCta =
42
+ | 'view'
43
+ | 'open'
44
+ | 'launch'
45
+ | 'get-started'
46
+ | 'start-now'
47
+ | 'gain-access'
48
+ | 'learn-more'
49
+ | 'find-out-more'
50
+ | 'watch-video'
51
+ | 'read'
52
+ | 'explore-here'
53
+ | 'get-support';
54
+
55
+ export type BrandLinkDestination = {
56
+ type: 'external' | 'internal' | 'hack' | 'collection' | 'course';
57
+ /** Can be a URL or an ID depending on the type */
58
+ target: string;
59
+ };
60
+
27
61
  // In case we need to add more properties to the BrandHack interface, we can do so here.
28
62
  export interface WelcomeHack {
29
63
  hackId: string;
package/src/learn-upon/learn-upon-commands.ts CHANGED
@@ -6,6 +6,7 @@ export interface SyncLearnUponUserCommandBody {
6
6
  userId: string;
7
7
  userType: 'learner' | 'instructor' | 'manager' | 'admin';
8
8
  uptimeLearnUponPortalId: string;
9
+ disabled?: boolean;
9
10
  organisationDisplayName?: string;
10
11
  brandAppName?: {
11
12
  [K in SupportedLocale]?: string