@svta/cml-cmsd 1.1.0 → 1.1.2

package/README.md

@@ -11,16 +11,23 @@ npm i @svta/cml-cmsd
 ## Usage
 
 ```typescript
-import { encodeCmsdStatic } from "@svta/cml-cmsd";
+import {
+	CmsdObjectType,
+	CmsdStreamingFormat,
+	CmsdStreamType,
+	encodeCmsdStatic,
+} from "@svta/cml-cmsd";
+import type { CmsdStatic } from "@svta/cml-cmsd";
 
-const input = Object.assign({}, CMSD_STATIC_OBJ, {
-	ot: new SfToken(CmsdObjectType.VIDEO),
-	sf: new SfToken(CmsdStreamingFormat.HLS),
-	st: new SfToken(CmsdStreamType.VOD),
-});
+const input: CmsdStatic = {
+	ot: CmsdObjectType.VIDEO,
+	sf: CmsdStreamingFormat.HLS,
+	st: CmsdStreamType.VOD,
+	d: 5000,
+	br: 2000,
+	n: "OriginProviderA",
+};
 
-assert(
-	encodeCmsdStatic(input) ===
-		`ot=v,sf=h,st=v,d=5000,br=2000,n="OriginProviderA"`
-);
+console.log(encodeCmsdStatic(input));
+// ot=v,sf=h,st=v,d=5000,br=2000,n="OriginProviderA"
 ```

package/dist/index.d.ts

@@ -1,462 +1,461 @@
 import { CmObjectType, CmStreamType, CmStreamingFormat } from "@svta/cml-cta";
 import { SfItem, SfToken } from "@svta/cml-structured-field-values";
 import { ValueOf } from "@svta/cml-utils";
-
 //#region src/CMSD_DYNAMIC.d.ts
 /**
-* CMSD dynamic header name.
-*
-* @public
-*/
-declare const CMSD_DYNAMIC = "CMSD-Dynamic";
+ * CMSD dynamic header name.
+ *
+ * @public
+ */
+export declare const CMSD_DYNAMIC = "CMSD-Dynamic";
 //#endregion
 //#region src/CMSD_STATIC.d.ts
 /**
-* CMSD static header name.
-*
-* @public
-*/
-declare const CMSD_STATIC = "CMSD-Static";
+ * CMSD static header name.
+ *
+ * @public
+ */
+export declare const CMSD_STATIC = "CMSD-Static";
 //#endregion
 //#region src/CMSD_V1.d.ts
 /**
-* CMSD Version 1
-*
-* @public
-*/
-declare const CMSD_V1 = 1;
+ * CMSD Version 1
+ *
+ * @public
+ */
+export declare const CMSD_V1 = 1;
 //#endregion
 //#region src/CmsdCustomKey.d.ts
 /**
-* A custom key for CMSD. Custom keys MUST carry a hyphenated prefix
-* to ensure that there will not be a namespace collision with future
-* revisions to this specification. Clients SHOULD use a reverse-DNS
-* syntax when defining their own prefix.
-*
-* The type requires a lowercase hyphenated string. At runtime a key
-* must also satisfy {@link isCmsdCustomKey} (a lowercase first
-* letter, then characters from `a-z 0-9 . -`, with a hyphen that is
-* neither the first nor the last character), the subset of the CMSD
-* custom-key grammar that survives RFC 8941 key serialization. Keys
-* failing it fail structured-field serialization at encode time.
-* Lowercase reverse-DNS names satisfy all constraints.
-*
-* @public
-*/
+ * A custom key for CMSD. Custom keys MUST carry a hyphenated prefix
+ * to ensure that there will not be a namespace collision with future
+ * revisions to this specification. Clients SHOULD use a reverse-DNS
+ * syntax when defining their own prefix.
+ *
+ * The type requires a lowercase hyphenated string. At runtime a key
+ * must also satisfy {@link isCmsdCustomKey} (a lowercase first
+ * letter, then characters from `a-z 0-9 . -`, with a hyphen that is
+ * neither the first nor the last character), the subset of the CMSD
+ * custom-key grammar that survives RFC 8941 key serialization. Keys
+ * failing it fail structured-field serialization at encode time.
+ * Lowercase reverse-DNS names satisfy all constraints.
+ *
+ * @public
+ */
 type CmsdCustomKey = Lowercase<`${string}-${string}`>;
 //#endregion
 //#region src/CmsdObjectType.d.ts
 /**
-* Common Media Server Data Object Type
-*
-*
-* @enum
-*
-* @public
-*/
-declare const CmsdObjectType: typeof CmObjectType;
+ * Common Media Server Data Object Type
+ *
+ *
+ * @enum
+ *
+ * @public
+ */
+export declare const CmsdObjectType: typeof CmObjectType;
 /**
-* @public
-*/
-type CmsdObjectType = CmObjectType;
+ * @public
+ */
+export type CmsdObjectType = CmObjectType;
 //#endregion
 //#region src/CmsdStreamType.d.ts
 /**
-* Common Media Server Data Stream Type
-*
-*
-* @enum
-*
-* @public
-*/
-declare const CmsdStreamType: typeof CmStreamType;
+ * Common Media Server Data Stream Type
+ *
+ *
+ * @enum
+ *
+ * @public
+ */
+export declare const CmsdStreamType: typeof CmStreamType;
 /**
-* @public
-*/
-type CmsdStreamType = CmStreamType;
+ * @public
+ */
+export type CmsdStreamType = CmStreamType;
 //#endregion
 //#region src/CmsdStreamingFormat.d.ts
 /**
-* Common Media Server Data Streaming Format
-*
-*
-* @enum
-*
-* @public
-*/
-declare const CmsdStreamingFormat: typeof CmStreamingFormat;
+ * Common Media Server Data Streaming Format
+ *
+ *
+ * @enum
+ *
+ * @public
+ */
+export declare const CmsdStreamingFormat: typeof CmStreamingFormat;
 /**
-* @public
-*/
-type CmsdStreamingFormat = CmStreamingFormat;
+ * @public
+ */
+export type CmsdStreamingFormat = CmStreamingFormat;
 //#endregion
 //#region src/CmsdValue.d.ts
 /**
-* CMSD Value
-*
-* @public
-*/
+ * CMSD Value
+ *
+ * @public
+ */
 type CmsdValue = CmsdObjectType | CmsdStreamingFormat | CmsdStreamType | string | number | boolean | symbol | SfToken;
 //#endregion
 //#region src/CmsdDynamicParams.d.ts
 /**
-* Common Media Server Data (CMSD) dynamic response header field parameters.
-*
-* @see {@link https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5006-final.pdf|CMSD Spec}
-*
-* @public
-*/
+ * Common Media Server Data (CMSD) dynamic response header field parameters.
+ *
+ * @see {@link https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5006-final.pdf|CMSD Spec}
+ *
+ * @public
+ */
 type CmsdDynamicParams = {
   /**
-  * Custom key names may be used, but they MUST carry a hyphenated prefix to ensure that there will not be a namespace collision
-  * with future revisions to this specification. Clients SHOULD use a reverse-DNS syntax when defining their own prefix.
-  */
+   * Custom key names may be used, but they MUST carry a hyphenated prefix to ensure that there will not be a namespace collision
+   * with future revisions to this specification. Clients SHOULD use a reverse-DNS syntax when defining their own prefix.
+   */
   [index: CmsdCustomKey]: CmsdValue;
   /**
-  * Duress
-  *
-  * Key is included without a value if the server is under duress, due to cpu, memory, disk IO, network IO or other reasons. The
-  * thresholds for signaling duress are left to the discretion of the server operator. The intent is that the client will use this
-  * signal to move away to an alternate server if possible. This key MUST NOT be sent if it is false.
-  *
-  * Boolean
-  */
+   * Duress
+   *
+   * Key is included without a value if the server is under duress, due to cpu, memory, disk IO, network IO or other reasons. The
+   * thresholds for signaling duress are left to the discretion of the server operator. The intent is that the client will use this
+   * signal to move away to an alternate server if possible. This key MUST NOT be sent if it is false.
+   *
+   * Boolean
+   */
   du?: boolean;
   /**
-  * Estimated Throughput
-  *
-  * The throughput between the server and the client over the currently negotiated transport as estimated by the server at the start
-  * of the response. The value is expressed in units of kilobits per second and rounded to the nearest integer. The time window for
-  * this estimate is expected to be the duration of the current response at most. The throughput may vary during the response and the
-  * client SHOULD use this data as an adjunct to its own throughput estimates. As an informative example, this estimate could be
-  * derived in this way:
-  *
-  *   etp = 8 * send_window / (rtt)
-  *
-  * where send_window = min (cwnd * mss, rwnd) with Congestion Window (cwnd) measured in packets, Maximum Segment Size (mss) in bytes,
-  * Receiver Window (rwnd) in bytes and rtt in milliseconds. Note that multiple client processes adjacent to the media player may pool
-  * their requests into the same connection to the server. In this case the server estimate of throughput will be against the entirety
-  * of the connection, not all of which will be accessible to the media player.
-  *
-  * Integer Kbps
-  */
+   * Estimated Throughput
+   *
+   * The throughput between the server and the client over the currently negotiated transport as estimated by the server at the start
+   * of the response. The value is expressed in units of kilobits per second and rounded to the nearest integer. The time window for
+   * this estimate is expected to be the duration of the current response at most. The throughput may vary during the response and the
+   * client SHOULD use this data as an adjunct to its own throughput estimates. As an informative example, this estimate could be
+   * derived in this way:
+   *
+   *   etp = 8 * send_window / (rtt)
+   *
+   * where send_window = min (cwnd * mss, rwnd) with Congestion Window (cwnd) measured in packets, Maximum Segment Size (mss) in bytes,
+   * Receiver Window (rwnd) in bytes and rtt in milliseconds. Note that multiple client processes adjacent to the media player may pool
+   * their requests into the same connection to the server. In this case the server estimate of throughput will be against the entirety
+   * of the connection, not all of which will be accessible to the media player.
+   *
+   * Integer Kbps
+   */
   etp?: number;
   /**
-  * Max suggested bitrate
-  *
-  * The maximum bitrate value that the player SHOULD play in its Adaptive Bit Rate (ABR) ladder. If the player is playing a bitrate higher
-  * than this value, it SHOULD immediately switch to a bitrate lower than or equal to this value.
-  *
-  * Integer Kbps
-  */
+   * Max suggested bitrate
+   *
+   * The maximum bitrate value that the player SHOULD play in its Adaptive Bit Rate (ABR) ladder. If the player is playing a bitrate higher
+   * than this value, it SHOULD immediately switch to a bitrate lower than or equal to this value.
+   *
+   * Integer Kbps
+   */
   mb?: number;
   /**
-  * Response delay
-  *
-  * The time elapsed between the receipt of the request and when the first byte of the body becomes available to send to the client. The
-  * intention is for receivers to use this value to more accurately calculate the throughput of the connection [MHV22].
-  *
-  * Integer milliseconds
-  */
+   * Response delay
+   *
+   * The time elapsed between the receipt of the request and when the first byte of the body becomes available to send to the client. The
+   * intention is for receivers to use this value to more accurately calculate the throughput of the connection [MHV22].
+   *
+   * Integer milliseconds
+   */
   rd?: number;
   /**
-  * Round Trip Time
-  *
-  * Estimated round trip time between client and server. This estimate may be derived from the transport handshake. For subsequent requests
-  * over the same connection, the value can be refined to be an exponentially weighted moving average of prior instantaneous values. An
-  * informative example algorithm for this averaging is provided by [18].
-  *
-  * Integer Kbps
-  */
+   * Round Trip Time
+   *
+   * Estimated round trip time between client and server. This estimate may be derived from the transport handshake. For subsequent requests
+   * over the same connection, the value can be refined to be an exponentially weighted moving average of prior instantaneous values. An
+   * informative example algorithm for this averaging is provided by [18].
+   *
+   * Integer Kbps
+   */
   rtt?: number;
 };
 //#endregion
 //#region src/CmsdDynamic.d.ts
 /**
-* Common Media Server Data (CMSD) dynamic response header fields.
-*
-* @see {@link https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5006-final.pdf|CMSD Spec}
-*
-* @public
-*/
+ * Common Media Server Data (CMSD) dynamic response header fields.
+ *
+ * @see {@link https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5006-final.pdf|CMSD Spec}
+ *
+ * @public
+ */
 type CmsdDynamic = {
   /**
-  * The server name.
-  */
+   * The server name.
+   */
   value: string;
   /**
-  * The CMSD dynamic parameters.
-  */
+   * The CMSD dynamic parameters.
+   */
   params: CmsdDynamicParams;
 };
 //#endregion
 //#region src/CmsdEncodeOptions.d.ts
 /**
-* Options for encoding CMCD values.
-*
-* @public
-*/
+ * Options for encoding CMCD values.
+ *
+ * @public
+ */
 type CmsdEncodeOptions = {
   /**
-  * Use Symbol to represent token values
-  *
-  * @defaultValue `true`
-  */
+   * Use Symbol to represent token values
+   *
+   * @defaultValue `true`
+   */
   useSymbol?: boolean;
 };
 //#endregion
 //#region src/CmsdHeaderField.d.ts
 /**
-* CMSD header fields.
-*
-*
-* @enum
-*
-* @public
-*/
-declare const CmsdHeaderField: {
+ * CMSD header fields.
+ *
+ *
+ * @enum
+ *
+ * @public
+ */
+export declare const CmsdHeaderField: {
   /**
-  * Keys whose values persist over multiple requests for the object.
-  */
+   * Keys whose values persist over multiple requests for the object.
+   */
   readonly STATIC: typeof CMSD_STATIC;
   /**
-  * Keys whose values apply only to the next transmission hop. Typically a
-  * new CMSD-Dynamic header instance will be added by each intermediary
-  * participating in the delivery.
-  */
+   * Keys whose values apply only to the next transmission hop. Typically a
+   * new CMSD-Dynamic header instance will be added by each intermediary
+   * participating in the delivery.
+   */
   readonly DYNAMIC: typeof CMSD_DYNAMIC;
 };
 /**
-* @public
-*/
-type CmsdHeaderField = ValueOf<typeof CmsdHeaderField>;
+ * @public
+ */
+export type CmsdHeaderField = ValueOf<typeof CmsdHeaderField>;
 //#endregion
 //#region src/CmsdStatic.d.ts
 /**
-* Common Media Server Data (CMSD) static response header fields.
-*
-* @see {@link https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5006-final.pdf|CMSD Spec}
-*
-* @public
-*/
+ * Common Media Server Data (CMSD) static response header fields.
+ *
+ * @see {@link https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5006-final.pdf|CMSD Spec}
+ *
+ * @public
+ */
 type CmsdStatic = {
   /**
-  * Custom key names may be used, but they MUST carry a hyphenated prefix to ensure that there will not be a namespace collision
-  * with future revisions to this specification. Clients SHOULD use a reverse-DNS syntax when defining their own prefix.
-  */
+   * Custom key names may be used, but they MUST carry a hyphenated prefix to ensure that there will not be a namespace collision
+   * with future revisions to this specification. Clients SHOULD use a reverse-DNS syntax when defining their own prefix.
+   */
   [index: CmsdCustomKey]: CmsdValue;
   /**
-  * Availability time
-  *
-  * The wallclock time at which the first byte of this object became available at the origin for successful request. The time is
-  * expressed as integer milliseconds since the Unix Epoch, i.e., the number of milliseconds that have elapsed since January 1,
-  * 1970 (midnight UTC/GMT), not counting leap seconds (in ISO 8601: 1970- 01-01T00:00:000Z).
-  *
-  * Integer Milliseconds
-  */
+   * Availability time
+   *
+   * The wallclock time at which the first byte of this object became available at the origin for successful request. The time is
+   * expressed as integer milliseconds since the Unix Epoch, i.e., the number of milliseconds that have elapsed since January 1,
+   * 1970 (midnight UTC/GMT), not counting leap seconds (in ISO 8601: 1970- 01-01T00:00:000Z).
+   *
+   * Integer Milliseconds
+   */
   at?: number;
   /**
-  * Encoded bitrate
-  *
-  * The encoded bitrate of the audio or video object being requested. If the instantaneous bitrate varies over the duration of the
-  * object, the average value over the duration of the object SHOULD be communicated. This key should only accompany objects that
-  * have an implicit bitrate.
-  *
-  * Integer kbps
-  */
+   * Encoded bitrate
+   *
+   * The encoded bitrate of the audio or video object being requested. If the instantaneous bitrate varies over the duration of the
+   * object, the average value over the duration of the object SHOULD be communicated. This key should only accompany objects that
+   * have an implicit bitrate.
+   *
+   * Integer kbps
+   */
   br?: number;
   /**
-  * Object duration
-  *
-  * The playback duration in milliseconds of the object being requested. If a partial segment is being requested, then this value
-  * MUST indicate the playback duration of that part and not that of its parent segment. This value can be an approximation of the
-  * estimated duration if the explicit value is not known.
-  *
-  * Integer milliseconds
-  */
+   * Object duration
+   *
+   * The playback duration in milliseconds of the object being requested. If a partial segment is being requested, then this value
+   * MUST indicate the playback duration of that part and not that of its parent segment. This value can be an approximation of the
+   * estimated duration if the explicit value is not known.
+   *
+   * Integer milliseconds
+   */
   d?: number;
   /**
-  * Held time
-  *
-  * The number of milliseconds that this response was held back by an origin before returning. This is applicable to blocking responses
-  * under LL-HLS [HLSbis].
-  *
-  * Integer Milliseconds
-  */
+   * Held time
+   *
+   * The number of milliseconds that this response was held back by an origin before returning. This is applicable to blocking responses
+   * under LL-HLS [HLSbis].
+   *
+   * Integer Milliseconds
+   */
   ht?: number;
   /**
-  * Intermediary identifier
-  *
-  * An identifier for the processing server. The value SHOULD identify both the organization and the intermediary that is writing the key.
-  * Identifiers SHOULD be as concise as possible to reduce log file and transferred size, while still remaining unique.
-  *
-  * String
-  */
+   * Intermediary identifier
+   *
+   * An identifier for the processing server. The value SHOULD identify both the organization and the intermediary that is writing the key.
+   * Identifiers SHOULD be as concise as possible to reduce log file and transferred size, while still remaining unique.
+   *
+   * String
+   */
   n?: string;
   /**
-  * Next object request
-  *
-  * Relative path of the next object to be requested. This can be used to trigger pre-fetching by the CDN. This MUST be a path relative to the current
-  * request. This string MUST be URLEncoded. The client SHOULD NOT depend upon any pre-fetch action being taken - it is merely a request for such a
-  * pre-fetch to take place.
-  *
-  * String
-  */
+   * Next object request
+   *
+   * Relative path of the next object to be requested. This can be used to trigger pre-fetching by the CDN. This MUST be a path relative to the current
+   * request. This string MUST be URLEncoded. The client SHOULD NOT depend upon any pre-fetch action being taken - it is merely a request for such a
+   * pre-fetch to take place.
+   *
+   * String
+   */
   nor?: string;
   /**
-  * Next range request
-  *
-  * If the next request will be a partial object request, then this string denotes the byte range to be requested. If the ‘nor’ field is not set, then the
-  * object is assumed to match the object currently being requested. The client SHOULD NOT depend upon any pre-fetch action being taken – it is merely a
-  * request for such a pre-fetch to take place. Formatting is similar to the HTTP Range header, except that the unit MUST be ‘byte’, the ‘Range:’ prefix is
-  * NOT required and specifying multiple ranges is NOT allowed. Valid combinations are:
-  *
-  * - `"\<range-start\>-"`
-  * - `"\<range-start\>-\<range-end\>"`
-  * - `"-\<suffix-length\>"`
-  *
-  * String
-  */
+   * Next range request
+   *
+   * If the next request will be a partial object request, then this string denotes the byte range to be requested. If the ‘nor’ field is not set, then the
+   * object is assumed to match the object currently being requested. The client SHOULD NOT depend upon any pre-fetch action being taken – it is merely a
+   * request for such a pre-fetch to take place. Formatting is similar to the HTTP Range header, except that the unit MUST be ‘byte’, the ‘Range:’ prefix is
+   * NOT required and specifying multiple ranges is NOT allowed. Valid combinations are:
+   *
+   * - `"\<range-start\>-"`
+   * - `"\<range-start\>-\<range-end\>"`
+   * - `"-\<suffix-length\>"`
+   *
+   * String
+   */
   nrr?: string;
   /**
-  * Object type
-  *
-  * The media type of the current object being requested:
-  * - `m` = text file, such as a manifest or playlist
-  * - `a` = audio only
-  * - `v` = video only
-  * - `av` = muxed audio and video
-  * - `i` = init segment
-  * - `c` = caption or subtitle
-  * - `tt` = ISOBMFF timed text track
-  * - `k` = cryptographic key, license or certificate.
-  * - `o` = other
-  *
-  * If the object type being requested is unknown, then this key MUST NOT be used.
-  *
-  * Token
-  */
+   * Object type
+   *
+   * The media type of the current object being requested:
+   * - `m` = text file, such as a manifest or playlist
+   * - `a` = audio only
+   * - `v` = video only
+   * - `av` = muxed audio and video
+   * - `i` = init segment
+   * - `c` = caption or subtitle
+   * - `tt` = ISOBMFF timed text track
+   * - `k` = cryptographic key, license or certificate.
+   * - `o` = other
+   *
+   * If the object type being requested is unknown, then this key MUST NOT be used.
+   *
+   * Token
+   */
   ot?: CmsdObjectType;
   /**
-  * Streaming format
-  *
-  * The streaming format that defines the current request.
-  *
-  * - `d` = MPEG DASH
-  * - `h` = HTTP Live Streaming (HLS)
-  * - `s` = Smooth Streaming
-  * - `o` = other
-  *
-  * If the streaming format being requested is unknown, then this key MUST NOT be used.
-  *
-  * Token
-  */
+   * Streaming format
+   *
+   * The streaming format that defines the current request.
+   *
+   * - `d` = MPEG DASH
+   * - `h` = HTTP Live Streaming (HLS)
+   * - `s` = Smooth Streaming
+   * - `o` = other
+   *
+   * If the streaming format being requested is unknown, then this key MUST NOT be used.
+   *
+   * Token
+   */
   sf?: CmsdStreamingFormat;
   /**
-  * Stream type
-  * - `v` = all segments are available – e.g., VOD
-  * - `l` = segments become available over time – e.g., LIVE
-  *
-  * Token
-  */
+   * Stream type
+   * - `v` = all segments are available – e.g., VOD
+   * - `l` = segments become available over time – e.g., LIVE
+   *
+   * Token
+   */
   st?: CmsdStreamType;
   /**
-  * Startup
-  *
-  * Key is included without a value if the object is needed urgently due to startup, seeking or recovery after a buffer-empty event. The media SHOULD not be
-  * rendering when this request is made. This key MUST not be sent if it is FALSE.
-  *
-  * Boolean
-  */
+   * Startup
+   *
+   * Key is included without a value if the object is needed urgently due to startup, seeking or recovery after a buffer-empty event. The media SHOULD not be
+   * rendering when this request is made. This key MUST not be sent if it is FALSE.
+   *
+   * Boolean
+   */
   su?: boolean;
   /**
-  * CMSD version
-  *
-  * The version of this specification used for interpreting the defined key names and values. If this key is omitted, the client and server MUST
-  * interpret the values as being defined by version 1. Client SHOULD omit this field if the version is 1.
-  *
-  * Integer
-  */
+   * CMSD version
+   *
+   * The version of this specification used for interpreting the defined key names and values. If this key is omitted, the client and server MUST
+   * interpret the values as being defined by version 1. Client SHOULD omit this field if the version is 1.
+   *
+   * Integer
+   */
   v?: number;
 };
 //#endregion
 //#region src/decodeCmsdDynamic.d.ts
 /**
-* Decode a CMSD dynamic string to an object.
-*
-* @param cmsd - The CMSD string to decode.
-*
-* @returns The decoded CMSD object.
-*
-* @public
-*/
-declare function decodeCmsdDynamic(cmsd: string): CmsdDynamic[];
+ * Decode a CMSD dynamic string to an object.
+ *
+ * @param cmsd - The CMSD string to decode.
+ *
+ * @returns The decoded CMSD object.
+ *
+ * @public
+ */
+export declare function decodeCmsdDynamic(cmsd: string): CmsdDynamic[];
 //#endregion
 //#region src/decodeCmsdStatic.d.ts
 /**
-* Decode a CMSD Static dict string to an object.
-*
-* @param cmsd - The CMSD string to decode.
-*
-* @returns The decoded CMSD object.
-*
-* @public
-*/
-declare function decodeCmsdStatic(cmsd: string): CmsdStatic;
+ * Decode a CMSD Static dict string to an object.
+ *
+ * @param cmsd - The CMSD string to decode.
+ *
+ * @returns The decoded CMSD object.
+ *
+ * @public
+ */
+export declare function decodeCmsdStatic(cmsd: string): CmsdStatic;
 //#endregion
 //#region src/encodeCmsdDynamic.d.ts
 /**
-* Encode a list of CMSD Dynamic objects.
-*
-* @param value - The list of `SfItems` to encode.
-*
-* @returns The encoded CMSD string.
-*
-* @public
-*/
-declare function encodeCmsdDynamic(value: SfItem[]): string;
+ * Encode a list of CMSD Dynamic objects.
+ *
+ * @param value - The list of `SfItems` to encode.
+ *
+ * @returns The encoded CMSD string.
+ *
+ * @public
+ */
+export declare function encodeCmsdDynamic(value: SfItem[]): string;
 /**
-* Encode a single CMSD Dynamic object.
-*
-* @param value - The server name
-* @param cmsd - The CMSD object to encode.
-*
-* @returns The encoded CMSD string.
-*
-* @public
-*/
-declare function encodeCmsdDynamic(value: string, cmsd: CmsdDynamic): string;
+ * Encode a single CMSD Dynamic object.
+ *
+ * @param value - The server name
+ * @param cmsd - The CMSD object to encode.
+ *
+ * @returns The encoded CMSD string.
+ *
+ * @public
+ */
+export declare function encodeCmsdDynamic(value: string, cmsd: CmsdDynamic): string;
 //#endregion
 //#region src/encodeCmsdStatic.d.ts
 /**
-* Encode a CMSD Static object.
-*
-* @param cmsd - The CMSD object to encode.
-* @param options - Encoding options
-*
-* @returns The encoded CMSD string.
-*
-* @public
-*/
-declare function encodeCmsdStatic(cmsd: CmsdStatic, options?: CmsdEncodeOptions): string;
+ * Encode a CMSD Static object.
+ *
+ * @param cmsd - The CMSD object to encode.
+ * @param options - Encoding options
+ *
+ * @returns The encoded CMSD string.
+ *
+ * @public
+ */
+export declare function encodeCmsdStatic(cmsd: CmsdStatic, options?: CmsdEncodeOptions): string;
 //#endregion
 //#region src/isCmsdCustomKey.d.ts
 /**
-* Check if a key is a valid custom key: a lowercase first letter, then
-* characters from `a-z 0-9 . -`, with a hyphen that is neither the first
-* nor the last character. These are the CMSD custom-key rules restricted
-* to names that survive RFC 8941 key serialization.
-*
-* @param key - The key to check.
-*
-* @returns `true` if the key is a custom key, `false` otherwise.
-*
-* @public
-*
-* @example
-* {@includeCode ../test/isCmsdCustomKey.test.ts#example}
-*/
-declare function isCmsdCustomKey(key: string): boolean;
+ * Check if a key is a valid custom key: a lowercase first letter, then
+ * characters from `a-z 0-9 . -`, with a hyphen that is neither the first
+ * nor the last character. These are the CMSD custom-key rules restricted
+ * to names that survive RFC 8941 key serialization.
+ *
+ * @param key - The key to check.
+ *
+ * @returns `true` if the key is a custom key, `false` otherwise.
+ *
+ * @public
+ *
+ * @example
+ * {@includeCode ../test/isCmsdCustomKey.test.ts#example}
+ */
+export declare function isCmsdCustomKey(key: string): boolean;
 //#endregion
-export { CMSD_DYNAMIC, CMSD_STATIC, CMSD_V1, CmsdCustomKey, CmsdDynamic, CmsdDynamicParams, CmsdEncodeOptions, CmsdHeaderField, CmsdObjectType, CmsdStatic, CmsdStreamType, CmsdStreamingFormat, CmsdValue, decodeCmsdDynamic, decodeCmsdStatic, encodeCmsdDynamic, encodeCmsdStatic, isCmsdCustomKey };
+export type { CmsdCustomKey, CmsdDynamic, CmsdDynamicParams, CmsdEncodeOptions, CmsdStatic, CmsdValue };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/CMSD_DYNAMIC.ts","../src/CMSD_STATIC.ts","../src/CMSD_V1.ts","../src/CmsdCustomKey.ts","../src/CmsdObjectType.ts","../src/CmsdStreamType.ts","../src/CmsdStreamingFormat.ts","../src/CmsdValue.ts","../src/CmsdDynamicParams.ts","../src/CmsdDynamic.ts","../src/CmsdEncodeOptions.ts","../src/CmsdHeaderField.ts","../src/CmsdStatic.ts","../src/decodeCmsdDynamic.ts","../src/decodeCmsdStatic.ts","../src/encodeCmsdDynamic.ts","../src/encodeCmsdStatic.ts","../src/isCmsdCustomKey.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;AAKa,cAAA,YAAA,GAAA,cAAA;;;;;;;;AAAA,cCAA,WAAA,GDAA,aAAA;;;;;;;;AAAA,cEAA,OAAA,GFAA,CAAA;;;;;;;;AAAb;;;;ACAA;;;;ACAA;;;KCWY,aAAA,GAAgB;;;;;;;AHX5B;;;;ACAa,cGKA,cHLA,EAAA,OGKwC,YHLxC;;;;ACAA,KEUD,cAAA,GAAiB,YFVhB;;;;;;;AFAb;;;;ACAa,cIKA,cJLA,EAAA,OIKwC,YJLxC;;;;ACAA,KGUD,cAAA,GAAiB,YHVhB;;;;;;;AFAb;;;;ACAa,cKKA,mBLLA,EAAA,OKKkD,iBLLlD;;;;ACAA,KIUD,mBAAA,GAAsB,iBJVrB;;;;AFAb;;;;ACAa,KMKD,SAAA,GAAY,cNLX,GMK4B,mBNL5B,GMKkD,cNLlD,GAAA,MAAA,GAAA,MAAA,GAAA,OAAA,GAAA,MAAA,GMKwG,ONLxG;;;;;;ADAb;;;;ACAa,KOKD,iBAAA,GPLC;;;;ACAb;UMUS,gBAAgB;;;ALCzB;;;;ACNA;AAKA;;;;ACLA;AAKA;;;;ACLA;AAKA;;;;ACLA;;;;;;;;;ACAA;;;;ACDA;;;;ECJA;;;;ACOA;AAiBA;;;;EChBA;;;;;;;;;;ACDA,CAAA;;;;;;;AbPA;;;KSIY,WAAA;ERJZ;;;;ECAA;;;UOaS;ANFT,CAAA;;;;;;;;AHXa,KUAD,iBAAA,GVAC;;;;ACAb;;;;;;;;ADAA;;;;ACAA;;cUOa;;ATPb;;0BSW+B;;ARA/B;;;;ECNA,SAAa,OAAA,EAAA,OOaoB,YPboB;AAKrD,CAAA;;;;ACLa,KMmBD,eAAA,GAAkB,ONnBuB,CAAA,OMmBR,eNnBQ,CAAA;;;ALLrD;;;;ACAA;;;KWQY,UAAA;EVRZ;;;;ECWA,CAAA,KAAY,ESGH,aTHG,CAAA,ESGa,STHG;;;;ACN5B;AAKA;;;;ACLA;EAKA,EAAA,CAAY,EAAA,MAAA;;;;ACLZ;AAKA;;;;ACLA;EAAwB,EAAA,CAAA,EAAA,MAAA;EAAiB;;;;;;;ACAzC;;;;ACDA;;;;ACJA;;;;ECOA;AAiBA;;;;AChBA;;;EA0GM,CAAA,CAAA,EAAA,MAAA;EAgBA;;;;;;AC3HN;;;;ECAA;;;;ACAA;AAYA;;;;ACTA;;;;ACIA;;;;;;;;;;;;;;;;;;;;OLoGM;;;;;;;;;;;;;;;OAgBA;;;;;;;;OASA;;;;;;;;;;;;;;;;;;;;;;;;;;AZ3IN;;;;ACAA;iBYOgB,iBAAA,gBAAiC;;;;;;;AbPjD;;;;ACAA;iBaOgB,gBAAA,gBAAgC;;;;;;AdPhD;;;;ACAA;;iBcOgB,iBAAA,QAAyB;;AbPzC;;;;ACWA;;;;ACNA;AAKY,iBWSI,iBAAA,CXTa,KAAA,EAAA,MAAA,EAAA,IAAA,EWS0B,WXT1B,CAAA,EAAA,MAAA;;;;;;AJV7B;;;;ACAA;;;iBeUgB,gBAAA,OAAuB,sBAAsB;;;;;;;;AhBV7D;;;;ACAA;;;;ACAA;;iBecgB,eAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/CMSD_DYNAMIC.ts","../src/CMSD_STATIC.ts","../src/CMSD_V1.ts","../src/CmsdCustomKey.ts","../src/CmsdObjectType.ts","../src/CmsdStreamType.ts","../src/CmsdStreamingFormat.ts","../src/CmsdValue.ts","../src/CmsdDynamicParams.ts","../src/CmsdDynamic.ts","../src/CmsdEncodeOptions.ts","../src/CmsdHeaderField.ts","../src/CmsdStatic.ts","../src/decodeCmsdDynamic.ts","../src/decodeCmsdStatic.ts","../src/encodeCmsdDynamic.ts","../src/encodeCmsdStatic.ts","../src/isCmsdCustomKey.ts"],"mappings":";;;;;;;;;qBAKa;;;;;;;;qBCAA;;;;;;;;qBCAA;;;;;;;;;;;;;;;;;;;KCWD,gBAAgB;;;;;;;;;;;qBCNf,uBAAwC;;;;YAKzC,iBAAiB;;;;;;;;;;;qBCLhB,uBAAwC;;;;YAKzC,iBAAiB;;;;;;;;;;;qBCLhB,4BAAkD;;;;YAKnD,sBAAsB;;;;;;;;KCLtB,YAAY,iBAAiB,sBAAsB,sDAAsD;;;;;;;;;;KCAzG;;;;;GAKH,OAAA,gBAAgB;;;;;;;;;;EAWxB;;;;;;;;;;;;;;;;;;;EAoBA;;;;;;;;;EAUA;;;;;;;;;EAUA;;;;;;;;;;EAWA;;;;;;;;;;;KCpEW;;;;EAIX;;;;EAKA,QAAQ;;;;;;;;;KCbG;;;;;;EAMX;;;;;;;;;;;;qBCCY;;;;WAIZ,eAA8B;;;;;;WAO9B,gBAAgC;;;;;YAMrB,kBAAkB,eAAe;;;;;;;;;;KChBjC;;;;;GAMH,OAAA,gBAAgB;;;;;;;;;;EAWxB;;;;;;;;;;EAWA;;;;;;;;;;EAWA;;;;;;;;;EAUA;;;;;;;;;EAUA;;;;;;;;;;EAWA;;;;;;;;;;;;;;;EAgBA;;;;;;;;;;;;;;;;;;;EAoBA,KAAK;;;;;;;;;;;;;;;EAgBL,KAAK;;;;;;;;EASL,KAAK;;;;;;;;;EAUL;;;;;;;;;EAUA;;;;;;;;;;;;;wBCxJe,kBAAkB,eAAe;;;;;;;;;;;;wBCAjC,iBAAiB,eAAe;;;;;;;;;;;;wBCAhC,kBAAkB,OAAO;;;;;;;;;;;wBAYzB,kBAAkB,eAAe,MAAM;;;;;;;;;;;;;wBCTvC,iBAAiB,MAAM,YAAY,UAAU;;;;;;;;;;;;;;;;;;wBCI7C,gBAAgB"}

package/dist/index.js

@@ -1,6 +1,5 @@
 import { CmObjectType, CmStreamType, CmStreamingFormat, isTokenField, isValid } from "@svta/cml-cta";
 import { SfItem, SfToken, decodeSfDict, decodeSfList, encodeSfDict, encodeSfList, symbolToStr } from "@svta/cml-structured-field-values";
-
 //#region src/CMSD_DYNAMIC.ts
 /**
 * CMSD dynamic header name.
@@ -8,7 +7,6 @@ import { SfItem, SfToken, decodeSfDict, decodeSfList, encodeSfDict, encodeSfList
 * @public
 */
 const CMSD_DYNAMIC = "CMSD-Dynamic";
-
 //#endregion
 //#region src/CMSD_STATIC.ts
 /**
@@ -17,7 +15,6 @@ const CMSD_DYNAMIC = "CMSD-Dynamic";
 * @public
 */
 const CMSD_STATIC = "CMSD-Static";
-
 //#endregion
 //#region src/CMSD_V1.ts
 /**
@@ -26,7 +23,6 @@ const CMSD_STATIC = "CMSD-Static";
 * @public
 */
 const CMSD_V1 = 1;
-
 //#endregion
 //#region src/CmsdHeaderField.ts
 /**
@@ -38,10 +34,17 @@ const CMSD_V1 = 1;
 * @public
 */
 const CmsdHeaderField = {
+	/**
+	* Keys whose values persist over multiple requests for the object.
+	*/
 	STATIC: CMSD_STATIC,
+	/**
+	* Keys whose values apply only to the next transmission hop. Typically a
+	* new CMSD-Dynamic header instance will be added by each intermediary
+	* participating in the delivery.
+	*/
 	DYNAMIC: CMSD_DYNAMIC
 };
-
 //#endregion
 //#region src/CmsdObjectType.ts
 /**
@@ -53,7 +56,6 @@ const CmsdHeaderField = {
 * @public
 */
 const CmsdObjectType = CmObjectType;
-
 //#endregion
 //#region src/CmsdStreamingFormat.ts
 /**
@@ -65,7 +67,6 @@ const CmsdObjectType = CmObjectType;
 * @public
 */
 const CmsdStreamingFormat = CmStreamingFormat;
-
 //#endregion
 //#region src/CmsdStreamType.ts
 /**
@@ -77,7 +78,6 @@ const CmsdStreamingFormat = CmStreamingFormat;
 * @public
 */
 const CmsdStreamType = CmStreamType;
-
 //#endregion
 //#region src/decodeCmsdDynamic.ts
 /**
@@ -93,7 +93,6 @@ function decodeCmsdDynamic(cmsd) {
 	if (!cmsd) return [];
 	return decodeSfList(cmsd);
 }
-
 //#endregion
 //#region src/decodeCmsdStatic.ts
 /**
@@ -113,7 +112,6 @@ function decodeCmsdStatic(cmsd) {
 		return acc;
 	}, {});
 }
-
 //#endregion
 //#region src/encodeCmsdDynamic.ts
 function encodeCmsdDynamic(value, cmsd) {
@@ -124,7 +122,6 @@ function encodeCmsdDynamic(value, cmsd) {
 	}
 	return encodeSfList(value, { whitespace: false });
 }
-
 //#endregion
 //#region src/utils/processCmsd.ts
 function processCmsd(obj, options) {
@@ -141,7 +138,6 @@ function processCmsd(obj, options) {
 	});
 	return results;
 }
-
 //#endregion
 //#region src/encodeCmsdStatic.ts
 /**
@@ -158,7 +154,6 @@ function encodeCmsdStatic(cmsd, options) {
 	if (!cmsd) return "";
 	return encodeSfDict(processCmsd(cmsd, options), { whitespace: false });
 }
-
 //#endregion
 //#region src/isCmsdCustomKey.ts
 const CUSTOM_KEY_REGEX = /^[a-z][a-z0-9.-]*$/;
@@ -181,7 +176,7 @@ function isCmsdCustomKey(key) {
 	const separator = key.indexOf("-", 1);
 	return separator > 0 && separator < key.length - 1 && CUSTOM_KEY_REGEX.test(key);
 }
-
 //#endregion
 export { CMSD_DYNAMIC, CMSD_STATIC, CMSD_V1, CmsdHeaderField, CmsdObjectType, CmsdStreamType, CmsdStreamingFormat, decodeCmsdDynamic, decodeCmsdStatic, encodeCmsdDynamic, encodeCmsdStatic, isCmsdCustomKey };
+
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["results: CmsdStatic"],"sources":["../src/CMSD_DYNAMIC.ts","../src/CMSD_STATIC.ts","../src/CMSD_V1.ts","../src/CmsdHeaderField.ts","../src/CmsdObjectType.ts","../src/CmsdStreamingFormat.ts","../src/CmsdStreamType.ts","../src/decodeCmsdDynamic.ts","../src/decodeCmsdStatic.ts","../src/encodeCmsdDynamic.ts","../src/utils/processCmsd.ts","../src/encodeCmsdStatic.ts","../src/isCmsdCustomKey.ts"],"sourcesContent":["/**\n * CMSD dynamic header name.\n *\n * @public\n */\nexport const CMSD_DYNAMIC = 'CMSD-Dynamic'\n","/**\n * CMSD static header name.\n *\n * @public\n */\nexport const CMSD_STATIC = 'CMSD-Static'\n","/**\n * CMSD Version 1\n *\n * @public\n */\nexport const CMSD_V1 = 1\n","import type { ValueOf } from '@svta/cml-utils'\nimport { CMSD_DYNAMIC } from './CMSD_DYNAMIC.ts'\nimport { CMSD_STATIC } from './CMSD_STATIC.ts'\n\n/**\n * CMSD header fields.\n *\n *\n * @enum\n *\n * @public\n */\nexport const CmsdHeaderField = {\n\t/**\n\t * Keys whose values persist over multiple requests for the object.\n\t */\n\tSTATIC: CMSD_STATIC as typeof CMSD_STATIC,\n\n\t/**\n\t * Keys whose values apply only to the next transmission hop. Typically a\n\t * new CMSD-Dynamic header instance will be added by each intermediary\n\t * participating in the delivery.\n\t */\n\tDYNAMIC: CMSD_DYNAMIC as typeof CMSD_DYNAMIC,\n} as const\n\n/**\n * @public\n */\nexport type CmsdHeaderField = ValueOf<typeof CmsdHeaderField>;\n","import { CmObjectType } from '@svta/cml-cta'\n\n/**\n * Common Media Server Data Object Type\n *\n *\n * @enum\n *\n * @public\n */\nexport const CmsdObjectType = CmObjectType as typeof CmObjectType\n\n/**\n * @public\n */\nexport type CmsdObjectType = CmObjectType;\n","import { CmStreamingFormat } from '@svta/cml-cta'\n\n/**\n * Common Media Server Data Streaming Format\n *\n *\n * @enum\n *\n * @public\n */\nexport const CmsdStreamingFormat = CmStreamingFormat as typeof CmStreamingFormat\n\n/**\n * @public\n */\nexport type CmsdStreamingFormat = CmStreamingFormat;\n","import { CmStreamType } from '@svta/cml-cta'\n\n/**\n * Common Media Server Data Stream Type\n *\n *\n * @enum\n *\n * @public\n */\nexport const CmsdStreamType = CmStreamType as typeof CmStreamType\n\n/**\n * @public\n */\nexport type CmsdStreamType = CmStreamType;\n","import { decodeSfList } from '@svta/cml-structured-field-values'\nimport type { CmsdDynamic } from './CmsdDynamic.ts'\n\n/**\n * Decode a CMSD dynamic string to an object.\n *\n * @param cmsd - The CMSD string to decode.\n *\n * @returns The decoded CMSD object.\n *\n * @public\n */\nexport function decodeCmsdDynamic(cmsd: string): CmsdDynamic[] {\n\tif (!cmsd) {\n\t\treturn []\n\t}\n\n\tconst sfDict = decodeSfList(cmsd)\n\n\treturn sfDict as CmsdDynamic[]\n}\n","import { decodeSfDict, symbolToStr } from '@svta/cml-structured-field-values'\nimport type { CmsdStatic } from './CmsdStatic.ts'\n\n/**\n * Decode a CMSD Static dict string to an object.\n *\n * @param cmsd - The CMSD string to decode.\n *\n * @returns The decoded CMSD object.\n *\n * @public\n */\nexport function decodeCmsdStatic(cmsd: string): CmsdStatic {\n\tif (!cmsd) {\n\t\treturn {}\n\t}\n\n\treturn Object\n\t\t.entries(decodeSfDict(cmsd))\n\t\t.reduce((acc, [key, item]) => {\n\t\t\tconst { value }: any = item\n\t\t\tacc[key as any] = (typeof value === 'symbol' ? symbolToStr(value) : value) as any\n\t\t\treturn acc\n\t\t}, {} as CmsdStatic)\n}\n","import { encodeSfList, SfItem } from '@svta/cml-structured-field-values'\nimport type { CmsdDynamic } from './CmsdDynamic.ts'\n\n/**\n * Encode a list of CMSD Dynamic objects.\n *\n * @param value - The list of `SfItems` to encode.\n *\n * @returns The encoded CMSD string.\n *\n * @public\n */\nexport function encodeCmsdDynamic(value: SfItem[]): string;\n\n/**\n * Encode a single CMSD Dynamic object.\n *\n * @param value - The server name\n * @param cmsd - The CMSD object to encode.\n *\n * @returns The encoded CMSD string.\n *\n * @public\n */\nexport function encodeCmsdDynamic(value: string, cmsd: CmsdDynamic): string;\n\nexport function encodeCmsdDynamic(value: string | SfItem[], cmsd?: CmsdDynamic): string {\n\tif (!value) {\n\t\treturn ''\n\t}\n\n\tif (typeof value === 'string') {\n\t\tif (!cmsd) {\n\t\t\treturn ''\n\t\t}\n\n\t\tvalue = [new SfItem(value, cmsd as any)]\n\t}\n\n\treturn encodeSfList(value, { whitespace: false })\n}\n","import type { CmValue } from '@svta/cml-cta'\nimport { isTokenField, isValid } from '@svta/cml-cta'\nimport { SfToken } from '@svta/cml-structured-field-values'\nimport type { CmsdEncodeOptions } from '../CmsdEncodeOptions.ts'\nimport type { CmsdStatic } from '../CmsdStatic.ts'\n\nexport function processCmsd(obj: CmsdStatic, options?: CmsdEncodeOptions): CmsdStatic {\n\tconst results: CmsdStatic = {}\n\n\tif (obj == null || typeof obj !== 'object') {\n\t\treturn results\n\t}\n\n\tconst keys = Object.keys(obj) as (keyof CmsdStatic)[]\n\tconst useSymbol = options?.useSymbol !== false\n\n\tkeys.forEach(key => {\n\t\tlet value = obj[key] as CmValue\n\n\t\t// Version should only be reported if not equal to 1.\n\t\tif (key === 'v' && value === 1) {\n\t\t\treturn\n\t\t}\n\n\t\t// ignore invalid values\n\t\tif (!isValid(value)) {\n\t\t\treturn\n\t\t}\n\n\t\tif (isTokenField(key) && typeof value === 'string') {\n\t\t\tvalue = useSymbol ? Symbol.for(value) : new SfToken(value)\n\t\t}\n\n\t\tresults[key as any] = value as any\n\t})\n\n\treturn results\n}\n","import { encodeSfDict } from '@svta/cml-structured-field-values'\nimport type { CmsdEncodeOptions } from './CmsdEncodeOptions.ts'\nimport type { CmsdStatic } from './CmsdStatic.ts'\nimport { processCmsd } from './utils/processCmsd.ts'\n\n/**\n * Encode a CMSD Static object.\n *\n * @param cmsd - The CMSD object to encode.\n * @param options - Encoding options\n *\n * @returns The encoded CMSD string.\n *\n * @public\n */\nexport function encodeCmsdStatic(cmsd: CmsdStatic, options?: CmsdEncodeOptions): string {\n\tif (!cmsd) {\n\t\treturn ''\n\t}\n\n\treturn encodeSfDict(processCmsd(cmsd, options), { whitespace: false })\n}\n","// The CMSD custom-key charset restricted to RFC 8941 key serialization\n// (serializeKey): a lowercase first letter, then `a-z 0-9 . -`.\nconst CUSTOM_KEY_REGEX = /^[a-z][a-z0-9.-]*$/\n\n/**\n * Check if a key is a valid custom key: a lowercase first letter, then\n * characters from `a-z 0-9 . -`, with a hyphen that is neither the first\n * nor the last character. These are the CMSD custom-key rules restricted\n * to names that survive RFC 8941 key serialization.\n *\n * @param key - The key to check.\n *\n * @returns `true` if the key is a custom key, `false` otherwise.\n *\n * @public\n *\n * @example\n * {@includeCode ../test/isCmsdCustomKey.test.ts#example}\n */\nexport function isCmsdCustomKey(key: string): boolean {\n\t// The separator is checked outside the regex to keep matching linear (CodeQL js/polynomial-redos).\n\tconst separator = key.indexOf('-', 1)\n\treturn separator > 0 && separator < key.length - 1 && CUSTOM_KEY_REGEX.test(key)\n}\n"],"mappings":";;;;;;;;;AAKA,MAAa,eAAe;;;;;;;;;ACA5B,MAAa,cAAc;;;;;;;;;ACA3B,MAAa,UAAU;;;;;;;;;;;;ACOvB,MAAa,kBAAkB;CAI9B,QAAQ;CAOR,SAAS;CACT;;;;;;;;;;;;ACdD,MAAa,iBAAiB;;;;;;;;;;;;ACA9B,MAAa,sBAAsB;;;;;;;;;;;;ACAnC,MAAa,iBAAiB;;;;;;;;;;;;;ACE9B,SAAgB,kBAAkB,MAA6B;AAC9D,KAAI,CAAC,KACJ,QAAO,EAAE;AAKV,QAFe,aAAa,KAAK;;;;;;;;;;;;;;ACLlC,SAAgB,iBAAiB,MAA0B;AAC1D,KAAI,CAAC,KACJ,QAAO,EAAE;AAGV,QAAO,OACL,QAAQ,aAAa,KAAK,CAAC,CAC3B,QAAQ,KAAK,CAAC,KAAK,UAAU;EAC7B,MAAM,EAAE,UAAe;AACvB,MAAI,OAAe,OAAO,UAAU,WAAW,YAAY,MAAM,GAAG;AACpE,SAAO;IACL,EAAE,CAAe;;;;;ACGtB,SAAgB,kBAAkB,OAA0B,MAA4B;AACvF,KAAI,CAAC,MACJ,QAAO;AAGR,KAAI,OAAO,UAAU,UAAU;AAC9B,MAAI,CAAC,KACJ,QAAO;AAGR,UAAQ,CAAC,IAAI,OAAO,OAAO,KAAY,CAAC;;AAGzC,QAAO,aAAa,OAAO,EAAE,YAAY,OAAO,CAAC;;;;;ACjClD,SAAgB,YAAY,KAAiB,SAAyC;CACrF,MAAMA,UAAsB,EAAE;AAE9B,KAAI,OAAO,QAAQ,OAAO,QAAQ,SACjC,QAAO;CAGR,MAAM,OAAO,OAAO,KAAK,IAAI;CAC7B,MAAM,YAAY,SAAS,cAAc;AAEzC,MAAK,SAAQ,QAAO;EACnB,IAAI,QAAQ,IAAI;AAGhB,MAAI,QAAQ,OAAO,UAAU,EAC5B;AAID,MAAI,CAAC,QAAQ,MAAM,CAClB;AAGD,MAAI,aAAa,IAAI,IAAI,OAAO,UAAU,SACzC,SAAQ,YAAY,OAAO,IAAI,MAAM,GAAG,IAAI,QAAQ,MAAM;AAG3D,UAAQ,OAAc;GACrB;AAEF,QAAO;;;;;;;;;;;;;;;ACrBR,SAAgB,iBAAiB,MAAkB,SAAqC;AACvF,KAAI,CAAC,KACJ,QAAO;AAGR,QAAO,aAAa,YAAY,MAAM,QAAQ,EAAE,EAAE,YAAY,OAAO,CAAC;;;;;AClBvE,MAAM,mBAAmB;;;;;;;;;;;;;;;;AAiBzB,SAAgB,gBAAgB,KAAsB;CAErD,MAAM,YAAY,IAAI,QAAQ,KAAK,EAAE;AACrC,QAAO,YAAY,KAAK,YAAY,IAAI,SAAS,KAAK,iBAAiB,KAAK,IAAI"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/CMSD_DYNAMIC.ts","../src/CMSD_STATIC.ts","../src/CMSD_V1.ts","../src/CmsdHeaderField.ts","../src/CmsdObjectType.ts","../src/CmsdStreamingFormat.ts","../src/CmsdStreamType.ts","../src/decodeCmsdDynamic.ts","../src/decodeCmsdStatic.ts","../src/encodeCmsdDynamic.ts","../src/utils/processCmsd.ts","../src/encodeCmsdStatic.ts","../src/isCmsdCustomKey.ts"],"sourcesContent":["/**\n * CMSD dynamic header name.\n *\n * @public\n */\nexport const CMSD_DYNAMIC = 'CMSD-Dynamic'\n","/**\n * CMSD static header name.\n *\n * @public\n */\nexport const CMSD_STATIC = 'CMSD-Static'\n","/**\n * CMSD Version 1\n *\n * @public\n */\nexport const CMSD_V1 = 1\n","import type { ValueOf } from '@svta/cml-utils'\nimport { CMSD_DYNAMIC } from './CMSD_DYNAMIC.ts'\nimport { CMSD_STATIC } from './CMSD_STATIC.ts'\n\n/**\n * CMSD header fields.\n *\n *\n * @enum\n *\n * @public\n */\nexport const CmsdHeaderField = {\n\t/**\n\t * Keys whose values persist over multiple requests for the object.\n\t */\n\tSTATIC: CMSD_STATIC as typeof CMSD_STATIC,\n\n\t/**\n\t * Keys whose values apply only to the next transmission hop. Typically a\n\t * new CMSD-Dynamic header instance will be added by each intermediary\n\t * participating in the delivery.\n\t */\n\tDYNAMIC: CMSD_DYNAMIC as typeof CMSD_DYNAMIC,\n} as const\n\n/**\n * @public\n */\nexport type CmsdHeaderField = ValueOf<typeof CmsdHeaderField>;\n","import { CmObjectType } from '@svta/cml-cta'\n\n/**\n * Common Media Server Data Object Type\n *\n *\n * @enum\n *\n * @public\n */\nexport const CmsdObjectType = CmObjectType as typeof CmObjectType\n\n/**\n * @public\n */\nexport type CmsdObjectType = CmObjectType;\n","import { CmStreamingFormat } from '@svta/cml-cta'\n\n/**\n * Common Media Server Data Streaming Format\n *\n *\n * @enum\n *\n * @public\n */\nexport const CmsdStreamingFormat = CmStreamingFormat as typeof CmStreamingFormat\n\n/**\n * @public\n */\nexport type CmsdStreamingFormat = CmStreamingFormat;\n","import { CmStreamType } from '@svta/cml-cta'\n\n/**\n * Common Media Server Data Stream Type\n *\n *\n * @enum\n *\n * @public\n */\nexport const CmsdStreamType = CmStreamType as typeof CmStreamType\n\n/**\n * @public\n */\nexport type CmsdStreamType = CmStreamType;\n","import { decodeSfList } from '@svta/cml-structured-field-values'\nimport type { CmsdDynamic } from './CmsdDynamic.ts'\n\n/**\n * Decode a CMSD dynamic string to an object.\n *\n * @param cmsd - The CMSD string to decode.\n *\n * @returns The decoded CMSD object.\n *\n * @public\n */\nexport function decodeCmsdDynamic(cmsd: string): CmsdDynamic[] {\n\tif (!cmsd) {\n\t\treturn []\n\t}\n\n\tconst sfDict = decodeSfList(cmsd)\n\n\treturn sfDict as CmsdDynamic[]\n}\n","import { decodeSfDict, symbolToStr } from '@svta/cml-structured-field-values'\nimport type { CmsdStatic } from './CmsdStatic.ts'\n\n/**\n * Decode a CMSD Static dict string to an object.\n *\n * @param cmsd - The CMSD string to decode.\n *\n * @returns The decoded CMSD object.\n *\n * @public\n */\nexport function decodeCmsdStatic(cmsd: string): CmsdStatic {\n\tif (!cmsd) {\n\t\treturn {}\n\t}\n\n\treturn Object\n\t\t.entries(decodeSfDict(cmsd))\n\t\t.reduce((acc, [key, item]) => {\n\t\t\tconst { value }: any = item\n\t\t\tacc[key as any] = (typeof value === 'symbol' ? symbolToStr(value) : value) as any\n\t\t\treturn acc\n\t\t}, {} as CmsdStatic)\n}\n","import { encodeSfList, SfItem } from '@svta/cml-structured-field-values'\nimport type { CmsdDynamic } from './CmsdDynamic.ts'\n\n/**\n * Encode a list of CMSD Dynamic objects.\n *\n * @param value - The list of `SfItems` to encode.\n *\n * @returns The encoded CMSD string.\n *\n * @public\n */\nexport function encodeCmsdDynamic(value: SfItem[]): string;\n\n/**\n * Encode a single CMSD Dynamic object.\n *\n * @param value - The server name\n * @param cmsd - The CMSD object to encode.\n *\n * @returns The encoded CMSD string.\n *\n * @public\n */\nexport function encodeCmsdDynamic(value: string, cmsd: CmsdDynamic): string;\n\nexport function encodeCmsdDynamic(value: string | SfItem[], cmsd?: CmsdDynamic): string {\n\tif (!value) {\n\t\treturn ''\n\t}\n\n\tif (typeof value === 'string') {\n\t\tif (!cmsd) {\n\t\t\treturn ''\n\t\t}\n\n\t\tvalue = [new SfItem(value, cmsd as any)]\n\t}\n\n\treturn encodeSfList(value, { whitespace: false })\n}\n","import type { CmValue } from '@svta/cml-cta'\nimport { isTokenField, isValid } from '@svta/cml-cta'\nimport { SfToken } from '@svta/cml-structured-field-values'\nimport type { CmsdEncodeOptions } from '../CmsdEncodeOptions.ts'\nimport type { CmsdStatic } from '../CmsdStatic.ts'\n\nexport function processCmsd(obj: CmsdStatic, options?: CmsdEncodeOptions): CmsdStatic {\n\tconst results: CmsdStatic = {}\n\n\tif (obj == null || typeof obj !== 'object') {\n\t\treturn results\n\t}\n\n\tconst keys = Object.keys(obj) as (keyof CmsdStatic)[]\n\tconst useSymbol = options?.useSymbol !== false\n\n\tkeys.forEach(key => {\n\t\tlet value = obj[key] as CmValue\n\n\t\t// Version should only be reported if not equal to 1.\n\t\tif (key === 'v' && value === 1) {\n\t\t\treturn\n\t\t}\n\n\t\t// ignore invalid values\n\t\tif (!isValid(value)) {\n\t\t\treturn\n\t\t}\n\n\t\tif (isTokenField(key) && typeof value === 'string') {\n\t\t\tvalue = useSymbol ? Symbol.for(value) : new SfToken(value)\n\t\t}\n\n\t\tresults[key as any] = value as any\n\t})\n\n\treturn results\n}\n","import { encodeSfDict } from '@svta/cml-structured-field-values'\nimport type { CmsdEncodeOptions } from './CmsdEncodeOptions.ts'\nimport type { CmsdStatic } from './CmsdStatic.ts'\nimport { processCmsd } from './utils/processCmsd.ts'\n\n/**\n * Encode a CMSD Static object.\n *\n * @param cmsd - The CMSD object to encode.\n * @param options - Encoding options\n *\n * @returns The encoded CMSD string.\n *\n * @public\n */\nexport function encodeCmsdStatic(cmsd: CmsdStatic, options?: CmsdEncodeOptions): string {\n\tif (!cmsd) {\n\t\treturn ''\n\t}\n\n\treturn encodeSfDict(processCmsd(cmsd, options), { whitespace: false })\n}\n","// The CMSD custom-key charset restricted to RFC 8941 key serialization\n// (serializeKey): a lowercase first letter, then `a-z 0-9 . -`.\nconst CUSTOM_KEY_REGEX = /^[a-z][a-z0-9.-]*$/\n\n/**\n * Check if a key is a valid custom key: a lowercase first letter, then\n * characters from `a-z 0-9 . -`, with a hyphen that is neither the first\n * nor the last character. These are the CMSD custom-key rules restricted\n * to names that survive RFC 8941 key serialization.\n *\n * @param key - The key to check.\n *\n * @returns `true` if the key is a custom key, `false` otherwise.\n *\n * @public\n *\n * @example\n * {@includeCode ../test/isCmsdCustomKey.test.ts#example}\n */\nexport function isCmsdCustomKey(key: string): boolean {\n\t// The separator is checked outside the regex to keep matching linear (CodeQL js/polynomial-redos).\n\tconst separator = key.indexOf('-', 1)\n\treturn separator > 0 && separator < key.length - 1 && CUSTOM_KEY_REGEX.test(key)\n}\n"],"mappings":";;;;;;;;AAKA,MAAa,eAAe;;;;;;;;ACA5B,MAAa,cAAc;;;;;;;;ACA3B,MAAa,UAAU;;;;;;;;;;;ACOvB,MAAa,kBAAkB;;;;CAI9B,QAAQ;;;;;;CAOR,SAAS;AACV;;;;;;;;;;;ACdA,MAAa,iBAAiB;;;;;;;;;;;ACA9B,MAAa,sBAAsB;;;;;;;;;;;ACAnC,MAAa,iBAAiB;;;;;;;;;;;;ACE9B,SAAgB,kBAAkB,MAA6B;CAC9D,IAAI,CAAC,MACJ,OAAO,CAAC;CAKT,OAFe,aAAa,IAEhB;AACb;;;;;;;;;;;;ACRA,SAAgB,iBAAiB,MAA0B;CAC1D,IAAI,CAAC,MACJ,OAAO,CAAC;CAGT,OAAO,OACL,QAAQ,aAAa,IAAI,CAAC,CAAC,CAC3B,QAAQ,KAAK,CAAC,KAAK,UAAU;EAC7B,MAAM,EAAE,UAAe;EACvB,IAAI,OAAe,OAAO,UAAU,WAAW,YAAY,KAAK,IAAI;EACpE,OAAO;CACR,GAAG,CAAC,CAAe;AACrB;;;ACEA,SAAgB,kBAAkB,OAA0B,MAA4B;CACvF,IAAI,CAAC,OACJ,OAAO;CAGR,IAAI,OAAO,UAAU,UAAU;EAC9B,IAAI,CAAC,MACJ,OAAO;EAGR,QAAQ,CAAC,IAAI,OAAO,OAAO,IAAW,CAAC;CACxC;CAEA,OAAO,aAAa,OAAO,EAAE,YAAY,MAAM,CAAC;AACjD;;;AClCA,SAAgB,YAAY,KAAiB,SAAyC;CACrF,MAAM,UAAsB,CAAC;CAE7B,IAAI,OAAO,QAAQ,OAAO,QAAQ,UACjC,OAAO;CAGR,MAAM,OAAO,OAAO,KAAK,GAAG;CAC5B,MAAM,YAAY,SAAS,cAAc;CAEzC,KAAK,SAAQ,QAAO;EACnB,IAAI,QAAQ,IAAI;EAGhB,IAAI,QAAQ,OAAO,UAAU,GAC5B;EAID,IAAI,CAAC,QAAQ,KAAK,GACjB;EAGD,IAAI,aAAa,GAAG,KAAK,OAAO,UAAU,UACzC,QAAQ,YAAY,OAAO,IAAI,KAAK,IAAI,IAAI,QAAQ,KAAK;EAG1D,QAAQ,OAAc;CACvB,CAAC;CAED,OAAO;AACR;;;;;;;;;;;;;ACtBA,SAAgB,iBAAiB,MAAkB,SAAqC;CACvF,IAAI,CAAC,MACJ,OAAO;CAGR,OAAO,aAAa,YAAY,MAAM,OAAO,GAAG,EAAE,YAAY,MAAM,CAAC;AACtE;;;ACnBA,MAAM,mBAAmB;;;;;;;;;;;;;;;;AAiBzB,SAAgB,gBAAgB,KAAsB;CAErD,MAAM,YAAY,IAAI,QAAQ,KAAK,CAAC;CACpC,OAAO,YAAY,KAAK,YAAY,IAAI,SAAS,KAAK,iBAAiB,KAAK,GAAG;AAChF"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@svta/cml-cmsd",
-	"version": "1.1.0",
+	"version": "1.1.2",
 	"description": "Common Media Server Data (CMSD) encoding and decoding",
 	"license": "Apache-2.0",
 	"type": "module",
@@ -52,8 +52,8 @@
 		}
 	},
 	"peerDependencies": {
-		"@svta/cml-cta": "1.0.8",
-		"@svta/cml-structured-field-values": "1.1.5",
-		"@svta/cml-utils": "1.6.0"
+		"@svta/cml-cta": "^1.0.10",
+		"@svta/cml-structured-field-values": "^1.1.7",
+		"@svta/cml-utils": "^1.6.2"
 	}
 }