@spscommerce/asst-api 4.6.0 → 4.8.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.
package/dist/msw.cjs CHANGED
@@ -32,6 +32,7 @@ __export(msw_exports, {
32
32
  createItemsApiV2Handlers: () => createItemsApiV2Handlers,
33
33
  createLocaleApiHandlers: () => createLocaleApiHandlers,
34
34
  createProductTypesApiHandlers: () => createProductTypesApiHandlers,
35
+ createRulesManagementApiHandlers: () => createRulesManagementApiHandlers,
35
36
  createSpreadsheetTemplateApiHandlers: () => createSpreadsheetTemplateApiHandlers,
36
37
  createTradingPartnerAccessApiHandlers: () => createTradingPartnerAccessApiHandlers,
37
38
  createTradingPartnerSettingsApiHandlers: () => createTradingPartnerSettingsApiHandlers,
@@ -5511,6 +5512,88 @@ var companyBriefByOrgSchema = external_exports.object({
5511
5512
  dc4Id: external_exports.number()
5512
5513
  });
5513
5514
 
5515
+ // lib/companies/models/CompanyRelationship.ts
5516
+ var applicationSchema = external_exports.object({
5517
+ application: applicationTypeSchema,
5518
+ relationshipApplicationId: external_exports.number()
5519
+ });
5520
+ var catalogSchema = external_exports.object({
5521
+ active: external_exports.boolean(),
5522
+ catalogId: external_exports.number(),
5523
+ itemPartnerId: external_exports.number()
5524
+ });
5525
+ var relationshipCompanySchema = external_exports.object({
5526
+ companyId: external_exports.number(),
5527
+ companyTypes: external_exports.array(companyTypeSchema),
5528
+ dc4Id: external_exports.number().nullable(),
5529
+ name: external_exports.string(),
5530
+ orgId: external_exports.string()
5531
+ });
5532
+ var relationshipSchema = external_exports.object({
5533
+ active: external_exports.boolean(),
5534
+ application: external_exports.array(applicationSchema),
5535
+ catalog: external_exports.array(catalogSchema),
5536
+ company: relationshipCompanySchema,
5537
+ createdAt: external_exports.number(),
5538
+ modifiedAt: external_exports.number().nullable(),
5539
+ relationshipId: external_exports.number()
5540
+ });
5541
+
5542
+ // lib/companies/models/Company.ts
5543
+ var featureResponseSchema = external_exports.object({
5544
+ active: external_exports.boolean(),
5545
+ createdBy: external_exports.string().nullable(),
5546
+ createdDate: external_exports.number().nullable(),
5547
+ display: external_exports.string(),
5548
+ modifiedBy: external_exports.string().nullable(),
5549
+ modifiedDate: external_exports.number().nullable(),
5550
+ type: external_exports.string()
5551
+ });
5552
+ var identitySchema = external_exports.object({
5553
+ orgId: external_exports.string().nullable(),
5554
+ service: external_exports.object({
5555
+ name: external_exports.string()
5556
+ }).nullable()
5557
+ });
5558
+ var companySchema = external_exports.object({
5559
+ active: external_exports.boolean(),
5560
+ companyId: external_exports.number(),
5561
+ companyTypes: external_exports.array(companyTypeSchema),
5562
+ createdAt: external_exports.number().nullable(),
5563
+ features: external_exports.array(featureResponseSchema),
5564
+ identity: identitySchema,
5565
+ modifiedAt: external_exports.number().nullable(),
5566
+ name: external_exports.string(),
5567
+ relationships: external_exports.array(relationshipSchema),
5568
+ uniqueAttributes: external_exports.array(external_exports.string())
5569
+ });
5570
+
5571
+ // lib/companies/models/CompanySearch.ts
5572
+ var companySearchParamsSchema = external_exports.object({
5573
+ name: external_exports.string().min(2).max(100).optional(),
5574
+ companyIds: external_exports.string().min(2).optional(),
5575
+ orgId: external_exports.string().min(2).optional(),
5576
+ catalogName: external_exports.string().min(2).max(100).optional(),
5577
+ catalogIds: external_exports.string().min(2).optional(),
5578
+ type: companyTypeSchema.optional()
5579
+ });
5580
+ var companyCatalogSchema = external_exports.object({
5581
+ categoryId: external_exports.number(),
5582
+ categoryName: external_exports.string()
5583
+ });
5584
+ var companySearchSchema = external_exports.object({
5585
+ id: external_exports.string(),
5586
+ organizationName: external_exports.string(),
5587
+ description: external_exports.string(),
5588
+ orgId: external_exports.string().optional(),
5589
+ roles: external_exports.array(companyTypeSchema),
5590
+ connections: external_exports.number(),
5591
+ uniqueCriteria: external_exports.array(external_exports.string()).optional(),
5592
+ serviceName: external_exports.string(),
5593
+ catalogs: external_exports.array(companyCatalogSchema),
5594
+ application: external_exports.array(applicationTypeSchema).optional()
5595
+ });
5596
+
5514
5597
  // lib/companies/index.ts
5515
5598
  var BASE_URL16 = "v3/companys";
5516
5599
 
@@ -5523,8 +5606,27 @@ function createCompaniesApiHandlers(client) {
5523
5606
  return import_msw16.http.get(`${client.getBaseUrl()}${BASE_URL16}/brief`, resolver);
5524
5607
  }
5525
5608
  getCompanyBriefInfoByOrg.generateData = () => (0, import_zod_mock15.generateMock)(companyBriefByOrgSchema);
5609
+ function companySearch(resolver = (_info) => {
5610
+ const data = Array.from(
5611
+ { length: 3 },
5612
+ () => (0, import_zod_mock15.generateMock)(companySearchSchema)
5613
+ );
5614
+ return import_msw16.HttpResponse.json(data);
5615
+ }) {
5616
+ return import_msw16.http.get(`${client.getBaseUrl()}${BASE_URL16}/search`, resolver);
5617
+ }
5618
+ companySearch.generateData = () => Array.from({ length: 3 }, () => (0, import_zod_mock15.generateMock)(companySearchSchema));
5619
+ function getCompanyById(resolver = (_info) => {
5620
+ const data = (0, import_zod_mock15.generateMock)(companySchema);
5621
+ return import_msw16.HttpResponse.json(data);
5622
+ }) {
5623
+ return import_msw16.http.get(`${client.getBaseUrl()}${BASE_URL16}/:companyId`, resolver);
5624
+ }
5625
+ getCompanyById.generateData = () => (0, import_zod_mock15.generateMock)(companySchema);
5526
5626
  return {
5527
- getCompanyBriefInfoByOrg
5627
+ getCompanyBriefInfoByOrg,
5628
+ companySearch,
5629
+ getCompanyById
5528
5630
  };
5529
5631
  }
5530
5632
 
@@ -5548,6 +5650,27 @@ function createItemsApiV2Handlers(client) {
5548
5650
  getItemStatus
5549
5651
  };
5550
5652
  }
5653
+
5654
+ // lib/rulesManagement/mockHandlers.ts
5655
+ var import_msw18 = require("msw");
5656
+
5657
+ // lib/rulesManagement/index.ts
5658
+ var BASE_URL18 = "rules";
5659
+
5660
+ // lib/rulesManagement/mockHandlers.ts
5661
+ function createRulesManagementApiHandlers(client) {
5662
+ function activateRule(resolver = () => {
5663
+ return import_msw18.HttpResponse.json({}, { status: 200 });
5664
+ }) {
5665
+ return import_msw18.http.post(
5666
+ `${client.getBaseUrl()}${BASE_URL18}/:ruleId/activate`,
5667
+ resolver
5668
+ );
5669
+ }
5670
+ return {
5671
+ activateRule
5672
+ };
5673
+ }
5551
5674
  // Annotate the CommonJS export names for ESM import in node:
5552
5675
  0 && (module.exports = {
5553
5676
  createCategoriesApiHandlers,
@@ -5562,6 +5685,7 @@ function createItemsApiV2Handlers(client) {
5562
5685
  createItemsApiV2Handlers,
5563
5686
  createLocaleApiHandlers,
5564
5687
  createProductTypesApiHandlers,
5688
+ createRulesManagementApiHandlers,
5565
5689
  createSpreadsheetTemplateApiHandlers,
5566
5690
  createTradingPartnerAccessApiHandlers,
5567
5691
  createTradingPartnerSettingsApiHandlers,
package/dist/msw.d.cts CHANGED
@@ -1,7 +1,8 @@
1
1
  import * as msw from 'msw';
2
2
  import { ResponseResolver, HttpResponseResolver, HttpHandler } from 'msw';
3
- import { A as AsstClient, I as ItemHierarchyResponse, S as SpsItemIdResponse, C as CompanyBriefByOrg } from './SpsItemIdResponse-gAHfCzwP.cjs';
3
+ import { A as AsstClient, I as ItemHierarchyResponse, S as SpsItemIdResponse, C as CompanyBriefByOrg } from './SpsItemIdResponse-BEq6yqtR.cjs';
4
4
  import { z } from 'zod';
5
+ import { C as CompanySearch, a as Company } from './CompanySearch-T6HJx4a6.cjs';
5
6
  import 'ky';
6
7
 
7
8
  /**
@@ -31,9 +32,9 @@ declare function createImportsApiHandlers(client: AsstClient): {
31
32
  count: number;
32
33
  imports: {
33
34
  status: string;
35
+ name: string;
34
36
  errorCount: number;
35
37
  importId: number;
36
- name: string;
37
38
  uploadedAt: string;
38
39
  completedAt?: number | null | undefined;
39
40
  startedAt?: string | null | undefined;
@@ -45,9 +46,9 @@ declare function createImportsApiHandlers(client: AsstClient): {
45
46
  generateData(): {
46
47
  status: "QUEUED_FOR_IMPORT" | "IN_PROGRESS" | "DOC_FAILED" | "VALIDATION_FAILED" | "COMPLETED";
47
48
  importId: number;
49
+ name?: string | null | undefined;
48
50
  completedAt?: string | null | undefined;
49
51
  errorCount?: number | null | undefined;
50
- name?: string | null | undefined;
51
52
  docInEventId?: string | null | undefined;
52
53
  invalidItemCount?: number | null | undefined;
53
54
  totalItemCount?: number | null | undefined;
@@ -78,14 +79,14 @@ declare function createCategoriesApiHandlers(client: AsstClient): {
78
79
  count: number;
79
80
  data: {
80
81
  type: "CATALOG" | "SELECTION_CODE" | "PRODUCT_CODE" | "EXPORT";
81
- name: string;
82
82
  companyId: number;
83
+ name: string;
83
84
  categoryid: number;
84
85
  encodedCategoryId: string;
85
86
  isActive: number;
86
87
  typeId: number;
87
- description?: string | null | undefined;
88
88
  createdDate?: number | null | undefined;
89
+ description?: string | null | undefined;
89
90
  categorytimestamp?: number | null | undefined;
90
91
  categorykey?: string | null | undefined;
91
92
  categoryCatalogName?: string | null | undefined;
@@ -105,16 +106,16 @@ declare function createCategoriesApiHandlers(client: AsstClient): {
105
106
  searchCatalogsByCompany: {
106
107
  (resolver?: ResponseResolver): msw.HttpHandler;
107
108
  generateData(): {
109
+ createdAt: string;
110
+ modifiedAt: string;
111
+ createdBy: string;
112
+ modifiedBy: string;
108
113
  categoryId: number;
109
114
  categoryName: string;
110
115
  categoryDescription: string;
111
116
  categoryDescriptionExt: string;
112
117
  ownerCompanyId: string;
113
118
  categoryTypeId: number;
114
- createdAt: string;
115
- modifiedAt: string;
116
- createdBy: string;
117
- modifiedBy: string;
118
119
  }[];
119
120
  };
120
121
  };
@@ -142,9 +143,9 @@ declare function createProductTypesApiHandlers(client: AsstClient): {
142
143
  next: string;
143
144
  previous: string;
144
145
  results: {
145
- description: string;
146
- createdDate: number;
147
146
  createdBy: string;
147
+ createdDate: number;
148
+ description: string;
148
149
  attrProdTypeId: number;
149
150
  productType: string;
150
151
  modifiedBy?: string | undefined;
@@ -164,11 +165,7 @@ declare function createTradingPartnerAccessApiHandlers(client: AsstClient): {
164
165
  getAllTradingPartners: {
165
166
  (resolver?: ResponseResolver): msw.HttpHandler;
166
167
  generateData(): {
167
- count: number;
168
168
  companyId: number;
169
- companyType: string;
170
- identityOrgId: string;
171
- companyName: string;
172
169
  connections: {
173
170
  catalog_id: number;
174
171
  catalog_name: string | null;
@@ -176,18 +173,22 @@ declare function createTradingPartnerAccessApiHandlers(client: AsstClient): {
176
173
  partner_company_id: number;
177
174
  partner_org_id: string;
178
175
  }[];
176
+ count: number;
177
+ companyType: string;
178
+ identityOrgId: string;
179
+ companyName: string;
179
180
  };
180
181
  };
181
182
  upsertRelationship: {
182
183
  (resolver?: ResponseResolver): msw.HttpHandler;
183
184
  generateData(): {
184
- isActive: number;
185
- createdDate: string;
186
185
  catalogId: number;
186
+ itemPartnerId: number;
187
+ createdDate: string;
187
188
  modifiedDate: string;
189
+ isActive: number;
188
190
  retailerId: number;
189
191
  supplierId: number;
190
- itemPartnerId: number;
191
192
  applications: ("ASSORTMENT" | "ITEM-XREF" | "TEST-ORDER-GENERATOR")[];
192
193
  };
193
194
  };
@@ -215,8 +216,9 @@ declare function createWhoAmIApiHandlers(client: AsstClient): {
215
216
  whoAmI: {
216
217
  (resolver?: ResponseResolver): msw.HttpHandler;
217
218
  generateData(): {
218
- name: string;
219
219
  companyId: number;
220
+ name: string;
221
+ uniqueAttributes: string[];
220
222
  companyName: string;
221
223
  identityUser: {
222
224
  name: string;
@@ -277,7 +279,6 @@ declare function createWhoAmIApiHandlers(client: AsstClient): {
277
279
  serviceId: number;
278
280
  identityServiceId: number;
279
281
  };
280
- uniqueAttributes: string[];
281
282
  admin: boolean;
282
283
  adminToolUser: boolean;
283
284
  attributeRegistryAdmin: boolean;
@@ -460,22 +461,22 @@ declare function createItemsApiHandlers(client: AsstClient): {
460
461
  type: "CATALOG" | "SELECTION_CODE" | "PRODUCT_CODE" | "EXPORT" | "ALIAS" | "LEGACY_PRODUCT_TYPE" | "PRODUCT_CLASSIFICATION" | "TAG" | "TAXONOMY_ROOT";
461
462
  name: string;
462
463
  id: number;
463
- description?: string | null | undefined;
464
464
  companyId?: number | null | undefined;
465
+ description?: string | null | undefined;
465
466
  }[];
466
467
  selectionCodes: {
467
468
  type: "CATALOG" | "SELECTION_CODE" | "PRODUCT_CODE" | "EXPORT" | "ALIAS" | "LEGACY_PRODUCT_TYPE" | "PRODUCT_CLASSIFICATION" | "TAG" | "TAXONOMY_ROOT";
468
469
  name: string;
469
470
  id: number;
470
- description?: string | null | undefined;
471
471
  companyId?: number | null | undefined;
472
+ description?: string | null | undefined;
472
473
  }[];
473
474
  productCodes: {
474
475
  type: "CATALOG" | "SELECTION_CODE" | "PRODUCT_CODE" | "EXPORT" | "ALIAS" | "LEGACY_PRODUCT_TYPE" | "PRODUCT_CLASSIFICATION" | "TAG" | "TAXONOMY_ROOT";
475
476
  name: string;
476
477
  id: number;
477
- description?: string | null | undefined;
478
478
  companyId?: number | null | undefined;
479
+ description?: string | null | undefined;
479
480
  }[];
480
481
  };
481
482
  groupedAttributes: {
@@ -542,22 +543,22 @@ declare function createItemsApiHandlers(client: AsstClient): {
542
543
  }[];
543
544
  childComponentDetails: {
544
545
  valid: boolean;
545
- itemInfoId: number;
546
- saleable: boolean;
547
546
  uniqueCriteria: {
548
547
  value: string;
549
548
  name: string;
550
549
  }[];
550
+ itemInfoId: number;
551
+ saleable: boolean;
551
552
  description?: string | null | undefined;
552
553
  }[];
553
554
  parentComponentDetails: {
554
555
  valid: boolean;
555
- itemInfoId: number;
556
- saleable: boolean;
557
556
  uniqueCriteria: {
558
557
  value: string;
559
558
  name: string;
560
559
  }[];
560
+ itemInfoId: number;
561
+ saleable: boolean;
561
562
  description?: string | null | undefined;
562
563
  }[];
563
564
  locales: string[];
@@ -684,13 +685,82 @@ declare function createCompaniesApiHandlers(client: AsstClient): {
684
685
  getCompanyBriefInfoByOrg: {
685
686
  (resolver?: HttpResponseResolver<never, never, CompanyBriefByOrg>): msw.HttpHandler;
686
687
  generateData(): {
687
- name: string;
688
688
  companyId: number;
689
+ name: string;
689
690
  orgId: string;
690
691
  companyTypes: ("SUPPLIER" | "RETAILER")[];
691
692
  dc4Id: number;
692
693
  };
693
694
  };
695
+ companySearch: {
696
+ (resolver?: HttpResponseResolver<never, never, CompanySearch[]>): msw.HttpHandler;
697
+ generateData(): {
698
+ id: string;
699
+ organizationName: string;
700
+ description: string;
701
+ roles: ("SUPPLIER" | "RETAILER")[];
702
+ connections: number;
703
+ serviceName: string;
704
+ catalogs: {
705
+ categoryId: number;
706
+ categoryName: string;
707
+ }[];
708
+ orgId?: string | undefined;
709
+ application?: ("ASSORTMENT" | "ITEM-XREF" | "TEST-ORDER-GENERATOR")[] | undefined;
710
+ uniqueCriteria?: string[] | undefined;
711
+ }[];
712
+ };
713
+ getCompanyById: {
714
+ (resolver?: HttpResponseResolver<{
715
+ companyId: string;
716
+ }, never, Company>): msw.HttpHandler;
717
+ generateData(): {
718
+ companyId: number;
719
+ name: string;
720
+ companyTypes: ("SUPPLIER" | "RETAILER")[];
721
+ active: boolean;
722
+ createdAt: number | null;
723
+ modifiedAt: number | null;
724
+ features: {
725
+ type: string;
726
+ active: boolean;
727
+ createdBy: string | null;
728
+ createdDate: number | null;
729
+ display: string;
730
+ modifiedBy: string | null;
731
+ modifiedDate: number | null;
732
+ }[];
733
+ identity: {
734
+ orgId: string | null;
735
+ service: {
736
+ name: string;
737
+ } | null;
738
+ };
739
+ relationships: {
740
+ application: {
741
+ application: "ASSORTMENT" | "ITEM-XREF" | "TEST-ORDER-GENERATOR";
742
+ relationshipApplicationId: number;
743
+ }[];
744
+ active: boolean;
745
+ catalog: {
746
+ active: boolean;
747
+ catalogId: number;
748
+ itemPartnerId: number;
749
+ }[];
750
+ company: {
751
+ companyId: number;
752
+ name: string;
753
+ orgId: string;
754
+ companyTypes: ("SUPPLIER" | "RETAILER")[];
755
+ dc4Id: number | null;
756
+ };
757
+ createdAt: number;
758
+ modifiedAt: number | null;
759
+ relationshipId: number;
760
+ }[];
761
+ uniqueAttributes: string[];
762
+ };
763
+ };
694
764
  };
695
765
 
696
766
  /**
@@ -723,4 +793,15 @@ declare function createItemsApiV2Handlers(client: AsstClient): {
723
793
  };
724
794
  };
725
795
 
726
- export { createCategoriesApiHandlers, createCompaniesApiHandlers, createCompanyFeaturesApiHandlers, createErrorsApiHandlers, createErrorsApiV2Handlers, createExportsApiHandlers, createFeatureFlagsApiHandlers, createImportsApiHandlers, createItemsApiHandlers, createItemsApiV2Handlers, createLocaleApiHandlers, createProductTypesApiHandlers, createSpreadsheetTemplateApiHandlers, createTradingPartnerAccessApiHandlers, createTradingPartnerSettingsApiHandlers, createUniqueCriteriaApiHandlers, createWhoAmIApiHandlers };
796
+ /**
797
+ * Generate collection of MSW request handlers for `RulesManagementApi`
798
+ * @param client Assortment Client instance
799
+ * @returns An object containing functions to generate MSW request handlers
800
+ */
801
+ declare function createRulesManagementApiHandlers(client: AsstClient): {
802
+ activateRule: (resolver?: HttpResponseResolver<{
803
+ ruleId: string;
804
+ }, never, Record<string, never>>) => msw.HttpHandler;
805
+ };
806
+
807
+ export { createCategoriesApiHandlers, createCompaniesApiHandlers, createCompanyFeaturesApiHandlers, createErrorsApiHandlers, createErrorsApiV2Handlers, createExportsApiHandlers, createFeatureFlagsApiHandlers, createImportsApiHandlers, createItemsApiHandlers, createItemsApiV2Handlers, createLocaleApiHandlers, createProductTypesApiHandlers, createRulesManagementApiHandlers, createSpreadsheetTemplateApiHandlers, createTradingPartnerAccessApiHandlers, createTradingPartnerSettingsApiHandlers, createUniqueCriteriaApiHandlers, createWhoAmIApiHandlers };