@spscommerce/asst-api 5.2.0 → 5.3.0

package/dist/{chunk-ZC44MAMI.js → chunk-35CHQUKC.js}

@@ -357,6 +357,19 @@ function createWhoAmIApi(client) {
 
 // lib/companyFeatures/index.ts
 var BASE_URL10 = "feature";
+var companyFeatureSchema = external_exports.object({
+  /**
+   * Validated as a string at runtime so that unknown feature types returned by the
+   * backend (e.g., after a backend-only deploy) never cause a ZodError.  The TypeScript
+   * type is narrowed to `FeatureType` so callers still get compile-time checking when
+   * comparing against known values.
+   */
+  type: external_exports.string(),
+  display: external_exports.string(),
+  active: external_exports.boolean(),
+  assortmentSystemInstanceId: external_exports.string().nullish(),
+  defaultCatalogId: external_exports.number().nullish()
+});
 function createCompanyFeaturesApi(client, companyType) {
   function getSearchParams() {
     return companyType && { companyType };
@@ -368,12 +381,17 @@ function createCompanyFeaturesApi(client, companyType) {
     }).json();
     return external_exports.boolean().parse(data);
   }
+  async function getFeaturesForCompany(companyId, signal) {
+    const data = await client.get(`${BASE_URL10}/company/${companyId}`, { signal }).json();
+    return external_exports.array(companyFeatureSchema).parse(data);
+  }
   async function enableFeatureForCompany(featureKey, companyId) {
     await client.put(`${BASE_URL10}/${featureKey}/company/${companyId}/enable`);
   }
   return {
     checkIfStageItemSetupIsEnabled,
-    enableFeatureForCompany
+    enableFeatureForCompany,
+    getFeaturesForCompany
   };
 }
 
@@ -701,6 +719,7 @@ export {
   BASE_URL9,
   createWhoAmIApi,
   BASE_URL10,
+  companyFeatureSchema,
   createCompanyFeaturesApi,
   BASE_URL11,
   createFeatureFlagsApi,

package/dist/index.cjs

@@ -4845,6 +4845,19 @@ function createWhoAmIApi(client) {
 
 // lib/companyFeatures/index.ts
 var BASE_URL10 = "feature";
+var companyFeatureSchema = external_exports.object({
+  /**
+   * Validated as a string at runtime so that unknown feature types returned by the
+   * backend (e.g., after a backend-only deploy) never cause a ZodError.  The TypeScript
+   * type is narrowed to `FeatureType` so callers still get compile-time checking when
+   * comparing against known values.
+   */
+  type: external_exports.string(),
+  display: external_exports.string(),
+  active: external_exports.boolean(),
+  assortmentSystemInstanceId: external_exports.string().nullish(),
+  defaultCatalogId: external_exports.number().nullish()
+});
 function createCompanyFeaturesApi(client, companyType) {
   function getSearchParams() {
     return companyType && { companyType };
@@ -4856,12 +4869,17 @@ function createCompanyFeaturesApi(client, companyType) {
     }).json();
     return external_exports.boolean().parse(data);
   }
+  async function getFeaturesForCompany(companyId, signal) {
+    const data = await client.get(`${BASE_URL10}/company/${companyId}`, { signal }).json();
+    return external_exports.array(companyFeatureSchema).parse(data);
+  }
   async function enableFeatureForCompany(featureKey, companyId) {
     await client.put(`${BASE_URL10}/${featureKey}/company/${companyId}/enable`);
   }
   return {
     checkIfStageItemSetupIsEnabled,
-    enableFeatureForCompany
+    enableFeatureForCompany,
+    getFeaturesForCompany
   };
 }
 

package/dist/index.d.cts

@@ -330,8 +330,37 @@ type ApplicationType = z.infer<typeof applicationTypeSchema>;
  * match the backend enum values in the CompanyFeatures service. If this list
  * grows significantly, we should consider moving these to their own constants file or
  * generating them from the backend.
+ *
+ * Defined as a const tuple so that both the `FeatureType` union and the Zod schema
+ * share a single source of truth — adding a value here automatically widens both.
  */
-type FeatureType = "RETAILERAPI" | "DELTASUPDATEEXPORT" | "ASSORTMENTUIDASHBOARD" | "PHASEDITEMSETUP" | "PUBLICIMAGEACCESS" | "SINGLEHIERARCHYBYITEM" | "DELTAPRICEEXPORT";
+type FeatureType = "RETAILERAPI" | "DELTASUPDATEEXPORT" | "ASSORTMENTUIDASHBOARD" | "PHASEDITEMSETUP" | "PUBLICIMAGEACCESS" | "SINGLEHIERARCHYBYITEM" | "DELTAPRICEEXPORT" | "ASSORTMENTXREF";
+declare const companyFeatureSchema: z.ZodObject<{
+    /**
+     * Validated as a string at runtime so that unknown feature types returned by the
+     * backend (e.g., after a backend-only deploy) never cause a ZodError.  The TypeScript
+     * type is narrowed to `FeatureType` so callers still get compile-time checking when
+     * comparing against known values.
+     */
+    type: z.ZodString;
+    display: z.ZodString;
+    active: z.ZodBoolean;
+    assortmentSystemInstanceId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    defaultCatalogId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    active: boolean;
+    display: string;
+    assortmentSystemInstanceId?: string | null | undefined;
+    defaultCatalogId?: number | null | undefined;
+}, {
+    type: string;
+    active: boolean;
+    display: string;
+    assortmentSystemInstanceId?: string | null | undefined;
+    defaultCatalogId?: number | null | undefined;
+}>;
+type CompanyFeature = z.infer<typeof companyFeatureSchema>;
 /**
  * Initialize Company Features Api functions
  * @param client Assortment Client instance
@@ -341,6 +370,7 @@ type FeatureType = "RETAILERAPI" | "DELTASUPDATEEXPORT" | "ASSORTMENTUIDASHBOARD
 declare function createCompanyFeaturesApi(client: AsstClient, companyType?: CompanyType): {
     checkIfStageItemSetupIsEnabled: (signal?: AbortSignal) => Promise<boolean>;
     enableFeatureForCompany: (featureKey: FeatureType, companyId: number) => Promise<void>;
+    getFeaturesForCompany: (companyId: number, signal?: AbortSignal) => Promise<CompanyFeature[]>;
 };
 
 interface FlagOptions {
@@ -961,4 +991,4 @@ declare function createRulesManagementApi(client: AsstClient): {
     activateRule: (ruleId: string, request: ActivateRuleRequestDto, signal?: AbortSignal) => Promise<void>;
 };
 
-export { type ActivateRuleRequestDto, type ApplicationType, AsstClient, AttrProdType, type CatalogBriefResponse, type CatalogCreateRequest, type CatalogCreateResponse, type CatalogSearchParams, type CategoriesApi, Company, CompanyBriefByOrg, type CompanyRelationship, CompanyRelationshipUpsertBody, CompanySearch, CompanySearchParams, CompanyType, DownLoadItemsParams, Export, type FeatureType, type FlagOptions, type FlattenedItemIdentifiers, GenerateImportTemplateParams, type GetItemErrorSummaryParams, Import, ImportsStatus, ItemCategoriesSearch, ItemDetail, ItemDetailView, ItemErrorDetailsResult, ItemErrorDetailsResultV2, ItemErrorSummaryResultV2, ItemHierarchyResponse, type ItemOrgStageDetails, type ItemOrgStatus, ItemPartner, ItemSearchView, type ItemStatus, type ItemStatusResponse, type ItemStatusV2, type ItemStatusV2Response, type ItemsApi, Locale, type OrgSummary, type RetailerTradingPartnerStages, SpreadsheetTemplate, SpsItemIdResponse, type Stage, TradingPartnerAccessByCompanyId, type UniqueCriteriaOptions, UserAccount, VendorPartnerAttGroups, createCategoriesApi, createCompaniesApi, createCompanyFeaturesApi, createErrorsApi, createErrorsApiV2, createExportsApi, createFeatureFlagsApi, createImportsApi, createItemsApi, createItemsApiV2, createLocaleApi, createProductTypesApi, createRulesManagementApi, createSpreadsheetTemplateApi, createTradingPartnerAccessApi, createTradingPartnerSettingsApi, createUniqueCriteriaApi, createWhoAmIApi };
+export { type ActivateRuleRequestDto, type ApplicationType, AsstClient, AttrProdType, type CatalogBriefResponse, type CatalogCreateRequest, type CatalogCreateResponse, type CatalogSearchParams, type CategoriesApi, Company, CompanyBriefByOrg, type CompanyFeature, type CompanyRelationship, CompanyRelationshipUpsertBody, CompanySearch, CompanySearchParams, CompanyType, DownLoadItemsParams, Export, type FeatureType, type FlagOptions, type FlattenedItemIdentifiers, GenerateImportTemplateParams, type GetItemErrorSummaryParams, Import, ImportsStatus, ItemCategoriesSearch, ItemDetail, ItemDetailView, ItemErrorDetailsResult, ItemErrorDetailsResultV2, ItemErrorSummaryResultV2, ItemHierarchyResponse, type ItemOrgStageDetails, type ItemOrgStatus, ItemPartner, ItemSearchView, type ItemStatus, type ItemStatusResponse, type ItemStatusV2, type ItemStatusV2Response, type ItemsApi, Locale, type OrgSummary, type RetailerTradingPartnerStages, SpreadsheetTemplate, SpsItemIdResponse, type Stage, TradingPartnerAccessByCompanyId, type UniqueCriteriaOptions, UserAccount, VendorPartnerAttGroups, createCategoriesApi, createCompaniesApi, createCompanyFeaturesApi, createErrorsApi, createErrorsApiV2, createExportsApi, createFeatureFlagsApi, createImportsApi, createItemsApi, createItemsApiV2, createLocaleApi, createProductTypesApi, createRulesManagementApi, createSpreadsheetTemplateApi, createTradingPartnerAccessApi, createTradingPartnerSettingsApi, createUniqueCriteriaApi, createWhoAmIApi };

package/dist/index.d.ts

@@ -330,8 +330,37 @@ type ApplicationType = z.infer<typeof applicationTypeSchema>;
  * match the backend enum values in the CompanyFeatures service. If this list
  * grows significantly, we should consider moving these to their own constants file or
  * generating them from the backend.
+ *
+ * Defined as a const tuple so that both the `FeatureType` union and the Zod schema
+ * share a single source of truth — adding a value here automatically widens both.
  */
-type FeatureType = "RETAILERAPI" | "DELTASUPDATEEXPORT" | "ASSORTMENTUIDASHBOARD" | "PHASEDITEMSETUP" | "PUBLICIMAGEACCESS" | "SINGLEHIERARCHYBYITEM" | "DELTAPRICEEXPORT";
+type FeatureType = "RETAILERAPI" | "DELTASUPDATEEXPORT" | "ASSORTMENTUIDASHBOARD" | "PHASEDITEMSETUP" | "PUBLICIMAGEACCESS" | "SINGLEHIERARCHYBYITEM" | "DELTAPRICEEXPORT" | "ASSORTMENTXREF";
+declare const companyFeatureSchema: z.ZodObject<{
+    /**
+     * Validated as a string at runtime so that unknown feature types returned by the
+     * backend (e.g., after a backend-only deploy) never cause a ZodError.  The TypeScript
+     * type is narrowed to `FeatureType` so callers still get compile-time checking when
+     * comparing against known values.
+     */
+    type: z.ZodString;
+    display: z.ZodString;
+    active: z.ZodBoolean;
+    assortmentSystemInstanceId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    defaultCatalogId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    active: boolean;
+    display: string;
+    assortmentSystemInstanceId?: string | null | undefined;
+    defaultCatalogId?: number | null | undefined;
+}, {
+    type: string;
+    active: boolean;
+    display: string;
+    assortmentSystemInstanceId?: string | null | undefined;
+    defaultCatalogId?: number | null | undefined;
+}>;
+type CompanyFeature = z.infer<typeof companyFeatureSchema>;
 /**
  * Initialize Company Features Api functions
  * @param client Assortment Client instance
@@ -341,6 +370,7 @@ type FeatureType = "RETAILERAPI" | "DELTASUPDATEEXPORT" | "ASSORTMENTUIDASHBOARD
 declare function createCompanyFeaturesApi(client: AsstClient, companyType?: CompanyType): {
     checkIfStageItemSetupIsEnabled: (signal?: AbortSignal) => Promise<boolean>;
     enableFeatureForCompany: (featureKey: FeatureType, companyId: number) => Promise<void>;
+    getFeaturesForCompany: (companyId: number, signal?: AbortSignal) => Promise<CompanyFeature[]>;
 };
 
 interface FlagOptions {
@@ -961,4 +991,4 @@ declare function createRulesManagementApi(client: AsstClient): {
     activateRule: (ruleId: string, request: ActivateRuleRequestDto, signal?: AbortSignal) => Promise<void>;
 };
 
-export { type ActivateRuleRequestDto, type ApplicationType, AsstClient, AttrProdType, type CatalogBriefResponse, type CatalogCreateRequest, type CatalogCreateResponse, type CatalogSearchParams, type CategoriesApi, Company, CompanyBriefByOrg, type CompanyRelationship, CompanyRelationshipUpsertBody, CompanySearch, CompanySearchParams, CompanyType, DownLoadItemsParams, Export, type FeatureType, type FlagOptions, type FlattenedItemIdentifiers, GenerateImportTemplateParams, type GetItemErrorSummaryParams, Import, ImportsStatus, ItemCategoriesSearch, ItemDetail, ItemDetailView, ItemErrorDetailsResult, ItemErrorDetailsResultV2, ItemErrorSummaryResultV2, ItemHierarchyResponse, type ItemOrgStageDetails, type ItemOrgStatus, ItemPartner, ItemSearchView, type ItemStatus, type ItemStatusResponse, type ItemStatusV2, type ItemStatusV2Response, type ItemsApi, Locale, type OrgSummary, type RetailerTradingPartnerStages, SpreadsheetTemplate, SpsItemIdResponse, type Stage, TradingPartnerAccessByCompanyId, type UniqueCriteriaOptions, UserAccount, VendorPartnerAttGroups, createCategoriesApi, createCompaniesApi, createCompanyFeaturesApi, createErrorsApi, createErrorsApiV2, createExportsApi, createFeatureFlagsApi, createImportsApi, createItemsApi, createItemsApiV2, createLocaleApi, createProductTypesApi, createRulesManagementApi, createSpreadsheetTemplateApi, createTradingPartnerAccessApi, createTradingPartnerSettingsApi, createUniqueCriteriaApi, createWhoAmIApi };
+export { type ActivateRuleRequestDto, type ApplicationType, AsstClient, AttrProdType, type CatalogBriefResponse, type CatalogCreateRequest, type CatalogCreateResponse, type CatalogSearchParams, type CategoriesApi, Company, CompanyBriefByOrg, type CompanyFeature, type CompanyRelationship, CompanyRelationshipUpsertBody, CompanySearch, CompanySearchParams, CompanyType, DownLoadItemsParams, Export, type FeatureType, type FlagOptions, type FlattenedItemIdentifiers, GenerateImportTemplateParams, type GetItemErrorSummaryParams, Import, ImportsStatus, ItemCategoriesSearch, ItemDetail, ItemDetailView, ItemErrorDetailsResult, ItemErrorDetailsResultV2, ItemErrorSummaryResultV2, ItemHierarchyResponse, type ItemOrgStageDetails, type ItemOrgStatus, ItemPartner, ItemSearchView, type ItemStatus, type ItemStatusResponse, type ItemStatusV2, type ItemStatusV2Response, type ItemsApi, Locale, type OrgSummary, type RetailerTradingPartnerStages, SpreadsheetTemplate, SpsItemIdResponse, type Stage, TradingPartnerAccessByCompanyId, type UniqueCriteriaOptions, UserAccount, VendorPartnerAttGroups, createCategoriesApi, createCompaniesApi, createCompanyFeaturesApi, createErrorsApi, createErrorsApiV2, createExportsApi, createFeatureFlagsApi, createImportsApi, createItemsApi, createItemsApiV2, createLocaleApi, createProductTypesApi, createRulesManagementApi, createSpreadsheetTemplateApi, createTradingPartnerAccessApi, createTradingPartnerSettingsApi, createUniqueCriteriaApi, createWhoAmIApi };

package/dist/index.js

@@ -17,7 +17,7 @@ import {
   createTradingPartnerSettingsApi,
   createUniqueCriteriaApi,
   createWhoAmIApi
-} from "./chunk-ZC44MAMI.js";
+} from "./chunk-35CHQUKC.js";
 import {
   AsstClient,
   BASE_URLS,

package/dist/msw.cjs

@@ -5352,6 +5352,19 @@ var import_msw13 = require("msw");
 
 // lib/companyFeatures/index.ts
 var BASE_URL13 = "feature";
+var companyFeatureSchema = external_exports.object({
+  /**
+   * Validated as a string at runtime so that unknown feature types returned by the
+   * backend (e.g., after a backend-only deploy) never cause a ZodError.  The TypeScript
+   * type is narrowed to `FeatureType` so callers still get compile-time checking when
+   * comparing against known values.
+   */
+  type: external_exports.string(),
+  display: external_exports.string(),
+  active: external_exports.boolean(),
+  assortmentSystemInstanceId: external_exports.string().nullish(),
+  defaultCatalogId: external_exports.number().nullish()
+});
 
 // lib/companyFeatures/mockHandlers.ts
 function createCompanyFeaturesApiHandlers(client) {
@@ -5361,8 +5374,15 @@ function createCompanyFeaturesApiHandlers(client) {
   }) {
     return import_msw13.http.get(`${client.getBaseUrl()}${BASE_URL13}/isphaseditemsetupenabled`, resolver);
   }
+  function getFeaturesForCompany(resolver = (_info) => {
+    const data = (0, import_zod_mock12.generateMock)(external_exports.array(companyFeatureSchema));
+    return import_msw13.HttpResponse.json(data);
+  }) {
+    return import_msw13.http.get(`${client.getBaseUrl()}${BASE_URL13}/company/:companyId`, resolver);
+  }
   return {
-    checkIfStageItemSetupIsEnabled
+    checkIfStageItemSetupIsEnabled,
+    getFeaturesForCompany
   };
 }
 

package/dist/msw.d.cts

@@ -634,6 +634,7 @@ declare function createSpreadsheetTemplateApiHandlers(client: AsstClient): {
  */
 declare function createCompanyFeaturesApiHandlers(client: AsstClient): {
     checkIfStageItemSetupIsEnabled: (resolver?: ResponseResolver) => msw.HttpHandler;
+    getFeaturesForCompany: (resolver?: ResponseResolver) => msw.HttpHandler;
 };
 
 /**

package/dist/msw.d.ts

@@ -634,6 +634,7 @@ declare function createSpreadsheetTemplateApiHandlers(client: AsstClient): {
  */
 declare function createCompanyFeaturesApiHandlers(client: AsstClient): {
     checkIfStageItemSetupIsEnabled: (resolver?: ResponseResolver) => msw.HttpHandler;
+    getFeaturesForCompany: (resolver?: ResponseResolver) => msw.HttpHandler;
 };
 
 /**

package/dist/msw.js

@@ -19,8 +19,9 @@ import {
   BASE_URL9,
   BASE_URL_V2,
   FlattenedItemIdentifierKeysSchema,
+  companyFeatureSchema,
   retailerTradingPartnerStages
-} from "./chunk-ZC44MAMI.js";
+} from "./chunk-35CHQUKC.js";
 import {
   attrProdTypeSchema,
   catalogBriefResponseSchema,
@@ -458,8 +459,15 @@ function createCompanyFeaturesApiHandlers(client) {
   }) {
     return http13.get(`${client.getBaseUrl()}${BASE_URL10}/isphaseditemsetupenabled`, resolver);
   }
+  function getFeaturesForCompany(resolver = (_info) => {
+    const data = generateMock12(external_exports.array(companyFeatureSchema));
+    return HttpResponse13.json(data);
+  }) {
+    return http13.get(`${client.getBaseUrl()}${BASE_URL10}/company/:companyId`, resolver);
+  }
   return {
-    checkIfStageItemSetupIsEnabled
+    checkIfStageItemSetupIsEnabled,
+    getFeaturesForCompany
   };
 }
 

package/package.json

@@ -3,7 +3,7 @@
   "description": "Assortment Api is a collection of HTTP functions to use Assortment endpoints",
   "author": "Assortment",
   "repository": "https://github.com/SPSCommerce/assortment-main/tree/main/ui/packages/asst-api",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "files": [
     "dist"
   ],