element-web/src/utils/permalinks/PermalinkConstructor.ts

/*
Copyright 2019, 2021 The Matrix.org Foundation C.I.C.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

/**
 * Interface for classes that actually produce permalinks (strings).
 * TODO: Convert this to a real TypeScript interface
 */
export default class PermalinkConstructor {
    public forEvent(roomId: string, eventId: string, serverCandidates: string[] = []): string {
        throw new Error("Not implemented");
    }

    public forRoom(roomIdOrAlias: string, serverCandidates: string[] = []): string {
        throw new Error("Not implemented");
    }

    public forUser(userId: string): string {
        throw new Error("Not implemented");
    }

    public forEntity(entityId: string): string {
        throw new Error("Not implemented");
    }

    public isPermalinkHost(host: string): boolean {
        throw new Error("Not implemented");
    }

    public parsePermalink(fullUrl: string): PermalinkParts {
        throw new Error("Not implemented");
    }
}

// Inspired by/Borrowed with permission from the matrix-bot-sdk:
// https://github.com/turt2live/matrix-js-bot-sdk/blob/7c4665c9a25c2c8e0fe4e509f2616505b5b66a1c/src/Permalinks.ts#L1-L6
export class PermalinkParts {
    public constructor(
        public readonly roomIdOrAlias: string | null,
        public readonly eventId: string | null,
        public readonly userId: string | null,
        public readonly viaServers: string[] | null,
    ) {}

    public static forUser(userId: string): PermalinkParts {
        return new PermalinkParts(null, null, userId, null);
    }

    public static forRoom(roomIdOrAlias: string, viaServers: string[] = []): PermalinkParts {
        return new PermalinkParts(roomIdOrAlias, null, null, viaServers);
    }

    public static forEvent(roomId: string, eventId: string, viaServers: string[] = []): PermalinkParts {
        return new PermalinkParts(roomId, eventId, null, viaServers);
    }

    public get primaryEntityId(): string | null {
        return this.roomIdOrAlias || this.userId;
    }
}