@visns-studio/visns-components 6.6.4 → 6.15.0

package/src/components/sms/smsEndpoints.js

@@ -0,0 +1,56 @@
+/**
+ * The URLs the messaging module talks to.
+ *
+ * Every SMS component takes an `endpoints` object rather than a base string,
+ * so a consumer can move one route without reproducing the other seventeen.
+ * The defaults are the CRM's routes under `/ajax/sms`; `makeSmsEndpoints` is
+ * there for the common case of moving all of them at once.
+ *
+ * Pure and React-free so `node --test` can import it — the same arrangement
+ * as vaultEndpoints.js, and for the same reason: these are the URLs a
+ * consumer that passes no `endpoints` prop will hit, so a change here is a
+ * change to every deployment.
+ */
+
+export const makeSmsEndpoints = (base = '/ajax/sms') => ({
+    // Kept so a component can build a route the contract grows later without
+    // the consumer having to re-derive the base from one of the URLs below.
+    base,
+
+    status: `${base}/status`,
+    lines: `${base}/lines`,
+    unread: `${base}/unread`,
+
+    threads: `${base}/threads`,
+    createThread: `${base}/threads`,
+    thread: (id) => `${base}/threads/${id}`,
+    updateThread: (id) => `${base}/threads/${id}`,
+    messages: (id) => `${base}/threads/${id}/messages`,
+    read: (id) => `${base}/threads/${id}/read`,
+    archive: (id) => `${base}/threads/${id}/archive`,
+    unarchive: (id) => `${base}/threads/${id}/unarchive`,
+    simulateInbound: (id) => `${base}/threads/${id}/simulate-inbound`,
+
+    clientSearch: `${base}/clients/search`,
+
+    templates: `${base}/templates`,
+    template: (id) => `${base}/templates/${id}`,
+
+    settingsLines: `${base}/settings/lines`,
+    settingsLine: (id) => `${base}/settings/lines/${id}`,
+});
+
+export const DEFAULT_ENDPOINTS = makeSmsEndpoints();
+
+/**
+ * Merge a partial `endpoints` prop over the defaults.
+ *
+ * A consumer overriding one route must not lose the rest, and passing nothing
+ * at all must land exactly on DEFAULT_ENDPOINTS.
+ */
+export const resolveSmsEndpoints = (endpoints) => ({
+    ...DEFAULT_ENDPOINTS,
+    ...(endpoints || {}),
+});
+
+export default DEFAULT_ENDPOINTS;