@uptime.app/contracts 2.0.37 → 2.0.39-rc.0

package/dist/cjs/enriched-hack/enriched-hack.d.ts

@@ -60,6 +60,10 @@ export interface EnrichedHack {
      * An estimation of the time saved in minutes when no reliable information is available on the knowledge source.
      */
     estimatedTimeSaved?: number;
+    /**
+     * Tenant display name, from the display name of its b2b-organisation, if any
+     */
+    tenantDisplayName?: string;
 }
 export interface EnrichedHackNotifications {
     aiGeneratedText?: string;

package/dist/cjs/enriched-hack/enriched-hack.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"enriched-hack.d.ts","sourceRoot":"","sources":["../../../src/enriched-hack/enriched-hack.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACrH,OAAO,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEhH,MAAM,WAAW,YAAY;IACzB,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB,sGAAsG;IACtG,MAAM,EAAE,MAAM,CAAC;IACf,iDAAiD;IACjD,gBAAgB,EAAE,MAAM,CAAC;IACzB,CAAC,EAAE,MAAM,CAAC;IACV,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAElB,2BAA2B;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IAGzB,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wGAAwG;IACxG,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,aAAa,CAAC,EAAE,yBAAyB,CAAC;IAE1C,WAAW,EAAE,MAAM,CAAC;IAGpB,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACpC,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;IACjC,IAAI,EAAE,QAAQ,CAAC;IACf,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,OAAO,EAAE,iBAAiB,CAAC;IAE3B,uBAAuB;IAEvB,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAGhC,2BAA2B,EAAE,OAAO,CAAC;IACrC,0BAA0B,EAAE,OAAO,CAAC;IACpC,wBAAwB,EAAE,OAAO,CAAC;IAClC,sBAAsB,EAAE,OAAO,CAAC;IAChC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;;SAGK;IACL,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,yBAAyB;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,oBAAoB;IACjC,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC,YAAY,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,SAAS,CAAC,EAAE;QACR,KAAK,EAAE,eAAe,EAAE,CAAC;QACzB,MAAM,EAAE,aAAa,EAAE,CAAC;KAC3B,CAAC;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,WAAW,EAAE,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC"}
+{"version":3,"file":"enriched-hack.d.ts","sourceRoot":"","sources":["../../../src/enriched-hack/enriched-hack.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACrH,OAAO,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEhH,MAAM,WAAW,YAAY;IACzB,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB,sGAAsG;IACtG,MAAM,EAAE,MAAM,CAAC;IACf,iDAAiD;IACjD,gBAAgB,EAAE,MAAM,CAAC;IACzB,CAAC,EAAE,MAAM,CAAC;IACV,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAElB,2BAA2B;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IAGzB,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wGAAwG;IACxG,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,aAAa,CAAC,EAAE,yBAAyB,CAAC;IAE1C,WAAW,EAAE,MAAM,CAAC;IAGpB,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACpC,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;IACjC,IAAI,EAAE,QAAQ,CAAC;IACf,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,OAAO,EAAE,iBAAiB,CAAC;IAE3B,uBAAuB;IAEvB,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAGhC,2BAA2B,EAAE,OAAO,CAAC;IACrC,0BAA0B,EAAE,OAAO,CAAC;IACpC,wBAAwB,EAAE,OAAO,CAAC;IAClC,sBAAsB,EAAE,OAAO,CAAC;IAChC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;;SAGK;IACL,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,yBAAyB;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,oBAAoB;IACjC,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC,YAAY,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,SAAS,CAAC,EAAE;QACR,KAAK,EAAE,eAAe,EAAE,CAAC;QACzB,MAAM,EAAE,aAAa,EAAE,CAAC;KAC3B,CAAC;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,WAAW,EAAE,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/dist/cjs/user/get-user.d.ts

@@ -25,9 +25,28 @@ export interface UserResponse {
     identityProviderId?: string;
 }
 export declare enum UserStatus {
+    /**
+     * User has not yet been created.
+     * Requires the frontend to post data to create the user
+     * */
     NEEDS_CREATING = "NEEDS_CREATING",
+    /**
+     * User is being created.
+     * Frontend has sent the required data and the backend is asynchronously processing.
+     * Poll and wait for ACTIVE
+     * */
     CREATION_IN_PROGRESS = "CREATION_IN_PROGRESS",
+    /**
+     * User has been created and should be part of an organisation but the membership has not been processed yet.
+     * Poll and wait for ACTIVE
+     * */
     PENDING_ORGANISATION_MEMBERSHIP = "PENDING_ORGANISATION_MEMBERSHIP",
+    /**
+     * User has been created and should have been issued entitlements but they have not been issued yet.
+     * Poll and wait for ACTIVE
+     * */
+    PENDING_ENTITLEMENTS = "PENDING_ENTITLEMENTS",
+    /** All user data is up to date */
     ACTIVE = "ACTIVE"
 }
 export interface UserResponseMembership {

package/dist/cjs/user/get-user.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-user.d.ts","sourceRoot":"","sources":["../../../src/user/get-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjD,MAAM,WAAW,4BAA4B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;IACnB,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,WAAW,EAAE,sBAAsB,EAAE,CAAC;IACtC,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yEAAyE;IACzE,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,oBAAY,UAAU;IAClB,cAAc,mBAAmB;IACjC,oBAAoB,yBAAyB;IAC7C,+BAA+B,oCAAoC;IACnE,MAAM,WAAW;CACpB;AAED,MAAM,WAAW,sBAAsB;IACnC,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAClB"}
+{"version":3,"file":"get-user.d.ts","sourceRoot":"","sources":["../../../src/user/get-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjD,MAAM,WAAW,4BAA4B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;IACnB,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,WAAW,EAAE,sBAAsB,EAAE,CAAC;IACtC,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yEAAyE;IACzE,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,oBAAY,UAAU;IAClB;;;SAGK;IACL,cAAc,mBAAmB;IACjC;;;;SAIK;IACL,oBAAoB,yBAAyB;IAC7C;;;SAGK;IACL,+BAA+B,oCAAoC;IACnE;;;SAGK;IACL,oBAAoB,yBAAyB;IAC7C,kCAAkC;IAClC,MAAM,WAAW;CACpB;AAED,MAAM,WAAW,sBAAsB;IACnC,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAClB"}

package/dist/cjs/user/get-user.js

@@ -3,9 +3,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserStatus = void 0;
 var UserStatus;
 (function (UserStatus) {
+    /**
+     * User has not yet been created.
+     * Requires the frontend to post data to create the user
+     * */
     UserStatus["NEEDS_CREATING"] = "NEEDS_CREATING";
+    /**
+     * User is being created.
+     * Frontend has sent the required data and the backend is asynchronously processing.
+     * Poll and wait for ACTIVE
+     * */
     UserStatus["CREATION_IN_PROGRESS"] = "CREATION_IN_PROGRESS";
+    /**
+     * User has been created and should be part of an organisation but the membership has not been processed yet.
+     * Poll and wait for ACTIVE
+     * */
     UserStatus["PENDING_ORGANISATION_MEMBERSHIP"] = "PENDING_ORGANISATION_MEMBERSHIP";
+    /**
+     * User has been created and should have been issued entitlements but they have not been issued yet.
+     * Poll and wait for ACTIVE
+     * */
+    UserStatus["PENDING_ENTITLEMENTS"] = "PENDING_ENTITLEMENTS";
+    /** All user data is up to date */
     UserStatus["ACTIVE"] = "ACTIVE";
 })(UserStatus || (exports.UserStatus = UserStatus = {}));
 //# sourceMappingURL=get-user.js.map

package/dist/cjs/user/get-user.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-user.js","sourceRoot":"","sources":["../../../src/user/get-user.ts"],"names":[],"mappings":";;;AA6BA,IAAY,UAKX;AALD,WAAY,UAAU;IAClB,+CAAiC,CAAA;IACjC,2DAA6C,CAAA;IAC7C,iFAAmE,CAAA;IACnE,+BAAiB,CAAA;AACrB,CAAC,EALW,UAAU,0BAAV,UAAU,QAKrB"}
+{"version":3,"file":"get-user.js","sourceRoot":"","sources":["../../../src/user/get-user.ts"],"names":[],"mappings":";;;AA6BA,IAAY,UAwBX;AAxBD,WAAY,UAAU;IAClB;;;SAGK;IACL,+CAAiC,CAAA;IACjC;;;;SAIK;IACL,2DAA6C,CAAA;IAC7C;;;SAGK;IACL,iFAAmE,CAAA;IACnE;;;SAGK;IACL,2DAA6C,CAAA;IAC7C,kCAAkC;IAClC,+BAAiB,CAAA;AACrB,CAAC,EAxBW,UAAU,0BAAV,UAAU,QAwBrB"}

package/dist/esm/enriched-hack/enriched-hack.d.ts

@@ -60,6 +60,10 @@ export interface EnrichedHack {
      * An estimation of the time saved in minutes when no reliable information is available on the knowledge source.
      */
     estimatedTimeSaved?: number;
+    /**
+     * Tenant display name, from the display name of its b2b-organisation, if any
+     */
+    tenantDisplayName?: string;
 }
 export interface EnrichedHackNotifications {
     aiGeneratedText?: string;

package/dist/esm/enriched-hack/enriched-hack.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"enriched-hack.d.ts","sourceRoot":"","sources":["../../../src/enriched-hack/enriched-hack.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACrH,OAAO,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEhH,MAAM,WAAW,YAAY;IACzB,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB,sGAAsG;IACtG,MAAM,EAAE,MAAM,CAAC;IACf,iDAAiD;IACjD,gBAAgB,EAAE,MAAM,CAAC;IACzB,CAAC,EAAE,MAAM,CAAC;IACV,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAElB,2BAA2B;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IAGzB,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wGAAwG;IACxG,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,aAAa,CAAC,EAAE,yBAAyB,CAAC;IAE1C,WAAW,EAAE,MAAM,CAAC;IAGpB,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACpC,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;IACjC,IAAI,EAAE,QAAQ,CAAC;IACf,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,OAAO,EAAE,iBAAiB,CAAC;IAE3B,uBAAuB;IAEvB,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAGhC,2BAA2B,EAAE,OAAO,CAAC;IACrC,0BAA0B,EAAE,OAAO,CAAC;IACpC,wBAAwB,EAAE,OAAO,CAAC;IAClC,sBAAsB,EAAE,OAAO,CAAC;IAChC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;;SAGK;IACL,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,yBAAyB;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,oBAAoB;IACjC,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC,YAAY,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,SAAS,CAAC,EAAE;QACR,KAAK,EAAE,eAAe,EAAE,CAAC;QACzB,MAAM,EAAE,aAAa,EAAE,CAAC;KAC3B,CAAC;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,WAAW,EAAE,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC"}
+{"version":3,"file":"enriched-hack.d.ts","sourceRoot":"","sources":["../../../src/enriched-hack/enriched-hack.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACrH,OAAO,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEhH,MAAM,WAAW,YAAY;IACzB,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB,sGAAsG;IACtG,MAAM,EAAE,MAAM,CAAC;IACf,iDAAiD;IACjD,gBAAgB,EAAE,MAAM,CAAC;IACzB,CAAC,EAAE,MAAM,CAAC;IACV,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAElB,2BAA2B;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IAGzB,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wGAAwG;IACxG,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,aAAa,CAAC,EAAE,yBAAyB,CAAC;IAE1C,WAAW,EAAE,MAAM,CAAC;IAGpB,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACpC,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;IACjC,IAAI,EAAE,QAAQ,CAAC;IACf,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,OAAO,EAAE,iBAAiB,CAAC;IAE3B,uBAAuB;IAEvB,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAGhC,2BAA2B,EAAE,OAAO,CAAC;IACrC,0BAA0B,EAAE,OAAO,CAAC;IACpC,wBAAwB,EAAE,OAAO,CAAC;IAClC,sBAAsB,EAAE,OAAO,CAAC;IAChC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;;SAGK;IACL,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,yBAAyB;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,oBAAoB;IACjC,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC,YAAY,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,SAAS,CAAC,EAAE;QACR,KAAK,EAAE,eAAe,EAAE,CAAC;QACzB,MAAM,EAAE,aAAa,EAAE,CAAC;KAC3B,CAAC;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,WAAW,EAAE,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/dist/esm/user/get-user.d.ts

@@ -25,9 +25,28 @@ export interface UserResponse {
     identityProviderId?: string;
 }
 export declare enum UserStatus {
+    /**
+     * User has not yet been created.
+     * Requires the frontend to post data to create the user
+     * */
     NEEDS_CREATING = "NEEDS_CREATING",
+    /**
+     * User is being created.
+     * Frontend has sent the required data and the backend is asynchronously processing.
+     * Poll and wait for ACTIVE
+     * */
     CREATION_IN_PROGRESS = "CREATION_IN_PROGRESS",
+    /**
+     * User has been created and should be part of an organisation but the membership has not been processed yet.
+     * Poll and wait for ACTIVE
+     * */
     PENDING_ORGANISATION_MEMBERSHIP = "PENDING_ORGANISATION_MEMBERSHIP",
+    /**
+     * User has been created and should have been issued entitlements but they have not been issued yet.
+     * Poll and wait for ACTIVE
+     * */
+    PENDING_ENTITLEMENTS = "PENDING_ENTITLEMENTS",
+    /** All user data is up to date */
     ACTIVE = "ACTIVE"
 }
 export interface UserResponseMembership {

package/dist/esm/user/get-user.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-user.d.ts","sourceRoot":"","sources":["../../../src/user/get-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjD,MAAM,WAAW,4BAA4B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;IACnB,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,WAAW,EAAE,sBAAsB,EAAE,CAAC;IACtC,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yEAAyE;IACzE,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,oBAAY,UAAU;IAClB,cAAc,mBAAmB;IACjC,oBAAoB,yBAAyB;IAC7C,+BAA+B,oCAAoC;IACnE,MAAM,WAAW;CACpB;AAED,MAAM,WAAW,sBAAsB;IACnC,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAClB"}
+{"version":3,"file":"get-user.d.ts","sourceRoot":"","sources":["../../../src/user/get-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjD,MAAM,WAAW,4BAA4B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;IACnB,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,WAAW,EAAE,sBAAsB,EAAE,CAAC;IACtC,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yEAAyE;IACzE,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,oBAAY,UAAU;IAClB;;;SAGK;IACL,cAAc,mBAAmB;IACjC;;;;SAIK;IACL,oBAAoB,yBAAyB;IAC7C;;;SAGK;IACL,+BAA+B,oCAAoC;IACnE;;;SAGK;IACL,oBAAoB,yBAAyB;IAC7C,kCAAkC;IAClC,MAAM,WAAW;CACpB;AAED,MAAM,WAAW,sBAAsB;IACnC,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAClB"}

package/dist/esm/user/get-user.js

@@ -1,8 +1,27 @@
 export var UserStatus;
 (function (UserStatus) {
+    /**
+     * User has not yet been created.
+     * Requires the frontend to post data to create the user
+     * */
     UserStatus["NEEDS_CREATING"] = "NEEDS_CREATING";
+    /**
+     * User is being created.
+     * Frontend has sent the required data and the backend is asynchronously processing.
+     * Poll and wait for ACTIVE
+     * */
     UserStatus["CREATION_IN_PROGRESS"] = "CREATION_IN_PROGRESS";
+    /**
+     * User has been created and should be part of an organisation but the membership has not been processed yet.
+     * Poll and wait for ACTIVE
+     * */
     UserStatus["PENDING_ORGANISATION_MEMBERSHIP"] = "PENDING_ORGANISATION_MEMBERSHIP";
+    /**
+     * User has been created and should have been issued entitlements but they have not been issued yet.
+     * Poll and wait for ACTIVE
+     * */
+    UserStatus["PENDING_ENTITLEMENTS"] = "PENDING_ENTITLEMENTS";
+    /** All user data is up to date */
     UserStatus["ACTIVE"] = "ACTIVE";
 })(UserStatus || (UserStatus = {}));
 //# sourceMappingURL=get-user.js.map

package/dist/esm/user/get-user.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-user.js","sourceRoot":"","sources":["../../../src/user/get-user.ts"],"names":[],"mappings":"AA6BA,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IAClB,+CAAiC,CAAA;IACjC,2DAA6C,CAAA;IAC7C,iFAAmE,CAAA;IACnE,+BAAiB,CAAA;AACrB,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB"}
+{"version":3,"file":"get-user.js","sourceRoot":"","sources":["../../../src/user/get-user.ts"],"names":[],"mappings":"AA6BA,MAAM,CAAN,IAAY,UAwBX;AAxBD,WAAY,UAAU;IAClB;;;SAGK;IACL,+CAAiC,CAAA;IACjC;;;;SAIK;IACL,2DAA6C,CAAA;IAC7C;;;SAGK;IACL,iFAAmE,CAAA;IACnE;;;SAGK;IACL,2DAA6C,CAAA;IAC7C,kCAAkC;IAClC,+BAAiB,CAAA;AACrB,CAAC,EAxBW,UAAU,KAAV,UAAU,QAwBrB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uptime.app/contracts",
-  "version": "2.0.37",
+  "version": "2.0.39-rc.0",
   "license": "MIT",
   "types": "./dist/esm/index.d.ts",
   "main": "./dist/cjs/index.js",
@@ -14,5 +14,5 @@
   "devDependencies": {
     "typescript": "^5.4.3"
   },
-  "gitHead": "4f00b19debd06f8b1330d7471807d66b2635565f"
+  "gitHead": "c0b7d8362d0707b3afad98e130735a6fd0dff70a"
 }

package/src/access-control/collection-access-control.ts

@@ -1,28 +1,28 @@
-export interface CollectionAccessControl {
-    id: string;
-    collectionId: string; // PK
-    v: number;
-    acl: string[]
-    createdAt: string;
-    updatedAt: string;
-}
-
-export interface CollectionAccessControlCreatedEvent {
-    id: string;
-    type: 'CollectionAccessControlCreated';
-    payload: CollectionAccessControl;
-}
-
-export interface CollectionAccessControlUpdatedEvent {
-    id: string;
-    type: 'CollectionAccessControlUpdated';
-    payload: CollectionAccessControl;
-}
-
-export interface CollectionAccessControlDeletedEvent {
-    id: string;
-    type: 'CollectionAccessControlDeleted';
-    payload: CollectionAccessControl;
-}
-
-export type CollectionAccessControlChangedEvent = CollectionAccessControlCreatedEvent | CollectionAccessControlUpdatedEvent | CollectionAccessControlDeletedEvent;
+export interface CollectionAccessControl {
+    id: string;
+    collectionId: string; // PK
+    v: number;
+    acl: string[]
+    createdAt: string;
+    updatedAt: string;
+}
+
+export interface CollectionAccessControlCreatedEvent {
+    id: string;
+    type: 'CollectionAccessControlCreated';
+    payload: CollectionAccessControl;
+}
+
+export interface CollectionAccessControlUpdatedEvent {
+    id: string;
+    type: 'CollectionAccessControlUpdated';
+    payload: CollectionAccessControl;
+}
+
+export interface CollectionAccessControlDeletedEvent {
+    id: string;
+    type: 'CollectionAccessControlDeleted';
+    payload: CollectionAccessControl;
+}
+
+export type CollectionAccessControlChangedEvent = CollectionAccessControlCreatedEvent | CollectionAccessControlUpdatedEvent | CollectionAccessControlDeletedEvent;

package/src/access-control/hack-access-control.ts

@@ -1,32 +1,32 @@
-export interface HackAccessControl {
-    id: string;
-    hackId: string; // PK
-    // do I need baseLocaleHackId ? don't think I do
-    v: number;
-    acl: string[]
-    createdAt: string;
-    updatedAt: string;
-    /** added April 2025 and backfilled */
-    owner: string;
-    tenant: string;
-}
-
-export interface HackAccessControlCreatedEvent {
-    id: string;
-    type: 'HackAccessControlCreated';
-    payload: HackAccessControl;
-}
-
-export interface HackAccessControlUpdatedEvent {
-    id: string;
-    type: 'HackAccessControlUpdated';
-    payload: HackAccessControl;
-}
-
-export interface HackAccessControlDeletedEvent {
-    id: string;
-    type: 'HackAccessControlDeleted';
-    payload: HackAccessControl;
-}
-
-export type HackAccessControlChangedEvent = HackAccessControlCreatedEvent | HackAccessControlUpdatedEvent | HackAccessControlDeletedEvent;
+export interface HackAccessControl {
+    id: string;
+    hackId: string; // PK
+    // do I need baseLocaleHackId ? don't think I do
+    v: number;
+    acl: string[]
+    createdAt: string;
+    updatedAt: string;
+    /** added April 2025 and backfilled */
+    owner: string;
+    tenant: string;
+}
+
+export interface HackAccessControlCreatedEvent {
+    id: string;
+    type: 'HackAccessControlCreated';
+    payload: HackAccessControl;
+}
+
+export interface HackAccessControlUpdatedEvent {
+    id: string;
+    type: 'HackAccessControlUpdated';
+    payload: HackAccessControl;
+}
+
+export interface HackAccessControlDeletedEvent {
+    id: string;
+    type: 'HackAccessControlDeleted';
+    payload: HackAccessControl;
+}
+
+export type HackAccessControlChangedEvent = HackAccessControlCreatedEvent | HackAccessControlUpdatedEvent | HackAccessControlDeletedEvent;

package/src/access-control/profile-access-control.ts

@@ -1,28 +1,28 @@
-export interface ProfileAccessControl {
-    id: string;
-    profileId: string;
-    v: number;
-    acl: string[]
-    createdAt: string;
-    updatedAt: string;
-}
-
-export interface ProfileAccessControlCreatedEvent {
-    id: string;
-    type: 'ProfileAccessControlCreated';
-    payload: ProfileAccessControl;
-}
-
-export interface ProfileAccessControlUpdatedEvent {
-    id: string;
-    type: 'ProfileAccessControlUpdated';
-    payload: ProfileAccessControl;
-}
-
-export interface ProfileAccessControlDeletedEvent {
-    id: string;
-    type: 'ProfileAccessControlDeleted';
-    payload: ProfileAccessControl;
-}
-
+export interface ProfileAccessControl {
+    id: string;
+    profileId: string;
+    v: number;
+    acl: string[]
+    createdAt: string;
+    updatedAt: string;
+}
+
+export interface ProfileAccessControlCreatedEvent {
+    id: string;
+    type: 'ProfileAccessControlCreated';
+    payload: ProfileAccessControl;
+}
+
+export interface ProfileAccessControlUpdatedEvent {
+    id: string;
+    type: 'ProfileAccessControlUpdated';
+    payload: ProfileAccessControl;
+}
+
+export interface ProfileAccessControlDeletedEvent {
+    id: string;
+    type: 'ProfileAccessControlDeleted';
+    payload: ProfileAccessControl;
+}
+
 export type ProfileAccessControlChangedEvent = ProfileAccessControlCreatedEvent | ProfileAccessControlUpdatedEvent | ProfileAccessControlDeletedEvent;

package/src/app-hack/app-full-hack.ts

@@ -1,9 +1,9 @@
-import { AppRestrictedHack } from './app-restricted-hack';
-import { EnrichedHack } from '../enriched-hack/enriched-hack';
-
-/**
- * Includes all of a hack's content that premium users are allowed to access. Free users should not have access to this object.
- */
-export interface AppFullHack extends AppRestrictedHack {
-    segments: EnrichedHack['segments'];
-}
+import { AppRestrictedHack } from './app-restricted-hack';
+import { EnrichedHack } from '../enriched-hack/enriched-hack';
+
+/**
+ * Includes all of a hack's content that premium users are allowed to access. Free users should not have access to this object.
+ */
+export interface AppFullHack extends AppRestrictedHack {
+    segments: EnrichedHack['segments'];
+}

package/src/app-hack/app-hack-metadata.ts

@@ -1,60 +1,60 @@
-import { EnrichedHack } from '../enriched-hack/enriched-hack';
-
-export interface AppHackMetadata {
-    id: string;
-    language: string;
-    locale: string;
-    baseLocaleHackId: string;
-    v: number;
-    hackVersion: number;
-    createdAt: string;
-    updatedAt: string;
-    owner: string;
-    acl: string[];
-    /** List of catalogues ids the hack is in. ids do not have the 'catalogue:' prefix. Added in Oct 2024 */
-    catalogues: string[];
-    themeId: string;
-    title: string;
-    isHidden?: boolean;
-    editorialTags?: string[];
-    coverUrl?: string;
-    /** Added in July 2024. This is the URL of the cover image that is free to use without any copyright. */
-    copyrightFreeCoverUrl?: string;
-    description: string;
-    /** 'public' or 'private' introduced Mar 2024 */
-    shareScope: string;
-    segments: {
-        favouriteQuote: {
-            id: string;
-        };
-        inANutshell: {
-            id: string;
-        };
-        introduction: {
-            id: string;
-        };
-        insights: {id: string}[];
-        conclusion: {
-            id: string;
-        };
-        overview: {
-            id: string;
-        };
-        shareableOverview: {
-            id: string;
-        };
-        hereAreTheInsights: {
-            id: string;
-        };
-        putInAction?: {
-            id: string;
-        };
-    }
-    topics: EnrichedHack['topics'];
-    contributors?: EnrichedHack['contributors'];
-    type: string;
-    sourceData?: EnrichedHack['sourceData'];
-    profile: EnrichedHack['profile'];
-    timeSaved?: number;
-    estimatedTimeSaved?: number;
-}
+import { EnrichedHack } from '../enriched-hack/enriched-hack';
+
+export interface AppHackMetadata {
+    id: string;
+    language: string;
+    locale: string;
+    baseLocaleHackId: string;
+    v: number;
+    hackVersion: number;
+    createdAt: string;
+    updatedAt: string;
+    owner: string;
+    acl: string[];
+    /** List of catalogues ids the hack is in. ids do not have the 'catalogue:' prefix. Added in Oct 2024 */
+    catalogues: string[];
+    themeId: string;
+    title: string;
+    isHidden?: boolean;
+    editorialTags?: string[];
+    coverUrl?: string;
+    /** Added in July 2024. This is the URL of the cover image that is free to use without any copyright. */
+    copyrightFreeCoverUrl?: string;
+    description: string;
+    /** 'public' or 'private' introduced Mar 2024 */
+    shareScope: string;
+    segments: {
+        favouriteQuote: {
+            id: string;
+        };
+        inANutshell: {
+            id: string;
+        };
+        introduction: {
+            id: string;
+        };
+        insights: {id: string}[];
+        conclusion: {
+            id: string;
+        };
+        overview: {
+            id: string;
+        };
+        shareableOverview: {
+            id: string;
+        };
+        hereAreTheInsights: {
+            id: string;
+        };
+        putInAction?: {
+            id: string;
+        };
+    }
+    topics: EnrichedHack['topics'];
+    contributors?: EnrichedHack['contributors'];
+    type: string;
+    sourceData?: EnrichedHack['sourceData'];
+    profile: EnrichedHack['profile'];
+    timeSaved?: number;
+    estimatedTimeSaved?: number;
+}

package/src/app-hack/app-restricted-hack.ts

@@ -1,22 +1,22 @@
-import { EnrichedHack } from '../enriched-hack/enriched-hack';
-import { AppHackMetadata } from './app-hack-metadata';
-
-/**
- * Includes all of a hack's content the free users are allowed to access.
- */
-export interface AppRestrictedHack extends AppHackMetadata {
-    segments: AppHackMetadata['segments'] & {
-        // only allow access to the shareableOverview and overview segment
-        overview: EnrichedHack['segments']['overview'];
-        shareableOverview: EnrichedHack['segments']['shareableOverview'];
-    }
-    theme: EnrichedHack['theme'];
-    affiliate?: {
-        url: string;
-        name: string;
-    };
-    externalLink?: {
-        url: string;
-        type: 'Website' | 'Book' | 'Course' | 'Podcast' | 'Video' | 'Other';
-    };
-}
+import { EnrichedHack } from '../enriched-hack/enriched-hack';
+import { AppHackMetadata } from './app-hack-metadata';
+
+/**
+ * Includes all of a hack's content the free users are allowed to access.
+ */
+export interface AppRestrictedHack extends AppHackMetadata {
+    segments: AppHackMetadata['segments'] & {
+        // only allow access to the shareableOverview and overview segment
+        overview: EnrichedHack['segments']['overview'];
+        shareableOverview: EnrichedHack['segments']['shareableOverview'];
+    }
+    theme: EnrichedHack['theme'];
+    affiliate?: {
+        url: string;
+        name: string;
+    };
+    externalLink?: {
+        url: string;
+        type: 'Website' | 'Book' | 'Course' | 'Podcast' | 'Video' | 'Other';
+    };
+}