@sapphire/string-store 1.1.1-next.3d59d8ea → 1.2.0-next.80c79c3f

package/dist/cjs/index.d.cts

@@ -66,14 +66,14 @@ declare class UnalignedUint16Array {
     static from(value: string | UnalignedUint16Array): UnalignedUint16Array;
 }
 
-interface IType<ValueType, BitSize extends number | null> {
+interface IType<ValueType, BitSize extends number | null, InputValue = ValueType> {
     /**
      * Serialize a value to a buffer.
      *
      * @param buffer The buffer to write to
      * @param value The value to write
      */
-    serialize(buffer: UnalignedUint16Array, value: Readonly<ValueType>): void;
+    serialize(buffer: UnalignedUint16Array, value: InputValue): void;
     /**
      * Deserialize a value from a buffer.
      *
@@ -97,10 +97,12 @@ declare const BigUint32Type: IType<bigint, 32>;
 
 declare const BigUint64Type: IType<bigint, 64>;
 
-declare const BitType: IType<number, 1>;
+declare const BitType: IType<0 | 1, 1, number>;
 
 declare const BooleanType: IType<boolean, 1>;
 
+declare function ConstantType<const ValueType>(constantValue: ValueType): IType<ValueType, 0, never>;
+
 declare function FixedLengthArrayType<ValueType, ValueBitSize extends number | null>(type: IType<ValueType, ValueBitSize>, length: number): IType<ValueType[], ValueBitSize extends null ? null : number>;
 
 declare const Float32Type: IType<number, 32>;
@@ -119,11 +121,9 @@ declare const Int64Type: IType<number, 64>;
 
 declare const Int8Type: IType<number, 8>;
 
-declare const SnowflakeType: {
-    readonly serialize: (buffer: UnalignedUint16Array, value: bigint | string) => void;
-    readonly deserialize: (buffer: UnalignedUint16Array, offset: Pointer) => bigint;
-    readonly BIT_SIZE: 64;
-};
+declare function NullableType<ValueType, ValueBitSize extends number | null>(type: IType<ValueType, ValueBitSize>): IType<ValueType | null, null, ValueType | null | undefined>;
+
+declare const SnowflakeType: IType<bigint, 64, bigint | string>;
 
 declare const StringType: IType<string, null>;
 
@@ -141,33 +141,31 @@ declare const Uint8Type: IType<number, 8>;
 
 declare const t: {
     array: typeof ArrayType;
-    bigInt32: IType<bigint, 32>;
-    bigInt64: IType<bigint, 64>;
-    bigUint32: IType<bigint, 32>;
-    bigUint64: IType<bigint, 64>;
-    bit: IType<number, 1>;
-    boolean: IType<boolean, 1>;
+    bigInt32: IType<bigint, 32, bigint>;
+    bigInt64: IType<bigint, 64, bigint>;
+    bigUint32: IType<bigint, 32, bigint>;
+    bigUint64: IType<bigint, 64, bigint>;
+    bit: IType<0 | 1, 1, number>;
+    boolean: IType<boolean, 1, boolean>;
+    constant: typeof ConstantType;
     fixedLengthArray: typeof FixedLengthArrayType;
-    float32: IType<number, 32>;
-    float64: IType<number, 64>;
-    int16: IType<number, 16>;
-    int2: IType<number, 2>;
-    int32: IType<number, 32>;
-    int4: IType<number, 4>;
-    int64: IType<number, 64>;
-    int8: IType<number, 8>;
-    snowflake: {
-        readonly serialize: (buffer: UnalignedUint16Array, value: string | bigint) => void;
-        readonly deserialize: (buffer: UnalignedUint16Array, offset: Pointer) => bigint;
-        readonly BIT_SIZE: 64;
-    };
-    string: IType<string, null>;
-    uint16: IType<number, 16>;
-    uint2: IType<number, 2>;
-    uint32: IType<number, 32>;
-    uint4: IType<number, 4>;
-    uint64: IType<number, 64>;
-    uint8: IType<number, 8>;
+    float32: IType<number, 32, number>;
+    float64: IType<number, 64, number>;
+    int16: IType<number, 16, number>;
+    int2: IType<number, 2, number>;
+    int32: IType<number, 32, number>;
+    int4: IType<number, 4, number>;
+    int64: IType<number, 64, number>;
+    int8: IType<number, 8, number>;
+    nullable: typeof NullableType;
+    snowflake: IType<bigint, 64, string | bigint>;
+    string: IType<string, null, string>;
+    uint16: IType<number, 16, number>;
+    uint2: IType<number, 2, number>;
+    uint32: IType<number, 32, number>;
+    uint4: IType<number, 4, number>;
+    uint64: IType<number, 64, number>;
+    uint8: IType<number, 8, number>;
 };
 
 declare class Schema<Id extends number = number, Entries extends object = object> {
@@ -183,7 +181,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      */
     get id(): Id;
     /**
-     * The total bit size of the schema.
+     * The bit size of the entries in the schema.
      *
      * @remarks
      *
@@ -191,6 +189,15 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * schema will also be `null`.
      */
     get bitSize(): number | null;
+    /**
+     * The total bit size of the entries in the schema and the ID.
+     *
+     * @remarks
+     *
+     * If any of the entries have a bit size of `null`, the total bit size of
+     * the schema will also be `null`.
+     */
+    get totalBitSize(): number | null;
     /**
      * Get a property from the schema.
      *
@@ -213,7 +220,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * The schema's ID is written to the buffer first, followed by each property
      * in the schema.
      */
-    serialize(buffer: UnalignedUint16Array, value: Readonly<UnwrapSchemaEntries<Entries>>): void;
+    serialize(buffer: UnalignedUint16Array, value: Readonly<SerializeValueEntries<Entries>>): void;
     /**
      * Deserialize a value from a buffer.
      *
@@ -236,7 +243,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param type The type of the entry in the array
      * @returns The modified schema
      */
-    array<const Name extends string, const ValueType, const ValueBitSize extends number | null>(name: Name, type: IType<ValueType, ValueBitSize>): Merge$1<Id, Entries, Name, IType<ValueType[], null>>;
+    array<const Name extends string, const ValueType, const ValueBitSize extends number | null>(name: Name, type: IType<ValueType, ValueBitSize>): Merge$1<Id, Entries, Name, IType<ValueType[], null, ValueType[]>>;
     /**
      * Adds a fixed length array property to the schema.
      *
@@ -247,28 +254,28 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param length The length of the array
      * @returns The modified schema
      */
-    fixedLengthArray<const Name extends string, const ValueType, const ValueBitSize extends number | null>(name: Name, type: IType<ValueType, ValueBitSize>, length: number): Merge$1<Id, Entries, Name, IType<ValueType[], ValueBitSize extends null ? null : number>>;
+    fixedLengthArray<const Name extends string, const ValueType, const ValueBitSize extends number | null>(name: Name, type: IType<ValueType, ValueBitSize>, length: number): Merge$1<Id, Entries, Name, IType<ValueType[], ValueBitSize extends null ? null : number, ValueType[]>>;
     /**
      * Adds a string property to the schema.
      *
      * @param name The name of the property
      * @returns The modified schema
      */
-    string<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<string, null>>;
+    string<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<string, null, string>>;
     /**
      * Adds a boolean property to the schema.
      *
      * @param name The name of the property
      * @returns The modified schema
      */
-    boolean<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<boolean, 1>>;
+    boolean<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<boolean, 1, boolean>>;
     /**
      * Adds a bit property to the schema.
      *
      * @param name The name of the property
      * @returns The modified schema
      */
-    bit<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 1>>;
+    bit<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<0 | 1, 1, number>>;
     /**
      * Adds a 2-bit integer property to the schema.
      *
@@ -279,7 +286,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    int2<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 2>>;
+    int2<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 2, number>>;
     /**
      * Adds a 2-bit unsigned integer property to the schema.
      *
@@ -290,7 +297,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    uint2<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 2>>;
+    uint2<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 2, number>>;
     /**
      * Adds a 4-bit integer property to the schema.
      *
@@ -301,7 +308,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    int4<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 4>>;
+    int4<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 4, number>>;
     /**
      * Adds a 4-bit unsigned integer property to the schema.
      *
@@ -312,7 +319,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    uint4<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 4>>;
+    uint4<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 4, number>>;
     /**
      * Adds a 8-bit integer property to the schema.
      *
@@ -323,7 +330,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    int8<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 8>>;
+    int8<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 8, number>>;
     /**
      * Adds a 8-bit unsigned integer property to the schema.
      *
@@ -334,7 +341,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    uint8<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 8>>;
+    uint8<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 8, number>>;
     /**
      * Adds a 16-bit integer property to the schema.
      *
@@ -345,7 +352,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    int16<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 16>>;
+    int16<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 16, number>>;
     /**
      * Adds a 16-bit unsigned integer property to the schema.
      *
@@ -356,7 +363,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    uint16<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 16>>;
+    uint16<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 16, number>>;
     /**
      * Adds a 32-bit integer property to the schema.
      *
@@ -367,7 +374,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    int32<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 32>>;
+    int32<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 32, number>>;
     /**
      * Adds a 32-bit unsigned integer property to the schema.
      *
@@ -378,7 +385,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    uint32<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 32>>;
+    uint32<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 32, number>>;
     /**
      * Adds a 64-bit integer property to the schema.
      *
@@ -391,7 +398,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    int64<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 64>>;
+    int64<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 64, number>>;
     /**
      * Adds a 64-bit unsigned integer property to the schema.
      *
@@ -404,7 +411,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    uint64<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 64>>;
+    uint64<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 64, number>>;
     /**
      * Adds a 32-bit big integer property to the schema.
      *
@@ -415,7 +422,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    bigInt32<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<bigint, 32>>;
+    bigInt32<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<bigint, 32, bigint>>;
     /**
      * Adds a 32-bit big integer property to the schema.
      *
@@ -426,7 +433,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    bigUint32<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<bigint, 32>>;
+    bigUint32<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<bigint, 32, bigint>>;
     /**
      * Adds a 64-bit big integer property to the schema.
      *
@@ -437,7 +444,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    bigInt64<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<bigint, 64>>;
+    bigInt64<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<bigint, 64, bigint>>;
     /**
      * Adds a 64-bit big integer property to the schema.
      *
@@ -448,7 +455,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    bigUint64<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<bigint, 64>>;
+    bigUint64<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<bigint, 64, bigint>>;
     /**
      * Adds a 32-bit floating point number property to the schema.
      *
@@ -459,7 +466,7 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    float32<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 32>>;
+    float32<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 32, number>>;
     /**
      * Adds a 64-bit floating point number property to the schema.
      *
@@ -470,7 +477,15 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    float64<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 64>>;
+    float64<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<number, 64, number>>;
+    /**
+     * Adds a nullable property to the schema.
+     *
+     * @param name The name of the property
+     * @param type The type of the underlying value
+     * @returns The modified schema
+     */
+    nullable<const Name extends string, const ValueType, const ValueBitSize extends number | null>(name: Name, type: IType<ValueType, ValueBitSize>): Merge$1<Id, Entries, Name, IType<ValueType | null, null, ValueType | null | undefined>>;
     /**
      * Adds a 64-bit big integer property to the schema, similar to {@link Schema.bigUint64}.
      *
@@ -481,7 +496,16 @@ declare class Schema<Id extends number = number, Entries extends object = object
      * @param name The name of the property
      * @returns The modified schema
      */
-    snowflake<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<bigint, 64>>;
+    snowflake<const Name extends string>(name: Name): Merge$1<Id, Entries, Name, IType<bigint, 64, string | bigint>>;
+    /**
+     * Adds a constant value in the schema, this will **not** be serialized and
+     * can be used to add extra data without making the payload bigger.
+     *
+     * @param name The name of the property
+     * @param constantValue The value to add to the schema
+     * @returns The modified schema
+     */
+    constant<const Name extends string, const ValueType>(name: Name, constantValue: ValueType): Merge$1<Id, Entries, Name, IType<ValueType, 0, never>>;
     /**
      * Iterates over the schema's property names.
      *
@@ -517,11 +541,19 @@ type ValueOfSchema<SchemaValue extends object> = SchemaValue extends Schema<infe
 type EntryOfSchema<SchemaValue extends object> = SchemaValue extends Schema<infer _, infer Type> ? {
     [K in keyof Type]: readonly [K, Type[K]];
 }[keyof Type] : never;
-type UnwrapSchemaType<Type extends object> = Type extends IType<infer T, infer _> ? T : never;
+type UnwrapSchemaType<Type extends object> = Type extends IType<infer ValueType, infer _BitSize, infer _InputType> ? ValueType : never;
 type UnwrapSchemaEntries<Entries extends object> = {
     [K in keyof Entries]: UnwrapSchemaType<Entries[K] & object>;
 } & object;
-type UnwrapSchema<SchemaValue extends object> = SchemaValue extends Schema<infer _, infer Type> ? UnwrapSchemaEntries<Type> : never;
+type UnwrapSchema<SchemaValue extends object> = SchemaValue extends Schema<infer _Id, infer Type> ? UnwrapSchemaEntries<Type> : never;
+type OmitNever<T> = {
+    [K in keyof T as T[K] extends never ? never : K]: T[K];
+};
+type SerializeValueType<Type extends object> = Type extends IType<infer _ValueType, infer _BitSize, infer InputType> ? InputType : never;
+type SerializeValueEntries<Entries extends object> = OmitNever<{
+    [K in keyof Entries]: SerializeValueType<Entries[K] & object>;
+}>;
+type SerializeValue<SchemaValue extends object> = SchemaValue extends Schema<infer _Id, infer Type> ? SerializeValueEntries<Type> : never;
 
 declare class SchemaStore<Entries extends object = object> {
     #private;
@@ -564,7 +596,7 @@ declare class SchemaStore<Entries extends object = object> {
      * @param value The value to serialize
      * @returns The serialized buffer
      */
-    serialize<const Id extends KeyOfStore<this>>(id: Id, value: Readonly<UnwrapSchema<Entries[Id] & object>>): UnalignedUint16Array;
+    serialize<const Id extends KeyOfStore<this>>(id: Id, value: SerializeValue<Entries[Id] & object>): UnalignedUint16Array;
     /**
      * Deserializes a buffer
      *
@@ -639,4 +671,4 @@ declare function toUTF16(buffer: TypedArray): string;
  */
 declare function fromUTF16(buffer: string): Uint16Array;
 
-export { ArrayType, BigInt32Type, BigInt64Type, BigUint32Type, BigUint64Type, BitType, BooleanType, type DeserializationResult, type EntryOfSchema, type EntryOfStore, FixedLengthArrayType, Float32Type, Float64Type, type IType, Int16Type, Int2Type, Int32Type, Int4Type, Int64Type, Int8Type, type KeyOfSchema, type KeyOfStore, Pointer, type PointerLike, Schema, SchemaStore, SnowflakeType, StringType, type TypedArray, Uint16Type, Uint2Type, Uint32Type, Uint4Type, Uint64Type, Uint8Type, UnalignedUint16Array, type UnwrapSchema, type UnwrapSchemaEntries, type UnwrapSchemaType, type ValueOfSchema, type ValueOfStore, fromUTF16, t, toUTF16 };
+export { ArrayType, BigInt32Type, BigInt64Type, BigUint32Type, BigUint64Type, BitType, BooleanType, ConstantType, type DeserializationResult, type EntryOfSchema, type EntryOfStore, FixedLengthArrayType, Float32Type, Float64Type, type IType, Int16Type, Int2Type, Int32Type, Int4Type, Int64Type, Int8Type, type KeyOfSchema, type KeyOfStore, NullableType, Pointer, type PointerLike, Schema, SchemaStore, type SerializeValue, type SerializeValueEntries, type SerializeValueType, SnowflakeType, StringType, type TypedArray, Uint16Type, Uint2Type, Uint32Type, Uint4Type, Uint64Type, Uint8Type, UnalignedUint16Array, type UnwrapSchema, type UnwrapSchemaEntries, type UnwrapSchemaType, type ValueOfSchema, type ValueOfStore, fromUTF16, t, toUTF16 };