@skmtc/core 0.0.333 → 0.0.335

package/script/typescript/List.d.ts

@@ -1,23 +1,90 @@
 import type { Stringable } from '../dsl/Stringable.js';
 type ConstructorOptions = {
     separator?: string;
-    bookends?: 'square' | 'curly' | 'round' | 'none';
+    bookends?: 'square' | 'curly' | 'round' | 'angle' | 'none';
 };
 export declare class List {
     values: Stringable[];
     separator: string;
-    bookends: 'square' | 'curly' | 'round' | 'none';
+    bookends: 'square' | 'curly' | 'round' | 'angle' | 'none';
     constructor(values: (Stringable | undefined)[], { separator, bookends }?: ConstructorOptions);
     toString(): string;
+    /**
+     * Create an empty List that will render as an empty string ''
+     * @returns List
+     */
     static toEmpty: () => List;
+    /**
+     * Create a List with a single value that will render as `value`
+     * @param value
+     * @returns List
+     */
     static toSingle: (value: Stringable) => List;
-    static toOptional: (value: Stringable, condition: boolean) => List;
+    /**
+     * If condition is true, return a List with a single value that will render as `value`.
+     * Otherwise, return an empty List that will render as an empty string ''.
+     *
+     * Useful for conditional rendering. For example, rendering a function arg object when
+     * it has at least one property.
+     * @param value
+     * @param condition
+     * @returns List
+     */
+    static toConditional: (value: Stringable, condition: boolean) => List;
+    /**
+     * Create a record with Stringable values. KeyValue pairs will be joined with `: ` as separator
+     * and the resulting List will be wrapped with `{}`
+     * @param record
+     * @returns `record` with `Stringable` values
+     */
+    static toRecord: (record: Record<string, Stringable | Stringable[] | List>) => List;
+    /**
+     * Create a record with `undefined` or empty array or List values filtered out.
+     * @param record
+     * @returns `record` with `undefined` values filtered out
+     */
     static toFilteredRecord: (record: Record<string, undefined | Stringable | Stringable[] | List>) => List;
+    /**
+     * Join `key` and `value` using `: ` as separator
+     * @param key
+     * @param value
+     * @returns `key` and `value` joined with `: ` as separator
+     */
     static toKeyValue: (key: string, value: Stringable) => List;
+    /**
+     * Join `key` and `value` using `.` as separator
+     * @param key
+     * @param value
+     * @returns `key` and `value` joined with `.` as separator
+     */
     static toObjectKey: (key: string, value: Stringable) => List;
+    /**
+     * Join `values` using `, ` as separator and wrap in `{` and `}`
+     * @param values
+     * @returns `values` joined with `, ` as separator and wrapped in `{` and `}`
+     */
     static toObject: (values: (Stringable | undefined)[]) => List;
+    /**
+     * Create a List using the keys of a record
+     * @param record
+     * @returns List of record keys
+     */
     static fromRecord: (record: Record<string, Stringable> | undefined) => List;
+    /**
+     * Create a keyValue pair if `value` is not undefined and is not an empty array or List.
+     * Return `undefined` otherwise.
+     *
+     * Useful for filtering out `undefined values from a record.
+     * @param key
+     * @param value
+     * @returns `key` and `value` joined with `: ` as separator if `value` is not undefined and is not an empty array or List. `undefined` otherwise.
+     */
     static toFilteredKeyValue: (key: string, value: undefined | Stringable | Stringable[] | List) => List | undefined;
+    /**
+     * Check if `value` is not undefined and is not an empty array or List.
+     * @param value
+     * @returns `true` if `value` is not undefined and is not an empty array or List. `false` otherwise.
+     */
     static hasValue: (value: undefined | Stringable | Stringable[] | List) => value is Stringable | Stringable[] | List;
 }
 export {};

package/script/typescript/List.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"List.d.ts","sourceRoot":"","sources":["../../src/typescript/List.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAGtD,KAAK,kBAAkB,GAAG;IACxB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;CACjD,CAAA;AAED,qBAAa,IAAI;IACf,MAAM,EAAE,UAAU,EAAE,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;gBAE7C,MAAM,EAAE,CAAC,UAAU,GAAG,SAAS,CAAC,EAAE,EAClC,EAAE,SAAgB,EAAE,QAAiB,EAAE,GAAE,kBAAuB;IAQlE,QAAQ,IAAI,MAAM;IAWlB,MAAM,CAAC,OAAO,aAA2C;IAEzD,MAAM,CAAC,QAAQ,UAAW,UAAU,UACK;IAEzC,MAAM,CAAC,UAAU,UAAW,UAAU,aAAa,OAAO,UACf;IAE3C,MAAM,CAAC,gBAAgB,WACb,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,EAAE,GAAG,IAAI,CAAC,UAOrE;IAED,MAAM,CAAC,UAAU,QAAS,MAAM,SAAS,UAAU,UACN;IAE7C,MAAM,CAAC,WAAW,QAAS,MAAM,SAAS,UAAU,UACR;IAE5C,MAAM,CAAC,QAAQ,WAAY,CAAC,UAAU,GAAG,SAAS,CAAC,EAAE,UACZ;IAEzC,MAAM,CAAC,UAAU,WAAY,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,SAAS,UAElE;IAED,MAAM,CAAC,kBAAkB,QAClB,MAAM,SACJ,SAAS,GAAG,UAAU,GAAG,UAAU,EAAE,GAAG,IAAI,sBAGpD;IAED,MAAM,CAAC,QAAQ,UACN,SAAS,GAAG,UAAU,GAAG,UAAU,EAAE,GAAG,IAAI,KAClD,KAAK,IAAI,UAAU,GAAG,UAAU,EAAE,GAAG,IAAI,CAc3C;CACF"}
+{"version":3,"file":"List.d.ts","sourceRoot":"","sources":["../../src/typescript/List.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAGtD,KAAK,kBAAkB,GAAG;IACxB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;CAC3D,CAAA;AAED,qBAAa,IAAI;IACf,MAAM,EAAE,UAAU,EAAE,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;gBAEvD,MAAM,EAAE,CAAC,UAAU,GAAG,SAAS,CAAC,EAAE,EAClC,EAAE,SAAgB,EAAE,QAAiB,EAAE,GAAE,kBAAuB;IAQlE,QAAQ,IAAI,MAAM;IAYlB;;;OAGG;IACH,MAAM,CAAC,OAAO,aAA2C;IAEzD;;;;OAIG;IACH,MAAM,CAAC,QAAQ,UAAW,UAAU,UAEnC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,aAAa,UAAW,UAAU,aAAa,OAAO,UAE5D;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,WACL,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,EAAE,GAAG,IAAI,CAAC,UAOzD;IAED;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,WACb,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,EAAE,GAAG,IAAI,CAAC,UAOrE;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,QAAS,MAAM,SAAS,UAAU,UAElD;IAED;;;;;OAKG;IACH,MAAM,CAAC,WAAW,QAAS,MAAM,SAAS,UAAU,UAEnD;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ,WAAY,CAAC,UAAU,GAAG,SAAS,CAAC,EAAE,UAEpD;IAED;;;;OAIG;IACH,MAAM,CAAC,UAAU,WAAY,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,SAAS,UAElE;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,kBAAkB,QAClB,MAAM,SACJ,SAAS,GAAG,UAAU,GAAG,UAAU,EAAE,GAAG,IAAI,sBAGpD;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ,UACN,SAAS,GAAG,UAAU,GAAG,UAAU,EAAE,GAAG,IAAI,KAClD,KAAK,IAAI,UAAU,GAAG,UAAU,EAAE,GAAG,IAAI,CAc3C;CACF"}

package/script/typescript/List.js

@@ -32,29 +32,75 @@ class List {
             .with('square', () => `[${joined}]`)
             .with('curly', () => `{${joined}}`)
             .with('round', () => `(${joined})`)
+            .with('angle', () => `<${joined}>`)
             .with('none', () => joined)
             .exhaustive();
     }
 }
 exports.List = List;
+/**
+ * Create an empty List that will render as an empty string ''
+ * @returns List
+ */
 Object.defineProperty(List, "toEmpty", {
     enumerable: true,
     configurable: true,
     writable: true,
     value: () => new List([], { bookends: 'none' })
 });
+/**
+ * Create a List with a single value that will render as `value`
+ * @param value
+ * @returns List
+ */
 Object.defineProperty(List, "toSingle", {
     enumerable: true,
     configurable: true,
     writable: true,
-    value: (value) => new List([value], { bookends: 'none' })
+    value: (value) => {
+        return new List([value], { bookends: 'none' });
+    }
 });
-Object.defineProperty(List, "toOptional", {
+/**
+ * If condition is true, return a List with a single value that will render as `value`.
+ * Otherwise, return an empty List that will render as an empty string ''.
+ *
+ * Useful for conditional rendering. For example, rendering a function arg object when
+ * it has at least one property.
+ * @param value
+ * @param condition
+ * @returns List
+ */
+Object.defineProperty(List, "toConditional", {
     enumerable: true,
     configurable: true,
     writable: true,
-    value: (value, condition) => new List([condition ? value : undefined])
+    value: (value, condition) => {
+        return new List([condition ? value : undefined], { bookends: 'none' });
+    }
 });
+/**
+ * Create a record with Stringable values. KeyValue pairs will be joined with `: ` as separator
+ * and the resulting List will be wrapped with `{}`
+ * @param record
+ * @returns `record` with `Stringable` values
+ */
+Object.defineProperty(List, "toRecord", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: (record) => {
+        const entries = Object.entries(record).map(([key, value]) => {
+            return List.toKeyValue(key, value);
+        });
+        return List.toObject(entries);
+    }
+});
+/**
+ * Create a record with `undefined` or empty array or List values filtered out.
+ * @param record
+ * @returns `record` with `undefined` values filtered out
+ */
 Object.defineProperty(List, "toFilteredRecord", {
     enumerable: true,
     configurable: true,
@@ -66,24 +112,52 @@ Object.defineProperty(List, "toFilteredRecord", {
         return List.toObject(entries);
     }
 });
+/**
+ * Join `key` and `value` using `: ` as separator
+ * @param key
+ * @param value
+ * @returns `key` and `value` joined with `: ` as separator
+ */
 Object.defineProperty(List, "toKeyValue", {
     enumerable: true,
     configurable: true,
     writable: true,
-    value: (key, value) => new List([key, value], { separator: ': ' })
+    value: (key, value) => {
+        return new List([key, value], { separator: ': ' });
+    }
 });
+/**
+ * Join `key` and `value` using `.` as separator
+ * @param key
+ * @param value
+ * @returns `key` and `value` joined with `.` as separator
+ */
 Object.defineProperty(List, "toObjectKey", {
     enumerable: true,
     configurable: true,
     writable: true,
-    value: (key, value) => new List([key, value], { separator: '.' })
+    value: (key, value) => {
+        return new List([key, value], { separator: '.' });
+    }
 });
+/**
+ * Join `values` using `, ` as separator and wrap in `{` and `}`
+ * @param values
+ * @returns `values` joined with `, ` as separator and wrapped in `{` and `}`
+ */
 Object.defineProperty(List, "toObject", {
     enumerable: true,
     configurable: true,
     writable: true,
-    value: (values) => new List(values, { bookends: 'curly' })
+    value: (values) => {
+        return new List(values, { bookends: 'curly' });
+    }
 });
+/**
+ * Create a List using the keys of a record
+ * @param record
+ * @returns List of record keys
+ */
 Object.defineProperty(List, "fromRecord", {
     enumerable: true,
     configurable: true,
@@ -92,6 +166,15 @@ Object.defineProperty(List, "fromRecord", {
         return new List(Object.keys(record ?? {}));
     }
 });
+/**
+ * Create a keyValue pair if `value` is not undefined and is not an empty array or List.
+ * Return `undefined` otherwise.
+ *
+ * Useful for filtering out `undefined values from a record.
+ * @param key
+ * @param value
+ * @returns `key` and `value` joined with `: ` as separator if `value` is not undefined and is not an empty array or List. `undefined` otherwise.
+ */
 Object.defineProperty(List, "toFilteredKeyValue", {
     enumerable: true,
     configurable: true,
@@ -100,6 +183,11 @@ Object.defineProperty(List, "toFilteredKeyValue", {
         return List.hasValue(value) ? List.toKeyValue(key, value) : undefined;
     }
 });
+/**
+ * Check if `value` is not undefined and is not an empty array or List.
+ * @param value
+ * @returns `true` if `value` is not undefined and is not an empty array or List. `false` otherwise.
+ */
 Object.defineProperty(List, "hasValue", {
     enumerable: true,
     configurable: true,