@foxtware/mineral 0.1.0 → 0.1.1

package/.creds.yml.sample

@@ -8,6 +8,11 @@ peoplevox:
   USERNAME: ______________________________
   PASSWORD: ______________________________
 
+logiwa:
+  BASE_URL: https://myapi.logiwa.com
+  EMAIL: _________________________________
+  PASSWORD: ______________________________
+
 youtube:
   API_KEY: _______________________________
 

package/README.md

@@ -49,4 +49,4 @@ The [bedrock](https://github.com/GorgonFreeman/bedrock) middleware, refactored f
   }
   ```
 - **Monorepo structure**
-Mineral gets pushed to from a larger repo that can also contain private functions. Mineral should be strictly useful stuff for the public, and can be used standalone, but needs to be instantiated for serving, setting stuff like which creds file to use. This allows it to be used as part of another repo in the same HTTP/curl way as by itself. In the serve functions, allow it to operate from a different directory, finding .hosting.yml, .creds.yml, etc. within it.
+Mineral gets pushed to from a larger repo that can also contain private functions. Mineral should be strictly useful stuff for the public, and can be used standalone, but needs to be instantiated for serving, setting stuff like which creds file to use. This allows it to be used as part of another repo in the same HTTP/curl way as by itself. Pass `--workspace` to locate `.creds.yml` and `--api_dirs` to serve additional function directories.

package/_build_scripts/publish.js

@@ -0,0 +1,85 @@
+const fs = require('fs');
+const path = require('path');
+const readline = require('readline');
+const { execSync } = require('child_process');
+
+const mineralRoot = path.join(__dirname, '..');
+const packageJsonPath = path.join(mineralRoot, 'package.json');
+
+const readPackageJson = () => JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+
+const writePackageJson = (packageJson) => {
+  fs.writeFileSync(packageJsonPath, `${ JSON.stringify(packageJson, null, 2) }\n`);
+};
+
+const bumpPatch = (version) => {
+  const [major, minor, patch] = version.split('.').map((part) => Number(part) || 0);
+  return [major, minor, patch + 1].join('.');
+};
+
+const getPublishedVersion = () => {
+  try {
+    return execSync('npm view @foxtware/mineral version', {
+      cwd: mineralRoot,
+      encoding: 'utf8',
+    }).trim();
+  } catch {
+    return '';
+  }
+};
+
+const ensureLoggedIn = () => {
+  try {
+    execSync('npm whoami', {
+      cwd: mineralRoot,
+      encoding: 'utf8',
+      stdio: 'pipe',
+    });
+  } catch {
+    throw new Error('Not logged in to npm. Run `npm login` with an account that can publish @foxtware/mineral.');
+  }
+};
+
+const askWithDefault = async (question, defaultAnswer) => {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+
+  const answer = await new Promise((resolve) => {
+    rl.question(`${ question } [${ defaultAnswer }] `, resolve);
+  });
+
+  rl.close();
+  return answer.trim() || defaultAnswer;
+};
+
+const publish = async () => {
+  ensureLoggedIn();
+
+  const packageJson = readPackageJson();
+  const localVersion = packageJson.version;
+  const publishedVersion = getPublishedVersion();
+
+  let version = localVersion;
+
+  if (localVersion === publishedVersion) {
+    const suggestedVersion = bumpPatch(localVersion);
+    version = await askWithDefault('What version should we use?', suggestedVersion);
+
+    packageJson.version = version;
+    writePackageJson(packageJson);
+  }
+
+  execSync('npm publish', {
+    cwd: mineralRoot,
+    stdio: 'inherit',
+  });
+
+  console.log(`Published @foxtware/mineral@${ version }`);
+};
+
+publish().catch((error) => {
+  console.error(error);
+  process.exit(1);
+});

package/api/logiwa/logiwa.constants.js

@@ -0,0 +1,8 @@
+const DEFAULT_API_VERSION = 'v3.1';
+
+const MAX_PER_PAGE = 200;
+
+module.exports = {
+  DEFAULT_API_VERSION,
+  MAX_PER_PAGE,
+};

package/api/logiwa/logiwa.utils.js

@@ -0,0 +1,53 @@
+const { DEFAULT_API_VERSION } = require('../logiwa/logiwa.constants');
+const { logiwaAuthGet } = require('../logiwa/logiwaAuthGet');
+const {
+  FetchClient,
+  Chain,
+  appendUrlToBase,
+  credsFromPayload,
+  fetchClientCommonSteps,
+} = require('../utils');
+
+const addUrlAndAuthHeaders = async (state) => {
+  const { requestPayload, context } = state;
+  const { credsPayload, apiVersion = DEFAULT_API_VERSION } = context;
+
+  const creds = context.creds ?? await credsFromPayload(credsPayload);
+  const authResponse = await logiwaAuthGet(credsPayload);
+  const { data } = authResponse;
+  const { token } = data;
+
+  // TODO: Handle failed auth
+
+  const { BASE_URL } = creds;
+
+  return {
+    context: {
+      creds,
+    },
+    requestPayload: {
+      url: appendUrlToBase(`${ BASE_URL }/${ apiVersion }`, requestPayload.url),
+      headers: {
+        Authorization: `Bearer ${ token }`,
+        ...requestPayload.headers,
+      },
+    },
+  };
+};
+
+const logiwaClientRequestPreparer = new Chain([
+  addUrlAndAuthHeaders,
+]);
+
+const logiwaClientResponseInterpreter = new Chain([
+  fetchClientCommonSteps.exitEarlyOnNotOk,
+]);
+
+const logiwaClient = new FetchClient({
+  requestPreparer: logiwaClientRequestPreparer,
+  responseInterpreter: logiwaClientResponseInterpreter,
+});
+
+module.exports = {
+  logiwaClient,
+};

package/api/logiwa/logiwaAuthGet.js

@@ -0,0 +1,86 @@
+// https://myapi.logiwa.com/swagger/index.html
+
+const { credsFromPayload, customFetch, appendUrlToBase, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { DEFAULT_API_VERSION } = require('./logiwa.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const logiwaAuthGet = async (
+  credsPayload,
+  {
+    apiVersion = DEFAULT_API_VERSION,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+  const {
+    BASE_URL,
+    EMAIL,
+    PASSWORD,
+  } = creds;
+
+  if (!EMAIL || !PASSWORD) {
+    return {
+      ok: false,
+      error: {
+        code: 'INVALID_CREDS',
+        message: 'EMAIL and PASSWORD are required.',
+      },
+    };
+  }
+
+  const url = appendUrlToBase(BASE_URL, `/${ apiVersion }/Authorize/token`);
+
+  const response = await customFetch(
+    url,
+    {
+      method: 'post',
+      body: {
+        email: EMAIL,
+        password: PASSWORD,
+      },
+    },
+  );
+
+  if (!response.ok) {
+    return response;
+  }
+
+  if (!response.data?.token) {
+    return {
+      ok: false,
+      error: {
+        code: 'AUTH_FAILED',
+        message: 'Logiwa did not return a token.',
+        details: response.data,
+      },
+    };
+  }
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  logiwaAuthGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/logiwaAuthGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "logiwa" }
+  }'
+*/

package/api/logiwa/logiwaInventoriesGet.js

@@ -0,0 +1,67 @@
+// https://myapi.logiwa.com/swagger/index.html#/Inventory/get_v3_1_Inventory_list_i__index__s__size_
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { logiwaClient } = require('../logiwa/logiwa.utils');
+const { MAX_PER_PAGE } = require('../logiwa/logiwa.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const logiwaInventoriesGet = async (
+  credsPayload,
+  {
+    apiVersion,
+    page = 0,
+    perPage = MAX_PER_PAGE,
+    sku_eq,
+    clientIdentifier_eq,
+    warehouseIdentifier_eq,
+    inventoryStatusId_eq,
+    location_eq,
+    useSnapshotData_eq,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const params = {
+    ...(sku_eq && { 'Sku.eq': sku_eq }),
+    ...(clientIdentifier_eq && { 'ClientIdentifier.eq': clientIdentifier_eq }),
+    ...(warehouseIdentifier_eq && { 'WarehouseIdentifier.eq': warehouseIdentifier_eq }),
+    ...(inventoryStatusId_eq && { 'InventoryStatusId.eq': inventoryStatusId_eq }),
+    ...(location_eq && { 'Location.eq': location_eq }),
+    ...(useSnapshotData_eq && { 'UseSnapshotData.eq': useSnapshotData_eq }),
+  };
+
+  return logiwaClient.fetch({
+    method: 'get',
+    url: `/Inventory/list/i/${ page }/s/${ perPage }`,
+    params,
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  logiwaInventoriesGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/logiwaInventoriesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "logiwa" }
+  }'
+*/

package/api/logiwa/logiwaOrderGet.js

@@ -0,0 +1,54 @@
+// https://myapi.logiwa.com/swagger/index.html#/ShipmentOrder/get_v3_1_ShipmentOrder__identifier_
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { logiwaClient } = require('../logiwa/logiwa.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['orderId'],
+]);
+
+const logiwaOrderGet = async (
+  credsPayload,
+  orderId, // Logiwa order UUID
+  {
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    orderId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return logiwaClient.fetch({
+    method: 'get',
+    url: `/ShipmentOrder/${ orderId }`,
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  logiwaOrderGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/logiwaOrderGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "logiwa" },
+    "orderId": "d53b375b-835d-4450-b71b-65e333f6709b"
+  }'
+*/

package/api/logiwa/logiwaOrdersGet.js

@@ -0,0 +1,92 @@
+// https://myapi.logiwa.com/swagger/index.html#/ShipmentOrder/get_v3_1_ShipmentOrder_list_i__index__s__size_
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { logiwaClient } = require('../logiwa/logiwa.utils');
+const { MAX_PER_PAGE } = require('../logiwa/logiwa.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const logiwaOrdersGet = async (
+  credsPayload,
+  {
+    apiVersion,
+    page = 0,
+    perPage = MAX_PER_PAGE,
+    sku_eq,
+    updatedDateTime_bt,
+    code_eq,
+    warehouseIdentifier_eq,
+    warehouseIdentifier_in,
+    identifier_eq,
+    clientIdentifier_eq,
+    clientIdentifier_in,
+    createdDateTime_bt,
+    actualShipmentDate_bt,
+    shipmentOrderDate_bt,
+    status_in,
+    status_eq,
+    expectedShipmentDate_bt,
+    shipmentOrderTypeName_eq,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const params = {
+    ...(sku_eq && { 'Sku.eq': sku_eq }),
+    ...(updatedDateTime_bt && { 'UpdatedDateTime.bt': updatedDateTime_bt }),
+    ...(code_eq && { 'Code.eq': code_eq }),
+    ...(warehouseIdentifier_eq && { 'WarehouseIdentifier.eq': warehouseIdentifier_eq }),
+    ...(warehouseIdentifier_in && { 'WarehouseIdentifier.in': warehouseIdentifier_in }),
+    ...(identifier_eq && { 'Identifier.eq': identifier_eq }),
+    ...(clientIdentifier_eq && { 'ClientIdentifier.eq': clientIdentifier_eq }),
+    ...(clientIdentifier_in && { 'ClientIdentifier.in': clientIdentifier_in }),
+    ...(createdDateTime_bt && { 'CreatedDateTime.bt': createdDateTime_bt }),
+    ...(actualShipmentDate_bt && { 'ActualShipmentDate.bt': actualShipmentDate_bt }),
+    ...(shipmentOrderDate_bt && { 'ShipmentOrderDate.bt': shipmentOrderDate_bt }),
+    ...(status_in && { 'Status.in': status_in }),
+    ...(status_eq && { 'Status.eq': status_eq }),
+    ...(expectedShipmentDate_bt && { 'ExpectedShipmentDate.bt': expectedShipmentDate_bt }),
+    ...(shipmentOrderTypeName_eq && { 'ShipmentOrderTypeName.eq': shipmentOrderTypeName_eq }),
+  };
+
+  return logiwaClient.fetch({
+    method: 'get',
+    url: `/ShipmentOrder/list/i/${ page }/s/${ perPage }`,
+    params,
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  logiwaOrdersGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/logiwaOrdersGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "logiwa" }
+  }'
+
+curl -X POST "http://localhost:8000/logiwaOrdersGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "logiwa" },
+    "options": { "code_eq": "#USA5674542" }
+  }'
+*/

package/api/logiwa/logiwaProductGet.js

@@ -0,0 +1,54 @@
+// https://myapi.logiwa.com/swagger/index.html#/Product/get_v3_1_Product_detail__id_
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { logiwaClient } = require('../logiwa/logiwa.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['productId'],
+]);
+
+const logiwaProductGet = async (
+  credsPayload,
+  productId,
+  {
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    productId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return logiwaClient.fetch({
+    method: 'get',
+    url: `/Product/detail/${ productId }`,
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  logiwaProductGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/logiwaProductGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "logiwa" },
+    "productId": "261a02aa-ce5a-4b06-a528-d419e0aa87a1"
+  }'
+*/

package/api/logiwa/logiwaProductsGet.js

@@ -0,0 +1,80 @@
+// https://myapi.logiwa.com/swagger/index.html#/Product/get_v3_1_Product_list_i__index__s__size_
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { logiwaClient } = require('../logiwa/logiwa.utils');
+const { MAX_PER_PAGE } = require('../logiwa/logiwa.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const logiwaProductsGet = async (
+  credsPayload,
+  {
+    apiVersion,
+    page = 0,
+    perPage = MAX_PER_PAGE,
+    sku_eq,
+    fnsku_eq,
+    clientIdentifier_eq,
+    clientIdentifier_in,
+    identifier_eq,
+    createdDateTime_bt,
+    updatedDateTime_bt,
+    productTypeName_eq,
+    productGroupName_eq,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const params = {
+    ...(sku_eq && { 'Sku.eq': sku_eq }),
+    ...(fnsku_eq && { 'FNSKU.eq': fnsku_eq }),
+    ...(clientIdentifier_eq && { 'ClientIdentifier.eq': clientIdentifier_eq }),
+    ...(clientIdentifier_in && { 'ClientIdentifier.in': clientIdentifier_in }),
+    ...(identifier_eq && { 'Identifier.eq': identifier_eq }),
+    ...(createdDateTime_bt && { 'CreatedDateTime.bt': createdDateTime_bt }),
+    ...(updatedDateTime_bt && { 'UpdatedDateTime.bt': updatedDateTime_bt }),
+    ...(productTypeName_eq && { 'ProductTypeName.eq': productTypeName_eq }),
+    ...(productGroupName_eq && { 'ProductGroupName.eq': productGroupName_eq }),
+  };
+
+  return logiwaClient.fetch({
+    method: 'get',
+    url: `/Product/list/i/${ page }/s/${ perPage }`,
+    params,
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  logiwaProductsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/logiwaProductsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "logiwa" }
+  }'
+
+curl -X POST "http://localhost:8000/logiwaProductsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "logiwa" },
+    "options": { "sku_eq": "EXD1684-2-L" }
+  }'
+*/