wirejs-resources 0.1.89 → 0.1.91-async-api

package/dist/index.d.ts

@@ -11,3 +11,4 @@ export type * from './resources/distributed-table.js';
 export * from './types/index.js';
 export * from './derived-types.js';
 export * from './services/realtime.js';
+export * from './resources/background-job.js';

package/dist/index.js

@@ -10,3 +10,4 @@ export { DistributedTable, PassThruParser, matchesFilter, indexName } from './re
 export * from './types/index.js';
 export * from './derived-types.js';
 export * from './services/realtime.js';
+export * from './resources/background-job.js';

package/dist/overrides.d.ts

@@ -2,6 +2,7 @@ import type { FileService } from "./services/file";
 import type { AuthenticationService } from "./services/authentication";
 import type { Secret } from "./resources/secret";
 import type { RealtimeService } from "./services/realtime";
+import type { BackgroundJob } from "./resources/background-job";
 /**
  * Used by hosting providers to provide service overrides.
  */
@@ -11,4 +12,5 @@ export declare const overrides: {
     FileService?: typeof FileService;
     Secret?: typeof Secret;
     RealtimeService?: typeof RealtimeService;
+    BackgroundJob?: typeof BackgroundJob;
 };

package/dist/resources/background-job.d.ts

@@ -0,0 +1,31 @@
+import { Resource } from '../resource.js';
+/**
+ * A function that will be executed in the background.
+ *
+ * Intended for longer-running work that will continue after an initial API response
+ * to the client.
+ *
+ * ## WARNINGS
+ *
+ * 1. It may execute in a completely different environment that the one that invoked it.
+ * DO NOT depend on global variables, closures, or other process state that is not lazily
+ * created or constructed in-place by the script.
+ * 2. Fire-and-forget behavior is undefined. As soon as the `Promise` returned by your
+ * function resolves, the execution environment is free to terminate the process.
+ * 3. In local development, **timeouts are not enforced.** (Yet.)
+ */
+export declare class BackgroundJob<T extends (...args: any) => Promise<void>> extends Resource {
+    #private;
+    constructor(scope: Resource | string, id: string, options: {
+        handler: T;
+        timeoutSeconds?: number;
+    });
+    /**
+     * Serializes parameter data and schedules background execution.
+     *
+     * **NOTE:** This resolves once the job is scheduled; *not when it completes!*
+     *
+     * @param data
+     */
+    start(...args: Parameters<T>): Promise<void>;
+}

package/dist/resources/background-job.js

@@ -0,0 +1,51 @@
+import { Resource } from '../resource.js';
+/**
+ * A function that will be executed in the background.
+ *
+ * Intended for longer-running work that will continue after an initial API response
+ * to the client.
+ *
+ * ## WARNINGS
+ *
+ * 1. It may execute in a completely different environment that the one that invoked it.
+ * DO NOT depend on global variables, closures, or other process state that is not lazily
+ * created or constructed in-place by the script.
+ * 2. Fire-and-forget behavior is undefined. As soon as the `Promise` returned by your
+ * function resolves, the execution environment is free to terminate the process.
+ * 3. In local development, **timeouts are not enforced.** (Yet.)
+ */
+export class BackgroundJob extends Resource {
+    #handler;
+    #timeoutSeconds;
+    constructor(scope, id, options) {
+        super(scope, id);
+        this.#handler = options.handler;
+        if (options.timeoutSeconds && (options.timeoutSeconds < 1 || options.timeoutSeconds > 900)) {
+            throw new Error('timeoutSeconds must be between 1 and 900 seconds.');
+        }
+        this.#timeoutSeconds = options.timeoutSeconds ?? 900;
+    }
+    /**
+     * Serializes parameter data and schedules background execution.
+     *
+     * **NOTE:** This resolves once the job is scheduled; *not when it completes!*
+     *
+     * @param data
+     */
+    async start(...args) {
+        // Serialize and deserialize is expected to occur in cloud contexts. So, we do
+        // the same here to ensure local development behaves similarly to production.
+        const serializedArgs = JSON.parse(JSON.stringify(args));
+        // Hacky delay for now to give the current request time to complete and to
+        // simulate a little bit of the delay that would be expected in a real
+        // background job.
+        setTimeout(async () => {
+            try {
+                await this.#handler(...serializedArgs);
+            }
+            catch (error) {
+                console.error('Background job failed:', error);
+            }
+        }, 300);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wirejs-resources",
-	"version": "0.1.89",
+	"version": "0.1.91-async-api",
 	"description": "Basic services and server-side resources for wirejs apps",
 	"type": "module",
 	"main": "./dist/index.js",

package/dist/hosting/client.d.ts

@@ -1 +0,0 @@
-export declare function apiTree(INTERNAL_API_URL: string, path?: string[]): () => void;

package/dist/hosting/client.js

@@ -1,68 +0,0 @@
-async function callApi(INTERNAL_API_URL, method, ...args) {
-    function isNode() {
-        return typeof args[0]?.cookies?.getAll === 'function';
-    }
-    function apiUrl() {
-        if (isNode()) {
-            return INTERNAL_API_URL;
-        }
-        else {
-            return "/api";
-        }
-    }
-    let cookieHeader = {};
-    if (isNode()) {
-        const context = args[0];
-        const cookies = context.cookies.getAll();
-        cookieHeader = typeof cookies === 'object'
-            ? {
-                Cookie: Object.entries(cookies).map(kv => kv.join('=')).join('; ')
-            }
-            : {};
-    }
-    const response = await fetch(apiUrl(), {
-        method: 'POST',
-        headers: {
-            'Content-Type': 'application/json',
-            ...cookieHeader
-        },
-        body: JSON.stringify([{ method, args: [...args] }]),
-    });
-    const body = await response.json();
-    if (isNode()) {
-        const context = args[0];
-        for (const c of response.headers.getSetCookie()) {
-            const parts = c.split(';').map(p => p.trim());
-            const flags = parts.slice(1);
-            const [name, value] = parts[0].split('=').map(decodeURIComponent);
-            const httpOnly = flags.includes('HttpOnly');
-            const secure = flags.includes('Secure');
-            const maxAgePart = flags.find(f => f.startsWith('Max-Age='))?.split('=')[1];
-            context.cookies.set({
-                name,
-                value,
-                httpOnly,
-                secure,
-                maxAge: maxAgePart ? parseInt(maxAgePart) : undefined
-            });
-        }
-    }
-    const error = body[0].error;
-    if (error) {
-        throw new Error(error);
-    }
-    const value = body[0].data;
-    return value;
-}
-;
-export function apiTree(INTERNAL_API_URL, path = []) {
-    return new Proxy(function () { }, {
-        apply(_target, _thisArg, args) {
-            return callApi(INTERNAL_API_URL, path, ...args);
-        },
-        get(_target, prop) {
-            return apiTree(INTERNAL_API_URL, [...path, prop]);
-        }
-    });
-}
-;

package/dist/internal/client.d.ts

@@ -1 +0,0 @@
-export declare function apiTree(INTERNAL_API_URL: string, path?: string[]): () => void;

package/dist/internal/client.js

@@ -1,68 +0,0 @@
-async function callApi(INTERNAL_API_URL, method, ...args) {
-    function isNode() {
-        return typeof args[0]?.cookies?.getAll === 'function';
-    }
-    function apiUrl() {
-        if (isNode()) {
-            return INTERNAL_API_URL;
-        }
-        else {
-            return "/api";
-        }
-    }
-    let cookieHeader = {};
-    if (isNode()) {
-        const context = args[0];
-        const cookies = context.cookies.getAll();
-        cookieHeader = typeof cookies === 'object'
-            ? {
-                Cookie: Object.entries(cookies).map(kv => kv.join('=')).join('; ')
-            }
-            : {};
-    }
-    const response = await fetch(apiUrl(), {
-        method: 'POST',
-        headers: {
-            'Content-Type': 'application/json',
-            ...cookieHeader
-        },
-        body: JSON.stringify([{ method, args: [...args] }]),
-    });
-    const body = await response.json();
-    if (isNode()) {
-        const context = args[0];
-        for (const c of response.headers.getSetCookie()) {
-            const parts = c.split(';').map(p => p.trim());
-            const flags = parts.slice(1);
-            const [name, value] = parts[0].split('=').map(decodeURIComponent);
-            const httpOnly = flags.includes('HttpOnly');
-            const secure = flags.includes('Secure');
-            const maxAgePart = flags.find(f => f.startsWith('Max-Age='))?.split('=')[1];
-            context.cookies.set({
-                name,
-                value,
-                httpOnly,
-                secure,
-                maxAge: maxAgePart ? parseInt(maxAgePart) : undefined
-            });
-        }
-    }
-    const error = body[0].error;
-    if (error) {
-        throw new Error(error);
-    }
-    const value = body[0].data;
-    return value;
-}
-;
-export function apiTree(INTERNAL_API_URL, path = []) {
-    return new Proxy(function () { }, {
-        apply(_target, _thisArg, args) {
-            return callApi(INTERNAL_API_URL, path, ...args);
-        },
-        get(_target, prop) {
-            return apiTree(INTERNAL_API_URL, [...path, prop]);
-        }
-    });
-}
-;

package/dist/setup/index.d.ts

@@ -1 +0,0 @@
-export declare function prebuildApi(): Promise<void>;

package/dist/setup/index.js

@@ -1,27 +0,0 @@
-import process from 'process';
-import fs from 'fs';
-import path from 'path';
-export async function prebuildApi() {
-    const CWD = process.cwd();
-    let API_URL = '/api';
-    const indexModule = await import(path.join(CWD, 'index.js'));
-    try {
-        const backendConfigModule = await import(path.join(CWD, 'config.js'));
-        const backendConfig = backendConfigModule.default;
-        console.log("backend config found", backendConfig);
-        if (backendConfig.apiUrl) {
-            API_URL = backendConfig.apiUrl;
-        }
-    }
-    catch {
-        console.log("No backend API config found.");
-    }
-    const apiCode = Object.keys(indexModule)
-        .map(k => `export const ${k} = apiTree(INTERNAL_API_URL, ${JSON.stringify([k])});`)
-        .join('\n');
-    const baseClient = [
-        `import { apiTree } from "wirejs-resources/hosting/client.js";`,
-        `const INTERNAL_API_URL = ${JSON.stringify(API_URL)};`,
-    ].join('\n');
-    await fs.promises.writeFile(path.join(CWD, 'index.client.js'), [baseClient, apiCode].join('\n\n'));
-}