@omni-co/embed 0.3.3 → 0.3.5

package/README.md

@@ -90,5 +90,12 @@ type EmbedSsoDashboardProps = {
   // 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;
+
+  // Optional link access setting to control which Omni dashboard links are shown. Note that regardless of the linkAccess value,
+  // all non-Omni dashboard links will be shown and allowed in drill menus. Acceptable values include:
+  // "__omni_link_access_open": Special string keyword that permisses and shows all Omni dashboard links on the embedded dashboard.
+  // "abcd1234,efgh5678,ijkl9999": An allowlist of dashboard IDs that permisses and shows links to the specified dashboards.
+  // undefined: If left undefined, the default behavior is to hide and disallow all links to other Omni dashboards on the embedded dashboard.
+  linkAccess?: string;
 };
 ```

package/lib/cjs/embed.d.ts

@@ -10,6 +10,7 @@ type EmbedSsoProps = {
     prefersDark?: string;
     theme?: string;
     filterSearchParam?: string;
+    linkAccess?: 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, filterSearchParam, } = props;
+    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, filterSearchParam, linkAccess, } = props;
     // Handle defaults
     nonce = nonce !== null && nonce !== void 0 ? nonce : (await (0, random_str_1.random32ByteString)());
     domain = domain !== null && domain !== void 0 ? domain : defaultEmbedDomain;
@@ -56,6 +56,7 @@ const embedSsoDashboard = async (props) => {
         prefersDark,
         theme,
         filterSearchParam,
+        linkAccess,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -69,6 +70,7 @@ const embedSsoDashboard = async (props) => {
     theme && url.searchParams.append("theme", theme);
     filterSearchParam &&
         url.searchParams.append("filterSearchParam", filterSearchParam);
+    linkAccess && url.searchParams.append("linkAccess", linkAccess);
     return url.toString();
 };
 exports.embedSsoDashboard = embedSsoDashboard;

package/lib/cjs/signature.d.ts

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

package/lib/cjs/signature.js

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

package/lib/esm/embed.d.ts

@@ -10,6 +10,7 @@ type EmbedSsoProps = {
     prefersDark?: string;
     theme?: string;
     filterSearchParam?: string;
+    linkAccess?: 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, filterSearchParam, } = props;
+    let { contentId, domain, externalId, name, nonce, organizationName, port, secret, userAttributes: rawUserAttributes, entity, prefersDark, theme, filterSearchParam, linkAccess, } = props;
     // Handle defaults
     nonce = nonce !== null && nonce !== void 0 ? nonce : (await random32ByteString());
     domain = domain !== null && domain !== void 0 ? domain : defaultEmbedDomain;
@@ -53,6 +53,7 @@ export const embedSsoDashboard = async (props) => {
         prefersDark,
         theme,
         filterSearchParam,
+        linkAccess,
     });
     // Build and return the signed url
     url.searchParams.append("contentPath", contentPath);
@@ -66,5 +67,6 @@ export const embedSsoDashboard = async (props) => {
     theme && url.searchParams.append("theme", theme);
     filterSearchParam &&
         url.searchParams.append("filterSearchParam", filterSearchParam);
+    linkAccess && url.searchParams.append("linkAccess", linkAccess);
     return url.toString();
 };

package/lib/esm/signature.d.ts

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

package/lib/esm/signature.js

@@ -6,10 +6,11 @@ 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, filterSearchParam, }) => {
+const generateStringForSignature = ({ loginUrl, contentPath, externalId, name, nonce, userAttributes, entity, prefersDark, theme, filterSearchParam, linkAccess, }) => {
     const optionalParams = [];
     entity && optionalParams.push(entity);
     filterSearchParam && optionalParams.push(filterSearchParam);
+    linkAccess && optionalParams.push(linkAccess);
     prefersDark && optionalParams.push(prefersDark);
     theme && optionalParams.push(theme);
     userAttributes && optionalParams.push(userAttributes);

package/package.json

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