wirejs-resources 0.1.170 → 0.1.172

package/dist/hosting/client.d.ts

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

package/dist/hosting/client.js

@@ -0,0 +1,68 @@
+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/index.d.ts

@@ -13,6 +13,7 @@ export * from './types/index.js';
 export * from './derived-types.js';
 export * from './services/realtime.js';
 export * from './resources/background-job.js';
+export * from './resources/cron-job.js';
 export * from './resources/key-value-store.js';
 export * from './resources/endpoint.js';
 export * from './resources/system-attribute.js';

package/dist/index.js

@@ -12,6 +12,7 @@ export * from './types/index.js';
 export * from './derived-types.js';
 export * from './services/realtime.js';
 export * from './resources/background-job.js';
+export * from './resources/cron-job.js';
 export * from './resources/key-value-store.js';
 export * from './resources/endpoint.js';
 export * from './resources/system-attribute.js';

package/dist/internal/client.d.ts

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

package/dist/internal/client.js

@@ -0,0 +1,68 @@
+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/overrides.d.ts

@@ -1,5 +1,6 @@
 import type { AuthenticationService } from "./services/authentication";
 import type { BackgroundJob } from "./resources/background-job";
+import type { CronJob } from "./resources/cron-job";
 import type { DistributedTable } from "./resources/distributed-table";
 import type { Endpoint } from "./resources/endpoint";
 import type { FileService } from "./services/file";
@@ -13,6 +14,7 @@ import type { Setting } from "./resources/setting";
 export declare const overrides: {
     AuthenticationService?: typeof AuthenticationService;
     BackgroundJob?: typeof BackgroundJob;
+    CronJob?: typeof CronJob;
     DistributedTable?: typeof DistributedTable;
     Endpoint?: typeof Endpoint;
     FileService?: typeof FileService;

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

@@ -0,0 +1,28 @@
+import { Resource } from '../resource.js';
+/**
+ * A function that will be executed in the background on a recurring schedule
+ * defined by a cron expression.
+ *
+ * These MUST be created at the top-level of your application. I.e., they cannot be created
+ * dynamically in response to an API request or other event.
+ *
+ * A `CronJob` can also invoke an existing {@link BackgroundJob} from its handler.
+ *
+ * ## WARNINGS
+ *
+ * 1. These jobs execute in a completely different environment that the one that defines 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. In local development, **timeouts are not enforced.** (Yet.)
+ */
+export declare class CronJob extends Resource {
+    static registeredJobs: Map<string, {
+        schedule: string;
+        handler: () => Promise<void>;
+    }>;
+    readonly schedule: string;
+    constructor(scope: Resource | string, id: string, options: {
+        schedule: string;
+        handler: () => Promise<void>;
+    });
+}

package/dist/resources/cron-job.js

@@ -0,0 +1,29 @@
+import { Resource } from '../resource.js';
+/**
+ * A function that will be executed in the background on a recurring schedule
+ * defined by a cron expression.
+ *
+ * These MUST be created at the top-level of your application. I.e., they cannot be created
+ * dynamically in response to an API request or other event.
+ *
+ * A `CronJob` can also invoke an existing {@link BackgroundJob} from its handler.
+ *
+ * ## WARNINGS
+ *
+ * 1. These jobs execute in a completely different environment that the one that defines 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. In local development, **timeouts are not enforced.** (Yet.)
+ */
+export class CronJob extends Resource {
+    static registeredJobs = new Map();
+    schedule;
+    constructor(scope, id, options) {
+        super(scope, id);
+        this.schedule = options.schedule;
+        CronJob.registeredJobs.set(this.absoluteId, {
+            schedule: options.schedule,
+            handler: options.handler,
+        });
+    }
+}

package/dist/resources/secret.d.ts

@@ -1,7 +1,13 @@
 import { Resource } from '../resource.js';
 export declare class Secret extends Resource {
-    #private;
     constructor(scope: Resource | string, id: string);
-    read(): Promise<any>;
-    write(data: any): Promise<void>;
+    read(): Promise<string>;
+    write(value: string, options?: {
+        onlyIfNotExists?: boolean;
+    }): Promise<void | undefined>;
+    scan(): AsyncGenerator<never, AsyncGenerator<{
+        key: string;
+        value: string;
+    }, any, any> | undefined, unknown>;
+    isAlreadyExistsError(error: any): boolean | undefined;
 }

package/dist/resources/secret.js

@@ -1,28 +1,38 @@
-import crypto from 'crypto';
+import * as crypto from 'crypto';
 import { Resource } from '../resource.js';
-import { FileService } from '../services/file.js';
+import { KeyValueStore } from './key-value-store.js';
 import { overrides } from '../overrides.js';
-const FILENAME = 'secret';
+let secrets;
 export class Secret extends Resource {
-    #fileService;
-    #initPromise;
     constructor(scope, id) {
         super(scope, id);
-        this.#fileService = new (overrides.FileService || FileService)(this, 'files');
-    }
-    #initialize() {
-        this.#initPromise = this.#initPromise || this.#fileService.write(FILENAME, JSON.stringify(crypto.randomBytes(64).toString('base64url')), { onlyIfNotExists: true }).catch(error => {
-            if (!this.#fileService.isAlreadyExistsError(error))
-                throw error;
-        });
-        return this.#initPromise;
+        secrets = new (overrides.KeyValueStore || KeyValueStore)('wirejs', 'secrets');
     }
     async read() {
-        await this.#initialize();
-        return JSON.parse(await this.#fileService.read(FILENAME));
+        const existingValue = await secrets?.get(this.absoluteId);
+        if (!existingValue) {
+            try {
+                const initValue = crypto.randomBytes(64).toString('base64url');
+                await this.write(initValue, { onlyIfNotExists: true });
+                return initValue;
+            }
+            catch (error) {
+                if (!this.isAlreadyExistsError(error))
+                    throw error;
+                return this.read();
+            }
+        }
+        else {
+            return existingValue;
+        }
+    }
+    async write(value, options) {
+        return secrets?.set(this.absoluteId, value, { onlyIfNotExists: options?.onlyIfNotExists });
+    }
+    async *scan() {
+        return secrets?.scan();
     }
-    async write(data) {
-        await this.#initialize();
-        await this.#fileService.write(FILENAME, JSON.stringify(data));
+    isAlreadyExistsError(error) {
+        return secrets?.isAlreadyExistsError(error);
     }
 }

package/dist/setup/index.d.ts

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

package/dist/setup/index.js

@@ -0,0 +1,27 @@
+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'));
+}

package/package.json

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