@lionweb/textgen-utils 0.7.0-beta.8 → 0.7.0

package/dist/general.d.ts

@@ -16,5 +16,5 @@ export declare const withFirstUpper: (str: string) => string;
  * @param left thunk returning a string
  * @param right string
  */
-export declare const wrapInIf: (condition: boolean, left: () => string, right: string) => (text: string) => string;
+export declare const wrapInIf: (condition: boolean, left: () => string, right: string) => ((text: string) => string);
 //# sourceMappingURL=general.d.ts.map

package/dist/general.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"general.d.ts","sourceRoot":"","sources":["../src/general.ts"],"names":[],"mappings":"AAmBA;;GAEG;AACH,eAAO,MAAM,MAAM,qEAAwB,CAAA;AAY3C;;GAEG;AACH,eAAO,MAAM,cAAc,QAXjB,MAAM,WAWsD,CAAA;AAEtE;;GAEG;AACH,eAAO,MAAM,cAAc,QAhBjB,MAAM,WAgBsD,CAAA;AAGtE;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,cAAe,OAAO,QAAQ,MAAM,MAAM,SAAS,MAAM,YAAW,MAAM,KAAK,MAG5E,CAAA"}
+{"version":3,"file":"general.d.ts","sourceRoot":"","sources":["../src/general.ts"],"names":[],"mappings":"AAmBA;;GAEG;AACH,eAAO,MAAM,MAAM,qEAAwB,CAAA;AAY3C;;GAEG;AACH,eAAO,MAAM,cAAc,QAXjB,MAAM,WAWsD,CAAA;AAEtE;;GAEG;AACH,eAAO,MAAM,cAAc,QAhBjB,MAAM,WAgBsD,CAAA;AAGtE;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,GAAI,WAAW,OAAO,EAAE,MAAM,MAAM,MAAM,EAAE,OAAO,MAAM,KAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAGlF,CAAA"}

package/dist/javascript.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"javascript.d.ts","sourceRoot":"","sources":["../src/javascript.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAG7C;;GAEG;AACH,eAAO,MAAM,cAAc,QAAS,MAAM,KAAG,MAGhB,CAAA;AAG7B;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,CAAC,CAAA;AAErE;;;;;GAKG;AACH,eAAO,MAAM,UAAU,eAAgB,MAAM,SAAS,SAAS,EAAE,gBAAgB,QAAQ,eAuBhF,CAAA;AAGT;;GAEG;AACH,eAAO,MAAM,YAAY,SAAU,OAAO,WACwB,CAAA"}
+{"version":3,"file":"javascript.d.ts","sourceRoot":"","sources":["../src/javascript.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAG7C;;GAEG;AACH,eAAO,MAAM,cAAc,GAAI,KAAK,MAAM,KAAG,MAGhB,CAAA;AAG7B;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,cAAc,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,CAAC,CAAA;AAErE;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,YAAY,MAAM,EAAE,OAAO,SAAS,EAAE,EAAE,cAAc,QAAQ,eAuBhF,CAAA;AAGT;;GAEG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,OAAO,WACmB,CAAA"}

package/dist/javascript.js

@@ -14,6 +14,7 @@
 //
 // SPDX-FileCopyrightText: 2025 TRUMPF Laser SE and other contributors
 // SPDX-License-Identifier: Apache-2.0
+import { asPrettyJsonString } from "@lionweb/ts-utils";
 import { indent } from "./general.js";
 /**
  * @return a sanitized version of the given string that should be suitable as a valid JavaScript identifier.
@@ -53,5 +54,5 @@ export const switchOrIf = (expression, cases, defaultBlock) => cases.length > 1
 /**
  * @return the given JSON as valid TypeScript source, meaning: without quotation marks around object keys.
  */
-export const asTypeScript = (json) => JSON.stringify(json, null, 4).replaceAll(/"(.+?)": /g, `$1: `);
+export const asTypeScript = (json) => asPrettyJsonString(json).replaceAll(/"(.+?)": /g, `$1: `);
 //# sourceMappingURL=javascript.js.map

package/dist/javascript.js.map

@@ -1 +1 @@
-{"version":3,"file":"javascript.js","sourceRoot":"","sources":["../src/javascript.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,EAAE;AACF,iEAAiE;AACjE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,sEAAsE;AACtE,sCAAsC;AAGtC,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAErC;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAW,EAAU,EAAE,CAClD,GAAG;KACE,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC;KACpB,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;AAQ7B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,UAAkB,EAAE,KAAkB,EAAE,YAAsB,EAAE,EAAE,CACzF,KAAK,CAAC,MAAM,GAAG,CAAC;IACZ,CAAC,CAAC;QACE,WAAW,UAAU,KAAK;QAC1B,MAAM,CAAC;YACH,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,cAAc,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,QAAQ,cAAc,YAAY,WAAW,GAAG,CAAC;YAC9F,OAAO,YAAY,KAAK,QAAQ;gBAC5B,CAAC,CAAC,YAAY,YAAY,EAAE;gBAC5B,CAAC,CAAC;oBACE,YAAY;oBACZ,MAAM,CAAC,YAAY,CAAC;oBACpB,GAAG;iBACN;SACR,CAAC;QACF,GAAG;KACN;IACD,CAAC,CAAC;QACE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,cAAc,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC;YACzC,OAAO,UAAU,QAAQ,cAAc,KAAK;YAC5C,MAAM,CAAC,UAAU,WAAW,GAAG,CAAC;YAChC,GAAG;SACN,CAAC;QACF,YAAY;KACf,CAAA;AAGT;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAa,EAAE,EAAE,CAC1C,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA"}
+{"version":3,"file":"javascript.js","sourceRoot":"","sources":["../src/javascript.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,EAAE;AACF,iEAAiE;AACjE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,sEAAsE;AACtE,sCAAsC;AAEtC,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAEtD,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAErC;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAW,EAAU,EAAE,CAClD,GAAG;KACE,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC;KACpB,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;AAQ7B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,UAAkB,EAAE,KAAkB,EAAE,YAAsB,EAAE,EAAE,CACzF,KAAK,CAAC,MAAM,GAAG,CAAC;IACZ,CAAC,CAAC;QACE,WAAW,UAAU,KAAK;QAC1B,MAAM,CAAC;YACH,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,cAAc,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,QAAQ,cAAc,YAAY,WAAW,GAAG,CAAC;YAC9F,OAAO,YAAY,KAAK,QAAQ;gBAC5B,CAAC,CAAC,YAAY,YAAY,EAAE;gBAC5B,CAAC,CAAC;oBACE,YAAY;oBACZ,MAAM,CAAC,YAAY,CAAC;oBACpB,GAAG;iBACN;SACR,CAAC;QACF,GAAG;KACN;IACD,CAAC,CAAC;QACE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,cAAc,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC;YACzC,OAAO,UAAU,QAAQ,cAAc,KAAK;YAC5C,MAAM,CAAC,UAAU,WAAW,GAAG,CAAC;YAChC,GAAG;SACN,CAAC;QACF,YAAY;KACf,CAAA;AAGT;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAa,EAAE,EAAE,CAC1C,kBAAkB,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA"}

package/package.json

@@ -1,32 +1,33 @@
 {
-  "name": "@lionweb/textgen-utils",
-  "version": "0.7.0-beta.8",
-  "description": "Utilities for text generation",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "typings": "dist/index.d.ts",
-  "type": "module",
-  "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/LionWeb-io/lionweb-typescript.git"
-  },
-  "bugs": {
-    "url": "https://github.com/LionWeb-io/lionweb-typescript/issues"
-  },
-  "scripts": {
-    "clean": "npx rimraf dist node_modules -g lionweb-textgen-utils-*.tgz",
-    "build": "tsc",
-    "lint": "eslint src",
-    "prep:pre-release": "npm run clean && npm install && npm run build",
-    "prerelease-alpha": "npm run prep:pre-release",
-    "release-alpha": "npm publish --tag alpha",
-    "prerelease-beta": "npm run prep:pre-release",
-    "release-beta": "npm publish --tag beta",
-    "prerelease": "npm run prep:pre-release",
-    "release": "npm publish"
-  },
-  "dependencies": {
-    "littoral-templates": "0.5.0"
-  }
+    "name": "@lionweb/textgen-utils",
+    "version": "0.7.0",
+    "description": "Utilities for text generation",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "typings": "dist/index.d.ts",
+    "type": "module",
+    "license": "Apache-2.0",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/LionWeb-io/lionweb-typescript.git"
+    },
+    "bugs": {
+        "url": "https://github.com/LionWeb-io/lionweb-typescript/issues"
+    },
+    "scripts": {
+        "clean": "npx rimraf dist node_modules -g lionweb-textgen-utils-*.tgz",
+        "build": "tsc",
+        "lint": "eslint src",
+        "prep:pre-release": "npm run clean && npm install && npm run build",
+        "prerelease-alpha": "npm run prep:pre-release",
+        "release-alpha": "npm publish --tag alpha",
+        "prerelease-beta": "npm run prep:pre-release",
+        "release-beta": "npm publish --tag beta",
+        "prerelease": "npm run prep:pre-release",
+        "release": "npm publish"
+    },
+    "dependencies": {
+        "@lionweb/ts-utils": "0.7.0",
+        "littoral-templates": "0.5.1"
+    }
 }

package/src/general.ts

@@ -0,0 +1,57 @@
+// Copyright 2025 TRUMPF Laser SE and other contributors
+//
+// Licensed under the Apache License, Version 2.0 (the "License")
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// SPDX-FileCopyrightText: 2025 TRUMPF Laser SE and other contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { indentWith } from "littoral-templates"
+
+/**
+ * @return an indenter function that indents by 4 spaces.
+ */
+export const indent = indentWith("    ")(1)
+
+
+const withFirstCased = (charFunc: (ch: string) => string) =>
+    (str: string) => {
+        if (str.length === 0) {
+            return str
+        }
+        return charFunc(str.charAt(0))
+            + (str.length > 1 ? str.substring(1) : "")
+    }
+
+/**
+ * @return the given string but with its first character lower-cased (when possible).
+ */
+export const withFirstLower = withFirstCased((ch) => ch.toLowerCase())
+
+/**
+ * @return the given string but with its first character upper-cased (when possible).
+ */
+export const withFirstUpper = withFirstCased((ch) => ch.toUpperCase())
+
+
+/**
+ * @return a function that takes one string argument, and returns that argument wrapped between `left` and `right`, provided `condition` is true.
+ * @param condition boolean
+ * @param left thunk returning a string
+ * @param right string
+ */
+export const wrapInIf = (condition: boolean, left: () => string, right: string): ((text: string) => string) =>
+    condition
+        ? (text) => `${left()}${text}${right}`  // (don't pre-eval left, as it might have side-effects)
+        : (text) => text
+
+

package/src/index.ts

@@ -0,0 +1,20 @@
+// Copyright 2025 TRUMPF Laser SE and other contributors
+//
+// Licensed under the Apache License, Version 2.0 (the "License")
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// SPDX-FileCopyrightText: 2025 TRUMPF Laser SE and other contributors
+// SPDX-License-Identifier: Apache-2.0
+
+export * from "./javascript.js"
+export * from "./general.js"
+

package/src/javascript.ts

@@ -0,0 +1,73 @@
+// Copyright 2025 TRUMPF Laser SE and other contributors
+//
+// Licensed under the Apache License, Version 2.0 (the "License")
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// SPDX-FileCopyrightText: 2025 TRUMPF Laser SE and other contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { asPrettyJsonString } from "@lionweb/ts-utils"
+import { Template } from "littoral-templates"
+import { indent } from "./general.js"
+
+/**
+ * @return a sanitized version of the given string that should be suitable as a valid JavaScript identifier.
+ */
+export const asJSIdentifier = (str: string): string =>
+    str
+        .replaceAll(".", "_")
+        .replaceAll("-", "_")
+
+
+/**
+ * A type def. that captures one `case` of a TypeScript `switch` statement.
+ */
+export type MatchCase = [caseExpression: string, returnValue: string]
+
+/**
+ * @return a JavaScript `switch` statement (as a {@link Template template}).
+ * @param expression string with a valid JS expression
+ * @param cases `cases` of the `switch` statement, encoded using {@link MatchCase}
+ * @param defaultBlock template with a valid `default` block – assumed to be a single-line string if it's a string
+ */
+export const switchOrIf = (expression: string, cases: MatchCase[], defaultBlock: Template) =>
+    cases.length > 1
+        ? [
+            `switch (${expression}) {`,
+            indent([
+                cases.map(([caseExpression, returnValue]) => `case ${caseExpression}: return ${returnValue};`),
+                typeof defaultBlock === "string"
+                    ? `default: ${defaultBlock}`
+                    : [
+                        `default: {`,
+                        indent(defaultBlock),
+                        `}`
+                    ]
+            ]),
+            `}`
+        ]
+        : [
+            cases.map(([caseExpression, returnValue]) => [
+                `if (${expression} === ${caseExpression}) {`,
+                indent(`return ${returnValue};`),
+                `}`
+            ]),
+            defaultBlock
+        ]
+
+
+/**
+ * @return the given JSON as valid TypeScript source, meaning: without quotation marks around object keys.
+ */
+export const asTypeScript = (json: unknown) =>
+    asPrettyJsonString(json).replaceAll(/"(.+?)": /g, `$1: `)
+