@adbls/api-types 1.4.7

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Adibilis GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,112 @@
+# `@adbls/api-types`
+
+Generated TypeScript + zod types for the Adibilis CORE API. **Nothing here is hand-written.**
+
+## What it is (and what it isn't)
+
+This package is a *build output* of core: ajtg reads core's compiled backend bytecode during
+`mvn process-classes` and emits the types into `src/`. That is why it is published from
+`core/core` and not from `core/SDK` — publishing it elsewhere would mean re-running core's Java
+build in that repo, or copying generated output between repos, which is exactly the drift this
+package exists to eliminate.
+
+It is **not** the SDK. `@adbls/sdk` is hand-written (API client, form layer, checkout, holidays),
+depends on this package, and re-exports the symbols satellites actually need. A satellite normally
+installs only the SDK.
+
+## Version contract
+
+A **released** version is **1:1 with the core release tag**: `@adbls/api-types@1.4.2` is exactly
+the API surface of core `v1.4.2`. CI stamps it from the tag; the `0.0.0` in `package.json` is a
+placeholder and is never hand-bumped.
+
+The package follows the same three channels as the core image, so the two can never drift:
+
+| core ref | image tag | package version | npm dist-tag | published to |
+|---|---|---|---|---|
+| `v1.4.2` | `:v1.4.2` | `1.4.2` | `latest` | npmjs.org (public) **and** Forgejo |
+| `main` | `:latest` | `0.0.0-stage.<run>` | `stage` | Forgejo only |
+| `dev` | `:dev` | `0.0.0-dev.<run>` | `dev` | Forgejo only |
+
+Releases are public so anyone can build a frontend against core: `@adbls/sdk` depends on this
+package and is public itself. Prereleases stay on Forgejo — they describe unreleased API, and
+publishing one per push would flood the public registry.
+
+```bash
+pnpm add @adbls/api-types          # newest released version (npmjs, no token)
+pnpm add @adbls/api-types@dev      # newest dev build (Forgejo, see below)
+pnpm add @adbls/api-types@stage    # newest stage build (Forgejo, see below)
+```
+
+Prereleases are published under their own dist-tag, so a plain `pnpm add` never resolves to one.
+Pin `latest` in production satellites; use `dev` while developing against unreleased API changes.
+
+`@adbls/sdk` carries its own semver and declares a compatible *range* on this package, so it can
+ship a fix without a core release and state which core versions it speaks to.
+
+## Consuming it
+
+Released versions need nothing: `pnpm add @adbls/api-types zod` resolves them from npmjs.org.
+
+For the `dev` and `stage` prereleases, map the scope to Forgejo instead: copy `.npmrc.example` to
+`.npmrc` and export a **read** token. The mapping is per scope, so while it is in place *every*
+`@adbls/*` package — releases included — comes from Forgejo, which carries them too.
+
+```ini
+@adbls:registry=https://forge.cloud.adibilis.ch/api/packages/core/npm/
+//forge.cloud.adibilis.ch/api/packages/core/npm/:_authToken=${NPM_TOKEN}
+```
+
+```bash
+export NPM_TOKEN=<read token>
+pnpm add @adbls/api-types zod
+```
+
+`zod` is a **peer** dependency so you resolve exactly one copy of it.
+
+> The npm registry token is build-time and has nothing to do with the **WEBSITE API key** a
+> satellite uses at runtime to call core. Different lifetimes, different blast radii — do not
+> conflate them.
+
+### Publishing (maintainers)
+
+CI publishes with the org-level `REGISTRY_TOKEN`. Forgejo serves the container registry and the npm
+registry from one package subsystem, and both need `write:package`, so the token that already does
+`docker login` for the image build covers `npm publish` too — no separate npm secret exists.
+
+Release tags are additionally published to npmjs.org with the `NPMJS_TOKEN` secret (a granular
+npm access token with publish rights on the `@adibilis` scope). The npmjs step checks whether the
+version already exists before publishing, so a re-run after a partial failure is safe.
+
+Consumers of prereleases still need their own **read**-scoped Forgejo token; do not hand out the
+publishing one.
+
+## What you get
+
+- **Validated DTOs** → a zod schema plus its inferred type:
+  `ContactRequestModel` (schema) and `ContactRequest` (type).
+- **Enums** → `UserRoleModel` (schema) and `UserRole` (type).
+- **Unvalidated DTOs** → a plain interface, default-exported and also re-exported by name from the
+  barrel.
+
+```ts
+import { ContactRequestModel, type ContactRequest } from '@adbls/api-types';
+
+const parsed = ContactRequestModel.safeParse(formValues);
+```
+
+Schemas mirror the backend's Bean Validation exactly: a `@NotBlank` field is **required** in the
+schema, so `parse({})` fails rather than silently passing.
+
+## Notes and limits
+
+- **CommonJS output.** The generator emits extensionless relative imports, which Node's ESM loader
+  rejects; CJS resolves them, and every consuming bundler (Next.js, Vite) handles CJS fine. Types
+  come from the `.d.ts` files either way.
+- **No Angular services.** The build emits them (ajtg-angular is on the plugin classpath) but routes
+  them to a throwaway directory via `typesOnlyOutputDirectories` — they import `@angular/*` and
+  would break a satellite's build.
+- **The barrel is generated** (`scripts/generate-index.mjs`, run as `prebuild`). ajtg wipes `src/`
+  on every build, so it cannot be a committed file.
+- `src/` and `dist/` are gitignored. Regenerate with `mvn clean package -DskipTests` from the repo
+  root, then `pnpm build` here.