@bento/types 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +0 -4
- package/dist/index.d.cts +3 -2
- package/dist/index.d.cts.map +1 -0
- package/dist/{index.d.ts → index.d.mts} +3 -2
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +1 -0
- package/package.json +16 -12
- package/README.md +0 -39
- package/dist/index.cjs.map +0 -1
- package/dist/index.js +0 -3
- package/dist/index.js.map +0 -1
package/dist/index.cjs
CHANGED
package/dist/index.d.cts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
+
//#region src/utility-types.d.ts
|
|
1
2
|
/**
|
|
2
3
|
* Represents an object with string keys and any values.
|
|
3
4
|
*
|
|
4
5
|
* @public
|
|
5
6
|
*/
|
|
6
7
|
type AnyObject = Record<string, any>;
|
|
7
|
-
|
|
8
8
|
/**
|
|
9
9
|
* Represents an object with string keys and unknown values.
|
|
10
10
|
* Safer alternative to AnyObject when the value types are not known.
|
|
@@ -12,5 +12,6 @@ type AnyObject = Record<string, any>;
|
|
|
12
12
|
* @public
|
|
13
13
|
*/
|
|
14
14
|
type UnknownObject = Record<string, unknown>;
|
|
15
|
-
|
|
15
|
+
//#endregion
|
|
16
16
|
export type { AnyObject, UnknownObject };
|
|
17
|
+
//# sourceMappingURL=index.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.cts","names":["Record"],"sources":["../src/utility-types.d.ts"],"mappings":";;AAKA;;;;KAAY,SAAA,GAAY,MAAM;;;;AAQI;;;KAAtB,aAAA,GAAgB,MAAM"}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
+
//#region src/utility-types.d.ts
|
|
1
2
|
/**
|
|
2
3
|
* Represents an object with string keys and any values.
|
|
3
4
|
*
|
|
4
5
|
* @public
|
|
5
6
|
*/
|
|
6
7
|
type AnyObject = Record<string, any>;
|
|
7
|
-
|
|
8
8
|
/**
|
|
9
9
|
* Represents an object with string keys and unknown values.
|
|
10
10
|
* Safer alternative to AnyObject when the value types are not known.
|
|
@@ -12,5 +12,6 @@ type AnyObject = Record<string, any>;
|
|
|
12
12
|
* @public
|
|
13
13
|
*/
|
|
14
14
|
type UnknownObject = Record<string, unknown>;
|
|
15
|
-
|
|
15
|
+
//#endregion
|
|
16
16
|
export type { AnyObject, UnknownObject };
|
|
17
|
+
//# sourceMappingURL=index.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":["Record"],"sources":["../src/utility-types.d.ts"],"mappings":";;AAKA;;;;KAAY,SAAA,GAAY,MAAM;;;;AAQI;;;KAAtB,aAAA,GAAgB,MAAM"}
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
package/package.json
CHANGED
|
@@ -1,20 +1,19 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bento/types",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Shared TypeScript types used across the Bento library.",
|
|
5
5
|
"type": "module",
|
|
6
|
-
"types": "dist/index.d.
|
|
6
|
+
"types": "dist/index.d.mts",
|
|
7
7
|
"scripts": {
|
|
8
|
-
"build": "
|
|
9
|
-
"lint": "biome lint &&
|
|
10
|
-
"posttest": "npm run lint",
|
|
11
|
-
"pretest": "npm run build",
|
|
8
|
+
"build": "tsdown",
|
|
9
|
+
"lint": "biome lint && tsgo --noEmit",
|
|
12
10
|
"test": "vitest --run",
|
|
13
|
-
"test:watch": "vitest"
|
|
11
|
+
"test:watch": "vitest",
|
|
12
|
+
"typecheck": "tsgo --noEmit -p tsconfig.json"
|
|
14
13
|
},
|
|
15
14
|
"repository": {
|
|
16
15
|
"type": "git",
|
|
17
|
-
"url": "git+https://github.com/godaddy/
|
|
16
|
+
"url": "git+https://github.com/godaddy/antares.git"
|
|
18
17
|
},
|
|
19
18
|
"keywords": [
|
|
20
19
|
"bento",
|
|
@@ -28,18 +27,23 @@
|
|
|
28
27
|
"author": "GoDaddy Operating Company, LLC",
|
|
29
28
|
"license": "MIT",
|
|
30
29
|
"bugs": {
|
|
31
|
-
"url": "https://github.com/godaddy/
|
|
30
|
+
"url": "https://github.com/godaddy/antares/issues"
|
|
32
31
|
},
|
|
33
|
-
"homepage": "https://github.com/godaddy/
|
|
32
|
+
"homepage": "https://github.com/godaddy/antares#readme",
|
|
34
33
|
"files": [
|
|
35
34
|
"dist",
|
|
36
35
|
"package.json"
|
|
37
36
|
],
|
|
37
|
+
"devDependencies": {
|
|
38
|
+
"tsdown": "^0.22.1",
|
|
39
|
+
"typescript": "^6.0.3",
|
|
40
|
+
"vitest": "^4.1.7"
|
|
41
|
+
},
|
|
38
42
|
"exports": {
|
|
39
43
|
".": {
|
|
40
44
|
"import": {
|
|
41
|
-
"types": "./dist/index.d.
|
|
42
|
-
"default": "./dist/index.
|
|
45
|
+
"types": "./dist/index.d.mts",
|
|
46
|
+
"default": "./dist/index.mjs"
|
|
43
47
|
},
|
|
44
48
|
"require": {
|
|
45
49
|
"types": "./dist/index.d.cts",
|
package/README.md
DELETED
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
# @bento/types
|
|
2
|
-
|
|
3
|
-
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.
|
|
4
|
-
|
|
5
|
-
## Installation
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
npm install @bento/types
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Usage
|
|
12
|
-
|
|
13
|
-
Import types directly from the package. Eg:
|
|
14
|
-
|
|
15
|
-
```tsx
|
|
16
|
-
import type { UnknownObject } from '@bento/types';
|
|
17
|
-
|
|
18
|
-
interface Data {
|
|
19
|
-
elements: UnknownObject
|
|
20
|
-
}
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
## Contributing
|
|
24
|
-
|
|
25
|
-
When adding new types to the library, follow these guidelines:
|
|
26
|
-
|
|
27
|
-
1. Organize types into appropriate categories
|
|
28
|
-
2. Document types with JSDoc comments
|
|
29
|
-
3. Add tests for the types in the `test` directory
|
|
30
|
-
4. Ensure exported types have descriptive names
|
|
31
|
-
5. Export them from the main `src/index.ts` file
|
|
32
|
-
|
|
33
|
-
## Testing
|
|
34
|
-
|
|
35
|
-
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:
|
|
36
|
-
|
|
37
|
-
```bash
|
|
38
|
-
npm test
|
|
39
|
-
```
|
package/dist/index.cjs.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":[],"names":[],"mappings":"","file":"index.cjs"}
|
package/dist/index.js
DELETED
package/dist/index.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}
|