ocel 0.0.1-alpha.1 → 0.0.1

package/LICENSE

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

package/NOTICE

@@ -0,0 +1,2 @@
+Ocel
+Copyright 2026 The Ocel Authors

package/README.md

@@ -0,0 +1,98 @@
+# ocel
+
+Platform as a Framework. `ocel` is the **runtime SDK** your app imports and the types your
+config is written against. Declaring a resource in app code — `postgres("main")` — *is* the
+provisioning step.
+
+## Install
+
+```sh
+npm install ocel
+```
+
+It belongs in `dependencies`, not `devDependencies`: the SDK subpaths are imported by your
+running app.
+
+## CLI
+
+The `ocel` command is a separate install:
+
+```sh
+npm install -g @ocel/cli
+curl -fsSL https://ocel.dev/install.sh | sh
+brew install --cask ocelhq/tap/ocel
+```
+
+## SDK
+
+Every entry point is a subpath — there is no root export.
+
+| Import | Contents |
+| --- | --- |
+| `ocel/config` | `defineConfig`, and the `OcelConfig` / `AppConfig` / `DomainConfig` / `ProviderDescriptor` types |
+| `ocel/postgres` | `postgres(id, config?)` — declares a Postgres database and returns a connected client |
+| `ocel/bucket` | `bucket(name, options?)` — declares a bucket and returns the handle its objects are read and written through, plus `uploader`, `createRouteHandler` and `resolveBucketContext`, framework-agnostic |
+| `ocel/bucket/next` | `bucket`, `uploader`, `createRouteHandler` returning Next route handlers |
+| `ocel/bucket/hono` | `bucket`, `uploader`, `createRouteHandler` returning a Hono handler |
+| `ocel/bucket/express` | `bucket`, `uploader`, `createRouteHandler` returning Express middleware |
+| `ocel/bucket/client` | `createUploadClient` — browser-side uploads against a bucket's uploaders |
+| `ocel/task` | `task(name, options)` — declares a task and returns the handle its runs are triggered through, plus `runs` and `AbortTaskRunError` |
+| `ocel/topic` | `topic(name, options?)` — declares a topic and returns the handle messages are sent through and consumers are declared on |
+| `ocel/kv` | `kv(name, options?)` — declares a key-value store and returns its typed entries as members, beside its ioredis `client` and `connectionString`; `kv.text`, `kv.counter`, `kv.json`, `kv.list` and `kv.set` declare the entries |
+| `ocel/worker` | `worker(name, options?)` — declares the worker tasks and consumers run on, plus `deliver`, which the generated worker entry calls |
+
+`next`, `hono`, `express`, `pg` and `ioredis` are optional peer dependencies; install only the one
+your app uses.
+
+`ocel init` writes `ocel.json`, which needs none of this package. `ocel/config` is for a
+project that would rather write the same document as a program — `ocel init --provider aws
+--ts` writes one:
+
+```ts
+// ocel.config.ts
+import { defineConfig } from "ocel/config";
+import awsProvider from "ocel/providers/aws";
+
+export default defineConfig({
+  slug: "my-app",
+  provider: awsProvider(),
+});
+```
+
+Point any command at a different config with `--config <path>` (or `OCEL_CONFIG`).
+
+```ts
+// ocel/index.ts
+import { bucket, uploader } from "ocel/bucket/next";
+import { postgres } from "ocel/postgres";
+
+export const db = postgres("main");
+
+export const uploads = bucket("uploads", {
+  uploaders: {
+    // The first argument authorizes the upload and returns the metadata the
+    // rest of the uploader — paths, limits, onUploadComplete — receives.
+    avatar: uploader(
+      { middleware: ({ req }) => ({ userId: req.headers.get("x-user-id") }) },
+      { accept: ["image/*"], limits: { maxFileCount: 1 } },
+    ),
+  },
+});
+```
+
+The handle `bucket()` returns is how the app reaches its objects: `put`, `get`, `head`,
+`delete`, `copy`, `list`, `signedUrl` and `signedUpload`, plus `publicUrl` on a bucket
+declared `public: true`. A `put` over 16 MB is uploaded in parts without being asked to.
+
+```ts
+await uploads.put("reports/q3.pdf", bytes, { contentType: "application/pdf" });
+
+const report = await uploads.get("reports/q3.pdf");
+if (report) console.log(report.info.etag, await report.bytes());
+
+for await (const object of uploads.list({ prefix: "reports/" })) console.log(object.key);
+```
+
+Resource declarations resolve through `ocel dev`, so importing them outside a `dev`/`run`
+session (or a deployed environment) throws unless the resource's environment variable is
+set.

package/dist/binding/binding.d.ts

@@ -0,0 +1,22 @@
+import { type Binding, BindingType } from "../gen/proto/common/bindings/v1/bindings_pb.js";
+/** The binding types an app resolves; a custom record is read by transforms alone. */
+export type BindingCase = Exclude<NonNullable<Binding["properties"]["case"]>, "custom">;
+/** The properties a binding of the given type carries. */
+export type BindingProperties<TCase extends BindingCase> = Extract<Binding["properties"], {
+    case: TCase;
+}>["value"];
+/** The type a binding's properties case declares; UNSPECIFIED when it has none. */
+export declare function bindingTypeOf(binding: Binding): BindingType;
+/** The env key a binding of the given type is delivered under. */
+export declare function bindingKey(name: string, type: BindingType): string;
+/**
+ * Reads the binding delivered for a resource and hands back its typed
+ * properties. Throws when nothing was delivered, when the payload is not a
+ * binding record, or when the record is of another type than the one asked for.
+ */
+export declare function getConfig<TCase extends BindingCase>(name: string, kind: TCase): BindingProperties<TCase>;
+/**
+ * The error for a resource whose binding of the given type was not delivered,
+ * is not a binding record, or is of another type; undefined when it was delivered.
+ */
+export declare function refuseUnbound(name: string, kind: BindingCase): Error | undefined;

package/dist/binding/binding.js

@@ -0,0 +1,60 @@
+import { fromJson } from "@bufbuild/protobuf";
+import { readLiveFile } from "../env/file.js";
+import { readLive } from "../env/live.js";
+import { BindingSchema, BindingType, } from "../gen/proto/common/bindings/v1/bindings_pb.js";
+const typeOfCase = {
+    postgres: BindingType.POSTGRES,
+    bucket: BindingType.BUCKET,
+    custom: BindingType.CUSTOM,
+    topic: BindingType.TOPIC,
+    task: BindingType.TASK,
+    kv: BindingType.KV,
+    realtime: BindingType.REALTIME,
+};
+/** The type a binding's properties case declares; UNSPECIFIED when it has none. */
+export function bindingTypeOf(binding) {
+    return binding.properties.case ? typeOfCase[binding.properties.case] : BindingType.UNSPECIFIED;
+}
+/** The env key a binding of the given type is delivered under. */
+export function bindingKey(name, type) {
+    return `OCEL_RESOURCE_${BindingType[type]}_${name}`;
+}
+/**
+ * Reads the binding delivered for a resource and hands back its typed
+ * properties. Throws when nothing was delivered, when the payload is not a
+ * binding record, or when the record is of another type than the one asked for.
+ */
+export function getConfig(name, kind) {
+    const found = findBinding(name, kind);
+    if (found instanceof Error) {
+        throw found;
+    }
+    return found.properties.value;
+}
+/**
+ * The error for a resource whose binding of the given type was not delivered,
+ * is not a binding record, or is of another type; undefined when it was delivered.
+ */
+export function refuseUnbound(name, kind) {
+    const found = findBinding(name, kind);
+    return found instanceof Error ? found : undefined;
+}
+function findBinding(name, kind) {
+    const type = typeOfCase[kind];
+    const key = bindingKey(name, type);
+    const raw = readLive(key) ?? readLiveFile(key) ?? process.env[key];
+    if (!raw) {
+        return new Error(`Value for ${key} is not defined. Run \`ocel dev\` to resolve it locally, or \`ocel deploy\` to have it delivered from the resource this app binds.`);
+    }
+    let binding;
+    try {
+        binding = fromJson(BindingSchema, JSON.parse(raw));
+    }
+    catch (cause) {
+        return new Error(`${key} does not contain a binding record, so this app cannot read it as a ${BindingType[type]}`, { cause });
+    }
+    if (binding.properties.case !== kind) {
+        return new Error(`${key} contains a ${BindingType[bindingTypeOf(binding)]} binding, and this app reads it as a ${BindingType[type]}`);
+    }
+    return binding;
+}

package/dist/binding/unprovisioned.d.ts

@@ -0,0 +1,17 @@
+/** The phase in which app code runs before any resource is provisioned. */
+export type UnprovisionedPhase = "discovery";
+/**
+ * Thrown when app code reaches for a resource this run never provisioned, which
+ * is discovery: the pass that reads the declarations before anything is
+ * provisioned. Catch it to keep a boot path alive when the resource is optional there; anything else
+ * thrown from the same call means the resource exists and is genuinely broken.
+ */
+export declare class UnprovisionedResourceError extends Error {
+    name: string;
+}
+/** The phase this process runs in when no resource has been provisioned yet; undefined once resources are. */
+export declare function unprovisionedPhase(): UnprovisionedPhase | undefined;
+/** The error app code gets for touching `access` on the resource `what` during discovery. */
+export declare function unprovisioned(what: string, access: string): UnprovisionedResourceError;
+/** A stand-in for the resource `what` that throws {@link UnprovisionedResourceError} on any property access. */
+export declare function unprovisionedProxy<T extends object>(what: string): T;

package/dist/binding/unprovisioned.js

@@ -0,0 +1,25 @@
+/**
+ * Thrown when app code reaches for a resource this run never provisioned, which
+ * is discovery: the pass that reads the declarations before anything is
+ * provisioned. Catch it to keep a boot path alive when the resource is optional there; anything else
+ * thrown from the same call means the resource exists and is genuinely broken.
+ */
+export class UnprovisionedResourceError extends Error {
+    name = "UnprovisionedResourceError";
+}
+/** The phase this process runs in when no resource has been provisioned yet; undefined once resources are. */
+export function unprovisionedPhase() {
+    return process.env.OCEL_PHASE === "discovery" ? "discovery" : undefined;
+}
+/** The error app code gets for touching `access` on the resource `what` during discovery. */
+export function unprovisioned(what, access) {
+    return new UnprovisionedResourceError(`'${what}' cannot be used during discovery: tried to access '${access}' before the resource was provisioned`);
+}
+/** A stand-in for the resource `what` that throws {@link UnprovisionedResourceError} on any property access. */
+export function unprovisionedProxy(what) {
+    return new Proxy({}, {
+        get(_target, prop) {
+            throw unprovisioned(what, String(prop));
+        },
+    });
+}

package/dist/bucket/bucket-client.d.ts

@@ -0,0 +1,4 @@
+import { type Client, type Transport } from "@connectrpc/connect";
+import { BucketService } from "../gen/proto/app/bucket/v1/bucket_pb.js";
+export type BucketServiceClient = Client<typeof BucketService>;
+export declare function createBucketClient(transport: Transport): BucketServiceClient;

package/dist/bucket/bucket-client.js

@@ -0,0 +1,5 @@
+import { createClient } from "@connectrpc/connect";
+import { BucketService } from "../gen/proto/app/bucket/v1/bucket_pb.js";
+export function createBucketClient(transport) {
+    return createClient(BucketService, transport);
+}

package/dist/bucket/bucket-context.d.ts

@@ -0,0 +1,8 @@
+import type { Bucket } from "./bucket.js";
+import { type BucketServiceClient } from "./bucket-client.js";
+export interface BucketContext {
+    client: BucketServiceClient;
+    bucket: string;
+    publicBaseUrl: string;
+}
+export declare function resolveBucketContext(bucket: Bucket): BucketContext;

package/dist/bucket/bucket-context.js

@@ -0,0 +1,10 @@
+import { createRuntimeTransport } from "../runtime/transport.js";
+import { createBucketClient } from "./bucket-client.js";
+export function resolveBucketContext(bucket) {
+    const { bucket: storeBucket, publicBaseUrl } = bucket.__config();
+    return {
+        client: createBucketClient(createRuntimeTransport()),
+        bucket: storeBucket,
+        publicBaseUrl,
+    };
+}

package/dist/bucket/bucket.d.ts

@@ -0,0 +1,60 @@
+import type { BucketProperties } from "../gen/proto/common/bindings/v1/bindings_pb.js";
+import { type GetOptions, type ListOptions, type ObjectBody, type ObjectInfo, type ObjectListing, type PutBody, type PutOptions, type SignedUpload, type SignedUploadOptions, type SignedUrlOptions } from "./objects.js";
+import type { AnyUploader } from "./types.js";
+/** How a bucket is declared. */
+export interface BucketOptions<TUploaders extends Record<string, AnyUploader>, TPublic extends boolean> {
+    /** Serves every object anonymously over HTTP. */
+    public?: TPublic;
+    /** Browser origins allowed to upload straight to the store. */
+    allowedOrigins?: string[];
+    /** The named browser-upload flows this bucket accepts. */
+    uploaders?: TUploaders;
+}
+/** The binding fields a bucket resolves at runtime. */
+export type ResolvedBucketConfig = Pick<BucketProperties, "bucket" | "publicBaseUrl">;
+/** A declared bucket, and the handle an app reads and writes its objects through. */
+export declare class Bucket<TUploaders extends Record<string, AnyUploader> = Record<string, AnyUploader>, TPublic extends boolean = boolean> {
+    /** The name this bucket was declared under. */
+    name: string;
+    /** The browser-upload flows this bucket accepts. */
+    uploaders: TUploaders;
+    /** The browser origins allowed to upload straight to the store. */
+    allowedOrigins: string[];
+    /** Whether every object is served anonymously over HTTP. */
+    isPublic: boolean;
+    private type;
+    private context;
+    private objects;
+    constructor(
+    /** The name this bucket was declared under. */
+    name: string, 
+    /** The browser-upload flows this bucket accepts. */
+    uploaders: TUploaders, 
+    /** The browser origins allowed to upload straight to the store. */
+    allowedOrigins: string[], 
+    /** Whether every object is served anonymously over HTTP. */
+    isPublic: boolean);
+    private runtime;
+    /** The binding delivered for this bucket. */
+    __config(): ResolvedBucketConfig;
+    /** Writes `body` under `key`, in one request or in parts, and returns the stored object. */
+    put(key: string, body: PutBody, options?: PutOptions): Promise<ObjectInfo>;
+    /** Reads the object under `key`, or `null` when the bucket has none. */
+    get(key: string, options?: GetOptions): Promise<ObjectBody | null>;
+    /** What the bucket knows about `key`, or `null` when it has none. */
+    head(key: string): Promise<ObjectInfo | null>;
+    /** Removes one key or many; a key that is not there is not an error. */
+    delete(key: string | string[]): Promise<void>;
+    /** The objects under a prefix, walked as an async iterable or one page at a time. */
+    list(options?: ListOptions): ObjectListing;
+    /** Copies `source` to `destination` within the bucket. */
+    copy(source: string, destination: string): Promise<ObjectInfo>;
+    /** A url that reads `key` without a credential, for as long as it is valid. */
+    signedUrl(key: string, options?: SignedUrlOptions): Promise<string>;
+    /** A target that writes `key` without a credential, for as long as it is valid. */
+    signedUpload(key: string, options?: SignedUploadOptions): Promise<SignedUpload>;
+    /** The object's address on a bucket declared `public: true`. */
+    publicUrl: TPublic extends true ? (key: string) => string : never;
+}
+/** Declares a bucket, and hands back the handle its objects are reached through. */
+export declare function bucket<TUploaders extends Record<string, AnyUploader> = Record<string, never>, TPublic extends boolean = false>(name: string, options?: BucketOptions<TUploaders, TPublic>): Bucket<TUploaders, TPublic>;

package/dist/bucket/bucket.js

@@ -0,0 +1,91 @@
+import { getConfig } from "../binding/binding.js";
+import { unprovisioned, unprovisionedPhase } from "../binding/unprovisioned.js";
+import { declarationSite } from "../declaration/callsite.js";
+import { defer } from "../declaration/defer.js";
+import { ResourceType } from "../gen/proto/app/resources/v1/resources_pb.js";
+import { rpc } from "../runtime/rpc.js";
+import { resolveBucketContext } from "./bucket-context.js";
+import { createObjects, } from "./objects.js";
+/** A declared bucket, and the handle an app reads and writes its objects through. */
+export class Bucket {
+    name;
+    uploaders;
+    allowedOrigins;
+    isPublic;
+    type = ResourceType.BUCKET;
+    context;
+    objects;
+    constructor(
+    /** The name this bucket was declared under. */
+    name, 
+    /** The browser-upload flows this bucket accepts. */
+    uploaders, 
+    /** The browser origins allowed to upload straight to the store. */
+    allowedOrigins, 
+    /** Whether every object is served anonymously over HTTP. */
+    isPublic) {
+        this.name = name;
+        this.uploaders = uploaders;
+        this.allowedOrigins = allowedOrigins;
+        this.isPublic = isPublic;
+        this.objects = createObjects({ runtime: () => this.runtime() });
+        if (process.env.OCEL_PHASE === "discovery") {
+            defer(rpc.resource.declare({
+                resource: { name, type: this.type },
+                config: {
+                    case: "bucket",
+                    value: { allowedOrigins, public: isPublic },
+                },
+                source: declarationSite(),
+            }));
+        }
+    }
+    runtime() {
+        return (this.context ??= resolveBucketContext(this));
+    }
+    /** The binding delivered for this bucket. */
+    __config() {
+        if (unprovisionedPhase()) {
+            throw unprovisioned(`bucket("${this.name}")`, "__config");
+        }
+        return getConfig(this.name, "bucket");
+    }
+    /** Writes `body` under `key`, in one request or in parts, and returns the stored object. */
+    put(key, body, options) {
+        return this.objects.put(key, body, options);
+    }
+    /** Reads the object under `key`, or `null` when the bucket has none. */
+    get(key, options) {
+        return this.objects.get(key, options);
+    }
+    /** What the bucket knows about `key`, or `null` when it has none. */
+    head(key) {
+        return this.objects.head(key);
+    }
+    /** Removes one key or many; a key that is not there is not an error. */
+    delete(key) {
+        return this.objects.delete(key);
+    }
+    /** The objects under a prefix, walked as an async iterable or one page at a time. */
+    list(options) {
+        return this.objects.list(options);
+    }
+    /** Copies `source` to `destination` within the bucket. */
+    copy(source, destination) {
+        return this.objects.copy(source, destination);
+    }
+    /** A url that reads `key` without a credential, for as long as it is valid. */
+    signedUrl(key, options) {
+        return this.objects.signedUrl(key, options);
+    }
+    /** A target that writes `key` without a credential, for as long as it is valid. */
+    signedUpload(key, options) {
+        return this.objects.signedUpload(key, options);
+    }
+    /** The object's address on a bucket declared `public: true`. */
+    publicUrl = ((key) => this.objects.publicUrl(key));
+}
+/** Declares a bucket, and hands back the handle its objects are reached through. */
+export function bucket(name, options = {}) {
+    return new Bucket(name, options.uploaders ?? {}, options.allowedOrigins ?? [], options.public ?? false);
+}