@2702rebels/wpidata 1.0.0 → 1.0.1

package/dist/abstractions.d.cts

@@ -3,134 +3,134 @@ type DataType = "boolean" | "string" | "number" | "booleanArray" | "stringArray"
 type DataTypeImpl = boolean | string | number | Array<boolean> | Array<string> | Array<number> | Record<string, unknown> | Array<Record<string, unknown>> | Uint8Array;
 interface StructuredTypeDescriptor {
   /**
-   * **Type name**
-   *
-   * Typically the name represents the original type name without any adorners.
-   * For example, `struct:Pose3d`, `struct:Pose3d[]` would be represented
-   * as `Pose3d`, and `proto:wpi.proto.ProtobufPose3d` as `wpi.proto.ProtobufPose3d`.
-   *
-   * To determine if the parsed value is an array, consult `array` indicator and
-   * use `Array.isArray` method.
-   */
+       * **Type name**
+       *
+       * Typically the name represents the original type name without any adorners.
+       * For example, `struct:Pose3d`, `struct:Pose3d[]` would be represented
+       * as `Pose3d`, and `proto:wpi.proto.ProtobufPose3d` as `wpi.proto.ProtobufPose3d`.
+       *
+       * To determine if the parsed value is an array, consult `array` indicator and
+       * use `Array.isArray` method.
+       */
   readonly name: string;
   /**
-   * **Type format**
-   *
-   * Represents the origin (protocol) of the deserialized data.
-   *
-   * Due to WPILIB idiosyncrasies deserialized JSON representation of the same
-   * structured type may differ across various serialization protocols.
-   */
+       * **Type format**
+       *
+       * Represents the origin (protocol) of the deserialized data.
+       *
+       * Due to WPILIB idiosyncrasies deserialized JSON representation of the same
+       * structured type may differ across various serialization protocols.
+       */
   readonly format: "protobuf" | "struct" | "composite";
   /**
-   * **Array indicator**
-   *
-   * Indicates that the value contains a top-level array of type.
-   */
+       * **Array indicator**
+       *
+       * Indicates that the value contains a top-level array of type.
+       */
   readonly isArray?: boolean;
 }
 interface DataChannelRecord<T extends DataTypeImpl = DataTypeImpl> {
   /**
-   * **Timestamp (microseconds)**
-   *
-   * Timestamp of the record in microseconds. Typically represents robot time.
-   */
+       * **Timestamp (microseconds)**
+       *
+       * Timestamp of the record in microseconds. Typically represents robot time.
+       */
   readonly timestamp: number;
   /**
-   * **Value**
-   *
-   * Record value. Depends on the {@link DataChannel.dataType}.
-   */
+       * **Value**
+       *
+       * Record value. Depends on the {@link DataChannel.dataType}.
+       */
   value: T;
 }
 interface DataChannelBase<T extends DataTypeImpl = DataTypeImpl> {
   /**
-   * **Channel source**
-   *
-   * For example, `nt` or `wpilog`. This field is considered opaque.
-   */
+       * **Channel source**
+       *
+       * For example, `nt` or `wpilog`. This field is considered opaque.
+       */
   readonly source: string;
   /**
-   * **Channel identifier**
-   *
-   * Must be unique within the data source.
-   * NT4 — topic name
-   * WPILOG — data channel identifier
-   */
+       * **Channel identifier**
+       *
+       * Must be unique within the data source.
+       * NT4 — topic name
+       * WPILOG — data channel identifier
+       */
   readonly id: string;
   /**
-   * **Data representation type**
-   *
-   * This type indicates the processed data representation in the Javascript world.
-   * For example, NT4 source may differentiate between numeric types, such as
-   * 32-bit integer and 64-bit float, yet both are stored as `number`.
-   *
-   * Complex types are typically serialized using JSON, msgpack, struct or protobuf
-   * protocols and require a corresponding data transformer to be registered in
-   * the pipeline to unpack them. If no transformer is present the raw `binary`
-   * representation is used where data is stored in a byte array buffer.
-   */
+       * **Data representation type**
+       *
+       * This type indicates the processed data representation in the Javascript world.
+       * For example, NT4 source may differentiate between numeric types, such as
+       * 32-bit integer and 64-bit float, yet both are stored as `number`.
+       *
+       * Complex types are typically serialized using JSON, msgpack, struct or protobuf
+       * protocols and require a corresponding data transformer to be registered in
+       * the pipeline to unpack them. If no transformer is present the raw `binary`
+       * representation is used where data is stored in a byte array buffer.
+       */
   readonly dataType: DataType;
   /**
-   * **Raw data type**
-   *
-   * Raw data type string to be used for publishing. Retains original type specifics
-   * that cannot be represented in the JavaScript world, such as differences between
-   * various numeric types.
-   */
+       * **Raw data type**
+       *
+       * Raw data type string to be used for publishing. Retains original type specifics
+       * that cannot be represented in the JavaScript world, such as differences between
+       * various numeric types.
+       */
   readonly publishedDataType: string;
   /**
-   * **Protocol transformer**
-   *
-   * Unpacks raw binary data into JSON object according to the serialization protocol.
-   */
+       * **Protocol transformer**
+       *
+       * Unpacks raw binary data into JSON object according to the serialization protocol.
+       */
   readonly transformer?: DataTransformer;
   /**
-   * **Structured type descriptor**
-   *
-   * Applicable to complex types, serialized as struct or protobuf. Must be set
-   * by the corresponding transformer.
-   */
+       * **Structured type descriptor**
+       *
+       * Applicable to complex types, serialized as struct or protobuf. Must be set
+       * by the corresponding transformer.
+       */
   structuredType?: StructuredTypeDescriptor;
   /**
-   * **Channel metadata**
-   *
-   * For NT4 metadata is extracted from topic properties beyond the default set.
-   * For WPILOG metadata is read and attempted to be parsed as JSON object first
-   * and stored as string otherwise.
-   *
-   * This field represents the most recently seen values as published by the source.
-   */
+       * **Channel metadata**
+       *
+       * For NT4 metadata is extracted from topic properties beyond the default set.
+       * For WPILOG metadata is read and attempted to be parsed as JSON object first
+       * and stored as string otherwise.
+       *
+       * This field represents the most recently seen values as published by the source.
+       */
   metadata?: Record<string, unknown> | string;
   /**
-   * **Timestamped records**
-   *
-   * Timestamps are provided by the data source. The array is sorted by the timestamp
-   * in ascending order, earlier records have smaller indices.
-   */
+       * **Timestamped records**
+       *
+       * Timestamps are provided by the data source. The array is sorted by the timestamp
+       * in ascending order, earlier records have smaller indices.
+       */
   records?: Array<DataChannelRecord<T>>;
   /**
-   * **Timestamped dead-letter queue**
-   *
-   * Records that cannot be yet unpacked due to missing type descriptors.
-   *
-   * Timestamps are provided by the data source. The array is sorted by the timestamp
-   * in ascending order, earlier records have smaller indices.
-   */
+       * **Timestamped dead-letter queue**
+       *
+       * Records that cannot be yet unpacked due to missing type descriptors.
+       *
+       * Timestamps are provided by the data source. The array is sorted by the timestamp
+       * in ascending order, earlier records have smaller indices.
+       */
   dlq?: Array<DataChannelRecord<Uint8Array>>;
   /**
-   * **Composite channel container**
-   *
-   * Returns the container composite channel for sub-channels that are part of it.
-   */
+       * **Composite channel container**
+       *
+       * Returns the container composite channel for sub-channels that are part of it.
+       */
   composite?: CompositeDataChannel;
   /**
-   * **Publishes value to the channel**
-   *
-   * @param value value to publish
-   * @param path optional path to the sub-channel
-   * @param options additional publisher options
-   */
+       * **Publishes value to the channel**
+       *
+       * @param value value to publish
+       * @param path optional path to the sub-channel
+       * @param options additional publisher options
+       */
   publish?: (value: unknown, path?: ReadonlyArray<string>, options?: DataChannelPublisherOptions) => void;
 }
 interface BooleanDataChannel extends DataChannelBase<boolean> {
@@ -160,11 +160,11 @@ interface BinaryDataChannel extends DataChannelBase<Uint8Array> {
 interface CompositeDataChannel extends DataChannelBase<Record<string, unknown>> {
   readonly dataType: "composite";
   /**
-   * **Sub-channel identifiers and record paths**
-   *
-   * Identifiers of individual data channels that comprise this composite channel
-   * and their respective paths for the data to be written in the JSON record.
-   */
+       * **Sub-channel identifiers and record paths**
+       *
+       * Identifiers of individual data channels that comprise this composite channel
+       * and their respective paths for the data to be written in the JSON record.
+       */
   channels: Map<string, Array<string>>;
 }
 /**
@@ -186,55 +186,55 @@ type DataChannel = BooleanDataChannel | StringDataChannel | NumberDataChannel |
  */
 interface DataTransformer {
   /**
-   * Inspects a channel to determine whether it represents a schema or a data channel
-   * that must run through this transformer.
-   *
-   * This method must return either a {@link DataChannel} instance indicating a data
-   * channel, which must have {@link DataChannel.transformer} field set, or a string
-   * containing the schema type name indicating a schema channel. Otherwise,
-   * a value of `undefined` must be returned.
-   *
-   * @param source source
-   * @param name channel name
-   * @param type channel type
-   * @param metadata channel metadata
-   * @returns data channel, schema type name or `undefined`
-   */
+       * Inspects a channel to determine whether it represents a schema or a data channel
+       * that must run through this transformer.
+       *
+       * This method must return either a {@link DataChannel} instance indicating a data
+       * channel, which must have {@link DataChannel.transformer} field set, or a string
+       * containing the schema type name indicating a schema channel. Otherwise,
+       * a value of `undefined` must be returned.
+       *
+       * @param source source
+       * @param name channel name
+       * @param type channel type
+       * @param metadata channel metadata
+       * @returns data channel, schema type name or `undefined`
+       */
   inspect(source: string, name: string, type: string, metadata?: Record<string, unknown> | string): DataChannel | string | undefined;
   /**
-   * Ingests raw schema data for the specified type name. This method will be invoked
-   * when the data arrives on a schema channel previously identified by {@link inspect}.
-   *
-   * @param typeName schema type name previously returned by {@link inspect}
-   * @param value raw schema data
-   */
+       * Ingests raw schema data for the specified type name. This method will be invoked
+       * when the data arrives on a schema channel previously identified by {@link inspect}.
+       *
+       * @param typeName schema type name previously returned by {@link inspect}
+       * @param value raw schema data
+       */
   schema(typeName: string, value: unknown): void;
   /**
-   * Deserializes raw data. If the data cannot be transformed yet due to missing
-   * schema dependencies, this method must return `undefined` and the data will
-   * stored in the dead-letter queue to retry automatically at a later time.
-   *
-   * @param value raw value to deserialize
-   * @param type an optional {@link DataChannel.structuredType} descriptor
-   * @returns a deserialized value on success or `undefined` otherwise
-   */
+       * Deserializes raw data. If the data cannot be transformed yet due to missing
+       * schema dependencies, this method must return `undefined` and the data will
+       * stored in the dead-letter queue to retry automatically at a later time.
+       *
+       * @param value raw value to deserialize
+       * @param type an optional {@link DataChannel.structuredType} descriptor
+       * @returns a deserialized value on success or `undefined` otherwise
+       */
   deserialize(value: unknown, type?: StructuredTypeDescriptor): DataTypeImpl | undefined;
   /**
-   * Serializes data into a raw format for publishing.
-   *
-   * @param value value to serialize
-   * @param type an optional {@link DataChannel.structuredType} descriptor
-   * @returns a serialized representation of the value
-   */
+       * Serializes data into a raw format for publishing.
+       *
+       * @param value value to serialize
+       * @param type an optional {@link DataChannel.structuredType} descriptor
+       * @returns a serialized representation of the value
+       */
   serialize(value: unknown, type?: StructuredTypeDescriptor): string | Uint8Array;
   /**
-   * Determines whether data with the specified `type` can be transformed.
-   *
-   * The transformer may not be able to transform certain types if it is missing
-   * corresponding type descriptors yet to arrive via schema channel.
-   *
-   * @param type type name
-   */
+       * Determines whether data with the specified `type` can be transformed.
+       *
+       * The transformer may not be able to transform certain types if it is missing
+       * corresponding type descriptors yet to arrive via schema channel.
+       *
+       * @param type type name
+       */
   canTransform(type: string): boolean;
 }
 interface DataChannelPublisherOptions {

package/dist/abstractions.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"abstractions.d.cts","names":[],"sources":["../src/abstractions.ts"],"sourcesContent":[],"mappings":";KAAY,QAAA;AAAA,KAWA,YAAA,GAXQ,OAAA,GAAA,MAAA,GAAA,MAAA,GAehB,KAfgB,CAAA,OAAA,CAAA,GAgBhB,KAhBgB,CAAA,MAAA,CAAA,GAiBhB,KAjBgB,CAAA,MAAA,CAAA,GAkBhB,MAlBgB,CAAA,MAAA,EAAA,OAAA,CAAA,GAmBhB,KAnBgB,CAmBV,MAnBU,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,GAoBhB,UApBgB;AAWR,UAWK,wBAAA,CAXO;EAIpB;;;;;;;;AAOJ;AA+BA;EAA6C,SAAA,IAAA,EAAA,MAAA;EAAe;;;AAgB5D;;;;;EAqDmB,SAAA,MAAA,EAAA,UAAA,GAAA,QAAA,GAAA,WAAA;EAWN;;;;;EAkBC,SAAA,OAAA,CAAA,EAAA,OAAA;;AAOA,UAzGG,iBAyGH,CAAA,UAzG+B,YAyG/B,GAzG8C,YAyG9C,CAAA,CAAA;EASsB;;;AAGpC;AAIA;EAIiB,SAAA,SAAA,EAAkB,MAAA;EAIlB;AAIjB;AAIA;AAIA;AAIA;EAIiB,KAAA,EAxIR,CAwIQ;;AASO,UA9IP,eA8IO,CAAA,UA9ImB,YA8InB,GA9IkC,YA8IlC,CAAA,CAAA;EAAZ;;;AASZ;;EAEI,SAAA,MAAA,EAAA,MAAA;EACA;;;;;;;EAMoB,SAAA,EAAA,EAAA,MAAA;EAYP;;;;;;;;AA+DjB;;;;qBA9MqB;;;;;;;;;;;;;;yBAgBI;;;;;;;mBAQN;;;;;;;;;;aAWN;;;;;;;YAQD,MAAM,kBAAkB;;;;;;;;;QAU5B,MAAM,kBAAkB;;;;;;cAOlB;;;;;;;;oCASsB,iCAAiC;;UAGpD,kBAAA,SAA2B;;;UAI3B,iBAAA,SAA0B;;;UAI1B,iBAAA,SAA0B;;;UAI1B,uBAAA,SAAgC,gBAAgB;;;UAIhD,sBAAA,SAA+B,gBAAgB;;;UAI/C,sBAAA,SAA+B,gBAAgB;;;UAI/C,eAAA,SAAwB,gBAAgB;;;UAIxC,iBAAA,SAA0B,gBAAgB;;;UAI1C,oBAAA,SAA6B,gBAAgB;;;;;;;;YASlD,YAAY;;;;;;;;KASZ,WAAA,GACR,qBACA,oBACA,oBACA,0BACA,yBACA,yBACA,kBACA,oBACA;;;;;;;;;;;UAYa,eAAA;;;;;;;;;;;;;;;;iEAoBF,mCACV;;;;;;;;;;;;;;;;;;qCAoBgC,2BAA2B;;;;;;;;mCAS7B,oCAAoC;;;;;;;;;;;UAatD,2BAAA;;mBAEE"}
+{"version":3,"file":"abstractions.d.cts","names":[],"sources":["../src/abstractions.ts"],"mappings":";KAAY,QAAA;AAAA,KAWA,YAAA,+BAIR,KAAA,YACA,KAAA,WACA,KAAA,WACA,MAAA,oBACA,KAAA,CAAM,MAAA,qBACN,UAAA;AAAA,UAEa,wBAAA;EAAA;AA+BjB;;;;;AAgBA;;;;EA/CiB,SAAA,IAAA;EAAA;AA+BjB;;;;;AAgBA;;EA/CiB,SAAA,MAAA;EAAA;AA+BjB;;;;EA/BiB,SAAA,OAAA;AAAA;AAAA,UA+BA,iBAAA,WAA4B,YAAA,GAAe,YAAA;EAAA;;;AAgB5D;;EAhB4D,SAAA,SAAA;EAAA;;;AAgB5D;;EAhB4D,KAAA,EAanD,CAAA;AAAA;AAAA,UAGQ,eAAA,WAA0B,YAAA,GAAe,YAAA;EAAA;;;;;EAAA,SAAA,MAAA;EAAA;;;;;;;EAAA,SAAA,EAAA;EAAA;;;;;;;;;;;;EAAA,SAAA,QAAA,EA6BrC,QAAA;EAAA;;;;;;;EAAA,SAAA,iBAAA;EAAA;;;;;EAAA,SAAA,WAAA,GAgBI,eAAA;EAAA;;;;;;EAAA,cAAA,GAQN,wBAAA;EAAA;;;;;;;;;EAAA,QAAA,GAWN,MAAA;EAAA;;;;;;EAAA,OAAA,GAQD,KAAA,CAAM,iBAAA,CAAkB,CAAA;EAAA;;;;;;;;EAAA,GAAA,GAU5B,KAAA,CAAM,iBAAA,CAAkB,UAAA;EAAA;;;;;EAAA,SAAA,GAOlB,oBAAA;EAAA;;;;AAYd;AAIA;AAIA;EApBc,OAAA,IAAA,KAAA,WAAA,IAAA,GASsB,aAAA,UAAA,OAAA,GAAiC,2BAAA;AAAA;AAAA,UAGpD,kBAAA,SAA2B,eAAA;EAAA,SAAA,QAAA;AAAA;AAAA,UAI3B,iBAAA,SAA0B,eAAA;EAAA,SAAA,QAAA;AAAA;AAAA,UAI1B,iBAAA,SAA0B,eAAA;EAAA,SAAA,QAAA;AAAA;AAAA,UAI1B,uBAAA,SAAgC,eAAA,CAAgB,KAAA;EAAA,SAAA,QAAA;AAAA;AAAA,UAIhD,sBAAA,SAA+B,eAAA,CAAgB,KAAA;EAAA,SAAA,QAAA;AAAA;AAAA,UAI/C,sBAAA,SAA+B,eAAA,CAAgB,KAAA;EAAA,SAAA,QAAA;AAAA;AAAA,UAI/C,eAAA,SAAwB,eAAA,CAAgB,MAAA;EAAA,SAAA,QAAA;AAAA;AAAA,UAIxC,iBAAA,SAA0B,eAAA,CAAgB,UAAA;EAAA,SAAA,QAAA;AAAA;AAAA,UAI1C,oBAAA,SAA6B,eAAA,CAAgB,MAAA;EAAA,SAAA,QAAA;EAAA;;;;;AAkB9D;EAlB8D,QAAA,EASlD,GAAA,SAAY,KAAA;AAAA;AAAA;;;;AASxB;;AATwB,KASZ,WAAA,GACR,kBAAA,GACA,iBAAA,GACA,iBAAA,GACA,uBAAA,GACA,sBAAA,GACA,sBAAA,GACA,eAAA,GACA,iBAAA,GACA,oBAAA;AAAA;;AAYJ;;;;;;;;AAZI,UAYa,eAAA;EAAA;;;;;;;;AA+DjB;;;;;;;EA/DiB,OAAA,CAAA,MAAA,UAAA,IAAA,UAAA,IAAA,UAAA,QAAA,GAoBF,MAAA,6BACV,WAAA;EAAA;;;;;;AA0CL;EA1CK,MAAA,CAAA,QAAA,UAAA,KAAA;EAAA;;;;;;AA0CL;;;EA1CK,WAAA,CAAA,KAAA,WAAA,IAAA,GAoBgC,wBAAA,GAA2B,YAAA;EAAA;;;;AAsBhE;;;EAtBgE,SAAA,CAAA,KAAA,WAAA,IAAA,GAS7B,wBAAA,YAAoC,UAAA;EAAA;;AAavE;;;;;;EAbuE,YAAA,CAAA,IAAA;AAAA;AAAA,UAatD,2BAAA;EAAA;EAAA,cAAA,GAEE,wBAAA;AAAA"}