@omni-co/embed 0.4.12 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,7 +2,7 @@ import { EmbedSsoContentDiscoveryProps, EmbedSsoDashboardProps, EmbedSsoWorkbook
2
2
  export declare const embedSsoDashboard: (props: EmbedSsoDashboardProps) => Promise<string>;
3
3
  export declare const embedSsoWorkbook: (props: EmbedSsoWorkbookProps) => Promise<string>;
4
4
  /**
5
- * *IN BETA* Generates an embed login URL using the passed-in content discovery page id.
5
+ * Generates an embed login URL using the passed-in content discovery page id.
6
6
  * @param EmbedSsoContentDiscoveryProps
7
7
  * @returns Promise wrapped around a generated embed login url.
8
8
  */
package/lib/cjs/embed.js CHANGED
@@ -117,12 +117,14 @@ const embedSsoWorkbook = async (props) => {
117
117
  };
118
118
  exports.embedSsoWorkbook = embedSsoWorkbook;
119
119
  /**
120
- * *IN BETA* Generates an embed login URL using the passed-in content discovery page id.
120
+ * Generates an embed login URL using the passed-in content discovery page id.
121
121
  * @param EmbedSsoContentDiscoveryProps
122
122
  * @returns Promise wrapped around a generated embed login url.
123
123
  */
124
124
  const embedSsoContentDiscovery = async (props) => {
125
- const contentPath = `/${props.path}`;
125
+ // Entity paths for the Content Discovery embed no longer require stripping the leading `/`.
126
+ // This check maintains backwards compatibility with the old behavior.
127
+ const contentPath = props.path.startsWith('/') ? props.path : `/${props.path}`;
126
128
  return embedSsoContent({
127
129
  ...props,
128
130
  contentPath,
@@ -188,8 +188,6 @@ export declare enum EmbeddedContent {
188
188
  Dashboard = "dashboards",
189
189
  Workbook = "w"
190
190
  }
191
- export declare const EmbedSsoContentDiscoveryPaths: readonly ["my", "entity-folder", "root"];
192
- export type EmbedSsoContentDiscoveryPath = (typeof EmbedSsoContentDiscoveryPaths)[number];
193
191
  export declare enum EmbedConnectionRoles {
194
192
  RESTRICTED_QUERIER = "RESTRICTED_QUERIER",
195
193
  VIEWER = "VIEWER",
@@ -218,6 +216,6 @@ export type EmbedSsoContentDiscoveryProps = EmbedSsoBaseProps & {
218
216
  /**
219
217
  * Path name of the content discovery page to embed.
220
218
  */
221
- path: EmbedSsoContentDiscoveryPath;
219
+ path: string;
222
220
  };
223
221
  export {};
package/lib/cjs/types.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.EmbedEntityFolderContentRoles = exports.EmbedConnectionRoles = exports.EmbedSsoContentDiscoveryPaths = exports.EmbeddedContent = exports.CustomThemeProperty = exports.EmbedSessionMode = void 0;
3
+ exports.EmbedEntityFolderContentRoles = exports.EmbedConnectionRoles = exports.EmbeddedContent = exports.CustomThemeProperty = exports.EmbedSessionMode = void 0;
4
4
  var EmbedSessionMode;
5
5
  (function (EmbedSessionMode) {
6
6
  EmbedSessionMode["Application"] = "APPLICATION";
@@ -68,11 +68,6 @@ var EmbeddedContent;
68
68
  EmbeddedContent["Dashboard"] = "dashboards";
69
69
  EmbeddedContent["Workbook"] = "w";
70
70
  })(EmbeddedContent || (exports.EmbeddedContent = EmbeddedContent = {}));
71
- exports.EmbedSsoContentDiscoveryPaths = [
72
- "my",
73
- "entity-folder",
74
- "root",
75
- ];
76
71
  var EmbedConnectionRoles;
77
72
  (function (EmbedConnectionRoles) {
78
73
  EmbedConnectionRoles["RESTRICTED_QUERIER"] = "RESTRICTED_QUERIER";
@@ -2,7 +2,7 @@ import { EmbedSsoContentDiscoveryProps, EmbedSsoDashboardProps, EmbedSsoWorkbook
2
2
  export declare const embedSsoDashboard: (props: EmbedSsoDashboardProps) => Promise<string>;
3
3
  export declare const embedSsoWorkbook: (props: EmbedSsoWorkbookProps) => Promise<string>;
4
4
  /**
5
- * *IN BETA* Generates an embed login URL using the passed-in content discovery page id.
5
+ * Generates an embed login URL using the passed-in content discovery page id.
6
6
  * @param EmbedSsoContentDiscoveryProps
7
7
  * @returns Promise wrapped around a generated embed login url.
8
8
  */
package/lib/esm/embed.js CHANGED
@@ -112,12 +112,14 @@ export const embedSsoWorkbook = async (props) => {
112
112
  return embedSsoContent({ ...props, contentPath });
113
113
  };
114
114
  /**
115
- * *IN BETA* Generates an embed login URL using the passed-in content discovery page id.
115
+ * Generates an embed login URL using the passed-in content discovery page id.
116
116
  * @param EmbedSsoContentDiscoveryProps
117
117
  * @returns Promise wrapped around a generated embed login url.
118
118
  */
119
119
  export const embedSsoContentDiscovery = async (props) => {
120
- const contentPath = `/${props.path}`;
120
+ // Entity paths for the Content Discovery embed no longer require stripping the leading `/`.
121
+ // This check maintains backwards compatibility with the old behavior.
122
+ const contentPath = props.path.startsWith('/') ? props.path : `/${props.path}`;
121
123
  return embedSsoContent({
122
124
  ...props,
123
125
  contentPath,
@@ -188,8 +188,6 @@ export declare enum EmbeddedContent {
188
188
  Dashboard = "dashboards",
189
189
  Workbook = "w"
190
190
  }
191
- export declare const EmbedSsoContentDiscoveryPaths: readonly ["my", "entity-folder", "root"];
192
- export type EmbedSsoContentDiscoveryPath = (typeof EmbedSsoContentDiscoveryPaths)[number];
193
191
  export declare enum EmbedConnectionRoles {
194
192
  RESTRICTED_QUERIER = "RESTRICTED_QUERIER",
195
193
  VIEWER = "VIEWER",
@@ -218,6 +216,6 @@ export type EmbedSsoContentDiscoveryProps = EmbedSsoBaseProps & {
218
216
  /**
219
217
  * Path name of the content discovery page to embed.
220
218
  */
221
- path: EmbedSsoContentDiscoveryPath;
219
+ path: string;
222
220
  };
223
221
  export {};
package/lib/esm/types.js CHANGED
@@ -65,11 +65,6 @@ export var EmbeddedContent;
65
65
  EmbeddedContent["Dashboard"] = "dashboards";
66
66
  EmbeddedContent["Workbook"] = "w";
67
67
  })(EmbeddedContent || (EmbeddedContent = {}));
68
- export const EmbedSsoContentDiscoveryPaths = [
69
- "my",
70
- "entity-folder",
71
- "root",
72
- ];
73
68
  export var EmbedConnectionRoles;
74
69
  (function (EmbedConnectionRoles) {
75
70
  EmbedConnectionRoles["RESTRICTED_QUERIER"] = "RESTRICTED_QUERIER";
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "0.4.12",
2
+ "version": "0.5.0",
3
3
  "license": "MIT",
4
4
  "name": "@omni-co/embed",
5
5
  "author": "Nate Agrin <nate@exploreomni.com>",
@@ -8,6 +8,7 @@
8
8
  ],
9
9
  "devDependencies": {
10
10
  "@types/node": "^20.8.9",
11
+ "semantic-release": "^24.2.1",
11
12
  "typescript": "^5.2.2",
12
13
  "vitest": "^0.34.6"
13
14
  },