@statezero/core 0.2.36 → 0.2.38

package/dist/actions/default/django_app/send-notification.d.ts

@@ -1,55 +0,0 @@
-/**
- * Send notifications to multiple recipients
- *
- * @param string message - Notification message to send
- * @param any[] recipients - List of email addresses to notify
- * @param 'low' | 'high' priority - Notification priority level
- * @param {Object} [axiosOverrides] - Allows overriding Axios request parameters.
- * @returns {Promise<Object>} A promise that resolves with the action's result.
- */
-export function sendNotification(message: any, recipients: any, priority?: string, axiosOverrides?: Object): Promise<Object>;
-export namespace sendNotification {
-    let actionName: string;
-    let title: string;
-    let app: string;
-    let permissions: string[];
-    let configKey: string;
-}
-/**
- * Zod schema for the input of sendNotification.
- * NOTE: This is an object schema for validating the data payload.
- */
-export const sendNotificationInputSchema: z.ZodObject<{
-    message: z.ZodString;
-    recipients: z.ZodArray<z.ZodAny, "many">;
-    priority: z.ZodDefault<z.ZodOptional<z.ZodEnum<["low", "high"]>>>;
-}, "strip", z.ZodTypeAny, {
-    message: string;
-    priority: "low" | "high";
-    recipients: any[];
-}, {
-    message: string;
-    recipients: any[];
-    priority?: "low" | "high" | undefined;
-}>;
-/**
- * Zod schema for the response of sendNotification.
- */
-export const sendNotificationResponseSchema: z.ZodObject<{
-    success: z.ZodBoolean;
-    message_id: z.ZodString;
-    sent_to: z.ZodNumber;
-    queued_at: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    success: boolean;
-    message_id: string;
-    sent_to: number;
-    queued_at: string;
-}, {
-    success: boolean;
-    message_id: string;
-    sent_to: number;
-    queued_at: string;
-}>;
-export default sendNotification;
-import { z } from 'zod';

package/dist/actions/default/django_app/send-notification.js

@@ -1,81 +0,0 @@
-/**
- * This file was auto-generated. Do not make direct changes to the file.
- * Action: Send Notification
- * App: django_app
- */
-import axios from 'axios';
-import { z } from 'zod';
-import { configInstance, parseStateZeroError, serializeActionPayload } from '../../../../src';
-import actionSchema from './send-notification.schema.json' assert { type: 'json' };
-/**
- * Zod schema for the input of sendNotification.
- * NOTE: This is an object schema for validating the data payload.
- */
-export const sendNotificationInputSchema = z.object({ message: z.string().max(500),
-    recipients: z.array(z.any()),
-    priority: z.enum(["low", "high"]).optional().default("low") });
-/**
- * Zod schema for the response of sendNotification.
- */
-export const sendNotificationResponseSchema = z.object({ success: z.boolean(),
-    message_id: z.string(),
-    sent_to: z.number().int(),
-    queued_at: z.string().datetime({ message: "Invalid ISO 8601 datetime string" }) });
-/**
- * Send notifications to multiple recipients
- *
- * @param string message - Notification message to send
- * @param any[] recipients - List of email addresses to notify
- * @param 'low' | 'high' priority - Notification priority level
- * @param {Object} [axiosOverrides] - Allows overriding Axios request parameters.
- * @returns {Promise<Object>} A promise that resolves with the action's result.
- */
-export async function sendNotification(message, recipients, priority = "low", axiosOverrides = {}) {
-    // Construct the data payload from the function arguments
-    const rawPayload = {
-        message,
-        recipients,
-        priority
-    };
-    // Serialize payload - handles model instances (extracts PK), files, dates, etc.
-    const payload = serializeActionPayload(rawPayload, actionSchema.input_properties);
-    const config = configInstance.getConfig();
-    const backend = config.backendConfigs['default'];
-    if (!backend) {
-        throw new Error(`No backend configuration found for key: default`);
-    }
-    const baseUrl = backend.API_URL.replace(/\/+$/, '');
-    const actionUrl = `${baseUrl}/actions/send_notification/`;
-    const headers = backend.getAuthHeaders ? backend.getAuthHeaders() : {};
-    try {
-        const response = await axios.post(actionUrl, payload, {
-            headers: { 'Content-Type': 'application/json', ...headers },
-            ...axiosOverrides,
-        });
-        return sendNotificationResponseSchema.parse(response.data);
-    }
-    catch (error) {
-        if (error instanceof z.ZodError) {
-            throw new Error(`Send Notification failed: Invalid response from server. Details: ${error.message}`);
-        }
-        if (error.response && error.response.data) {
-            const parsedError = parseStateZeroError(error.response.data);
-            if (Error.captureStackTrace) {
-                Error.captureStackTrace(parsedError, sendNotification);
-            }
-            throw parsedError;
-        }
-        else if (error.request) {
-            throw new Error(`Send Notification failed: No response received from server.`);
-        }
-        else {
-            throw new Error(`Send Notification failed: ${error.message}`);
-        }
-    }
-}
-export default sendNotification;
-sendNotification.actionName = 'send_notification';
-sendNotification.title = 'Send Notification';
-sendNotification.app = 'django_app';
-sendNotification.permissions = ['ValidatedCanSendNotifications'];
-sendNotification.configKey = 'default';

package/dist/actions/default/django_app/send-notification.schema.json

@@ -1,175 +0,0 @@
-{
-    "action_name": "send_notification",
-    "app": "django_app",
-    "title": "Send Notification",
-    "docstring": "Send notifications to multiple recipients",
-    "class_name": "SendNotification",
-    "input_properties": {
-        "message": {
-            "type": "string",
-            "title": "Message",
-            "required": true,
-            "description": "Notification message to send",
-            "nullable": false,
-            "format": null,
-            "max_length": 500,
-            "choices": null,
-            "default": null,
-            "validators": [],
-            "max_digits": null,
-            "decimal_places": null,
-            "read_only": false,
-            "ref": null
-        },
-        "recipients": {
-            "type": "array",
-            "title": "Recipients",
-            "required": true,
-            "description": "List of email addresses to notify",
-            "nullable": false,
-            "format": null,
-            "max_length": null,
-            "choices": null,
-            "default": null,
-            "validators": [],
-            "max_digits": null,
-            "decimal_places": null,
-            "read_only": false,
-            "ref": null
-        },
-        "priority": {
-            "type": "string",
-            "title": "Priority",
-            "required": false,
-            "description": "Notification priority level",
-            "nullable": false,
-            "format": null,
-            "max_length": null,
-            "choices": {
-                "low": "Low",
-                "high": "High"
-            },
-            "default": "low",
-            "validators": [],
-            "max_digits": null,
-            "decimal_places": null,
-            "read_only": false,
-            "ref": null
-        }
-    },
-    "response_properties": {
-        "success": {
-            "type": "boolean",
-            "title": "Success",
-            "required": true,
-            "description": null,
-            "nullable": false,
-            "format": null,
-            "max_length": null,
-            "choices": null,
-            "default": null,
-            "validators": [],
-            "max_digits": null,
-            "decimal_places": null,
-            "read_only": false,
-            "ref": null
-        },
-        "message_id": {
-            "type": "string",
-            "title": "Message id",
-            "required": true,
-            "description": null,
-            "nullable": false,
-            "format": null,
-            "max_length": null,
-            "choices": null,
-            "default": null,
-            "validators": [],
-            "max_digits": null,
-            "decimal_places": null,
-            "read_only": false,
-            "ref": null
-        },
-        "sent_to": {
-            "type": "integer",
-            "title": "Sent to",
-            "required": true,
-            "description": null,
-            "nullable": false,
-            "format": null,
-            "max_length": null,
-            "choices": null,
-            "default": null,
-            "validators": [],
-            "max_digits": null,
-            "decimal_places": null,
-            "read_only": false,
-            "ref": null
-        },
-        "queued_at": {
-            "type": "string",
-            "title": "Queued at",
-            "required": true,
-            "description": null,
-            "nullable": false,
-            "format": "date-time",
-            "max_length": null,
-            "choices": null,
-            "default": null,
-            "validators": [],
-            "max_digits": null,
-            "decimal_places": null,
-            "read_only": false,
-            "ref": null
-        }
-    },
-    "relationships": {},
-    "permissions": [
-        "ValidatedCanSendNotifications"
-    ],
-    "display": {
-        "display_title": "Send Notifications",
-        "display_description": "Send notifications to multiple recipients with priority control",
-        "field_groups": [
-            {
-                "display_title": "Message Content",
-                "display_description": "The notification message and priority level",
-                "field_names": [
-                    "message",
-                    "priority"
-                ]
-            },
-            {
-                "display_title": "Recipients",
-                "display_description": "Email addresses to send notifications to",
-                "field_names": [
-                    "recipients"
-                ]
-            }
-        ],
-        "field_display_configs": [
-            {
-                "field_name": "message",
-                "display_component": "TextArea",
-                "filter_queryset": null,
-                "display_help_text": "Enter your notification message here (max 500 characters)",
-                "extra": null
-            },
-            {
-                "field_name": "priority",
-                "display_component": "RadioGroup",
-                "filter_queryset": null,
-                "display_help_text": "High priority notifications are processed first",
-                "extra": null
-            },
-            {
-                "field_name": "recipients",
-                "display_component": "EmailListInput",
-                "filter_queryset": null,
-                "display_help_text": "Add one or more email addresses",
-                "extra": null
-            }
-        ],
-        "extra": null
-    }
-}

package/dist/actions/default/index.d.ts

@@ -1 +0,0 @@
-export * from "./django_app/index.js";

package/dist/actions/default/index.js

@@ -1 +0,0 @@
-export * from './django_app/index.js';

package/dist/actions/index.d.ts

@@ -1 +0,0 @@
-export * from "./default/index.js";

package/dist/actions/index.js

@@ -1,5 +0,0 @@
-/**
- * This file was auto-generated. Do not make direct changes to the file.
- * Re-exports from the 'default' backend for backwards compatibility.
- */
-export * from './default/index.js';

package/dist/adaptors/react/composables.d.ts

@@ -1 +0,0 @@
-export function useQueryset(querysetFactory: any): any;

package/dist/adaptors/react/composables.js

@@ -1,4 +0,0 @@
-export function useQueryset(querysetFactory) {
-    console.warn("React environments are not currently supported");
-    return querysetFactory;
-}

package/dist/adaptors/react/index.d.ts

@@ -1 +0,0 @@
-export { useQueryset } from "./composables.js";

package/dist/adaptors/react/index.js

@@ -1 +0,0 @@
-export { useQueryset } from './composables.js';

package/dist/adaptors/vue/components/defaults/index.d.ts

@@ -1,7 +0,0 @@
-/**
- * Create a default components registry (without Control - user must provide)
- *
- * @param {Object} options - Override specific components
- * @returns {Object} Components registry for LayoutRenderer
- */
-export function createDefaultComponents(options?: Object): Object;

package/dist/adaptors/vue/components/defaults/index.js

@@ -1,31 +0,0 @@
-/**
- * Default component implementations for LayoutRenderer
- *
- * These are minimal, unstyled implementations that follow the contracts.
- * Users can use these as-is or as reference for custom implementations.
- */
-export { default as AlertElement } from './AlertElement.vue';
-export { default as LabelElement } from './LabelElement.vue';
-export { default as DividerElement } from './DividerElement.vue';
-export { default as DisplayElement } from './DisplayElement.vue';
-export { default as GroupElement } from './GroupElement.vue';
-export { default as TabsElement } from './TabsElement.vue';
-export { default as ErrorBlock } from './ErrorBlock.vue';
-/**
- * Create a default components registry (without Control - user must provide)
- *
- * @param {Object} options - Override specific components
- * @returns {Object} Components registry for LayoutRenderer
- */
-export function createDefaultComponents(options = {}) {
-    return {
-        Alert: AlertElement,
-        Label: LabelElement,
-        Divider: DividerElement,
-        Display: DisplayElement,
-        Group: GroupElement,
-        Tabs: TabsElement,
-        ErrorBlock: ErrorBlock,
-        ...options
-    };
-}

package/dist/adaptors/vue/components/index.d.ts

@@ -1 +0,0 @@
-export { AlertElement, LabelElement, DividerElement, DisplayElement, GroupElement, TabsElement, ErrorBlock, createDefaultComponents } from "./defaults/index.js";

package/dist/adaptors/vue/components/index.js

@@ -1,7 +0,0 @@
-/**
- * Vue components for StateZero
- */
-// Main layout renderer
-export { default as LayoutRenderer } from './LayoutRenderer.vue';
-// Default component implementations
-export { AlertElement, LabelElement, DividerElement, DisplayElement, GroupElement, TabsElement, ErrorBlock, createDefaultComponents } from './defaults/index.js';

package/dist/adaptors/vue/composables.d.ts

@@ -1,2 +0,0 @@
-export function useQueryset(querysetFactory: any): import("vue").ComputedRef<any>;
-export const querysets: Map<any, any>;

package/dist/adaptors/vue/composables.js

@@ -1,44 +0,0 @@
-import { computed, getCurrentInstance, onBeforeUnmount } from 'vue';
-import { querysetStoreRegistry } from '../../syncEngine/registries/querysetStoreRegistry.js';
-import { metricRegistry } from '../../syncEngine/registries/metricRegistry.js';
-import { syncManager } from '../../syncEngine/sync.js';
-import { registerAdapterReset } from '../../reset.js';
-import { v7 } from 'uuid';
-syncManager.followAllQuerysets = false;
-export const querysets = new Map(); // Map of composableId -> queryset
-function updateSyncManager() {
-    // Get unique querysets from all active composables
-    const uniqueQuerysets = new Set(querysets.values());
-    syncManager.followedQuerysets = uniqueQuerysets;
-}
-export function useQueryset(querysetFactory) {
-    const instance = getCurrentInstance();
-    if (!instance) {
-        throw new Error('useQueryset must be called within a component setup function');
-    }
-    const composableId = v7();
-    let lastQueryset = null;
-    onBeforeUnmount(() => {
-        querysets.delete(composableId);
-        updateSyncManager();
-    });
-    return computed(() => {
-        const result = querysetFactory();
-        const original = result?.original || result;
-        const queryset = original?.queryset || original;
-        // Only update if queryset actually changed
-        if (lastQueryset !== queryset) {
-            querysets.set(composableId, queryset);
-            updateSyncManager();
-            lastQueryset = queryset;
-        }
-        return result;
-    });
-}
-registerAdapterReset(() => {
-    querysets.clear();
-    // Reset syncManager back to following all querysets since no composables are active
-    syncManager.followAllQuerysets = true;
-    syncManager.followedQuerysets.clear();
-    console.log("Vue composables state cleared");
-});

package/dist/adaptors/vue/index.d.ts

@@ -1,3 +0,0 @@
-export { useQueryset, querysets } from "./composables.js";
-export { ModelAdaptor, QuerySetAdaptor, MetricAdaptor } from "./reactivity.js";
-export { LayoutRenderer, AlertElement, LabelElement, DividerElement, DisplayElement, GroupElement, TabsElement, ErrorBlock, createDefaultComponents } from "./components/index.js";

package/dist/adaptors/vue/index.js

@@ -1,4 +0,0 @@
-export { useQueryset, querysets } from './composables.js';
-export { ModelAdaptor, QuerySetAdaptor, MetricAdaptor } from './reactivity.js';
-// Layout components
-export { LayoutRenderer, AlertElement, LabelElement, DividerElement, DisplayElement, GroupElement, TabsElement, ErrorBlock, createDefaultComponents } from './components/index.js';

package/dist/adaptors/vue/reactivity.d.ts

@@ -1,18 +0,0 @@
-/**
- * Adapts a model instance to a Vue reactive object by directly wrapping
- * the instance and incrementing an internal version on relevant events.
- *
- * @param {Object} modelInstance - An instance of a model class with static modelName and primaryKeyField
- * @param {Function} [reactivityFn=reactive] - Which Vue reactivity function to use (reactive or ref)
- * @returns {import('vue').Reactive|import('vue').Ref} The reactive model instance, augmented with __version
- */
-export function ModelAdaptor(modelInstance: Object, reactivityFn?: Function): any | import("vue").Ref;
-/**
- * Adapts a queryset to a Vue reactive object and sets up event handling for queryset updates
- *
- * @param {Object} liveQuerySet - A LiveQueryset instance
- * @param {Function} [reactivityFn=reactive] - Which Vue reactivity function to use (reactive or ref)
- * @returns {import('vue').Reactive|import('vue').Ref} The reactive queryset
- */
-export function QuerySetAdaptor(liveQuerySet: Object, reactivityFn?: Function): any | import("vue").Ref;
-export function MetricAdaptor(metric: any): any;

package/dist/adaptors/vue/reactivity.js

@@ -1,132 +0,0 @@
-import { reactive, ref, nextTick } from "vue";
-import { modelEventEmitter, querysetEventEmitter, metricEventEmitter } from "../../syncEngine/stores/reactivity.js";
-import { initEventHandler } from "../../syncEngine/stores/operationEventHandlers.js";
-import { isEqual, isNil } from 'lodash-es';
-import hash from 'object-hash';
-import { registerAdapterReset } from "../../reset.js";
-initEventHandler();
-const wrappedQuerysetCache = new Map();
-const wrappedMetricCache = new Map();
-/**
- * Adapts a model instance to a Vue reactive object by directly wrapping
- * the instance and incrementing an internal version on relevant events.
- *
- * @param {Object} modelInstance - An instance of a model class with static modelName and primaryKeyField
- * @param {Function} [reactivityFn=reactive] - Which Vue reactivity function to use (reactive or ref)
- * @returns {import('vue').Reactive|import('vue').Ref} The reactive model instance, augmented with __version
- */
-export function ModelAdaptor(modelInstance, reactivityFn = reactive) {
-    const modelClass = modelInstance.constructor;
-    const modelName = modelClass.modelName;
-    const configKey = modelClass.configKey;
-    const pkField = modelClass.primaryKeyField;
-    // Make the model instance reactive using the specified function
-    const wrapper = reactivityFn(modelInstance);
-    const eventName = `${configKey}::${modelName}::render`;
-    // Handler bumps version to trigger Vue reactivity when this instance updates
-    const renderHandler = (eventData) => {
-        const isRef = reactivityFn === ref;
-        const model = isRef ? wrapper.value : wrapper;
-        const modelPk = model[pkField];
-        // Check if this model's pk is in the event's pks array
-        if (eventData.pks && eventData.pks.includes(modelPk)) {
-            if (isRef) {
-                wrapper.value.touch();
-            }
-            else {
-                wrapper.touch();
-            }
-        }
-    };
-    // Subscribe to model events indefinitely
-    modelEventEmitter.on(eventName, renderHandler);
-    return wrapper;
-}
-/**
- * Adapts a queryset to a Vue reactive object and sets up event handling for queryset updates
- *
- * @param {Object} liveQuerySet - A LiveQueryset instance
- * @param {Function} [reactivityFn=reactive] - Which Vue reactivity function to use (reactive or ref)
- * @returns {import('vue').Reactive|import('vue').Ref} The reactive queryset
- */
-export function QuerySetAdaptor(liveQuerySet, reactivityFn = reactive) {
-    const queryset = liveQuerySet?.queryset;
-    const modelName = queryset?.ModelClass?.modelName;
-    const configKey = queryset?.ModelClass?.configKey;
-    if (isNil(queryset) || isNil(modelName)) {
-        throw new Error(`liveQuerySet ${JSON.stringify(liveQuerySet)} had null qs: ${queryset} or model: ${modelName}`);
-    }
-    // Use the semantic key if available
-    const cacheKey = queryset.semanticKey;
-    // Check the cache first
-    if (cacheKey && wrappedQuerysetCache.has(cacheKey)) {
-        return wrappedQuerysetCache.get(cacheKey);
-    }
-    const querysetAst = queryset.build();
-    // Make the queryset reactive using the specified function
-    const wrapper = reactivityFn([...liveQuerySet]);
-    wrapper.original = liveQuerySet;
-    const eventName = `${configKey}::${modelName}::queryset::render`;
-    // Handler bumps version to trigger Vue reactivity when this queryset updates
-    const renderHandler = (eventData) => {
-        if (eventData && eventData.ast && isEqual(querysetAst, eventData.ast)) {
-            if (reactivityFn === ref) {
-                wrapper.value = [...liveQuerySet];
-            }
-            else {
-                wrapper.splice(0, wrapper.length);
-                wrapper.push(...liveQuerySet);
-            }
-        }
-    };
-    // Subscribe to queryset events indefinitely
-    querysetEventEmitter.on(eventName, renderHandler);
-    /* Dont delete the innocuous looking queryset.length check. There is some weird interaction
-    with vue, where when we load an empty queryset from the cache, the reactivity completely breaks.
-    I wasted over 2 days on this bug, and it won't show up in the e2e tests because it just impacts the
-    vue reactivity. If this causes performance issues, and needs to be refactored. Make sure you understand
-    the vue reactivity interaction correctly and find a different way to fix the broken reactivity for empty querysets */
-    if (cacheKey && liveQuerySet && liveQuerySet.length > 0) {
-        wrappedQuerysetCache.set(cacheKey, wrapper);
-    }
-    return wrapper;
-}
-export function MetricAdaptor(metric) {
-    const queryset = metric.queryset;
-    const modelName = queryset?.ModelClass?.modelName;
-    const configKey = queryset?.ModelClass?.configKey;
-    const querysetAst = queryset.build();
-    // Create a cache key based on metric properties
-    // This combines model, metric type, field, and the queryset AST hash to ensure uniqueness
-    const cacheKey = `${configKey}::${modelName}::${metric.metricType}::${metric.field}::${hash(querysetAst)}`;
-    // Check the cache first
-    if (cacheKey && wrappedMetricCache.has(cacheKey)) {
-        return wrappedMetricCache.get(cacheKey);
-    }
-    // Create a reactive reference with the initial value
-    const wrapper = ref(metric.value);
-    wrapper.original = metric;
-    // Single handler for metric render events
-    const metricRenderHandler = (eventData) => {
-        // Only update if this event is for our metric
-        if (eventData.metricType === metric.metricType &&
-            eventData.ModelClass === metric.queryset.ModelClass &&
-            eventData.field === metric.field &&
-            eventData.ast === hash(querysetAst) &&
-            eventData.valueChanged === true) {
-            // Update the wrapper value with the latest metric value
-            wrapper.value = metric.value;
-        }
-    };
-    // Only listen for metric render events
-    metricEventEmitter.on('metric::render', metricRenderHandler);
-    // Store in cache
-    if (cacheKey) {
-        wrappedMetricCache.set(cacheKey, wrapper);
-    }
-    return wrapper;
-}
-registerAdapterReset(() => {
-    wrappedQuerysetCache.clear();
-    wrappedMetricCache.clear();
-});

package/dist/cli/commands/sync.d.ts

@@ -1,6 +0,0 @@
-/**
- * Executes a full synchronization, running sync-models first,
- * followed by sync-actions.
- * @param {object} args - Command-line arguments, passed from yargs.
- */
-export function sync(args?: object): Promise<void>;

package/dist/cli/commands/sync.js

@@ -1,30 +0,0 @@
-import { generateSchema } from "./syncModels.js";
-import { generateActions } from "./syncActions.js";
-/**
- * Executes a full synchronization, running sync-models first,
- * followed by sync-actions.
- * @param {object} args - Command-line arguments, passed from yargs.
- */
-export async function sync(args = {}) {
-    try {
-        console.log("🚀 Starting full synchronization...");
-        // --- Step 1: Synchronize Models ---
-        console.log("\n----- Running Model Synchronization -----");
-        // Pass args down, as generateSchema expects an object
-        await generateSchema(args);
-        console.log("----- Model Synchronization Complete -----\n");
-        // --- Step 2: Synchronize Actions ---
-        console.log("----- Running Action Synchronization -----");
-        // generateActions does not require args based on its definition
-        await generateActions();
-        console.log("----- Action Synchronization Complete -----\n");
-        console.log("✅ Full synchronization finished successfully!");
-    }
-    catch (error) {
-        console.error("\n❌ A critical error occurred during full synchronization:", error.message);
-        if (process.env.DEBUG) {
-            console.error("Stack trace:", error.stack);
-        }
-        process.exit(1);
-    }
-}