@idfkit/types-v26-1 0.0.0
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/LICENSE +21 -0
- package/README.md +47 -0
- package/index.d.ts +66761 -0
- package/package.json +43 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Samuel Letellier-Duchesne
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# @idfkit/types-v26-1
|
|
2
|
+
|
|
3
|
+
Generated TypeScript interfaces and a `TypeMap` for EnergyPlus 26.1.0.
|
|
4
|
+
|
|
5
|
+
Opt-in. `@idfkit/core` is fully usable without it: a document with no map is
|
|
6
|
+
typed permissively rather than not at all, so nothing here is needed to read,
|
|
7
|
+
edit, or write a model (FR-040, SC-014). Install it when you want the editor to
|
|
8
|
+
complete field names and check them for one EnergyPlus version.
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm install --save-dev @idfkit/types-v26-1
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
```ts
|
|
15
|
+
import { loadIdf } from '@idfkit/core/node';
|
|
16
|
+
import type { TypeMap } from '@idfkit/types-v26-1';
|
|
17
|
+
|
|
18
|
+
const doc = await loadIdf<TypeMap>('model.idf');
|
|
19
|
+
doc.all('Zone').first?.ceiling_height; // number | 'Autosize' | 'Autocalculate' | undefined
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## What is in here
|
|
23
|
+
|
|
24
|
+
One `index.d.ts`. No JavaScript, no `main`, no dependencies: the package is
|
|
25
|
+
declarations and nothing else, and CI fails the build if a single runtime byte
|
|
26
|
+
appears in it (`npm run check:type-packages`).
|
|
27
|
+
|
|
28
|
+
## Versioning
|
|
29
|
+
|
|
30
|
+
`@idfkit/core` is a **peer range**, not a pin. The map borrows one type from
|
|
31
|
+
core, `ExtensibleGroup`, and carries no runtime, so a version skew between the
|
|
32
|
+
two is a type error at your build and never a failure at run time. Pick the
|
|
33
|
+
package whose version tag matches the EnergyPlus release you are reading; the
|
|
34
|
+
core you install alongside it does not have to match anything.
|
|
35
|
+
|
|
36
|
+
## Regenerating
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npm run codegen -- 26.1.0
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Run from the repository root, against the schemas in the sibling `idfkit`
|
|
43
|
+
Python checkout. Do not edit `index.d.ts` by hand.
|
|
44
|
+
|
|
45
|
+
## License
|
|
46
|
+
|
|
47
|
+
MIT
|