@csfloat/cs2-inspect-serializer 1.0.0 → 1.1.0

package/README.md

@@ -1,6 +1,6 @@
 # CS2 Inspect Link Serializer
 
-Lightweight serializer for CS2 inspect links. Fork of the package
+Lightweight serializer and decoder for CS2 inspect links. Fork of the package
 [cs2-inspect-create](https://github.com/candyboyz/cs2-inspect-create).
 
 # Installation
@@ -13,6 +13,26 @@ npm i @csfloat/cs2-inspect-serializer
 
 See the [tests](tests/gen.test.ts) for examples.
 
+```ts
+import { decodeHex, decodeLink, generateHex, generateLink } from "@csfloat/cs2-inspect-serializer";
+
+const props = {
+	defindex: 7,
+	paintindex: 474,
+	paintseed: 306,
+	paintwear: 0.6336590647697449,
+	rarity: 6,
+	stickers: [],
+	keychains: [],
+};
+
+const hex = generateHex(props);
+const link = generateLink(props);
+
+decodeHex(hex);
+decodeLink(link);
+```
+
 # Development
 
 ```bash

package/dist/index.d.mts

@@ -1,10 +1,7 @@
-import { MessageType, PartialMessage, IBinaryReader, BinaryReadOptions, IBinaryWriter, BinaryWriteOptions } from '@protobuf-ts/runtime';
+import { MessageType } from '@protobuf-ts/runtime';
 
 declare class CEconItemPreviewDataBlock$Type extends MessageType<CEconItemPreviewDataBlock> {
     constructor();
-    create(value?: PartialMessage<CEconItemPreviewDataBlock>): CEconItemPreviewDataBlock;
-    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CEconItemPreviewDataBlock): CEconItemPreviewDataBlock;
-    internalBinaryWrite(message: CEconItemPreviewDataBlock, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
 }
 /**
  * @generated from protobuf message CEconItemPreviewDataBlock
@@ -97,9 +94,6 @@ interface CEconItemPreviewDataBlock {
 declare const CEconItemPreviewDataBlock: CEconItemPreviewDataBlock$Type;
 declare class CEconItemPreviewDataBlock_Sticker$Type extends MessageType<CEconItemPreviewDataBlock_Sticker> {
     constructor();
-    create(value?: PartialMessage<CEconItemPreviewDataBlock_Sticker>): CEconItemPreviewDataBlock_Sticker;
-    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CEconItemPreviewDataBlock_Sticker): CEconItemPreviewDataBlock_Sticker;
-    internalBinaryWrite(message: CEconItemPreviewDataBlock_Sticker, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
 }
 /**
  * @generated from protobuf message CEconItemPreviewDataBlock.Sticker
@@ -155,6 +149,9 @@ interface CEconItemPreviewDataBlock_Sticker {
  */
 declare const CEconItemPreviewDataBlock_Sticker: CEconItemPreviewDataBlock_Sticker$Type;
 
+declare const decodeHex: (hex: string) => CEconItemPreviewDataBlock;
+declare const decodeLink: (link: string) => CEconItemPreviewDataBlock;
+
 declare const previewLink = "steam://rungame/730/76561202255233023/+csgo_econ_action_preview";
 /**
  * Creates the hex representation of the inspect data
@@ -169,4 +166,4 @@ declare const generateHex: ({ paintwear, ...props }: CEconItemPreviewDataBlock)
  */
 declare const generateLink: (props: CEconItemPreviewDataBlock) => string;
 
-export { generateHex, generateLink, previewLink };
+export { CEconItemPreviewDataBlock, decodeHex, decodeLink, generateHex, generateLink, previewLink };

package/dist/index.d.ts

@@ -1,10 +1,7 @@
-import { MessageType, PartialMessage, IBinaryReader, BinaryReadOptions, IBinaryWriter, BinaryWriteOptions } from '@protobuf-ts/runtime';
+import { MessageType } from '@protobuf-ts/runtime';
 
 declare class CEconItemPreviewDataBlock$Type extends MessageType<CEconItemPreviewDataBlock> {
     constructor();
-    create(value?: PartialMessage<CEconItemPreviewDataBlock>): CEconItemPreviewDataBlock;
-    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CEconItemPreviewDataBlock): CEconItemPreviewDataBlock;
-    internalBinaryWrite(message: CEconItemPreviewDataBlock, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
 }
 /**
  * @generated from protobuf message CEconItemPreviewDataBlock
@@ -97,9 +94,6 @@ interface CEconItemPreviewDataBlock {
 declare const CEconItemPreviewDataBlock: CEconItemPreviewDataBlock$Type;
 declare class CEconItemPreviewDataBlock_Sticker$Type extends MessageType<CEconItemPreviewDataBlock_Sticker> {
     constructor();
-    create(value?: PartialMessage<CEconItemPreviewDataBlock_Sticker>): CEconItemPreviewDataBlock_Sticker;
-    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CEconItemPreviewDataBlock_Sticker): CEconItemPreviewDataBlock_Sticker;
-    internalBinaryWrite(message: CEconItemPreviewDataBlock_Sticker, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
 }
 /**
  * @generated from protobuf message CEconItemPreviewDataBlock.Sticker
@@ -155,6 +149,9 @@ interface CEconItemPreviewDataBlock_Sticker {
  */
 declare const CEconItemPreviewDataBlock_Sticker: CEconItemPreviewDataBlock_Sticker$Type;
 
+declare const decodeHex: (hex: string) => CEconItemPreviewDataBlock;
+declare const decodeLink: (link: string) => CEconItemPreviewDataBlock;
+
 declare const previewLink = "steam://rungame/730/76561202255233023/+csgo_econ_action_preview";
 /**
  * Creates the hex representation of the inspect data
@@ -169,4 +166,4 @@ declare const generateHex: ({ paintwear, ...props }: CEconItemPreviewDataBlock)
  */
 declare const generateLink: (props: CEconItemPreviewDataBlock) => string;
 
-export { generateHex, generateLink, previewLink };
+export { CEconItemPreviewDataBlock, decodeHex, decodeLink, generateHex, generateLink, previewLink };