Really map/list types, add empty overloads

Author: burner1024

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.4.0
+
+- **Breaking:** `SfallMap<K, V>` now requires `K extends string | number` and uses a mapped type `[key in K]: V` instead of open index signatures. This enforces type-safe key access — a `SfallMap<number, V>` no longer silently accepts string keys.
+- **Breaking:** All generic functions accepting `SfallMap` (`map_contains_key`, `array_keys`, `array_values`, `clone_array`, `array_append`, `array_concat`, `create_array_map`, `temp_array_map`, `create_lookup_map`, `temp_lookup_map`) now constrain `K extends string | number`.
+- Add no-arg overloads for `list<T>()` and `map<K, V>()` to create empty typed collections.
+
 ## 0.3.0
 
 - **Breaking:** Rename `folib/rp/*` to `folib/rpu/*` (Restoration Project, updated).

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "folib",
-	"version": "0.3.0",
+	"version": "0.4.0",
 	"description": "TypeScript bindings for Fallout 2",
 	"type": "module",
 	"files": [

src/sfall/lib.arrays.ts

@@ -12,7 +12,7 @@ import {
 import { temp_array_list, temp_array_map, array_is_map } from "./sfall";
 
 /** Check if key exists in map array */
-export function map_contains_key<K, V>(arrayMap: SfallMap<K, V>, key: K): boolean {
+export function map_contains_key<K extends string | number, V>(arrayMap: SfallMap<K, V>, key: K): boolean {
     for (let i = 0; i < len_array(arrayMap); i++) {
         if (array_key(arrayMap, i) == key) return true;
     }
@@ -51,7 +51,7 @@ export function array_pop<T>(array: SfallList<T>): T {
 }
 
 /** Returns a temp list of keys from a given array */
-export function array_keys<K, V>(array: SfallMap<K, V>): SfallList<K>;
+export function array_keys<K extends string | number, V>(array: SfallMap<K, V>): SfallList<K>;
 export function array_keys<T>(array: SfallList<T>): SfallList<number>;
 export function array_keys(array: any): any {
     const len = len_array(array);
@@ -63,7 +63,7 @@ export function array_keys(array: any): any {
 }
 
 /** Returns a temp list of values from a given array */
-export function array_values<K, V>(array: SfallMap<K, V>): SfallList<V>;
+export function array_values<K extends string | number, V>(array: SfallMap<K, V>): SfallList<V>;
 export function array_values<T>(array: SfallList<T>): SfallList<T>;
 export function array_values(array: any): any {
     const len = len_array(array);
@@ -118,7 +118,7 @@ export function copy_array<T>(src: SfallList<T>, srcPos: number, dest: SfallList
 }
 
 /** Create a shallow copy of array as new temp array */
-export function clone_array<K, V>(array: SfallMap<K, V>): SfallMap<K, V>;
+export function clone_array<K extends string | number, V>(array: SfallMap<K, V>): SfallMap<K, V>;
 export function clone_array<T>(array: SfallList<T>): SfallList<T>;
 export function clone_array(array: any): any {
     const len = len_array(array);
@@ -251,7 +251,7 @@ export function array_fill<T>(arr: SfallList<T>, pos: number, count: number, val
 
 /** Append all items from arr2 to arr1 */
 export function array_append<T>(arr1: SfallList<T>, arr2: SfallList<T>): SfallList<T>;
-export function array_append<K, V>(arr1: SfallMap<K, V>, arr2: SfallMap<K, V>): SfallMap<K, V>;
+export function array_append<K extends string | number, V>(arr1: SfallMap<K, V>, arr2: SfallMap<K, V>): SfallMap<K, V>;
 export function array_append(arr1: any, arr2: any): any {
     if (array_is_map(arr1)) {
         const len2 = len_array(arr2);
@@ -270,7 +270,7 @@ export function array_append(arr1: any, arr2: any): any {
 
 /** Concat arrays into new temp array */
 export function array_concat<T>(arr1: SfallList<T>, arr2: SfallList<T>): SfallList<T>;
-export function array_concat<K, V>(arr1: SfallMap<K, V>, arr2: SfallMap<K, V>): SfallMap<K, V>;
+export function array_concat<K extends string | number, V>(arr1: SfallMap<K, V>, arr2: SfallMap<K, V>): SfallMap<K, V>;
 export function array_concat(arr1: any, arr2: any): any {
     return array_append(clone_array(arr1), arr2);
 }

src/sfall/sfall.ts

@@ -1079,22 +1079,22 @@ export function temp_array_list<T>(size: number): SfallList<T> {
 }
 
 /** Create a persistent map */
-export function create_array_map<K, V>(): SfallMap<K, V> {
+export function create_array_map<K extends string | number, V>(): SfallMap<K, V> {
     return create_array(-1, 0) as unknown as SfallMap<K, V>;
 }
 
 /** Create a temporary map */
-export function temp_array_map<K, V>(): SfallMap<K, V> {
+export function temp_array_map<K extends string | number, V>(): SfallMap<K, V> {
     return temp_array(-1, 0) as unknown as SfallMap<K, V>;
 }
 
 /** Create a persistent lookup map (see arrays.txt for details) */
-export function create_lookup_map<K, V>(): SfallMap<K, V> {
+export function create_lookup_map<K extends string | number, V>(): SfallMap<K, V> {
     return create_array(-1, 2) as unknown as SfallMap<K, V>;
 }
 
 /** Create a temporary lookup map */
-export function temp_lookup_map<K, V>(): SfallMap<K, V> {
+export function temp_lookup_map<K extends string | number, V>(): SfallMap<K, V> {
     return temp_array(-1, 2) as unknown as SfallMap<K, V>;
 }
 

src/types.d.ts

@@ -98,22 +98,33 @@ export type HitResult = 0 | 1 | 2 | 3;
 /** Sfall list array - numeric index, iterable over values */
 export type SfallList<T> = {
     [index: number]: T;
+} & Iterable<T> & {
     readonly __brand: 'SfallList';
-} & Iterable<T>;
+};
 
 /** Sfall map array - key/value pairs, iterable as [key, value] tuples */
-export type SfallMap<K, V> = {
-    [key: string]: V;
-    [key: number]: V;
+export type SfallMap<K extends string | number, V> = {
+    [key in K]: V;
+} & Iterable<[K, V]> & {
     readonly __brand: 'SfallMap';
-} & Iterable<[K, V]>;
+};
 
 /**
  * Create a typed list from items. Transpiles to array literal [a, b, c].
  */
 export declare function list<T>(...items: T[]): SfallList<T>;
 
+/**
+ * Create an empty typed list. Transpiles to empty array literal [].
+ */
+export declare function list<T>(): SfallList<T>;
+
 /**
  * Create a typed map from object literal. Transpiles to map literal {a: 1}.
  */
 export declare function map<K extends string | number, V>(obj: Record<K, V>): SfallMap<K, V>;
+
+/**
+ * Create an empty typed map. Transpiles to empty map literal {}.
+ */
+export declare function map<K extends string | number, V>(): SfallMap<K, V>;