@uptime.app/contracts 1.0.12 → 1.0.13-user-context.1

package/dist/esm/user-context/user-context-events.d.ts

@@ -0,0 +1,18 @@
+import { UserContext } from "./user-context";
+export interface UserContextCreatedEvent {
+    id: string;
+    type: 'UserContextCreated';
+    payload: UserContext;
+}
+export interface UserContextUpdatedEvent {
+    id: string;
+    type: 'UserContextUpdated';
+    payload: UserContext;
+}
+export interface UserContextDeletedEvent {
+    id: string;
+    type: 'UserContextDeleted';
+    payload: UserContext;
+}
+export type UserContextChangedEvent = UserContextCreatedEvent | UserContextUpdatedEvent | UserContextDeletedEvent;
+//# sourceMappingURL=user-context-events.d.ts.map

package/dist/esm/user-context/user-context-events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-context-events.d.ts","sourceRoot":"","sources":["../../../src/user-context/user-context-events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,WAAW,uBAAuB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,oBAAoB,CAAC;IAC3B,OAAO,EAAE,WAAW,CAAC;CACxB;AAED,MAAM,WAAW,uBAAuB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,oBAAoB,CAAC;IAC3B,OAAO,EAAE,WAAW,CAAC;CACxB;AAED,MAAM,WAAW,uBAAuB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,oBAAoB,CAAC;IAC3B,OAAO,EAAE,WAAW,CAAC;CACxB;AAED,MAAM,MAAM,uBAAuB,GAAG,uBAAuB,GAAG,uBAAuB,GAAG,uBAAuB,CAAC"}

package/dist/esm/user-context/user-context-events.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=user-context-events.js.map

package/dist/esm/user-context/user-context-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-context-events.js","sourceRoot":"","sources":["../../../src/user-context/user-context-events.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,17 @@
+import { Entitlement } from "../entitlement/user-entitlements";
+export interface UserContext {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    entitlements: Entitlement[];
+    organisationIds: string[];
+    roles: string[];
+    acl: string[];
+    permissions: string[];
+    partnerId?: string;
+    brandId?: string;
+    skinId?: string;
+}
+//# sourceMappingURL=user-context.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"user-context.d.ts","sourceRoot":"","sources":["../../../src/user-context/user-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAE/D,MAAM,WAAW,WAAW;IACxB,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,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB"}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=user-context.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"user-context.js","sourceRoot":"","sources":["../../../src/user-context/user-context.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uptime.app/contracts",
-  "version": "1.0.12",
+  "version": "1.0.13-user-context.1",
   "license": "MIT",
   "types": "./dist/esm/index.d.ts",
   "main": "./dist/cjs/index.js",
@@ -13,5 +13,5 @@
   "devDependencies": {
     "typescript": "^5.4.3"
   },
-  "gitHead": "1c8aa56436af18e4f4c3cc854d3f9eb4e3e4f38f"
+  "gitHead": "cf9618d1a558c19965b58fbb69776dac8ab82530"
 }

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

@@ -0,0 +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;

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

@@ -0,0 +1,29 @@
+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;
+}
+
+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/distribution/collection-distribution.ts

@@ -0,0 +1,17 @@
+export interface CollectionDistribution extends CollectionDistributionProperties  {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    collectionId: string;
+    baseLocaleCollectionId: string;
+}
+
+export interface CollectionDistributionProperties {
+    includeInEmailNotifications: boolean;
+    includeInPushNotifications: boolean;
+    includeInRecommendations: boolean;
+    includeInSearchResults: boolean;
+    includeInWebsite: boolean;
+    isHidden: boolean;
+}

package/src/distribution/distribution-events.ts

@@ -0,0 +1,61 @@
+import { HackDistribution } from './hack-distribution';
+import { CollectionDistribution } from './collection-distribution';
+
+export interface HackDistributionCreatedEvent {
+    id: string;
+    type: 'HackDistributionCreated';
+    payload: HackDistribution;
+}
+
+export interface HackDistributionUpdatedEvent {
+    id: string;
+    type: 'HackDistributionUpdated';
+    payload: HackDistribution;
+}
+
+export interface HackDistributionDeletedEvent {
+    id: string;
+    type: 'HackDistributionDeleted';
+    payload: HackDistribution;
+}
+
+export interface CollectionDistributionCreatedEvent {
+    id: string;
+    type: 'CollectionDistributionCreated';
+    payload: CollectionDistribution;
+}
+
+export interface CollectionDistributionUpdatedEvent {
+    id: string;
+    type: 'CollectionDistributionUpdated';
+    payload: CollectionDistribution;
+}
+
+export interface CollectionDistributionDeletedEvent {
+    id: string;
+    type: 'CollectionDistributionDeleted';
+    payload: CollectionDistribution;
+}
+
+export type HackDistributionChangedEvent = HackDistributionCreatedEvent | HackDistributionUpdatedEvent | HackDistributionDeletedEvent;
+export type CollectionDistributionChangedEvent = CollectionDistributionCreatedEvent | CollectionDistributionUpdatedEvent | CollectionDistributionDeletedEvent;
+
+export interface CheckPrivateHackDistributionEvent {
+    id: string;
+    type: 'CheckPrivateHackDistribution'
+    payload: {
+        id: string;
+        v: number;
+        hackId: string;
+    }
+}
+
+export interface CheckPrivateCollectionDistributionEvent {
+    id: string;
+    type: 'CheckPrivateCollectionDistribution'
+    payload: {
+        id: string;
+        v: number;
+        collectionId: string;
+    }
+}

package/src/distribution/hack-distribution.ts

@@ -0,0 +1,19 @@
+export interface HackDistribution extends HackDistributionProperties  {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    hackId: string;
+    baseLocaleHackId: string; // added 09/03/23 to allow syncing across hacks with the same baseLocaleHackId
+}
+
+export interface HackDistributionProperties {
+    includeInEmailNotifications: boolean;
+    includeInPushNotifications: boolean;
+    includeInRecommendations: boolean;
+    includeInSearchResults: boolean;
+    includeInTrending: boolean;
+    includeInHackOfTheDay: boolean;
+    includeInWebsite: boolean;
+    isHidden: boolean; // added 17/11/22, to replace Hack property with the same name
+}

package/src/draft-hack-generation/draft-hack-generation-events.ts

@@ -0,0 +1,42 @@
+import { GeneratedDraftHackContent } from './draft-hack-generation';
+
+export interface DraftHackGenerated {
+    id: string;
+    type: 'DraftHackGenerated';
+    payload: {
+        // the draft hack id
+        id: string;
+        // the version
+        v: number;
+        reference: string;
+        draftHackId: string;
+        draftHackContent: GeneratedDraftHackContent;
+    }
+}
+
+export interface DraftHackGenerationFailed {
+    id: string;
+    type: 'DraftHackGenerationFailed';
+    payload: {
+        reference: string;
+        errorMessage: string;
+    }
+}
+
+export interface GeneratedDraftHackSavedToGoogleDrive {
+    id: string;
+    type: 'GeneratedDraftHackSavedToGoogleDrive';
+    payload: {
+        // the draft hack id
+        id: string;
+        // the version
+        v: number;
+        reference: string;
+        draftHackId: string;
+        draftHackContent: GeneratedDraftHackContent;
+        driveFile: {
+            id: string;
+            parentId: string;
+        }
+    }
+}

package/src/draft-hack-generation/draft-hack-generation.ts

@@ -0,0 +1,38 @@
+export interface GeneratedDraftHackContent {
+    title: string;
+    segments: GeneratedDraftHackSegments;
+    coverUrl?: string;
+    topics: GeneratedDraftTopic[];
+    notification: GeneratedDraftHackNotification;
+    contributors: GeneratedDraftContributor[];
+}
+export interface GeneratedDraftHackSegments {
+    favouriteQuote: GeneratedDraftHackSegment;
+    inANutshell: GeneratedDraftHackSegment;
+    introduction: GeneratedDraftHackSegment;
+    insights: GeneratedDraftHackInsightSegment[];
+    conclusion: GeneratedDraftHackSegment;
+}
+export interface GeneratedDraftHackSegment {
+    paragraphCards: GeneratedDraftHackCard[][];
+}
+export interface GeneratedDraftHackCard {
+    markdown: string;
+}
+export interface GeneratedDraftHackInsightSegment extends GeneratedDraftHackSegment {
+    title: string;
+    actions: GeneratedDraftHackAction[];
+}
+export interface GeneratedDraftHackAction {
+    title: string;
+    markdown: string;
+}
+export interface GeneratedDraftTopic {
+    name: string;
+}
+export interface GeneratedDraftHackNotification {
+    aiGeneratedText: string;
+}
+export interface GeneratedDraftContributor {
+    name: string;
+}

package/src/enriched-hack/enriched-hack-events.ts

@@ -0,0 +1,21 @@
+import { EnrichedHack } from './enriched-hack';
+
+export interface EnrichedHackCreatedEvent {
+    id: string;
+    type: 'EnrichedHackCreated';
+    payload: EnrichedHack;
+}
+
+export interface EnrichedHackUpdatedEvent {
+    id: string;
+    type: 'EnrichedHackUpdated';
+    payload: EnrichedHack;
+}
+
+export interface EnrichedHackDeletedEvent {
+    id: string;
+    type: 'EnrichedHackDeleted';
+    payload: EnrichedHack;
+}
+
+export type EnrichedHackChangedEvent = EnrichedHackCreatedEvent | EnrichedHackUpdatedEvent | EnrichedHackDeletedEvent;

package/src/enriched-hack/enriched-hack.ts

@@ -0,0 +1,101 @@
+import { HackAffiliate, HackContributor, HackExternalLink, HackSourceData, HackTopic, HackType } from '../hack/hack';
+import { KnowledgeSource } from '../knowledge-source/knowledge-source';
+import { Profile } from '../profile/profile';
+import { Theme } from '../theme/theme';
+import { HackWithVoice } from '../hack/hack-with-voice';
+import { ExtractedSubject } from '../hack/extracted-subject';
+import { SegmentType, SegmentAction, SegmentSpeech, SegmentSection, SegmentTextCard } from '../segment/segment';
+
+export interface EnrichedHack {
+    /** The hack id */
+    id: string;
+    /** The hack language e.g. 'fr' if it is French */
+    language: string;
+    /** The locale (language and region) of the hack e.g. fr-FR. Use @uptime.app/localisation-contracts */
+    locale: string;
+    /** The id of the hack in its original locale. */
+    baseLocaleHackId: string;
+    v: number;
+    hackVersion: number;
+    createdAt: string;
+    updatedAt: string;
+
+    /** introduced Oct 2023 **/
+    draftHackId: string;
+    draftHackVersion: number;
+
+    //@todo: Deprecate
+    source?: KnowledgeSource;
+    owner: string;
+    acl: string[];
+    theme: Theme;
+    title: string;
+    isHidden?: boolean;
+    editorialTags?: string[];
+    coverUrl?: string;
+    notifications?: EnrichedHackNotifications;
+    /* currently contains the inANutshell segment markdown */
+    description: string;
+    // ...
+
+    segments: HackWithVoice['segments']; // Use the 'HackWithVoice' type
+    affiliate?: HackAffiliate;
+    topics: HackTopic[];
+    contributors?: HackContributor[];
+    type: HackType;
+    sourceData?: HackSourceData;
+    externalLink?: HackExternalLink;
+    profile: EnrichHackProfile;
+
+    /** added April 2024 */
+    // TODO make it mandatory after a republish
+    subjects?: EnrichedHackSubjects;
+
+    // distribution
+    includeInEmailNotifications: boolean;
+    includeInPushNotifications: boolean;
+    includeInRecommendations: boolean;
+    includeInSearchResults: boolean;
+    includeInTrending: boolean;
+    includeInHackOfTheDay: boolean;
+    includeInWebsite: boolean;
+
+    /**
+     * Time saved in minutes by consuming the hack rather than the underlying knowledge source.
+     * calculated using the knowledge source page count / duration
+     * */
+    timeSaved?: number;
+    /**
+     * An estimation of the time saved in minutes when no reliable information is available on the knowledge source.
+     */
+    estimatedTimeSaved?: number;
+}
+
+export interface EnrichedHackNotifications {
+    aiGeneratedText?: string;
+    humanCuratedText?: string;
+}
+
+export interface EnrichedHackSubjects {
+    aiGenerated: ExtractedSubject[];
+    humanCurated?: ExtractedSubject[];
+}
+
+export interface EnrichedHackSegment {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    title: string;
+    type: SegmentType;
+    keywords: string[];
+    actions: SegmentAction[];
+    speech: SegmentSpeech[];
+    sections: SegmentSection[];
+    storyMode?: {
+        cards: SegmentTextCard[];
+        speech: SegmentSpeech[];
+    },
+    textSummary?: string;
+}
+
+export type EnrichHackProfile = Profile | { deleted: boolean, uptimeOwned: boolean, avatarUrl: string };

package/src/entitlement/user-entitlements-events.ts

@@ -0,0 +1,21 @@
+import { UserEntitlements } from "./user-entitlements";
+
+export interface UserEntitlementsCreatedEvent {
+    id: string;
+    type: 'UserEntitlementsCreated';
+    payload: UserEntitlements;
+}
+
+export interface UserEntitlementsUpdatedEvent {
+    id: string;
+    type: 'UserEntitlementsUpdated';
+    payload: UserEntitlements;
+}
+
+export interface UserEntitlementsDeletedEvent {
+    id: string;
+    type: 'UserEntitlementsDeleted';
+    payload: UserEntitlements;
+}
+
+export type UserEntitlementsChangedEvent = UserEntitlementsCreatedEvent | UserEntitlementsUpdatedEvent | UserEntitlementsDeletedEvent;

package/src/entitlement/user-entitlements.ts

@@ -0,0 +1,18 @@
+export type EntitlementName = 'premium' | 'trial';
+export type EntitlementIssuer = 'Uptime' | 'RevenueCat';
+
+export type Entitlement = {
+    entitlement: EntitlementName | string;
+    issuer: EntitlementIssuer | string;
+    expiresAt: string
+    issuedAt: string;
+};
+
+export interface UserEntitlements {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    entitlements: Entitlement[];
+}

package/src/index.ts

@@ -1,3 +1,6 @@
+export * from './access-control/collection-access-control';
+export * from './access-control/hack-access-control';
+
 export * from './b2b-organisation/b2b-organisation';
 export * from './b2b-organisation/b2b-organisation-events';
 
@@ -7,9 +10,19 @@ export * from './b2b-organisation/b2b-organisation-member-events';
 export * from './brand/brand';
 export * from './brand/brand-events';
 
+export * from './distribution/distribution-events';
+export * from './distribution/hack-distribution';
+export * from './distribution/collection-distribution';
+
 export * from './draft-hack/draft-hack';
 export * from './draft-hack/draft-hack-events';
 
+export * from './draft-hack-generation/draft-hack-generation';
+export * from './draft-hack-generation/draft-hack-generation-events';
+
+export * from './enriched-hack/enriched-hack';
+export * from './enriched-hack/enriched-hack-events';
+
 export * from './hack/extracted-subject';
 export * from './hack/hack';
 export * from './hack/hack-with-voice';
@@ -48,4 +61,10 @@ export * from './text-to-speech/speech-created-events';
 export * from './text-to-speech/text-segment';
 
 export * from './theme/theme';
-export * from './theme/theme-events';
+export * from './theme/theme-events';
+
+export * from './entitlement/user-entitlements';
+export * from './entitlement/user-entitlements-events';
+
+export * from './user-context/user-context';
+export * from './user-context/user-context-events';

package/src/user-context/user-context-events.ts

@@ -0,0 +1,21 @@
+import { UserContext } from "./user-context";
+
+export interface UserContextCreatedEvent {
+    id: string;
+    type: 'UserContextCreated';
+    payload: UserContext;
+}
+
+export interface UserContextUpdatedEvent {
+    id: string;
+    type: 'UserContextUpdated';
+    payload: UserContext;
+}
+
+export interface UserContextDeletedEvent {
+    id: string;
+    type: 'UserContextDeleted';
+    payload: UserContext;
+}
+
+export type UserContextChangedEvent = UserContextCreatedEvent | UserContextUpdatedEvent | UserContextDeletedEvent;

package/src/user-context/user-context.ts

@@ -0,0 +1,17 @@
+import { Entitlement } from "../entitlement/user-entitlements";
+
+export interface UserContext {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    userId: string;
+    entitlements: Entitlement[];
+    organisationIds: string[];
+    roles: string[];
+    acl: string[];
+    permissions: string[];
+    partnerId?: string;
+    brandId?: string;
+    skinId?: string;
+}