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

package/dist/react/omakase-components/src/types/tams/model/container-mapping-audio-track.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.
+ */
+/**
+ * Mapping for channels in audio tracks to the Flow channels
+ */
+export interface ContainerMappingAudioTrack {
+    /**
+     * Array of (zero-based) container channel numbers in Flow order
+     */
+    channel_numbers?: Array<number>;
+    /**
+     * Inclusive range of (zero-based) container channel numbers
+     */
+    channel_range?: string;
+}

package/dist/react/omakase-components/src/types/tams/model/container-mapping-isobmff-container.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+/**
+ * Mapping to ISO Base Media File Format (e.g. MP4 and MOV) containers, ISO/IEC 14496-12
+ */
+export interface ContainerMappingIsobmffContainer {
+    /**
+     * The track ID
+     */
+    track_id?: number;
+}

package/dist/react/omakase-components/src/types/tams/model/container-mapping-mp2ts-container.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+/**
+ * Mapping to MPEG-2 Transport Stream containers, ISO/IEC 13818-1 or ITU-T Recommendation H.222.0
+ */
+export interface ContainerMappingMp2tsContainer {
+    /**
+     * The packet ID for the elementary stream packets
+     */
+    pid?: number;
+}

package/dist/react/omakase-components/src/types/tams/model/container-mapping-mxf-container.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.
+ */
+/**
+ * Mapping to Material Exchange Format containers, SMPTE ST 377-1
+ */
+export interface ContainerMappingMxfContainer {
+    /**
+     * The package UID. Either a SMPTE UMID URN or UUID URN
+     */
+    package_uid?: string;
+    /**
+     * The track ID in the package
+     */
+    track_id?: number;
+}

package/dist/react/omakase-components/src/types/tams/model/container-mapping.d.ts

@@ -0,0 +1,21 @@
+import { ContainerMappingAudioTrack } from './container-mapping-audio-track';
+import { ContainerMappingMxfContainer } from './container-mapping-mxf-container';
+import { ContainerMappingMp2tsContainer } from './container-mapping-mp2ts-container';
+import { ContainerMappingIsobmffContainer } from './container-mapping-isobmff-container';
+/**
+ * Describes the mapping of the Flow essence from this Flow collection\'s container
+ */
+export interface ContainerMapping {
+    /**
+     * A zero-based and sequential track index in the container. This assumes a reliable ordering of tracks
+     */
+    track_index?: number;
+    /**
+     * A zero-based and sequential track index in the container for a particular Flow format. A container with a video and 2 audio tracks would have a format_track_index 0 for the video Flow and format_track_index 0 and 1 for the audio Flows. This assumes a reliable ordering of tracks for each Flow format
+     */
+    format_track_index?: number;
+    audio_track?: ContainerMappingAudioTrack;
+    mp2ts_container?: ContainerMappingMp2tsContainer;
+    mxf_container?: ContainerMappingMxfContainer;
+    isobmff_container?: ContainerMappingIsobmffContainer;
+}

package/dist/react/omakase-components/src/types/tams/model/container-mapping1.d.ts

@@ -0,0 +1,21 @@
+import { ContainerMappingAudioTrack } from './container-mapping-audio-track';
+import { ContainerMappingMxfContainer } from './container-mapping-mxf-container';
+import { ContainerMappingMp2tsContainer } from './container-mapping-mp2ts-container';
+import { ContainerMappingIsobmffContainer } from './container-mapping-isobmff-container';
+/**
+ * Describes the mapping of the Flow essence from the this Flow\'s container
+ */
+export interface ContainerMapping1 {
+    /**
+     * A zero-based and sequential track index in the container. This assumes a reliable ordering of tracks
+     */
+    track_index?: number;
+    /**
+     * A zero-based and sequential track index in the container for a particular Flow format. A container with a video and 2 audio tracks would have a format_track_index 0 for the video Flow and format_track_index 0 and 1 for the audio Flows. This assumes a reliable ordering of tracks for each Flow format
+     */
+    format_track_index?: number;
+    audio_track?: ContainerMappingAudioTrack;
+    mp2ts_container?: ContainerMappingMp2tsContainer;
+    mxf_container?: ContainerMappingMxfContainer;
+    isobmff_container?: ContainerMappingIsobmffContainer;
+}

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

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+/**
+ * Identifies the content format for a flow or source using a URN string.
+ */
+export type Contentformat = 'urn:x-nmos:format:video' | 'urn:x-nmos:format:audio' | 'urn:x-nmos:format:data' | 'urn:x-nmos:format:multi';
+export declare const Contentformat: {
+    Video: Contentformat;
+    Audio: Contentformat;
+    Data: Contentformat;
+    Multi: Contentformat;
+};

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

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+/**
+ * Describes the parameters of the essence inside this data Flow
+ */
+export interface DataFlowEssenceParameters {
+    /**
+     * The type of information encoded in the flow, identified using a URN. e.g. The data_type may be urn:x-tams:data:bounding-box, and the codec `application/json`.
+     */
+    data_type?: string;
+}

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

@@ -0,0 +1,104 @@
+import { FlowCoreSegmentDuration } from './flow-core-segment-duration';
+import { ContainerMapping1 } from './container-mapping1';
+import { CollectionItem } from './collection-item';
+import { DataFlowEssenceParameters } from './data-flow-essence-parameters';
+/**
+ * Describes a data Flow
+ */
+export interface DataFlow {
+    /**
+     * 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: DataFlow.FormatEnum;
+    essence_parameters: DataFlowEssenceParameters;
+}
+export declare namespace DataFlow {
+    type FormatEnum = 'urn:x-nmos:format:data';
+    const FormatEnum: {
+        UrnxNmosformatdata: FormatEnum;
+    };
+}

package/dist/react/omakase-components/src/types/tams/model/deletion-request-error.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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.
+ */
+/**
+ * Provides more information for the error status.
+ */
+export interface DeletionRequestError {
+    /**
+     * The error type name.
+     */
+    type: string;
+    /**
+     * Summary description of the error and causes.
+     */
+    summary: string;
+    /**
+     * Stack trace leading to error (as a list of strings)
+     */
+    traceback?: Array<string>;
+    /**
+     * Time at which the error ocurred, to aid in log correlation
+     */
+    time: string;
+}

package/dist/react/omakase-components/src/types/tams/model/deletion-request.d.ts

@@ -0,0 +1,56 @@
+import { DeletionRequestError } from './deletion-request-error';
+/**
+ * Describes an ongoing deletion request
+ */
+export interface DeletionRequest {
+    /**
+     * Deletion Request ID
+     */
+    id: string;
+    /**
+     * ID of the flow to which the deletion request relates
+     */
+    flow_id: string;
+    /**
+     * The timerange of FlowSegments to be deleted in this request, as described by the [TimeRange](../schemas/timerange#top) type
+     */
+    timerange_to_delete: string;
+    /**
+     * The timerange of FlowSegments not yet deleted by this request, as described by the [TimeRange](../schemas/timerange#top) type
+     */
+    timerange_remaining?: string;
+    /**
+     * Whether the Flow should be deleted once the timerange has been
+     */
+    delete_flow: boolean;
+    /**
+     * Date/Time when this deletion request was created
+     */
+    created?: string;
+    /**
+     * A string identifier for the entity that created the deletion request. 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;
+    /**
+     * Date/Time when this deletion request was updated
+     */
+    updated?: string;
+    /**
+     * Date/Time when this deletion request will be deleted
+     */
+    expiry?: string;
+    /**
+     * Status of the delete request
+     */
+    status: DeletionRequest.StatusEnum;
+    error?: DeletionRequestError;
+}
+export declare namespace DeletionRequest {
+    type StatusEnum = 'created' | 'started' | 'done' | 'error';
+    const StatusEnum: {
+        Created: StatusEnum;
+        Started: StatusEnum;
+        Done: StatusEnum;
+        Error: StatusEnum;
+    };
+}

package/dist/react/omakase-components/src/types/tams/model/event-stream-mechanism.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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.
+ */
+/**
+ * Describes an event stream mechanism available in this implementation of TAMS
+ */
+export interface EventStreamMechanism {
+    /**
+     * Name of this type of event stream mechanism. Must be unique. Any name defined in this specification is reserved
+     */
+    name: string;
+    /**
+     * Location (e.g. a URL) at which documentation for this event stream mechanism may be found
+     */
+    docs?: string;
+    /**
+     * Configuration options required to make use of this mechanism
+     */
+    config?: object;
+}

package/dist/react/omakase-components/src/types/tams/model/flow-core-segment-duration.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 target flow segment duration in seconds. The duration for each segment may vary around this target value. See also the [Setting Flow Bit Rate Properties](https://github.com/bbc/tams/blob/main/docs/appnotes/0013-setting-flow-bit-rate-properties.md) AppNote for how this property can be used to calculate buffer sizes.
+ */
+export interface FlowCoreSegmentDuration {
+    /**
+     * numerator
+     */
+    numerator: number;
+    /**
+     * denominator
+     */
+    denominator?: number;
+}

package/dist/react/omakase-components/src/types/tams/model/flow-segment-get-urls-inner.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+export interface FlowSegmentGetUrlsInner {
+    /**
+     * Label identifying this URL. If the \'label\' is not set then this URL can\'t be filtered for using the \'accept_get_urls\' API query parameter.
+     */
+    label?: string;
+    /**
+     * A URL to which a GET request can be made to directly retrieve the contents of the segment. Clients should include credentials if the provide URL is on the same origin as the API endpoint
+     */
+    url: string;
+}

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

@@ -0,0 +1,38 @@
+import { FlowSegmentGetUrlsInner } from './flow-segment-get-urls-inner';
+/**
+ * Provides the location and metadata of the media files corresponding to timerange segments of a Flow.
+ */
+export interface FlowSegment {
+    /**
+     * The object store identifier for the media object.
+     */
+    object_id: string;
+    /**
+     * The timestamp offset between the sample timestamps stored in the media file and the corresponding timestamp in the segment, ie. ts_offset = segment ts - media object ts. Assumed to be 0:0 if not set. Format as described by the [Timestamp](../schemas/timestamp#top) type, but cannot be negative
+     */
+    ts_offset?: string;
+    /**
+     * The timerange of segments that have been deleted. The timerange MUST intersect with a segment which has been deleted at both start and end (e.g. it cannot start or end in empty space).
+     */
+    timerange: string;
+    /**
+     * The difference between the exclusive end of the `timerange` and the last sample timestamp. Format as described by the [Timestamp](../schemas/timestamp#top) type, but cannot be negative
+     */
+    last_duration?: string;
+    /**
+     * The start of the segment represented as a count of samples from the start of the object. Note that a sample is a video frame or audio sample. A (coded) audio frame has multiple audio samples. Assumed to be 0 if not set.
+     */
+    sample_offset?: number;
+    /**
+     * The count of samples in the segment (which may be fewer than in the object). The count could be less than expected given the segment duration and rate if there are gaps. If not set, every sample from sample_offset onwards is used. Note that a sample is a video frame or audio sample. A (coded) audio frame has multiple audio samples
+     */
+    sample_count?: number;
+    /**
+     * A list of URLs to which a GET request can be made to directly retrieve the contents of the segment. This is required by the `http_object_store` media store type, which is the only one currently described. Clients may choose any URL in the list and treat them as identical, however servers may sort the list such that the preferred URL is first.
+     */
+    get_urls?: Array<FlowSegmentGetUrlsInner>;
+    /**
+     * The number of key frames in the segment. This should be set greater than zero when the segment contains key frames that serve as a stream access point
+     */
+    key_frame_count?: number;
+}

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

@@ -0,0 +1,38 @@
+import { FlowSegmentGetUrlsInner } from './flow-segment-get-urls-inner';
+/**
+ * Provides the location and metadata of the media files corresponding to timerange segments of a Flow.
+ */
+export interface FlowSegment1 {
+    /**
+     * The object store identifier for the media object.
+     */
+    object_id: string;
+    /**
+     * The timestamp offset between the sample timestamps stored in the media file and the corresponding timestamp in the segment, ie. ts_offset = segment ts - media object ts. Assumed to be 0:0 if not set. Format as described by the [Timestamp](../schemas/timestamp#top) type, but cannot be negative
+     */
+    ts_offset?: string;
+    /**
+     * The timerange for the samples contained in the segment. The timerange start is always inclusive. If samples have a duration then the timerange end is exclusive and covers at least the duration of the last sample. The exclusive timerange end will typically be set to the timestamp of the next sample. If the samples don\'t have a duration then the timerange end is inclusive. Format is described by the [TimeRange](../schemas/timerange#top) type. Note that where temporal re-ordering is used, the timerange and samples refers to the presentation timeline.
+     */
+    timerange: string;
+    /**
+     * The difference between the exclusive end of the `timerange` and the last sample timestamp. Format as described by the [Timestamp](../schemas/timestamp#top) type, but cannot be negative
+     */
+    last_duration?: string;
+    /**
+     * The start of the segment represented as a count of samples from the start of the object. Note that a sample is a video frame or audio sample. A (coded) audio frame has multiple audio samples. Assumed to be 0 if not set.
+     */
+    sample_offset?: number;
+    /**
+     * The count of samples in the segment (which may be fewer than in the object). The count could be less than expected given the segment duration and rate if there are gaps. If not set, every sample from sample_offset onwards is used. Note that a sample is a video frame or audio sample. A (coded) audio frame has multiple audio samples
+     */
+    sample_count?: number;
+    /**
+     * A list of URLs to which a GET request can be made to directly retrieve the contents of the segment. This is required by the `http_object_store` media store type, which is the only one currently described. Clients may choose any URL in the list and treat them as identical, however servers may sort the list such that the preferred URL is first.
+     */
+    get_urls?: Array<FlowSegmentGetUrlsInner>;
+    /**
+     * The number of key frames in the segment. This should be set greater than zero when the segment contains key frames that serve as a stream access point
+     */
+    key_frame_count?: number;
+}

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

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+/**
+ * Post data for the flow storage endpoint
+ */
+export interface FlowStoragePost {
+    /**
+     * Limit the number of storage segments in each response page. Implementations may specify their own default and maximum for the limit
+     */
+    limit?: number;
+}

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

@@ -0,0 +1,14 @@
+import { AudioFlow } from './audio-flow';
+import { VideoFlow } from './video-flow';
+import { MultiEssenceFlow } from './multi-essence-flow';
+import { DataFlow } from './data-flow';
+import { ImageFlow } from './image-flow';
+/**
+ * Describes a Flow
+ */
+/**
+ * @type Flow
+ * Describes a Flow
+ * @export
+ */
+export type Flow = AudioFlow | DataFlow | MultiEssenceFlow | VideoFlow | ImageFlow;

package/dist/react/omakase-components/src/types/tams/model/http-request.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ * Gives information on a particular http request a client should perform
+ */
+export interface HTTPRequest {
+    /**
+     * The URL to make the request to
+     */
+    url: string;
+    /**
+     * The text of the body which needs to be included in the request
+     */
+    body?: string;
+    /**
+     * The content type which must be used
+     */
+    'content-type'?: string;
+    /**
+     * Additional headers that should be included
+     */
+    headers?: {
+        [key: string]: string;
+    };
+}

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

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+/**
+ * Describes the parameters of the essence inside this image Flow
+ */
+export interface ImageFlowEssenceParameters {
+    /**
+     * Parameters describing the essence of image Flow
+     */
+    frame_width: number;
+    frame_height: number;
+}