quantum-component-library 0.0.1 → 1.0.0-qa

package/dist/lib/hooks/index.d.ts

@@ -0,0 +1,7 @@
+export * from './use-graphql-client';
+export * from './use-joints-for-limb-ids';
+export * from './use-joints-for-sensor-locations';
+export * from './use-limbs-for-sensor-locations';
+export * from './use-part-options-for-joints';
+export * from './use-part-options-for-limbs';
+export * from './use-part-options-for-sensor-locations';

package/dist/lib/hooks/use-graphql-client.d.ts

@@ -0,0 +1,5 @@
+import { Client } from 'urql';
+export declare const useGraphqlClient: ({ url, getAuthToken, }: {
+    url: string;
+    getAuthToken: () => string;
+}) => Client;

package/dist/lib/hooks/use-joints-for-limb-ids.d.ts

@@ -0,0 +1,2 @@
+import { HumanBodyLimbId } from '../types/human';
+export declare const useJointsForLimbIds: (limbIds: HumanBodyLimbId[]) => import('../types').IAvailableJoint[];

package/dist/lib/hooks/use-joints-for-sensor-locations.d.ts

@@ -0,0 +1,2 @@
+import { SensorLocation } from '../../generated/graphql';
+export declare const useJointsForSensorLocations: (locations: SensorLocation[]) => import('../types').IAvailableJoint[];

package/dist/lib/hooks/use-limbs-for-sensor-locations.d.ts

@@ -0,0 +1,2 @@
+import { SensorLocation } from '../../generated/graphql';
+export declare const useLimbsForSensorLocations: (locations: SensorLocation[]) => import('../types').IAvailableHumanLimb[];

package/dist/lib/hooks/use-part-options-for-joints.d.ts

@@ -0,0 +1,3 @@
+import { AngleDataSource, HumanBodyJointId } from '../types/human';
+import { PartParameter } from '../types/parameters';
+export declare const usePartOptionsForJoints: (joints: HumanBodyJointId[], dataSource: AngleDataSource) => Omit<PartParameter, "kind">[];

package/dist/lib/hooks/use-part-options-for-limbs.d.ts

@@ -0,0 +1,3 @@
+import { AngleDataSource, HumanBodyLimbId } from '../types/human';
+import { PartParameter } from '../types/parameters';
+export declare const usePartOptionsForLimbs: (limbIds: HumanBodyLimbId[], dataSource: AngleDataSource) => Omit<PartParameter, "kind">[];

package/dist/lib/hooks/use-part-options-for-sensor-locations.d.ts

@@ -0,0 +1,3 @@
+import { SensorLocation } from '../../generated/graphql';
+import { PartParameter } from '../types/parameters';
+export declare const usePartOptionsForSensorLocations: (locations: SensorLocation[]) => Omit<PartParameter, "kind">[];

package/dist/lib/services/human.d.ts

@@ -0,0 +1,69 @@
+import { AngleDataSource, AnglePlane, HumanBodyJointId, HumanBodyLimbId, IAvailableJoint, IAvailableHumanLimb as IAvailableLimb, IHumanBody } from '../types/human';
+import { HumanPart, XYZ } from '../types/human-part';
+import { Parameter } from '../../generated/graphql';
+export declare const limbNames: Record<HumanBodyLimbId, string>;
+export declare const jointNames: Record<HumanBodyJointId, string>;
+export declare const jointsUsedByLimbs: Record<HumanBodyLimbId, HumanBodyJointId[]>;
+export declare const limbsRequiredForJoints: Record<HumanBodyJointId, HumanBodyLimbId[]>;
+export declare const getAllAvailableLimbs: () => Array<IAvailableLimb>;
+export declare const getAvailableLimbsForLimbIds: (limbIds: HumanBodyLimbId[]) => IAvailableLimb[];
+export declare const getAllAvailableJoints: () => Array<IAvailableJoint>;
+export declare const getAllAvailableSensorJoints: () => Array<IAvailableJoint>;
+export declare const getAllAvailablePoseJoints: () => Array<IAvailableJoint>;
+export declare const getAllAvailablePoseLimbs: () => Array<IAvailableLimb>;
+export declare const getAvailableSensorJointsForLimbIds: (limbIds: HumanBodyLimbId[]) => IAvailableJoint[];
+export declare const getAvailablePoseJointsForLimbIds: (limbIds: HumanBodyLimbId[]) => IAvailableJoint[];
+export declare const getEnabledJointPlanes: (joint: IAvailableJoint["id"], angleDataSource?: AngleDataSource, enableAllData?: boolean) => AnglePlane[];
+export declare const getEnabledSegmentPlanes: (segment: IAvailableLimb["id"], angleDataSource?: AngleDataSource) => AnglePlane[];
+export declare const getJointAngleDirectionName: (joint: IAvailableJoint["id"], angle: AnglePlane, direction: -1 | 1) => string | null;
+export declare const getJointAngleDirectionAbbr: (joint: IAvailableJoint["id"], angle: AnglePlane, direction: -1 | 1) => string | null;
+export declare const getSegmentAngleDirectionName: (segment: IAvailableLimb["id"], angle: AnglePlane, direction: -1 | 1) => string | null;
+export declare const getSegmentAngleDirectionAbbr: (segment: IAvailableLimb["id"], angle: AnglePlane, direction: -1 | 1) => string | null;
+export declare const getDefaultJointRange: (joint: HumanBodyJointId, plane: AnglePlane) => {
+    min: number;
+    max: number;
+};
+export declare const getDefaultLimbRange: (limb: HumanBodyLimbId, plane: AnglePlane) => {
+    min: number;
+    max: number;
+};
+export declare const getNormativeJointRange: (joint: HumanBodyJointId, plane: AnglePlane) => {
+    min: number;
+    max: number;
+};
+export declare const mkJointPart: (value: IAvailableJoint, plane: AnglePlane) => HumanPart;
+export declare const mkLimbPart: (value: IAvailableLimb, plane: AnglePlane) => HumanPart;
+export declare const mkAccelerationPart: (value: IAvailableLimb, axis: XYZ) => HumanPart;
+export declare const mkAngularVelocityPart: (value: IAvailableJoint, plane: AnglePlane) => HumanPart;
+export declare const isAxis: (value: string) => value is XYZ;
+export declare const isPlane: (value: string) => value is AnglePlane;
+export declare const isLimb: (value: unknown) => value is IAvailableLimb;
+export declare const isJoint: (value: unknown) => value is IAvailableJoint;
+export declare const mkHumanPart: <A extends XYZ | AnglePlane>(value: A extends XYZ ? IAvailableLimb : IAvailableLimb | IAvailableJoint, planeOrAxis: A, angularVelocity?: boolean) => HumanPart;
+export declare const planeOrAxis: (part: HumanPart) => XYZ | AnglePlane;
+export declare const getAxis: (part?: HumanPart) => XYZ | null;
+export declare const getPlane: (part?: HumanPart) => AnglePlane | null;
+export declare const getPartName: (partId: HumanBodyLimbId | HumanBodyJointId) => string;
+export declare const getPartNameNoSide: (partId: HumanBodyLimbId | HumanBodyJointId) => string;
+export declare const getTypicalRom: (partId: HumanBodyJointId | HumanBodyLimbId, plane: AnglePlane) => {
+    min: number;
+    max: number;
+} | null;
+export declare const getTypicalRomSize: (...args: Parameters<typeof getTypicalRom>) => number;
+export declare const getDefaultAngleSource: (body: IHumanBody, partId: HumanBodyJointId | HumanBodyLimbId) => AngleDataSource | null;
+export declare const getIsDefaultAngleAllowed: (body: IHumanBody, partId: HumanBodyJointId | HumanBodyLimbId, plane: AnglePlane) => boolean;
+export declare const getHumanBodyAngle: (body: IHumanBody, partId: HumanBodyJointId | HumanBodyLimbId, plane: AnglePlane) => number | null;
+export declare const getJointPlaneName: (joint: HumanBodyJointId, plane: AnglePlane, reverse?: boolean) => string | null;
+export declare const getSegmentNameWithPlane: (segment: HumanBodyLimbId, plane: AnglePlane, reverse?: boolean) => string;
+export declare const getSegmentXyzName: (segment: HumanBodyLimbId, axis: XYZ) => string;
+export declare const getJointNameWithPlane: (joint: HumanBodyJointId, plane: AnglePlane, reverse?: boolean) => string | null;
+export declare const getJointOrSegmentNameWithPlane: (part: HumanBodyJointId | HumanBodyLimbId | string, plane: AnglePlane | string) => string;
+export declare const getAngleDirectionNames: <K extends "joint" | "segment">(kind: K, id: K extends "joint" ? HumanBodyJointId : HumanBodyLimbId, plane: AnglePlane, abbreviate?: boolean) => {
+    readonly positive: string | null;
+    readonly negative: string | null;
+};
+export declare const getParameterDirectionNames: (parameter: Pick<Parameter, "partKind" | "partId" | "partDimension">, abbreviate?: boolean) => {
+    readonly positive: string | null;
+    readonly negative: string | null;
+};
+export declare const getParameterAngleDirectionName: (value: number, parameter: Pick<Parameter, "partKind" | "partId" | "partDimension">, abbreviate?: boolean) => string | null;

package/dist/lib/services/index.d.ts

@@ -0,0 +1 @@
+export * from './human';

package/dist/lib/services/rom.json.d.ts

@@ -0,0 +1,226 @@
+declare const _default: {
+  "LeftAnkle": {
+    "sagittal": {
+      "__COMMENT__": "-Plantar Flexion, +Dorsi flexion",
+      "min": -20,
+      "max": 30 
+    },
+    "frontal": {
+      "__COMMENT__": "-Inversion, +Eversion",
+      "min": -30,
+      "max": 20
+    },
+    "transverse": {
+      "__COMMENT__": "-Pronation, +Supination",
+      "min": -10,
+      "max": 10
+    }
+  },
+  "RightAnkle": {
+    "sagittal": {
+      "__COMMENT__": "-Plantar Flexion, +Dorsi flexion",
+      "min": -20,
+      "max": 30 
+    },
+    "frontal": {
+      "__COMMENT__": "-Inversion, +Eversion",
+      "min": -30,
+      "max": 20
+    },
+    "transverse": {
+      "__COMMENT__": "-Pronation, +Supination",
+      "min": -10,
+      "max": 10
+    }
+  },
+  "LeftKnee": {
+    "sagittal": {
+      "__COMMENT__": "-Extension, +Flexion",
+      "min": -5,
+      "max": 142
+    },
+    "frontal": {
+      "__COMMENT__": "N/A",
+      "min": 0,
+      "max": 0
+    },
+    "transverse": {
+      "__COMMENT__": "N/A",
+      "min": 0,
+      "max": 0
+    }
+  },
+  "RightKnee": {
+    "sagittal": {
+      "__COMMENT__": "-Extension, +Flexion",
+      "min": -5,
+      "max": 142
+    },
+    "frontal": {
+      "__COMMENT__": "N/A",
+      "min": 0,
+      "max": 0
+    },
+    "transverse": {
+      "__COMMENT__": "N/A",
+      "min": 0,
+      "max": 0
+    }
+  },
+  "LeftHip": {
+    "sagittal": {
+      "__COMMENT__": "-Extension, +Flexion",
+      "min": -18,
+      "max": 134
+    },
+    "frontal": {
+      "__COMMENT__": "-Adduction, +Abduction",
+      "min": -20,
+      "max": 40
+    },
+    "transverse": {
+      "__COMMENT__": "-Internal Rotation, +External Rotation",
+      "min": -40,
+      "max": 50
+    }
+  },
+  "RightHip": {
+    "sagittal": {
+      "__COMMENT__": "-Extension, +Flexion",
+      "min": -18,
+      "max": 134
+    },
+    "frontal": {
+      "__COMMENT__": "-Adduction, +Abduction",
+      "min": -20,
+      "max": 40
+    },
+    "transverse": {
+      "__COMMENT__": "-Internal Rotation, +External Rotation",
+      "min": -40,
+      "max": 50
+    }
+  },
+  "NavalSpine": {
+    "sagittal": {
+      "__COMMENT__": "-Extension, +Flexion",
+      "min": -75,
+      "max": 60
+    },
+    "frontal": {
+      "__COMMENT__": "-Bend Right, +Bend Left",
+      "min": -45,
+      "max": 45
+    },
+    "transverse": {
+      "__COMMENT__": "-Twist Right, +Twist Left",
+      "min": -80,
+      "max": 80
+    }
+  },
+  "ChestSpine": {
+    "sagittal": {
+      "__COMMENT__": "-Extension, +Flexion",
+      "min": -25,
+      "max": 50
+    },
+    "frontal": {
+      "__COMMENT__": "-Bend Right, +Bend Left",
+      "min": -25,
+      "max": 25
+    },
+    "transverse": {
+      "__COMMENT__": "-Twist Right, +Twist Left",
+      "min": -30,
+      "max": 30
+    }
+  },
+  "TotalSpine": {
+    "__COMMENT__": "This is the sum of the ChestSpine and NavalSpine",
+    "sagittal": {
+      "__COMMENT__": "-Extension, +Flexion",
+      "min": -100,
+      "max": 110
+    },
+    "frontal": {
+      "__COMMENT__": "-Bend Right, +Bend Left",
+      "min": -70,
+      "max": 70
+    },
+    "transverse": {
+      "__COMMENT__": "-Twist Right, +Twist Left",
+      "min": -110,
+      "max": 110
+    }
+  },
+  "LeftShoulder": {
+    "sagittal": {
+      "__COMMENT__": "-Extension, +Flexion",
+      "min": -50,
+      "max": 180
+    },
+    "frontal": {
+      "__COMMENT__": "-Adduction, +Abduction",
+      "min": -50,
+      "max": 180
+    },
+    "transverse": {
+      "__COMMENT__": "-Internal Rotation, +External Rotation",
+      "min": -90,
+      "max": 90
+    }
+  },
+  "RightShoulder": {
+    "sagittal": {
+      "__COMMENT__": "-Extension, +Flexion",
+      "min": -50,
+      "max": 180
+    },
+    "frontal": {
+      "__COMMENT__": "-Adduction, +Abduction",
+      "min": -50,
+      "max": 180
+    },
+    "transverse": {
+      "__COMMENT__": "-Internal Rotation, +External Rotation",
+      "min": -90,
+      "max": 90
+    }
+  },
+  "LeftElbow": {
+    "sagittal": {
+      "__COMMENT__": "-Extension, +Flexion",
+      "min": 0,
+      "max": 140
+    },
+    "frontal": {
+      "__COMMENT__": "N/A",
+      "min": 0,
+      "max": 0
+    },
+    "transverse": {
+      "__COMMENT__": "-Pronation/+Supination (of forearm)",
+      "min": -80,
+      "max": 80
+    }
+  },
+  "RightElbow": {
+    "sagittal": {
+      "__COMMENT__": "-Extension, +Flexion",
+      "min": 0,
+      "max": 140
+    },
+    "frontal": {
+      "__COMMENT__": "N/A",
+      "min": 0,
+      "max": 0
+    },
+    "transverse": {
+      "__COMMENT__": "-Pronation/+Supination (of forearm)",
+      "min": -80,
+      "max": 80
+    }
+  }
+};
+
+export default _default;

package/dist/lib/types/activity.d.ts

@@ -0,0 +1,19 @@
+import { IHumanBody } from './human';
+export interface IPerformanceMetric {
+    name: string;
+    value: string | null;
+}
+export interface IActivityInfo {
+    mass: number;
+}
+export interface IActivityStep {
+    key: string;
+    name: string;
+}
+export interface IGetPerformanceMetricsArgs {
+    activity: string;
+    info: IActivityInfo;
+    packets: {
+        [key: string]: IHumanBody | null;
+    };
+}

package/dist/lib/types/analysis.d.ts

@@ -0,0 +1,115 @@
+import { TestAnalysisThresholdKind } from '../../generated/graphql';
+import { AnglePlane, HumanBodyJointId, HumanBodyLimbId } from './human';
+import { XYZ } from './human-part';
+export type UnitKind = "DeltaMilliseconds" | "Milliseconds" | "Meters" | "MetersPerSecond" | "MetersPerSecondSq" | "Kg" | "Rad" | "RadPerSecond" | "RadPerSecondSq" | "Frame" | "Percent" | "Count" | "Score" | "Newton" | "Centimeters" | "PassFail";
+export type UnitDirectionLabels = {
+    positive: string;
+    negative: string;
+};
+export type Unit = {
+    unit: UnitKind;
+    value: number;
+};
+export type UnitMap = {
+    unit: "DistanceOverTime";
+    values: {
+        [t: number]: number;
+    };
+} | {
+    unit: "VelocityOverTime";
+    values: {
+        [t: number]: number;
+    };
+} | {
+    unit: "AccelerationOverTime";
+    values: {
+        [t: number]: number;
+    };
+} | {
+    unit: "AngleOverTime";
+    values: {
+        [t: number]: number;
+    };
+} | {
+    unit: "AngularVelocityOverTime";
+    values: {
+        [t: number]: number;
+    };
+};
+export interface ITimeRange {
+    __type?: "TimeRange";
+    start: number;
+    end: number;
+}
+export interface IFrameRange {
+    __type?: "FrameRange";
+    start: number;
+    end: number;
+}
+export type JointPartId = {
+    joint: HumanBodyJointId;
+};
+export type SegmentPartId = {
+    segment: HumanBodyLimbId;
+};
+export type AnalysisPartId = JointPartId | SegmentPartId;
+export interface IAnalysisThreshold {
+    kind?: TestAnalysisThresholdKind | null;
+    min: number;
+    max: number;
+    part_id: AnalysisPartId;
+    plane: AnglePlane;
+}
+export interface IGenerateAnalysisArgs {
+    filePath: string;
+}
+export interface IAnalysisDesc {
+    name: string;
+    hint: string | null;
+}
+export interface IAnalysisStat {
+    desc: IAnalysisDesc;
+    value: Unit;
+    suffix?: string;
+    isLoading?: boolean;
+}
+export interface IAnalysisRange {
+    partId: AnalysisPartId;
+    dimension: AnalysisDimension;
+    threshold?: {
+        min: number;
+        max: number;
+    };
+    items: UnitMap[];
+    itemsOfInterest?: UnitMap;
+}
+export interface IAngleDimension {
+    type: "angle";
+    plane: AnglePlane;
+}
+export interface IAccelerationDimension {
+    type: "acceleration";
+    axis: XYZ;
+}
+export type AnalysisDimension = IAngleDimension | IAccelerationDimension;
+export declare const analysisStatBuilder: () => {
+    add: (name: string, value: Unit | undefined, hint?: string, suffix?: string | null, isLoading?: boolean) => /*elided*/ any;
+    build: () => IAnalysisStat[];
+};
+export declare const mkUnit: (unit: UnitKind, value: number) => Unit;
+export declare const tryMkUnit: (unit: UnitKind, value: number | undefined | null) => Unit | undefined;
+export declare const partIdToJointLimbId: (partId: AnalysisPartId) => HumanBodyJointId | HumanBodyLimbId;
+export declare const partIdToString: (partId: AnalysisPartId) => string;
+export declare const dimensionToLegacy: (dimension: AnalysisDimension) => XYZ | AnglePlane;
+export declare const dimensionName: (dimension: AnalysisDimension) => string;
+export declare const partIdName: (partId: AnalysisPartId) => string;
+type GetAnalysisNameProps = {
+    name?: string | null;
+    action?: {
+        name?: string | null;
+        id?: string | null;
+    } | null;
+    actionSide?: string | null;
+};
+export declare const getAnalysisName: (analysis?: GetAnalysisNameProps | null) => string;
+export {};

package/dist/lib/types/athlete.d.ts

@@ -0,0 +1,8 @@
+export interface IAthlete {
+    id: string;
+    name: string;
+    sex: string;
+    height: string;
+    age: number;
+    weight: number;
+}

package/dist/lib/types/catalog.d.ts

@@ -0,0 +1,35 @@
+import { CreateTestInput } from '../../generated/graphql';
+import { ISensorRecording } from './sensor-info';
+export interface ICatalogMetadata {
+    testFields: CreateTestInput & {
+        id?: string;
+    };
+    profileId: string;
+}
+export interface ICameraCalibration {
+    focalLength: [number, number] | null;
+    principalPoint: [number, number] | null;
+}
+export interface ICatalogAction {
+    startTimestamp: number;
+    endTimestamp?: number | null;
+    actionId: string;
+    actionName: string;
+}
+export interface ICatalogEntry {
+    id: string;
+    createdAt: number;
+    name: string | null;
+    zeroedAt: number | null;
+    videoStartedAt: number | null;
+    transcodedAt: number | null;
+    metadata: ICatalogMetadata;
+    videoPath: string | null;
+    externalVideo: string | null;
+    cameraDataPath: string | null;
+    sensorDataPath: string | null;
+    dataPath: string | null;
+    sensorRecordings: ISensorRecording[];
+    cameraCalibration: ICameraCalibration | null;
+    actions: ICatalogAction[];
+}

package/dist/lib/types/error.d.ts

@@ -0,0 +1,4 @@
+import { SensorError, SyncError } from './sensor-info';
+export declare const isSyncError: (error: any) => error is SyncError & {
+    SyncError: SensorError;
+};

package/dist/lib/types/human-part.d.ts

@@ -0,0 +1,23 @@
+import { AnglePlane, IAvailableJoint, IAvailableHumanLimb as IAvailableLimb } from './human';
+export type XYZ = "x" | "y" | "z";
+export type HumanPart = {
+    kind: "joint";
+    value: IAvailableJoint;
+    plane: AnglePlane;
+} | {
+    kind: "limb";
+    value: IAvailableLimb;
+    plane: AnglePlane;
+} | {
+    kind: "acceleration";
+    value: IAvailableLimb;
+    axis: XYZ;
+} | {
+    kind: "angular_velocity";
+    value: IAvailableJoint;
+    plane: AnglePlane;
+};
+export type HumanPartKind = HumanPart["kind"];
+export declare const partKinds: HumanPartKind[];
+export declare const planes: AnglePlane[];
+export declare const axes: XYZ[];