a80e55d38d
* add helpers for beacon duration calculations Signed-off-by: Kerry Archibald <kerrya@element.io> * makeBeaconInfoEvent timestsamp prop Signed-off-by: Kerry Archibald <kerrya@element.io> * ad copyright Signed-off-by: Kerry Archibald <kerrya@element.io>
122 lines
3.3 KiB
TypeScript
122 lines
3.3 KiB
TypeScript
/*
|
|
Copyright 2022 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.
|
|
*/
|
|
|
|
import { makeBeaconInfoContent, makeBeaconContent } from "matrix-js-sdk/src/content-helpers";
|
|
import { MatrixEvent } from "matrix-js-sdk/src/matrix";
|
|
import { M_BEACON, M_BEACON_INFO } from "matrix-js-sdk/src/@types/beacon";
|
|
import { LocationAssetType } from "matrix-js-sdk/src/@types/location";
|
|
|
|
type InfoContentProps = {
|
|
timeout: number;
|
|
isLive?: boolean;
|
|
assetType?: LocationAssetType;
|
|
description?: string;
|
|
timestamp?: number;
|
|
};
|
|
const DEFAULT_INFO_CONTENT_PROPS: InfoContentProps = {
|
|
timeout: 3600000,
|
|
};
|
|
|
|
let count = 1;
|
|
|
|
/**
|
|
* Create an m.beacon_info event
|
|
* all required properties are mocked
|
|
* override with contentProps
|
|
*/
|
|
export const makeBeaconInfoEvent = (
|
|
sender: string,
|
|
roomId: string,
|
|
contentProps: Partial<InfoContentProps> = {},
|
|
eventId?: string,
|
|
): MatrixEvent => {
|
|
const {
|
|
timeout,
|
|
isLive,
|
|
description,
|
|
assetType,
|
|
timestamp,
|
|
} = {
|
|
...DEFAULT_INFO_CONTENT_PROPS,
|
|
...contentProps,
|
|
};
|
|
const event = new MatrixEvent({
|
|
type: `${M_BEACON_INFO.name}.${sender}.${++count}`,
|
|
room_id: roomId,
|
|
state_key: sender,
|
|
content: makeBeaconInfoContent(timeout, isLive, description, assetType, timestamp),
|
|
});
|
|
|
|
// live beacons use the beacon_info event id
|
|
// set or default this
|
|
event.replaceLocalEventId(eventId || `$${Math.random()}-${Math.random()}`);
|
|
|
|
return event;
|
|
};
|
|
|
|
type ContentProps = {
|
|
geoUri: string;
|
|
timestamp: number;
|
|
beaconInfoId: string;
|
|
description?: string;
|
|
};
|
|
const DEFAULT_CONTENT_PROPS: ContentProps = {
|
|
geoUri: 'geo:-36.24484561954707,175.46884959563613;u=10',
|
|
timestamp: 123,
|
|
beaconInfoId: '$123',
|
|
};
|
|
|
|
/**
|
|
* Create an m.beacon event
|
|
* all required properties are mocked
|
|
* override with contentProps
|
|
*/
|
|
export const makeBeaconEvent = (
|
|
sender: string,
|
|
contentProps: Partial<ContentProps> = {},
|
|
): MatrixEvent => {
|
|
const { geoUri, timestamp, beaconInfoId, description } = {
|
|
...DEFAULT_CONTENT_PROPS,
|
|
...contentProps,
|
|
};
|
|
|
|
return new MatrixEvent({
|
|
type: M_BEACON.name,
|
|
sender,
|
|
content: makeBeaconContent(geoUri, timestamp, beaconInfoId, description),
|
|
});
|
|
};
|
|
|
|
/**
|
|
* Create a mock geolocation position
|
|
* defaults all required properties
|
|
*/
|
|
export const makeGeolocationPosition = (
|
|
{ timestamp, coords }:
|
|
{ timestamp?: number, coords: Partial<GeolocationCoordinates> },
|
|
): GeolocationPosition => ({
|
|
timestamp: timestamp ?? 1647256791840,
|
|
coords: {
|
|
accuracy: 1,
|
|
latitude: 54.001927,
|
|
longitude: -8.253491,
|
|
altitude: null,
|
|
altitudeAccuracy: null,
|
|
heading: null,
|
|
speed: null,
|
|
...coords,
|
|
},
|
|
});
|