@solana/codecs-data-structures 2.0.0 → 2.0.1-canary-20241112044734

package/dist/types/index.d.ts

@@ -8,6 +8,7 @@ export * from './discriminated-union';
 export * from './enum';
 export * from './hidden-prefix';
 export * from './hidden-suffix';
+export * from './literal-union';
 export * from './map';
 export * from './nullable';
 export * from './set';

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,uBAAuB,CAAC;AACtC,cAAc,QAAQ,CAAC;AACvB,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC;AAC3B,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,uBAAuB,CAAC;AACtC,cAAc,QAAQ,CAAC;AACvB,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC;AAC3B,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC"}

package/dist/types/literal-union.d.ts

@@ -0,0 +1,47 @@
+import { FixedSizeCodec, FixedSizeDecoder, FixedSizeEncoder, VariableSizeCodec, VariableSizeDecoder, VariableSizeEncoder } from '@solana/codecs-core';
+import { FixedSizeNumberCodec, FixedSizeNumberDecoder, FixedSizeNumberEncoder, NumberCodec, NumberDecoder, NumberEncoder } from '@solana/codecs-numbers';
+/** Defines the config for literal union codecs. */
+export type LiteralUnionCodecConfig<TDiscriminator = NumberCodec | NumberDecoder | NumberEncoder> = {
+    /**
+     * The number codec to use for the literal union discriminator.
+     * @defaultValue u8 discriminator.
+     */
+    size?: TDiscriminator;
+};
+type Variant = bigint | boolean | number | string | null | undefined;
+type GetTypeFromVariants<TVariants extends readonly Variant[]> = TVariants[number];
+/**
+ * Creates a literal union encoder.
+ *
+ * @param variants - The variant encoders of the literal union.
+ * @param config - A set of config for the encoder.
+ */
+export declare function getLiteralUnionEncoder<const TVariants extends readonly Variant[]>(variants: TVariants): FixedSizeEncoder<GetTypeFromVariants<TVariants>, 1>;
+export declare function getLiteralUnionEncoder<const TVariants extends readonly Variant[], TSize extends number>(variants: TVariants, config: LiteralUnionCodecConfig<NumberEncoder> & {
+    size: FixedSizeNumberEncoder<TSize>;
+}): FixedSizeEncoder<GetTypeFromVariants<TVariants>, TSize>;
+export declare function getLiteralUnionEncoder<const TVariants extends readonly Variant[]>(variants: TVariants, config?: LiteralUnionCodecConfig<NumberEncoder>): VariableSizeEncoder<GetTypeFromVariants<TVariants>>;
+/**
+ * Creates a literal union decoder.
+ *
+ * @param variants - The variant decoders of the literal union.
+ * @param config - A set of config for the decoder.
+ */
+export declare function getLiteralUnionDecoder<const TVariants extends readonly Variant[]>(variants: TVariants): FixedSizeDecoder<GetTypeFromVariants<TVariants>, 1>;
+export declare function getLiteralUnionDecoder<const TVariants extends readonly Variant[], TSize extends number>(variants: TVariants, config: LiteralUnionCodecConfig<NumberDecoder> & {
+    size: FixedSizeNumberDecoder<TSize>;
+}): FixedSizeDecoder<GetTypeFromVariants<TVariants>, TSize>;
+export declare function getLiteralUnionDecoder<const TVariants extends readonly Variant[]>(variants: TVariants, config?: LiteralUnionCodecConfig<NumberDecoder>): VariableSizeDecoder<GetTypeFromVariants<TVariants>>;
+/**
+ * Creates a literal union codec.
+ *
+ * @param variants - The variant codecs of the literal union.
+ * @param config - A set of config for the codec.
+ */
+export declare function getLiteralUnionCodec<const TVariants extends readonly Variant[]>(variants: TVariants): FixedSizeCodec<GetTypeFromVariants<TVariants>, GetTypeFromVariants<TVariants>, 1>;
+export declare function getLiteralUnionCodec<const TVariants extends readonly Variant[], TSize extends number>(variants: TVariants, config: LiteralUnionCodecConfig<NumberCodec> & {
+    size: FixedSizeNumberCodec<TSize>;
+}): FixedSizeCodec<GetTypeFromVariants<TVariants>, GetTypeFromVariants<TVariants>, TSize>;
+export declare function getLiteralUnionCodec<const TVariants extends readonly Variant[]>(variants: TVariants, config?: LiteralUnionCodecConfig<NumberCodec>): VariableSizeCodec<GetTypeFromVariants<TVariants>>;
+export {};
+//# sourceMappingURL=literal-union.d.ts.map

package/dist/types/literal-union.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"literal-union.d.ts","sourceRoot":"","sources":["../../src/literal-union.ts"],"names":[],"mappings":"AAAA,OAAO,EAKH,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAGhB,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACtB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACH,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EAGtB,WAAW,EACX,aAAa,EACb,aAAa,EAChB,MAAM,wBAAwB,CAAC;AAOhC,mDAAmD;AACnD,MAAM,MAAM,uBAAuB,CAAC,cAAc,GAAG,WAAW,GAAG,aAAa,GAAG,aAAa,IAAI;IAChG;;;OAGG;IACH,IAAI,CAAC,EAAE,cAAc,CAAC;CACzB,CAAC;AAEF,KAAK,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;AACrE,KAAK,mBAAmB,CAAC,SAAS,SAAS,SAAS,OAAO,EAAE,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC;AAEnF;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,CAAC,SAAS,SAAS,SAAS,OAAO,EAAE,EAC7E,QAAQ,EAAE,SAAS,GACpB,gBAAgB,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;AACvD,wBAAgB,sBAAsB,CAAC,KAAK,CAAC,SAAS,SAAS,SAAS,OAAO,EAAE,EAAE,KAAK,SAAS,MAAM,EACnG,QAAQ,EAAE,SAAS,EACnB,MAAM,EAAE,uBAAuB,CAAC,aAAa,CAAC,GAAG;IAAE,IAAI,EAAE,sBAAsB,CAAC,KAAK,CAAC,CAAA;CAAE,GACzF,gBAAgB,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,CAAC;AAC3D,wBAAgB,sBAAsB,CAAC,KAAK,CAAC,SAAS,SAAS,SAAS,OAAO,EAAE,EAC7E,QAAQ,EAAE,SAAS,EACnB,MAAM,CAAC,EAAE,uBAAuB,CAAC,aAAa,CAAC,GAChD,mBAAmB,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC;AAkBvD;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,CAAC,SAAS,SAAS,SAAS,OAAO,EAAE,EAC7E,QAAQ,EAAE,SAAS,GACpB,gBAAgB,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;AACvD,wBAAgB,sBAAsB,CAAC,KAAK,CAAC,SAAS,SAAS,SAAS,OAAO,EAAE,EAAE,KAAK,SAAS,MAAM,EACnG,QAAQ,EAAE,SAAS,EACnB,MAAM,EAAE,uBAAuB,CAAC,aAAa,CAAC,GAAG;IAAE,IAAI,EAAE,sBAAsB,CAAC,KAAK,CAAC,CAAA;CAAE,GACzF,gBAAgB,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,CAAC;AAC3D,wBAAgB,sBAAsB,CAAC,KAAK,CAAC,SAAS,SAAS,SAAS,OAAO,EAAE,EAC7E,QAAQ,EAAE,SAAS,EACnB,MAAM,CAAC,EAAE,uBAAuB,CAAC,aAAa,CAAC,GAChD,mBAAmB,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC;AAkBvD;;;;;GAKG;AAEH,wBAAgB,oBAAoB,CAAC,KAAK,CAAC,SAAS,SAAS,SAAS,OAAO,EAAE,EAC3E,QAAQ,EAAE,SAAS,GACpB,cAAc,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;AACrF,wBAAgB,oBAAoB,CAAC,KAAK,CAAC,SAAS,SAAS,SAAS,OAAO,EAAE,EAAE,KAAK,SAAS,MAAM,EACjG,QAAQ,EAAE,SAAS,EACnB,MAAM,EAAE,uBAAuB,CAAC,WAAW,CAAC,GAAG;IAAE,IAAI,EAAE,oBAAoB,CAAC,KAAK,CAAC,CAAA;CAAE,GACrF,cAAc,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,CAAC;AACzF,wBAAgB,oBAAoB,CAAC,KAAK,CAAC,SAAS,SAAS,SAAS,OAAO,EAAE,EAC3E,QAAQ,EAAE,SAAS,EACnB,MAAM,CAAC,EAAE,uBAAuB,CAAC,WAAW,CAAC,GAC9C,iBAAiB,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solana/codecs-data-structures",
-  "version": "2.0.0",
+  "version": "2.0.1-canary-20241112044734",
   "description": "Codecs for various data structures",
   "exports": {
     "edge-light": {
@@ -53,13 +53,10 @@
     "supports bigint and not dead",
     "maintained node versions"
   ],
-  "engine": {
-    "node": ">=17.4"
-  },
   "dependencies": {
-    "@solana/codecs-core": "2.0.0",
-    "@solana/codecs-numbers": "2.0.0",
-    "@solana/errors": "2.0.0"
+    "@solana/codecs-core": "2.0.1-canary-20241112044734",
+    "@solana/errors": "2.0.1-canary-20241112044734",
+    "@solana/codecs-numbers": "2.0.1-canary-20241112044734"
   },
   "peerDependencies": {
     "typescript": ">=5"