@bento/types 0.1.0

package/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 GoDaddy Operating Company, LLC.
+
+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,39 @@
+# @bento/types
+
+A shared TypeScript types package for the Bento library. This package centralizes common type definitions to reduce duplication, improve consistency, and simplify type maintenance across the Bento library.
+
+## Installation
+
+```bash
+npm install @bento/types
+```
+
+## Usage
+
+Import types directly from the package. Eg:
+
+```tsx
+import type { UnknownObject } from '@bento/types';
+
+interface Data {
+  elements: UnknownObject
+}
+```
+
+## Contributing
+
+When adding new types to the library, follow these guidelines:
+
+1. Organize types into appropriate categories
+2. Document types with JSDoc comments
+3. Add tests for the types in the `test` directory
+4. Ensure exported types have descriptive names
+5. Export them from the main `src/index.ts` file
+
+## Testing
+
+Tests are written using [`Vitest's type testing approach`](https://vitest.dev/guide/testing-types). To run the tests for the types, run the following command:
+
+```bash
+npm test
+```

package/dist/index.cjs

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.cjs"}

package/dist/index.d.cts

@@ -0,0 +1,16 @@
+/**
+ * Represents an object with string keys and any values.
+ *
+ * @public
+ */
+type AnyObject = Record<string, any>;
+
+/**
+ * Represents an object with string keys and unknown values.
+ * Safer alternative to AnyObject when the value types are not known.
+ *
+ * @public
+ */
+type UnknownObject = Record<string, unknown>;
+
+export type { AnyObject, UnknownObject };

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Represents an object with string keys and any values.
+ *
+ * @public
+ */
+type AnyObject = Record<string, any>;
+
+/**
+ * Represents an object with string keys and unknown values.
+ * Safer alternative to AnyObject when the value types are not known.
+ *
+ * @public
+ */
+type UnknownObject = Record<string, unknown>;
+
+export type { AnyObject, UnknownObject };

package/dist/index.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@bento/types",
+  "version": "0.1.0",
+  "description": "Shared TypeScript types used across the Bento library.",
+  "type": "module",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsup-node",
+    "lint": "biome lint && tsc --noEmit",
+    "posttest": "npm run lint",
+    "pretest": "npm run build",
+    "test": "vitest --run",
+    "test:watch": "vitest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/godaddy/bento.git"
+  },
+  "keywords": [
+    "bento",
+    "component",
+    "library",
+    "react",
+    "types",
+    "typescript",
+    "value"
+  ],
+  "author": "GoDaddy Operating Company, LLC",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/godaddy/bento/issues"
+  },
+  "homepage": "https://github.com/godaddy/bento#readme",
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}