@formant/data-sdk 0.0.140 → 0.0.141

package/dist/types/data-sdk/src/model/IFilter.d.ts

@@ -1,10 +0,0 @@
-import { StreamType } from "./StreamType";
-import { ITagSets } from "./ITagSets";
-import { Uuid } from "./Uuid";
-export interface IFilter {
-    deviceIds?: Uuid[];
-    names?: string[];
-    types?: StreamType[];
-    tags?: ITagSets;
-    notNames?: string[];
-}

package/dist/types/data-sdk/src/model/IGoal.d.ts

@@ -1,5 +0,0 @@
-import { ITransform } from "./ITransform";
-export interface IGoal {
-    worldToLocal: ITransform;
-    pose: ITransform;
-}

package/dist/types/data-sdk/src/model/IGoalID.d.ts

@@ -1,3 +0,0 @@
-export interface IGoalID {
-    id?: string;
-}

package/dist/types/data-sdk/src/model/IHealth.d.ts

@@ -1,4 +0,0 @@
-import { HealthStatus } from "./HealthStatus";
-export interface IHealth {
-    status: HealthStatus;
-}

package/dist/types/data-sdk/src/model/IImage.d.ts

@@ -1,6 +0,0 @@
-import { IImageAnnotation } from "./IImageAnnotation";
-export interface IImage {
-    url: string;
-    size?: number;
-    annotations?: IImageAnnotation[];
-}

package/dist/types/data-sdk/src/model/IImageAnnotation.d.ts

@@ -1,9 +0,0 @@
-import { AnnotationAreaType } from "./AnnotationAreaType";
-import { HexRgbColor } from "./HexRgbColor";
-import { IAnnotationAreaTypeMap } from "./IAnnotationAreaTypeMap";
-export interface IImageAnnotation<T extends AnnotationAreaType = AnnotationAreaType> {
-    label: string;
-    type: AnnotationAreaType;
-    area: IAnnotationAreaTypeMap[T];
-    color: HexRgbColor;
-}

package/dist/types/data-sdk/src/model/IInterventionRequest.d.ts

@@ -1,9 +0,0 @@
-import { IBaseEvent } from "./IBaseEvent";
-import { IInterventionResponse } from "./IInterventionResponse";
-import { IInterventionTypeMap } from "./IInterventionTypeMap";
-import { InterventionType } from "./InterventionType";
-export interface IInterventionRequest<T extends InterventionType = InterventionType> extends IBaseEvent<"intervention-request"> {
-    interventionType: T;
-    data: IInterventionTypeMap[T]["request"];
-    responses?: IInterventionResponse<T>[];
-}

package/dist/types/data-sdk/src/model/IInterventionResponse.d.ts

@@ -1,10 +0,0 @@
-import { IBaseEntity } from "./IBaseEntity";
-import { IInterventionTypeMap } from "./IInterventionTypeMap";
-import { InterventionType } from "./InterventionType";
-import { Uuid } from "./Uuid";
-export interface IInterventionResponse<T extends InterventionType = InterventionType> extends IBaseEntity {
-    userId?: Uuid;
-    interventionId: Uuid;
-    interventionType: T;
-    data: IInterventionTypeMap[T]["response"];
-}

package/dist/types/data-sdk/src/model/IInterventionTypeMap.d.ts

@@ -1,20 +0,0 @@
-import { ILabelingRequestData } from "./ILabelingRequestData";
-import { ILabelingResponseData } from "./ILabelingResponseData";
-import { ISelectionRequestData } from "./ISelectionRequestData";
-import { ISelectionResponseData } from "./ISelectionResponseData";
-import { ITeleopRequestData } from "./ITeleopRequestData";
-import { ITeleopResponseData } from "./ITeleopResponseData";
-export interface IInterventionTypeMap {
-    selection: {
-        request: ISelectionRequestData;
-        response: ISelectionResponseData;
-    };
-    labeling: {
-        request: ILabelingRequestData;
-        response: ILabelingResponseData;
-    };
-    teleop: {
-        request: ITeleopRequestData;
-        response: ITeleopResponseData;
-    };
-}

package/dist/types/data-sdk/src/model/ILabel.d.ts

@@ -1,4 +0,0 @@
-export interface ILabel {
-    value: string;
-    displayName?: string;
-}

package/dist/types/data-sdk/src/model/ILabeledPolygon.d.ts

@@ -1,4 +0,0 @@
-export interface ILabeledPolygon {
-    vertices: [number, number][];
-    labels: string[];
-}

package/dist/types/data-sdk/src/model/ILabelingRequestData.d.ts

@@ -1,8 +0,0 @@
-import { ILabel } from "./ILabel";
-import { ILabeledPolygon } from "./ILabeledPolygon";
-export interface ILabelingRequestData {
-    instruction: string;
-    imageUrl: string;
-    labels: ILabel[];
-    hint?: ILabeledPolygon[];
-}

package/dist/types/data-sdk/src/model/ILabelingResponseData.d.ts

@@ -1,4 +0,0 @@
-import { ILabeledPolygon } from "./ILabeledPolygon";
-export interface ILabelingResponseData {
-    value: ILabeledPolygon[];
-}

package/dist/types/data-sdk/src/model/ILocalization.d.ts

@@ -1,14 +0,0 @@
-import { IGoal } from "./IGoal";
-import { IMap } from "./IMap";
-import { IOdometry } from "./IOdometry";
-import { IPath } from "./IPath";
-import { IPointCloud } from "./IPointCloud";
-export interface ILocalization {
-    odometry?: IOdometry;
-    map?: IMap;
-    pointClouds?: IPointCloud[];
-    path?: IPath;
-    goal?: IGoal;
-    url?: string;
-    size?: number;
-}

package/dist/types/data-sdk/src/model/ILocation.d.ts

@@ -1,6 +0,0 @@
-export interface ILocation {
-    latitude: number;
-    longitude: number;
-    altitude?: number;
-    orientation?: number;
-}

package/dist/types/data-sdk/src/model/IMap.d.ts

@@ -1,10 +0,0 @@
-import { ITransform } from "./ITransform";
-export interface IMap {
-    url: string;
-    size?: number;
-    width: number;
-    height: number;
-    resolution: number;
-    origin: ITransform;
-    worldToLocal: ITransform;
-}

package/dist/types/data-sdk/src/model/INumericAggregate.d.ts

@@ -1,7 +0,0 @@
-export interface INumericAggregate {
-    min: number;
-    max: number;
-    sum: number;
-    count: number;
-    sumOfSquares: number;
-}

package/dist/types/data-sdk/src/model/INumericSetAggregateMap.d.ts

@@ -1,5 +0,0 @@
-import { INumericAggregate } from "./INumericAggregate";
-export type INumericSetAggregateMap = Map<string, {
-    value: INumericAggregate;
-    unit?: string;
-}>;

package/dist/types/data-sdk/src/model/INumericSetEntry.d.ts

@@ -1,5 +0,0 @@
-export interface INumericSetEntry {
-    label: string;
-    value: number;
-    unit?: string;
-}

package/dist/types/data-sdk/src/model/IOdometry.d.ts

@@ -1,7 +0,0 @@
-import { ITransform } from "./ITransform";
-import { ITwist } from "./ITwist";
-export interface IOdometry {
-    pose: ITransform;
-    twist: ITwist;
-    worldToLocal: ITransform;
-}

package/dist/types/data-sdk/src/model/IPath.d.ts

@@ -1,5 +0,0 @@
-import { ITransform } from "./ITransform";
-export interface IPath {
-    worldToLocal: ITransform;
-    poses: ITransform[];
-}

package/dist/types/data-sdk/src/model/IPointCloud.d.ts

@@ -1,6 +0,0 @@
-import { ITransform } from "./ITransform";
-export interface IPointCloud {
-    url: string;
-    size?: number;
-    worldToLocal?: ITransform;
-}

package/dist/types/data-sdk/src/model/IPortForwardingSessionRecord.d.ts

@@ -1,3 +0,0 @@
-import { IRtcSessionRecord } from "./IRtcSessionRecord";
-export interface IPortForwardingSessionRecord extends IRtcSessionRecord<"port-forwarding-session-record"> {
-}

package/dist/types/data-sdk/src/model/IQuaternion.d.ts

@@ -1,6 +0,0 @@
-export interface IQuaternion {
-    x: number;
-    y: number;
-    z: number;
-    w: number;
-}

package/dist/types/data-sdk/src/model/IQuery.d.ts

@@ -1,9 +0,0 @@
-import { AggregateLevel } from "./AggregateLevel";
-import { IFilter } from "./IFilter";
-import { IsoDate } from "./IsoDate";
-export interface IQuery extends IFilter {
-    aggregate?: AggregateLevel;
-    start: IsoDate;
-    end: IsoDate;
-    latestOnly?: boolean;
-}

package/dist/types/data-sdk/src/model/IRtcSessionRecord.d.ts

@@ -1,9 +0,0 @@
-import { Uuid } from "./Uuid";
-import { IBaseEvent } from "./IBaseEvent";
-import { IsoDate } from "./IsoDate";
-export interface IRtcSessionRecord<T extends "teleop-session-record" | "port-forwarding-session-record"> extends IBaseEvent<T> {
-    sessionId: Uuid;
-    userId: Uuid;
-    deviceId: Uuid;
-    endTime: IsoDate;
-}

package/dist/types/data-sdk/src/model/IScopeFilter.d.ts

@@ -1,6 +0,0 @@
-import { IFilter } from "./IFilter";
-import { IsoDate } from "./IsoDate";
-export interface IScopeFilter extends IFilter {
-    start?: IsoDate;
-    end?: IsoDate;
-}

package/dist/types/data-sdk/src/model/ISelectionRequestData.d.ts

@@ -1,6 +0,0 @@
-export interface ISelectionRequestData {
-    instruction: string;
-    imageUrl: string;
-    options: string[];
-    hint?: number;
-}

package/dist/types/data-sdk/src/model/ISelectionResponseData.d.ts

@@ -1,3 +0,0 @@
-export interface ISelectionResponseData {
-    value: number;
-}

package/dist/types/data-sdk/src/model/IShare.d.ts

@@ -1,16 +0,0 @@
-import { IBaseEntity } from "./IBaseEntity";
-import { Uuid } from "./Uuid";
-import { IScopeFilter } from "./IScopeFilter";
-import { IsoDate } from "./IsoDate";
-export interface IShare extends IBaseEntity {
-    organizationId?: Uuid;
-    userId?: Uuid;
-    code?: string;
-    scope: IScopeFilter;
-    time: IsoDate;
-    expiration?: IsoDate | null;
-    channelId?: Uuid;
-    message?: string;
-    userName?: string;
-    delegateTeleop?: boolean;
-}

package/dist/types/data-sdk/src/model/ISheetParameters.d.ts

@@ -1,5 +0,0 @@
-export interface ISheetParameters {
-    url?: string;
-    spreadsheetId: string;
-    range: string;
-}

package/dist/types/data-sdk/src/model/ISpreadsheetIdRange.d.ts

@@ -1,4 +0,0 @@
-export interface ISpreadsheetIdRange {
-    spreadsheetId: string;
-    range: string;
-}

package/dist/types/data-sdk/src/model/ISqlColumn.d.ts

@@ -1,6 +0,0 @@
-export interface ISqlColumn {
-    name: string;
-    tableName: string;
-    isNullable?: boolean;
-    dataType: "string" | "timestamp" | "boolean" | "number" | "null";
-}

package/dist/types/data-sdk/src/model/ISqlQuery.d.ts

@@ -1,21 +0,0 @@
-import { IsoDate } from "./IsoDate";
-import { IFilter } from "./IFilter";
-import { AggregateLevel } from "./AggregateLevel";
-import { IStreamColumn } from "./IStreamColumn";
-import { ITaskReportColumn } from "./ITaskReportColumn";
-export interface ISqlQuery extends IFilter {
-    sqlQuery?: string;
-    parameters?: string[];
-    start?: IsoDate;
-    end?: IsoDate;
-    streamColumns?: IStreamColumn[];
-    taskColumns?: ITaskReportColumn[];
-    aggregateLevel?: AggregateLevel;
-    limit?: number;
-    orderByColumn?: string;
-    orderByDescending?: boolean;
-    visibleColumns?: string[];
-    filters?: string[];
-    type?: "stream" | "task" | "advanced";
-    unit?: string;
-}

package/dist/types/data-sdk/src/model/ISqlResult.d.ts

@@ -1,12 +0,0 @@
-import { IAggregateRow } from "./IAggregateRow";
-import { ISqlColumn } from "./ISqlColumn";
-import { ISqlRow } from "./ISqlRow";
-export interface ISqlResult {
-    rows: ISqlRow[];
-    columns: ISqlColumn[];
-    aggregates?: IAggregateRow[];
-    sqlText: string;
-    aggregateSqlText?: string;
-    rowCount: number;
-    unit?: string;
-}

package/dist/types/data-sdk/src/model/ISqlRow.d.ts

@@ -1,5 +0,0 @@
-import { IsoDate } from "./IsoDate";
-export interface ISqlRow {
-    [key: string]: string | IsoDate | number | boolean | null;
-    tableName: string;
-}

package/dist/types/data-sdk/src/model/IStream.d.ts

@@ -1,18 +0,0 @@
-import { IsoDate } from "./IsoDate";
-import { Uuid } from "./Uuid";
-import { StreamType } from "./StreamType";
-export interface IStream {
-    active: boolean;
-    alias: string;
-    createdAt: IsoDate;
-    enabled: boolean;
-    id: Uuid;
-    isEventFilter: boolean;
-    isOverviewColumn: boolean;
-    isOverviewRow: boolean;
-    isTelemetryFilter: boolean;
-    organizationId: Uuid;
-    streamName: string;
-    streamType: StreamType;
-    updatedAt: IsoDate;
-}

package/dist/types/data-sdk/src/model/IStreamAggregateData.d.ts

@@ -1,11 +0,0 @@
-import { IDataAggregate } from "./IDataAggregate";
-import { ITags } from "./ITags";
-import { StreamType } from "./StreamType";
-import { Uuid } from "./Uuid";
-export interface IStreamAggregateData<T extends StreamType = StreamType> {
-    deviceId: Uuid;
-    name: string;
-    type: T;
-    tags: ITags;
-    aggregates: IDataAggregate<T>[];
-}

package/dist/types/data-sdk/src/model/IStreamAggregateTypeMap.d.ts

@@ -1,10 +0,0 @@
-import { INumericAggregate } from "./INumericAggregate";
-import { INumericSetAggregateMap } from "./INumericSetAggregateMap";
-import { StreamType } from "./StreamType";
-export interface ISupportedStreamAggregateTypeMap {
-    "numeric set": INumericSetAggregateMap;
-    numeric: INumericAggregate;
-}
-export type IStreamAggregateTypeMap = Omit<{
-    [_ in StreamType]: undefined;
-}, keyof ISupportedStreamAggregateTypeMap> & ISupportedStreamAggregateTypeMap;

package/dist/types/data-sdk/src/model/IStreamColumn.d.ts

@@ -1,7 +0,0 @@
-import { StreamType } from "./StreamType";
-import { AnalyticsAggregateType } from "./AnalyticsAggregateType";
-export interface IStreamColumn {
-    streamName: string;
-    streamType: StreamType;
-    aggregateType?: AnalyticsAggregateType;
-}

package/dist/types/data-sdk/src/model/IStreamCurrentValue.d.ts

@@ -1,13 +0,0 @@
-import { IsoDate } from "./IsoDate";
-import { IStreamTypeMap } from "./IStreamTypeMap";
-import { ITags } from "./ITags";
-import { StreamType } from "./StreamType";
-import { Uuid } from "./Uuid";
-export interface IStreamCurrentValue<T extends StreamType = any> {
-    deviceId: Uuid;
-    streamName: string;
-    streamType: StreamType;
-    tags: ITags;
-    currentValue: IStreamTypeMap[T];
-    currentValueTime: IsoDate;
-}

package/dist/types/data-sdk/src/model/IStreamData.d.ts

@@ -1,11 +0,0 @@
-import { IDataPoint } from "./IDataPoint";
-import { ITags } from "./ITags";
-import { StreamType } from "./StreamType";
-import { Uuid } from "./Uuid";
-export interface IStreamData<T extends StreamType = StreamType> {
-    deviceId: Uuid;
-    name: string;
-    type: T;
-    tags: ITags;
-    points: IDataPoint<T>[];
-}

package/dist/types/data-sdk/src/model/IStreamTypeMap.d.ts

@@ -1,27 +0,0 @@
-import { IBattery } from "./IBattery";
-import { IBitset } from "./IBitset";
-import { IFile } from "./IFile";
-import { IHealth } from "./IHealth";
-import { IImage } from "./IImage";
-import { ILocalization } from "./ILocalization";
-import { ILocation } from "./ILocation";
-import { INumericSetEntry } from "./INumericSetEntry";
-import { IPointCloud } from "./IPointCloud";
-import { ITransformNode } from "./ITransformNode";
-import { IVideo } from "./IVideo";
-export interface IStreamTypeMap {
-    bitset: IBitset;
-    localization: ILocalization;
-    "point cloud": IPointCloud;
-    location: ILocation;
-    file: IFile;
-    health: IHealth;
-    "transform tree": ITransformNode;
-    battery: IBattery;
-    video: IVideo;
-    "numeric set": INumericSetEntry[];
-    json: string;
-    image: IImage;
-    numeric: number;
-    text: string;
-}

package/dist/types/data-sdk/src/model/ISystemEvent.d.ts

@@ -1,3 +0,0 @@
-import { IBaseEvent } from "./IBaseEvent";
-export interface ISystemEvent extends IBaseEvent<"system"> {
-}

package/dist/types/data-sdk/src/model/ITagParameters.d.ts

@@ -1,3 +0,0 @@
-export interface ITagParameters {
-    choices: string[];
-}

package/dist/types/data-sdk/src/model/ITagSets.d.ts

@@ -1,3 +0,0 @@
-export interface ITagSets {
-    [key: string]: string[];
-}

package/dist/types/data-sdk/src/model/ITaggedUsers.d.ts

@@ -1,4 +0,0 @@
-import { Uuid } from "./Uuid";
-export interface ITaggedUsers {
-    [key: string]: Uuid[];
-}

package/dist/types/data-sdk/src/model/ITags.d.ts

@@ -1,3 +0,0 @@
-export interface ITags {
-    [key: string]: string;
-}

package/dist/types/data-sdk/src/model/ITaskReportColumn.d.ts

@@ -1,7 +0,0 @@
-import { ISqlColumn } from "./ISqlColumn";
-export interface ITaskReportColumn {
-    tableName: string;
-    columns?: ISqlColumn[];
-    name: string;
-    yAxis?: string;
-}

package/dist/types/data-sdk/src/model/ITeleopRequestData.d.ts

@@ -1,3 +0,0 @@
-export interface ITeleopRequestData {
-    instruction: string;
-}

package/dist/types/data-sdk/src/model/ITeleopResponseData.d.ts

@@ -1,4 +0,0 @@
-export interface ITeleopResponseData {
-    state: "inProgress" | "requestAssistance" | "success" | "failure";
-    notes?: string;
-}

package/dist/types/data-sdk/src/model/ITeleopSessionRecord.d.ts

@@ -1,3 +0,0 @@
-import { IRtcSessionRecord } from "./IRtcSessionRecord";
-export interface ITeleopSessionRecord extends IRtcSessionRecord<"teleop-session-record"> {
-}

package/dist/types/data-sdk/src/model/ITransform.d.ts

@@ -1,6 +0,0 @@
-import { IQuaternion } from "./IQuaternion";
-import { IVector3 } from "./IVector3";
-export interface ITransform {
-    translation: IVector3;
-    rotation: IQuaternion;
-}

package/dist/types/data-sdk/src/model/ITransformNode.d.ts

@@ -1,7 +0,0 @@
-import { ITransform } from "./ITransform";
-export interface ITransformNode {
-    name?: string;
-    transform?: ITransform;
-    children?: ITransformNode[];
-    url?: string;
-}

package/dist/types/data-sdk/src/model/ITriggeredEvent.d.ts

@@ -1,10 +0,0 @@
-import { IBaseEvent } from "./IBaseEvent";
-import { IsoDate } from "./IsoDate";
-import { Severity } from "./Severity";
-import { Uuid } from "./Uuid";
-export interface ITriggeredEvent extends IBaseEvent<"triggered-event"> {
-    severity: Severity;
-    eventTriggerId: Uuid;
-    interval: number;
-    intervalStart?: IsoDate;
-}

package/dist/types/data-sdk/src/model/ITwist.d.ts

@@ -1,5 +0,0 @@
-import { IVector3 } from "./IVector3";
-export interface ITwist {
-    linear: IVector3;
-    angular: IVector3;
-}

package/dist/types/data-sdk/src/model/IUserParameters.d.ts

@@ -1,4 +0,0 @@
-import { AccessLevel } from "./AccessLevel";
-export interface IUserParameters {
-    roles?: AccessLevel[];
-}

package/dist/types/data-sdk/src/model/IVector3.d.ts

@@ -1,5 +0,0 @@
-export interface IVector3 {
-    x: number;
-    y: number;
-    z: number;
-}

package/dist/types/data-sdk/src/model/IVideo.d.ts

@@ -1,7 +0,0 @@
-import { VideoMimeType } from "./VideoMimeType";
-export interface IVideo {
-    url: string;
-    size?: number;
-    duration: number;
-    mimeType: VideoMimeType;
-}

package/dist/types/data-sdk/src/model/IView.d.ts

@@ -1,15 +0,0 @@
-import { IsoDate } from "./IsoDate";
-import { Uuid } from "./Uuid";
-export interface IView {
-    id: Uuid;
-    createdAt: IsoDate;
-    updatedAt: IsoDate;
-    organizationId: Uuid;
-    name: string;
-    url: string;
-    showOnSingleDevice: boolean;
-    showOnMultiDevice: boolean;
-    showOnTeleop: boolean;
-    showOnAnalytics: boolean;
-    showTimeline: boolean;
-}

package/dist/types/data-sdk/src/model/InterventionType.d.ts

@@ -1,2 +0,0 @@
-import { IInterventionTypeMap } from "./IInterventionTypeMap";
-export type InterventionType = keyof IInterventionTypeMap;

package/dist/types/data-sdk/src/model/IsoDate.d.ts

@@ -1 +0,0 @@
-export type IsoDate = string;

package/dist/types/data-sdk/src/model/JsonSchema.d.ts

@@ -1,39 +0,0 @@
-import { StreamType } from "./StreamType";
-export type FieldType = "string" | "integer" | "number" | "array" | "object" | "boolean";
-export interface IJsonBaseSchema<T extends FieldType> {
-    title?: string;
-    description?: string;
-    type: T;
-    required?: string[];
-    $schema?: string;
-    "$formant.visible.when"?: [string, "=", string];
-}
-export interface IJsonBaseSchemaWithDefault<T extends FieldType, U> extends IJsonBaseSchema<T> {
-    default?: U;
-}
-export interface IPropertyObject {
-    [key: string]: JsonSchema;
-}
-export interface IJsonObjectSchema extends IJsonBaseSchema<"object"> {
-    properties?: IPropertyObject;
-    "$formant.documentationUrl"?: string;
-}
-export interface IJsonArraySchema extends IJsonBaseSchema<"array"> {
-    items: {
-        type: "integer" | "number" | "string" | "object";
-        properties: IPropertyObject;
-        required?: string[];
-        "$formant.itemName"?: string;
-    };
-}
-export interface IJsonStringSchema extends IJsonBaseSchemaWithDefault<"string", string> {
-    enum?: string[];
-    "$formant.streams.byType"?: StreamType;
-    "$formant.placeholder"?: string;
-    "$formant.groups"?: boolean;
-    "$formant.date"?: boolean;
-}
-export type IJsonBooleanSchema = IJsonBaseSchemaWithDefault<"boolean", boolean>;
-export type IJsonIntegerSchema = IJsonBaseSchemaWithDefault<"integer", number>;
-export type IJsonNumberSchema = IJsonBaseSchemaWithDefault<"number", number>;
-export type JsonSchema = IJsonObjectSchema | IJsonStringSchema | IJsonArraySchema | IJsonBooleanSchema | IJsonIntegerSchema | IJsonNumberSchema;

package/dist/types/data-sdk/src/model/Severity.d.ts

@@ -1,2 +0,0 @@
-import { severities } from "./severities";
-export type Severity = typeof severities[number];

package/dist/types/data-sdk/src/model/SortOrder.d.ts

@@ -1 +0,0 @@
-export type SortOrder = "asc" | "desc";

package/dist/types/data-sdk/src/model/StreamType.d.ts

@@ -1,2 +0,0 @@
-import { IStreamTypeMap } from "./IStreamTypeMap";
-export type StreamType = keyof IStreamTypeMap;