zitejs 0.9.153 → 0.9.154
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/dist/cjs/auth/actions.d.ts +28 -0
- package/dist/cjs/auth/actions.js +93 -0
- package/dist/cjs/auth/client.d.ts +357 -0
- package/dist/cjs/auth/client.js +66 -0
- package/dist/cjs/auth/config.js +9 -3
- package/dist/cjs/auth/index.d.ts +2 -249
- package/dist/cjs/auth/index.js +11 -108
- package/dist/cjs/auth/index.test.js +60 -0
- package/dist/cjs/auth/previewClaim.d.ts +7 -0
- package/dist/cjs/auth/previewClaim.js +16 -0
- package/dist/cjs/auth/profileUpdates.d.ts +9 -0
- package/dist/cjs/auth/profileUpdates.js +11 -0
- package/dist/cjs/backend/index.d.ts +6 -6
- package/dist/cjs/backend/index.js +13 -13
- package/dist/cjs/backend/index.test.js +102 -102
- package/dist/cjs/bundle/index.js +29 -16
- package/dist/cjs/caller/index.js +43 -43
- package/dist/cjs/check/index.d.ts +44 -1
- package/dist/cjs/check/index.js +198 -61
- package/dist/cjs/check/start/routeTree.d.ts +8 -0
- package/dist/cjs/check/start/routeTree.js +118 -0
- package/dist/cjs/check/start/tsgo.d.ts +2 -0
- package/dist/cjs/check/start/tsgo.js +35 -0
- package/dist/cjs/cli.js +19 -6
- package/dist/cjs/client/index.d.ts +2 -2
- package/dist/cjs/client/index.js +25 -25
- package/dist/cjs/dev/index.js +81 -53
- package/dist/cjs/dev/signin.d.ts +16 -0
- package/dist/cjs/dev/signin.js +84 -0
- package/dist/cjs/index.d.ts +5 -5
- package/dist/cjs/integrations/client.d.ts +3 -3
- package/dist/cjs/integrations/client.js +5 -4
- package/dist/cjs/integrations/client.test-d.js +15 -15
- package/dist/cjs/integrations/index.d.ts +2 -2
- package/dist/cjs/integrations/rules.js +42 -42
- package/dist/cjs/integrations/rules.test.js +60 -55
- package/dist/cjs/internal/appMode.d.ts +14 -0
- package/dist/cjs/internal/appMode.js +19 -0
- package/dist/cjs/internal/env.js +3 -2
- package/dist/cjs/internal/platformFetch.d.ts +2 -0
- package/dist/cjs/internal/platformFetch.js +14 -0
- package/dist/cjs/internal/reservedIds.d.ts +8 -0
- package/dist/cjs/internal/reservedIds.js +14 -0
- package/dist/cjs/internal/serviceUrls.d.ts +5 -0
- package/dist/cjs/internal/serviceUrls.js +14 -0
- package/dist/cjs/pdf/index.js +2 -1
- package/dist/cjs/runtime/filterConditionTypes.test-d.js +11 -11
- package/dist/cjs/runtime/index.d.ts +22 -22
- package/dist/cjs/runtime/index.js +28 -28
- package/dist/cjs/runtime/index.test.js +34 -34
- package/dist/cjs/runtime/sendEmailParamsTypes.test-d.js +29 -29
- package/dist/cjs/runtime/writeResultTypes.test-d.js +8 -8
- package/dist/cjs/sourceRoots.js +15 -15
- package/dist/cjs/sourceRoots.test.js +29 -27
- package/dist/cjs/start/build/entries.d.ts +25 -0
- package/dist/cjs/start/build/entries.js +121 -0
- package/dist/cjs/start/build/placeholders/devApp.d.ts +1 -0
- package/dist/cjs/start/build/placeholders/devApp.js +6 -0
- package/dist/cjs/start/describe/describeBuilt.d.ts +5 -0
- package/dist/cjs/start/describe/describeBuilt.js +144 -0
- package/dist/cjs/start/platform/aiUsage.d.ts +29 -0
- package/dist/cjs/start/platform/aiUsage.js +215 -0
- package/dist/cjs/start/platform/airtable/cache.d.ts +17 -0
- package/dist/cjs/start/platform/airtable/cache.js +93 -0
- package/dist/cjs/start/protocol.d.ts +19 -0
- package/dist/cjs/start/protocol.js +33 -0
- package/dist/cjs/start/serve/local/provider.d.ts +25 -0
- package/dist/cjs/start/serve/local/provider.js +196 -0
- package/dist/cjs/start/serve/provider.d.ts +19 -0
- package/dist/cjs/start/serve/provider.js +86 -0
- package/dist/cjs/start/types.d.ts +373 -0
- package/dist/cjs/start/types.js +2 -0
- package/dist/cjs/steps/index.d.ts +8 -8
- package/dist/cjs/steps/index.js +53 -53
- package/dist/cjs/steps/index.test.js +218 -218
- package/dist/cjs/sync/index.d.ts +1 -1
- package/dist/cjs/sync/index.js +28 -27
- package/dist/cjs/sync/lib.d.ts +15 -8
- package/dist/cjs/sync/lib.js +651 -665
- package/dist/cjs/sync/lib.test.js +81 -14
- package/dist/cjs/sync/sdkNames.d.ts +67 -9
- package/dist/cjs/sync/sdkNames.js +97 -31
- package/dist/cjs/sync/sdkNames.test.js +189 -113
- package/dist/cjs/types/fields.d.ts +1 -1
- package/dist/cjs/types/fields.js +105 -97
- package/dist/cjs/types/index.d.ts +2 -2
- package/dist/cjs/types/tables.d.ts +1 -1
- package/dist/cjs/upload/index.js +89 -24
- package/dist/cjs/upload/index.test.js +104 -1
- package/dist/cjs/vite/domTagNames.js +252 -252
- package/dist/cjs/vite/index.d.ts +1 -1
- package/dist/cjs/vite/index.js +51 -42
- package/dist/cjs/vite/index.test.js +10 -2
- package/dist/esm/auth/actions.d.ts +28 -0
- package/dist/esm/auth/actions.js +55 -0
- package/dist/esm/auth/client.d.ts +357 -0
- package/dist/esm/auth/client.js +62 -0
- package/dist/esm/auth/config.js +9 -3
- package/dist/esm/auth/index.d.ts +2 -249
- package/dist/esm/auth/index.js +2 -103
- package/dist/esm/auth/index.test.js +60 -0
- package/dist/esm/auth/previewClaim.d.ts +7 -0
- package/dist/esm/auth/previewClaim.js +12 -0
- package/dist/esm/auth/profileUpdates.d.ts +9 -0
- package/dist/esm/auth/profileUpdates.js +6 -0
- package/dist/esm/backend/index.d.ts +6 -6
- package/dist/esm/backend/index.js +13 -13
- package/dist/esm/backend/index.test.js +106 -106
- package/dist/esm/bundle/index.js +29 -16
- package/dist/esm/caller/index.js +44 -44
- package/dist/esm/check/index.d.ts +44 -1
- package/dist/esm/check/index.js +194 -61
- package/dist/esm/check/start/routeTree.d.ts +8 -0
- package/dist/esm/check/start/routeTree.js +77 -0
- package/dist/esm/check/start/tsgo.d.ts +2 -0
- package/dist/esm/check/start/tsgo.js +29 -0
- package/dist/esm/cli.js +19 -6
- package/dist/esm/client/index.d.ts +2 -2
- package/dist/esm/client/index.js +25 -25
- package/dist/esm/dev/index.js +88 -60
- package/dist/esm/dev/signin.d.ts +16 -0
- package/dist/esm/dev/signin.js +80 -0
- package/dist/esm/index.d.ts +5 -5
- package/dist/esm/index.js +3 -3
- package/dist/esm/integrations/client.d.ts +3 -3
- package/dist/esm/integrations/client.js +6 -5
- package/dist/esm/integrations/client.test-d.js +19 -19
- package/dist/esm/integrations/index.d.ts +2 -2
- package/dist/esm/integrations/index.js +1 -1
- package/dist/esm/integrations/rules.js +42 -42
- package/dist/esm/integrations/rules.test.js +62 -57
- package/dist/esm/internal/appMode.d.ts +14 -0
- package/dist/esm/internal/appMode.js +13 -0
- package/dist/esm/internal/env.js +3 -2
- package/dist/esm/internal/platformFetch.d.ts +2 -0
- package/dist/esm/internal/platformFetch.js +9 -0
- package/dist/esm/internal/reservedIds.d.ts +8 -0
- package/dist/esm/internal/reservedIds.js +10 -0
- package/dist/esm/internal/serviceUrls.d.ts +5 -0
- package/dist/esm/internal/serviceUrls.js +10 -0
- package/dist/esm/pdf/index.js +2 -1
- package/dist/esm/runtime/filterConditionTypes.test-d.js +12 -12
- package/dist/esm/runtime/index.d.ts +22 -22
- package/dist/esm/runtime/index.js +31 -31
- package/dist/esm/runtime/index.test.js +36 -36
- package/dist/esm/runtime/sendEmailParamsTypes.test-d.js +30 -30
- package/dist/esm/runtime/writeResultTypes.test-d.js +9 -9
- package/dist/esm/signin/conformance.d.ts +100 -0
- package/dist/esm/signin/conformance.js +616 -0
- package/dist/esm/signin/cookies.d.ts +28 -0
- package/dist/esm/signin/cookies.js +67 -0
- package/dist/esm/signin/encoding.d.ts +1 -0
- package/dist/esm/signin/encoding.js +12 -0
- package/dist/esm/signin/endpoints.d.ts +12 -0
- package/dist/esm/signin/endpoints.js +32 -0
- package/dist/esm/signin/http.d.ts +25 -0
- package/dist/esm/signin/http.js +106 -0
- package/dist/esm/signin/index.d.ts +8 -0
- package/dist/esm/signin/index.js +9 -0
- package/dist/esm/signin/keys.d.ts +35 -0
- package/dist/esm/signin/keys.js +230 -0
- package/dist/esm/signin/paths.d.ts +2 -0
- package/dist/esm/signin/paths.js +5 -0
- package/dist/esm/signin/seal.d.ts +19 -0
- package/dist/esm/signin/seal.js +47 -0
- package/dist/esm/signin/signin.d.ts +60 -0
- package/dist/esm/signin/signin.js +447 -0
- package/dist/esm/signin/transport.d.ts +112 -0
- package/dist/esm/signin/transport.js +1 -0
- package/dist/esm/signin/verifier.d.ts +2 -0
- package/dist/esm/signin/verifier.js +4 -0
- package/dist/esm/signin/verify.d.ts +83 -0
- package/dist/esm/signin/verify.js +142 -0
- package/dist/esm/sourceRoots.js +17 -17
- package/dist/esm/sourceRoots.test.js +34 -32
- package/dist/esm/start/access.d.ts +19 -0
- package/dist/esm/start/access.js +43 -0
- package/dist/esm/start/auth.d.ts +28 -0
- package/dist/esm/start/auth.js +33 -0
- package/dist/esm/start/automations/quiet.d.ts +2 -0
- package/dist/esm/start/automations/quiet.js +36 -0
- package/dist/esm/start/automations/registration.d.ts +13 -0
- package/dist/esm/start/automations/registration.js +25 -0
- package/dist/esm/start/automations/steps.d.ts +29 -0
- package/dist/esm/start/automations/steps.js +95 -0
- package/dist/esm/start/automations/workflow.d.ts +83 -0
- package/dist/esm/start/automations/workflow.js +36 -0
- package/dist/esm/start/automations/workflow.test-d.d.ts +1 -0
- package/dist/esm/start/automations/workflow.test-d.js +130 -0
- package/dist/esm/start/automations/workflowRun.d.ts +130 -0
- package/dist/esm/start/automations/workflowRun.js +185 -0
- package/dist/esm/start/barrel.test-d.d.ts +10 -0
- package/dist/esm/start/barrel.test-d.js +6 -0
- package/dist/esm/start/build/entries.d.ts +25 -0
- package/dist/esm/start/build/entries.js +109 -0
- package/dist/esm/start/build/placeholders/authHooksModule.d.ts +1 -0
- package/dist/esm/start/build/placeholders/authHooksModule.js +3 -0
- package/dist/esm/start/build/placeholders/devApp.d.ts +1 -0
- package/dist/esm/start/build/placeholders/devApp.js +3 -0
- package/dist/esm/start/build/placeholders/devSignIn.d.ts +1 -0
- package/dist/esm/start/build/placeholders/devSignIn.js +3 -0
- package/dist/esm/start/build/placeholders/siteHead.d.ts +2 -0
- package/dist/esm/start/build/placeholders/siteHead.js +3 -0
- package/dist/esm/start/build/placeholders/workflowModules.d.ts +1 -0
- package/dist/esm/start/build/placeholders/workflowModules.js +3 -0
- package/dist/esm/start/build/placeholders/workspaceSchema.d.ts +2 -0
- package/dist/esm/start/build/placeholders/workspaceSchema.js +3 -0
- package/dist/esm/start/build/registrationHash.d.ts +11 -0
- package/dist/esm/start/build/registrationHash.js +88 -0
- package/dist/esm/start/build/sdk/axios.d.ts +76 -0
- package/dist/esm/start/build/sdk/axios.js +253 -0
- package/dist/esm/start/build/sdk/nodeFetch.d.ts +41 -0
- package/dist/esm/start/build/sdk/nodeFetch.js +35 -0
- package/dist/esm/start/build/sdk/undici.d.ts +34 -0
- package/dist/esm/start/build/sdk/undici.js +18 -0
- package/dist/esm/start/build/sdkPatches.d.ts +22 -0
- package/dist/esm/start/build/sdkPatches.js +430 -0
- package/dist/esm/start/build/siteHead.d.ts +26 -0
- package/dist/esm/start/build/siteHead.js +88 -0
- package/dist/esm/start/build/vite.d.ts +50 -0
- package/dist/esm/start/build/vite.js +487 -0
- package/dist/esm/start/classicOnly.d.ts +1 -0
- package/dist/esm/start/classicOnly.js +4 -0
- package/dist/esm/start/clientErrorMessage.test.d.ts +1 -0
- package/dist/esm/start/clientErrorMessage.test.js +105 -0
- package/dist/esm/start/describe/describe.d.ts +120 -0
- package/dist/esm/start/describe/describe.js +372 -0
- package/dist/esm/start/describe/describeBuilt.d.ts +5 -0
- package/dist/esm/start/describe/describeBuilt.js +102 -0
- package/dist/esm/start/describe/descriptions.d.ts +4 -0
- package/dist/esm/start/describe/descriptions.js +54 -0
- package/dist/esm/start/errors.d.ts +62 -0
- package/dist/esm/start/errors.js +163 -0
- package/dist/esm/start/errors.test.d.ts +1 -0
- package/dist/esm/start/errors.test.js +54 -0
- package/dist/esm/start/factories.d.ts +14 -0
- package/dist/esm/start/factories.js +23 -0
- package/dist/esm/start/factories.test-d.d.ts +2 -0
- package/dist/esm/start/factories.test-d.js +60 -0
- package/dist/esm/start/failures.d.ts +7 -0
- package/dist/esm/start/failures.js +62 -0
- package/dist/esm/start/fnFactory.d.ts +16 -0
- package/dist/esm/start/fnFactory.js +1 -0
- package/dist/esm/start/host.d.ts +3 -0
- package/dist/esm/start/host.js +4 -0
- package/dist/esm/start/index.d.ts +10 -0
- package/dist/esm/start/index.js +7 -0
- package/dist/esm/start/login.d.ts +5 -0
- package/dist/esm/start/login.js +29 -0
- package/dist/esm/start/middlewareKind.d.ts +13 -0
- package/dist/esm/start/middlewareKind.js +9 -0
- package/dist/esm/start/platform/aiUsage.d.ts +29 -0
- package/dist/esm/start/platform/aiUsage.js +210 -0
- package/dist/esm/start/platform/airtable/arrayFields.d.ts +10 -0
- package/dist/esm/start/platform/airtable/arrayFields.js +30 -0
- package/dist/esm/start/platform/airtable/built.d.ts +2 -0
- package/dist/esm/start/platform/airtable/built.js +3 -0
- package/dist/esm/start/platform/airtable/cache.d.ts +17 -0
- package/dist/esm/start/platform/airtable/cache.js +89 -0
- package/dist/esm/start/platform/airtable/dispatch.d.ts +57 -0
- package/dist/esm/start/platform/airtable/dispatch.js +541 -0
- package/dist/esm/start/platform/airtable/formulas.d.ts +70 -0
- package/dist/esm/start/platform/airtable/formulas.js +261 -0
- package/dist/esm/start/platform/airtable/index.d.ts +6 -0
- package/dist/esm/start/platform/airtable/index.js +51 -0
- package/dist/esm/start/platform/airtable/settings.d.ts +37 -0
- package/dist/esm/start/platform/airtable/settings.js +138 -0
- package/dist/esm/start/platform/analytics.d.ts +3 -0
- package/dist/esm/start/platform/analytics.js +59 -0
- package/dist/esm/start/platform/calls.d.ts +5 -0
- package/dist/esm/start/platform/calls.js +104 -0
- package/dist/esm/start/platform/caps.d.ts +9 -0
- package/dist/esm/start/platform/caps.js +35 -0
- package/dist/esm/start/platform/connections.d.ts +25 -0
- package/dist/esm/start/platform/connections.js +198 -0
- package/dist/esm/start/platform/data/baseRunner.d.ts +97 -0
- package/dist/esm/start/platform/data/baseRunner.js +117 -0
- package/dist/esm/start/platform/data/dispatch.d.ts +17 -0
- package/dist/esm/start/platform/data/dispatch.js +216 -0
- package/dist/esm/start/platform/data/fetch.d.ts +7 -0
- package/dist/esm/start/platform/data/fetch.js +9 -0
- package/dist/esm/start/platform/data/index.d.ts +27 -0
- package/dist/esm/start/platform/data/index.js +75 -0
- package/dist/esm/start/platform/data/names.d.ts +7 -0
- package/dist/esm/start/platform/data/names.js +18 -0
- package/dist/esm/start/platform/data/sqlNameMappings.d.ts +58 -0
- package/dist/esm/start/platform/data/sqlNameMappings.js +92 -0
- package/dist/esm/start/platform/data/transformations.d.ts +97 -0
- package/dist/esm/start/platform/data/transformations.js +262 -0
- package/dist/esm/start/platform/data/types.d.ts +94 -0
- package/dist/esm/start/platform/data/types.js +14 -0
- package/dist/esm/start/platform/local.d.ts +6 -0
- package/dist/esm/start/platform/local.js +18 -0
- package/dist/esm/start/platform/meta.d.ts +3 -0
- package/dist/esm/start/platform/meta.js +33 -0
- package/dist/esm/start/platform/outbound.d.ts +17 -0
- package/dist/esm/start/platform/outbound.js +510 -0
- package/dist/esm/start/platform/redactSecrets.d.ts +13 -0
- package/dist/esm/start/platform/redactSecrets.js +156 -0
- package/dist/esm/start/platform/redactSecrets.test.d.ts +1 -0
- package/dist/esm/start/platform/redactSecrets.test.js +151 -0
- package/dist/esm/start/platform/requestSecrets.d.ts +15 -0
- package/dist/esm/start/platform/requestSecrets.js +41 -0
- package/dist/esm/start/platform/runLog.d.ts +40 -0
- package/dist/esm/start/platform/runLog.js +149 -0
- package/dist/esm/start/platform/services.d.ts +7 -0
- package/dist/esm/start/platform/services.js +46 -0
- package/dist/esm/start/platform/steps.d.ts +9 -0
- package/dist/esm/start/platform/steps.js +60 -0
- package/dist/esm/start/platform/telemetry.d.ts +13 -0
- package/dist/esm/start/platform/telemetry.js +71 -0
- package/dist/esm/start/platform/transport.d.ts +28 -0
- package/dist/esm/start/platform/transport.js +59 -0
- package/dist/esm/start/platformHead.d.ts +23 -0
- package/dist/esm/start/platformHead.js +133 -0
- package/dist/esm/start/previewClaim.d.ts +6 -0
- package/dist/esm/start/previewClaim.js +24 -0
- package/dist/esm/start/protocol.d.ts +19 -0
- package/dist/esm/start/protocol.js +27 -0
- package/dist/esm/start/roles.d.ts +12 -0
- package/dist/esm/start/roles.js +27 -0
- package/dist/esm/start/router.d.ts +44 -0
- package/dist/esm/start/router.js +280 -0
- package/dist/esm/start/serve/authHooks.d.ts +7 -0
- package/dist/esm/start/serve/authHooks.js +18 -0
- package/dist/esm/start/serve/demo.d.ts +9 -0
- package/dist/esm/start/serve/demo.js +24 -0
- package/dist/esm/start/serve/fetch.d.ts +1 -0
- package/dist/esm/start/serve/fetch.js +6 -0
- package/dist/esm/start/serve/instance.d.ts +12 -0
- package/dist/esm/start/serve/instance.js +134 -0
- package/dist/esm/start/serve/invoke.d.ts +13 -0
- package/dist/esm/start/serve/invoke.js +126 -0
- package/dist/esm/start/serve/local/load.d.ts +8 -0
- package/dist/esm/start/serve/local/load.js +44 -0
- package/dist/esm/start/serve/local/provider.d.ts +25 -0
- package/dist/esm/start/serve/local/provider.js +188 -0
- package/dist/esm/start/serve/local/signIn.d.ts +28 -0
- package/dist/esm/start/serve/local/signIn.js +123 -0
- package/dist/esm/start/serve/pageHead.d.ts +20 -0
- package/dist/esm/start/serve/pageHead.js +34 -0
- package/dist/esm/start/serve/provider.d.ts +19 -0
- package/dist/esm/start/serve/provider.js +78 -0
- package/dist/esm/start/serve/requestEnv.d.ts +2 -0
- package/dist/esm/start/serve/requestEnv.js +84 -0
- package/dist/esm/start/serve/scope.d.ts +18 -0
- package/dist/esm/start/serve/scope.js +67 -0
- package/dist/esm/start/serve/server.d.ts +56 -0
- package/dist/esm/start/serve/server.js +297 -0
- package/dist/esm/start/serve/uploads.d.ts +2 -0
- package/dist/esm/start/serve/uploads.js +49 -0
- package/dist/esm/start/serve/worker.d.ts +6 -0
- package/dist/esm/start/serve/worker.js +12 -0
- package/dist/esm/start/types.d.ts +373 -0
- package/dist/esm/start/types.js +1 -0
- package/dist/esm/start/version.d.ts +1 -0
- package/dist/esm/start/version.js +2 -0
- package/dist/esm/steps/index.d.ts +8 -8
- package/dist/esm/steps/index.js +54 -54
- package/dist/esm/steps/index.test.js +220 -220
- package/dist/esm/sync/index.d.ts +1 -1
- package/dist/esm/sync/index.js +32 -31
- package/dist/esm/sync/lib.d.ts +15 -8
- package/dist/esm/sync/lib.js +655 -669
- package/dist/esm/sync/lib.test.js +81 -14
- package/dist/esm/sync/sdkNames.d.ts +67 -9
- package/dist/esm/sync/sdkNames.js +94 -30
- package/dist/esm/sync/sdkNames.test.js +192 -116
- package/dist/esm/types/fields.d.ts +1 -1
- package/dist/esm/types/fields.js +106 -98
- package/dist/esm/types/index.d.ts +2 -2
- package/dist/esm/types/index.js +2 -2
- package/dist/esm/types/tables.d.ts +1 -1
- package/dist/esm/types/tables.js +2 -2
- package/dist/esm/upload/index.js +89 -24
- package/dist/esm/upload/index.test.js +104 -1
- package/dist/esm/vite/domTagNames.js +252 -252
- package/dist/esm/vite/index.d.ts +1 -1
- package/dist/esm/vite/index.js +56 -47
- package/dist/esm/vite/index.test.js +10 -2
- package/package.json +129 -16
- package/dist/cjs/auth-server/index.d.ts +0 -369
- package/dist/cjs/auth-server/index.js +0 -119
- package/dist/cjs/meta/index.d.ts +0 -14
- package/dist/cjs/meta/index.js +0 -12
- package/dist/cjs/notifications/index.d.ts +0 -25
- package/dist/cjs/notifications/index.js +0 -12
- package/dist/esm/auth-server/index.d.ts +0 -369
- package/dist/esm/auth-server/index.js +0 -116
- package/dist/esm/meta/index.d.ts +0 -14
- package/dist/esm/meta/index.js +0 -8
- package/dist/esm/notifications/index.d.ts +0 -25
- package/dist/esm/notifications/index.js +0 -8
package/dist/cjs/sync/lib.js
CHANGED
|
@@ -13,7 +13,6 @@ exports.generateIntegrationsIndex = generateIntegrationsIndex;
|
|
|
13
13
|
const parser_1 = require("@babel/parser");
|
|
14
14
|
const sdkNames_js_1 = require("./sdkNames.js");
|
|
15
15
|
const rules_js_1 = require("../integrations/rules.js");
|
|
16
|
-
const AUTH_USERS_TABLE_ID = "zite_user";
|
|
17
16
|
/**
|
|
18
17
|
* What a field's value looks like when a record is READ back.
|
|
19
18
|
*
|
|
@@ -44,65 +43,65 @@ const AUTH_USERS_TABLE_ID = "zite_user";
|
|
|
44
43
|
*/
|
|
45
44
|
const FIELD_TYPE_MAP = {
|
|
46
45
|
// Text: NULL is rewritten to '' on read, so these are never even absent.
|
|
47
|
-
single_line_text:
|
|
48
|
-
long_text:
|
|
49
|
-
rich_text:
|
|
50
|
-
email:
|
|
51
|
-
url:
|
|
52
|
-
phone_number:
|
|
53
|
-
number:
|
|
54
|
-
currency:
|
|
55
|
-
percent:
|
|
56
|
-
rating:
|
|
46
|
+
single_line_text: 'string',
|
|
47
|
+
long_text: 'string',
|
|
48
|
+
rich_text: 'string',
|
|
49
|
+
email: 'string',
|
|
50
|
+
url: 'string',
|
|
51
|
+
phone_number: 'string',
|
|
52
|
+
number: 'number',
|
|
53
|
+
currency: 'number',
|
|
54
|
+
percent: 'number',
|
|
55
|
+
rating: 'number',
|
|
57
56
|
// DECIMAL seconds, unlike Airtable's, which is formatted to "HH:mm:ss".
|
|
58
57
|
// 1.0 typed this `string`, which was simply wrong — base-runner groups it
|
|
59
58
|
// with the numeric types — so it stays a number rather than reverting.
|
|
60
|
-
duration:
|
|
61
|
-
checkbox:
|
|
62
|
-
single_select:
|
|
63
|
-
multiple_select:
|
|
64
|
-
date:
|
|
65
|
-
datetime:
|
|
66
|
-
attachments:
|
|
59
|
+
duration: 'number',
|
|
60
|
+
checkbox: 'boolean',
|
|
61
|
+
single_select: 'string',
|
|
62
|
+
multiple_select: 'string[]',
|
|
63
|
+
date: 'string',
|
|
64
|
+
datetime: 'string',
|
|
65
|
+
attachments: 'ZiteAttachment[]',
|
|
67
66
|
// `string | string[]`, matching the pre-monorepo type. base-runner does force
|
|
68
67
|
// an array on read today, but 1.0 code is written with `typeof x === 'string'`
|
|
69
68
|
// guards — narrowing to `string[]` turns those branches into `never` and
|
|
70
69
|
// fails the app's typecheck for no gain.
|
|
71
|
-
linked_record:
|
|
72
|
-
user:
|
|
70
|
+
linked_record: 'string | string[]',
|
|
71
|
+
user: 'string | string[]',
|
|
73
72
|
// `any`, not `unknown`, and deliberately: these are values the platform
|
|
74
73
|
// cannot type — a lookup is whatever the far side holds. 1.0 said `any`, and
|
|
75
74
|
// `unknown` buys nothing because there is no narrowing an app could have
|
|
76
75
|
// written in advance: `sum + (x || 0)` is a TS2365 on `unknown`, and the
|
|
77
76
|
// guarded spellings already narrowed fine under `any`.
|
|
78
|
-
lookup:
|
|
79
|
-
rollup:
|
|
80
|
-
autonumber:
|
|
77
|
+
lookup: 'any',
|
|
78
|
+
rollup: 'any',
|
|
79
|
+
autonumber: 'number',
|
|
81
80
|
// JSONB change metadata (`{ type: "PublicAPI", apiKeyId: 3 }`), not a string.
|
|
82
|
-
source:
|
|
83
|
-
formula:
|
|
84
|
-
created_at:
|
|
85
|
-
updated_at:
|
|
86
|
-
created_by:
|
|
87
|
-
updated_by:
|
|
81
|
+
source: 'any',
|
|
82
|
+
formula: 'any',
|
|
83
|
+
created_at: 'string',
|
|
84
|
+
updated_at: 'string',
|
|
85
|
+
created_by: 'string',
|
|
86
|
+
updated_by: 'string',
|
|
88
87
|
};
|
|
89
88
|
/**
|
|
90
89
|
* Field types whose WRITE shape differs from their read shape — the API accepts
|
|
91
90
|
* looser input than it stores.
|
|
92
91
|
*/
|
|
93
92
|
const FIELD_INPUT_TYPE_MAP = {
|
|
94
|
-
attachments:
|
|
95
|
-
linked_record:
|
|
96
|
-
user:
|
|
97
|
-
multiple_select:
|
|
98
|
-
date:
|
|
99
|
-
datetime:
|
|
100
|
-
number:
|
|
101
|
-
currency:
|
|
102
|
-
percent:
|
|
103
|
-
rating:
|
|
104
|
-
duration:
|
|
105
|
-
checkbox:
|
|
93
|
+
attachments: 'ZiteAttachmentInput[] | ZiteAttachmentInput',
|
|
94
|
+
linked_record: 'string | string[]',
|
|
95
|
+
user: 'string | string[]',
|
|
96
|
+
multiple_select: 'string | string[]',
|
|
97
|
+
date: 'string | Date',
|
|
98
|
+
datetime: 'string | Date',
|
|
99
|
+
number: 'string | number',
|
|
100
|
+
currency: 'string | number',
|
|
101
|
+
percent: 'string | number',
|
|
102
|
+
rating: 'string | number',
|
|
103
|
+
duration: 'string | number',
|
|
104
|
+
checkbox: 'string | boolean',
|
|
106
105
|
};
|
|
107
106
|
/**
|
|
108
107
|
* Computed and system-managed fields, omitted from the generated input type
|
|
@@ -116,15 +115,15 @@ const FIELD_INPUT_TYPE_MAP = {
|
|
|
116
115
|
* leave typed as writable.
|
|
117
116
|
*/
|
|
118
117
|
const READ_ONLY_FIELD_TYPES = new Set([
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
118
|
+
'lookup',
|
|
119
|
+
'rollup',
|
|
120
|
+
'source',
|
|
121
|
+
'formula',
|
|
122
|
+
'autonumber',
|
|
123
|
+
'created_by',
|
|
124
|
+
'updated_by',
|
|
125
|
+
'created_at',
|
|
126
|
+
'updated_at',
|
|
128
127
|
]);
|
|
129
128
|
/**
|
|
130
129
|
* Emitted once per `db.ts`. The old inline `{ url: string; name?: string }` was
|
|
@@ -132,28 +131,28 @@ const READ_ONLY_FIELD_TYPES = new Set([
|
|
|
132
131
|
* `filename` / `originalName`), and the other six read properties were missing.
|
|
133
132
|
*/
|
|
134
133
|
const ATTACHMENT_TYPES = [
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
134
|
+
'/** An attachment as returned when reading a record. */',
|
|
135
|
+
'export type ZiteAttachment = {',
|
|
136
|
+
' /** Original filename as uploaded. */',
|
|
137
|
+
' filename: string;',
|
|
138
|
+
' /** Display name — may differ from `filename`. */',
|
|
139
|
+
' originalName: string;',
|
|
140
|
+
' /** File size in bytes. */',
|
|
141
|
+
' size: number;',
|
|
142
|
+
' mimeType: string;',
|
|
143
|
+
' /** Publicly accessible URL. */',
|
|
144
|
+
' url: string;',
|
|
145
|
+
' /** ISO timestamp of the upload. */',
|
|
146
|
+
' uploadedAt: string;',
|
|
147
|
+
' metadata?: Record<string, unknown>;',
|
|
148
|
+
'};',
|
|
149
|
+
'',
|
|
150
|
+
'/** What you may write to an attachments field: a URL, a URL with a name, or an attachment you read earlier. */',
|
|
151
|
+
'export type ZiteAttachmentInput =',
|
|
152
|
+
' | string',
|
|
153
|
+
' | { url: string; filename?: string }',
|
|
154
|
+
' | ZiteAttachment;',
|
|
155
|
+
'',
|
|
157
156
|
];
|
|
158
157
|
const MAX_SELECT_OPTIONS = 100;
|
|
159
158
|
/**
|
|
@@ -180,30 +179,30 @@ const tsSingleQuoted = (value) => `'${JSON.stringify(value).slice(1, -1).replace
|
|
|
180
179
|
* Applied where the comment is written rather than at each contributor, so
|
|
181
180
|
* anything added to one later is covered by default.
|
|
182
181
|
*/
|
|
183
|
-
const commentSafe = (value) => value.replace(/\*\//g,
|
|
182
|
+
const commentSafe = (value) => value.replace(/\*\//g, '* /').replace(/\s+/g, ' ').trim();
|
|
184
183
|
const NUMBER_FORMAT_EXAMPLES = {
|
|
185
|
-
local:
|
|
186
|
-
comma_period:
|
|
187
|
-
period_comma:
|
|
188
|
-
space_comma:
|
|
189
|
-
space_period:
|
|
190
|
-
no_separator:
|
|
184
|
+
local: '1,000,000.50',
|
|
185
|
+
comma_period: '1,000,000.50',
|
|
186
|
+
period_comma: '1.000.000,50',
|
|
187
|
+
space_comma: '1 000 000,50',
|
|
188
|
+
space_period: '1 000 000.50',
|
|
189
|
+
no_separator: '1000000.50',
|
|
191
190
|
};
|
|
192
191
|
const DURATION_FORMAT_EXAMPLES = {
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
192
|
+
'h:mm': '1:23',
|
|
193
|
+
'h:mm:ss': '1:23:03',
|
|
194
|
+
'h:mm:ss.s': '1:23:03.0',
|
|
195
|
+
'h:mm:ss.ss': '1:23:03.00',
|
|
196
|
+
'h:mm:ss.sss': '1:23:03.000',
|
|
198
197
|
};
|
|
199
198
|
// Naming the format alone ("display as `european` format") doesn't say what to
|
|
200
199
|
// render — these mirror the pickers in the database UI, which is what the user
|
|
201
200
|
// chose from. `local` is the viewer's system locale, so it has no fixed example.
|
|
202
201
|
const DATE_FORMAT_EXAMPLES = {
|
|
203
|
-
long:
|
|
204
|
-
us:
|
|
205
|
-
european:
|
|
206
|
-
iso:
|
|
202
|
+
long: 'January 15, 2024',
|
|
203
|
+
us: '1/15/2024',
|
|
204
|
+
european: '15/01/2024',
|
|
205
|
+
iso: '2024-01-15',
|
|
207
206
|
};
|
|
208
207
|
const withDateFormatExample = (format) => {
|
|
209
208
|
const example = DATE_FORMAT_EXAMPLES[format];
|
|
@@ -223,29 +222,29 @@ Object.defineProperty(exports, "toSdkName", { enumerable: true, get: function ()
|
|
|
223
222
|
* `allowExplicitNull`. A write type without it makes the documented way to
|
|
224
223
|
* empty a field a compile error.
|
|
225
224
|
*/
|
|
226
|
-
const withNull = (type) => type.includes(
|
|
227
|
-
function tsTypeForSchemaField(def, variant =
|
|
228
|
-
if (def.type ===
|
|
225
|
+
const withNull = (type) => type.includes('null') ? type : `${type} | null`;
|
|
226
|
+
function tsTypeForSchemaField(def, variant = 'read') {
|
|
227
|
+
if (def.type === 'single_select' || def.type === 'multiple_select') {
|
|
229
228
|
const options = def.template
|
|
230
229
|
?.options;
|
|
231
230
|
if (options && options.length > 0) {
|
|
232
231
|
const literals = options
|
|
233
232
|
.slice(0, MAX_SELECT_OPTIONS)
|
|
234
|
-
.map(
|
|
235
|
-
.join(
|
|
233
|
+
.map(o => tsStringLiteral(o.label))
|
|
234
|
+
.join(' | ');
|
|
236
235
|
const union = `${literals} | string`;
|
|
237
236
|
// No `| null` on the read side — see FIELD_TYPE_MAP. The write side keeps
|
|
238
237
|
// it below, since null is how a select cell is cleared.
|
|
239
|
-
const read = def.type ===
|
|
240
|
-
if (variant ===
|
|
241
|
-
return def.type ===
|
|
238
|
+
const read = def.type === 'multiple_select' ? `(${union})[]` : union;
|
|
239
|
+
if (variant === 'write') {
|
|
240
|
+
return def.type === 'multiple_select'
|
|
242
241
|
? `${union} | (${union})[] | null`
|
|
243
242
|
: `${union} | null`;
|
|
244
243
|
}
|
|
245
244
|
return read;
|
|
246
245
|
}
|
|
247
246
|
}
|
|
248
|
-
if (variant ===
|
|
247
|
+
if (variant === 'write') {
|
|
249
248
|
const write = FIELD_INPUT_TYPE_MAP[def.type] ?? FIELD_TYPE_MAP[def.type];
|
|
250
249
|
if (write)
|
|
251
250
|
return withNull(write);
|
|
@@ -255,43 +254,38 @@ function tsTypeForSchemaField(def, variant = "read") {
|
|
|
255
254
|
// Not `string`. A field type this generator doesn't know about is not a
|
|
256
255
|
// string just because most of them are — asserting one lets `record.value`
|
|
257
256
|
// silently pass as `string` everywhere it flows.
|
|
258
|
-
return
|
|
257
|
+
return 'unknown';
|
|
259
258
|
}
|
|
260
259
|
function fieldJsdoc(schemaField, table, schema) {
|
|
261
260
|
const def = schemaField.definition;
|
|
262
261
|
const parts = [];
|
|
263
262
|
if (table.primaryFieldId === schemaField.id)
|
|
264
|
-
parts.push(
|
|
265
|
-
if (def.type
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
def.type === "formula" ||
|
|
269
|
-
def.type === "autonumber") {
|
|
270
|
-
parts.push("Read-only");
|
|
271
|
-
}
|
|
272
|
-
if (def.type === "linked_record") {
|
|
263
|
+
parts.push('Primary field');
|
|
264
|
+
if (READ_ONLY_FIELD_TYPES.has(def.type))
|
|
265
|
+
parts.push('Read-only');
|
|
266
|
+
if (def.type === 'linked_record') {
|
|
273
267
|
const tpl = def.template;
|
|
274
268
|
if (tpl.tableId) {
|
|
275
269
|
// The SDK name, not the raw `tbl...` id — the id appears nowhere the
|
|
276
270
|
// reader can act on, while the SDK name is the property on `zite`. Its
|
|
277
271
|
// display name rides along, since after a rename the two differ.
|
|
278
|
-
const linked = schema?.tables.find(
|
|
272
|
+
const linked = schema?.tables.find(t => t.id === tpl.tableId);
|
|
279
273
|
parts.push(linked
|
|
280
|
-
? `Links to ${linked.sdkName}${linked.name ? ` ("${linked.name}")` :
|
|
274
|
+
? `Links to ${linked.sdkName}${linked.name ? ` ("${linked.name}")` : ''}`
|
|
281
275
|
: `Links to ${tpl.tableId}`);
|
|
282
276
|
}
|
|
283
277
|
if (tpl.allowMultiple === false)
|
|
284
|
-
parts.push(
|
|
278
|
+
parts.push('Single record only');
|
|
285
279
|
}
|
|
286
280
|
parts.push(`"${def.name}"`);
|
|
287
|
-
if (def.type ===
|
|
281
|
+
if (def.type === 'date') {
|
|
288
282
|
const tpl = def.template;
|
|
289
283
|
if (tpl.dateFormat)
|
|
290
284
|
parts.push(`Date-only field (YYYY-MM-DD string), null when unset, display as ${withDateFormatExample(tpl.dateFormat)}`);
|
|
291
285
|
}
|
|
292
|
-
if (def.type ===
|
|
286
|
+
if (def.type === 'datetime') {
|
|
293
287
|
const tpl = def.template;
|
|
294
|
-
const timeParts = [
|
|
288
|
+
const timeParts = ['Date+time field (ISO 8601 timestamp), null when unset'];
|
|
295
289
|
if (tpl.dateFormat)
|
|
296
290
|
timeParts.push(`date: ${withDateFormatExample(tpl.dateFormat)}`);
|
|
297
291
|
if (tpl.timeFormat)
|
|
@@ -299,45 +293,45 @@ function fieldJsdoc(schemaField, table, schema) {
|
|
|
299
293
|
if (tpl.timezone)
|
|
300
294
|
timeParts.push(`tz: ${tpl.timezone}`);
|
|
301
295
|
if (tpl.displayTimeZone)
|
|
302
|
-
timeParts.push(
|
|
303
|
-
parts.push(timeParts.join(
|
|
296
|
+
timeParts.push('timezone displayed to user');
|
|
297
|
+
parts.push(timeParts.join(', '));
|
|
304
298
|
}
|
|
305
|
-
if (def.type ===
|
|
299
|
+
if (def.type === 'currency') {
|
|
306
300
|
const tpl = def.template;
|
|
307
301
|
if (tpl.currencySymbol) {
|
|
308
|
-
const formatHint = NUMBER_FORMAT_EXAMPLES[tpl.numberFormat ??
|
|
309
|
-
parts.push(`Value is a raw number; display as currency with symbol "${tpl.currencySymbol}", ${tpl.decimalPlaces ?? 2} decimal places, format: ${tpl.numberFormat ??
|
|
302
|
+
const formatHint = NUMBER_FORMAT_EXAMPLES[tpl.numberFormat ?? 'local'] ?? '';
|
|
303
|
+
parts.push(`Value is a raw number; display as currency with symbol "${tpl.currencySymbol}", ${tpl.decimalPlaces ?? 2} decimal places, format: ${tpl.numberFormat ?? 'local'} (e.g. ${formatHint})`);
|
|
310
304
|
}
|
|
311
305
|
}
|
|
312
|
-
if (def.type ===
|
|
306
|
+
if (def.type === 'number') {
|
|
313
307
|
const tpl = def.template;
|
|
314
|
-
const formatHint = NUMBER_FORMAT_EXAMPLES[tpl.numberFormat ??
|
|
315
|
-
parts.push(`${tpl.decimalPlaces ?? 0} decimal places, format: ${tpl.numberFormat ??
|
|
308
|
+
const formatHint = NUMBER_FORMAT_EXAMPLES[tpl.numberFormat ?? 'local'] ?? '';
|
|
309
|
+
parts.push(`${tpl.decimalPlaces ?? 0} decimal places, format: ${tpl.numberFormat ?? 'local'} (e.g. ${formatHint})`);
|
|
316
310
|
}
|
|
317
|
-
if (def.type ===
|
|
311
|
+
if (def.type === 'percent') {
|
|
318
312
|
const tpl = def.template;
|
|
319
313
|
if (tpl.decimalPlaces !== undefined)
|
|
320
314
|
parts.push(`${tpl.decimalPlaces} decimal places`);
|
|
321
315
|
}
|
|
322
|
-
if (def.type ===
|
|
316
|
+
if (def.type === 'duration') {
|
|
323
317
|
const tpl = def.template;
|
|
324
318
|
if (tpl.format) {
|
|
325
|
-
const example = DURATION_FORMAT_EXAMPLES[tpl.format] ??
|
|
319
|
+
const example = DURATION_FORMAT_EXAMPLES[tpl.format] ?? '';
|
|
326
320
|
parts.push(`Value is in seconds; display in "${tpl.format}" format (${example})`);
|
|
327
321
|
}
|
|
328
322
|
}
|
|
329
|
-
if (def.type ===
|
|
323
|
+
if (def.type === 'rating') {
|
|
330
324
|
const tpl = def.template;
|
|
331
325
|
if (tpl.maxRating)
|
|
332
326
|
parts.push(`Max rating: ${tpl.maxRating}`);
|
|
333
327
|
}
|
|
334
|
-
if (def.type ===
|
|
335
|
-
parts.push(
|
|
328
|
+
if (def.type === 'created_at') {
|
|
329
|
+
parts.push('Auto-set when record was created (ISO 8601)');
|
|
336
330
|
}
|
|
337
|
-
if (def.type ===
|
|
338
|
-
parts.push(
|
|
331
|
+
if (def.type === 'updated_at') {
|
|
332
|
+
parts.push('Auto-set when record was last modified (ISO 8601)');
|
|
339
333
|
}
|
|
340
|
-
if ((def.type ===
|
|
334
|
+
if ((def.type === 'single_select' || def.type === 'multiple_select') &&
|
|
341
335
|
def.template?.options) {
|
|
342
336
|
const count = (def.template.options ?? [])
|
|
343
337
|
.length;
|
|
@@ -347,7 +341,7 @@ function fieldJsdoc(schemaField, table, schema) {
|
|
|
347
341
|
}
|
|
348
342
|
if (parts.length <= 1)
|
|
349
343
|
return undefined;
|
|
350
|
-
return parts.join(
|
|
344
|
+
return parts.join('. ');
|
|
351
345
|
}
|
|
352
346
|
/**
|
|
353
347
|
* Build a ZiteSchema from a Database API response.
|
|
@@ -358,75 +352,49 @@ function fieldJsdoc(schemaField, table, schema) {
|
|
|
358
352
|
* name stability across schema changes.
|
|
359
353
|
*/
|
|
360
354
|
function generateSchema(database, existingSchema) {
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
const existingTable = existingTableById.get(table.id);
|
|
370
|
-
const existingFieldById = new Map();
|
|
371
|
-
for (const f of existingTable?.fields ?? []) {
|
|
372
|
-
existingFieldById.set(f.id, f);
|
|
355
|
+
// A name from the existing schema is locked: it is what the app is compiling
|
|
356
|
+
// against, and only moves if it is reserved or collides.
|
|
357
|
+
const { names, renames } = (0, sdkNames_js_1.allocateLiveNames)(database.tables, existingSchema);
|
|
358
|
+
if (renames.length > 0) {
|
|
359
|
+
// Never silent: a rename means the accessor a developer would reach for is
|
|
360
|
+
// not the one that got emitted.
|
|
361
|
+
for (const line of (0, sdkNames_js_1.describeRenames)(renames)) {
|
|
362
|
+
console.warn(`[zitejs] SDK name collision resolved: ${line}`);
|
|
373
363
|
}
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
const
|
|
380
|
-
const { id: _id, order: _order, ...definition } = field;
|
|
364
|
+
}
|
|
365
|
+
const liveTables = new Map(database.tables.map(table => [table.id, table]));
|
|
366
|
+
return {
|
|
367
|
+
tables: names.tables.map(named => {
|
|
368
|
+
const table = liveTables.get(named.id);
|
|
369
|
+
const liveFields = new Map(table.fields.map(field => [field.id, field]));
|
|
381
370
|
return {
|
|
382
|
-
field: { id: field.id, sdkName: "", definition },
|
|
383
|
-
draft: {
|
|
384
|
-
preferred: existing ?? (0, sdkNames_js_1.toSdkName)(field.name),
|
|
385
|
-
locked: existing !== undefined,
|
|
386
|
-
},
|
|
387
|
-
};
|
|
388
|
-
});
|
|
389
|
-
const existingName = (0, sdkNames_js_1.keepValidSdkName)(existingTable?.sdkName);
|
|
390
|
-
drafts.push({
|
|
391
|
-
table: {
|
|
392
371
|
id: table.id,
|
|
393
|
-
sdkName:
|
|
372
|
+
sdkName: named.sdkName,
|
|
394
373
|
// Always the live name — never `existingTable?.name`. Locking it the way
|
|
395
374
|
// `sdkName` is locked would freeze it at the first name the table ever
|
|
396
375
|
// had, which is the one thing this is here to avoid.
|
|
397
376
|
name: table.name,
|
|
398
377
|
primaryFieldId: table.primaryFieldId,
|
|
399
|
-
fields:
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
});
|
|
407
|
-
}
|
|
408
|
-
const { tables, renames } = (0, sdkNames_js_1.allocateSchemaNames)(drafts);
|
|
409
|
-
if (renames.length > 0) {
|
|
410
|
-
// Never silent: a rename means the accessor a developer would reach for is
|
|
411
|
-
// not the one that got emitted.
|
|
412
|
-
for (const line of (0, sdkNames_js_1.describeRenames)(renames)) {
|
|
413
|
-
console.warn(`[zitejs] SDK name collision resolved: ${line}`);
|
|
414
|
-
}
|
|
415
|
-
}
|
|
416
|
-
return { tables };
|
|
378
|
+
fields: named.fields.map(namedField => {
|
|
379
|
+
const { id, order: _order, ...definition } = liveFields.get(namedField.id);
|
|
380
|
+
return { id, sdkName: namedField.sdkName, definition };
|
|
381
|
+
}),
|
|
382
|
+
};
|
|
383
|
+
}),
|
|
384
|
+
};
|
|
417
385
|
}
|
|
418
386
|
function generateSentinelSdkTypes() {
|
|
419
387
|
return [
|
|
420
388
|
// Must match `AuthUser` in zitejs/runtime and `User` in zitejs/auth.
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
389
|
+
'export interface ZiteAuthUser {',
|
|
390
|
+
' id: string;',
|
|
391
|
+
' name: string;',
|
|
392
|
+
' email: string;',
|
|
393
|
+
' firstName?: string;',
|
|
394
|
+
' lastName?: string;',
|
|
395
|
+
' image: string | null;',
|
|
396
|
+
'}',
|
|
397
|
+
'',
|
|
430
398
|
];
|
|
431
399
|
}
|
|
432
400
|
function buildLinkTableComments(schema) {
|
|
@@ -444,7 +412,7 @@ function buildLinkTableComments(schema) {
|
|
|
444
412
|
const entries = [];
|
|
445
413
|
for (const table of schema.tables) {
|
|
446
414
|
for (const field of table.fields) {
|
|
447
|
-
if (field.definition.type !==
|
|
415
|
+
if (field.definition.type !== 'linked_record')
|
|
448
416
|
continue;
|
|
449
417
|
const tpl = field.definition.template;
|
|
450
418
|
if (tpl.isInverse)
|
|
@@ -483,12 +451,12 @@ function buildLinkTableComments(schema) {
|
|
|
483
451
|
if (entries.length === 0)
|
|
484
452
|
return [];
|
|
485
453
|
const lines = [
|
|
486
|
-
|
|
487
|
-
|
|
454
|
+
'//',
|
|
455
|
+
'// Link tables for zite.sql() JOINs (use these exact names):',
|
|
488
456
|
];
|
|
489
457
|
for (const e of entries) {
|
|
490
458
|
lines.push(`// "${commentSafe(e.name)}" — columns: "${commentSafe(e.cols[0])}", "${commentSafe(e.cols[1])}"` +
|
|
491
|
-
(e.gloss ? ` (${commentSafe(e.gloss)})` :
|
|
459
|
+
(e.gloss ? ` (${commentSafe(e.gloss)})` : ''));
|
|
492
460
|
}
|
|
493
461
|
return lines;
|
|
494
462
|
}
|
|
@@ -496,7 +464,12 @@ function buildLinkTableComments(schema) {
|
|
|
496
464
|
* Generate .zite/db.ts purely from ZiteSchema.
|
|
497
465
|
* Pure function — no external data needed beyond what's in the schema file.
|
|
498
466
|
*/
|
|
499
|
-
|
|
467
|
+
/**
|
|
468
|
+
* `hasStartApps` rewords the usage notes for a workspace where the code using
|
|
469
|
+
* the client isn't only classic endpoints. A classic-only workspace keeps the
|
|
470
|
+
* old wording, so its committed db.ts doesn't change.
|
|
471
|
+
*/
|
|
472
|
+
function generateDbTs(inputSchema, { hasStartApps = false } = {}) {
|
|
500
473
|
const lines = [];
|
|
501
474
|
// Defensive, and idempotent: a schema whose names are already unique and
|
|
502
475
|
// unreserved normalizes to itself. It matters for a `zite.schema.json`
|
|
@@ -510,68 +483,77 @@ function generateDbTs(inputSchema) {
|
|
|
510
483
|
console.warn(`[zitejs] Repaired SDK name in zite.schema.json: ${line}`);
|
|
511
484
|
}
|
|
512
485
|
}
|
|
513
|
-
const tables = schema.tables.filter(
|
|
514
|
-
lines.push(
|
|
515
|
-
lines.push(
|
|
516
|
-
|
|
486
|
+
const tables = schema.tables.filter(table => table.id !== sdkNames_js_1.AUTH_USERS_TABLE_ID);
|
|
487
|
+
lines.push('// Auto-generated by zitejs generate. Do not edit manually.');
|
|
488
|
+
lines.push('//');
|
|
489
|
+
if (hasStartApps) {
|
|
490
|
+
lines.push("// Usage in server code: a classic app's endpoints (src/api/*.ts), or a Start");
|
|
491
|
+
lines.push("// app's server functions and *.server.ts files:");
|
|
492
|
+
}
|
|
493
|
+
else {
|
|
494
|
+
lines.push('// Usage in endpoint files (src/api/*.ts):');
|
|
495
|
+
}
|
|
517
496
|
lines.push('// import { zite } from "zitejs/db";');
|
|
518
|
-
lines.push(
|
|
497
|
+
lines.push('//');
|
|
519
498
|
lines.push('// Always use "zitejs/db" — never use relative paths like "../../.zite/db".');
|
|
520
|
-
lines.push(
|
|
521
|
-
lines.push(
|
|
522
|
-
lines.push(
|
|
523
|
-
lines.push(
|
|
524
|
-
lines.push(
|
|
525
|
-
lines.push(
|
|
526
|
-
lines.push('// `not: null` means "is set". An empty `in: []` matches nothing; an',
|
|
499
|
+
lines.push('// The tsconfig aliases resolve zitejs/* imports to the correct .zite/ files.');
|
|
500
|
+
lines.push('//');
|
|
501
|
+
lines.push('// Table client methods (all take a single params object):');
|
|
502
|
+
lines.push('// .findAll({ filters?, sort?, offset?, limit?, fields? }) → { records: T[], hasMore: boolean }');
|
|
503
|
+
lines.push('// filters: { fieldName: value } for equality, or { fieldName: { <op>: value } }');
|
|
504
|
+
lines.push('// operators: contains, not, in, notIn, lt, lte, gt, gte');
|
|
505
|
+
lines.push('// `not: null` means "is set". An empty `in: []` matches nothing; an', '// empty `notIn: []` applies no filter.');
|
|
527
506
|
lines.push('// sort: [{ field: "fieldName", direction: "asc" | "desc" }]');
|
|
528
|
-
lines.push(
|
|
529
|
-
lines.push("// a filter value of `undefined`
|
|
530
|
-
lines.push(
|
|
531
|
-
lines.push(
|
|
532
|
-
lines.push(
|
|
533
|
-
lines.push(
|
|
534
|
-
lines.push(
|
|
535
|
-
lines.push(
|
|
536
|
-
lines.push(
|
|
537
|
-
lines.push(
|
|
538
|
-
lines.push(
|
|
507
|
+
lines.push('// limit defaults to 500, max 2000; offset is a row count (a number)');
|
|
508
|
+
lines.push("// a filter value of `undefined` drops that filter and reads as if it weren't", '// there. Check the value first: `{ owner: user?.id }` signed out reads every row.');
|
|
509
|
+
lines.push('// .findOne({ id?, filters?, fields? }) → T | undefined');
|
|
510
|
+
lines.push('// a filter value of `undefined`, or an `undefined` id with no filters, matches', '// no record and returns undefined');
|
|
511
|
+
lines.push('// .create({ record }) → T');
|
|
512
|
+
lines.push('// .update({ id, record }) → { id: string, fields: Partial<T> }');
|
|
513
|
+
lines.push('// .delete({ id }) → { success: true, id: string }');
|
|
514
|
+
lines.push('// .bulkCreate({ records, matchOn? }) → { success: boolean, records: T[] }');
|
|
515
|
+
lines.push('// up to 100 records per call; matchOn upserts on those fields');
|
|
516
|
+
lines.push('//');
|
|
517
|
+
lines.push('// Reading these types:');
|
|
518
|
+
lines.push('// SDK names are stable identifiers — they do NOT change when a table or field is');
|
|
539
519
|
lines.push('// renamed. Each carries its current user-facing name in quotes (// "Task Name").');
|
|
540
|
-
lines.push(
|
|
541
|
-
lines.push(
|
|
542
|
-
lines.push(
|
|
520
|
+
lines.push('// Where the two differ the field was renamed, and the quoted name is what it means');
|
|
521
|
+
lines.push('// now — treat it as the source of truth.');
|
|
522
|
+
lines.push('// Values are RAW: dates are ISO strings, durations are seconds. Format them for');
|
|
543
523
|
lines.push("// display yourself, following the display config in each field's comment.");
|
|
544
|
-
lines.push(
|
|
545
|
-
lines.push(
|
|
546
|
-
lines.push(
|
|
547
|
-
lines.push(
|
|
548
|
-
lines.push(
|
|
549
|
-
lines.push(
|
|
550
|
-
lines.push(
|
|
551
|
-
lines.push(
|
|
552
|
-
lines.push(
|
|
553
|
-
lines.push(
|
|
554
|
-
lines.push(
|
|
555
|
-
lines.push(
|
|
556
|
-
lines.push(
|
|
557
|
-
lines.push(
|
|
524
|
+
lines.push('// PERCENT fields are stored as decimals — 0.5 is 50%, 1.0 is 100%.');
|
|
525
|
+
lines.push('// LINKED RECORD fields hold UUID record ids from findOne/findAll — never invent one.');
|
|
526
|
+
lines.push('// Computed and system-managed fields (formula, rollup, lookup, autonumber,');
|
|
527
|
+
lines.push('// created/updated timestamps and more) are absent from the *Input types —');
|
|
528
|
+
lines.push('// a write to one is rejected or silently dropped.');
|
|
529
|
+
lines.push('//');
|
|
530
|
+
lines.push('// Zite auth users:');
|
|
531
|
+
lines.push('// zite.auth.findAllUsers({ appIds?, filter?, filters?, sort?, limit?, offset? })');
|
|
532
|
+
lines.push('// Supports the same filter, sort, and pagination options as table .findAll()');
|
|
533
|
+
lines.push('// appIds restricts results to users belonging to any listed app');
|
|
534
|
+
lines.push('// zite.auth.updateUserProfile(userId, { firstName?, lastName?, image? })');
|
|
535
|
+
lines.push('// User email addresses cannot be updated through this API');
|
|
536
|
+
lines.push('//');
|
|
537
|
+
lines.push('// Raw SQL (read-only SELECTs for aggregates, joins, multi-table queries):');
|
|
558
538
|
lines.push('// zite.sql({ query: "SELECT ...", params?: [...] })');
|
|
559
|
-
lines.push(
|
|
560
|
-
lines.push(
|
|
561
|
-
lines.push(
|
|
562
|
-
lines.push(
|
|
563
|
-
lines.push(
|
|
564
|
-
lines.push(
|
|
565
|
-
lines.push(
|
|
539
|
+
lines.push('// → { rows: Record<string, unknown>[], columns, rowCount, truncated }');
|
|
540
|
+
lines.push('// Capped at 2000 rows — `truncated: true` means there were more, so paginate in');
|
|
541
|
+
lines.push('// SQL rather than assuming you got everything. Queries time out after 10s.');
|
|
542
|
+
lines.push('// columns[].name is the SDK name; columns[].originalName is the underlying', '// database column (or your own SQL alias).');
|
|
543
|
+
lines.push('//');
|
|
544
|
+
lines.push('// SQL guidelines:');
|
|
545
|
+
lines.push('// - Use SDK names for tables (PascalCase) and fields (camelCase)');
|
|
566
546
|
lines.push('// - ALWAYS double-quote every identifier: FROM "Orders", WHERE "status" = $1');
|
|
567
|
-
lines.push(
|
|
547
|
+
lines.push('// - Use params array for user input ($1, $2, ...): never interpolate into SQL');
|
|
568
548
|
lines.push('// - Auth users are available as "ziteUsers" with id, name, email, firstName, lastName, and image');
|
|
569
|
-
lines.push(
|
|
570
|
-
lines.push(
|
|
571
|
-
lines.push(
|
|
549
|
+
lines.push('// - Soft-deleted rows are excluded automatically — no WHERE deleted_at IS NULL');
|
|
550
|
+
lines.push('// - SELECT only — use .create/.update/.delete for writes');
|
|
551
|
+
lines.push(hasStartApps
|
|
552
|
+
? '// - In the Zite editor, the "zite:sql" skill is the full SQL reference (formulas, lookups, etc.)'
|
|
553
|
+
: '// - Load the "zite:sql" skill for full SQL reference (formulas, lookups, etc.)');
|
|
572
554
|
lines.push(...buildLinkTableComments(schema));
|
|
573
555
|
lines.push("import { createTableClient, createSqlClient, createAuthClient } from 'zitejs/runtime';");
|
|
574
|
-
lines.push(
|
|
556
|
+
lines.push('');
|
|
575
557
|
lines.push(...ATTACHMENT_TYPES);
|
|
576
558
|
for (const table of tables) {
|
|
577
559
|
const className = (0, sdkNames_js_1.toPascalCase)(table.sdkName);
|
|
@@ -583,9 +565,9 @@ function generateDbTs(inputSchema) {
|
|
|
583
565
|
? `/** A record in the "${commentSafe(table.name)}" table, as it is read back. */`
|
|
584
566
|
: `/** A ${table.sdkName} record as it is read back. */`);
|
|
585
567
|
lines.push(`export type ${recordType} = {`);
|
|
586
|
-
lines.push(
|
|
568
|
+
lines.push(' id: string;');
|
|
587
569
|
for (const field of table.fields) {
|
|
588
|
-
if (field.sdkName ===
|
|
570
|
+
if (field.sdkName === 'id')
|
|
589
571
|
continue;
|
|
590
572
|
const tsType = tsTypeForSchemaField(field.definition);
|
|
591
573
|
const jsdoc = fieldJsdoc(field, table, schema);
|
|
@@ -598,35 +580,35 @@ function generateDbTs(inputSchema) {
|
|
|
598
580
|
// be absent on a read.
|
|
599
581
|
lines.push(` ${field.sdkName}?: ${tsType};`);
|
|
600
582
|
}
|
|
601
|
-
lines.push(
|
|
602
|
-
lines.push(
|
|
583
|
+
lines.push('};');
|
|
584
|
+
lines.push('');
|
|
603
585
|
// The write shape is a separate type, not `Partial<RecordType>`: computed
|
|
604
586
|
// fields can't be written at all, and several field types accept looser
|
|
605
587
|
// input than they store (an attachments field takes a URL string; a linked
|
|
606
588
|
// record takes one id or many).
|
|
607
|
-
const writableFields = table.fields.filter(
|
|
589
|
+
const writableFields = table.fields.filter(f => f.sdkName !== 'id' && !READ_ONLY_FIELD_TYPES.has(f.definition.type));
|
|
608
590
|
lines.push(table.name
|
|
609
591
|
? `/** What you may write when creating or updating a record in the "${commentSafe(table.name)}" table. */`
|
|
610
592
|
: `/** What you may write when creating or updating a ${table.sdkName}. */`);
|
|
611
593
|
lines.push(`export type ${className}RecordInput = {`);
|
|
612
594
|
for (const field of writableFields) {
|
|
613
|
-
lines.push(` ${field.sdkName}: ${tsTypeForSchemaField(field.definition,
|
|
595
|
+
lines.push(` ${field.sdkName}: ${tsTypeForSchemaField(field.definition, 'write')};`);
|
|
614
596
|
}
|
|
615
|
-
lines.push(
|
|
616
|
-
lines.push(
|
|
597
|
+
lines.push('};');
|
|
598
|
+
lines.push('');
|
|
617
599
|
}
|
|
618
600
|
lines.push(...generateSentinelSdkTypes());
|
|
619
|
-
lines.push(
|
|
601
|
+
lines.push('export const zite = {');
|
|
620
602
|
for (const table of tables) {
|
|
621
603
|
const className = (0, sdkNames_js_1.toPascalCase)(table.sdkName);
|
|
622
604
|
lines.push(` ${table.sdkName}: createTableClient<${className}RecordType, ${className}RecordInput>('${className}'),` +
|
|
623
|
-
(table.name ? ` // "${commentSafe(table.name)}"` :
|
|
605
|
+
(table.name ? ` // "${commentSafe(table.name)}"` : ''));
|
|
624
606
|
}
|
|
625
607
|
lines.push(` sql: createSqlClient(),`);
|
|
626
608
|
lines.push(` auth: createAuthClient<ZiteAuthUser>(),`);
|
|
627
|
-
lines.push(
|
|
628
|
-
lines.push(
|
|
629
|
-
return lines.join(
|
|
609
|
+
lines.push('};');
|
|
610
|
+
lines.push('');
|
|
611
|
+
return lines.join('\n');
|
|
630
612
|
}
|
|
631
613
|
const NOT_AN_ENDPOINT = {
|
|
632
614
|
isEndpoint: false,
|
|
@@ -635,23 +617,23 @@ const NOT_AN_ENDPOINT = {
|
|
|
635
617
|
};
|
|
636
618
|
/** `createEndpoint(...)` anywhere in the expression, through wrappers. */
|
|
637
619
|
function callsCreateEndpoint(node) {
|
|
638
|
-
if (!node || typeof node !==
|
|
620
|
+
if (!node || typeof node !== 'object')
|
|
639
621
|
return false;
|
|
640
622
|
const n = node;
|
|
641
|
-
if (n.type ===
|
|
623
|
+
if (n.type === 'CallExpression' &&
|
|
642
624
|
n.callee?.name ===
|
|
643
|
-
|
|
625
|
+
'createEndpoint') {
|
|
644
626
|
return true;
|
|
645
627
|
}
|
|
646
|
-
return Object.values(n).some(
|
|
628
|
+
return Object.values(n).some(v => Array.isArray(v) ? v.some(callsCreateEndpoint) : callsCreateEndpoint(v));
|
|
647
629
|
}
|
|
648
630
|
/** Unwrap `x satisfies T` / `x as const` to the expression underneath. */
|
|
649
631
|
function unwrapExpression(node) {
|
|
650
632
|
let current = node;
|
|
651
|
-
while ((current?.type ===
|
|
652
|
-
current?.type ===
|
|
653
|
-
current?.type ===
|
|
654
|
-
current?.type ===
|
|
633
|
+
while ((current?.type === 'TSAsExpression' ||
|
|
634
|
+
current?.type === 'TSSatisfiesExpression' ||
|
|
635
|
+
current?.type === 'TSNonNullExpression' ||
|
|
636
|
+
current?.type === 'ParenthesizedExpression') &&
|
|
655
637
|
current.expression) {
|
|
656
638
|
current = current.expression;
|
|
657
639
|
}
|
|
@@ -660,7 +642,7 @@ function unwrapExpression(node) {
|
|
|
660
642
|
function inspectEndpointFile(source) {
|
|
661
643
|
let ast;
|
|
662
644
|
try {
|
|
663
|
-
ast = (0, parser_1.parse)(source, { sourceType:
|
|
645
|
+
ast = (0, parser_1.parse)(source, { sourceType: 'module', plugins: ['typescript'] });
|
|
664
646
|
}
|
|
665
647
|
catch {
|
|
666
648
|
// Unparseable with a TS-only plugin set — most likely TSX, which is still
|
|
@@ -669,31 +651,31 @@ function inspectEndpointFile(source) {
|
|
|
669
651
|
return { isEndpoint: true, hasDefaultExport: true, stream: false };
|
|
670
652
|
}
|
|
671
653
|
const body = ast.program.body;
|
|
672
|
-
const hasDefaultExport = body.some(
|
|
673
|
-
(n.type ===
|
|
674
|
-
n.specifiers?.some(
|
|
675
|
-
(spec.exported.type ===
|
|
654
|
+
const hasDefaultExport = body.some(n => n.type === 'ExportDefaultDeclaration' ||
|
|
655
|
+
(n.type === 'ExportNamedDeclaration' &&
|
|
656
|
+
n.specifiers?.some(spec => spec.type === 'ExportSpecifier' &&
|
|
657
|
+
(spec.exported.type === 'Identifier'
|
|
676
658
|
? spec.exported.name
|
|
677
|
-
: spec.exported.value) ===
|
|
659
|
+
: spec.exported.value) === 'default')));
|
|
678
660
|
const isEndpoint = hasDefaultExport || body.some(callsCreateEndpoint);
|
|
679
661
|
if (!isEndpoint)
|
|
680
662
|
return NOT_AN_ENDPOINT;
|
|
681
663
|
// Stream detection is best-effort on the literal config: it is the only
|
|
682
664
|
// shape we can read `stream: true` out of statically.
|
|
683
|
-
const defaultExport = body.find(
|
|
665
|
+
const defaultExport = body.find(n => n.type === 'ExportDefaultDeclaration');
|
|
684
666
|
const call = defaultExport
|
|
685
667
|
? unwrapExpression(defaultExport.declaration)
|
|
686
668
|
: undefined;
|
|
687
|
-
const arg = call?.type ===
|
|
669
|
+
const arg = call?.type === 'CallExpression'
|
|
688
670
|
? unwrapExpression(call.arguments?.[0] ?? {})
|
|
689
671
|
: undefined;
|
|
690
|
-
if (arg?.type !==
|
|
672
|
+
if (arg?.type !== 'ObjectExpression') {
|
|
691
673
|
return { isEndpoint, hasDefaultExport, stream: false };
|
|
692
674
|
}
|
|
693
|
-
const streamProp = arg.properties.find(
|
|
694
|
-
((prop.key?.type ===
|
|
695
|
-
(prop.key?.type ===
|
|
696
|
-
const stream = streamProp?.value?.type ===
|
|
675
|
+
const streamProp = arg.properties.find(prop => prop.type === 'ObjectProperty' &&
|
|
676
|
+
((prop.key?.type === 'Identifier' && prop.key.name === 'stream') ||
|
|
677
|
+
(prop.key?.type === 'StringLiteral' && prop.key.value === 'stream')));
|
|
678
|
+
const stream = streamProp?.value?.type === 'BooleanLiteral' &&
|
|
697
679
|
streamProp.value.value === true;
|
|
698
680
|
return { isEndpoint, hasDefaultExport, stream };
|
|
699
681
|
}
|
|
@@ -704,52 +686,52 @@ function inspectEndpointFile(source) {
|
|
|
704
686
|
* words are legal object keys.
|
|
705
687
|
*/
|
|
706
688
|
const RESERVED_IDENTIFIERS = new Set([
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
689
|
+
'await',
|
|
690
|
+
'break',
|
|
691
|
+
'case',
|
|
692
|
+
'catch',
|
|
693
|
+
'class',
|
|
694
|
+
'const',
|
|
695
|
+
'continue',
|
|
696
|
+
'debugger',
|
|
697
|
+
'default',
|
|
698
|
+
'delete',
|
|
699
|
+
'do',
|
|
700
|
+
'else',
|
|
701
|
+
'enum',
|
|
702
|
+
'export',
|
|
703
|
+
'extends',
|
|
704
|
+
'false',
|
|
705
|
+
'finally',
|
|
706
|
+
'for',
|
|
707
|
+
'function',
|
|
708
|
+
'if',
|
|
709
|
+
'implements',
|
|
710
|
+
'import',
|
|
711
|
+
'in',
|
|
712
|
+
'instanceof',
|
|
713
|
+
'interface',
|
|
714
|
+
'let',
|
|
715
|
+
'new',
|
|
716
|
+
'null',
|
|
717
|
+
'package',
|
|
718
|
+
'private',
|
|
719
|
+
'protected',
|
|
720
|
+
'public',
|
|
721
|
+
'return',
|
|
722
|
+
'static',
|
|
723
|
+
'super',
|
|
724
|
+
'switch',
|
|
725
|
+
'this',
|
|
726
|
+
'throw',
|
|
727
|
+
'true',
|
|
728
|
+
'try',
|
|
729
|
+
'typeof',
|
|
730
|
+
'var',
|
|
731
|
+
'void',
|
|
732
|
+
'while',
|
|
733
|
+
'with',
|
|
734
|
+
'yield',
|
|
753
735
|
]);
|
|
754
736
|
const toSafeIdentifier = (camelName) => RESERVED_IDENTIFIERS.has(camelName) ? `_${camelName}` : camelName;
|
|
755
737
|
function generateApiTs(endpointFiles) {
|
|
@@ -759,11 +741,11 @@ function generateApiTs(endpointFiles) {
|
|
|
759
741
|
const seenIdents = new Set();
|
|
760
742
|
const skipped = [];
|
|
761
743
|
for (const file of endpointFiles) {
|
|
762
|
-
const fileName = typeof file ===
|
|
763
|
-
const content = typeof file ===
|
|
744
|
+
const fileName = typeof file === 'string' ? file : file.fileName;
|
|
745
|
+
const content = typeof file === 'string' ? undefined : file.content;
|
|
764
746
|
// `foo.d.ts` -> baseName `foo.d`, which imports nothing and camelCases to
|
|
765
747
|
// `fooD`. Declaration files are never endpoints.
|
|
766
|
-
if (fileName.endsWith(
|
|
748
|
+
if (fileName.endsWith('.d.ts'))
|
|
767
749
|
continue;
|
|
768
750
|
// Callers that pass bare filenames can't be filtered — every in-tree caller
|
|
769
751
|
// passes content, and so does the backend's migration assembler.
|
|
@@ -772,7 +754,7 @@ function generateApiTs(endpointFiles) {
|
|
|
772
754
|
skipped.push(fileName);
|
|
773
755
|
continue;
|
|
774
756
|
}
|
|
775
|
-
const baseName = fileName.replace(/\.(ts|js)$/,
|
|
757
|
+
const baseName = fileName.replace(/\.(ts|js)$/, '');
|
|
776
758
|
const key = (0, sdkNames_js_1.toCamelCase)(baseName);
|
|
777
759
|
const ident = toSafeIdentifier(key);
|
|
778
760
|
// Distinct files can collide on one identifier (`send-email.ts` and
|
|
@@ -798,27 +780,27 @@ function generateApiTs(endpointFiles) {
|
|
|
798
780
|
}
|
|
799
781
|
if (endpoints.length === 0)
|
|
800
782
|
return null;
|
|
801
|
-
const hasStreaming = endpoints.some(
|
|
783
|
+
const hasStreaming = endpoints.some(e => e.stream);
|
|
802
784
|
const lines = [
|
|
803
|
-
|
|
804
|
-
|
|
785
|
+
'// Auto-generated by zitejs generate. Do not edit manually.',
|
|
786
|
+
'',
|
|
805
787
|
hasStreaming
|
|
806
788
|
? "import { createCaller, createStreamingCaller } from 'zitejs/caller';"
|
|
807
789
|
: "import { createCaller } from 'zitejs/caller';",
|
|
808
|
-
|
|
790
|
+
'',
|
|
809
791
|
];
|
|
810
792
|
if (skipped.length > 0) {
|
|
811
|
-
lines.push(
|
|
793
|
+
lines.push('// Not endpoints, so no callers were generated for them:');
|
|
812
794
|
for (const name of skipped)
|
|
813
795
|
lines.push(`// ${commentSafe(name)}`);
|
|
814
|
-
lines.push(
|
|
796
|
+
lines.push('');
|
|
815
797
|
}
|
|
816
798
|
for (const { pascal, baseName, typed } of endpoints) {
|
|
817
799
|
if (!typed)
|
|
818
800
|
continue;
|
|
819
801
|
lines.push(`import type { default as _${pascal}Ep } from ${tsSingleQuoted(`../src/api/${baseName}`)};`);
|
|
820
802
|
}
|
|
821
|
-
lines.push(
|
|
803
|
+
lines.push('');
|
|
822
804
|
for (const { baseName, ident, pascal, stream, typed } of endpoints) {
|
|
823
805
|
if (!typed) {
|
|
824
806
|
// Declared with `export const x = createEndpoint(...)` — the 1.0 shape.
|
|
@@ -827,8 +809,8 @@ function generateApiTs(endpointFiles) {
|
|
|
827
809
|
lines.push(`// ${commentSafe(`'${baseName}'`)} has no default export, so its input/output are untyped.`);
|
|
828
810
|
lines.push(`export type ${pascal}InputType = unknown;`);
|
|
829
811
|
lines.push(`export type ${pascal}OutputType = unknown;`);
|
|
830
|
-
lines.push(`export const ${ident} = ${stream ?
|
|
831
|
-
lines.push(
|
|
812
|
+
lines.push(`export const ${ident} = ${stream ? 'createStreamingCaller' : 'createCaller'}<${pascal}InputType, ${pascal}OutputType>(${tsSingleQuoted(baseName)});`);
|
|
813
|
+
lines.push('');
|
|
832
814
|
continue;
|
|
833
815
|
}
|
|
834
816
|
lines.push(`type _${pascal}Cfg = typeof _${pascal}Ep;`);
|
|
@@ -845,65 +827,65 @@ function generateApiTs(endpointFiles) {
|
|
|
845
827
|
// against those keys, so `send-email.ts` is reachable at `/api/send-email`.
|
|
846
828
|
// Calling it `sendEmail` here made every hyphenated or snake_cased endpoint
|
|
847
829
|
// a 404.
|
|
848
|
-
const caller = stream ?
|
|
830
|
+
const caller = stream ? 'createStreamingCaller' : 'createCaller';
|
|
849
831
|
lines.push(`export const ${ident} = ${caller}<${pascal}InputType, ${pascal}OutputType>(${tsSingleQuoted(baseName)});`);
|
|
850
|
-
lines.push(
|
|
832
|
+
lines.push('');
|
|
851
833
|
}
|
|
852
|
-
lines.push(
|
|
853
|
-
lines.push(
|
|
834
|
+
lines.push('');
|
|
835
|
+
lines.push('export const api = {');
|
|
854
836
|
for (const { key, ident } of endpoints) {
|
|
855
837
|
lines.push(key === ident ? ` ${ident},` : ` ${key}: ${ident},`);
|
|
856
838
|
}
|
|
857
|
-
lines.push(
|
|
858
|
-
lines.push(
|
|
859
|
-
return lines.join(
|
|
839
|
+
lines.push('};');
|
|
840
|
+
lines.push('');
|
|
841
|
+
return lines.join('\n');
|
|
860
842
|
}
|
|
861
843
|
function tsTypeForField(field) {
|
|
862
844
|
if (FIELD_TYPE_MAP[field.type])
|
|
863
845
|
return FIELD_TYPE_MAP[field.type];
|
|
864
|
-
return
|
|
846
|
+
return 'string';
|
|
865
847
|
}
|
|
866
848
|
const AIRTABLE_FIELD_TYPE_MAP = {
|
|
867
849
|
// Writable fields
|
|
868
|
-
singleLineText:
|
|
869
|
-
multilineText:
|
|
870
|
-
richText:
|
|
871
|
-
email:
|
|
872
|
-
url:
|
|
873
|
-
phoneNumber:
|
|
874
|
-
barcode:
|
|
875
|
-
number:
|
|
876
|
-
currency:
|
|
877
|
-
percent:
|
|
878
|
-
rating:
|
|
850
|
+
singleLineText: 'string',
|
|
851
|
+
multilineText: 'string',
|
|
852
|
+
richText: 'string',
|
|
853
|
+
email: 'string',
|
|
854
|
+
url: 'string',
|
|
855
|
+
phoneNumber: 'string',
|
|
856
|
+
barcode: 'string',
|
|
857
|
+
number: 'number',
|
|
858
|
+
currency: 'number',
|
|
859
|
+
percent: 'number',
|
|
860
|
+
rating: 'number',
|
|
879
861
|
// Formatted to "HH:mm:ss" before it reaches the app — `formatAirtableDuration`
|
|
880
862
|
// in BOTH dispatches. Unlike the Zite DB's, which is DECIMAL seconds.
|
|
881
|
-
duration:
|
|
882
|
-
checkbox:
|
|
883
|
-
date:
|
|
884
|
-
dateTime:
|
|
885
|
-
singleSelect:
|
|
886
|
-
multipleSelects:
|
|
887
|
-
multipleAttachments:
|
|
863
|
+
duration: 'string',
|
|
864
|
+
checkbox: 'boolean',
|
|
865
|
+
date: 'string',
|
|
866
|
+
dateTime: 'string',
|
|
867
|
+
singleSelect: 'string',
|
|
868
|
+
multipleSelects: 'string[]',
|
|
869
|
+
multipleAttachments: 'AirtableAttachment[]',
|
|
888
870
|
// `string | string[]`, matching the pre-monorepo type — see the note on the
|
|
889
871
|
// Zite DB's `linked_record`.
|
|
890
|
-
multipleRecordLinks:
|
|
891
|
-
singleCollaborator:
|
|
892
|
-
multipleCollaborators:
|
|
872
|
+
multipleRecordLinks: 'string | string[]',
|
|
873
|
+
singleCollaborator: '{ id: string; email: string; name?: string }',
|
|
874
|
+
multipleCollaborators: 'Array<{ id: string; email: string; name?: string }>',
|
|
893
875
|
// Read-only fields
|
|
894
|
-
autoNumber:
|
|
895
|
-
count:
|
|
896
|
-
formula:
|
|
897
|
-
rollup:
|
|
898
|
-
multipleLookupValues:
|
|
899
|
-
createdTime:
|
|
900
|
-
lastModifiedTime:
|
|
901
|
-
createdBy:
|
|
902
|
-
lastModifiedBy:
|
|
876
|
+
autoNumber: 'number',
|
|
877
|
+
count: 'number',
|
|
878
|
+
formula: 'unknown',
|
|
879
|
+
rollup: 'unknown',
|
|
880
|
+
multipleLookupValues: 'unknown',
|
|
881
|
+
createdTime: 'string',
|
|
882
|
+
lastModifiedTime: 'string',
|
|
883
|
+
createdBy: '{ id: string; email: string; name?: string }',
|
|
884
|
+
lastModifiedBy: '{ id: string; email: string; name?: string }',
|
|
903
885
|
// Both dispatches extract the URL string off the button object.
|
|
904
|
-
button:
|
|
905
|
-
externalSyncSource:
|
|
906
|
-
aiText:
|
|
886
|
+
button: 'string',
|
|
887
|
+
externalSyncSource: 'unknown',
|
|
888
|
+
aiText: 'string',
|
|
907
889
|
};
|
|
908
890
|
/**
|
|
909
891
|
* Field types whose WRITE shape is looser than what Airtable returns.
|
|
@@ -911,10 +893,10 @@ const AIRTABLE_FIELD_TYPE_MAP = {
|
|
|
911
893
|
* `{ url, filename? }`; a link field returns an array but accepts one id.
|
|
912
894
|
*/
|
|
913
895
|
const AIRTABLE_FIELD_INPUT_TYPE_MAP = {
|
|
914
|
-
multipleAttachments:
|
|
915
|
-
multipleRecordLinks:
|
|
916
|
-
singleCollaborator:
|
|
917
|
-
multipleCollaborators:
|
|
896
|
+
multipleAttachments: 'Array<{ url: string; filename?: string }>',
|
|
897
|
+
multipleRecordLinks: 'string | string[]',
|
|
898
|
+
singleCollaborator: '{ id: string } | { email: string }',
|
|
899
|
+
multipleCollaborators: 'Array<{ id: string } | { email: string }>',
|
|
918
900
|
};
|
|
919
901
|
/**
|
|
920
902
|
* Airtable's attachment object as the REST API really returns it.
|
|
@@ -925,34 +907,34 @@ const AIRTABLE_FIELD_INPUT_TYPE_MAP = {
|
|
|
925
907
|
* migration type error. Optional, because a non-image attachment has neither.
|
|
926
908
|
*/
|
|
927
909
|
const AIRTABLE_ATTACHMENT_TYPE = [
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
910
|
+
'export type AirtableAttachment = {',
|
|
911
|
+
' id: string;',
|
|
912
|
+
' url: string;',
|
|
913
|
+
' filename: string;',
|
|
914
|
+
' /** Size in bytes. */',
|
|
915
|
+
' size: number;',
|
|
916
|
+
' /** MIME type. */',
|
|
917
|
+
' type: string;',
|
|
918
|
+
' /** Pixel width — images only. */',
|
|
919
|
+
' width?: number;',
|
|
920
|
+
' /** Pixel height — images only. */',
|
|
921
|
+
' height?: number;',
|
|
922
|
+
' thumbnails?: {',
|
|
923
|
+
' small: { url: string; width: number; height: number };',
|
|
924
|
+
' large: { url: string; width: number; height: number };',
|
|
925
|
+
' full: { url: string; width: number; height: number };',
|
|
926
|
+
' };',
|
|
927
|
+
'};',
|
|
928
|
+
'',
|
|
947
929
|
];
|
|
948
|
-
function airtableTsType(field, lock, depth, variant =
|
|
949
|
-
if (variant ===
|
|
930
|
+
function airtableTsType(field, lock, depth, variant = 'read') {
|
|
931
|
+
if (variant === 'write' && AIRTABLE_FIELD_INPUT_TYPE_MAP[field.type]) {
|
|
950
932
|
return AIRTABLE_FIELD_INPUT_TYPE_MAP[field.type];
|
|
951
933
|
}
|
|
952
934
|
// A formula or rollup's cell type is whatever its expression produces, and
|
|
953
935
|
// Airtable reports that in the field's `result`. Reading it turns `unknown`
|
|
954
936
|
// — which forces a cast at every use — into the actual type.
|
|
955
|
-
if ((field.type ===
|
|
937
|
+
if ((field.type === 'formula' || field.type === 'rollup') &&
|
|
956
938
|
(depth ?? 0) < 5) {
|
|
957
939
|
const result = field.config?.result;
|
|
958
940
|
if (result?.type && result.type !== field.type) {
|
|
@@ -960,28 +942,28 @@ function airtableTsType(field, lock, depth, variant = "read") {
|
|
|
960
942
|
}
|
|
961
943
|
}
|
|
962
944
|
const choices = field.config?.choices;
|
|
963
|
-
if ((field.type ===
|
|
945
|
+
if ((field.type === 'singleSelect' || field.type === 'multipleSelects') &&
|
|
964
946
|
choices &&
|
|
965
947
|
choices.length > 0) {
|
|
966
948
|
const literals = choices
|
|
967
949
|
.slice(0, MAX_SELECT_OPTIONS)
|
|
968
|
-
.map(
|
|
969
|
-
.join(
|
|
950
|
+
.map(o => tsStringLiteral(o))
|
|
951
|
+
.join(' | ');
|
|
970
952
|
const union = `${literals} | string`;
|
|
971
|
-
if (field.type ===
|
|
953
|
+
if (field.type === 'multipleSelects')
|
|
972
954
|
return `(${union})[]`;
|
|
973
955
|
return union;
|
|
974
956
|
}
|
|
975
|
-
if (field.type ===
|
|
957
|
+
if (field.type === 'multipleLookupValues' && lock && (depth ?? 0) < 5) {
|
|
976
958
|
const linkFieldId = field.config?.recordLinkFieldId;
|
|
977
959
|
const targetFieldId = field.config?.fieldIdInLinkedTable;
|
|
978
960
|
if (linkFieldId && targetFieldId) {
|
|
979
|
-
const table = lock.tables.find(
|
|
980
|
-
const linkField = table?.fields.find(
|
|
961
|
+
const table = lock.tables.find(t => t.fields.some(f => f.id === linkFieldId));
|
|
962
|
+
const linkField = table?.fields.find(f => f.id === linkFieldId);
|
|
981
963
|
const linkedTableId = linkField?.config?.linkedTableId;
|
|
982
964
|
if (linkedTableId) {
|
|
983
|
-
const linkedTable = lock.tables.find(
|
|
984
|
-
const targetField = linkedTable?.fields.find(
|
|
965
|
+
const linkedTable = lock.tables.find(t => t.id === linkedTableId);
|
|
966
|
+
const targetField = linkedTable?.fields.find(f => f.id === targetFieldId);
|
|
985
967
|
if (targetField) {
|
|
986
968
|
const resolved = airtableTsType(targetField, lock, (depth ?? 0) + 1);
|
|
987
969
|
return `${resolved}[] | undefined`;
|
|
@@ -989,90 +971,90 @@ function airtableTsType(field, lock, depth, variant = "read") {
|
|
|
989
971
|
}
|
|
990
972
|
}
|
|
991
973
|
}
|
|
992
|
-
return AIRTABLE_FIELD_TYPE_MAP[field.type] ??
|
|
974
|
+
return AIRTABLE_FIELD_TYPE_MAP[field.type] ?? 'unknown';
|
|
993
975
|
}
|
|
994
976
|
const READ_ONLY_AIRTABLE_FIELDS = new Set([
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
977
|
+
'autoNumber',
|
|
978
|
+
'count',
|
|
979
|
+
'formula',
|
|
980
|
+
'rollup',
|
|
981
|
+
'multipleLookupValues',
|
|
982
|
+
'createdTime',
|
|
983
|
+
'lastModifiedTime',
|
|
984
|
+
'createdBy',
|
|
985
|
+
'lastModifiedBy',
|
|
986
|
+
'button',
|
|
987
|
+
'externalSyncSource',
|
|
988
|
+
'aiText',
|
|
1007
989
|
]);
|
|
1008
990
|
function airtableFieldJsdoc(field, table, lock) {
|
|
1009
991
|
const parts = [];
|
|
1010
992
|
if (table.primaryFieldId === field.id)
|
|
1011
|
-
parts.push(
|
|
993
|
+
parts.push('Primary field');
|
|
1012
994
|
if (READ_ONLY_AIRTABLE_FIELDS.has(field.type))
|
|
1013
|
-
parts.push(
|
|
1014
|
-
if (field.type ===
|
|
995
|
+
parts.push('Read-only; do not write');
|
|
996
|
+
if (field.type === 'multipleRecordLinks') {
|
|
1015
997
|
const linkedTableId = field.config?.linkedTableId;
|
|
1016
998
|
if (linkedTableId) {
|
|
1017
|
-
const linked = lock?.tables.find(
|
|
999
|
+
const linked = lock?.tables.find(t => t.id === linkedTableId);
|
|
1018
1000
|
parts.push(linked
|
|
1019
|
-
? `Links to ${linked.sdkName}${linked.name ? ` ("${linked.name}")` :
|
|
1001
|
+
? `Links to ${linked.sdkName}${linked.name ? ` ("${linked.name}")` : ''}`
|
|
1020
1002
|
: `Links to ${linkedTableId}`);
|
|
1021
1003
|
}
|
|
1022
1004
|
if (field.config?.prefersSingleRecordLink)
|
|
1023
|
-
parts.push(
|
|
1005
|
+
parts.push('Single record only');
|
|
1024
1006
|
}
|
|
1025
|
-
if (field.type ===
|
|
1026
|
-
parts.push(
|
|
1027
|
-
if (field.type ===
|
|
1028
|
-
parts.push(
|
|
1007
|
+
if (field.type === 'multipleLookupValues')
|
|
1008
|
+
parts.push('Lookup: value is an array — index or aggregate when displaying');
|
|
1009
|
+
if (field.type === 'percent')
|
|
1010
|
+
parts.push('Raw decimal — multiply by 100 for display percentage');
|
|
1029
1011
|
parts.push(`"${field.name}"`);
|
|
1030
|
-
if (field.type ===
|
|
1012
|
+
if (field.type === 'currency') {
|
|
1031
1013
|
const symbol = field.config?.symbol;
|
|
1032
1014
|
const precision = field.config?.precision;
|
|
1033
1015
|
if (symbol)
|
|
1034
1016
|
parts.push(`Display as currency with "${symbol}", ${precision ?? 2} decimals`);
|
|
1035
1017
|
}
|
|
1036
|
-
if (field.type ===
|
|
1018
|
+
if (field.type === 'date') {
|
|
1037
1019
|
const fmt = field.config?.dateFormat;
|
|
1038
1020
|
if (fmt)
|
|
1039
1021
|
parts.push(`Date-only (ISO string), display as "${fmt}"`);
|
|
1040
1022
|
}
|
|
1041
|
-
if (field.type ===
|
|
1023
|
+
if (field.type === 'dateTime') {
|
|
1042
1024
|
const dateFmt = field.config?.dateFormat;
|
|
1043
1025
|
const timeFmt = field.config?.timeFormat;
|
|
1044
1026
|
const tz = field.config?.timeZone;
|
|
1045
|
-
const fmtParts = [
|
|
1027
|
+
const fmtParts = ['Date+time (ISO string)'];
|
|
1046
1028
|
if (dateFmt)
|
|
1047
1029
|
fmtParts.push(`date: ${dateFmt}`);
|
|
1048
1030
|
if (timeFmt)
|
|
1049
1031
|
fmtParts.push(`time: ${timeFmt}`);
|
|
1050
1032
|
if (tz)
|
|
1051
1033
|
fmtParts.push(`tz: ${tz}`);
|
|
1052
|
-
parts.push(fmtParts.join(
|
|
1034
|
+
parts.push(fmtParts.join(', '));
|
|
1053
1035
|
}
|
|
1054
|
-
if (field.type ===
|
|
1036
|
+
if (field.type === 'rating') {
|
|
1055
1037
|
const max = field.config?.max;
|
|
1056
1038
|
if (max)
|
|
1057
1039
|
parts.push(`Max: ${max}`);
|
|
1058
1040
|
}
|
|
1059
|
-
if (field.type ===
|
|
1041
|
+
if (field.type === 'duration') {
|
|
1060
1042
|
const fmt = field.config?.format;
|
|
1061
1043
|
if (fmt)
|
|
1062
1044
|
parts.push(`Value in seconds, display as "${fmt}"`);
|
|
1063
1045
|
}
|
|
1064
|
-
if (field.type ===
|
|
1046
|
+
if (field.type === 'number' || field.type === 'percent') {
|
|
1065
1047
|
const precision = field.config?.precision;
|
|
1066
1048
|
if (precision != null)
|
|
1067
1049
|
parts.push(`${precision} decimal places`);
|
|
1068
1050
|
}
|
|
1069
1051
|
if (parts.length <= 1)
|
|
1070
1052
|
return undefined;
|
|
1071
|
-
return parts.join(
|
|
1053
|
+
return parts.join('. ');
|
|
1072
1054
|
}
|
|
1073
1055
|
// A table client is a `const`, so only value-space bindings can collide with
|
|
1074
1056
|
// one. `AirtableAttachment` is a type, and types and consts coexist.
|
|
1075
|
-
const RESERVED_AIRTABLE_NAMES = [
|
|
1057
|
+
const RESERVED_AIRTABLE_NAMES = ['createAirtableClient'];
|
|
1076
1058
|
/**
|
|
1077
1059
|
* Make every table sdkName in the lock unique, so a duplicated lock can't emit
|
|
1078
1060
|
* a file that cannot compile (TS2300/TS2451) and that no app can edit or
|
|
@@ -1108,7 +1090,7 @@ function normalizeAirtableLockNames(lock) {
|
|
|
1108
1090
|
});
|
|
1109
1091
|
// Sole owners claim their names before any contender is suffixed, so a
|
|
1110
1092
|
// contender can never displace a table legitimately named `GroupCalls2`.
|
|
1111
|
-
const kept = lock.tables.map(
|
|
1093
|
+
const kept = lock.tables.map(table => owners.get(table.sdkName) === 1 && tableNames.available(table.sdkName)
|
|
1112
1094
|
? tableNames.allocate(table.sdkName)
|
|
1113
1095
|
: undefined);
|
|
1114
1096
|
const renames = [];
|
|
@@ -1116,7 +1098,7 @@ function normalizeAirtableLockNames(lock) {
|
|
|
1116
1098
|
const sdkName = kept[i] ?? tableNames.allocate(table.sdkName);
|
|
1117
1099
|
if (sdkName !== table.sdkName) {
|
|
1118
1100
|
renames.push({
|
|
1119
|
-
kind:
|
|
1101
|
+
kind: 'table',
|
|
1120
1102
|
tableId: table.id,
|
|
1121
1103
|
from: table.sdkName,
|
|
1122
1104
|
to: sdkName,
|
|
@@ -1126,7 +1108,11 @@ function normalizeAirtableLockNames(lock) {
|
|
|
1126
1108
|
});
|
|
1127
1109
|
return { lock: { ...lock, tables }, renames };
|
|
1128
1110
|
}
|
|
1129
|
-
|
|
1111
|
+
/** Where an app keeps the server code a generated client is used from. */
|
|
1112
|
+
const serverCodeIn = (runtime) => runtime === 'start'
|
|
1113
|
+
? 'server functions and *.server.ts files'
|
|
1114
|
+
: 'endpoint files (src/api/*.ts)';
|
|
1115
|
+
function generateAirtableTs(inputLock, runtime = 'classic') {
|
|
1130
1116
|
if (inputLock.tables.length === 0)
|
|
1131
1117
|
return null;
|
|
1132
1118
|
const { lock, renames } = normalizeAirtableLockNames(inputLock);
|
|
@@ -1136,48 +1122,48 @@ function generateAirtableTs(inputLock) {
|
|
|
1136
1122
|
}
|
|
1137
1123
|
}
|
|
1138
1124
|
const lines = [
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
`// import { ${lock.tables[0]?.sdkName ??
|
|
1144
|
-
|
|
1125
|
+
'// Auto-generated by zitejs generate from zite.lock. Do not edit manually.',
|
|
1126
|
+
'// Airtable SDK — uses createAirtableClient from zitejs/runtime.',
|
|
1127
|
+
'//',
|
|
1128
|
+
`// Usage in ${serverCodeIn(runtime)} — one client is exported per table:`,
|
|
1129
|
+
`// import { ${lock.tables[0]?.sdkName ?? 'TableName'} } from 'zitejs/integrations';`,
|
|
1130
|
+
'//',
|
|
1145
1131
|
"// Always use 'zitejs/integrations' — never a relative path like",
|
|
1146
1132
|
"// '../../.zite/integrations/airtable'. The tsconfig aliases resolve zitejs/*",
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
|
-
|
|
1160
|
-
|
|
1133
|
+
'// imports to the correct .zite/ files.',
|
|
1134
|
+
'//',
|
|
1135
|
+
'// Each exported table client has these methods (all take a single params object):',
|
|
1136
|
+
'// findAll({ offset?, limit?, filters? }) => { records: T[], offset: string | undefined, hasMore: boolean }',
|
|
1137
|
+
'// findOne({ id?, filters? }) => T | undefined',
|
|
1138
|
+
'// create({ record }) => T | undefined',
|
|
1139
|
+
'// bulkCreate({ records }) => T[]',
|
|
1140
|
+
'// update({ id, record }) => { id: string, fields: T } | undefined',
|
|
1141
|
+
'// delete({ id }) => { id: string }',
|
|
1142
|
+
'//',
|
|
1143
|
+
'// Reading these types:',
|
|
1144
|
+
'// Every field is OPTIONAL. Airtable omits an empty cell from the response',
|
|
1145
|
+
'// entirely rather than sending null, so any field can be undefined on any row.',
|
|
1146
|
+
'// SDK names are stable identifiers and do not change when a field is renamed —',
|
|
1161
1147
|
'// each carries its current user-facing name in quotes (// "Task Name"), which is',
|
|
1162
|
-
|
|
1148
|
+
'// the source of truth for what it means.',
|
|
1163
1149
|
"// Values are RAW; format them for display using each field's comment.",
|
|
1164
1150
|
'// Fields marked "Links to X" hold Airtable record ids (rec...) from',
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
1151
|
+
'// findOne/findAll — never invent one.',
|
|
1152
|
+
'// Read-only fields are absent from the *RecordInput types: Airtable rejects a',
|
|
1153
|
+
'// write to a computed one (formula, rollup, lookup, autonumber, the created/',
|
|
1154
|
+
'// modified metadata, button, aiText) with a 422.',
|
|
1155
|
+
'//',
|
|
1156
|
+
'// Usage tips:',
|
|
1157
|
+
'// - Airtable has a strict rate limit of 5 requests/second per base',
|
|
1158
|
+
'// - Use bulkCreate() instead of calling create() in a loop, but chunk it',
|
|
1159
|
+
'// yourself: Airtable rejects more than 10 records in one create request',
|
|
1160
|
+
'// with a 422, and not every runtime path batches for you',
|
|
1161
|
+
'// - findAll() offsets are opaque cursor strings from a previous call, NOT row',
|
|
1162
|
+
'// counts (unlike zite.<table>.findAll, whose offset IS a number)',
|
|
1163
|
+
'// - Always destructure record properties individually in create/update calls',
|
|
1164
|
+
'',
|
|
1179
1165
|
"import { createAirtableClient } from 'zitejs/runtime';",
|
|
1180
|
-
|
|
1166
|
+
'',
|
|
1181
1167
|
];
|
|
1182
1168
|
lines.push(...AIRTABLE_ATTACHMENT_TYPE);
|
|
1183
1169
|
for (const table of lock.tables) {
|
|
@@ -1186,9 +1172,9 @@ function generateAirtableTs(inputLock) {
|
|
|
1186
1172
|
? `/** A record in the "${commentSafe(table.name)}" table, as it is read back. */`
|
|
1187
1173
|
: `/** A ${commentSafe(table.sdkName)} record as it is read back. */`);
|
|
1188
1174
|
lines.push(`export type ${recordType} = {`);
|
|
1189
|
-
lines.push(
|
|
1175
|
+
lines.push(' id: string;');
|
|
1190
1176
|
for (const field of table.fields) {
|
|
1191
|
-
if (field.sdkName ===
|
|
1177
|
+
if (field.sdkName === 'id')
|
|
1192
1178
|
continue;
|
|
1193
1179
|
const jsdoc = airtableFieldJsdoc(field, table, lock);
|
|
1194
1180
|
if (jsdoc) {
|
|
@@ -1201,172 +1187,172 @@ function generateAirtableTs(inputLock) {
|
|
|
1201
1187
|
// typed `string` is `undefined` at runtime on the first blank row.
|
|
1202
1188
|
lines.push(` ${field.sdkName}?: ${tsType};`);
|
|
1203
1189
|
}
|
|
1204
|
-
lines.push(
|
|
1205
|
-
lines.push(
|
|
1190
|
+
lines.push('};');
|
|
1191
|
+
lines.push('');
|
|
1206
1192
|
// Read-only fields are omitted rather than typed: Airtable rejects a write
|
|
1207
1193
|
// to a formula, rollup, lookup or autonumber with a 422.
|
|
1208
|
-
const writableFields = table.fields.filter(
|
|
1194
|
+
const writableFields = table.fields.filter(f => f.sdkName !== 'id' && !READ_ONLY_AIRTABLE_FIELDS.has(f.type));
|
|
1209
1195
|
lines.push(table.name
|
|
1210
1196
|
? `/** What you may write when creating or updating a record in the "${commentSafe(table.name)}" table. */`
|
|
1211
1197
|
: `/** What you may write when creating or updating a ${commentSafe(table.sdkName)}. */`);
|
|
1212
1198
|
lines.push(`export type ${table.sdkName}RecordInput = {`);
|
|
1213
1199
|
for (const field of writableFields) {
|
|
1214
|
-
lines.push(` ${field.sdkName}: ${airtableTsType(field, lock, 0,
|
|
1200
|
+
lines.push(` ${field.sdkName}: ${airtableTsType(field, lock, 0, 'write')};`);
|
|
1215
1201
|
}
|
|
1216
|
-
lines.push(
|
|
1217
|
-
lines.push(
|
|
1202
|
+
lines.push('};');
|
|
1203
|
+
lines.push('');
|
|
1218
1204
|
lines.push(`export const ${table.sdkName} = createAirtableClient<${recordType}, ${table.sdkName}RecordInput>(`);
|
|
1219
1205
|
lines.push(` '${lock.integrationId}',`);
|
|
1220
1206
|
lines.push(` '${table.sdkName}',`);
|
|
1221
1207
|
lines.push(` { tableId: '${table.id}' },` +
|
|
1222
|
-
(table.name ? ` // "${commentSafe(table.name)}"` :
|
|
1208
|
+
(table.name ? ` // "${commentSafe(table.name)}"` : ''));
|
|
1223
1209
|
lines.push(`);`);
|
|
1224
|
-
lines.push(
|
|
1210
|
+
lines.push('');
|
|
1225
1211
|
}
|
|
1226
|
-
return lines.join(
|
|
1212
|
+
return lines.join('\n');
|
|
1227
1213
|
}
|
|
1228
1214
|
function generateBackendWrapperTs(envVarNames = []) {
|
|
1229
1215
|
const names = [
|
|
1230
|
-
|
|
1231
|
-
...envVarNames.filter(
|
|
1216
|
+
'ZITE_APP_URL',
|
|
1217
|
+
...envVarNames.filter(n => n !== 'ZITE_APP_URL'),
|
|
1232
1218
|
];
|
|
1233
1219
|
return [
|
|
1234
|
-
|
|
1235
|
-
|
|
1236
|
-
|
|
1220
|
+
'// Auto-generated type-narrowing wrapper. Do not edit manually.',
|
|
1221
|
+
'// Re-exports createEndpoint with context.user typed to the app User.',
|
|
1222
|
+
'',
|
|
1237
1223
|
"import type { ZiteRequestContext as _ZiteRequestContext, ZiteScheduledContext, ZiteErrorCode, ZiteSchedule, ZiteStep, ZiteStreamInterface, ZiteTrigger, ZiteTriggerContext, ZiteEndpointInput, ZiteWebhook } from 'zitejs/backend/base';",
|
|
1238
1224
|
"import type { User } from 'zitejs/auth';",
|
|
1239
|
-
|
|
1240
|
-
|
|
1225
|
+
'',
|
|
1226
|
+
'export type { ZiteErrorCode, ZiteSchedule, ZiteScheduledContext, ZiteStep, ZiteStreamInterface, ZiteTrigger, ZiteWebhook };',
|
|
1241
1227
|
// A trigger's registration exports are typed against these, and they
|
|
1242
1228
|
// only reach app code through this file.
|
|
1243
1229
|
"export type { ZiteDatabaseTriggerEvent, ZiteDatabaseTriggerInput, ZiteFormTriggerInput, ZiteTriggerContext, ZiteTriggerDeliveryInfo, ZiteTriggerDeliveryRun, ZiteTriggerRun, ZiteTriggerSubscribe, ZiteTriggerSubscribeInput, ZiteTriggerSubscribeResult, ZiteTriggerUnsubscribe, ZiteTriggerUnsubscribeInput } from 'zitejs/backend/base';",
|
|
1244
1230
|
// The pre-monorepo SDK put this in scope for every endpoint, so migrated
|
|
1245
1231
|
// code can name it. `createEndpoint` infers the same thing without it.
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1232
|
+
'export type InferSchemaType<T> = T extends { _output: infer U } ? U : T;',
|
|
1233
|
+
'',
|
|
1234
|
+
'export class ZiteError extends Error {',
|
|
1235
|
+
' code: ZiteErrorCode;',
|
|
1236
|
+
' /** Short, non-technical message suitable for showing to an end user. */',
|
|
1237
|
+
' userFacingMessage?: string;',
|
|
1252
1238
|
" // Both shapes, mirroring the worker's own class: object form preferred,",
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1239
|
+
' // positional form is what pre-monorepo app code was written against.',
|
|
1240
|
+
' constructor(options: { code: ZiteErrorCode; message: string; userFacingMessage?: string });',
|
|
1241
|
+
' constructor(message: string, code?: ZiteErrorCode);',
|
|
1242
|
+
' constructor(',
|
|
1243
|
+
' optionsOrMessage: { code: ZiteErrorCode; message: string; userFacingMessage?: string } | string,',
|
|
1244
|
+
' legacyCode?: ZiteErrorCode,',
|
|
1245
|
+
' ) {',
|
|
1260
1246
|
" if (typeof optionsOrMessage === 'string') {",
|
|
1261
|
-
|
|
1247
|
+
' super(optionsOrMessage);',
|
|
1262
1248
|
" this.code = legacyCode ?? 'INTERNAL_ERROR';",
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
|
|
1249
|
+
' } else {',
|
|
1250
|
+
' super(optionsOrMessage.message);',
|
|
1251
|
+
' this.code = optionsOrMessage.code;',
|
|
1252
|
+
' this.userFacingMessage = optionsOrMessage.userFacingMessage;',
|
|
1253
|
+
' }',
|
|
1268
1254
|
" this.name = 'ZiteError';",
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
|
|
1255
|
+
' }',
|
|
1256
|
+
'}',
|
|
1257
|
+
'',
|
|
1272
1258
|
// Narrows `user` to this app's generated User. ZiteScheduledContext is
|
|
1273
1259
|
// re-exported unchanged — a scheduled fire has no user at all, so there is
|
|
1274
1260
|
// nothing to narrow.
|
|
1275
|
-
|
|
1276
|
-
|
|
1261
|
+
'/**',
|
|
1262
|
+
' * The user an endpoint sees. NOT the full `User` from zitejs/auth — that is',
|
|
1277
1263
|
" * the browser's better-auth session, and the runtime never sends its",
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1264
|
+
' * `name`, `emailVerified`, `image`, `createdAt` or `updatedAt` to an',
|
|
1265
|
+
' * endpoint. Typing those here let `context.user.createdAt.getFullYear()`',
|
|
1266
|
+
' * compile and throw. `Omit` keeps any index signature merged in by',
|
|
1267
|
+
' * `.zite/user-extensions.d.ts`, so a migrated user-sync app still reads its',
|
|
1268
|
+
' * synced columns off this.',
|
|
1269
|
+
' *',
|
|
1270
|
+
' * The `Pick` intersection is not redundant. On an app that DOES merge in',
|
|
1271
|
+
' * `[key: string]: any`, `keyof User` widens to `string`, `Exclude` then',
|
|
1272
|
+
' * removes nothing, and the `Omit` collapses to a bare index signature —',
|
|
1273
|
+
' * which would silently degrade `user.id` from `string` to `any`. The `Pick`',
|
|
1274
|
+
' * names those members explicitly, so they survive the collapse.',
|
|
1275
|
+
' *',
|
|
1276
|
+
' * Only `id` and `email` are pinned that way, deliberately. On a user-sync',
|
|
1277
|
+
' * app `context.user` IS the synced row (`buildUserContext` returns it',
|
|
1278
|
+
' * whole), and only those two are guaranteed by the runtime: the id is the',
|
|
1279
|
+
' * record id and the email is merged in explicitly. `firstName`/`lastName`',
|
|
1280
|
+
' * come from whatever the app mapped those columns to, so pinning them to',
|
|
1281
|
+
' * `string` would reject a legitimate read on a table that types them',
|
|
1282
|
+
' * differently. Non-widened apps get both from the `Omit` regardless.',
|
|
1283
|
+
' *',
|
|
1284
|
+
' * On such an app `user.createdAt` still compiles, as `any`. That is',
|
|
1285
|
+
' * deliberate: a synced user table may legitimately have its own',
|
|
1286
|
+
' * `createdAt` column, and typing it `never` to close the hole would break',
|
|
1287
|
+
' * exactly the legacy apps `user-extensions.d.ts` exists to keep compiling.',
|
|
1288
|
+
' */',
|
|
1289
|
+
'export type ZiteEndpointUser = Omit<',
|
|
1290
|
+
' User,',
|
|
1305
1291
|
" 'name' | 'emailVerified' | 'image' | 'createdAt' | 'updatedAt'",
|
|
1306
|
-
|
|
1292
|
+
'> &',
|
|
1307
1293
|
" Pick<User, 'id' | 'email'> &",
|
|
1308
1294
|
" Pick<_ZiteRequestContext['user'], 'roles'>;",
|
|
1309
|
-
|
|
1295
|
+
'',
|
|
1310
1296
|
'export interface ZiteRequestContext extends Omit<_ZiteRequestContext, "user"> {',
|
|
1311
|
-
|
|
1312
|
-
|
|
1313
|
-
|
|
1314
|
-
|
|
1315
|
-
|
|
1297
|
+
' user: ZiteEndpointUser;',
|
|
1298
|
+
'}',
|
|
1299
|
+
'',
|
|
1300
|
+
'type SchemaLike<TOut, TIn = TOut> = { _output: TOut; _input: TIn; parse: (data: unknown) => TOut };',
|
|
1301
|
+
'',
|
|
1316
1302
|
// TStream mirrors zitejs/backend/base. Without it `stream: true` endpoints
|
|
1317
1303
|
// get no `stream` argument here — and this wrapper, not the base module, is
|
|
1318
1304
|
// what `zitejs/backend` resolves to in every app.
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
|
|
1305
|
+
'export interface EndpointConfig<TInput = unknown, TOutput = unknown, TStream extends boolean = false, TSchedule extends ZiteSchedule | undefined = undefined, TWebhook extends ZiteWebhook | undefined = undefined, TRawInput = TInput, TTrigger extends ZiteTrigger | undefined = undefined> {',
|
|
1306
|
+
' description?: string;',
|
|
1307
|
+
' inputSchema?: SchemaLike<TInput, TRawInput>;',
|
|
1322
1308
|
// Apps compile against this copy, not the base module's.
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
|
|
1309
|
+
' /** Documentation only. Never validated, and not an inference site for TOutput. */',
|
|
1310
|
+
' outputSchema?: SchemaLike<unknown>;',
|
|
1311
|
+
' stream?: TStream;',
|
|
1312
|
+
' authenticated?: boolean;',
|
|
1313
|
+
' /** When set, the endpoint also fires on this cron schedule. It stays request-callable — declaring one widens `context`, so `context.user` must be null-checked. */',
|
|
1314
|
+
' schedule?: TSchedule;',
|
|
1315
|
+
' /** When set, an inbound webhook can also trigger this endpoint. Like `schedule`, it widens `context` — a webhook fire has no session. */',
|
|
1316
|
+
' webhook?: TWebhook;',
|
|
1331
1317
|
" /** When set, a connection's events (registered by this file's own `subscribe` export), a poll (`every`), a change to one of the project's tables (`table`) or a submission to one of its forms (`form`) also fire this endpoint. Like `webhook`, it widens `context` — a trigger fire has no session. */",
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
|
|
1318
|
+
' trigger?: TTrigger;',
|
|
1319
|
+
' execute: (',
|
|
1320
|
+
' params: {',
|
|
1321
|
+
' input: ZiteEndpointInput<TInput, TTrigger>;',
|
|
1336
1322
|
' /** Durable steps: step.run(name, fn) runs fn once per logical run — its result is saved before anything after it executes, and a resumed run replays completed steps from their saved results. In a run fired by a schedule, webhook or trigger, step.sleep(name, "2d") pauses the run and a failed step is tried again. Provided by the platform; never define a local stand-in. */',
|
|
1337
|
-
|
|
1338
|
-
|
|
1323
|
+
' step: ZiteStep;',
|
|
1324
|
+
' context: TSchedule extends ZiteSchedule ? ZiteRequestContext | ZiteScheduledContext : TWebhook extends ZiteWebhook ? ZiteRequestContext | ZiteScheduledContext : TTrigger extends ZiteTrigger ? ZiteRequestContext | ZiteScheduledContext : ZiteRequestContext;',
|
|
1339
1325
|
// Mirrors the base module: a trigger's run gets `trigger`.
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
|
-
|
|
1348
|
-
|
|
1349
|
-
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
|
|
1353
|
-
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
-
|
|
1326
|
+
' } & (TStream extends true ? { stream: ZiteStreamInterface } : {}) & (TTrigger extends ZiteTrigger ? { trigger?: ZiteTriggerContext<TTrigger> } : {}),',
|
|
1327
|
+
' ) => Promise<TOutput> | TOutput;',
|
|
1328
|
+
'}',
|
|
1329
|
+
'',
|
|
1330
|
+
'export function createEndpoint<TInput = unknown, TOutput = unknown, TStream extends boolean = false, TSchedule extends ZiteSchedule | undefined = undefined, TWebhook extends ZiteWebhook | undefined = undefined, TRawInput = TInput, TTrigger extends ZiteTrigger | undefined = undefined>(',
|
|
1331
|
+
' config: EndpointConfig<TInput, TOutput, TStream, TSchedule, TWebhook, TRawInput, TTrigger>,',
|
|
1332
|
+
'): EndpointConfig<TInput, TOutput, TStream, TSchedule, TWebhook, TRawInput, TTrigger> {',
|
|
1333
|
+
' return config;',
|
|
1334
|
+
'}',
|
|
1335
|
+
'',
|
|
1336
|
+
'/**',
|
|
1337
|
+
' * Checks if a user has a specific role. Returns true if the user has the role, false',
|
|
1338
|
+
' * otherwise. If the user is not logged in, returns false.',
|
|
1339
|
+
' */',
|
|
1340
|
+
'export const hasRole = (context: ZiteRequestContext, roleId: string) => {',
|
|
1341
|
+
' return context.user?.roles?.some((r) => r.id === roleId);',
|
|
1342
|
+
'};',
|
|
1343
|
+
'',
|
|
1358
1344
|
// Declared in the wrapper (not a standalone .d.ts) so the merge is
|
|
1359
1345
|
// guaranteed to be in the program — every endpoint imports this file,
|
|
1360
1346
|
// while tsconfig `include` does not reliably pick up dot-directories.
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
...names.map(
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
|
|
1368
|
-
|
|
1369
|
-
].join(
|
|
1347
|
+
'declare global {',
|
|
1348
|
+
' namespace NodeJS {',
|
|
1349
|
+
' interface ProcessEnv {',
|
|
1350
|
+
...names.map(name => ` ${JSON.stringify(name)}: string;`),
|
|
1351
|
+
' }',
|
|
1352
|
+
' }',
|
|
1353
|
+
'}',
|
|
1354
|
+
'',
|
|
1355
|
+
].join('\n');
|
|
1370
1356
|
}
|
|
1371
1357
|
/**
|
|
1372
1358
|
* The key of the email integration an app sends through, which is the
|
|
@@ -1376,9 +1362,9 @@ function generateBackendWrapperTs(envVarNames = []) {
|
|
|
1376
1362
|
function findEmailIntegrationId(appConfig, workspaceConfig) {
|
|
1377
1363
|
const app = (appConfig ?? {});
|
|
1378
1364
|
const workspace = (workspaceConfig ?? {});
|
|
1379
|
-
const isEmail = (config, id) => config.integrations?.[id]?.type ===
|
|
1380
|
-
return (Object.keys(app.integrations ?? {}).find(
|
|
1381
|
-
Object.keys(app.integrationSettings ?? {}).find(
|
|
1365
|
+
const isEmail = (config, id) => config.integrations?.[id]?.type === 'email';
|
|
1366
|
+
return (Object.keys(app.integrations ?? {}).find(id => isEmail(app, id)) ??
|
|
1367
|
+
Object.keys(app.integrationSettings ?? {}).find(id => isEmail(workspace, id)));
|
|
1382
1368
|
}
|
|
1383
1369
|
/**
|
|
1384
1370
|
* Generate `.zite/integrations/email.ts` — the `Email` client for an app with
|
|
@@ -1387,52 +1373,52 @@ function findEmailIntegrationId(appConfig, workspaceConfig) {
|
|
|
1387
1373
|
* SDK bridge, resolved via the `zitejs/email` alias. `integrationId` is the
|
|
1388
1374
|
* connected integration's key.
|
|
1389
1375
|
*/
|
|
1390
|
-
function generateEmailSdk(integrationId) {
|
|
1376
|
+
function generateEmailSdk(integrationId, runtime = 'classic') {
|
|
1391
1377
|
return [
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1378
|
+
'// Auto-generated by zitejs generate from zite.config.json. Do not edit manually.',
|
|
1379
|
+
'// Email SDK — sends through the Zite email gateway via the runtime bridge.',
|
|
1380
|
+
'//',
|
|
1381
|
+
`// Usage in ${serverCodeIn(runtime)}:`,
|
|
1396
1382
|
"// import { Email } from 'zitejs/email';",
|
|
1397
|
-
|
|
1383
|
+
'//',
|
|
1398
1384
|
"// Always use 'zitejs/email' — never a relative path like '../../.zite/integrations/email'.",
|
|
1399
|
-
|
|
1400
|
-
|
|
1385
|
+
'// The tsconfig aliases resolve zitejs/* imports to the correct .zite/ files.',
|
|
1386
|
+
'//',
|
|
1401
1387
|
"// await Email.send({ to, subject, html: '<p>...</p>' })",
|
|
1402
|
-
|
|
1403
|
-
|
|
1404
|
-
|
|
1405
|
-
|
|
1406
|
-
|
|
1388
|
+
'// => { success: boolean; messageId: string; warnings?: string[] }',
|
|
1389
|
+
'//',
|
|
1390
|
+
'// Emails written before html support pass `body` (blocks) instead; they',
|
|
1391
|
+
'// keep working.',
|
|
1392
|
+
'//',
|
|
1407
1393
|
"// RTL languages (Hebrew, Arabic): pass direction: 'rtl'.",
|
|
1408
|
-
|
|
1409
|
-
|
|
1394
|
+
'//',
|
|
1395
|
+
'// await Email.sendBatch([...]) // up to 100, results in order',
|
|
1410
1396
|
"// await Email.get(messageId) // delivery status (Zite's sender only)",
|
|
1411
|
-
|
|
1397
|
+
'',
|
|
1412
1398
|
"import { createEmailClient } from 'zitejs/runtime';",
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
|
|
1399
|
+
'',
|
|
1400
|
+
'export type {',
|
|
1401
|
+
' EmailBlock,',
|
|
1402
|
+
' EmailStatus,',
|
|
1403
|
+
' SendBatchResult,',
|
|
1404
|
+
' SendBlocksEmailParams,',
|
|
1405
|
+
' SendEmailParams,',
|
|
1406
|
+
' SendEmailResult,',
|
|
1407
|
+
' SendHtmlEmailParams,',
|
|
1422
1408
|
"} from 'zitejs/runtime';",
|
|
1423
|
-
|
|
1409
|
+
'',
|
|
1424
1410
|
`export const Email = createEmailClient(${tsSingleQuoted(integrationId)});`,
|
|
1425
|
-
|
|
1426
|
-
].join(
|
|
1411
|
+
'',
|
|
1412
|
+
].join('\n');
|
|
1427
1413
|
}
|
|
1428
1414
|
const connectedTypeFor = (serviceType) => {
|
|
1429
1415
|
const extraLabels = rules_js_1.CREDENTIAL_FIELDS[serviceType].slice(1);
|
|
1430
1416
|
const optional = rules_js_1.OPTIONAL_CREDENTIAL_FIELDS[serviceType] ?? [];
|
|
1431
1417
|
return extraLabels.length === 0
|
|
1432
|
-
?
|
|
1418
|
+
? 'Connected'
|
|
1433
1419
|
: `Connected<{ ${extraLabels
|
|
1434
|
-
.map(
|
|
1435
|
-
.join(
|
|
1420
|
+
.map(label => `${label}${optional.includes(label) ? '?' : ''}: string`)
|
|
1421
|
+
.join('; ')} }>`;
|
|
1436
1422
|
};
|
|
1437
1423
|
/**
|
|
1438
1424
|
* `.zite/integrations/index.ts`: `zitejs/integrations` for one source dir. The
|
|
@@ -1442,42 +1428,42 @@ const connectedTypeFor = (serviceType) => {
|
|
|
1442
1428
|
function generateIntegrationsIndex(entries, opts) {
|
|
1443
1429
|
const sorted = [...entries].sort((a, b) => a.name < b.name ? -1 : a.name > b.name ? 1 : 0);
|
|
1444
1430
|
const nameUnion = sorted.length === 0
|
|
1445
|
-
?
|
|
1446
|
-
: sorted.map(({ name }) => tsSingleQuoted(name)).join(
|
|
1431
|
+
? 'never'
|
|
1432
|
+
: sorted.map(({ name }) => tsSingleQuoted(name)).join(' | ');
|
|
1447
1433
|
const byName = sorted.length === 0
|
|
1448
|
-
? [
|
|
1434
|
+
? ['export type IntegrationByName = {};']
|
|
1449
1435
|
: [
|
|
1450
|
-
|
|
1451
|
-
...sorted.map(({ name, serviceType, perUser }) => ` ${tsSingleQuoted(name)}: ${connectedTypeFor(serviceType)}${perUser ?
|
|
1452
|
-
|
|
1436
|
+
'export type IntegrationByName = {',
|
|
1437
|
+
...sorted.map(({ name, serviceType, perUser }) => ` ${tsSingleQuoted(name)}: ${connectedTypeFor(serviceType)}${perUser ? ' | NeedsConnect' : ''};`),
|
|
1438
|
+
'};',
|
|
1453
1439
|
];
|
|
1454
1440
|
return [
|
|
1455
|
-
|
|
1441
|
+
'// Auto-generated by zitejs generate from zite.config.json. Do not edit manually.',
|
|
1456
1442
|
"// zitejs/integrations — an integration's credentials by its zite.config.json entry name.",
|
|
1457
|
-
|
|
1458
|
-
|
|
1443
|
+
'//',
|
|
1444
|
+
'// Usage in endpoints (src/api/*.ts) and automations (src/index.ts):',
|
|
1459
1445
|
"// import { integrations } from 'zitejs/integrations';",
|
|
1460
|
-
|
|
1446
|
+
'//',
|
|
1461
1447
|
"// const { accessToken } = await integrations.get('<entry name>');",
|
|
1462
|
-
|
|
1448
|
+
'//',
|
|
1463
1449
|
"// A workspace connection that isn't connected throws a ZiteError. A per-user",
|
|
1464
|
-
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
|
|
1450
|
+
'// entry answers `missing`/`expired` with a connectUrl for the signed-in user.',
|
|
1451
|
+
'//',
|
|
1452
|
+
'// Call get where the value is used, not once at module scope: a token refreshed',
|
|
1453
|
+
'// mid-run is what the next call returns.',
|
|
1454
|
+
'',
|
|
1469
1455
|
// Not 'zitejs/integrations': apps alias that specifier to this very file.
|
|
1470
1456
|
"import { createIntegrationsClient } from 'zitejs/runtime';",
|
|
1471
1457
|
"import type { Connected, NeedsConnect } from 'zitejs/runtime';",
|
|
1472
|
-
|
|
1473
|
-
...(opts.reexportAirtable ? ["export * from './airtable';",
|
|
1474
|
-
|
|
1475
|
-
|
|
1458
|
+
'',
|
|
1459
|
+
...(opts.reexportAirtable ? ["export * from './airtable';", ''] : []),
|
|
1460
|
+
'export type { Connected, NeedsConnect };',
|
|
1461
|
+
'',
|
|
1476
1462
|
`export type IntegrationName = ${nameUnion};`,
|
|
1477
|
-
|
|
1463
|
+
'',
|
|
1478
1464
|
...byName,
|
|
1479
|
-
|
|
1480
|
-
|
|
1481
|
-
|
|
1482
|
-
].join(
|
|
1465
|
+
'',
|
|
1466
|
+
'export const integrations = createIntegrationsClient<IntegrationByName>();',
|
|
1467
|
+
'',
|
|
1468
|
+
].join('\n');
|
|
1483
1469
|
}
|