@elmeragroup/internal 0.1.1-canary.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/LICENSE +21 -0
- package/NOTICE +62 -0
- package/README.md +56 -0
- package/dist/api-artifacts/model.d.mts +3 -0
- package/dist/api-artifacts/model.mjs +2 -0
- package/dist/api-extractor.d.mts +3 -0
- package/dist/api-extractor.mjs +3 -0
- package/dist/dist-CcEC-Qb_.mjs +558 -0
- package/dist/dist-_NayZK35.mjs +7760 -0
- package/dist/errors-ByXSCE94.mjs +29 -0
- package/dist/index-C9vKRif1.d.mts +815 -0
- package/dist/index.d.mts +53 -0
- package/dist/index.mjs +15 -0
- package/dist/model-1dzGdHi8.d.mts +35 -0
- package/dist/oxlint/anti-slop.d.mts +6 -0
- package/dist/oxlint/anti-slop.mjs +1588 -0
- package/dist/oxlint.d.mts +6 -0
- package/dist/oxlint.mjs +2029 -0
- package/package.json +72 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Elmera Group
|
|
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/NOTICE
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
Portions of the extraction model and resolver design are informed by
|
|
2
|
+
typescript-api-extractor, copyright (c) 2025 Michał Dudak, at commit e145350.
|
|
3
|
+
The bundled extractor includes compound-type canonicalization, equivalence,
|
|
4
|
+
and rendering policy ported from that project. Its array, tuple, and mapped-type
|
|
5
|
+
resolution policy follows the upstream resolvers.
|
|
6
|
+
|
|
7
|
+
The upstream project is available at:
|
|
8
|
+
https://github.com/michaldudak/typescript-api-extractor
|
|
9
|
+
|
|
10
|
+
The upstream project is licensed under the MIT License. Its copyright and permission
|
|
11
|
+
notice are retained below.
|
|
12
|
+
|
|
13
|
+
MIT License
|
|
14
|
+
|
|
15
|
+
Copyright (c) 2025 Michał Dudak.
|
|
16
|
+
|
|
17
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
18
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
19
|
+
in the Software without restriction, including without limitation the rights
|
|
20
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
21
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
22
|
+
furnished to do so, subject to the following conditions:
|
|
23
|
+
|
|
24
|
+
The above copyright notice and this permission notice shall be included in all
|
|
25
|
+
copies or substantial portions of the Software.
|
|
26
|
+
|
|
27
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
28
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
29
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
30
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
31
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
32
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
33
|
+
SOFTWARE.
|
|
34
|
+
|
|
35
|
+
Effect-derived dependencies retain the MIT notice from Effectful Technologies Inc in their
|
|
36
|
+
installed package licenses. No Effect source is copied into this package.
|
|
37
|
+
|
|
38
|
+
Anti-slop lint rules
|
|
39
|
+
https://github.com/dmmulroy/anti-slop
|
|
40
|
+
Commit: 446268e5d15baa968eaec669ff65358d36ae6259
|
|
41
|
+
|
|
42
|
+
MIT License
|
|
43
|
+
|
|
44
|
+
Copyright (c) 2026 Dillon Mulroy
|
|
45
|
+
|
|
46
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
47
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
48
|
+
in the Software without restriction, including without limitation the rights
|
|
49
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
50
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
51
|
+
furnished to do so, subject to the following conditions:
|
|
52
|
+
|
|
53
|
+
The above copyright notice and this permission notice shall be included in all
|
|
54
|
+
copies or substantial portions of the Software.
|
|
55
|
+
|
|
56
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
57
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
58
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
59
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
60
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
61
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
62
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# @elmeragroup/internal
|
|
2
|
+
|
|
3
|
+
Shared engineering helpers for the Elmera Group.
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
pnpm add -D @elmeragroup/internal@canary
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import { generateApiArtifacts } from "@elmeragroup/internal";
|
|
11
|
+
|
|
12
|
+
const { components } = await generateApiArtifacts({
|
|
13
|
+
projectRoot: process.cwd(),
|
|
14
|
+
tsconfigPath: "tsconfig.json",
|
|
15
|
+
components: [
|
|
16
|
+
{
|
|
17
|
+
slug: "button",
|
|
18
|
+
entryFile: "src/button.ts",
|
|
19
|
+
exportNames: ["Button"],
|
|
20
|
+
outputFile: "docs/button/api.json",
|
|
21
|
+
},
|
|
22
|
+
],
|
|
23
|
+
});
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Requires Node >=24.13.0 <25. Generate during the build, then import the JSON from rendering code.
|
|
27
|
+
|
|
28
|
+
The generator defaults to `includeExternalTypes: ["@base-ui/react"]` and `allowedWarningCodes: ["unsupported-type-fallback"]`. Override either option as needed. Accepted warnings are returned in `diagnostics`.
|
|
29
|
+
|
|
30
|
+
Use `mode: "check"` to detect stale artifacts without writing. See [api-artifacts](https://github.com/elmeragroup/internal/tree/main/packages/api-artifacts) for options and output details.
|
|
31
|
+
|
|
32
|
+
## Entry points
|
|
33
|
+
|
|
34
|
+
`@elmeragroup/internal/api-artifacts` exports the same function, defaults, errors, and types as the root.
|
|
35
|
+
Use `@elmeragroup/internal/api-artifacts/model` for artifact types. Its runtime module is empty. Diagnostic declarations reference the extractor’s Effect-based warning types.
|
|
36
|
+
The low-level Effect interface is available from `@elmeragroup/internal/api-extractor`.
|
|
37
|
+
|
|
38
|
+
Configure the plugins explicitly in Oxlint:
|
|
39
|
+
|
|
40
|
+
```json
|
|
41
|
+
{
|
|
42
|
+
"jsPlugins": [
|
|
43
|
+
{ "name": "elmera", "specifier": "@elmeragroup/internal/oxlint" },
|
|
44
|
+
{ "name": "anti-slop", "specifier": "@elmeragroup/internal/oxlint/anti-slop" }
|
|
45
|
+
],
|
|
46
|
+
"rules": {
|
|
47
|
+
"elmera/no-tailwind-dark-variant": "error",
|
|
48
|
+
"anti-slop/no-reflect-get": "error"
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Both entries export a default plugin. They do not load TypeScript or Effect.
|
|
54
|
+
The package is ESM-only. Installation includes the pinned compiler and Effect runtime, while
|
|
55
|
+
consumer bundlers can remove unused exports. Browser-safe helpers must have separate entries;
|
|
56
|
+
the root is reserved for artifact generation.
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
/// <reference lib="esnext.disposable" />
|
|
2
|
+
import { a as ComponentApiArtifact, i as ApiPropOrigin, n as ApiPart, o as RscStatus, r as ApiProp, t as ApiArtifactDiagnostic } from "../model-1dzGdHi8.mjs";
|
|
3
|
+
export type { ApiArtifactDiagnostic, ApiPart, ApiProp, ApiPropOrigin, ComponentApiArtifact, RscStatus };
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
/// <reference lib="esnext.disposable" />
|
|
2
|
+
import { $ as ExtractionResultSchema, A as ExtractionResult, At as ComponentSourceRequestSchema, B as ArrayNode, Bt as ComponentSourceUnresolvedSchema, C as DeclarationOwner, Ct as ExtractError, D as ProvenanceEntry, Dt as ComponentSourceForwarded, E as ProvenanceDeclarationSchema, Et as ComponentSourceDefaultSchema, F as ProjectFileSystem, Ft as ComponentSourceResults, G as ComponentNode, H as ClassMethod, I as ProjectFileSystemEntries, It as ComponentSourceResultsSchema, J as DocumentationTag, K as ConstructSignatureNode, L as ShouldIncludeData, Lt as ComponentSourceUnresolved, M as ProjectExtractorService, Mt as ComponentSourceResolvedSchema, N as ExtractorOptions, Nt as ComponentSourceResult, O as ProvenanceEntrySchema, Ot as ComponentSourceForwardedSchema, P as OpenProjectOptions, Pt as ComponentSourceResultSchema, Q as ExternalTypeNode, R as ShouldResolveObjectData, Rt as ComponentSourceUnresolvedReason, S as UnsupportedTypeFallbackWarningSchema, St as ConfigError, T as ProvenanceDeclaration, Tt as ComponentSourceDefault, U as ClassNode, V as CallSignatureNode, W as ClassProperty, X as EnumNode, Y as EnumMember, Z as ExportNode, _ as UnrepresentedConstructSignaturesWarningSchema, _t as TypeOperatorResolutionKind, a as MissingEnumDeclarationWarning, at as LiteralNode, b as UnresolvedReExportWarningSchema, bt as UnionNode, c as OmittedCallableMembersWarningSchema, ct as ObjectNode, d as OmittedIndexSignatureWarningSchema, dt as SemanticType, et as FunctionNode, f as TypeFlagName, ft as SemanticTypeSchema, g as UnrepresentedConstructSignaturesWarning, gt as TypeOperatorNode, h as UncertainComponentRecognitionWarningSchema, ht as TypeName, i as MissingDefaultExportSymbolWarningSchema, it as IntrinsicNode, j as ProjectExtractor, jt as ComponentSourceResolved, k as ProvenanceSchema, kt as ComponentSourceRequest, l as OmittedIndexSignatureReason, lt as ParameterNode, m as UncertainComponentRecognitionWarning, mt as TypeArgument, n as ExtractWarningSchema, nt as IntersectionNode, o as MissingEnumDeclarationWarningSchema, ot as ModuleNode, p as UncertainComponentRecognitionReason, pt as TupleNode, q as Documentation, r as MissingDefaultExportSymbolWarning, rt as IntrinsicName, s as OmittedCallableMembersWarning, st as ModuleNodeSchema, t as ExtractWarning, tt as IndexSignatureNode, u as OmittedIndexSignatureWarning, ut as PropertyNode, v as UnresolvedReExportReason, vt as TypeParameterNode, w as DeclarationOwnerSchema, wt as FileNotInProgramError, x as UnsupportedTypeFallbackWarning, xt as BackendError, y as UnresolvedReExportWarning, yt as TypeQueryNode, z as defaultExtractorOptions, zt as ComponentSourceUnresolvedReasonSchema } from "./index-C9vKRif1.mjs";
|
|
3
|
+
export { type ArrayNode, BackendError, type CallSignatureNode, type ClassMethod, type ClassNode, type ClassProperty, type ComponentNode, type ComponentSourceDefault, ComponentSourceDefaultSchema, type ComponentSourceForwarded, ComponentSourceForwardedSchema, type ComponentSourceRequest, ComponentSourceRequestSchema, type ComponentSourceResolved, ComponentSourceResolvedSchema, type ComponentSourceResult, ComponentSourceResultSchema, type ComponentSourceResults, ComponentSourceResultsSchema, type ComponentSourceUnresolved, type ComponentSourceUnresolvedReason, ComponentSourceUnresolvedReasonSchema, ComponentSourceUnresolvedSchema, ConfigError, type ConstructSignatureNode, type DeclarationOwner, DeclarationOwnerSchema, type Documentation, type DocumentationTag, type EnumMember, type EnumNode, type ExportNode, type ExternalTypeNode, ExtractError, type ExtractWarning, ExtractWarningSchema, type ExtractionResult, ExtractionResultSchema, type ExtractorOptions, FileNotInProgramError, type FunctionNode, type IndexSignatureNode, type IntersectionNode, type IntrinsicName, type IntrinsicNode, type LiteralNode, type MissingDefaultExportSymbolWarning, MissingDefaultExportSymbolWarningSchema, type MissingEnumDeclarationWarning, MissingEnumDeclarationWarningSchema, type ModuleNode, ModuleNodeSchema, type ObjectNode, type OmittedCallableMembersWarning, OmittedCallableMembersWarningSchema, type OmittedIndexSignatureReason, type OmittedIndexSignatureWarning, OmittedIndexSignatureWarningSchema, type OpenProjectOptions, type ParameterNode, ProjectExtractor, type ProjectExtractorService, type ProjectFileSystem, type ProjectFileSystemEntries, type PropertyNode, type ProvenanceDeclaration, ProvenanceDeclarationSchema, type ProvenanceEntry, ProvenanceEntrySchema, ProvenanceSchema, type SemanticType, SemanticTypeSchema, type ShouldIncludeData, type ShouldResolveObjectData, type TupleNode, type TypeArgument, type TypeFlagName, type TypeName, type TypeOperatorNode, type TypeOperatorResolutionKind, type TypeParameterNode, type TypeQueryNode, type UncertainComponentRecognitionReason, type UncertainComponentRecognitionWarning, UncertainComponentRecognitionWarningSchema, type UnionNode, type UnrepresentedConstructSignaturesWarning, UnrepresentedConstructSignaturesWarningSchema, type UnresolvedReExportReason, type UnresolvedReExportWarning, UnresolvedReExportWarningSchema, type UnsupportedTypeFallbackWarning, UnsupportedTypeFallbackWarningSchema, defaultExtractorOptions };
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
|
|
2
|
+
import { A as ComponentSourceUnresolvedSchema, C as ComponentSourceDefaultSchema, D as ComponentSourceResultSchema, E as ComponentSourceResolvedSchema, O as ComponentSourceResultsSchema, S as FileNotInProgramError, T as ComponentSourceRequestSchema, _ as UnresolvedReExportWarningSchema, a as SemanticTypeSchema, b as ConfigError, c as ProvenanceEntrySchema, d as MissingDefaultExportSymbolWarningSchema, f as MissingEnumDeclarationWarningSchema, g as UnrepresentedConstructSignaturesWarningSchema, h as UncertainComponentRecognitionWarningSchema, i as ModuleNodeSchema, k as ComponentSourceUnresolvedReasonSchema, l as ProvenanceSchema, m as OmittedIndexSignatureWarningSchema, n as defaultExtractorOptions, o as DeclarationOwnerSchema, p as OmittedCallableMembersWarningSchema, r as ExtractionResultSchema, s as ProvenanceDeclarationSchema, t as ProjectExtractor, u as ExtractWarningSchema, v as UnsupportedTypeFallbackWarningSchema, w as ComponentSourceForwardedSchema, x as ExtractError, y as BackendError } from "./dist-_NayZK35.mjs";
|
|
3
|
+
export { BackendError, ComponentSourceDefaultSchema, ComponentSourceForwardedSchema, ComponentSourceRequestSchema, ComponentSourceResolvedSchema, ComponentSourceResultSchema, ComponentSourceResultsSchema, ComponentSourceUnresolvedReasonSchema, ComponentSourceUnresolvedSchema, ConfigError, DeclarationOwnerSchema, ExtractError, ExtractWarningSchema, ExtractionResultSchema, FileNotInProgramError, MissingDefaultExportSymbolWarningSchema, MissingEnumDeclarationWarningSchema, ModuleNodeSchema, OmittedCallableMembersWarningSchema, OmittedIndexSignatureWarningSchema, ProjectExtractor, ProvenanceDeclarationSchema, ProvenanceEntrySchema, ProvenanceSchema, SemanticTypeSchema, UncertainComponentRecognitionWarningSchema, UnrepresentedConstructSignaturesWarningSchema, UnresolvedReExportWarningSchema, UnsupportedTypeFallbackWarningSchema, defaultExtractorOptions };
|