@develit-io/backend-sdk 5.29.0 → 5.30.0

package/dist/deployment/index.d.mts

@@ -2,8 +2,8 @@ import * as alchemy_cloudflare from 'alchemy/cloudflare';
 import { KVNamespace, D1Database, Queue, R2Bucket, DurableObjectNamespace, Bindings, Worker } from 'alchemy/cloudflare';
 import { P as Project } from '../shared/backend-sdk.CP78x0gl.mjs';
 import { E as Environment } from '../shared/backend-sdk.CYcpgphg.mjs';
-import { W as WorkerType$1, R as Resource } from '../shared/backend-sdk.OvCBQJUw.mjs';
-export { c as composeWorkerArguments, e as extractWorkerCrons, l as loadWorkerConfig } from '../shared/backend-sdk.OvCBQJUw.mjs';
+import { W as WorkerType$1, R as Resource } from '../shared/backend-sdk.C-0xIdM4.mjs';
+export { c as composeWorkerArguments, e as extractWorkerCrons, a as extractWorkerVars, l as loadWorkerConfig } from '../shared/backend-sdk.C-0xIdM4.mjs';
 import alchemy from 'alchemy';
 
 declare class Deployment {
@@ -22,7 +22,7 @@ declare class Deployment {
      */
     kv(options: {
         /**
-         * Name of the KV. Do not include the 'kv' prefix.
+         * Name of the instance. Do not include a 'kv' prefix.
          */
         resourceName: string;
     }): Promise<KVNamespace>;
@@ -31,24 +31,41 @@ declare class Deployment {
      */
     d1(options: {
         /**
-         * Name of the D1. Do not include the 'd1' prefix.
+         * Name of the instance. Do not include a 'd1' prefix.
          */
         resourceName: string;
     }): Promise<D1Database>;
     /**
-     * Creates an instance of Cloudflare Queue.
+     * Creates an instance of Cloudflare Queue. A DLQ is created automatically.
      */
     queue(options: {
         /**
-         * Name of the Queue. Do not include the 'queue' prefix.
+         * Name of the instance. Do not include a 'queue' prefix.
          */
         resourceName: string;
         /**
-         * The number of seconds to delay delivery of messages to the queue.
+         * The number of seconds to delay delivery of messages to the instance.
          */
         deliveryDelay?: number;
         /**
-         * The number of seconds a message will remain in the queue before being deleted.
+         * The number of seconds a message will remain in the instance before being deleted.
+         */
+        messageRetentionPeriod?: number;
+    }): Promise<Queue<unknown>>;
+    /**
+     * Creates an instance of Cloudflare Queue as a DLQ.
+     */
+    dlq(options: {
+        /**
+         * Name of the instance. Do not include a 'dlq' or 'queue' prefix.
+         */
+        resourceName: string;
+        /**
+         * The number of seconds to delay delivery of messages to the instance.
+         */
+        deliveryDelay?: number;
+        /**
+         * The number of seconds a message will remain in the instance before being deleted.
          */
         messageRetentionPeriod?: number;
     }): Promise<Queue<unknown>>;
@@ -57,11 +74,11 @@ declare class Deployment {
      */
     r2(options: {
         /**
-         * Name of the R2. Do not include the 'r2' prefix.
+         * Name of the instance. Do not include an 'r2' prefix.
          */
         resourceName: string;
         /**
-         * The storage class for the R2 bucket.
+         * The storage class that the instance should take on.
          */
         storageClass?: 'Standard' | 'InfrequentAccess';
     }): Promise<R2Bucket>;
@@ -70,7 +87,7 @@ declare class Deployment {
      */
     durableObject(options: {
         /**
-         * Name of the Durable Object class. Do not include the 'durable-object' or 'do' prefix.
+         * Name of the instance class. Do not include a 'durable-object' or 'do' prefix.
          */
         className: string;
     }): Promise<DurableObjectNamespace<any>>;
@@ -79,43 +96,35 @@ declare class Deployment {
      */
     worker(options: {
         /**
-         * Name of the Worker. Do not include the 'worker' prefix.
+         * Name of the instance. Do not include the 'worker' prefix.
          */
         resourceName: string;
         /**
-         * Type of the Worker.
+         * Type of the instance.
          */
         resource?: WorkerType$1;
         /**
-         * Path to the root of the Worker.
+         * Path to the root of the instance.
          */
         path: string;
         /**
-         * Custom domains to bind to the Worker.
+         * Custom domains to bind to the instance.
          */
         domains?: string[];
         /**
-         * Static assets of the Worker.
+         * Static assets for the instance.
          */
         assets?: Bindings;
         /**
-         * Cron expressions for the trigger of the Worker.
+         * Cron expressions for the triggers of the instange.
          */
         crons?: string[];
         /**
-         * Bindings of the Worker.
+         * Bindings of the instance.
          */
         bindings?: Bindings;
         /**
-         * Environment variables of the Worker.
-         */
-        variables?: Bindings;
-        /**
-         * Secrets of the Worker.
-         */
-        secrets?: Bindings;
-        /**
-         * Event sources for the service to consume.
+         * Event sources for the instance to consume.
          */
         eventSources?: Queue[];
     }): Promise<Worker<Bindings, Rpc.WorkerEntrypointBranded>>;
@@ -124,23 +133,15 @@ declare class Deployment {
      */
     service(options: {
         /**
-         * Name of the service. Do not include the 'service' prefix.
+         * Name of the instance. Do not include a 'service' prefix.
          */
         resourceName: string;
         /**
-         * Bindings of the Worker.
+         * Bindings of the instance.
          */
         bindings?: Bindings;
         /**
-         * Environment variables of the Worker.
-         */
-        variables?: Bindings;
-        /**
-         * Secrets of the Worker.
-         */
-        secrets?: Bindings;
-        /**
-         * Event sources for the service to consume.
+         * Event sources for the instance to consume.
          */
         eventSources?: Queue[];
     }): Promise<Worker<Bindings, Rpc.WorkerEntrypointBranded>>;
@@ -149,27 +150,19 @@ declare class Deployment {
      */
     orchestrator(options: {
         /**
-         * Name of the orchestrator. Do not include the 'orchestrator' prefix.
+         * Name of the instance. Do not include an 'orchestrator' prefix.
          */
         resourceName: string;
         /**
-         * Custom domains to bind to the Worker.
+         * Custom domains to bind to the instance.
          */
         domains?: string[];
         /**
-         * Bindings of the Worker.
+         * Bindings of the instance.
          */
         bindings?: Bindings;
         /**
-         * Environment variables of the Worker.
-         */
-        variables?: Bindings;
-        /**
-         * Secrets of the Worker.
-         */
-        secrets?: Bindings;
-        /**
-         * Event sources for the orchestrator to consume.
+         * Event sources for the instance to consume.
          */
         eventSources?: Queue[];
     }): Promise<Worker<Bindings, Rpc.WorkerEntrypointBranded>>;
@@ -178,25 +171,21 @@ declare class Deployment {
      */
     client(options: {
         /**
-         * Name of the client. Do not include the 'client' prefix.
+         * Name of the instance. Do not include a 'client' prefix.
          */
         resourceName: string;
         /**
-         * Custom domains to bind to the Worker.
+         * Custom domains to bind to the instance.
          */
         domains?: string[];
         /**
-         * Bindings of the Worker.
+         * Bindings of the instance.
          */
         bindings?: Bindings;
         /**
-         * Environment variables of the Worker.
+         * Environment variables of the instance.
          */
         variables?: Bindings;
-        /**
-         * Secrets of the Worker.
-         */
-        secrets?: Bindings;
     }): Promise<Worker<{
         [x: string]: alchemy_cloudflare.Binding;
     } & {
@@ -211,24 +200,36 @@ declare const composeD1Arguments: ({ resourceName, }: {
     primaryLocationHint: "weur";
 };
 
+declare const composeDlqArguments: ({ resourceName, deliveryDelay, messageRetentionPeriod, }: {
+    resourceName: string;
+    deliveryDelay?: number;
+    messageRetentionPeriod?: number;
+}) => {
+    name: string;
+    settings: {
+        deliveryDelay: number;
+        messageRetentionPeriod: number;
+    };
+};
+
 declare const composeKvArguments: ({ resourceName, }: {
     resourceName: string;
 }) => {
     title: string;
 };
 
-declare const composeQueueArguments: ({ resourceName, deliveryDelay, messageRetentionPeriod, dlq, }: {
+declare const composeQueueArguments: ({ resourceName, dlq, deliveryDelay, messageRetentionPeriod, }: {
     resourceName: string;
+    dlq: Queue;
     deliveryDelay?: number;
     messageRetentionPeriod?: number;
-    dlq: Queue;
 }) => {
     name: string;
+    dlq: Queue;
     settings: {
         deliveryDelay: number;
         messageRetentionPeriod: number;
     };
-    dlq: Queue;
 };
 
 declare const composeR2Arguments: ({ resourceName, storageClass, }: {
@@ -236,9 +237,9 @@ declare const composeR2Arguments: ({ resourceName, storageClass, }: {
     storageClass?: "Standard" | "InfrequentAccess";
 }) => {
     name: string;
+    storageClass: "Standard" | "InfrequentAccess";
     jurisdiction: "eu";
     locationHint: string;
-    storageClass: "Standard" | "InfrequentAccess";
 };
 
 declare const composeIdentifierName: ({ resource, resourceName, }: {
@@ -251,4 +252,4 @@ declare const composeResourceName: ({ project, environment, resourceName, }: {
     resourceName: string;
 }) => string;
 
-export { Deployment, composeD1Arguments, composeIdentifierName, composeKvArguments, composeQueueArguments, composeR2Arguments, composeResourceName };
+export { Deployment, composeD1Arguments, composeDlqArguments, composeIdentifierName, composeKvArguments, composeQueueArguments, composeR2Arguments, composeResourceName };

package/dist/deployment/index.d.ts

@@ -2,8 +2,8 @@ import * as alchemy_cloudflare from 'alchemy/cloudflare';
 import { KVNamespace, D1Database, Queue, R2Bucket, DurableObjectNamespace, Bindings, Worker } from 'alchemy/cloudflare';
 import { P as Project } from '../shared/backend-sdk.CP78x0gl.js';
 import { E as Environment } from '../shared/backend-sdk.CYcpgphg.js';
-import { W as WorkerType$1, R as Resource } from '../shared/backend-sdk.DSK5flKM.js';
-export { c as composeWorkerArguments, e as extractWorkerCrons, l as loadWorkerConfig } from '../shared/backend-sdk.DSK5flKM.js';
+import { W as WorkerType$1, R as Resource } from '../shared/backend-sdk.qPzlx18G.js';
+export { c as composeWorkerArguments, e as extractWorkerCrons, a as extractWorkerVars, l as loadWorkerConfig } from '../shared/backend-sdk.qPzlx18G.js';
 import alchemy from 'alchemy';
 
 declare class Deployment {
@@ -22,7 +22,7 @@ declare class Deployment {
      */
     kv(options: {
         /**
-         * Name of the KV. Do not include the 'kv' prefix.
+         * Name of the instance. Do not include a 'kv' prefix.
          */
         resourceName: string;
     }): Promise<KVNamespace>;
@@ -31,24 +31,41 @@ declare class Deployment {
      */
     d1(options: {
         /**
-         * Name of the D1. Do not include the 'd1' prefix.
+         * Name of the instance. Do not include a 'd1' prefix.
          */
         resourceName: string;
     }): Promise<D1Database>;
     /**
-     * Creates an instance of Cloudflare Queue.
+     * Creates an instance of Cloudflare Queue. A DLQ is created automatically.
      */
     queue(options: {
         /**
-         * Name of the Queue. Do not include the 'queue' prefix.
+         * Name of the instance. Do not include a 'queue' prefix.
          */
         resourceName: string;
         /**
-         * The number of seconds to delay delivery of messages to the queue.
+         * The number of seconds to delay delivery of messages to the instance.
          */
         deliveryDelay?: number;
         /**
-         * The number of seconds a message will remain in the queue before being deleted.
+         * The number of seconds a message will remain in the instance before being deleted.
+         */
+        messageRetentionPeriod?: number;
+    }): Promise<Queue<unknown>>;
+    /**
+     * Creates an instance of Cloudflare Queue as a DLQ.
+     */
+    dlq(options: {
+        /**
+         * Name of the instance. Do not include a 'dlq' or 'queue' prefix.
+         */
+        resourceName: string;
+        /**
+         * The number of seconds to delay delivery of messages to the instance.
+         */
+        deliveryDelay?: number;
+        /**
+         * The number of seconds a message will remain in the instance before being deleted.
          */
         messageRetentionPeriod?: number;
     }): Promise<Queue<unknown>>;
@@ -57,11 +74,11 @@ declare class Deployment {
      */
     r2(options: {
         /**
-         * Name of the R2. Do not include the 'r2' prefix.
+         * Name of the instance. Do not include an 'r2' prefix.
          */
         resourceName: string;
         /**
-         * The storage class for the R2 bucket.
+         * The storage class that the instance should take on.
          */
         storageClass?: 'Standard' | 'InfrequentAccess';
     }): Promise<R2Bucket>;
@@ -70,7 +87,7 @@ declare class Deployment {
      */
     durableObject(options: {
         /**
-         * Name of the Durable Object class. Do not include the 'durable-object' or 'do' prefix.
+         * Name of the instance class. Do not include a 'durable-object' or 'do' prefix.
          */
         className: string;
     }): Promise<DurableObjectNamespace<any>>;
@@ -79,43 +96,35 @@ declare class Deployment {
      */
     worker(options: {
         /**
-         * Name of the Worker. Do not include the 'worker' prefix.
+         * Name of the instance. Do not include the 'worker' prefix.
          */
         resourceName: string;
         /**
-         * Type of the Worker.
+         * Type of the instance.
          */
         resource?: WorkerType$1;
         /**
-         * Path to the root of the Worker.
+         * Path to the root of the instance.
          */
         path: string;
         /**
-         * Custom domains to bind to the Worker.
+         * Custom domains to bind to the instance.
          */
         domains?: string[];
         /**
-         * Static assets of the Worker.
+         * Static assets for the instance.
          */
         assets?: Bindings;
         /**
-         * Cron expressions for the trigger of the Worker.
+         * Cron expressions for the triggers of the instange.
          */
         crons?: string[];
         /**
-         * Bindings of the Worker.
+         * Bindings of the instance.
          */
         bindings?: Bindings;
         /**
-         * Environment variables of the Worker.
-         */
-        variables?: Bindings;
-        /**
-         * Secrets of the Worker.
-         */
-        secrets?: Bindings;
-        /**
-         * Event sources for the service to consume.
+         * Event sources for the instance to consume.
          */
         eventSources?: Queue[];
     }): Promise<Worker<Bindings, Rpc.WorkerEntrypointBranded>>;
@@ -124,23 +133,15 @@ declare class Deployment {
      */
     service(options: {
         /**
-         * Name of the service. Do not include the 'service' prefix.
+         * Name of the instance. Do not include a 'service' prefix.
          */
         resourceName: string;
         /**
-         * Bindings of the Worker.
+         * Bindings of the instance.
          */
         bindings?: Bindings;
         /**
-         * Environment variables of the Worker.
-         */
-        variables?: Bindings;
-        /**
-         * Secrets of the Worker.
-         */
-        secrets?: Bindings;
-        /**
-         * Event sources for the service to consume.
+         * Event sources for the instance to consume.
          */
         eventSources?: Queue[];
     }): Promise<Worker<Bindings, Rpc.WorkerEntrypointBranded>>;
@@ -149,27 +150,19 @@ declare class Deployment {
      */
     orchestrator(options: {
         /**
-         * Name of the orchestrator. Do not include the 'orchestrator' prefix.
+         * Name of the instance. Do not include an 'orchestrator' prefix.
          */
         resourceName: string;
         /**
-         * Custom domains to bind to the Worker.
+         * Custom domains to bind to the instance.
          */
         domains?: string[];
         /**
-         * Bindings of the Worker.
+         * Bindings of the instance.
          */
         bindings?: Bindings;
         /**
-         * Environment variables of the Worker.
-         */
-        variables?: Bindings;
-        /**
-         * Secrets of the Worker.
-         */
-        secrets?: Bindings;
-        /**
-         * Event sources for the orchestrator to consume.
+         * Event sources for the instance to consume.
          */
         eventSources?: Queue[];
     }): Promise<Worker<Bindings, Rpc.WorkerEntrypointBranded>>;
@@ -178,25 +171,21 @@ declare class Deployment {
      */
     client(options: {
         /**
-         * Name of the client. Do not include the 'client' prefix.
+         * Name of the instance. Do not include a 'client' prefix.
          */
         resourceName: string;
         /**
-         * Custom domains to bind to the Worker.
+         * Custom domains to bind to the instance.
          */
         domains?: string[];
         /**
-         * Bindings of the Worker.
+         * Bindings of the instance.
          */
         bindings?: Bindings;
         /**
-         * Environment variables of the Worker.
+         * Environment variables of the instance.
          */
         variables?: Bindings;
-        /**
-         * Secrets of the Worker.
-         */
-        secrets?: Bindings;
     }): Promise<Worker<{
         [x: string]: alchemy_cloudflare.Binding;
     } & {
@@ -211,24 +200,36 @@ declare const composeD1Arguments: ({ resourceName, }: {
     primaryLocationHint: "weur";
 };
 
+declare const composeDlqArguments: ({ resourceName, deliveryDelay, messageRetentionPeriod, }: {
+    resourceName: string;
+    deliveryDelay?: number;
+    messageRetentionPeriod?: number;
+}) => {
+    name: string;
+    settings: {
+        deliveryDelay: number;
+        messageRetentionPeriod: number;
+    };
+};
+
 declare const composeKvArguments: ({ resourceName, }: {
     resourceName: string;
 }) => {
     title: string;
 };
 
-declare const composeQueueArguments: ({ resourceName, deliveryDelay, messageRetentionPeriod, dlq, }: {
+declare const composeQueueArguments: ({ resourceName, dlq, deliveryDelay, messageRetentionPeriod, }: {
     resourceName: string;
+    dlq: Queue;
     deliveryDelay?: number;
     messageRetentionPeriod?: number;
-    dlq: Queue;
 }) => {
     name: string;
+    dlq: Queue;
     settings: {
         deliveryDelay: number;
         messageRetentionPeriod: number;
     };
-    dlq: Queue;
 };
 
 declare const composeR2Arguments: ({ resourceName, storageClass, }: {
@@ -236,9 +237,9 @@ declare const composeR2Arguments: ({ resourceName, storageClass, }: {
     storageClass?: "Standard" | "InfrequentAccess";
 }) => {
     name: string;
+    storageClass: "Standard" | "InfrequentAccess";
     jurisdiction: "eu";
     locationHint: string;
-    storageClass: "Standard" | "InfrequentAccess";
 };
 
 declare const composeIdentifierName: ({ resource, resourceName, }: {
@@ -251,4 +252,4 @@ declare const composeResourceName: ({ project, environment, resourceName, }: {
     resourceName: string;
 }) => string;
 
-export { Deployment, composeD1Arguments, composeIdentifierName, composeKvArguments, composeQueueArguments, composeR2Arguments, composeResourceName };
+export { Deployment, composeD1Arguments, composeDlqArguments, composeIdentifierName, composeKvArguments, composeQueueArguments, composeR2Arguments, composeResourceName };