Smoke Test SDK (@W-18482922@)

[joeluong-sfcc]

This PR smoke tests the new OAS SDK and adds small updates for any gaps found.

The CI is expected to fail in this PR and will be fixed in a follow up PR to prepare for the release of the SDK. This is because we need to pull in the latest versions of the APIs and I don't want to bloat this PR with all the API changes.

npm run test should pass after updating the APIs

Testing Instructions

1. git checkout ju/smoke-test
2. npm run ci
3. add ANYPOINT_USERNAME and ANYPOINT_PASSWORD to environment variables
4. npm run updateApis
5. npm run build
6. In a new directory, set up a small node project to test the SDK, npm init -y
7. in package.json dependencies, add the path to your local commerce-sdk project:

"commerce-sdk": "/Users/<User>/Desktop/workspace/commerce-sdk",

OR

"commerce-sdk": "file:../commerce-sdk",

8. npm install
9. and add the following script, index.js:

import { ShopperSearch, ShopperLogin, ShopperProducts, slasHelpers } from "commerce-sdk";

// Reach out to me for details
const CLIENT_ID = '<>'
const ORG_ID = '<>'
const SHORT_CODE ='<>'
const SITE_ID = '<>'

// must be registered in SLAS. On server, redirectURI is never called
const redirectURI = "http://localhost:3000/callback";

// client configuration parameters
const clientConfig = {
  parameters: {
    clientId: CLIENT_ID,
    organizationId: ORG_ID,
    shortCode: SHORT_CODE,
    siteId: SITE_ID,
  },
};

const slasClient = new ShopperLogin(clientConfig);

const guestTokenResponse = await slasHelpers.loginGuestUser({
    slasClient,
    parameters: {
        redirectURI,
    },
});

console.log("Guest Token Response: ", guestTokenResponse);

const shopperSearchClient = new ShopperSearch({
    ...clientConfig, 
    headers: {authorization: `Bearer ${guestTokenResponse.access_token}`}
});

const searchResponse = await shopperSearchClient.productSearch({
    parameters: {
        q: "skirt",
    },
});

console.log("Search Response: ", searchResponse);

const productId = searchResponse.hits[0].productId;

const shopperProductsClient = new ShopperProducts({
    ...clientConfig, 
    headers: {authorization: `Bearer ${guestTokenResponse.access_token}`}
});

const productResponse = await shopperProductsClient.getProduct({
    parameters: {
        id: productId,
    },
});

console.log("Product Response: ", productResponse);

10. Run the script with node index.js in the sample project directory

[vcua-mobify]

Based on this, I assume we've decided to name shopper baskets V1 as ShopperBaskets and not ShopperBasketsV1?

[joeluong-sfcc]

Yes that's correct

[vcua-mobify]

Just curious, do we need to run this more than once? Or is this just a helper function for cleaning up the -internal files current state of the repo?

[joeluong-sfcc]

We'll have to run it everytime we pull down the APIs as the internal OAS file will always be a part of anypoint exchange asset (at least for now)