wrangler 0.0.0-e64812e → 0.0.0-e6c9c5c0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -3
- package/bin/wrangler.js +170 -62
- package/kv-asset-handler.js +1 -0
- package/miniflare-dist/index.mjs +1499 -21
- package/package.json +193 -152
- package/src/__tests__/access.test.ts +25 -0
- package/src/__tests__/api-dev.test.ts +238 -0
- package/src/__tests__/api-devregistry.test.js +64 -0
- package/src/__tests__/api.test.ts +80 -0
- package/src/__tests__/config-cache-without-cache-dir.test.ts +38 -0
- package/src/__tests__/config-cache.test.ts +30 -24
- package/src/__tests__/configuration.test.ts +4152 -3363
- package/src/__tests__/d1/d1.test.ts +127 -0
- package/src/__tests__/d1/splitter.test.ts +255 -0
- package/src/__tests__/delete.test.ts +266 -0
- package/src/__tests__/deployments.test.ts +105 -0
- package/src/__tests__/dev.test.tsx +1558 -952
- package/src/__tests__/generate.test.ts +238 -0
- package/src/__tests__/get-host-from-url.test.ts +16 -0
- package/src/__tests__/guess-worker-format.test.ts +68 -68
- package/src/__tests__/helpers/cmd-shim.d.ts +6 -6
- package/src/__tests__/helpers/mock-account-id.ts +24 -24
- package/src/__tests__/helpers/mock-auth-domain.ts +20 -0
- package/src/__tests__/helpers/mock-bin.ts +20 -20
- package/src/__tests__/helpers/mock-console.ts +58 -39
- package/src/__tests__/helpers/mock-dialogs.ts +88 -79
- package/src/__tests__/helpers/mock-get-zone-from-host.ts +11 -0
- package/src/__tests__/helpers/mock-http-server.ts +30 -30
- package/src/__tests__/helpers/mock-istty.ts +65 -18
- package/src/__tests__/helpers/mock-known-routes.ts +12 -0
- package/src/__tests__/helpers/mock-kv.ts +41 -28
- package/src/__tests__/helpers/mock-oauth-flow.ts +241 -233
- package/src/__tests__/helpers/mock-process.ts +34 -0
- package/src/__tests__/helpers/mock-stdin.ts +82 -77
- package/src/__tests__/helpers/mock-web-socket.ts +21 -21
- package/src/__tests__/helpers/msw/blob-worker.cjs +19 -0
- package/src/__tests__/helpers/msw/handlers/access.ts +13 -0
- package/src/__tests__/helpers/msw/handlers/deployments.ts +69 -0
- package/src/__tests__/helpers/msw/handlers/namespaces.ts +81 -0
- package/src/__tests__/helpers/msw/handlers/oauth.ts +31 -0
- package/src/__tests__/helpers/msw/handlers/r2.ts +60 -0
- package/src/__tests__/helpers/msw/handlers/script.ts +56 -0
- package/src/__tests__/helpers/msw/handlers/user.ts +52 -0
- package/src/__tests__/helpers/msw/handlers/zones.ts +20 -0
- package/src/__tests__/helpers/msw/index.ts +50 -0
- package/src/__tests__/helpers/msw/read-file-sync.js +61 -0
- package/src/__tests__/helpers/run-in-tmp.ts +27 -28
- package/src/__tests__/helpers/run-wrangler.ts +8 -8
- package/src/__tests__/helpers/worker-scripts/child-wrangler.toml +1 -0
- package/src/__tests__/helpers/worker-scripts/hello-world-worker.js +5 -0
- package/src/__tests__/helpers/worker-scripts/hello-world-wrangler.toml +1 -0
- package/src/__tests__/helpers/worker-scripts/parent-worker.js +8 -0
- package/src/__tests__/helpers/worker-scripts/parent-wrangler.toml +5 -0
- package/src/__tests__/helpers/write-worker-source.ts +16 -16
- package/src/__tests__/helpers/write-wrangler-toml.ts +9 -9
- package/src/__tests__/https-options.test.ts +142 -109
- package/src/__tests__/index.test.ts +245 -233
- package/src/__tests__/init.test.ts +3135 -1605
- package/src/__tests__/jest.setup.ts +148 -50
- package/src/__tests__/kv.test.ts +1778 -1471
- package/src/__tests__/logger.test.ts +100 -74
- package/src/__tests__/logout.test.ts +47 -0
- package/src/__tests__/metrics.test.ts +493 -0
- package/src/__tests__/middleware.scheduled.test.ts +145 -0
- package/src/__tests__/middleware.test.ts +750 -0
- package/src/__tests__/package-manager.test.ts +303 -303
- package/src/__tests__/pages-deployment-tail.test.ts +955 -0
- package/src/__tests__/pages.test.ts +2887 -743
- package/src/__tests__/parse.test.ts +252 -252
- package/src/__tests__/paths.test.ts +39 -0
- package/src/__tests__/publish.test.ts +8004 -5355
- package/src/__tests__/pubsub.test.ts +490 -0
- package/src/__tests__/queues.test.ts +522 -0
- package/src/__tests__/r2.test.ts +364 -228
- package/src/__tests__/route.test.ts +18 -18
- package/src/__tests__/secret.test.ts +681 -469
- package/src/__tests__/tail.test.ts +835 -567
- package/src/__tests__/test-old-node-version.js +31 -0
- package/src/__tests__/tsconfig-sanity.ts +12 -0
- package/src/__tests__/tsconfig.json +8 -0
- package/src/__tests__/tsconfig.tsbuildinfo +1 -0
- package/src/__tests__/type-generation.test.ts +233 -0
- package/src/__tests__/user.test.ts +107 -120
- package/src/__tests__/utils-collectKeyValues.test.ts +47 -0
- package/src/__tests__/validate-dev-props.test.ts +56 -0
- package/src/__tests__/version.test.ts +35 -0
- package/src/__tests__/whoami.test.tsx +165 -98
- package/src/__tests__/worker-namespace.test.ts +334 -0
- package/src/abort.d.ts +1 -1
- package/src/api/dev.ts +259 -0
- package/src/api/index.ts +3 -0
- package/src/api/pages/index.ts +5 -0
- package/src/api/pages/publish.tsx +321 -0
- package/src/bundle-reporter.ts +68 -0
- package/src/bundle.ts +838 -163
- package/src/cfetch/index.ts +120 -83
- package/src/cfetch/internal.ts +210 -97
- package/src/cli.ts +23 -8
- package/src/config/config.ts +236 -195
- package/src/config/diagnostics.ts +61 -61
- package/src/config/environment.ts +516 -357
- package/src/config/index.ts +326 -193
- package/src/config/validation-helpers.ts +379 -357
- package/src/config/validation.ts +1979 -1367
- package/src/config-cache.ts +81 -41
- package/src/create-worker-preview.ts +239 -142
- package/src/create-worker-upload-form.ts +309 -238
- package/src/d1/backups.tsx +219 -0
- package/src/d1/constants.ts +2 -0
- package/src/d1/create.tsx +63 -0
- package/src/d1/delete.ts +56 -0
- package/src/d1/execute.tsx +323 -0
- package/src/d1/formatTimeAgo.ts +14 -0
- package/src/d1/index.ts +101 -0
- package/src/d1/list.tsx +48 -0
- package/src/d1/migrations/apply.tsx +197 -0
- package/src/d1/migrations/create.tsx +77 -0
- package/src/d1/migrations/helpers.ts +147 -0
- package/src/d1/migrations/index.ts +3 -0
- package/src/d1/migrations/list.tsx +79 -0
- package/src/d1/migrations/options.ts +18 -0
- package/src/d1/options.ts +22 -0
- package/src/d1/splitter.ts +161 -0
- package/src/d1/types.ts +24 -0
- package/src/d1/utils.ts +48 -0
- package/src/delete.ts +103 -0
- package/src/deployments.ts +93 -0
- package/src/deprecated/index.ts +145 -0
- package/src/dev/dev-vars.ts +20 -17
- package/src/dev/dev.tsx +547 -352
- package/src/dev/get-local-persistence-path.ts +31 -0
- package/src/dev/local.tsx +903 -298
- package/src/dev/remote.tsx +620 -215
- package/src/dev/start-server.ts +538 -0
- package/src/dev/use-esbuild.ts +184 -97
- package/src/dev/validate-dev-props.ts +31 -0
- package/src/dev-registry.ts +201 -0
- package/src/dev.tsx +949 -0
- package/src/dialogs.ts +136 -0
- package/src/dispatch-namespace.ts +207 -0
- package/src/docs/index.ts +98 -0
- package/src/durable.ts +87 -87
- package/src/entry.ts +236 -230
- package/src/environment-variables/factory.ts +88 -0
- package/src/environment-variables/misc-variables.ts +30 -0
- package/src/errors.ts +6 -6
- package/src/generate/index.ts +300 -0
- package/src/git-client.ts +135 -0
- package/src/global-wrangler-config-path.ts +26 -0
- package/src/https-options.ts +84 -80
- package/src/index.ts +694 -0
- package/src/init.ts +1024 -0
- package/src/inspect.ts +698 -593
- package/src/intl-polyfill.d.ts +123 -123
- package/src/is-ci.ts +14 -0
- package/src/is-interactive.ts +16 -0
- package/src/jest.d.ts +4 -0
- package/src/kv/helpers.ts +430 -0
- package/src/kv/index.ts +596 -0
- package/src/logger.ts +80 -42
- package/src/metrics/index.ts +5 -0
- package/src/metrics/metrics-config.ts +239 -0
- package/src/metrics/metrics-dispatcher.ts +96 -0
- package/src/metrics/metrics-usage-headers.ts +24 -0
- package/src/metrics/send-event.ts +98 -0
- package/src/miniflare-cli/assets.ts +250 -0
- package/src/miniflare-cli/index.ts +202 -33
- package/src/miniflare-cli/request-context.ts +18 -18
- package/src/miniflare-cli/tsconfig.json +9 -0
- package/src/miniflare-cli/tsconfig.tsbuildinfo +1 -0
- package/src/miniflare-cli/types.ts +11 -0
- package/src/module-collection.ts +221 -212
- package/src/open-in-browser.ts +4 -6
- package/src/package-manager.ts +173 -128
- package/src/pages/build.ts +150 -0
- package/src/pages/buildFunctions.ts +129 -0
- package/src/pages/constants.ts +18 -0
- package/src/pages/deployment-tails.ts +284 -0
- package/src/pages/deployments.tsx +84 -0
- package/src/pages/dev.ts +716 -0
- package/src/pages/errors.ts +66 -0
- package/src/pages/functions/buildPlugin.ts +90 -0
- package/src/pages/functions/buildWorker.ts +288 -0
- package/{pages → src/pages}/functions/filepath-routing.test.ts +113 -113
- package/src/pages/functions/filepath-routing.ts +189 -0
- package/src/pages/functions/identifiers.ts +78 -0
- package/src/pages/functions/routes-consolidation.test.ts +250 -0
- package/src/pages/functions/routes-consolidation.ts +73 -0
- package/src/pages/functions/routes-transformation.test.ts +282 -0
- package/src/pages/functions/routes-transformation.ts +115 -0
- package/src/pages/functions/routes-validation.test.ts +403 -0
- package/src/pages/functions/routes-validation.ts +202 -0
- package/src/pages/functions/routes.ts +151 -0
- package/src/pages/functions/tsconfig.json +8 -0
- package/src/pages/functions/tsconfig.tsbuildinfo +1 -0
- package/src/pages/functions.ts +82 -0
- package/src/pages/hash.ts +13 -0
- package/src/pages/index.ts +102 -0
- package/src/pages/projects.tsx +167 -0
- package/src/pages/prompt-select-project.tsx +31 -0
- package/src/pages/publish.tsx +263 -0
- package/src/pages/types.ts +41 -0
- package/src/pages/upload.tsx +447 -0
- package/src/pages/utils.ts +23 -0
- package/src/parse.ts +209 -125
- package/src/paths.ts +53 -8
- package/src/proxy.ts +623 -394
- package/src/publish/index.ts +270 -0
- package/src/publish/publish.ts +1064 -0
- package/src/pubsub/index.ts +286 -0
- package/src/pubsub/pubsub-commands.ts +624 -0
- package/src/queues/cli/commands/consumer/add.ts +71 -0
- package/src/queues/cli/commands/consumer/index.ts +22 -0
- package/src/queues/cli/commands/consumer/remove.ts +38 -0
- package/src/queues/cli/commands/create.ts +25 -0
- package/src/queues/cli/commands/delete.ts +26 -0
- package/src/queues/cli/commands/index.ts +36 -0
- package/src/queues/cli/commands/list.ts +25 -0
- package/src/queues/client.ts +135 -0
- package/src/queues/utils.ts +18 -0
- package/src/r2/constants.ts +4 -0
- package/src/r2/helpers.ts +131 -0
- package/src/r2/index.ts +289 -0
- package/src/routes.ts +140 -0
- package/src/secret/index.ts +379 -0
- package/src/selfsigned.d.ts +23 -23
- package/src/sites.ts +372 -0
- package/src/tail/createTail.ts +406 -0
- package/src/tail/filters.ts +108 -110
- package/src/tail/index.ts +210 -296
- package/src/tail/printing.ts +101 -46
- package/src/tsconfig-sanity.ts +16 -0
- package/src/type-generation.ts +181 -0
- package/src/update-check.ts +11 -11
- package/src/user/access.ts +68 -0
- package/src/user/auth-variables.ts +113 -0
- package/src/user/choose-account.tsx +39 -0
- package/src/user/generate-auth-url.ts +33 -0
- package/src/user/generate-random-state.ts +16 -0
- package/src/user/index.ts +2 -0
- package/src/user/user.ts +1232 -0
- package/src/utils/collectKeyValues.ts +14 -0
- package/src/whoami.ts +135 -0
- package/src/worker.ts +177 -106
- package/src/yargs-types.ts +24 -0
- package/src/zones.ts +191 -0
- package/templates/__tests__/pages-dev-util.test.ts +128 -0
- package/templates/__tests__/tsconfig-sanity.ts +12 -0
- package/templates/__tests__/tsconfig.json +8 -0
- package/templates/__tests__/tsconfig.tsbuildinfo +1 -0
- package/templates/checked-fetch.js +15 -0
- package/templates/d1-beta-facade.js +241 -0
- package/templates/facade.d.ts +14 -0
- package/templates/first-party-worker-module-facade.ts +19 -0
- package/templates/format-dev-errors.ts +33 -0
- package/templates/init-tests/test-jest-new-worker.js +23 -0
- package/templates/init-tests/test-vitest-new-worker.js +24 -0
- package/templates/init-tests/test-vitest-new-worker.ts +25 -0
- package/templates/middleware/common.ts +62 -0
- package/templates/middleware/loader-modules.ts +84 -0
- package/templates/middleware/loader-sw.ts +233 -0
- package/templates/middleware/middleware-miniflare3-json-error.ts +20 -0
- package/templates/middleware/middleware-pretty-error.ts +40 -0
- package/templates/middleware/middleware-scheduled.ts +15 -0
- package/templates/new-worker-scheduled.js +3 -3
- package/templates/new-worker-scheduled.ts +15 -15
- package/templates/new-worker.js +3 -3
- package/templates/new-worker.ts +15 -15
- package/templates/no-op-worker.js +10 -0
- package/templates/pages-dev-pipeline.ts +31 -0
- package/templates/pages-dev-util.ts +52 -0
- package/templates/pages-shim.ts +12 -0
- package/templates/pages-template-plugin.ts +176 -0
- package/templates/pages-template-worker.ts +189 -0
- package/templates/serve-static-assets.ts +65 -0
- package/templates/service-bindings-module-facade.js +54 -0
- package/templates/service-bindings-sw-facade.js +42 -0
- package/templates/tsconfig-sanity.ts +11 -0
- package/templates/tsconfig.init.json +106 -0
- package/templates/tsconfig.json +6 -103
- package/templates/tsconfig.tsbuildinfo +1 -0
- package/wrangler-dist/cli.d.ts +1028 -0
- package/wrangler-dist/cli.js +129259 -110922
- package/wrangler-dist/wasm-sync.wasm +0 -0
- package/pages/functions/buildPlugin.ts +0 -105
- package/pages/functions/buildWorker.ts +0 -151
- package/pages/functions/filepath-routing.ts +0 -189
- package/pages/functions/identifiers.ts +0 -78
- package/pages/functions/routes.ts +0 -156
- package/pages/functions/template-plugin.ts +0 -147
- package/pages/functions/template-worker.ts +0 -143
- package/src/__tests__/helpers/faye-websocket.d.ts +0 -6
- package/src/__tests__/helpers/mock-cfetch.ts +0 -211
- package/src/dialogs.tsx +0 -135
- package/src/environment-variables.ts +0 -35
- package/src/index.tsx +0 -2864
- package/src/kv.ts +0 -408
- package/src/miniflare-cli/enum-keys.ts +0 -17
- package/src/pages.tsx +0 -2038
- package/src/publish.ts +0 -583
- package/src/r2.ts +0 -50
- package/src/sites.tsx +0 -295
- package/src/user.tsx +0 -1203
- package/src/whoami.tsx +0 -70
- package/templates/static-asset-facade.js +0 -47
- package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
- package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
- package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
- package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
- package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
- package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
- package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
- package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
- package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
- package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
- package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
- package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
- package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
- package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
- package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
- package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
- package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
- package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
- package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
- package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
- package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
- package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
- package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
- package/vendor/wrangler-mime/CHANGELOG.md +0 -289
- package/vendor/wrangler-mime/LICENSE +0 -21
- package/vendor/wrangler-mime/Mime.js +0 -97
- package/vendor/wrangler-mime/README.md +0 -187
- package/vendor/wrangler-mime/cli.js +0 -46
- package/vendor/wrangler-mime/index.js +0 -4
- package/vendor/wrangler-mime/lite.js +0 -4
- package/vendor/wrangler-mime/package.json +0 -52
- package/vendor/wrangler-mime/types/other.js +0 -1
- package/vendor/wrangler-mime/types/standard.js +0 -1
package/src/kv.ts
DELETED
|
@@ -1,408 +0,0 @@
|
|
|
1
|
-
import { URLSearchParams } from "node:url";
|
|
2
|
-
import { fetchListResult, fetchResult, fetchKVGetValue } from "./cfetch";
|
|
3
|
-
import { logger } from "./logger";
|
|
4
|
-
import type { Config } from "./config";
|
|
5
|
-
|
|
6
|
-
/** The largest number of kv items we can pass to the API in a single request. */
|
|
7
|
-
const API_MAX = 10000;
|
|
8
|
-
// The const below are halved from the API's true capacity to help avoid
|
|
9
|
-
// hammering it with large requests.
|
|
10
|
-
const BATCH_KEY_MAX = API_MAX / 2;
|
|
11
|
-
|
|
12
|
-
type KvArgs = {
|
|
13
|
-
binding?: string;
|
|
14
|
-
"namespace-id"?: string;
|
|
15
|
-
preview?: boolean;
|
|
16
|
-
};
|
|
17
|
-
|
|
18
|
-
/**
|
|
19
|
-
* Create a new namespace under the given `accountId` with the given `title`.
|
|
20
|
-
*
|
|
21
|
-
* @returns the generated id of the created namespace.
|
|
22
|
-
*/
|
|
23
|
-
export async function createKVNamespace(
|
|
24
|
-
accountId: string,
|
|
25
|
-
title: string
|
|
26
|
-
): Promise<string> {
|
|
27
|
-
const response = await fetchResult<{ id: string }>(
|
|
28
|
-
`/accounts/${accountId}/storage/kv/namespaces`,
|
|
29
|
-
{
|
|
30
|
-
method: "POST",
|
|
31
|
-
headers: {
|
|
32
|
-
"Content-Type": "application/json",
|
|
33
|
-
},
|
|
34
|
-
body: JSON.stringify({
|
|
35
|
-
title,
|
|
36
|
-
}),
|
|
37
|
-
}
|
|
38
|
-
);
|
|
39
|
-
|
|
40
|
-
return response.id;
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
/**
|
|
44
|
-
* The information about a namespace that is returned from `listNamespaces()`.
|
|
45
|
-
*/
|
|
46
|
-
export interface KVNamespaceInfo {
|
|
47
|
-
id: string;
|
|
48
|
-
title: string;
|
|
49
|
-
supports_url_encoding?: boolean;
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
/**
|
|
53
|
-
* Fetch a list of all the namespaces under the given `accountId`.
|
|
54
|
-
*/
|
|
55
|
-
export async function listKVNamespaces(
|
|
56
|
-
accountId: string
|
|
57
|
-
): Promise<KVNamespaceInfo[]> {
|
|
58
|
-
const pageSize = 100;
|
|
59
|
-
let page = 1;
|
|
60
|
-
const results: KVNamespaceInfo[] = [];
|
|
61
|
-
while (results.length % pageSize === 0) {
|
|
62
|
-
const json = await fetchResult<KVNamespaceInfo[]>(
|
|
63
|
-
`/accounts/${accountId}/storage/kv/namespaces`,
|
|
64
|
-
{},
|
|
65
|
-
new URLSearchParams({
|
|
66
|
-
per_page: pageSize.toString(),
|
|
67
|
-
order: "title",
|
|
68
|
-
direction: "asc",
|
|
69
|
-
page: page.toString(),
|
|
70
|
-
})
|
|
71
|
-
);
|
|
72
|
-
page++;
|
|
73
|
-
results.push(...json);
|
|
74
|
-
if (json.length < pageSize) {
|
|
75
|
-
break;
|
|
76
|
-
}
|
|
77
|
-
}
|
|
78
|
-
return results;
|
|
79
|
-
}
|
|
80
|
-
|
|
81
|
-
export interface NamespaceKeyInfo {
|
|
82
|
-
name: string;
|
|
83
|
-
expiration?: number;
|
|
84
|
-
metadata?: { [key: string]: unknown };
|
|
85
|
-
}
|
|
86
|
-
|
|
87
|
-
export async function listKVNamespaceKeys(
|
|
88
|
-
accountId: string,
|
|
89
|
-
namespaceId: string,
|
|
90
|
-
prefix = ""
|
|
91
|
-
) {
|
|
92
|
-
return await fetchListResult<NamespaceKeyInfo>(
|
|
93
|
-
`/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/keys`,
|
|
94
|
-
{},
|
|
95
|
-
new URLSearchParams({ prefix })
|
|
96
|
-
);
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
export async function deleteKVNamespace(
|
|
100
|
-
accountId: string,
|
|
101
|
-
namespaceId: string
|
|
102
|
-
) {
|
|
103
|
-
return await fetchResult<{ id: string }>(
|
|
104
|
-
`/accounts/${accountId}/storage/kv/namespaces/${namespaceId}`,
|
|
105
|
-
{ method: "DELETE" }
|
|
106
|
-
);
|
|
107
|
-
}
|
|
108
|
-
|
|
109
|
-
/**
|
|
110
|
-
* Information about a key-value pair, including its "metadata" fields.
|
|
111
|
-
*/
|
|
112
|
-
export interface KeyValue {
|
|
113
|
-
key: string;
|
|
114
|
-
value: string;
|
|
115
|
-
expiration?: number;
|
|
116
|
-
expiration_ttl?: number;
|
|
117
|
-
metadata?: object;
|
|
118
|
-
base64?: boolean;
|
|
119
|
-
}
|
|
120
|
-
|
|
121
|
-
const KeyValueKeys = new Set([
|
|
122
|
-
"key",
|
|
123
|
-
"value",
|
|
124
|
-
"expiration",
|
|
125
|
-
"expiration_ttl",
|
|
126
|
-
"metadata",
|
|
127
|
-
"base64",
|
|
128
|
-
]);
|
|
129
|
-
|
|
130
|
-
/**
|
|
131
|
-
* The object has the specified property.
|
|
132
|
-
*/
|
|
133
|
-
function hasProperty<T extends object>(
|
|
134
|
-
obj: object,
|
|
135
|
-
property: keyof T
|
|
136
|
-
): obj is T {
|
|
137
|
-
return property in obj;
|
|
138
|
-
}
|
|
139
|
-
|
|
140
|
-
/**
|
|
141
|
-
* The object has a required property of the specified type.
|
|
142
|
-
*/
|
|
143
|
-
function hasTypedProperty<T extends object>(
|
|
144
|
-
obj: object,
|
|
145
|
-
property: keyof T,
|
|
146
|
-
type: string
|
|
147
|
-
): obj is T {
|
|
148
|
-
return hasProperty(obj, property) && typeof obj[property] === type;
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
/**
|
|
152
|
-
* The object an optional property, of the specified type.
|
|
153
|
-
*/
|
|
154
|
-
function hasOptionalTypedProperty<T extends object>(
|
|
155
|
-
obj: object,
|
|
156
|
-
property: keyof T,
|
|
157
|
-
type: string
|
|
158
|
-
): obj is Omit<T, typeof property> | T {
|
|
159
|
-
return !hasProperty(obj, property) || typeof obj[property] === type;
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
/**
|
|
163
|
-
* Is the given object a valid `KeyValue` type?
|
|
164
|
-
*/
|
|
165
|
-
export function isKVKeyValue(keyValue: unknown): keyValue is KeyValue {
|
|
166
|
-
if (
|
|
167
|
-
keyValue === null ||
|
|
168
|
-
typeof keyValue !== "object" ||
|
|
169
|
-
!hasTypedProperty(keyValue, "key", "string") ||
|
|
170
|
-
!hasTypedProperty(keyValue, "value", "string") ||
|
|
171
|
-
!hasOptionalTypedProperty(keyValue, "expiration", "number") ||
|
|
172
|
-
!hasOptionalTypedProperty(keyValue, "expiration_ttl", "number") ||
|
|
173
|
-
!hasOptionalTypedProperty(keyValue, "base64", "boolean") ||
|
|
174
|
-
!hasOptionalTypedProperty(keyValue, "metadata", "object")
|
|
175
|
-
) {
|
|
176
|
-
return false;
|
|
177
|
-
}
|
|
178
|
-
return true;
|
|
179
|
-
}
|
|
180
|
-
|
|
181
|
-
/**
|
|
182
|
-
* Get all the properties on the `keyValue` that are not expected.
|
|
183
|
-
*/
|
|
184
|
-
export function unexpectedKVKeyValueProps(keyValue: KeyValue): string[] {
|
|
185
|
-
const props = Object.keys(keyValue);
|
|
186
|
-
return props.filter((prop) => !KeyValueKeys.has(prop));
|
|
187
|
-
}
|
|
188
|
-
|
|
189
|
-
export async function putKVKeyValue(
|
|
190
|
-
accountId: string,
|
|
191
|
-
namespaceId: string,
|
|
192
|
-
keyValue: KeyValue
|
|
193
|
-
) {
|
|
194
|
-
let searchParams: URLSearchParams | undefined;
|
|
195
|
-
if (keyValue.expiration || keyValue.expiration_ttl) {
|
|
196
|
-
searchParams = new URLSearchParams();
|
|
197
|
-
if (keyValue.expiration) {
|
|
198
|
-
searchParams.set("expiration", `${keyValue.expiration}`);
|
|
199
|
-
}
|
|
200
|
-
if (keyValue.expiration_ttl) {
|
|
201
|
-
searchParams.set("expiration_ttl", `${keyValue.expiration_ttl}`);
|
|
202
|
-
}
|
|
203
|
-
}
|
|
204
|
-
return await fetchResult(
|
|
205
|
-
`/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${encodeURIComponent(
|
|
206
|
-
keyValue.key
|
|
207
|
-
)}`,
|
|
208
|
-
{ method: "PUT", body: keyValue.value },
|
|
209
|
-
searchParams
|
|
210
|
-
);
|
|
211
|
-
}
|
|
212
|
-
|
|
213
|
-
export async function getKVKeyValue(
|
|
214
|
-
accountId: string,
|
|
215
|
-
namespaceId: string,
|
|
216
|
-
key: string
|
|
217
|
-
): Promise<string> {
|
|
218
|
-
return await fetchKVGetValue(accountId, namespaceId, encodeURIComponent(key));
|
|
219
|
-
}
|
|
220
|
-
|
|
221
|
-
export async function deleteKVKeyValue(
|
|
222
|
-
accountId: string,
|
|
223
|
-
namespaceId: string,
|
|
224
|
-
key: string
|
|
225
|
-
) {
|
|
226
|
-
return await fetchResult(
|
|
227
|
-
`/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${encodeURIComponent(
|
|
228
|
-
key
|
|
229
|
-
)}`,
|
|
230
|
-
{ method: "DELETE" }
|
|
231
|
-
);
|
|
232
|
-
}
|
|
233
|
-
|
|
234
|
-
/**
|
|
235
|
-
* Formatter for converting e.g. 5328 --> 5,328
|
|
236
|
-
*/
|
|
237
|
-
const formatNumber = new Intl.NumberFormat("en-US", {
|
|
238
|
-
notation: "standard",
|
|
239
|
-
}).format;
|
|
240
|
-
|
|
241
|
-
/**
|
|
242
|
-
* Helper function for bulk requests, logs ongoing output to console.
|
|
243
|
-
*/
|
|
244
|
-
function logBulkProgress(
|
|
245
|
-
operation: "put" | "delete",
|
|
246
|
-
index: number,
|
|
247
|
-
total: number
|
|
248
|
-
) {
|
|
249
|
-
logger.log(
|
|
250
|
-
`${operation === "put" ? "Uploaded" : "Deleted"} ${Math.floor(
|
|
251
|
-
(100 * index) / total
|
|
252
|
-
)}% (${formatNumber(index)} out of ${formatNumber(total)})`
|
|
253
|
-
);
|
|
254
|
-
}
|
|
255
|
-
|
|
256
|
-
export async function putKVBulkKeyValue(
|
|
257
|
-
accountId: string,
|
|
258
|
-
namespaceId: string,
|
|
259
|
-
keyValues: KeyValue[],
|
|
260
|
-
quiet = false
|
|
261
|
-
) {
|
|
262
|
-
for (let index = 0; index < keyValues.length; index += BATCH_KEY_MAX) {
|
|
263
|
-
if (!quiet && keyValues.length > BATCH_KEY_MAX) {
|
|
264
|
-
logBulkProgress("put", index, keyValues.length);
|
|
265
|
-
}
|
|
266
|
-
|
|
267
|
-
await fetchResult(
|
|
268
|
-
`/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/bulk`,
|
|
269
|
-
{
|
|
270
|
-
method: "PUT",
|
|
271
|
-
body: JSON.stringify(keyValues.slice(index, index + BATCH_KEY_MAX)),
|
|
272
|
-
headers: { "Content-Type": "application/json" },
|
|
273
|
-
}
|
|
274
|
-
);
|
|
275
|
-
}
|
|
276
|
-
|
|
277
|
-
if (!quiet && keyValues.length > BATCH_KEY_MAX) {
|
|
278
|
-
logBulkProgress("put", keyValues.length, keyValues.length);
|
|
279
|
-
}
|
|
280
|
-
}
|
|
281
|
-
|
|
282
|
-
export async function deleteKVBulkKeyValue(
|
|
283
|
-
accountId: string,
|
|
284
|
-
namespaceId: string,
|
|
285
|
-
keys: string[],
|
|
286
|
-
quiet = false
|
|
287
|
-
) {
|
|
288
|
-
for (let index = 0; index < keys.length; index += BATCH_KEY_MAX) {
|
|
289
|
-
if (!quiet && keys.length > BATCH_KEY_MAX) {
|
|
290
|
-
logBulkProgress("delete", index, keys.length);
|
|
291
|
-
}
|
|
292
|
-
|
|
293
|
-
await fetchResult(
|
|
294
|
-
`/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/bulk`,
|
|
295
|
-
{
|
|
296
|
-
method: "DELETE",
|
|
297
|
-
body: JSON.stringify(keys.slice(index, index + BATCH_KEY_MAX)),
|
|
298
|
-
headers: { "Content-Type": "application/json" },
|
|
299
|
-
}
|
|
300
|
-
);
|
|
301
|
-
}
|
|
302
|
-
if (!quiet && keys.length > BATCH_KEY_MAX) {
|
|
303
|
-
logBulkProgress("delete", keys.length, keys.length);
|
|
304
|
-
}
|
|
305
|
-
}
|
|
306
|
-
|
|
307
|
-
export function getKVNamespaceId(
|
|
308
|
-
{ preview, binding, "namespace-id": namespaceId }: KvArgs,
|
|
309
|
-
config: Config
|
|
310
|
-
): string {
|
|
311
|
-
// nice
|
|
312
|
-
if (namespaceId) {
|
|
313
|
-
return namespaceId;
|
|
314
|
-
}
|
|
315
|
-
|
|
316
|
-
// begin pre-flight checks
|
|
317
|
-
|
|
318
|
-
// `--binding` is only valid if there's a wrangler configuration.
|
|
319
|
-
if (binding && !config) {
|
|
320
|
-
throw new Error("--binding specified, but no config file was found.");
|
|
321
|
-
}
|
|
322
|
-
|
|
323
|
-
// there's no config. abort here
|
|
324
|
-
if (!config) {
|
|
325
|
-
throw new Error(
|
|
326
|
-
"Failed to find a config file.\n" +
|
|
327
|
-
"Either use --namespace-id to upload directly or create a configuration file with a binding."
|
|
328
|
-
);
|
|
329
|
-
}
|
|
330
|
-
|
|
331
|
-
// there's no KV namespaces
|
|
332
|
-
if (!config.kv_namespaces || config.kv_namespaces.length === 0) {
|
|
333
|
-
throw new Error(
|
|
334
|
-
"No KV Namespaces configured! Either use --namespace-id to upload directly or add a KV namespace to your wrangler config file."
|
|
335
|
-
);
|
|
336
|
-
}
|
|
337
|
-
|
|
338
|
-
const namespace = config.kv_namespaces.find((ns) => ns.binding === binding);
|
|
339
|
-
|
|
340
|
-
// we couldn't find a namespace with that binding
|
|
341
|
-
if (!namespace) {
|
|
342
|
-
throw new Error(
|
|
343
|
-
`A namespace with binding name "${binding}" was not found in the configured "kv_namespaces".`
|
|
344
|
-
);
|
|
345
|
-
}
|
|
346
|
-
|
|
347
|
-
// end pre-flight checks
|
|
348
|
-
|
|
349
|
-
// we're in preview mode, `--preview true` or `--preview` was passed
|
|
350
|
-
if (preview && namespace.preview_id) {
|
|
351
|
-
namespaceId = namespace.preview_id;
|
|
352
|
-
// We don't want to execute code below if preview is set to true, so we just return. Otherwise we will get errors!
|
|
353
|
-
return namespaceId;
|
|
354
|
-
} else if (preview) {
|
|
355
|
-
throw new Error(
|
|
356
|
-
`No preview ID found for ${binding}. Add one to your wrangler config file to use a separate namespace for previewing your worker.`
|
|
357
|
-
);
|
|
358
|
-
}
|
|
359
|
-
|
|
360
|
-
// either `--preview false`, or preview wasn't passed
|
|
361
|
-
// TODO: should we care? or should we just treat false and undefined the same
|
|
362
|
-
const previewIsDefined = typeof preview !== "undefined";
|
|
363
|
-
|
|
364
|
-
// --preview false was passed
|
|
365
|
-
if (previewIsDefined && namespace.id) {
|
|
366
|
-
namespaceId = namespace.id;
|
|
367
|
-
// We don't want to execute code below if preview is set to true, so we just return. Otherwise we can get error!
|
|
368
|
-
return namespaceId;
|
|
369
|
-
} else if (previewIsDefined) {
|
|
370
|
-
throw new Error(
|
|
371
|
-
`No namespace ID found for ${binding}. Add one to your wrangler config file to use a separate namespace for previewing your worker.`
|
|
372
|
-
);
|
|
373
|
-
}
|
|
374
|
-
|
|
375
|
-
// `--preview` wasn't passed
|
|
376
|
-
const bindingHasOnlyOneId =
|
|
377
|
-
(namespace.id && !namespace.preview_id) ||
|
|
378
|
-
(!namespace.id && namespace.preview_id);
|
|
379
|
-
if (bindingHasOnlyOneId) {
|
|
380
|
-
namespaceId = namespace.id || namespace.preview_id;
|
|
381
|
-
} else {
|
|
382
|
-
throw new Error(
|
|
383
|
-
`${binding} has both a namespace ID and a preview ID. Specify "--preview" or "--preview false" to avoid writing data to the wrong namespace.`
|
|
384
|
-
);
|
|
385
|
-
}
|
|
386
|
-
|
|
387
|
-
// shouldn't happen. we should be able to prove this with strong typing.
|
|
388
|
-
// TODO: when we add strongly typed commands, rewrite these checks so they're exhaustive
|
|
389
|
-
if (!namespaceId) {
|
|
390
|
-
throw Error(
|
|
391
|
-
"Something went wrong trying to determine which namespace to upload to.\n" +
|
|
392
|
-
"Please create a github issue with the command you just ran along with your wrangler configuration."
|
|
393
|
-
);
|
|
394
|
-
}
|
|
395
|
-
|
|
396
|
-
return namespaceId;
|
|
397
|
-
}
|
|
398
|
-
|
|
399
|
-
/**
|
|
400
|
-
* KV namespace binding names must be valid JS identifiers.
|
|
401
|
-
*/
|
|
402
|
-
export function isValidKVNamespaceBinding(
|
|
403
|
-
binding: string | undefined
|
|
404
|
-
): binding is string {
|
|
405
|
-
return (
|
|
406
|
-
typeof binding === "string" && /^[a-zA-Z_][a-zA-Z0-9_]*$/.test(binding)
|
|
407
|
-
);
|
|
408
|
-
}
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
export type EnumKeys<Enum> = Exclude<keyof Enum, number>;
|
|
2
|
-
|
|
3
|
-
export const enumObject = <Enum extends Record<string, number | string>>(
|
|
4
|
-
e: Enum
|
|
5
|
-
) => {
|
|
6
|
-
const copy = { ...e } as { [K in EnumKeys<Enum>]: Enum[K] };
|
|
7
|
-
Object.values(e).forEach(
|
|
8
|
-
(value) => typeof value === "number" && delete copy[value]
|
|
9
|
-
);
|
|
10
|
-
return copy;
|
|
11
|
-
};
|
|
12
|
-
|
|
13
|
-
export const enumKeys = <Enum extends Record<string, number | string>>(
|
|
14
|
-
e: Enum
|
|
15
|
-
) => {
|
|
16
|
-
return Object.keys(enumObject(e)) as EnumKeys<Enum>[];
|
|
17
|
-
};
|