@uptime.app/contracts 2.0.41 → 2.0.42-rc.0

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

@@ -1,81 +1,81 @@
-import { removeUndefinedFields } from './remove-undefined-fields';
-import { hackIsInUptimeCatalogue } from './access-helper';
-import { EnrichedHack } from '../enriched-hack/enriched-hack';
-import { AppHackMetadata } from '../app-hack/app-hack-metadata';
-
-export function mapToAppHackMetadata(hack: EnrichedHack): AppHackMetadata {
-    // This function purposely picks the required fields from the EnrichedHack rather than deleting the unnecessary fields from EnrichedHack
-    // This ensures that if the EnrichedHack model is updated then those extra fields are not returned accidentally.
-    // This means that a service will not reflect any updated fields until it updates this module
-    return removeUndefinedFields({
-        id: hack.id,
-        title: hack.title,
-        owner: hack.owner,
-        v: hack.v,
-        hackVersion: hack.hackVersion,
-        createdAt: hack.createdAt,
-        updatedAt: hack.updatedAt,
-        baseLocaleHackId: hack.baseLocaleHackId,
-        language: hack.language,
-        locale: hack.locale,
-        acl: hack.acl,
-        themeId: hack.theme.id,
-        isHidden: hack.isHidden,
-        editorialTags: hack.editorialTags,
-        coverUrl: hack.coverUrl,
-        description: hack.description,
-        segments: toHackAppMetadataSegments(hack.segments),
-        topics: hack.topics,
-        contributors: hack.contributors,
-        type: hack.type,
-        sourceData: hack.sourceData,
-        // todo - should we pick the required fields from profile rather than the entire object?
-        profile: hack.profile,
-        timeSaved: hack.timeSaved,
-        estimatedTimeSaved: hack.estimatedTimeSaved,
-        shareScope: getShareScope(hack),
-        catalogues: aclToCatalogues(hack.acl)
-    });
-}
-
-function toHackAppMetadataSegments(segments: EnrichedHack['segments']): AppHackMetadata['segments'] {
-    return removeUndefinedFields({
-        favouriteQuote: {
-            id: segments.favouriteQuote.id,
-        },
-        inANutshell: {
-            id: segments.inANutshell.id,
-        },
-        introduction: {
-            id: segments.introduction.id,
-        },
-        insights: segments.insights.map(insight => ({
-            id: insight.id,
-        })),
-        conclusion: {
-            id: segments.conclusion.id,
-        },
-        overview: {
-            id: segments.overview.id,
-        },
-        shareableOverview: {
-            id: segments.shareableOverview.id,
-        },
-        hereAreTheInsights: {
-            id: segments.hereAreTheInsights.id,
-        },
-        putInAction: segments.putInAction && {
-            id: segments.putInAction.id,
-        },
-    });
-}
-
-function getShareScope(hack: {acl: string[]; includeInWebsite: boolean}): 'public' | 'private' {
-    return (hack.includeInWebsite && hackIsInUptimeCatalogue(hack)) ? 'public' : 'private';
-}
-
-function aclToCatalogues(acl: string[]): string[] {
-    return acl
-        .filter(entry => entry.startsWith('catalogue:'))
-        .map(entry => entry.replace('catalogue:', ''));
-}
+import { removeUndefinedFields } from './remove-undefined-fields';
+import { hackIsInUptimeCatalogue } from './access-helper';
+import { EnrichedHack } from '../enriched-hack/enriched-hack';
+import { AppHackMetadata } from '../app-hack/app-hack-metadata';
+
+export function mapToAppHackMetadata(hack: EnrichedHack): AppHackMetadata {
+    // This function purposely picks the required fields from the EnrichedHack rather than deleting the unnecessary fields from EnrichedHack
+    // This ensures that if the EnrichedHack model is updated then those extra fields are not returned accidentally.
+    // This means that a service will not reflect any updated fields until it updates this module
+    return removeUndefinedFields({
+        id: hack.id,
+        title: hack.title,
+        owner: hack.owner,
+        v: hack.v,
+        hackVersion: hack.hackVersion,
+        createdAt: hack.createdAt,
+        updatedAt: hack.updatedAt,
+        baseLocaleHackId: hack.baseLocaleHackId,
+        language: hack.language,
+        locale: hack.locale,
+        acl: hack.acl,
+        themeId: hack.theme.id,
+        isHidden: hack.isHidden,
+        editorialTags: hack.editorialTags,
+        coverUrl: hack.coverUrl,
+        description: hack.description,
+        segments: toHackAppMetadataSegments(hack.segments),
+        topics: hack.topics,
+        contributors: hack.contributors,
+        type: hack.type,
+        sourceData: hack.sourceData,
+        // todo - should we pick the required fields from profile rather than the entire object?
+        profile: hack.profile,
+        timeSaved: hack.timeSaved,
+        estimatedTimeSaved: hack.estimatedTimeSaved,
+        shareScope: getShareScope(hack),
+        catalogues: aclToCatalogues(hack.acl)
+    });
+}
+
+function toHackAppMetadataSegments(segments: EnrichedHack['segments']): AppHackMetadata['segments'] {
+    return removeUndefinedFields({
+        favouriteQuote: {
+            id: segments.favouriteQuote.id,
+        },
+        inANutshell: {
+            id: segments.inANutshell.id,
+        },
+        introduction: {
+            id: segments.introduction.id,
+        },
+        insights: segments.insights.map(insight => ({
+            id: insight.id,
+        })),
+        conclusion: {
+            id: segments.conclusion.id,
+        },
+        overview: {
+            id: segments.overview.id,
+        },
+        shareableOverview: {
+            id: segments.shareableOverview.id,
+        },
+        hereAreTheInsights: {
+            id: segments.hereAreTheInsights.id,
+        },
+        putInAction: segments.putInAction && {
+            id: segments.putInAction.id,
+        },
+    });
+}
+
+function getShareScope(hack: {acl: string[]; includeInWebsite: boolean}): 'public' | 'private' {
+    return (hack.includeInWebsite && hackIsInUptimeCatalogue(hack)) ? 'public' : 'private';
+}
+
+function aclToCatalogues(acl: string[]): string[] {
+    return acl
+        .filter(entry => entry.startsWith('catalogue:'))
+        .map(entry => entry.replace('catalogue:', ''));
+}

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

@@ -1,11 +1,11 @@
-import { EnrichedHack } from '@uptime.app/contracts';
-import ENRICHED_HACK from './test-data/enriched-hack.json';
-import EXPECTED_APP_RESTRICTED_HACK from './test-data/expected-app-restricted-hack.json';
-import { mapToAppRestrictedHack } from './app-restricted-hack';
-describe('converting an EnrichedHack to an AppRestrictedHack', () => {
-    test('it returns the expected fields', () => {
-        const enrichedHackData = ENRICHED_HACK as any as EnrichedHack;
-        const restrictedHack = mapToAppRestrictedHack(enrichedHackData);
-        expect(restrictedHack).toEqual(EXPECTED_APP_RESTRICTED_HACK);
-    });
-});
+import { EnrichedHack } from '@uptime.app/contracts';
+import ENRICHED_HACK from './test-data/enriched-hack.json';
+import EXPECTED_APP_RESTRICTED_HACK from './test-data/expected-app-restricted-hack.json';
+import { mapToAppRestrictedHack } from './app-restricted-hack';
+describe('converting an EnrichedHack to an AppRestrictedHack', () => {
+    test('it returns the expected fields', () => {
+        const enrichedHackData = ENRICHED_HACK as any as EnrichedHack;
+        const restrictedHack = mapToAppRestrictedHack(enrichedHackData);
+        expect(restrictedHack).toEqual(EXPECTED_APP_RESTRICTED_HACK);
+    });
+});

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

@@ -1,21 +1,21 @@
-import { AppRestrictedHack } from '../app-hack/app-restricted-hack';
-import { EnrichedHack } from '../enriched-hack/enriched-hack';
-import { mapToAppHackMetadata } from './app-hack-metadata';
-import { removeUndefinedFields } from './remove-undefined-fields';
-
-export function mapToAppRestrictedHack(hack: EnrichedHack): AppRestrictedHack {
-    const appHack = mapToAppHackMetadata(hack);
-    // only allow access to the shareableOverview and overview segment
-    const segments:  AppRestrictedHack['segments'] = {
-        ...appHack.segments,
-        shareableOverview: hack.segments.shareableOverview,
-        overview: hack.segments.overview
-    };
-    return removeUndefinedFields({
-        ...appHack,
-        segments,
-        theme: hack.theme,
-        affiliate: hack.affiliate,
-        externalLink: hack.externalLink,
-    });
-}
+import { AppRestrictedHack } from '../app-hack/app-restricted-hack';
+import { EnrichedHack } from '../enriched-hack/enriched-hack';
+import { mapToAppHackMetadata } from './app-hack-metadata';
+import { removeUndefinedFields } from './remove-undefined-fields';
+
+export function mapToAppRestrictedHack(hack: EnrichedHack): AppRestrictedHack {
+    const appHack = mapToAppHackMetadata(hack);
+    // only allow access to the shareableOverview and overview segment
+    const segments:  AppRestrictedHack['segments'] = {
+        ...appHack.segments,
+        shareableOverview: hack.segments.shareableOverview,
+        overview: hack.segments.overview
+    };
+    return removeUndefinedFields({
+        ...appHack,
+        segments,
+        theme: hack.theme,
+        affiliate: hack.affiliate,
+        externalLink: hack.externalLink,
+    });
+}

package/src/hack-mapping/remove-undefined-fields.ts

@@ -1,9 +1,9 @@
-export function removeUndefinedFields<T>(obj: T): T {
-    return Object.keys(obj as any).reduce((acc, key) => {
-        const val = (obj as any)[key];
-        if (val !== undefined) {
-            (acc as any)[key] = val;
-        }
-        return acc;
-    }, {}) as any;
-}
+export function removeUndefinedFields<T>(obj: T): T {
+    return Object.keys(obj as any).reduce((acc, key) => {
+        const val = (obj as any)[key];
+        if (val !== undefined) {
+            (acc as any)[key] = val;
+        }
+        return acc;
+    }, {}) as any;
+}