arky-sdk 0.7.134 → 0.9.0

package/dist/{admin-DlDViCdY.d.cts → admin-CfHen7c5.d.cts}

@@ -81,60 +81,100 @@ interface TrackParams {
 declare const COMMON_ACTIVITY_TYPES: readonly ["page_view", "product_view", "service_view", "provider_view", "cart_added", "cart_removed", "checkout_started", "purchase", "order_created", "signin", "signup", "verified_email", "search", "share", "wishlist_added"];
 type CommonActivityType = (typeof COMMON_ACTIVITY_TYPES)[number];
 
-type EntityKind = "product" | "service" | "provider" | "node" | "customer" | "audience" | "agent" | "workflow" | "promo_code" | "email_template" | "form" | "taxonomy" | "media" | "order";
-type Granularity = "hour" | "day" | "week" | "month" | {
-    minutes: 5 | 10 | 15 | 30;
-};
-type Measure = "count" | "uniq_customers" | "orders_created" | "new_customers" | "form_submissions" | {
-    entity_state: {
-        entity: EntityKind;
-        status: string;
-    };
-};
-type Dimension = "country_code" | "city" | "device_type" | "browser" | "os" | "language" | "activity_type" | "entity" | "entity_status" | {
-    time_bucket: {
-        granularity: Granularity;
-    };
-};
-type FilterField = "type" | "country_code" | "device_type" | "browser" | "os" | "language" | "entity" | "action" | "customer_id";
-type FilterOp = "eq" | "neq" | "in" | "not_in" | "contains";
-interface Filter {
-    field: FilterField;
-    op: FilterOp;
-    values: string[];
-}
-type TimeUnit = "hour" | "day" | "week" | "month";
-type TimeRange = {
-    from: number;
-    unit: TimeUnit;
-    to?: number;
-} | {
+interface AnalyticsTimeRange {
     from: number;
     to: number;
-};
-interface OrderBy {
-    field: string;
-    dir: "asc" | "desc";
-}
-interface AnalyticsQuery {
-    measures: Measure[];
-    dimensions?: Dimension[];
-    filters?: Filter[];
-    time_range: TimeRange;
-    granularity?: Granularity;
-    order_by?: OrderBy[];
+}
+type AnalyticsReportKey = "orders_created" | "customers_created" | "form_submissions_created" | "carts_abandoned" | "media_count" | "products_by_status" | "services_by_status" | "providers_by_status" | "nodes_by_status" | "customers_by_status" | "audiences_by_status" | "agents_by_status" | "workflows_by_status" | "promo_codes_by_status" | "email_templates_by_status" | "forms_by_status" | "taxonomies_by_status" | "carts_by_status" | "orders_by_status" | "order_items_by_status" | "activity_by_country" | "recent_activity";
+type ActivityFeedCategory = "orders" | "carts" | "promo_codes" | "submissions" | "customers" | "audiences" | "products" | "services" | "providers" | "cms" | "workflows" | "agents" | "activities";
+interface AnalyticsReportRequest {
+    key: AnalyticsReportKey;
     limit?: number;
+    category?: ActivityFeedCategory;
+    cursor_created_at?: number;
+    cursor_id?: string;
+}
+interface AnalyticsRequest {
+    time: AnalyticsTimeRange;
+    reports: AnalyticsReportRequest[];
+}
+interface AnalyticsMetricData {
+    value: number;
+    execution_ms?: number;
+}
+interface AnalyticsBreakdownItem {
+    key: string;
+    label: string;
+    value: number;
+    unique_customers?: number;
 }
-interface AnalyticsRow {
-    [key: string]: string | number | null;
+interface AnalyticsBreakdownData {
+    items: AnalyticsBreakdownItem[];
 }
-interface AnalyticsQueryResponse {
-    rows: AnalyticsRow[];
+interface ActivityFeedItem {
+    id: string;
+    entity: string;
+    entity_id: string;
+    action: string;
+    event_type: string;
+    status: string;
+    customer_id: string;
+    category: string;
+    title: string;
+    description: string;
+    href?: string | null;
+    data: unknown;
+    payload: unknown;
+    created_at: number;
+}
+interface ActivityFeedSummary {
+    total: number;
+    orders: number;
+    submissions: number;
+    customers: number;
+    audiences: number;
+    abandoned_carts: number;
+    carts: number;
+    promo_codes: number;
+    products: number;
+    services: number;
+    providers: number;
+    cms: number;
+    workflows: number;
+    agents: number;
+    activities: number;
+    window_start: number;
+}
+interface ActivityFeedCursor {
+    created_at: number;
+    id: string;
+}
+interface ActivityFeedData {
+    items: ActivityFeedItem[];
+    summary: ActivityFeedSummary;
+    next_cursor?: ActivityFeedCursor | null;
     meta: {
         row_count: number;
         execution_ms: number;
     };
 }
+type AnalyticsReport = {
+    key: AnalyticsReportKey;
+    type: "metric";
+    data: AnalyticsMetricData;
+} | {
+    key: AnalyticsReportKey;
+    type: "breakdown";
+    data: AnalyticsBreakdownData;
+} | {
+    key: AnalyticsReportKey;
+    type: "activity";
+    data: ActivityFeedData;
+};
+interface AnalyticsResponse {
+    time: AnalyticsTimeRange;
+    reports: AnalyticsReport[];
+}
 
 interface Activity {
     id: string;
@@ -706,9 +746,9 @@ declare function createAdmin(config: CreateAdminConfig): {
         };
     };
     analytics: {
-        query: (spec: AnalyticsQuery, options?: RequestOptions$1 & {
+        get(request: AnalyticsRequest, options?: RequestOptions$1 & {
             store_id?: string;
-        }) => Promise<AnalyticsQueryResponse>;
+        }): Promise<AnalyticsResponse>;
     };
     setStoreId: (storeId: string) => void;
     getStoreId: () => string;
@@ -993,4 +1033,4 @@ declare function createStorefront(config: CreateStorefrontConfig): {
     };
 };
 
-export { type AnalyticsQueryResponse as $, type AuthStateListener as A, type CartControllerListener as B, type CreateStorefrontConfig as C, type CartControllerQuoteParams as D, type CartControllerRefreshParams as E, type CartControllerRemoveItemParams as F, type CartControllerState as G, type CartControllerUpdateParams as H, type IdentifyResponse as I, type HttpClientConfig as J, type AuthStorage as K, SUPPORTED_FRAMEWORKS as L, type ApiConfig as M, type AdminSessionInternal as N, type CustomerSessionInternal as O, type AdminSession as P, type AdminSessionUpdater as Q, type CustomerSessionUpdater as R, SDK_VERSION as S, type TrackParams as T, type CreateAdminConfig as U, type VerifyResponse as V, createAdmin as W, type LocationState as X, type LocationCountry as Y, type GetCountriesResponse as Z, type AnalyticsQuery as _, type CustomerSession as a, type AnalyticsRow as a0, type Measure as a1, type Dimension as a2, type Filter as a3, type FilterField as a4, type FilterOp as a5, type Granularity as a6, type EntityKind as a7, type TimeRange as a8, type TimeUnit as a9, type OrderBy as aa, type TimelineParams as ab, type IntegrationOperation as ac, type IntegrationResource as ad, type IntegrationService as ae, type CustomerToken as b, type CartController as c, findTimeZone as d, extractBlockValues as e, formatBlockValue as f, getBlockLabel as g, humanize as h, categorify as i, formatDate as j, getSvgContentForAstro as k, fetchSvgContent as l, injectSvgIntoElement as m, type Activity$1 as n, COMMON_ACTIVITY_TYPES as o, prepareBlocksForSubmission as p, createStorefront as q, createCartController as r, slugify as s, type CommonActivityType as t, type CartApi as u, validatePhoneNumber as v, type CartControllerAddItemParams as w, type CartControllerCheckoutParams as x, type CartControllerClearParams as y, type CartControllerInitParams as z };
+export { type AnalyticsReportKey as $, type AuthStateListener as A, type CartControllerListener as B, type CreateStorefrontConfig as C, type CartControllerQuoteParams as D, type CartControllerRefreshParams as E, type CartControllerRemoveItemParams as F, type CartControllerState as G, type CartControllerUpdateParams as H, type IdentifyResponse as I, type HttpClientConfig as J, type AuthStorage as K, SUPPORTED_FRAMEWORKS as L, type ApiConfig as M, type AdminSessionInternal as N, type CustomerSessionInternal as O, type AdminSession as P, type AdminSessionUpdater as Q, type CustomerSessionUpdater as R, SDK_VERSION as S, type TrackParams as T, type CreateAdminConfig as U, type VerifyResponse as V, createAdmin as W, type LocationState as X, type LocationCountry as Y, type GetCountriesResponse as Z, type AnalyticsTimeRange as _, type CustomerSession as a, type AnalyticsReportRequest as a0, type AnalyticsRequest as a1, type AnalyticsMetricData as a2, type AnalyticsBreakdownItem as a3, type AnalyticsBreakdownData as a4, type AnalyticsReport as a5, type AnalyticsResponse as a6, type ActivityFeedCategory as a7, type ActivityFeedItem as a8, type ActivityFeedSummary as a9, type ActivityFeedCursor as aa, type ActivityFeedData as ab, type TimelineParams as ac, type IntegrationOperation as ad, type IntegrationResource as ae, type IntegrationService as af, type CustomerToken as b, type CartController as c, findTimeZone as d, extractBlockValues as e, formatBlockValue as f, getBlockLabel as g, humanize as h, categorify as i, formatDate as j, getSvgContentForAstro as k, fetchSvgContent as l, injectSvgIntoElement as m, type Activity$1 as n, COMMON_ACTIVITY_TYPES as o, prepareBlocksForSubmission as p, createStorefront as q, createCartController as r, slugify as s, type CommonActivityType as t, type CartApi as u, validatePhoneNumber as v, type CartControllerAddItemParams as w, type CartControllerCheckoutParams as x, type CartControllerClearParams as y, type CartControllerInitParams as z };

package/dist/{admin-id0wkGff.d.ts → admin-ru7pX5bd.d.ts}

@@ -81,60 +81,100 @@ interface TrackParams {
 declare const COMMON_ACTIVITY_TYPES: readonly ["page_view", "product_view", "service_view", "provider_view", "cart_added", "cart_removed", "checkout_started", "purchase", "order_created", "signin", "signup", "verified_email", "search", "share", "wishlist_added"];
 type CommonActivityType = (typeof COMMON_ACTIVITY_TYPES)[number];
 
-type EntityKind = "product" | "service" | "provider" | "node" | "customer" | "audience" | "agent" | "workflow" | "promo_code" | "email_template" | "form" | "taxonomy" | "media" | "order";
-type Granularity = "hour" | "day" | "week" | "month" | {
-    minutes: 5 | 10 | 15 | 30;
-};
-type Measure = "count" | "uniq_customers" | "orders_created" | "new_customers" | "form_submissions" | {
-    entity_state: {
-        entity: EntityKind;
-        status: string;
-    };
-};
-type Dimension = "country_code" | "city" | "device_type" | "browser" | "os" | "language" | "activity_type" | "entity" | "entity_status" | {
-    time_bucket: {
-        granularity: Granularity;
-    };
-};
-type FilterField = "type" | "country_code" | "device_type" | "browser" | "os" | "language" | "entity" | "action" | "customer_id";
-type FilterOp = "eq" | "neq" | "in" | "not_in" | "contains";
-interface Filter {
-    field: FilterField;
-    op: FilterOp;
-    values: string[];
-}
-type TimeUnit = "hour" | "day" | "week" | "month";
-type TimeRange = {
-    from: number;
-    unit: TimeUnit;
-    to?: number;
-} | {
+interface AnalyticsTimeRange {
     from: number;
     to: number;
-};
-interface OrderBy {
-    field: string;
-    dir: "asc" | "desc";
-}
-interface AnalyticsQuery {
-    measures: Measure[];
-    dimensions?: Dimension[];
-    filters?: Filter[];
-    time_range: TimeRange;
-    granularity?: Granularity;
-    order_by?: OrderBy[];
+}
+type AnalyticsReportKey = "orders_created" | "customers_created" | "form_submissions_created" | "carts_abandoned" | "media_count" | "products_by_status" | "services_by_status" | "providers_by_status" | "nodes_by_status" | "customers_by_status" | "audiences_by_status" | "agents_by_status" | "workflows_by_status" | "promo_codes_by_status" | "email_templates_by_status" | "forms_by_status" | "taxonomies_by_status" | "carts_by_status" | "orders_by_status" | "order_items_by_status" | "activity_by_country" | "recent_activity";
+type ActivityFeedCategory = "orders" | "carts" | "promo_codes" | "submissions" | "customers" | "audiences" | "products" | "services" | "providers" | "cms" | "workflows" | "agents" | "activities";
+interface AnalyticsReportRequest {
+    key: AnalyticsReportKey;
     limit?: number;
+    category?: ActivityFeedCategory;
+    cursor_created_at?: number;
+    cursor_id?: string;
+}
+interface AnalyticsRequest {
+    time: AnalyticsTimeRange;
+    reports: AnalyticsReportRequest[];
+}
+interface AnalyticsMetricData {
+    value: number;
+    execution_ms?: number;
+}
+interface AnalyticsBreakdownItem {
+    key: string;
+    label: string;
+    value: number;
+    unique_customers?: number;
 }
-interface AnalyticsRow {
-    [key: string]: string | number | null;
+interface AnalyticsBreakdownData {
+    items: AnalyticsBreakdownItem[];
 }
-interface AnalyticsQueryResponse {
-    rows: AnalyticsRow[];
+interface ActivityFeedItem {
+    id: string;
+    entity: string;
+    entity_id: string;
+    action: string;
+    event_type: string;
+    status: string;
+    customer_id: string;
+    category: string;
+    title: string;
+    description: string;
+    href?: string | null;
+    data: unknown;
+    payload: unknown;
+    created_at: number;
+}
+interface ActivityFeedSummary {
+    total: number;
+    orders: number;
+    submissions: number;
+    customers: number;
+    audiences: number;
+    abandoned_carts: number;
+    carts: number;
+    promo_codes: number;
+    products: number;
+    services: number;
+    providers: number;
+    cms: number;
+    workflows: number;
+    agents: number;
+    activities: number;
+    window_start: number;
+}
+interface ActivityFeedCursor {
+    created_at: number;
+    id: string;
+}
+interface ActivityFeedData {
+    items: ActivityFeedItem[];
+    summary: ActivityFeedSummary;
+    next_cursor?: ActivityFeedCursor | null;
     meta: {
         row_count: number;
         execution_ms: number;
     };
 }
+type AnalyticsReport = {
+    key: AnalyticsReportKey;
+    type: "metric";
+    data: AnalyticsMetricData;
+} | {
+    key: AnalyticsReportKey;
+    type: "breakdown";
+    data: AnalyticsBreakdownData;
+} | {
+    key: AnalyticsReportKey;
+    type: "activity";
+    data: ActivityFeedData;
+};
+interface AnalyticsResponse {
+    time: AnalyticsTimeRange;
+    reports: AnalyticsReport[];
+}
 
 interface Activity {
     id: string;
@@ -706,9 +746,9 @@ declare function createAdmin(config: CreateAdminConfig): {
         };
     };
     analytics: {
-        query: (spec: AnalyticsQuery, options?: RequestOptions$1 & {
+        get(request: AnalyticsRequest, options?: RequestOptions$1 & {
             store_id?: string;
-        }) => Promise<AnalyticsQueryResponse>;
+        }): Promise<AnalyticsResponse>;
     };
     setStoreId: (storeId: string) => void;
     getStoreId: () => string;
@@ -993,4 +1033,4 @@ declare function createStorefront(config: CreateStorefrontConfig): {
     };
 };
 
-export { type AnalyticsQueryResponse as $, type AuthStateListener as A, type CartControllerListener as B, type CreateStorefrontConfig as C, type CartControllerQuoteParams as D, type CartControllerRefreshParams as E, type CartControllerRemoveItemParams as F, type CartControllerState as G, type CartControllerUpdateParams as H, type IdentifyResponse as I, type HttpClientConfig as J, type AuthStorage as K, SUPPORTED_FRAMEWORKS as L, type ApiConfig as M, type AdminSessionInternal as N, type CustomerSessionInternal as O, type AdminSession as P, type AdminSessionUpdater as Q, type CustomerSessionUpdater as R, SDK_VERSION as S, type TrackParams as T, type CreateAdminConfig as U, type VerifyResponse as V, createAdmin as W, type LocationState as X, type LocationCountry as Y, type GetCountriesResponse as Z, type AnalyticsQuery as _, type CustomerSession as a, type AnalyticsRow as a0, type Measure as a1, type Dimension as a2, type Filter as a3, type FilterField as a4, type FilterOp as a5, type Granularity as a6, type EntityKind as a7, type TimeRange as a8, type TimeUnit as a9, type OrderBy as aa, type TimelineParams as ab, type IntegrationOperation as ac, type IntegrationResource as ad, type IntegrationService as ae, type CustomerToken as b, type CartController as c, findTimeZone as d, extractBlockValues as e, formatBlockValue as f, getBlockLabel as g, humanize as h, categorify as i, formatDate as j, getSvgContentForAstro as k, fetchSvgContent as l, injectSvgIntoElement as m, type Activity$1 as n, COMMON_ACTIVITY_TYPES as o, prepareBlocksForSubmission as p, createStorefront as q, createCartController as r, slugify as s, type CommonActivityType as t, type CartApi as u, validatePhoneNumber as v, type CartControllerAddItemParams as w, type CartControllerCheckoutParams as x, type CartControllerClearParams as y, type CartControllerInitParams as z };
+export { type AnalyticsReportKey as $, type AuthStateListener as A, type CartControllerListener as B, type CreateStorefrontConfig as C, type CartControllerQuoteParams as D, type CartControllerRefreshParams as E, type CartControllerRemoveItemParams as F, type CartControllerState as G, type CartControllerUpdateParams as H, type IdentifyResponse as I, type HttpClientConfig as J, type AuthStorage as K, SUPPORTED_FRAMEWORKS as L, type ApiConfig as M, type AdminSessionInternal as N, type CustomerSessionInternal as O, type AdminSession as P, type AdminSessionUpdater as Q, type CustomerSessionUpdater as R, SDK_VERSION as S, type TrackParams as T, type CreateAdminConfig as U, type VerifyResponse as V, createAdmin as W, type LocationState as X, type LocationCountry as Y, type GetCountriesResponse as Z, type AnalyticsTimeRange as _, type CustomerSession as a, type AnalyticsReportRequest as a0, type AnalyticsRequest as a1, type AnalyticsMetricData as a2, type AnalyticsBreakdownItem as a3, type AnalyticsBreakdownData as a4, type AnalyticsReport as a5, type AnalyticsResponse as a6, type ActivityFeedCategory as a7, type ActivityFeedItem as a8, type ActivityFeedSummary as a9, type ActivityFeedCursor as aa, type ActivityFeedData as ab, type TimelineParams as ac, type IntegrationOperation as ad, type IntegrationResource as ae, type IntegrationService as af, type CustomerToken as b, type CartController as c, findTimeZone as d, extractBlockValues as e, formatBlockValue as f, getBlockLabel as g, humanize as h, categorify as i, formatDate as j, getSvgContentForAstro as k, fetchSvgContent as l, injectSvgIntoElement as m, type Activity$1 as n, COMMON_ACTIVITY_TYPES as o, prepareBlocksForSubmission as p, createStorefront as q, createCartController as r, slugify as s, type CommonActivityType as t, type CartApi as u, validatePhoneNumber as v, type CartControllerAddItemParams as w, type CartControllerCheckoutParams as x, type CartControllerClearParams as y, type CartControllerInitParams as z };

package/dist/admin.cjs

@@ -1884,11 +1884,11 @@ var createTaxonomyApi = (apiConfig) => {
 // src/api/analytics.ts
 var createAnalyticsApi = (apiConfig) => {
   return {
-    async query(spec, options) {
+    async get(request, options) {
       const store_id = options?.store_id || apiConfig.storeId;
       return apiConfig.httpClient.post(
-        `/v1/stores/${store_id}/analytics/query`,
-        spec,
+        `/v1/stores/${store_id}/analytics`,
+        request,
         options
       );
     }
@@ -2427,9 +2427,7 @@ function createAdmin(config) {
         getExecution: workflowApi.getWorkflowExecution
       }
     },
-    analytics: {
-      query: analyticsApi.query
-    },
+    analytics: analyticsApi,
     setStoreId: (storeId) => {
       apiConfig.storeId = storeId;
     },