k3-plugin-api 1.4.5 → 1.5.0

package/dist/index.cjs

@@ -0,0 +1,73 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region index.ts
+/**
+* Internal getter function injected by K3 at runtime.
+*/
+let _getSettings = null;
+/**
+* Internal reactive hook injected by K3 at runtime.
+*/
+let _usePluginSettings = null;
+/**
+* Get plugin-specific settings from the K3 store.
+* Returns a snapshot of the current settings - not reactive.
+* Use this in plugin components that need access to settings configured in the admin.
+*
+* @param pluginId - The unique plugin ID (e.g. "acme.my-plugin")
+* @returns The settings object for this plugin, or `{}` if none are configured
+*
+* @example
+* ```typescript
+* const settings = getSettings("acme.my-plugin") as { apiKey?: string };
+* if (settings.apiKey) {
+*   // Use API key
+* }
+* ```
+*/
+function getSettings(pluginId) {
+	if (!_getSettings) throw new Error("k3-plugin-api not initialized. Make sure K3 calls init() before using getSettings().");
+	return _getSettings(pluginId);
+}
+/**
+* Get plugin-specific settings from the K3 store as a reactive hook.
+* Re-renders the component whenever the settings change.
+* Use this in plugin React components.
+*
+* @param pluginId - The unique plugin ID (e.g. "acme.my-plugin")
+* @returns The settings object for this plugin, or `{}` if none are configured
+*
+* @example
+* ```typescript
+* const settings = useK3PluginSettings("acme.my-plugin") as { apiKey?: string };
+* ```
+*/
+function useK3PluginSettings(pluginId) {
+	if (!_usePluginSettings) throw new Error("k3-plugin-api not initialized. Make sure K3 calls init() before using useK3PluginSettings().");
+	return _usePluginSettings(pluginId);
+}
+/**
+* Called by K3 when the plugin is loaded to inject runtime API functions.
+* @internal This function is called by K3 automatically - plugins should not call it directly.
+*/
+function init(api) {
+	_getSettings = api.getSettings;
+	_usePluginSettings = api.usePluginSettings;
+}
+/** All variable type string literals. */
+const VariableType = {
+	List: "list",
+	Color: "color",
+	Number: "number",
+	Text: "text",
+	MultiSelect: "multiSelect",
+	Boolean: "boolean",
+	Image: "image",
+	Upload: "upload",
+	Components: "components",
+	Information: "information"
+};
+//#endregion
+exports.VariableType = VariableType;
+exports.getSettings = getSettings;
+exports.init = init;
+exports.useK3PluginSettings = useK3PluginSettings;