Add getDeviceDetails action

[bachya]

Checks

• I've checked there are no linting errors.
• I've checked the code is still at 100% test coverage.

Added Actions (if relevant)

• Get Device Details

Are you happy to be listed as a contributor on Shortcuts.fun?

Yes

Any other information / comments

N/A

[bachya]

@joshfarrant One thing I don't see any examples of how we handle "Ask When Run" parameter values. Any thoughts? I see there's an askWhenRun constant in src/variables.ts; I just don't know how to use it. 😄

[xAlien95]

One thing I don't see any examples of how we handle "Ask When Run" parameter values. Any thoughts? I see there's an askWhenRun constant in src/variables.ts; I just don't know how to use it.

My fault, I didn't add any concrete example since my work on the variables in still in progress (#14).

You can use those global variables like this:

const {
  askWhenRun,
  clipboard,
} = require('@joshfarrant/shortcuts-js/variables');

const actions = [
  text({
    text: withVariables`I need ${askWhenRun} cups of ${clipboard} ☕️`
  }),
];

Or, if you have a local copy of the git:

const {
  askWhenRun,
  clipboard,
} = require('./build/variables');

[bachya]

Great! Thanks so much, @xAlien95!

[bachya]

@xAlien95, quick follow-up: what would I do in situations where “Ask When Run” is part of an option set?

[xAlien95]

... what would I do in situations where “Ask When Run” is part of an option set?

@bachya, you have to add WFSerialization as possible type for WFDeviceDetail:

const getDeviceDetails = (
  options: {
    /** The particular detail to retrieve */
    detail?: WFDeviceDetail | WFSerialization,
  },
): WFWorkflowAction => {
  const {
    detail = 'Device Name',
  } = options;

  return {
    WFWorkflowActionIdentifier: 'is.workflow.actions.getdevicedetails',
    WFWorkflowActionParameters: {
      WFDeviceDetail: detail,
    },
  };
};

Take a look at actions/text.ts as an example.

[bachya]

@xAlien95 I believe I added support correctly, but, inexperienced as I am, I can't seem to test it successfully (i.e., I can't establish what code produces a shortcut that actually uses "Ask When Run" in this case). Please correct me where I'm wrong!

[xAlien95]

@bachya, thanks for looking into it. I added some comments to let you separate WFDeviceDetail type from the WFSerialization (askWhenRun variable).

I can't establish what code produces a shortcut that actually uses "Ask When Run" in this case

At the moment askWhenRun global variable is based on the Attachment type, in the next few days I'll present a pull request in which variables are based on WFSerialization.

If you want to test now your action with askWhenRun, you have to write the following:

getDeviceDetails({
  detail: {
    Value: askWhenRun,
    WFSerializationType: 'WFTextTokenAttachment',
  },
})

In the future, you'll just have to write:

getDeviceDetails({
  detail: askWhenRun,
})

[joshfarrant]

Thanks both, looks good 👍

[joshfarrant]

Just one tiny tweak then we're good to go 👍