venue-js 1.1.1 → 1.2.0-next.1

package/dist/index.d.mts

@@ -658,8 +658,10 @@ type Filter = EqFilter | InFilter;
 type Filters = Record<string, Filter>;
 
 interface VenueClientOptions {
+    mode?: "delivery" | "preview";
     projectId: string;
-    apiKey: string;
+    apiKey?: string;
+    previewToken?: string;
     baseUrl?: string;
     queryClient?: QueryClient;
 }
@@ -701,8 +703,15 @@ declare const GEOJSON_FEATURE_TYPES: FeatureType[];
 declare const ALL_FEATURE_TYPES: FeatureType[];
 declare const defaultFeatureQueryOptionsMap: Record<FeatureType, FeatureQueryOptions>;
 
-declare function fetchFeature<T extends FeatureType = FeatureType>(projectId: string, apiKey: string, featureType: FeatureType, baseUrl?: string): Promise<FeatureResponseMap[T][]>;
-declare const safeFetchFeature: <T extends FeatureType = FeatureType>(projectId: string, apiKey: string, featureType: FeatureType, baseUrl?: string) => Promise<FeatureResponseMap[T][]>;
+declare function fetchDeliveryApi<T extends FeatureType = FeatureType>(projectId: string, apiKey: string, featureType: FeatureType, baseUrl?: string): Promise<FeatureResponseMap[T][]>;
+declare function fetchPreviewApi<T extends FeatureType = FeatureType>(projectId: string, previewToken: string, featureType: FeatureType, baseUrl?: string): Promise<FeatureResponseMap[T][]>;
+declare const safeFetchFeature: <T extends FeatureType = FeatureType>(featureType: FeatureType, params: {
+    mode: "delivery" | "preview";
+    projectId: string;
+    apiKey: string;
+    previewToken?: string;
+    baseUrl: string;
+}) => Promise<FeatureResponseMap[T][]>;
 
 declare const getDataClient: (options: VenueClientOptions) => VenueDataClient;
 
@@ -1211,4 +1220,4 @@ declare const VENUE_EVENTS: {
     VENUE_MOVEINTOVIEW: string;
 };
 
-export { ALL_FEATURE_TYPES, ALWAYS_VISIBLE_FEATURE_TYPES, type AmenityFeature, type AmenityFeaturePopulated, type AmenityGeometry, type AmenityProperties, type AnchorFeature, type AnchorFeaturePopulated, type AnchorGeometry, type AnchorProperties, BASE_LAYER_NAME, DEFAULT_BASE_URL, DEFAULT_HIGHLIGHT_OPTIONS, DEFAULT_LOCALE, DEFAULT_SET_HIGHLIGHT_2DELEMENT_IDS_OPTIONS, DESTINATION_MARKER_ID, type DetailFeature, type DetailGeometry, type DetailProperties, type ElementFeature, type ElementGeometry, type ElementProperties, type EventFeature, type EventGeometry, type EventProperties, type FeaturePopulatedResponseMap, type FeatureQueryOptions, type FeatureResponseMap, type FeatureType, type FilterParams, type FindParams, type FixtureFeature, type FixtureFeaturePopulated, type FixtureGeometry, type FixtureProperties, GEOJSON_FEATURE_TYPES, HIGHLIGHT_LAYER_NAME, IMDF_FEATURE_TYPES, type Id, type ImdfFeature, IndoorMap, type InternalFilterByType, type InternalFindById, type KioskFeature, type KioskFeaturePopulated, type KioskGeometry, type KioskProperties, LAST_USER_LOCATION_ELEMENT_ID_PREFIX, LAYERS, LAYER_FEATURE_TYPE_OBJ, LAYER_OPTIONS, LOCALE_SYMBOL_KEY, type LabelFeature, type LabelGeometry, type LabelProperties, type LevelFeature, type LevelFeaturePopulated, type LevelGeometry, type LevelProperties, MARKER_LAYER_NAME, type Media, type MediaFile, type Model3d, NONIMDF_FEATURE_TYPES, ORIGIN_MARKER_ID, type OccupantFeature, type OccupantFeaturePopulated, type OccupantGeometry, type OccupantProperties, type OpeningFeature, type OpeningFeaturePopulated, type OpeningGeometry, type OpeningProperties, POI_MARKER_LAYER_NAME, type Page, type PolygonalFeature, type PopulatableFeatureType, type PopulatedParams, type PrivilegeFeature, type PrivilegeGeometry, type PrivilegeProperties, type PromotionFeature, type PromotionProperties, type RelationshipFeature, type RelationshipGeometry, type RelationshipProperties, type SectionFeature, type SectionFeaturePopulated, type SectionGeometry, type SectionProperties, type SponsoredContentFeature, type SponsoredContentLegacyType, type SponsoredContentPlacementType, type SponsoredContentStrapiV4ApiResponse, type TaxonomyFeature, type TaxonomyFeaturePopulated, type TaxonomyGeometry, type TaxonomyProperties, USER_LOCATION_ELEMENT_ID, USER_LOCATION_LAYER_NAME, type UnitFeature, type UnitFeaturePopulated, type UnitGeometry, type UnitProperties, VENUE_EVENTS, type VenueClientOptions, type VenueDataClient, type VenueFeature, type VenueFeaturePopulated, type VenueGeometry, type VenueProperties, createPolygonFromLineString, createSpriteMaterialByLabelSymbol, createStyledUIMarkerElement, defaultFeatureQueryOptionsMap, fetchFeature, getBearingBetweenPoints, getCenterFromGeometry, getDataClient, getExtrudeConfigByFeature, getFeatureByLocationId, getLocationByAmenity, getLocationByFeature, getLocationByOccupant, getLocationIdByFeature, getOrdinalByLocationId, getRelatedLocationIdsByFeature, getRelatedLocationsByAmenity, getRelatedLocationsByFeature, getRelatedLocationsByOccupant, getSuitablyValueBetweenBearings, isClickableFeature, safeFetchFeature, styledFeatureGenerator };
+export { ALL_FEATURE_TYPES, ALWAYS_VISIBLE_FEATURE_TYPES, type AmenityFeature, type AmenityFeaturePopulated, type AmenityGeometry, type AmenityProperties, type AnchorFeature, type AnchorFeaturePopulated, type AnchorGeometry, type AnchorProperties, BASE_LAYER_NAME, DEFAULT_BASE_URL, DEFAULT_HIGHLIGHT_OPTIONS, DEFAULT_LOCALE, DEFAULT_SET_HIGHLIGHT_2DELEMENT_IDS_OPTIONS, DESTINATION_MARKER_ID, type DetailFeature, type DetailGeometry, type DetailProperties, type ElementFeature, type ElementGeometry, type ElementProperties, type EventFeature, type EventGeometry, type EventProperties, type FeaturePopulatedResponseMap, type FeatureQueryOptions, type FeatureResponseMap, type FeatureType, type FilterParams, type FindParams, type FixtureFeature, type FixtureFeaturePopulated, type FixtureGeometry, type FixtureProperties, GEOJSON_FEATURE_TYPES, HIGHLIGHT_LAYER_NAME, IMDF_FEATURE_TYPES, type Id, type ImdfFeature, IndoorMap, type InternalFilterByType, type InternalFindById, type KioskFeature, type KioskFeaturePopulated, type KioskGeometry, type KioskProperties, LAST_USER_LOCATION_ELEMENT_ID_PREFIX, LAYERS, LAYER_FEATURE_TYPE_OBJ, LAYER_OPTIONS, LOCALE_SYMBOL_KEY, type LabelFeature, type LabelGeometry, type LabelProperties, type LevelFeature, type LevelFeaturePopulated, type LevelGeometry, type LevelProperties, MARKER_LAYER_NAME, type Media, type MediaFile, type Model3d, NONIMDF_FEATURE_TYPES, ORIGIN_MARKER_ID, type OccupantFeature, type OccupantFeaturePopulated, type OccupantGeometry, type OccupantProperties, type OpeningFeature, type OpeningFeaturePopulated, type OpeningGeometry, type OpeningProperties, POI_MARKER_LAYER_NAME, type Page, type PolygonalFeature, type PopulatableFeatureType, type PopulatedParams, type PrivilegeFeature, type PrivilegeGeometry, type PrivilegeProperties, type PromotionFeature, type PromotionProperties, type RelationshipFeature, type RelationshipGeometry, type RelationshipProperties, type SectionFeature, type SectionFeaturePopulated, type SectionGeometry, type SectionProperties, type SponsoredContentFeature, type SponsoredContentLegacyType, type SponsoredContentPlacementType, type SponsoredContentStrapiV4ApiResponse, type TaxonomyFeature, type TaxonomyFeaturePopulated, type TaxonomyGeometry, type TaxonomyProperties, USER_LOCATION_ELEMENT_ID, USER_LOCATION_LAYER_NAME, type UnitFeature, type UnitFeaturePopulated, type UnitGeometry, type UnitProperties, VENUE_EVENTS, type VenueClientOptions, type VenueDataClient, type VenueFeature, type VenueFeaturePopulated, type VenueGeometry, type VenueProperties, createPolygonFromLineString, createSpriteMaterialByLabelSymbol, createStyledUIMarkerElement, defaultFeatureQueryOptionsMap, fetchDeliveryApi, fetchPreviewApi, getBearingBetweenPoints, getCenterFromGeometry, getDataClient, getExtrudeConfigByFeature, getFeatureByLocationId, getLocationByAmenity, getLocationByFeature, getLocationByOccupant, getLocationIdByFeature, getOrdinalByLocationId, getRelatedLocationIdsByFeature, getRelatedLocationsByAmenity, getRelatedLocationsByFeature, getRelatedLocationsByOccupant, getSuitablyValueBetweenBearings, isClickableFeature, safeFetchFeature, styledFeatureGenerator };

package/dist/index.d.ts

@@ -658,8 +658,10 @@ type Filter = EqFilter | InFilter;
 type Filters = Record<string, Filter>;
 
 interface VenueClientOptions {
+    mode?: "delivery" | "preview";
     projectId: string;
-    apiKey: string;
+    apiKey?: string;
+    previewToken?: string;
     baseUrl?: string;
     queryClient?: QueryClient;
 }
@@ -701,8 +703,15 @@ declare const GEOJSON_FEATURE_TYPES: FeatureType[];
 declare const ALL_FEATURE_TYPES: FeatureType[];
 declare const defaultFeatureQueryOptionsMap: Record<FeatureType, FeatureQueryOptions>;
 
-declare function fetchFeature<T extends FeatureType = FeatureType>(projectId: string, apiKey: string, featureType: FeatureType, baseUrl?: string): Promise<FeatureResponseMap[T][]>;
-declare const safeFetchFeature: <T extends FeatureType = FeatureType>(projectId: string, apiKey: string, featureType: FeatureType, baseUrl?: string) => Promise<FeatureResponseMap[T][]>;
+declare function fetchDeliveryApi<T extends FeatureType = FeatureType>(projectId: string, apiKey: string, featureType: FeatureType, baseUrl?: string): Promise<FeatureResponseMap[T][]>;
+declare function fetchPreviewApi<T extends FeatureType = FeatureType>(projectId: string, previewToken: string, featureType: FeatureType, baseUrl?: string): Promise<FeatureResponseMap[T][]>;
+declare const safeFetchFeature: <T extends FeatureType = FeatureType>(featureType: FeatureType, params: {
+    mode: "delivery" | "preview";
+    projectId: string;
+    apiKey: string;
+    previewToken?: string;
+    baseUrl: string;
+}) => Promise<FeatureResponseMap[T][]>;
 
 declare const getDataClient: (options: VenueClientOptions) => VenueDataClient;
 
@@ -1211,4 +1220,4 @@ declare const VENUE_EVENTS: {
     VENUE_MOVEINTOVIEW: string;
 };
 
-export { ALL_FEATURE_TYPES, ALWAYS_VISIBLE_FEATURE_TYPES, type AmenityFeature, type AmenityFeaturePopulated, type AmenityGeometry, type AmenityProperties, type AnchorFeature, type AnchorFeaturePopulated, type AnchorGeometry, type AnchorProperties, BASE_LAYER_NAME, DEFAULT_BASE_URL, DEFAULT_HIGHLIGHT_OPTIONS, DEFAULT_LOCALE, DEFAULT_SET_HIGHLIGHT_2DELEMENT_IDS_OPTIONS, DESTINATION_MARKER_ID, type DetailFeature, type DetailGeometry, type DetailProperties, type ElementFeature, type ElementGeometry, type ElementProperties, type EventFeature, type EventGeometry, type EventProperties, type FeaturePopulatedResponseMap, type FeatureQueryOptions, type FeatureResponseMap, type FeatureType, type FilterParams, type FindParams, type FixtureFeature, type FixtureFeaturePopulated, type FixtureGeometry, type FixtureProperties, GEOJSON_FEATURE_TYPES, HIGHLIGHT_LAYER_NAME, IMDF_FEATURE_TYPES, type Id, type ImdfFeature, IndoorMap, type InternalFilterByType, type InternalFindById, type KioskFeature, type KioskFeaturePopulated, type KioskGeometry, type KioskProperties, LAST_USER_LOCATION_ELEMENT_ID_PREFIX, LAYERS, LAYER_FEATURE_TYPE_OBJ, LAYER_OPTIONS, LOCALE_SYMBOL_KEY, type LabelFeature, type LabelGeometry, type LabelProperties, type LevelFeature, type LevelFeaturePopulated, type LevelGeometry, type LevelProperties, MARKER_LAYER_NAME, type Media, type MediaFile, type Model3d, NONIMDF_FEATURE_TYPES, ORIGIN_MARKER_ID, type OccupantFeature, type OccupantFeaturePopulated, type OccupantGeometry, type OccupantProperties, type OpeningFeature, type OpeningFeaturePopulated, type OpeningGeometry, type OpeningProperties, POI_MARKER_LAYER_NAME, type Page, type PolygonalFeature, type PopulatableFeatureType, type PopulatedParams, type PrivilegeFeature, type PrivilegeGeometry, type PrivilegeProperties, type PromotionFeature, type PromotionProperties, type RelationshipFeature, type RelationshipGeometry, type RelationshipProperties, type SectionFeature, type SectionFeaturePopulated, type SectionGeometry, type SectionProperties, type SponsoredContentFeature, type SponsoredContentLegacyType, type SponsoredContentPlacementType, type SponsoredContentStrapiV4ApiResponse, type TaxonomyFeature, type TaxonomyFeaturePopulated, type TaxonomyGeometry, type TaxonomyProperties, USER_LOCATION_ELEMENT_ID, USER_LOCATION_LAYER_NAME, type UnitFeature, type UnitFeaturePopulated, type UnitGeometry, type UnitProperties, VENUE_EVENTS, type VenueClientOptions, type VenueDataClient, type VenueFeature, type VenueFeaturePopulated, type VenueGeometry, type VenueProperties, createPolygonFromLineString, createSpriteMaterialByLabelSymbol, createStyledUIMarkerElement, defaultFeatureQueryOptionsMap, fetchFeature, getBearingBetweenPoints, getCenterFromGeometry, getDataClient, getExtrudeConfigByFeature, getFeatureByLocationId, getLocationByAmenity, getLocationByFeature, getLocationByOccupant, getLocationIdByFeature, getOrdinalByLocationId, getRelatedLocationIdsByFeature, getRelatedLocationsByAmenity, getRelatedLocationsByFeature, getRelatedLocationsByOccupant, getSuitablyValueBetweenBearings, isClickableFeature, safeFetchFeature, styledFeatureGenerator };
+export { ALL_FEATURE_TYPES, ALWAYS_VISIBLE_FEATURE_TYPES, type AmenityFeature, type AmenityFeaturePopulated, type AmenityGeometry, type AmenityProperties, type AnchorFeature, type AnchorFeaturePopulated, type AnchorGeometry, type AnchorProperties, BASE_LAYER_NAME, DEFAULT_BASE_URL, DEFAULT_HIGHLIGHT_OPTIONS, DEFAULT_LOCALE, DEFAULT_SET_HIGHLIGHT_2DELEMENT_IDS_OPTIONS, DESTINATION_MARKER_ID, type DetailFeature, type DetailGeometry, type DetailProperties, type ElementFeature, type ElementGeometry, type ElementProperties, type EventFeature, type EventGeometry, type EventProperties, type FeaturePopulatedResponseMap, type FeatureQueryOptions, type FeatureResponseMap, type FeatureType, type FilterParams, type FindParams, type FixtureFeature, type FixtureFeaturePopulated, type FixtureGeometry, type FixtureProperties, GEOJSON_FEATURE_TYPES, HIGHLIGHT_LAYER_NAME, IMDF_FEATURE_TYPES, type Id, type ImdfFeature, IndoorMap, type InternalFilterByType, type InternalFindById, type KioskFeature, type KioskFeaturePopulated, type KioskGeometry, type KioskProperties, LAST_USER_LOCATION_ELEMENT_ID_PREFIX, LAYERS, LAYER_FEATURE_TYPE_OBJ, LAYER_OPTIONS, LOCALE_SYMBOL_KEY, type LabelFeature, type LabelGeometry, type LabelProperties, type LevelFeature, type LevelFeaturePopulated, type LevelGeometry, type LevelProperties, MARKER_LAYER_NAME, type Media, type MediaFile, type Model3d, NONIMDF_FEATURE_TYPES, ORIGIN_MARKER_ID, type OccupantFeature, type OccupantFeaturePopulated, type OccupantGeometry, type OccupantProperties, type OpeningFeature, type OpeningFeaturePopulated, type OpeningGeometry, type OpeningProperties, POI_MARKER_LAYER_NAME, type Page, type PolygonalFeature, type PopulatableFeatureType, type PopulatedParams, type PrivilegeFeature, type PrivilegeGeometry, type PrivilegeProperties, type PromotionFeature, type PromotionProperties, type RelationshipFeature, type RelationshipGeometry, type RelationshipProperties, type SectionFeature, type SectionFeaturePopulated, type SectionGeometry, type SectionProperties, type SponsoredContentFeature, type SponsoredContentLegacyType, type SponsoredContentPlacementType, type SponsoredContentStrapiV4ApiResponse, type TaxonomyFeature, type TaxonomyFeaturePopulated, type TaxonomyGeometry, type TaxonomyProperties, USER_LOCATION_ELEMENT_ID, USER_LOCATION_LAYER_NAME, type UnitFeature, type UnitFeaturePopulated, type UnitGeometry, type UnitProperties, VENUE_EVENTS, type VenueClientOptions, type VenueDataClient, type VenueFeature, type VenueFeaturePopulated, type VenueGeometry, type VenueProperties, createPolygonFromLineString, createSpriteMaterialByLabelSymbol, createStyledUIMarkerElement, defaultFeatureQueryOptionsMap, fetchDeliveryApi, fetchPreviewApi, getBearingBetweenPoints, getCenterFromGeometry, getDataClient, getExtrudeConfigByFeature, getFeatureByLocationId, getLocationByAmenity, getLocationByFeature, getLocationByOccupant, getLocationIdByFeature, getOrdinalByLocationId, getRelatedLocationIdsByFeature, getRelatedLocationsByAmenity, getRelatedLocationsByFeature, getRelatedLocationsByOccupant, getSuitablyValueBetweenBearings, isClickableFeature, safeFetchFeature, styledFeatureGenerator };

package/dist/index.js

@@ -58,7 +58,8 @@ __export(index_exports, {
   createSpriteMaterialByLabelSymbol: () => createSpriteMaterialByLabelSymbol,
   createStyledUIMarkerElement: () => createStyledUIMarkerElement,
   defaultFeatureQueryOptionsMap: () => defaultFeatureQueryOptionsMap,
-  fetchFeature: () => fetchFeature,
+  fetchDeliveryApi: () => fetchDeliveryApi,
+  fetchPreviewApi: () => fetchPreviewApi,
   getBearingBetweenPoints: () => getBearingBetweenPoints,
   getCenterFromGeometry: () => getCenterFromGeometry,
   getDataClient: () => getDataClient,
@@ -161,7 +162,7 @@ var defaultFeatureQueryOptionsMap = {
 };
 
 // src/data/api/delivery-project.ts
-async function fetchFeature(projectId, apiKey, featureType, baseUrl = DEFAULT_BASE_URL) {
+async function fetchDeliveryApi(projectId, apiKey, featureType, baseUrl = DEFAULT_BASE_URL) {
   switch (featureType) {
     case "label":
     case "element": {
@@ -195,14 +196,78 @@ async function fetchFeature(projectId, apiKey, featureType, baseUrl = DEFAULT_BA
     }
   }
 }
-var safeFetchFeature = async (projectId, apiKey, featureType, baseUrl = DEFAULT_BASE_URL) => {
+async function fetchPreviewApi(projectId, previewToken, featureType, baseUrl = DEFAULT_BASE_URL) {
+  switch (featureType) {
+    case "label":
+    case "element": {
+      const pluralFeatureType = `${featureType}s`;
+      const res = await fetch(
+        `${baseUrl}/preview/projects/${projectId}/${pluralFeatureType}.geojson`,
+        {
+          headers: {
+            Authorization: `Bearer ${previewToken}`
+          }
+        }
+      );
+      if (res.status !== 200) return [];
+      const items = await res.json();
+      return items;
+    }
+    case "sponsored-content": {
+      const res = await fetch(
+        `${baseUrl}/preview/projects/${projectId}/sponsored-content.json`,
+        {
+          headers: {
+            Authorization: `Bearer ${previewToken}`
+          }
+        }
+      );
+      if (res.status !== 200) return [];
+      const jsonRes = await res.json();
+      const items = jsonRes.data;
+      return items.map((item) => ({
+        id: item.id,
+        ...item.attributes
+      }));
+    }
+    default: {
+      const res = await fetch(
+        `${baseUrl}/preview/projects/${projectId}/imdf/${featureType}.geojson`,
+        {
+          headers: {
+            Authorization: `Bearer ${previewToken}`
+          }
+        }
+      );
+      if (res.status !== 200) return [];
+      const collections = await res.json();
+      return collections.features;
+    }
+  }
+}
+var safeFetchFeature = async (featureType, params) => {
+  const mode = params.mode ?? "delivery";
+  const projectId = params.projectId;
+  const apiKey = params.apiKey;
+  const previewToken = params.previewToken;
+  const baseUrl = params.baseUrl ?? DEFAULT_BASE_URL;
   try {
-    const result = await fetchFeature(
-      projectId,
-      apiKey,
-      featureType,
-      baseUrl
-    );
+    let result = [];
+    if (mode === "delivery") {
+      result = await fetchDeliveryApi(
+        projectId,
+        apiKey,
+        featureType,
+        baseUrl
+      );
+    } else if (mode === "preview") {
+      result = await fetchPreviewApi(
+        projectId,
+        previewToken,
+        featureType,
+        baseUrl
+      );
+    }
     return result ?? [];
   } catch (e) {
     return Promise.resolve([]);
@@ -481,18 +546,22 @@ function matchFilters(item, filters) {
 var getDataClient = (options) => {
   const observers = /* @__PURE__ */ new Map();
   const queryClient = options.queryClient ?? new import_query_core.QueryClient();
-  const { projectId, apiKey, baseUrl } = options;
+  const { mode = "delivery", projectId, apiKey, baseUrl, previewToken } = options;
   if (!projectId)
     throw new Error(
       "Cannot create VenueDataClient. Reason: `projectId` is missing"
     );
-  if (!apiKey)
+  if (mode === "delivery" && !apiKey)
     throw new Error(
       "Cannot create VenueDataClient. Reason: `apiKey` is missing"
     );
+  if (mode === "preview" && !previewToken)
+    throw new Error(
+      "Cannot create VenueDataClient. Reason: `previewToken` is missing"
+    );
   const createDeliveryApiQueryOptions = (featureType) => ({
     queryKey: ["_deliveryapi", featureType],
-    queryFn: () => safeFetchFeature(projectId, apiKey, featureType, baseUrl)
+    queryFn: () => safeFetchFeature(featureType, { mode, projectId, apiKey, previewToken, baseUrl })
   });
   const internalFilterByType = async (featureType) => {
     try {
@@ -5248,7 +5317,8 @@ var IndoorMap = class extends EventTarget {
   createSpriteMaterialByLabelSymbol,
   createStyledUIMarkerElement,
   defaultFeatureQueryOptionsMap,
-  fetchFeature,
+  fetchDeliveryApi,
+  fetchPreviewApi,
   getBearingBetweenPoints,
   getCenterFromGeometry,
   getDataClient,