@omni-co/embed 0.3.1 → 0.3.3

package/README.md

@@ -86,5 +86,9 @@ type EmbedSsoDashboardProps = {
 
   // Optional theme setting. Can be one of "dawn", "vibes", "breeze" or "blank".
   theme?: string;
+
+  // Optional url filter search parameter. Should be the same as the filter search parameters on a dashboard url.
+  // Example: f--inventory_items.cost=%7B"kind"%3A"EQUALS"%2C"type"%3A"number"%2C"values"%3A%5B%5D%2C"is_negative"%3Afalse%2C"is_inclusive"%3Afalse%7D&f--users.state=%7B"kind"%3A"EQUALS"%2C"type"%3A"string"%2C"values"%3A%5B"Aberdeen"%2C"Alabama"%5D%2C"is_negative"%3Afalse%7D&f--users.country=%7B"kind"%3A"EQUALS"%2C"type"%3A"string"%2C"values"%3A%5B"UK"%5D%2C"is_negative"%3Afalse%7D
+  filterSearchParam?: string;
 };
 ```

package/lib/cjs/embed.d.ts

@@ -9,6 +9,7 @@ type EmbedSsoProps = {
     userAttributes?: Record<string, UserAttributeValue>;
     prefersDark?: string;
     theme?: string;
+    filterSearchParam?: string;
     domain?: string;
     nonce?: string;
     port?: number;

package/lib/cjs/embed.js

@@ -34,7 +34,7 @@ const validateProps = (props) => {
 };
 const embedSsoDashboard = async (props) => {
     validateProps(props);
-    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
+    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, filterSearchParam, } = props;
     // Handle defaults
     nonce = nonce !== null && nonce !== void 0 ? nonce : (await (0, random_str_1.random32ByteString)());
     domain = domain !== null && domain !== void 0 ? domain : defaultEmbedDomain;
@@ -55,6 +55,7 @@ const embedSsoDashboard = async (props) => {
         entity,
         prefersDark,
         theme,
+        filterSearchParam,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -66,6 +67,8 @@ const embedSsoDashboard = async (props) => {
     entity && url.searchParams.append("entity", entity);
     prefersDark && url.searchParams.append("prefersDark", prefersDark);
     theme && url.searchParams.append("theme", theme);
+    filterSearchParam &&
+        url.searchParams.append("filterSearchParam", filterSearchParam);
     return url.toString();
 };
 exports.embedSsoDashboard = embedSsoDashboard;

package/lib/cjs/signature.d.ts

@@ -47,9 +47,13 @@ type SignatureProps = {
      * The theme of the embed.
      */
     theme?: string;
+    /**
+     * Filter search parameter.
+     */
+    filterSearchParam?: string;
 };
 export declare const getSignature: ({ secret, ...props }: SignatureProps) => string;
 export declare const TEST_ONLY: {
-    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, filterSearchParam, }: Omit<SignatureProps, "secret">) => string;
 };
 export {};

package/lib/cjs/signature.js

@@ -13,9 +13,10 @@ const hmacSign = (data, secret) => {
     return base64url_1.default.fromBase64(b64);
 };
 exports.hmacSign = hmacSign;
-const generateStringForSignature = ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, }) => {
+const generateStringForSignature = ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, filterSearchParam, }) => {
     const optionalParams = [];
     entity && optionalParams.push(entity);
+    filterSearchParam && optionalParams.push(filterSearchParam);
     prefersDark && optionalParams.push(prefersDark);
     theme && optionalParams.push(theme);
     userAttributes && optionalParams.push(userAttributes);

package/lib/esm/embed.d.ts

@@ -9,6 +9,7 @@ type EmbedSsoProps = {
     userAttributes?: Record<string, UserAttributeValue>;
     prefersDark?: string;
     theme?: string;
+    filterSearchParam?: string;
     domain?: string;
     nonce?: string;
     port?: number;

package/lib/esm/embed.js

@@ -31,7 +31,7 @@ const validateProps = (props) => {
 };
 export const embedSsoDashboard = async (props) => {
     validateProps(props);
-    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, } = props;
+    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, filterSearchParam, } = props;
     // Handle defaults
     nonce = nonce !== null && nonce !== void 0 ? nonce : (await random32ByteString());
     domain = domain !== null && domain !== void 0 ? domain : defaultEmbedDomain;
@@ -52,6 +52,7 @@ export const embedSsoDashboard = async (props) => {
         entity,
         prefersDark,
         theme,
+        filterSearchParam,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -63,5 +64,7 @@ export const embedSsoDashboard = async (props) => {
     entity && url.searchParams.append("entity", entity);
     prefersDark && url.searchParams.append("prefersDark", prefersDark);
     theme && url.searchParams.append("theme", theme);
+    filterSearchParam &&
+        url.searchParams.append("filterSearchParam", filterSearchParam);
     return url.toString();
 };

package/lib/esm/signature.d.ts

@@ -47,9 +47,13 @@ type SignatureProps = {
      * The theme of the embed.
      */
     theme?: string;
+    /**
+     * Filter search parameter.
+     */
+    filterSearchParam?: string;
 };
 export declare const getSignature: ({ secret, ...props }: SignatureProps) => string;
 export declare const TEST_ONLY: {
-    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, }: Omit<SignatureProps, "secret">) => string;
+    generateStringForSignature: ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, filterSearchParam, }: Omit<SignatureProps, "secret">) => string;
 };
 export {};

package/lib/esm/signature.js

@@ -6,9 +6,10 @@ export const hmacSign = (data, secret) => {
     const b64 = hmac.digest("base64");
     return base64url.fromBase64(b64);
 };
-const generateStringForSignature = ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, }) => {
+const generateStringForSignature = ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, filterSearchParam, }) => {
     const optionalParams = [];
     entity && optionalParams.push(entity);
+    filterSearchParam && optionalParams.push(filterSearchParam);
     prefersDark && optionalParams.push(prefersDark);
     theme && optionalParams.push(theme);
     userAttributes && optionalParams.push(userAttributes);

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.3.1",
+  "version": "0.3.3",
   "license": "MIT",
   "name": "@omni-co/embed",
   "author": "Nate Agrin <nate@exploreomni.com>",