@apollo-deploy/schemas 0.4.4
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/README.md +450 -0
- package/dist/definitions/admin-users/domain.schema.d.ts +27 -0
- package/dist/definitions/admin-users/domain.schema.d.ts.map +1 -0
- package/dist/definitions/admin-users/domain.schema.js +24 -0
- package/dist/definitions/admin-users/domain.schema.js.map +1 -0
- package/dist/definitions/admin-users/index.d.ts +4 -0
- package/dist/definitions/admin-users/index.d.ts.map +1 -0
- package/dist/definitions/admin-users/index.js +7 -0
- package/dist/definitions/admin-users/index.js.map +1 -0
- package/dist/definitions/admin-users/request.schema.d.ts +55 -0
- package/dist/definitions/admin-users/request.schema.d.ts.map +1 -0
- package/dist/definitions/admin-users/request.schema.js +44 -0
- package/dist/definitions/admin-users/request.schema.js.map +1 -0
- package/dist/definitions/admin-users/response.schema.d.ts +100 -0
- package/dist/definitions/admin-users/response.schema.d.ts.map +1 -0
- package/dist/definitions/admin-users/response.schema.js +60 -0
- package/dist/definitions/admin-users/response.schema.js.map +1 -0
- package/dist/definitions/analytics/domain.schema.d.ts +160 -0
- package/dist/definitions/analytics/domain.schema.d.ts.map +1 -0
- package/dist/definitions/analytics/domain.schema.js +223 -0
- package/dist/definitions/analytics/domain.schema.js.map +1 -0
- package/dist/definitions/analytics/index.d.ts +56 -0
- package/dist/definitions/analytics/index.d.ts.map +1 -0
- package/dist/definitions/analytics/index.js +30 -0
- package/dist/definitions/analytics/index.js.map +1 -0
- package/dist/definitions/analytics/request.schema.d.ts +167 -0
- package/dist/definitions/analytics/request.schema.d.ts.map +1 -0
- package/dist/definitions/analytics/request.schema.js +326 -0
- package/dist/definitions/analytics/request.schema.js.map +1 -0
- package/dist/definitions/analytics/response.schema.d.ts +190 -0
- package/dist/definitions/analytics/response.schema.d.ts.map +1 -0
- package/dist/definitions/analytics/response.schema.js +158 -0
- package/dist/definitions/analytics/response.schema.js.map +1 -0
- package/dist/definitions/approvals/domain.schema.d.ts +495 -0
- package/dist/definitions/approvals/domain.schema.d.ts.map +1 -0
- package/dist/definitions/approvals/domain.schema.js +316 -0
- package/dist/definitions/approvals/domain.schema.js.map +1 -0
- package/dist/definitions/approvals/index.d.ts +9 -0
- package/dist/definitions/approvals/index.d.ts.map +1 -0
- package/dist/definitions/approvals/index.js +9 -0
- package/dist/definitions/approvals/index.js.map +1 -0
- package/dist/definitions/approvals/request.schema.d.ts +502 -0
- package/dist/definitions/approvals/request.schema.d.ts.map +1 -0
- package/dist/definitions/approvals/request.schema.js +208 -0
- package/dist/definitions/approvals/request.schema.js.map +1 -0
- package/dist/definitions/approvals/response.schema.d.ts +1067 -0
- package/dist/definitions/approvals/response.schema.d.ts.map +1 -0
- package/dist/definitions/approvals/response.schema.js +77 -0
- package/dist/definitions/approvals/response.schema.js.map +1 -0
- package/dist/definitions/apps/domain.schema.d.ts +58 -0
- package/dist/definitions/apps/domain.schema.d.ts.map +1 -0
- package/dist/definitions/apps/domain.schema.js +50 -0
- package/dist/definitions/apps/domain.schema.js.map +1 -0
- package/dist/definitions/apps/index.d.ts +10 -0
- package/dist/definitions/apps/index.d.ts.map +1 -0
- package/dist/definitions/apps/index.js +14 -0
- package/dist/definitions/apps/index.js.map +1 -0
- package/dist/definitions/apps/request.schema.d.ts +191 -0
- package/dist/definitions/apps/request.schema.d.ts.map +1 -0
- package/dist/definitions/apps/request.schema.js +215 -0
- package/dist/definitions/apps/request.schema.js.map +1 -0
- package/dist/definitions/apps/response.schema.d.ts +288 -0
- package/dist/definitions/apps/response.schema.d.ts.map +1 -0
- package/dist/definitions/apps/response.schema.js +127 -0
- package/dist/definitions/apps/response.schema.js.map +1 -0
- package/dist/definitions/artifacts/domain.schema.d.ts +563 -0
- package/dist/definitions/artifacts/domain.schema.d.ts.map +1 -0
- package/dist/definitions/artifacts/domain.schema.js +287 -0
- package/dist/definitions/artifacts/domain.schema.js.map +1 -0
- package/dist/definitions/artifacts/index.d.ts +9 -0
- package/dist/definitions/artifacts/index.d.ts.map +1 -0
- package/dist/definitions/artifacts/index.js +20 -0
- package/dist/definitions/artifacts/index.js.map +1 -0
- package/dist/definitions/artifacts/request.schema.d.ts +999 -0
- package/dist/definitions/artifacts/request.schema.d.ts.map +1 -0
- package/dist/definitions/artifacts/request.schema.js +302 -0
- package/dist/definitions/artifacts/request.schema.js.map +1 -0
- package/dist/definitions/artifacts/response.schema.d.ts +2740 -0
- package/dist/definitions/artifacts/response.schema.d.ts.map +1 -0
- package/dist/definitions/artifacts/response.schema.js +475 -0
- package/dist/definitions/artifacts/response.schema.js.map +1 -0
- package/dist/definitions/audit-log/domain.schema.d.ts +519 -0
- package/dist/definitions/audit-log/domain.schema.d.ts.map +1 -0
- package/dist/definitions/audit-log/domain.schema.js +250 -0
- package/dist/definitions/audit-log/domain.schema.js.map +1 -0
- package/dist/definitions/audit-log/index.d.ts +9 -0
- package/dist/definitions/audit-log/index.d.ts.map +1 -0
- package/dist/definitions/audit-log/index.js +12 -0
- package/dist/definitions/audit-log/index.js.map +1 -0
- package/dist/definitions/audit-log/request.schema.d.ts +695 -0
- package/dist/definitions/audit-log/request.schema.d.ts.map +1 -0
- package/dist/definitions/audit-log/request.schema.js +114 -0
- package/dist/definitions/audit-log/request.schema.js.map +1 -0
- package/dist/definitions/audit-log/response.schema.d.ts +730 -0
- package/dist/definitions/audit-log/response.schema.d.ts.map +1 -0
- package/dist/definitions/audit-log/response.schema.js +143 -0
- package/dist/definitions/audit-log/response.schema.js.map +1 -0
- package/dist/definitions/auth/domain.schema.d.ts +141 -0
- package/dist/definitions/auth/domain.schema.d.ts.map +1 -0
- package/dist/definitions/auth/domain.schema.js +116 -0
- package/dist/definitions/auth/domain.schema.js.map +1 -0
- package/dist/definitions/auth/index.d.ts +4 -0
- package/dist/definitions/auth/index.d.ts.map +1 -0
- package/dist/definitions/auth/index.js +7 -0
- package/dist/definitions/auth/index.js.map +1 -0
- package/dist/definitions/auth/request.schema.d.ts +133 -0
- package/dist/definitions/auth/request.schema.d.ts.map +1 -0
- package/dist/definitions/auth/request.schema.js +173 -0
- package/dist/definitions/auth/request.schema.js.map +1 -0
- package/dist/definitions/auth/response.schema.d.ts +289 -0
- package/dist/definitions/auth/response.schema.d.ts.map +1 -0
- package/dist/definitions/auth/response.schema.js +194 -0
- package/dist/definitions/auth/response.schema.js.map +1 -0
- package/dist/definitions/billing/domain.schema.d.ts +523 -0
- package/dist/definitions/billing/domain.schema.d.ts.map +1 -0
- package/dist/definitions/billing/domain.schema.js +299 -0
- package/dist/definitions/billing/domain.schema.js.map +1 -0
- package/dist/definitions/billing/index.d.ts +9 -0
- package/dist/definitions/billing/index.d.ts.map +1 -0
- package/dist/definitions/billing/index.js +12 -0
- package/dist/definitions/billing/index.js.map +1 -0
- package/dist/definitions/billing/request.schema.d.ts +98 -0
- package/dist/definitions/billing/request.schema.d.ts.map +1 -0
- package/dist/definitions/billing/request.schema.js +112 -0
- package/dist/definitions/billing/request.schema.js.map +1 -0
- package/dist/definitions/billing/response.schema.d.ts +443 -0
- package/dist/definitions/billing/response.schema.d.ts.map +1 -0
- package/dist/definitions/billing/response.schema.js +190 -0
- package/dist/definitions/billing/response.schema.js.map +1 -0
- package/dist/definitions/common.d.ts +227 -0
- package/dist/definitions/common.d.ts.map +1 -0
- package/dist/definitions/common.js +205 -0
- package/dist/definitions/common.js.map +1 -0
- package/dist/definitions/credentials/domain.schema.d.ts +68 -0
- package/dist/definitions/credentials/domain.schema.d.ts.map +1 -0
- package/dist/definitions/credentials/domain.schema.js +56 -0
- package/dist/definitions/credentials/domain.schema.js.map +1 -0
- package/dist/definitions/credentials/index.d.ts +9 -0
- package/dist/definitions/credentials/index.d.ts.map +1 -0
- package/dist/definitions/credentials/index.js +12 -0
- package/dist/definitions/credentials/index.js.map +1 -0
- package/dist/definitions/credentials/request.schema.d.ts +101 -0
- package/dist/definitions/credentials/request.schema.d.ts.map +1 -0
- package/dist/definitions/credentials/request.schema.js +95 -0
- package/dist/definitions/credentials/request.schema.js.map +1 -0
- package/dist/definitions/credentials/response.schema.d.ts +98 -0
- package/dist/definitions/credentials/response.schema.d.ts.map +1 -0
- package/dist/definitions/credentials/response.schema.js +30 -0
- package/dist/definitions/credentials/response.schema.js.map +1 -0
- package/dist/definitions/index.d.ts +191 -0
- package/dist/definitions/index.d.ts.map +1 -0
- package/dist/definitions/index.js +233 -0
- package/dist/definitions/index.js.map +1 -0
- package/dist/definitions/integrations/domain.schema.d.ts +122 -0
- package/dist/definitions/integrations/domain.schema.d.ts.map +1 -0
- package/dist/definitions/integrations/domain.schema.js +85 -0
- package/dist/definitions/integrations/domain.schema.js.map +1 -0
- package/dist/definitions/integrations/index.d.ts +12 -0
- package/dist/definitions/integrations/index.d.ts.map +1 -0
- package/dist/definitions/integrations/index.js +18 -0
- package/dist/definitions/integrations/index.js.map +1 -0
- package/dist/definitions/integrations/marketplace-request.schema.d.ts +142 -0
- package/dist/definitions/integrations/marketplace-request.schema.d.ts.map +1 -0
- package/dist/definitions/integrations/marketplace-request.schema.js +121 -0
- package/dist/definitions/integrations/marketplace-request.schema.js.map +1 -0
- package/dist/definitions/integrations/marketplace-response.schema.d.ts +415 -0
- package/dist/definitions/integrations/marketplace-response.schema.d.ts.map +1 -0
- package/dist/definitions/integrations/marketplace-response.schema.js +121 -0
- package/dist/definitions/integrations/marketplace-response.schema.js.map +1 -0
- package/dist/definitions/integrations/marketplace.schema.d.ts +328 -0
- package/dist/definitions/integrations/marketplace.schema.d.ts.map +1 -0
- package/dist/definitions/integrations/marketplace.schema.js +164 -0
- package/dist/definitions/integrations/marketplace.schema.js.map +1 -0
- package/dist/definitions/integrations/request.schema.d.ts +141 -0
- package/dist/definitions/integrations/request.schema.d.ts.map +1 -0
- package/dist/definitions/integrations/request.schema.js +135 -0
- package/dist/definitions/integrations/request.schema.js.map +1 -0
- package/dist/definitions/integrations/response.schema.d.ts +142 -0
- package/dist/definitions/integrations/response.schema.d.ts.map +1 -0
- package/dist/definitions/integrations/response.schema.js +55 -0
- package/dist/definitions/integrations/response.schema.js.map +1 -0
- package/dist/definitions/orgs/domain.schema.d.ts +75 -0
- package/dist/definitions/orgs/domain.schema.d.ts.map +1 -0
- package/dist/definitions/orgs/domain.schema.js +62 -0
- package/dist/definitions/orgs/domain.schema.js.map +1 -0
- package/dist/definitions/orgs/index.d.ts +9 -0
- package/dist/definitions/orgs/index.d.ts.map +1 -0
- package/dist/definitions/orgs/index.js +12 -0
- package/dist/definitions/orgs/index.js.map +1 -0
- package/dist/definitions/orgs/request.schema.d.ts +151 -0
- package/dist/definitions/orgs/request.schema.d.ts.map +1 -0
- package/dist/definitions/orgs/request.schema.js +139 -0
- package/dist/definitions/orgs/request.schema.js.map +1 -0
- package/dist/definitions/orgs/response.schema.d.ts +161 -0
- package/dist/definitions/orgs/response.schema.d.ts.map +1 -0
- package/dist/definitions/orgs/response.schema.js +64 -0
- package/dist/definitions/orgs/response.schema.js.map +1 -0
- package/dist/definitions/policies/domain.schema.d.ts +421 -0
- package/dist/definitions/policies/domain.schema.d.ts.map +1 -0
- package/dist/definitions/policies/domain.schema.js +341 -0
- package/dist/definitions/policies/domain.schema.js.map +1 -0
- package/dist/definitions/policies/index.d.ts +9 -0
- package/dist/definitions/policies/index.d.ts.map +1 -0
- package/dist/definitions/policies/index.js +20 -0
- package/dist/definitions/policies/index.js.map +1 -0
- package/dist/definitions/policies/request.schema.d.ts +272 -0
- package/dist/definitions/policies/request.schema.d.ts.map +1 -0
- package/dist/definitions/policies/request.schema.js +261 -0
- package/dist/definitions/policies/request.schema.js.map +1 -0
- package/dist/definitions/policies/response.schema.d.ts +529 -0
- package/dist/definitions/policies/response.schema.d.ts.map +1 -0
- package/dist/definitions/policies/response.schema.js +300 -0
- package/dist/definitions/policies/response.schema.js.map +1 -0
- package/dist/definitions/products/domain.schema.d.ts +339 -0
- package/dist/definitions/products/domain.schema.d.ts.map +1 -0
- package/dist/definitions/products/domain.schema.js +156 -0
- package/dist/definitions/products/domain.schema.js.map +1 -0
- package/dist/definitions/products/index.d.ts +9 -0
- package/dist/definitions/products/index.d.ts.map +1 -0
- package/dist/definitions/products/index.js +12 -0
- package/dist/definitions/products/index.js.map +1 -0
- package/dist/definitions/products/request.schema.d.ts +431 -0
- package/dist/definitions/products/request.schema.d.ts.map +1 -0
- package/dist/definitions/products/request.schema.js +274 -0
- package/dist/definitions/products/request.schema.js.map +1 -0
- package/dist/definitions/products/response.schema.d.ts +483 -0
- package/dist/definitions/products/response.schema.d.ts.map +1 -0
- package/dist/definitions/products/response.schema.js +172 -0
- package/dist/definitions/products/response.schema.js.map +1 -0
- package/dist/definitions/release-risk/domain.schema.d.ts +127 -0
- package/dist/definitions/release-risk/domain.schema.d.ts.map +1 -0
- package/dist/definitions/release-risk/domain.schema.js +179 -0
- package/dist/definitions/release-risk/domain.schema.js.map +1 -0
- package/dist/definitions/release-risk/index.d.ts +15 -0
- package/dist/definitions/release-risk/index.d.ts.map +1 -0
- package/dist/definitions/release-risk/index.js +18 -0
- package/dist/definitions/release-risk/index.js.map +1 -0
- package/dist/definitions/release-risk/request.schema.d.ts +119 -0
- package/dist/definitions/release-risk/request.schema.d.ts.map +1 -0
- package/dist/definitions/release-risk/request.schema.js +136 -0
- package/dist/definitions/release-risk/request.schema.js.map +1 -0
- package/dist/definitions/release-risk/response.schema.d.ts +283 -0
- package/dist/definitions/release-risk/response.schema.d.ts.map +1 -0
- package/dist/definitions/release-risk/response.schema.js +192 -0
- package/dist/definitions/release-risk/response.schema.js.map +1 -0
- package/dist/definitions/releases/domain.schema.d.ts +559 -0
- package/dist/definitions/releases/domain.schema.d.ts.map +1 -0
- package/dist/definitions/releases/domain.schema.js +221 -0
- package/dist/definitions/releases/domain.schema.js.map +1 -0
- package/dist/definitions/releases/index.d.ts +9 -0
- package/dist/definitions/releases/index.d.ts.map +1 -0
- package/dist/definitions/releases/index.js +12 -0
- package/dist/definitions/releases/index.js.map +1 -0
- package/dist/definitions/releases/request.schema.d.ts +312 -0
- package/dist/definitions/releases/request.schema.d.ts.map +1 -0
- package/dist/definitions/releases/request.schema.js +176 -0
- package/dist/definitions/releases/request.schema.js.map +1 -0
- package/dist/definitions/releases/response.schema.d.ts +394 -0
- package/dist/definitions/releases/response.schema.d.ts.map +1 -0
- package/dist/definitions/releases/response.schema.js +43 -0
- package/dist/definitions/releases/response.schema.js.map +1 -0
- package/dist/definitions/service-accounts/domain.schema.d.ts +111 -0
- package/dist/definitions/service-accounts/domain.schema.d.ts.map +1 -0
- package/dist/definitions/service-accounts/domain.schema.js +63 -0
- package/dist/definitions/service-accounts/domain.schema.js.map +1 -0
- package/dist/definitions/service-accounts/index.d.ts +9 -0
- package/dist/definitions/service-accounts/index.d.ts.map +1 -0
- package/dist/definitions/service-accounts/index.js +12 -0
- package/dist/definitions/service-accounts/index.js.map +1 -0
- package/dist/definitions/service-accounts/request.schema.d.ts +115 -0
- package/dist/definitions/service-accounts/request.schema.d.ts.map +1 -0
- package/dist/definitions/service-accounts/request.schema.js +119 -0
- package/dist/definitions/service-accounts/request.schema.js.map +1 -0
- package/dist/definitions/service-accounts/response.schema.d.ts +126 -0
- package/dist/definitions/service-accounts/response.schema.d.ts.map +1 -0
- package/dist/definitions/service-accounts/response.schema.js +78 -0
- package/dist/definitions/service-accounts/response.schema.js.map +1 -0
- package/dist/definitions/sessions/domain.schema.d.ts +55 -0
- package/dist/definitions/sessions/domain.schema.d.ts.map +1 -0
- package/dist/definitions/sessions/domain.schema.js +53 -0
- package/dist/definitions/sessions/domain.schema.js.map +1 -0
- package/dist/definitions/sessions/index.d.ts +9 -0
- package/dist/definitions/sessions/index.d.ts.map +1 -0
- package/dist/definitions/sessions/index.js +12 -0
- package/dist/definitions/sessions/index.js.map +1 -0
- package/dist/definitions/sessions/request.schema.d.ts +17 -0
- package/dist/definitions/sessions/request.schema.d.ts.map +1 -0
- package/dist/definitions/sessions/request.schema.js +16 -0
- package/dist/definitions/sessions/request.schema.js.map +1 -0
- package/dist/definitions/sessions/response.schema.d.ts +82 -0
- package/dist/definitions/sessions/response.schema.d.ts.map +1 -0
- package/dist/definitions/sessions/response.schema.js +52 -0
- package/dist/definitions/sessions/response.schema.js.map +1 -0
- package/dist/definitions/settings/domain.schema.d.ts +60 -0
- package/dist/definitions/settings/domain.schema.d.ts.map +1 -0
- package/dist/definitions/settings/domain.schema.js +30 -0
- package/dist/definitions/settings/domain.schema.js.map +1 -0
- package/dist/definitions/settings/index.d.ts +7 -0
- package/dist/definitions/settings/index.d.ts.map +1 -0
- package/dist/definitions/settings/index.js +7 -0
- package/dist/definitions/settings/index.js.map +1 -0
- package/dist/definitions/settings/request.schema.d.ts +28 -0
- package/dist/definitions/settings/request.schema.d.ts.map +1 -0
- package/dist/definitions/settings/request.schema.js +43 -0
- package/dist/definitions/settings/request.schema.js.map +1 -0
- package/dist/definitions/settings/response.schema.d.ts +92 -0
- package/dist/definitions/settings/response.schema.d.ts.map +1 -0
- package/dist/definitions/settings/response.schema.js +56 -0
- package/dist/definitions/settings/response.schema.js.map +1 -0
- package/dist/definitions/share-links/domain.schema.d.ts +123 -0
- package/dist/definitions/share-links/domain.schema.d.ts.map +1 -0
- package/dist/definitions/share-links/domain.schema.js +117 -0
- package/dist/definitions/share-links/domain.schema.js.map +1 -0
- package/dist/definitions/share-links/index.d.ts +9 -0
- package/dist/definitions/share-links/index.d.ts.map +1 -0
- package/dist/definitions/share-links/index.js +12 -0
- package/dist/definitions/share-links/index.js.map +1 -0
- package/dist/definitions/share-links/request.schema.d.ts +229 -0
- package/dist/definitions/share-links/request.schema.d.ts.map +1 -0
- package/dist/definitions/share-links/request.schema.js +373 -0
- package/dist/definitions/share-links/request.schema.js.map +1 -0
- package/dist/definitions/share-links/response.schema.d.ts +295 -0
- package/dist/definitions/share-links/response.schema.d.ts.map +1 -0
- package/dist/definitions/share-links/response.schema.js +185 -0
- package/dist/definitions/share-links/response.schema.js.map +1 -0
- package/dist/definitions/stores/domain.schema.d.ts +126 -0
- package/dist/definitions/stores/domain.schema.d.ts.map +1 -0
- package/dist/definitions/stores/domain.schema.js +86 -0
- package/dist/definitions/stores/domain.schema.js.map +1 -0
- package/dist/definitions/stores/index.d.ts +9 -0
- package/dist/definitions/stores/index.d.ts.map +1 -0
- package/dist/definitions/stores/index.js +12 -0
- package/dist/definitions/stores/index.js.map +1 -0
- package/dist/definitions/stores/request.schema.d.ts +131 -0
- package/dist/definitions/stores/request.schema.d.ts.map +1 -0
- package/dist/definitions/stores/request.schema.js +106 -0
- package/dist/definitions/stores/request.schema.js.map +1 -0
- package/dist/definitions/stores/response.schema.d.ts +192 -0
- package/dist/definitions/stores/response.schema.d.ts.map +1 -0
- package/dist/definitions/stores/response.schema.js +90 -0
- package/dist/definitions/stores/response.schema.js.map +1 -0
- package/dist/definitions/teams/domain.schema.d.ts +37 -0
- package/dist/definitions/teams/domain.schema.d.ts.map +1 -0
- package/dist/definitions/teams/domain.schema.js +33 -0
- package/dist/definitions/teams/domain.schema.js.map +1 -0
- package/dist/definitions/teams/index.d.ts +9 -0
- package/dist/definitions/teams/index.d.ts.map +1 -0
- package/dist/definitions/teams/index.js +12 -0
- package/dist/definitions/teams/index.js.map +1 -0
- package/dist/definitions/teams/request.schema.d.ts +88 -0
- package/dist/definitions/teams/request.schema.d.ts.map +1 -0
- package/dist/definitions/teams/request.schema.js +93 -0
- package/dist/definitions/teams/request.schema.js.map +1 -0
- package/dist/definitions/teams/response.schema.d.ts +83 -0
- package/dist/definitions/teams/response.schema.d.ts.map +1 -0
- package/dist/definitions/teams/response.schema.js +34 -0
- package/dist/definitions/teams/response.schema.js.map +1 -0
- package/dist/definitions/waitlist/index.d.ts +56 -0
- package/dist/definitions/waitlist/index.d.ts.map +1 -0
- package/dist/definitions/waitlist/index.js +114 -0
- package/dist/definitions/waitlist/index.js.map +1 -0
- package/dist/definitions/webhooks/domain.schema.d.ts +144 -0
- package/dist/definitions/webhooks/domain.schema.d.ts.map +1 -0
- package/dist/definitions/webhooks/domain.schema.js +90 -0
- package/dist/definitions/webhooks/domain.schema.js.map +1 -0
- package/dist/definitions/webhooks/index.d.ts +10 -0
- package/dist/definitions/webhooks/index.d.ts.map +1 -0
- package/dist/definitions/webhooks/index.js +13 -0
- package/dist/definitions/webhooks/index.js.map +1 -0
- package/dist/definitions/webhooks/request.schema.d.ts +95 -0
- package/dist/definitions/webhooks/request.schema.d.ts.map +1 -0
- package/dist/definitions/webhooks/request.schema.js +69 -0
- package/dist/definitions/webhooks/request.schema.js.map +1 -0
- package/dist/definitions/webhooks/response.schema.d.ts +255 -0
- package/dist/definitions/webhooks/response.schema.d.ts.map +1 -0
- package/dist/definitions/webhooks/response.schema.js +60 -0
- package/dist/definitions/webhooks/response.schema.js.map +1 -0
- package/dist/definitions/workflows/domain.schema.d.ts +225 -0
- package/dist/definitions/workflows/domain.schema.d.ts.map +1 -0
- package/dist/definitions/workflows/domain.schema.js +112 -0
- package/dist/definitions/workflows/domain.schema.js.map +1 -0
- package/dist/definitions/workflows/index.d.ts +9 -0
- package/dist/definitions/workflows/index.d.ts.map +1 -0
- package/dist/definitions/workflows/index.js +9 -0
- package/dist/definitions/workflows/index.js.map +1 -0
- package/dist/definitions/workflows/request.schema.d.ts +112 -0
- package/dist/definitions/workflows/request.schema.d.ts.map +1 -0
- package/dist/definitions/workflows/request.schema.js +89 -0
- package/dist/definitions/workflows/request.schema.js.map +1 -0
- package/dist/definitions/workflows/response.schema.d.ts +241 -0
- package/dist/definitions/workflows/response.schema.d.ts.map +1 -0
- package/dist/definitions/workflows/response.schema.js +44 -0
- package/dist/definitions/workflows/response.schema.js.map +1 -0
- package/dist/generators/generate-schemas.d.ts +10 -0
- package/dist/generators/generate-schemas.d.ts.map +1 -0
- package/dist/generators/generate-schemas.js +151 -0
- package/dist/generators/generate-schemas.js.map +1 -0
- package/dist/generators/index.d.ts +8 -0
- package/dist/generators/index.d.ts.map +1 -0
- package/dist/generators/index.js +8 -0
- package/dist/generators/index.js.map +1 -0
- package/dist/generators/zod-to-json-schema.d.ts +64 -0
- package/dist/generators/zod-to-json-schema.d.ts.map +1 -0
- package/dist/generators/zod-to-json-schema.js +307 -0
- package/dist/generators/zod-to-json-schema.js.map +1 -0
- package/dist/index.d.ts +15 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +15 -0
- package/dist/index.js.map +1 -0
- package/dist/settings/domain.schema.d.ts +2 -0
- package/dist/settings/domain.schema.d.ts.map +1 -0
- package/dist/settings/domain.schema.js +2 -0
- package/dist/settings/domain.schema.js.map +1 -0
- package/dist/settings/index.d.ts +2 -0
- package/dist/settings/index.d.ts.map +1 -0
- package/dist/settings/index.js +2 -0
- package/dist/settings/index.js.map +1 -0
- package/dist/settings/request.schema.d.ts +2 -0
- package/dist/settings/request.schema.d.ts.map +1 -0
- package/dist/settings/request.schema.js +2 -0
- package/dist/settings/request.schema.js.map +1 -0
- package/dist/settings/response.schema.d.ts +2 -0
- package/dist/settings/response.schema.d.ts.map +1 -0
- package/dist/settings/response.schema.js +2 -0
- package/dist/settings/response.schema.js.map +1 -0
- package/package.json +135 -0
package/README.md
ADDED
|
@@ -0,0 +1,450 @@
|
|
|
1
|
+
# @apollo-deploy/schemas
|
|
2
|
+
|
|
3
|
+
Cross-language type definitions for Apollo Deploy using JSON Schema and Zod.
|
|
4
|
+
|
|
5
|
+
This package provides a single source of truth for all API schemas across the Apollo Deploy platform, enabling type-safe development in TypeScript services and cross-language compatibility for non-TypeScript services (Zig, Rust, Go).
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
`@apollo-deploy/schemas` is a comprehensive schema package that:
|
|
10
|
+
|
|
11
|
+
- **Defines all API types** using Zod for runtime validation and TypeScript type inference
|
|
12
|
+
- **Generates JSON Schema files** for cross-language compatibility
|
|
13
|
+
- **Organizes schemas by domain** for easy discovery and modular imports
|
|
14
|
+
- **Provides subpath imports** to minimize bundle size and improve tree-shaking
|
|
15
|
+
- **Maintains a single source of truth** for all type definitions across the monorepo
|
|
16
|
+
|
|
17
|
+
### Key Features
|
|
18
|
+
|
|
19
|
+
- ✅ **Type-Safe**: Full TypeScript support with Zod schema validation
|
|
20
|
+
- ✅ **Cross-Language**: JSON Schema files for Zig, Rust, Go, and other languages
|
|
21
|
+
- ✅ **Modular**: Domain-based organization with subpath imports
|
|
22
|
+
- ✅ **Performant**: Optimized for tree-shaking and minimal bundle size
|
|
23
|
+
- ✅ **Well-Documented**: Comprehensive JSDoc comments and examples
|
|
24
|
+
- ✅ **Maintainable**: Single source of truth prevents schema duplication
|
|
25
|
+
|
|
26
|
+
## Installation
|
|
27
|
+
|
|
28
|
+
### From GitHub npm Registry
|
|
29
|
+
|
|
30
|
+
Add to your `.npmrc`:
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
@apollo-deploy:registry=https://npm.pkg.github.com
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Then install:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npm install @apollo-deploy/schemas
|
|
40
|
+
# or
|
|
41
|
+
yarn add @apollo-deploy/schemas
|
|
42
|
+
# or
|
|
43
|
+
bun add @apollo-deploy/schemas
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Authentication
|
|
47
|
+
|
|
48
|
+
You'll need a GitHub Personal Access Token (PAT) with `read:packages` scope:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
npm login --scope=@apollo-deploy --registry=https://npm.pkg.github.com
|
|
52
|
+
# Enter your GitHub username and PAT when prompted
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Quick Start
|
|
56
|
+
|
|
57
|
+
### TypeScript - Import from Root
|
|
58
|
+
|
|
59
|
+
```typescript
|
|
60
|
+
import {
|
|
61
|
+
AppSchema,
|
|
62
|
+
AppCreateSchema,
|
|
63
|
+
AppResponseSchema,
|
|
64
|
+
type App,
|
|
65
|
+
type AppCreateInput,
|
|
66
|
+
type AppResponse,
|
|
67
|
+
} from '@apollo-deploy/schemas';
|
|
68
|
+
|
|
69
|
+
// Validate input
|
|
70
|
+
const input = AppCreateSchema.parse(userInput);
|
|
71
|
+
|
|
72
|
+
// Use types
|
|
73
|
+
const app: App = await createApp(input);
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### TypeScript - Subpath Imports (Recommended)
|
|
77
|
+
|
|
78
|
+
For better tree-shaking, import from specific domains:
|
|
79
|
+
|
|
80
|
+
```typescript
|
|
81
|
+
// Apps domain
|
|
82
|
+
import {
|
|
83
|
+
AppSchema,
|
|
84
|
+
AppCreateSchema,
|
|
85
|
+
AppResponseSchema,
|
|
86
|
+
type App,
|
|
87
|
+
type AppCreateInput,
|
|
88
|
+
} from '@apollo-deploy/schemas/apps';
|
|
89
|
+
|
|
90
|
+
// Artifacts domain
|
|
91
|
+
import {
|
|
92
|
+
ArtifactSchema,
|
|
93
|
+
CreateArtifactSchema,
|
|
94
|
+
type Artifact,
|
|
95
|
+
type CreateArtifactInput,
|
|
96
|
+
} from '@apollo-deploy/schemas/artifacts';
|
|
97
|
+
|
|
98
|
+
// Credentials domain
|
|
99
|
+
import {
|
|
100
|
+
CredentialSchema,
|
|
101
|
+
CredentialCreateSchema,
|
|
102
|
+
type Credential,
|
|
103
|
+
type CredentialCreateInput,
|
|
104
|
+
} from '@apollo-deploy/schemas/credentials';
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Non-TypeScript Services
|
|
108
|
+
|
|
109
|
+
Use the generated JSON Schema files for code generation:
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
# Copy JSON schema files to your project
|
|
113
|
+
cp packages/schemas/generated/*.schema.json ./schemas/
|
|
114
|
+
|
|
115
|
+
# Use with your language's JSON Schema tools
|
|
116
|
+
# Zig: Use with zig-json-schema
|
|
117
|
+
# Rust: Use with serde_json and json-schema crates
|
|
118
|
+
# Go: Use with go-json-schema
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## Available Domains
|
|
122
|
+
|
|
123
|
+
The package is organized into the following domains:
|
|
124
|
+
|
|
125
|
+
| Domain | Purpose | Subpath |
|
|
126
|
+
|--------|---------|---------|
|
|
127
|
+
| **Common** | Shared schemas (pagination, errors, enums) | `@apollo-deploy/schemas` |
|
|
128
|
+
| **Auth** | Authentication, roles, permissions | `@apollo-deploy/schemas` |
|
|
129
|
+
| **Apps** | Application management | `@apollo-deploy/schemas/apps` |
|
|
130
|
+
| **Artifacts** | Build artifacts (APK, IPA, etc.) | `@apollo-deploy/schemas/artifacts` |
|
|
131
|
+
| **Releases** | Release management | `@apollo-deploy/schemas/releases` |
|
|
132
|
+
| **Credentials** | Store credentials | `@apollo-deploy/schemas/credentials` |
|
|
133
|
+
| **Teams** | Team management | `@apollo-deploy/schemas/teams` |
|
|
134
|
+
| **Organizations** | Organization management | `@apollo-deploy/schemas/orgs` |
|
|
135
|
+
| **Webhooks** | Webhook configuration | `@apollo-deploy/schemas/webhooks` |
|
|
136
|
+
| **Billing** | Subscriptions and billing | `@apollo-deploy/schemas/billing` |
|
|
137
|
+
| **Analytics** | Analytics data | `@apollo-deploy/schemas/analytics` |
|
|
138
|
+
| **Share Links** | Shareable artifact links | `@apollo-deploy/schemas/share-links` |
|
|
139
|
+
| **Integrations** | Third-party integrations | `@apollo-deploy/schemas/integrations` |
|
|
140
|
+
| **Stores** | Store connections | `@apollo-deploy/schemas/stores` |
|
|
141
|
+
| **Audit Log** | Audit logging | `@apollo-deploy/schemas/audit-log` |
|
|
142
|
+
| **Sessions** | Session management | `@apollo-deploy/schemas/sessions` |
|
|
143
|
+
|
|
144
|
+
## Schema Organization
|
|
145
|
+
|
|
146
|
+
Each domain module contains three types of schemas:
|
|
147
|
+
|
|
148
|
+
### Domain Schemas (`domain.schema.ts`)
|
|
149
|
+
|
|
150
|
+
Core entity definitions:
|
|
151
|
+
|
|
152
|
+
```typescript
|
|
153
|
+
import { AppSchema, type App } from '@apollo-deploy/schemas/apps';
|
|
154
|
+
|
|
155
|
+
const app: App = {
|
|
156
|
+
id: 'app_123',
|
|
157
|
+
name: 'My App',
|
|
158
|
+
packages: { android: 'com.example.app' },
|
|
159
|
+
// ...
|
|
160
|
+
};
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
### Request Schemas (`request.schema.ts`)
|
|
164
|
+
|
|
165
|
+
Input validation for API requests:
|
|
166
|
+
|
|
167
|
+
```typescript
|
|
168
|
+
import { AppCreateSchema, type AppCreateInput } from '@apollo-deploy/schemas/apps';
|
|
169
|
+
|
|
170
|
+
const input: AppCreateInput = AppCreateSchema.parse({
|
|
171
|
+
name: 'My App',
|
|
172
|
+
packages: { android: 'com.example.app' },
|
|
173
|
+
});
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### Response Schemas (`response.schema.ts`)
|
|
177
|
+
|
|
178
|
+
Output validation for API responses:
|
|
179
|
+
|
|
180
|
+
```typescript
|
|
181
|
+
import { AppResponseSchema, type AppResponse } from '@apollo-deploy/schemas/apps';
|
|
182
|
+
|
|
183
|
+
const response: AppResponse = AppResponseSchema.parse(apiResponse);
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
## TypeScript Examples
|
|
187
|
+
|
|
188
|
+
### Validation
|
|
189
|
+
|
|
190
|
+
```typescript
|
|
191
|
+
import { AppCreateSchema, type AppCreateInput } from '@apollo-deploy/schemas/apps';
|
|
192
|
+
|
|
193
|
+
// Validate and parse input
|
|
194
|
+
try {
|
|
195
|
+
const input: AppCreateInput = AppCreateSchema.parse(userInput);
|
|
196
|
+
console.log('Valid input:', input);
|
|
197
|
+
} catch (error) {
|
|
198
|
+
console.error('Validation failed:', error.errors);
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
// Safe parsing (returns result object)
|
|
202
|
+
const result = AppCreateSchema.safeParse(userInput);
|
|
203
|
+
if (result.success) {
|
|
204
|
+
console.log('Valid:', result.data);
|
|
205
|
+
} else {
|
|
206
|
+
console.error('Invalid:', result.error.flatten());
|
|
207
|
+
}
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### Type Inference
|
|
211
|
+
|
|
212
|
+
```typescript
|
|
213
|
+
import { AppCreateSchema } from '@apollo-deploy/schemas/apps';
|
|
214
|
+
|
|
215
|
+
// Infer type from schema
|
|
216
|
+
type AppCreateInput = typeof AppCreateSchema._type;
|
|
217
|
+
|
|
218
|
+
// Or use explicit type import
|
|
219
|
+
import type { AppCreateInput } from '@apollo-deploy/schemas/apps';
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Pagination
|
|
223
|
+
|
|
224
|
+
```typescript
|
|
225
|
+
import { AppListEnvelopeSchema, type AppListEnvelope } from '@apollo-deploy/schemas/apps';
|
|
226
|
+
|
|
227
|
+
const response: AppListEnvelope = {
|
|
228
|
+
data: [
|
|
229
|
+
{ id: 'app_1', name: 'App 1', /* ... */ },
|
|
230
|
+
{ id: 'app_2', name: 'App 2', /* ... */ },
|
|
231
|
+
],
|
|
232
|
+
page: {
|
|
233
|
+
size: 2,
|
|
234
|
+
totalPages: 5,
|
|
235
|
+
hasMore: true,
|
|
236
|
+
},
|
|
237
|
+
};
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
## JSON Schema Examples
|
|
241
|
+
|
|
242
|
+
### Using with Zig
|
|
243
|
+
|
|
244
|
+
```zig
|
|
245
|
+
const std = @import("std");
|
|
246
|
+
const json = std.json;
|
|
247
|
+
|
|
248
|
+
// Load schema
|
|
249
|
+
const schema_text = @embedFile("schemas/apps.schema.json");
|
|
250
|
+
const schema = try json.parseFromSlice(json.Value, allocator, schema_text, .{});
|
|
251
|
+
|
|
252
|
+
// Generate types or validate data
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
### Using with Rust
|
|
256
|
+
|
|
257
|
+
```rust
|
|
258
|
+
use serde_json::json;
|
|
259
|
+
use jsonschema::JSONSchema;
|
|
260
|
+
|
|
261
|
+
// Load schema
|
|
262
|
+
let schema_text = include_str!("../schemas/apps.schema.json");
|
|
263
|
+
let schema = serde_json::from_str(schema_text)?;
|
|
264
|
+
let validator = JSONSchema::compile(&schema)?;
|
|
265
|
+
|
|
266
|
+
// Validate data
|
|
267
|
+
let data = json!({ "name": "My App", "packages": { "android": "com.example.app" } });
|
|
268
|
+
validator.validate(&data)?;
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
### Using with Go
|
|
272
|
+
|
|
273
|
+
```go
|
|
274
|
+
import (
|
|
275
|
+
"encoding/json"
|
|
276
|
+
"github.com/xeipuuv/gojsonschema"
|
|
277
|
+
)
|
|
278
|
+
|
|
279
|
+
// Load schema
|
|
280
|
+
schemaLoader := gojsonschema.NewReferenceLoader("file:///schemas/apps.schema.json")
|
|
281
|
+
schema, _ := gojsonschema.NewSchema(schemaLoader)
|
|
282
|
+
|
|
283
|
+
// Validate data
|
|
284
|
+
documentLoader := gojsonschema.NewGoLoader(data)
|
|
285
|
+
result, _ := schema.Validate(documentLoader)
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
## Schema Regeneration
|
|
289
|
+
|
|
290
|
+
### Automatic Generation
|
|
291
|
+
|
|
292
|
+
Schemas are automatically generated during the build process:
|
|
293
|
+
|
|
294
|
+
```bash
|
|
295
|
+
# Generate all JSON schemas
|
|
296
|
+
bun run generate
|
|
297
|
+
|
|
298
|
+
# This creates/updates files in packages/schemas/generated/
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### Manual Generation
|
|
302
|
+
|
|
303
|
+
To manually regenerate schemas:
|
|
304
|
+
|
|
305
|
+
```bash
|
|
306
|
+
cd packages/schemas
|
|
307
|
+
bun run generate
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
### Committing Generated Files
|
|
311
|
+
|
|
312
|
+
Generated JSON Schema files are committed to the repository for easy consumption:
|
|
313
|
+
|
|
314
|
+
```bash
|
|
315
|
+
# After running generate, commit the files
|
|
316
|
+
git add packages/schemas/generated/
|
|
317
|
+
git commit -m "chore: regenerate JSON schemas"
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
## Contributing
|
|
321
|
+
|
|
322
|
+
### Adding a New Domain
|
|
323
|
+
|
|
324
|
+
1. **Create domain directory**:
|
|
325
|
+
```bash
|
|
326
|
+
mkdir -p packages/schemas/src/definitions/my-domain
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
2. **Create schema files**:
|
|
330
|
+
- `domain.schema.ts` - Entity definitions
|
|
331
|
+
- `request.schema.ts` - Request validation
|
|
332
|
+
- `response.schema.ts` - Response structures
|
|
333
|
+
- `index.ts` - Domain exports
|
|
334
|
+
|
|
335
|
+
3. **Update exports**:
|
|
336
|
+
- Add exports to `src/definitions/index.ts`
|
|
337
|
+
- Add subpath export to `package.json`
|
|
338
|
+
|
|
339
|
+
4. **Generate schemas**:
|
|
340
|
+
```bash
|
|
341
|
+
bun run generate
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
5. **Commit changes**:
|
|
345
|
+
```bash
|
|
346
|
+
git add packages/schemas/
|
|
347
|
+
git commit -m "feat: add my-domain schemas"
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
### Schema Best Practices
|
|
351
|
+
|
|
352
|
+
- **Use Zod refinements** for complex validation logic
|
|
353
|
+
- **Add JSDoc comments** to all exported schemas
|
|
354
|
+
- **Keep schemas focused** - one concern per schema
|
|
355
|
+
- **Reuse common schemas** - import from `common.ts`
|
|
356
|
+
- **Test schema validation** - add unit tests for complex schemas
|
|
357
|
+
- **Document breaking changes** - update CHANGELOG.md
|
|
358
|
+
|
|
359
|
+
### Testing Schemas
|
|
360
|
+
|
|
361
|
+
```typescript
|
|
362
|
+
import { describe, it, expect } from 'bun:test';
|
|
363
|
+
import { AppCreateSchema } from '@apollo-deploy/schemas/apps';
|
|
364
|
+
|
|
365
|
+
describe('AppCreateSchema', () => {
|
|
366
|
+
it('should validate valid input', () => {
|
|
367
|
+
const input = {
|
|
368
|
+
name: 'My App',
|
|
369
|
+
packages: { android: 'com.example.app' },
|
|
370
|
+
};
|
|
371
|
+
expect(() => AppCreateSchema.parse(input)).not.toThrow();
|
|
372
|
+
});
|
|
373
|
+
|
|
374
|
+
it('should reject invalid input', () => {
|
|
375
|
+
const input = { name: '' }; // Invalid: empty name
|
|
376
|
+
expect(() => AppCreateSchema.parse(input)).toThrow();
|
|
377
|
+
});
|
|
378
|
+
});
|
|
379
|
+
```
|
|
380
|
+
|
|
381
|
+
## API Reference
|
|
382
|
+
|
|
383
|
+
### Common Schemas
|
|
384
|
+
|
|
385
|
+
```typescript
|
|
386
|
+
// Pagination
|
|
387
|
+
import { PaginationSchema, PaginationMetaSchema } from '@apollo-deploy/schemas';
|
|
388
|
+
|
|
389
|
+
// Enums
|
|
390
|
+
import { PlatformSchema, StoreProviderSchema, StatusSchema } from '@apollo-deploy/schemas';
|
|
391
|
+
|
|
392
|
+
// Utilities
|
|
393
|
+
import { UUIDSchema, DateTimeSchema, UrlSchema } from '@apollo-deploy/schemas';
|
|
394
|
+
```
|
|
395
|
+
|
|
396
|
+
### Authentication
|
|
397
|
+
|
|
398
|
+
```typescript
|
|
399
|
+
import {
|
|
400
|
+
UserRoleSchema,
|
|
401
|
+
OrgRoleSchema,
|
|
402
|
+
TeamRoleSchema,
|
|
403
|
+
PermissionSchema,
|
|
404
|
+
} from '@apollo-deploy/schemas';
|
|
405
|
+
```
|
|
406
|
+
|
|
407
|
+
### Domain Imports
|
|
408
|
+
|
|
409
|
+
```typescript
|
|
410
|
+
// Apps
|
|
411
|
+
import { AppSchema, AppCreateSchema, AppResponseSchema } from '@apollo-deploy/schemas/apps';
|
|
412
|
+
|
|
413
|
+
// Artifacts
|
|
414
|
+
import { ArtifactSchema, CreateArtifactSchema } from '@apollo-deploy/schemas/artifacts';
|
|
415
|
+
|
|
416
|
+
// Credentials
|
|
417
|
+
import { CredentialSchema, CredentialCreateSchema } from '@apollo-deploy/schemas/credentials';
|
|
418
|
+
|
|
419
|
+
// And so on for other domains...
|
|
420
|
+
```
|
|
421
|
+
|
|
422
|
+
## Troubleshooting
|
|
423
|
+
|
|
424
|
+
### Import Errors
|
|
425
|
+
|
|
426
|
+
**Problem**: `Cannot find module '@apollo-deploy/schemas/apps'`
|
|
427
|
+
|
|
428
|
+
**Solution**: Ensure the package is installed and the subpath export is defined in `package.json`.
|
|
429
|
+
|
|
430
|
+
### Type Errors
|
|
431
|
+
|
|
432
|
+
**Problem**: `Type 'AppCreateInput' is not assignable to type 'App'`
|
|
433
|
+
|
|
434
|
+
**Solution**: Use the correct schema type. `AppCreateInput` is for creating apps, `App` is the full entity type.
|
|
435
|
+
|
|
436
|
+
### Validation Errors
|
|
437
|
+
|
|
438
|
+
**Problem**: `Validation failed: [{"code":"too_small","minimum":3,"type":"string","path":["name"],"message":"String must contain at least 3 characters"}]`
|
|
439
|
+
|
|
440
|
+
**Solution**: Ensure input meets all schema requirements. Check the error details for specific field requirements.
|
|
441
|
+
|
|
442
|
+
## Performance
|
|
443
|
+
|
|
444
|
+
- **Bundle Size**: Subpath imports enable tree-shaking (~5KB per domain)
|
|
445
|
+
- **Validation Speed**: Zod schemas are compiled once at import time
|
|
446
|
+
- **JSON Schema Generation**: Runs in <1s for all domains
|
|
447
|
+
|
|
448
|
+
## License
|
|
449
|
+
|
|
450
|
+
This package is part of Apollo Deploy and follows the same license as the main repository.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Admin Users Domain Schemas
|
|
3
|
+
*
|
|
4
|
+
* Core domain schemas for admin user management.
|
|
5
|
+
*/
|
|
6
|
+
import { z } from 'zod';
|
|
7
|
+
/**
|
|
8
|
+
* Admin user schema
|
|
9
|
+
*
|
|
10
|
+
* Represents a user in admin context (Better Auth internal roles).
|
|
11
|
+
*/
|
|
12
|
+
export declare const AdminUserSchema: z.ZodObject<{
|
|
13
|
+
id: z.ZodString;
|
|
14
|
+
email: z.ZodString;
|
|
15
|
+
name: z.ZodNullable<z.ZodString>;
|
|
16
|
+
role: z.ZodEnum<{
|
|
17
|
+
admin: "admin";
|
|
18
|
+
user: "user";
|
|
19
|
+
}>;
|
|
20
|
+
emailVerified: z.ZodBoolean;
|
|
21
|
+
image: z.ZodNullable<z.ZodString>;
|
|
22
|
+
createdAt: z.ZodUnion<readonly [z.ZodDate, z.ZodString]>;
|
|
23
|
+
updatedAt: z.ZodUnion<readonly [z.ZodDate, z.ZodString]>;
|
|
24
|
+
banned: z.ZodOptional<z.ZodBoolean>;
|
|
25
|
+
}, z.core.$strip>;
|
|
26
|
+
export type AdminUser = z.infer<typeof AdminUserSchema>;
|
|
27
|
+
//# sourceMappingURL=domain.schema.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"domain.schema.d.ts","sourceRoot":"","sources":["../../../src/definitions/admin-users/domain.schema.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;GAIG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;iBAU1B,CAAC;AAGH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Admin Users Domain Schemas
|
|
3
|
+
*
|
|
4
|
+
* Core domain schemas for admin user management.
|
|
5
|
+
*/
|
|
6
|
+
import { z } from 'zod';
|
|
7
|
+
import { TimestampSchema, UserRoleSchema } from '../common.js';
|
|
8
|
+
/**
|
|
9
|
+
* Admin user schema
|
|
10
|
+
*
|
|
11
|
+
* Represents a user in admin context (Better Auth internal roles).
|
|
12
|
+
*/
|
|
13
|
+
export const AdminUserSchema = z.object({
|
|
14
|
+
id: z.string(),
|
|
15
|
+
email: z.string().email(),
|
|
16
|
+
name: z.string().nullable(),
|
|
17
|
+
role: UserRoleSchema,
|
|
18
|
+
emailVerified: z.boolean(),
|
|
19
|
+
image: z.string().nullable(),
|
|
20
|
+
createdAt: TimestampSchema,
|
|
21
|
+
updatedAt: TimestampSchema,
|
|
22
|
+
banned: z.boolean().optional(),
|
|
23
|
+
});
|
|
24
|
+
//# sourceMappingURL=domain.schema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"domain.schema.js","sourceRoot":"","sources":["../../../src/definitions/admin-users/domain.schema.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE/D;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE;IACzB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,IAAI,EAAE,cAAc;IACpB,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE;IAC1B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,SAAS,EAAE,eAAe;IAC1B,SAAS,EAAE,eAAe;IAC1B,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export { AdminUserSchema, type AdminUser, } from './domain.schema.js';
|
|
2
|
+
export { CreateUserSchema, UserIdParamSchema, ListUsersQuerySchema, SetUserRoleSchema, BanUserSchema, type CreateUserInput, type UserIdParam, type ListUsersQuery, type SetUserRoleInput, type BanUserInput, } from './request.schema.js';
|
|
3
|
+
export { UserResponseSchema, UserListResponseSchema, BanResponseSchema, UnbanResponseSchema, SessionListResponseSchema, RevokeSessionsResponseSchema, ImpersonateResponseSchema, StopImpersonationResponseSchema, DeleteUserResponseSchema, type UserResponse, type UserListResponse, type BanResponse, type UnbanResponse, type SessionListResponse, type RevokeSessionsResponse, type ImpersonateResponse, type StopImpersonationResponse, type DeleteUserResponse, } from './response.schema.js';
|
|
4
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/definitions/admin-users/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,eAAe,EACf,KAAK,SAAS,GACf,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,aAAa,EACb,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,YAAY,GAClB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EACL,kBAAkB,EAClB,sBAAsB,EACtB,iBAAiB,EACjB,mBAAmB,EACnB,yBAAyB,EACzB,4BAA4B,EAC5B,yBAAyB,EACzB,+BAA+B,EAC/B,wBAAwB,EACxB,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,GACxB,MAAM,sBAAsB,CAAC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
// Domain schemas
|
|
2
|
+
export { AdminUserSchema, } from './domain.schema.js';
|
|
3
|
+
// Request schemas
|
|
4
|
+
export { CreateUserSchema, UserIdParamSchema, ListUsersQuerySchema, SetUserRoleSchema, BanUserSchema, } from './request.schema.js';
|
|
5
|
+
// Response schemas
|
|
6
|
+
export { UserResponseSchema, UserListResponseSchema, BanResponseSchema, UnbanResponseSchema, SessionListResponseSchema, RevokeSessionsResponseSchema, ImpersonateResponseSchema, StopImpersonationResponseSchema, DeleteUserResponseSchema, } from './response.schema.js';
|
|
7
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/definitions/admin-users/index.ts"],"names":[],"mappings":"AAAA,iBAAiB;AACjB,OAAO,EACL,eAAe,GAEhB,MAAM,oBAAoB,CAAC;AAE5B,kBAAkB;AAClB,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,aAAa,GAMd,MAAM,qBAAqB,CAAC;AAE7B,mBAAmB;AACnB,OAAO,EACL,kBAAkB,EAClB,sBAAsB,EACtB,iBAAiB,EACjB,mBAAmB,EACnB,yBAAyB,EACzB,4BAA4B,EAC5B,yBAAyB,EACzB,+BAA+B,EAC/B,wBAAwB,GAUzB,MAAM,sBAAsB,CAAC"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Admin Users Request Schemas
|
|
3
|
+
*
|
|
4
|
+
* Request schemas for admin user management endpoints.
|
|
5
|
+
*/
|
|
6
|
+
import { z } from 'zod';
|
|
7
|
+
/**
|
|
8
|
+
* Create user request schema
|
|
9
|
+
*/
|
|
10
|
+
export declare const CreateUserSchema: z.ZodObject<{
|
|
11
|
+
email: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
|
|
12
|
+
password: z.ZodString;
|
|
13
|
+
name: z.ZodOptional<z.ZodString>;
|
|
14
|
+
}, z.core.$strip>;
|
|
15
|
+
/**
|
|
16
|
+
* User ID path parameter schema
|
|
17
|
+
*/
|
|
18
|
+
export declare const UserIdParamSchema: z.ZodObject<{
|
|
19
|
+
userId: z.ZodString;
|
|
20
|
+
}, z.core.$strip>;
|
|
21
|
+
/**
|
|
22
|
+
* List users query schema
|
|
23
|
+
*/
|
|
24
|
+
export declare const ListUsersQuerySchema: z.ZodObject<{
|
|
25
|
+
page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
26
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
27
|
+
role: z.ZodOptional<z.ZodEnum<{
|
|
28
|
+
admin: "admin";
|
|
29
|
+
user: "user";
|
|
30
|
+
}>>;
|
|
31
|
+
emailVerified: z.ZodOptional<z.ZodCoercedBoolean<unknown>>;
|
|
32
|
+
banned: z.ZodOptional<z.ZodCoercedBoolean<unknown>>;
|
|
33
|
+
}, z.core.$strip>;
|
|
34
|
+
/**
|
|
35
|
+
* Set user role request schema
|
|
36
|
+
*/
|
|
37
|
+
export declare const SetUserRoleSchema: z.ZodObject<{
|
|
38
|
+
role: z.ZodEnum<{
|
|
39
|
+
admin: "admin";
|
|
40
|
+
user: "user";
|
|
41
|
+
}>;
|
|
42
|
+
}, z.core.$strip>;
|
|
43
|
+
/**
|
|
44
|
+
* Ban user request schema
|
|
45
|
+
*/
|
|
46
|
+
export declare const BanUserSchema: z.ZodObject<{
|
|
47
|
+
banReason: z.ZodOptional<z.ZodString>;
|
|
48
|
+
expireSeconds: z.ZodOptional<z.ZodNumber>;
|
|
49
|
+
}, z.core.$strip>;
|
|
50
|
+
export type CreateUserInput = z.infer<typeof CreateUserSchema>;
|
|
51
|
+
export type UserIdParam = z.infer<typeof UserIdParamSchema>;
|
|
52
|
+
export type ListUsersQuery = z.infer<typeof ListUsersQuerySchema>;
|
|
53
|
+
export type SetUserRoleInput = z.infer<typeof SetUserRoleSchema>;
|
|
54
|
+
export type BanUserInput = z.infer<typeof BanUserSchema>;
|
|
55
|
+
//# sourceMappingURL=request.schema.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"request.schema.d.ts","sourceRoot":"","sources":["../../../src/definitions/admin-users/request.schema.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;iBAI3B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,iBAAiB;;iBAE5B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;iBAI/B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;iBAE5B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,aAAa;;;iBAGxB,CAAC;AAGH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC/D,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAClE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AACjE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC"}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Admin Users Request Schemas
|
|
3
|
+
*
|
|
4
|
+
* Request schemas for admin user management endpoints.
|
|
5
|
+
*/
|
|
6
|
+
import { z } from 'zod';
|
|
7
|
+
import { PaginationSchema, UserRoleSchema } from '../common.js';
|
|
8
|
+
import { SafeEmailSchema } from '../auth/request.schema.js';
|
|
9
|
+
/**
|
|
10
|
+
* Create user request schema
|
|
11
|
+
*/
|
|
12
|
+
export const CreateUserSchema = z.object({
|
|
13
|
+
email: SafeEmailSchema,
|
|
14
|
+
password: z.string().min(8, 'Password must be at least 8 characters'),
|
|
15
|
+
name: z.string().min(1).optional(),
|
|
16
|
+
});
|
|
17
|
+
/**
|
|
18
|
+
* User ID path parameter schema
|
|
19
|
+
*/
|
|
20
|
+
export const UserIdParamSchema = z.object({
|
|
21
|
+
userId: z.string().min(1, 'userId is required'),
|
|
22
|
+
});
|
|
23
|
+
/**
|
|
24
|
+
* List users query schema
|
|
25
|
+
*/
|
|
26
|
+
export const ListUsersQuerySchema = PaginationSchema.extend({
|
|
27
|
+
role: UserRoleSchema.optional(),
|
|
28
|
+
emailVerified: z.coerce.boolean().optional(),
|
|
29
|
+
banned: z.coerce.boolean().optional(),
|
|
30
|
+
});
|
|
31
|
+
/**
|
|
32
|
+
* Set user role request schema
|
|
33
|
+
*/
|
|
34
|
+
export const SetUserRoleSchema = z.object({
|
|
35
|
+
role: UserRoleSchema,
|
|
36
|
+
});
|
|
37
|
+
/**
|
|
38
|
+
* Ban user request schema
|
|
39
|
+
*/
|
|
40
|
+
export const BanUserSchema = z.object({
|
|
41
|
+
banReason: z.string().min(1).max(500).optional(),
|
|
42
|
+
expireSeconds: z.number().int().positive().optional(),
|
|
43
|
+
});
|
|
44
|
+
//# sourceMappingURL=request.schema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"request.schema.js","sourceRoot":"","sources":["../../../src/definitions/admin-users/request.schema.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,KAAK,EAAE,eAAe;IACtB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,wCAAwC,CAAC;IACrE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,oBAAoB,CAAC;CAChD,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,MAAM,CAAC;IAC1D,IAAI,EAAE,cAAc,CAAC,QAAQ,EAAE;IAC/B,aAAa,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC5C,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACtC,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,IAAI,EAAE,cAAc;CACrB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IAChD,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CACtD,CAAC,CAAC"}
|