@cedarjs/utils 3.0.0-canary.13524

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Cedar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,42 @@
+# Utils
+
+Shared utilities for CedarJS packages and Cedar apps.
+
+## Utilities
+
+### `cedarPluralize`
+
+A thin wrapper around the [`pluralize`](https://github.com/plurals/pluralize)
+library that adds support for PascalCased multi-word identifiers (e.g.
+`DataModel` -> `DataModels`) and a custom singular/plural mapping registry.
+
+#### Functions
+
+| Function                              | Description                                    |
+| ------------------------------------- | ---------------------------------------------- |
+| `pluralize(word)`                     | Returns the plural form of the given word      |
+| `singularize(word)`                   | Returns the singular form of the given word    |
+| `isPlural(word)`                      | Returns `true` if the (last) word is plural    |
+| `isSingular(word)`                    | Returns `true` if the (last) word is singular  |
+| `addSingularPlural(singular, plural)` | Registers a custom singular <-> plural mapping |
+
+#### Usage
+
+```ts
+import {
+  pluralize,
+  singularize,
+  isPlural,
+  isSingular,
+  addSingularPlural,
+} from '@cedarjs/utils/cedarPluralize'
+
+pluralize('book') // 'books'
+pluralize('DataModel') // 'DataModels'
+singularize('teeth') // 'tooth'
+isPlural('books') // true
+isSingular('tooth') // true
+
+addSingularPlural('Pokemon', 'Pokemonii')
+pluralize('Pokemon') // 'Pokemonii'
+```

package/dist/cedarPluralize.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Returns the plural form of the given word.
+ */
+export declare function pluralize(word: string): string;
+/**
+ * Returns the singular form of the given word.
+ */
+export declare function singularize(word: string): string;
+/**
+ * Returns true if the (last) word is plural.
+ */
+export declare function isPlural(word: string): boolean;
+/**
+ * Returns true if the (last) word is singular.
+ */
+export declare function isSingular(word: string): boolean;
+/**
+ * Adds a new mapping from singular to plural.
+ *
+ * This function also maintains reverse mappings and ensures any previous
+ * conflicting mapping is removed (tests rely on this behavior).
+ */
+export declare function addSingularPlural(singular: string, plural: string): void;
+//# sourceMappingURL=cedarPluralize.d.ts.map

package/dist/cedarPluralize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cedarPluralize.d.ts","sourceRoot":"","sources":["../src/cedarPluralize.ts"],"names":[],"mappings":"AAiCA;;GAEG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAc9C;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAahD;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAE9C;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEhD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAcxE"}

package/dist/cedarPluralize.js

@@ -0,0 +1,65 @@
+import plurals from "pluralize";
+const mappings = {
+  toSingular: {},
+  toPlural: {}
+};
+function lastWord(str) {
+  const capitals = str.match(/[A-Z]/g) ?? [];
+  if (capitals.length === 0) {
+    return str;
+  }
+  const lastCapital = capitals[capitals.length - 1];
+  const lastIndex = str.lastIndexOf(lastCapital);
+  if (lastIndex >= 0) {
+    return str.slice(lastIndex);
+  }
+  return str;
+}
+function pluralize(word) {
+  if (mappings.toPlural[word]) {
+    return mappings.toPlural[word];
+  }
+  const singular = lastWord(word);
+  const base = word.slice(0, word.length - singular.length);
+  if (mappings.toPlural[singular]) {
+    return base + mappings.toPlural[singular];
+  }
+  return base + plurals.plural(singular);
+}
+function singularize(word) {
+  if (mappings.toSingular[word]) {
+    return mappings.toSingular[word];
+  }
+  const plural = lastWord(word);
+  const base = word.slice(0, word.length - plural.length);
+  if (mappings.toSingular[plural]) {
+    return base + mappings.toSingular[plural];
+  }
+  return base + plurals.singular(plural);
+}
+function isPlural(word) {
+  return plurals.isPlural(lastWord(word));
+}
+function isSingular(word) {
+  return plurals.isSingular(lastWord(word));
+}
+function addSingularPlural(singular, plural) {
+  const existingPlural = Object.keys(mappings.toSingular).find((key) => {
+    return mappings.toSingular[key] === singular;
+  });
+  if (existingPlural !== void 0) {
+    delete mappings.toSingular[existingPlural];
+    delete mappings.toPlural[existingPlural];
+  }
+  mappings.toPlural[singular] = plural;
+  mappings.toPlural[plural] = plural;
+  mappings.toSingular[plural] = singular;
+  mappings.toSingular[singular] = singular;
+}
+export {
+  addSingularPlural,
+  isPlural,
+  isSingular,
+  pluralize,
+  singularize
+};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@cedarjs/utils",
+  "version": "3.0.0-canary.13524+64f541c46",
+  "description": "Shared utilities for CedarJS packages and apps",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cedarjs/cedar.git",
+    "directory": "packages/utils"
+  },
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    "./cedarPluralize": {
+      "types": "./dist/cedarPluralize.d.ts",
+      "default": "./dist/cedarPluralize.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "node ./build.mts",
+    "build:pack": "yarn pack -o cedarjs-utils.tgz",
+    "build:types": "tsc --build --verbose ./tsconfig.build.json",
+    "build:watch": "nodemon --watch src --ext \"js,ts,tsx\" --ignore dist --exec \"yarn build\"",
+    "check:package": "yarn:publint",
+    "prepublishOnly": "NODE_ENV=production yarn build",
+    "test": "vitest run",
+    "test:watch": "vitest watch"
+  },
+  "dependencies": {
+    "pluralize": "8.0.0"
+  },
+  "devDependencies": {
+    "@cedarjs/framework-tools": "3.0.0-canary.13524",
+    "@types/pluralize": "0.0.33",
+    "nodemon": "3.1.14",
+    "publint": "0.3.18",
+    "typescript": "5.9.3",
+    "vitest": "3.2.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "64f541c46831ac89850fc7c4f84bc7820ba3c6d3"
+}