@uptime.app/contracts 1.0.2 → 1.0.4-rc.0

package/src/segment/segment.ts

@@ -0,0 +1,82 @@
+export interface SegmentVoice {
+    id: string;
+    language: string;
+    name: string;
+    countryCode: string;
+    speechProvider: string;
+}
+
+export interface Segment {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    hackId: string;
+    type: SegmentType;
+    title: string;
+    sections: SegmentSection[];
+    keywords: string[];
+    actions: SegmentAction[];
+    speech: SegmentSpeech[];
+    textSummary?: string;
+    lastUpdatedFromPendingSegmentId?: string;
+    hackType: string;
+    /** use @uptime.app/text-to-speech-contracts */
+    locale: string;
+}
+
+export type SegmentType =
+    'overview' | 'favourite-quote' | 'in-a-nutshell' |
+    'introduction' | 'here-are-the-insights' |
+    'insight-one' | 'insight-two' | 'insight-three' |
+    'put-in-action' | 'conclusion' |
+    'shareable-overview' | 'download-app-to-see-more';
+
+export type CardType = 'hack-cover' | 'action';
+
+export interface SegmentAction {
+    title: string;
+    cards: SegmentTextCard[];
+}
+
+export interface SegmentTextCard {
+    id: string;
+    markdown: string;
+    segmentType: SegmentType;
+    cardType?: CardType;
+    isTitle?: boolean;
+    speech?: TextCardSpeech[];
+}
+
+export interface SegmentSection {
+    heading?: string;
+    cards: SegmentTextCard[];
+}
+
+export interface SegmentSpeech {
+    voice: SegmentVoice;
+    withHeading: {
+        url: string;
+        lengthSeconds: number;
+    };
+    withoutHeading: {
+        url: string;
+        lengthSeconds: number;
+    };
+}
+
+export interface TextCardSpeech {
+    voiceId: string;
+    withHeading: {
+        timestamps: {
+            startsAt: number;
+            endsAt: number;
+        };
+    };
+    withoutHeading: {
+        timestamps: {
+            startsAt: number;
+            endsAt: number;
+        };
+    };
+}

package/src/text-to-speech/create-speech-commands.ts

@@ -0,0 +1,20 @@
+import { TextSegment, Voice } from './text-segment';
+
+export interface CreateSpeechFromTextCommand {
+    id: string;
+    type: 'CreateSpeechFromText';
+    payload: {
+        locale: string;
+        textSegments: TextSegment[];
+    };
+}
+
+export interface CreateSpeechWithVoiceCommand {
+    id: string;
+    type: 'CreateSpeechWithVoice';
+    payload: {
+        locale: string;
+        textSegments: TextSegment[];
+        voice: Voice;
+    };
+}

package/src/text-to-speech/speech-created-events.ts

@@ -0,0 +1,11 @@
+import { TextSegmentWithSpeech } from './text-segment';
+import { SupportedLocale } from '../localisation/supported-locales';
+
+export interface SpeechFromTextCreatedEvent {
+    id: string;
+    type: 'SpeechFromTextCreated';
+    payload: {
+        locale: SupportedLocale;
+        textSegments: TextSegmentWithSpeech[];
+    };
+}

package/src/text-to-speech/text-segment.ts

@@ -0,0 +1,29 @@
+export interface TextSegment {
+    parentId: string;
+    textSegmentId: string;
+    content: string;
+}
+
+export interface TextSegmentWithSpeech extends TextSegment {
+    speech: Speech[];
+    /* The speech-friendly version of the "content" field. Trimmed, enrichment links removed, words replaced based on custom dictionary, etc. */
+    spokenContent: string;
+}
+
+export interface Speech {
+    voice: Voice;
+    url: string;
+}
+
+export interface Voice {
+    id: string;
+    language: string;
+    name: string;
+    countryCode: string;
+    /** use SupportedSpeechProvider */
+    speechProvider: string;
+}
+
+export enum SupportedSpeechProvider {
+    MicrosoftAzure = 'microsoft-azure'
+}

package/tsconfig.cjs.json

@@ -1,7 +1,7 @@
-{
-    "extends": "./tsconfig.npm.json",
-    "compilerOptions": {
-      "module": "CommonJS",
-      "outDir": "./dist/cjs"
-    },
-}
+{
+    "extends": "./tsconfig.npm.json",
+    "compilerOptions": {
+      "module": "CommonJS",
+      "outDir": "./dist/cjs"
+    },
+}

package/tsconfig.npm.json

@@ -1,21 +1,21 @@
-{
-    "compilerOptions": {
-        "build": true,
-        "target": "ES2020",
-        "module": "ES2020",
-        "declaration": true,
-        "emitDeclarationOnly": false,
-        "declarationMap": true,
-        "sourceMap": true,
-        "outDir": "./dist/esm",
-        "noEmit": false,
-        "strict": true,
-        "noImplicitAny": true,
-        "strictNullChecks": true,
-        "esModuleInterop": true,
-        "moduleResolution": "node",
-    },
-    "files": [
-        "src/index.ts"
-    ]
-}
+{
+    "compilerOptions": {
+        "build": true,
+        "target": "ES2020",
+        "module": "ES2020",
+        "declaration": true,
+        "emitDeclarationOnly": false,
+        "declarationMap": true,
+        "sourceMap": true,
+        "outDir": "./dist/esm",
+        "noEmit": false,
+        "strict": true,
+        "noImplicitAny": true,
+        "strictNullChecks": true,
+        "esModuleInterop": true,
+        "moduleResolution": "node",
+    },
+    "files": [
+        "src/index.ts"
+    ]
+}

package/dist/cjs/hack.d.ts

@@ -1,8 +0,0 @@
-export interface Hack {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    title: string;
-}
-//# sourceMappingURL=hack.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"hack.d.ts","sourceRoot":"","sources":["../../src/hack.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,IAAI;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACjB"}

package/dist/esm/hack.d.ts

@@ -1,8 +0,0 @@
-export interface Hack {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    title: string;
-}
-//# sourceMappingURL=hack.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"hack.d.ts","sourceRoot":"","sources":["../../src/hack.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,IAAI;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACjB"}

package/src/hack.ts

@@ -1,7 +0,0 @@
-export interface Hack {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    title: string;
-}