@thoughtbot/superglue 0.53.4 → 0.54.0

package/dist/chunk-MNVGYKSD.mjs

@@ -0,0 +1,779 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+// lib/utils/url.ts
+import parse from "url-parse";
+function pathQuery(url) {
+  const { pathname, query } = new parse(url, {});
+  return pathname + query;
+}
+function pathQueryHash(url) {
+  const { pathname, query, hash } = new parse(url, {});
+  return pathname + query + hash;
+}
+function hasPropsAt(url) {
+  const parsed = new parse(url, {}, true);
+  const query = parsed.query;
+  return !!query["props_at"];
+}
+function withFormatJson(url) {
+  const parsed = new parse(url, {}, true);
+  parsed.query["format"] = "json";
+  return parsed.toString();
+}
+function pathWithoutBZParams(url) {
+  const parsed = new parse(url, {}, true);
+  const query = parsed.query;
+  delete query["props_at"];
+  delete query["format"];
+  parsed.set("query", query);
+  return pathQueryHash(parsed.toString());
+}
+function removePropsAt(url) {
+  const parsed = new parse(url, {}, true);
+  const query = parsed.query;
+  delete query["props_at"];
+  parsed.set("query", query);
+  return parsed.toString();
+}
+function urlToPageKey(url) {
+  const parsed = new parse(url, {}, true);
+  const query = parsed.query;
+  delete query["props_at"];
+  delete query["format"];
+  parsed.set("query", query);
+  return pathQuery(parsed.toString());
+}
+function withoutHash(url) {
+  const parsed = new parse(url, {}, true);
+  parsed.set("hash", "");
+  return parsed.toString();
+}
+function withoutBusters(url) {
+  const parsed = new parse(url, {}, true);
+  const query = parsed.query;
+  delete query["format"];
+  parsed.set("query", query);
+  return pathQuery(parsed.toString());
+}
+function formatForXHR(url) {
+  const formats = [withoutHash, withFormatJson];
+  return formats.reduce((memo, f) => f(memo), url);
+}
+
+// lib/utils/helpers.ts
+function argsForHistory(path) {
+  const pageKey = urlToPageKey(path);
+  return [
+    path,
+    {
+      superglue: true,
+      pageKey,
+      posX: 0,
+      posY: 0
+    }
+  ];
+}
+
+// lib/utils/immutability.ts
+var canLookAhead = /^[\da-zA-Z\-_]+=[\da-zA-Z\-_]+$/;
+var KeyPathError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "KeyPathError";
+  }
+};
+function getIn(node, path) {
+  const keyPath = normalizeKeyPath(path);
+  let result = node;
+  let i;
+  for (i = 0; i < keyPath.length; i++) {
+    const key = keyPath[i];
+    if (typeof result === "object" && result !== null) {
+      if (!Array.isArray(result) && canLookAhead.test(key)) {
+        throw new KeyPathError(
+          `Expected to find an Array when using the key: ${key}`
+        );
+      }
+      result = atKey(result, key);
+    } else {
+      throw new KeyPathError(
+        `Expected to traverse an Array or Obj, got ${JSON.stringify(result)}`
+      );
+    }
+  }
+  if (i === keyPath.length) {
+    return result;
+  } else {
+    return void 0;
+  }
+}
+function clone(node) {
+  return Array.isArray(node) ? [].slice.call(node) : { ...node };
+}
+function getKey(node, key) {
+  if (Array.isArray(node) && Number.isNaN(Number(key))) {
+    const key_parts = Array.from(key.split("="));
+    const attr = key_parts[0];
+    const id = key_parts[1];
+    if (!id || !attr) {
+      return key;
+    }
+    let i;
+    let child;
+    for (i = 0; i < node.length; i++) {
+      child = node[i];
+      if (typeof child === "object" && !Array.isArray(child) && child !== null) {
+        const val = child[attr];
+        if (val && val.toString() === id) {
+          break;
+        }
+      } else {
+        throw new KeyPathError(`Could not look ahead ${key} at ${child}`);
+      }
+    }
+    if (i === node.length) {
+      throw new KeyPathError(`Could not find ${key} while looking ahead`);
+    }
+    return i;
+  } else {
+    return key;
+  }
+}
+function atKey(node, key) {
+  const actualKey = getKey(node, key);
+  if (Array.isArray(node)) {
+    return node[actualKey];
+  } else {
+    return node[actualKey];
+  }
+}
+function normalizeKeyPath(path) {
+  if (typeof path === "string") {
+    path = path.replace(/ /g, "");
+    if (path === "") {
+      return [];
+    }
+    return path.split(".");
+  } else {
+    return path;
+  }
+}
+function setIn(object, path, value) {
+  const keypath = normalizeKeyPath(path);
+  const results = { 0: object };
+  const parents = { 0: object };
+  let i;
+  for (i = 0; i < keypath.length; i++) {
+    const parent = parents[i];
+    if (!(typeof parent === "object" && parent !== null)) {
+      throw new KeyPathError(
+        `Expected to traverse an Array or Obj, got ${JSON.stringify(parent)}`
+      );
+    }
+    const child = atKey(parent, keypath[i]);
+    parents[i + 1] = child;
+  }
+  results[keypath.length] = value;
+  for (i = keypath.length - 1; i >= 0; i--) {
+    const target = clone(parents[i]);
+    results[i] = target;
+    const key = getKey(results[i], keypath[i]);
+    if (Array.isArray(target)) {
+      target[key] = results[i + 1];
+    } else {
+      target[key] = results[i + 1];
+    }
+  }
+  return results[0];
+}
+
+// lib/utils/react.ts
+function mapStateToProps(state, ownProps) {
+  let pageKey = ownProps.pageKey;
+  const params = ownProps;
+  const csrfToken = state.superglue.csrfToken;
+  pageKey = urlToPageKey(pageKey);
+  const { data, fragments } = state.pages[pageKey] || {
+    data: {},
+    fragments: []
+  };
+  return { ...data, ...params, pageKey, csrfToken, fragments };
+}
+var mapDispatchToProps = {
+  saveAndProcessPage,
+  copyPage
+};
+
+// lib/utils/request.ts
+import parse2 from "url-parse";
+
+// lib/config.ts
+var config = {
+  baseUrl: "",
+  maxPages: 20
+};
+
+// lib/utils/request.ts
+function isValidResponse(xhr) {
+  return isValidContent(xhr) && !downloadingFile(xhr);
+}
+function isValidContent(rsp) {
+  const contentType = rsp.headers.get("content-type");
+  const jsContent = /^(?:application\/json)(?:;|$)/;
+  return !!(contentType && contentType.match(jsContent));
+}
+function downloadingFile(xhr) {
+  const disposition = xhr.headers.get("content-disposition");
+  return !!(disposition && disposition.match(/^attachment/) !== null);
+}
+var SuperglueResponseError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "SuperglueResponseError";
+  }
+};
+function validateResponse(args) {
+  const { rsp } = args;
+  if (isValidResponse(rsp)) {
+    return args;
+  } else {
+    const error = new SuperglueResponseError("Invalid Superglue Response");
+    error.response = rsp;
+    throw error;
+  }
+}
+function handleServerErrors(args) {
+  const { rsp } = args;
+  if (!rsp.ok) {
+    if (rsp.status === 406) {
+      console.error(
+        "Superglue encountered a 406 Not Acceptable response. This can happen if you used respond_to and didn't specify format.json in the block. Try adding it to your respond_to. For example:\n\nrespond_to do |format|\n  format.html\n  format.json\n  format.csv\nend"
+      );
+    }
+    const error = new SuperglueResponseError(rsp.statusText);
+    error.response = rsp;
+    throw error;
+  }
+  return args;
+}
+function argsForFetch(getState, pathQuery2, { method = "GET", headers = {}, body = "", signal } = {}) {
+  method = method.toUpperCase();
+  const currentState = getState().superglue;
+  const nextHeaders = { ...headers };
+  nextHeaders["x-requested-with"] = "XMLHttpRequest";
+  nextHeaders["accept"] = "application/json";
+  nextHeaders["x-superglue-request"] = "true";
+  if (method != "GET" && method != "HEAD") {
+    nextHeaders["content-type"] = "application/json";
+  }
+  if (body instanceof FormData) {
+    delete nextHeaders["content-type"];
+  }
+  if (currentState.csrfToken) {
+    nextHeaders["x-csrf-token"] = currentState.csrfToken;
+  }
+  const fetchPath = new parse2(
+    formatForXHR(pathQuery2),
+    config.baseUrl || {},
+    true
+  );
+  const credentials = "same-origin";
+  if (!(method == "GET" || method == "HEAD")) {
+    nextHeaders["x-http-method-override"] = method;
+    method = "POST";
+  }
+  const options = {
+    method,
+    headers: nextHeaders,
+    body,
+    credentials,
+    signal
+  };
+  if (currentState.currentPageKey) {
+    const referrer = new parse2(
+      currentState.currentPageKey,
+      config.baseUrl || {},
+      false
+    ).href;
+    options.referrer = referrer;
+  }
+  if (method == "GET" || method == "HEAD") {
+    if (options.body instanceof FormData) {
+      const allData = new URLSearchParams(
+        options.body
+      );
+      const nextQuery = { ...fetchPath.query, ...Object.fromEntries(allData) };
+      fetchPath.set("query", nextQuery);
+    }
+    delete options.body;
+  }
+  return [fetchPath.toString(), options];
+}
+function extractJSON(rsp) {
+  return rsp.json().then((json) => {
+    return { rsp, json };
+  }).catch((e) => {
+    e.response = rsp;
+    throw e;
+  });
+}
+function parseResponse(prm) {
+  return Promise.resolve(prm).then(extractJSON).then(handleServerErrors).then(validateResponse);
+}
+
+// lib/utils/ujs.ts
+var HandlerBuilder = class {
+  constructor({
+    ujsAttributePrefix,
+    visit: visit2,
+    remote: remote2
+  }) {
+    this.attributePrefix = ujsAttributePrefix;
+    this.isUJS = this.isUJS.bind(this);
+    this.handleSubmit = this.handleSubmit.bind(this);
+    this.handleClick = this.handleClick.bind(this);
+    this.visit = visit2;
+    this.remote = remote2;
+    this.visitOrRemote = this.visitOrRemote.bind(this);
+  }
+  retrieveLink(target) {
+    const link = target.closest("a");
+    if (link && link.href.length !== 0) {
+      return link;
+    }
+  }
+  isNonStandardClick(event) {
+    return event.which > 1 || event.metaKey || event.ctrlKey || event.shiftKey || event.altKey;
+  }
+  isUJS(node) {
+    const hasVisit = !!node.getAttribute(this.attributePrefix + "-visit");
+    const hasRemote = !!node.getAttribute(this.attributePrefix + "-remote");
+    return hasVisit || hasRemote;
+  }
+  handleSubmit(event) {
+    const form = event.target;
+    if (!(form instanceof HTMLFormElement)) {
+      return;
+    }
+    if (!this.isUJS(form)) {
+      return;
+    }
+    event.preventDefault();
+    let url = form.getAttribute("action");
+    if (!url) {
+      return;
+    }
+    const method = (form.getAttribute("method") || "POST").toUpperCase();
+    url = withoutBusters(url);
+    this.visitOrRemote(form, url, {
+      method,
+      body: new FormData(form)
+    });
+  }
+  handleClick(event) {
+    if (!(event.target instanceof Element)) {
+      return;
+    }
+    const link = this.retrieveLink(event.target);
+    const isNonStandard = this.isNonStandardClick(event);
+    if (!link || isNonStandard || !this.isUJS(link)) {
+      return;
+    }
+    event.preventDefault();
+    let url = link.getAttribute("href");
+    if (!url) {
+      return;
+    }
+    url = withoutBusters(url);
+    this.visitOrRemote(link, url, { method: "GET" });
+  }
+  visitOrRemote(linkOrForm, url, opts) {
+    if (linkOrForm.getAttribute(this.attributePrefix + "-visit")) {
+      const nextOpts = { ...opts };
+      const placeholderKey = linkOrForm.getAttribute(
+        this.attributePrefix + "-placeholder"
+      );
+      if (placeholderKey) {
+        nextOpts.placeholderKey = urlToPageKey(placeholderKey);
+      }
+      return this.visit(url, { ...nextOpts });
+    }
+    if (linkOrForm.getAttribute(this.attributePrefix + "-remote")) {
+      return this.remote(url, opts);
+    }
+  }
+  handlers() {
+    return {
+      onClick: this.handleClick,
+      onSubmit: this.handleSubmit
+    };
+  }
+};
+var ujsHandlers = ({
+  ujsAttributePrefix,
+  visit: visit2,
+  remote: remote2
+}) => {
+  const builder = new HandlerBuilder({
+    visit: visit2,
+    remote: remote2,
+    ujsAttributePrefix
+  });
+  return builder.handlers();
+};
+
+// lib/utils/window.ts
+function needsRefresh(prevAssets, newAssets) {
+  if (prevAssets && newAssets) {
+    const hasNewAssets = !newAssets.every((asset) => prevAssets.includes(asset));
+    return hasNewAssets;
+  } else {
+    return false;
+  }
+}
+
+// lib/action_creators/index.ts
+import parse3 from "url-parse";
+
+// lib/actions.ts
+var actions_exports = {};
+__export(actions_exports, {
+  BEFORE_FETCH: () => BEFORE_FETCH,
+  BEFORE_REMOTE: () => BEFORE_REMOTE,
+  BEFORE_VISIT: () => BEFORE_VISIT,
+  COPY_PAGE: () => COPY_PAGE,
+  GRAFTING_ERROR: () => GRAFTING_ERROR,
+  GRAFTING_SUCCESS: () => GRAFTING_SUCCESS,
+  HANDLE_GRAFT: () => HANDLE_GRAFT,
+  HISTORY_CHANGE: () => HISTORY_CHANGE,
+  REMOVE_PAGE: () => REMOVE_PAGE,
+  SAVE_RESPONSE: () => SAVE_RESPONSE,
+  SET_CSRF_TOKEN: () => SET_CSRF_TOKEN,
+  SUPERGLUE_ERROR: () => SUPERGLUE_ERROR,
+  UPDATE_FRAGMENTS: () => UPDATE_FRAGMENTS
+});
+var BEFORE_FETCH = "@@superglue/BEFORE_FETCH";
+var BEFORE_VISIT = "@@superglue/BEFORE_VISIT";
+var BEFORE_REMOTE = "@@superglue/BEFORE_REMOTE";
+var SAVE_RESPONSE = "@@superglue/SAVE_RESPONSE";
+var HANDLE_GRAFT = "@@superglue/HANDLE_GRAFT";
+var SUPERGLUE_ERROR = "@@superglue/ERROR";
+var GRAFTING_ERROR = "@@superglue/GRAFTING_ERROR";
+var GRAFTING_SUCCESS = "@@superglue/GRAFTING_SUCCESS";
+var HISTORY_CHANGE = "@@superglue/HISTORY_CHANGE";
+var SET_CSRF_TOKEN = "@@superglue/SET_CSRF_TOKEN";
+var REMOVE_PAGE = "@@superglue/REMOVE_PAGE";
+var COPY_PAGE = "@@superglue/COPY_PAGE";
+var UPDATE_FRAGMENTS = "@@superglue/UPDATE_FRAGMENTS";
+
+// lib/action_creators/requests.ts
+function beforeVisit(payload) {
+  return {
+    type: BEFORE_VISIT,
+    payload
+  };
+}
+function beforeRemote(payload) {
+  return {
+    type: BEFORE_REMOTE,
+    payload
+  };
+}
+function beforeFetch(payload) {
+  return {
+    type: BEFORE_FETCH,
+    payload
+  };
+}
+function handleError(err) {
+  return {
+    type: SUPERGLUE_ERROR,
+    payload: {
+      message: err.message
+    }
+  };
+}
+function handleFetchErr(err, fetchArgs, dispatch) {
+  dispatch(handleError(err));
+  throw err;
+}
+function buildMeta(pageKey, page, state, rsp, fetchArgs) {
+  const { assets: prevAssets } = state;
+  const { assets: nextAssets } = page;
+  return {
+    pageKey,
+    page,
+    redirected: rsp.redirected,
+    rsp,
+    fetchArgs,
+    componentIdentifier: page.componentIdentifier,
+    needsRefresh: needsRefresh(prevAssets, nextAssets)
+  };
+}
+var remote = (path, {
+  method = "GET",
+  headers,
+  body,
+  pageKey: rawPageKey,
+  beforeSave = (prevPage, receivedPage) => receivedPage
+} = {}) => {
+  path = withoutBusters(path);
+  rawPageKey = rawPageKey && urlToPageKey(rawPageKey);
+  return (dispatch, getState) => {
+    const fetchArgs = argsForFetch(getState, path, {
+      method,
+      headers,
+      body
+    });
+    if (rawPageKey === void 0) {
+      rawPageKey = getState().superglue.currentPageKey;
+    }
+    const pageKey = rawPageKey;
+    const currentPageKey = getState().superglue.currentPageKey;
+    dispatch(beforeRemote({ currentPageKey, fetchArgs }));
+    dispatch(beforeFetch({ fetchArgs }));
+    return fetch(...fetchArgs).then(parseResponse).then(({ rsp, json }) => {
+      const { superglue, pages = {} } = getState();
+      const meta = buildMeta(pageKey, json, superglue, rsp, fetchArgs);
+      const willReplaceCurrent = pageKey == currentPageKey;
+      const existingId = pages[currentPageKey]?.componentIdentifier;
+      const receivedId = json.componentIdentifier;
+      if (willReplaceCurrent && !!existingId && existingId != receivedId) {
+        console.warn(
+          `You're about replace an existing page located at pages["${currentPageKey}"]
+that has the componentIdentifier "${existingId}" with the contents of a
+received page that has a componentIdentifier of "${receivedId}".
+
+This can happen if you're using data-sg-remote or remote but your response
+redirected to a completely different page. Since remote requests do not
+navigate or change the current page component, your current page component may
+receive a shape that is unexpected and cause issues with rendering.
+
+Consider using data-sg-visit, the visit function, or redirect_back.`
+        );
+      }
+      const page = beforeSave(pages[pageKey], json);
+      return dispatch(saveAndProcessPage(pageKey, page)).then(() => meta);
+    }).catch((e) => handleFetchErr(e, fetchArgs, dispatch));
+  };
+};
+var lastVisitController = {
+  abort: () => {
+  }
+};
+var visit = (path, {
+  method = "GET",
+  headers,
+  body,
+  placeholderKey,
+  beforeSave = (prevPage, receivedPage) => receivedPage,
+  revisit = false
+} = {}) => {
+  path = withoutBusters(path);
+  let pageKey = urlToPageKey(path);
+  return (dispatch, getState) => {
+    placeholderKey = placeholderKey && urlToPageKey(placeholderKey);
+    const hasPlaceholder = !!(placeholderKey && getState().pages[placeholderKey]);
+    if (placeholderKey && hasPlaceholder) {
+      dispatch(copyPage({ from: placeholderKey, to: pageKey }));
+    }
+    if (placeholderKey && !hasPlaceholder) {
+      console.warn(
+        `Could not find placeholder with key ${placeholderKey} in state. The props_at param will be ignored`
+      );
+      path = removePropsAt(path);
+    }
+    if (!placeholderKey && hasPropsAt(path)) {
+      console.warn(
+        `visit was called with props_at param in the path ${path}, this will be ignore unless you provide a placeholder.`
+      );
+      path = removePropsAt(path);
+    }
+    const controller = new AbortController();
+    const { signal } = controller;
+    const fetchArgs = argsForFetch(getState, path, {
+      headers,
+      body,
+      method,
+      signal
+    });
+    const currentPageKey = getState().superglue.currentPageKey;
+    dispatch(beforeVisit({ currentPageKey, fetchArgs }));
+    dispatch(beforeFetch({ fetchArgs }));
+    lastVisitController.abort();
+    lastVisitController = controller;
+    return fetch(...fetchArgs).then(parseResponse).then(({ rsp, json }) => {
+      const { superglue, pages = {} } = getState();
+      const meta = buildMeta(pageKey, json, superglue, rsp, fetchArgs);
+      const isGet = fetchArgs[1].method === "GET";
+      meta.suggestedAction = "push";
+      if (!rsp.redirected && !isGet) {
+        meta.suggestedAction = "replace";
+      }
+      if (revisit && isGet) {
+        if (rsp.redirected) {
+          meta.suggestedAction = "replace";
+        } else {
+          meta.suggestedAction = "none";
+        }
+      }
+      pageKey = urlToPageKey(rsp.url);
+      if (!isGet && !rsp.redirected) {
+        pageKey = currentPageKey;
+      }
+      const contentLocation = rsp.headers.get("content-location");
+      if (contentLocation) {
+        pageKey = urlToPageKey(contentLocation);
+      }
+      const page = beforeSave(pages[pageKey], json);
+      return dispatch(saveAndProcessPage(pageKey, page)).then(() => {
+        meta.pageKey = pageKey;
+        return meta;
+      });
+    }).catch((e) => handleFetchErr(e, fetchArgs, dispatch));
+  };
+};
+
+// lib/action_creators/index.ts
+function copyPage({
+  from,
+  to
+}) {
+  return {
+    type: COPY_PAGE,
+    payload: {
+      from,
+      to
+    }
+  };
+}
+function saveResponse({
+  pageKey,
+  page
+}) {
+  pageKey = urlToPageKey(pageKey);
+  return {
+    type: SAVE_RESPONSE,
+    payload: {
+      pageKey,
+      page
+    }
+  };
+}
+function handleGraft({
+  pageKey,
+  page
+}) {
+  pageKey = urlToPageKey(pageKey);
+  return {
+    type: HANDLE_GRAFT,
+    payload: {
+      pageKey,
+      page
+    }
+  };
+}
+function fetchDeferments(pageKey, defers = []) {
+  pageKey = urlToPageKey(pageKey);
+  return (dispatch) => {
+    const fetches = defers.filter(({ type }) => type === "auto").map(function({
+      url,
+      successAction = GRAFTING_SUCCESS,
+      failAction = GRAFTING_ERROR
+    }) {
+      const parsedUrl = new parse3(url, true);
+      const keyPath = parsedUrl.query.props_at;
+      return dispatch(remote(url, { pageKey })).then(() => {
+        dispatch({
+          type: successAction,
+          payload: {
+            pageKey,
+            keyPath
+          }
+        });
+      }).catch((err) => {
+        dispatch({
+          type: failAction,
+          payload: {
+            url,
+            err,
+            pageKey,
+            keyPath
+          }
+        });
+      });
+    });
+    return Promise.all(fetches);
+  };
+}
+function updateFragmentsUsing(page) {
+  const changedFragments = {};
+  page.fragments.forEach((fragment) => {
+    const { type, path } = fragment;
+    changedFragments[type] = getIn(page, path);
+  });
+  return {
+    type: UPDATE_FRAGMENTS,
+    payload: { changedFragments }
+  };
+}
+function saveAndProcessPage(pageKey, page) {
+  return (dispatch, getState) => {
+    pageKey = urlToPageKey(pageKey);
+    const { defers = [] } = page;
+    if ("action" in page) {
+      dispatch(handleGraft({ pageKey, page }));
+    } else {
+      dispatch(saveResponse({ pageKey, page }));
+    }
+    const hasFetch = typeof fetch != "undefined";
+    if (hasFetch) {
+      return dispatch(fetchDeferments(pageKey, defers)).then(() => {
+        if (page.fragments.length > 0) {
+          const finishedPage = getState().pages[pageKey];
+          dispatch(updateFragmentsUsing(finishedPage));
+          return Promise.resolve();
+        }
+      });
+    } else {
+      return Promise.resolve();
+    }
+  };
+}
+
+export {
+  pathWithoutBZParams,
+  urlToPageKey,
+  argsForHistory,
+  KeyPathError,
+  getIn,
+  setIn,
+  BEFORE_FETCH,
+  BEFORE_VISIT,
+  BEFORE_REMOTE,
+  SAVE_RESPONSE,
+  HANDLE_GRAFT,
+  GRAFTING_ERROR,
+  GRAFTING_SUCCESS,
+  HISTORY_CHANGE,
+  SET_CSRF_TOKEN,
+  REMOVE_PAGE,
+  COPY_PAGE,
+  UPDATE_FRAGMENTS,
+  actions_exports,
+  remote,
+  visit,
+  copyPage,
+  saveResponse,
+  handleGraft,
+  saveAndProcessPage,
+  mapStateToProps,
+  mapDispatchToProps,
+  config,
+  ujsHandlers
+};
+//# sourceMappingURL=chunk-MNVGYKSD.mjs.map