@spscommerce/asst-api 4.1.0 → 4.1.1

package/dist/chunk-KKX3CXHP.js

@@ -0,0 +1,558 @@
+import {
+  attrProdTypeSchema,
+  attributeDefinitionSchema,
+  attributeMetaDataSchema,
+  attributeValidValuesSchema,
+  attributesByCompanySchema,
+  companyBriefByOrgSchema,
+  importErrorsSchema,
+  importSchema,
+  importsStatusSchema,
+  itemCategoriesSearchSchema,
+  itemDetailViewSchema,
+  itemErrorDetailsResultSchema,
+  itemErrorDetailsResultV2Schema,
+  itemErrorSummaryResultV2Schema,
+  itemHierarchyResponseSchema,
+  itemSearchViewSchema,
+  itemStatusResponseSchema,
+  localeSchema,
+  spreadsheetTemplateSchema,
+  spsItemIdResponseSchema,
+  tradingPartnerAccessByCompanyIdSchema,
+  userAccountSchema,
+  vendorPartnerAttGroupsSchema,
+  z
+} from "./chunk-LYMA4XGG.js";
+
+// lib/imports/index.ts
+var BASE_URL = "imports";
+function createImportsApi(client) {
+  async function getImportErrors(importId, params, signal) {
+    const data = await client.get(`${BASE_URL}/${importId}/errors`, { searchParams: params, signal }).json();
+    return importErrorsSchema.parse(data);
+  }
+  async function getImports(params, signal) {
+    const data = await client.get(`${BASE_URL}`, {
+      searchParams: params,
+      signal
+    }).json();
+    return importSchema.parse(data);
+  }
+  async function getImportsStatus(signal) {
+    const data = await client.get(`${BASE_URL}/status`, { signal }).json();
+    return z.array(importsStatusSchema).parse(data);
+  }
+  async function uploadImport(file) {
+    await client.post(`${BASE_URL}`, { body: file });
+  }
+  async function getVendorPartnerGroups(signal) {
+    const data = await client.get(`${BASE_URL}/template/vendor-partner-groups`, { signal }).json();
+    return z.array(vendorPartnerAttGroupsSchema).parse(data);
+  }
+  async function generateImportTemplate(params) {
+    const response = await client.get(`${BASE_URL}/template/generate`, {
+      searchParams: params,
+      headers: {
+        Accept: "application/octet-stream"
+      },
+      timeout: false
+    });
+    const disposition = response.headers.get("content-disposition") || "";
+    const filename = disposition.match(/filename="(.+)"/)?.[1];
+    const downloadUrl = window.URL.createObjectURL(
+      new Blob([await response.blob()])
+    );
+    const link = document.createElement("a");
+    link.href = downloadUrl;
+    if (filename) {
+      link.download = filename;
+    }
+    document.body.appendChild(link);
+    link.click();
+    link.remove();
+  }
+  return {
+    getImportErrors,
+    getImports,
+    getImportsStatus,
+    uploadImport,
+    getVendorPartnerGroups,
+    generateImportTemplate
+  };
+}
+
+// lib/exports/index.ts
+var BASE_URL2 = "exports";
+var BASE_URL_V2 = "v2/exports";
+function createExportsApi(client) {
+  async function createExport(data, params) {
+    await client.post(`${BASE_URL_V2}/add`, {
+      json: data,
+      searchParams: params
+    });
+  }
+  async function downloadItems(params) {
+    const searchParams = { ...params, ids: params.ids.join(",") };
+    const response = await client.get(`${BASE_URL2}/spreadsheet/by-item`, {
+      searchParams,
+      headers: {
+        Accept: "application/octet-stream"
+      },
+      timeout: false
+    });
+    const disposition = response.headers.get("content-disposition") || "";
+    const filename = disposition.match(/filename="(.+)"/)?.[1];
+    const downloadUrl = window.URL.createObjectURL(
+      new Blob([await response.blob()])
+    );
+    const link = document.createElement("a");
+    link.href = downloadUrl;
+    if (filename) {
+      link.download = filename;
+    }
+    document.body.appendChild(link);
+    link.click();
+    link.remove();
+  }
+  return {
+    createExport,
+    downloadItems
+  };
+}
+
+// lib/productTypes/index.ts
+var BASE_URL3 = "product-types";
+function createProductTypesApi(client) {
+  async function getProductTypes(params, signal) {
+    const searchParams = params ? { retailerIds: params.retailerIds.join(",") } : void 0;
+    const data = await client.get(`${BASE_URL3}/all`, {
+      searchParams,
+      signal
+    }).json();
+    return z.array(attrProdTypeSchema).parse(data.results);
+  }
+  return {
+    getProductTypes
+  };
+}
+
+// lib/tradingPartners/index.ts
+var BASE_URL4 = "trading-partner-access";
+function createTradingPartnerAccessApi(client) {
+  async function getAllTradingPartners(params, signal) {
+    const data = await client.get(`${BASE_URL4}/connections`, {
+      searchParams: params,
+      signal
+    }).json();
+    return tradingPartnerAccessByCompanyIdSchema.parse(data);
+  }
+  async function upsertRelationship(data) {
+    return await client.post(`${BASE_URL4}/upsert-relationship`, { json: data }).json();
+  }
+  async function upsertHierarchy(data) {
+    await client.post(`${BASE_URL4}/upsert-hierarchy`, { json: data }).json();
+  }
+  return {
+    getAllTradingPartners,
+    upsertRelationship,
+    upsertHierarchy
+  };
+}
+
+// lib/tradingPartnerSettings/models/RetailerTradingPartnerStages.ts
+var retailerTradingPartnerStages = z.array(
+  z.enum([
+    "Core",
+    "Core Plus",
+    "Core Advanced",
+    "Enriched",
+    "Standard Requirements"
+  ])
+);
+
+// lib/tradingPartnerSettings/index.ts
+var BASE_URL5 = "trading-partner-settings";
+function createTradingPartnerSettingsApi(client) {
+  async function getRetailerStages(signal) {
+    const data = await client.get(`${BASE_URL5}/stages/retailer-configured`, {
+      signal
+    }).json();
+    return retailerTradingPartnerStages.parse(data);
+  }
+  return {
+    getRetailerStages
+  };
+}
+
+// lib/categories/index.ts
+var BASE_URL6 = "categories";
+function createCategoriesApi(client) {
+  async function getCatalogs(params, signal) {
+    const data = await client.get(`${BASE_URL6}/search-category`, {
+      searchParams: { ...params, type: "CATALOG" },
+      signal
+    }).json();
+    return itemCategoriesSearchSchema.parse(data);
+  }
+  async function getProductCodes(params, signal) {
+    const searchParams = { type: "PRODUCT_CODE" };
+    if (params?.categoryName) {
+      searchParams.categoryName = params.categoryName;
+    }
+    if (params?.catalogId) {
+      searchParams.catalogId = params.catalogId;
+    }
+    if (params?.selectionCodeId) {
+      searchParams.selectionCodeId = params.selectionCodeId;
+    }
+    if (params?.orgId) {
+      searchParams.orgId = params.orgId;
+    }
+    const data = await client.get(`${BASE_URL6}/search-category`, {
+      searchParams,
+      signal,
+      timeout: false
+    }).json();
+    return itemCategoriesSearchSchema.parse(data);
+  }
+  async function getSelectionCodes(params, signal) {
+    const searchParams = { type: "SELECTION_CODE" };
+    if (params?.categoryName) {
+      searchParams.categoryName = params.categoryName;
+    }
+    if (params?.catalogId) {
+      searchParams.catalogId = params.catalogId;
+    }
+    if (params?.orgId) {
+      searchParams.orgId = params.orgId;
+    }
+    const data = await client.get(`${BASE_URL6}/search-category`, {
+      searchParams,
+      signal
+    }).json();
+    return itemCategoriesSearchSchema.parse(data);
+  }
+  async function getItemHierarchy(itemIds) {
+    const data = await client.post(`${BASE_URL6}/item-hierarchy`, { json: { itemIds } }).json();
+    return itemHierarchyResponseSchema.parse(data);
+  }
+  return {
+    getCatalogs,
+    getProductCodes,
+    getSelectionCodes,
+    getItemHierarchy
+  };
+}
+
+// lib/attributes/index.ts
+var BASE_URL7 = "attributes";
+function createAttributesApi(client) {
+  async function getAllAttributes(signal) {
+    const data = await client.get(`${BASE_URL7}`, { signal }).json();
+    return z.array(attributeMetaDataSchema).parse(data);
+  }
+  async function getAllAttributesByCompany(params, signal) {
+    const data = await client.get(`${BASE_URL7}/company`, {
+      searchParams: params,
+      signal
+    }).json();
+    return attributesByCompanySchema.parse(data);
+  }
+  async function getAttributesExtensiveInfo(signal) {
+    const data = await client.get(`${BASE_URL7}/registry/editui`, { signal }).json();
+    return z.array(attributeDefinitionSchema).parse(data);
+  }
+  async function getAttributeValidValues(attributeDbName, signal) {
+    const data = await client.get(`${BASE_URL7}/registry/attribute/${attributeDbName}/values`, {
+      signal
+    }).json();
+    return z.array(attributeValidValuesSchema).parse(data);
+  }
+  async function getCompanyInterestedAttributes(params, signal) {
+    const data = await client.get(`${BASE_URL7}/company/interested-attributes`, {
+      searchParams: params,
+      signal
+    }).json();
+    return z.array(z.string()).parse(data);
+  }
+  return {
+    getAllAttributes,
+    getAllAttributesByCompany,
+    getAttributesExtensiveInfo,
+    getAttributeValidValues,
+    getCompanyInterestedAttributes
+  };
+}
+
+// lib/locale/index.ts
+var BASE_URL8 = "locale";
+function createLocaleApi(client) {
+  async function getLocale(signal) {
+    const data = await client.get(`${BASE_URL8}`, { signal }).json();
+    return z.array(localeSchema).parse(data);
+  }
+  return {
+    getLocale
+  };
+}
+
+// lib/spreadsheetTemplate/index.ts
+var BASE_URL9 = "templates";
+function createSpreadsheetTemplateApi(client) {
+  async function getTemplates(params, signal) {
+    const data = await client.get(`${BASE_URL9}`, { searchParams: params, signal }).json();
+    return z.array(spreadsheetTemplateSchema).parse(data);
+  }
+  return {
+    getTemplates
+  };
+}
+
+// lib/whoami/index.ts
+var BASE_URL10 = "whoami";
+function createWhoAmIApi(client) {
+  async function whoAmI(signal) {
+    const data = await client.get(`${BASE_URL10}`, { signal }).json();
+    return userAccountSchema.parse(data);
+  }
+  return {
+    whoAmI
+  };
+}
+
+// lib/companyFeatures/index.ts
+var BASE_URL11 = "feature";
+function createCompanyFeaturesApi(client) {
+  async function checkIfStageItemSetupIsEnabled(signal) {
+    const data = await client.get(`${BASE_URL11}/isphaseditemsetupenabled`, {
+      signal
+    }).json();
+    return z.boolean().parse(data);
+  }
+  return {
+    checkIfStageItemSetupIsEnabled
+  };
+}
+
+// lib/featureFlags/index.ts
+var BASE_URL12 = "feature-flag";
+function createFeatureFlagsApi(client) {
+  async function checkEnableItemsLevelMSIS(signal) {
+    const data = await client.get(`${BASE_URL12}/enable-item-level-msis/`, {
+      signal
+    }).json();
+    return z.boolean().parse(data);
+  }
+  async function checkIfEnabledForPackagingHierarchies(signal) {
+    const data = await client.get(`${BASE_URL12}/server-allow-import-and-export-of-packsizes-170720/`, {
+      signal
+    }).json();
+    return z.boolean().parse(data);
+  }
+  return {
+    checkEnableItemsLevelMSIS,
+    checkIfEnabledForPackagingHierarchies
+  };
+}
+
+// lib/items/v1/index.ts
+var BASE_URL13 = "items";
+function createItemsApi(client) {
+  function createQueryParameterString(params = {}) {
+    const searchParams = new URLSearchParams();
+    const { limit, offset, applicationType, url } = params ?? {};
+    if (limit) searchParams.append("limit", limit.toString());
+    if (offset) searchParams.append("offset", offset.toString());
+    if (applicationType) searchParams.append("application", applicationType);
+    const queryParameterString = searchParams.toString();
+    return url ? `${queryParameterString}&${url}` : queryParameterString;
+  }
+  async function searchItems(params, signal) {
+    const searchParams = createQueryParameterString(params);
+    const data = await client.get(`${BASE_URL13}`, { searchParams, signal }).json();
+    return itemSearchViewSchema.parse(data);
+  }
+  async function getItem(itemId, locale = "en-US", signal) {
+    const data = await client.get(`${BASE_URL13}/${itemId}`, { searchParams: { locale }, signal }).json();
+    return itemDetailViewSchema.parse(data);
+  }
+  async function updateItem(itemId, item) {
+    await client.put(`${BASE_URL13}/details/${itemId}`, { json: { ...item } }).json();
+  }
+  async function deleteItem(itemId) {
+    await client.delete(`${BASE_URL13}/${itemId}`);
+  }
+  async function deleteItems(itemIds) {
+    const params = new URLSearchParams();
+    itemIds.forEach((id) => {
+      params.append("items", id);
+    });
+    await client.delete(`${BASE_URL13}`, { searchParams: params });
+  }
+  async function getItemInfoId(spsItemId, signal) {
+    const data = await client.get(`${BASE_URL13}/${spsItemId}/itemInfoId`, { signal }).json();
+    return z.number().parse(data);
+  }
+  async function getSpsItemId(itemInfoId, signal) {
+    const data = await client.get(`${BASE_URL13}/${itemInfoId}/spsItemId`, { signal }).json();
+    return spsItemIdResponseSchema.parse(data);
+  }
+  async function getItemStatus(itemIds) {
+    const data = await client.post(`${BASE_URL13}/status`, { json: { itemIds } }).json();
+    return itemStatusResponseSchema.parse(data);
+  }
+  return {
+    searchItems,
+    getItem,
+    updateItem,
+    deleteItem,
+    deleteItems,
+    getItemInfoId,
+    getSpsItemId,
+    getItemStatus
+  };
+}
+
+// lib/errors/v1/index.ts
+var BASE_URL14 = "errors";
+function createErrorsApi(client) {
+  async function getInvalidItemErrorDetails(itemInfoId, signal) {
+    const data = await client.get(`${BASE_URL14}/items/${itemInfoId}`, {
+      signal
+    }).json();
+    return itemErrorDetailsResultSchema.parse(data);
+  }
+  return {
+    getInvalidItemErrorDetails
+  };
+}
+
+// lib/errors/v2/index.ts
+var BASE_URL15 = "errors/v2";
+function createErrorsApiV2(client) {
+  async function getItemErrorSummary(params, signal) {
+    const searchParams = new URLSearchParams();
+    if (params.searchField) searchParams.append("searchField", params.searchField);
+    if (params.searchText) searchParams.append("searchText", params.searchText);
+    if (params.tradingPartnerIds) {
+      params.tradingPartnerIds.forEach((id) => searchParams.append("tradingPartnerIds", id.toString()));
+    }
+    if (params.offset) searchParams.append("offset", params.offset.toString());
+    if (params.limit) searchParams.append("limit", params.limit.toString());
+    if (params.docInEventId) searchParams.append("docInEventId", params.docInEventId);
+    if (params.importId) searchParams.append("importId", params.importId);
+    const data = await client.get(`${BASE_URL15}/summary`, { signal, searchParams }).json();
+    return itemErrorSummaryResultV2Schema.parse(data);
+  }
+  async function getItemErrorDetails(itemInfoId, signal) {
+    const data = await client.get(`${BASE_URL15}/items/${itemInfoId}`, { signal }).json();
+    return itemErrorDetailsResultV2Schema.parse(data);
+  }
+  return {
+    getItemErrorSummary,
+    getItemErrorDetails
+  };
+}
+
+// lib/uniqueCriteria/models/FlattenedItemIdentifierKeysSchema.ts
+var FlattenedItemIdentifierKeys = [
+  //Nested gtin keys
+  "eaneight",
+  // Different naming convention from items-api's ean8
+  "upc",
+  "ean",
+  // Different naming convention from items-api's ean13
+  "gtin",
+  // Different naming convention from items-api's gtin14
+  "upcCaseCode",
+  //Top level keys
+  "buyerPartNumber",
+  "partnumber",
+  // Different naming convention from items-api's vendorPartNumber
+  "isbn",
+  "sku",
+  "nationalDrugCode",
+  "drugIdentificationNumber",
+  "nationalHealthRelatedItemCode",
+  "manufacturersPartNumber",
+  "internationalStandardSerialNumber",
+  "nabcaNumber",
+  "erpId",
+  "componentId"
+];
+var FlattenedItemIdentifierKeysSchema = z.enum(
+  FlattenedItemIdentifierKeys
+);
+
+// lib/uniqueCriteria/index.ts
+var BASE_URL16 = "uniquecriteria";
+function createUniqueCriteriaApi(client) {
+  async function getUniqueCriteriaByOrg(params, signal) {
+    const data = await client.get(`${BASE_URL16}/org`, {
+      searchParams: params,
+      signal
+    }).json();
+    return z.array(z.string()).parse(data);
+  }
+  async function getProductUniqueCriteriaByOrg(params, signal) {
+    const data = await client.get(`${BASE_URL16}/product/org`, {
+      searchParams: params,
+      signal
+    }).json();
+    return z.array(FlattenedItemIdentifierKeysSchema).parse(data);
+  }
+  return { getUniqueCriteriaByOrg, getProductUniqueCriteriaByOrg };
+}
+
+// lib/companies/index.ts
+var BASE_URL17 = "companys";
+function createCompaniesApi(client) {
+  async function getCompanyBriefInfoByOrg(params, signal) {
+    const data = await client.get(`${BASE_URL17}/brief`, {
+      searchParams: params,
+      signal
+    }).json();
+    return companyBriefByOrgSchema.parse(data);
+  }
+  return { getCompanyBriefInfoByOrg };
+}
+
+export {
+  BASE_URL,
+  createImportsApi,
+  BASE_URL2,
+  BASE_URL_V2,
+  createExportsApi,
+  BASE_URL3,
+  createProductTypesApi,
+  BASE_URL4,
+  createTradingPartnerAccessApi,
+  retailerTradingPartnerStages,
+  BASE_URL5,
+  createTradingPartnerSettingsApi,
+  BASE_URL6,
+  createCategoriesApi,
+  BASE_URL7,
+  createAttributesApi,
+  BASE_URL8,
+  createLocaleApi,
+  BASE_URL9,
+  createSpreadsheetTemplateApi,
+  BASE_URL10,
+  createWhoAmIApi,
+  BASE_URL11,
+  createCompanyFeaturesApi,
+  BASE_URL12,
+  createFeatureFlagsApi,
+  BASE_URL13,
+  createItemsApi,
+  BASE_URL14,
+  createErrorsApi,
+  BASE_URL15,
+  createErrorsApiV2,
+  FlattenedItemIdentifierKeysSchema,
+  BASE_URL16,
+  createUniqueCriteriaApi,
+  createCompaniesApi
+};

package/dist/chunk-LCK4AEWB.js

@@ -0,0 +1,79 @@
+import {
+  external_exports
+} from "./chunk-HHJDDPFR.js";
+
+// lib/asstClient.ts
+import ky from "ky";
+var baseUrlsSchema = external_exports.object({
+  local: external_exports.literal("https://localhost:8443/"),
+  test: external_exports.literal(
+    "https://integration.api.spscommerce.com/assortment/gateway/"
+  ),
+  prod: external_exports.literal("https://api.spscommerce.com/assortment/gateway/")
+});
+var BASE_URLS = {
+  local: "https://localhost:8443/",
+  test: "https://integration.api.spscommerce.com/assortment/gateway/",
+  prod: "https://api.spscommerce.com/assortment/gateway/"
+};
+var envSchema = baseUrlsSchema.keyof();
+var initialConfig = {
+  prefixUrl: BASE_URLS["test"],
+  retry: 0
+};
+var AsstClient = class {
+  #client = ky.create(initialConfig);
+  #baseUrl = BASE_URLS["test"];
+  #listeners = /* @__PURE__ */ new Set();
+  #currentConfig = initialConfig;
+  constructor(options) {
+    if (options) {
+      this.updateConfig(options);
+    }
+  }
+  updateConfig(options) {
+    this.#client = this.#client.extend(options);
+    this.#currentConfig = options;
+    if (options.prefixUrl) {
+      this.#baseUrl = options.prefixUrl;
+    }
+    this.#listeners.forEach((listener) => listener(options));
+  }
+  getBaseUrl() {
+    return this.#baseUrl;
+  }
+  /**
+   * Subscribe to config changes.  The callback will be immediately invoked with the current config.
+   * @param subscriptionCallback Function that will be called with the new config every time it is changed
+   * @returns Function to unsubscribe to config changes
+   */
+  subscribeToConfigChange(listener) {
+    this.#listeners.add(listener);
+    listener(this.#currentConfig);
+    return () => this.#listeners.delete(listener);
+  }
+  get(url, options) {
+    return this.#client.get(url, options);
+  }
+  post(url, options) {
+    return this.#client.post(url, options);
+  }
+  put(url, options) {
+    return this.#client.put(url, options);
+  }
+  patch(url, options) {
+    return this.#client.patch(url, options);
+  }
+  head(url, options) {
+    return this.#client.head(url, options);
+  }
+  delete(url, options) {
+    return this.#client.delete(url, options);
+  }
+};
+
+export {
+  BASE_URLS,
+  envSchema,
+  AsstClient
+};