@voxgig/sdkgen-infrapack 0.0.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.
@@ -0,0 +1,132 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, caste, color, religion, or sexual
10
+ identity and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ - Demonstrating empathy and kindness toward other people
21
+ - Being respectful of differing opinions, viewpoints, and experiences
22
+ - Giving and gracefully accepting constructive feedback
23
+ - Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ - Focusing on what is best not just for us as individuals, but for the overall
26
+ community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ - The use of sexualized language or imagery, and sexual attention or advances of
31
+ any kind
32
+ - Trolling, insulting or derogatory comments, and personal or political attacks
33
+ - Public or private harassment
34
+ - Publishing others' private information, such as a physical or email address,
35
+ without their explicit permission
36
+ - Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official e-mail address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ [INSERT CONTACT METHOD].
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series of
86
+ actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or permanent
93
+ ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within the
113
+ community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.1, available at
119
+ [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120
+
121
+ Community Impact Guidelines were inspired by
122
+ [Mozilla's code of conduct enforcement ladder][mozilla coc].
123
+
124
+ For answers to common questions about this code of conduct, see the FAQ at
125
+ [https://www.contributor-covenant.org/faq][faq]. Translations are available at
126
+ [https://www.contributor-covenant.org/translations][translations].
127
+
128
+ [homepage]: https://www.contributor-covenant.org
129
+ [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130
+ [mozilla coc]: https://github.com/mozilla/diversity
131
+ [faq]: https://www.contributor-covenant.org/faq
132
+ [translations]: https://www.contributor-covenant.org/translations
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2021 Seneca Microservices Framework
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.
@@ -0,0 +1,15 @@
1
+ .PHONY: all build test clean reset
2
+
3
+ all: build test
4
+
5
+ build:
6
+ npm run build
7
+
8
+ test:
9
+ npm test
10
+
11
+ clean:
12
+ rm -rf dist dist-test .tsbuildinfo
13
+
14
+ reset:
15
+ npm run reset
@@ -0,0 +1,18 @@
1
+ {
2
+ "compilerOptions": {
3
+ "esModuleInterop": true,
4
+ "module": "nodenext",
5
+ "noEmitOnError": true,
6
+ "outDir": "../dist",
7
+ "rootDir": ".",
8
+ "tsBuildInfoFile": "../.tsbuildinfo/src.json",
9
+ "resolveJsonModule": true,
10
+ "sourceMap": true,
11
+ "strict": true,
12
+ "target": "es2022",
13
+ "useDefineForClassFields": false,
14
+ "declaration": true,
15
+ "declarationDir": "../dist",
16
+ "types": ["node"]
17
+ }
18
+ }
@@ -0,0 +1,16 @@
1
+ {
2
+ "compilerOptions": {
3
+ "esModuleInterop": true,
4
+ "module": "nodenext",
5
+ "noEmitOnError": true,
6
+ "outDir": "../dist-test",
7
+ "rootDir": ".",
8
+ "tsBuildInfoFile": "../.tsbuildinfo/test.json",
9
+ "resolveJsonModule": true,
10
+ "sourceMap": true,
11
+ "strict": true,
12
+ "target": "es2022",
13
+ "types": ["node"]
14
+ },
15
+ "include": ["**/*.ts"]
16
+ }
@@ -0,0 +1,3 @@
1
+ {
2
+ "indentSize": 2
3
+ }
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 voxgig
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,123 @@
1
+ # @voxgig/sdkgen-infrapack
2
+
3
+ **Infrastructure-provider targets** for the
4
+ [Voxgig SDK Generator](https://github.com/voxgig/sdkgen).
5
+
6
+ An infrastructure provider is not an SDK. It is a plugin for someone else's
7
+ system — Seneca, Terraform — that exposes your API's entities in that system's
8
+ own vocabulary, layered on the SDK generated from the same model. Every target
9
+ here wraps a language target rather than being one.
10
+
11
+ ```bash
12
+ npm install --save-dev @voxgig/sdkgen-infrapack
13
+ voxgig-sdkgen package add @voxgig/sdkgen-infrapack
14
+ npm run generate
15
+ ```
16
+
17
+ ## Targets
18
+
19
+ | target | wraps | produces |
20
+ |---|---|---|
21
+ | `seneca-provider` | `ts` | a [Seneca](https://senecajs.org) plugin exposing entities as `provider/<name>/<entity>` |
22
+
23
+ `terraform-provider` is designed and not yet built; see the design notes in the
24
+ sdkgen repository.
25
+
26
+ ## Every target here needs the target it wraps
27
+
28
+ These are consumer targets: they switch every standard generation phase off and
29
+ emit their whole package from `Main`, and each one fails without the target it
30
+ wraps, deliberately. Add `ts` to your project before `seneca-provider`.
31
+
32
+ There is no manifest field for that requirement. Nothing in
33
+ `sdkgen-package.json` says "this target needs that one", so this paragraph and
34
+ the error at generation are where the requirement lives.
35
+
36
+ ## Custom actions reach Seneca as `action$`
37
+
38
+ An API definition folds a non-CRUD verb into an ordinary operation as an
39
+ alternative route — GitHub's `PUT /repos/{owner}/{repo}/pulls/{n}/merge` is a
40
+ second point of the pull request's `update`. The SDK selects one with
41
+ `$action` in the call's argument. Seneca has no operation to add it to, so the
42
+ provider takes it as a directive, spelled the Seneca way:
43
+
44
+ ```js
45
+ const pull = seneca.entity('provider/github/pull')
46
+
47
+ await pull
48
+ .make$({ id: 42, owner: 'voxgig', repo: 'sdkgen',
49
+ commit_title: 'Merge pull request #42' })
50
+ .directive$({ action$: 'merge' })
51
+ .save$()
52
+ ```
53
+
54
+ `save$` routes by the operation the action belongs to, not by the command, so
55
+ an action folded into `create` is called as a create even on an entity that
56
+ carries an id. A name the entity does not have throws, naming the valid ones —
57
+ it never falls back to the plain command. Each generated provider lists its own
58
+ actions in its README and its reference.
59
+
60
+ `make$({ action$ })` does not work and cannot: `seneca-entity`'s `make$` copies
61
+ only keys without a `$`, plus the four directives it knows by name, so any
62
+ other trailing-`$` key is dropped before a store sees it. Use `directive$`, or
63
+ assign the property to an entity you have already made.
64
+
65
+ Providers generated before this gain their actions on the next regeneration.
66
+
67
+
68
+ ## `seneca-provider` generates into its own repository
69
+
70
+ Unlike a language target, a Seneca provider is not a folder in the SDK
71
+ repository. It is an independently released npm package under the `@seneca`
72
+ scope, with its own license, workflow and release cadence, and it depends on
73
+ the SDK as an ordinary published dependency. Point it at that repository from
74
+ your project model:
75
+
76
+ ```
77
+ main: kit: target: 'seneca-provider': output: path: '../../seneca/seneca-acme-provider'
78
+ ```
79
+
80
+ The path resolves against the SDK repository root. Left unset, the provider
81
+ generates in-tree under `seneca-provider/`, which is a usable default for a
82
+ first look at the output.
83
+
84
+ Set that in `model/project.aon`, not in the target's own file — `target add`
85
+ overwrites the latter.
86
+
87
+ ## Parity
88
+
89
+ Every target here declares `CONSUMER`. That is not a coverage tier alongside
90
+ `FULL`, `MIRRORED` and `UNCOVERED`, which grade a language target against the
91
+ shared corpus. A consumer target has no utility layer to measure, so it is
92
+ outside that system — and says so, rather than omitting the field, which cannot
93
+ be told apart from an author who did not know it existed.
94
+
95
+ ## Developing
96
+
97
+ ```bash
98
+ npm install
99
+ npm test # type-checks the components, then runs the suite
100
+ ```
101
+
102
+ The suite runs on `@voxgig/sdkgen/testkit`: it installs this package into a
103
+ staged consumer through the real `package add`, compiles the components the way
104
+ a consumer's build does, and generates.
105
+
106
+ Two tests **skip** against a published sdkgen whose test kit predates the
107
+ `outside` option, which is what lets a suite express out-of-tree generation at
108
+ all. They report the skip rather than passing quietly, and start running as
109
+ soon as that release lands.
110
+
111
+ Validate the package itself with:
112
+
113
+ ```bash
114
+ npx voxgig-sdkgen package check .
115
+ ```
116
+
117
+ ## Provenance
118
+
119
+ `seneca-provider` was generated from the same trees that shipped inside
120
+ `@voxgig/sdkgen`. Before it moved, its output was compared file by file against
121
+ the bundled version from the same model: **21 files, 0 differences**, identical
122
+ warnings and an identical placeholder scan. Nothing about a generated provider
123
+ changed in the move.
package/package.json ADDED
@@ -0,0 +1,98 @@
1
+ {
2
+ "name": "@voxgig/sdkgen-infrapack",
3
+ "version": "0.0.1",
4
+ "description": "Infrastructure-provider targets for the Voxgig SDK Generator: Seneca provider.",
5
+ "type": "commonjs",
6
+ "license": "MIT",
7
+ "keywords": [
8
+ "voxgig",
9
+ "sdkgen",
10
+ "sdkgen-package",
11
+ "seneca",
12
+ "seneca-provider",
13
+ "provider"
14
+ ],
15
+ "author": "Richard Rodger (http://richardrodger.com)",
16
+ "repository": {
17
+ "type": "git",
18
+ "url": "git://github.com/voxgig/sdkgen-infrapack.git"
19
+ },
20
+ "files": [
21
+ ".sdk",
22
+ "sdkgen-package.json"
23
+ ],
24
+ "scripts": {
25
+ "test": "node --enable-source-maps --test test/*.test.js",
26
+ "test-some": "node --enable-source-maps --test-name-pattern=\"$npm_config_pattern\" --test test/*.test.js",
27
+ "watch": "tsc -w",
28
+ "build": "tsc",
29
+ "clean": "rm -rf node_modules yarn.lock package-lock.json .build",
30
+ "reset": "npm run clean && npm i && npm run build && npm test",
31
+ "repo-tag": "REPO_VERSION=`node -e \"console.log(require('./package').version)\"` && echo TAG: v$REPO_VERSION && git commit -a -m v$REPO_VERSION && git push && git tag v$REPO_VERSION && git push --tags;",
32
+ "repo-publish": "npm run clean && npm i && npm run repo-publish-quick",
33
+ "repo-publish-quick": "npm run build && npm run test && npm run repo-tag && npm publish --registry https://registry.npmjs.org --access=public",
34
+ "resset": "npm run reset",
35
+ "check-cmp": "tsc -p tsconfig.json --noEmit",
36
+ "check-package": "voxgig-sdkgen package check .",
37
+ "build:provider-test": "tsc --ignoreConfig --noCheck --noResolve --target ES2021 --module node16"
38
+ },
39
+ "_peer_comment": [
40
+ "A MIGRATED TARGET INHERITS SDKGEN'S PEERS AS ITS OWN. These components",
41
+ "import @voxgig/sdkgen and @voxgig/apidef BY NAME, which resolved silently",
42
+ "while the target lived in the bundled scaffold beside sdkgen's own",
43
+ "node_modules. Out here they have to be declared, or the components fail",
44
+ "to type-check for the author and fail to resolve for anyone who installs",
45
+ "this package without sdkgen's peers present.",
46
+ "",
47
+ "Peers rather than dependencies: a consumer necessarily has these already,",
48
+ "via sdkgen, and a second copy at a different version is the one outcome",
49
+ "worth preventing.",
50
+ "",
51
+ "NOT @seneca/maintain, AND NOT ANY OTHER SENECA PACKAGE. The migration",
52
+ "guide's candidate-check grep prints @seneca/maintain for this target, and",
53
+ "declaring it here would be wrong: the hit is inside the template literal",
54
+ "in Extras that WRITES the generated provider's test file. The Seneca",
55
+ "packages are dependencies of the generated provider, declared in",
56
+ ".sdk/model/target/seneca-provider.aon's `deps` block, and a consumer of",
57
+ "THIS package has no reason to supply any of them. The grep cannot tell an",
58
+ "import from an emitted string; expect that from any target generating a",
59
+ "Node package.",
60
+ "",
61
+ "No @voxgig/struct either \u2014 haskell needs it, this target does not.",
62
+ "",
63
+ "The apidef floor MATCHES SDKGEN'S OWN peer range rather than being",
64
+ "chosen here. A consumer satisfies this package through sdkgen, so a",
65
+ "looser range would only let npm resolve an apidef that sdkgen itself",
66
+ "rejects \u2014 a package that installs and then fails to generate.",
67
+ "",
68
+ "THE SDKGEN FLOOR IS THE OLDEST PUBLISHED VERSION THIS SUITE IS RUN",
69
+ "AGAINST, which is 4.9.0. Not the oldest that might work: a floor nobody",
70
+ "tests is the shape of the old >=3.5.0, which accepted versions where a",
71
+ "target's components install and then die at generation on a missing",
72
+ "export \u2014 this target calls `pointSegments`, which sdkgen first exported",
73
+ "in 4.8.0. 4.9.0 is also the first release carrying the test kit this",
74
+ "suite runs on.",
75
+ "",
76
+ "This is a SEPARATE REPOSITORY, so there is no `file:` path back to the",
77
+ "generator: the dependency is the published package, and that is the",
78
+ "point. It makes this package's CI the thing that catches an sdkgen",
79
+ "release breaking a packaged target.",
80
+ "",
81
+ "@types/node IS REQUIRED, not incidental: these components import",
82
+ "`node:path` and read `__dirname`. Inside the sdkgen checkout they",
83
+ "hoisted from the generator's own devDependencies; standing alone that",
84
+ "hoist is gone and the type-check lane fails."
85
+ ],
86
+ "peerDependencies": {
87
+ "@voxgig/apidef": ">=8.2.2",
88
+ "@voxgig/sdkgen": ">=4.9.0"
89
+ },
90
+ "devDependencies": {
91
+ "@voxgig/apidef": ">=8.2.2",
92
+ "@voxgig/sdkgen": ">=4.9.0",
93
+ "aontu": ">=0.52",
94
+ "memfs": "4.68.1",
95
+ "typescript": "7.0.2",
96
+ "@types/node": ">=24"
97
+ }
98
+ }
@@ -0,0 +1,18 @@
1
+ {
2
+ "sdkgen": {
3
+ "package": 1
4
+ },
5
+ "name": "@voxgig/sdkgen-infrapack",
6
+ "version": "1.1.0",
7
+ "engines": {
8
+ "sdkgen": ">=4.9.0"
9
+ },
10
+ "provides": {
11
+ "target": [
12
+ "seneca-provider"
13
+ ]
14
+ },
15
+ "parity": {
16
+ "seneca-provider": "CONSUMER"
17
+ }
18
+ }