@plasmicpkgs/plasmic-basic-components 0.0.191 → 0.0.192

package/dist/LoadingBoundary.d.ts

@@ -5,8 +5,6 @@ interface LoadingBoundaryProps {
     children?: React.ReactNode;
     forceLoading?: boolean;
 }
-export declare const isBrowser: boolean;
-export declare const useIsomorphicLayoutEffect: typeof React.useLayoutEffect;
 export default function LoadingBoundary({ children, forceLoading, loadingState, }: LoadingBoundaryProps): React.JSX.Element | null;
 export declare const loadingBoundaryMeta: ComponentMeta<LoadingBoundaryProps>;
 export declare function registerLoadingBoundary(loader?: {

package/dist/Timer.d.ts

@@ -0,0 +1,12 @@
+import registerComponent, { CodeComponentMeta } from "@plasmicapp/host/registerComponent";
+export interface TimerProps {
+    onTick: () => void;
+    isRunning?: boolean;
+    intervalSeconds?: number;
+}
+export declare function useInterval(callback: () => void, delay: number | null): void;
+export default function Timer({ intervalSeconds, isRunning, onTick, }: TimerProps): null;
+export declare const timerMeta: CodeComponentMeta<TimerProps>;
+export declare function registerTimer(loader?: {
+    registerComponent: typeof registerComponent;
+}, customMeta?: CodeComponentMeta<TimerProps>): void;

package/dist/common.d.ts

@@ -1,2 +1,5 @@
+import React from "react";
 export declare const tuple: <T extends any[]>(...args: T) => T;
 export declare function ensure<T>(x: T | null | undefined): T;
+export declare const isBrowser: boolean;
+export declare const useIsomorphicLayoutEffect: typeof React.useLayoutEffect;

package/dist/index.d.ts

@@ -1,17 +1,19 @@
+export * from "./ConditionGuard";
+export { default as ConditionGuard } from "./ConditionGuard";
 export * from "./Data";
 export * from "./Embed";
 export { default as Embed } from "./Embed";
 export * from "./Iframe";
 export { default as Iframe } from "./Iframe";
+export * from "./LoadingBoundary";
+export { default as LoadingBoundary } from "./LoadingBoundary";
 export * from "./Repeater";
 export { default as Repeater } from "./Repeater";
 export * from "./ScrollRevealer";
 export { default as ScrollRevealer } from "./ScrollRevealer";
+export * from "./SideEffect";
+export { default as SideEffect } from "./SideEffect";
+export * from "./Timer";
+export { default as Timer } from "./Timer";
 export * from "./Video";
 export { default as Video } from "./Video";
-export { default as LoadingBoundary } from "./LoadingBoundary";
-export * from "./LoadingBoundary";
-export { default as ConditionGuard } from "./ConditionGuard";
-export * from "./ConditionGuard";
-export { default as SideEffect } from "./SideEffect";
-export * from "./SideEffect";

package/dist/plasmic-basic-components.cjs.development.js

@@ -4,12 +4,92 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
 
-var host = require('@plasmicapp/host');
 var registerComponent = _interopDefault(require('@plasmicapp/host/registerComponent'));
 var React = require('react');
 var React__default = _interopDefault(React);
+var host = require('@plasmicapp/host');
+var registerGlobalContext = _interopDefault(require('@plasmicapp/host/registerGlobalContext'));
 var plasmicQuery = require('@plasmicapp/query');
 
+function ConditionGuardOnNotSatisfied(_ref) {
+  var onNotSatisfied = _ref.onNotSatisfied;
+  var ref = React__default.useRef(false);
+  React__default.useEffect(function () {
+    if (!ref.current) {
+      ref.current = true;
+      onNotSatisfied == null || onNotSatisfied();
+    }
+  }, [onNotSatisfied]);
+  return null;
+}
+function isCurrentLocationInSkipPaths(skipPaths) {
+  var _globalThis$__PLASMIC;
+  var pathname = window.location.pathname;
+  // Ignore search params
+  var currentPath = window.location.origin + pathname;
+  var plasmicPathname = globalThis == null || (_globalThis$__PLASMIC = globalThis["__PLASMIC_STUDIO_PATH"]) == null ? void 0 : _globalThis$__PLASMIC.call(globalThis);
+  return skipPaths == null ? void 0 : skipPaths.some(function (_ref2) {
+    var path = _ref2.path;
+    return path === pathname || path === currentPath || path === plasmicPathname;
+  });
+}
+function ConditionGuard(_ref3) {
+  var condition = _ref3.condition,
+    onNotSatisfied = _ref3.onNotSatisfied,
+    children = _ref3.children,
+    skipPaths = _ref3.skipPaths;
+  if (!condition && !isCurrentLocationInSkipPaths(skipPaths)) {
+    return React__default.createElement(ConditionGuardOnNotSatisfied, {
+      onNotSatisfied: onNotSatisfied
+    });
+  }
+  return React__default.createElement(React__default.Fragment, null, children);
+}
+var conditionGuardMeta = {
+  name: "hostless-condition-guard",
+  displayName: "Condition Guard",
+  description: "Ensure some condition, or else run an interaction. Examples: ensure all users have a database row, or require new users to setup a profile.",
+  importName: "ConditionGuard",
+  importPath: "@plasmicpkgs/plasmic-basic-components",
+  props: {
+    children: "slot",
+    condition: {
+      type: "boolean",
+      displayName: "Condition",
+      description: "The condition to guard against",
+      helpText: "Condition to check. Render contents only if true. Run interaction if false.",
+      defaultValue: true
+    },
+    onNotSatisfied: {
+      type: "eventHandler",
+      displayName: "On condition false",
+      description: "The action to run when the condition is not satisfied",
+      argTypes: []
+    },
+    skipPaths: {
+      type: "array",
+      displayName: "Skip Paths",
+      description: "Paths that the action should not run",
+      itemType: {
+        type: "object",
+        fields: {
+          path: "href"
+        },
+        nameFunc: function nameFunc(item) {
+          return item == null ? void 0 : item.path;
+        }
+      }
+    }
+  }
+};
+function registerConditionGuard(loader, customConditionGuardMeta) {
+  if (loader) {
+    loader.registerComponent(ConditionGuard, customConditionGuardMeta != null ? customConditionGuardMeta : conditionGuardMeta);
+  } else {
+    registerComponent(ConditionGuard, customConditionGuardMeta != null ? customConditionGuardMeta : conditionGuardMeta);
+  }
+}
+
 function _regeneratorRuntime() {
   _regeneratorRuntime = function () {
     return e;
@@ -599,6 +679,7 @@ function registerDynamicImage(loader, customDynamicImageMeta) {
   }
 }
 
+console.log(typeof registerGlobalContext);
 function ensure(x) {
   if (x === null || x === undefined) {
     debugger;
@@ -607,6 +688,8 @@ function ensure(x) {
     return x;
   }
 }
+var isBrowser = typeof window !== "undefined";
+var useIsomorphicLayoutEffect = isBrowser ? React__default.useLayoutEffect : React__default.useEffect;
 
 /**
  * A common use case for embedding HTML snippets is loading/running script tags, so most of the logic here is for
@@ -788,6 +871,90 @@ function registerIframe(loader, customIframeMeta) {
   }
 }
 
+var reactMajorVersion = + /*#__PURE__*/React__default.version.split(".")[0];
+if (reactMajorVersion < 18) {
+  console.warn("The LoadingBoundary component only works with React 18+");
+}
+var enableLoadingBoundaryKey = "plasmicInternalEnableLoadingBoundary";
+var hasLoadingBoundaryKey = "plasmicInternalHasLoadingBoundary";
+function useIsClient() {
+  var _useState = React.useState(false),
+    loaded = _useState[0],
+    setLoaded = _useState[1];
+  useIsomorphicLayoutEffect(function () {
+    setLoaded(true);
+  }, []);
+  return loaded;
+}
+var hasWarnedDisabledLoadingBoundary = false;
+function warnDisabledLoadingBoundary() {
+  if (!hasWarnedDisabledLoadingBoundary) {
+    hasWarnedDisabledLoadingBoundary = true;
+    console.warn("LoadingBoundary feature is not enabled. To use the LoadingBoundary component make sure to upgrade your @plasmicapp/* dependencies to the latest version and to wrap you App inside <PlasmicRootProvider />");
+  }
+}
+function LoadingBoundary(_ref) {
+  var _useDataEnv;
+  var children = _ref.children,
+    forceLoading = _ref.forceLoading,
+    loadingState = _ref.loadingState;
+  var isClient = useIsClient();
+  var enableLoadingBoundary = !!((_useDataEnv = host.useDataEnv()) != null && _useDataEnv[enableLoadingBoundaryKey]);
+  if (!isClient && !(plasmicQuery.isPlasmicPrepass != null && plasmicQuery.isPlasmicPrepass())) {
+    return null;
+  }
+  if (forceLoading) {
+    return React__default.createElement(React__default.Fragment, null, loadingState != null ? loadingState : null);
+  }
+  if (reactMajorVersion < 18) {
+    return React__default.createElement(React__default.Fragment, null, children != null ? children : null);
+  }
+  if (!enableLoadingBoundary) {
+    warnDisabledLoadingBoundary();
+    return React__default.createElement(React__default.Fragment, null, children != null ? children : null);
+  }
+  return React__default.createElement(React.Suspense, {
+    fallback: React__default.createElement(React__default.Fragment, null, loadingState != null ? loadingState : null)
+  }, React__default.createElement(host.DataProvider, {
+    hidden: true,
+    name: hasLoadingBoundaryKey,
+    data: true
+  }, children != null ? children : null));
+}
+var loadingBoundaryMeta = {
+  name: "hostless-loading-boundary",
+  displayName: "Loading Boundary",
+  importName: "LoadingBoundary",
+  importPath: "@plasmicpkgs/plasmic-basic-components",
+  props: {
+    children: "slot",
+    loadingState: {
+      type: "slot",
+      displayName: "Loading State",
+      defaultValue: {
+        type: "text",
+        value: "Loading..."
+      }
+    },
+    forceLoading: {
+      type: "boolean",
+      editOnly: true,
+      displayName: "Force Loading",
+      description: "Force rendering the 'Loading' state"
+    }
+  },
+  providesData: true,
+  styleSections: false,
+  description: "Handle the loading state of queries and integrations"
+};
+function registerLoadingBoundary(loader, customLoadingBoundaryMeta) {
+  if (loader) {
+    loader.registerComponent(LoadingBoundary, customLoadingBoundaryMeta != null ? customLoadingBoundaryMeta : loadingBoundaryMeta);
+  } else {
+    registerComponent(LoadingBoundary, customLoadingBoundaryMeta != null ? customLoadingBoundaryMeta : loadingBoundaryMeta);
+  }
+}
+
 var thisModule$1 = "@plasmicpkgs/plasmic-basic-components";
 var defaultItemName = "currentItem";
 var defaultIndexName = "currentIndex";
@@ -943,6 +1110,117 @@ function registerScrollRevealer(loader, customScrollRevealerMeta) {
   }
 }
 
+function SideEffect(_ref) {
+  var deps = _ref.deps,
+    onMount = _ref.onMount,
+    onUnmount = _ref.onUnmount;
+  React__default.useEffect(function () {
+    onMount == null || onMount();
+    return function () {
+      onUnmount == null || onUnmount();
+    };
+  }, deps != null ? deps : []);
+  return null;
+}
+var sideEffectMeta = {
+  name: "hostless-side-effect",
+  displayName: "Side Effect",
+  description: "Run actions on load, unload, and when data changes.",
+  importName: "SideEffect",
+  importPath: "@plasmicpkgs/plasmic-basic-components",
+  props: {
+    onMount: {
+      type: "eventHandler",
+      displayName: "On load",
+      description: "Actions to run when this Side Effect component is mounted.",
+      argTypes: []
+    },
+    onUnmount: {
+      type: "eventHandler",
+      displayName: "On unload",
+      description: "Actions to run when this Side Effect component is unmounted.",
+      argTypes: []
+    },
+    deps: {
+      type: "array",
+      displayName: "When data changes",
+      description: "List of values which should trigger a re-run of the actions if changed."
+    }
+  }
+};
+function registerSideEffect(loader, customMeta) {
+  if (loader) {
+    loader.registerComponent(SideEffect, customMeta != null ? customMeta : sideEffectMeta);
+  } else {
+    registerComponent(SideEffect, customMeta != null ? customMeta : sideEffectMeta);
+  }
+}
+
+function useInterval(callback, delay) {
+  var savedCallback = React.useRef(callback);
+  // Remember the latest callback if it changes.
+  useIsomorphicLayoutEffect(function () {
+    savedCallback.current = callback;
+  }, [callback]);
+  // Set up the interval.
+  React.useEffect(function () {
+    // Don't schedule if no delay is specified.
+    // Note: 0 is a valid value for delay.
+    if (!delay && delay !== 0) {
+      return;
+    }
+    var id = setInterval(function () {
+      return savedCallback.current();
+    }, delay);
+    return function () {
+      return clearInterval(id);
+    };
+  }, [delay]);
+}
+function Timer(_ref) {
+  var _ref$intervalSeconds = _ref.intervalSeconds,
+    intervalSeconds = _ref$intervalSeconds === void 0 ? 1 : _ref$intervalSeconds,
+    _ref$isRunning = _ref.isRunning,
+    isRunning = _ref$isRunning === void 0 ? false : _ref$isRunning,
+    _ref$onTick = _ref.onTick,
+    onTick = _ref$onTick === void 0 ? function () {} : _ref$onTick;
+  useInterval(onTick,
+  // Delay in milliseconds or null to stop it
+  isRunning ? intervalSeconds * 1000 : null);
+  return null;
+}
+var timerMeta = {
+  name: "hostless-timer",
+  displayName: "Timer",
+  description: "Run something periodically",
+  importName: "Timer",
+  importPath: "@plasmicpkgs/plasmic-basic-components",
+  props: {
+    onTick: {
+      type: "eventHandler",
+      displayName: "Run periodically",
+      description: "Actions to run periodically",
+      argTypes: []
+    },
+    isRunning: {
+      type: "boolean",
+      displayName: "Is Running?"
+    },
+    intervalSeconds: {
+      type: "number",
+      displayName: "Seconds",
+      description: "Interval in seconds"
+    }
+  }
+};
+function registerTimer(loader, customMeta) {
+  if (loader) {
+    loader.registerComponent(Timer, customMeta != null ? customMeta : timerMeta);
+  } else {
+    registerComponent(Timer, customMeta != null ? customMeta : timerMeta);
+  }
+}
+
 var Video = /*#__PURE__*/React__default.forwardRef(function (props, ref) {
   return React__default.createElement("video", Object.assign({
     ref: ref
@@ -1013,217 +1291,6 @@ function registerVideo(loader, customVideoMeta) {
   }
 }
 
-var reactMajorVersion = + /*#__PURE__*/React__default.version.split(".")[0];
-if (reactMajorVersion < 18) {
-  console.warn("The LoadingBoundary component only works with React 18+");
-}
-var isBrowser = typeof window !== "undefined";
-var enableLoadingBoundaryKey = "plasmicInternalEnableLoadingBoundary";
-var hasLoadingBoundaryKey = "plasmicInternalHasLoadingBoundary";
-var useIsomorphicLayoutEffect = isBrowser ? React__default.useLayoutEffect : React__default.useEffect;
-function useIsClient() {
-  var _useState = React.useState(false),
-    loaded = _useState[0],
-    setLoaded = _useState[1];
-  useIsomorphicLayoutEffect(function () {
-    setLoaded(true);
-  }, []);
-  return loaded;
-}
-var hasWarnedDisabledLoadingBoundary = false;
-function warnDisabledLoadingBoundary() {
-  if (!hasWarnedDisabledLoadingBoundary) {
-    hasWarnedDisabledLoadingBoundary = true;
-    console.warn("LoadingBoundary feature is not enabled. To use the LoadingBoundary component make sure to upgrade your @plasmicapp/* dependencies to the latest version and to wrap you App inside <PlasmicRootProvider />");
-  }
-}
-function LoadingBoundary(_ref) {
-  var _useDataEnv;
-  var children = _ref.children,
-    forceLoading = _ref.forceLoading,
-    loadingState = _ref.loadingState;
-  var isClient = useIsClient();
-  var enableLoadingBoundary = !!((_useDataEnv = host.useDataEnv()) != null && _useDataEnv[enableLoadingBoundaryKey]);
-  if (!isClient && !(plasmicQuery.isPlasmicPrepass != null && plasmicQuery.isPlasmicPrepass())) {
-    return null;
-  }
-  if (forceLoading) {
-    return React__default.createElement(React__default.Fragment, null, loadingState != null ? loadingState : null);
-  }
-  if (reactMajorVersion < 18) {
-    return React__default.createElement(React__default.Fragment, null, children != null ? children : null);
-  }
-  if (!enableLoadingBoundary) {
-    warnDisabledLoadingBoundary();
-    return React__default.createElement(React__default.Fragment, null, children != null ? children : null);
-  }
-  return React__default.createElement(React.Suspense, {
-    fallback: React__default.createElement(React__default.Fragment, null, loadingState != null ? loadingState : null)
-  }, React__default.createElement(host.DataProvider, {
-    hidden: true,
-    name: hasLoadingBoundaryKey,
-    data: true
-  }, children != null ? children : null));
-}
-var loadingBoundaryMeta = {
-  name: "hostless-loading-boundary",
-  displayName: "Loading Boundary",
-  importName: "LoadingBoundary",
-  importPath: "@plasmicpkgs/plasmic-basic-components",
-  props: {
-    children: "slot",
-    loadingState: {
-      type: "slot",
-      displayName: "Loading State",
-      defaultValue: {
-        type: "text",
-        value: "Loading..."
-      }
-    },
-    forceLoading: {
-      type: "boolean",
-      editOnly: true,
-      displayName: "Force Loading",
-      description: "Force rendering the 'Loading' state"
-    }
-  },
-  providesData: true,
-  styleSections: false,
-  description: "Handle the loading state of queries and integrations"
-};
-function registerLoadingBoundary(loader, customLoadingBoundaryMeta) {
-  if (loader) {
-    loader.registerComponent(LoadingBoundary, customLoadingBoundaryMeta != null ? customLoadingBoundaryMeta : loadingBoundaryMeta);
-  } else {
-    registerComponent(LoadingBoundary, customLoadingBoundaryMeta != null ? customLoadingBoundaryMeta : loadingBoundaryMeta);
-  }
-}
-
-function ConditionGuardOnNotSatisfied(_ref) {
-  var onNotSatisfied = _ref.onNotSatisfied;
-  var ref = React__default.useRef(false);
-  React__default.useEffect(function () {
-    if (!ref.current) {
-      ref.current = true;
-      onNotSatisfied == null || onNotSatisfied();
-    }
-  }, [onNotSatisfied]);
-  return null;
-}
-function isCurrentLocationInSkipPaths(skipPaths) {
-  var _globalThis$__PLASMIC;
-  var pathname = window.location.pathname;
-  // Ignore search params
-  var currentPath = window.location.origin + pathname;
-  var plasmicPathname = globalThis == null || (_globalThis$__PLASMIC = globalThis["__PLASMIC_STUDIO_PATH"]) == null ? void 0 : _globalThis$__PLASMIC.call(globalThis);
-  return skipPaths == null ? void 0 : skipPaths.some(function (_ref2) {
-    var path = _ref2.path;
-    return path === pathname || path === currentPath || path === plasmicPathname;
-  });
-}
-function ConditionGuard(_ref3) {
-  var condition = _ref3.condition,
-    onNotSatisfied = _ref3.onNotSatisfied,
-    children = _ref3.children,
-    skipPaths = _ref3.skipPaths;
-  if (!condition && !isCurrentLocationInSkipPaths(skipPaths)) {
-    return React__default.createElement(ConditionGuardOnNotSatisfied, {
-      onNotSatisfied: onNotSatisfied
-    });
-  }
-  return React__default.createElement(React__default.Fragment, null, children);
-}
-var conditionGuardMeta = {
-  name: "hostless-condition-guard",
-  displayName: "Condition Guard",
-  description: "Ensure some condition, or else run an interaction. Examples: ensure all users have a database row, or require new users to setup a profile.",
-  importName: "ConditionGuard",
-  importPath: "@plasmicpkgs/plasmic-basic-components",
-  props: {
-    children: "slot",
-    condition: {
-      type: "boolean",
-      displayName: "Condition",
-      description: "The condition to guard against",
-      helpText: "Condition to check. Render contents only if true. Run interaction if false.",
-      defaultValue: true
-    },
-    onNotSatisfied: {
-      type: "eventHandler",
-      displayName: "On condition false",
-      description: "The action to run when the condition is not satisfied",
-      argTypes: []
-    },
-    skipPaths: {
-      type: "array",
-      displayName: "Skip Paths",
-      description: "Paths that the action should not run",
-      itemType: {
-        type: "object",
-        fields: {
-          path: "href"
-        },
-        nameFunc: function nameFunc(item) {
-          return item == null ? void 0 : item.path;
-        }
-      }
-    }
-  }
-};
-function registerConditionGuard(loader, customConditionGuardMeta) {
-  if (loader) {
-    loader.registerComponent(ConditionGuard, customConditionGuardMeta != null ? customConditionGuardMeta : conditionGuardMeta);
-  } else {
-    registerComponent(ConditionGuard, customConditionGuardMeta != null ? customConditionGuardMeta : conditionGuardMeta);
-  }
-}
-
-function SideEffect(_ref) {
-  var deps = _ref.deps,
-    onMount = _ref.onMount,
-    onUnmount = _ref.onUnmount;
-  React__default.useEffect(function () {
-    onMount == null || onMount();
-    return function () {
-      onUnmount == null || onUnmount();
-    };
-  }, deps != null ? deps : []);
-  return null;
-}
-var sideEffectMeta = {
-  name: "hostless-side-effect",
-  displayName: "Side Effect",
-  description: "Run actions on load, unload, and when data changes.",
-  importName: "SideEffect",
-  importPath: "@plasmicpkgs/plasmic-basic-components",
-  props: {
-    onMount: {
-      type: "eventHandler",
-      displayName: "On load",
-      description: "Actions to run when this Side Effect component is mounted.",
-      argTypes: []
-    },
-    onUnmount: {
-      type: "eventHandler",
-      displayName: "On unload",
-      description: "Actions to run when this Side Effect component is unmounted.",
-      argTypes: []
-    },
-    deps: {
-      type: "array",
-      displayName: "When data changes",
-      description: "List of values which should trigger a re-run of the actions if changed."
-    }
-  }
-};
-function registerSideEffect(loader, customMeta) {
-  if (loader) {
-    loader.registerComponent(SideEffect, customMeta != null ? customMeta : sideEffectMeta);
-  } else {
-    registerComponent(SideEffect, customMeta != null ? customMeta : sideEffectMeta);
-  }
-}
-
 exports.ConditionGuard = ConditionGuard;
 exports.DataProvider = DataProvider;
 exports.DynamicElement = DynamicElement;
@@ -1236,6 +1303,7 @@ exports.LoadingBoundary = LoadingBoundary;
 exports.Repeater = Repeater;
 exports.ScrollRevealer = ScrollRevealer;
 exports.SideEffect = SideEffect;
+exports.Timer = Timer;
 exports.Video = Video;
 exports.applySelector = applySelector;
 exports.conditionGuardMeta = conditionGuardMeta;
@@ -1247,7 +1315,6 @@ exports.dynamicRepeaterProps = dynamicRepeaterProps;
 exports.dynamicTextMeta = dynamicTextMeta;
 exports.embedMeta = embedMeta;
 exports.iframeMeta = iframeMeta;
-exports.isBrowser = isBrowser;
 exports.loadingBoundaryMeta = loadingBoundaryMeta;
 exports.registerConditionGuard = registerConditionGuard;
 exports.registerDataProvider = registerDataProvider;
@@ -1261,13 +1328,15 @@ exports.registerLoadingBoundary = registerLoadingBoundary;
 exports.registerRepeater = registerRepeater;
 exports.registerScrollRevealer = registerScrollRevealer;
 exports.registerSideEffect = registerSideEffect;
+exports.registerTimer = registerTimer;
 exports.registerVideo = registerVideo;
 exports.repeaterMeta = repeaterMeta;
 exports.scrollRevealerMeta = scrollRevealerMeta;
 exports.sideEffectMeta = sideEffectMeta;
+exports.timerMeta = timerMeta;
 exports.useDataEnv = useDataEnv;
 exports.useDirectionalIntersection = useDirectionalIntersection;
-exports.useIsomorphicLayoutEffect = useIsomorphicLayoutEffect;
+exports.useInterval = useInterval;
 exports.useSelector = useSelector;
 exports.useSelectors = useSelectors;
 exports.videoMeta = videoMeta;