@byomakase/omakase-react-components 0.0.1-SNAPSHOT.1743070950

package/dist/react/omakase-components/src/types/tams/model/video-flow-essence-parameters-pixel-aspect-ratio.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The pixel aspect ratio. This is usually 1:1 (i.e. square pixels) for modern video. Some, usually older, video formats use non-square pixels e.g. some Standard Definition video. This is where that may be indicated.
+ */
+export interface VideoFlowEssenceParametersPixelAspectRatio {
+    /**
+     * numerator
+     */
+    numerator: number;
+    /**
+     * denominator
+     */
+    denominator: number;
+}

package/dist/react/omakase-components/src/types/tams/model/video-flow-essence-parameters.d.ts

@@ -0,0 +1,78 @@
+import { VideoFlowEssenceParametersFrameRate } from './video-flow-essence-parameters-frame-rate';
+import { AVCCodecParameters } from './avc-codec-parameters';
+import { VideoFlowEssenceParametersAspectRatio } from './video-flow-essence-parameters-aspect-ratio';
+import { VideoFlowEssenceParametersPixelAspectRatio } from './video-flow-essence-parameters-pixel-aspect-ratio';
+import { UncompressedVideoParameters } from './uncompressed-video-parameters';
+/**
+ * Describes the parameters of the essence inside this video Flow
+ */
+export interface VideoFlowEssenceParameters {
+    frame_rate?: VideoFlowEssenceParametersFrameRate;
+    /**
+     * The width of the picture in pixels.
+     */
+    frame_width: number;
+    /**
+     * The height of the picture in pixels.
+     */
+    frame_height: number;
+    /**
+     * The number of significant bits used to represent the video component sample. If codec is `video/raw`, bit_depth must be set.
+     */
+    bit_depth?: number;
+    /**
+     * Interlaced video mode for frames in this Flow
+     */
+    interlace_mode?: VideoFlowEssenceParameters.InterlaceModeEnum;
+    /**
+     * Colorspace used for the video
+     */
+    colorspace?: VideoFlowEssenceParameters.ColorspaceEnum;
+    /**
+     * Transfer characteristic
+     */
+    transfer_characteristic?: VideoFlowEssenceParameters.TransferCharacteristicEnum;
+    aspect_ratio?: VideoFlowEssenceParametersAspectRatio;
+    pixel_aspect_ratio?: VideoFlowEssenceParametersPixelAspectRatio;
+    /**
+     * Picture component representation.
+     */
+    component_type?: VideoFlowEssenceParameters.ComponentTypeEnum;
+    /**
+     * Horizontal chroma component sub-sampling. When unc_type is set to a YUV type, horiz_chroma_subs must be set.
+     */
+    horiz_chroma_subs?: number;
+    /**
+     * Vertical chroma component sub-sampling. When unc_type is set to a YUV type, vert_chroma_subs must be set.
+     */
+    vert_chroma_subs?: number;
+    unc_parameters?: UncompressedVideoParameters;
+    avc_parameters?: AVCCodecParameters;
+}
+export declare namespace VideoFlowEssenceParameters {
+    type InterlaceModeEnum = 'progressive' | 'interlaced_tff' | 'interlaced_bff' | 'interlaced_psf';
+    const InterlaceModeEnum: {
+        Progressive: InterlaceModeEnum;
+        InterlacedTff: InterlaceModeEnum;
+        InterlacedBff: InterlaceModeEnum;
+        InterlacedPsf: InterlaceModeEnum;
+    };
+    type ColorspaceEnum = 'BT601' | 'BT709' | 'BT2020' | 'BT2100';
+    const ColorspaceEnum: {
+        Bt601: ColorspaceEnum;
+        Bt709: ColorspaceEnum;
+        Bt2020: ColorspaceEnum;
+        Bt2100: ColorspaceEnum;
+    };
+    type TransferCharacteristicEnum = 'SDR' | 'HLG' | 'PQ';
+    const TransferCharacteristicEnum: {
+        Sdr: TransferCharacteristicEnum;
+        Hlg: TransferCharacteristicEnum;
+        Pq: TransferCharacteristicEnum;
+    };
+    type ComponentTypeEnum = 'YCbCr' | 'RGB';
+    const ComponentTypeEnum: {
+        YcbCr: ComponentTypeEnum;
+        Rgb: ComponentTypeEnum;
+    };
+}

package/dist/react/omakase-components/src/types/tams/model/video-flow.d.ts

@@ -0,0 +1,104 @@
+import { FlowCoreSegmentDuration } from './flow-core-segment-duration';
+import { ContainerMapping1 } from './container-mapping1';
+import { VideoFlowEssenceParameters } from './video-flow-essence-parameters';
+import { CollectionItem } from './collection-item';
+/**
+ * Describes a video Flow
+ */
+export interface VideoFlow {
+    /**
+     * Flow identifier
+     */
+    id: string;
+    /**
+     * Source identifier
+     */
+    source_id: string;
+    /**
+     * Freeform string label for the flow
+     */
+    label?: string;
+    /**
+     * Freeform text describing the flow
+     */
+    description?: string;
+    /**
+     * A string identifier for the entity that created the flow. Implementations SHOULD set suitable default values for `created_by` based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.
+     */
+    created_by?: string;
+    /**
+     * A string identifier for the entity that updated the flow metadata most recently. Implementations SHOULD set suitable default values for `updated_by` based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.
+     */
+    updated_by?: string;
+    /**
+     * Key value is a freeform string.
+     */
+    tags?: {
+        [key: string]: string;
+    };
+    /**
+     * A change to the flow metadata, not including metadata_version, last_update or segments, results in a new version. If the metadata_version for flow instances is identical then the metadata is identical.
+     */
+    metadata_version?: string;
+    /**
+     * An indication of how many lossy encodings the flow content has been through. A flow with a higher generation may contain less of the original information than a flow with a lower generation.
+     */
+    generation?: number;
+    /**
+     * The date-time the flow was created in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    created?: string;
+    /**
+     * The date-time the flow metadata was updated in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    metadata_updated?: string;
+    /**
+     * The date-time the flow segments were updated in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    segments_updated?: string;
+    /**
+     * If set to \'true\', implementations SHOULD reject client requests to update Flow metadata (other than the read_only property), Flow Segments and media objects
+     */
+    read_only?: boolean;
+    /**
+     * A MIME type identification of the (lossy or lossless) coding used for the flow content.
+     */
+    codec?: string;
+    /**
+     * The container MIME type for flow segments.
+     */
+    container?: string;
+    /**
+     * The average bit rate of the flow segments in 1000 bits/second. A precise definition can be found in the [Setting Flow Bit Rate Properties](https://github.com/bbc/tams/blob/main/docs/appnotes/0013-setting-flow-bit-rate-properties.md) AppNote.
+     */
+    avg_bit_rate?: number;
+    /**
+     * The maximum bit rate of the flow segments in 1000 bits/second. A precise definition can be found in the [Setting Flow Bit Rate Properties](https://github.com/bbc/tams/blob/main/docs/appnotes/0013-setting-flow-bit-rate-properties.md) AppNote.
+     */
+    max_bit_rate?: number;
+    segment_duration?: FlowCoreSegmentDuration;
+    /**
+     * The timerange of samples available in the flow, as described by the [TimeRange](../schemas/timerange#top) type
+     */
+    timerange?: string;
+    /**
+     * List of Flows that are collected together by this Flow.
+     */
+    flow_collection?: Array<CollectionItem>;
+    /**
+     * Flows that reference this Flow to include it in a collection. This attribute is intended to be read-only. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    collected_by?: Array<string>;
+    container_mapping?: ContainerMapping1;
+    /**
+     * The primary content type URN for the flow.
+     */
+    format: VideoFlow.FormatEnum;
+    essence_parameters: VideoFlowEssenceParameters;
+}
+export declare namespace VideoFlow {
+    type FormatEnum = 'urn:x-nmos:format:video';
+    const FormatEnum: {
+        UrnxNmosformatvideo: FormatEnum;
+    };
+}

package/dist/react/omakase-components/src/types/user-agent.d.ts

@@ -0,0 +1,2 @@
+export type UserAgent = "unknown" | "android" | "firefox" | "edge" | "chrome" | "chromium" | "safari";
+export type UserAgentPlatform = "unknown" | "macos" | "windows" | "linux";

package/dist/react/omakase-components/src/util/array-util.d.ts

@@ -0,0 +1,3 @@
+export declare class ArrayUtil {
+    static range(start: number, end: number): number[];
+}

package/dist/react/omakase-components/src/util/blob-util.d.ts

@@ -0,0 +1,7 @@
+export declare class BlobUtil {
+    private static _blobs;
+    static createBlob(blobParts: BlobPart[], options?: BlobPropertyBag): Blob;
+    static createObjectURL(blob: Blob): string;
+    static revokeObjectURL(url: string): void;
+    static revokeAll(): void;
+}

package/dist/react/omakase-components/src/util/color-util.d.ts

@@ -0,0 +1,21 @@
+export declare class ColorUtil {
+    static randomHexColor(): string;
+    static inverseFillGradient(gradient: (string | number)[]): (string | number)[];
+    static hexToRgb(hex: string): {
+        r: number;
+        g: number;
+        b: number;
+    } | undefined;
+    static getLuminance({ r, g, b }: {
+        r: number;
+        g: number;
+        b: number;
+    }): number;
+    static rgbToHex({ r, g, b }: {
+        r: number;
+        g: number;
+        b: number;
+    }): string;
+    static isLightColor(hex: string): boolean;
+    static lightenColor(hex: string, percent: number): string;
+}

package/dist/react/omakase-components/src/util/crypto-util.d.ts

@@ -0,0 +1,3 @@
+export declare class CryptoUtil {
+    static uuid(): string;
+}

package/dist/react/omakase-components/src/util/frame-rate-util.d.ts

@@ -0,0 +1,3 @@
+export declare class FrameRateUtil {
+    static resolveFrameRateValueFromFraction(fraction: string): number;
+}

package/dist/react/omakase-components/src/util/object-util.d.ts

@@ -0,0 +1 @@
+export declare function isNullOrUndefined(value: any): boolean;

package/dist/react/omakase-components/src/util/player-util.d.ts

@@ -0,0 +1,3 @@
+export declare class PlayerUtil {
+    static createUrl(flowId: string, timerange: string | undefined): string;
+}

package/dist/react/omakase-components/src/util/rxjs-util.d.ts

@@ -0,0 +1,2 @@
+import { Subject, Subscriber } from 'rxjs';
+export declare function completeSub(subscriber: Subscriber<void> | Subject<void>): void;

package/dist/react/omakase-components/src/util/string-util.d.ts

@@ -0,0 +1,9 @@
+export declare class StringUtil {
+    static isNullUndefinedOrWhitespace(value: string | undefined | null): boolean;
+    static isNonEmpty(value: string | undefined | null): boolean;
+    static endsWith(value: string, suffix: string): boolean;
+    static toMixedCase(value: string): string;
+    static replaceWhitespace(searchValue: string, replaceValue: string): string;
+    static whitespacesToCommas(searchValue: string): string;
+    static tokenizeWhitespaceSeparated(value: string): string[] | undefined;
+}

package/dist/react/omakase-components/src/util/time-range-util.d.ts

@@ -0,0 +1,38 @@
+export interface AuthResponse {
+    access_token: string;
+    expires_in: number;
+    token_type: string;
+}
+export interface AuthSession {
+    authResponse: AuthResponse;
+    refreshAtLatestByUtcTimestamp: number;
+    expiresUtcTimestamp: number;
+}
+export type TimeMoment = [number, number];
+export interface TimeRange {
+    start?: TimeMoment;
+    end?: TimeMoment;
+    isStartInclusive: boolean;
+    isEndInclusive: boolean;
+}
+export declare class TimeRangeUtil {
+    private static timeRangePattern;
+    static parseTimeMoment(timeMomentText: string): TimeMoment;
+    static parseTimeRange(timeRangeStr: string): TimeRange;
+    static timeMomentToSeconds(timeMoment: TimeMoment): number;
+    static timeMomentToMilliseconds(timeMoment: TimeMoment): number;
+    static timeMomentToDate(timeMoment: TimeMoment): Date;
+    static formatTimeMomentToTimecodeText(timeMoment: TimeMoment, frameRateFraction: string, audioOnly?: boolean): string;
+    static formatTimerangeToTimecodeText(timerange: string, frameRateFraction: string, audioOnly?: boolean): string;
+    static nanosecondsToSeconds(nanoseconds: number): number;
+    static nanosecondsToTimeMoment(nanoseconds: number): TimeMoment;
+    static secondsToTimeMoment(seconds: number): TimeMoment;
+    static timerangeExprDuration(timerange: string): number;
+    static timeRangeDuration(timeRange: TimeRange): number;
+    static formatTimeMomentExpr(timeMoment: TimeMoment): string;
+    static formatNanosecondsToTimeMomentExpr(nanoseconds: number): string;
+    static toTimeRange(start?: TimeMoment, end?: TimeMoment, isStartInclusive?: boolean, isEndInclusive?: boolean): TimeRange;
+    static formatTimeRangeExpr(timeRange: TimeRange): string;
+    static timerangeDuration(timerangeExpr: string): number;
+    private static padZero;
+}

package/dist/react/omakase-components/src/util/timecode-util.d.ts

@@ -0,0 +1,10 @@
+export declare class TimecodeUtil {
+    static formatToTimecode(time: number, frameRate: number, audioOnly?: boolean): string;
+    static formatTimecodeText(hours: number, minutes: number, seconds: number, frames: number, audioOnly?: boolean): string;
+    /**
+     * Fast padding
+     * @param num
+     * @private
+     */
+    private static padZero;
+}

package/dist/react/omakase-components/src/util/window-util.d.ts

@@ -0,0 +1,6 @@
+export declare class WindowUtil {
+    static resetCursorStyle(): void;
+    static cursor(cursor: 'default' | 'pointer' | 'grab' | 'grabbing' | 'ew-resize' | 'col-resize'): void;
+    static open(url: string, target?: '_self' | '_blank' | '_parent' | '_top' | '_unfencedTop', features?: string): WindowProxy | undefined;
+    static close(): void;
+}

package/dist/react/omakase-components/vite.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vite').UserConfig;
+export default _default;

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@byomakase/omakase-react-components",
+  "version": "0.0.1-SNAPSHOT.1743070950",
+  "description": "Omakase Player React.js wrapped components",
+  "main": "./dist/index.cjs.js",
+  "module": "./dist/index.es.js",
+  "types": "./dist/index.es.d.ts",
+  "scripts": {
+    "build": "vite build",
+    "build:prod": "rm -rf dist && tsc --noEmit && vite build --mode production"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/byomakase/omakase-player-utils.git"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.13",
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.4",
+    "typescript": "^5.7.3",
+    "vite": "^6.2.0",
+    "vite-plugin-dts": "^4.5.0"
+  },
+  "peerDependencies": {
+    "@byomakase/omakase-player": "0.15.1-SNAPSHOT.1742994494",
+    "react": "^18.3.1"
+  },
+  "dependencies": {
+    "decimal.js": "^10.5.0",
+    "rxjs": "7.8.1"
+  }
+}