@uptime.app/contracts 3.0.54 → 3.0.55

package/src/user-acl/user-acl-utils.test.ts

@@ -1,273 +0,0 @@
-import { parseAclEntry, getAclValuesByNamespace, aclFor, UserAclBuilder } from './user-acl-utils';
-
-describe('parseAclEntry', () => {
-
-    test('returns null for empty string', () => {
-        expect(parseAclEntry('')).toBeNull();
-    });
-
-    test('returns null for whitespace-only string', () => {
-        expect(parseAclEntry('   ')).toBeNull();
-    });
-
-    test('parses a simple namespace-only entry', () => {
-        expect(parseAclEntry('public')).toEqual({
-            raw: 'public',
-            excluded: false,
-            namespace: 'public',
-            value: null
-        });
-    });
-
-    test('parses a namespace:value entry', () => {
-        expect(parseAclEntry('catalogue:uptime')).toEqual({
-            raw: 'catalogue:uptime',
-            excluded: false,
-            namespace: 'catalogue',
-            value: 'uptime'
-        });
-    });
-
-    test('parses an excluded namespace-only entry', () => {
-        expect(parseAclEntry('!public')).toEqual({
-            raw: '!public',
-            excluded: true,
-            namespace: 'public',
-            value: null
-        });
-    });
-
-    test('parses an excluded namespace:value entry', () => {
-        expect(parseAclEntry('!catalogue:uptime')).toEqual({
-            raw: '!catalogue:uptime',
-            excluded: true,
-            namespace: 'catalogue',
-            value: 'uptime'
-        });
-    });
-
-    test('trims leading and trailing whitespace', () => {
-        expect(parseAclEntry('  catalogue:uptime  ')).toEqual({
-            raw: 'catalogue:uptime',
-            excluded: false,
-            namespace: 'catalogue',
-            value: 'uptime'
-        });
-    });
-
-    test('returns null when namespace is empty (entry starts with colon)', () => {
-        expect(parseAclEntry(':value')).toBeNull();
-    });
-
-    test('preserves colons in value', () => {
-        expect(parseAclEntry('catalogue:b2b:org-123')).toEqual({
-            raw: 'catalogue:b2b:org-123',
-            excluded: false,
-            namespace: 'catalogue',
-            value: 'b2b:org-123'
-        });
-    });
-});
-
-describe('getAclValuesByNamespace', () => {
-    const acl = [
-        'public',
-        'catalogue:uptime',
-        'catalogue:premium',
-        '!catalogue:restricted',
-        'b2b:org-1',
-        '!b2b:org-2',
-        'user:user-123'
-    ];
-
-    test('returns included values for a namespace by default', () => {
-        expect(getAclValuesByNamespace(acl, 'catalogue')).toEqual(['uptime', 'premium']);
-    });
-
-    test('returns excluded values when mode is "excluded"', () => {
-        expect(getAclValuesByNamespace(acl, 'catalogue', { mode: 'excluded' })).toEqual(['restricted']);
-    });
-
-    test('returns all values when mode is "all"', () => {
-        expect(getAclValuesByNamespace(acl, 'catalogue', { mode: 'all' })).toEqual(['uptime', 'premium', 'restricted']);
-    });
-
-    test('returns empty array when namespace has no matches', () => {
-        expect(getAclValuesByNamespace(acl, 'subject')).toEqual([]);
-    });
-
-    test('deduplicates values by default', () => {
-        const aclWithDupes = ['catalogue:uptime', 'catalogue:uptime', 'catalogue:premium'];
-        expect(getAclValuesByNamespace(aclWithDupes, 'catalogue')).toEqual(['uptime', 'premium']);
-    });
-
-    test('preserves duplicates when dedupe is false', () => {
-        const aclWithDupes = ['catalogue:uptime', 'catalogue:uptime', 'catalogue:premium'];
-        expect(getAclValuesByNamespace(aclWithDupes, 'catalogue', { dedupe: false })).toEqual(['uptime', 'uptime', 'premium']);
-    });
-
-    test('excludes namespace-only entries (no value)', () => {
-        expect(getAclValuesByNamespace(acl, 'public')).toEqual([]);
-    });
-
-    test('returns empty array for empty acl', () => {
-        expect(getAclValuesByNamespace([], 'catalogue')).toEqual([]);
-    });
-
-    test('skips invalid entries', () => {
-        const aclWithInvalid = ['', '   ', 'catalogue:uptime'];
-        expect(getAclValuesByNamespace(aclWithInvalid, 'catalogue')).toEqual(['uptime']);
-    });
-});
-
-describe('UserAclBuilder', () => {
-
-    test('does not include "public" by default', () => {
-        const acl = new UserAclBuilder().build();
-        expect(acl).not.toContain('public');
-    });
-
-    test('includes "public" when allowPublic is called', () => {
-        const acl = new UserAclBuilder().allowPublic().build();
-        expect(acl).toContain('public');
-    });
-
-    test('includes user entry when allowUser is called', () => {
-        const acl = new UserAclBuilder().allowUser('user-123').build();
-        expect(acl).toContain('user:user-123');
-    });
-
-    test('merges baseAcl entries', () => {
-        const acl = new UserAclBuilder({ baseAcl: ['catalogue:uptime', '!catalogue:restricted'] }).build();
-        expect(acl).toContain('catalogue:uptime');
-        expect(acl).toContain('!catalogue:restricted');
-    });
-
-    describe('allow', () => {
-        test('adds namespace:value entry', () => {
-            const acl = new UserAclBuilder().allow('catalogue', 'uptime').build();
-            expect(acl).toContain('catalogue:uptime');
-        });
-
-        test('adds namespace-only entry when no value provided', () => {
-            const acl = new UserAclBuilder().allow('public').build();
-            expect(acl).toContain('public');
-        });
-
-        test('removes entry from excluded when allowed', () => {
-            const acl = new UserAclBuilder()
-                .deny('catalogue', 'uptime')
-                .allow('catalogue', 'uptime')
-                .build();
-            expect(acl).toContain('catalogue:uptime');
-            expect(acl).not.toContain('!catalogue:uptime');
-        });
-    });
-
-    describe('deny', () => {
-        test('adds excluded namespace:value entry', () => {
-            const acl = new UserAclBuilder().deny('catalogue', 'restricted').build();
-            expect(acl).toContain('!catalogue:restricted');
-        });
-
-        test('removes entry from included when denied', () => {
-            const acl = new UserAclBuilder()
-                .allow('catalogue', 'uptime')
-                .deny('catalogue', 'uptime')
-                .build();
-            expect(acl).not.toContain('catalogue:uptime');
-            expect(acl).toContain('!catalogue:uptime');
-        });
-    });
-
-    describe('allowCatalogue', () => {
-        test('adds catalogue:<id> entry', () => {
-            const acl = new UserAclBuilder().allowCatalogue('premium').build();
-            expect(acl).toContain('catalogue:premium');
-        });
-    });
-
-    describe('denyCatalogue', () => {
-        test('adds !catalogue:<id> entry', () => {
-            const acl = new UserAclBuilder().denyCatalogue('restricted').build();
-            expect(acl).toContain('!catalogue:restricted');
-        });
-    });
-
-    describe('allowOrganisation', () => {
-        test('adds b2b:<id> entry', () => {
-            const acl = new UserAclBuilder().allowOrganisation('org-1').build();
-            expect(acl).toContain('b2b:org-1');
-        });
-    });
-
-    describe('denySubject', () => {
-        test('adds !subject:<value> entry', () => {
-            const acl = new UserAclBuilder().denySubject('some-topic').build();
-            expect(acl).toContain('!subject:some-topic');
-        });
-    });
-
-    describe('addRaw', () => {
-        test('adds an included raw entry', () => {
-            const acl = new UserAclBuilder().addRaw('catalogue:uptime').build();
-            expect(acl).toContain('catalogue:uptime');
-        });
-
-        test('adds an excluded raw entry', () => {
-            const acl = new UserAclBuilder().addRaw('!catalogue:restricted').build();
-            expect(acl).toContain('!catalogue:restricted');
-        });
-
-        test('ignores invalid raw entries', () => {
-            const acl = new UserAclBuilder().addRaw('').build();
-            expect(acl).toEqual([]);
-        });
-    });
-
-    describe('addMany', () => {
-        test('adds multiple entries at once', () => {
-            const acl = new UserAclBuilder()
-                .addMany(['catalogue:uptime', 'b2b:org-1', '!catalogue:restricted'])
-                .build();
-            expect(acl).toContain('catalogue:uptime');
-            expect(acl).toContain('b2b:org-1');
-            expect(acl).toContain('!catalogue:restricted');
-        });
-    });
-});
-
-describe('aclFor', () => {
-    test('includes user entry', () => {
-        const acl = aclFor({ userId: 'user-abc', organisationIds: [], catalogueIds: [] });
-        expect(acl).toContain('user:user-abc');
-    });
-
-    test('always includes catalogue:uptime', () => {
-        const acl = aclFor({ userId: 'user-abc', organisationIds: [], catalogueIds: [] });
-        expect(acl).toContain('catalogue:uptime');
-    });
-
-    test('includes provided catalogue ids', () => {
-        const acl = aclFor({ userId: 'user-abc', organisationIds: [], catalogueIds: ['premium', 'free'] });
-        expect(acl).toContain('catalogue:premium');
-        expect(acl).toContain('catalogue:free');
-    });
-
-    test('includes b2b catalogue entry for each organisation', () => {
-        const acl = aclFor({ userId: 'user-abc', organisationIds: ['org-1', 'org-2'], catalogueIds: [] });
-        expect(acl).toContain('catalogue:b2b:org-1');
-        expect(acl).toContain('catalogue:b2b:org-2');
-    });
-
-    test('includes b2b namespace entry for each organisation', () => {
-        const acl = aclFor({ userId: 'user-abc', organisationIds: ['org-1', 'org-2'], catalogueIds: [] });
-        expect(acl).toContain('b2b:org-1');
-        expect(acl).toContain('b2b:org-2');
-    });
-
-    test('includes public by default', () => {
-        const acl = aclFor({ userId: 'user-abc', organisationIds: [], catalogueIds: [] });
-        expect(acl).toContain('public');
-    });
-});

package/src/user-acl/user-acl-utils.ts

@@ -1,177 +0,0 @@
-export type AclQueryMode = 'included' | 'excluded' | 'all';
-
-export interface ParsedAclEntry {
-    raw: string;
-    excluded: boolean;
-    namespace: string;
-    value: string | null;
-}
-
-export interface GetAclValuesOptions {
-    mode?: AclQueryMode;
-    dedupe?: boolean;
-}
-
-export interface BuildAclOptions {
-    baseAcl?: string[];
-}
-
-function normalizeAclEntry(entry: string): string {
-    return entry.trim();
-}
-
-export function parseAclEntry(entry: string): ParsedAclEntry | null {
-    const raw = normalizeAclEntry(entry);
-    if (!raw) {
-        return null;
-    }
-
-    const excluded = raw.startsWith('!');
-    const token = excluded ? raw.slice(1) : raw;
-    const firstColonIndex = token.indexOf(':');
-
-    if (firstColonIndex === -1) {
-        return {
-            raw,
-            excluded,
-            namespace: token,
-            value: null
-        };
-    }
-
-    const namespace = token.slice(0, firstColonIndex);
-    const value = token.slice(firstColonIndex + 1);
-
-    if (!namespace) {
-        return null;
-    }
-
-    return {
-        raw,
-        excluded,
-        namespace,
-        value
-    };
-}
-
-export function getAclValuesByNamespace(
-    acl: string[],
-    namespace: string,
-    options: GetAclValuesOptions = {}
-): string[] {
-    const mode = options.mode ?? 'included';
-    const dedupe = options.dedupe ?? true;
-
-    const values = acl
-        .map(parseAclEntry)
-        .filter((entry): entry is ParsedAclEntry => Boolean(entry))
-        .filter(entry => entry.namespace === namespace)
-        .filter(entry => entry.value !== null)
-        .filter(entry => {
-            if (mode === 'all') {
-                return true;
-            }
-            if (mode === 'included') {
-                return !entry.excluded;
-            }
-            return entry.excluded;
-        })
-        .map(entry => entry.value as string);
-
-    return dedupe ? Array.from(new Set(values)) : values;
-}
-
-export function aclFor({ userId, organisationIds, catalogueIds }: { userId: string; organisationIds: string[]; catalogueIds: string[] }) {
-    const builder = new UserAclBuilder()
-        .allowPublic()
-        .allowUser(userId);
-
-    // everyone has access to the uptime catalogue
-    builder.allowCatalogue('uptime');
-
-    catalogueIds.forEach(catalogueId => builder.allowCatalogue(catalogueId));
-
-    // each b2b has a catalogue called b2b:<organisationId> so permit access to this
-    organisationIds.forEach(organisationId => builder.allowCatalogue(`b2b:${organisationId}`));
-
-    // previously we also had acl of b2b:<organisationId> that is still being used for collections
-    organisationIds.forEach(organisationId => builder.allowOrganisation(organisationId));
-
-    return builder.build();
-}
-
-export class UserAclBuilder {
-    private included = new Set<string>();
-    private excluded = new Set<string>();
-
-    constructor(options: BuildAclOptions = {}) {
-        if (options.baseAcl?.length) {
-            this.addMany(options.baseAcl);
-        }
-    }
-
-    addRaw(entry: string): this {
-        const parsed = parseAclEntry(entry);
-        if (!parsed) {
-            return this;
-        }
-
-        if (parsed.excluded) {
-            this.excluded.add(parsed.raw.slice(1));
-        } else {
-            this.included.add(parsed.raw);
-        }
-
-        return this;
-    }
-
-    addMany(entries: string[]): this {
-        entries.forEach(entry => this.addRaw(entry));
-        return this;
-    }
-
-    allow(namespace: string, value?: string): this {
-        const token = value === undefined ? namespace : `${namespace}:${value}`;
-        this.included.add(token);
-        this.excluded.delete(token);
-        return this;
-    }
-
-    deny(namespace: string, value?: string): this {
-        const token = value === undefined ? namespace : `${namespace}:${value}`;
-        this.excluded.add(token);
-        this.included.delete(token);
-        return this;
-    }
-
-    allowCatalogue(catalogueId: string): this {
-        return this.allow('catalogue', catalogueId);
-    }
-
-    allowPublic(): this {
-        return this.allow('public');
-    }
-
-    allowUser(userId: string): this {
-        return this.allow('user', userId);
-    }
-
-    denyCatalogue(catalogueId: string): this {
-        return this.deny('catalogue', catalogueId);
-    }
-
-    allowOrganisation(organisationId: string): this {
-        return this.allow('b2b', organisationId);
-    }
-
-    denySubject(subject: string): this {
-        return this.deny('subject', subject);
-    }
-
-    build(): string[] {
-        return [
-            ...this.included,
-            ...Array.from(this.excluded).map(token => `!${token}`)
-        ];
-    }
-}

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

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

@@ -1,16 +0,0 @@
-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[];
-    partnerId?: string;
-    brandId?: string;
-    skinId?: string;
-}

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

@@ -1,21 +0,0 @@
-import { UserNotificationContext } from './user-notification-context';
-
-export interface UserNotificationContextCreatedEvent {
-    id: string;
-    type: 'UserNotificationContextCreated';
-    payload: UserNotificationContext;
-}
-
-export interface UserNotificationContextUpdatedEvent {
-    id: string;
-    type: 'UserNotificationContextUpdated';
-    payload: UserNotificationContext;
-}
-
-export interface UserNotificationContextDeletedEvent {
-    id: string;
-    type: 'UserNotificationContextDeleted';
-    payload: UserNotificationContext;
-}
-
-export type UserNotificationContextChangedEvent = UserNotificationContextCreatedEvent | UserNotificationContextUpdatedEvent | UserNotificationContextDeletedEvent;

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

@@ -1,10 +0,0 @@
-export interface UserNotificationContext {
-    id: string;
-    userId: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    skinId: string;
-    brandId?: string;
-    translationVariation: string;
-}

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

@@ -1,97 +0,0 @@
-import { DailyInsightCompleted, StreakRepair, UserHackStatistics, UserInsightStreak, ViewedHack } from './user-statistics';
-
-export interface DailyInsightCompletedCreatedEvent {
-    id: string;
-    type: 'DailyInsightCompletedCreated';
-    payload: DailyInsightCompleted;
-}
-
-export interface DailyInsightCompletedUpdatedEvent {
-    id: string;
-    type: 'DailyInsightCompletedUpdated';
-    payload: DailyInsightCompleted;
-}
-
-export interface DailyInsightCompletedDeletedEvent {
-    id: string;
-    type: 'DailyInsightCompletedDeleted';
-    payload: DailyInsightCompleted;
-}
-
-export interface StreakRepairCreatedEvent {
-    id: string;
-    type: 'StreakRepairCreated';
-    payload: StreakRepair;
-}
-
-export interface StreakRepairUpdatedEvent {
-    id: string;
-    type: 'StreakRepairUpdated';
-    payload: StreakRepair;
-}
-
-export interface StreakRepairDeletedEvent {
-    id: string;
-    type: 'StreakRepairDeleted';
-    payload: StreakRepair;
-}
-
-export interface UserHackStatisticsCreatedEvent {
-    id: string;
-    type: 'UserHackStatisticsCreated';
-    payload: UserHackStatistics;
-}
-
-export interface UserHackStatisticsUpdatedEvent {
-    id: string;
-    type: 'UserHackStatisticsUpdated';
-    payload: UserHackStatistics;
-}
-
-export interface UserHackStatisticsDeletedEvent {
-    id: string;
-    type: 'UserHackStatisticsDeleted';
-    payload: UserHackStatistics;
-}
-
-export interface UserInsightStreakCreatedEvent {
-    id: string;
-    type: 'UserInsightStreakCreated';
-    payload: UserInsightStreak;
-}
-
-export interface UserInsightStreakUpdatedEvent {
-    id: string;
-    type: 'UserInsightStreakUpdated';
-    payload: UserInsightStreak;
-}
-
-export interface UserInsightStreakDeletedEvent {
-    id: string;
-    type: 'UserInsightStreakDeleted';
-    payload: UserInsightStreak;
-}
-
-export interface ViewedHackCreatedEvent {
-    id: string;
-    type: 'ViewedHackCreated';
-    payload: ViewedHack;
-}
-
-export interface ViewedHackUpdatedEvent {
-    id: string;
-    type: 'ViewedHackUpdated';
-    payload: ViewedHack;
-}
-
-export interface ViewedHackDeletedEvent {
-    id: string;
-    type: 'ViewedHackDeleted';
-    payload: ViewedHack;
-}
-
-export type DailyInsightCompletedChangedEvent = DailyInsightCompletedCreatedEvent | DailyInsightCompletedUpdatedEvent | DailyInsightCompletedDeletedEvent;
-export type StreakRepairChangedEvent = StreakRepairCreatedEvent | StreakRepairUpdatedEvent | StreakRepairDeletedEvent;
-export type UserHackStatisticsChangedEvent = UserHackStatisticsCreatedEvent | UserHackStatisticsUpdatedEvent | UserHackStatisticsDeletedEvent;
-export type UserInsightStreakChangedEvent = UserInsightStreakCreatedEvent | UserInsightStreakUpdatedEvent | UserInsightStreakDeletedEvent;
-export type ViewedHackChangedEvent = ViewedHackCreatedEvent | ViewedHackUpdatedEvent | ViewedHackDeletedEvent;

package/src/user-statistics/user-statistics.ts

@@ -1,82 +0,0 @@
-export interface ViewedHack {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    userId: string;
-    hackId: string;
-    isHackCompleted: boolean;
-    insightsCompletedCount: number;
-    /** added Aug 2023 */
-    percentageComplete: number;
-    /** added Aug 2023 */
-    lastViewedAt: string;
-    hackProgress: {
-        id: string;
-        version: number;
-        createdAt: string;
-    }
-}
-
-export interface UserInsightStreak {
-    userId: string;
-    v: number;
-    id: string; // deterministic from userId
-    createdAt: string;
-    updatedAt: string;
-    longestStreak: {
-        length: number;
-    },
-    latestStreak: {
-        // date with format YYYY-MM-DD
-        latestDayCompleted: string;
-        length: number;
-    },
-    previousStreak: {
-        length: number;
-    },
-    // 30 dates with format YYYY-MM-DD
-    latestDaysCompleted: string[];
-    repairs?: {
-        usedThisMonthCount: number;
-    }
-}
-
-export interface UserHackStatistics {
-    userId: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-
-    id: string; // deterministic from userId
-    insightsCompletedCount: number;
-    hacksCompletedCount: number;
-    /** Time saved in minutes. Added Aug 2023 */
-    totalTimeSaved: number;
-    perTopic?: PerTopicStatistics[]
-}
-
-export interface PerTopicStatistics {
-    name: string;
-    insightsCompletedCount: number;
-}
-
-export interface StreakRepair {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    userId: string;
-    repairDate_streakType : string;
-    repairDate: string;
-    streakType: string;
-}
-
-export interface DailyInsightCompleted {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    userId: string;
-    dateInsightCompleted: string;
-}