@develit-io/backend-sdk 5.29.0 → 5.30.0

package/dist/deployment/index.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-const worker = require('../shared/backend-sdk.n8SfX_xu.cjs');
+const worker = require('../shared/backend-sdk.DEE4fXCZ.cjs');
 const text = require('@std/text');
 const cloudflare = require('alchemy/cloudflare');
 const environment_consts = require('../shared/backend-sdk.ClVQ4AzB.cjs');
@@ -22,6 +22,20 @@ const composeD1Arguments = ({
   };
 };
 
+const composeDlqArguments = ({
+  resourceName,
+  deliveryDelay = worker.QUEUE_DELIVERY_DELAY,
+  messageRetentionPeriod = worker.QUEUE_MESSAGE_RETENTION_PERIOD
+}) => {
+  return {
+    name: resourceName,
+    settings: {
+      deliveryDelay,
+      messageRetentionPeriod
+    }
+  };
+};
+
 const composeKvArguments = ({
   resourceName
 }) => {
@@ -32,17 +46,17 @@ const composeKvArguments = ({
 
 const composeQueueArguments = ({
   resourceName,
+  dlq,
   deliveryDelay = worker.QUEUE_DELIVERY_DELAY,
-  messageRetentionPeriod = worker.QUEUE_MESSAGE_RETENTION_PERIOD,
-  dlq
+  messageRetentionPeriod = worker.QUEUE_MESSAGE_RETENTION_PERIOD
 }) => {
   return {
     name: resourceName,
+    dlq,
     settings: {
       deliveryDelay,
       messageRetentionPeriod
-    },
-    dlq
+    }
   };
 };
 
@@ -52,9 +66,9 @@ const composeR2Arguments = ({
 }) => {
   return {
     name: resourceName,
+    storageClass,
     jurisdiction: worker.R2_JURISDICTION,
-    locationHint: worker.R2_LOCATION_HINT,
-    storageClass
+    locationHint: worker.R2_LOCATION_HINT
   };
 };
 
@@ -75,6 +89,7 @@ const composeResourceName = ({
 class Deployment {
   project;
   environment;
+  // TODO: Check if the type is most correct
   alchemy;
   constructor({ project }) {
     this.project = project;
@@ -85,6 +100,7 @@ class Deployment {
           scriptName: environment_consts.ALCHEMY_STATE_STORE
         });
       },
+      // TODO: Convert to a util
       stage: Bun.env.ENVIRONMENT || "unknown"
     });
   }
@@ -127,21 +143,13 @@ class Deployment {
     );
   }
   /**
-   * Creates an instance of Cloudflare Queue.
+   * Creates an instance of Cloudflare Queue. A DLQ is created automatically.
    */
   async queue(options) {
     const { resourceName, deliveryDelay, messageRetentionPeriod } = options;
-    const dlq = await cloudflare.Queue(
-      composeIdentifierName({ resourceName, resource: "dlq" }),
-      {
-        name: composeResourceName({
-          project: this.project,
-          environment: this.environment,
-          // TODO: Convert to a util
-          resourceName: `${resourceName}-dlq`
-        })
-      }
-    );
+    const deadLetterQueue = await this.dlq({
+      resourceName
+    });
     return await cloudflare.Queue(
       composeIdentifierName({ resourceName, resource: "queue" }),
       composeQueueArguments({
@@ -150,9 +158,28 @@ class Deployment {
           environment: this.environment,
           resourceName
         }),
+        dlq: deadLetterQueue,
         deliveryDelay,
-        messageRetentionPeriod,
-        dlq
+        messageRetentionPeriod
+      })
+    );
+  }
+  /**
+   * Creates an instance of Cloudflare Queue as a DLQ.
+   */
+  async dlq(options) {
+    const { resourceName, deliveryDelay, messageRetentionPeriod } = options;
+    return await cloudflare.Queue(
+      composeIdentifierName({ resourceName, resource: "dlq" }),
+      composeDlqArguments({
+        resourceName: composeResourceName({
+          project: this.project,
+          environment: this.environment,
+          // TODO: Convert to a util
+          resourceName: `${resourceName}-dlq`
+        }),
+        deliveryDelay,
+        messageRetentionPeriod
       })
     );
   }
@@ -183,6 +210,7 @@ class Deployment {
         resourceName: className,
         resource: "durable-object"
       }),
+      // TODO: Create util
       {
         // TODO: Create util
         className: `${className}DurableObject`,
@@ -202,12 +230,11 @@ class Deployment {
       assets,
       crons,
       bindings,
-      variables,
-      secrets,
       eventSources
     } = options;
     const identifierName = composeIdentifierName({
       resourceName,
+      // TODO: Convert to a util
       resource: resource || "worker"
     });
     const workerConfig = await worker.loadWorkerConfig({ path });
@@ -218,10 +245,12 @@ class Deployment {
           deadLetterQueue: queue.dlq,
           batchSize: worker.QUEUE_MAX_BATCH_SIZE,
           maxWaitTimeMs: worker.QUEUE_MAX_BATCH_TIMEOUT
+          // TODO: Watch out for the type
         }
       };
     });
     return await cloudflare.Worker(
+      // TODO: Make it to use composeIdentifierName similary to other resources
       identifierName,
       worker.composeWorkerArguments({
         resourceName: composeResourceName({
@@ -233,14 +262,17 @@ class Deployment {
         entrypoint: `${path}/src/index.ts`,
         domains,
         assets,
+        // TODO: Convert to a util
         crons: crons || worker.extractWorkerCrons({
           workerConfig,
           environment: this.environment
         }),
         bindings: {
           ...bindings,
-          ...variables,
-          ...secrets
+          ...worker.extractWorkerVars({
+            workerConfig,
+            environment: this.environment
+          })
         },
         eventSources: consumers
       })
@@ -250,15 +282,13 @@ class Deployment {
    * Creates an instance of Cloudflare Worker as a service.
    */
   async service(options) {
-    const { resourceName, bindings, variables, secrets, eventSources } = options;
+    const { resourceName, bindings, eventSources } = options;
     return await this.worker({
       resourceName,
       resource: "service",
       // TODO: Convert to util
       path: `./services/${resourceName}`,
       bindings,
-      variables,
-      secrets,
       eventSources
     });
   }
@@ -266,14 +296,7 @@ class Deployment {
    * Creates an instance of Cloudflare Worker as an orchestrator.
    */
   async orchestrator(options) {
-    const {
-      resourceName,
-      domains,
-      bindings,
-      variables,
-      secrets,
-      eventSources
-    } = options;
+    const { resourceName, domains, bindings, eventSources } = options;
     return await this.worker({
       resourceName,
       resource: "orchestrator",
@@ -281,8 +304,6 @@ class Deployment {
       path: `./apps/${resourceName}`,
       domains,
       bindings,
-      variables,
-      secrets,
       eventSources
     });
   }
@@ -290,7 +311,7 @@ class Deployment {
    * Creates an instance of Cloudflare Worker as a client.
    */
   async client(options) {
-    const { resourceName, domains, bindings, variables, secrets } = options;
+    const { resourceName, domains, bindings, variables } = options;
     return await cloudflare.Nuxt(
       composeIdentifierName({
         resourceName,
@@ -311,8 +332,7 @@ class Deployment {
         domains,
         bindings: {
           ...bindings,
-          ...variables,
-          ...secrets
+          ...variables
         },
         // TODO: Convert to util
         cwd: `./apps/${resourceName}`
@@ -323,9 +343,11 @@ class Deployment {
 
 exports.composeWorkerArguments = worker.composeWorkerArguments;
 exports.extractWorkerCrons = worker.extractWorkerCrons;
+exports.extractWorkerVars = worker.extractWorkerVars;
 exports.loadWorkerConfig = worker.loadWorkerConfig;
 exports.Deployment = Deployment;
 exports.composeD1Arguments = composeD1Arguments;
+exports.composeDlqArguments = composeDlqArguments;
 exports.composeIdentifierName = composeIdentifierName;
 exports.composeKvArguments = composeKvArguments;
 exports.composeQueueArguments = composeQueueArguments;

package/dist/deployment/index.d.cts

@@ -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.cjs';
 import { E as Environment } from '../shared/backend-sdk.CYcpgphg.cjs';
-import { W as WorkerType$1, R as Resource } from '../shared/backend-sdk.D8N5si7y.cjs';
-export { c as composeWorkerArguments, e as extractWorkerCrons, l as loadWorkerConfig } from '../shared/backend-sdk.D8N5si7y.cjs';
+import { W as WorkerType$1, R as Resource } from '../shared/backend-sdk.CdngrAa0.cjs';
+export { c as composeWorkerArguments, e as extractWorkerCrons, a as extractWorkerVars, l as loadWorkerConfig } from '../shared/backend-sdk.CdngrAa0.cjs';
 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 };